对象存储 OSS：在URL中包含V4签名（推荐）

SDK签名实现

OSS SDK已实现自动完成V4签名。推荐采用OSS SDK的方式发起请求，可以免去手动签名的过程。如果您想了解具体语言的签名实现，请参考OSS SDK的代码。OSS SDK签名实现的文件请参见下表。

URL签名描述

• URL签名示例

  https://examplebucket.oss-cn-hangzhou.aliyuncs.com/exampleobject?x-oss-additional-headers=host&x-oss-credential=LTAI********************%2F20241203%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-date=20241203T034420Z&x-oss-expires=86400&x-oss-signature=70c542eaf652ac291c0c343d63ac24ede41c0526661d9d4c63c0906a2686160c&x-oss-signature-version=OSS4-HMAC-SHA256

  上述URL中的x-oss-credential的值为方便展示各个字段的参数，使用正斜线（/）进行分隔。在实际请求时，需要对URL中的/执行UrlEncode，即转化成%2F，示例如下：

  &x-oss-credential=LTAI********************%2F20241203%2Fcn-hangzhou%2Foss%2Faliyun_v4_request

• URL中的QueryString参数说明

  参数	类型	是否必选	示例值	说明
  x-oss-signature-version	字符串	是	OSS4-HMAC-SHA256	指定签名的版本和算法，固定值为OSS4-HMAC-SHA256。
  x-oss-credential	字符串	是	LTAI********************/20241203/cn-hangzhou/oss/aliyun_v4_request	指明派生密钥的参数集，格式如下： LTAI********************/<date>/<region>/oss/aliyun_v4_request AccessKeyId：填写访问密钥中的AccessKey ID。 date：填写请求的日期， region：填写请求所在的Region。 oss：请求的服务名称，固定为oss。 aliyun_v4_request：请求的版本说明，固定为aliyun_v4_request。
  x-oss-date	字符串	是	20241203T034420Z	签名URL的起始时间，为避免时钟误差，允许向后偏移15分钟，格式为ISO8601。 说明 该时间用作StringToSign中的TimeStamp，取值必须与创建SigningKey中的Date是同一天。
  x-oss-expires	整数	是	3600	签名URL的有效时长，单位为秒（s）。最小值为1，最大值为 604800（即7 天）。
  x-oss-additional-headers	字符串	否	host	除默认要加入签名的Header以外，指定其他也需要签名的Header。例如：添加签名host，并禁止修改请求的域名。 该字段的构建方法说明如下： 额外头部中的所有Header均要求小写。 按照字典序升序排列额外头部中的所有Header。 以分号连接数组中的元素，获取字符串。
  x-oss-signature	字符串	是	77Dv****************	用于签名认证的描述信息。x-oss-signature不参与签名计算。
  x-oss-security-token	字符串	否	CAIS********************************	STS安全令牌。仅当使用STS构造URL签名时，才需要设置此参数。

签名计算过程

URL签名计算方法与Header签名计算方法基本类似。但由于签名URL使用方法的不同，与Header签名计算仍存在以下差异：

• 签名URL的方式不包含描述payload的Header（x-oss-content-sha256）。原因是创建预签名时，无法预估实际传输的payload。因此，在URL签名过程中，直接使用UNSIGNED-PAYLOAD。

• 如果签名URL的QueryParameter与待签名Header中的Key相同但Value不同的情况，会出现报错。同一个Key有多个Value的情况，会同时比较Key对应的所有Value，如果Value不一致也会出现报错。

• 签名URL中，如果通过STS访问OSS，必须在QueryString中添加x-oss-security-token。

• QueryString中的x-oss-signature不参与签名。

HTTP Verb + "\n" +
Canonical URI + "\n" +
Canonical Query String + "\n" +
Canonical Headers + "\n" +
Additional Headers + "\n" +
Hashed PayLoad

"GET" | "GET" | ... + "\n" +
UriEncode(<Resource>) + "\n" +
UriEncode(<QueryParam1>) + "=" + UriEncode(<Value>) + "&" + UriEncode(<QueryParam2>) + "\n" +
Lowercase(<HeaderName1>) + ":" + Trim(<value>) + "\n" + Lowercase(<HeaderName2>) + ":" + Trim(<value>) + "\n" + "\n"
Lowercase(<AdditionalHeaderName1>) + ";" + Lowercase(<AdditionalHeaderName2>) + "\n" +
UNSIGNED-PAYLOAD

