javax.crypto
类 Cipher

java.lang.Object
  javax.crypto.Cipher

直接已知子类：

NullCipher

public class Cipher
     

      extends 
      Object
     

此类为加密和解密提供密码功能。它构成了 Java Cryptographic Extension (JCE) 框架的核心。

为创建 Cipher 对象，应用程序调用 Cipher 的 getInstance 方法并将所请求转换 的名称传递给它。还可以指定提供者的名称（可选）。

转换 是一个字符串，它描述为产生某种输出而在给定的输入上执行的操作（或一组操作）。转换始终包括加密算法的名称（例如，DES），后面可能跟有一个反馈模式和填充方案。

转换具有以下形式：

• “算法/模式/填充”或

• “算法”

（后一种情况下，使用模式和填充方案特定于提供者的默认值）。例如，以下是有效的转换：

     Cipher c = Cipher.getInstance("DES/CBC/PKCS5Padding");
 

从以下版本开始：

1.4

另请参见：

KeyGenerator, SecretKey

ENCRYPT_MODE

public static final int ENCRYPT_MODE

用于将 Cipher 初始化为加密模式的常量。

另请参见：

常量字段值

DECRYPT_MODE

public static final int DECRYPT_MODE

用于将 Cipher 初始化为解密模式的常量。

另请参见：

常量字段值

WRAP_MODE

public static final int WRAP_MODE

用于将 Cipher 初始化为密钥包装模式的常量。

另请参见：

常量字段值

UNWRAP_MODE

public static final int UNWRAP_MODE

用于将 Cipher 初始化为密钥解包模式的常量。

另请参见：

常量字段值

PUBLIC_KEY

public static final int PUBLIC_KEY

用于表示要解包的密钥为“公钥”的常量。

另请参见：

常量字段值

PRIVATE_KEY

public static final int PRIVATE_KEY

用于表示要解包的密钥为“私钥”的常量。

另请参见：

常量字段值

SECRET_KEY

public static final int SECRET_KEY

用于表示要解包的密钥为“秘密密钥”的常量。

另请参见：

常量字段值

Cipher

protected Cipher(CipherSpi cipherSpi,
                 Provider provider,
                 String transformation)

创建 Cipher 对象。

参数：

cipherSpi - 代理

provider - 提供者

transformation - 转换

getInstance

public static final Cipher getInstance(String transformation)
                                throws NoSuchAlgorithmException,
                                       NoSuchPaddingException

返回实现指定转换的 Cipher 对象。

此方法从首选 Provider 开始遍历已注册安全提供者列表。返回一个封装 CipherSpi 实现的新 Cipher 对象，该实现取自支持指定算法的第一个 Provider。

注意，可以通过 Security.getProviders() 方法获取已注册提供者列表。

参数：

transformation - 转换的名称，例如 DES/CBC/PKCS5Padding。有关标准转换名称的信息，请参见 Java Cryptography Architecture Reference Guide 的附录 A。

返回：

实现所请求转换的 Cipher。

抛出：

NoSuchAlgorithmException - 如果 transformation 为 null、空、无效格式，或者没有 Provider 支持指定算法的 CipherSpi 实现。

NoSuchPaddingException - 如果 transformation 包含的填充方案不可用。

另请参见：

Provider

getInstance

public static final Cipher getInstance(String transformation,
                                       String provider)
                                throws NoSuchAlgorithmException,
                                       NoSuchProviderException,
                                       NoSuchPaddingException

返回实现指定转换的 Cipher 对象。

返回一个封装 CipherSpi 实现的新 Cipher 对象，该实现取自指定提供者。指定提供者必须在安全提供者列表中注册。

注意，可以通过 Security.getProviders() 方法获取已注册提供者列表。

参数：

transformation - 转换的名称，例如 DES/CBC/PKCS5Padding。有关标准转换名称的信息，请参见 Java Cryptography Architecture Reference Guide 的附录 A。

provider - 提供者的名称。

返回：

实现所请求转换的 Cipher。

抛出：

NoSuchAlgorithmException - 如果 transformation 为 null、空、无效格式，或者不能从指定提供者获得指定算法的 CipherSpi 实现。

NoSuchProviderException - 如果指定提供者未在安全提供者列表中注册。

NoSuchPaddingException - 如果 transformation 包含的填充方案不可用。

IllegalArgumentException - 如果 provider 为 null 或空。

另请参见：

Provider

getInstance

public static final Cipher getInstance(String transformation,
                                       Provider provider)
                                throws NoSuchAlgorithmException,
                                       NoSuchPaddingException

