utils

Documentation

Index

• Variables
• type Assumption
  • func (a *Assumption) Execute() (Creds, error)
  • func (a *Assumption) ExecuteWithCreds(c Creds) (Creds, error)
  • func (a *Assumption) ParseFlags(cmd *cobra.Command) error
• type Creds
  • func (c *Creds) New(argCreds map[string]string) error
  • func (c *Creds) NewFromEnv() error
  • func (c *Creds) NewFromStsSdk(stsCreds *sts.Credentials) error
  • func (c Creds) ToConsoleURL() (string, error)
  • func (c Creds) ToEnvVars() []string
  • func (c *Creds) ToSdk() *credentials.Credentials
  • func (c Creds) Translate(dictionary map[string]string) map[string]string
• type CredsExecutor
• type Lifetime
• type Mfa
• type Signin
  • func (s *Signin) Execute() (Creds, error)
  • func (s *Signin) ExecuteWithCreds(c Creds) (Creds, error)
  • func (s *Signin) ParseFlags(cmd *cobra.Command) error

Variables

var API = api{}

API exposes the STS API and related info

var Translations = map[string]map[string]string{
	"envvar": {
		"AWS_ACCESS_KEY_ID":     "AccessKey",
		"AWS_SECRET_ACCESS_KEY": "SecretKey",
		"AWS_SESSION_TOKEN":     "SessionToken",
		"AWS_SECURITY_TOKEN":    "SessionToken",
	},
	"console": {
		"sessionId":    "AccessKey",
		"sessionKey":   "SecretKey",
		"sessionToken": "SessionToken",
	},
}

Translations defines common mappings for credential variables

var Version = "unset"

Version is overriden by link flags during build

Types

type Assumption

type Assumption struct {
	RoleName    string
	AccountID   string
	SessionName string
	Policy      string
	Lifetime
	Mfa
}

Assumption describes the parameters that result in a Role

func (*Assumption) Execute

func (a *Assumption) Execute() (Creds, error)

Execute actions a role assumption object with creds from the environment

func (*Assumption) ExecuteWithCreds

func (a *Assumption) ExecuteWithCreds(c Creds) (Creds, error)

ExecuteWithCreds actions a role assumption with provided creds

func (*Assumption) ParseFlags

func (a *Assumption) ParseFlags(cmd *cobra.Command) error

ParseFlags for assumption object

type Creds

type Creds struct {
	AccessKey, SecretKey, SessionToken string
}

Creds defines a set of AWS credentials

func (*Creds) New

func (c *Creds) New(argCreds map[string]string) error

New initializes credentials from a map

func (*Creds) NewFromEnv

func (c *Creds) NewFromEnv() error

NewFromEnv initializes credentials from the environment variables

func (*Creds) NewFromStsSdk

func (c *Creds) NewFromStsSdk(stsCreds *sts.Credentials) error

NewFromStsSdk initializes a credential object from an AWS SDK Credentials object

func (Creds) ToConsoleURL

func (c Creds) ToConsoleURL() (string, error)

ToConsoleURL returns a console URL for the role

func (Creds) ToEnvVars

func (c Creds) ToEnvVars() []string

ToEnvVars returns environment variables suitable for eval-ing into the shell

func (*Creds) ToSdk

func (c *Creds) ToSdk() *credentials.Credentials

ToSdk returns an AWS SDK Credentials object

func (Creds) Translate

func (c Creds) Translate(dictionary map[string]string) map[string]string

Translate converts credentials based on a map of field names

type CredsExecutor

type CredsExecutor interface {
	ParseFlags(*cobra.Command) error
	Execute() (Creds, error)
	ExecuteWithCreds(Creds) (Creds, error)
}

CredsExecutor defines the interface for requesting a new set of AWS creds

type Lifetime

type Lifetime struct {
	LifetimeInt int64
}

Lifetime object encapsulates the setup of session duration

type Mfa

type Mfa struct {
	UseMfa  bool
	MfaCode string
}

Mfa object encapsulates the setup of MFA for API calls

type Signin

type Signin struct {
	Lifetime
	Mfa
}

Signin describes the parameters to perform GetSigninToken

func (*Signin) Execute

func (s *Signin) Execute() (Creds, error)

Execute actions the signin object with creds from the environment

func (*Signin) ExecuteWithCreds

func (s *Signin) ExecuteWithCreds(c Creds) (Creds, error)

ExecuteWithCreds actions the signin object with the provided creds

func (*Signin) ParseFlags

func (s *Signin) ParseFlags(cmd *cobra.Command) error

ParseFlags for signin object