auth

Documentation

Overview

Package auth is the credential utilities of sdk

Index

• type Credential
  • func NewCredential() Credential
  • func (c *Credential) Apply(payload map[string]interface{}) map[string]interface{}
  • func (c *Credential) BuildCredentialedQuery(params map[string]string) string
  • func (c *Credential) CreateSign(query string) string
  • func (c *Credential) IsExpired() bool
  • func (c *Credential) VerifyAc(payload map[string]interface{}) string

Types

type Credential

type Credential struct {
	// UCloud Public Key
	PublicKey string

	// UCloud Private Key
	PrivateKey string

	// UCloud STS token for temporary usage
	SecurityToken string

	// Time the credentials will expire.
	CanExpire bool
	Expires   time.Time
}

Credential is the information of credential keys

func NewCredential

func NewCredential() Credential

NewCredential will return credential config with default values

func (*Credential) Apply

func (c *Credential) Apply(payload map[string]interface{}) map[string]interface{}

Apply will return payload with credential and signature

func (*Credential) BuildCredentialedQuery

func (c *Credential) BuildCredentialedQuery(params map[string]string) string

BuildCredentialedQuery will build query string with signature query param.

func (*Credential) CreateSign

func (c *Credential) CreateSign(query string) string

CreateSign will encode query string to credential signature.

func (*Credential) IsExpired

func (c *Credential) IsExpired() bool

IsExpired will return if the credential is expired

func (*Credential) VerifyAc

func (c *Credential) VerifyAc(payload map[string]interface{}) string

VerifyAc will return payload with credential and signature