To use Object Storage Service (OSS) SDK for Go to initiate a request, you must configure access credentials, which are used to verify your identity and access permissions. You can select different types of access credentials based on your authentication and authorization requirements. This topic describes how to configure temporary access credentials, long-term access credentials, and OpenID Connect (OIDC) access credentials.
Prerequisites
OSS SDK for Go is installed. For more information, see Installation.
Access credentials
You can choose from the following types of access credentials:
Temporary access credentials: We recommend that you use temporary access credentials in scenarios that require enhanced security. For example, you can use temporary access credentials to grant applications temporary access to OSS. Temporary access credentials are valid within the specified period of time, which helps prevent credential leaks. Temporary access credentials support fine-grained access control to prevent security risks caused by excessive permissions. For more information, see Use temporary access credentials.
Long-term access credentials: To ensure security, we recommend that you do not use long-term access credentials. For scenarios that require convenience, long-term access credentials eliminate the need for multiple refreshes within a long period of time. We recommend that you change your long-term access credentials every three months to ensure the security of your Alibaba Cloud account. If long-term access credentials are leaked or no longer used, we recommend that you delete or disable the long-term access credentials to reduce security risks. For more information, see Use long-term access credentials.
OIDC access credentials: If you need to deploy untrusted applications to a container cluster, you may want to prevent the applications from accessing the Security Token Service (STS) token of the RAM role for the instance associated with the worker by using a metadata service. In this case, you can use OIDC access credentials. OIDC is an authentication protocol based on OAuth 2.0. OIDC can be used to grant untrusted applications the minimal level of access. OIDC access credentials allow untrusted applications to access STS tokens safely without affecting the security of cloud resources. RAM roles support OIDC-based single sign-on (SSO). For more information, see OIDC access credentials.
Usage notes
This topic describes how to run shell commands to configure environment variables on macOS, Linux, and Windows. If you properly configure environment variables, programs started by command lines can recognize the required configurations. If you start the programs in an integrated development environment (IDE), you may need to refer to this topic to separately configure environment variables in the IDE.
Use temporary access credentials
If you want to use OSS SDK for Go to temporarily access OSS resources, you can use one of the following methods to configure temporary access credentials:
Configure Security Token Service (STS) temporary access credentials: If you want to grant time-limited access to your OSS resource, you need to use temporary access credentials obtained from STS. The temporary access credentials avoid exposing the AccessKey pair of your RAM user, which enhances access security.
Configure a RAM role for a RAM user: If you want to grant a RAM user of your Alibaba Cloud account or a RAM user of another Alibaba Cloud account the permissions to access your OSS resources, you can configure a RAM role for the RAM user to assume.
Configure a RAM role for an Elastic Compute Service (ECS) instance: If you want to access OSS resources from an ECS instance, you can use a RAM role of the ECS instance to access OSS resources. You can attach a RAM role to an ECS instance to access OSS resources from the instance by using temporary access credentials that are obtained from STS. STS temporary access credentials are automatically generated and updated. Applications can obtain STS temporary access credentials by using the instance metadata URL.
Configure STS temporary access credentials
Create a RAM user.
For more information, see Create a RAM user.
Attach the
AliyunSTSAssumeRoleAccess
policy to the RAM user.For more information, see Grant permissions to a RAM user.
Use the RAM user to call the AssumeRole operation of STS to obtain temporary access credentials.
For more information, see AssumeRole.
Configure the temporary access credentials provided by STS.
Environment variables
Configure environment variables to store the access credentials.
macOS
Open the terminal.
Run the following command:
nano ~/.bash_profile
Add the temporary access credentials (AccessKey ID, AccessKey secret, and security token) to the end of the file.
export OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Press
Ctrl
+X
, pressY
to save the file, and then pressEnter
to close the file.Run the following command to apply the changes:
source ~/.bash_profile
Run the following command to verify environment variable configurations:
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_SESSION_TOKEN
Sample success response:
STS.NV5ZCwphFSXqscqUHAKbH**** IrVTNZNy5yQelTETg0cZML3TQn**** CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Linux
Open the terminal.
Run the following command:
sudo vim /etc/profile
Add the temporary access credentials (AccessKey ID, AccessKey secret, and security token) to the end of the file.
export OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Press
Esc
to exit the edit mode. Then, enter:wq
and pressEnter
to save and close the file.Run the following command to apply the changes:
source /etc/profile
Run the following command to verify environment variable configurations:
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_SESSION_TOKEN
Sample success response:
STS.NV5ZCwphFSXqscqUHAKbH**** IrVTNZNy5yQelTETg0cZML3TQn**** CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Windows
Open the CLI.
Run the following command to configure environment variables for the temporary access credentials (AccessKey ID, AccessKey secret, and security token):
set OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH**** set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** set OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Run the following command to apply the changes:
setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%" setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%" setx OSS_SESSION_TOKEN "%OSS_SESSION_TOKEN%"
Run the following command to verify environment variable configurations:
echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET% echo %OSS_SESSION_TOKEN%
Sample success response:
STS.NV5ZCwphFSXqscqUHAKbH**** IrVTNZNy5yQelTETg0cZML3TQn**** CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Obtain the temporary access credentials from the environment variables.
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "os" ) func main() { // Use the temporary AccessKey pair and security token that are obtained from the environment variables. provider, err := oss.NewEnvironmentVariableCredentialsProvider() if err != nil { fmt.Println("Error:", err) os.Exit(-1) } // Create an OSSClient instance. // Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. Specify your actual endpoint. client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider)) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } }
Embedded access credentials
WarningSecurity issues may occur if you embed access credentials in code. Leaked access credentials can be used by attackers to access your resources, which causes data breaches. To ensure security, we recommend that you use more secure methods, such as obtaining temporary access credentials from environment variables.
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "os" ) func main(){ // Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. Specify your actual endpoint. // Specify the temporary AccessKey pair obtained from STS. The AccessKey pair consists of an AccessKey ID and an AccessKey secret. // Specify the security token obtained from STS. client, err := oss.New("yourEndpoint", "yourAccessKeyId", "yourAccessKeySecret", oss.SecurityToken("yourSecurityToken")) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } }
Configure a RAM role for a RAM user
Run the following command to install
alibabacloud_credentials
:pip install alibabacloud_credentials
Obtain the AccessKey pair of a RAM user.
For more information, see Create an AccessKey pair for a RAM user.
ImportantTo reduce the risk that the AccessKey pair of a RAM user is leaked, we recommend that you rotate an AccessKey pair that is used for more than three months. We recommend that you disable and delete the AccessKey pair of a RAM user that is not used for a long period of time.
Obtain RamRoleArn of the RAM role.
NoteRamRoleArn is the Alibaba Cloud Resource Name (ARN) of the RAM role. The ARN is in the format of acs:ram::$accountID:role/$roleName, where $accountID is the ID of the Alibaba Cloud account and $roleName is the name of the RAM role.
For more information, see View the information about a RAM role.
Configure the AccessKey pair of the RAM user and the ARN of the RAM role as the temporary access credentials.
Environment variables
Configure environment variables for the AccessKey pair of the RAM user and the ARN of the RAM role.
macOS
Open the terminal.
Run the following command:
nano ~/.bash_profile
Add the AccessKey pair of the RAM user and the ARN of the RAM role to the end of the file.
export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest
Press
Ctrl
+X
, pressY
to save the file, and then pressEnter
to close the file.Run the following command to apply the changes:
source /etc/profile
Run the following command to verify environment variable configurations:
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_STS_ROLE_ARN
Sample success response:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn**** acs:ram::17464958********:role/ossststest
Linux
Open the terminal.
Run the following command:
sudo vim /etc/profile
Add the AccessKey pair of the RAM user and the ARN of the RAM role to the end of the file.
export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest
Press
Esc
to exit the edit mode. Then, enter:wq
and pressEnter
to save and close the file.Run the following command to apply the changes:
source /etc/profile
Run the following command to verify environment variable configurations:
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_STS_ROLE_ARN
Sample success response:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn**** acs:ram::17464958********:role/ossststest
Windows
Open the CLI.
Run the following command to configure environment variables for the AccessKey pair of the RAM user and the ARN of the RAM role:
set OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** set OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest
Run the following command to apply the changes:
setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%" setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%" setx OSS_STS_ROLE_ARN "%OSS_STS_ROLE_ARN%"
Run the following command to verify environment variable configurations:
echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET% echo %OSS_STS_ROLE_ARN%
Sample success response:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn**** acs:ram::17464958********:role/ossststest
Obtain the AccessKey pair of the RAM user and the ARN of the RAM role from the environment variables.
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "github.com/aliyun/credentials-go/credentials" "os" ) type Credentials struct { AccessKeyId string AccessKeySecret string SecurityToken string } type defaultCredentialsProvider struct { cred credentials.Credential } func (credentials *Credentials) GetAccessKeyID() string { return credentials.AccessKeyId } func (credentials *Credentials) GetAccessKeySecret() string { return credentials.AccessKeySecret } func (credentials *Credentials) GetSecurityToken() string { return credentials.SecurityToken } func (defBuild *defaultCredentialsProvider) GetCredentials() oss.Credentials { id,_ := defBuild.cred.GetAccessKeyId() secret,_ := defBuild.cred.GetAccessKeySecret() token,_ := defBuild.cred.GetSecurityToken() return &Credentials{ AccessKeyId: *id, AccessKeySecret: *secret, SecurityToken: *token, } } func NewCredentialsProvider(credential credentials.Credential) defaultCredentialsProvider { return defaultCredentialsProvider{ cred: credential, } } func main(){ config := new(credentials.Config). // Set the credential type to ram_role_arn. SetType("ram_role_arn"). // Obtain the AccessKey ID and AccessKey secret of the RAM user from the environment variables. SetAccessKeyId(os.Getenv("OSS_ACCESS_KEY_ID")). SetAccessKeySecret(os.Getenv("OSS_ACCESS_KEY_SECRET")). // Obtain the ARN of the RAM role from the environment variable. The ARN is in the format of acs:ram::$accountID:role/$roleName. SetRoleArn(os.Getenv("OSS_STS_ROLE_ARN")). // Specify the role session name to distinguish different tokens. SetRoleSessionName("Role_Session_Name"). // (Optional) Specify the permissions of the STS token. SetPolicy(""). // (Optional) Specify the validity period of the STS token. SetRoleSessionExpiration(3600) arnCredential, err := credentials.NewCredential(config) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } provider := NewCredentialsProvider(arnCredential) client, err := oss.New("oss-cn-hangzhou.aliyuncs.com", "", "", oss.SetCredentialsProvider(&provider)) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } }
Embedded access credentials
WarningSecurity issues may occur if you embed access credentials in code. Leaked access credentials can be used by attackers to access your resources, which causes data breaches. To ensure security, we recommend that you use more secure methods, such as obtaining temporary access credentials from environment variables.
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "github.com/aliyun/credentials-go/credentials" "os" ) type Credentials struct { AccessKeyId string AccessKeySecret string SecurityToken string } type defaultCredentialsProvider struct { cred credentials.Credential } func (credentials *Credentials) GetAccessKeyID() string { return credentials.AccessKeyId } func (credentials *Credentials) GetAccessKeySecret() string { return credentials.AccessKeySecret } func (credentials *Credentials) GetSecurityToken() string { return credentials.SecurityToken } func (defBuild *defaultCredentialsProvider) GetCredentials() oss.Credentials { id,_ := defBuild.cred.GetAccessKeyId() secret,_ := defBuild.cred.GetAccessKeySecret() token,_ := defBuild.cred.GetSecurityToken() return &Credentials{ AccessKeyId: *id, AccessKeySecret: *secret, SecurityToken: *token, } } func NewCredentialsProvider(credential credentials.Credential) defaultCredentialsProvider { return defaultCredentialsProvider{ cred: credential, } } func main(){ config := new(credentials.Config). // Set the credential type to ram_role_arn. SetType("ram_role_arn"). // Specify the AccessKey pair of the RAM user. SetAccessKeyId("AccessKeyId"). SetAccessKeySecret("AccessKeySecret"). // Specify the ARN of the RAM role. The ARN is in the format of acs:ram::$accountID:role/$roleName. SetRoleArn("acs:ram::15069***********:role/ram-oss-test"). // Specify the role session name to distinguish different tokens. SetRoleSessionName("Role_Session_Name"). // (Optional) Specify the permissions of the STS token. SetPolicy(""). // (Optional) Specify the validity period of the STS token. SetRoleSessionExpiration(3600) arnCredential, err := credentials.NewCredential(config) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } provider := NewCredentialsProvider(arnCredential) client, err := oss.New("oss-cn-hangzhou.aliyuncs.com", "", "", oss.SetCredentialsProvider(&provider)) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } }
Configure a RAM role for an ECS instance
Run the following command to install
alibabacloud_credentials
:go get github.com/aliyun/credentials-go/credentials
Attach a RAM role to an ECS instance.
For more information, see Attach an instance RAM role to an ECS instance.
Configure temporary access credentials by using the RAM role for the ECS instance.
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "github.com/aliyun/credentials-go/credentials" "os" ) type Credentials struct { AccessKeyId string AccessKeySecret string SecurityToken string } type CredentialsProvider struct { cred credentials.Credential } func (credentials *Credentials) GetAccessKeyID() string { return credentials.AccessKeyId } func (credentials *Credentials) GetAccessKeySecret() string { return credentials.AccessKeySecret } func (credentials *Credentials) GetSecurityToken() string { return credentials.SecurityToken } func (defBuild CredentialsProvider) GetCredentials() oss.Credentials { id,_ := defBuild.cred.GetAccessKeyId() secret,_ := defBuild.cred.GetAccessKeySecret() token,_ := defBuild.cred.GetSecurityToken() return &Credentials{ AccessKeyId: *id, AccessKeySecret: *secret, SecurityToken: *token, } } func NewStaticCredentialsProvider(credential credentials.Credential) CredentialsProvider { return CredentialsProvider{ cred: credential, } } func main(){ config := new(credentials.Config). // Set the credential type to ecs_ram_role. SetType("ecs_ram_role"). // (Optional) Specify the role name. If you do not specify the role name, OSS automatically obtains a role name. We recommend that you specify a role name to reduce the number of requests. SetRoleName("RoleName") ecsCredential, err := credentials.NewCredential(config) if err != nil { return } provider := NewStaticCredentialsProvider(ecsCredential) client, err := oss.New("oss-cn-hangzhou.aliyuncs.com", "", "", oss.SetCredentialsProvider(&provider)) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } fmt.Printf("client:%#v\n", client) }
Use long-term access credentials
If you want to regularly use OSS SDK for Go to access OSS resources for an application or service, you can provide long-term access credentials
that consist of the AccessKey ID and AccessKey secret of a RAM user.
Configure access credentials by using AccessKey pair of a RAM user
Obtain the AccessKey pair of the RAM user.
For more information, see Create an AccessKey pair for a RAM user.
ImportantWe recommend that you rotate the AccessKey pair of a RAM user that is used for more than three months. We recommend that you disable and delete the AccessKey pair of a RAM user that is not used for a long period of time. This reduces the risk of AccessKey pair leaks.
Configure the AccessKey pair of the RAM user as access credentials.
Environment variables
Run the following command to configure environment variables:
macOS
Open the terminal.
Run the following command:
nano ~/.bash_profile
Add the AccessKey pair of the RAM user to the end of the file.
export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
Press
Ctrl
+X
, pressY
to save the file, and then pressEnter
to close the file.Run the following command to apply the changes:
source ~/.bash_profile
Run the following command to verify environment variable configurations:
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
Sample success response:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
Linux
Open the terminal.
Run the following command:
sudo vim /etc/profile
Add the AccessKey pair of the RAM user to the end of the file.
export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
Press
Esc
to exit the edit mode. Then, enter:wq
and pressEnter
to save and close the file.Run the following command to apply the changes:
source /etc/profile
Run the following command to verify environment variable configurations:
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
Sample success response:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
Windows
Open the CLI.
Run the following command to configure the environment variables for the AccessKey pair:
set OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
Run the following command to apply the changes:
setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%" setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%"
Run the following command to verify environment variable configurations:
echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET%
Sample success response:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
Obtain the AccessKey pair of the RAM user from the environment variables.
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "os" ) func main() { // Obtain access credentials from the environment variables. provider, err := oss.NewEnvironmentVariableCredentialsProvider() if err != nil { fmt.Println("Error:", err) os.Exit(-1) } // Create an OSSClient instance. // Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. Specify your actual endpoint. client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider)) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } }
Embedded access credentials
WarningSecurity issues may occur if you embed access credentials in code. Leaked access credentials can be used by attackers to access your resources, which causes data breaches. To ensure security, we recommend that you use more secure methods, such as obtaining temporary access credentials from environment variables.
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "os" ) func main() { // Create an OSSClient instance. // Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. Specify your actual endpoint. // Specify the AccessKey ID and AccessKey secret of the RAM user. client, err := oss.New("yourEndpoint", "yourAccessKeyId", "yourAccessKeySecret") if err != nil { fmt.Println("Error:", err) os.Exit(-1) } }
OIDC access credentials
For more information about OIDC role-based SSO, see Overview.
If you want to use OIDC access credentials for your application or service to access OSS, use the following steps to configure OIDC access credentials first.
Run the following command to install alibabacloud_credentials: Add the AccessKey pair of the RAM user to the end of the file.
go get github.com/aliyun/credentials-go/credentials
Create an OIDC IdP and a RAM role for the OIDC IdP. For more information, see Create a RAM role for a trusted IdP and Grant permissions to a RAM role.
Use the RAM role to provide access credentials. The following sample code creates an OSSClient instance that can be used to access OSS by using OIDC access credentials:
package main import ( "fmt" "github.com/aliyun/aliyun-oss-go-sdk/oss" "github.com/aliyun/credentials-go/credentials" "os" ) type Credentials struct { AccessKeyId string AccessKeySecret string SecurityToken string } type CredentialsProvider struct { cred credentials.Credential } func (credentials *Credentials) GetAccessKeyID() string { return credentials.AccessKeyId } func (credentials *Credentials) GetAccessKeySecret() string { return credentials.AccessKeySecret } func (credentials *Credentials) GetSecurityToken() string { return credentials.SecurityToken } func (defBuild CredentialsProvider) GetCredentials() oss.Credentials { id, _ := defBuild.cred.GetAccessKeyId() secret, _ := defBuild.cred.GetAccessKeySecret() token, _ := defBuild.cred.GetSecurityToken() return &Credentials{ AccessKeyId: *id, AccessKeySecret: *secret, SecurityToken: *token, } } func NewStaticCredentialsProvider(credential credentials.Credential) CredentialsProvider { return CredentialsProvider{ cred: credential, } } func main() { config := new(credentials.Config). // Specify the type of the credential. Set the type to oidc_role_arn. SetType("oidc_role_arn"). // Specify the ARN of the OIDC IdP. The ARN is in the acs:ram::account-id:oidc-provider/provider-name format. SetOIDCProviderArn("acs:ram::113511544585****:oidc-provider/TestOidcProvider"). // Specify the file path of the OIDC token. SetOIDCTokenFilePath("OIDCTokenFilePath"). // Specify the role session name to distinguish different tokens. SetRoleSessionName("TestOidcAssumedRoleSession"). // (Optional) Specify the policy for the RAM role. SetPolicy(""). // Specify the ARN of the RAM role. The ARN is in the acs:ram::113511544585****:oidc-provider/TestOidcProvider format. SetRoleArn("acs:ram::113511544585****:role/testoidc"). SetSessionExpiration(3600) oidcCredential, err := credentials.NewCredential(config) if err != nil { return } provider := NewStaticCredentialsProvider(oidcCredential) // Create an OSSClient instance. // Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. Specify your actual endpoint. client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider)) if err != nil { fmt.Println("Error:", err) os.Exit(-1) } fmt.Printf("client:%#v\n", client) }
What to do next
After you configure the access credentials, you can initialize an OSSClient instance. For more information, see Initialization.