Class: Mongo::Auth::CR Deprecated Private

Inherits:

Base

• Object
• Base
• Mongo::Auth::CR

Defined in:

build/ruby-driver-v2.19/lib/mongo/auth/cr.rb,
build/ruby-driver-v2.19/lib/mongo/auth/cr/conversation.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Deprecated.

MONGODB-CR authentication mechanism is deprecated as of MongoDB 3.6. Support for it in the Ruby driver will be removed in driver version 3.0. Please use SCRAM instead.

Defines behavior for MongoDB-CR authentication.

Since:

• 2.0.0

Defined Under Namespace

Classes: Conversation

Constant Summary

MECHANISM =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The authentication mechanism string.

Since:

• 2.0.0

'MONGODB-CR'.freeze

Instance Attribute Summary

Attributes inherited from Base

#connection, #user

Instance Method Summary

• #login ⇒ BSON::Document private

  Log the user in on the current connection.

Methods inherited from Base

#conversation, #initialize

Constructor Details

This class inherits a constructor from Mongo::Auth::Base

Instance Method Details

#login ⇒ BSON::Document

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Log the user in on the current connection.

Returns:

• (BSON::Document) —

  The document of the authentication response.

Since:

• 2.0.0

# File 'build/ruby-driver-v2.19/lib/mongo/auth/cr.rb', line 38

def login
  converse_2_step(connection, conversation)
end