返回实现指定转换的 Cipher 对象。

返回一个封装 CipherSpi 实现的新 Cipher 对象，该实现取自指定的 Provider 对象。 注意，指定的 Provider 对象无需在提供者列表中注册。

参数：

transformation - 转换的名称，例如 DES/CBC/PKCS5Padding。有关标准转换名称的信息，请参见 Java Cryptography Architecture Reference Guide 的附录 A。

provider - 提供者。

返回：

实现所请求转换的 Cipher。

抛出：

NoSuchAlgorithmException - 如果 transformation 为 null、空、无效格式，或者不能从指定 Provider 对象获得指定算法的 CipherSpi 实现。

NoSuchPaddingException - 如果 transformation 包含的填充方案不可用。

IllegalArgumentException - 如果 provider 为 null。

另请参见：

Provider

getProvider

public final Provider getProvider()

返回此 Cipher 对象的提供者。

返回：

此 Cipher 对象的提供者

getAlgorithm

public final String getAlgorithm()

返回此 Cipher 对象的算法名称。

这与创建此 Cipher 对象的 getInstance 调用之一指定的名称相同。

返回：

此 Cipher 对象的算法名称。

getBlockSize

public final int getBlockSize()

返回块的大小（以字节为单位）。

返回：

块的大小（以字节为单位）；如果底层算法不是 Cipher 块，则返回 0

getOutputSize

public final int getOutputSize(int inputLen)

根据给定的输入长度 inputLen（以字节为单位），返回保存下一个 update 或 doFinal 操作结果所需的输出缓冲区长度（以字节为单位）。

此调用还考虑到任何取自上一个 update 调用的未处理（已缓存）数据和填充。

下一个 update 或 doFinal 调用的实际输出长度可能小于此方法返回的长度。

参数：

inputLen - 输入长度（以字节为单位）

返回：

所需的输出缓冲区大小（以字节为单位）

抛出：

IllegalStateException - 如果此 Cipher 处于错误的状态（例如，尚未初始化）

getIV

public final byte[] getIV()

返回新缓冲区中的初始化向量 (IV)。

在创建随机 IV 的情况下，或者在基于密码加密或解密的上下文中（其中，IV 派生自用户提供的密码）此方法很有用。

返回：

新缓冲区中的初始化向量；如果底层算法不使用 IV，或者 IV 尚未设置，则返回 null。

getParameters

public final AlgorithmParameters getParameters()

返回此 Cipher 使用的参数。

返回的参数可能与初始化此 Cipher 所使用的参数相同；如果此 Cipher 需要算法参数但却未使用任何参数进行初始化，则返回的参数将由默认值和底层 Cipher 实现所使用的随机参数值组成。

返回：

此 Cipher 使用的参数；如果此 Cipher 不使用任何参数，则返回 null。

getExemptionMechanism

public final ExemptionMechanism getExemptionMechanism()

返回此 Cipher 使用的豁免 (exemption) 机制对象。

返回：

此 Cipher 使用的豁免机制对象，如果此 Cipher 不使用任何豁免机制，则返回 null。

init

public final void init(int opmode,
                       Key key)
                throws InvalidKeyException

用密钥初始化此 Cipher。

为以下 4 种操作之一初始化该 Cipher：加密、解密、密钥包装或密钥解包，具体取决于 opmode 的值。

如果此 Cipher 需要任何无法从给定 key 派生的算法参数，则在为加密或密钥包装初始化时，底层 Cipher 实现应自己生成所需的参数（使用特定于提供者的默认值或随机值）；在为解密或密钥解包初始化时，将引发 InvalidKeyException。可以用 getParameters 或 getIV 获取生成的参数（如果该参数为 IV）。

如果此 Cipher（包括其底层反馈或填充方案）需要随机字节（例如，用于参数生成），那么它将使用具有最高优先级的已安装提供者的 SecureRandom 实现作为随机源获取这些字节。（如果已安装的提供者都不提供 SecureRandom 实现，则将使用系统提供的随机源）。

注意，初始化 Cipher 对象时，它将失去所有以前获得的状态。换句话说，初始化 Cipher 相当于创建该 Cipher 的一个新实例并将其初始化。

参数：

opmode - 此 Cipher 的操作模式（为以下之一： ENCRYPT_MODE、 DECRYPT_MODE、 WRAP_MODE 或 UNWRAP_MODE）

key - 密钥

抛出：

InvalidKeyException - 如果给定的 key 不适合初始化此 Cipher；如果此 Cipher 为解密初始化，并且所需算法参数无法从给定的 key 确定；如果给定 key 的键大小超出所允许的最大值（由已配置的仲裁策略文件确定）。

