javax.crypto.spec

クラス PBEKeySpec

java.lang.Object

javax.crypto.spec.PBEKeySpec

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

KeySpec

public class PBEKeySpec
extends Object
implements KeySpec

パスワードベースの暗号化 (PBE) で使用できる、ユーザーが選択したパスワードです。

パスワードは一種の生の鍵データと見なすことができます。パスワードを使用する暗号化メカニズムは、鍵データから暗号化鍵を派生します。

PBE メカニズムが異なると、各パスワード文字のビット数も異なる場合があります。たとえば、PKCS #5 で定義されている PBE メカニズムは、各文字の下位 8 ビットだけを使用し、PKCS #12 では、各文字の 16 ビットすべてを使用します。

該当する秘密鍵ファクトリのインスタンスを生成して、パスワード文字を PBE 鍵に変換します。たとえば、PKCS #5 の秘密鍵ファクトリは各パスワード文字の下位 8 ビットだけから PBE 鍵を構築し、PKCS #12 の秘密鍵ファクトリは各文字の 16 ビットすべてをとります。

また、このクラスは、パスワードを String オブジェクト (これの方が論理的に思えるかもしれない) ではなく char 配列として格納します。これは、String クラスは変更不可能なので、格納されているパスワードが必要なくなったときに内部値を上書きする方法がないためです。つまり、このクラスは、パスワードを char 配列として要求するので、完了時に上書きできます。

導入されたバージョン:

1.4

関連項目:

SecretKeyFactory, PBEParameterSpec

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

コンストラクタ

コンストラクタと説明
PBEKeySpec(char[] password) パスワードをとるコンストラクタです。
PBEKeySpec(char[] password, byte[] salt, int iterationCount) パスワード、ソルト、および固定鍵サイズの PBE 暗号の PBEKey を生成するための繰り返し数をとるコンストラクタです。
PBEKeySpec(char[] password, byte[] salt, int iterationCount, int keyLength) パスワード、ソルト、繰り返し数、および可変鍵サイズの PBE 暗号の PBEKey を生成するために派生される鍵の長さをとるコンストラクタです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	clearPassword() パスワードの内部コピーを消去します。
int	getIterationCount() 繰り返し処理の回数を返します。指定がない場合は 0 を返します。
int	getKeyLength() 派生される鍵の長さを返します。指定がない場合は 0 を返します。
char[]	getPassword() パスワードのコピーを返します。
byte[]	getSalt() salt のコピーを返します。指定がない場合は null を返します。

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

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

コンストラクタの詳細

PBEKeySpec

public PBEKeySpec(char[] password)

パスワードをとるコンストラクタです。null が指定された場合は、空の char[] が使用されます。

注:password は、複製されてから新しい PBEKeySpec オブジェクトに格納されます。

パラメータ:

password - パスワード。

PBEKeySpec

public PBEKeySpec(char[] password,
          byte[] salt,
          int iterationCount,
          int keyLength)

パスワード、ソルト、繰り返し数、および可変鍵サイズの PBE 暗号の PBEKey を生成するために派生される鍵の長さをとるコンストラクタです。password に null が指定された場合は、空の char[] が使用されます。

注:password および salt は、複製されてから新しい PBEKeySpec オブジェクトに格納されます。

パラメータ:

password - パスワード。

salt - ソルト。

iterationCount - 反復数。

keyLength - 派生される鍵の長さ。

例外:

NullPointerException - salt が null である場合。

IllegalArgumentException - salt が空、つまり長さ 0 である場合、iterationCount または keyLength が正でない場合。

PBEKeySpec

public PBEKeySpec(char[] password,
          byte[] salt,
          int iterationCount)

パスワード、ソルト、および固定鍵サイズの PBE 暗号の PBEKey を生成するための繰り返し数をとるコンストラクタです。password に null が指定された場合は、空の char[] が使用されます。

注:password および salt は、複製されてから新しい PBEKeySpec オブジェクトに格納されます。

パラメータ:

password - パスワード。

salt - ソルト。

iterationCount - 反復数。

例外:

NullPointerException - salt が null である場合。

IllegalArgumentException - salt が空、つまり長さ 0 である場合、または iterationCount が正でない場合。

メソッドの詳細

clearPassword

public final void clearPassword()

パスワードの内部コピーを消去します。

getPassword

public final char[] getPassword()

パスワードのコピーを返します。

注:このメソッドは、パスワードのコピーを返します。不要になったパスワード情報をゼロにする (消去する) のは、呼び出し元の責任です。

戻り値:

パスワード

例外:

IllegalStateException - clearPassword メソッドを呼び出してパスワードがクリアされた場合。

getSalt

public final byte[] getSalt()

salt のコピーを返します。指定がない場合は null を返します。

注:このメソッドは、ソルトのコピーを返します。不要になったソルト情報をゼロにする (消去する) のは、呼び出し側の責任です。

戻り値:

ソルト

getIterationCount

public final int getIterationCount()

繰り返し処理の回数を返します。指定がない場合は 0 を返します。

戻り値:

繰り返し数

getKeyLength

public final int getKeyLength()

派生される鍵の長さを返します。指定がない場合は 0 を返します。

注:これは、可変鍵サイズ暗号の鍵の長さの設定を示すのに使用されます。実際の鍵サイズは各プロバイダの実装によって異なります。

戻り値:

派生される鍵の長さ