为保证API的安全调用,在调用API时阿里云会对每个API请求通过签名(Signature)进行身份验证。无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名信息。

概述

RPC API要按以下格式在API请求的Query中增加签名(Signature)。

https://Endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
其中:
  • SignatureMethod:签名方式,目前支持HMAC-SHA1。
  • SignatureVersion:签名算法版本,目前版本是1.0。
  • SignatureNonce:唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值,建议使用通用唯一识别码UUID(Universally Unique Identifier)。
  • Signature:使用AccessKey Secret对请求进行对称加密后生成的签名。
签名算法遵循RFC 2104 HMAC-SHA1规范,使用AccessKey Secret对编码、排序后的整个请求串计算HMAC值作为签名。签名的元素是请求自身的一些参数,由于每个API请求内容不同,所以签名的结果也不尽相同。可参考本文的操作步骤,计算签名值。
Signature = Base64( HMAC-SHA1( AccessKey Secret, UTF-8-Encoding-Of(StringToSign)) )

步骤一:构造待签名字符串

  1. 使用请求参数构造规范化的请求字符串(Canonicalized Query String)。
    1. 按照参数名称的字典顺序对请求中所有的请求参数(包括公共请求参数和接口的自定义参数,但不包括公共请求参数中的Signature参数)进行排序。
      说明 当使用GET方法提交请求时,这些参数就是请求URI中的参数部分,即URI中“?”之后由“&”连接的部分。
    2. 对排序之后的请求参数的名称和值分别用UTF-8字符集进行URL编码。编码规则请参考下表。
      字符 编码方式
      A~Z、a~z和0~9以及“-”、“_”、“.”和“~” 不编码。
      其它字符 编码成 %XY 的格式,其中 XY 是字符对应ASCII码的16进制表示。例如英文的双引号(")对应的编码为 %22
      扩展的UTF-8字符 编码成 %XY%ZA…的格式。
      英文空格 编码成 %20,而不是加号(+)。
      该编码方式和一般采用的application/x-www-form-urlencodedMIME格式编码算法(例如Java标准库中的java.net.URLEncoder的实现)存在区别。编码时可以先用标准库的方式进行编码,然后把编码后的字符串中的加号(+)替换成%20,星号(*)替换成%2A%7E替换回波浪号(~),即可得到上述规则描述的编码字符串。本算法可以用下面的percentEncode方法来实现:
      private static final String ENCODING = "UTF-8";
      private static String percentEncode(String value) throws UnsupportedEncodingException 
      {
      return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
      }
    3. 将编码后的参数名称和值用英文等号(=)进行连接。
    4. 将等号连接得到的参数组合按步骤i排好的顺序依次使用“&”符号连接,即得到规范化请求字符串。
  2. 将构造的规范化字符串按照下面的规则构造成待签名的字符串。
    StringToSign=
          HTTPMethod + “&” +
          percentEncode(“/”) + ”&” +
           percentEncode(CanonicalizedQueryString)

    其中:

    • HTTPMethod 是提交请求用的HTTP方法,例如GET。
    • percentEncode(“/”) 是按照URL编码规则对字符“/”进行编码得到的值,即%2F。
    • percentEncode(CanonicalizedQueryString) 是对构造的规范化请求字符串按URL编码规则编码后得到的字符串。

步骤二:计算签名值

  1. 按照RFC2104的定义,计算待签名字符串(StringToSign)的HMAC值。
    说明 计算签名时使用的Key就是您持有的AccessKey Secret并加上一个“&”字符(ASCII:38), 使用的哈希算法是SHA1。
  2. 按照Base64编码规则把上面的HMAC值编码成字符串,即得到签名值(Signature)。
  3. 将得到的签名值作为Signature参数添加到请求参数中。
    说明 得到的签名值在作为最后的请求参数值提交时要和其它参数一样,按照RFC3986的规则进行URL编码。

示例

下文以CreateUser为例,介绍签名的一个具体示例及结果。

签名前的请求URL为:

https://ram.aliyuncs.com/?UserName=test&SignatureVersion=1.0&Format=JSON&Timestamp=2015-08-18T03%3A15%3A45Z&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&Version=2015-05-01&Action=CreateUser&SignatureNonce=6a6e0ca6-4557-11e5-86a2-b8e8563dc8d2

对应的StringToSign为:

GET&%2F&AccessKeyId%3Dtestid%26Action%3DCreateUser%26Format%3DJSON%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D6a6e0ca6-4557-11e5-86a2-b8e8563dc8d2%26SignatureVersion%3D1.0%26Timestamp%3D2015-08-18T03%253A15%253A45Z%26UserName%3Dtest%26Version%3D2015-05-01

例如:AccessKey ID为:testid,AccessKey Secret为:testsecret,则用于计算HMAC的key为:testsecret&。

计算得到的签名值为:kRA2cnpJVacIhDMzXnoNZG9tDCI=

签名后的请求URL为:

https://ram.aliyuncs.com/?UserName=test&SignatureVersion=1.0&Format=JSON&Timestamp=2015-08-18T03%3A15%3A45Z&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&Version=2015-05-01&Signature=kRA2cnpJVacIhDMzXnoNZG9tDCI%3D&Action=CreateUser&SignatureNonce=6a6e0ca6-4557-11e5-86a2-b8e8563dc8d2