Cipher

DECRYPT_MODE

int DECRYPT_MODE

常用于将密码初始化为解密模式。

常量值：2（0x00000002）

ENCRYPT_MODE

int ENCRYPT_MODE

常用于将密码初始化为加密模式。

常数值：1（0x00000001）

PRIVATE_KEY

int PRIVATE_KEY

用于指示待解包密钥的常量是“私钥”。

常量值：2（0x00000002）

PUBLIC_KEY

int PUBLIC_KEY

用于指示待解包密钥的常量是“公钥”。

常数值：1（0x00000001）

SECRET_KEY

int SECRET_KEY

用于指示待解包密钥的常量是“密钥”。

常量值：3（0x00000003）

UNWRAP_MODE

int UNWRAP_MODE

常量用于将密码初始化为密钥解开模式。

常量值：4（0x00000004）

WRAP_MODE

int WRAP_MODE

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

常量值：3（0x00000003）

Cipher

Cipher (CipherSpi cipherSpi, 
                Provider provider, 
                String transformation)

创建一个密码对象。

doFinal

int doFinal (byte[] input, 
                int inputOffset, 
                int inputLen, 
                byte[] output)

在单部分操作中加密或解密数据，或完成多部分操作。 数据被加密或解密，取决于这个密码是如何初始化的。

第一inputLen字节在input缓冲区中，从inputOffset以下，并且可能在上一次期间已缓存的任何输入字节update操作，进行处理，填充（如果要求）被施加。 如果使用诸如GCM / CCM的AEAD模式，则在加密的情况下附加认证标签，或者在解密的情况下验证。 结果存储在output缓冲区中。

如果output缓冲区太小而无法保留结果， ShortBufferException抛出ShortBufferException 。 在这种情况下，使用更大的输出缓冲区重复此调用。 使用getOutputSize来确定输出缓冲区应该有多大。

完成后，此方法将此密码对象重置为之前通过调用init初始化时的状态。 也就是说，该对象被重置并可用于加密或解密（取决于调用init时指定的操作模式）更多数据。

注意：如果抛出任何异常，则可能需要重置此密码对象才能再次使用它。

注意：此方法应该是复制安全的，这意味着 input和 output缓冲区可以引用相同的字节数组，并且在结果复制到输出缓冲区时不会覆盖未处理的输入数据。

doFinal

int doFinal (byte[] output, 
                int outputOffset)

完成多部分加密或解密操作，具体取决于此密码的初始化方式。

处理前一个update操作期间可能已缓冲的输入数据，并应用填充（如果请求）。 如果使用诸如GCM / CCM的AEAD模式，则在加密的情况下附加认证标签，或者在解密的情况下验证。 结果存储在output缓冲区中，从outputOffset开始。

如果output缓冲区太小而无法保存结果， ShortBufferException抛出ShortBufferException 。 在这种情况下，使用更大的输出缓冲区重复此调用。 使用getOutputSize来确定输出缓冲区应该有多大。

完成后，此方法将此密码对象重置为之前通过调用init初始化时的状态。 也就是说，该对象被重置并可用于加密或解密（取决于调用init时指定的操作模式）更多数据。

注意：如果抛出任何异常，则可能需要重置此密码对象才能再次使用它。

doFinal

byte[] doFinal ()

完成多部分加密或解密操作，具体取决于此密码的初始化方式。

处理前一个update操作期间可能已缓冲的输入数据，并应用填充（如果需要）。 如果使用诸如GCM / CCM的AEAD模式，则在加密的情况下附加认证标签，或者在解密的情况下验证。 结果存储在新的缓冲区中。

完成后，此方法将此密码对象重置为之前通过调用init初始化时的状态。 也就是说，该对象被重置并可用于加密或解密（取决于调用init时指定的操作模式）更多数据。

注意：如果抛出任何异常，则可能需要重置此密码对象才能再次使用它。

doFinal

byte[] doFinal (byte[] input)

在单部分操作中加密或解密数据，或完成多部分操作。 数据被加密或解密，取决于这个密码是如何初始化的。

处理input缓冲区中的字节以及可能在前一个update操作期间缓冲的任何输入字节，并应用填充（如果需要）。 如果使用诸如GCM / CCM的AEAD模式，则在加密的情况下附加认证标签，或者在解密的情况下验证。 结果存储在新的缓冲区中。

