Module: Mongo::Auth

Relationships & Source Files
Namespace Children
Modules: `CredentialCache`, `Roles`, `StringPrep`
Classes: `Aws`, `Base`, `CR`, `ConversationBase`, `Gssapi`, `LDAP`, `SaslConversationBase`, `Scram`, `Scram256`, `ScramConversationBase`, `User`, `X509`
Exceptions: `InvalidConfiguration`, `InvalidMechanism`, `Unauthorized`
Defined in:	lib/mongo/auth.rb, lib/mongo/auth/aws.rb, lib/mongo/auth/base.rb, lib/mongo/auth/conversation_base.rb, lib/mongo/auth/cr.rb, lib/mongo/auth/credential_cache.rb, lib/mongo/auth/gssapi.rb, lib/mongo/auth/ldap.rb, lib/mongo/auth/roles.rb, lib/mongo/auth/sasl_conversation_base.rb, lib/mongo/auth/scram.rb, lib/mongo/auth/scram256.rb, lib/mongo/auth/scram_conversation_base.rb, lib/mongo/auth/stringprep.rb, lib/mongo/auth/user.rb, lib/mongo/auth/x509.rb, lib/mongo/auth/aws/conversation.rb, lib/mongo/auth/aws/credentials.rb, lib/mongo/auth/aws/credentials_cache.rb, lib/mongo/auth/aws/credentials_retriever.rb, lib/mongo/auth/aws/request.rb, lib/mongo/auth/cr/conversation.rb, lib/mongo/auth/gssapi/conversation.rb, lib/mongo/auth/ldap/conversation.rb, lib/mongo/auth/scram/conversation.rb, lib/mongo/auth/scram256/conversation.rb, lib/mongo/auth/stringprep/tables.rb, lib/mongo/auth/stringprep/profiles/sasl.rb, lib/mongo/auth/user/view.rb, lib/mongo/auth/x509/conversation.rb

Overview

This namespace contains all authentication related behavior.

Since:

2.0.0

Constant Summary

EXTERNAL = Internal use only

The external database name.
Since:
- 2.0.0
# File 'lib/mongo/auth.rb', line 49
```
'$external'.freeze
```
GET_NONCE = Internal use only

Constant for the nonce command.
Since:
- 2.0.0
# File 'lib/mongo/auth.rb', line 55
```
{ getnonce: 1 }.freeze
```
NONCE = Internal use only

Constant for the nonce field.
Since:
- 2.0.0
# File 'lib/mongo/auth.rb', line 61
```
'nonce'.freeze
```
SOURCES =

Note:

This map is not frozen because when mongo_kerberos is loaded, it mutates this map by adding the Kerberos authenticator.

Map the symbols parsed from the URI connection string to strategies.
Since:
- 2.0.0
# File 'lib/mongo/auth.rb', line 69
```
{
  aws: Aws,
  gssapi: Gssapi,
  mongodb_cr: CR,
  mongodb_x509: X509,
  plain: LDAP,
  scram: Scram,
  scram256: Scram256,
}
```

Instance Method Summary

#get(user, connection, **opts) ⇒ Auth::Aws | Auth::CR | Auth::Gssapi | Auth::LDAP | Auth::Scram | Auth::Scram256 | Auth::X509 Internal use only Internal use only

Get an authenticator for the provided user to authenticate over the provided connection.

Instance Method Details

#get(user, connection, **opts) ⇒ Auth::Aws | Auth::CR | Auth::Gssapi | Auth::LDAP | Auth::Scram | Auth::Scram256 | Auth::X509

This method is for internal use only.

Get an authenticator for the provided user to authenticate over the provided connection.

Parameters:

user (Auth::User) —

The user to authenticate.
connection (Mongo::Connection) —

The connection to authenticate over.
opts (Hash) —

a customizable set of options

Options Hash (**opts):

speculative_auth_client_nonce (String | nil) —

The client nonce used in speculative auth on the specified connection that produced the specified speculative auth result.
speculative_auth_result (BSON::Document | nil) —

The value of speculativeAuthenticate field of hello response of the handshake on the specified connection.

Returns:

(Auth::Aws | Auth::CR | Auth::Gssapi | Auth::LDAP | Auth::Scram | Auth::Scram256 | Auth::X509) —

The authenticator.

Raises:

(InvalidMechanism)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/auth.rb', line 97


def get(user, connection, **opts)
  mechanism = user.mechanism
  raise InvalidMechanism.new(mechanism) if !SOURCES.has_key?(mechanism)
  SOURCES[mechanism].new(user, connection, **opts)
end