appId和appKey加签验签工具类

2023-10-25

在开放平台，接口调用一般通过appId和appKey的加签验签实现验证。

本文提供三个类实现：

Md5Data：数据传输体，传输带加签的数据和签名；
Md5Helper：Md5加签验签服务类；
AppMd5：与应用相关的验证类，一般使用这个类实现验证。

另外，还提供SM3的加签验签，也是三个类实现。

Md5Data

数据传输体，传输带加签的数据和签名。

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description Md5加入签名数据
 * @date 2023/5/18 12:49 PM
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "Md5Data", description = "Md5加入签名数据")
public class Md5Data {

    @ApiModelProperty(value = "app唯一标识ID")
    private String appId;

    @ApiModelProperty(value = "app密钥")
    private String appSecret;

    @ApiModelProperty(value = "请求时间戳，格式'1692621865169'")
    private String timeStamp;

    @ApiModelProperty(value = "签名字符串")
    private String sign;
}

Md5Helper

Md5加签验签服务类。

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description MD5 Helper
 *     <p>生成有序map，签名，验签
 * @date 2023/5/17 11:53 AM
 */
@Slf4j
public class Md5Helper {

    /**
     * 生成sign
     *
     * <p>有序map
     *
     * @param params 请求参数 有序map
     * @param key 密钥
     * @return 签名
     */
    public static String createSign(SortedMap<String, String> params, String key) {

        // 生成待签名的字符串
        StringBuilder sb = new StringBuilder();
        Set<Map.Entry<String, String>> es = params.entrySet();
        for (Map.Entry<String, String> entry : es) {
            String k = entry.getKey();
            String v = entry.getValue();
            // 去除空值，sign，key
            if (null != v && !"".equals(v) && !"sign".equals(k) && !"appSecret".equals(k)) {
                sb.append(k).append("=").append(v).append("&");
            }
        }
        // 添加key
        sb.append("appSecret=").append(key);

        // 待签名的字符串
        String waitSign = sb.toString();
        // 判断待签名参数的合法性
        if (StringUtils.isBlank(waitSign)) {
            log.error("待签名参数为空");

            return null;
        }

        // 生成签名
        String sign = md5(waitSign);
        if (StringUtils.isBlank(sign)) {
            log.error("签名为空");

            return null;
        }

        // 返回
        return sign;
    }

    /**
     * 生成sign
     *
     * <p>一般map
     *
     * @param params 请求参数 一般map
     * @param key 密钥
     * @return 签名
     */
    public static String createSign(Map<String, String> params, String key) {

        // 生成有序map
        SortedMap<String, String> sortedMap = getSortedMap(params);

        // 生成待签名的字符串
        StringBuilder sb = new StringBuilder();
        Set<Map.Entry<String, String>> es = sortedMap.entrySet();
        for (Map.Entry<String, String> entry : es) {
            String k = entry.getKey();
            String v = entry.getValue();
            // 去除空值，sign，key
            if (null != v && !"".equals(v) && !"sign".equals(k) && !"appSecret".equals(k)) {
                sb.append(k).append("=").append(v).append("&");
            }
        }
        // 添加key
        sb.append("appSecret=").append(key);

        // 待签名的字符串
        String waitSign = sb.toString();
        // 判断待签名参数的合法性
        if (StringUtils.isBlank(waitSign)) {
            log.error("待签名参数为空");

            return null;
        }

        // 生成签名
        String sign = md5(waitSign);
        if (StringUtils.isBlank(sign)) {
            log.error("签名为空");

            return null;
        }

        // 返回
        return sign;
    }

    /**
     * 校验签名
     *
     * <p>有序map
     *
     * @param params 请求参数 有序map
     * @param key 密钥
     * @return 是否正确
     */
    public static boolean isCorrectSign(SortedMap<String, String> params, String key) {

        // 生成签名
        String sign = createSign(params, key);

        // 获取参数中的签名
        String paramSign = params.get("sign");

        // 判断签名是否正确
        return paramSign.equals(sign);
    }

    /**
     * 校验签名
     *
     * <p>一般map
     *
     * @param params 请求参数 一般map
     * @param key 密钥
     * @return 是否正确
     */
    public static boolean isCorrectSign(Map<String, String> params, String key) {

        // 生成签名
        String sign = createSign(params, key);

        // 获取参数中的签名
        String paramSign = params.get("sign");

        // 判断签名是否正确
        return paramSign.equals(sign);
    }

    /**
     * 获取有序map
     *
     * @param map 请求参数
     * @return 有序map
     */
    public static SortedMap<String, String> getSortedMap(Map<String, String> map) {

        // 生成有序map
        SortedMap<String, String> sortedMap = new TreeMap<>();
        for (Map.Entry<String, String> entry : map.entrySet()) {
            String key = entry.getKey();
            String value = entry.getValue();
            String temp = "";
            if (null != value) {
                temp = value.trim();
            }
            sortedMap.put(key, temp);
        }

        return sortedMap;
    }