完成后，此方法将此密码对象重置为之前通过调用init初始化时的状态。 也就是说，该对象被重置并可用于加密或解密（取决于调用init时指定的操作模式）更多数据。

注意：如果抛出任何异常，则可能需要重置此密码对象才能再次使用它。

doFinal

int doFinal (byte[] input, 
                int inputOffset, 
                int inputLen, 
                byte[] output, 
                int outputOffset)

在单部分操作中加密或解密数据，或完成多部分操作。 数据被加密或解密，取决于这个密码是如何初始化的。

第一inputLen字节在input缓冲区中，从inputOffset以下，并且可能在上一次期间已缓存的任何输入字节update操作，进行处理，填充（如果要求）被施加。 如果使用诸如GCM / CCM的AEAD模式，则在加密的情况下附加认证标签，或者在解密的情况下验证。 结果存储在output缓冲区中，从outputOffset含）开始。

如果output缓冲区太小而无法保存结果， ShortBufferException抛出ShortBufferException 。 在这种情况下，使用更大的输出缓冲区重复此调用。 使用getOutputSize来确定输出缓冲区应该有多大。

完成后，此方法将此密码对象重置为之前通过调用init初始化时的状态。 也就是说，该对象被重置并可用于加密或解密（取决于调用init时指定的操作模式）更多数据。

注意：如果抛出任何异常，则可能需要重置此密码对象才能再次使用它。

注意：此方法应该是复制安全的，这意味着 input和 output缓冲区可以引用相同的字节数组，并且在结果复制到输出缓冲区时不会覆盖未处理的输入数据。

doFinal

int doFinal (ByteBuffer input, 
                ByteBuffer output)

在单部分操作中加密或解密数据，或完成多部分操作。 数据被加密或解密，取决于这个密码是如何初始化的。

所有input.remaining()起始字节input.position()被处理。 如果使用诸如GCM / CCM的AEAD模式，则在加密的情况下附加认证标签，或者在解密的情况下验证。 结果存储在输出缓冲区中。 返回时，输入缓冲区的位置将等于它的限制; 其限制不会改变。 输出缓冲区的位置将前进n，其中n是此方法返回的值; 输出缓冲区的限制不会改变。

如果output.remaining()字节不足以保存结果，则抛出ShortBufferException 。 在这种情况下，使用更大的输出缓冲区重复此调用。 使用getOutputSize来确定输出缓冲区应该有多大。

完成后，此方法将此密码对象重置为之前通过调用init初始化时的状态。 也就是说，该对象被重置并可用于加密或解密（取决于调用init时指定的操作模式）更多数据。

注意：如果抛出任何异常，则可能需要重置此密码对象才能再次使用它。

注意：此方法应该是复制安全的，这意味着 input和 output缓冲区可以引用相同的字节数组，并且在结果复制到输出缓冲区时不会覆盖未处理的输入数据。

doFinal

byte[] doFinal (byte[] input, 
                int inputOffset, 
                int inputLen)

在单部分操作中加密或解密数据，或完成多部分操作。 数据被加密或解密，取决于这个密码是如何初始化的。

第一inputLen字节在input缓冲区中，从inputOffset以下，并且可能在上一次期间已缓存的任何输入字节update操作，进行处理，填充（如果要求）被施加。 如果使用诸如GCM / CCM的AEAD模式，则在加密的情况下附加认证标签，或者在解密的情况下验证。 结果存储在新的缓冲区中。

完成后，此方法会将此密码对象重置为之前通过调用init初始化时的状态。 也就是说，该对象被重置并可用于加密或解密（取决于调用init时指定的操作模式）更多数据。

注意：如果抛出任何异常，则可能需要重置此密码对象才能再次使用它。

getAlgorithm

String getAlgorithm ()

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

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

getBlockSize

int getBlockSize ()

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

getExemptionMechanism

ExemptionMechanism getExemptionMechanism ()

返回与此密码一起使用的豁免机制对象。

getIV

byte[] getIV ()

返回新缓冲区中的初始化向量（IV）。

在创建随机IV的情况下，或者在基于密码的加密或解密的情况下，IV是从用户提供的密码导出的情况下，这非常有用。

getInstance

Cipher getInstance (String transformation)

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

该方法遍历注册安全提供程序的列表，从最优先的提供程序开始。 返回一个新的Cipher对象，该对象封装来自支持指定算法的第一个Provider的CipherSpi实现。

请注意，注册供应商列表可能通过 Security.getProviders()方法检索。

getInstance

