org.aoju.bus.crypto.digest

Class HMac

java.lang.Object

org.aoju.bus.crypto.digest.HMac

All Implemented Interfaces:

Serializable

public class HMac
extends Object
implements Serializable

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

Since:

JDK 1.8+

Version:

6.3.1

Author:

Kimi Liu

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HMac(org.aoju.bus.core.lang.Algorithm algorithm) 构造，自动生成密钥
HMac(org.aoju.bus.core.lang.Algorithm algorithm, byte[] key) 构造
HMac(org.aoju.bus.core.lang.Algorithm algorithm, Key key) 构造
HMac(MacEngine engine) 构造
HMac(String algorithm, byte[] key) 构造
HMac(String algorithm, Key key) 构造
HMac(String algorithm, Key key, AlgorithmParameterSpec spec) 构造

Method Summary

Modifier and Type	Method and Description
byte[]	digest(byte[] data) 生成摘要
byte[]	digest(File file) 生成文件摘要 使用默认缓存大小，见 IoKit.DEFAULT_BUFFER_SIZE
byte[]	digest(InputStream data) 生成摘要，使用默认缓存大小，见 IoKit.DEFAULT_BUFFER_SIZE
byte[]	digest(InputStream data, int bufferLength) 生成摘要
byte[]	digest(String data) 生成文件摘要
byte[]	digest(String data, Charset charset) 生成文件摘要
String	digestBase64(String data, boolean isUrlSafe) 生成文件摘要，并转为Base64
String	digestBase64(String data, Charset charset, boolean isUrlSafe) 生成文件摘要，并转为Base64
String	digestHex(byte[] data) 生成摘要，并转为16进制字符串
String	digestHex(File file) 生成文件摘要，并转为16进制字符串 使用默认缓存大小，见 IoKit.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 IoKit.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data, int bufferLength) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 IoKit.DEFAULT_BUFFER_SIZE
String	digestHex(String data) 生成文件摘要
String	digestHex(String data, Charset charset) 生成文件摘要，并转为16进制字符串
String	getAlgorithm() 获取算法
MacEngine	getEngine() 获得MAC算法引擎
int	getMacLength() 获取MAC算法块长度
boolean	verify(byte[] digest, byte[] digestToCompare) 验证生成的摘要与给定的摘要比较是否一致 简单比较每个byte位是否相同

Methods inherited from class java.lang.Object

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

Constructor Detail

HMac

public HMac(org.aoju.bus.core.lang.Algorithm algorithm)

构造，自动生成密钥

Parameters:

algorithm - 算法 Algorithm

HMac

public HMac(org.aoju.bus.core.lang.Algorithm algorithm,
            byte[] key)

构造

Parameters:

algorithm - 算法 Algorithm

key - 密钥

HMac

public HMac(org.aoju.bus.core.lang.Algorithm algorithm,
            Key key)

构造

Parameters:

algorithm - 算法 Algorithm

key - 密钥

HMac

public HMac(String algorithm,
            byte[] key)

构造

Parameters:

algorithm - 算法

key - 密钥

HMac

public HMac(String algorithm,
            Key key)

构造

Parameters:

algorithm - 算法

key - 密钥

HMac

public HMac(String algorithm,
            Key key,
            AlgorithmParameterSpec spec)

构造

Parameters:

algorithm - 算法

key - 密钥

spec - AlgorithmParameterSpec

HMac

public HMac(MacEngine engine)

构造

Parameters:

engine - MAC算法实现引擎

Method Detail

getEngine

public MacEngine getEngine()

获得MAC算法引擎

Returns:

MAC算法引擎

digest

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

生成文件摘要

Parameters:

data - 被摘要数据

charset - 编码

Returns:

摘要

digest

public byte[] digest(String data)

生成文件摘要

Parameters:

data - 被摘要数据

Returns:

摘要

digestBase64

public String digestBase64(String data,
                           boolean isUrlSafe)

生成文件摘要，并转为Base64

Parameters:

data - 被摘要数据

isUrlSafe - 是否使用URL安全字符

Returns:

摘要

digestBase64

public String digestBase64(String data,
                           Charset charset,
                           boolean isUrlSafe)

生成文件摘要，并转为Base64

Parameters:

data - 被摘要数据

charset - 编码

isUrlSafe - 是否使用URL安全字符

Returns:

摘要

digestHex

public String digestHex(String data,
                        Charset 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.CryptoException

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

Parameters:

file - 被摘要文件

Returns:

摘要bytes

Throws:

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

digestHex

public String digestHex(File file)

生成文件摘要，并转为16进制字符串 使用默认缓存大小，见 IoKit.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)

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

Parameters:

data - InputStream 数据流

Returns:

摘要bytes

digestHex

public String digestHex(InputStream data)

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

Parameters:

data - 被摘要数据

Returns:

摘要

digest

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

生成摘要

Parameters:

data - InputStream 数据流

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

Returns:

摘要bytes

digestHex

public String digestHex(InputStream data,
                        int bufferLength)

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

Parameters:

data - 被摘要数据

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

Returns:

摘要

verify

public boolean verify(byte[] digest,
                      byte[] digestToCompare)

验证生成的摘要与给定的摘要比较是否一致 简单比较每个byte位是否相同

Parameters:

digest - 生成的摘要

digestToCompare - 需要比较的摘要

Returns:

是否一致

See Also:

MessageDigest.isEqual(byte[], byte[])

getMacLength

public int getMacLength()

获取MAC算法块长度

Returns:

MAC算法块长度

getAlgorithm

public String getAlgorithm()

获取算法

Returns:

算法