bunny 1.3.0 → 2.17.0

data/lib/bunny/test_kit.rb

@@ -1,9 +1,23 @@
 # -*- coding: utf-8 -*-
+
+require "timeout"
+
 module Bunny
   # Unit, integration and stress testing toolkit
   class TestKit
     class << self
 
+      def poll_while(timeout = 60, &probe)
+        Timeout.timeout(timeout) {
+          sleep 0.1 while probe.call
+        }
+      end
+      def poll_until(timeout = 60, &probe)
+        Timeout.timeout(timeout) {
+          sleep 0.1 until probe.call
+        }
+      end
+
       # @return [Integer] Random integer in the range of [a, b]
       # @api private
       def random_in_range(a, b)

data/lib/bunny/timeout.rb

@@ -1,16 +1,5 @@
 module Bunny
-  # Unifies Ruby standard library's Timeout (which is not accurate on
-  # Ruby 1.8) and SystemTimer (the gem)
-  Timeout = if RUBY_VERSION < "1.9"
-              begin
-                require "bunny/system_timer"
-                Bunny::SystemTimer
-              rescue LoadError
-                Timeout
-              end
-            else
-              Timeout
-            end
+  Timeout = ::Timeout
 
   # Backwards compatibility
   # @private

data/lib/bunny/transport.rb

@@ -4,7 +4,7 @@ require "monitor"
 
 begin
   require "openssl"
-rescue LoadError => le
+rescue LoadError => _le
   $stderr.puts "Could not load OpenSSL"
 end
 
@@ -20,18 +20,22 @@ module Bunny
     #
 
     # Default TCP connection timeout
-    DEFAULT_CONNECTION_TIMEOUT = 5.0
-    # Default TLS protocol version to use.
-    # Currently SSLv3, same as in RabbitMQ Java client
-    DEFAULT_TLS_PROTOCOL       = "SSLv3"
+    DEFAULT_CONNECTION_TIMEOUT = 30.0
 
+    DEFAULT_READ_TIMEOUT  = 30.0
+    DEFAULT_WRITE_TIMEOUT = 30.0
 
-    attr_reader :session, :host, :port, :socket, :connect_timeout, :read_write_timeout, :disconnect_timeout
-    attr_reader :tls_context
+    attr_reader :session, :host, :port, :socket, :connect_timeout, :read_timeout, :write_timeout, :disconnect_timeout
+    attr_reader :tls_context, :verify_peer, :tls_ca_certificates, :tls_certificate_path, :tls_key_path
+
+    def read_timeout=(v)
+      @read_timeout = v
+      @read_timeout = nil if @read_timeout == 0
+    end
 
     def initialize(session, host, port, opts)
       @session        = session
-      @session_thread = opts[:session_thread]
+      @session_error_handler = opts[:session_error_handler]
       @host    = host
       @port    = port
       @opts    = opts
@@ -39,14 +43,22 @@ module Bunny
       @logger                = session.logger
       @tls_enabled           = tls_enabled?(opts)
 
-      @read_write_timeout = opts[:socket_timeout] || 3
-      @read_write_timeout = nil if @read_write_timeout == 0
+      @read_timeout = opts[:read_timeout] || DEFAULT_READ_TIMEOUT
+      @read_timeout = nil if @read_timeout == 0
+
+      @write_timeout = opts[:socket_timeout] # Backwards compatability
+
+      @write_timeout ||= opts[:write_timeout] || DEFAULT_WRITE_TIMEOUT
+      @write_timeout = nil if @write_timeout == 0
+
       @connect_timeout    = self.timeout_from(opts)
       @connect_timeout    = nil if @connect_timeout == 0
-      @disconnect_timeout = @read_write_timeout || @connect_timeout
+      @disconnect_timeout = @write_timeout || @read_timeout || @connect_timeout
 
       @writes_mutex       = @session.mutex_impl.new
 
+      @socket = nil
+
       prepare_tls_context(opts) if @tls_enabled
     end
 
@@ -70,9 +82,30 @@ module Bunny
 
 
     def connect
