对于每一次HTTP或者HTTPS协议请求,阿里云会根据访问中的签名信息验证访问请求者身份。具体由使用AccessKey ID和AccessKey Secret对称加密验证实现。

说明
  • AccessKey相当于用户密码,AccessKey用于调用API,而用户密码用于登录弹性容器实例控制台。其中AccessKey ID是访问者身份,AccessKey Secret是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。更多详情,请参见获取AccessKey
  • 弹性容器实例提供了多种编程语言的SDK及第三方SDK,可以免去您签名的烦恼。更多信息,请参见SDK概述

概述

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对请求进行对称加密后生成的签名值。

步骤一:构造规范化请求字符串

  1. 排序参数。
    排序规则以首字母顺序排序,排序参数包括公共请求参数和接口自定义参数,但不包括公共请求参数中的Signature参数。
    说明 当使用GET方法提交请求时,这些参数就是请求URL中的参数部分,即URL中?之后由&连接的部分。
  2. 编码参数。
    使用UTF-8字符集,按照RFC 3986规则编码请求参数的名称和取值,编码规则可参考下表。
    字符 编码方式
    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. 将使用等号连接得到的请求参数组合,使用与号(&)进行连接。

    连接时,参数排序需与第1步保持一致,连接完成后即可得到规范化请求字符串(CanonicalizedQueryString),其结构遵循请求结构。更多信息,请参见请求结构

步骤二:构造签名字符串

  1. 构造待签名字符串StringToSign
    按照以下规则,使用percentEncode处理步骤一构造的规范化请求字符串。
    StringToSign=
      HTTPMethod + "&" +
      percentEncode("/") + "&" +
      percentEncode(CanonicalizedQueryString)
    • HTTPMethod为发送请求的HTTP方法,例如GET。
    • percentEncode(“/”)为字符/使用UTF-8字符集,按照RFC 3986规则编码得到的值,即%2F。
    • percentEncode(CanonicalizedQueryString)为规范化请求字符串使用UTF-8字符集,按照RFC 3986规则编码得到的字符串。
  2. 按照RFC 2104的定义,计算待签名字符串StringToSign的HMAC-SHA1值。
    以下示例使用Java Base64编码方法:
    Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
    说明 计算签名值时,RFC 2104规定的Key值是您的AccessKeySecret并加上与号(&),其ASCII值为38。
  3. 添加根据RFC 3986规则编码后的参数Signature到规范化请求字符串URL中。

示例一:参数拼接法

以调用DescribeRegions查询地域为例。假设使用的AccessKey IdtestidAccessKey Secrettestsecret。流程如下所示:

  1. 构造规范化请求字符串。
    假设请求URL为:
    http://eci.aliyuncs.com/?Timestamp=2016-02-23T12%3A46%3A24Z&Format=XML&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2018-08-08&SignatureVersion=1.0
    则按照规则,构造规范化请求字符串为:
    AccessKeyId%3Dtestid%26Action%3DDescribeRegions%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26Timestamp%3D2016-02-23T12%253A46%253A24Z%26Version%3D2018-08-08
  2. 构造待签名字符串(StringToSign)。
    GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeRegions%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26Timestamp%3D2016-02-23T12%253A46%253A24Z%26Version%3D2018-08-08
  3. 计算签名值。

    由于AccessKeySecret=testsecret,则用于计算HMAC的Key为testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ+uX5qY=。示例使用的是Java Base64编码方法。

    Signature = Base64(HMAC-SHA1(AccessSecret,UTF-8-Encoding-Of(StringToSign)))
  4. 添加按RFC 3986规则编码后的Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D到规范化请求字符串中。
    http://eci.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2018-08-08&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%253A46%253A24Z

通过以上URL,您可以使用浏览器、curl或者wget等工具发起HTTP请求调用DescribeRegions,查看地域列表。

示例二:编程语言法

以调用DescribeRegions查询地域为例。假设使用的AccessKey IdtestidAccessKey Secrettestsecret,并且假定所有请求参数放在一个Java Map<String, String>对象里。

  1. 预定义编码方法。
    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;
    }
  2. 预定义编码时间格式Timestamp。参数Timestamp必须符合ISO 8601规范,并需要使用UTC时间,时区为+0。
    private static final String ISO8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
    private static String formatIso8601Date(Date date) {
      SimpleDateFormat df = new SimpleDateFormat(ISO8601_DATE_FORMAT);
      df.setTimeZone(new SimpleTimeZone(0, "GMT"));
      return df.format(date);
    }
  3. 构造请求字符串。
    final String HTTP_METHOD = "GET";
    Map parameters = new HashMap();
    // 输入请求参数
    parameters.put("Action", "DescribeRegions");
    parameters.put("Version", "2018-08-08");
    parameters.put("AccessKeyId", "testid");
    parameters.put("Timestamp", formatIso8601Date(new Date()));
    parameters.put("SignatureMethod", "HMAC-SHA1");
    parameters.put("SignatureVersion", "1.0");
    parameters.put("SignatureNonce", UUID.randomUUID().toString());
    parameters.put("Format", "XML");
    // 排序请求参数
    String[] sortedKeys = parameters.keySet().toArray(new String[]{});
    Arrays.sort(sortedKeys);
    final String SEPARATOR = "&";
    // 构造 stringToSign 字符串
    StringBuilder stringToSign = new StringBuilder();
    stringToSign.append(HTTP_METHOD).append(SEPARATOR);
    stringToSign.append(percentEncode("/")).append(SEPARATOR);
    StringBuilder canonicalizedQueryString = new StringBuilder();
    for(String key : sortedKeys) {
    // 这里注意编码 key 和 value
      canonicalizedQueryString.append("&")
      .append(percentEncode(key)).append("=")
      .append(percentEncode(parameters.get(key)));
    }
    // 这里注意编码 canonicalizedQueryString
    stringToSign.append(percentEncode(
      canonicalizedQueryString.toString().substring(1)));
  4. 计算签名。

    由于AccessKeySecret=testsecret,则用于计算HMAC的Key为testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ+uX5qY=

    // 以下是一段计算签名的示例代码
    final String ALGORITHM = "HmacSHA1";
    final String ENCODING = "UTF-8";
    key = "testsecret&";
    Mac mac = Mac.getInstance(ALGORITHM);
    mac.init(new SecretKeySpec(key.getBytes(ENCODING), ALGORITHM));
    byte[] signData = mac.doFinal(stringToSign.getBytes(ENCODING));
    String signature = new String(Base64.encodeBase64(signData));

    添加签名参数Signature后,按照RFC 3986规则编码后的URL如下所示:

    http://eci.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%253A46%253A24Z
  5. 使用浏览器、curl或者wget等工具发送HTTP请求。
    <DescribeRegionsResponse>
     <Regions>
         <Region>
             <LocalName>青岛节点</LocalName>
             <RegionId>cn-qingdao</RegionId>
         </Region>
         <Region>
             <LocalName>杭州节点</LocalName>
             <RegionId>cn-hangzhou</RegionId>
         </Region>
     </Regions>
     <RequestId>833C6B2C-E309-45D4-A5C3-03A7A7A48ACF</RequestId>
    </DescribeRegionsResponse>

返回结果列举了地域和地域ID列表。如果您在提交请求时,指定参数Format=JSON,那么返回结果的格式为JSON格式而不是XML格式。更多信息,请参见返回结果