Tiven Wang
Wang Tiven September 08, 2017
425 favorite favorites
bookmark bookmark
share share

Aliyun API Signature

阿里云 开发API参考 签名机制

const crypto = require('crypto');

1 使用请求参数构造规范化的请求字符串(Canonicalized Query String)

a. 按照参数名称的字典顺序对请求中所有的请求参数(包括文档中描述的公共请求参数和给定的请求接口的自定义参数,但不能包括公共请求参数中提到 Signature 参数本身)进行排序。

注:当使用 GET 方法提交请求时,这些参数就是请求 URI 中的参数部分(即 URI 中 “?” 之后由 “&” 连接的部分)。

b. 对每个请求参数的名称和值进行编码。名称和值要使用 UTF-8 字符集进行 URL 编码,URL 编码的编码规则是:

  • 对于字符 A-Z、a-z、0-9 以及字符 “-”、“_”、“.”、“~” 不编码;
  • 对于其他字符编码成 %XY 的格式,其中 XY 是字符对应 ASCII 码 的 16 进制表示。比如半角的双引号(”)对应的编码就是 %22;
  • 对于扩展的 UTF-8 字符,编码成 %XY%ZA… 的格式;
  • 需要说明的是半角的空格( )要被编码是 %20,而不是加号(+)。

注:一般支持 URL 编码的库(比如 Java 中的 java.net.URLEncoder)都是按照 application/x-www-form-urlencoded 的 MIME 类型的规则进行编码的。实现时可以直接使用这类方式进行编码,把编码后的字符串中加号(+)替换成 %20、星号(*)替换成 %2A、%7E 替换回波浪号(~),即可得到上述规则描述的编码字符串。

对于 Javascript 语言,网络上常见代码都有一些问题: encodeURIComponent 函数转码后还要再转几个字符才复合要求

  function percentEncode(value) {
    var encoded = encodeURIComponent(value);
    return encoded.replace(/!/g, '%21').replace(/'/g, '%27').replace(/\(/g, '%28').replace(/\)/g, '%29').replace(/\*/g, '%2A');
  }

c. 对编码后的参数名称和值使用半角的等号(=)进行连接。

d. 再把半角的等号连接得到的字符串按参数名称的字典顺序依次使用 “&” 符号连接,即得到规范化请求字符串。

signature: function(params, accessKeySecret) {
  var queryParams = [], canonicalizedQueryString;
  var oa = Object.keys(params).sort();
  for (var i = 0; i < oa.length; i++) {
      var key = oa[i];
      queryParams.push(percentEncode(key) + '=' + percentEncode(params[key]));
  }
  canonicalizedQueryString = queryParams.join('&');
  ...
}

2 使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串:

 StringToSign=
 HTTPMethod + & +
 percentEncode(/) + & +
 percentEncode(CanonicalizedQueryString)

其中 HTTPMethod 是提交请求用的 HTTP 方法,比 GET、POST。
percentEncode(“/”)是按照 1.b 中描述的 URL 编码规则对字符 “/” 进行编码得到的值,即 %2F。
percentEncode (CanonicalizedQueryString) 是对第 1 步中构造的规范化请求字符串按 1.b 中描述的 URL 编码规则编码后得到的字符串。

var stringToSign = 'POST' + '&' + percentEncode('/') + '&' + percentEncode(canonicalizedQueryString);
accessKeySecret = accessKeySecret + '&';

3 按照 RFC2104 的定义,使用上面的用于签名的字符串计算签名 HMAC 值。注意:计算签名时使用的 Key 就是用户持有的 Access Key Secret 并加上一个 “&” 字符(ASCII:38),使用的哈希算法是 SHA1。
4 按照 Base64 编码规则把上面的 HMAC 值编码成字符串,即得到签名值(Signature)。

return crypto.createHmac('sha1', accessKeySecret).update(new Buffer(stringToSign, 'utf-8')).digest('base64');

5 将得到的签名值作为 Signature 参数添加到请求参数中,即完成对请求签名的过程。注意:得到的签名值在作为最后的请求参数值提交给 SMS 服务器的时候,要和其他参数一样,按照 RFC3986 的规则进行 URL 编码)。

var apiUrl = 'http://dysmsapi.aliyuncs.com/';
request.post({
    url: apiUrl,
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded'
    },
    form: params
}, callback);

完整代码:

Aliyun MNS Signature

https://help.aliyun.com/document_detail/27487.html

References

Similar Posts

Comments

comments powered by Disqus
Back to Top