auth

Documentation

Index

• Constants
• func RequiredScopes() []string
• type Authenticator
  • func (a *Authenticator) Start(ctx context.Context) (State, error)
  • func (a *Authenticator) Wait(ctx context.Context, state State) (Result, error)
• type Keyring
  • func (k *Keyring) Delete(namespace, key string) error
  • func (k *Keyring) Get(namespace, key string) (string, error)
  • func (k *Keyring) Set(namespace, key, value string) error
• type Result
• type SecretStore
• type State
  • func (s *State) IntervalDuration() time.Duration
• type TokenResponse
• type TokenRetriever
  • func (t *TokenRetriever) Delete(system string) error
  • func (t *TokenRetriever) Refresh(ctx context.Context, system string) (TokenResponse, error)

Constants

const (

	// SecretsNamespace namespace used to set/get values from the keychain
	SecretsNamespace = "vespa-cli"
)

Functions

func RequiredScopes

func RequiredScopes() []string

RequiredScopes returns the scopes used for login.

Types

type Authenticator

type Authenticator struct {
	Audience           string
	ClientID           string
	DeviceCodeEndpoint string
	OauthTokenEndpoint string
}

func (*Authenticator) Start

func (a *Authenticator) Start(ctx context.Context) (State, error)

Start kicks-off the device authentication flow by requesting a device code from Auth0, The returned state contains the URI for the next step of the flow.

func (*Authenticator) Wait

func (a *Authenticator) Wait(ctx context.Context, state State) (Result, error)

Wait waits until the user is logged in on the browser.

type Keyring

type Keyring struct{}

func (*Keyring) Delete

func (k *Keyring) Delete(namespace, key string) error

Delete deletes a value for the given namespace and key.

func (*Keyring) Get

func (k *Keyring) Get(namespace, key string) (string, error)

Get gets a value for the given namespace and key.

func (*Keyring) Set

func (k *Keyring) Set(namespace, key, value string) error

Set sets the given key/value pair with the given namespace.

type Result

type Result struct {
	RefreshToken string
	AccessToken  string
	ExpiresIn    int64
}

type SecretStore

type SecretStore interface {
	// Get gets the secret
	Get(namespace, key string) (string, error)
	// Delete removes the secret
	Delete(namespace, key string) error
}

SecretStore provides access to stored sensitive data.

type State

type State struct {
	DeviceCode      string `json:"device_code"`
	UserCode        string `json:"user_code"`
	VerificationURI string `json:"verification_uri_complete"`
	ExpiresIn       int    `json:"expires_in"`
	Interval        int    `json:"interval"`
}

func (*State) IntervalDuration

func (s *State) IntervalDuration() time.Duration

type TokenResponse

type TokenResponse struct {
	AccessToken string `json:"access_token"`
	IDToken     string `json:"id_token"`
	TokenType   string `json:"token_type"`
	ExpiresIn   int    `json:"expires_in"`
}

type TokenRetriever

type TokenRetriever struct {
	Authenticator *Authenticator
	Secrets       SecretStore
	Client        *http.Client
}

func (*TokenRetriever) Delete

func (t *TokenRetriever) Delete(system string) error

Delete deletes the given system from the secrets' storage.

func (*TokenRetriever) Refresh

func (t *TokenRetriever) Refresh(ctx context.Context, system string) (TokenResponse, error)

Refresh gets a new access token from the provided refresh token, The request is used the default client_id and endpoint for device authentication.