credentials

package
v1.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 22, 2024 License: Apache-2.0 Imports: 18 Imported by: 51

Documentation

Index

Constants

View Source 
const (
	// EnvVarAccessKeyId is a name of ALIBABA_CLOUD_ACCESS_KEY_Id
	EnvVarAccessKeyId    = "ALIBABA_CLOUD_ACCESS_KEY_Id"
	EnvVarAccessKeyIdNew = "ALIBABA_CLOUD_ACCESS_KEY_ID"
	// EnvVarAccessKeySecret is a name of ALIBABA_CLOUD_ACCESS_KEY_SECRET
	EnvVarAccessKeySecret = "ALIBABA_CLOUD_ACCESS_KEY_SECRET"
)
View Source 
const (
	ENVCredentialFile  = "ALIBABA_CLOUD_CREDENTIALS_FILE"
	ENVEcsMetadata     = "ALIBABA_CLOUD_ECS_METADATA"
	PATHCredentialFile = "~/.alibabacloud/credentials"
	ENVRoleArn         = "ALIBABA_CLOUD_ROLE_ARN"
	ENVOIDCProviderArn = "ALIBABA_CLOUD_OIDC_PROVIDER_ARN"
	ENVOIDCTokenFile   = "ALIBABA_CLOUD_OIDC_TOKEN_FILE"
	ENVRoleSessionName = "ALIBABA_CLOUD_ROLE_SESSION_NAME"
)

Environmental virables that may be used by the provider

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessKeyCredential 

type AccessKeyCredential struct {
	AccessKeyId     string
	AccessKeySecret string
}

AccessKeyCredential is a kind of credential

func (*AccessKeyCredential) GetAccessKeyId added in v0.0.2 