签名计算示例

以创建一个预签名URL，分享给其他用户上传数据为例，演示如何在URL包含V4签名。

• 计算参数示例

  参数	值
  AccessKeyId	accesskeyid
  AccessKeySecret	accesskeysecret
  Bucket	examplebucket
  Object	exampleobject
  Region	cn-hangzhou

• GetObject

  https://examplebucket.oss-cn-hangzhou.aliyuncs.com/exampleobject?x-oss-additional-headers=host&x-oss-credential=LTAI********************%2F20241203%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-date=20241203T032307Z&x-oss-expires=86400&x-oss-signature=eee300fa39f52127a02af5f9bb86c0fd8b6776fc19101d9a6a7982c9d0edcc04&x-oss-signature-version=OSS4-HMAC-SHA256
  host:examplebucket.oss-cn-hangzhou.aliyuncs.com

在URL包含V4签名的步骤如下：

1. 构造CanonicalRequest。

   String resourcePath = "exampleobject";
           String endpoint = "https://examplebucket.oss-cn-hangzhou.aliyuncs.com";
           String queryString = "x-oss-additional-headers=host&" +
                   "x-oss-credential=" + accesskeyid + "%2F" + dateStr + "%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&" +
                   "x-oss-date=" + dateTimeStr + "&" +
                   "x-oss-expires=86400&" +
                   "x-oss-signature=" + signature + "&" +
                   "x-oss-signature-version=OSS4-HMAC-SHA256";
   
           String urlStr = endpoint + "/" + resourcePath + "?" + queryString;
           URL url = new URL(urlStr);

2. 构造待签名字符串（StringToSign）。

   String stringToSign = "OSS4-HMAC-SHA256\n" +
       dateTimeStr + "\n" +
       dateStr + "/cn-hangzhou/oss/aliyun_v4_request\n" +
       DigestUtils.sha256Hex(canonicalRequest);

3. 计算签名。

   1. 计算SigningKey。

      说明

      为方便可读，如下为SigningKey经Base64编码后的字符串。

       dateKey = hmacsha256(("aliyun_v4" + accesskeysecret).getBytes(), dateStr);
       dateRegionKey = hmacsha256(dateKey, "cn-hangzhou");
       dateRegionServiceKey = hmacsha256(dateRegionKey, "oss");
       signingKey = hmacsha256(dateRegionServiceKey, "aliyun_v4_request");

   2. 计算Signature。

      result = hmacsha256(signingKey, stringToSign);
      String signature = BinaryUtil.toHex(result);
      signature:eee300fa39f52127a02af5f9bb86c0fd8b6776fc19101d9a6a7982c9d0edcc04

4. 在URL中加入签名。

   String resourcePath = "exampleobject";
           String endpoint = "https://examplebucket.oss-cn-hangzhou.aliyuncs.com";
           String queryString = "x-oss-additional-headers=host&" +
                   "x-oss-credential=" + accesskeyid + "%2F" + dateStr + "%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&" +
                   "x-oss-date=" + dateTimeStr + "&" +
                   "x-oss-expires=86400&" +
                   "x-oss-signature=" + signature + "&" +
                   "x-oss-signature-version=OSS4-HMAC-SHA256";
   
           String urlStr = endpoint + "/" + resourcePath + "?" + queryString;
           URL url = new URL(urlStr);
           System.out.println("url:" + url);

签名计算完整示例代码

使用上述计算参数示例，通过Java示例代码演示签名计算完整过程。

import com.aliyun.oss.common.utils.BinaryUtil;
import org.apache.commons.codec.digest.DigestUtils;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.net.URL;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.TimeZone;

public class Demo {

