SaslConversationBase — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Auth::SaslConversationBasePrivate

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 common behavior around SASL conversations between the client and the server.

Constant Summarycollapse

CLIENT_FIRST_MESSAGE =

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 base client first message.

{ saslStart: 1, autoAuthorize: 1 }.freeze

CLIENT_CONTINUE_MESSAGE =

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 base client continue message.

{ saslContinue: 1 }.freeze

Instance Attribute Summary

Attributes inherited from ConversationBase

#connection, #user

Instance Method Summarycollapse

• #start(connection) ⇒ Protocol::Message private
  Start the SASL conversation.

Methods inherited from ConversationBase

#build_message, #initialize, #speculative_auth_document, #validate_external_auth_source

Instance Method Details

#start(connection) ⇒ Protocol::Message

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 SASL conversation. This returns the first message that needs to be sent to the server.