    /**
     * md5常用工具类
     *
     * @param data 待加密字符串
     * @return 加密后字符串
     */
    public static String md5(String data) {

        try {
            // 获取MD5实例
            MessageDigest md5 = MessageDigest.getInstance("MD5");

            // 加密
            byte[] array = md5.digest(data.getBytes(StandardCharsets.UTF_8));
            StringBuilder sb = new StringBuilder();
            for (byte item : array) {
                sb.append(Integer.toHexString((item & 0xFF) | 0x100), 1, 3);
            }

            // 返回加密后字符串，转换成大写
            return sb.toString().toUpperCase();

        } catch (Exception e) {
            log.error("MD5加密失败，data={}，原因={}", data, e.getMessage());

            return null;
        }
    }
}

AppMd5

与应用相关的验证类，一般使用这个类实现验证。

import lombok.extern.slf4j.Slf4j;

import java.util.HashMap;
import java.util.Map;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 应用MD5校验类
 * @date 2023/5/18 12:47 PM
 */
@Slf4j
public class AppMd5 {

    /**
     * 生成签名
     *
     * @param appId app唯一标识ID
     * @param appSecret app密钥
     * @param timeStamp 请求时间戳，格式'1692621865169'
     * @return 签名，失败返回null
     */
    public static String generateSign(String appId, String appSecret, String timeStamp) {

        // 构建需要签名的Map
        Map<String, String> map = new HashMap<>();
        map.put("appId", appId);
        map.put("timeStamp", timeStamp);

        // 生成签名
        return Md5Helper.createSign(map, appSecret);
    }

    /**
     * 生成签名
     *
     * @param md5Data Md5Data
     * @return 签名，失败返回null
     */
    public static String generateSign(Md5Data md5Data) {

        // 构建需要签名的Map
        Map<String, String> map = new HashMap<>();
        map.put("appId", md5Data.getAppId());
        map.put("timeStamp", md5Data.getTimeStamp());

        // 生成签名
        return Md5Helper.createSign(map, md5Data.getAppSecret());
    }

    /**
     * 验证签名
     *
     * @param md5Data Md5Data
     * @return true:验证通过，false:验证失败
     */
    public static Boolean verifySign(Md5Data md5Data) {

        // 构建需要验证签名的Map
        Map<String, String> map = new HashMap<>();
        map.put("appId", md5Data.getAppId());
        map.put("timeStamp", md5Data.getTimeStamp());
        map.put("sign", md5Data.getSign());

        // 验证签名
        return Md5Helper.isCorrectSign(map, md5Data.getAppSecret());
    }
}

SM3加签验签

Sm3Data

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description Sm3加入签名数据
 * @date 2023/5/18 12:49 PM
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "Sm3Data", description = "Sm3加入签名数据")
public class Sm3Data {

    @ApiModelProperty(value = "app唯一标识ID")
    private String appId;

    @ApiModelProperty(value = "app密钥")
    private String appSecret;

    @ApiModelProperty(value = "请求时间戳，格式'1692621865169'")
    private String timeStamp;

    @ApiModelProperty(value = "签名字符串")
    private String sign;
}

Sm3Helper

import cn.hutool.crypto.digest.DigestUtil;
import cn.hutool.crypto.digest.Digester;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;

import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description Sm3 Helper
 *     <p>生成有序map，签名，验签
 * @date 2023/5/17 11:53 AM
 */
@Slf4j
public class Sm3Helper {

    /**
     * 生成sign
     *
     * <p>有序map
     *
     * @param params 请求参数 有序map
     * @param key 密钥
     * @return 签名
     */
    public static String createSign(SortedMap<String, String> params, String key) {

        // 生成待签名的字符串
        StringBuilder sb = new StringBuilder();
        Set<Map.Entry<String, String>> es = params.entrySet();
        for (Map.Entry<String, String> entry : es) {
            String k = entry.getKey();
            String v = entry.getValue();
            // 去除空值，sign，key
            if (null != v && !"".equals(v) && !"sign".equals(k) && !"appSecret".equals(k)) {
                sb.append(k).append("=").append(v).append("&");
            }
        }
        // 添加key
        sb.append("appSecret=").append(key);

        // 待签名的字符串
        String waitSign = sb.toString();
        // 判断待签名参数的合法性
        if (StringUtils.isBlank(waitSign)) {
            log.error("待签名参数为空");

            return null;
        }

        // 生成签名
        String sign = sm3(waitSign);
        if (StringUtils.isBlank(sign)) {
            log.error("签名为空");

            return null;
        }

        // 返回
        return sign;
    }

