authentication

Documentation

Index

• func RegisterAuthentication(reg AuthenticationRegistration)
• func RegisteredAuthenticationNames() []string
• type AuthWrapper
  • func (w AuthWrapper) CheckAuthentication(ctx context.Context, req *http.Request) bool
• type Authentication
  • func ConstructAuth(rawConfig map[string]interface{}, errorMessages config.ErrorMessages) (Authentication, error)
• type AuthenticationRegistration
  • func RegisteredAuthentication(name string) (AuthenticationRegistration, bool)

Functions

func RegisterAuthentication

func RegisterAuthentication(reg AuthenticationRegistration)

func RegisteredAuthenticationNames

func RegisteredAuthenticationNames() []string

Types

type AuthWrapper

type AuthWrapper struct {
	Name string
	Auth Authentication
}

A struct that wraps all other auths in order to add in instrumentation, specifically child spans for tracing flow. This is used even when telemetry is disabled but OTEL handles no-op'ing in that case so performance impact is minimal

func (AuthWrapper) CheckAuthentication

func (w AuthWrapper) CheckAuthentication(ctx context.Context, req *http.Request) bool

type Authentication

type Authentication interface {
	CheckAuthentication(ctx context.Context, req *http.Request) bool
}

func ConstructAuth

func ConstructAuth(rawConfig map[string]interface{}, errorMessages config.ErrorMessages) (Authentication, error)

type AuthenticationRegistration

type AuthenticationRegistration interface {
	Name() string
	Initialize(config any, errorMessages config.ErrorMessages) (Authentication, error)
	InitializeConfig() any
}

func RegisteredAuthentication

func RegisteredAuthentication(name string) (AuthenticationRegistration, bool)