-
Notifications
You must be signed in to change notification settings - Fork 271
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add default credentials provider(credentials provider chain)
- Loading branch information
1 parent
bdee72c
commit fbea940
Showing
4 changed files
with
192 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package credentials | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
| ) | ||
|
|
||
| type DefaultCredentialsProvider struct { | ||
| providerChain []CredentialsProvider | ||
| lastUsedProvider CredentialsProvider | ||
| } | ||
|
|
||
| func NewDefaultCredentialsProvider() (provider *DefaultCredentialsProvider) { | ||
| providers := []CredentialsProvider{} | ||
|
|
||
| // Add static ak or sts credentials provider | ||
| providers = append(providers, NewEnvironmentVariableCredentialsProvider()) | ||
|
|
||
| // oidc check | ||
| oidcProvider, err := NewOIDCCredentialsProviderBuilder().Build() | ||
| if err == nil { | ||
| providers = append(providers, oidcProvider) | ||
| } | ||
|
|
||
| // cli credentials provider | ||
| providers = append(providers, NewCLIProfileCredentialsProviderBuilder().Build()) | ||
|
|
||
| // profile credentials provider | ||
| // providers = append(providers) | ||
| providers = append(providers, NewProfileCredentialsProviderBuilder().Build()) | ||
|
|
||
| // Add IMDS | ||
| if os.Getenv("ALIBABA_CLOUD_ECS_METADATA") != "" { | ||
| ecsRamRoleProvider := NewECSRAMRoleCredentialsProvider(os.Getenv("ALIBABA_CLOUD_ECS_METADATA")) | ||
| providers = append(providers, ecsRamRoleProvider) | ||
| } | ||
|
|
||
| // TODO: ALIBABA_CLOUD_CREDENTIALS_URI check | ||
|
|
||
| return &DefaultCredentialsProvider{ | ||
| providerChain: providers, | ||
| } | ||
| } | ||
|
|
||
| func (provider *DefaultCredentialsProvider) GetCredentials() (cc *Credentials, err error) { | ||
| if provider.lastUsedProvider != nil { | ||
| return provider.lastUsedProvider.GetCredentials() | ||
| } | ||
|
|
||
| errors := []string{} | ||
| for _, p := range provider.providerChain { | ||
| provider.lastUsedProvider = p | ||
| cc, err = p.GetCredentials() | ||
| if err != nil { | ||
| errors = append(errors, err.Error()) | ||
| // 如果有错误，进入下一个获取过程 | ||
| continue | ||
| } | ||
|
|
||
| if cc != nil { | ||
| return | ||
| } | ||
| } | ||
|
|
||
| err = fmt.Errorf("unable to get credentials from any of the providers in the chain: %s", strings.Join(errors, ", ")) | ||
| return | ||
| } |
102 changes: 102 additions & 0 deletions
102
sdk/auth/credentials/default_credentials_provider_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| package credentials | ||
|
|
||
| import ( | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/aliyun/alibaba-cloud-sdk-go/sdk/internal" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestDefaultCredentialsProvider(t *testing.T) { | ||
| provider := NewDefaultCredentialsProvider() | ||
| assert.NotNil(t, provider) | ||
| assert.Len(t, provider.providerChain, 3) | ||
| _, ok := provider.providerChain[0].(*EnvironmentVariableCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[1].(*CLIProfileCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[2].(*ProfileCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| // Add oidc provider | ||
| rollback := internal.Memory("ALIBABA_CLOUD_OIDC_TOKEN_FILE", | ||
| "ALIBABA_CLOUD_OIDC_PROVIDER_ARN", | ||
| "ALIBABA_CLOUD_ROLE_ARN", | ||
| "ALIBABA_CLOUD_ECS_METADATA") | ||
|
|
||
| defer rollback() | ||
| os.Setenv("ALIBABA_CLOUD_OIDC_TOKEN_FILE", "/path/to/oidc.token") | ||
| os.Setenv("ALIBABA_CLOUD_OIDC_PROVIDER_ARN", "oidcproviderarn") | ||
| os.Setenv("ALIBABA_CLOUD_ROLE_ARN", "rolearn") | ||
|
|
||
| provider = NewDefaultCredentialsProvider() | ||
| assert.NotNil(t, provider) | ||
| assert.Len(t, provider.providerChain, 4) | ||
| _, ok = provider.providerChain[0].(*EnvironmentVariableCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[1].(*OIDCCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[2].(*CLIProfileCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[3].(*ProfileCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| // Add ecs ram role | ||
| os.Setenv("ALIBABA_CLOUD_ECS_METADATA", "rolename") | ||
| provider = NewDefaultCredentialsProvider() | ||
| assert.NotNil(t, provider) | ||
| assert.Len(t, provider.providerChain, 5) | ||
| _, ok = provider.providerChain[0].(*EnvironmentVariableCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[1].(*OIDCCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[2].(*CLIProfileCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[3].(*ProfileCredentialsProvider) | ||
| assert.True(t, ok) | ||
|
|
||
| _, ok = provider.providerChain[4].(*ECSRAMRoleCredentialsProvider) | ||
| assert.True(t, ok) | ||
| } | ||
|
|
||
| func TestDefaultCredentialsProvider_GetCredentials(t *testing.T) { | ||
| rollback := internal.Memory("ALIBABA_CLOUD_ACCESS_KEY_ID", | ||
| "ALIBABA_CLOUD_ACCESS_KEY_SECRET", | ||
| "ALIBABA_CLOUD_SECURITY_TOKEN") | ||
|
|
||
| defer func() { | ||
| getHomePath = internal.GetHomePath | ||
| rollback() | ||
| }() | ||
|
|
||
| // testcase: empty home | ||
| getHomePath = func() string { | ||
| return "" | ||
| } | ||
|
|
||
| provider := NewDefaultCredentialsProvider() | ||
| assert.Len(t, provider.providerChain, 3) | ||
| _, err := provider.GetCredentials() | ||
| assert.EqualError(t, err, "unable to get credentials from any of the providers in the chain: unable to get credentials from enviroment variables, Access key ID must be specified via environment variable (ALIBABA_CLOUD_ACCESS_KEY_ID), cannot found home dir, cannot found home dir") | ||
|
|
||
| os.Setenv("ALIBABA_CLOUD_ACCESS_KEY_ID", "akid") | ||
| os.Setenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET", "aksecret") | ||
| provider = NewDefaultCredentialsProvider() | ||
| assert.Len(t, provider.providerChain, 3) | ||
| cc, err := provider.GetCredentials() | ||
| assert.Nil(t, err) | ||
| assert.Equal(t, &Credentials{AccessKeyId: "akid", AccessKeySecret: "aksecret", SecurityToken: "", BearerToken: ""}, cc) | ||
| // get again | ||
| cc, err = provider.GetCredentials() | ||
| assert.Nil(t, err) | ||
| assert.Equal(t, &Credentials{AccessKeyId: "akid", AccessKeySecret: "aksecret", SecurityToken: "", BearerToken: ""}, cc) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters