全部产品
开放搜索

V2版API 签名机制

更新时间:2017-06-09 16:04:51   分享:   

授权机制

OpenSearch服务会对每个访问的请求进行身份验证,通过使用Access Key ID和Access Key Secret进行对称加密的方法来验证请求的发送者身份。Access Key ID和Access Key Secret由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中Access Key ID用于标识访问者的身份;

Access Key Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密,只有阿里云和用户知道。

【特别注意】

标准版应用必须要使用实现了 V3 版 API 的SDK,或使用我们提供的已实现V3 版API的 SDK 才能正常访问若使用实现了 V2版API 或 实现了V2版 API的 SDK访问标准版应用会报错(错误码: 2030 ,报错提示信息:Request is not permitted)。

签名步骤

1. 使用请求参数构造规范化的请求字符串(Canonicalized Query String)

a. 按照参数名称的字典顺序对请求中所有的请求参数(包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数,但不能包括“公共请求参数”中提到Signature参数本身)进行排序;

  1. 注:当使用GET方法提交请求时,这些参数就是请求URI中的参数部分(即URI中“?”之后由“&”连接的部分);

b. 对每个请求参数的名称和值分别进行URL编码(仅支持UTF-8字符集)’’’。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. 将参数对按照原参数名称字典序排序结果使用&符号依次连接,即得到规范化请求字符串。

2. 使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串

生成方式如下:

  1. StringToSign=
  2. HTTPMethod + "&" +
  3. percentEncode("/") + "&" +
  4. percentEncode(CanonicalizedQueryString)
  • 其中HTTPMethod是提交请求用的HTTP方法,比如GET。
  • percentEncode(“/”)是按照1.b中描述的URL编码规则对字符“/”进行编码得到的值,即“%2F”。
  • percentEncode(CanonicalizedQueryString)是对第1步中构造的规范化请求字符串按1.b中描述的URL编码规则编码后得到的字符串。

3. 按照RFC2104的定义,使用上面的用于签名的字符串计算签名HMAC值。

  1. 注意:计算签名时使用的Key就是用户持有的Access Key Secret并加上一个“&”字符(ASCII:38),使用的哈希算法是SHA1

4. 按照Base64编码规则把上面的HMAC值编码成字符串,即得到签名值(Signature)。

5. 最后将得到的签名值作为Signature参数添加到请求参数中,即完成对请求签名的过程。

  1. 注意: 得到的签名值在作为最后的请求参数值提交给OPENSEARCH服务器的时候,要和其他参数一样,按照RFC3986的规则进行URL编码)

示例

以搜索请求为例,签名前的请求url原串(未urlencode的)为:

  1. 公共参数:Version=v2&AccessKeyId=testid&SignatureMethod=HMACSHA1&SignatureVersion=1.0&SignatureNonce=14053016951271226&Timestamp=2014-07-14T01:34:55Z
  2. 请求参数为:query=config=format:json,start:0,hit:20&&query=default:'的'&index_name=ut_3885312&format=json&fetch_fields=title;gmt_modified

经过第一步排序、编码及拼接等工作,得到Canonicalized Query String为:

  1. AccessKeyId=testid&SignatureMethod=HMAC-SHA1&SignatureNonce=14053016951271226&SignatureVersion=1.0&Timestamp=2014-07-14T01%3A34%3A55Z&Version=v2&fetch_fields=title%3Bgmt_modified&format=json&index_name=ut_3885312&query=config%3Dformat%3Ajson%2Cstart%3A0%2Chit%3A20&&query%3Ddefault%3A%27%E7%9A%84%27

搜索使用GET协议,那么第二步的StringToSign就是:

  1. GET&%2F&AccessKeyId%3Dtestid&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D14053016951271226&SignatureVersion%3D1.0&Timestamp%3D2014-07-14T01%253A34%253A55Z&Version%3Dv2&fetch_fields%3Dtitle%253Bgmt_modified&format%3Djson&index_name%3Dut_3885312&query%3Dconfig%253Dformat%253Ajson%252Cstart%253A0%252Chit%253A20%2526%2526query%253Ddefault%253A%2527%25E7%259A%2584%2527

假如使用的Access Key Id是“testid”,Access Key Secret是“testsecret”,用于计算HMAC的Key就是“testsecret&”,则计算得到的签名值Signature是:

  1. AXA41Uk1UbIyLDttENNn34mqRbE=

签名后的请求URL为(注意增加了Signature参数):

  1. http://$host/search?query=config%3Dformat%3Ajson%2Cstart%3A0%2Chit%3A20&&query%3Ddefault%3A%27%E7%9A%84%27&index_name=ut_3885312&format=json&fetch_fields=title%3Bgmt_modified&Version=v2&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&SignatureVersion=1.0&SignatureNonce=14053016951271226&Timestamp=2014-07-14T01%3A34%3A55Z&Signature=AXA41Uk1UbIyLDttENNn34mqRbE%3D
本文导读目录
本文导读目录
以上内容是否对您有帮助?