Class: Mongo::Auth::SCRAM

Inherits:

Object

• Object
• Mongo::Auth::SCRAM

Defined in:

lib/mongo/auth/scram.rb,
lib/mongo/auth/scram/conversation.rb

Overview

Defines behaviour for SCRAM-SHA1 authentication.

Since:

• 2.0.0

Defined Under Namespace

Classes: Conversation

Constant Summary

MECHANISM =

The authentication mechinism string.

Since:

• 2.0.0

'SCRAM-SHA-1'.freeze

Instance Attribute Summary

• #user ⇒ Mongo::Auth::User readonly

  The user to authenticate.

Instance Method Summary

• #initialize(user) ⇒ SCRAM constructor

  Instantiate a new authenticator.

• #login(connection) ⇒ Protocol::Reply

  Log the user in on the given connection.

Constructor Details

#initialize(user) ⇒ SCRAM

Instantiate a new authenticator.

Examples:

Create the authenticator.

Mongo::Auth::SCRAM.new(user)

Parameters:

• user (Mongo::Auth::User) —

  The user to authenticate.

Since:

• 2.0.0

# File 'lib/mongo/auth/scram.rb', line 41

def initialize(user)
  @user = user
end

Instance Attribute Details

#user ⇒ Mongo::Auth::User (readonly)

Returns The user to authenticate.

Returns:

• (Mongo::Auth::User) —

  The user to authenticate.

Since:

• 2.0.0

# File 'lib/mongo/auth/scram.rb', line 31

def user
  @user
end

Instance Method Details

#login(connection) ⇒ Protocol::Reply

Log the user in on the given connection.

Examples:

Log the user in.

user.login(connection)

Parameters:

• connection (Mongo::Connection) —

  The connection to log into. on.

Returns:

• (Protocol::Reply) —

  The authentication response.

Since:

• 2.0.0

# File 'lib/mongo/auth/scram.rb', line 56

def login(connection)
  conversation = Conversation.new(user)
  reply = connection.dispatch([ conversation.start ])
  reply = connection.dispatch([ conversation.continue(reply) ])
  until reply.documents[0][Conversation::DONE]
    reply = connection.dispatch([ conversation.finalize(reply) ])
  end
  reply
end