HTTP协议及签名 - 号码隐私保护

本文为您详细介绍隐私号码服务涉及的HTTP协议及签名。

为方便其它语言能快速实现，在此增加了HTTP的详解。

注意

云通信下的四类产品（包括短信、语音、流量、隐私保护），接口协议一致。

一、前言说明

对应的协议是：发生通话行为后的话单消息回执采用的是阿里云的消息中间件MNS来实现。

二、协议说明

由于POP的签名算法比较复杂，下面这里结合AXB的绑定API进行详细说明。

2.1 号码隐私保护发送API的HTTP协议包示例

请求示例：

GET /?Signature=zJDF%2BLrzhj%2FThnlvIToysFRq6t4%3D&AccessKeyId=testId&Action=BindAxb&Format=XML&OutId=123&PhoneNumbers=15300000001&RegionId=cn-hangzhou&SignName=%E9%98%BF%E9%87%8C%E4%BA%91%E7%9F%AD%E4%BF%A1%E6%B5%8B%E8%AF%95%E4%B8%93%E7%94%A8&SignatureMethod=HMAC-SHA1&SignatureNonce=45e25e9b-0a6f-4070-8c85-2956eda1b466&SignatureVersion=1.0&PoolKey=FC123456&PhoneNoA=170000000&PhoneNoB=171000000&ExpireDate=2017-07-12T02%3A42%3A19Z&Timestamp=2017-07-12T02%3A42%3A19Z&Version=2017-05-25
HTTP/1.1
Host: dyplsapi.aliyuncs.com
...

返回示例：

HTTP/1.1 200 OK
...
<?xml version='1.0' encoding='UTF-8'?><BindAxbResponse>
<Code>OK</Code>
<Message>OK</Message>
<RequestId>E8534574-7381-4810-8F70-65B37BBA8970</RequestId><SubsId>108374502347^1111325525761</SubsId>
<SecretNo>1350000000</SecretNo>
</BindAxbResponse>

2.2 号码隐私保护Rest请求参数

如HTTP示例中，请求的参数可以分两大块：系统参数和业务参数。系统参数为POP协议的基本参数。

系统参数

参数	是否必填	说明
AccessKeyId	是
Timestamp	是	格式为：yyyy-MM-dd'T'HH:mm:ss'Z'；时区为：GMT。
Format	否	没传默认为JSON，可选填值：XML。
SignatureMethod	是	建议固定值：HMAC-SHA1。
SignatureVersion	是	建议固定值：1.0。
SignatureNonce	是	用于请求的防重放攻击，每次请求唯一，JAVA语言建议用：java.util.UUID.randomUUID()生成即可。
Signature	是	最终生成的签名结果值。

业务参数

参数KEY	是否必填	说明
Action	是	API的命名，固定值，如发绑定AXB：BindAxb
Version	是	API的版本，固定值，如短信API的值为：2017-05-25。
RegionId	是	API支持的RegionID，如短信API的值为：cn-hangzhou。
PoolKey	是	具体请参见API文档。
PhoneNoA	是	具体请参见API文档。
PhoneNoB	是	具体请参见API文档。
Expiration	否	具体请参见API文档。
OutId	否	具体请参见API文档。

2.3 生成签名

签名是为了让请求合法，共分为五步：

第一步：请求参数。

请求参数包括系统参数和业务参数，不要遗漏。
请求参数中不允许出现以Signature为key的参数。参考代码如下。

String accessKeyId = "testId";
String accessSecret = "testSecret";
java.text.SimpleDateFormat df = new java.text.SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
df.setTimeZone(new java.util.SimpleTimeZone(0, "GMT"));// 这里一定要设置GMT时区
java.util.Map<String, String> paras = new java.util.HashMap<String, String>();

①系统参数

paras.put("SignatureMethod", "HMAC-SHA1");
paras.put("SignatureNonce", java.util.UUID.randomUUID().toString());
paras.put("AccessKeyId", accessKeyId);
paras.put("SignatureVersion", "1.0");
paras.put("Timestamp", df.format(new java.util.Date()));
paras.put("Format", "XML");

②业务API参数

