auth

Documentation

Index

• type Authenticator
• type Client
• type Options
• type Refresher
• type Token
  • func GetToken(options *Options, authenticator Authenticator) (*Token, error)

Types

type Authenticator

type Authenticator interface {
	ClientCredentials() (*Token, error)
	PasswordCredentials(user, password string) (*Token, error)
}

Authenticator should be implemented for different authentication strategies

type Client

type Client interface {
	Do(*http.Request) (*http.Response, error)
}

Client should be implemented for http like clients which do automatic authentication

type Options

type Options struct {
	User                  string
	Password              string
	ClientID              string `mapstructure:"client_id"`
	ClientSecret          string `mapstructure:"client_secret"`
	AuthorizationEndpoint string `mapstructure:"authorization_endpoint"`
	TokenEndpoint         string `mapstructure:"token_endpoint"`
	IssuerURL             string `mapstructure:"issuer_url"`

	TokenBasicAuth bool `mapstructure:"token_basic_auth"`
	SSLDisabled    bool `mapstructure:"ssl_disabled"`

	Timeout time.Duration `mapstructure:"timeout"`
}

Options is used to configure new authenticators and clients

type Refresher

type Refresher interface {
	Token() (*Token, error)
}

Refresher should be implemented for refreshing access tokens with refresh token flow

type Token

type Token struct {
	AccessToken  string    `json:"access_token"`
	TokenType    string    `json:"token_type"`
	RefreshToken string    `json:"refresh_token"`
	ExpiresIn    time.Time `json:"expires_in"`
	Scope        string    `json:"scope"`
}

Token contains the structure of a typical UAA response token

func GetToken

func GetToken(options *Options, authenticator Authenticator) (*Token, error)

GetToken uses the provided authenticator to get a token using the appropriate flow depending on the provided options