クラスKeyGenerator

java.lang.Object

javax.crypto.KeyGenerator

public class KeyGenerator extends Object

このクラスは、秘密(対称)キー・ジェネレータの機能を提供します。

キー・ジェネレータは、このクラスのgetInstanceクラス・メソッドの1つを使用して構築されます。

KeyGeneratorオブジェクトは再利用可能です。つまり、キーの生成後、同じKeyGeneratorオブジェクトを再利用して、さらにキーを生成できます。

キーの生成方法には、アルゴリズ� 独立型とアルゴリズ� 固有型の2つがあります。 この2つの唯一の相違点は、オブジェクトの初期化にあります。

• アルゴリズ� に依存しない初期化

  すべてのキー・ジェネレータが、キー・サイズおよび乱数発生の元の概念を共有します。 このKeyGeneratorクラスには、これら2つの汎用共有型の引数を取るinitメソッドがあります。 また、keysize引数のみを取り、最も優先度の高いインストール済プロバイダのSecureRandom実装をランダ� 性のソース(または、インストールされているどのプロバイダもSecureRandom実装を提供していない� �合、システ� 提供のランダ� 性ソース)として使用し、ランダ� 性のソースのみを使用するプロバイダもあります。

  上記のアルゴリズ� に依存しないinitメソッドを呼び出した� �合、パラメータが指定されないため、それぞれのキーに関連したアルゴリズ� 固有のパラメータが存在する� �合、これをどのように扱うかはプロバイダに任されます。

• アルゴリズ� 固有の初期化

  アルゴリズ� 固有のパラメータのセットがすでに存在する状況では、AlgorithmParameterSpec引数を取る2つのinitメソッドが存在します。 このうち一方は引数にSecureRandomもとりますが、もう一方は、乱数発生の元として、もっとも高い優先� �位でインストールされているプロバイダのSecureRandomの実装を使用します(SecureRandomの実装を提供するプロバイダが1つもインストールされていない� �合は、システ� が提供する乱数発生の元を使用)。

クライアントがKeyGenerator (initメソッドへのコールを介して)を明示的に初期化しない� �合、各プロバイダは(とドキュメント)をデフォルトの初期化に指定する必要があります。 JDKプロバイダで使用されるKeyGeneratorのデフォルトの詳細は、「JDKプロバイダ」ドキュメントの「キー・サイズの制限」セクションを参照してく� さい。 た� し、デフォルトはプロバイダごとに異なる� �合があります。 また、プロバイダのデフォルト値は、将来のバージョンで変更される可能性があります。 そのため、プロバイダ固有のデフォルトに依存するかわりに、KeyGeneratorを明示的に初期化することをお薦めします。

Javaプラットフォー� の実装は、すべて次の標準のKeyGeneratorアルゴリズ� とカッコ内のキー・サイズをサポートする必要があります。

• AES (128)
• DESede (168)
• HmacSHA1
• HmacSHA256

これらのアルゴリズ� については、Javaセキュリティ標準アルゴリズ� 名仕様の「KeyGeneratorセクション」を参照してく� さい。 サポートされているその他のアルゴリズ� については、実装のリリース・ドキュメントを参照してく� さい。

導入されたバージョン:

1.4

関連� �目:

• SecretKey

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

コンストラクタ