func (a *AccessKeyCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId reutrns AccessKeyCreential's AccessKeyId

func (*AccessKeyCredential) GetAccessKeySecret added in v0.0.2 

func (a *AccessKeyCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret reutrns AccessKeyCreential's AccessKeySecret

func (*AccessKeyCredential) GetBearerToken 

func (a *AccessKeyCredential) GetBearerToken() *string

GetBearerToken is useless for AccessKeyCreential

func (*AccessKeyCredential) GetCredential added in v1.3.1 

func (s *AccessKeyCredential) GetCredential() (*CredentialModel, error)

func (*AccessKeyCredential) GetSecurityToken 

func (a *AccessKeyCredential) GetSecurityToken() (*string, error)

GetSecurityToken is useless for AccessKeyCreential

func (*AccessKeyCredential) GetType 

func (a *AccessKeyCredential) GetType() *string

GetType reutrns AccessKeyCreential's type

type BearerTokenCredential 

type BearerTokenCredential struct {
	BearerToken string
}

BearerTokenCredential is a kind of credential

func (*BearerTokenCredential) GetAccessKeyId added in v0.0.2 

func (b *BearerTokenCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId is useless for BearerTokenCredential

func (*BearerTokenCredential) GetAccessKeySecret added in v0.0.2 

func (b *BearerTokenCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret is useless for BearerTokenCredential

func (*BearerTokenCredential) GetBearerToken 

func (b *BearerTokenCredential) GetBearerToken() *string

GetBearerToken reutrns BearerTokenCredential's BearerToken

func (*BearerTokenCredential) GetCredential added in v1.3.1 

func (s *BearerTokenCredential) GetCredential() (*CredentialModel, error)

func (*BearerTokenCredential) GetSecurityToken 

func (b *BearerTokenCredential) GetSecurityToken() (*string, error)

GetSecurityToken is useless for BearerTokenCredential

func (*BearerTokenCredential) GetType 

func (b *BearerTokenCredential) GetType() *string

GetType reutrns BearerTokenCredential's type

type Config added in v0.0.3 

type Config struct {
	Type                  *string  `json:"type"`
	AccessKeyId           *string  `json:"access_key_id"`
	AccessKeySecret       *string  `json:"access_key_secret"`
	OIDCProviderArn       *string  `json:"oidc_provider_arn"`
	OIDCTokenFilePath     *string  `json:"oidc_token"`
	RoleArn               *string  `json:"role_arn"`
	RoleSessionName       *string  `json:"role_session_name"`
	PublicKeyId           *string  `json:"public_key_id"`
	RoleName              *string  `json:"role_name"`
	SessionExpiration     *int     `json:"session_expiration"`
	PrivateKeyFile        *string  `json:"private_key_file"`
	BearerToken           *string  `json:"bearer_token"`
	SecurityToken         *string  `json:"security_token"`
	RoleSessionExpiration *int     `json:"role_session_expiratioon"`
	Policy                *string  `json:"policy"`
	Host                  *string  `json:"host"`
	Timeout               *int     `json:"timeout"`
	ConnectTimeout        *int     `json:"connect_timeout"`
	Proxy                 *string  `json:"proxy"`
	InAdvanceScale        *float64 `json:"inAdvanceScale"`
	Url                   *string  `json:"url"`
	STSEndpoint           *string  `json:"sts_endpoint"`
	ExternalId            *string  `json:"external_id"`
}

Config is important when call NewCredential

func (Config) GoString added in v1.1.2 

func (s Config) GoString() string

func (*Config) SetAccessKeyId added in v1.1.2 

func (s *Config) SetAccessKeyId(v string) *Config

func (*Config) SetAccessKeySecret added in v1.1.2 

func (s *Config) SetAccessKeySecret(v string) *Config

func (*Config) SetBearerToken added in v1.1.2 

func (s *Config) SetBearerToken(v string) *Config

func (*Config) SetConnectTimeout added in v1.1.2 

func (s *Config) SetConnectTimeout(v int) *Config

func (*Config) SetHost added in v1.1.2 

func (s *Config) SetHost(v string) *Config

func (*Config) SetOIDCProviderArn added in v1.2.0 

func (s *Config) SetOIDCProviderArn(v string) *Config

func (*Config) SetOIDCTokenFilePath added in v1.2.0 

func (s *Config) SetOIDCTokenFilePath(v string) *Config

func (*Config) SetPolicy added in v1.1.2 

func (s *Config) SetPolicy(v string) *Config

func (*Config) SetPrivateKeyFile added in v1.1.2 

func (s *Config) SetPrivateKeyFile(v string) *Config

func (*Config) SetProxy added in v1.1.2 

func (s *Config) SetProxy(v string) *Config

func (*Config) SetPublicKeyId added in v1.1.2 

func (s *Config) SetPublicKeyId(v string) *Config

func (*Config) SetRoleArn added in v1.1.2 

func (s *Config) SetRoleArn(v string) *Config

func (*Config) SetRoleName added in v1.1.2 

func (s *Config) SetRoleName(v string) *Config

func (*Config) SetRoleSessionExpiration added in v1.1.2 

func (s *Config) SetRoleSessionExpiration(v int) *Config

func (*Config) SetRoleSessionName added in v1.1.2 

func (s *Config) SetRoleSessionName(v string) *Config

func (*Config) SetSTSEndpoint added in v1.2.7 

func (s *Config) SetSTSEndpoint(v string) *Config

func (*Config) SetSecurityToken added in v1.1.2 

func (s *Config) SetSecurityToken(v string) *Config

func (*Config) SetSessionExpiration added in v1.1.2 

func (s *Config) SetSessionExpiration(v int) *Config

func (*Config) SetTimeout added in v1.1.2 

func (s *Config) SetTimeout(v int) *Config

func (*Config) SetType added in v1.1.2 

func (s *Config) SetType(v string) *Config

func (*Config) SetURLCredential added in v1.2.0 

func (s *Config) SetURLCredential(v string) *Config

func (Config) String added in v1.1.2 

func (s Config) String() string

type Credential 

type Credential interface {
	// Deprecated: GetAccessKeyId is deprecated, use GetCredential instead of.
	GetAccessKeyId() (*string, error)
	// Deprecated: GetAccessKeySecret is deprecated, use GetCredential instead of.
	GetAccessKeySecret() (*string, error)
	// Deprecated: GetSecurityToken is deprecated, use GetCredential instead of.
	GetSecurityToken() (*string, error)
	GetBearerToken() *string
	GetType() *string
	GetCredential() (*CredentialModel, error)
}

Credential is an interface for getting actual credential

func NewCredential 

func NewCredential(config *Config) (credential Credential, err error)

NewCredential return a credential according to the type in config. if config is nil, the function will use default provider chain to get credential. please see README.md for detail.

type CredentialModel added in v1.3.1 

type CredentialModel struct {
	// accesskey id
	AccessKeyId *string `json:"accessKeyId,omitempty" xml:"accessKeyId,omitempty"`
	// accesskey secret
	AccessKeySecret *string `json:"accessKeySecret,omitempty" xml:"accessKeySecret,omitempty"`
	// security token
	SecurityToken *string `json:"securityToken,omitempty" xml:"securityToken,omitempty"`
	// bearer token
	BearerToken *string `json:"bearerToken,omitempty" xml:"bearerToken,omitempty"`
	// type
	Type *string `json:"type,omitempty" xml:"type,omitempty"`
}

CredentialModel is a model

func (CredentialModel) GoString added in v1.3.1 

func (s CredentialModel) GoString() string

func (*CredentialModel) SetAccessKeyId added in v1.3.1 

func (s *CredentialModel) SetAccessKeyId(v string) *CredentialModel

func (*CredentialModel) SetAccessKeySecret added in v1.3.1 

func (s *CredentialModel) SetAccessKeySecret(v string) *CredentialModel

func (*CredentialModel) SetBearerToken added in v1.3.1 

func (s *CredentialModel) SetBearerToken(v string) *CredentialModel

func (*CredentialModel) SetSecurityToken added in v1.3.1 

func (s *CredentialModel) SetSecurityToken(v string) *CredentialModel

func (*CredentialModel) SetType added in v1.3.1 

func (s *CredentialModel) SetType(v string) *CredentialModel

func (CredentialModel) String added in v1.3.1 

func (s CredentialModel) String() string

type EcsRAMRoleCredential 

type EcsRAMRoleCredential struct {
	RoleName string
	// contains filtered or unexported fields
}

EcsRAMRoleCredential is a kind of credential

func (*EcsRAMRoleCredential) GetAccessKeyId added in v0.0.2 

func (e *EcsRAMRoleCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId reutrns EcsRAMRoleCredential's AccessKeyId if AccessKeyId is not exist or out of date, the function will update it.

func (*EcsRAMRoleCredential) GetAccessKeySecret added in v0.0.2 

func (e *EcsRAMRoleCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret reutrns EcsRAMRoleCredential's AccessKeySecret if AccessKeySecret is not exist or out of date, the function will update it.

func (*EcsRAMRoleCredential) GetBearerToken 

func (e *EcsRAMRoleCredential) GetBearerToken() *string

GetBearerToken is useless for EcsRAMRoleCredential

func (*EcsRAMRoleCredential) GetCredential added in v1.3.1 

func (e *EcsRAMRoleCredential) GetCredential() (*CredentialModel, error)

func (*EcsRAMRoleCredential) GetSecurityToken 

func (e *EcsRAMRoleCredential) GetSecurityToken() (*string, error)

GetSecurityToken reutrns EcsRAMRoleCredential's SecurityToken if SecurityToken is not exist or out of date, the function will update it.

func (*EcsRAMRoleCredential) GetType 

func (e *EcsRAMRoleCredential) GetType() *string

GetType reutrns EcsRAMRoleCredential's type

type OIDCCredential added in v1.2.0 

type OIDCCredential struct {
	AccessKeyId           string
	AccessKeySecret       string
	RoleArn               string
	OIDCProviderArn       string
	OIDCTokenFilePath     string
	Policy                string
	RoleSessionName       string
	RoleSessionExpiration int
	// contains filtered or unexported fields
}

OIDCCredential is a kind of credentials

func (*OIDCCredential) GetAccessKeyId added in v1.2.0 

func (r *OIDCCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId reutrns OIDCCredential's AccessKeyId if AccessKeyId is not exist or out of date, the function will update it.

func (*OIDCCredential) GetAccessKeySecret added in v1.2.0 

func (r *OIDCCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret reutrns OIDCCredential's AccessKeySecret if AccessKeySecret is not exist or out of date, the function will update it.

func (*OIDCCredential) GetBearerToken added in v1.2.0 

func (r *OIDCCredential) GetBearerToken() *string

GetBearerToken is useless OIDCCredential

func (*OIDCCredential) GetCredential added in v1.3.1 

func (e *OIDCCredential) GetCredential() (*CredentialModel, error)

func (*OIDCCredential) GetOIDCToken added in v1.2.0 

func (r *OIDCCredential) GetOIDCToken(OIDCTokenFilePath string) *string

func (*OIDCCredential) GetSecurityToken added in v1.2.0 

func (r *OIDCCredential) GetSecurityToken() (*string, error)

GetSecurityToken reutrns OIDCCredential's SecurityToken if SecurityToken is not exist or out of date, the function will update it.

func (*OIDCCredential) GetType added in v1.2.0 

func (r *OIDCCredential) GetType() *string

GetType reutrns OIDCCredential's type

type OIDCResponse added in v1.2.0 

type OIDCResponse struct {
	Credentials *credentialsInResponse `json:"Credentials" xml:"Credentials"`
}

type OIDCcredentialsInResponse added in v1.2.0 

type OIDCcredentialsInResponse struct {
	AccessKeyId     string `json:"AccessKeyId" xml:"AccessKeyId"`
	AccessKeySecret string `json:"AccessKeySecret" xml:"AccessKeySecret"`
	SecurityToken   string `json:"SecurityToken" xml:"SecurityToken"`
	Expiration      string `json:"Expiration" xml:"Expiration"`
}

type Provider 

type Provider interface {
	// contains filtered or unexported methods
}

Provider will be implemented When you want to customize the provider.

type RAMRoleArnCredential 

type RAMRoleArnCredential struct {
	AccessKeyId           string
	AccessKeySecret       string
	RoleArn               string
	RoleSessionName       string
	RoleSessionExpiration int
	Policy                string
	ExternalId            string
	// contains filtered or unexported fields
}

RAMRoleArnCredential is a kind of credentials

func (*RAMRoleArnCredential) GetAccessKeyId added in v0.0.2 

func (r *RAMRoleArnCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId reutrns RamRoleArnCredential's AccessKeyId if AccessKeyId is not exist or out of date, the function will update it.

func (*RAMRoleArnCredential) GetAccessKeySecret added in v0.0.2 

func (r *RAMRoleArnCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret reutrns RamRoleArnCredential's AccessKeySecret if AccessKeySecret is not exist or out of date, the function will update it.

func (*RAMRoleArnCredential) GetBearerToken 

func (r *RAMRoleArnCredential) GetBearerToken() *string

GetBearerToken is useless RamRoleArnCredential

func (*RAMRoleArnCredential) GetCredential added in v1.3.1 

func (e *RAMRoleArnCredential) GetCredential() (*CredentialModel, error)

func (*RAMRoleArnCredential) GetSecurityToken 

func (r *RAMRoleArnCredential) GetSecurityToken() (*string, error)

GetSecurityToken reutrns RamRoleArnCredential's SecurityToken if SecurityToken is not exist or out of date, the function will update it.

func (*RAMRoleArnCredential) GetType 

func (r *RAMRoleArnCredential) GetType() *string

GetType reutrns RamRoleArnCredential's type

type RsaKeyPairCredential 

type RsaKeyPairCredential struct {
	PrivateKey        string
	PublicKeyId       string
	SessionExpiration int
	// contains filtered or unexported fields
}

RsaKeyPairCredential is a kind of credentials

func (*RsaKeyPairCredential) GetAccessKeyId added in v0.0.2 

func (r *RsaKeyPairCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId reutrns RsaKeyPairCredential's AccessKeyId if AccessKeyId is not exist or out of date, the function will update it.

func (*RsaKeyPairCredential) GetAccessKeySecret added in v0.0.2 

func (r *RsaKeyPairCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret reutrns RsaKeyPairCredential's AccessKeySecret if AccessKeySecret is not exist or out of date, the function will update it.

func (*RsaKeyPairCredential) GetBearerToken 

func (r *RsaKeyPairCredential) GetBearerToken() *string

GetBearerToken is useless for RsaKeyPairCredential

func (*RsaKeyPairCredential) GetCredential added in v1.3.1 

func (e *RsaKeyPairCredential) GetCredential() (*CredentialModel, error)

func (*RsaKeyPairCredential) GetSecurityToken 

func (r *RsaKeyPairCredential) GetSecurityToken() (*string, error)

GetSecurityToken is useless RsaKeyPairCredential

func (*RsaKeyPairCredential) GetType 

func (r *RsaKeyPairCredential) GetType() *string

GetType reutrns RsaKeyPairCredential's type

type StsTokenCredential 

type StsTokenCredential struct {
	AccessKeyId     string
	AccessKeySecret string
	SecurityToken   string
}

StsTokenCredential is a kind of credentials

func (*StsTokenCredential) GetAccessKeyId added in v0.0.2 

func (s *StsTokenCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId reutrns StsTokenCredential's AccessKeyId

func (*StsTokenCredential) GetAccessKeySecret added in v0.0.2 

func (s *StsTokenCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret reutrns StsTokenCredential's AccessKeySecret

func (*StsTokenCredential) GetBearerToken 

func (s *StsTokenCredential) GetBearerToken() *string

GetBearerToken is useless StsTokenCredential

func (*StsTokenCredential) GetCredential added in v1.3.1 

func (s *StsTokenCredential) GetCredential() (*CredentialModel, error)

func (*StsTokenCredential) GetSecurityToken 

func (s *StsTokenCredential) GetSecurityToken() (*string, error)

GetSecurityToken reutrns StsTokenCredential's SecurityToken

func (*StsTokenCredential) GetType 

func (s *StsTokenCredential) GetType() *string

GetType reutrns StsTokenCredential's type

type URLCredential added in v1.2.0 

type URLCredential struct {
	URL string
	// contains filtered or unexported fields
}

URLCredential is a kind of credential

func (*URLCredential) GetAccessKeyId added in v1.2.0 

func (e *URLCredential) GetAccessKeyId() (*string, error)

GetAccessKeyId reutrns URLCredential's AccessKeyId if AccessKeyId is not exist or out of date, the function will update it.

func (*URLCredential) GetAccessKeySecret added in v1.2.0 

func (e *URLCredential) GetAccessKeySecret() (*string, error)

GetAccessSecret reutrns URLCredential's AccessKeySecret if AccessKeySecret is not exist or out of date, the function will update it.

func (*URLCredential) GetBearerToken added in v1.2.0 

func (e *URLCredential) GetBearerToken() *string

GetBearerToken is useless for URLCredential

func (*URLCredential) GetCredential added in v1.3.1 

func (e *URLCredential) GetCredential() (*CredentialModel, error)

func (*URLCredential) GetSecurityToken added in v1.2.0 

func (e *URLCredential) GetSecurityToken() (*string, error)

GetSecurityToken reutrns URLCredential's SecurityToken if SecurityToken is not exist or out of date, the function will update it.

func (*URLCredential) GetType added in v1.2.0 

func (e *URLCredential) GetType() *string

GetType reutrns URLCredential's type

type URLResponse added in v1.2.0 

type URLResponse struct {
	AccessKeyId     string `json:"AccessKeyId" xml:"AccessKeyId"`
	AccessKeySecret string `json:"AccessKeySecret" xml:"AccessKeySecret"`
	SecurityToken   string `json:"SecurityToken" xml:"SecurityToken"`
	Expiration      string `json:"Expiration" xml:"Expiration"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.