ibmcreds

Documentation

Overview

Package ibmcreds provides support for retrieving credentials from IBM IAM endpoint.

Index

• Constants
• func NewCredentialsClient(apiKey, serviceInstanceID, iamEndpoint string) *credentials.Credentials
• func NewProviderClient(apiKey, serviceInstanceID, iamEndpoint string) credentials.Provider
• type Provider
  • func (p *Provider) IsExpired() bool
  • func (p *Provider) Retrieve() (credentials.Value, error)

Constants

const ProviderName = "IBMIAMProvider"

ProviderName is the name of the credentials provider.

Functions

func NewCredentialsClient

func NewCredentialsClient(apiKey, serviceInstanceID, iamEndpoint string) *credentials.Credentials

NewCredentialsClient returns a Credentials wrapper for retrieving credentials from IBM IAM endpoint.

func NewProviderClient

func NewProviderClient(apiKey, serviceInstanceID, iamEndpoint string) credentials.Provider

NewProviderClient returns a credentials Provider for retrieving IBM IAM credentials from IBM IAM endpoint.

Types

type Provider

type Provider struct {
	credentials.Expiry

	// IAMEndpoint
	IAMEndpoint string

	// ExpiryWindow will allow the credentials to trigger refreshing prior to
	// the credentials actually expiring. This is beneficial so race conditions
	// with expiring credentials do not cause request to fail unexpectedly
	// due to ExpiredTokenException exceptions.
	//
	// So a ExpiryWindow of 10s would cause calls to IsExpired() to return true
	// 10 seconds before the credentials are actually expired.
	//
	// If ExpiryWindow is 0 or less it will be ignored.
	ExpiryWindow time.Duration
	// contains filtered or unexported fields
}

Provider satisfies the credentials.Provider interface, and is a client to retrieve credentials from IBM IAM endpoint.

func (*Provider) IsExpired

func (p *Provider) IsExpired() bool

IsExpired returns true if the credentials retrieved are expired, or not yet retrieved.

func (*Provider) Retrieve

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

Retrieve will attempt to request the credentials from the endpoint the Provider was configured for. And error will be returned if the retrieval fails.