javax.security.auth.login
클래스 LoginContext

java.lang.Object 
  javax.security.auth.login.LoginContext

public class LoginContext
extends Object 

LoginContext 클래스는 Subject를 인증하기 위한 기본적인 메서드를 기술해, 기본이 되는 인증 테크놀러지에 존하지 않는 어플리케이션 개발의 방법을 제공합니다. Configuration는 어플리케이션으로 사용되는 인증 테크놀러지 (LoginModule)를 지정합니다. 이 때문에 어플리케이션 자체로 변경을 더하는 일 없이, 어플리케이션에 다른 LoginModule를 플러그 인 할 수 있습니다.

이 클래스는 플러그 인 가능한 인증을 지원 할 뿐만 아니라, 스택 된 인증의 개념도 지원 합니다. 어플리케이션을 2개 이상의 LoginModule를 사용하도록 구성할 수 있습니다. 예를 들어 1개의 어플리케이션으로 Kerberos LoginModule와 스마트 카드 LoginModule 양쪽 모두를 구성할 수 있습니다.

보통 의 호출측은, name와 CallbackHandler를 사용해 LoginContext를 인스턴스화합니다. LoginContext는 name를 Configuration 인덱스로서 사용해, 사용하는 LoginModule 나, 인증 전체를 성공시키기 위해서 성공하지 않으면 안 되는 LoginModule를 판정합니다. CallbackHandler는 기본이 되는 LoginModule 에게 건네져 LoginModule는 사용자와의 주고받아 (그래피컬 사용자 인터페이스로 사용자 명과 패스워드의 입력을 요구하는 등)를 실시합니다.

호출측은 LoginContext를 인스턴스화하면, login 메서드를 호출해 Subject 인증을 실시합니다. login 메서드는 구성이 끝난 모듈을 호출해, 각종 인증 (사용자 명/패스워드를 사용한 인증, 스마트 카드의 PIN 인증등)을 실시합니다. 인증에 실패해도, LoginModule는 인증을 재시행하지 않습니다. 또, 지연 시간도 발생하지 않습니다. 이러한 태스크는 LoginContext 호출측이 담당합니다.

login 메서드가 예외를 Throw 하는 일 없이 되돌아 왔을 경우는 인증 전체에 성공한 것이 됩니다. 그리고, 호출측은 getSubject 메서드를 호출하는 것으로 새롭게 인증된 Subject를 취득할 수 있습니다. Subject와 관련된 Principal와 Credential는 Subject getPrincipals, getPublicCredentials 및 getPrivateCredentials 각 메서드를 호출하는 것으로 취득할 수 있습니다.

Subject를 로그아웃 시키는 경우, 호출측은 logout 메서드를 호출합니다. login 메서드의 경우와 같이, 이 logout 메서드는 구성이 끝난 모듈의 logout 메서드를 호출합니다.

1개의 LoginContext 로 복수의 Subject를 인증할 수 없습니다. Subject 마다 별개의 LoginContext를 사용할 필요가 있습니다.

다음의 내용은 모든 LoginContext 생성자에 적용됩니다.

1. Subject
   • 생성자에 Subject 입력 파라미터가 가리키는 경우, LoginContext는 호출해 옆에서 지정된 Subject 객체를 사용한다

   • 호출측이 null Subject를 지정했을 경우로null값이 허가되고 있을 때, LoginContext는 새로운 Subject를 인스턴스화한다

   • 생성자에 Subject 입력 파라미터가 지정되어 있지 않은 경우, LoginContext는 새로운 Subject를 인스턴스화한다

