org.dromara.hutool.crypto.digest.mac.Mac Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.crypto.digest.mac;
import org.dromara.hutool.core.codec.binary.HexUtil;
import org.dromara.hutool.core.codec.binary.Base64;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.io.file.FileUtil;
import org.dromara.hutool.core.util.ByteUtil;
import org.dromara.hutool.core.util.CharsetUtil;
import org.dromara.hutool.crypto.CryptoException;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.InputStream;
import java.io.Serializable;
import java.nio.charset.Charset;
import java.security.MessageDigest;
/**
* MAC摘要算法（此类兼容和JCE的 {@code javax.crypto.Mac}对象和BC库的{@code org.bouncycastle.crypto.Mac}对象）
* MAC，全称为“Message Authentication Code”，中文名“消息鉴别码”
* 主要是利用指定算法，以一个密钥和一个消息为输入，生成一个消息摘要作为输出。
* 一般的，消息鉴别码用于验证传输于两个共同享有一个密钥的单位之间的消息。
* 注意：此对象实例化后为非线程安全！
*
* @author Looly
* @since 5.8.0
*/
public class Mac implements Serializable {
private static final long serialVersionUID = 1L;
private final MacEngine engine;
/**
* 构造
*
* @param engine MAC算法实现引擎
*/
public Mac(final MacEngine engine) {
this.engine = engine;
}
// ------------------------------------------------------------------------------------------- Constructor end
/**
* 获得MAC算法引擎
*
* @return MAC算法引擎
*/
public MacEngine getEngine() {
return this.engine;
}
// ------------------------------------------------------------------------------------------- Digest
/**
* 生成文件摘要
*
* @param data 被摘要数据
* @param charset 编码
* @return 摘要
*/
public byte[] digest(final String data, final Charset charset) {
return digest(ByteUtil.toBytes(data, charset));
}
/**
* 生成文件摘要
*
* @param data 被摘要数据
* @return 摘要
*/
public byte[] digest(final String data) {
return digest(data, CharsetUtil.UTF_8);
}
/**
* 生成文件摘要，并转为Base64
*
* @param data 被摘要数据
* @param isUrlSafe 是否使用URL安全字符
* @return 摘要
*/
public String digestBase64(final String data, final boolean isUrlSafe) {
return digestBase64(data, CharsetUtil.UTF_8, isUrlSafe);
}
/**
* 生成文件摘要，并转为Base64
*
* @param data 被摘要数据
* @param charset 编码
* @param isUrlSafe 是否使用URL安全字符
* @return 摘要
*/
public String digestBase64(final String data, final Charset charset, final boolean isUrlSafe) {
final byte[] digest = digest(data, charset);
return isUrlSafe ? Base64.encodeUrlSafe(digest) : Base64.encode(digest);
}
/**
* 生成文件摘要，并转为16进制字符串
*
* @param data 被摘要数据
* @param charset 编码
* @return 摘要
*/
public String digestHex(final String data, final Charset charset) {
return HexUtil.encodeStr(digest(data, charset));
}
/**
* 生成文件摘要
*
* @param data 被摘要数据
* @return 摘要
*/
public String digestHex(final String data) {
return digestHex(data, CharsetUtil.UTF_8);
}
/**
* 生成文件摘要
* 使用默认缓存大小，见 {@link IoUtil#DEFAULT_BUFFER_SIZE}
*
* @param file 被摘要文件
* @return 摘要bytes
* @throws CryptoException Cause by IOException
*/
public byte[] digest(final File file) throws CryptoException {
InputStream in = null;
try {
in = FileUtil.getInputStream(file);
return digest(in);
} finally {
IoUtil.closeQuietly(in);
}
}
/**
* 生成文件摘要，并转为16进制字符串
* 使用默认缓存大小，见 {@link IoUtil#DEFAULT_BUFFER_SIZE}
*
* @param file 被摘要文件
* @return 摘要
*/
public String digestHex(final File file) {
return HexUtil.encodeStr(digest(file));
}
/**
* 生成摘要
*
* @param data 数据bytes
* @return 摘要bytes
*/
public byte[] digest(final byte[] data) {
return digest(new ByteArrayInputStream(data), -1);
}
/**
* 生成摘要，并转为16进制字符串
*
* @param data 被摘要数据
* @return 摘要
*/
public String digestHex(final byte[] data) {
return HexUtil.encodeStr(digest(data));
}
/**
* 生成摘要，使用默认缓存大小，见 {@link IoUtil#DEFAULT_BUFFER_SIZE}
*
* @param data {@link InputStream} 数据流
* @return 摘要bytes
*/
public byte[] digest(final InputStream data) {
return digest(data, IoUtil.DEFAULT_BUFFER_SIZE);
}
/**
* 生成摘要，并转为16进制字符串
* 使用默认缓存大小，见 {@link IoUtil#DEFAULT_BUFFER_SIZE}
*
* @param data 被摘要数据
* @return 摘要
*/
public String digestHex(final InputStream data) {
return HexUtil.encodeStr(digest(data));
}
/**
* 生成摘要
*
* @param data {@link InputStream} 数据流
* @param bufferLength 缓存长度，不足1使用 {@link IoUtil#DEFAULT_BUFFER_SIZE} 做为默认值
* @return 摘要bytes
*/
public byte[] digest(final InputStream data, final int bufferLength) {
return this.engine.digest(data, bufferLength);
}
/**
* 生成摘要，并转为16进制字符串
* 使用默认缓存大小，见 {@link IoUtil#DEFAULT_BUFFER_SIZE}
*
* @param data 被摘要数据
* @param bufferLength 缓存长度，不足1使用 {@link IoUtil#DEFAULT_BUFFER_SIZE} 做为默认值
* @return 摘要
*/
public String digestHex(final InputStream data, final int bufferLength) {
return HexUtil.encodeStr(digest(data, bufferLength));
}
/**
* 验证生成的摘要与给定的摘要比较是否一致
* 简单比较每个byte位是否相同
*
* @param digest 生成的摘要
* @param digestToCompare 需要比较的摘要
* @return 是否一致
* @see MessageDigest#isEqual(byte[], byte[])
* @since 5.6.8
*/
public boolean verify(final byte[] digest, final byte[] digestToCompare) {
return MessageDigest.isEqual(digest, digestToCompare);
}
/**
* 获取MAC算法块长度
*
* @return MAC算法块长度
* @since 5.3.3
*/
public int getMacLength() {
return this.engine.getMacLength();
}
/**
* 获取算法
*
* @return 算法
* @since 5.3.3
*/
public String getAlgorithm() {
return this.engine.getAlgorithm();
}
}