V1签名升级为V4签名

Java

1. 升级OSS Java SDK为3.17.4及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的地域ID作为发起请求地域的标识，以华东1（杭州）为例，地域ID为cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：SignVersion.V4。

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;

public class OSSClientV4 {

    public static void main(String[] args) throws Exception {
        // yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 填写Endpoint对应的Region信息，例如cn-hangzhou。
        String region = "cn-hangzhou";

        // 从环境变量中获取访问凭证。运行本代码示例之前，请先配置环境变量。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

        // 创建OSSClient实例。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        // 显式声明使用 V4 签名算法
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                .region(region)
                .build();

        // 关闭OSSClient。
        ossClient.shutdown();
    }
}

PHP

1. 升级OSS PHP SDK为2.7.0及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的地域ID作为发起请求地域的标识，以华东1（杭州）为例，地域ID为cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：OSS_SIGNATURE_VERSION_V4。

<?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\Core\OssException;

try {
    // 从环境变量中获取访问凭证,并保存在provider中。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    $provider = new EnvironmentVariableCredentialsProvider();
    // 填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
    $endpoint = "https://oss-cn-hangzhou.aliyuncs.com";    
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,        
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        // 填写Endpoint对应的Region信息，例如cn-hangzhou。
        "region" => "cn-hangzhou"
    );
    $ossClient = new OssClient($config);
} catch (OssException $e) {
    printf($e->getMessage() . "\n");
    return;
}

Node.js

1. 升级OSS Node.js SDK为6.20.0及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的OSS专用地域ID作为发起请求地域的标识，以华东1（杭州）为例，Region ID为oss-cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：authorizationV4。

const OSS = require('ali-oss');

const client = new OSS({
  // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  // yourRegion填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou。
  region: 'yourRegion',
  authorizationV4: true,
  // yourBucketName填写Bucket名称。
  bucket: 'yourBucketName',
});

Python

import alibabacloud_oss_v2 as oss

def main():
    # 从环境变量中加载凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 加载SDK的默认配置，并设置凭证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 方式一： 只填写Region即可
    # 填写Bucket所在地域。以华东1（杭州）为例，Region填写为cn-hangzhou
    cfg.region = 'cn-hangzhou'

    # # 方式二： 直接填写Region和Endpoint
    # # 填写Bucket所在地域。以华东1（杭州）为例，Region填写为cn-hangzhou
    # cfg.region = 'cn-hangzhou'
    # # 填写Bucket所在地域对应的公网Endpoint。以华东1（杭州）为例，Endpoint填写为'https://oss-cn-hangzhou.aliyuncs.com',
    # # 如需指定为http协议，请在指定域名时填写为'http://oss-cn-hangzhou.aliyuncs.com'
    # cfg.endpoint = 'https://oss-cn-hangzhou.aliyuncs.com'

    # 使用配置好的信息创建OSS客户端
    client = oss.Client(cfg)

    # 使用创建好的client执行后续操作...

# 当此脚本被直接运行时，调用main函数
if __name__ == "__main__":
    main()  # 脚本入口，当文件被直接运行时调用main函数

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 从环境变量中获取访问凭证。运行本代码示例之前，请先配置环境变量。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# 填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
endpoint = 'yourEndpoint'
# 填写Endpoint对应的Region信息，例如cn-hangzhou。
region = 'cn-hangzhou'

# 填写Bucket名称。
bucket = oss2.Bucket(auth, endpoint, 'examplebucket', region=region) 

Browser.js

