auth

type CertificateAuthenticator ¶

type CertificateAuthenticator interface {
	// VerifyCertificate verifies the client certificate.
	VerifyCertificate(conn tls.Conn) (bool, error)
}

CertificateAuthenticator is the interface for authenticating a client using TLS certificates.

func NewCertificateAuthenticator(opts ...CertificateAuthenticatorOption) (CertificateAuthenticator, error)

type CertificateAuthenticatorOption ¶

type CertificateAuthenticatorOption = func(*certificateAuthenticator) error

CertificateAuthenticatorOption is a function to set the certificate authenticator options.

func WithCommonNameRegexp(regexps ...string) CertificateAuthenticatorOption

type Conn ¶

type Conn = auth.Conn

Conn represents a connection interface.

type Credential ¶ added in v1.0.0

type Credential = auth.Credential

Credential represents a credential.

func NewCredential(opts ...CredentialOptionFn) Credential

type CredentialAuthenticator ¶

type CredentialAuthenticator = auth.CredentialAuthenticator

CredentialAuthenticator is the interface for authenticating a client using credential.

type CredentialOptionFn ¶ added in v1.0.0

type CredentialOptionFn = auth.CredentialOptionFn

CredentialOptionFn represents an option function for a credential.

func WithCredentialGroup(group string) CredentialOptionFn

func WithCredentialPassword(password string) CredentialOptionFn

func WithCredentialUsername(username string) CredentialOptionFn

type CredentialStore ¶

type CredentialStore = auth.CredentialStore

CredentialAuthenticator is the credential authenticator.

type DefaultCredentialAuthenticator ¶ added in v1.0.4

type DefaultCredentialAuthenticator = auth.DefaultCredentialAuthenticator

DefaultCredentialAuthenticator is the default credential authenticator.

func NewCredentialAuthenticator() DefaultCredentialAuthenticator

type EncryptFunc ¶ added in v1.0.3

type EncryptFunc = auth.EncryptFunc

EncryptFunc represents an encrypt function.

type Manager ¶

type Manager interface {
	// Mechanisms returns the mechanisms.
	Mechanisms() []Mechanism
	// Mechanism returns a mechanism by name.
	Mechanism(name string) (Mechanism, error)
	// SetCredentialAuthenticator sets the credential authenticator.
	SetCredentialAuthenticator(auth CredentialAuthenticator)
	// SetCredentialStore sets the credential store.
	SetCredentialStore(store CredentialStore)
	// CredentialStore returns the credential store.
	CredentialStore() CredentialStore
	// VerifyCredential verifies the client credential.
	VerifyCredential(conn Conn, q Query) (bool, error)
	// SetCertificateAuthenticator sets the certificate authenticator.
	SetCertificateAuthenticator(auth CertificateAuthenticator)
	// VerifyCertificate verifies the client certificate.
	VerifyCertificate(conn tls.Conn) (bool, error)
}

func NewManager() Manager

type Mechanism ¶ added in v1.0.2

type Mechanism = sasl.Mechanism

Mechanism represents a SASL mechanism.

type Query ¶ added in v1.0.0

type Query = auth.Query

Query represents a query.

func NewQuery(opts ...QueryOptionFn) (Query, error)

type QueryOption ¶ added in v1.0.0

type QueryOption = auth.QueryOption

QueryOption represents an option for a query.

type QueryOptionFn ¶ added in v1.0.0

type QueryOptionFn = auth.QueryOptionFn

QueryOptionFn represents an option function for a query.

func WithQueryEncryptFunc(encryptFunc EncryptFunc) QueryOptionFn

func WithQueryGroup(group string) QueryOptionFn

func WithQueryMechanism(mech string) QueryOptionFn

func WithQueryOptions(opts ...any) QueryOptionFn

func WithQueryPassword(password string) QueryOptionFn

func WithQueryUsername(username string) QueryOptionFn