tokenstore

Documentation

Index

• Variables
• func WithKeyring(k keyring.Keyring) func(o *Opts)
• type InMemoryTokenStore
  • func NewInMemoryTokenStore() *InMemoryTokenStore
  • func (ts *InMemoryTokenStore) Clear() error
  • func (ts *InMemoryTokenStore) Save(token *oauth2.Token) error
  • func (ts *InMemoryTokenStore) Token() (*oauth2.Token, error)
• type Keyring
  • func (s *Keyring) Clear(key string) error
  • func (s *Keyring) HasKey(key string) (bool, error)
  • func (s *Keyring) List() ([]keyring.Item, error)
  • func (s *Keyring) ListKeys() ([]string, error)
  • func (s *Keyring) Retrieve(key string, target interface{}) error
  • func (s *Keyring) Store(key string, payload interface{}) error
• type NotifyRefreshTokenSource
  • func (s *NotifyRefreshTokenSource) Token() (*oauth2.Token, error)
• type Opts
• type Storage
  • func New(opts Opts) Storage
  • func (s *Storage) Clear() error
  • func (s *Storage) Save(token *oauth2.Token) error
  • func (s *Storage) Token() (*oauth2.Token, error)
• type TokenNotifyFunc

Variables

var (
	ErrNotFound = errors.New("auth token not found")
)

Functions

func WithKeyring

func WithKeyring(k keyring.Keyring) func(o *Opts)

WithKeyring specifies a custom keyring to use.

Types

type InMemoryTokenStore

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

func NewInMemoryTokenStore

func NewInMemoryTokenStore() *InMemoryTokenStore

func (*InMemoryTokenStore) Clear

func (ts *InMemoryTokenStore) Clear() error

func (*InMemoryTokenStore) Save

func (ts *InMemoryTokenStore) Save(token *oauth2.Token) error

func (*InMemoryTokenStore) Token

func (ts *InMemoryTokenStore) Token() (*oauth2.Token, error)

type Keyring

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

Keyring is a wrapper around 99designs/keyring that handles config via env vars and marshalling/unmarshalling of items.

func (*Keyring) Clear

func (s *Keyring) Clear(key string) error

func (*Keyring) HasKey

func (s *Keyring) HasKey(key string) (bool, error)

returns false if the key is not found, true if it is found, or false and an error if there was a keyring related error

func (*Keyring) List

func (s *Keyring) List() ([]keyring.Item, error)

func (*Keyring) ListKeys

func (s *Keyring) ListKeys() ([]string, error)

func (*Keyring) Retrieve

func (s *Keyring) Retrieve(key string, target interface{}) error

returns keyring.ErrKeyNotFound if not found

func (*Keyring) Store

func (s *Keyring) Store(key string, payload interface{}) error

type NotifyRefreshTokenSource

type NotifyRefreshTokenSource struct {
	New oauth2.TokenSource

	T         *oauth2.Token
	SaveToken TokenNotifyFunc // called when token refreshed so new refresh token can be persisted
	// contains filtered or unexported fields
}

NotifyRefreshTokenSource is essentially `oauth2.ResuseTokenSource` with `TokenNotifyFunc` added.

func (*NotifyRefreshTokenSource) Token

func (s *NotifyRefreshTokenSource) Token() (*oauth2.Token, error)

Token returns the current token if it's still valid, else will refresh the current token (using r.Context for HTTP client information) and return the new one.

type Opts

type Opts struct {
	Name string

	// Keyring is a custom keyring to use rather than
	// the default one, which is configured with
	// environment variables.
	Keyring keyring.Keyring
}

type Storage

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

func New

func New(opts Opts) Storage

New creates a new token storage driver. The context is the authentication context to use. This is usually 'default' and in future can be expanded to allow CLI users to switch between separate Common Fate tenancies.

func (*Storage) Clear

func (s *Storage) Clear() error

Clear the token

func (*Storage) Save

func (s *Storage) Save(token *oauth2.Token) error

Save the token

func (*Storage) Token

func (s *Storage) Token() (*oauth2.Token, error)

Token returns the token.

type TokenNotifyFunc

type TokenNotifyFunc func(*oauth2.Token) error

TokenNotifyFunc is a function that accepts an oauth2 Token upon refresh, and returns an error if it should not be used.