Class: Mongo::Auth::X509

Inherits:

Object

• Object
• Mongo::Auth::X509

Defined in:

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

Overview

Defines behaviour for x.509 authentication.

Since:

• 2.0.0

Defined Under Namespace

Classes: Conversation

Constant Summary

MECHANISM =

The authentication mechinism string.

Since:

• 2.0.0

'MONGODB-X509'.freeze

Instance Attribute Summary

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

  The user to authenticate.

Instance Method Summary

• #initialize(user) ⇒ X509 constructor

  Instantiate a new authenticator.

• #login(connection) ⇒ Protocol::Reply

  Log the user in on the given connection.

Constructor Details

#initialize(user) ⇒ X509

Instantiate a new authenticator.

Examples:

Create the authenticator.

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

Parameters:

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

  The user to authenticate.

Since:

• 2.0.0

# File 'lib/mongo/auth/x509.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/x509.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/x509.rb', line 56

def login(connection)
  conversation = Conversation.new(user)
  conversation.finalize(connection.dispatch([ conversation.start ]))
end