compact3

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