auth

Documentation

Overview

Package auth is not for public use.

The API for packages in the 'private' directory have no stability guarantee.

The packages within the 'private' directory would normally be put into an 'internal' directory to prohibit their use outside the 'mongo' directory. However, some MongoDB tools require very low-level access to the building blocks of a driver, so we have placed them under 'private' to allow these packages to be imported by projects that need them.

These package APIs may be modified in backwards-incompatible ways at any time.

You are strongly discouraged from directly using any packages under 'private'.

Index

• Constants
• func ConductSaslConversation(ctx context.Context, conn driver.Connection, db string, client SaslClient) error
• func Handshaker(h driver.Handshaker, options *HandshakeOptions) driver.Handshaker
• func RegisterAuthenticatorFactory(name string, factory AuthenticatorFactory)
• type Authenticator
  • func CreateAuthenticator(name string, cred *Cred) (Authenticator, error)
• type AuthenticatorFactory
• type Cred
• type DefaultAuthenticator
  • func (a *DefaultAuthenticator) Auth(ctx context.Context, desc description.Server, conn driver.Connection) error
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Inner() error
  • func (e *Error) Message() string
• type HandshakeOptions
• type MongoDBCRAuthenticator
  • func (a *MongoDBCRAuthenticator) Auth(ctx context.Context, _ description.Server, conn driver.Connection) error
• type MongoDBX509Authenticator
  • func (a *MongoDBX509Authenticator) Auth(ctx context.Context, desc description.Server, conn driver.Connection) error
• type PlainAuthenticator
  • func (a *PlainAuthenticator) Auth(ctx context.Context, _ description.Server, conn driver.Connection) error
• type SaslClient
• type SaslClientCloser
• type ScramAuthenticator
  • func (a *ScramAuthenticator) Auth(ctx context.Context, _ description.Server, conn driver.Connection) error

Constants

const GSSAPI = "GSSAPI"

GSSAPI is the mechanism name for GSSAPI.

const MONGODBCR = "MONGODB-CR"

MONGODBCR is the mechanism name for MONGODB-CR.

The MONGODB-CR authentication mechanism is deprecated in MongoDB 4.0.

const MongoDBX509 = "MONGODB-X509"

MongoDBX509 is the mechanism name for MongoDBX509.

const PLAIN = "PLAIN"

PLAIN is the mechanism name for PLAIN.

const SCRAMSHA1 = "SCRAM-SHA-1"

SCRAMSHA1 holds the mechanism name "SCRAM-SHA-1"

const SCRAMSHA256 = "SCRAM-SHA-256"

SCRAMSHA256 holds the mechanism name "SCRAM-SHA-256"

Functions

func ConductSaslConversation

func ConductSaslConversation(ctx context.Context, conn driver.Connection, db string, client SaslClient) error

ConductSaslConversation handles running a sasl conversation with MongoDB.

func Handshaker

func Handshaker(h driver.Handshaker, options *HandshakeOptions) driver.Handshaker

Handshaker creates a connection handshaker for the given authenticator.

func RegisterAuthenticatorFactory

func RegisterAuthenticatorFactory(name string, factory AuthenticatorFactory)

RegisterAuthenticatorFactory registers the authenticator factory.

Types

type Authenticator

type Authenticator interface {
	// Auth authenticates the connection.
	Auth(context.Context, description.Server, driver.Connection) error
}

Authenticator handles authenticating a connection.

func CreateAuthenticator

func CreateAuthenticator(name string, cred *Cred) (Authenticator, error)

CreateAuthenticator creates an authenticator.

type AuthenticatorFactory

type AuthenticatorFactory func(cred *Cred) (Authenticator, error)

AuthenticatorFactory constructs an authenticator.

type Cred

type Cred struct {
	Source      string
	Username    string
	Password    string
	PasswordSet bool
	Props       map[string]string
}

Cred is a user's credential.

type DefaultAuthenticator

type DefaultAuthenticator struct {
	Cred *Cred
}

DefaultAuthenticator uses SCRAM-SHA-1 or MONGODB-CR depending on the server version.

func (*DefaultAuthenticator) Auth

func (a *DefaultAuthenticator) Auth(ctx context.Context, desc description.Server, conn driver.Connection) error

Auth authenticates the connection.

type Error

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

Error is an error that occurred during authentication.

func (*Error) Error

func (e *Error) Error() string

func (*Error) Inner

func (e *Error) Inner() error

Inner returns the wrapped error.

func (*Error) Message

func (e *Error) Message() string

Message returns the message.

type HandshakeOptions

type HandshakeOptions struct {
	AppName               string
	Authenticator         Authenticator
	Compressors           []string
	DBUser                string
	PerformAuthentication func(description.Server) bool
}

HandshakeOptions packages options that can be passed to the Handshaker() function. DBUser is optional but must be of the form <dbname.username>; if non-empty, then the connection will do SASL mechanism negotiation.

type MongoDBCRAuthenticator

type MongoDBCRAuthenticator struct {
	DB       string
	Username string
	Password string
}

MongoDBCRAuthenticator uses the MONGODB-CR algorithm to authenticate a connection.

The MONGODB-CR authentication mechanism is deprecated in MongoDB 4.0.

func (*MongoDBCRAuthenticator) Auth

func (a *MongoDBCRAuthenticator) Auth(ctx context.Context, _ description.Server, conn driver.Connection) error

Auth authenticates the connection.

The MONGODB-CR authentication mechanism is deprecated in MongoDB 4.0.

type MongoDBX509Authenticator

type MongoDBX509Authenticator struct {
	User string
}

MongoDBX509Authenticator uses X.509 certificates over TLS to authenticate a connection.

func (*MongoDBX509Authenticator) Auth

func (a *MongoDBX509Authenticator) Auth(ctx context.Context, desc description.Server, conn driver.Connection) error

Auth implements the Authenticator interface.

type PlainAuthenticator

type PlainAuthenticator struct {
	Username string
	Password string
}

PlainAuthenticator uses the PLAIN algorithm over SASL to authenticate a connection.

func (*PlainAuthenticator) Auth

func (a *PlainAuthenticator) Auth(ctx context.Context, _ description.Server, conn driver.Connection) error

Auth authenticates the connection.

type SaslClient

type SaslClient interface {
	Start() (string, []byte, error)
	Next(challenge []byte) ([]byte, error)
	Completed() bool
}

SaslClient is the client piece of a sasl conversation.

type SaslClientCloser

type SaslClientCloser interface {
	SaslClient
	Close()
}

SaslClientCloser is a SaslClient that has resources to clean up.

type ScramAuthenticator

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

ScramAuthenticator uses the SCRAM algorithm over SASL to authenticate a connection.

func (*ScramAuthenticator) Auth

func (a *ScramAuthenticator) Auth(ctx context.Context, _ description.Server, conn driver.Connection) error

Auth authenticates the connection.