javax.security.auth.kerberos

クラス KeyTab

java.lang.Object

javax.security.auth.kerberos.KeyTab

public final class KeyTab
extends Object

このクラスは、キータブファイルをカプセル化します。

長期の秘密鍵をキータブファイルから取得する Kerberos JAAS ログインモジュールでは、このクラスを使用するようにしてください。ログインモジュールは、認証プロセスのコミットフェーズ中に、このクラスのインスタンスを Subject の非公開資格セットに格納します。

アプリケーションが Subject オブジェクトから KeyTab インスタンスにアクセスする必要がある場合は、アプリケーションに PrivateCredentialPermission を与えることが必要な場合があります。アプリケーションが KeyTab にアクセスするのにデフォルトの JGSS Kerberos メカニズムに依存している場合、このアクセス権は必要ありません。ただしその場合、アプリケーションには適切な ServicePermission が必要です。

キータブのファイル形式については、http://www.ioplex.com/utilities/keytab.txt を参照してください。

導入されたバージョン:

1.7

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	equals(Object other) 指定された Object とこの KeyTab を比較し、同等であるかどうかを調べます。
boolean	exists() キータブファイルが存在するかどうかをチェックします。
static KeyTab	getInstance() デフォルトの KeyTab インスタンスを返します。
static KeyTab	getInstance(File file) File オブジェクトから KeyTab インスタンスを返します。
KerberosKey[]	getKeys(KerberosPrincipal principal) 指定した Kerberos 主体の新しい鍵を返します。
int	hashCode() この KeyTab のハッシュコードを返します。
String	toString() オブジェクトの文字列表現を返します。

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

メソッドの詳細

getInstance

public static KeyTab getInstance(File file)

File オブジェクトから KeyTab インスタンスを返します。

このメソッドの結果は null にはなりません。このメソッドは返された KeyTab オブジェクトをファイルに関連付けるだけで、読み込みは行いません。

パラメータ:

file - キータブ File オブジェクト (null 以外)。

戻り値:

キータブインスタンス

例外:

NullPointerException - file 引数が null の場合

getInstance

public static KeyTab getInstance()

デフォルトの KeyTab インスタンスを返します。

このメソッドの結果は null にはなりません。このメソッドは返された KeyTab オブジェクトをデフォルトのキータブファイルに関連付けるだけで、読み込みは行いません。

戻り値:

デフォルトのキータブインスタンス。

getKeys

public KerberosKey[] getKeys(KerberosPrincipal principal)

指定した Kerberos 主体の新しい鍵を返します。

このメソッドの実装では、戻り値の鍵がキータブファイルの最新の内容と一致していることを確認するようにしてください。新しく作成されたコピーが結果として得られ、これはキータブオブジェクトを変更することなく、呼び出し側から変更できます。呼び出し側は、結果として得られた鍵を使用したあと、それを破棄するべきです。

キータブファイルは、KeyTab オブジェクトのインスタンス化後に作成可能となり、その内容は時間とともに変わる可能性があります。したがって、アプリケーションは、鍵を使用する必要があるときのみ、このメソッドを呼び出すべきです。以前の呼び出しによる古い結果は期限切れになっている可能性があります。

KeyTab ファイルの読み取りプロセス中にエラー (I/O エラーやフォーマットエラーなど) が発生した場合は、保存されている結果を返すようにしてください。保存されている結果がない場合は (このメソッドを最初に呼び出した場合や以前の読み取りがすべて失敗した場合など) 、空の配列を返すようにしてください。これにより、時間のかかることが多いキータブファイルの更新中に結果が大きく変わることがなくなります。

このメソッドが呼び出され、例外 (入出力エラーやファイル形式エラー) が発生することなくファイルの読み込みに成功するたびに、結果が principal 用に保存されるようにしてください。場合によっては、同じキータブオブジェクト内に鍵が格納されているほかの主体用に鍵を保存することもできます。

キータブから読み込まれたサポートされていない鍵は無視され、結果には含められません。

パラメータ:

principal - Kerberos 主体 (null 以外)。

戻り値:

鍵 (空であってもよいが、Null は不可)

例外:

NullPointerException - principal 引数が null の場合

SecurityException - セキュリティーマネージャーが存在し、キータブファイルへの読み込みアクセスが許可されない場合

exists

public boolean exists()

キータブファイルが存在するかどうかをチェックします。このメソッドの実装では、結果がキータブファイルの最新の状態と一致していることを確認するようにしてください。

呼び出し側は、この結果を使用して、鍵を読み取るために別のメカニズムにフォールバックするべきかどうかを判断できます。

戻り値:

キータブファイルが存在する場合は true、それ以外の場合は false。

例外:

SecurityException - セキュリティーマネージャーが存在し、キータブファイルへの読み込みアクセスが許可されない場合

toString

public String toString()

次のクラスからコピーされた説明: Object

オブジェクトの文字列表現を返します。一般に、toString メソッドは、このオブジェクトを「テキストで表す」文字列を返します。この結果は、人間が読める簡潔で有益な情報であるべきです。すべてのサブクラスで、このメソッドをオーバーライドすることをお勧めします。

クラス Object の toString メソッドは、オブジェクトがインスタンスになっている元のクラスの名前、アットマーク文字「@」、およびオブジェクトのハッシュコードの符号なし 16 進数表現から構成される文字列を返します。つまり、このメソッドは次の値と等しい文字列を返します。

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

オーバーライド:

toString、クラス: Object

戻り値:

このオブジェクトの文字列表現。

hashCode

public int hashCode()

この KeyTab のハッシュコードを返します。

オーバーライド:

hashCode、クラス: Object

戻り値:

この KeyTab の hashCode()

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public boolean equals(Object other)

指定された Object とこの KeyTab を比較し、同等であるかどうかを調べます。指定されたオブジェクトが KeyTab であり、2 つの KeyTab インスタンスが等価である場合、true を返します。

オーバーライド:

equals、クラス: Object

パラメータ:

other - 比較対象の Object

戻り値:

指定されたオブジェクトがこの KeyTab インスタンスと等しい場合は true

関連項目:

Object.hashCode()、HashMap