bolt

Documentation

Index

• type Authenticator
  • func NewAuthenticator() *Authenticator
  • func (sa *Authenticator) AuthenticateUser(username, password string) (*jwt.UserClaims, int, error)
  • func (sa *Authenticator) Configure() error
  • func (sa *Authenticator) SetPath(s string)
• type Backend
  • func NewDatabaseBackend() *Backend
  • func (b *Backend) Authenticate(reqID string, kv map[string]string) (*jwt.UserClaims, int, error)
  • func (b *Backend) ConfigureAuthenticator() error
  • func (b *Backend) ConfigureLogger(logger *zap.Logger) error
  • func (b *Backend) ConfigureTokenProvider(upstream *jwt.TokenProviderConfig) error
  • func (b *Backend) GetRealm() string
  • func (b *Backend) Validate() error
  • func (b *Backend) ValidateConfig() error

Types

type Authenticator

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

Authenticator represents database connector.

func NewAuthenticator

func NewAuthenticator() *Authenticator

NewAuthenticator returns an instance of Authenticator.

func (*Authenticator) AuthenticateUser

func (sa *Authenticator) AuthenticateUser(username, password string) (*jwt.UserClaims, int, error)

AuthenticateUser checks the database for the presence of a username and password and returns user claims.

func (*Authenticator) Configure

func (sa *Authenticator) Configure() error

Configure check database connectivity and required tables.

func (*Authenticator) SetPath

func (sa *Authenticator) SetPath(s string)

SetPath sets database path.

type Backend

type Backend struct {
	Realm         string                   `json:"realm,omitempty"`
	Path          string                   `json:"path,omitempty"`
	TokenProvider *jwt.TokenProviderConfig `json:"jwt,omitempty"`
	Authenticator *Authenticator           `json:"-"`
	// contains filtered or unexported fields
}

Backend represents authentication provider with BoltDB backend.

func NewDatabaseBackend

func NewDatabaseBackend() *Backend

NewDatabaseBackend return an instance of authentication provider with BoltDB backend.

func (*Backend) Authenticate

func (b *Backend) Authenticate(reqID string, kv map[string]string) (*jwt.UserClaims, int, error)

Authenticate performs authentication.

func (*Backend) ConfigureAuthenticator

func (b *Backend) ConfigureAuthenticator() error

ConfigureAuthenticator configures backend for .

func (*Backend) ConfigureLogger

func (b *Backend) ConfigureLogger(logger *zap.Logger) error

ConfigureLogger configures backend with the same logger as its user.

func (*Backend) ConfigureTokenProvider

func (b *Backend) ConfigureTokenProvider(upstream *jwt.TokenProviderConfig) error

ConfigureTokenProvider configures TokenProvider.

func (*Backend) GetRealm

func (b *Backend) GetRealm() string

GetRealm return authentication realm.

func (*Backend) Validate

func (b *Backend) Validate() error

Validate checks whether Backend is functional.

func (*Backend) ValidateConfig

func (b *Backend) ValidateConfig() error

ValidateConfig checks whether Backend has mandatory configuration.