-      if uses_ssl?
-        @socket.connect
-        @socket.post_connection_check(host) if uses_tls? && @verify_peer
+      if uses_tls?
+        begin
+          @socket.connect
+        rescue OpenSSL::SSL::SSLError => e
+          @logger.error { "TLS connection failed: #{e.message}" }
+          raise e
+        end
+
+        log_peer_certificate_info(Logger::DEBUG, @socket.peer_cert)
+        log_peer_certificate_chain_info(Logger::DEBUG, @socket.peer_cert_chain)
+
+        begin
+          @socket.post_connection_check(host) if @verify_peer
+        rescue OpenSSL::SSL::SSLError => e
+          @logger.error do
+            msg = "Peer verification of target server failed: #{e.message}. "
+            msg += "Target hostname: #{hostname}, see peer certificate chain details below."
+            msg
+          end
+          log_peer_certificate_info(Logger::ERROR, @socket.peer_cert)
+          log_peer_certificate_chain_info(Logger::ERROR, @socket.peer_cert_chain)
+
+          raise e
+        end
 
         @status = :connected
 
@@ -83,7 +116,7 @@ module Bunny
     end
 
     def connected?
-      :not_connected == @status && open?
+      :connected == @status && open?
     end
 
     def configure_socket(&block)
@@ -94,50 +127,68 @@ module Bunny
       block.call(@tls_context) if @tls_context
     end
 
-    # Writes data to the socket. If read/write timeout was specified, Bunny::ClientTimeout will be raised
-    # if the operation times out.
-    #
-    # @raise [ClientTimeout]
-    def write(data)
-      begin
-        if @read_write_timeout
-          Bunny::Timeout.timeout(@read_write_timeout, Bunny::ClientTimeout) do
-            if open?
-              @writes_mutex.synchronize { @socket.write(data) }
-              @socket.flush
+    if defined?(JRUBY_VERSION)
+      # Writes data to the socket.
+      def write(data)
+        return write_without_timeout(data) unless @write_timeout
+
+        begin
+          if open?
+            @writes_mutex.synchronize do
+              @socket.write(data)
             end
           end
-        else
-          if open?
-            @writes_mutex.synchronize { @socket.write(data) }
-            @socket.flush
+        rescue SystemCallError, Timeout::Error, Bunny::ConnectionError, IOError => e
+          @logger.error "Got an exception when sending data: #{e.message} (#{e.class.name})"
+          close
+          @status = :not_connected
+
+          if @session.automatically_recover?
+            @session.handle_network_failure(e)
+          else
+            @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
           end
         end
-      rescue SystemCallError, Bunny::ClientTimeout, Bunny::ConnectionError, IOError => e
-        @logger.error "Got an exception when sending data: #{e.message} (#{e.class.name})"
-        close
-        @status = :not_connected
+      end
+    else
+      # Writes data to the socket. If read/write timeout was specified the operation will return after that
+      # amount of time has elapsed waiting for the socket.
+      def write(data)
+        return write_without_timeout(data) unless @write_timeout
 
-        if @session.automatically_recover?
-          @session.handle_network_failure(e)
-        else
-          @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+        begin
+          if open?
+            @writes_mutex.synchronize do
+              @socket.write_nonblock_fully(data, @write_timeout)
+            end
+          end
+        rescue SystemCallError, Timeout::Error, Bunny::ConnectionError, IOError => e
+          @logger.error "Got an exception when sending data: #{e.message} (#{e.class.name})"
+          close
+          @status = :not_connected
+
+          if @session.automatically_recover?
+            @session.handle_network_failure(e)
+          else
+            @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+          end
         end
       end
     end
 
     # Writes data to the socket without timeout checks
-    def write_without_timeout(data)
+    def write_without_timeout(data, raise_exceptions = false)
       begin
         @writes_mutex.synchronize { @socket.write(data) }
         @socket.flush
       rescue SystemCallError, Bunny::ConnectionError, IOError => e
         close
+        raise e if raise_exceptions
 
         if @session.automatically_recover?
           @session.handle_network_failure(e)
         else
-          @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+          @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
         end
       end
     end
@@ -183,8 +234,20 @@ module Bunny
       @socket.flush if @socket
     end
 
