auth

Documentation

Index

• type CertificateAuthenticator
  • func NewCertificateAuthenticator(opts ...CertificateAuthenticatorOption) (CertificateAuthenticator, error)
• type CertificateAuthenticatorOption
  • func WithCommonNameRegexp(regexps ...string) CertificateAuthenticatorOption
• type Conn
• type Credential
  • func NewCredential(opts ...CredentialOptionFn) Credential
• type CredentialOptionFn
  • func WithCredentialGroup(group string) CredentialOptionFn
  • func WithCredentialPassword(password string) CredentialOptionFn
  • func WithCredentialUsername(username string) CredentialOptionFn
• type CredentialStore
• type Manader
  • func NewManader() *Manader
• 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

Types

type CertificateAuthenticator

type CertificateAuthenticator = auth.CertificateAuthenticator

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

func NewCertificateAuthenticator

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

NewCertificateAuthenticator returns a new certificate authenticator.

type CertificateAuthenticatorOption

type CertificateAuthenticatorOption = auth.CertificateAuthenticatorOption

CertificateAuthenticatorOption represents an authenticator option.

func WithCommonNameRegexp

func WithCommonNameRegexp(regexps ...string) CertificateAuthenticatorOption

WithCertificateAuthenticatorCommonName sets the common name.

type Conn

type Conn interface {
	net.Conn

	// UserName returns the user name and true if the connection has the user name.
	UserName() (string, bool)
	// Password returns the password and true if the connection has the password.
	Password() (string, bool)

	// IsTLSConnection return true if the connection is enabled TLS.
	IsTLSConnection() bool
	// TLSConnectionState returns the TLS connection state.
	TLSConnectionState() (*tls.ConnectionState, bool)
}

Conn represents a connection.

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 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

CredentialAuthenticator is the credential authenticator.

type Manader

type Manader struct {
	auth.Manager
}

Manader represent an authenticator manager.

func NewManader

func NewManader() *Manader

NewManader returns a new authenticator manager.

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.