全部产品
云市场

签名机制

更新时间:2019-09-18 20:36:47

对于每一次HTTP或者HTTPS协议请求,我们会根据访问中的签名信息验证访问请求者身份。具体由使用AccessKeyID和AccessKeySecret对称加密验证实现。其中AccessKeyID是访问者身份,AccessKeySecret是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。

1.指定请求参数

在代码中指定请求参数,参数中需要包含公共请求头和接口必备的参数信息。请求参数中不允许出现以Signature为key的参数。

示例代码如下:

  1. String accessKeyId = "testId";
  2. String accessSecret = "testSecret";
  3. java.text.SimpleDateFormat df = new java.text.SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
  4. df.setTimeZone(new java.util.SimpleTimeZone(0, "GMT"));// 这里一定要设置GMT时区
  5. java.util.Map<String, Obejct> paras = new java.util.HashMap<String, Object>();

指定参数:

  1. // 1. 系统参数
  2. params.put("SignatureMethod", "HMAC-SHA1");
  3. params.put("SignatureNonce", java.util.UUID.randomUUID().toString());
  4. params.put("AccessKeyId", accessKeyId);
  5. params.put("SignatureVersion", "1.0");
  6. params.put("Timestamp", df.format(new java.util.Date()));
  7. params.put("Format", "JSON");
  8. // 2. 业务API参数
  9. params.put("Action", "CreateLabelTask");
  10. params.put("Version", "2019-08-10");
  11. params.put("ApplicationId", "applicationId");
  12. params.put("VideoName", "test1");
  13. params.put("VideoUrl", "http://XXX.mp4");

去除签名关键字Key:

  1. if (params.containsKey("Signature")){
  2. params.remove("Signature");
  3. }

2.根据参数Key排序(顺序)

参考代码如下:

  1. java.util.TreeMap<String, Object> sortParas = new java.util.TreeMap<String, Object>();
  2. sortParas.putAll(params);

3.构造待签名的请求串

首先介绍下面会用到的特殊URL编码这个是POP特殊的一种规则,即在一般的URLEncode后再增加三种字符替换:加号 (+)替换成 %20、星号 (*)替换成 %2A、 %7E 替换回波浪号 (~)参考代码如下:

  1. public static String specialUrlEncode(String value) throws Exception {
  2. return java.net.URLEncoder.encode(value, "UTF-8").replace("+", "%20").replace("*", "%2A").replace("%7E", "~");
  3. }

构造待签名的请求串:

参考代码如下:

  1. java.util.Iterator<String> it = sortParas.keySet().iterator();
  2. StringBuilder sortQueryStringTmp = new StringBuilder();
  3. while (it.hasNext()) {
  4. String key = it.next();
  5. sortQueryStringTmp.append("&").append(specialUrlEncode(key)).append("=").append(specialUrlEncode(String.valueOf(params.get(key))));
  6. }
  7. String sortedQueryString = sortQueryStringTmp.substring(1);// 去除第一个多余的&符号

按POP的签名规则拼接成最终的待签名串。规则如下:

  1. HTTPMethod + “&” + specialUrlEncode(“/”) + ”&” + specialUrlEncode(sortedQueryString)

参考代码如下:

  1. StringBuilder stringToSign = new StringBuilder();
  2. stringToSign.append("GET").append("&");
  3. stringToSign.append(specialUrlEncode("/")).append("&");
  4. stringToSign.append(specialUrlEncode(sortedQueryString));

4.签名

签名采用HmacSHA1算法 + Base64,编码采用UTF-8。参考代码如下:

  1. String sign = sign(accessSecret + "&", stringToSign.toString());
  2. public static String sign(String accessSecret, String stringToSign) throws Exception {
  3. javax.crypto.Mac mac = javax.crypto.Mac.getInstance("HmacSHA1");
  4. mac.init(new javax.crypto.spec.SecretKeySpec(accessSecret.getBytes("UTF-8"), "HmacSHA1"));
  5. byte[] signData = mac.doFinal(stringToSign.getBytes("UTF-8"));
  6. return new sun.misc.BASE64Encoder().encode(signData);
  7. }

