阿里云SDK：管理访问凭据

背景信息

在使用阿里云SDK进行开发时，需要根据具体的应用场景和授权需求选择合适的访问凭据类型，并正确配置和管理这些凭据。通过合理设置环境变量或配置文件，确保SDK能够正确读取和使用凭据，从而帮助开发者构建稳定、可靠的应用程序。

前提条件

• Go 环境版本必须不低于 1.10.x。

• 安装 SDK 核心库 Core

  go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk

初始化凭据客户端

方式一：使用默认凭证链

当您在初始化凭据客户端不传入任何参数时，SDK会使用默认凭据链方式初始化客户端。默认凭据的读取逻辑请参见默认凭据链。

package main

import (
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/auth/credentials/provider"
)

func main() {
    config := sdk.NewConfig()
    
    // 不传参数
    credentialsProvider := credentials.NewDefaultCredentialsProvider()
    
    // <REGION_ID>：指定客户端要访问的阿里云区域。示例值:cn_hangzhou。
    sdk.NewClientWithOptions("<REGION_ID>", config, credentialsProvider)
    
    // 省略调用API步骤...
}

方式二：使用AK

阿里云账号和RAM用户可以生成用于调用OpenAPI的AccessKey密钥对，您可以使用该AccessKey初始化客户端。

package main

import (
    "os"

    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/auth/credentials"
)

