Class: Mongo::Auth::LDAP::Conversation Private

Inherits:

ConversationBase

• Object
• ConversationBase
• Mongo::Auth::LDAP::Conversation

Defined in:

lib/mongo/auth/ldap/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.

Defines behavior around a single PLAIN conversation between the client and server.

Since:

• 2.0.0

Constant Summary

LOGIN =

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 login message.

Since:

• 2.0.0

{ saslStart: 1, autoAuthorize: 1 }.freeze

Instance Attribute Summary

Attributes inherited from ConversationBase

#connection, #user

Instance Method Summary

• #start(connection) ⇒ Protocol::Query private

  Start the PLAIN conversation.

Methods inherited from ConversationBase

#build_message, #initialize, #speculative_auth_document, #validate_external_auth_source

Constructor Details

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

Instance Method Details

#start(connection) ⇒ Protocol::Query

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.

Start the PLAIN conversation. This returns the first message that needs to be sent to the server.

Parameters:

• connection (Server::Connection) —

  The connection being authenticated.

Returns:

• (Protocol::Query) —

  The first PLAIN conversation message.

Since:

• 2.0.0

# File 'lib/mongo/auth/ldap/conversation.rb', line 43

def start(connection)
  validate_external_auth_source
  selector = LOGIN.merge(payload: payload, mechanism: LDAP::MECHANISM)
  build_message(connection, '$external', selector)
end