credentials

package
v1.0.2 Latest Latest
Warning

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

Go to latest
Published: Dec 20, 2023 License: Apache-2.0, Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// EnvVarAccessKeyId is a name of ALIBABA_CLOUD_ACCESS_KEY_Id
	EnvVarAccessKeyId = "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"
)

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

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

GetAccessKeyId reutrns AccessKeyCreential's AccessKeyId

func (*AccessKeyCredential) GetAccessKeySecret

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) 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

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

GetAccessKeyId is useless for BearerTokenCredential

func (*BearerTokenCredential) GetAccessKeySecret

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) 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

type Config struct {
	Type                  *string `json:"type"`
	AccessKeyId           *string `json:"access_key_id"`
	AccessKeySecret       *string `json:"access_key_secret"`
	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"`
}

Config is important when call NewCredential

func (Config) GoString

func (s Config) GoString() string

func (*Config) SetAccessKeyId

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

func (*Config) SetAccessKeySecret

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

func (*Config) SetBearerToken

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

func (*Config) SetConnectTimeout

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

func (*Config) SetHost

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

func (*Config) SetPolicy

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

func (*Config) SetPrivateKeyFile

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

func (*Config) SetProxy

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

func (*Config) SetPublicKeyId

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

func (*Config) SetRoleArn

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

func (*Config) SetRoleName

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

func (*Config) SetRoleSessionExpiration

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

func (*Config) SetRoleSessionName

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

func (*Config) SetSecurityToken

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

func (*Config) SetSessionExpiration

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

func (*Config) SetTimeout

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

func (*Config) SetType

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

func (Config) String

func (s Config) String() string

type Credential

type Credential interface {
	GetAccessKeyId() (*string, error)
	GetAccessKeySecret() (*string, error)
	GetSecurityToken() (*string, error)
	GetBearerToken() *string
	GetType() *string
}

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 EcsRAMRoleCredential

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

EcsRAMRoleCredential is a kind of credential

func (*EcsRAMRoleCredential) GetAccessKeyId

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

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) 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 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
	// contains filtered or unexported fields
}

RAMRoleArnCredential is a kind of credentials

func (*RAMRoleArnCredential) GetAccessKeyId

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

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) 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

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

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) 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

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

GetAccessKeyId reutrns StsTokenCredential's AccessKeyId

func (*StsTokenCredential) GetAccessKeySecret

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) 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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL