cn.hutool.crypto.digest

类 HMac

java.lang.Object

cn.hutool.crypto.digest.HMac

所有已实现的接口:

Serializable

public class HMac
extends Object
implements Serializable

HMAC摘要算法
HMAC，全称为“Hash Message Authentication Code”，中文名“散列消息鉴别码”
主要是利用哈希算法，以一个密钥和一个消息为输入，生成一个消息摘要作为输出。
一般的，消息鉴别码用于验证传输于两个共 同享有一个密钥的单位之间的消息。
HMAC 可以与任何迭代散列函数捆绑使用。MD5 和 SHA-1 就是这种散列函数。HMAC 还可以使用一个用于计算和确认消息鉴别值的密钥。
注意：此对象实例化后为非线程安全！

作者:

Looly

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
HMac(HmacAlgorithm algorithm) 构造，自动生成密钥
HMac(HmacAlgorithm algorithm, byte[] key) 构造
HMac(HmacAlgorithm algorithm, Key key) 构造
HMac(MacEngine engine) 构造
HMac(String algorithm, byte[] key) 构造
HMac(String algorithm, Key key) 构造

方法概要

限定符和类型	方法和说明
byte[]	digest(byte[] data) 生成摘要
byte[]	digest(File file) 生成文件摘要 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
byte[]	digest(InputStream data) 生成摘要，使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
byte[]	digest(InputStream data, int bufferLength) 生成摘要
byte[]	digest(String data) 生成文件摘要
byte[]	digest(String data, String charset) 生成文件摘要
String	digestHex(byte[] data) 生成摘要，并转为16进制字符串
String	digestHex(File file) 生成文件摘要，并转为16进制字符串 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data, int bufferLength) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
String	digestHex(String data) 生成文件摘要
String	digestHex(String data, String charset) 生成文件摘要，并转为16进制字符串
String	getAlgorithm() 获取算法
int	getMacLength() 获取MAC算法块长度

从类继承的方法 java.lang.Object

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

构造器详细资料

HMac

public HMac(HmacAlgorithm algorithm)

构造，自动生成密钥

参数:

algorithm - 算法 HmacAlgorithm

HMac

public HMac(HmacAlgorithm algorithm,
            byte[] key)

构造

参数:

algorithm - 算法 HmacAlgorithm

key - 密钥

HMac

public HMac(HmacAlgorithm algorithm,
            Key key)

构造

参数:

algorithm - 算法 HmacAlgorithm

key - 密钥

HMac

public HMac(String algorithm,
            byte[] key)

构造

参数:

algorithm - 算法

key - 密钥

从以下版本开始:

4.5.13

HMac

public HMac(String algorithm,
            Key key)

构造

参数:

algorithm - 算法

key - 密钥

从以下版本开始:

4.5.13

HMac

public HMac(MacEngine engine)

构造

参数:

engine - MAC算法实现引擎

从以下版本开始:

4.5.13

方法详细资料

digest

public byte[] digest(String data,
                     String charset)

生成文件摘要

参数:

data - 被摘要数据

charset - 编码

返回:

摘要

digest

public byte[] digest(String data)

生成文件摘要

参数:

data - 被摘要数据

返回:

摘要

digestHex

public String digestHex(String data,
                        String charset)

生成文件摘要，并转为16进制字符串

参数:

data - 被摘要数据

charset - 编码

返回:

摘要

digestHex

public String digestHex(String data)

生成文件摘要

参数:

data - 被摘要数据

返回:

摘要

digest

public byte[] digest(File file)
              throws CryptoException

生成文件摘要
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

参数:

file - 被摘要文件

返回:

摘要bytes

抛出:

CryptoException - Cause by IOException

digestHex

public String digestHex(File file)

生成文件摘要，并转为16进制字符串
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

参数:

file - 被摘要文件

返回:

摘要

digest

public byte[] digest(byte[] data)

生成摘要

参数:

data - 数据bytes

返回:

摘要bytes

digestHex

public String digestHex(byte[] data)

生成摘要，并转为16进制字符串

参数:

data - 被摘要数据

返回:

摘要

digest

public byte[] digest(InputStream data)

生成摘要，使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

参数:

data - InputStream 数据流

返回:

摘要bytes

digestHex

public String digestHex(InputStream data)

生成摘要，并转为16进制字符串
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

参数:

data - 被摘要数据

返回:

摘要

digest

public byte[] digest(InputStream data,
                     int bufferLength)

生成摘要

参数:

data - InputStream 数据流

bufferLength - 缓存长度，不足1使用 NioUtil.DEFAULT_BUFFER_SIZE 做为默认值

返回:

摘要bytes

digestHex

public String digestHex(InputStream data,
                        int bufferLength)

生成摘要，并转为16进制字符串
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

参数:

data - 被摘要数据

bufferLength - 缓存长度，不足1使用 NioUtil.DEFAULT_BUFFER_SIZE 做为默认值

返回:

摘要

getMacLength

public int getMacLength()

获取MAC算法块长度

返回:

MAC算法块长度

从以下版本开始:

5.3.3

getAlgorithm

public String getAlgorithm()

获取算法

返回:

算法

从以下版本开始:

5.3.3