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

Class: Mongo::Auth::ScramPrivate

Inherits:

Base

• Object
• Base
• Mongo::Auth::Scram show all

Defined in:

lib/mongo/auth/scram.rb,
lib/mongo/auth/scram/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 for SCRAM authentication.

Defined Under Namespace

Classes: Conversation

Constant Summarycollapse

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.

'SCRAM-SHA-1'.freeze

Instance Attribute Summary collapse

• #speculative_auth_client_nonce ⇒ String | nil readonly private
  The client nonce used in speculative auth on the current connection.
• #speculative_auth_result ⇒ BSON::Document | nil readonly private
  The value of speculativeAuthenticate field of hello response of the handshake on the current connection.

Attributes inherited from Base

#connection, #user

Instance Method Summarycollapse

• #conversation ⇒ Object private
• #initialize(user, connection, **opts) ⇒ Scram constructor private
  Initializes the Scram authenticator.
• #login ⇒ BSON::Document private
  Log the user in on the current connection.

Constructor Details

#initialize(user, connection, **opts) ⇒ Scram

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.

Initializes the Scram authenticator.

Instance Attribute Details

#speculative_auth_client_nonce ⇒ String | nil

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.

Returns The client nonce used in speculative auth on the current connection.

#speculative_auth_result ⇒ BSON::Document | nil

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.

Returns The value of speculativeAuthenticate field of hello response of the handshake on the current connection.

Instance Method Details

#conversation ⇒ Object

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.

| 54 55 56 57 | # File 'lib/mongo/auth/scram.rb', line 54 def conversation @conversation ||= self.class.const_get(:Conversation).new( user, connection, client_nonce: speculative_auth_client_nonce) end | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#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.