如何对请求进行签名处理(邮件推送) - 邮件推送

注意：

若使用阿里云提供的 SDK，则无需查看签名机制。当前已提供 Java、PHP、C# 的 SDK。
接口支持通过 GET 和 POST 提交请求，但是 GET 和 POST 的 StringToSign 不一样。

邮件推送服务会对每个访问请求进行身份验证，所以无论使用 HTTP 还是 HTTPS 协议提交请求，都需要在请求中包含签名（Signature）信息。邮件推送通过使用 AccessKeyID 和 AccessKeySecret 进行对称加密的方法来验证请求的发送者身份。AccessKeyID 和 AccessKeySecret 由阿里云官方颁发给用户的 AccessKey 信息（可以通过阿里云控制台用户信息管理中查看和管理）。其中 AccessKeyID 用于标识访问者的身份；AccessKeySecret 是用于加密签名字符串和服务器端验证签名字符串的密钥。AccessKey 信息必须严格保密。

签名步骤

在访问时，按照下面的方法对请求进行签名处理：

使用请求参数构造规范化的请求字符串（Canonicalized Query String）
a) 排序参数。
按照参数名称的字典顺序，对请求中所有的请求参数（包括文档中描述的公共请求参数和给定的请求接口的自定义参数，但不包括公共请求参数中的 Signature 参数本身）进行排序。
注意：当使用 GET 方法提交请求时，这些参数就是请求 URI 中的参数部分（即 URI 中 ? 之后由 & 连接的部分）。
b) 对每个请求参数的名称和值进行编码。
参数名称和值要使用 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 替换回波浪号 ~，即可得到上述规则描述的编码字符串。
c) 使用半角的等号 = 连接编码后的参数名称和参数值。
d) 使用 & 符号连接编码后的请求参数（参数排序与步骤 a 的排序一致），即得到规范化请求字符串。
使用上一步构造的规范化字符串，按照下面的规则构造用于计算签名的字符串：
```
 StringToSign=
 HTTPMethod + "&" +
 percentEncode("/") + "&" +
 percentEncode(CanonicalizedQueryString)        
```
其中 HTTPMethod 是提交请求用的 HTTP 方法，比如 GET 和 POST。
percentEncode(“/”)是按照 1.b 中描述的 URL 编码规则对字符 /进行编码得到的值，即 %2F。
percentEncode (CanonicalizedQueryString) 是对第 1 步中构造的规范化请求字符串，再次按 1.b 中描述的 URL 编码规则进行编码后得到的字符串。注意：这里的 percentEncode (CanonicalizedQueryString) 是两次编码后得到的结果。
计算 HMAC 值。
按照 RFC2104 的定义，使用步骤 2 得到的字符串 StringToSign 计算签名 HMAC 值。
注意：计算签名时，使用的 Key 就是您的 AccessKeySecret 加上一个 & 字符 (ASCII:38)，使用的哈希算法是 SHA1。
计算签名值。
按照 Base64 编码规则，把步骤 3 得到的 HMAC 值编码成字符串，即得到签名值（Signature）。
将得到的签名值作为 Signature 参数添加到请求参数中，即完成请求签名过程。
注意：得到的签名值作为请求参数值提交给邮件推送服务器的时候，要和其他参数一样，按照 RFC3986 的规则进行 URL 编码）。

签名示例

以 SingleSendMail 接口，通过 HTTPS 发送 POST 请求调用说明为例：

请求URL为：http://dm.aliyuncs.com/ 。

请求参数为：

AccessKeyId=testid&AccountName=<a%b'>&Action=SingleSendMail&AddressType=1&Format=XML&HtmlBody=4&RegionId=cn-hangzhou&ReplyToAddress=true&SignatureMethod=HMAC-SHA1&SignatureNonce=c1b2c332-4cfb-4a0f-b8cc-ebe622aa0a5c&SignatureVersion=1.0&Subject=3&TagName=2&Timestamp=2016-10-20T06:27:56Z&ToAddress=1@test.com&Version=2015-11-23

那么 StringToSign 就是

POST&%2F&AccessKeyId%3Dtestid%26AccountName%3D%253Ca%2525b%2527%253E%26Action%3DSingleSendMail%26AddressType%3D1%26Format%3DXML%26HtmlBody%3D4%26RegionId%3Dcn-hangzhou%26ReplyToAddress%3Dtrue%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3Dc1b2c332-4cfb-4a0f-b8cc-ebe622aa0a5c%26SignatureVersion%3D1.0%26Subject%3D3%26TagName%3D2%26Timestamp%3D2016-10-20T06%253A27%253A56Z%26ToAddress%3D1%2540test.com%26Version%3D2015-11-23

假如使用的 AccessKeyId 是 testid，AccessKeySecret 是 testsecret，用于计算 HMAC 的 Key 就是 testsecret&，则计算得到的签名值是：

llJfXJjBW3OacrVgxxsITgYaYm0=

签名后，请求 http://dm.aliyuncs.com/ 发起 POST 请求的 BODY内容参数如下（增加了 Signature 参数和修改了请求头 Content-Type: application/x-www-form-urlencoded）：