Cipher getInstance (String transformation, 
                String provider)

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

返回封装指定提供程序的CipherSpi实现的新Cipher对象。 指定的提供者必须在安全提供者列表中注册。

请注意，注册供应商列表可能通过 Security.getProviders()方法检索。

getInstance

Cipher getInstance (String transformation, 
                Provider provider)

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

返回封装指定Provider对象的CipherSpi实现的新Cipher对象。 请注意，指定的Provider对象不必在提供程序列表中注册。

getMaxAllowedKeyLength

int getMaxAllowedKeyLength (String transformation)

根据安装的JCE辖区策略文件返回指定转换的最大密钥长度。 如果安装了JCE无限强度管辖权策略文件，则返回Integer.MAX_VALUE。 有关JCE辖区策略文件中默认密钥大小的更多信息，请参阅Java Cryptography Architecture Reference Guide中的附录E.

getMaxAllowedParameterSpec

AlgorithmParameterSpec getMaxAllowedParameterSpec (String transformation)

根据辖区策略文件返回包含最大密码参数值的AlgorithmParameterSpec对象。 如果安装了JCE无限强度管辖权策略文件，或者策略文件中指定转换的参数没有最大限制，则将返回null。

getOutputSize

int getOutputSize (int inputLen)

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

此调用考虑到来自先前的 update调用，填充和AEAD标记的任何未处理（缓冲）的数据。

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

getParameters

AlgorithmParameters getParameters ()

返回此密码使用的参数。

返回的参数可能与用于初始化此密码的参数相同，或者如果此密码需要算法参数但未用任何初始值进行初始化，则可能包含底层密码实现使用的默认参数值和随机参数值的组合。

getProvider

Provider getProvider ()

返回此 Cipher对象的提供者。

init

void init (int opmode, 
                Key key, 
                AlgorithmParameters params)

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

密码初始化为以下四种操作之一：加密，解密，密钥打包或密钥解包，具体取决于 opmode的值。

如果此密码需要任何算法参数，并且params为空，则假定基础密码实现本身（使用特定于提供者的默认值或随机值）自动生成所需参数（如果它正在初始化用于加密或密钥包装），并且引发InvalidAlgorithmParameterException if它正在被初始化用于解密或密钥解包。 生成的参数可以使用getParameters或getIV （如果参数是IV）来检索。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基础反馈或填充方案）需要任何随机字节（例如，用于参数生成），则它将使用最高优先级的安装提供程序的SecureRandom实现作为随机源。 （如果没有安装的提供商提供SecureRandom的实现，则将使用系统提供的随机源。）

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

init

void init (int opmode, 
                Certificate certificate, 
                SecureRandom random)

使用来自给定证书的公钥和随机源初始化此密码。

密码初始化为以下四种操作之一：加密，解密，密钥打包或密钥解包，具体取决于 opmode的值。

如果证书的类型为X.509，并且 密钥使用扩展字段标记为 关键字 ，并且 密钥使用扩展字段的值意味着证书中的公钥和其相应的私钥不应用于由 opmode的值表示的操作， InvalidKeyException被抛出。

如果此密码要求任何算法参数无法从给定的certificate公钥中派生出来，那么底层密码实现应该自己生成所需的参数（使用特定于提供者的默认值或随机值），如果它正在初始化用于加密或密钥包装，并且如果正在初始化用于解密或密钥解包，则引发InvalidKeyException 。 生成的参数可以使用getParameters或getIV （如果参数是IV）来检索。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基础反馈或填充方案）需要任何随机字节（例如，用于参数生成），则它将从 random获得它们。

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

init

void init (int opmode, 
                Key key, 
                SecureRandom random)

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

密码初始化为以下四种操作之一：加密，解密，密钥打包或密钥解包，具体取决于 opmode的值。

如果此密码要求任何算法参数不能从给定的key ，则底层密码实现应该自己生成所需参数（使用特定于提供者的默认值或随机值）（如果它正在初始化用于加密或密钥包装），并且如果它正在初始化用于解密或密钥解InvalidKeyException则引发一个InvalidKeyException 。 可以使用getParameters或getIV （如果参数是IV）检索生成的参数。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基本反馈或填充方案）需要任何随机字节（例如，用于参数生成），它将从 random获得它们。

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

init

void init (int opmode, 
                Key key, 
                AlgorithmParameterSpec params)

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

密码初始化为以下四种操作之一：加密，解密，密钥打包或密钥解包，具体取决于 opmode的值。