2. Configuration
   • 생성자에 Configuration 입력 파라미터가 가리키는 경우로 호출측이 null 이외의 Configuration를 지정했을 때, LoginContext는 호출해 옆에서 지정된 Configuration를 사용한다

     생성자에 Configuration 입력 파라미터가 지정되어 있지 않은 경우, 또는 호출해 옆이 null Configuration 객체를 지정했을 경우, 생성자는 다음의 호출을 사용해 인스톨 끝난 Configuration를 취득한다

     
     config = Configuration.getConfiguration();
      

     어느 쪽의 경우도, 생성자 으로 지정된 name 인수는 Configuration.getAppConfigurationEntry 메서드에게 건네진다. Configuration가 지정된 name 엔트리를 가지지 않는 경우, LoginContext는 디폴트의 엔트리명인 「other」로 getAppConfigurationEntry를 호출한다. 「other」의 엔트리가 존재하지 않는 경우, LoginException가 Throw 된다

   • LoginContext가 인스톨 끝난 Configuration를 사용하는 경우, 호출측은 createLoginContext. name와 경우에 따라서는 createLoginContext.other 라고 하는 AuthPermission를 필요한다. 게다가 LoginContext는 AccessController.doPrivileged로 부터 구성이 끝난 모듈을 호출한다. 이것은 시큐러티 보호의 필요가 있는 태스크 (리모트 호스트에게로의 접속, Subject 갱신등)를 실행하는 모듈이 각각 적절한 접근 권한을 필요로 하는데 대해, LoginContext 호출측은 이러한 접근 권한을 필요로 하지 않기 때문이다

   • LoginContext가 호출해 옆에서 지정된 Configuration를 사용하는 경우, 호출측은 createLoginContext AuthPermission를 필요로 하지 않는다. LoginContext는 호출해 측에 대신해 AccessControlContext을 보존해, 그 컨텍스트 의 제약을 부과된 AccessController.doPrivileged 호출로부터로 구성이 끝난 모듈을 호출한다. 즉, 호출측의 컨텍스트 (LoginContext 작성시에 보존된 컨텍스트)은 모듈이 실행하는 시큐러티 보호를 필요로 하는 태스크의 실행에 필요한 접근 권한을 갖추고 있을 필요가 있다

3. CallbackHandler
   • 생성자에 CallbackHandler 입력 파라미터가 가리키는 경우, LoginContext는 호출해 옆에서 지정된 CallbackHandler 객체를 사용한다

   • 생성자에 CallbackHandler 입력 파라미터가 지정되어 있지 않은 경우나, 호출측이 null CallbackHandler 객체를 지정해, 한편 null값이 허가되고 있는 경우, LoginContext는 auth.login.defaultCallbackHandler 시큐러티 프로퍼티로부터 디폴트의 핸들러 구현의 완전 수식 클래스명을 조회한다. 이 시큐러티 프로퍼티가 설정되어 있지 않은 경우, 부하의 모듈은 사용자와의 통신에 사용하는 CallbackHandler를 가지지 않는다. 이 때문에 호출측은 구성이 끝난 모듈이 다른 수단으로 사용자 인증을 실시할 수가 있으면 상정한다

   • 상기와 같이 호출해 옆에서 지정된 Configuration를 사용하지 않고, 인스톨이 끝난 Configuration를 사용하는 LoginContext는 호출측에서 지정된 (디폴트의) CallbackHandler 구현을 새로운 CallbackHandler 구현에 랩 할 필요가 있다. 이 새로운 CallbackHandler 구현의 handle 메서드 구현은 호출측의 현재의 AccessControlContext에 의해 제약을 부과된 java.security.AccessController.doPrivileged 호출내에서 지정된 CallbackHandler handle 메서드를 호출할 필요가 있다

auth.login.defaultCallbackHandler 등의 시큐러티 프로퍼티는 java.security.Security 클래스를 사용해 프로그램에 의해 설정하는지, <JAVA_HOME>/lib/security/java.security 라고 하는 파일에 있는 Java 시큐러티 프로퍼티 파일로 정적으로 설정합니다. <JAVA_HOME>는 SDK가 인스톨 되고 있는 디렉토리입니다.

관련 항목:

Security, AuthPermission, Subject, CallbackHandler, Configuration, LoginModule

생성자 개요

LoginContext (String name)
이름을 지정해 새로운 LoginContext를 인스턴스화합니다.

LoginContext (String name, CallbackHandler callbackHandler)
이름과 CallbackHandler를 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

LoginContext (String name, Subject subject)
이름과 Subject를 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

LoginContext (String name, Subject subject, CallbackHandler callbackHandler)
이름, 인증을 받는 Subject 객체 및 CallbackHandler 객체를 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

LoginContext (String name, Subject subject, CallbackHandler callbackHandler, Configuration config)
이름, 인증을 받는 Subject 객체, CallbackHandler 객체 및 로그인 Configuration을 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

메서드 개요

Subject	getSubject () 인증된 Subject를 리턴합니다.
void	login () 인증을 실행합니다.
void	logout () Subject를 로그아웃 합니다.

