接口调用AK/SK常用验证方式,保证请求合法性

摘要:本文主要介绍api接口调用常见的加密方式ak/sk,这种方式对于非敏感数据传输的接口做调用签名认证是非常有效的,效率高比较高,下面给出几个工具类和使用案例。

AkSkGenerator秘钥对生成

java 复制代码
/**
 * ak sk 生成器
 * @author huzhihui
 * @version $ v 0.1 2025/1/21 8:58 Exp $$
 */
public class AkSkGenerator {

    private static final int KEY_LENGTH = 32;

    /**
     * 生成ak/sk
     * @return
     */
    public static AkSk generate(){
        AkSk akSk = new AkSk();
        akSk.setAccessKey(generateKey());
        akSk.setSecretKey(generateKey());
        return akSk;
    }

    /**
     * 生成key
     * @return
     */
    private static String generateKey() {
        SecureRandom secureRandom = new SecureRandom();
        byte[] randomBytes = new byte[KEY_LENGTH];
        secureRandom.nextBytes(randomBytes);
        return Base64.getUrlEncoder().withoutPadding().encodeToString(randomBytes);
    }

    @Data
    public static class AkSk {
        /**  */
        private String accessKey;
        /**  */
        private String secretKey;
    }

}

AkSkSignatureUtil签名工具类

java 复制代码
public class AkSkSignatureUtil {

    /**
     * 生成签名
     * @param secretKey
     * @param params
     * @return
     * @throws Exception
     */
    public static String generateSignature(String secretKey, Long timestamp, Map<String, String> params) throws Exception {
        // 使用 TreeMap 对参数进行排序
        Map<String, String> sortedParams = new TreeMap<>(params);
        sortedParams.put("timestamp", timestamp.toString());

        // 构建待签名字符串
        StringBuilder dataToSign = new StringBuilder();
        for (Map.Entry<String, String> entry : sortedParams.entrySet()) {
            dataToSign.append(entry.getKey()).append(entry.getValue());
        }

        // 生成签名
        Mac mac = Mac.getInstance("HmacSHA256");
        SecretKeySpec secretKeySpec = new SecretKeySpec(secretKey.getBytes(StandardCharsets.UTF_8), "HmacSHA256");
        mac.init(secretKeySpec);
        byte[] hmacData = mac.doFinal(dataToSign.toString().getBytes(StandardCharsets.UTF_8));
        return Base64.getEncoder().encodeToString(hmacData);
    }

}

使用案例

生成密钥对

ak是用于网络传输,sk只能调用方和服务器方才能知道,需要妥善保管。

java 复制代码
private static AkSkGenerator.AkSk aksk(){
    AkSkGenerator.AkSk akSk = AkSkGenerator.generate();
    System.out.println("ak:" + akSk.getAccessKey());
    System.out.println("sk:" + akSk.getSecretKey());
    System.out.println(System.currentTimeMillis());
    return akSk;
}

生成签名

下面的案例用于展示签名过程,实际的调用我给出伪代码图。

java 复制代码
private static void generateSignature() throws Exception{
    Map<String, String> paramMap = new HashMap<>();
    paramMap.put("username", "张三");
    paramMap.put("age", "12");
    paramMap.put("address", "中国");
    String signature = AkSkSignatureUtil.generateSignature("s4RA20ZmpIt4eXasKztcX-aKAOyxlmICzWUTbcIKqCw", 1737424189619L, paramMap);
    System.out.println(signature);
}

实际生产过程中使用方式

  • 接口请求方式POST
  • 参数定义,一般两种方式

@RequestBody接收参数

参数定义 描述
ak 请求的key
timestamp 时间戳
data 传输的对象

String data来接收json字符串

  • data参数转map,如果是字符串,直接转就行了,但是如果是对象,则需要把对象里面的属性转map,使用BeanUtil.beanToMap(xxx),然后再次签名验证参数是否正确。
相关推荐
简创AIGC陶先生12 小时前
【剪映小助手源码精讲】09_音频素材管理系统
后端
will_we12 小时前
Spring Boot4正式篇:第二篇 多版本API特性
java·后端
v***56513 小时前
Spring Cloud Gateway
android·前端·后端
e***956413 小时前
springboot项目架构
spring boot·后端·架构
q***216013 小时前
Spring Boot项目接收前端参数的11种方式
前端·spring boot·后端
j***121513 小时前
Spring Boot与MyBatis
spring boot·后端·mybatis
optimistic_chen13 小时前
【Java EE进阶 --- SpringBoot】Spring事务传播机制
spring boot·后端·spring·java-ee·事务·事务传播机制
l***749414 小时前
SQL Server2022版+SSMS安装教程(保姆级)
后端·python·flask
昵称为空C15 小时前
kafka的替代品redpanda部署与SpringBoot集成使用案例
spring boot·后端·kafka
q***098016 小时前
Spring Boot 2.7.x 至 2.7.18 及更旧的版本,漏洞说明
java·spring boot·后端