虚商集成涉及的阿里云服务会对每个访问的请求进行身份验证,所以无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含签名(Signature)信息。本文介绍 RPC 风格的 API 的签名机制。

说明

  • 消息服务类 API 属于 ROA 风格,其签名机制请参见请求签名机制
  • 安全访问类 API 接口无需签名。

签名机制概述

虚商集成涉及的阿里云服务通过使用 Access Key ID 和 Access Key Secret 进行对称加密的方法来验证请求的发送者身份。Access Key ID 和Access Key Secret 由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中 Access Key ID 用于标识访问者的身份。Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密,只有阿里云和用户知道。

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:唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值,建议使用通用唯一识别码(Universally Unique Identifier, UUID)。
  • Signature: 使用 AccessKey Secret 对请求进行对称加密后生成的签名。

计算签名

签名算法遵循 RFC 2104 HMAC-SHA1 规范,使用 AccessSecret 对编码、排序后的整个请求串计算 HMAC 值作为签名。签名的元素是请求自身的一些参数,由于每个 API 请求内容不同,所以签名的结果也不尽相同。

Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(
StringToSign)) )
完成以下操作,计算签名:
  1. 构建待签名字符串
    1. 使用请求参数构造规范化的请求字符串(Canonicalized Query String):
      1. 按照参数名称的字典顺序对请求中所有的请求参数(包括公共请求参数和接口的自定义参数,但不包括公共请求参数中的Signature参数)进行排序。

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

      2. 对排序之后的请求参数的名称和值分别用 UTF-8 字符集进行 URL 编码。编码规则如下:
        字符 编码方式
        A-Z、a-z 和 0-9 以及“-”、“_”、“.”和“~” 不编码。
        其它字符 编码成 %XY 的格式,其中 XY 是字符对应ASCII码的16进制表示。例如英文的双引号(””)对应的编码为 %22
        扩展的UTF-8字符 编码成 %XY%ZA…的格式。
        英文空格 编码成 %20,而不是加号(+)。
        该编码方式和一般采用的 application/x-www-form-urlencoded MIME格式编码算法(例如 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(“/”) 是按照步骤1.1中描述的 URL 编码规则对字符 “/” 进行编码得到的值,即 %2F。
      • percentEncode(CanonicalizedQueryString) 是对步骤1中构造的规范化请求字符串按步骤 1.2 中描述的URL编码规则编码后得到的字符串。
  2. 计算签名
    1. 按照RFC2104的定义,计算待签名字符串(StringToSign)的HMAC值。
      说明 计算签名时使用的Key就是您持有的AccessKey Secret并加上一个 “&” 字符(ASCII:38), 使用的哈希算法是SHA1。
    2. 按照Base64编码规则把上面的HMAC值编码成字符串,即得到签名值(Signature)。
    3. 将得到的签名值作为Signature参数添加到请求参数中。
      说明 得到的签名值在作为最后的请求参数值提交时要和其它参数一样,按照RFC3986的规则进行URL编码。

示例

GetBsnBySn 为例,假设使用的 Access Key IdtestidAccessKey Sercettestsecret
http://bsn.aliyuncs.com/?AccessKeyId=testKey&Action=GetBsnBySn&Format=XML&RegionId=cn-beijing&SignatureMethod=HMAC-SHA1&SignatureNonce=1432632186688&SignatureVersion=1.0&Timestamp=2015-05-26T09:23:06Z&Version=2015-05-12&sn=2015-05-12
那么,StringToSign 就是:
GET&%2F&AccessKeyId%3DtestKey%26Action%3DGetBsnBySn%26Format%3DXML%26RegionId%3Dcn-beijing%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D1432632186688%26SignatureVersion%3D1.0%26Timestamp%3D2015-05-26T09%253A23%253A06Z%26Version%3D2015-05-12%26sn%3D2015-05-12
使用testsecret&,计算得到的签名值是:
dIac/qOaYA0OoPI/8A8UxuEmDqk=
最后将签名作为Signature参数加入到URL请求中,最后得到的URL为:
http://http://bsn.aliyuncs.com/?AccessKeyId=testKey&Action=GetBsnBySn&Format=XML&RegionId=cn-beijing&SignatureMethod=HMAC-SHA1&SignatureNonce=1432632186688&SignatureVersion=1.0&Timestamp=2015-05-26T09:23:06Z&Version=2015-05-12&sn=2015-05-12&Signature=dIac/qOaYA0OoPI/8A8UxuEmDqk=.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ+uX5qY=&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%3A46%3A24Z