全部产品
阿里云办公

签名方法

更新时间:2018-04-23 20:47:33

签名机制

ROA风格API签名包含两部分:公共请求头(HTTP 协议 header 参数和阿里云协议 Header 参数)和 CanonicalizedResource(规范资源)。推荐使用SDK接入,用户可以不关注签名细节。

名称 描述
Authorization 用于验证请求合法性的认证信息,采用 acs AccessKeyId:signature 格式。
Content-Length RFC 2616 中定义的 HTTP 请求内容长度。
Content-Type RFC 2616 中定义的 HTTP 请求内容类型。
Content-MD5 HTTP 协议消息体的 128-bit MD5 散列值转换成 BASE64 编码的结果。为了防止所有请求被篡改,建议所有请求都附加该信息。
Date 描述请求时间,GMT 格式,如: Wed, 26 Aug. 2015 17:01:00 GMT。
Accept 客户端需要的返回值类型,只支持 application/json
Host 访问 Host 值,例如:nlp.cn-shanghai.aliyuncs.com。
x-acs-signature-nonce 唯一随机数,用于防止网络重放攻击。用户在不同请求中要使用不同的随机数值。
x-acs-signature-method 签名方法,目前只支持 HMAC-SHA1。
x-acs-version API版本, 如果不填写,服务端默认取最高版本

签名计算方法

ROA风格的API请求使用标准的Authorization头来签名自己的请求,请求格式如下:

Authorization: acs AccessKeyId:Signature

  1. 计算body的MD5值,然后再对其进行base64编码,编码后的值设置到 Header中。

  2. 使用请求中的Header参数构造规范化的Header字符串

    1. headerStringToSign =
    2. HTTP-Verb + "\n" + //HTTP_Verb只支持POST
    3. Accept + \n + //Acceptapplication/json
    4. Content-MD5 + "\n" + //第1步中计算出来的MD5
    5. Content-Type + "\n" + //Content-Type值为application/json;chrset=utf-8
    6. Date + "\n" + //Date值为GMT时间
    7. x-acs-signature-method:HMAC-SHA1\n +
    8. x-acs-signature-nonce:” + ${x-acs-signature-nonce} + "\n" +
    9. x-acs-version:2018-04-04" + "\n";
  3. CanonicalizedResource 表示客户想要访问资源的规范描述,需要将子资源和qurey一同按照字典序,从小到大排列并以 & 为分隔符生成子资源字符串(?后的所有参数),示例如下(nlp所有请求都不带参数)。

    1. resourceStringToSign =
    2. URI + "?instanceName=" + ${instanceName};
  4. 将上两步构造的规范化字符串按照下面的规则构造成待签名的字符串。
    stringToSign = headerStringToSign + resourceStringToSign;

  5. 按照 RFC2104的定义,计算待签名字符串StringToSign的 HMAC 值,按照 Base64 编码规则把上面的 HMAC 值编码成字符串,并在前面加上AccessKeyId,即得到签名值(Authorization),示例如下:

    1. Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
    2. Authorization = "acs " + AccessKeyId + ":" + Signature