-    def read_fully(*args)
-      @socket.read_fully(*args)
+    def read_fully(count)
+      begin
+        @socket.read_fully(count, @read_timeout)
+      rescue SystemCallError, Timeout::Error, Bunny::ConnectionError, IOError => e
+        @logger.error "Got an exception when receiving data: #{e.message} (#{e.class.name})"
+        close
+        @status = :not_connected
+
+        if @session.automatically_recover?
+          raise
+        else
+          @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+        end
+      end
     end
 
     def read_ready?(timeout = nil)
@@ -192,22 +255,17 @@ module Bunny
       io && io[0].include?(@socket)
     end
 
-
     # Exposed primarily for Bunny::Channel
     # @private
     def read_next_frame(opts = {})
-      header    = @socket.read_fully(7)
-      # TODO: network issues here will sometimes cause
-      #       the socket method return an empty string. We need to log
-      #       and handle this better.
-      # type, channel, size = begin
-      #                         AMQ::Protocol::Frame.decode_header(header)
-      #                       rescue AMQ::Protocol::EmptyResponseError => e
-      #                         puts "Got AMQ::Protocol::EmptyResponseError, header is #{header.inspect}"
-      #                       end
+      header              = read_fully(7)
       type, channel, size = AMQ::Protocol::Frame.decode_header(header)
-      payload   = @socket.read_fully(size)
-      frame_end = @socket.read_fully(1)
+      payload             = if size > 0
+                              read_fully(size)
+                            else
+                              ''
+                            end
+      frame_end = read_fully(1)
 
       # 1) the size is miscalculated
       if payload.bytesize != size
@@ -223,10 +281,10 @@ module Bunny
     def self.reacheable?(host, port, timeout)
       begin
         s = Bunny::SocketImpl.open(host, port,
-          :socket_timeout => timeout)
+          :connect_timeout => timeout)
 
         true
-      rescue SocketError, Timeout::Error => e
+      rescue SocketError, Timeout::Error => _e
         false
       ensure
         s.close if s
@@ -241,7 +299,7 @@ module Bunny
       begin
         @socket = Bunny::SocketImpl.open(@host, @port,
           :keepalive      => @opts[:keepalive],
-          :socket_timeout => @connect_timeout)
+          :connect_timeout => @connect_timeout)
       rescue StandardError, ClientTimeout => e
         @status = :not_connected
         raise Bunny::TCPConnectionFailed.new(e, self.hostname, self.port)
@@ -255,7 +313,7 @@ module Bunny
     end
 
     def post_initialize_socket
-      @socket = if uses_tls?
+      @socket = if uses_tls? and !@socket.is_a?(Bunny::SSLSocketImpl)
                   wrap_in_tls_socket(@socket)
                 else
                   @socket
@@ -265,23 +323,27 @@ module Bunny
     protected
 
     def tls_enabled?(opts)
-      return opts[:tls] unless opts[:tls].nil?
-      return opts[:ssl] unless opts[:ssl].nil?
+      return !!opts[:tls] unless opts[:tls].nil?
+      return !!opts[:ssl] unless opts[:ssl].nil?
       (opts[:port] == AMQ::Protocol::TLS_PORT) || false
     end
 
+    def tls_ca_certificates_paths_from(opts)
+      Array(opts[:cacertfile] || opts[:tls_ca_certificates] || opts[:ssl_ca_certificates])
+    end
+
     def tls_certificate_path_from(opts)
-      opts[:tls_cert] || opts[:ssl_cert] || opts[:tls_cert_path] || opts[:ssl_cert_path] || opts[:tls_certificate_path] || opts[:ssl_certificate_path]
+      opts[:certfile] || opts[:tls_cert] || opts[:ssl_cert] || opts[:tls_cert_path] || opts[:ssl_cert_path] || opts[:tls_certificate_path] || opts[:ssl_certificate_path]
     end
 
     def tls_key_path_from(opts)