1. 升级OSS Browser.js SDK为6.20.0及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的OSS专用地域ID作为发起请求地域的标识，以华东1（杭州）为例，Region ID为oss-cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：authorizationV4。

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Document</title>
  </head>
  <body>
    <!--导入SDK文件-->
    <script
      type="text/javascript"
      src="https://gosspublic.alicdn.com/aliyun-oss-sdk-6.20.0.min.js"
    ></script>
    <script type="text/javascript">
      const client = new OSS({
        // yourRegion填写Bucket所在地域。以华东1（杭州）为例，yourRegion填写为oss-cn-hangzhou。
        region: 'yourRegion',
	authorizationV4: true,
        // 从STS服务获取的临时访问密钥（AccessKey ID和AccessKey Secret）。
        accessKeyId: 'yourAccessKeyId',
        accessKeySecret: 'yourAccessKeySecret',
        // 从STS服务获取的安全令牌（SecurityToken）。
        stsToken: 'yourSecurityToken',
        // 填写Bucket名称，例如examplebucket。
        bucket: "examplebucket",
      });
    </script>
  </body>
</html>

.NET

1. 升级OSS .NET SDK为2.14.0及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的地域ID作为发起请求地域的标识，以华东1（杭州）为例，Region ID为cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：SignVersion.V4。

using Aliyun.OSS;
using Aliyun.OSS.Common;
// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");、

//  填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
const string endpoint = "https://oss-cn-hangzhou.aliyuncs.com";

// 填写Bucket所在地域对应的Region。以华东1（杭州）为例，Region填写为cn-hangzhou。
const string region = "cn-hangzhou";

// 创建ClientConfiguration实例，按照您的需要修改默认参数。
var conf = new ClientConfiguration();

// 设置v4签名。
conf.SignatureVersion = SignatureVersion.V4;

// 创建OssClient实例。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
client.SetRegion(region);

Go

package main

import (
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

func main() {
	// 方式一：只填写Region即可
	// 填写Bucket所在地域，以华东1（杭州）为例，Region填写为cn-hangzhou
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion("cn-hangzhou")

	// 方式二：直接填写Region和Endpoint
	// 填写Bucket所在地域，以华东1（杭州）为例，Region填写为cn-hangzhou
	// 填写Bucket所在地域对应的公网Endpoint，以华东1（杭州）为例，Endpoint填写为'https://oss-cn-hangzhou.aliyuncs.com'。如需指定为http协议，请在指定域名时填写为'http://oss-cn-hangzhou.aliyuncs.com'
	// cfg := oss.LoadDefaultConfig().
	//     WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
	//     WithRegion("cn-hangzhou").
	//     WithEndpoint("https://oss-cn-hangzhou.aliyuncs.com")

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 使用client执行后续操作...
}

package main

import (
	"log"

	"github.com/aliyun/aliyun-oss-go-sdk/oss"
)

// handleError 用于处理不可恢复的错误，并记录错误信息后终止程序。
func handleError(err error) {
	log.Fatalf("Error: %v", err)
}

// setupClient 用于设置并创建OSS客户端实例。
// 参数：
//
//	endpoint - Bucket对应的Endpoint。
//	region - Endpoint对应的Region信息。
//
// 返回创建的OSS客户端实例。
func setupClient(endpoint, region string) (*oss.Client, error) {
	// 从环境变量中获取访问凭证。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		return nil, err
	}

	// 创建OSSClient实例，并使用V4签名。
	client, err := oss.New(endpoint, "", "", oss.SetCredentialsProvider(&provider), oss.AuthVersion(oss.AuthV4), oss.Region(region))
	if err != nil {
		return nil, err
	}

	return client, nil
}

func main() {
	// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
	endpoint := "yourEndpoint"

	// yourRegion填写Endpoint对应的Region信息，例如cn-hangzhou。
	region := "yourRegion"

	// 检查环境变量是否已经设置。
	if endpoint == "" || region == "" {
		log.Fatal("Please set yourEndpoint and yourRegion.")
	}

	// 设置并创建OSS客户端实例。
	client, err := setupClient(endpoint, region)
	if err != nil {
		handleError(err)
	}

	// 输出客户端信息。
	log.Printf("Client: %#v\n", client)
}

C++

1. 升级OSS C++ SDK为1.10.0及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的地域ID作为发起请求地域的标识，以华东1（杭州）为例，Region ID为cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：SignatureVersionType::V4。

#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;