修飾子	コンストラクタ	説明
protected	KeyGenerator(KeyGeneratorSpi keyGenSpi, Provider provider, String algorithm)	KeyGeneratorオブジェクトを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
final SecretKey	generateKey()	秘密キーを生成します。
final String	getAlgorithm()	このKeyGeneratorオブジェクトのアルゴリズ� 名を返します。
static final KeyGenerator	getInstance(String algorithm)	指定されたアルゴリズ� の秘密キーを生成するKeyGeneratorオブジェクトを返します。
static final KeyGenerator	getInstance(String algorithm, String provider)	指定されたアルゴリズ� の秘密キーを生成するKeyGeneratorオブジェクトを返します。
static final KeyGenerator	getInstance(String algorithm, Provider provider)	指定されたアルゴリズ� の秘密キーを生成するKeyGeneratorオブジェクトを返します。
final Provider	getProvider()	このKeyGeneratorオブジェクトのプロバイダを返します。
final void	init(int keysize)	このキー・ジェネレータを特定のキー・サイズに応じて初期化します。
final void	init(int keysize, SecureRandom random)	ユーザーが提供する乱数発生の元を使って、このキー・ジェネレータを特定のキー・サイズに応じて初期化します。
final void	init(SecureRandom random)	このキー・ジェネレータを初期化します。
final void	init(AlgorithmParameterSpec params)	このキー・ジェネレータを、指定されたパラメータ・セットを使って初期化します。
final void	init(AlgorithmParameterSpec params, SecureRandom random)	指定されたパラメータ・セットとユーザーが提供する乱数発生の元を使って、このキー・ジェネレータを初期化します。

クラスjava.lang.Objectで宣言されたメソッド

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

コンストラクタの詳細

KeyGenerator

protected KeyGenerator(KeyGeneratorSpi keyGenSpi, Provider provider, String algorithm)

KeyGeneratorオブジェクトを作成します。

パラメータ:

keyGenSpi - 委譲先

provider - プロバイダ

algorithm - アルゴリズ�

メソッドの詳細

getAlgorithm

public final String getAlgorithm()

このKeyGeneratorオブジェクトのアルゴリズ� 名を返します。

これは、このKeyGeneratorオブジェクトを作成したgetInstance呼出しのいずれかに指定された名前と同じです。

戻り値:

このKeyGeneratorオブジェクトのアルゴリズ� 名。

getInstance

public static final KeyGenerator getInstance(String algorithm) throws NoSuchAlgorithmException

指定されたアルゴリズ� の秘密キーを生成するKeyGeneratorオブジェクトを返します。

このメソッドは、最も優先されるプロバイダから始まる登録済セキュリティ・プロバイダのリストを横断します。 指定されたアルゴリズ� をサポートする最初のプロバイダからKeyGeneratorSpi実装をカプセル化する新しいKeyGeneratorオブジェクトが返されます。

登録済みプロバイダのリストは、Security.getProviders()メソッド経由で取得できます。

実装上のノート:

JDKリファレンス実装では、さらにjdk.security.provider.preferred Securityプロパティを使用して、指定したアルゴリズ� の優先プロバイダ� �序を決定します。 これは、Security.getProviders()によって返されるプロバイダの� �序とは異なる� �合があります。

パラメータ:

algorithm - 要求されたキー・アルゴリズ� の標準名。 標準アルゴリズ� 名の詳細は、「Javaセキュリティ標準アルゴリズ� 名仕様」のKeyGeneratorの� �を参照してく� さい。

戻り値:

新しいKeyGeneratorオブジェクト

スロー:

NoSuchAlgorithmException - Providerが、指定されたアルゴリズ� のKeyGeneratorSpi実装をサポートしていない� �合

NullPointerException - algorithmがnullである� �合

関連� �目:

• Provider

getInstance

public static final KeyGenerator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

指定されたアルゴリズ� の秘密キーを生成するKeyGeneratorオブジェクトを返します。

指定したプロバイダからKeyGeneratorSpi実装をカプセル化する新しいKeyGeneratorオブジェクトが返されます。 指定したプロバイダは、セキュリティ・プロバイダ・リストに登録する必要があります。

登録済みプロバイダのリストは、Security.getProviders()メソッド経由で取得できます。

パラメータ:

algorithm - 要求されたキー・アルゴリズ� の標準名。 標準アルゴリズ� 名の詳細は、「Javaセキュリティ標準アルゴリズ� 名仕様」のKeyGeneratorの� �を参照してく� さい。

provider - プロバイダ名。

戻り値:

新しいKeyGeneratorオブジェクト

スロー:

IllegalArgumentException - providerがnullまたは空の� �合