-      opts[:tls_key] || opts[:ssl_key] || opts[:tls_key_path] || opts[:ssl_key_path]
+      opts[:keyfile] || opts[:tls_key] || opts[:ssl_key] || opts[:tls_key_path] || opts[:ssl_key_path]
     end
 
     def tls_certificate_from(opts)
       begin
         read_client_certificate!
-      rescue MissingTLSCertificateFile => e
+      rescue MissingTLSCertificateFile => _e
         inline_client_certificate_from(opts)
       end
     end
@@ -289,14 +351,37 @@ module Bunny
     def tls_key_from(opts)
       begin
         read_client_key!
-      rescue MissingTLSKeyFile => e
+      rescue MissingTLSKeyFile => _e
         inline_client_key_from(opts)
       end
     end
 
+    def peer_certificate_info(peer_cert, prefix = "Peer's leaf certificate")
+      exts = peer_cert.extensions.map { |x| x.value }
+      # Subject Alternative Names
+      sans = exts.select { |s| s =~ /^DNS/ }.map { |s| s.gsub(/^DNS:/, "") }
+
+      msg = "#{prefix} subject: #{peer_cert.subject}, "
+      msg += "subject alternative names: #{sans.join(', ')}, "
+      msg += "issuer: #{peer_cert.issuer}, "
+      msg += "not valid after: #{peer_cert.not_after}, "
+      msg += "X.509 usage extensions: #{exts.join(', ')}"
+
+      msg
+    end
+
+    def log_peer_certificate_info(severity, peer_cert, prefix = "Peer's leaf certificate")
+      @logger.add(severity) { peer_certificate_info(peer_cert, prefix) }
+    end
+
+    def log_peer_certificate_chain_info(severity, chain)
+      chain.each do |cert|
+        self.log_peer_certificate_info(severity, cert, "Peer's certificate chain entry")
+      end
+    end
 
     def inline_client_certificate_from(opts)
-      opts[:tls_certificate] || opts[:ssl_cert_string]
+      opts[:tls_certificate] || opts[:ssl_cert_string] || opts[:tls_cert]
     end
 
     def inline_client_key_from(opts)
@@ -304,6 +389,10 @@ module Bunny
     end
 
     def prepare_tls_context(opts)
+      if opts.values_at(:verify_ssl, :verify_peer, :verify).all?(&:nil?)
+        opts[:verify_peer] = true
+      end
+
       # client cert/key paths
       @tls_certificate_path  = tls_certificate_path_from(opts)
       @tls_key_path          = tls_key_path_from(opts)
@@ -312,10 +401,20 @@ module Bunny
       @tls_key               = tls_key_from(opts)
       @tls_certificate_store = opts[:tls_certificate_store]
 
-      @tls_ca_certificates   = opts.fetch(:tls_ca_certificates, default_tls_certificates)
-      @verify_peer           = opts[:verify_ssl] || opts[:verify_peer]
+      @verify_peer           = as_boolean(opts[:verify_ssl] || opts[:verify_peer] || opts[:verify])
 
-      @tls_context = initialize_tls_context(OpenSSL::SSL::SSLContext.new)
+      @tls_context = initialize_tls_context(OpenSSL::SSL::SSLContext.new, opts)
+    end
+
+    def as_boolean(val)
+      case val
+      when true    then true
+      when false   then false
+      when "true"  then true
+      when "false" then false
+      else
+        !!val
+      end
     end
 
     def wrap_in_tls_socket(socket)
@@ -323,6 +422,11 @@ module Bunny
       raise "cannot wrap a socket into TLS socket, @tls_context is nil. This is a Bunny bug." unless @tls_context
 
       s = Bunny::SSLSocketImpl.new(socket, @tls_context)
+
+      # always set the SNI server name if possible since RFC 3546 and RFC 6066 both state
+      # that TLS clients supporting the extensions can talk to TLS servers that do not
+      s.hostname = @host if s.respond_to?(:hostname)
+
       s.sync_close = true
       s
     end
@@ -349,65 +453,68 @@ module Bunny
       end
     end
 
