Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename to formal credentials provider name #89

Merged
merged 1 commit into from
Jul 29, 2024
Merged

rename to formal credentials provider name #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions credentials/ecs_ram_role.go → ...ials/ecs_ram_role_credentials_provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ var securityCredTokenURL = "http://100.100.100.200/latest/api/token"

const defaultMetadataTokenDuration = int(21600)

// EcsRAMRoleCredential is a kind of credential
type EcsRAMRoleCredential struct {
// ECSRAMRoleCredentialsProvider is a kind of credentials provider
type ECSRAMRoleCredentialsProvider struct {
*credentialUpdater
RoleName string
EnableIMDSv2 bool
Expand All @@ -36,12 +36,12 @@ type ecsRAMRoleResponse struct {
Expiration string `json:"Expiration" xml:"Expiration"`
}

func newEcsRAMRoleCredentialWithEnableIMDSv2(roleName string, enableIMDSv2 bool, metadataTokenDuration int, inAdvanceScale float64, runtime *utils.Runtime) *EcsRAMRoleCredential {
func newEcsRAMRoleCredentialWithEnableIMDSv2(roleName string, enableIMDSv2 bool, metadataTokenDuration int, inAdvanceScale float64, runtime *utils.Runtime) *ECSRAMRoleCredentialsProvider {
credentialUpdater := new(credentialUpdater)
if inAdvanceScale < 1 && inAdvanceScale > 0 {
credentialUpdater.inAdvanceScale = inAdvanceScale
}
return &EcsRAMRoleCredential{
return &ECSRAMRoleCredentialsProvider{
RoleName: roleName,
EnableIMDSv2: enableIMDSv2,
MetadataTokenDuration: metadataTokenDuration,
Expand All @@ -50,7 +50,7 @@ func newEcsRAMRoleCredentialWithEnableIMDSv2(roleName string, enableIMDSv2 bool,
}
}

func (e *EcsRAMRoleCredential) GetCredential() (*CredentialModel, error) {
func (e *ECSRAMRoleCredentialsProvider) GetCredential() (*CredentialModel, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
Expand All @@ -68,7 +68,7 @@ func (e *EcsRAMRoleCredential) GetCredential() (*CredentialModel, error) {

// GetAccessKeyId reutrns EcsRAMRoleCredential's AccessKeyId
// if AccessKeyId is not exist or out of date, the function will update it.
func (e *EcsRAMRoleCredential) GetAccessKeyId() (*string, error) {
func (e *ECSRAMRoleCredentialsProvider) GetAccessKeyId() (*string, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
Expand All @@ -83,7 +83,7 @@ func (e *EcsRAMRoleCredential) GetAccessKeyId() (*string, error) {

// GetAccessSecret reutrns EcsRAMRoleCredential's AccessKeySecret
// if AccessKeySecret is not exist or out of date, the function will update it.
func (e *EcsRAMRoleCredential) GetAccessKeySecret() (*string, error) {
func (e *ECSRAMRoleCredentialsProvider) GetAccessKeySecret() (*string, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
Expand All @@ -98,7 +98,7 @@ func (e *EcsRAMRoleCredential) GetAccessKeySecret() (*string, error) {

// GetSecurityToken reutrns EcsRAMRoleCredential's SecurityToken
// if SecurityToken is not exist or out of date, the function will update it.
func (e *EcsRAMRoleCredential) GetSecurityToken() (*string, error) {
func (e *ECSRAMRoleCredentialsProvider) GetSecurityToken() (*string, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
Expand All @@ -112,12 +112,12 @@ func (e *EcsRAMRoleCredential) GetSecurityToken() (*string, error) {
}

// GetBearerToken is useless for EcsRAMRoleCredential
func (e *EcsRAMRoleCredential) GetBearerToken() *string {
func (e *ECSRAMRoleCredentialsProvider) GetBearerToken() *string {
return tea.String("")
}

// GetType reutrns EcsRAMRoleCredential's type
func (e *EcsRAMRoleCredential) GetType() *string {
func (e *ECSRAMRoleCredentialsProvider) GetType() *string {
return tea.String("ecs_ram_role")
}

Expand All @@ -133,7 +133,7 @@ func getRoleName() (string, error) {
return string(content), nil
}

func (e *EcsRAMRoleCredential) getMetadataToken() (err error) {
func (e *ECSRAMRoleCredentialsProvider) getMetadataToken() (err error) {
if e.needToRefresh() {
if e.MetadataTokenDuration <= 0 {
e.MetadataTokenDuration = defaultMetadataTokenDuration
Expand All @@ -153,7 +153,7 @@ func (e *EcsRAMRoleCredential) getMetadataToken() (err error) {
return
}

func (e *EcsRAMRoleCredential) updateCredential() (err error) {
func (e *ECSRAMRoleCredentialsProvider) updateCredential() (err error) {
if e.runtime == nil {
e.runtime = new(utils.Runtime)
}
Expand Down Expand Up @@ -201,7 +201,7 @@ func (e *EcsRAMRoleCredential) updateCredential() (err error) {
return
}

func (e *EcsRAMRoleCredential) needToRefresh() (needToRefresh bool) {
func (e *ECSRAMRoleCredentialsProvider) needToRefresh() (needToRefresh bool) {
needToRefresh = time.Now().Unix() >= e.staleTime
return
}
2 changes: 1 addition & 1 deletion credentials/ecs_ram_role_test.go → ...ecs_ram_role_credentials_provider_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
func Test_EcsRAmRoleCredential(t *testing.T) {
credentialUpdater := new(credentialUpdater)
credentialUpdater.inAdvanceScale = 0.5
auth := &EcsRAMRoleCredential{
auth := &ECSRAMRoleCredentialsProvider{
RoleName: "go sdk",
credentialUpdater: credentialUpdater,
runtime: nil,
Expand Down
40 changes: 20 additions & 20 deletions credentials/sts_role_arn_credential.go → ...ials/ram_role_arn_credentials_provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (

const defaultDurationSeconds = 3600

// RAMRoleArnCredential is a kind of credentials
type RAMRoleArnCredential struct {
// RAMRoleArnCredentialsProvider is a kind of credentials
type RAMRoleArnCredentialsProvider struct {
*credentialUpdater
AccessKeyId string
AccessKeySecret string
Expand All @@ -40,8 +40,8 @@ type credentialsInResponse struct {
Expiration string `json:"Expiration" xml:"Expiration"`
}

func newRAMRoleArnl(accessKeyId, accessKeySecret, securityToken, roleArn, roleSessionName, policy string, roleSessionExpiration int, externalId string, runtime *utils.Runtime) *RAMRoleArnCredential {
return &RAMRoleArnCredential{
func newRAMRoleArnl(accessKeyId, accessKeySecret, securityToken, roleArn, roleSessionName, policy string, roleSessionExpiration int, externalId string, runtime *utils.Runtime) *RAMRoleArnCredentialsProvider {
return &RAMRoleArnCredentialsProvider{
AccessKeyId: accessKeyId,
AccessKeySecret: accessKeySecret,
SecurityToken: securityToken,
Expand All @@ -55,8 +55,8 @@ func newRAMRoleArnl(accessKeyId, accessKeySecret, securityToken, roleArn, roleSe
}
}

func newRAMRoleArnCredential(accessKeyId, accessKeySecret, roleArn, roleSessionName, policy string, roleSessionExpiration int, runtime *utils.Runtime) *RAMRoleArnCredential {
return &RAMRoleArnCredential{
func newRAMRoleArnCredential(accessKeyId, accessKeySecret, roleArn, roleSessionName, policy string, roleSessionExpiration int, runtime *utils.Runtime) *RAMRoleArnCredentialsProvider {
return &RAMRoleArnCredentialsProvider{
AccessKeyId: accessKeyId,
AccessKeySecret: accessKeySecret,
RoleArn: roleArn,
Expand All @@ -68,8 +68,8 @@ func newRAMRoleArnCredential(accessKeyId, accessKeySecret, roleArn, roleSessionN
}
}

func newRAMRoleArnWithExternalIdCredential(accessKeyId, accessKeySecret, roleArn, roleSessionName, policy string, roleSessionExpiration int, externalId string, runtime *utils.Runtime) *RAMRoleArnCredential {
return &RAMRoleArnCredential{
func newRAMRoleArnWithExternalIdCredential(accessKeyId, accessKeySecret, roleArn, roleSessionName, policy string, roleSessionExpiration int, externalId string, runtime *utils.Runtime) *RAMRoleArnCredentialsProvider {
return &RAMRoleArnCredentialsProvider{
AccessKeyId: accessKeyId,
AccessKeySecret: accessKeySecret,
RoleArn: roleArn,
Expand All @@ -82,7 +82,7 @@ func newRAMRoleArnWithExternalIdCredential(accessKeyId, accessKeySecret, roleArn
}
}

func (e *RAMRoleArnCredential) GetCredential() (*CredentialModel, error) {
func (e *RAMRoleArnCredentialsProvider) GetCredential() (*CredentialModel, error) {
if e.sessionCredential == nil || e.needUpdateCredential() {
err := e.updateCredential()
if err != nil {
Expand All @@ -98,9 +98,9 @@ func (e *RAMRoleArnCredential) GetCredential() (*CredentialModel, error) {
return credential, nil
}

// GetAccessKeyId reutrns RamRoleArnCredential's AccessKeyId
// GetAccessKeyId reutrns RAMRoleArnCredentialsProvider's AccessKeyId
// if AccessKeyId is not exist or out of date, the function will update it.
func (r *RAMRoleArnCredential) GetAccessKeyId() (accessKeyId *string, err error) {
func (r *RAMRoleArnCredentialsProvider) GetAccessKeyId() (accessKeyId *string, err error) {
c, err := r.GetCredential()
if err != nil {
return
Expand All @@ -110,9 +110,9 @@ func (r *RAMRoleArnCredential) GetAccessKeyId() (accessKeyId *string, err error)
return
}

// GetAccessSecret reutrns RamRoleArnCredential's AccessKeySecret
// GetAccessSecret reutrns RAMRoleArnCredentialsProvider's AccessKeySecret
// if AccessKeySecret is not exist or out of date, the function will update it.
func (r *RAMRoleArnCredential) GetAccessKeySecret() (accessKeySecret *string, err error) {
func (r *RAMRoleArnCredentialsProvider) GetAccessKeySecret() (accessKeySecret *string, err error) {
c, err := r.GetCredential()
if err != nil {
return
Expand All @@ -122,9 +122,9 @@ func (r *RAMRoleArnCredential) GetAccessKeySecret() (accessKeySecret *string, er
return
}

// GetSecurityToken reutrns RamRoleArnCredential's SecurityToken
// GetSecurityToken reutrns RAMRoleArnCredentialsProvider's SecurityToken
// if SecurityToken is not exist or out of date, the function will update it.
func (r *RAMRoleArnCredential) GetSecurityToken() (securityToken *string, err error) {
func (r *RAMRoleArnCredentialsProvider) GetSecurityToken() (securityToken *string, err error) {
c, err := r.GetCredential()
if err != nil {
return
Expand All @@ -134,17 +134,17 @@ func (r *RAMRoleArnCredential) GetSecurityToken() (securityToken *string, err er
return
}

// GetBearerToken is useless RamRoleArnCredential
func (r *RAMRoleArnCredential) GetBearerToken() *string {
// GetBearerToken is useless RAMRoleArnCredentialsProvider
func (r *RAMRoleArnCredentialsProvider) GetBearerToken() *string {
return tea.String("")
}

// GetType reutrns RamRoleArnCredential's type
func (r *RAMRoleArnCredential) GetType() *string {
// GetType reutrns RAMRoleArnCredentialsProvider's type
func (r *RAMRoleArnCredentialsProvider) GetType() *string {
return tea.String("ram_role_arn")
}

func (r *RAMRoleArnCredential) updateCredential() (err error) {
func (r *RAMRoleArnCredentialsProvider) updateCredential() (err error) {
if r.runtime == nil {
r.runtime = new(utils.Runtime)
}
Expand Down
0 credentials/sts_role_arn_credential_test.go → ...ram_role_arn_credentials_provider_test.go
View file
Open in desktop
File renamed without changes.
20 changes: 10 additions & 10 deletions credentials/access_key_credential.go → ...entials/static_ak_credentials_provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@ package credentials

import "github.com/alibabacloud-go/tea/tea"

// AccessKeyCredential is a kind of credential
type AccessKeyCredential struct {
// StaticAKCredentialsProvider is a kind of credentials provider
type StaticAKCredentialsProvider struct {
AccessKeyId string
AccessKeySecret string
}

func newAccessKeyCredential(accessKeyId, accessKeySecret string) *AccessKeyCredential {
return &AccessKeyCredential{
func newAccessKeyCredential(accessKeyId, accessKeySecret string) *StaticAKCredentialsProvider {
return &StaticAKCredentialsProvider{
AccessKeyId: accessKeyId,
AccessKeySecret: accessKeySecret,
}
}

func (s *AccessKeyCredential) GetCredential() (*CredentialModel, error) {
func (s *StaticAKCredentialsProvider) GetCredential() (*CredentialModel, error) {
credential := &CredentialModel{
AccessKeyId: tea.String(s.AccessKeyId),
AccessKeySecret: tea.String(s.AccessKeySecret),
Expand All @@ -25,26 +25,26 @@ func (s *AccessKeyCredential) GetCredential() (*CredentialModel, error) {
}

// GetAccessKeyId reutrns AccessKeyCreential's AccessKeyId
func (a *AccessKeyCredential) GetAccessKeyId() (*string, error) {
func (a *StaticAKCredentialsProvider) GetAccessKeyId() (*string, error) {
return tea.String(a.AccessKeyId), nil
}

// GetAccessSecret reutrns AccessKeyCreential's AccessKeySecret
func (a *AccessKeyCredential) GetAccessKeySecret() (*string, error) {
func (a *StaticAKCredentialsProvider) GetAccessKeySecret() (*string, error) {
return tea.String(a.AccessKeySecret), nil
}

// GetSecurityToken is useless for AccessKeyCreential
func (a *AccessKeyCredential) GetSecurityToken() (*string, error) {
func (a *StaticAKCredentialsProvider) GetSecurityToken() (*string, error) {
return tea.String(""), nil
}

// GetBearerToken is useless for AccessKeyCreential
func (a *AccessKeyCredential) GetBearerToken() *string {
func (a *StaticAKCredentialsProvider) GetBearerToken() *string {
return tea.String("")
}

// GetType reutrns AccessKeyCreential's type
func (a *AccessKeyCredential) GetType() *string {
func (a *StaticAKCredentialsProvider) GetType() *string {
return tea.String("access_key")
}
0 credentials/access_key_credential_test.go → ...ls/static_ak_credentials_provider_test.go
View file
Open in desktop
File renamed without changes.
Loading