JavaTM 2 Platform
Standard Ed. 5.0

javax.crypto
类 KeyGenerator

java.lang.Object
  继承者 javax.crypto.KeyGenerator

public class KeyGenerator
extends Object

此类提供(对称)密钥生成器的功能。

密钥生成器是使用此类的某个 getInstance 类方法构造的。

KeyGenerator 对象可重复使用,也就是说,在生成密钥后,可以重复使用同一 KeyGenerator 对象来生成进一步的密钥。

生成密钥的方式有两种:与算法无关的方式,以及特定于算法的方式。两者之间的惟一不同是对象的初始化:

如果客户端没有显式地初始化 KeyGenerator(通过调用 init 方法),每个提供程序必须提供(和记录)默认初始化。

从以下版本开始:
1.4
另请参见:
SecretKey

构造方法摘要
protected KeyGenerator(KeyGeneratorSpi keyGenSpi, Provider provider, String algorithm)
          创建一个 KeyGenerator 对象。
 
方法摘要
 SecretKey generateKey()
          生成一个密钥。
 String getAlgorithm()
          返回此 KeyGenerator 对象的算法名称。
static KeyGenerator getInstance(String algorithm)
          为指定算法生成一个 KeyGenerator 对象。
static KeyGenerator getInstance(String algorithm, Provider provider)
          为来自指定提供程序的指定密钥算法生成一个 KeyGenerator 对象。
static KeyGenerator getInstance(String algorithm, String provider)
          为来自指定提供程序的指定密钥算法生成一个 KeyGenerator 对象。
 Provider getProvider()
          返回此 KeyGenerator 对象的提供程序。
 void init(AlgorithmParameterSpec params)
          用指定参数集初始化此密钥生成器。
 void init(AlgorithmParameterSpec params, SecureRandom random)
          用指定参数集和用户提供的随机源初始化此密钥生成器。
 void init(int keysize)
          初始化此密钥生成器,使其具有确定的密钥长度。
 void init(int keysize, SecureRandom random)
          使用用户提供的随机源初始化此密钥生成器,使其具有确定的密钥长度。
 void init(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 对象。如果默认提供程序包提供所请求密钥生成器的实现,则返回包含该实现的 KeyGenerator 实例。如果默认提供程序包中不存在请求的密钥生成器,则搜索其他提供程序包。

参数:
algorithm - 所请求的密钥算法的标准名称。有关标准算法名称的信息,请参阅 Java Cryptography Extension Reference Guide 中的附录 A。
返回:
新的 KeyGenerator 对象
抛出:
NullPointerException - 如果指定算法为 null。
NoSuchAlgorithmException - 如果默认提供程序包或搜索到的任何其他提供程序包中不存在指定算法的密钥生成器。

getInstance

public static final KeyGenerator getInstance(String algorithm,
                                             String provider)
                                      throws NoSuchAlgorithmException,
                                             NoSuchProviderException
为来自指定提供程序的指定密钥算法生成一个 KeyGenerator 对象。

参数:
algorithm - 请求的密钥算法的标准名称。有关标准算法名称的信息,请参阅 Java Cryptography Extension Reference Guide 中的附录 A。
provider - 提供程序的名称
返回:
新的 KeyGenerator 对象
抛出:
NullPointerException - 如果指定算法为 null。
NoSuchAlgorithmException - 如果指定算法的密钥生成器在指定的提供程序中不可用。
NoSuchProviderException - 如果尚未配置指定的提供程序。
IllegalArgumentException - 如果该 provider 为 null。

getInstance

public static final KeyGenerator getInstance(String algorithm,
                                             Provider provider)
                                      throws NoSuchAlgorithmException
为来自指定提供程序的指定密钥算法生成一个 KeyGenerator 对象。注:该 provider 不必注册。

参数:
algorithm - 请求的密钥算法的标准名称。有关标准算法名称的信息,请参阅 Java Cryptography Extension Reference Guide 中的附录 A。
provider - 提供程序
返回:
新的 KeyGenerator 对象
抛出:
NullPointerException - 如果指定算法为 null。
NoSuchAlgorithmException - 如果指定算法的密钥生成器在指定的提供程序中不可用。
IllegalArgumentException - 如果该 provider 为 null。

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 的实现,则将使用系统提供的随机源。)

参数:
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 的实现,则将使用系统提供的随机源。)

参数:
keysize - 密钥长度。这是特定于算法的一种规格,是按位数指定的。
抛出:
InvalidParameterException - 如果密钥长度错误或不受支持。

init

public final void init(int keysize,
                       SecureRandom random)
使用用户提供的随机源初始化此密钥生成器,使其具有确定的密钥长度。

参数:
keysize - 密钥长度。这是特定于算法的一种规格,是按位数指定的。
random - 此密钥生成器的随机源
抛出:
InvalidParameterException - 如果密钥长度错误或不受支持。

generateKey

public final SecretKey generateKey()
生成一个密钥。

返回:
新的密钥

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策