如何對請求進行簽名處理(Direct Mail) -

注意：

若使用阿里雲提供的 SDK，則無需查看簽名機制。當前已提供 Java、PHP、C# 的 SDK。
介面支援通過 GET 和 POST 提交請求，但是 GET 和 POST 的 StringToSign 不一樣。

Direct Mail服務會對每個訪問請求進行身分識別驗證，所以無論使用 HTTP 還是 HTTPS 協議提交請求，都需要在請求中包含簽名（Signature）資訊。Direct Mail通過使用 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。
計算簽名值。
按照 Base 64 編碼規則，把步驟 3 得到的 HMAC 值編碼成字串，即得到簽名值（Signature）。
將得到的簽名值作為 Signature 參數添加到請求參數中，即完成請求籤名過程。
注意：得到的簽名值作為請求參數值提交給Direct Mail伺服器的時候，要和其他參數一樣，按照 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版