PolarDB-X 1.0-API参考-1.0（2017版本）-OpenAPI使用-签名机制

关于 Access Key ID 与 Access Key Secret

• PolarDB-X 服务会对每个 API 的调用请求进行身份验证，所以无论使用 HTTP 还是 HTTPS 协议提交请求，都需要在请求中包含由 Access Key ID 与 Access Key Secret 所产生的签名（Signature）信息。
  
• Access Key ID 和 Access Key Secret 由阿里云官方颁发给访问者（可以通过阿里云官方网站申请和管理），其中 Access Key ID 用于标识访问者的身份。
  
• Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密，只有阿里云和用户知道。
  

签名方法

发送 OpenAPI 请求时，请按照下面的方法对请求进行签名处理：

1. 使用请求参数构造规范化的请求字符串（Canonicalized Query String）。1.1. 按照参数名称的字典顺序对请求中所有的请求参数（包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数，但不能包括“公共请求参数”中提到 Signature 参数本身）进行排序。注意：使用 GET 方法提交请求时，这些参数就是请求 URI 中的参数部分（即 URI 中“?”之后由“&”连接的部分）。1.2. 对每个请求参数的名称和值进行编码。名称和值要使用 UTF-8字符集进行 URL 编码，URL 编码的编码规则是：

• 对于字符 A-Z、a-z、0-9以及字符“-”、“_”、“.”、“~”不编码；
• 对于其他字符编码成“%XY”的格式，其中 XY 是字符对应 ASCII 码的16进制表示。比如英文的双引号（”）对应的编码就是%22;
• 对于扩展的 UTF-8 字符，编码成“%XY%ZA…”的格式；
• 英文空格（ ）要被编码是%20，而不是加号（+）。
  注意：一般支持 URL 编码的库（比如 Java 中的 java.net.URLEncoder）都是按照“application/x-www-form-urlencoded”的 MIME 类型的规则进行编码的。实现时可以直接使用这类方式进行编码，把编码后的字符串中加号（+）替换成%20、星号（*）替换成%2A、%7E 替换回波浪号（~），即可得到上述规则描述的编码字符串。
  

2. 1.3. 对编码后的参数名称和值使用英文等号（=）进行连接。
   1.4. 把英文等号连接得到的字符串按参数名称的字典顺序依次使用&符号连接，即得到规范化请求字符串。
   
3. 使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串。

1. StringToSign=
2. HTTPMethod+"&"+
3. percentEncode("/")+"&"+
4. percentEncode(CanonicalizedQueryString)

• 其中 HTTPMethod 是提交请求用的 HTTP 方法，比 GET。
• percentEncode（“/”）是按照1.2中描述的 URL 编码规则对字符“/”进行编码得到的值，即“%2F”。
• percentEncode（CanonicalizedQueryString）是对第1步中构造的规范化请求字符串按 1.2 中描述的 URL 编码规则编码后得到的字符串。

4. 按照 RFC2104 的定义，使用上面的用于签名的字符串计算签名 HMAC 值。
   注意：计算签名时使用的 Key 就是用户持有的 Access Key Secret 并加上一个“&”字符（ASCII:38），使用的哈希算法是 SHA1。
   
5. 按照 Base64 编码规则把上面的 HMAC 值编码成字符串，即得到签名值（Signature）。
   
6. 将得到的签名值作为 Signature 参数添加到请求参数中，即完成对请求签名的过程。
   注意：得到的签名值在作为最后的请求参数值提交给 PolarDB-X 服务器的时候，要和其他参数一样，按照 RFC3986 的规则进行 URL 编码）。
   

示例

以 DescribeDrdsInstances 为例，签名前的请求参数字符串为：

1. AccessKeyId=testid&Action=DescribeDrdsInstances&Format=XML&RegionId=cn-hangzhou&SignatureMethod=HMAC-SHA1&SignatureNonce=ae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion=1.0&Timestamp=2016-01-20T14%3A26%3A15Z&Version=2015-04-13

对这个字符串进行编码，那么 StringToSign 就是：

1. GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeDrdsInstances&Format%3DXML&RegionId%3Dcn-hangzhou&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3Dae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion%3D1.0&Timestamp%3D2016-01-20T14%253A26%253A15Z&Version%3D2015-04-13