paras.put("Action", "BindAxb");
paras.put("Version", "2017-05-25");
paras.put("RegionId", "cn-hangzhou");
paras.put("PoolKey", "FC123456");
paras.put("PhoneNoA", "1700000000");
paras.put("PhoneNoB", "1700000000");
paras.put("Expiration", "2017-05-25 00:00:00");
paras.put("OutId", "123");

③去除签名关键字Key

if (paras.containsKey("Signature"))
paras.remove("Signature");

第二步：根据参数Key排序（顺序）。

参考代码如下：

java.util.TreeMap<String, String> sortParas = new java.util.TreeMap<String, String>();
sortParas.putAll(paras);

第三步：构造待签名的请求串。

首先介绍下面会用到的特殊URL编码，这个是POP特殊的一种规则，即在一般的URLEncode后再增加三种字符替换：加号（+）替换成 %20、星号（*）替换成 %2A、%7E 替换回波浪号（~） 参考代码如下：

public static String specialUrlEncode(String value) throws Exception {
        return java.net.URLEncoder.encode(value, "UTF-8").replace("+", "%20").replace("*", "%2A").replace("%7E", "~");
}

构造待签名的请求串这里有两步动作。

第1步，把排序后的参数顺序拼接成如下格式：

* specialUrlEncode(参数Key) + "=" + specialUrlEncode(参数值)

参考代码如下：

java.util.Iterator<String> it = sortParas.keySet().iterator();
StringBuilder sortQueryStringTmp = new StringBuilder();
while (it.hasNext()) {
        String key = it.next();
        sortQueryStringTmp.append("&").append(specialUrlEncode(key)).append("=").append(specialUrlEncode(paras.get(key)));
}
String sortedQueryString = sortQueryStringTmp.substring(1);// 去除第一个多余的&符号

打印上面的sortQueryString结果如下：

AccessKeyId=testId&Action=BindAxb&Format=XML&OutId=123&RegionId=cn-hangzhou&SignatureMethod=HMAC-SHA1&SignatureNonce=45e25e9b-0a6f-4070-8c85-2956eda1b466&SignatureVersion=1.0&PoolKey=FC123456&PhoneNoA=170000000&PhoneNoB=17100000000&Expiration=2017-07-12T02%3A42%3A19Z&Timestamp=2017-07-12T02%3A42%3A19Z&Version=2017-05-25`

第2步，按POP的签名规则拼接成最终的待签名串，规则如下：

* HTTPMethod + “&” + specialUrlEncode(“/”) + ”&” + specialUrlEncode(sortedQueryString)

参考代码如下：

StringBuilder stringToSign = new StringBuilder();
stringToSign.append("GET").append("&");
stringToSign.append(specialUrlEncode("/")).append("&");
stringToSign.append(specialUrlEncode(sortedQueryString));

这就完成了待签名的请求字符串了。打印结果如下：

GET&%2F&AccessKeyId%3DtestId&Action%BindAxb&Format%3DXML&OutId%3D123&PhoneNoA%3D17000000000&RegionId%3Dcn-hangzhou&PhoneNob%3D171000000000&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D45e25e9b-0a6f-4070-8c85-2956eda1b466&SignatureVersion%3D1.0&PoolKey%3DFC123456&Expiration%3D2017-07-12T02%253A42%253A19Z&Timestamp%3D2017-07-12T02%253A42%253A19Z&Version%3D2017-05-25`

第四步：签名。

签名采用HmacSHA1算法 + Base64，编码采用：UTF-8 参考代码如下：

String sign = sign(accessSecret + "&", stringToSign.toString());
public static String sign(String accessSecret, String stringToSign) throws Exception {
        javax.crypto.Mac mac = javax.crypto.Mac.getInstance("HmacSHA1");
        mac.init(new javax.crypto.spec.SecretKeySpec(accessSecret.getBytes("UTF-8"), "HmacSHA1"));
        byte[] signData = mac.doFinal(stringToSign.getBytes("UTF-8"));
        return new sun.misc.BASE64Encoder().encode(signData);
}

参数说明： 1. accessSecret：你的AccessKeyId对应的密钥AccessSecret，特别说明：POP要求需要后面多加一个“&”字符，即accessSecret + “&” 2. stringToSign：即第三步生成的待签名请求串

签名后的结果打印如下：