如果此密码需要任何算法参数并且params为空，则如果基础密码实现正在初始化用于加密或密钥包装，则它应该自己生成所需的参数（使用提供程序特定的默认值或随机值），并且如果此参数为InvalidAlgorithmParameterException if它正在被初始化用于解密或密钥解包。 生成的参数可以使用getParameters或getIV （如果参数是IV）来检索。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基础反馈或填充方案）需要任何随机字节（例如，用于参数生成），则它将使用最高优先级安装提供程序的SecureRandom实现作为随机源。 （如果没有安装的提供商提供SecureRandom的实现，则将使用系统提供的随机源。）

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

init

void init (int opmode, 
                Key key)

使用密钥初始化此密码。

密码初始化为以下四种操作之一：加密，解密，密钥打包或密钥解包，具体取决于 opmode的值。

如果此密码要求任何算法参数不能从给定的key ，则底层密码实现应该自己生成所需的参数（使用特定于提供者的默认值或随机值），如果它正在初始化用于加密或密钥包装，以及如果正在初始化解密或密钥解InvalidKeyException则提出InvalidKeyException 。 生成的参数可以使用getParameters或getIV （如果参数是IV）来检索。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基础反馈或填充方案）需要任何随机字节（例如，用于参数生成），则它将使用最高优先级安装提供程序的SecureRandom实现作为随机源。 （如果没有安装的提供商提供SecureRandom的实现，则将使用系统提供的随机源。）

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

init

void init (int opmode, 
                Key key, 
                AlgorithmParameterSpec params, 
                SecureRandom random)

使用密钥，一组算法参数和一个随机源初始化此密码。

密码初始化为以下四种操作之一：加密，解密，密钥打包或密钥解包，具体取决于 opmode的值。

如果此密码需要任何算法参数并且params为空，则假定基础密码实现本身（使用特定于提供者的默认值或随机值）自动生成所需参数（如果它正在初始化用于加密或密钥包装），并且引发InvalidAlgorithmParameterException if它正在被初始化用于解密或密钥解包。 生成的参数可以使用getParameters或getIV （如果参数是IV）来检索。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基础反馈或填充方案）需要任何随机字节（例如，用于参数生成），则它将从 random获得它们。

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

init

void init (int opmode, 
                Certificate certificate)

使用给定证书中的公钥初始化此密码。

密码初始化为以下四种操作之一：加密，解密，密钥打包或密钥解包，具体取决于 opmode的值。

如果证书的类型为X.509，并且 密钥使用扩展字段标记为 关键字 ，并且 密钥使用扩展字段的值意味着证书中的公钥和其相应的私钥不应用于由 opmode的值表示的操作， InvalidKeyException被抛出。

如果此密码需要任何不能从给定证书中的公钥导出的算法参数，那么如果基础密码实现正被初始化用于加密，则其本身（使用提供商特定的默认值或随机值）应该生成所需参数密钥包装，并且如果正在初始化用于解密或密钥解包，则引发InvalidKeyException 。 生成的参数可以使用getParameters或getIV （如果参数是IV）来检索。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基础反馈或填充方案）需要任何随机字节（例如，用于参数生成），它将使用最高优先级安装提供程序的SecureRandom实现作为随机源。 （如果没有安装的提供商提供SecureRandom的实现，则将使用系统提供的随机源。）

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

init

void init (int opmode, 
                Key key, 
                AlgorithmParameters params, 
                SecureRandom random)

使用密钥，一组算法参数和一个随机源初始化此密码。

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

如果这个密码需要任何算法参数，并且params为空，那么底层密码实现本身应该生成所需的参数（使用提供商特定的默认值或随机值），如果它正在初始化用于加密或密钥包装，并且引发InvalidAlgorithmParameterException if它正在被初始化用于解密或密钥解包。 生成的参数可以使用getParameters或getIV （如果参数是IV）来检索。

如果此密码需要不能从输入参数派生的算法参数，并且没有合理的特定于提供者的默认值，则初始化必然会失败。

如果此密码（包括其基础反馈或填充方案）需要任何随机字节（例如，用于参数生成），则它将从 random获得它们。

请注意，当Cipher对象初始化时，它会丢失所有先前获取的状态。 换句话说，初始化密码就相当于创建该密码的一个新实例并对其进行初始化。

unwrap

Key unwrap (byte[] wrappedKey, 
                String wrappedKeyAlgorithm, 
                int wrappedKeyType)

