auth

type Authenticator ¶

type Authenticator interface {
	Auth(ctx AuthenticatorContext) AuthenticatorResult
}

Authenticator interface for providing auth credentials.

type AuthenticatorContext ¶

type AuthenticatorContext struct {
	Type     string                 `json:"type"`
	Config   map[string]interface{} `json:"config"`
	Debug    bool                   `json:"debug"`
	Insecure bool                   `json:"insecure"`
	Request  AuthenticatorRequest   `json:"request"`
}

AuthenticatorContext provides information required for authenticating requests.

func NewAuthenticatorContext(
	authType string,
	config map[string]interface{},
	debug bool,
	insecure bool,
	request AuthenticatorRequest) *AuthenticatorContext

type AuthenticatorRequest ¶

type AuthenticatorRequest struct {
	URL    string            `json:"url"`
	Header map[string]string `json:"header"`
}

AuthenticatorRequest describes the request which needs to be authenticated.

func NewAuthenticatorRequest(
	url string,
	header map[string]string) *AuthenticatorRequest

type AuthenticatorResult ¶

type AuthenticatorResult struct {
	Error         string                 `json:"error"`
	RequestHeader map[string]string      `json:"requestHeader"`
	Config        map[string]interface{} `json:"config"`
}

The AuthenticatorResult indicates if the authentication was successful and returns the authentication credentials.

func AuthenticatorError(err error) *AuthenticatorResult

func AuthenticatorSuccess(requestHeader map[string]string, config map[string]interface{}) *AuthenticatorResult

type BearerAuthenticator ¶

type BearerAuthenticator struct {
	Cache cache.Cache
}

The BearerAuthenticator calls the identity token-endpoint to retrieve a JWT bearer token. It requires clientId and clientSecret.

func (a BearerAuthenticator) Auth(ctx AuthenticatorContext) AuthenticatorResult

type BrowserLauncher ¶ added in v1.0.8

type BrowserLauncher interface {
	Open(url string) error
}

BrowserLauncher interface for opening browser windows.

type ExecBrowserLauncher ¶ added in v1.0.8

type ExecBrowserLauncher struct{}

ExecBrowserLauncher is the default implementation for the browser launcher which tries to open the default browser on the local system.

func (l ExecBrowserLauncher) Open(url string) error

type ExternalAuthenticator ¶

type ExternalAuthenticator struct {
	Config ExternalAuthenticatorConfig
}

The ExternalAuthenticator invokes a configurable executable which is providing the authentication credentials.

The ExternalAuthenticator serializes the AuthenticatorContext and passes it on standard input to the external executable. The executable performs the authentication and returns the AuthenticatorResult on standard output.

Example: Authenticator which uses kubernetes to retrieve clientId, clientSecret https://github.com/UiPath/uipathcli-authenticator-k8s

func (a ExternalAuthenticator) Auth(ctx AuthenticatorContext) AuthenticatorResult

type ExternalAuthenticatorConfig ¶

type ExternalAuthenticatorConfig struct {
	Name string
	Path string
}

ExternalAuthenticatorConfig keeps the configuration values for the external authenticator.

func NewExternalAuthenticatorConfig(
	name string,
	path string) *ExternalAuthenticatorConfig

type OAuthAuthenticator ¶ added in v1.0.1

type OAuthAuthenticator struct {
	Cache           cache.Cache
	BrowserLauncher BrowserLauncher
}

The OAuthAuthenticator triggers the oauth authorization code flow with proof key for code exchange (PKCE).

The user can login to the UiPath platform using the browser. In case the user interface is available, the browser is automatically launched and the oauth flow will be initiated. The CLI will open up a port on localhost waiting for the cloud.uipath.com platform to redirect back for handing over the authorization code which will be exchanged for a JWT bearer token using the token-endpoint from identity.

There is no need to store any long-term credentials.

func (a OAuthAuthenticator) Auth(ctx AuthenticatorContext) AuthenticatorResult

type PatAuthenticator ¶ added in v1.0.2

type PatAuthenticator struct{}

PatAuthenticator provides authorization headers when using personal access tokens.

func (a PatAuthenticator) Auth(ctx AuthenticatorContext) AuthenticatorResult