参数说明:

accessSecret:你的AccessKeyId对应的秘钥AccessSecret,特别说明:POP要求需要后面多加一个“&”字符,即accessSecret + “&”stringToSign:即第三步生成的待签名请求串

5.增加签名结果到请求参数中,发送请求

说明 签名也要做特殊URL编码。

  1. String Signature = specialUrlEncode(sign);

JAVA示例

完整的Java签名Demo代码:

  1. public static void main(String[] args) throws Exception{
  2. String accessKeyId = "testId";
  3. String accessSecret = "testSecret";
  4. java.text.SimpleDateFormat df = new java.text.SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
  5. df.setTimeZone(new java.util.SimpleTimeZone(0, "GMT"));// 这里一定要设置GMT时区
  6. java.util.Map<String, Object> paras = new java.util.HashMap<String, Object>();
  7. // 1. 系统参数
  8. paras.put("SignatureMethod", "HMAC-SHA1");
  9. paras.put("SignatureNonce", java.util.UUID.randomUUID().toString());
  10. paras.put("AccessKeyId", accessKeyId);
  11. paras.put("SignatureVersion", "1.0");
  12. paras.put("Timestamp", df.format(new java.util.Date()));
  13. paras.put("Format", "JSON");
  14. // 2. 业务API参数
  15. paras.put("Action", "CreateLabelTask");
  16. paras.put("Version", "2019-08-10");
  17. paras.put("ApplicationId", "applicationId");
  18. paras.put("VideoName", "test1");
  19. paras.put("VideoUrl", "http://XXX.mp4");
  20. // 3. 去除签名关键字Key
  21. if (paras.containsKey("Signature"))
  22. paras.remove("Signature");
  23. // 4. 参数KEY排序
  24. java.util.TreeMap<String, Object> sortParas = new java.util.TreeMap<String, Object>();
  25. sortParas.putAll(paras);
  26. // 5. 构造待签名的字符串
  27. java.util.Iterator<String> it = sortParas.keySet().iterator();
  28. StringBuilder sortQueryStringTmp = new StringBuilder();
  29. while (it.hasNext()) {
  30. String key = it.next();
  31. sortQueryStringTmp.append("&").append(specialUrlEncode(key)).append("=").append(specialUrlEncode(String.valueOf(paras.get(key))));
  32. }
  33. String sortedQueryString = sortQueryStringTmp.substring(1);// 去除第一个多余的&符号
  34. StringBuilder stringToSign = new StringBuilder();
  35. stringToSign.append("GET").append("&");
  36. stringToSign.append(specialUrlEncode("/")).append("&");
  37. stringToSign.append(specialUrlEncode(sortedQueryString));
  38. String sign = sign(accessSecret + "&", stringToSign.toString());
  39. // 6. 签名最后也要做特殊URL编码
  40. String signature = specialUrlEncode(sign);
  41. // 最终生成合法GET请求的URL
  42. String url = "https://multimediaai.cn-beijing.aliyuncs.com/?Signature=" + signature + sortQueryStringTmp;
  43. }
  44. public static String specialUrlEncode(String value) throws Exception {
  45. return java.net.URLEncoder.encode(value, "UTF-8").replace("+", "%20").replace("*", "%2A").replace("%7E", "~");
  46. }
  47. public static String sign(String accessSecret, String stringToSign) throws Exception {
  48. javax.crypto.Mac mac = javax.crypto.Mac.getInstance("HmacSHA1");
  49. mac.init(new javax.crypto.spec.SecretKeySpec(accessSecret.getBytes("UTF-8"), "HmacSHA1"));
  50. byte[] signData = mac.doFinal(stringToSign.getBytes("UTF-8"));
  51. return new sun.misc.BASE64Encoder().encode(signData);
  52. }