    /**
     * 签名计算工具
     *
     * @return url
     */
    public static void main(String[] args) throws Exception {
        // 运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
        String accesskeyid =  System.getenv().get("OSS_ACCESS_KEY_ID");
        String accesskeysecret =  System.getenv().get("OSS_ACCESS_KEY_SECRET");
        // 获取当前时间并格式化为指定的 ISO8601 格式
        ZonedDateTime now = ZonedDateTime.now(TimeZone.getTimeZone("UTC").toZoneId());
        String dateStr = now.format(DateTimeFormatter.ofPattern("yyyyMMdd"));
        String dateTimeStr = now.format(DateTimeFormatter.ofPattern("yyyyMMdd'T'HHmmss'Z'"));
        // 步骤1：构造CanonicalRequest。
        String canonicalRequest =
                "GET\n" +
                        "/examplebucket/exampleobject\n" +
                        "x-oss-additional-headers=host&x-oss-credential=" + accesskeyid + "%2F" + dateStr + "%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-date=" + dateTimeStr + "&x-oss-expires=86400&x-oss-signature-version=OSS4-HMAC-SHA256\n" +
                        "host:examplebucket.oss-cn-hangzhou.aliyuncs.com\n" +
                        "\n" +
                        "host\n" +
                        "UNSIGNED-PAYLOAD";
        System.out.println("canonicalRequest:" + canonicalRequest);
        // 步骤2：构造待签名字符串（StringToSign）。
        String stringToSign = "OSS4-HMAC-SHA256\n" +
                dateTimeStr + "\n" +
                dateStr + "/cn-hangzhou/oss/aliyun_v4_request\n" +
                DigestUtils.sha256Hex(canonicalRequest);

        // 步骤3：计算Signature。
        byte[] dateKey = hmacsha256(("aliyun_v4" + accesskeysecret).getBytes(), dateStr);
        byte[] dateRegionKey = hmacsha256(dateKey, "cn-hangzhou");
        byte[] dateRegionServiceKey = hmacsha256(dateRegionKey, "oss");
        byte[] signingKey = hmacsha256(dateRegionServiceKey, "aliyun_v4_request");

        byte[] result = hmacsha256(signingKey, stringToSign);
        String signature = BinaryUtil.toHex(result);
        System.out.println("signature:" + signature);

        // 步骤4：在URL中加入签名。
        String resourcePath = "exampleobject";
        String endpoint = "https://examplebucket.oss-cn-hangzhou.aliyuncs.com";
        String queryString = "x-oss-additional-headers=host&" +
                "x-oss-credential=" + accesskeyid + "%2F" + dateStr + "%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&" +
                "x-oss-date=" + dateTimeStr + "&" +
                "x-oss-expires=86400&" +
                "x-oss-signature=" + signature + "&" +
                "x-oss-signature-version=OSS4-HMAC-SHA256";

        String urlStr = endpoint + "/" + resourcePath + "?" + queryString;
        URL url = new URL(urlStr);
        System.out.println("url:" + url);
    }

    public static byte[] hmacsha256(byte[] key, String data) {
        try {
            // 初始化HMAC密钥规格，指定算法为HMAC-SHA256并使用提供的密钥。
            SecretKeySpec secretKeySpec = new SecretKeySpec(key, "HmacSHA256");

            // 获取Mac实例，并通过getInstance方法指定使用HMAC-SHA256算法。
            Mac mac = Mac.getInstance("HmacSHA256");
            // 使用密钥初始化Mac对象。
            mac.init(secretKeySpec);

            // 执行HMAC计算，通过doFinal方法接收需要计算的数据并返回计算结果的数组。
            byte[] hmacBytes = mac.doFinal(data.getBytes());

            return hmacBytes;
        } catch (Exception e) {
            throw new RuntimeException("Failed to calculate HMAC-SHA256", e);
        }
    }
}

返回结果如下：

signature:eee300fa39f52127a02af5f9bb86c0fd8b6776fc19101d9a6a7982c9d0edcc04
url:https://examplebucket.oss-cn-hangzhou.aliyuncs.com/exampleobject?x-oss-additional-headers=host&x-oss-credential=LTAI********************%2F20241203%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-date=20241203T032307Z&x-oss-expires=86400&x-oss-signature=eee300fa39f52127a02af5f9bb86c0fd8b6776fc19101d9a6a7982c9d0edcc04&x-oss-signature-version=OSS4-HMAC-SHA256