func main() {
    config := sdk.NewConfig()

    // 这里通过环境变量获取RAM用户的AccessKey ID和AccessKey Secret，以避免硬编码带来的安全风险
    credentialsProvider := credentials.NewStaticAKCredentialsProvider(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
    
    // <REGION_ID>：指定客户端要访问的阿里云区域。示例值:cn_hangzhou
    sdk.NewClientWithOptions("<REGION_ID>", config, credentialsProvider)
    
    // 省略调用API步骤...
}

方式三：使用STS Token

通过安全令牌服务（Security Token Service，简称 STS），申请临时安全凭证（Temporary Security Credentials，简称 TSC），创建临时安全客户端。

package main

import (
    "os"

    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/auth/credentials"
)

func main() {
    config := sdk.NewConfig()

    // 这里通过环境变量获取RAM用户的AccessKey ID、AccessKey Secret和STS Token，以避免硬编码带来的安全风险
    credentialsProvider := credentials.NewStaticSTSCredentialsProvider(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"), os.Getenv("ALIBABA_CLOUD_SECURITY_TOKEN"))
    
    // <REGION_ID>：指定客户端要访问的阿里云区域。示例值:cn_hangzhou。
    client, err := sdk.NewClientWithOptions("<REGION_ID>", config, credentialsProvider)
    
    // 省略调用API步骤...
}

方式四：使用AK及RamRoleArn

通过指定RAM角色的ARN（Alibabacloud Resource Name）来初始化客户端。客户端在发起请求前，需先通过调用STS服务获取STS Token。若需限制STS Token的权限，可使用自定义权限策略.

package main

import (
    "os"

    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/auth/credentials"
)

func main() {
    config := sdk.NewConfig()
    
    credentialsProvider := credentials.NewRamRoleArnWithPolicyAndExternalIdCredential(
        // os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")：从环境变量中获取RAM用户AccessKey ID
        os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
        // os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")：从环境变量中获取RAM用户AccessKey Secret
        os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
        // "<ROLE_ARN>"：指定要扮演的RAM角色的ARN。示例值：acs:ram::123456789012****:role/adminrole。
        "<ROLE_ARN>",
        // "<ROLE_SESSION_NAME>"：指定角色会话的名称，用于标识和区分不同的会话。示例值：alice。
        "<ROLE_SESSION_NAME>",
        // "<POLICY>"：指定一个自定义的授权策略用于限制角色会话的权限。示例值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}。
        "<POLICY>",
        // "<EXTERNAL_ID>"：指定一个角色外部ID，防止混淆代理人问题。示例值：abcd1234。
        "<EXTERNAL_ID>",
        // <ROLE_SESSION_EXPIRATION>：Token 有效期。示例值：3600。
        "<ROLE_SESSION_EXPIRATION>"
    )
    
    // <REGION_ID>：指定客户端要访问的阿里云区域。示例值:cn_hangzhou
    client, err := sdk.NewClientWithOptions("<REGION_ID>", config, credentialsProvider)
    
    // 省略调用API步骤...
}

方式五：使用ECS实例RAM角色

package main

import (
    "os"

    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/auth/credentials"
)

func main() {
    
    // 通过ECS实例的RAM角色来获取访问凭证，从而创建一个阿里云客户端
    // 它适用于那些需要在ECS实例上运行，并且需要访问其他阿里云资源的程序
    // "<ROLE_NAME>"：指定要使用的RAM角色名称，您可以在环境变量ALIBABA_CLOUD_ECS_METADATA中设置 roleName 默认值。示例值：alice。
   credentialsProvider := credentials.NewECSRAMRoleCredentialsProvider("<ROLE_NAME>")
   
   // <REGION_ID>：指定客户端要访问的阿里云区域。示例值:cn_hangzhou。
   client, err := sdk.NewClientWithOptions("<REGION_ID>", config, credentialsProvider)

   // 省略调用API步骤...
}

方式六：使用OIDCRoleArn

package main

import (
	"os"

	"github.com/aliyun/alibaba-cloud-sdk-go/sdk"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/auth/credentials"
)

func main() {
    config := sdk.NewConfig()

    // 使用OIDCRoleArn初始化SDK客户端
    oidcProvider, _ := credentials.NewOIDCCredentialsProviderBuilder().
	// OIDC提供商ARN，可以通过环境变量ALIBABA_CLOUD_OIDC_PROVIDER_ARN设置OIDCProviderARN
	WithOIDCProviderARN(os.Getenv("ALIBABA_CLOUD_OIDC_PROVIDER_ARN")).
	// OIDC Token文件路径，可以通过环境变量ALIBABA_CLOUD_OIDC_TOKEN_FILE设置OIDCTokenFilePath
	WithOIDCTokenFilePath(os.Getenv("ALIBABA_CLOUD_OIDC_TOKEN_FILE")).
	// RAM角色名称ARN，可以通过环境变量ALIBABA_CLOUD_ROLE_ARN设置RoleArn
	WithRoleArn(os.Getenv("ALIBABA_CLOUD_ROLE_ARN")).
	// "<ROLE_SESSION_NAME>"：自定义角色会话名称。示例值：alice。
	WithRoleSessionName("<ROLE_SESSION_NAME>").
	// "<POLICY>"：设置更小的权限策略，非必填。示例值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}。
	WithPolicy("<POLICY>").
	// <ROLE_SESSION_EXPIRATION>：设置session过期时间。示例值：3600。
	WithDurationSeconds( "<ROLE_SESSION_EXPIRATION>").
	Build()
        
        // <REGION_ID>：指定客户端要访问的阿里云区域。示例值:cn_hangzhou。
	client, err := sdk.NewClientWithOptions("<REGION_ID>", config, oidcProvider)

        // 省略调用API步骤...
}

方式七：使用Bearer Token

目前只有云呼叫中心CCC这款产品支持Bearer Token的凭据初始化方式。

package main

import (
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/auth/credentials"
)

func main() {
    config := sdk.NewConfig()

    // <BEARER_TOKEN>是一种认证方式，用于授权访问API
    credentialsProvider := credentials.NewBearerTokenCredentialsProvider("BEARER_TOKEN")
    
    // <REGION_ID>：指定客户端要访问的阿里云区域。示例值:cn_hangzhou。
    client, err := sdk.NewClientWithOptions("<REGION_ID>", config, credentialsProvider)

    // 省略调用API步骤...
}

默认凭据链

当开发环境与生产环境使用的凭据类型不一致时，常见做法是在代码中获取当前环境信息，编写获取不同凭据的分支代码。借助Credentials工具的默认凭据链，您可以用同一套代码，通过程序之外的配置来控制不同环境下的凭据获取方式。当您使用credentials.NewDefaultCredentialsProvider()初始化凭据客户端，且不传入任何参数时，阿里云SDK将会尝试按照如下顺序查找相关凭据信息。

1. 使用环境变量

2. 使用OIDC RAM角色

3. 使用config.json配置文件

{
	"current": "default",
	"profiles": [
		{
			"name": "default",
			"mode": "AK",
			"access_key_id": "<ALIBABA_CLOUD_ACCESS_KEY_ID>",
			"access_key_secret": "<ALIBABA_CLOUD_ACCESS_KEY_SECRET>"
		},
		{
			"name":"client1",
			"mode":"RamRoleArn",
			"access_key_id":"<ALIBABA_CLOUD_ACCESS_KEY_ID>",
			"access_key_secret":"<ALIBABA_CLOUD_ACCESS_KEY_SECRET>",
			"ram_role_arn":"<ROLE_ARN>",
			"ram_session_name":"<ROLE_SESSION_NAME>",
			"expired_seconds":3600
		},
		{
			"name":"client2",
			"mode":"EcsRamRole",
			"ram_role_name":"<RAM_ROLE_ARN>"
		},
		{
			"name":"client3",
			"mode":"OIDC",
			"oidc_provider_arn":"<OIDC_PROVIDER_ARN>",
			"oidc_token_file":"<OIDC_TOKEN_FILE>",
			"ram_role_arn":"<ROLE_ARN>",
			"ram_session_name":"<ROLE_SESSION_NAME>",
			"expired_seconds":3600
		},
		{
			"name":"client4",
			"mode":"ChainableRamRoleArn",
			"source_profile":"<PROFILE_NAME>",
			"ram_role_arn":"<ROLE_ARN>",
			"ram_session_name":"<ROLE_SESSION_NAME>",
			"expired_seconds":3600
		}
	]
}

4. ECS实例RAM角色

5. 使用Credentials工具URI