class Mongo::Auth::LDAP::Conversation
Defines behaviour around a single PLAIN conversation between the client and server.
@since 2.0.0
Constants
- LOGIN
The login message.
@since 2.0.0
Attributes
@return [ Protocol::Message ] reply The current reply in the
conversation.
@return [ User ] user The user for the conversation.
Public Class Methods
Create the new conversation.
@example Create the new conversation.
Conversation.new(user, "admin")
@param [ Auth::User ] user The user to converse about.
@since 2.0.0
# File lib/mongo/auth/ldap/conversation.rb, line 89 def initialize(user) @user = user end
Public Instance Methods
Finalize the PLAIN conversation. This is meant to be iterated until the provided reply indicates the conversation is finished.
@example Finalize the conversation.
conversation.finalize(reply)
@param [ Protocol::Message ] reply The reply of the previous
message.
@return [ Protocol::Query ] The next message to send.
@since 2.0.0
# File lib/mongo/auth/ldap/conversation.rb, line 49 def finalize(reply) validate!(reply) end
Start the PLAIN conversation. This returns the first message that needs to be send to the server.
@example Start the conversation.
conversation.start
@param [ Mongo::Server::Connection ] connection The connection being authenticated.
@return [ Protocol::Query ] The first PLAIN conversation message.
@since 2.0.0
# File lib/mongo/auth/ldap/conversation.rb, line 64 def start(connection = nil) if connection && connection.features.op_msg_enabled? selector = LOGIN.merge(payload: payload, mechanism: LDAP::MECHANISM) selector[Protocol::Msg::DATABASE_IDENTIFIER] = Auth::EXTERNAL cluster_time = connection.mongos? && connection.cluster_time selector[Operation::CLUSTER_TIME] = cluster_time if cluster_time Protocol::Msg.new([:none], {}, selector) else Protocol::Query.new( Auth::EXTERNAL, Database::COMMAND, LOGIN.merge(payload: payload, mechanism: LDAP::MECHANISM), limit: -1 ) end end
Private Instance Methods
# File lib/mongo/auth/ldap/conversation.rb, line 95 def payload BSON::Binary.new("\x00#{user.name}\x00#{user.password}") end
# File lib/mongo/auth/ldap/conversation.rb, line 99 def validate!(reply) raise Unauthorized.new(user) if reply.documents[0][Operation::Result::OK] != 1 @reply = reply end