Signature=llJfXJjBW3OacrVgxxsITgYaYm0=&AccessKeyId=testid&AccountName=<a%b'>&Action=SingleSendMail&AddressType=1&Format=XML&HtmlBody=4&RegionId=cn-hangzhou&ReplyToAddress=true&SignatureMethod=HMAC-SHA1&SignatureNonce=c1b2c332-4cfb-4a0f-b8cc-ebe622aa0a5c&SignatureVersion=1.0&Subject=3&TagName=2&Timestamp=2016-10-20T06:27:56Z&ToAddress=1@test.com&Version=2015-11-23

以上提供的是编码之前的BODY所需参数，具体请求需要对参数进行编码。

Java版

private static final String MAC_NAME ="HmacSHA1";
private static final String ENCODING ="UTF-8";

/**
 * 使用 HMAC-SHA1 签名方法对encryptText进行签名
 *
 *@param encryptText 被签名的字符串
 *@param encryptKey  密钥
 *@return
 *@throws Exception
 */
public static byte[] HmacSHA1Encrypt(StringencryptText, String encryptKey) throwsException {
byte[] data = encryptKey.getBytes(ENCODING);
//根据给定的字节数组构造一个密钥,第二参数指定一个密钥算法的名称
SecretKey secretKey = new SecretKeySpec(data,MAC_NAME);
//生成一个指定 Mac 算法的 Mac 对象
Mac mac = Mac.getInstance(MAC_NAME);
//用给定密钥初始化 Mac 对象
mac.init(secretKey);
byte[] text = encryptText.getBytes(ENCODING);
//完成 Mac 操作
return mac.doFinal(text);
}
@Test
public void test() throws Exception {
/*StringToSign=
                HTTPMethod + “&” +
                percentEncode(“/”) + ”&” +
percentEncode(CanonicalizedQueryString)*/
String str ="AccessKeyId=testid&AccountName=<a%b'>&Action=SingleSendMail&AddressType=1&Format=XML&HtmlBody=4&RegionId=cn-hangzhou&ReplyToAddress=true&SignatureMethod=HMAC"+
"-SHA1&SignatureNonce=c1b2c332-4cfb-4a0f-b8cc-ebe622aa0a5c&SignatureVersion=1.0&Subject=3&TagName=2&Timestamp=2016-10-20T06:27:56Z&ToAddress=1@test.com&Version=2015-11-23";
String percentStr = "";
String[] strs = str.split("&");
for (int i = 0; i < strs.length;i++) {
String[] str1 =strs[i].split("=");
if (str1.length == 1){
                percentStr = percentStr + getUtf8Encoder(str1[0])+ "=" + getUtf8Encoder("")+ "&";
}else {
                percentStr = percentStr + getUtf8Encoder(str1[0])+ "=" + getUtf8Encoder(str1[1]) + "&";
            }
}
percentStr =percentStr.substring(0,percentStr.lastIndexOf("&"));
String percent = URLEncoder.encode("/","UTF-8");
percentStr = getUtf8Encoder(percentStr);
String toSign = HttpMethod.POST + "&"+ percent +"&" + percentStr;
System.out.println("--------------"+ toSign);
/*POST&%2F&AccessKeyId%3Dtestid%26AccountName%3D%253Ca%2525b%2527%253E%26Action%3DSingleSendMail%26AddressType%3D1%26Format%3DXML%26HtmlBody%3D4%26RegionId%3Dcn-hangzhou%26ReplyToAddress%3Dtrue%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3Dc1b2c332-4cfb-4a0f-b8cc-ebe622aa0a5c%26SignatureVersion%3D1.0%26Subject%3D3%26TagName%3D2%26Timestamp%3D2016-10-20T06%253A27%253A56Z%26ToAddress%3D1%2540test.com%26Version%3D2015-11-23*/
byte[] bytes = HmacSHA1Encrypt(toSign,"testsecret&");
String base64Str = Base64.encode(bytes);
System.out.println(base64Str);//llJfXJjBW3OacrVgxxsITgYaYm0=
}
private String getUtf8Encoder(String param) throwsUnsupportedEncodingException {
return URLEncoder.encode(param, "UTF-8")
                .replaceAll("\\+","%20")
                .replaceAll("\\*","%2A")
                .replaceAll("%7E","~");
 };

Python版

import hmac
import base64
#其中StringToSign需要替换为对应的内容。
message = b'StringToSign'
key = b'testsecret&'
h = hmac.new(key, message, digestmod='sha1')
# print(h.digest())
print(base64.b64encode(h.digest()))

PHP版

<?php
function encryptTokey($data){
     $apikey = 'testsecret&';
     $sign = base64_encode(hash_hmac("sha1", $data, $apikey, true));
     //printf($sign);
     return $sign;
}
//其中StringToSign需要替换为对应的内容。
echo encryptTokey(StringToSign);
?>

签名常见问题：

若在使用API的过程中，出现时好时坏的情况，显示错误SignatureDoesNotMatch。原因：未对编码后的字符串进行特殊字符替换，具体请参考上面的特别注意事项。
若未解决签名不匹配的问题或不清楚如何使用签名机制，建议移步到请求示例，可以直接替换为自己的请求参数套用。

邮件推送：签名机制

签名步骤

签名示例

相关代码参考

Java版

Python版

PHP版