init

public final void init(int opmode,
                       Key key,
                       SecureRandom random)
                throws InvalidKeyException

用密钥和随机源初始化此 Cipher。

为以下 4 种操作之一初始化该 Cipher：加密、解密、密钥包装或密钥解包，具体取决于 opmode 的值。

如果此 Cipher 需要算法参数，而参数无法从给定的 key 派生，则在为加密或密钥包装初始化时，底层 Cipher 实现应自己生成所需的参数（使用特定于提供者的默认值或随机值）；在为解密或密钥解包初始化时，将引发 InvalidKeyException。可以用 getParameters 或 getIV 获取生成的参数（如果该参数为 IV）。

如果此 Cipher（包括其底层反馈或填充方案）需要随机字节（例如，用于参数生成），那么它将从 random 获取这些随机字节。

注意，初始化 Cipher 对象时，它将失去所有以前获得的状态。换句话说，初始化 Cipher 相当于创建该 Cipher 的一个新实例并将其初始化。

参数：

opmode - 此 Cipher 的操作模式（为以下之一： ENCRYPT_MODE、 DECRYPT_MODE、 WRAP_MODE 或 UNWRAP_MODE）

key - 加密密钥

random - 随机源

抛出：

InvalidKeyException - 如果给定的 key 不适合初始化此 Cipher；如果此 Cipher 为解密初始化，并且所需算法参数无法从给定的 key 确定；如果给定 key 的键大小超出所允许的最大值（由已配置的仲裁策略文件确定）。

init

public final void init(int opmode,
                       Key key,
                       AlgorithmParameterSpec params)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException

用密钥和一组算法参数初始化此 Cipher。

为以下 4 种操作之一初始化该 Cipher：加密、解密、密钥包装或密钥解包，具体取决于 opmode 的值。

如果此 Cipher 需要算法参数，而 params 为 null，则在为加密或密钥包装初始化时，底层 Cipher 实现应自己生成所需的参数（使用特定于提供者的默认值或随机值）；在为解密或密钥解包初始化时，将引发 InvalidAlgorithmParameterException。可以用 getParameters 或 getIV 获取生成的参数（如果该参数为 IV）。

如果此 Cipher（包括其底层反馈或填充方案）需要随机字节（例如，用于参数生成），那么它将使用具有最高优先级的已安装提供者的 SecureRandom 实现作为随机源来获取这些字节。（如果已安装的提供者都不提供 SecureRandom 实现，则将使用系统提供的随机源）。

注意，初始化 Cipher 对象时，它将失去所有以前获得的状态。换句话说，初始化 Cipher 相当于创建该 Cipher 的一个新实例并将其初始化。

参数：

opmode - 此 Cipher 的操作模式（为以下之一： ENCRYPT_MODE、 DECRYPT_MODE、 WRAP_MODE 或 UNWRAP_MODE）

key - 加密密钥

params - 算法参数

抛出：

InvalidKeyException - 如果给定的 key 不适合初始化此 Cipher，或其它的键大小超出所允许的最大（由已配置的仲裁策略文件确定）。

InvalidAlgorithmParameterException - 如果给定的算法参数不适合此 Cipher；此 Cipher 为解密初始化，并且需要算法参数而 params 为 null；给定的算法参数所含的加密强度超出了合法限制（由已配置的仲裁策略文件确定）。

init

public final void init(int opmode,
                       Key key,
                       AlgorithmParameterSpec params,
                       SecureRandom random)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException

用一个密钥、一组算法参数和一个随机源初始化此 Cipher。

为以下 4 种操作之一初始化该 Cipher：加密、解密、密钥包装或密钥解包，具体取决于 opmode 的值。

如果此 Cipher 需要算法参数，而 params 为 null，则在为加密或密钥包装初始化时，底层 Cipher 实现应自己生成所需的参数（使用特定于提供者的默认值或随机值）；在为解密或密钥解包初始化时，将引发 InvalidAlgorithmParameterException。可以用 getParameters 或 getIV 获取生成的参数（如果该参数为 IV）。

如果此 Cipher（包括其底层反馈或填充方案）需要随机字节（例如，用于参数生成），那么它将从 random 获取这些随机字节。

注意，初始化 Cipher 对象时，它将失去所有以前获得的状态。换句话说，初始化 Cipher 相当于创建该 Cipher 的一个新实例并将其初始化。

参数：

