Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrAuthrizationFailed = errors.New("authorization failed")
Functions ¶
This section is empty.
Types ¶
type CertificateAuthenticator ¶ added in v1.5.3
type CertificateAuthenticator = auth.CertificateAuthenticator
CertificateAuthenticator is the interface for authenticating a client using TLS certificates.
func NewCertificateAuthenticator ¶ added in v1.6.2
func NewCertificateAuthenticator(opts ...CertificateAuthenticatorOption) CertificateAuthenticator
NewCertificateAuthenticator returns a new certificate authenticator.
type CertificateAuthenticatorOption ¶ added in v1.5.3
type CertificateAuthenticatorOption = auth.CertificateAuthenticatorOption
CertificateAuthenticatorOption represents an authenticator option.
func WithCommonNameRegexp ¶ added in v1.6.2
func WithCommonNameRegexp(regexps ...string) CertificateAuthenticatorOption
WithCertificateAuthenticatorCommonName sets the common name.
type Credential ¶ added in v1.6.2
type Credential = auth.Credential
Credential represents a credential.
func NewCredential ¶ added in v1.6.2
func NewCredential(opts ...CredentialOptionFn) Credential
NewCredential returns a new credential with options.
type CredentialAuthenticator ¶ added in v1.6.2
type CredentialAuthenticator = auth.CredentialAuthenticator
CredentialAuthenticator is the interface for authenticating a client using credential.
type CredentialOptionFn ¶ added in v1.6.2
type CredentialOptionFn = auth.CredentialOptionFn
CredentialOptionFn represents an option function for a credential.
func WithCredentialGroup ¶ added in v1.6.2
func WithCredentialGroup(group string) CredentialOptionFn
WithCredentialGroup returns an option to set the group.
func WithCredentialPassword ¶ added in v1.6.2
func WithCredentialPassword(password string) CredentialOptionFn
WithCredentialPassword returns an option to set the password.
func WithCredentialUsername ¶ added in v1.6.2
func WithCredentialUsername(username string) CredentialOptionFn
WithCredentialUsername returns an option to set the username.
type CredentialStore ¶ added in v1.6.2
type CredentialStore = auth.CredentialStore
CredentialAuthenticator is the credential authenticator.
type Manager ¶ added in v1.6.2
Manager represent an authenticator manager.
func NewManager ¶ added in v1.6.2
func NewManager() Manager
NewManager returns a new authenticator manager.
type Query ¶ added in v1.6.2
Query represents a query.
func NewQuery ¶ added in v1.6.2
func NewQuery(opts ...QueryOptionFn) (Query, error)
NewQuery returns a new query with options.
type QueryOption ¶ added in v1.6.2
type QueryOption = auth.QueryOption
QueryOption represents an option for a query.
type QueryOptionFn ¶ added in v1.6.2
type QueryOptionFn = auth.QueryOptionFn
QueryOptionFn represents an option function for a query.
func WithQueryGroup ¶ added in v1.6.2
func WithQueryGroup(group string) QueryOptionFn
WithQueryGroup returns an option to set the group.
func WithQueryMechanism ¶ added in v1.6.2
func WithQueryMechanism(mech string) QueryOptionFn
WithQueryMechanism returns an option to set the mechanism.
func WithQueryPassword ¶ added in v1.6.2
func WithQueryPassword(password string) QueryOptionFn
WithQueryPassword returns an option to set the password.
func WithQueryUsername ¶ added in v1.6.2
func WithQueryUsername(username string) QueryOptionFn
WithQueryUsername returns an option to set the username.