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

您的用户名/密码是用于登录消息队列 for Apache Kafka 控制台的身份凭据,与此类似,AccessKey 是用于调用 API 的身份凭据。AccessKey 中的 AccessKeyId 是访问者身份,AccessKeySecret 是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。

说明 消息队列 for Apache Kafka 提供了多种编程语言的 SDK,可以免去您签名的烦恼。更多详情,请下载 SDK

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

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

  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 替换为波浪号(~),即可得到上述规则描述的编码字符串。示例如下:

      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 方法,例如 POST。
    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。
  3. 添加根据 RFC3986 规则编码后的参数 Signature 到规范化请求字符串URL中。

示例一:参数拼接法

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

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

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

    POST&%2F&AccessKeyId%3Dtestid&Action%3DGetInstanceList&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&,计算得到的签名值为 OLeaidS1JvxuMvnyHOwuJ+uX5qY=。示例使用的是 Java Base64 编码方法。

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

    http://alikafka.%s.aliyuncs.com/?SignatureVersion=1.0&Action=GetInstanceList&Format=JSON&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
    					

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

示例二:编程语言法

依然以调用 GetInstanceList 获取实例列表为例。假设您获得了 AccessKeyID=testid 以及 AccessKeySecret=testsecret,并且假定所有请求参数放在一个 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 必须符合 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 = "POST";
    Map parameters = new HashMap();
    // 输入请求参数
    parameters.put("Action", "GetInstanceList");
    parameters.put("Version", "2014-05-26");
    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", "JSON");
    // 排序请求参数
    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%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));