javax.security.auth.spi
인터페이스 LoginModule

public interface LoginModule

LoginModule에 서는 인증 테크놀러지 프로바이더가 구현하는 인터페이스를 기술합니다. LoginModule를 어플리케이션에 플러그 인 하는 것으로써, 특정의 인증 타입을 제공할 수 있습니다.

어플리케이션이 LoginContext API를 호출하는 한편으로 인증 테크놀러지 프로바이더는 LoginModule인터페이스를 구현합니다. Configuration에 서는 특정의 로그인 어플리케이션으로 사용되는 LoginModule를 지정합니다. 그 때문에 어플리케이션 자체로 변경을 더하는 일 없이, 어플리케이션에 다른 LoginModule를 플러그 인 할 수 있습니다 .

LoginContext는 Configuration을 읽어내, 적절한 LoginModule를 인스턴스화합니다. 각 LoginModule 은, Subject, CallbackHandler, 공유 LoginModule 상태 및 LoginModule 고유의 옵션을 사용해, 초기화됩니다. Subject는 현재 인증중의 Subject를 나타내, 인증에 성공하면, 관련된 Credential 로 갱신됩니다. LoginModule 에서는 CallbackHandler를 사용해 사용자와 통신합니다. 예를 들어 사용자 명과 패스워드의 입력을 요구할 때, CallbackHandler를 사용합니다. CallbackHandler는 null 에서도 가능입니다. Subject를 인증하기 위해서 반드시 CallbackHandler가 필요한 LoginModule 에서는 LoginException을 Throw 하는 일이 있습니다. LoginModule 에서는 공유 상태를 사용해, LoginModule 간에 정보나 데이터를 공유할 수 있습니다 .

LoginModule 고유의 옵션은 관리자나 사용자가 로그인 Configuration 내에서 설정하는 이 LoginModule 용으로 구성한 옵션을 나타냅니다. 옵션은 LoginModule 자체에 의해 정의되어LoginModule 내부의 동작을 제어합니다. 예를 들어 디버그나 테스트 기능을 지원 하기 위해서 옵션을 정의할 수 있습니다. 옵션은 키와 값의 페어 (debug=true 등)를 사용해 정의합니다. 키를 사용해 값을 취득할 수 있도록, LoginModule에 서는 옵션을 Map로 서 포함합니다. LoginModule로 정의할 수 있는 옵션의 수에 상한은 없습니다.

호출하는 어플리케이션은 인증 프로세스를 단일 조작이라고 봅니다. 그러나, LoginModule 내의 인증 프로세스는 2개의 별도인 국면으로 처리됩니다. 최초의 국면에서는 LoginModule login 메서드가 LoginContext login 메서드에 의해 호출합니다. LoginModule login 메서드에서는 실제의 인증 (예를 들어 패스워드의 입력을 요구해 검증한다)을 실행해, 인증 상태를 비공개 상태 정보로서 저장합니다. 끝나면, LoginModule login 메서드에서는 true (성공했을 경우) 또는 false (무시할 수 없는 경우)를 돌려주는지, LoginException을 Throw의해 실패를 지정합니다. 실패했을 경우, LoginModule로 인증을 재시행하거나 유예 하거나 하지 말아 주세요. 이런 종류의 처리는 어플리케이션이 실시합니다. 어플리케이션으로 인증을 재시행하는 경우는 LoginModule login 메서드가 한번 더 호출합니다.

2번째의 국면에서는 LoginContext 인증 전체가 성공했을 경우 (관련된 REQUIRED, REQUISITE, SUFFICIENT, OPTIONAL LoginModule 이 성공), LoginModule commit 메서드가 호출됩니다. LoginModule commit 메서드에서는 비공개로 보존된 상태를 확인해, 자신의 인증에 성공했는지 어떠했는지를 판단합니다. LoginContext 전체의 인증에 성공해, LoginModule 자체의 인증에 성공했을 경우는 commit 메서드에 의해 관련된 Principal (인증된 식별 정보)와 Credential (암호화키등의 인증 데이터)이, LoginModule 내에 있는 Subject와 관련지을 수 있습니다.

LoginContext 인증 전체가 실패했을 (관련된 REQUIRED, REQUISITE, SUFFICIENT, OPTIONAL LoginModule가 성공하지 않았다) 경우, 각각의 LoginModule에 대해서 abort 메서드가 호출됩니다. 이 경우 LoginModule 들어간 보존되고 있던 인증 상태를 삭제 또는 파기합니다.