zJDF+Lrzhj/ThnlvIToysFRq6t4=

第五步：增加签名结果到请求参数中，发送请求。

注意

签名也要做特殊URL编码。

String Signature = specialUrlEncode(sign);// zJDF%2BLrzhj%2FThnlvIToysFRq6t4%3D

三、附加完整的Java签名Demo代码

以云通信短信产品-发送接口为列进行说明，业务参数自行替换成隐私保护绑定接口参数即可。

public class SignDemo {
        public static void main(String[] args) throws Exception {
                String accessKeyId = "testId";
                String accessSecret = "testSecret";
                java.text.SimpleDateFormat df = new java.text.SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
                df.setTimeZone(new java.util.SimpleTimeZone(0, "GMT"));// 这里一定要设置GMT时区
                java.util.Map<String, String> paras = new java.util.HashMap<String, String>();
                // 1. 系统参数
                paras.put("SignatureMethod", "HMAC-SHA1");
                paras.put("SignatureNonce", java.util.UUID.randomUUID().toString());
                paras.put("AccessKeyId", accessKeyId);
                paras.put("SignatureVersion", "1.0");
                paras.put("Timestamp", df.format(new java.util.Date()));
                paras.put("Format", "XML");
                // 2. 业务API参数
                paras.put("Action", "SendSms");
                paras.put("Version", "2017-05-25");
                paras.put("RegionId", "cn-hangzhou");
                paras.put("PhoneNumbers", "15300000001");
                paras.put("SignName", "阿里云短信测试专用");
                paras.put("TemplateParam", "{\"customer\":\"test\"}");
                paras.put("TemplateCode", "SMS_71390007");
                paras.put("OutId", "123");
                // 3. 去除签名关键字Key
                if (paras.containsKey("Signature"))
                        paras.remove("Signature");
                // 4. 参数KEY排序
                java.util.TreeMap<String, String> sortParas = new java.util.TreeMap<String, String>();
                sortParas.putAll(paras);
                // 5. 构造待签名的字符串
                java.util.Iterator<String> it = sortParas.keySet().iterator();
                StringBuilder sortQueryStringTmp = new StringBuilder();
                while (it.hasNext()) {
                        String key = it.next();
                        sortQueryStringTmp.append("&").append(specialUrlEncode(key)).append("=").append(specialUrlEncode(paras.get(key)));
                }
                String sortedQueryString = sortQueryStringTmp.substring(1);// 去除第一个多余的&符号
                StringBuilder stringToSign = new StringBuilder();
                stringToSign.append("GET").append("&");
                stringToSign.append(specialUrlEncode("/")).append("&");
                stringToSign.append(specialUrlEncode(sortedQueryString));
                String sign = sign(accessSecret + "&", stringToSign.toString());
                // 6. 签名最后也要做特殊URL编码
                String signature = specialUrlEncode(sign);
                System.out.println(paras.get("SignatureNonce"));
                System.out.println("\r\n=========\r\n");
                System.out.println(paras.get("Timestamp"));
                System.out.println("\r\n=========\r\n");
                System.out.println(sortedQueryString);
                System.out.println("\r\n=========\r\n");
                System.out.println(stringToSign.toString());
                System.out.println("\r\n=========\r\n");
                System.out.println(sign);
                System.out.println("\r\n=========\r\n");
                System.out.println(signature);
                System.out.println("\r\n=========\r\n");
                // 最终打印出合法GET请求的URL
                System.out.println("http://dysmsapi.aliyuncs.com/?Signature=" + signature + sortQueryStringTmp);
        }
        public static String specialUrlEncode(String value) throws Exception {
                return java.net.URLEncoder.encode(value, "UTF-8").replace("+", "%20").replace("*", "%2A").replace("%7E", "~");
        }
        public static String sign(String accessSecret, String stringToSign) throws Exception {
                javax.crypto.Mac mac = javax.crypto.Mac.getInstance("HmacSHA1");
                mac.init(new javax.crypto.spec.SecretKeySpec(accessSecret.getBytes("UTF-8"), "HmacSHA1"));
                byte[] signData = mac.doFinal(stringToSign.getBytes("UTF-8"));
                return new sun.misc.BASE64Encoder().encode(signData);
        }
}