org.aoju.bus.crypto.digest

Class HMac

java.lang.Object

org.aoju.bus.crypto.digest.HMac

public class HMac
extends Object

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

Since:

JDK 1.8

Version:

3.0.0

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor and Description
HMac(Mode algorithm) 构造，自动生成密钥
HMac(Mode algorithm, byte[] key) 构造
HMac(Mode algorithm, SecretKey key) 构造

Method Summary

Modifier and Type	Method and Description
byte[]	digest(byte[] data) 生成摘要
byte[]	digest(File file) 生成文件摘要 使用默认缓存大小，见 IoUtils.DEFAULT_BUFFER_SIZE
byte[]	digest(InputStream data) 生成摘要，使用默认缓存大小，见 IoUtils.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进制字符串 使用默认缓存大小，见 IoUtils.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 IoUtils.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data, int bufferLength) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 IoUtils.DEFAULT_BUFFER_SIZE
String	digestHex(String data) 生成文件摘要
String	digestHex(String data, String charset) 生成文件摘要，并转为16进制字符串
Mac	getMac() 获得 Mac
SecretKey	getSecretKey() 获得密钥
HMac	init(String algorithm, byte[] key) 初始化
HMac	init(String algorithm, SecretKey key) 初始化

Methods inherited from class java.lang.Object

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

Constructor Detail

HMac

public HMac(Mode algorithm)

构造，自动生成密钥

Parameters:

algorithm - 算法 Mode

HMac

public HMac(Mode algorithm,
            byte[] key)

构造

Parameters:

algorithm - 算法 Mode

key - 密钥

HMac

public HMac(Mode algorithm,
            SecretKey key)

构造

Parameters:

algorithm - 算法 Mode

key - 密钥

Method Detail

init

public HMac init(String algorithm,
                 byte[] key)

初始化

Parameters:

algorithm - 算法

key - 密钥

Returns:

HMac

Throws:

org.aoju.bus.core.lang.exception.CommonException - Cause by IOException

init

public HMac init(String algorithm,
                 SecretKey key)

初始化

Parameters:

algorithm - 算法

key - 密钥 SecretKey

Returns:

HMac

Throws:

org.aoju.bus.core.lang.exception.CommonException - Cause by IOException

digest

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

生成文件摘要

Parameters:

data - 被摘要数据

charset - 编码

Returns:

摘要

digest

public byte[] digest(String data)

生成文件摘要

Parameters:

data - 被摘要数据

Returns:

摘要

digestHex

public String digestHex(String data,
                        String charset)

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

Parameters:

data - 被摘要数据

charset - 编码

Returns:

摘要

digestHex

public String digestHex(String data)

生成文件摘要

Parameters:

data - 被摘要数据

Returns:

摘要

digest

public byte[] digest(File file)
              throws org.aoju.bus.core.lang.exception.CommonException

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

Parameters:

file - 被摘要文件

Returns:

摘要bytes

Throws:

org.aoju.bus.core.lang.exception.CommonException - Cause by IOException

digestHex

public String digestHex(File file)

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

Parameters:

file - 被摘要文件

Returns:

摘要

digest

public byte[] digest(byte[] data)

生成摘要

Parameters:

data - 数据bytes

Returns:

摘要bytes

digestHex

public String digestHex(byte[] data)

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

Parameters:

data - 被摘要数据

Returns:

摘要

digest

public byte[] digest(InputStream data)

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

Parameters:

data - InputStream 数据流

Returns:

摘要bytes

digestHex

public String digestHex(InputStream data)

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

Parameters:

data - 被摘要数据

Returns:

摘要

digest

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

生成摘要

Parameters:

data - InputStream 数据流

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

Returns:

摘要bytes

digestHex

public String digestHex(InputStream data,
                        int bufferLength)

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

Parameters:

data - 被摘要数据

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

Returns:

摘要

getMac

public Mac getMac()

获得 Mac

Returns:

Mac

getSecretKey

public SecretKey getSecretKey()

获得密钥

Returns:

密钥

Since:

3.0.3