auth

Documentation

Index

• Constants
• func Flow(hostname string, provider AuthProvider) (accessToken string, username string, err error)
• func NewCmdLogin() *cobra.Command
• func NewCmdLogout() *cobra.Command
• func NewCmdStatus() *cobra.Command
• type AuthProvider
  • func (p AuthProvider) AuthPath() (s string)
  • func (p AuthProvider) AuthorizeURL() string
  • func (p AuthProvider) ClientID() string
  • func (p AuthProvider) Scopes() string
  • func (p AuthProvider) String() string
• type LoginOptions
  • func (l *LoginOptions) GetToken() string
  • func (l *LoginOptions) Reader() io.ReadCloser
  • func (l *LoginOptions) SetToken(t string)
• type LogoutOptions
• type StatusOptions

Constants

const OauthSuccessPage = `` /* 1941-byte string literal not displayed */

const ResetLine = "\r\033[K"

ResetLine returns the cursor to start of line and clean it

Functions

func Flow

func Flow(hostname string, provider AuthProvider) (accessToken string, username string, err error)

Flow - authentication workflow returns access tooken

func NewCmdLogin

func NewCmdLogin() *cobra.Command

NewCmdLogin creates the `auth login` command

func NewCmdLogout

func NewCmdLogout() *cobra.Command

NewCmdLogout creates the `auth logout` command

func NewCmdStatus

func NewCmdStatus() *cobra.Command

NewCmdStatus creates the `auth status` command

Types

type AuthProvider

type AuthProvider int

const (
	AuthWithGithub AuthProvider = iota
	AuthWithGitlab

	// used for requesting more permissions from
	// github when working with Github repo based
	// objectives
	AuthWithGithubWorkflow
)

func (AuthProvider) AuthPath

func (p AuthProvider) AuthPath() (s string)

func (AuthProvider) AuthorizeURL

func (p AuthProvider) AuthorizeURL() string

AuthorizeURL returns the URL of the OAuth authorization endpoint

func (AuthProvider) ClientID

func (p AuthProvider) ClientID() string

func (AuthProvider) Scopes

func (p AuthProvider) Scopes() string

func (AuthProvider) String

func (p AuthProvider) String() string

type LoginOptions

type LoginOptions struct {
	IO *iostreams.IOStreams

	Interactive bool

	Hostname string
	Provider string
	Token    string
}

func (*LoginOptions) GetToken

func (l *LoginOptions) GetToken() string

implement utils.TokenReader interface

func (*LoginOptions) Reader

func (l *LoginOptions) Reader() io.ReadCloser

func (*LoginOptions) SetToken

func (l *LoginOptions) SetToken(t string)

type LogoutOptions

type LogoutOptions struct {
	IO *iostreams.IOStreams

	Interactive bool

	Hostname  string
	NoConfirm bool
}

type StatusOptions

type StatusOptions struct {
	IO *iostreams.IOStreams

	Hostname  string
	ShowToken bool
}