全部产品

签名机制

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

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

说明云效提供了多种编程语言的SDK及第三方SDK,可以免去您签名的烦恼。更多详情,请下载 SDK

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

  1. 排序参数。排序规则以首字母顺序排序,排序参数包括公共参数和接口自定义参数,不包括公共请求参数中的Signature参数。当使用GET方法提交请求时,这些参数就是请求 URL 中的参数部分,即 URL 中?之后由&连接的部分。

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

    1. 字符A~Z、a~z、0~9以及字符-_.~不编码。

    2. 其它字符编码成%XY的格式,其中XY是字符对应ASCII码的16进制。示例:半角双引号(")对应%22

    3. 扩展的UTF-8字符,编码成%XY%ZA…的格式。

    4. 空格( )编码成%20,而不是加号(+)。该编码方式与application/x-www-form-urlencodedMIME格式编码算法相似,但又有所不同。如果您使用的是Java标准库中的java.net.URLEncoder,可以先用标准库中percentEncode编码,随后将编码后的字符中加号(+)替换为%20、星号(*)替换为%2A%7E替换为波浪号(~),即可得到上述规则描述的编码字符串。

      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 + "&" + //HTTPMethod:发送请求的 HTTP 方法,例如 GET。
      percentEncode("/") + "&" + //percentEncode("/"):字符(/)UTF-8 编码得到的值,即 %2F。  
      percentEncode(CanonicalizedQueryString) //您的规范化请求字符串

  2. 按照 RFC2104的定义,计算待签名字符串StringToSign的 HMAC-SHA1 值。示例使用的是 Java Base64 编码方法。

    Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
    说明

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

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

示例一:参数拼接法

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

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

    http://api-devops.cn-beijing.aliyuncs.com/?Timestamp=2016-02-23T12%3A46%3A24Z&Format=XML&AccessKeyId=testid&Action=ExecutePipeline&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2020-03-03&SignatureVersion=1.0

  2. 构造待签名字符串StringToSign。

    GET&%2F&AccessKeyId%3Dtestid%26Action%ExecutePipeline%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26Timestamp%3D2016-02-23T12%253A46%253A24Z%26Version%3D2020-03-03

  3. 计算签名值。因为AccessKeySecret=testsecret,用于计算的Key为testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ+uX5qY=。示例使用的是JavaBase64编码方法。

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

  4. 添加RFC3986规则编码后的Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D到步骤 1 的URL中。

    http://api-devops.cn-beijing.aliyuncs.com/?SignatureVersion=1.0&Action=ExecutePipeline&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2020-03-03&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%253A46%253A24Z

    通过以上URL,您可以使用浏览器、curl 或者 wget 等工具发起 HTTP 请求调用 ExecutePipeline

示例二:编程语言法

依然以调用 ExecutePipeline为例。假设您获得了AccessKeyID=testid以及AccessKeySecret=testsecret,并且假定所有请求参数放在一个JavaMap<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必须符合ISO8601规范,并需要使用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", "ExecutePipeline");
    parameters.put("Version", "2020-03-03");
    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)));}
    // 这里注意编码 
    canonicalizedQueryStringstringToSign.append(percentEncode(  canonicalizedQueryString.toString().substring(1)));

  4. 签名。因为AccessKeySecret=testsecret,所以用于计算 HMAC 的 Key 为testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D

    // 以下是一段计算签名的示例代码
    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));

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

    http://api-devops.cn-beijing.aliyuncs.com/?SignatureVersion=1.0&Action=ExecutePipeline&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2020-03-03&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%253A46%253A24Z