全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 更多
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 智能硬件
云服务器 ECS

签名机制

更新时间:2018-04-17 13:31:31

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

AccessKey 相当于用户密码,AccessKey 用于调用 API,而用户密码用于登录 管理控制台。其中 AccessKeyID 是访问者身份,AccessKeySecret 是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。更多详情,请参阅 创建AccessKey

说明:我们提供了多种编程语言的 SDK 及第三方 SDK,可以免去您签名的烦恼。更多详情,请参阅 阿里云开发工具包(SDK)

签名流程

步骤 1. 构造规范化请求字符串

  1. 排序参数。排序规则以首字母顺序排序,排序参数包括 公共请求参数 和接口自定义参数,不包括公共请求参数中的 Signature 参数。

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

  2. 编码参数。使用 UTF-8 字符集按照 RFC3986 规则编码请求参数和参数取值,编码规则如下:

    • 字符 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,可以先用标准库中 percentEncode 编码,随后将编码后的字符中加号(+)替换为 %20、星号(*)替换为 %2A%7E 替换为波浪号(~),即可得到上述规则描述的编码字符串。

      1. private static final String ENCODING = "UTF-8";
      2. private static String percentEncode(String value) throws UnsupportedEncodingException {
      3. return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
      4. }
  3. 使用等号(=)连接编码后的请求参数和参数取值。

  4. 使用与号(&)连接编码后的请求参数,注意参数排序与 步骤 1 一致。

现在,您得到了规范化请求字符串(CanonicalizedQueryString),其结构遵循 请求结构

步骤 2. 构造签名字符串

  1. 构造待签名字符串 StringToSign您可以同样使用 percentEncode 处理上一步构造的规范化请求字符串,规则如下:

    1. StringToSign=
    2. HTTPMethod + "&" + //HTTPMethod:发送请求的 HTTP 方法,例如 GET。
    3. percentEncode("/") + "&" + //percentEncode("/"):字符(/)UTF-8 编码得到的值,即 %2F。
    4. percentEncode(CanonicalizedQueryString) //您的规范化请求字符串。
  2. 按照 RFC2104 的定义,计算待签名字符串 StringToSign 的 HMAC-SHA1 值。示例使用的是 Java Base64 编码方法。

    1. Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )

    注意:计算签名时,RFC2104 规定的 Key 值是您的 AccessKeySecret 并加上与号(&),其 ASCII 值为 38。更多详情,请参阅 创建AccessKey

  3. 添加根据 RFC3986 规则编码后的参数 Signature 到规范化请求字符串 URL 中。

示例 1. 参数拼接法

以调用 DescribeRegions 查询地域为例。假设您获得了 AccessKeyID=testid 以及 AccessKeySecret=testsecret,签名流程如下所示:

  1. 构造规范化请求字符串。

    1. http://ecs.aliyuncs.com/?Timestamp=2016-02-23T12:46:24Z&Format=XML&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&SignatureVersion=1.0
  2. 构造待签名字符串 StringToSign

    1. GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeRegions&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&Timestamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2014-05-26
  3. 计算签名值。因为 AccessKeySecret=testsecret,用于计算的 Key 为 testsecret&,计算得到的签名值为 CT9X0VtwR86fNWSnsc6v8YGOjuE=。示例使用的是 Java Base64 编码方法。

    1. Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
  4. 添加 RFC3986 规则编码后的 Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D步骤 1 的 URL 中。

    1. http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureMethod=HMAC-SHA1&Timestamp=2018-04-17T03%3A09%3A55Z

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

示例 2. 编程语言法

依然以调用 DescribeRegions 查询地域为例。假设您获得了 AccessKeyID=testid 以及 AccessKeySecret=testsecret,并且假定所有请求参数放在一个 Java Map<String, String> 对象里。

  1. 预定义编码方法。

    1. private static final String ENCODING = "UTF-8";
    2. private static String percentEncode(String value) throws UnsupportedEncodingException {
    3. return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
    4. }
  2. 预定义编码时间格式 Timestamp。参数 Timestamp 必须符合 ISO8601 规范,并需要使用 UTC 时间。

    1. private static final String ISO8601_DATE_FORMAT = "YYYY-MM-DD'T'HH:mm:ss'Z'";
    2. private static String formatIso8601Date(Date date) {
    3. SimpleDateFormat df = new SimpleDateFormat(ISO8601_DATE_FORMAT);
    4. df.setTimeZone(new SimpleTimeZone(0, "GMT"));
    5. return df.format(date);
    6. }
  3. 构造请求字符串。

    1. final String HTTP_METHOD = "GET";
    2. Map<String, String> parameters = new HashMap<String, String>();
    3. // 输入请求参数
    4. parameters.put("Action", "DescribeRegions");
    5. parameters.put("Version", "2014-05-26");
    6. parameters.put("AccessKeyId", "testid");
    7. parameters.put("Timestamp", formatIso8601Date(new Date()));
    8. parameters.put("SignatureMethod", "HMAC-SHA1");
    9. parameters.put("SignatureVersion", "1.0");
    10. parameters.put("SignatureNonce", UUID.randomUUID().toString());
    11. parameters.put("Format", "XML");
    12. // 排序请求参数
    13. String[] sortedKeys = parameters.keySet().toArray(new String[]{});
    14. Arrays.sort(sortedKeys);
    15. final String SEPARATOR = "&";
    16. // 构造 stringToSign 字符串
    17. StringBuilder stringToSign = new StringBuilder();
    18. stringToSign.append(HTTP_METHOD).append(SEPARATOR);
    19. stringToSign.append(percentEncode("/")).append(SEPARATOR);
    20. StringBuilder canonicalizedQueryString = new StringBuilder();
    21. for(String key : sortedKeys) {
    22. // 这里注意编码 key 和 value
    23. canonicalizedQueryString.append("&")
    24. .append(percentEncode(key)).append("=")
    25. .append(percentEncode(parameters.get(key)));
    26. }
    27. // 这里注意编码 canonicalizedQueryString
    28. stringToSign.append(percentEncode(
    29. canonicalizedQueryString.toString().substring(1)));
  4. 签名。因为 AccessKeySecret=testsecret,所以用于计算 HMAC 的 Key 为 testsecret&,计算得到的签名值为 CT9X0VtwR86fNWSnsc6v8YGOjuE%3D

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

    增加签名参数后,按照 RFC3986 规则编码后的 URL 如下所示:

    1. http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureMethod=HMAC-SHA1&Timestamp=2018-04-17T03%3A09%3A55Z
  5. 使用浏览器、curl 或者 wget 等工具发送 HTTP 请求。

    1. <DescribeRegionsResponse>
    2. <Regions>
    3. <Region>
    4. <LocalName>青岛节点</LocalName>
    5. <RegionId>cn-qingdao</RegionId>
    6. </Region>
    7. <Region>
    8. <LocalName>杭州节点</LocalName>
    9. <RegionId>cn-hangzhou</RegionId>
    10. </Region>
    11. </Regions>
    12. <RequestId>833C6B2C-E309-45D4-A5C3-03A7A7A48ACF</RequestId>
    13. </DescribeRegionsResponse>

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

本文导读目录