全部产品
阿里云办公

签名机制

更新时间:2018-04-04 10:18:19

云小蜜 API 对每个访问的请求进行身份验证,所以无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含签名(Signature)信息。通过使用 Access Key ID 和 Access Key Secret 进行对称加密的方法来验证请求的发送者身份。Access Key ID 和 Access Key Secret 由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中 Access Key ID 用于标识访问者的身份;Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密,只有阿里云和用户知道。

用户在访问时,按照下面的方法对请求进行签名处理:

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

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

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

    2. 对每个请求参数的名称和值进行编码。名称和值要使用 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”替换回波浪号“~”,即可得到上述规则描述的编码字符串。

    3. 对编码后的参数名称和值使用英文等号“=”进行连接。

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

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

    1. StringToSign=
    2. HTTPMethod + “&” +
    3. percentEncode(“/”) + ”&” +
    4. percentEncode(CanonicalizedQueryString)
    • HTTPMethod 是提交请求用的 HTTP 方法,比如 GET。
    • percentEncode(“/”) 是按照 1.ii 中描述的URL编码规则对字符“/”进行编码得到的值,即“%2F”。
    • percentEncode(CanonicalizedQueryString)是对第 1 步中构造的规范化请求字符串按 1.ii 中描述的 URL 编码规则编码后得到的字符串。
  3. 按照 RFC2104 的定义,使用上面的用于签名的字符串计算签名 HMAC 值。

    注意:计算签名时使用的 Key 就是用户持有的 Access Key Secret 并加上一个“&”字符(ASCII:38),使用的哈希算法是 SHA1。

  4. 按照 Base64 编码规则把上面的 HMAC 值编码成字符串,即得到签名值(Signature)。

  5. 将得到的签名值作为 Signature 参数添加到请求参数中,即完成请求签名的过程。

    注意:得到的签名值在作为最后的请求参数值提交给云小蜜服务器的时候,要和其他参数一样,按照 RFC3986 的规则进行 URL 编码。

    以 Chat 为例,签名前的请求 URL 为:

    1. https://chatbot.cn-shanghai.aliyuncs.com/?Timestamp=2017-10-11T11%3A10%3A07Z&Format=XML&AccessKeyId=testid&Action=Chat&SignatureMethod=HMAC-SHA1&RegionId=cn-shanghai&SignatureNonce=1324fd0e-e2bb-4bb1-917c-bd6e437f1710&SignatureVersion=1.0&Version=2017-10-11

    那么 StringToSign 就是:

    1. GET&%2F&AccessKeyId%3Dtestid&Action%3DChat&Format%3DXML&RegionId%3Dcn-shanghai&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3Dfece5dec-1a16-497c-b598-8640f85a8637&SignatureVersion%3D1.0&Timestamp%3D2017-10-11T11%253A10%253A07Z&Version%3D2017-10-11

    假如使用的 Access Key Id 是“testid”,Access Key Secret 是“testsecret”,用于计算 HMAC 的 Key 就是“testsecret&”,则计算得到的签名值是WnTdGgI9QNHAqhzYNuY9G8gBJG4=

    签名后的请求 URL 为(注意增加了 Signature 参数):

    1. https://chatbot.cn-shanghai.aliyuncs.com/?SignatureVersion=1.0&Action=Chat&Format=XML&SignatureNonce=fece5dec-1a16-497c-b598-8640f85a8637&Version=2017-10-11&AccessKeyId=testid&Signature=WnTdGgI9QNHAqhzYNuY9G8gBJG4%3D&SignatureMethod=HMAC-SHA1&RegionId=cn-shanghai&Timestamp=2017-10-11T11%3A10%3A07Z