opmode - 此 Cipher 的操作模式（为以下之一： ENCRYPT_MODE、 DECRYPT_MODE、 WRAP_MODE 或 UNWRAP_MODE）

key - 加密密钥

params - 算法参数

random - 随机源

抛出：

InvalidKeyException - 如果给定的 key 不适合初始化此 Cipher，或其键大小超出所允许的最大值（由已配置的仲裁策略文件确定）。

InvalidAlgorithmParameterException - 如果给定的算法参数不适合此 Cipher；此 Cipher 为解密初始化，并且需要算法参数而 params 为 null；给定的算法参数所含的加密强度超出了合法限制（由已配置的仲裁策略文件确定）。

init

public final void init(int opmode,
                       Key key,
                       AlgorithmParameters params)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException

用密钥和一组算法参数初始化此 Cipher。

为以下 4 种操作之一初始化该 Cipher：加密、解密、密钥包装或密钥解包，具体取决于 opmode 的值。

如果此 Cipher 需要算法参数，而 params 为 null，则在为加密或密钥包装初始化时，底层 Cipher 实现应自己生成所需的参数（使用特定于提供者的默认值或随机值）；在初始化为解密或密钥解包时，将引发 InvalidAlgorithmParameterException。可以用 getParameters 或 getIV 获取生成的参数（如果该参数为 IV）。

如果此 Cipher（包括其底层反馈或填充方案）需要随机字节（例如，用于参数生成），那么它将使用具有最高优先级的已安装提供者的 SecureRandom 实现作为随机源来获取这些字节。（如果已安装的提供者都不提供 SecureRandom 实现，则将使用系统提供的随机源）。

注意，初始化 Cipher 对象时，它将失去所有以前获得的状态。换句话说，初始化 Cipher 相当于创建该 Cipher 的一个新实例并将其初始化。

参数：

opmode - 此 Cipher 的操作模式（为以下之一： ENCRYPT_MODE、 DECRYPT_MODE、 WRAP_MODE 或 UNWRAP_MODE）

key - 加密密钥

params - 算法参数

抛出：

InvalidKeyException - 如果给定的 key 不适合初始化此 Cipher，或其键大小超出所允许的最大值（由已配置的仲裁策略文件确定）。

InvalidAlgorithmParameterException - 如果给定的算法参数不适合此 Cipher；此 Cipher 为解密初始化，并且需要算法参数而 params 为 null；给定的算法参数所含的加密强度超出了合法限制（由已配置的仲裁策略文件确定）。

init

public final void init(int opmode,
                       Key key,
                       AlgorithmParameters params,
                       SecureRandom random)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException

用一个密钥、一组算法参数和一个随机源初始化此 Cipher。

为以下 4 种操作之一初始化该 Cipher：加密、解密、密钥包装或密钥解包，具体取决于 opmode 的值。

如果此 Cipher 需要算法参数，而 params 为 null，则在为加密或密钥包装初始化时，底层 Cipher 实现应自己生成所需的参数（使用特定于提供者的默认值或随机值）；在为解密或密钥解包初始化时，将引发 InvalidAlgorithmParameterException。可以用 getParameters 或 getIV 获取生成的参数（如果该参数为 IV）。

如果此 Cipher（包括其底层反馈或填充方案）需要随机字节（例如，用于参数生成），那么它将从 random 获取这些随机字节。

注意，初始化 Cipher 对象时，它将失去所有以前获得的状态。换句话说，初始化 Cipher 相当于创建该 Cipher 的一个新实例并将其初始化。

参数：

opmode - 此 Cipher 的操作模式（为以下之一： ENCRYPT_MODE、 DECRYPT_MODE、 WRAP_MODE 或 UNWRAP_MODE）

key - 加密密钥

params - 算法参数

random - 随机源

抛出：

InvalidKeyException - 如果给定的 key 不适合初始化此 Cipher，或其键大小超出所允许的最大值（由已配置的仲裁策略文件确定）。

InvalidAlgorithmParameterException - 如果给定的算法参数不适合此 Cipher；此 Cipher 为解密初始化，并且需要算法参数而 params 为 null；给定的算法参数所含的加密强度超出了合法限制（由已配置的仲裁策略文件确定）。

init

public final void init(int opmode,
                       Certificate certificate)
                throws InvalidKeyException

用取自给定证书的公钥初始化此 Cipher。

为以下 4 种操作之一初始化该 Cipher：加密、解密、密钥包装或密钥解包，具体取决于 opmode 的值。

如果证书类型为 X.509 并有一个标记为关键的 key usage 扩展字段，且此 key usage 扩展字段的值表示在 opmode 值所代