mongo 2.23.0 → 2.24.0

data/lib/mongo/auth/gssapi/conversation.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,13 +17,11 @@
 module Mongo
   module Auth
     class Gssapi
-
-      # Defines behaviour around a single Kerberos conversation between the
+      # Defines behavior around a single Kerberos conversation between the
       # client and the server.
       #
       # @api private
       class Conversation < SaslConversationBase
-
         # The base client first message.
         START_MESSAGE = { saslStart: 1, autoAuthorize: 1 }.freeze
 
@@ -44,14 +41,12 @@ module Mongo
         def initialize(user, connection, **opts)
           super
           host = connection.address.host
-          unless defined?(Mongo::GssapiNative)
-            require 'mongo_kerberos'
-          end
+          require 'mongo_kerberos' unless defined?(Mongo::GssapiNative)
           @authenticator = Mongo::GssapiNative::Authenticator.new(
             user.name,
             host,
             user.auth_mech_properties[:service_name] || 'mongodb',
-            user.auth_mech_properties[:canonicalize_host_name] || false,
+            user.auth_mech_properties[:canonicalize_host_name] || false
           )
         end
 

data/lib/mongo/auth/gssapi.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB, Inc.
 #
@@ -17,16 +16,14 @@
 
 module Mongo
   module Auth
-
     # Defines behavior for Kerberos authentication.
     #
     # @api private
     class Gssapi < Base
-
       # The authentication mechanism string.
       #
       # @since 2.0.0
-      MECHANISM = 'GSSAPI'.freeze
+      MECHANISM = 'GSSAPI'
 
       # Log the user in on the current connection.
       #

data/lib/mongo/auth/ldap/conversation.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,14 +17,12 @@
 module Mongo
   module Auth
     class LDAP
-
       # Defines behavior around a single PLAIN conversation between the
       # client and server.
       #
       # @since 2.0.0
       # @api private
       class Conversation < ConversationBase
-
         # The login message.
         #
         # @since 2.0.0

data/lib/mongo/auth/ldap.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,17 +16,15 @@
 
 module Mongo
   module Auth
-
     # Defines behavior for LDAP Proxy authentication.
     #
     # @since 2.0.0
     # @api private
     class LDAP < Base
-
       # The authentication mechanism string.
       #
       # @since 2.0.0
-      MECHANISM = 'PLAIN'.freeze
+      MECHANISM = 'PLAIN'
 
       # Log the user in on the current connection.
       #

data/lib/mongo/auth/roles.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,91 +16,89 @@
 
 module Mongo
   module Auth
-
     # Provides constants for the built in roles provided by MongoDB.
     #
     # @since 2.0.0
     module Roles
-
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#backup
       #
       # @since 2.0.0
-      BACKUP = 'backup'.freeze
+      BACKUP = 'backup'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#clusterAdmin
       #
       # @since 2.0.0
-      CLUSTER_ADMIN = 'clusterAdmin'.freeze
+      CLUSTER_ADMIN = 'clusterAdmin'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#clusterManager
       #
       # @since 2.0.0
-      CLUSTER_MANAGER = 'clusterManager'.freeze
+      CLUSTER_MANAGER = 'clusterManager'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#clusterMonitor
       #
       # @since 2.0.0
-      CLUSTER_MONITOR = 'clusterMonitor'.freeze
+      CLUSTER_MONITOR = 'clusterMonitor'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#dbAdmin
       #
       # @since 2.0.0
-      DATABASE_ADMIN = 'dbAdmin'.freeze
+      DATABASE_ADMIN = 'dbAdmin'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#dbAdminAnyDatabase
       #
       # @since 2.0.0
-      DATABASE_ADMIN_ANY_DATABASE = 'dbAdminAnyDatabase'.freeze
+      DATABASE_ADMIN_ANY_DATABASE = 'dbAdminAnyDatabase'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#dbOwner
       #
       # @since 2.0.0
-      DATABASE_OWNER = 'dbOwner'.freeze
+      DATABASE_OWNER = 'dbOwner'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#hostManager
       #
       # @since 2.0.0
