对于每一次HTTP或者HTTPS协议请求,我们会根据访问中的签名信息验证访问请求者身份。具体由使用AccessKey ID和AccessKey Secret对称加密验证实现。
- AccessKey相当于用户密码,AccessKey用于调用API,而用户密码用于登录NAS控制台。其中AccessKey ID是访问者身份,AccessKey Secret是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。更多信息,请参见获取AccessKey。
- 文件存储NAS提供了多种编程语言的SDK及第三方SDK,可以免去您签名的烦恼。更多信息,请参见SDK。
步骤一:构造规范化请求字符串
- 排序参数。排序规则以首字母顺序排序,排序参数包括公共参数和接口自定义参数,不包括公共请求参数中的
Signature
参数。说明 当使用GET方法提交请求时,这些参数就是请求URL中的参数部分,即URL中?
之后由&
连接的部分。 - 编码参数。使用UTF-8字符集按照RFC3986规则编码请求参数和参数取值,编码规则如下:
- 字符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
,即可得到上述规则描述的编码字符串。此算法可以使用如下的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") : null; }
- 字符A~Z、a~z、0~9以及字符
- 使用等号(
=
)连接编码后的请求参数和参数取值。 - 使用与号(
&
)连接编码后的请求参数,注意参数排序与步骤1一致。
现在,您得到了规范化请求字符串(CanonicalizedQueryString),其结构遵循请求结构。更多信息,请参见请求结构。
步骤二:构造签名字符串
- 构造待签名字符串
StringToSign
。您可以同样使用percentEncode
处理上一步构造的规范化请求字符串,规则如下:StringToSign= HTTPMethod + "&" + //HTTPMethod:发送请求的HTTP方法,例如GET。 percentEncode("/") + "&" + //percentEncode("/"):字符(/)UTF-8编码得到的值,即%2F。 percentEncode(CanonicalizedQueryString) //您的规范化请求字符串。
- 按照RFC2104的定义,计算待签名字符串
StringToSign
的HMAC-SHA1值。示例使用的是Java Base64编码方法。Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
- 添加根据RFC3986规则编码后的参数
Signature
到规范化请求字符串URL中。
示例一:参数拼接法
以调用DescribeRegions查询地域为例。假设您获得了AccessKeyID=testid
以及AccessKeySecret=testsecret
,签名流程如下所示:
- 构造规范化请求字符串。
http://nas.cn-hangzhou.aliyuncs.com/?Timestamp=2021-11-30T09%3A18%3A51Z&Format=JSON&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=HMAC-SHA1&SignatureNonce=47b920a4f8fb2769d2404b74860e3e5d&Version=2017-06-26&SignatureVersion=1.0
- 构造待签名字符串
StringToSign
。GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeRegions%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26Timestamp%3D2021-11-11T12%253A46%253A24Z%26Version%3D2017-06-26
- 计算签名值。因为
AccessKeySecret=testsecret
,用于计算的Key为testsecret&
,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ+uX5qY=
。示例使用的是JavaBase64编码方法。Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
- 添加RFC3986规则编码后的
Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D
到上文步骤1的URL中。http://nas.cn-hangzhou.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=JSON&SignatureNonce=47b920a4f8fb2769d2404b74860e3e5d&Version=2017-06-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2021-11-30T12%253A46%253A24Z
通过以上URL,您可以使用浏览器、curl或者wget等工具发起HTTP请求调用DescribeRegions
,查看阿里云的地域列表。
示例二:编程语言法
依然以调用DescribeRegions查询地域为例。假设您获得了AccessKeyID=testid
以及AccessKeySecret=testsecret
,并且假定所有请求参数放在一个Java Map<String, String>
对象里。
- 预定义编码方法。
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") : null; }
- 预定义编码时间格式
Timestamp
。参数Timestamp
必须符合ISO8601规范,并需要使用UTC时间,时区为+0。private static final String ISO8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'"; private static String formatIso8601Date(Date date) { SimpleDateFormat df = new SimpleDateFormat(ISO8601_DATE_FORMAT); df.setTimeZone(new SimpleTimeZone(0, "GMT")); return df.format(date); }
- 构造请求字符串。
final String HTTP_METHOD = "GET"; Map<String, String> parameters = new HashMap<>(); // 输入请求参数 parameters.put("Action", "DescribeRegions"); parameters.put("Version", "2017-06-26"); parameters.put("AccessKeyId", "testid"); parameters.put("Timestamp", formatIso8601Date(new Date())); parameters.put("SignatureMethod", "HMAC-SHA1"); parameters.put("SignatureVersion", "1.0"); parameters.put("SignatureNonce", UUID.randomUUID().toString()); parameters.put("Format", "JSON"); // 排序请求参数 String[] sortedKeys = parameters.keySet().toArray(new String[]{}); Arrays.sort(sortedKeys); final String SEPARATOR = "&"; // 构造stringToSign字符串 StringBuilder stringToSign = new StringBuilder(); stringToSign.append(HTTP_METHOD).append(SEPARATOR); stringToSign.append(percentEncode("/")).append(SEPARATOR); StringBuilder canonicalizedQueryString = new StringBuilder(); for(String key : sortedKeys) { // 这里注意编码key和value canonicalizedQueryString.append("&") .append(percentEncode(key)).append("=") .append(percentEncode(parameters.get(key))); } // 这里注意编码canonicalizedQueryString stringToSign.append(percentEncode( canonicalizedQueryString.toString().substring(1)));
- 签名。因为
AccessKeySecret=testsecret
,所以用于计算HMAC的Key为testsecret&
,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D
。// 以下是一段计算签名的示例代码 final String ALGORITHM = "HmacSHA1"; final String ENCODING = "UTF-8"; key = "testsecret&"; Mac mac = Mac.getInstance(ALGORITHM); mac.init(new SecretKeySpec(key.getBytes(ENCODING), ALGORITHM)); byte[] signData = mac.doFinal(stringToSign.toString().getBytes()); String signature = Base64 .getEncoder().encodeToString(signData); // 以下直接打印出可使用的URL String url = parameters.entrySet().stream() .map(e -> String.format("%s=%s", e.getKey(), percentEncode(e.getValue()))) .collect(Collectors.joining("&", "http://nas.cn-hangzhou.aliyuncs.com/?", "&Signature=" + percentEncode(signature))); System.out.println("url: " + url);
增加签名参数后,按照RFC3986规则编码后的URL如下所示:
http://nas.cn-hangzhou.aliyuncs.com/?AccessKeyId=testid&Action=DescribeRegions&Format=JSON&SignatureMethod=HMAC-SHA1&SignatureNonce=a7568db9-3647-4a3b-9f49-6cd9cd51c28a&SignatureVersion=1.0&Timestamp=2021-11-30T09%3A46%3A11Z&Version=2017-06-26&Signature=7LgzXFA0qiWbH0L2fFk0qbYyGC8%3D
- 使用浏览器、curl或者wget等工具发送HTTP请求。
{ "TotalCount":25, "RequestId":"A66FCCB9-4538-193F-A67A-2E0A515A****", "PageSize":10, "PageNumber":1, "Regions":{ "Region":[ { "RegionId":"cn-hangzhou", "RegionEndpoint":"nas.cn-hangzhou.aliyuncs.com", "LocalName":"China (Hangzhou)" }, { "RegionId":"cn-shanghai", "RegionEndpoint":"nas.cn-shanghai.aliyuncs.com", "LocalName":"China (Shanghai)" } ] } }
返回结果列举了地域和地域ID列表。如果您在提交请求时,指定参数Format=XML
,那么返回结果的格式为XML格式而不是JSON格式。更多信息,请参见返回结果。