javax.security.auth.kerberos

クラス KerberosKey

java.lang.Object

javax.security.auth.kerberos.KerberosKey

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

Serializable, Key, SecretKey, Destroyable

public class KerberosKey
extends Object
implements SecretKey, Destroyable

このクラスでは、Kerberos 主体の長期の秘密鍵をカプセル化します。

主体のパスワードを取得して秘密鍵を生成するすべての Kerberos JAAS ログインモジュールでは、このクラスを使用するようにしてください。ユーザー対ユーザー認証なしでサーバーを認証する場合などに、ログインモジュールは、認証プロセスのコミットフェーズ中に、このクラスのインスタンスを Subject の非公開資格セットに格納することがあります。

キータブを使用して秘密鍵を読み込む Kerberos サービスでは、KeyTab クラスを使用するようにしてください。このクラスでは、必要に応じて最新の鍵が読み込まれます。

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

導入されたバージョン:

1.4

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
KerberosKey(KerberosPrincipal principal, byte[] keyBytes, int keyType, int versionNum) 鍵タイプと鍵のバージョン番号が判明している場合、指定されたバイトで KerberosKey を構築します。
KerberosKey(KerberosPrincipal principal, char[] password, String algorithm) 主体のパスワードから KerberosKey を構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	destroy() この鍵を破棄します。
boolean	equals(Object other) 指定された Object がこの KerberosKey と等しいかどうか比較します。
String	getAlgorithm() この鍵に対する標準アルゴリズムを返します。
byte[]	getEncoded() この秘密鍵の鍵データを返します。
String	getFormat() この秘密鍵のエンコード形式の名前を返します。
int	getKeyType() この長期鍵の鍵タイプを返します。
KerberosPrincipal	getPrincipal() この鍵が属する主体を返します。
int	getVersionNumber() 鍵のバージョン番号を返します。
int	hashCode() この KerberosKey のハッシュコードを返します。
boolean	isDestroyed() この鍵が破棄されたかどうかを判定します。
String	toString() オブジェクトの文字列表現を返します。

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

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

コンストラクタの詳細

KerberosKey

public KerberosKey(KerberosPrincipal principal,
           byte[] keyBytes,
           int keyType,
           int versionNum)

鍵タイプと鍵のバージョン番号が判明している場合、指定されたバイトで KerberosKey を構築します。秘密鍵の情報が Kerberos の「キータブ」から読み取れるときに使用できます。

パラメータ:

principal - この秘密鍵が属する主体

keyBytes - 秘密鍵の raw バイト

keyType - Kerberos プロトコル仕様で定義された、秘密鍵の鍵タイプ。

versionNum - この秘密鍵のバージョン番号

KerberosKey

public KerberosKey(KerberosPrincipal principal,
           char[] password,
           String algorithm)

主体のパスワードから KerberosKey を構築します。

パラメータ:

principal - このパスワードが属する主体

password - 鍵を計算するのに使用されるパスワード

algorithm - この鍵が使用されるアルゴリズムの名前。このパラメータは、デフォルトのアルゴリズム (DES) を使用する場合は null でも可。

例外:

IllegalArgumentException - 渡されたアルゴリズム名がサポートされていない場合。

メソッドの詳細

getPrincipal

public final KerberosPrincipal getPrincipal()

この鍵が属する主体を返します。

戻り値:

この鍵が属する主体。

getVersionNumber

public final int getVersionNumber()

鍵のバージョン番号を返します。

戻り値:

鍵のバージョン番号。

getKeyType

public final int getKeyType()

この長期鍵の鍵タイプを返します。

戻り値:

鍵タイプ。

getAlgorithm

public final String getAlgorithm()

この鍵に対する標準アルゴリズムを返します。たとえば、「DES」はこの鍵が DES 鍵であることを示します。標準のアルゴリズム名については、「Java 暗号化アーキテクチャー API の仕様およびリファレンス」の「付録 A」を参照してください。

定義:

getAlgorithm、インタフェース: Key

戻り値:

この鍵に関連したアルゴリズムの名前。

getFormat

public final String getFormat()

この秘密鍵のエンコード形式の名前を返します。

定義:

getFormat、インタフェース: Key

戻り値:

String "RAW"

getEncoded

public final byte[] getEncoded()

この秘密鍵の鍵データを返します。

定義:

getEncoded、インタフェース: Key

戻り値:

鍵データ

destroy

public void destroy()
             throws DestroyFailedException

この鍵を破棄します。このあとで、そのほかの任意のメソッドを呼び出すと、IllegalStateException がスローされる原因になります。

定義:

destroy、インタフェース: Destroyable

例外:

DestroyFailedException - この鍵の破棄中にエラーが起きた場合。

isDestroyed

public boolean isDestroyed()

この鍵が破棄されたかどうかを判定します。

定義:

isDestroyed、インタフェース: Destroyable

戻り値:

この Object が破棄された場合は true、そうでない場合は false。

toString

public String toString()

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

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

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

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

オーバーライド:

toString、クラス: Object

戻り値:

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

hashCode

public int hashCode()

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

オーバーライド:

hashCode、クラス: Object

戻り値:

この KerberosKey の hashCode()

導入されたバージョン:

1.6

関連項目:

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

equals

public boolean equals(Object other)

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

オーバーライド:

equals、クラス: Object

パラメータ:

other - 比較対象の Object

戻り値:

指定されたオブジェクトがこの KerberosKey と等しい場合は true、そうでない場合は false。注:どちらかの KerberosKey オブジェクトが破棄された場合は false を返す。

導入されたバージョン:

1.6

関連項目:

Object.hashCode()、HashMap