代码示例(java)

  1. import java.io.BufferedReader;
  2. import java.io.IOException;
  3. import java.io.InputStream;
  4. import java.io.InputStreamReader;
  5. import java.io.PrintWriter;
  6. import java.net.HttpURLConnection;
  7. import java.net.URL;
  8. import java.net.URLConnection;
  9. import java.security.MessageDigest;
  10. import java.text.SimpleDateFormat;
  11. import java.util.Date;
  12. import java.util.Locale;
  13. import java.util.UUID;
  14. import javax.crypto.spec.SecretKeySpec;
  15. import sun.misc.BASE64Encoder;
  16. import javax.crypto.Mac;
  17. public class Sender {
  18. /*
  19. * 计算MD5+BASE64
  20. */
  21. public static String MD5Base64(String s) {
  22. if (s == null)
  23. return null;
  24. String encodeStr = "";
  25. byte[] utfBytes = s.getBytes();
  26. MessageDigest mdTemp;
  27. try {
  28. mdTemp = MessageDigest.getInstance("MD5");
  29. mdTemp.update(utfBytes);
  30. byte[] md5Bytes = mdTemp.digest();
  31. BASE64Encoder b64Encoder = new BASE64Encoder();
  32. encodeStr = b64Encoder.encode(md5Bytes);
  33. } catch (Exception e) {
  34. throw new Error("Failed to generate MD5 : " + e.getMessage());
  35. }
  36. return encodeStr;
  37. }
  38. /*
  39. * 计算 HMAC-SHA1
  40. */
  41. public static String HMACSha1(String data, String key) {
  42. String result;
  43. try {
  44. SecretKeySpec signingKey = new SecretKeySpec(key.getBytes(), "HmacSHA1");
  45. Mac mac = Mac.getInstance("HmacSHA1");
  46. mac.init(signingKey);
  47. byte[] rawHmac = mac.doFinal(data.getBytes());
  48. result = (new BASE64Encoder()).encode(rawHmac);
  49. } catch (Exception e) {
  50. throw new Error("Failed to generate HMAC : " + e.getMessage());
  51. }
  52. return result;
  53. }
  54. /*
  55. * 获取时间
  56. */
  57. public static String toGMTString(Date date) {
  58. SimpleDateFormat df = new SimpleDateFormat("E, dd MMM yyyy HH:mm:ss z", Locale.UK);
  59. df.setTimeZone(new java.util.SimpleTimeZone(0, "GMT"));
  60. return df.format(date);
  61. }
  62. /*
  63. * 发送POST请求
  64. */
  65. public static String sendPost(String url, String body, String ak_id, String ak_secret) {
  66. PrintWriter out = null;
  67. BufferedReader in = null;
  68. String result = "";
  69. try {
  70. URL realUrl = new URL(url);
  71. /*
  72. * http header 参数
  73. */
  74. String method = "POST";
  75. String accept = "application/json";
  76. String content_type = "application/json;chrset=utf-8";
  77. String path = realUrl.getFile();
  78. String date = toGMTString(new Date());
  79. String host = realUrl.getHost();
  80. // 1.对body做MD5+BASE64加密
  81. String bodyMd5 = MD5Base64(body);
  82. String uuid = UUID.randomUUID().toString();
  83. String stringToSign = method + "\n" + accept + "\n" + bodyMd5 + "\n" + content_type + "\n" + date + "\n"
  84. + "x-acs-signature-method:HMAC-SHA1\n"
  85. + "x-acs-signature-nonce:" + uuid + "\n"
  86. //+ "x-acs-version:2018-04-04\n"
  87. + path;
  88. // 2.计算 HMAC-SHA1
  89. String signature = HMACSha1(stringToSign, ak_secret);
  90. // 3.得到 authorization header
  91. String authHeader = "acs " + ak_id + ":" + signature;
  92. // 打开和URL之间的连接
  93. URLConnection conn = realUrl.openConnection();
  94. // 设置通用的请求属性
  95. conn.setRequestProperty("Accept", accept);
  96. conn.setRequestProperty("Content-Type", content_type);
  97. conn.setRequestProperty("Content-MD5", bodyMd5);
  98. conn.setRequestProperty("Date", date);
  99. conn.setRequestProperty("Host", host);
  100. conn.setRequestProperty("Authorization", authHeader);
  101. conn.setRequestProperty("x-acs-signature-nonce", uuid);
  102. conn.setRequestProperty("x-acs-signature-method", "HMAC-SHA1");
  103. //conn.setRequestProperty("x-acs-version", "2018-04-04"); // 版本可选
  104. // 发送POST请求必须设置如下两行
  105. conn.setDoOutput(true);
  106. conn.setDoInput(true);
  107. // 获取URLConnection对象对应的输出流
  108. out = new PrintWriter(conn.getOutputStream());
  109. // 发送请求参数
  110. out.print(body);
  111. // flush输出流的缓冲
  112. out.flush();
  113. // 定义BufferedReader输入流来读取URL的响应
  114. InputStream is;
  115. HttpURLConnection httpconn = (HttpURLConnection) conn;
  116. if (httpconn.getResponseCode() == 200) {
  117. is = httpconn.getInputStream();
  118. } else {
  119. is = httpconn.getErrorStream();
  120. }
  121. in = new BufferedReader(new InputStreamReader(is));
  122. String line;
  123. while ((line = in.readLine()) != null) {
  124. result += line;
  125. }
  126. } catch (Exception e) {
  127. System.out.println("发送 POST 请求出现异常!" + e);
  128. e.printStackTrace();
  129. }
  130. // 使用finally块来关闭输出流、输入流
  131. finally {
  132. try {
  133. if (out != null) {
  134. out.close();
  135. }
  136. if (in != null) {
  137. in.close();
  138. }
  139. } catch (IOException ex) {
  140. ex.printStackTrace();
  141. }
  142. }
  143. return result;
  144. }
  145. }