mongo 2.6.4 → 2.7.0.rc0

data/lib/mongo/session/server_session.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2018 MongoDB, Inc.
+# Copyright (C) 2017-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,7 +38,21 @@ module Mongo
       # @since 2.5.0
       attr_reader :last_use
 
-      # The current transactions number.
+      # The current transaction number.
+      #
+      # When a transaction is active, all operations in that transaction
+      # use the same transaction number. If the entire transaction is restarted
+      # (for example, by Session#with_transaction, in which case it would
+      # also invoke the block provided to it again), each transaction attempt
+      # has its own transaction number.
+      #
+      # Transaction number is also used outside of transactions for
+      # retryable writes. In this case, each write operation has its own
+      # transaction number, but retries of a write operation use the same
+      # transaction number as the first write (which is how the server
+      # knows that subsequent writes are retries and should be ignored if
+      # the first write succeeded on the server but was not read by the
+      # client, for example).
       #
       # @since 2.5.0
       attr_reader :txn_num
@@ -80,12 +94,9 @@ module Mongo
                           BSON::Document.new(id: BSON::Binary.new(bytes, :uuid)))
       end
 
-      # Increment and return the next transaction number.
+      # Increment the current transaction number and return the new value.
       #
-      # @example Get the next transaction number.
-      #   server_session.next_txn_num
-      #
-      # @return [ Integer ] The next transaction number.
+      # @return [ Integer ] The updated transaction number.
       #
       # @since 2.5.0
       def next_txn_num

data/lib/mongo/session/session_pool.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2018 MongoDB, Inc.
+# Copyright (C) 2017-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/socket.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/socket/ssl.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -114,12 +114,51 @@ module Mongo
 
       private
 
+      def verify_certificate?
+        @verify_certificate ||=
+          # If ssl_verify_certificate is not present, disable only if ssl_verify is
+          # explicitly set to false.
+          if options[:ssl_verify_certificate].nil?
+            options[:ssl_verify] != false
+          # If ssl_verify_certificate is present, enable or disable based on its value.
+          else
+            !!options[:ssl_verify_certificate]
+          end
+      end
+
+      def verify_hostname?
+        @verify_hostname ||=
+         # If ssl_verify_hostname is not present, disable only if ssl_verify is
+          # explicitly set to false.
+          if options[:ssl_verify_hostname].nil?
+            options[:ssl_verify] != false
+          # If ssl_verify_hostname is present, enable or disable based on its value.
+          else
+            !!options[:ssl_verify_hostname]
+          end
+      end
+
+
       def create_context(options)
-        context = OpenSSL::SSL::SSLContext.new
-        set_cert(context, options)
-        set_key(context, options)
-        set_cert_verification(context, options) unless options[:ssl_verify] == false
-        context
+        OpenSSL::SSL::SSLContext.new.tap do |context|
+          set_cert(context, options)
+          set_key(context, options)
+
+
+          if verify_certificate?
+            context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            set_cert_verification(context, options)
+          else
+            context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+
+          if context.respond_to?(:verify_hostname=)
+            # We manually check the hostname after the connection is established if necessary, so
+            # we disable it here in order to give consistent errors across Ruby versions which
+            # don't support hostname verification at the time of the handshake.
+            context.verify_hostname = OpenSSL::SSL::VERIFY_NONE
+          end
+        end
       end
 
       def set_cert(context, options)
@@ -162,7 +201,7 @@ module Mongo
       end
 
       def verify_certificate!(socket)
-        if context.verify_mode == OpenSSL::SSL::VERIFY_PEER
+        if verify_hostname?
           unless OpenSSL::SSL.verify_certificate_identity(socket.peer_cert, host_name)
             raise Error::SocketError, 'SSL handshake failed due to a hostname mismatch.'
           end

data/lib/mongo/socket/tcp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/socket/unix.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/uri.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -256,6 +256,19 @@ module Mongo
       parsed_scheme, _, remaining = string.partition(SCHEME_DELIM)
       raise_invalid_error!(INVALID_SCHEME) unless parsed_scheme == scheme
       parse!(remaining)
+
+      # Warn if conflicting insecure TLS options are provided.
+      if @uri_options[:ssl_verify] == false
+        if @uri_options[:ssl_verify_certificate]
+          log_warn("tlsInsecure is set to disable verification, but tlsAllowInvalidCertificates " +
+                     "is set to enable it; tlsAllowInvalidCertificates takes precedence")
+        end
+
+       if @uri_options[:ssl_verify_hostname]
+          log_warn("tlsInsecure is set to disable verification, but tlsAllowInvalidHostnames is " +
+                     "set to enable it; tlsAllowInvalidHostnames takes precedence")
+        end
+      end
     end
 
     # Get the credentials provided in the URI.
