ec2roleprovider

Documentation

Index

• Constants
• type EC2InnerProviders
• type EC2RoleProvider
  • func NewEC2RoleProvider(log log.T, innerProviders *EC2InnerProviders, ...) *EC2RoleProvider
  • func (p *EC2RoleProvider) CredentialSource() string
  • func (p *EC2RoleProvider) ExpiresAt() time.Time
  • func (p *EC2RoleProvider) GetInnerProvider() IInnerProvider
  • func (p *EC2RoleProvider) IsExpired() bool
  • func (p *EC2RoleProvider) RemoteExpiresAt() time.Time
  • func (p *EC2RoleProvider) RemoteRetrieve(ctx context.Context) (credentials.Value, error)
  • func (p *EC2RoleProvider) Retrieve() (credentials.Value, error)
  • func (p *EC2RoleProvider) RetrieveWithContext(ctx context.Context) (credentials.Value, error)
  • func (p *EC2RoleProvider) ShareFile() string
  • func (p *EC2RoleProvider) ShareProfile() string
  • func (p *EC2RoleProvider) SharesCredentials() bool
• type IEC2RoleProvider
• type IInnerProvider

Constants

const (
	CredentialSourceNone = "None"
	CredentialSourceSSM  = "SSM"
	CredentialSourceEC2  = "EC2"
	IdentityTypeEC2      = "EC2"
)

Types

type EC2InnerProviders

type EC2InnerProviders struct {
	IPRProvider               IInnerProvider
	SsmEc2Provider            IInnerProvider
	SharedCredentialsProvider IInnerProvider
}

type EC2RoleProvider

type EC2RoleProvider struct {
	credentials.Expiry
	InnerProviders *EC2InnerProviders
	Log            log.T
	InstanceInfo   *ssmec2roleprovider.InstanceInfo

	SsmEndpoint string

	RuntimeConfigClient runtimeconfig.IIdentityRuntimeConfigClient
	// contains filtered or unexported fields
}

EC2RoleProvider provides credentials for the agent when on an EC2 instance

func NewEC2RoleProvider

func NewEC2RoleProvider(log log.T, innerProviders *EC2InnerProviders, instanceInfo *ssmec2roleprovider.InstanceInfo, ssmEndpoint string, runtimeConfigClient runtimeconfig.IIdentityRuntimeConfigClient) *EC2RoleProvider

NewEC2RoleProvider initializes a new EC2RoleProvider using runtime config values

func (*EC2RoleProvider) CredentialSource

func (p *EC2RoleProvider) CredentialSource() string

CredentialSource returns the name of the current provider being used

func (*EC2RoleProvider) ExpiresAt

func (p *EC2RoleProvider) ExpiresAt() time.Time

ExpiresAt returns the expiry of shared credentials using shared credentials and returns instance profile role provider expiry otherwise

func (*EC2RoleProvider) GetInnerProvider

func (p *EC2RoleProvider) GetInnerProvider() IInnerProvider

GetInnerProvider gets the remote role provider that is currently being used for credentials

func (*EC2RoleProvider) IsExpired

func (p *EC2RoleProvider) IsExpired() bool

IsExpired wraps the IsExpired method of the current provider

func (*EC2RoleProvider) RemoteExpiresAt

func (p *EC2RoleProvider) RemoteExpiresAt() time.Time

RemoteExpiresAt returns the expiry of the remote inner provider currently in use This function is intended for use by the core module's credential refresher routine

func (*EC2RoleProvider) RemoteRetrieve

func (p *EC2RoleProvider) RemoteRetrieve(ctx context.Context) (credentials.Value, error)

RemoteRetrieve uses network calls to retrieve credentials for EC2 instances This function is intended for use by the core module's credential refresher routine When an error is returned, credential source is updated to CredentialSourceNone

func (*EC2RoleProvider) Retrieve

func (p *EC2RoleProvider) Retrieve() (credentials.Value, error)

Retrieve returns instance profile role credentials if it has sufficient systems manager permissions and returns ssm provided credentials otherwise. If neither can be retrieved then empty credentials are returned This function is intended for use by agent workers that require credentials

func (*EC2RoleProvider) RetrieveWithContext

func (p *EC2RoleProvider) RetrieveWithContext(ctx context.Context) (credentials.Value, error)

RetrieveWithContext returns shared credentials if specified in runtime config and returns instance profile role credentials otherwise. If neither can be retrieved then empty credentials are returned This function is intended for use by agent workers that require credentials

func (*EC2RoleProvider) ShareFile

func (p *EC2RoleProvider) ShareFile() string

ShareFile is the credentials file where the agent should write shared credentials Only default host management role credentials are shared across workers

func (*EC2RoleProvider) ShareProfile

func (p *EC2RoleProvider) ShareProfile() string

ShareProfile is the profile where the agent should write shared credentials

func (*EC2RoleProvider) SharesCredentials

func (p *EC2RoleProvider) SharesCredentials() bool

SharesCredentials returns true if credentials may be saved to disk

type IEC2RoleProvider

type IEC2RoleProvider interface {
	credentials.Expirer
	credentialproviders.IRemoteProvider
	GetInnerProvider() IInnerProvider
	Retrieve() (credentials.Value, error)
	ShareFile() string
	ShareProfile() string
	SharesCredentials() bool
	RetrieveWithContext(ctx context.Context) (credentials.Value, error)
	RemoteRetrieve(ctx context.Context) (credentials.Value, error)
}

type IInnerProvider

type IInnerProvider interface {
	credentials.Provider
	credentials.Expirer
	Retrieve() (credentials.Value, error)
	RetrieveWithContext(ctx context.Context) (credentials.Value, error)
	SetExpiration(expiration time.Time, window time.Duration)
}