클래스 java.lang. Object 로부터 상속된 메서드

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

생성자 상세

LoginContext

public LoginContext(String  name)
             throws LoginException 

이름을 지정해 새로운 LoginContext를 인스턴스화합니다.

파라미터:

name - Configuration 인덱스로서 사용되는 이름

예외:

LoginException - 호출측에서 지정된 name가 Configuration에 없고, 「other」라고 하는 Configuration 엔트리가 없는 경우, 혹은 auth.login.defaultCallbackHandler 시큐러티 프로퍼티가 설정되어 있는 것에도 불구하고, 구현 클래스를 로드할 수 없었던 경우

SecurityException - SecurityManager가 설정되어 있어, 호출측이 AuthPermission("createLoginContext. name")를 가지지 않는 경우, 또는 name 구성 엔트리가 존재하지 않고, 호출측이 AuthPermission("createLoginContext.other")를 가지지 않는 경우

LoginContext

public LoginContext(String  name,
                    Subject  subject)
             throws LoginException 

이름과 Subject를 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

파라미터:

name - Configuration 인덱스로서 사용되는 이름

subject - 인증 대상의 Subject

예외:

LoginException - 호출측에서 지정된 name가 Configuration에 없고, 「other」라고 하는 Configuration 엔트리가 없는 경우, 호출측에서 지정된 subject이 null인 경우, 혹은, auth.login.defaultCallbackHandler 시큐러티 프로퍼티가 설정되어 있는 것에도 불구하고, 구현 클래스를 로드할 수 없었던 경우

SecurityException - SecurityManager가 설정되어 있어, 호출측이 AuthPermission("createLoginContext. name")를 가지지 않는 경우, 또는 name 구성 엔트리가 존재하지 않고, 호출측이 AuthPermission("createLoginContext.other")를 가지지 않는 경우

LoginContext

public LoginContext(String  name,
                    CallbackHandler  callbackHandler)
             throws LoginException 

이름과 CallbackHandler를 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

파라미터:

name - Configuration 인덱스로서 사용되는 이름

callbackHandler - LoginModule가 사용자와 교환하기 위해서 사용하는 CallbackHandler 객체

예외:

LoginException - 호출측에서 지정된 name가 Configuration에 없고, 「other」라고 하는 Configuration 엔트리가 없는 경우, 혹은 호출해 옆에서 지정된 callbackHandler가 null인 경우

SecurityException - SecurityManager가 설정되어 있어, 호출측이 AuthPermission("createLoginContext. name")를 가지지 않는 경우, 또는 name 구성 엔트리가 존재하지 않고, 호출측이 AuthPermission("createLoginContext.other")를 가지지 않는 경우

LoginContext

public LoginContext(String  name,
                    Subject  subject,
                    CallbackHandler  callbackHandler)
             throws LoginException 

이름, 인증을 받는 Subject 객체 및 CallbackHandler 객체를 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

파라미터:

name - Configuration 인덱스로서 사용되는 이름

subject - 인증 대상의 Subject

callbackHandler - LoginModule가 사용자와 교환하기 위해서 사용하는 CallbackHandler 객체

예외:

LoginException - 호출측에서 지정된 name가 Configuration에 없고, 「other」라고 하는 Configuration 엔트리가 없는 경우, 호출측에서 지정된 subject이 null인 경우, 혹은 호출해 옆에서 지정된 callbackHandler가 null인 경우

SecurityException - SecurityManager가 설정되어 있어, 호출측이 AuthPermission("createLoginContext. name")를 가지지 않는 경우, 또는 name 구성 엔트리가 존재하지 않고, 호출측이 AuthPermission("createLoginContext.other")를 가지지 않는 경우

LoginContext

public LoginContext(String  name,
                    Subject  subject,
                    CallbackHandler  callbackHandler,
                    Configuration  config)
             throws LoginException 

이름, 인증을 받는 Subject 객체, CallbackHandler 객체 및 로그인 Configuration을 지정해, 새로운 LoginContext 객체를 인스턴스화합니다.

파라미터:

name - 호출측에서 지정된 Configuration 인덱스로서 사용되는 이름

subject - 인증 대상의 Subject, 또는 null

callbackHandler - LoginModule가 사용자와의 주고받아에 사용하는 CallbackHandler 객체, 또는 null