NoSuchAlgorithmException - 指定されたアルゴリズ� のKeyGeneratorSpi実装が、指定されたプロバイダから利用可能でない� �合

NoSuchProviderException - 指定されたプロバイダがセキュリティ・プロバイダ・リストに登録されていない� �合

NullPointerException - algorithmがnullである� �合

関連� �目:

• Provider

getInstance

public static final KeyGenerator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException

指定されたアルゴリズ� の秘密キーを生成するKeyGeneratorオブジェクトを返します。

指定されたプロバイダ・オブジェクトからKeyGeneratorSpi実装をカプセル化する新しいKeyGeneratorオブジェクトが返されます。 指定したプロバイダ・オブジェクトは、プロバイダ・リストに登録する必要はありません。

パラメータ:

algorithm - 要求されたキー・アルゴリズ� の標準名。 標準アルゴリズ� 名の詳細は、「Javaセキュリティ標準アルゴリズ� 名仕様」のKeyGeneratorの� �を参照してく� さい。

provider - プロバイダ

戻り値:

新しいKeyGeneratorオブジェクト

スロー:

IllegalArgumentException - providerがnullの� �合

NoSuchAlgorithmException - 指定されたアルゴリズ� のKeyGeneratorSpi実装が、指定されたProviderオブジェクトから使用できない� �合

NullPointerException - algorithmがnullである� �合

関連� �目:

• Provider

getProvider

public final Provider getProvider()

このKeyGeneratorオブジェクトのプロバイダを返します。

戻り値:

このKeyGeneratorオブジェクトのプロバイダ

init

public final void init(SecureRandom random)

このキー・ジェネレータを初期化します。

パラメータ:

random - このジェネレータの乱数発生の元

init

public final void init(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException

このキー・ジェネレータを、指定されたパラメータ・セットを使って初期化します。

このキー・ジェネレータが乱数バイトを必要とする� �合は、インストールされているプロバイダのうち、もっとも優先� �位の高いプロバイダのSecureRandomの実装を乱数発生の元として使用して乱数バイトを取得します。 (SecureRandomを提供するプロバイダが1つもインストールされていない� �合は、システ� が提供する乱数発生の元が使用されます。)

パラメータ:

params - キー・ジェネレータのパラメータ

スロー:

InvalidAlgorithmParameterException - 指定されたパラメータがこのキー・ジェネレータに不適切な� �合

init

public final void init(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException

指定されたパラメータ・セットとユーザーが提供する乱数発生の元を使って、このキー・ジェネレータを初期化します。

パラメータ:

params - キー・ジェネレータのパラメータ

random - このキー・ジェネレータの乱数発生の元

スロー:

InvalidAlgorithmParameterException - paramsがこのキー・ジェネレータに不適切な� �合

init

public final void init(int keysize)

このキー・ジェネレータを特定のキー・サイズに応じて初期化します。

このキー・ジェネレータが乱数バイトを必要とする� �合は、インストールされているプロバイダのうち、もっとも優先� �位の高いプロバイダのSecureRandomの実装を乱数発生の元として使用して乱数バイトを取得します。 (SecureRandomを提供するプロバイダが1つもインストールされていない� �合は、システ� が提供する乱数発生の元が使用されます。)

パラメータ:

keysize - キー・サイズ。 ビット長で指定されたアルゴリズ� 固有のメトリックス

スロー:

InvalidParameterException - キー・サイズが間違っているか、サポートされていない� �合。

init

public final void init(int keysize, SecureRandom random)

ユーザーが提供する乱数発生の元を使って、このキー・ジェネレータを特定のキー・サイズに応じて初期化します。

パラメータ:

keysize - キー・サイズ。 ビット長で指定されたアルゴリズ� 固有のメトリックス

random - このキー・ジェネレータの乱数発生の元

スロー:

InvalidParameterException - キー・サイズが間違っているか、サポートされていない� �合。

generateKey

public final SecretKey generateKey()

秘密キーを生成します。

戻り値:

新しいキー