client

Documentation

Index

• Constants
• Variables
• func WantsAuth(resp *http.Response) []*TokenInfo
• type AuthClient
  • func (c *AuthClient) Authorize(req *http.Request, schemes []*TokenInfo) error
  • func (c *AuthClient) Do(req *http.Request) (resp *http.Response, err error)
• type AuthStore
• type FileAuthStore
  • func NewFileAuthStore(baseDir string) (*FileAuthStore, error)
  • func (s *FileAuthStore) Get(schemeId string, endpoint string) (*TokenInfo, error)
  • func (s *FileAuthStore) Set(token *TokenInfo, endpoint string) error

Constants

const AuthDirName = "auth"

const AuthTokenSuffix = ".token"

Variables

var ErrAuthNotFound error = fmt.Errorf("Authorization not found")

Functions

func WantsAuth

func WantsAuth(resp *http.Response) []*TokenInfo

WantsAuth returns information on the authentication schemes a server is advertising. These are mandatory for an HTTP 401 Not Authorized response, but may also be given in other responses.

Types

type AuthClient

type AuthClient struct {
	*http.Client
	Store AuthStore
}

AuthClient is an *http.Client that is able to automatically negotiate authentication with a server from an AuthStore.

func (*AuthClient) Authorize

func (c *AuthClient) Authorize(req *http.Request, schemes []*TokenInfo) error

Authorize adds any stored auth tokens from the requested schemes to an *http.Request.

func (*AuthClient) Do

func (c *AuthClient) Do(req *http.Request) (resp *http.Response, err error)

Do performs an *http.Request and returns the *http.Response or any error that occurs, after automatically attempting to negotiate authentication with the server.

type AuthStore

type AuthStore interface {
	// Get reads and decodes the authentication token from storage.
	Get(schemeId string, endpoint string) (*TokenInfo, error)
	// Set stores an authentication token.
	Set(token *TokenInfo, endpoint string) error
}

AuthTokenStore stores authentication tokens by their scheme and endpoint.

type FileAuthStore

type FileAuthStore struct {
	// contains filtered or unexported fields
}

FileAuthStore stores an affinity client's authentication credential in a directory structure with file naming convention.

func NewFileAuthStore

func NewFileAuthStore(baseDir string) (*FileAuthStore, error)

NewFileAuthStore creates a new FileAuthStore at the given directory.

func (*FileAuthStore) Get

func (s *FileAuthStore) Get(schemeId string, endpoint string) (*TokenInfo, error)

Get retrieves a token for a scheme and endpoint.

func (*FileAuthStore) Set

func (s *FileAuthStore) Set(token *TokenInfo, endpoint string) error

Set stores a token.