更新时间:2020-08-27 13:59
为保证API的安全调用,在调用API时阿里云会对每个API请求通过签名(Signature)进行身份验证。无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名信息。
RPC API要按以下格式在API请求的Query中增加签名(Signature)。
https://Endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
其中:
SignatureMethod
:签名方式,目前支持HMAC-SHA1。
SignatureVersion
:签名算法版本,目前版本是 1.0。
SignatureNonce
:唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值,建议使用通用唯一识别码(Universally Unique Identifier, UUID)。
Signature
: 使用AccessKey Secret对请求进行对称加密后生成的签名。
签名算法遵循RFC 2104 HMAC-SHA1规范,使用AccessSecret对编码、排序后的整个请求串计算HMAC值作为签名。签名的元素是请求自身的一些参数,由于每个API请求内容不同,所以签名的结果也不尽相同。可参考本文的操作步骤,计算签名值。
Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(
StringToSign)) )
使用请求参数构造规范化的请求字符串(Canonicalized Query String)。
i. 按照参数名称的字典顺序对请求中所有的请求参数(包括公共请求参数和接口的自定义参数,但不包括公共请求参数中的Signature参数)进行排序。
说明:当使用GET方法提交请求时,这些参数就是请求URI中的参数部分,即URI中“?”之后由“&”连接的部分。
ii. 对排序之后的请求参数的名称和值分别用UTF-8字符集进行URL编码。编码规则请参考下表。
字符 | 编码方式 |
---|---|
A-Z、a-z和0-9以及“-”、“_”、“.”和“~” | 不编码。 |
其它字符 | 编码成 %XY 的格式,其中 XY 是字符对应ASCII码的16进制表示。例如英文的双引号(””)对应的编码为 %22。 |
扩展的UTF-8字符 | 编码成 %XY%ZA…的格式。 |
英文空格 | 编码成 %20,而不是加号(+)。 该编码方式和一般采用的 application/x-www-form-urlencoded MIME格式编码算法(例如Java标准库中的 java.net.URLEncoder的实现)存在区别。编码时可以先用标准库的方式进行编码,然后把编码后的字符串中的加号(+)替换成 %20,星号(*)替换成 %2A,%7E替换回波浪号(~),即可得到上述规则描述的编码字符串。本算法可以用下面的percentEncode方法来实现 (见下) |
private static final String ENCODING = "UTF-8";
private static String percentEncode(String value) throws UnsupportedEncodingException
{
return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
}
iii. 将编码后的参数名称和值用英文等号(=)进行连接。
iv. 将等号连接得到的参数组合按步骤 i 排好的顺序依次使用“&”符号连接,即得到规范化请求字符串。
StringToSign=
HTTPMethod + “&” +
percentEncode(“/”) + ”&” +
percentEncode(CanonicalizedQueryString)
其中:
HTTPMethod
是提交请求用的HTTP方法,例如GET。percentEncode(“/”)
是按照步骤1.1中描述的 URL 编码规则对字符 “/” 进行编码得到的值,即 %2F。percentEncode(CanonicalizedQueryString)
是对步骤1中构造的规范化请求字符串按步骤 1.2 中描述的URL编码规则编码后得到的字符串。按照RFC2104的定义,计算待签名字符串(StringToSign)的HMAC值。
说明:是您持有的AccessKey Secret并加上一个 “&” 字符(ASCII:38), 使用的哈希算法是SHA1。
按照Base64编码规则把上面的HMAC值编码成字符串,即得到签名值(Signature)。
将得到的签名值作为Signature参数添加到请求参数中。
说明:得到的签名值在作为最后的请求参数值提交时要和其它参数一样,按照RFC3986(参看:https://tools.ietf.org/html/rfc3986) 的规则进行URL编码。
以DescribeRegions
API为例,假设使用的AccessKey Id
为 testid
, AccessKey Secret
为testsecret
。 签名前的请求URL如下:
http://ecs.aliyuncs.com/?Timestamp=2016-02-23T12%3A46:24Z&Format=XML&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&SignatureVersion=1.0
使用testsecret&
,计算得到的签名值是:
OLeaidS1JvxuMvnyHOwuJ+uX5qY=
最后将签名作为Signature
参数加入到URL请求中,最后得到的URL为:
http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ+uX5qY=&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%3A46%3A24Z
这里以python代码为例,为读者以代码的方式解释签名生成过程;其它语言语法虽然不同,但是过程是一致的。如果出现SignatureDoesNotMatch的报错,可以将自己用了计算签名的字符串和报错提示的字符串做比较。
url = "http://alinlp.cn-hangzhou.aliyuncs.com/"
AccessKeyId = "LTXXXXkey"
AccessKeySecret = "4BXXXsecret"
# 准备公共参数和API对应的参数,这里以词性标注--通用为例
# 注意,这里并没有Signature参数哦
param = {
"Format":"json",
"Version":"2020-06-29",
"AccessKeyId":AccessKeyId,
"SignatureMethod":"HMAC-SHA1",
"Timestamp":(datetime.datetime.now() - datetime.timedelta(hours=8)).strftime("%Y-%m-%dT%H:%M:%SZ"),
"SignatureVersion":"1.0",
"SignatureNonce":uuid.uuid4().hex,
"Text":"今天测试一下",
"TokenizerId":"MAINSE",
"Action":"GetPosChEcom",
"ServiceCode":"alinlp"
}
# 对参数按照key进行排序
param_list = sorted(param.items(), key=lambda x:x[0])
# 将key-value转化为url的形式
StringToSign = urllib.parse.urlencode(param_list)
# AccessKeyId=LTXXXXkey&Action=GetPosChEcom&Format=json&ServiceCode=alinlp&SignatureMethod=HMAC-SHA1&SignatureNonce=5c901f6ebac94f7196ba651b838c13d9&SignatureVersion=1.0&Text=%E4%BB%8A%E5%A4%A9%E6%B5%8B%E8%AF%95%E4%B8%80%E4%B8%8B&Timestamp=2020-08-26T14%3A01%3A48Z&TokenizerId=MAINSE&Version=2020-06-29
# 做urlencode
StringToSign = urllib.parse.quote(StringToSign)
# AccessKeyId%3DLTXXXXkey&Action%3DGetPosChEcom&Format%3Djson&ServiceCode%3Dalinlp&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D5c901f6ebac94f7196ba651b838c13d9&SignatureVersion%3D1.0&Text%3D%25E4%25BB%258A%25E5%25A4%25A9%25E6%25B5%258B%25E8%25AF%2595%25E4%25B8%2580%25E4%25B8%258B&Timestamp%3D2020-08-26T14%253A01%253A48Z&TokenizerId%3DMAINSE&Version%3D2020-06-29
# 拼接头
StringToSign = "GET&%2F&" + StringToSign
# 拼接SHA1对应的key
secret = AccessKeySecret + "&"
# 计算SHA1值,并做base64
sig = base64.b64encode(hmac.new(secret.encode("utf-8") , StringToSign.encode("utf-8"), hashlib.sha1).digest())
# 将Signature添加到参数中
param["Signature"] = bytes.decode(sig)
# 发送http请求
reponse = requests.get(url, param)
在文档使用中是否遇到以下问题
更多建议
匿名提交