class Mongo::Auth::User
Represents a user in MongoDB.
@since 2.0.0
Attributes
@return [ Hash ] The authentication mechanism properties.
@return [ String ] The authorization source, either a database or
external name.
The client key for the user.
@return [ String ] The client key for the user.
@return [ String ] The database the user is created in.
@return [ Symbol ] The authorization mechanism.
@return [ String ] The username.
@return [ String ] The cleartext password.
@return [ Array<String> ] roles The user roles.
Public Class Methods
Create the new user.
@example Create a new user.
Mongo::Auth::User.new(options)
@param [ Hash ] options The options to create the user from.
@option options [ String ] :auth_source The authorization database or
external source.
@option options [ String ] :database The database the user is
authorized for.
@option options [ String ] :user The user name. @option options [ String ] :password The user's password. @option options [ Symbol ] :auth_mech The authorization mechanism. @option options [ Array<String>, Array<Hash> ] roles The user roles. @option options [ String ] :client_key The user's client key cached from a previous
authentication on the same connection.
@since 2.0.0
# File lib/mongo/auth/user.rb, line 133 def initialize(options) @database = options[:database] || Database::ADMIN @auth_source = options[:auth_source] || @database @name = options[:user] @password = options[:password] || options[:pwd] @mechanism = options[:auth_mech] || :mongodb_cr @auth_mech_properties = options[:auth_mech_properties] || {} @roles = options[:roles] || [] @client_key = options[:client_key] end
Public Instance Methods
Determine if this user is equal to another.
@example Check user equality.
user == other
@param [ Object ] other The object to compare against.
@return [ true, false ] If the objects are equal.
@since 2.0.0
# File lib/mongo/auth/user.rb, line 57 def ==(other) return false unless other.is_a?(User) name == other.name && database == other.database && password == other.password end
Get an authentication key for the user based on a nonce from the server.
@example Get the authentication key.
user.auth_key(nonce)
@param [ String ] nonce The response from the server.
@return [ String ] The authentication key.
@since 2.0.0
# File lib/mongo/auth/user.rb, line 73 def auth_key(nonce) Digest::MD5.hexdigest("#{nonce}#{name}#{hashed_password}") end
Get the UTF-8 encoded name with escaped special characters for use with SCRAM authorization.
@example Get the encoded name.
user.encoded_name
@return [ String ] The encoded user name.
@since 2.0.0
# File lib/mongo/auth/user.rb, line 86 def encoded_name name.encode(BSON::UTF8).gsub('=','=3D').gsub(',','=2C') end
Get the hash key for the user.
@example Get the hash key.
user.hash
@return [ String ] The user hash key.
@since 2.0.0
# File lib/mongo/auth/user.rb, line 98 def hash [ name, database, password ].hash end
Get the user's hashed password.
@example Get the user's hashed password.
user.hashed_password
@return [ String ] The hashed password.
@since 2.0.0
# File lib/mongo/auth/user.rb, line 110 def hashed_password @hashed_password ||= Digest::MD5.hexdigest("#{name}:mongo:#{password}").encode(BSON::UTF8) end
Get the specification for the user, used in creation.
@example Get the user's specification.
user.spec
@return [ Hash ] The user spec.
@since 2.0.0
# File lib/mongo/auth/user.rb, line 152 def spec { pwd: hashed_password, roles: roles } end