oauth

package

v0.1.9 Latest Latest Go to latest Published: Feb 2, 2023 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lekkodev/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type AuthCredentials
type DeviceFlow
- func NewDeviceFlow(lekkoURL string) *DeviceFlow
- func (f *DeviceFlow) Authorize(ctx context.Context) (*AuthCredentials, error)
type OAuth
- func NewOAuth() *OAuth

Constants ¶

View Source

const (
	// Lekko CLI client ID. Used for oauth with lekko.
	LekkoClientID string = "v0.303976a05d96c02eee5b1a75a3923815d82599b0"
	// Relevant headers used for auth with lekko.
	LekkoTeamHeaderKey     string = "X-Lekko-Team"
	GithubOAuthHeaderKey   string = "X-Github-Token"
	GithubUserHeaderKey    string = "X-Github-User"
	AuthorizationHeaderKey string = "Authorization"
	LekkoURL               string = "https://prod.api.lekko.dev"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AuthCredentials ¶

type AuthCredentials struct {
	// OAuth token to be used in rpcs to Lekko.
	Token string
	// Optional team that the user is a member of and is currently operating on
	Team *string
}

type DeviceFlow ¶

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

DeviceFlow initiates the OAuth 2.0 device authorization flow with Lekko.

func NewDeviceFlow ¶

func NewDeviceFlow(lekkoURL string) *DeviceFlow

func (*DeviceFlow) Authorize ¶

func (f *DeviceFlow) Authorize(ctx context.Context) (*AuthCredentials, error)

type OAuth ¶

type OAuth struct {
	Secrets metadata.Secrets
	// contains filtered or unexported fields
}

OAuth is responsible for managing all of the authentication credentials and settings on the CLI.

func NewOAuth ¶

func NewOAuth() *OAuth

Returns an OAuth object, responsible for managing oauth on the local FS. This is meant to be used by the cli on the user's local filesystem.

func (*OAuth) Close ¶

func (a *OAuth) Close()

func (a *OAuth) Login(ctx context.Context) error

Login will attempt to read any existing lekko and github credentials from disk. If either of those credentials don't exist, or are expired, we will reinitiate oauath with that provider.

func (*OAuth) Logout ¶

func (a *OAuth) Logout(ctx context.Context) error

Logout implicitly expires the relevant credentials by deleting them. TODO: explore explicitly expiring these credentials with each provider.

func (*OAuth) Status ¶

func (a *OAuth) Status(ctx context.Context, skipAuthCheck bool)

Status reads existing credentials and prints them out in stdout.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL