authenticators

Documentation

Overview

Package authenticators contains logic for setting up an Open ID Connect authenticator

Index

• func BasicOSBAuthenticator(request *web.Request, repository storage.Repository, username, password string) (*web.UserContext, httpsec.Decision, error)
• func BasicPlatformAuthenticator(request *web.Request, repository storage.Repository, username, password string) (*web.UserContext, httpsec.Decision, error)
• func NewOIDCAuthenticator(ctx context.Context, options *OIDCOptions) (httpsec.Authenticator, string, error)
• type Basic
  • func (a *Basic) Authenticate(request *web.Request) (*web.UserContext, httpsec.Decision, error)
• type BasicAuthenticatorFunc
• type OIDCOptions
• type OauthAuthenticator
  • func (a *OauthAuthenticator) Authenticate(request *web.Request) (*web.UserContext, httpsec.Decision, error)

Functions

func BasicOSBAuthenticator

func BasicOSBAuthenticator(request *web.Request, repository storage.Repository, username, password string) (*web.UserContext, httpsec.Decision, error)

BasicOSBAuthenticator attempts to authenticate basic auth requests with provided broker platform credentials

func BasicPlatformAuthenticator

func BasicPlatformAuthenticator(request *web.Request, repository storage.Repository, username, password string) (*web.UserContext, httpsec.Decision, error)

BasicPlatformAuthenticator attempts to authenticate basic auth requests with provided platform credentials

func NewOIDCAuthenticator

func NewOIDCAuthenticator(ctx context.Context, options *OIDCOptions) (httpsec.Authenticator, string, error)

NewOIDCAuthenticator returns a new OpenID authenticator or an error if one couldn't be configured

Types

type Basic

type Basic struct {
	Repository             storage.Repository
	BasicAuthenticatorFunc BasicAuthenticatorFunc
}

Basic for basic security

func (*Basic) Authenticate

func (a *Basic) Authenticate(request *web.Request) (*web.UserContext, httpsec.Decision, error)

Authenticate authenticates by using the provided Basic credentials

type BasicAuthenticatorFunc

type BasicAuthenticatorFunc func(request *web.Request, repository storage.Repository, username, password string) (*web.UserContext, httpsec.Decision, error)

BasicAuthenticatorFunc defines a function which attempts to authenticate a basic auth request

type OIDCOptions

type OIDCOptions struct {
	// IssuerURL is the base URL of the token issuer
	IssuerURL string

	// ClientID is the id of the oauth client used to verify the tokens
	ClientID string

	// ReadConfigurationFunc is the function used to call the token issuer. If one is not provided, http.DefaultClient.Do will be used
	ReadConfigurationFunc util.DoRequestFunc
}

OIDCOptions is the configuration used to construct a new OIDC authenticator

type OauthAuthenticator

type OauthAuthenticator struct {
	Verifier httpsec.TokenVerifier
}

OauthAuthenticator is the OpenID implementation of security.Authenticator

func (*OauthAuthenticator) Authenticate

func (a *OauthAuthenticator) Authenticate(request *web.Request) (*web.UserContext, httpsec.Decision, error)

Authenticate returns information about the user by obtaining it from the bearer token, or an error if security is unsuccessful