打开以前包装的密钥。

update

byte[] update (byte[] input)

继续进行多部分加密或解密操作（取决于此密码的初始化方式），处理另一个数据部分。

处理 input缓冲区中的字节，并将结果存储在新的缓冲区中。

如果 input的长度为零，则此方法返回 null 。

update

int update (byte[] input, 
                int inputOffset, 
                int inputLen, 
                byte[] output)

继续进行多部分加密或解密操作（取决于此密码的初始化方式），处理另一个数据部分。

第一 inputLen字节在 input缓冲区中，从 inputOffset以下，被处理，并且结果被存储在 output缓冲器。

如果output缓冲区太小而无法保存结果， ShortBufferException抛出ShortBufferException 。 在这种情况下，使用更大的输出缓冲区重复此调用。 使用getOutputSize来确定输出缓冲区应该有多大。

如果 inputLen为零，则此方法返回零长度。

注意：此方法应该是复制安全的，这意味着 input和 output缓冲区可以引用相同的字节数组，并且当结果复制到输出缓冲区时不会覆盖未处理的输入数据。

update

byte[] update (byte[] input, 
                int inputOffset, 
                int inputLen)

继续进行多部分加密或解密操作（取决于此密码的初始化方式），处理另一个数据部分。

第一 inputLen字节在 input缓冲区中，从 inputOffset以下，被处理，并且结果被存储在新的缓冲器。

如果 inputLen为零，则此方法返回 null 。

update

int update (ByteBuffer input, 
                ByteBuffer output)

继续进行多部分加密或解密操作（取决于此密码的初始化方式），处理另一个数据部分。

所有input.remaining()起始字节input.position()被处理。 结果存储在输出缓冲区中。 返回时，输入缓冲区的位置将等于它的限制; 其限制不会改变。 输出缓冲区的位置将前进n，其中n是此方法返回的值; 输出缓冲区的限制不会改变。

如果output.remaining()字节不足以保存结果，则引发ShortBufferException 。 在这种情况下，使用更大的输出缓冲区重复此调用。 使用getOutputSize来确定输出缓冲区应该有多大。

注意：此方法应该是复制安全的，这意味着 input和 output缓冲区可以引用相同的内存块，并且当结果复制到输出缓冲区时不会覆盖未处理的输入数据。

update

int update (byte[] input, 
                int inputOffset, 
                int inputLen, 
                byte[] output, 
                int outputOffset)

继续进行多部分加密或解密操作（取决于此密码的初始化方式），处理另一个数据部分。

第一 inputLen字节在 input缓冲区中，从 inputOffset以下，被处理，并且结果被存储在 output缓冲区中，从 outputOffset以下。

如果output缓冲区太小而无法保存结果， ShortBufferException抛出ShortBufferException 。 在这种情况下，使用更大的输出缓冲区重复此调用。 使用getOutputSize来确定输出缓冲区应该有多大。

如果 inputLen为零，则此方法返回长度为零。

注意：此方法应该是复制安全的，这意味着 input和 output缓冲区可以引用相同的字节数组，并且在结果复制到输出缓冲区时不会覆盖未处理的输入数据。

updateAAD

void updateAAD (byte[] src, 
                int offset, 
                int len)

使用提供的缓冲区的子集继续多部分更新附加验证数据（AAD）。

在AEAD（GCM / CCM）等模式下操作时，调用此方法可为AAD提供密码。 如果此密码以GCM或CCM模式运行，则必须在密文开始操作之前提供所有AAD（通过update和doFinal方法）。

updateAAD

void updateAAD (ByteBuffer src)

继续更新附加验证数据（AAD）。

在AEAD（GCM / CCM）等模式下操作时，调用此方法可为AAD提供密码。 如果此密码以GCM或CCM模式运行，则必须在开始密文操作之前提供所有AAD（通过update和doFinal方法）。

所有src.remaining()起始字节src.position()被处理。 返回时，输入缓冲区的位置将等于它的限制; 其限制不会改变。

updateAAD

void updateAAD (byte[] src)

继续更新附加验证数据（AAD）。

在AEAD（GCM / CCM）等模式下操作时，调用此方法可为AAD提供密码。 如果此密码以GCM或CCM模式运行，则必须在开始密文操作之前提供所有AAD（通过update和doFinal方法）。

wrap

byte[] wrap (Key key)

包裹一把钥匙。