-      HOST_MANAGER = 'hostManager'.freeze
+      HOST_MANAGER = 'hostManager'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#read
       #
       # @since 2.0.0
-      READ = 'read'.freeze
+      READ = 'read'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#readAnyDatabase
       #
       # @since 2.0.0
-      READ_ANY_DATABASE = 'readAnyDatabase'.freeze
+      READ_ANY_DATABASE = 'readAnyDatabase'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#readWriteAnyDatabase
       #
       # @since 2.0.0
-      READ_WRITE_ANY_DATABASE = 'readWriteAnyDatabase'.freeze
+      READ_WRITE_ANY_DATABASE = 'readWriteAnyDatabase'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#readWrite
       #
       # @since 2.0.0
-      READ_WRITE = 'readWrite'.freeze
+      READ_WRITE = 'readWrite'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#restore
       #
       # @since 2.0.0
-      RESTORE = 'restore'.freeze
+      RESTORE = 'restore'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#root
       #
       # @since 2.0.0
-      ROOT = 'root'.freeze
+      ROOT = 'root'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#userAdmin
       #
       # @since 2.0.0
-      USER_ADMIN = 'userAdmin'.freeze
+      USER_ADMIN = 'userAdmin'
 
       # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#userAdminAnyDatabase
       #
       # @since 2.0.0
-      USER_ADMIN_ANY_DATABASE = 'userAdminAnyDatabase'.freeze
+      USER_ADMIN_ANY_DATABASE = 'userAdminAnyDatabase'
     end
   end
 end

data/lib/mongo/auth/sasl_conversation_base.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Auth
-
     # Defines common behavior around SASL conversations between
     # the client and the server.
     #
     # @api private
     class SaslConversationBase < ConversationBase
-
       # The base client first message.
       CLIENT_FIRST_MESSAGE = { saslStart: 1, autoAuthorize: 1 }.freeze
 
@@ -66,14 +63,13 @@ module Mongo
 
       def client_first_document
         payload = client_first_payload
-        if Lint.enabled?
-          unless payload.is_a?(String)
-            raise Error::LintError, "Payload must be a string but is a #{payload.class}: #{payload}"
-          end
+        if Lint.enabled? && !payload.is_a?(String)
+          raise Error::LintError, "Payload must be a string but is a #{payload.class}: #{payload}"
         end
+
         doc = CLIENT_FIRST_MESSAGE.merge(
           mechanism: auth_mechanism_name,
-          payload: BSON::Binary.new(payload),
+          payload: BSON::Binary.new(payload)
         )
         if options = client_first_message_options
           # Short SCRAM conversation,
@@ -93,9 +89,9 @@ module Mongo
           raise ArgumentError, 'Cannot validate server nonce when client nonce is nil or empty'
         end
 
-        unless server_nonce.start_with?(client_nonce)
-          raise Error::InvalidNonce.new(client_nonce, server_nonce)
-        end
+        return if server_nonce.start_with?(client_nonce)
+
+        raise Error::InvalidNonce.new(client_nonce, server_nonce)
       end
     end
   end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,13 +17,11 @@
 module Mongo
   module Auth
     class Scram
-
       # Defines behavior around a single SCRAM-SHA-1 conversation between
       # the client and server.
       #
       # @api private
       class Conversation < ScramConversationBase
-
         private
 
         # HI algorithm implementation.
@@ -39,7 +36,7 @@ module Mongo
             data,
             salt,
             iterations,
-            digest.size,
+            digest.size
           )
         end
 
@@ -57,7 +54,7 @@ module Mongo
         end
 
         def digest
-          @digest ||= OpenSSL::Digest::SHA1.new.freeze
+          @digest ||= OpenSSL::Digest.new('SHA1').freeze
         end
       end
     end

data/lib/mongo/auth/scram.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,14 +16,12 @@
 
 module Mongo
   module Auth
-
     # Defines behavior for SCRAM authentication.
     #
     # @api private
     class Scram < Base
-
       # The authentication mechanism string.
