com.sun.security.auth.module
クラス KeyStoreLoginModule

java.lang.Object
  |
  +--com.sun.security.auth.module.KeyStoreLoginModule

すべての実装インタフェース:

LoginModule

public class KeyStoreLoginModule

extends Object

implements LoginModule

キーストアの別名を入力を要求して、別名のプリンシパルとクレデンシャルを使用してサブジェクトを生成する、JAAS ログインモジュールを提供します。サブジェクトのプリンシパルにある別名のクレデンシャルで、最初の証明書のサブジェクトの識別名に対する X500Principal とサブジェクトの public クレデンシャルにある別名の証明書のパスを格納します。また、証明書が別名の証明書のパスで最初の証明書であり、かつ非公開鍵がサブジェクトの private クレデンシャルにある別名の非公開鍵である X500PrivateCredential も格納します。

JASS 認証ポリシーファイルでは、次のオプションを使用できます。

keyStoreURL

キーストアファイルの位置を指定する URL です。デフォルトでは、java.home システムプロパティで指定したディレクトリ内の .keystore ファイルです。

keyStoreType

キーストアの種類です。指定しない場合のデフォルトは、KeyStore.getDefaultType() を呼び出した結果です

keyStoreProvider

キーストアのプロバイダです。指定しない場合は、プロバイダを検索する標準的な検索順序が使用されます。

keyStoreAlias

キーストア内の、ログインするための別名です。コールバックハンドラが与えられていない場合は必須になります。デフォルト値はありません。

keyStorePasswordURL

キーストアのパスワードの位置を指定する URL です。コールバックハンドラが与えられていない場合は必須になります。デフォルト値はありません。

privateKeyPasswordURL

別名の非公開鍵にアクセスするために必要となる特定の非公開鍵のパスワードの位置を指定する URL です。この値を指定しない場合は、キーストアのパスワードが使われます。

コンストラクタの概要

KeyStoreLoginModule()

メソッドの概要

boolean	abort() LoginContext の認証全体が失敗した場合 (関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が失敗した場合) に呼び出されます。
boolean	commit() 認証プロセスをコミットする抽象メソッドです (フェーズ 2)。
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options) この LoginModule を初期化します。
boolean	login() ユーザを認証します。
boolean	logout() ユーザをログアウトさせます。

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

KeyStoreLoginModule

public KeyStoreLoginModule()

メソッドの詳細

initialize

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

この LoginModule を初期化します。

定義:

インタフェース LoginModule 内の initialize

パラメータ:

subject - 認証を受ける Subject

callbackHandler - エンドユーザとの通信 (ユーザ名とパスワードの入力など) に使用される CallbackHandler

sharedState - 共有 LoginModule の状態

options - この LoginModule 用にログイン Configuration で指定されたオプション

login

public boolean login()
              throws LoginException

ユーザを認証します。

キーストアの別名とパスワードの入力をユーザに要求します。入力された別名のプリンシパルとクレデンシャルをキーストアから取得します。

定義:

インタフェース LoginModule 内の login

戻り値:

常に true (この LoginModule を無視してはならない)

例外:

FailedLoginException - 認証に失敗した場合

LoginException

commit

public boolean commit()
               throws LoginException

認証プロセスをコミットする抽象メソッドです (フェーズ 2)。

LoginContext の認証全体が成功した場合 (関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が成功した場合) に呼び出されます。

この LoginModule 自体の認証が成功したかどうかをチェックするには、login メソッドによって保存された非公開状態を取得します。認証が成功した場合、サブジェクトのプリンシパルにある別名のクレデンシャルで最初の証明書のサブジェクトの識別名に対する X500Principal、サブジェクトの public クレデンシャルにある別名の証明書パス、別名の証明書パス内の最初の証明書とサブジェクトの private クレデンシャルにある別名の非公開鍵を持つ X500PrivateCredential の 3 つを、このメソッドは関連付けます。認証が失敗した場合、このメソッドは保存されていた状態をすべて削除します。

定義:

インタフェース LoginModule 内の commit

戻り値:

この LoginModule 自体のログインとコミットの試みが成功した場合は true、そうでない場合は false

例外:

LoginException - コミットに失敗した場合

abort

public boolean abort()
              throws LoginException

LoginContext の認証全体が失敗した場合 (関連する REQUIRED、REQUISITE、SUFFICIENT、および OPTIONAL の各 LoginModule が失敗した場合) に呼び出されます。

この LoginModule 自体の認証が成功 (login メソッドと commit メソッドによって保存された、非公開状態を取得することでチェックされる) した場合は、当初保存された状態を整理します。

定義:

インタフェース LoginModule 内の abort

戻り値:

この LoginModule 自体のログインやコミットの試みが失敗した場合は false、そうでない場合は true

例外:

LoginException - 中止に失敗した場合

logout

public boolean logout()
               throws LoginException

ユーザをログアウトさせます。

このメソッドは、commit メソッドによって追加されたプリンシパル、public クレデンシャル、および private クレデンシャルを削除します。

定義:

インタフェース LoginModule 内の logout

戻り値:

この LoginModule を無視してはならないため、常に true

例外:

LoginException - ログアウトに失敗した場合