config - 인증을 실시하기 위해서 호출되는 로그인 모듈을 리스트 하는 Configuration, 또는 null

예외:

LoginException - 호출측에서 지정된 name가 Configuration에 존재하지 않고, 「other」의 Configuration 엔트리가 없는 경우

SecurityException - SecurityManager가 설정되어 있어, config가 null로 한편 호출해 옆이 AuthPermission("createLoginContext. name")를 가지지 않는 경우, 또는 name 구성 엔트리가 존재하지 않고, 호출측이 AuthPermission("createLoginContext.other")를 가지지 않는 경우

도입된 버전 :

1.5

메서드의 상세

login

public void login()
           throws LoginException 

인증을 실행합니다.

이 메서드는 로그인 Configuration 정의에 따라, LoginContext 생성자 으로 지정된 name 용으로 설정된 각 LoginModule에 대해서 login 메서드를 호출합니다. 그러자(면), 각 LoginModule에 의해 각종 인증 (사용자 명/패스워드의 인증, 스마트 카드의 PIN 인증등)이 실행됩니다.

이 메서드에서는 LoginContext 인증 전체가 성공했을 경우 (관련된 REQUIRED, REQUISITE, SUFFICIENT, OPTIONAL LoginModule 이 성공)에 구성 끝난 LoginModule에 대해서 commit 메서드를 호출하는지, 인증 전체가 실패했을 경우에 구성 끝난 각 LoginModule에 대해서 abort 메서드를 호출하는 것으로 2 국면의 인증 프로세스가 완료합니다. 인증에 성공했을 경우는 성공한 각 LoginModule commit 메서드에의해 관련된 Principal와 Credential 가Subject와 관련지을 수 있습니다. 인증에 실패했을 경우는 각 LoginModule abort 메서드에의해 일단 보존되고 있던 상태를 삭제 또는 파기합니다.

인증 프로세스의 commit 국면에 실패하면 인증 전체가 실패해, 이 메서드는 구성 끝난 각 LoginModule에 대해서 abort 메서드를 호출합니다.

어떠한 이유로써 abort 국면이 실패해도, login 국면중이나 commit 국면중에 Throw 된 원의 예외를 전달합니다. 어느 쪽의 경우도, 인증 전체가 실패합니다.

복수의 LoginModule 으로 실패했을 경우, 최초로 실패한 LoginModule로 발생한 예외를 전달합니다.

이 메서드가 abort 국면에 들어갔을 (login 국면이나 commit 국면에 실패할) 경우, 어플리케이션용으로 구성된 모든 LoginModule 가 각각의 Configuration 플래그 파라미터와는 관계없이 호출합니다. 즉, abort 국면중은, Requisite와 Sufficient 시멘틱스는 무시됩니다. 이것에 의해 적절한 클린 업과 상태의 복원을 실시하는 것이 보증됩니다.

예외:

LoginException - 인증에 실패했을 경우

logout

public void logout()
            throws LoginException 

Subject를 로그아웃 합니다.

이 메서드는 이 LoginContext 용으로 구성된 각 LoginModule logout 메서드를 호출합니다. 각 LoginModule는 각각의 로그아웃 처리를 실시합니다. 로그아웃 처리에는 Subject로 부터의 Principal 나 Credential 삭제/파기나, 상태의 클린 업등이 포함됩니다.

이 메서드에서는 어플리케이션용으로 구성된 모든 LoginModule 가 각각의 Configuration 플래그 파라미터에 관계없이 호출합니다. 즉, 이 메서드에서는 Requisite와 Sufficient 시멘틱스는 무시됩니다. 이것에 의해 적절한 클린 업과 상태의 복원을 실시하는 것이 보증됩니다.

예외:

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

getSubject

public Subject  getSubject()

인증된 Subject를 리턴합니다.

반환값:

인증이 끝난 Subject. 호출측이 이 LoginContext 생성자에 Subject를 지정했을 경우, 이 메서드는 호출해 옆에서 지정된 Subject를 돌려준다. Subject가 지정되지 않고, 인증이 성공했을 경우, 이 메서드는 인스턴스화 되어 이 LoginContext 에 한 인증에 사용되는 Subject를 돌려준다. Subject가 지정되지 않고, 인증이 실패했을 경우, 또는 인증을 하지 않았던 경우, 이 메서드는 null을 돌려준다