# Packages
Package creds is intended for internal use only.
# Functions
ConductSaslConversation runs a full SASL conversation to authenticate the given connection.
CreateAuthenticator creates an authenticator.
Handshaker creates a connection handshaker for the given authenticator.
RegisterAuthenticatorFactory registers the authenticator factory.
# Constants
AllowedHostsProp is the property key name that specifies the allowed hosts for the OIDC authenticator.
AzureEnvironmentValue is the value for the Azure environment.
EnvironmentProp is the property key name that specifies the environment for the OIDC authenticator.
GCPEnvironmentValue is the value for the GCP environment.
GSSAPI is the mechanism name for GSSAPI.
MongoDBAWS is the mechanism name for MongoDBAWS.
MONGODBCR is the mechanism name for MONGODB-CR.
MongoDBOIDC is the string constant for the MONGODB-OIDC authentication mechanism.
MongoDBX509 is the mechanism name for MongoDBX509.
PLAIN is the mechanism name for PLAIN.
ResourceProp is the property key name that specifies the token resource for GCP and AZURE OIDC auth.
SCRAMSHA1 holds the mechanism name "SCRAM-SHA-1".
SCRAMSHA256 holds the mechanism name "SCRAM-SHA-256".
TestEnvironmentValue is the value for the test environment.
# Structs
DefaultAuthenticator uses SCRAM-SHA-1 or MONGODB-CR depending on the server version.
Error is an error that occurred during authentication.
HandshakeOptions packages options that can be passed to the Handshaker() function.
MongoDBAWSAuthenticator uses AWS-IAM credentials over SASL to authenticate a connection.
MongoDBCRAuthenticator uses the MONGODB-CR algorithm to authenticate a connection.
MongoDBX509Authenticator uses X.509 certificates over TLS to authenticate a connection.
OIDCAuthenticator is synchronized and handles caching of the access token, refreshToken, and IDPInfo.
PlainAuthenticator uses the PLAIN algorithm over SASL to authenticate a connection.
ScramAuthenticator uses the SCRAM algorithm over SASL to authenticate a connection.
# Interfaces
ExtraOptionsSaslClient is a SaslClient that appends options to the saslStart command.
SaslClient is the client piece of a sasl conversation.
SaslClientCloser is a SaslClient that has resources to clean up.
SpeculativeAuthenticator represents an authenticator that supports speculative authentication.
SpeculativeConversation represents an authentication conversation that can be merged with the initial connection handshake.
# Type aliases
Authenticator handles authenticating a connection.
AuthenticatorFactory constructs an authenticator.
Config contains the configuration for an Authenticator.
Cred is the type of user credential.
IDPInfo contains the information needed to perform OIDC authentication with an Identity Provider.
OIDCArgs contains the arguments for the OIDC callback.
OIDCCallback is a function that takes a context and OIDCArgs and returns an OIDCCredential.
OIDCCredential contains the access token and refresh token.