Documentation

Overview

    Package endpointcreds provides support for retrieving credentials from an arbitrary HTTP endpoint.

    The credentials endpoint Provider can receive both static and refreshable credentials that will expire. Credentials are static when an "Expiration" value is not provided in the endpoint's response.

    Static credentials will never expire once they have been retrieved. The format of the static credentials response:

    {
        "AccessKeyId" : "MUA...",
        "SecretAccessKey" : "/7PC5om....",
    }
    

    Refreshable credentials will expire within the "ExpiryWindow" of the Expiration value in the response. The format of the refreshable credentials response:

    {
        "AccessKeyId" : "MUA...",
        "SecretAccessKey" : "/7PC5om....",
        "Token" : "AQoDY....=",
        "Expiration" : "2016-02-25T06:03:31Z"
    }
    

    Errors should be returned in the following format and only returned with 400 or 500 HTTP status codes.

    {
        "code": "ErrorCode",
        "message": "Helpful error message."
    }
    

    Index

    Constants

    View Source
    const ProviderName = `CredentialsEndpointProvider`

      ProviderName is the name of the credentials provider.

      Variables

      This section is empty.

      Functions

      func NewCredentialsClient

      func NewCredentialsClient(cfg aws.Config, handlers request.Handlers, endpoint string, options ...func(*Provider)) *credentials.Credentials

        NewCredentialsClient returns a Credentials wrapper for retrieving credentials from an arbitrary endpoint concurrently. The client will request the

        func NewProviderClient

        func NewProviderClient(cfg aws.Config, handlers request.Handlers, endpoint string, options ...func(*Provider)) credentials.Provider

          NewProviderClient returns a credentials Provider for retrieving AWS credentials from arbitrary endpoint.

          Types

          type Provider

          type Provider struct {
          	credentials.Expiry
          
          	// Requires a AWS Client to make HTTP requests to the endpoint with.
          	// the Endpoint the request will be made to is provided by the aws.Config's
          	// Endpoint value.
          	Client *client.Client
          
          	// 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 an arbitrary 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.

                Source Files