Cipher
类提供加密和解密的功能。
实例化
Cipher
没有公开的构造方法,所以只能调用其静态方法getInstace
进行实现化。这个方法有多个重载如下:
public static final Cipher getInstance(String algorithm)
throws NoSuchAlgorithmException, NoSuchPaddingException;
public static final Cipher getInstance(String algorithm, String provider )
throws NoSuchAlgorithmException, NoSuchProviderException, NoSuchPaddingException;
public static final Cipher getInstance(String algorithm, Provider provider )
throws NoSuchAlgorithmException, NoSuchPaddingException
我们通常使用的是public static final Cipher getInstance(String algorithm)
;此方法需要一个字符串作为参数,这个参数有以下两种形式:
- "算法":使用
Provider
给定的默认“模式”和“填充”。 - "算法/模式/填充"
注:使用 CFB 和 OFB 之类的模式,Cipher 块可以加密单元中小于该 Cipher 的实际块大小的数据。请求这样一个模式时,可以指定一次处理的位数(可选):将此数添加到模式名称中,正如 "DES/CFB8/NoPadding" 和 "DES/OFB32/PKCS5Padding" 转换所示。如果未指定该数,则将使用特定于提供者的默认值。(例如,SunJCE 提供者对 DES 使用默认的 64 位)。因此,通过使用如 CFB8 或 OFB8 的 8 位模式,Cipher 块可以被转换为面向字节的 Cipher 流。
需要了解的静态字段
public static final int ENCRYPT_MODE //用于将 Cipher 初始化为加密模式的常量。
public static final int DECRYPT_MODE //用于将 Cipher 初始化为解密模式的常量。
public static final int WRAP_MODE //用于将 Cipher 初始化为密钥包装模式的常量。
public static final int UNWRAP_MODE //用于将 Cipher 初始化为密钥解包模式的常量。
public static final int PUBLIC_KEY //用于表示要解包的密钥为“公钥”的常量。
public static final int PRIVATE_KEY //用于表示要解包的密钥为“私钥”的常量。
public static final int SECRET_KEY //用于表示要解包的密钥为“秘密密钥”的常量。
初始化方法
// 仅使用密钥进行初始化
public final void init(int mode, Key key)
throws InvalidKeyException
// 用密钥和随机源初始化此 Cipher。
public final void init(int mode, Key key, SecureRandom random)
throws InvalidKeyException
//用密钥和一组算法参数初始化此 Cipher。
public final void init(int mode, Key key,
AlgorithmParameterSpec paramSpcec)
throws InvalidKeyException, InvalidAlgorithmParameterException
// 用密钥、一组算法参数和随机源初始化此 Cipher。
public final void init(int mode, Key key,
AlgorithmParameterSpec paramSpec, SecureRandom random)
throws InvalidKeyException, InvalidAlgorithmParameterException
// 用密钥和一组算法参数初始化此 Cipher。
public final void init(int mode, Key key, AlgorithmParameters param)
throws InvalidKeyException, InvalidAlgorithmParameterException
// 用密钥、一组算法参数和随机源初始化此 Cipher。
public final void init(int mode, Key key,
AlgorithmParameters param, SecureRandom random)
throws InvalidKeyException, InvalidAlgorithmParameterException
// 用取自给定证书的公钥初始化此 Cipher。
public final void init(int mode, Certificate certificate)
throws InvalidKeyException
// 用取自给定证书的公钥和随机源初始化此 Cipher。
public final void init(int mode, Certificate certificate,
SecureRandom random)
throws InvalidKeyException
我们通常使用的是public final void init(int mode, Key key)
。有四种mode可供选择,分别对应于Cipher中的四个常量如下:
- ENCRYPT_MODE 用于将 Cipher 初始化为加密模式。
- DECRYPT_MODE 用于将 Cipher 初始化为解密模式。
- WRAP_MODE 用于将 Cipher 初始化为密钥包装模式。
- UNWRAP_MODE 用于将 Cipher 初始化为密钥解包模式。
如果此 Cipher 需要任何无法从给定 key 派生的算法参数,则在为加密或密钥包装初始化时,底层 Cipher 实现应自己生成所需的参数(使用特定于提供者的默认值或随机值);在为解密或密钥解包初始化时,将引发 InvalidKeyException。可以用 getParameters 或 getIV 获取生成的参数(如果该参数为 IV)。
如果此 Cipher(包括其底层反馈或填充方案)需要随机字节(例如,用于参数生成),那么它将使用具有最高优先级的已安装提供者的 SecureRandom 实现作为随机源获取这些字节。(如果已安装的提供者都不提供 SecureRandom 实现,则将使用系统提供的随机源)。
update 和 doFinal 方法
update方法有多个重载如下:
public final byte[] update(byte[] input)
public final byte[] update(byte[] input, int offset, int len)
public final int update(byte[] input, int offset, int len, byte[] output)
throws ShortBufferException
public final int update(byte[] input, int inOffset, int len, byte[] output, int outOffset)
throws ShortBufferException
public final int update(ByteBuffer input, ByteBuffer output)
throws ShortBufferException
// doFinal 方法除下面这个无参方法外,还有五个与update参数一致的重载方法,
// 它们相当于使用同样的参数调用update后再调用无参doFinal
public final byte[] doFinal()
throws IllegalBlockSizeException, BadPaddingException
update方法有于在多部分加密或解密操作中处理其他未完成加密或解密的部分数据。doFinal则用于完成一次加密或解密操作,并将Cipher
对象重置为上一次调用init
方法时的状态。
wrap 和 unwrap 方法
public final byte[] wrap(Key key)
throws IllegalBlockSizeException, InvalidKeyException
public final Key unwrap(byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType)
throws InvalidKeyException, NoSuchAlgorithmException
wrap
方法用于包装密钥,unwrap
方法用于解包一个以前包装的密钥。两者为互逆操作。
在解包时参数 wrappedKeyType
可以取三个值,它们都对应于Cipher
的静态常量:
- PUBLIC_KEY 表示要解包的密钥为“公钥”。
- PRIVATE_KEY 表示要解包的密钥为“私钥”。
- SECRET_KEY 表示要解包的密钥为“秘密密钥”。
其他方法
-
public final int getBlockSize()
返回块的大小(以字节为单位)。 -
public final int getOutputSize(int inputLen)
根据给定的输入长度 inputLen(以字节为单位),返回保存下一个 update 或 doFinal 操作结果所需的输出缓冲区长度(以字节为单位)。 -
public final byte[] getIV()
返回新缓冲区中的初始化向量 (IV) -
public final AlgorithmParameters getParameters()
返回此 Cipher 使用的参数。返回的参数可能与初始化此 Cipher 所使用的参数相同;如果此 Cipher 需要算法参数但却未使用任何参数进行初始化,则返回的参数将由默认值和底层 Cipher 实现所使用的随机参数值组成。
algorithm 参数支持的字符串:
- RSA
- DES
- DESede
- DESedeWrap
- PBEWithMD5AndDES
- PBEWithMD5AndTripleDES
- PBEWithSHA1AndDESede
- PBEWithSHA1AndRC2_40
- PBEWithSHA1AndRC2_128
- PBEWithSHA1AndRC4_40
- PBEWithSHA1AndRC4_128
- PBEWithHmacSHA1AndAES_128
- PBEWithHmacSHA224AndAES_128
- PBEWithHmacSHA256AndAES_128
- PBEWithHmacSHA384AndAES_128
- PBEWithHmacSHA512AndAES_128
- PBEWithHmacSHA1AndAES_256
- PBEWithHmacSHA224AndAES_256
- PBEWithHmacSHA256AndAES_256
- PBEWithHmacSHA384AndAES_256
- PBEWithHmacSHA512AndAES_256
- Blowfish
- AES
- AES_128/ECB/NoPadding
- AES_128/CBC/NoPadding
- AES_128/OFB/NoPadding
- AES_128/CFB/NoPadding
- AES_128/GCM/NoPadding
- AES_192/ECB/NoPadding
- AES_192/CBC/NoPadding
- AES_192/OFB/NoPadding
- AES_192/CFB/NoPadding
- AES_192/GCM/NoPadding
- AES_256/ECB/NoPadding
- AES_256/CBC/NoPadding
- AES_256/OFB/NoPadding
- AES_256/CFB/NoPadding
- AES_256/GCM/NoPadding
- AESWrap
- AESWrap_128
- AESWrap_192
- AESWrap_256
- RC2
- ARCFOUR
- Blowfish
- RSA/ECB/PKCS1Padding