auth

Documentation

Index

• Constants
• Variables
• func NewErrInvalidUserPassword() error
• type AuthManager
  • func NewAuthManager() AuthManager
• type AuthenticatorType
  • func NewAuthenticatorTypeFrom(str string) (AuthenticatorType, error)
  • func (t AuthenticatorType) String() string
• type CertificateAuthenticator
• type Conn
• type Credential
  • func NewCredential(opts ...CredentialOptionFn) Credential
• type CredentialAuthenticator
• type CredentialOptionFn
  • func WithCredentialGroup(group string) CredentialOptionFn
  • func WithCredentialPassword(password string) CredentialOptionFn
  • func WithCredentialUsername(username string) CredentialOptionFn
• type CredentialStore
• type PlainConfig
  • func NewPlainConfigFrom(config config.Config, path ...string) ([]PlainConfig, error)
• type Query
  • func NewQuery(opts ...QueryOptionFn) Query
• type QueryOption
• type QueryOptionFn
  • func WithQueryGroup(group string) QueryOptionFn
  • func WithQueryMechanism(mech string) QueryOptionFn
  • func WithQueryPassword(password string) QueryOptionFn
  • func WithQueryUsername(username string) QueryOptionFn

Constants

const (
	// AuthenticatorTypePlainString represents an authenticator type of plain.
	AuthenticatorTypePlainString = "plain"
)

Variables

var (
	ErrInvalid        = errors.New("invalid")
	ErrAuthentication = errors.New("authentication failed")
)

Functions

func NewErrInvalidUserPassword

func NewErrInvalidUserPassword() error

NewErrInvalidUserPassword returns an error for invalid username or password.

Types

type AuthManager

type AuthManager interface {
	auth.Manager
}

AuthManager represent an authenticator manager.

func NewAuthManager

func NewAuthManager() AuthManager

NewAuthManager returns a new authenticator manager.

type AuthenticatorType

type AuthenticatorType int

AuthenticatorType represents an authenticator type.

const (
	// AuthenticatorTypeNone represents an authenticator type of none.
	AuthenticatorTypeNone AuthenticatorType = iota
	// AuthenticatorTypePlain represents an authenticator type of plain.
	AuthenticatorTypePlain
)

func NewAuthenticatorTypeFrom

func NewAuthenticatorTypeFrom(str string) (AuthenticatorType, error)

NewAuthenticatorTypeFrom returns an authenticator type from the specified string.

func (AuthenticatorType) String

func (t AuthenticatorType) String() string

String returns a string representation of the authenticator type.

type CertificateAuthenticator

type CertificateAuthenticator = auth.CertificateAuthenticator

CertificateAuthenticator represent a certificate authenticator.

type Conn

type Conn = auth.Conn

Conn represents a connection interface.

type Credential

type Credential = auth.Credential

Credential represents a credential.

func NewCredential

func NewCredential(opts ...CredentialOptionFn) Credential

NewCredential returns a new credential with options.

type CredentialAuthenticator

type CredentialAuthenticator = auth.CredentialAuthenticator

CredentialAuthenticator represent a credential authenticator.

type CredentialOptionFn

type CredentialOptionFn = auth.CredentialOptionFn

CredentialOptionFn represents an option function for a credential.

func WithCredentialGroup

func WithCredentialGroup(group string) CredentialOptionFn

WithCredentialGroup returns an option to set the group.

func WithCredentialPassword

func WithCredentialPassword(password string) CredentialOptionFn

WithCredentialPassword returns an option to set the password.

func WithCredentialUsername

func WithCredentialUsername(username string) CredentialOptionFn

WithCredentialUsername returns an option to set the username.

type CredentialStore

type CredentialStore = auth.CredentialStore

CredentialStore represent a credential store.

type PlainConfig

type PlainConfig struct {
	Enabled  bool   `mapstructure:"enabled"`
	Username string `mapstructure:"username"`
	Password string `mapstructure:"password"`
}

PlainConfig represents a plain configuration for authenticator.

func NewPlainConfigFrom

func NewPlainConfigFrom(config config.Config, path ...string) ([]PlainConfig, error)

NewPlainConfigFrom returns a new plain authenticator configuration from the specified configuration.

type Query

type Query = auth.Query

Query represents a query.

func NewQuery

func NewQuery(opts ...QueryOptionFn) Query

NewQuery returns a new query with options.

type QueryOption

type QueryOption = auth.QueryOption

QueryOption represents an option for a query.

type QueryOptionFn

type QueryOptionFn = auth.QueryOptionFn

QueryOptionFn represents an option function for a query.

func WithQueryGroup

func WithQueryGroup(group string) QueryOptionFn

WithQueryGroup returns an option to set the group.

func WithQueryMechanism

func WithQueryMechanism(mech string) QueryOptionFn

WithQueryMechanism returns an option to set the mechanism.

func WithQueryPassword

func WithQueryPassword(password string) QueryOptionFn

WithQueryPassword returns an option to set the password.

func WithQueryUsername

func WithQueryUsername(username string) QueryOptionFn

WithQueryUsername returns an option to set the username.