    /**
     * 生成sign
     *
     * <p>一般map
     *
     * @param params 请求参数 一般map
     * @param key 密钥
     * @return 签名
     */
    public static String createSign(Map<String, String> params, String key) {

        // 生成有序map
        SortedMap<String, String> sortedMap = getSortedMap(params);

        // 生成待签名的字符串
        StringBuilder sb = new StringBuilder();
        Set<Map.Entry<String, String>> es = sortedMap.entrySet();
        for (Map.Entry<String, String> entry : es) {
            String k = entry.getKey();
            String v = entry.getValue();
            // 去除空值，sign，key
            if (null != v && !"".equals(v) && !"sign".equals(k) && !"appSecret".equals(k)) {
                sb.append(k).append("=").append(v).append("&");
            }
        }
        // 添加key
        sb.append("appSecret=").append(key);

        // 待签名的字符串
        String waitSign = sb.toString();
        // 判断待签名参数的合法性
        if (StringUtils.isBlank(waitSign)) {
            log.error("待签名参数为空");

            return null;
        }

        // 生成签名
        String sign = sm3(waitSign);
        if (StringUtils.isBlank(sign)) {
            log.error("签名为空");

            return null;
        }

        // 返回
        return sign;
    }

    /**
     * 校验签名
     *
     * <p>有序map
     *
     * @param params 请求参数 有序map
     * @param key 密钥
     * @return 是否正确
     */
    public static boolean isCorrectSign(SortedMap<String, String> params, String key) {

        // 生成签名
        String sign = createSign(params, key);

        // 获取参数中的签名
        String paramSign = params.get("sign");

        // 判断签名是否正确
        return paramSign.equals(sign);
    }

    /**
     * 校验签名
     *
     * <p>一般map
     *
     * @param params 请求参数 一般map
     * @param key 密钥
     * @return 是否正确
     */
    public static boolean isCorrectSign(Map<String, String> params, String key) {

        // 生成签名
        String sign = createSign(params, key);

        // 获取参数中的签名
        String paramSign = params.get("sign");

        // 判断签名是否正确
        return paramSign.equals(sign);
    }

    /**
     * 获取有序map
     *
     * @param map 请求参数
     * @return 有序map
     */
    public static SortedMap<String, String> getSortedMap(Map<String, String> map) {

        // 生成有序map
        SortedMap<String, String> sortedMap = new TreeMap<>();
        for (Map.Entry<String, String> entry : map.entrySet()) {
            String key = entry.getKey();
            String value = entry.getValue();
            String temp = "";
            if (null != value) {
                temp = value.trim();
            }
            sortedMap.put(key, temp);
        }

        return sortedMap;
    }

    /**
     * sm3常用工具类
     *
     * @param data 待加密字符串
     * @return 加密后字符串
     */
    public static String sm3(String data) {

        try {
            // 获取Sm3实例
            Digester digester = DigestUtil.digester("sm3");

            // 加密
            return digester.digestHex(data, StandardCharsets.UTF_8);

        } catch (Exception e) {
            log.error("Sm3加密失败，data={}，原因={}", data, e.getMessage());

            return null;
        }
    }
}

AppSm3

import lombok.extern.slf4j.Slf4j;

import java.util.HashMap;
import java.util.Map;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 应用Sm3校验类
 * @date 2023/5/18 12:47 PM
 */
@Slf4j
public class AppSm3 {

    /**
     * 生成签名
     *
     * @param appId app唯一标识ID
     * @param appSecret app密钥
     * @param timeStamp 请求时间戳，格式'1692621865169'
     * @return 签名，失败返回null
     */
    public static String generateSign(String appId, String appSecret, String timeStamp) {

        // 构建需要签名的Map
        Map<String, String> map = new HashMap<>();
        map.put("appId", appId);
        map.put("timeStamp", timeStamp);

        // 生成签名
        return Sm3Helper.createSign(map, appSecret);
    }

    /**
     * 生成签名
     *
     * @param sm3Data Sm3Data
     * @return 签名，失败返回null
     */
    public static String generateSign(Sm3Data sm3Data) {

        // 构建需要签名的Map
        Map<String, String> map = new HashMap<>();
        map.put("appId", sm3Data.getAppId());
        map.put("timeStamp", sm3Data.getTimeStamp());

        // 生成签名
        return Sm3Helper.createSign(map, sm3Data.getAppSecret());
    }

    /**
     * 验证签名
     *
     * @param sm3Data Sm3Data
     * @return true:验证通过，false:验证失败
     */
    public static Boolean verifySign(Sm3Data sm3Data) {

        // 构建需要验证签名的Map
        Map<String, String> map = new HashMap<>();
        map.put("appId", sm3Data.getAppId());
        map.put("timeStamp", sm3Data.getTimeStamp());
        map.put("sign", sm3Data.getSign());

        // 验证签名
        return Sm3Helper.isCorrectSign(map, sm3Data.getAppSecret());
    }
}