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 를 슬로우 하는 일이 있습니다. LoginModule 에서는 공유 상태를 사용해, LoginModule 간에 정보나 데이터를 공유할 수가 있습니다.

LoginModule 고유의 옵션은 관리자나 로그인 Configuration 내에서 설정된 유저가, 이 LoginModule 용으로 구성한 옵션을 나타냅니다. 옵션은 LoginModule 자체에 의해 정의되어LoginModule 내에서의 동작을 제어합니다. 옵션은 열쇠와 값의 페어 ( debug=true 등)를 사용해 정의합니다. 열쇠를 사용해 값을 취득할 수 있게,LoginModule 에서는 옵션을 Map 로서 저장합니다. LoginModule 로 정의할 수 있는 옵션의 수에 상한은 없습니다.

호출하는 어플리케이션은 인증 프로세스를 단일 조작으로 간주합니다. 그러나,LoginModule 내의 인증 프로세스는 2 kr의 별도인 국면으로 처리됩니다. 최초의 국면에서는 LoginModule 의 login 메소드가, LoginContext 의 login 메소드에 의해 불려 갑니다. LoginModule 의 login 메소드에서는 실제의 인증 (예를 들어 패스워드의 입력을 요구해 검증한다)을 실행해, 인증 상태를 비공개 상태 정보로서 보존합니다. 끝나면(자), LoginModule 의 login 메소드에서는 true (성공했을 경우) 또는 false (무시할 수 없는 경우)를 돌려주는지 LoginException 를 슬로우 해 실패를 지정합니다. 실패했을 경우,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 의 구현은 인수 없음의 constructor를 보관 유지할 필요가 있습니다. 이것에 의해,LoginModule 를 로드하는 클래스는 LoginModule 를 인스턴스화할 수 있습니다.

관련 항목:

LoginContext , Configuration

메소드의 개요

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

메소드의 상세

initialize

public void initialize(Subject  subject,
                       CallbackHandler  callbackHandler,
                       Map  sharedState,
                       Map  options)

이 LoginModule 를 초기화합니다.

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

파라미터:

subject - 인증 대상의 Object

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

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

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

login

public boolean login()
              throws LoginException 

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

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

반환값:

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

예외:

LoginException - 인증에 실패했을 경우

commit

public boolean commit()
               throws LoginException 

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

LoginContext 의 인증 전체가 성공했을 (관련하는 REQUIRED, REQUISITE, SUFFICIENT, OPTIONAL 의 각 LoginModule 가 성공할) 경우에, 이 메소드가 불려 갑니다.

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

반환값:

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

예외:

LoginException - 위탁에 실패했을 경우

abort

public boolean abort()
              throws LoginException 

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

LoginContext 의 인증 전체가 실패했을 (관련하는 REQUIRED, REQUISITE, SUFFICIENT, OPTIONAL 의 각 LoginModule 가 성공하지 않았다) 경우에, 이 메소드가 불려 갑니다.

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

반환값:

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

예외:

LoginException - 중지에 실패했을 경우

logout

public boolean logout()
               throws LoginException 

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

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

반환값:

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

예외:

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