org.dromara.hutool.crypto

Class SignUtil

java.lang.Object

org.dromara.hutool.crypto.SignUtil

public class SignUtil
extends Object

签名工具类
封装包括：

• 非对称签名，签名算法支持见SignAlgorithm
• 对称签名，支持Map类型参数排序后签名
• 摘要签名，支持Map类型参数排序后签名，签名方法见：DigestAlgorithm

Since:

5.7.20

Author:

looly

Constructor Summary

Constructors

Constructor and Description
SignUtil()

Method Summary

Modifier and Type	Method and Description
static Signature	createSignature(AsymmetricAlgorithm asymmetricAlgorithm, DigestAlgorithm digestAlgorithm) 生成签名对象，仅用于非对称加密
static Signature	createSignature(String algorithm) 创建Signature签名对象
static Sign	sign(SignAlgorithm algorithm) 创建签名算法对象 生成新的私钥公钥对
static Sign	sign(SignAlgorithm algorithm, byte[] privateKey, byte[] publicKey) 创建Sign算法对象 私钥和公钥同时为空时生成一对新的私钥和公钥 私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
static Sign	sign(SignAlgorithm algorithm, String privateKeyBase64, String publicKeyBase64) 创建签名算法对象 私钥和公钥同时为空时生成一对新的私钥和公钥 私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
static String	signParams(DigestAlgorithm digestAlgorithm, Map<?,?> params, String... otherParams) 对参数做签名 参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串 拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值
static String	signParams(DigestAlgorithm digestAlgorithm, Map<?,?> params, String separator, String keyValueSeparator, boolean isIgnoreNull, String... otherParams) 对参数做签名 参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串
static String	signParams(SymmetricCrypto crypto, Map<?,?> params, String... otherParams) 对参数做签名 参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串 拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值
static String	signParams(SymmetricCrypto crypto, Map<?,?> params, String separator, String keyValueSeparator, boolean isIgnoreNull, String... otherParams) 对参数做签名 参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串
static String	signParamsMd5(Map<?,?> params, String... otherParams) 对参数做md5签名 参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串 拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值
static String	signParamsSha1(Map<?,?> params, String... otherParams) 对参数做Sha1签名 参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串 拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值
static String	signParamsSha256(Map<?,?> params, String... otherParams) 对参数做Sha256签名 参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串 拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值

Methods inherited from class java.lang.Object

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

Constructor Detail

SignUtil

public SignUtil()

Method Detail

createSignature

public static Signature createSignature(AsymmetricAlgorithm asymmetricAlgorithm,
                                        DigestAlgorithm digestAlgorithm)

生成签名对象，仅用于非对称加密

Parameters:

asymmetricAlgorithm - AsymmetricAlgorithm 非对称加密算法

digestAlgorithm - DigestAlgorithm 摘要算法

Returns:

Signature

createSignature

public static Signature createSignature(String algorithm)

创建Signature签名对象

Parameters:

algorithm - 算法

Returns:

Signature

Since:

5.7.0

sign

public static Sign sign(SignAlgorithm algorithm)

创建签名算法对象
生成新的私钥公钥对

Parameters:

algorithm - 签名算法

Returns:

Sign

Since:

3.3.0

sign

public static Sign sign(SignAlgorithm algorithm,
                        String privateKeyBase64,
                        String publicKeyBase64)

创建签名算法对象
私钥和公钥同时为空时生成一对新的私钥和公钥
私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证

Parameters:

algorithm - 签名算法

privateKeyBase64 - 私钥Base64

publicKeyBase64 - 公钥Base64

Returns:

Sign

Since:

3.3.0

sign

public static Sign sign(SignAlgorithm algorithm,
                        byte[] privateKey,
                        byte[] publicKey)

创建Sign算法对象
私钥和公钥同时为空时生成一对新的私钥和公钥
私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证

Parameters:

algorithm - 算法枚举

privateKey - 私钥

publicKey - 公钥

Returns:

Sign

Since:

3.3.0

signParams

public static String signParams(SymmetricCrypto crypto,
                                Map<?,?> params,
                                String... otherParams)

对参数做签名
参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串
拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值

Parameters:

crypto - 对称加密算法

params - 参数

otherParams - 其它附加参数字符串（例如密钥）

Returns:

签名

Since:

4.0.1

signParams

public static String signParams(SymmetricCrypto crypto,
                                Map<?,?> params,
                                String separator,
                                String keyValueSeparator,
                                boolean isIgnoreNull,
                                String... otherParams)

对参数做签名
参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串

Parameters:

crypto - 对称加密算法

params - 参数

separator - entry之间的连接符

keyValueSeparator - kv之间的连接符

isIgnoreNull - 是否忽略null的键和值

otherParams - 其它附加参数字符串（例如密钥）

Returns:

签名

Since:

4.0.1

signParamsMd5

public static String signParamsMd5(Map<?,?> params,
                                   String... otherParams)

对参数做md5签名
参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串
拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值

Parameters:

params - 参数

otherParams - 其它附加参数字符串（例如密钥）

Returns:

签名

Since:

4.0.1

signParamsSha1

public static String signParamsSha1(Map<?,?> params,
                                    String... otherParams)

对参数做Sha1签名
参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串
拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值

Parameters:

params - 参数

otherParams - 其它附加参数字符串（例如密钥）

Returns:

签名

Since:

4.0.8

signParamsSha256

public static String signParamsSha256(Map<?,?> params,
                                      String... otherParams)

对参数做Sha256签名
参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串
拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值

Parameters:

params - 参数

otherParams - 其它附加参数字符串（例如密钥）

Returns:

签名

Since:

4.0.1

signParams

public static String signParams(DigestAlgorithm digestAlgorithm,
                                Map<?,?> params,
                                String... otherParams)

对参数做签名
参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串
拼接后的字符串键值对之间无符号，键值对之间无符号，忽略null值

Parameters:

digestAlgorithm - 摘要算法

params - 参数

otherParams - 其它附加参数字符串（例如密钥）

Returns:

签名

Since:

4.0.1

signParams

public static String signParams(DigestAlgorithm digestAlgorithm,
                                Map<?,?> params,
                                String separator,
                                String keyValueSeparator,
                                boolean isIgnoreNull,
                                String... otherParams)

对参数做签名
参数签名为对Map参数按照key的顺序排序后拼接为字符串，然后根据提供的签名算法生成签名字符串

Parameters:

digestAlgorithm - 摘要算法

params - 参数

separator - entry之间的连接符

keyValueSeparator - kv之间的连接符

isIgnoreNull - 是否忽略null的键和值

otherParams - 其它附加参数字符串（例如密钥）

Returns:

签名

Since:

4.0.1