-    def initialize_tls_context(ctx)
+    def initialize_tls_context(ctx, opts={})
       ctx.cert       = OpenSSL::X509::Certificate.new(@tls_certificate) if @tls_certificate
       ctx.key        = OpenSSL::PKey::RSA.new(@tls_key) if @tls_key
       ctx.cert_store = if @tls_certificate_store
                          @tls_certificate_store
                        else
+                         # this ivar exists so that this value can be exposed in the API
+                         @tls_ca_certificates = tls_ca_certificates_paths_from(opts)
                          initialize_tls_certificate_store(@tls_ca_certificates)
                        end
 
       if !@tls_certificate
         @logger.warn <<-MSG
-        Using TLS but no client certificate is provided! If RabbitMQ is configured to verify peer
-        certificate, connection upgrade will fail!
+Using TLS but no client certificate is provided. If RabbitMQ is configured to require & verify peer
+certificate, connection will be rejected. Learn more at https://www.rabbitmq.com/ssl.html
         MSG
       end
       if @tls_certificate && !@tls_key
         @logger.warn "Using TLS but no client private key is provided!"
       end
 
-      # setting TLS/SSL version only works correctly when done
-      # vis set_params. MK.
-      ctx.set_params(:ssl_version => @opts.fetch(:tls_protocol, DEFAULT_TLS_PROTOCOL))
-     
       verify_mode = if @verify_peer
         OpenSSL::SSL::VERIFY_PEER|OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
       else
         OpenSSL::SSL::VERIFY_NONE
       end
+      @logger.debug { "Will use peer verification mode #{verify_mode}" }
+      ctx.verify_mode = verify_mode
+
+      if !@verify_peer
+        @logger.warn <<-MSG
+Using TLS but peer hostname verification is disabled. This is convenient for local development
+but prone to man-in-the-middle attacks. Please set verify_peer: true in production. Learn more at https://www.rabbitmq.com/ssl.html
+        MSG
+      end
 
-      ctx.set_params(:verify_mode => verify_mode)
+      ssl_version = opts[:tls_protocol] || opts[:ssl_version]
+      ctx.ssl_version = ssl_version if ssl_version
 
       ctx
     end
 
-    def default_tls_certificates
-      if defined?(JRUBY_VERSION)
-        # see https://github.com/jruby/jruby/issues/1055. MK.
-        []
-      else
-        default_ca_file = ENV[OpenSSL::X509::DEFAULT_CERT_FILE_ENV] || OpenSSL::X509::DEFAULT_CERT_FILE
-        default_ca_path = ENV[OpenSSL::X509::DEFAULT_CERT_DIR_ENV] || OpenSSL::X509::DEFAULT_CERT_DIR
-
-        [
-          default_ca_file,
-          File.join(default_ca_path, 'ca-certificates.crt'), # Ubuntu/Debian
-          File.join(default_ca_path, 'ca-bundle.crt'),       # Amazon Linux & Fedora/RHEL
-          File.join(default_ca_path, 'ca-bundle.pem')        # OpenSUSE
-          ].uniq
-      end
-    end
-
     def initialize_tls_certificate_store(certs)
-      certs = certs.select { |path| File.readable? path }
-      @logger.debug "Using CA certificates at #{certs.join(', ')}"
-      if certs.empty?
-        @logger.error "No CA certificates found, add one with :tls_ca_certificates"
+      cert_files = []
+      cert_inlines = []
+      certs.each do |cert|
+        # if it starts with / or C:/ then it's a file path that may or may not
+        # exist (e.g. a default OpenSSL path). MK.
+        if File.readable?(cert) || cert =~ /^([a-z]:?)?\//i
+          cert_files.push(cert)
+        else
+          cert_inlines.push(cert)
+        end
       end
+      @logger.debug { "Using CA certificates at #{cert_files.join(', ')}" }
+      @logger.debug { "Using #{cert_inlines.count} inline CA certificates" }
       OpenSSL::X509::Store.new.tap do |store|
-        certs.each { |path| store.add_file(path) }
+        store.set_default_paths
+        cert_files.select { |path| File.readable?(path) }.
+          each { |path| store.add_file(path) }
+        cert_inlines.
+          each { |cert| store.add_cert(OpenSSL::X509::Certificate.new(cert)) }
       end
     end