auth

Documentation

Index

• Constants
• Variables
• func Write(cache Cache) error
• type Browser
• type Cache
  • func Read() (*Cache, error)
• type MockSession
  • func (s *MockSession) GetToken(ctx context.Context, conf *oauth2.Config) (*oauth2.Token, error)
• type Session
• type UserSession
  • func (s *UserSession) GetToken(ctx context.Context, conf *oauth2.Config) (*oauth2.Token, error)

Constants

const (
	SessionMaxAge = time.Hour * 24
)

Variables

var (
	// ErrorNoLocalCredsFound is returned if no client or user credentials were found and the invoker created the config with the option WithoutBrowserLogin
	ErrorNoLocalCredsFound = errors.New("there were no credentials found present on the machine")
)

Functions

func Write

func Write(cache Cache) error

Write saves HCP auth data in a common location in the home directory.

Types

type Browser

type Browser interface {
	GetTokenFromBrowser(context.Context, *oauth2.Config) (*oauth2.Token, error)
}

Browser implements the browser handler for the OAuth2 login flow.

type Cache

type Cache struct {
	// AccessToken is the bearer token used to authenticate to HCP.
	AccessToken string `json:"access_token,omitempty"`

	// RefreshToken is used to get a new access token.
	RefreshToken string `json:"refresh_token,omitempty"`

	// AccessTokenExpiry is when the access token will expire.
	AccessTokenExpiry time.Time `json:"access_token_expiry,omitempty"`

	// SessionExpiry is the session limit.
	SessionExpiry time.Time `json:"session_expiry,omitempty"`
}

func Read

func Read() (*Cache, error)

Read opens the saved HCP auth data and returns the token.

type MockSession

type MockSession struct{}

func (*MockSession) GetToken

func (s *MockSession) GetToken(ctx context.Context, conf *oauth2.Config) (*oauth2.Token, error)

GetToken returns some mock token with static data.

type Session

type Session interface {
	GetToken(ctx context.Context, conf *oauth2.Config) (*oauth2.Token, error)
}

Session handles managing a user's session.

type UserSession

type UserSession struct {
	NoBrowserLogin bool
	// contains filtered or unexported fields
}

UserSession implements the auth package's Session interface

func (*UserSession) GetToken

func (s *UserSession) GetToken(ctx context.Context, conf *oauth2.Config) (*oauth2.Token, error)

GetToken returns an access token obtained from either an existing session or new browser login.