Subject 로그아웃에는 1 국면만이 포함됩니다. LoginContext는 LoginModule logout 메서드를 호출합니다. LoginModule logout 메서드는 로그아웃 처리를 실행해, Principal 나 Credential를 Subject로 부터 삭제하거나 세션 정보를 기록하거나 합니다.

LoginModule 구현은 인수 없음의 생성자를 제공할 필요가 있습니다. 이것에 의해 LoginModule를 로드하는 클래스는 LoginModule를 인스턴스화할 수 있습니다.

관련 항목:

LoginContext, Configuration

메서드 개요

boolean	abort () 인증 프로세스를 중지하는 메서드입니다 (국면 2).
boolean	commit () 인증 프로세스를 위탁하는 메서드입니다 (국면 2).
void	initialize (Subject subject, CallbackHandler callbackHandler, Map <String, ? > sharedState, Map <String, ? > options) 이 LoginModule를 초기화합니다.
boolean	login () Subject를 인증하는 메서드입니다 (국면 1).
boolean	logout () Subject를 로그아웃 시키는 메서드입니다.

메서드의 상세

initialize

void initialize(Subject  subject,
                CallbackHandler  callbackHandler,
                Map <String,
? > sharedState,
                Map <String,
? > options)

이 LoginModule를 초기화합니다.

이 LoginModule가 인스턴스화 되고 나서, LoginContext에 의해 호출합니다. 이 메서드의 목적은 이 LoginModule를 관련 정보로 초기화하는 것입니다. 이 LoginModule 이 sharedState 파라미터나 options 파라미터에 포함된 정보를 인식할 수 없는 경우, 그러한 정보는 무시됩니다.

파라미터:

subject - 인증 대상의 Object

callbackHandler - 최종 사용자와 통신하는 (예를 들어 사용자 명과 패스워드의 입력을 요구한다) CallbackHandler

sharedState - 구성된 것 외의 LoginModule 과 공유하는 상태

options - 이 LoginModule용의 로그인 Configuration로 지정된 옵션

login

boolean login()
              throws LoginException 

Subject를 인증하는 메서드입니다 (국면 1).

이 메서드의 구현에서는 Subject를 인증합니다. 예를 들어 사용자 명이나 패스워드라고 하는 Subject 정보의 입력을 요구하고 나서, 패스워드를 검증합니다. 이 메서드에서는 인증의 시행 결과를, LoginModule 내에 비공개 상태로서 저장합니다.

반환값:

인증에 성공했을 경우는 true. 이 LoginModule가 무시되는 경우는 false

예외:

LoginException - 인증에 실패했을 경우

commit

boolean commit()
               throws LoginException 

인증 프로세스를 위탁하는 메서드입니다 (국면 2).

LoginContext 인증 전체가 성공했을 (관련된 REQUIRED, REQUISITE, SUFFICIENT, OPTIONAL LoginModule가 성공할) 경우에 이 메서드가 호출됩니다.

이 LoginModule 자체의 인증에 성공했을 경우는 (login 메서드로 보존된 비공개 상태를 취득해 조사한다), 이 메서드에 의해 관련된 Principal와 Credential 이, LoginModule 내에 있는 Subject에 관련지을 수 있습니다. 이 LoginModule 자체의 인증에 실패했을 경우는 일단 보존되고 있던 상태를 삭제 또는 파기합니다.

반환값:

이 메서드가 성공했을 경우는 true. 이 LoginModule가 무시되는 경우는 false

예외:

LoginException - 위탁에 실패했을 경우

abort

boolean abort()
              throws LoginException 

인증 프로세스를 중지하는 메서드입니다 (국면 2).

LoginContext 인증 전체가 실패했을 (관련된 REQUIRED, REQUISITE, SUFFICIENT, OPTIONAL LoginModule가 성공하지 않았다) 경우에 이 메서드가 호출됩니다.

이 LoginModule 자체의 인증에 성공했을 경우는 (login 메서드로 보존된 비공개 상태를 취득해 조사한다), 일단 보존되고 있던 상태가 이 메서드에 의해 클린 업 됩니다.

반환값:

이 메서드가 성공했을 경우는 true. 이 LoginModule가 무시되는 경우는 false

예외:

LoginException - 중지에 실패했을 경우

logout

boolean logout()
               throws LoginException 

Subject를 로그아웃 시키는 메서드입니다.

이 메서드의 구현에서는 Subject Principal와 Credential를 삭제 또는 파기합니다.

반환값:

이 메서드가 성공했을 경우는 true. 이 LoginModule가 무시되는 경우는 false

예외:

LoginException - 로그아웃에 실패했을 경우