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

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo/auth/ldap/conversation.rb

Overview

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

Since:

  • 2.0.0

Constant Summary collapse

LOGIN =

The login message.

Since:

  • 2.0.0

{ saslStart: 1, autoAuthorize: 1 }.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user) ⇒ Conversation

Create the new conversation.

Examples:

Create the new coversation.

Conversation.new(user, "admin")

Parameters:

  • user (Auth::User) —

    The user to converse about.

Since:

  • 2.0.0



79
80
81
 
# File 'lib/mongo/auth/ldap/conversation.rb', line 79

def initialize(user)
  @user = user
end

Instance Attribute Details

#reply ⇒ Protocol::Reply (readonly)

Returns reply The current reply in the conversation.

Returns:

Since:

  • 2.0.0



32
33
34
 
# File 'lib/mongo/auth/ldap/conversation.rb', line 32

def reply
  @reply
end

#user ⇒ User (readonly)

Returns user The user for the conversation.

Returns:

  • (User) —

    user The user for the conversation.

Since:

  • 2.0.0



35
36
37
 
# File 'lib/mongo/auth/ldap/conversation.rb', line 35

def user
  @user
end

Instance Method Details

#finalize(reply) ⇒ Protocol::Query

Finalize the PLAIN conversation. This is meant to be iterated until the provided reply indicates the conversation is finished.

Examples:

Finalize the conversation.

conversation.finalize(reply)

Parameters:

Returns:

Since:

  • 2.0.0



49
50
51
 
# File 'lib/mongo/auth/ldap/conversation.rb', line 49

def finalize(reply)
  validate!(reply)
end

#start ⇒ Protocol::Query

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

Examples:

Start the conversation.

conversation.start

Returns:

Since:

  • 2.0.0



62
63
64
65
66
67
68
69
 
# File 'lib/mongo/auth/ldap/conversation.rb', line 62

def start
  Protocol::Query.new(
    Auth::EXTERNAL,
    Database::COMMAND,
    LOGIN.merge(payload: payload, mechanism: LDAP::MECHANISM),
    limit: -1
  )
end