@@ -426,29 +439,40 @@ module Mongo
     uri_option 'replicaset', :replica_set, :type => :replica_set
 
     # Timeout Options
-    uri_option 'connecttimeoutms', :connect_timeout, :type => :ms_convert
-    uri_option 'sockettimeoutms', :socket_timeout, :type => :ms_convert
-    uri_option 'serverselectiontimeoutms', :server_selection_timeout, :type => :ms_convert
-    uri_option 'localthresholdms', :local_threshold, :type => :ms_convert
+    uri_option 'connecttimeoutms', :connect_timeout, :type => :connect_timeout
+    uri_option 'sockettimeoutms', :socket_timeout, :type => :socket_timeout
+    uri_option 'serverselectiontimeoutms', :server_selection_timeout, :type => :server_selection_timeout
+    uri_option 'localthresholdms', :local_threshold, :type => :local_threshold
+    uri_option 'heartbeatfrequencyms', :heartbeat_frequency, :type => :heartbeat_frequency
+    uri_option 'maxidletimems', :max_idle_time, :type => :max_idle_time
 
     # Write Options
     uri_option 'w', :w, :group => :write
-    uri_option 'journal', :j, :group => :write
+    uri_option 'journal', :j, :group => :write, :type => :journal
     uri_option 'fsync', :fsync, :group => :write
-    uri_option 'wtimeoutms', :timeout, :group => :write
+    uri_option 'wtimeoutms', :timeout, :group => :write, :type => :wtimeout
 
     # Read Options
     uri_option 'readpreference', :mode, :group => :read, :type => :read_mode
     uri_option 'readpreferencetags', :tag_sets, :group => :read, :type => :read_tags
-    uri_option 'maxstalenessseconds', :max_staleness, :group => :read
+    uri_option 'maxstalenessseconds', :max_staleness, :group => :read, :type => :max_staleness
 
     # Pool options
-    uri_option 'minpoolsize', :min_pool_size
-    uri_option 'maxpoolsize', :max_pool_size
-    uri_option 'waitqueuetimeoutms', :wait_queue_timeout, :type => :ms_convert
+    uri_option 'minpoolsize', :min_pool_size, :type => :min_pool_size
+    uri_option 'maxpoolsize', :max_pool_size, :type => :max_pool_size
+    uri_option 'waitqueuetimeoutms', :wait_queue_timeout, :type => :wait_queue_timeout
 
     # Security Options
     uri_option 'ssl', :ssl
+    uri_option 'tls', :ssl
+    uri_option 'tlsallowinvalidcertificates', :ssl_verify_certificate,
+               :type => :ssl_verify_certificate
+    uri_option 'tlsallowinvalidhostnames', :ssl_verify_hostname,
+               :type => :ssl_verify_hostname
+    uri_option 'tlscafile', :ssl_ca_cert
+    uri_option 'tlscertificatekeyfile', :ssl_cert
+    uri_option 'tlscertificatekeyfilepassword', :ssl_key_pass_phrase
+    uri_option 'tlsinsecure', :ssl_verify, :type => :ssl_verify
 
     # Topology options
     uri_option 'connect', :connect
@@ -461,7 +485,9 @@ module Mongo
     # Client Options
     uri_option 'appname', :app_name
     uri_option 'compressors', :compressors, :type => :array
-    uri_option 'zlibcompressionlevel', :zlib_compression_level
+    uri_option 'readconcernlevel', :read_concern
+    uri_option 'retrywrites', :retry_writes, :type => :retry_writes
+    uri_option 'zlibcompressionlevel', :zlib_compression_level, :type => :zlib_compression_level
 
     # Casts option values that do not have a specifically provided
     # transformation to the appropriate type.
@@ -474,7 +500,7 @@ module Mongo
         true
       elsif value == 'false'
         false
-      elsif value =~ /[\d]/
+      elsif value =~ /\A[\d]\z/
         value.to_i
       else
         decode(value).to_sym
@@ -571,7 +597,9 @@ module Mongo
     #
     # @return [Symbol] The transformed authentication mechanism.
     def auth_mech(value)
