auth

Documentation

Index

• Constants
• func RequiredScopes() []string
• func RequiredScopesMin() []string
• type Auth
  • func NewAuth(authStore AuthStore, oauth OAuth) *Auth
  • func (t Auth) GetFreshAccessTokenOrLogin() (string, error)
  • func (t Auth) GetFreshAccessTokenOrNil() (string, error)
  • func (t Auth) Login() (*LoginTokens, error)
  • func (t Auth) Logout() error
  • func (t Auth) PromptForLogin() (*LoginTokens, error)
  • func (t *Auth) WithAccessTokenValidator(val func(string) (bool, error)) *Auth
• type AuthStore
• type Authenticator
  • func (a Authenticator) DoDeviceAuthFlow(onStateRetrieved func(url string, code string)) (*LoginTokens, error)
  • func (a Authenticator) GetNewAuthTokensWithRefresh(refreshToken string) (*entity.AuthTokens, error)
  • func (a *Authenticator) Start(ctx context.Context) (State, error)
  • func (a *Authenticator) Wait(ctx context.Context, state State) (Result, error)
• type LoginAuth
  • func NewLoginAuth(authStore AuthStore, oauth OAuth) *LoginAuth
  • func (l LoginAuth) GetAccessToken() (string, error)
• type LoginTokens
• type NoLoginAuth
  • func NewNoLoginAuth(authStore AuthStore, oauth OAuth) *NoLoginAuth
  • func (l NoLoginAuth) GetAccessToken() (string, error)
• type OAuth
• type Result
• type State
  • func (s *State) IntervalDuration() time.Duration

Constants

const (

	// namespace used to set/get values from the keychain.
	SecNamespace = "auth0-cli"
)

Functions

func RequiredScopes

func RequiredScopes() []string

RequiredScopes returns the scopes used for login.

func RequiredScopesMin

func RequiredScopesMin() []string

RequiredScopesMin returns minimum scopes used for login in integration tests.

Types

type Auth

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

func NewAuth

func NewAuth(authStore AuthStore, oauth OAuth) *Auth

func (Auth) GetFreshAccessTokenOrLogin

func (t Auth) GetFreshAccessTokenOrLogin() (string, error)

Gets fresh access token and prompts for login and saves to store

func (Auth) GetFreshAccessTokenOrNil

func (t Auth) GetFreshAccessTokenOrNil() (string, error)

Gets fresh access token or returns nil and saves to store

func (Auth) Login

func (t Auth) Login() (*LoginTokens, error)

func (Auth) Logout

func (t Auth) Logout() error

func (Auth) PromptForLogin

func (t Auth) PromptForLogin() (*LoginTokens, error)

Prompts for login and returns tokens, and saves to store

func (*Auth) WithAccessTokenValidator

func (t *Auth) WithAccessTokenValidator(val func(string) (bool, error)) *Auth

type AuthStore

type AuthStore interface {
	SaveAuthTokens(tokens entity.AuthTokens) error
	GetAuthTokens() (*entity.AuthTokens, error)
	DeleteAuthTokens() error
}

type Authenticator

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

func (Authenticator) DoDeviceAuthFlow

func (a Authenticator) DoDeviceAuthFlow(onStateRetrieved func(url string, code string)) (*LoginTokens, error)

func (Authenticator) GetNewAuthTokensWithRefresh

func (a Authenticator) GetNewAuthTokensWithRefresh(refreshToken string) (*entity.AuthTokens, error)

https://auth0.com/docs/get-started/authentication-and-authorization-flow/call-your-api-using-the-authorization-code-flow#example-post-to-token-url

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 LoginAuth

type LoginAuth struct {
	Auth
}

func NewLoginAuth

func NewLoginAuth(authStore AuthStore, oauth OAuth) *LoginAuth

func (LoginAuth) GetAccessToken

func (l LoginAuth) GetAccessToken() (string, error)

type LoginTokens

type LoginTokens struct {
	entity.AuthTokens
	IDToken string
}

type NoLoginAuth

type NoLoginAuth struct {
	Auth
}

func NewNoLoginAuth

func NewNoLoginAuth(authStore AuthStore, oauth OAuth) *NoLoginAuth

func (NoLoginAuth) GetAccessToken

func (l NoLoginAuth) GetAccessToken() (string, error)

type OAuth

type OAuth interface {
	DoDeviceAuthFlow(onStateRetrieved func(url string, code string)) (*LoginTokens, error)
	GetNewAuthTokensWithRefresh(refreshToken string) (*entity.AuthTokens, error)
}

type Result

type Result struct {
	Tenant       string
	Domain       string
	RefreshToken string
	AccessToken  string
	IDToken      string
	ExpiresIn    int64
}

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