int main(void)
{
    /* 初始化OSS账号信息。*/
            
    /* yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
    std::string Endpoint = "yourEndpoint";
    /* yourRegion填写Bucket所在地域对应的Region。以华东1（杭州）为例，Region填写为cn-hangzhou。*/
    std::string Region = "yourRegion";
    
    /* 初始化网络等资源。*/
    InitializeSdk();

    ClientConfiguration conf;
    conf.signatureVersion = SignatureVersionType::V4;
    /* 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/
    auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
    OssClient client(Endpoint, credentialsProvider, conf);
    client.SetRegion(Region);

    /* 释放网络等资源。*/
    ShutdownSdk();
    return 0;
}

C

1. 升级OSS C SDK为3.11.0及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的地域ID作为发起请求地域的标识，以华东1（杭州）为例，Region ID为cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：signature_version = 4。

#include "oss_api.h"
#include "aos_http_io.h"
/* yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
const char *endpoint = "yourEndpoint";
/* yourRegion填写Bucket所在地域对应的Region。以华东1（杭州）为例，Region填写为cn-hangzhou。*/
const char *region = "yourRegion";

void init_options(oss_request_options_t *options)
{
    options->config = oss_config_create(options->pool);
    /* 用char*类型的字符串初始化aos_string_t类型。*/
    aos_str_set(&options->config->endpoint, endpoint);
    /* 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/  
    aos_str_set(&options->config->access_key_id, getenv("OSS_ACCESS_KEY_ID"));
    aos_str_set(&options->config->access_key_secret, getenv("OSS_ACCESS_KEY_SECRET"));
    //需要额外配置以下两个参数
    aos_str_set(&options->config->region, region);
    options->config->signature_version = 4;
    /* 是否使用CNAME访问OSS服务。0表示不使用。*/
    options->config->is_cname = 0;
    /* 用于设置网络相关参数，其中这个函数的第二个参数表示ctl的归属，默认为0。*/
    options->ctl = aos_http_controller_create(options->pool, 0);
}
int main() {
    aos_pool_t *p;
    oss_request_options_t *options;
    /* 初始化全局变量，在程序生命周期内只需要调用一次。*/
    if (aos_http_io_initialize(NULL, 0) != AOSE_OK) {
        return -1;
    }
    /* 初始化内存池和options。*/
    aos_pool_create(&p, NULL);
    options = oss_request_options_create(p);
    init_options(options);
    /* 逻辑代码，此处省略。*/
    /* 释放内存池，相当于释放了请求过程中各资源分配的内存。*/
    aos_pool_destroy(p);
    /* 释放之前分配的全局资源，在程序生命周期内只需要调用一次。*/
    aos_http_io_deinitialize();
    return 0;
}

iOS

1. 升级OSS iOS SDK为2.11.1及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的地域ID作为发起请求地域的标识，以华东1（杭州）为例，Region ID为cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：OSSSignVersionV4。

// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
NSString *endpoint = @"yourEndpoint";
// 从STS服务获取的临时访问密钥（AccessKey ID和AccessKey Secret）。
NSString *accessKeyId = @"yourAccessKeyId";
NSString *accessKeySecret = @"yourAccessKeySecret";
// 从STS服务获取的安全令牌（SecurityToken）。
NSString *securityToken = @"yourSecurityToken";
NSString *region = @"yourRegion";

id<OSSCredentialProvider> credentialProvider = [[OSSStsTokenCredentialProvider alloc] initWithAccessKeyId:accessKeyId secretKeyId:accessKeySecret securityToken:securityToken];
OSSClientConfiguration *configuration = [OSSClientConfiguration new];
configuration.signVersion = OSSSignVersionV4;
OSSClient *client = [[OSSClient alloc] initWithEndpoint:endpoint credentialProvider:credentialProvider clientConfiguration:configuration];
client.region = region;

Android

1. 升级OSS Android SDK为2.3及以上版本。

2. 相比V1签名，使用V4签名初始化OSS Client时，您需要：

   • 指定Bucket所在地域的地域ID作为发起请求地域的标识，以华东1（杭州）为例，Region ID为cn-hangzhou。

   • 显式声明使用 V4 签名算法，示例值：SignVersion.V4。

// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
String endpoint = "yourEndpoint";
// 从STS服务获取的临时访问密钥（AccessKey ID和AccessKey Secret）。
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// 从STS服务获取的安全令牌（SecurityToken）。
String securityToken = "yourSecurityToken";
// yourEndpoint填写Bucket所在地域。以华东1（杭州）为例，region填写为cn-hangzhou。
String region = "yourRegion";

OSSCredentialProvider credentialProvider = new OSSStsTokenCredentialProvider(accessKeyId, accessKeySecret, securityToken);
ClientConfiguration config = new ClientConfiguration();
config.setSignVersion(SignVersion.V4);
// 创建OSSClient实例。
OSSClient oss = new OSSClient(getApplicationContext(), endpoint, credentialProvider);
oss.setRegion(region);

ossutil2.0

命令行工具ossutil 2.0所有版本默认支持V4签名。

相比V1签名，使用V4签名时，您需要在配置ossutil时，使用Bucket所在地域的地域ID设置Region。

Please enter Region [cn-hangzhou]:cn-hangzhou

ossutil1.0

命令行工具ossutil 1.0的1.7.12及以上版本支持V4签名。

相比V1签名，使用V4签名时，您需要在命令中：

• 使用v4设置签名版本--sign-version。

• 使用Bucket所在地域的地域ID设置--region。

./ossutil64 --sign-version v4 --region cn-hangzhou mb oss://examplebucket

ossbrowser2.0

图形化管理工具ossbrowser 2.0（预览版）所有版本默认支持V4签名。

ossbrowser1.0

图形化管理工具ossbrowser 1.0所有版本不支持V4签名，您需要使用图形化管理工具ossbrowser 2.0（预览版）。

ossfs2.0

ossfs 2.0（预览版）所有版本都支持V4签名，默认V1版本。

1. 升级之前，执行ossfs --version命令查看当前版本，并根据实际版本要求完成以下前置操作。

   重要

   涉及卸载操作将会中断业务，建议您选择在业务低谷期进行此操作。

   卸载已挂载的OSS文件系统。<mountpoint>替换为实际目录。

   sudo umount <mountpoint>

   卸载后，请按照示例命令进行升级。

2. 相比V1签名，使用V4签名时，您需要在挂载命令中：

• 使用Bucket所在地域的地域ID设置oss_region选项。

ossfs2 mount /tmp/ossfs2-bucket/ -c /etc/ossfs2.conf   --oss_region=cn-hongkong

ossfs1.0

ossfs 1.0的1.91.4及以上版本支持V4签名。

1. 升级之前，执行ossfs --version命令查看当前版本，并根据实际版本要求完成以下前置操作。

   重要

   涉及卸载操作将会中断业务，建议您选择在业务低谷期进行此操作。

   符合版本要求升级V4

   卸载已挂载的OSS文件系统。<mountpoint>替换为实际目录。

   sudo umount <mountpoint>

   卸载后，请按照示例命令进行升级。

   不符合版本要求升级V4

   1. 卸载已挂载的OSS文件系统。<mountpoint>替换为实际目录。

      sudo umount <mountpoint>

   2. 卸载旧版本。

      如果是通过包管理工具（如 apt、yum等）安装的，请执行以下操作：

      sudo apt remove ossfs  # Ubuntu/Debian系统
      sudo yum remove ossfs  # CentOS系统/Anolis系统/Alibaba Cloud Linux系统

      如果是从源代码编译安装的，进入到安装目录并执行以下操作：

      sudo make uninstall

   3. 下载安装新版本。

   安装新版本后，请按照示例命令进行升级。

2. 相比V1签名，使用V4签名时，您需要在挂载命令中：

• 设置sigv4选项。

• 使用Bucket所在地域的地域ID设置region选项。

ossfs examplebucket -o sigv4 -o region=cn-hangzhou  /tmp/ossfs -o url=http://oss-cn-hangzhou.aliyuncs.com