stscreds

Documentation

Index

• Constants
• type AuthCommand
  • func DefaultAuthCommand() *AuthCommand
  • func (cmd *AuthCommand) Execute() error
• type Credentials
  • func (c *Credentials) String() string
• type ExpiredCredentialsErr
  • func (e ExpiredCredentialsErr) Error() string
• type InitCommand
  • func (cmd *InitCommand) Execute() error
• type Keys
  • func (k *Keys) Valid() (bool, error)
• type LimitedAccessCredentials
  • func DefaultLimitedAccessCredentials(profile string) (*LimitedAccessCredentials, error)
  • func (c *LimitedAccessCredentials) Exist() (bool, error)
  • func (c *LimitedAccessCredentials) Initialise(keys *Keys) error
  • func (c *LimitedAccessCredentials) IsTemporaryCredentialsExpired(now time.Time) (bool, error)
  • func (c *LimitedAccessCredentials) NewSession() (*session.Session, error)
  • func (c *LimitedAccessCredentials) RecordExpiry(expiresAt time.Time) error
• type ReadCommand
  • func (cmd *ReadCommand) Execute() error
• type StdioTokenReader
  • func (f *StdioTokenReader) Read() (string, error)
• type TemporaryCredentials
  • func DefaultTemporaryCredentials(profile string) (*TemporaryCredentials, error)
  • func (c *TemporaryCredentials) Read(key string) (interface{}, error)
  • func (c *TemporaryCredentials) Save() error
  • func (c *TemporaryCredentials) UpdateCredentials(credentials *Credentials)
• type TokenReader
• type WhoAmI
  • func (w *WhoAmI) Execute() error

Constants

const ExpiresKey = "temp_credentials_expire"

Types

type AuthCommand

type AuthCommand struct {
	Expiry              time.Duration
	OutputAsEnvVariable bool
	Profile             string
	TokenReader         TokenReader
}

func DefaultAuthCommand

func DefaultAuthCommand() *AuthCommand

creates an auth command suitable for reading from stdin with a prompt

func (*AuthCommand) Execute

func (cmd *AuthCommand) Execute() error

type Credentials

type Credentials struct {
	AccessKey    string
	SecretKey    string
	SessionToken string
	Expiry       time.Time
}

func (*Credentials) String

func (c *Credentials) String() string

type ExpiredCredentialsErr

type ExpiredCredentialsErr string

func (ExpiredCredentialsErr) Error

func (e ExpiredCredentialsErr) Error() string

type InitCommand

type InitCommand struct {
	Profile string
}

func (*InitCommand) Execute

func (cmd *InitCommand) Execute() error

type Keys

type Keys struct {
	AccessKey string
	SecretKey string
}

func (*Keys) Valid

func (k *Keys) Valid() (bool, error)

type LimitedAccessCredentials

type LimitedAccessCredentials struct {
	// contains filtered or unexported fields
}

these are the credentials used by the program to request credentials through STS and retrieve user info through IAM etc.

func DefaultLimitedAccessCredentials

func DefaultLimitedAccessCredentials(profile string) (*LimitedAccessCredentials, error)

func (*LimitedAccessCredentials) Exist

func (c *LimitedAccessCredentials) Exist() (bool, error)

func (*LimitedAccessCredentials) Initialise

func (c *LimitedAccessCredentials) Initialise(keys *Keys) error

func (*LimitedAccessCredentials) IsTemporaryCredentialsExpired

func (c *LimitedAccessCredentials) IsTemporaryCredentialsExpired(now time.Time) (bool, error)

func (*LimitedAccessCredentials) NewSession

func (c *LimitedAccessCredentials) NewSession() (*session.Session, error)

func (*LimitedAccessCredentials) RecordExpiry

func (c *LimitedAccessCredentials) RecordExpiry(expiresAt time.Time) error

type ReadCommand

type ReadCommand struct {
	Key     string
	Profile string
}

func (*ReadCommand) Execute

func (cmd *ReadCommand) Execute() error

type StdioTokenReader

type StdioTokenReader struct {
}

func (*StdioTokenReader) Read

func (f *StdioTokenReader) Read() (string, error)

type TemporaryCredentials

type TemporaryCredentials struct {
	// contains filtered or unexported fields
}

credentials managed by stscreds that are requested through STS

func DefaultTemporaryCredentials

func DefaultTemporaryCredentials(profile string) (*TemporaryCredentials, error)

func (*TemporaryCredentials) Read

func (c *TemporaryCredentials) Read(key string) (interface{}, error)

func (*TemporaryCredentials) Save

func (c *TemporaryCredentials) Save() error

func (*TemporaryCredentials) UpdateCredentials

func (c *TemporaryCredentials) UpdateCredentials(credentials *Credentials)

type TokenReader

type TokenReader interface {
	Read() (string, error)
}

interface to allow other things to provide tokens

type WhoAmI

type WhoAmI struct {
	Profile string
}

func (*WhoAmI) Execute

func (w *WhoAmI) Execute() error