-      MECHANISM = 'SCRAM-SHA-1'.freeze
+      MECHANISM = 'SCRAM-SHA-1'
 
       # Initializes the Scram authenticator.
       #
@@ -53,7 +50,8 @@ module Mongo
 
       def conversation
         @conversation ||= self.class.const_get(:Conversation).new(
-          user, connection, client_nonce: speculative_auth_client_nonce)
+          user, connection, client_nonce: speculative_auth_client_nonce
+        )
       end
 
       # Log the user in on the current connection.
@@ -61,11 +59,8 @@ module Mongo
       # @return [ BSON::Document ] The document of the authentication response.
       def login
         converse_multi_step(connection, conversation,
-          speculative_auth_result: speculative_auth_result,
-        ).tap do
-          unless conversation.server_verified?
-            raise Error::MissingScramServerSignature
-          end
+                            speculative_auth_result: speculative_auth_result).tap do
+          raise Error::MissingScramServerSignature unless conversation.server_verified?
         end
       end
     end

data/lib/mongo/auth/scram256/conversation.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -18,13 +17,11 @@
 module Mongo
   module Auth
     class Scram256
-
       # Defines behavior around a single SCRAM-SHA-256 conversation between
       # the client and server.
       #
       # @api private
       class Conversation < ScramConversationBase
-
         private
 
         # HI algorithm implementation.
@@ -40,7 +37,7 @@ module Mongo
             salt,
             iterations,
             digest.size,
-            digest,
+            digest
           )
         end
 
@@ -58,7 +55,7 @@ module Mongo
         end
 
         def digest
-          @digest ||= OpenSSL::Digest::SHA256.new.freeze
+          @digest ||= OpenSSL::Digest.new('SHA256').freeze
         end
       end
     end

data/lib/mongo/auth/scram256.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Auth
-
     # Defines behavior for SCRAM-SHA-256 authentication.
     #
     # The purpose of this class is to provide the namespace for the
@@ -26,7 +24,7 @@ module Mongo
     # @api private
     class Scram256 < Scram
       # The authentication mechanism string.
-      MECHANISM = 'SCRAM-SHA-256'.freeze
+      MECHANISM = 'SCRAM-SHA-256'
     end
   end
 end

data/lib/mongo/auth/scram_conversation_base.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Auth
-
     # Defines common behavior around authentication conversations between
     # the client and the server.
     #
     # @api private
     class ScramConversationBase < SaslConversationBase
-
       # The minimum iteration count for SCRAM-SHA-1 and SCRAM-SHA-256.
       MIN_ITER_COUNT = 4096
 
@@ -55,7 +52,7 @@ module Mongo
       #
       # @see https://jira.mongodb.org/browse/SECURITY-621
       #
-      # @return [ true | fase ] Whether the server's signature was verified.
+      # @return [ true | false ] Whether the server's signature was verified.
       def server_verified?
         !!@server_verified
       end
@@ -79,7 +76,8 @@ module Mongo
         @iterations = parsed_data.fetch('i').to_i.tap do |i|
           if i < MIN_ITER_COUNT
             raise Error::InsufficientIterationCount.new(
-              Error::InsufficientIterationCount.message(MIN_ITER_COUNT, i))
+              Error::InsufficientIterationCount.message(MIN_ITER_COUNT, i)
+            )
           end
         end
         @auth_message = "#{first_bare},#{payload_data},#{without_proof}"
@@ -88,7 +86,7 @@ module Mongo
 
         selector = CLIENT_CONTINUE_MESSAGE.merge(
           payload: client_final_message,
-          conversationId: id,
+          conversationId: id
         )
         build_message(connection, user.auth_source, selector)
       end
@@ -111,7 +109,7 @@ module Mongo
       def finalize(connection)
         selector = CLIENT_CONTINUE_MESSAGE.merge(
           payload: client_empty_message,
-          conversationId: id,
+          conversationId: id
         )
         build_message(connection, user.auth_source, selector)
       end