假如使用的 Access Key ID 是“testid”，Access Key Secret 是“testsecret”，用于计算 HMAC 的 Key 就是“testsecret&”，则计算得到的签名值是：

1. h/ka/jNO+WZv8Tqgo4a75sp6eTs=

签名后的请求 URL 为（注意增加了 Signature 参数）：

1. http://drds.aliyuncs.com/?AccessKeyId=testid&Action=DescribeDrdsInstances&Format=XML&RegionId=cn-hangzhou&SignatureMethod=HMAC-SHA1&SignatureNonce=ae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion=1.0&Timestamp=2016-01-20T14%3A26%3A15Z&Version=2015-04-13&Signature=h%2Fka%2FjNO%2BWZv8Tqgo4a75sp6eTs%3D

调用接口 DescribeDrdsInstances 的 Java 示例如下：

1. publicstaticvoid drdsOpenAPI()throwsNoSuchAlgorithmException,InvalidKeyException,IOException{
2.        //AK 与 SK
3.        String accessKey ="testid";
4.        String accessSecret ="testsecret";
5.        //公共参数
6.        Map<String,String> parameters =newTreeMap<String,String>();
7.        parameters.put("Format","JSON");
8.        parameters.put("Action","DescribeDrdsInstances");//调用 DescribeDrdsInstances 接口
9.        parameters.put("Version","2015-04-13");
10.        parameters.put("AccessKeyId", accessKey);
11.        parameters.put("SignatureMethod","HMAC-SHA1");
12.        parameters.put("Timestamp", getISO8601Time());
13.        parameters.put("SignatureVersion","1.0");
14.        parameters.put("SignatureNonce", UUID.randomUUID().toString());
15.        parameters.put("RegionId","cn-hangzhou");
16.        StringBuilder paramStr =newStringBuilder();
17.        //拼接请求参数
18.        for(Map.Entry<String,String> entry : parameters.entrySet()){
19.          paramStr.append(percentEncode(entry.getKey())).append("=").append(percentEncode(entry.getValue())).append("&");
20.        }
21.        paramStr.deleteCharAt(paramStr.length()-1);
22. 
    
23.        //计算签名
24.        StringBuilder stringToSign =newStringBuilder();
25.            stringToSign.append("GET").append("&").append(percentEncode("/"))
26.                  .append("&").append(percentEncode(paramStr.toString()));
27.            Mac mac =Mac.getInstance("HmacSHA1");
28.        mac.init(newSecretKeySpec((accessSecret +"&").getBytes("UTF-8"),"HmacSHA1"));
29.        byte[] signData = mac.doFinal(stringToSign.toString().getBytes("UTF-8"));
30.        String signStr =Base64Helper.encode(signData);
31.        //拼接 URL
32.        String requestUrl ="http://drds.aliyuncs.com/?"+ paramStr.toString()+
33.            "&Signature="+  percentEncode(signStr);
34.        //准备发送 HTTP 请求
35.        URL url =new URL(requestUrl);
36.        HttpURLConnection httpConn =(HttpURLConnection)url.openConnection();
37.        httpConn.setRequestMethod("GET");
38.        httpConn.setDoOutput(true);
39.        httpConn.setDoInput(true);
40.        httpConn.setUseCaches(false);
41.        httpConn.connect();
42.        InputStream content = httpConn.getInputStream();
43.        ByteArrayOutputStream outputStream =newByteArrayOutputStream();
44.        byte[] buff =newbyte[1024];
45.        while(true){
46.           finalint read = content.read(buff);
47.           if(read ==-1)break;
48.           outputStream.write(buff,0,read);
49.        }
50.        System.out.println(newString(outputStream.toByteArray()));;
51.  }
52. 
    
53.  publicstaticString percentEncode(String value)throwsUnsupportedEncodingException{
54.        return value !=null?URLEncoder.encode(value,"UTF-8").replace("+","%20")
55.                .replace("*","%2A").replace("%7E","~"):null;
56.    }
57. 
    
58.  staticString getISO8601Time(){
59.        SimpleDateFormat df =newSimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
60.        df.setTimeZone(newSimpleTimeZone(0,"GMT"));
61.        return df.format(newDate());
62.  }
63. }