-      AUTH_MECH_MAP[value.upcase]
+      AUTH_MECH_MAP[value.upcase].tap do |mech|
+        log_warn("#{value} is not a valid auth mechanism") unless mech
+      end
     end
 
     # Read preference mode transformation.
@@ -598,7 +626,7 @@ module Mongo
     #
     # @return [Hash] The tag set hash.
     def read_set(value)
-      hash_extractor(value)
+      hash_extractor('readPreferenceTags', value)
     end
 
     # Auth mechanism properties extractor.
@@ -607,7 +635,7 @@ module Mongo
     #
     # @return [ Hash ] The auth mechanism properties hash.
     def auth_mech_props(value)
-      properties = hash_extractor(value)
+      properties = hash_extractor('authMechanismProperties', value)
       if properties[:canonicalize_host_name]
         properties.merge!(canonicalize_host_name:
                             properties[:canonicalize_host_name] == 'true')
@@ -615,6 +643,249 @@ module Mongo
       properties
     end
 
+    # Parses the zlib compression level.
+    #
+    # @param value [ String ] The zlib compression level string.
+    #
+    # @return [ Integer | nil ] The compression level value if it is between -1 and 9 (inclusive),
+    #   otherwise nil (and a warning will be logged).
+    def zlib_compression_level(value)
+      if /\A-?\d+\z/ =~ value
+        i = value.to_i
+
+        if i >= -1 && i <= 9
+          return i
+        end
+      end
+
+      log_warn("#{value} is not a valid zlibCompressionLevel")
+      nil
+    end
+
+    # Parses the max pool size.
+    #
+    # @param value [ String ] The max pool size string.
+    #
+    # @return [ Integer | nil ] The min pool size if it is valid, otherwise nil (and a warning will)
+    #   be logged.
+    def max_pool_size(value)
+      if /\A\d+\z/ =~ value
+        return value.to_i
+      end
+
+      log_warn("#{value} is not a valid maxPoolSize")
+      nil
+    end
+
+
+    # Parses the min pool size.
+    #
+    # @param value [ String ] The min pool size string.
+    #
+    # @return [ Integer | nil ] The min pool size if it is valid, otherwise nil (and a warning will
+    #   be logged).
+    def min_pool_size(value)
+      if /\A\d+\z/ =~ value
+        return value.to_i
+      end
+
+      log_warn("#{value} is not a valid minPoolSize")
+      nil
+    end
+
+    # Parses the journal value.
+    #
+    # @param value [ String ] The journal value.
+    #
+    # @return [ true | false | nil ] The journal value parsed out, otherwise nil (and a warning
+    #   will be logged).
+    def journal(value)
+      bool('journal', value)
+    end
+
+    # Parses the ssl_verify value from the tlsInsecure URI value. Note that this will be the inverse
+    # of the value of tlsInsecure (if present).
+    #
+    # @param value [ String ] The tlsInsecure value.
+    #
+    # @return [ true | false | nil ] The ssl_verify value parsed out, otherwise nil (and a warning
+    #   will be logged).
+    def ssl_verify(value)
+      inverse_bool('tlsAllowInvalidCertificates', value)
+    end
+
+    # Parses the ssl_verify_certificate value from the tlsAllowInvalidCertificates URI value. Note
+    # that this will be the inverse of the value of tlsInsecure (if present).
+    #
+    # @param value [ String ] The tlsAllowInvalidCertificates value.
+    #
+    # @return [ true | false | nil ] The ssl_verify_certificate value parsed out, otherwise nil
+    #   (and a warning will be logged).
+    def ssl_verify_certificate(value)
+      inverse_bool('tlsAllowInvalidCertificates', value)
+    end
+
+    # Parses the ssl_verify_hostname value from the tlsAllowInvalidHostnames URI value. Note that
+    # this will be the inverse of the value of tlsAllowInvalidHostnames (if present).
+    #
+    # @param value [ String ] The tlsAllowInvalidHostnames value.
+    #
+    # @return [ true | false | nil ] The ssl_verify_hostname value parsed out, otherwise nil
+    #   (and a warning will be logged).
+    def ssl_verify_hostname(value)
+      inverse_bool('tlsAllowInvalidHostnames', value)
+    end
+
+    # Parses the retryWrites value.
+    #
+    # @param value [ String ] The retryWrites value.
+    #
+    # @return [ true | false | nil ] The boolean value parsed out, otherwise nil (and a warning
+    #   will be logged).
+    def retry_writes(value)
+      bool('retryWrites', value)
+    end
+
+    # Parses a boolean value.
+    #
+    # @param value [ String ] The URI option value.
+    #
+    # @return [ true | false | nil ] The boolean value parsed out, otherwise nil (and a warning
+    #   will be logged).
+    def bool(name, value)
+      case value
+      when "true"
+        true
+      when "false"
+        false
+      else
+        log_warn("invalid boolean option for #{name}: #{value}")
+        nil
+      end
+    end
+
+    # Parses a boolean value and returns its inverse.
+    #
+    # @param value [ String ] The URI option value.
+    #
+    # @return [ true | false | nil ] The inverse of the  boolean value parsed out, otherwise nil
+    #   (and a warning will be logged).
+     def inverse_bool(name, value)
+      b = bool(name, value)
+
+      if b.nil?
+        nil
+      else
+        !b
+      end
+    end
+
+    # Parses the max staleness value, which must be either "0" or an integer greater or equal to 90.
+    #
+    # @param value [ String ] The max staleness string.
+    #
+    # @return [ Integer | nil ] The max staleness integer parsed out if it is valid, otherwise nil
+    #   (and a warning will be logged).
+    def max_staleness(value)
+      if /\A\d+\z/ =~ value
+        int = value.to_i
+
+        if int >= 0 && int < 90
+          log_warn("max staleness must be either 0 or greater than 90: #{value}")
+        end
+
+        return int
+      end
+
+      log_warn("Invalid max staleness value: #{value}")
+      nil
+    end
+
+    # Parses the connectTimeoutMS value.
+    #
+    # @param value [ String ] The connectTimeoutMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def connect_timeout(value)
+      ms_convert('connectTimeoutMS', value)
+    end
+
+    # Parses the localThresholdMS value.
+    #
+    # @param value [ String ] The localThresholdMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def local_threshold(value)
+      ms_convert('localThresholdMS', value)
+    end
+
+    # Parses the heartbeatFrequencyMS value.
+    #
+    # @param value [ String ] The heartbeatFrequencyMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def heartbeat_frequency(value)
+      ms_convert('heartbeatFrequencyMS', value)
+    end
+
+    # Parses the maxIdleTimeMS value.
+    #
+    # @param value [ String ] The maxIdleTimeMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def max_idle_time(value)
+      ms_convert('maxIdleTimeMS', value)
+    end
+
+    # Parses the serverSelectionMS value.
+    #
+    # @param value [ String ] The serverSelectionMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def server_selection_timeout(value)
+      ms_convert('serverSelectionTimeoutMS', value)
+    end
+
+    # Parses the socketTimeoutMS value.
+    #
+    # @param value [ String ] The socketTimeoutMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def socket_timeout(value)
+      ms_convert('socketTimeoutMS', value)
+    end
+
+    # Parses the waitQueueTimeoutMS value.
+    #
+    # @param value [ String ] The waitQueueTimeoutMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def wait_queue_timeout(value)
+      ms_convert('MS', value)
+    end
+
+    # Parses the wtimeoutMS value.
+    #
+    # @param value [ String ] The wtimeoutMS value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   logged).
+    def wtimeout(value)
+      unless /\A\d+\z/ =~ value
+        log_warn("Invalid wtimeoutMS value: #{value}")
+        return nil
+      end
+
+      value.to_i
+    end
+
     # Ruby's convention is to provide timeouts in seconds, not milliseconds and
     # to use fractions where more precision is necessary. The connection string
     # options are always in MS so we provide an easy conversion type.
@@ -624,7 +895,17 @@ module Mongo
     # @return [ Float ] The seconds value.
     #
     # @since 2.0.0
-    def ms_convert(value)
+    def ms_convert(name, value)
+      unless /\A-?\d+(\.\d+)?\z/ =~ value
+        log_warn("Invalid ms value for #{name}: #{value}")
+        return nil
+      end
+
+      if value[0] == '-'
+        log_warn("#{name} cannot be a negative number")
+        return nil
+      end
+
       value.to_f / 1000
     end
 
@@ -633,9 +914,14 @@ module Mongo
     # @param value [ String ] The string to build a hash from.
     #
     # @return [ Hash ] The hash built from the string.
-    def hash_extractor(value)
+    def hash_extractor(name, value)
       value.split(',').reduce({}) do |set, tag|
         k, v = tag.split(':')
+        if v.nil?
+          log_warn("Invalid hash value for #{name}: #{value}")
+          return nil
+        end
+
         set.merge(decode(k).downcase.to_sym => decode(v))
       end
     end