@@ -138,15 +136,14 @@ module Mongo
       def parse_payload(payload)
         Hash[payload.split(',').reject { |v| v == '' }.map do |pair|
           k, v, = pair.split('=', 2)
-          if k == ''
-            raise Error::InvalidServerAuthResponse, 'Payload malformed: missing key'
-          end
-          [k, v]
+          raise Error::InvalidServerAuthResponse, 'Payload malformed: missing key' if k == ''
+
+          [ k, v ]
         end]
       end
 
       def client_first_message_options
-        {skipEmptyExchange: true}
+        { skipEmptyExchange: true }
       end
 
       # @see http://tools.ietf.org/html/rfc5802#section-3
@@ -192,8 +189,8 @@ module Mongo
       # @since 2.0.0
       def client_final
         @client_final ||= client_proof(client_key,
-          client_signature(stored_key(client_key),
-          auth_message))
+                                       client_signature(stored_key(client_key),
+                                                        auth_message))
       end
 
       # Looks for field 'v' in payload data, if it is present verifies the
@@ -203,13 +200,10 @@ module Mongo
       # This method can be called from different conversation steps
       # depending on whether the short SCRAM conversation is used.
       def check_server_signature(payload_data)
-        if verifier = payload_data['v']
-          if compare_digest(verifier, server_signature)
-            @server_verified = true
-          else
-            raise Error::InvalidSignature.new(verifier, server_signature)
-          end
-        end
+        return unless verifier = payload_data['v']
+        raise Error::InvalidSignature.new(verifier, server_signature) unless compare_digest(verifier, server_signature)
+
+        @server_verified = true
       end
 
       # Client key algorithm implementation.
@@ -310,7 +304,7 @@ module Mongo
 
       # @api private
       def cache_key(*extra)
-        [user.password, salt, iterations, @mechanism] + extra
+        [ user.password, salt, iterations, @mechanism ] + extra
       end
 
       # Server key algorithm implementation.
@@ -365,12 +359,12 @@ module Mongo
       #
       # @since 2.0.0
       def xor(first, second)
-        first.bytes.zip(second.bytes).map{ |(a,b)| (a ^ b).chr }.join('')
+        first.bytes.zip(second.bytes).map { |(a, b)| (a ^ b).chr }.join('')
       end
 
       def compare_digest(a, b)
         check = a.bytesize ^ b.bytesize
-        a.bytes.zip(b.bytes){ |x, y| check |= x ^ y.to_i }
+        a.bytes.zip(b.bytes) { |x, y| check |= x ^ y.to_i }
         check == 0
       end
     end

data/lib/mongo/auth/stringprep/profiles/sasl.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -27,23 +26,23 @@ module Mongo
         # @api private
         module SASL
           MAP_NON_ASCII_TO_SPACE = {
-            0x00A0 => [0x0020],
-            0x1680 => [0x0020],
-            0x2000 => [0x0020],
-            0x2001 => [0x0020],
-            0x2002 => [0x0020],
-            0x2003 => [0x0020],
-            0x2004 => [0x0020],
-            0x2005 => [0x0020],
-            0x2006 => [0x0020],
-            0x2007 => [0x0020],
-            0x2008 => [0x0020],
-            0x2009 => [0x0020],
-            0x200A => [0x0020],
-            0x200B => [0x0020],
-            0x202F => [0x0020],
-            0x205F => [0x0020],
-            0x3000 => [0x0020],
+            0x00A0 => [ 0x0020 ],
+            0x1680 => [ 0x0020 ],
+            0x2000 => [ 0x0020 ],
+            0x2001 => [ 0x0020 ],
+            0x2002 => [ 0x0020 ],
+            0x2003 => [ 0x0020 ],
+            0x2004 => [ 0x0020 ],
+            0x2005 => [ 0x0020 ],
+            0x2006 => [ 0x0020 ],
+            0x2007 => [ 0x0020 ],
+            0x2008 => [ 0x0020 ],
+            0x2009 => [ 0x0020 ],
+            0x200A => [ 0x0020 ],
+            0x200B => [ 0x0020 ],
+            0x202F => [ 0x0020 ],
+            0x205F => [ 0x0020 ],
+            0x3000 => [ 0x0020 ],
           }.freeze
 
           # The mappings to use for SASL string preparation.