auth

Documentation

Index

• Variables
• func IsAccessKeyValid(accessKey string) bool
• func IsSecretKeyValid(secretKey string) bool
• type Credentials
  • func CreateCredentials(accessKey, secretKey string) (cred Credentials, err error)
  • func GetNewCredentials() (cred Credentials, err error)
  • func GetNewCredentialsWithMetadata(m map[string]interface{}, tokenSecret string) (cred Credentials, err error)
  • func (cred Credentials) Equal(ccred Credentials) bool
  • func (cred Credentials) IsExpired() bool
  • func (cred Credentials) IsValid() bool

Variables

var (
	ErrInvalidAccessKeyLength = fmt.Errorf("access key must be minimum %v or more characters long", accessKeyMinLen)
	ErrInvalidSecretKeyLength = fmt.Errorf("secret key must be minimum %v or more characters long", secretKeyMinLen)
)

Common errors generated for access and secret key validation.

Functions

func IsAccessKeyValid

func IsAccessKeyValid(accessKey string) bool

IsAccessKeyValid - validate access key for right length.

func IsSecretKeyValid

func IsSecretKeyValid(secretKey string) bool

IsSecretKeyValid - validate secret key for right length.

Types

type Credentials

type Credentials struct {
	AccessKey    string    `xml:"AccessKeyId" json:"accessKey,omitempty"`
	SecretKey    string    `xml:"SecretAccessKey" json:"secretKey,omitempty"`
	Expiration   time.Time `xml:"Expiration" json:"expiration,omitempty"`
	SessionToken string    `xml:"SessionToken" json:"sessionToken,omitempty"`
	Status       string    `xml:"-" json:"status,omitempty"`
}

Credentials holds access and secret keys.

func CreateCredentials

func CreateCredentials(accessKey, secretKey string) (cred Credentials, err error)

CreateCredentials returns new credential with the given access key and secret key. Error is returned if given access key or secret key are invalid length.

func GetNewCredentials

func GetNewCredentials() (cred Credentials, err error)

GetNewCredentials generates and returns new credential.

func GetNewCredentialsWithMetadata

func GetNewCredentialsWithMetadata(m map[string]interface{}, tokenSecret string) (cred Credentials, err error)

GetNewCredentialsWithMetadata generates and returns new credential with expiry.

func (Credentials) Equal

func (cred Credentials) Equal(ccred Credentials) bool

Equal - returns whether two credentials are equal or not.

func (Credentials) IsExpired

func (cred Credentials) IsExpired() bool

IsExpired - returns whether Credential is expired or not.

func (Credentials) IsValid

func (cred Credentials) IsValid() bool

IsValid - returns whether credential is valid or not.