stomp 1.3.3 → 1.3.4

data/CHANGELOG.rdoc

@@ -1,3 +1,17 @@
+== 1.3.4 20141202
+
+* Change :start_timeout default to 0 (might break some clients) (#98).
+* Allow user set of SSLContext options (#105).
+* Allow user set of parm in SSLContext.new(parm) (#105).
+
+== 1.3.3 20140810
+
+* Do not attempt to write empty message bodies.
+* Explicity close ssl socket on connection timeout.
+* Fix incorrect behavior for empty header keys (#93)
+* Do not override explicit :reliable => false.
+* Fix client fail-over fails (#98)
+
 == 1.3.2 20131208
 
 * Anon tests assigned unique class name.

data/README.rdoc

@@ -12,6 +12,8 @@ An implementation of the Stomp protocol for Ruby. See:
 
 See _CHANGELOG.rdoc_ for details.
 
+* Gem version 1.3.4. Miscellaneous fixes, see CHANGELOG.rdoc for details.
+* Gem version 1.3.3. Miscellaneous fixes, see CHANGELOG.rdoc for details.
 * Gem version 1.3.2. Miscellaneous fixes, see changelog for details.
 * Gem version 1.3.1. Bugfix for logging.
 * Gem version 1.3.0. Added ERROR frame raising as exception, added anonymous connections, miscellaneous other fixes.
@@ -67,7 +69,8 @@ See _CHANGELOG.rdoc_ for details.
                                           # correct for your environment, expect unnecessary fail overs
       :connread_timeout => 0,             # Timeout during CONNECT for read of CONNECTED/ERROR, secs
       :tcp_nodelay => true,               # Turns on the TCP_NODELAY socket option; disables Nagle's algorithm
-      :start_timeout => 10,               # Timeout around Stomp::Client initialization
+      :start_timeout => 0,                # Timeout around Stomp::Client initialization
+      :sslctx_newparm => nil,             # Param for SSLContext.new
     }
 
     # for client

data/examples/ssl_ctxoptions.rb

@@ -0,0 +1,96 @@
+# -*- encoding: utf-8 -*-
+
+#
+require "rubygems"
+require "stomp"
+#
+# == Demo User Control of SSLContext options contents
+#
+# Roughly based on example ssl_uc1.rb.  
+# See comments in that example for more detail.
+#
+# Not tested with jruby. YMMV.
+#
+class ExampleSSLCtxOptions
+  # Initialize.
+  def initialize
+  end
+
+  # Run example 1
+  def run1
+    require 'openssl' unless defined?(OpenSSL)
+    puts "run method ...."
+		# Define SSL Options to be used.  This code is copied from the defaults
+    # in later versions of Ruby V2.x (which has been backported to 1.9.3).
+    #
+    # Connection / Example 1 of 2, user supplied options.
+    #
+
+    # Build SSL Options per user requirements: this is just one
+    # particular/possible example of setting SSL context options.
+    opts = OpenSSL::SSL::OP_ALL
+    # Perhaps. If you need/want any of these you will know it.
+    # This is exactly what is done in later versions of Ruby 2.x (also has
+    # been backported by Ruby team to later versions of 1.9.3).
+    opts &= ~OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS if defined?(OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS)
+    opts |= OpenSSL::SSL::OP_NO_COMPRESSION if defined?(OpenSSL::SSL::OP_NO_COMPRESSION)
+    opts |= OpenSSL::SSL::OP_NO_SSLv2 if defined?(OpenSSL::SSL::OP_NO_SSLv2)
+    opts |= OpenSSL::SSL::OP_NO_SSLv3 if defined?(OpenSSL::SSL::OP_NO_SSLv3)
+
+    urc = defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /jruby/ ? true : false
+
+		# Pass options to SSLParams constructor.
+    ssl_opts = Stomp::SSLParams.new(:ssl_ctxopts => opts, # SSLContext options to set
+      :use_ruby_ciphers => urc,
+      :fsck => true)
+    sport = ENV["STOMP_PORT"].to_i
+    hash = { :hosts => [
+        {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => sport, :ssl => ssl_opts},
+      ],
+      :reliable => false, # YMMV, to test this in a sane manner
+    }
+    #
+    puts "Connect starts, SSLContext Options Set: #{opts}"
+    c = Stomp::Connection.new(hash)
+    puts "Connect completed"
+    puts "SSL Verify Result: #{ssl_opts.verify_result}"
+    # puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+    #
+    c.disconnect
+  end
+  
+  # Run example 2
+  def run2
+    puts "run2 method ...."
+    #
+    # Connection / Example 2 of 2, gem supplied options.
+    #
+
+    urc = defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /jruby/ ? true : false
+
+    # Use gem method to define SSL options.  Exactly the same as the
+    # options used in Example 1 above.
+    ssl_opts = Stomp::SSLParams.new(:ssl_ctxopts => Stomp::Connection::ssl_v2xoptions(),
+       :use_ruby_ciphers => urc,
+       :fsck => true)
+    sport = ENV["STOMP_PORT"].to_i
+    hash = { :hosts => [
+        {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => sport, :ssl => ssl_opts},
+      ],
+      :reliable => false, # YMMV, to test this in a sane manner
+    }
+    #
+    puts "Connect starts, SSLContext Options Set: #{Stomp::Connection::ssl_v2xoptions()}"
+    c = Stomp::Connection.new(hash)
+    puts "Connect completed"
+    puts "SSL Verify Result: #{ssl_opts.verify_result}"
+    # puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+    #
+    c.disconnect
+  end
+end
+#
+e = ExampleSSLCtxOptions.new
+e.run1
+e.run2
+

data/examples/ssl_newparm.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+#
+# Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# == Demo override of SSLContext.new parameters.
+#
+# Based roughly on example ssl_uc1.rb.
+#
+#
+class ExampleSSLNewParm
+  # Initialize.
+  def initialize
+  end
+  # Run example.
+  def run
+    ssl_opts = Stomp::SSLParams.new
+    hash = { :hosts => [
+        {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ],
+      :reliable => false, # YMMV, to test this in a sane manner
+      :sslctx_newparm => :SSLv2,  # An example should you:
+      # a) Actually want SSLv2 *AND*
+      # b) Your Ruby version supports SSLv2 *AND*
+      # c) Your broker supports and allows SSLv2
+    }
+    #
+    puts "Connect starts, SSL Use Case 1"
+    c = Stomp::Connection.new(hash)
+    puts "Connect completed"
+    puts "SSL Verify Result: #{ssl_opts.verify_result}"
+    # puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+    #
+    c.disconnect
+  end
+end
+#
+e = ExampleSSLNewParm.new
+e.run
+

data/examples/ssl_uc2.rb

@@ -30,8 +30,7 @@ class ExampleSSL2
     ts_flist << "/home/gmallard/sslwork/2013/TestCA.crt"
 
     ssl_opts = Stomp::SSLParams.new(:ts_files => ts_flist.join(","), 
-      :fsck => true,
-    )
+      :fsck => true)
     #
     hash = { :hosts => [
         {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},

data/lib/client/utils.rb

@@ -107,8 +107,7 @@ module Stomp
       if @parameters[:reliable] && @start_timeout > 0
         warn "WARN detected :reliable == true and :start_timeout > 0"
         warn "WARN this may cause incorrect fail-over behavior"
-        warn "WARN use :start_timeout => 0 to correct"
-        warn "WARN !! :start_timeout default will change to 0 in the next release"
+        warn "WARN use :start_timeout => 0 to correct fail-over behavior"
       end
     end
 

data/lib/connection/netio.rb

@@ -209,7 +209,7 @@ module Stomp
     def open_ssl_socket()
       require 'openssl' unless defined?(OpenSSL)
       begin # Any raised SSL exceptions
-        ctx = OpenSSL::SSL::SSLContext.new
+        ctx = @sslctx_newparm ? OpenSSL::SSL::SSLContext.new(@sslctx_newparm) : OpenSSL::SSL::SSLContext.new
         ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE # Assume for now
         #
         # Note: if a client uses :ssl => true this would result in the gem using
@@ -275,6 +275,13 @@ module Stomp
               ctx.ciphers = Stomp::DEFAULT_CIPHERS # Just use Stomp defaults
             end
           end
+
+          # Set SSLContext Options if user asks for it in Stomp::SSLParams
+          # and SSL supports it.
+          if @ssl.ssl_ctxopts && ctx.respond_to?(:options=)
+	          ctx.options = @ssl.ssl_ctxopts
+          end
+
         end
 
         #

data/lib/connection/utils.rb

@@ -178,7 +178,8 @@ module Stomp
         :fast_hbs_adjust => 0.0,
         :connread_timeout => 0,
         :tcp_nodelay => true,
-        :start_timeout => 10,
+        :start_timeout => 0,
+        :sslctx_newparm => nil,
       }
 
       res_params = default_params.merge(params)

data/lib/stomp/client.rb

@@ -51,7 +51,8 @@ module Stomp
     #     :fast_hbs_adjust => 0.0,
     #     :connread_timeout => 0,
     #     :tcp_nodelay => true,
-    #     :start_timeout => 10,
+    #     :start_timeout => 0,
+    #     :sslctx_newparm => nil,
     #   }
     #
     #   e.g. c = Stomp::Client.new(hash)
@@ -82,7 +83,7 @@ module Stomp
         parse_positional_params(login, passcode, host, port, reliable)
 
       @logger = @parameters[:logger] ||= Stomp::NullLogger.new
-      @start_timeout = @parameters[:start_timeout] || 10.0
+      @start_timeout = @parameters[:start_timeout] || 0
       check_arguments!()
 
       begin

data/lib/stomp/connection.rb

@@ -46,6 +46,18 @@ module Stomp
       ssl ? 61612 : 61613
     end
 
+    # SSL Helper
+    def self.ssl_v2xoptions()
+        require 'openssl' unless defined?(OpenSSL)
+        # Mimic code in later versions of Ruby 2.x (and backported to later
+        # versions of 1.9.3).
+        opts = OpenSSL::SSL::OP_ALL
+        opts &= ~OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS if defined?(OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS)
+        opts |= OpenSSL::SSL::OP_NO_COMPRESSION if defined?(OpenSSL::SSL::OP_NO_COMPRESSION)
+        opts |= OpenSSL::SSL::OP_NO_SSLv2 if defined?(OpenSSL::SSL::OP_NO_SSLv2)
+        opts |= OpenSSL::SSL::OP_NO_SSLv3 if defined?(OpenSSL::SSL::OP_NO_SSLv3)
+    end
+
     # A new Connection object can be initialized using two forms:
     #
     # Hash (this is the recommended Connection initialization method):
@@ -76,7 +88,8 @@ module Stomp
     #     :fast_hbs_adjust => 0.0,
     #     :connread_timeout => 0,
     #     :tcp_nodelay => true,
-    #     :start_timeout => 10,
+    #     :start_timeout => 0,
+    #     :sslctx_newparm => nil,
     #   }
     #
     #   e.g. c = Stomp::Connection.new(hash)
@@ -126,7 +139,8 @@ module Stomp
         @fast_hbs_adjust = 0.0 # Fast heartbeat senders sleep adjustment
         @connread_timeout = 0 # Connect read CONNECTED/ERROR timeout
         @tcp_nodelay = true # Disable Nagle
-        @start_timeout = 10 # Client only, startup timeout
+        @start_timeout = 0 # Client only, startup timeout
+        @sslctx_newparm = nil # SSLContext.new paramater
         warn "login looks like a URL, do you have the correct parameters?" if @login =~ /:\/\//
       end
 
@@ -163,6 +177,7 @@ module Stomp
       @max_hbrlck_fails = @parameters[:max_hbrlck_fails]
       @fast_hbs_adjust = @parameters[:fast_hbs_adjust]
       @connread_timeout = @parameters[:connread_timeout]
+      @sslctx_newparm = @parameters[:sslctx_newparm]
       #
       # Try to support Ruby 1.9.x and 2.x ssl.
       unless defined?(RSpec)

data/lib/stomp/sslparams.rb

@@ -41,6 +41,9 @@ module Stomp
   # Client wants file existance check on initialize. true/value or false/nil.
   attr_reader :fsck #
 
+  # SSLContext options.
+  attr_reader :ssl_ctxopts #
+
   # initialize returns a valid instance of SSLParams or raises an error.
   def initialize(opts={})
 
@@ -76,6 +79,8 @@ module Stomp
      end
     end
    end
+   # SSLContext options.  See example:  ssl_ctxoptions.rb.
+   @ssl_ctxopts = opts[:ssl_ctxopts]  # nil or options to set
   end
 
  end # of class SSLParams

data/lib/stomp/version.rb

@@ -6,7 +6,7 @@ module Stomp
   module Version  #:nodoc: all
     MAJOR = 1
     MINOR = 3
-    PATCH = 3
+    PATCH = 4
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/client_spec.rb

@@ -77,18 +77,6 @@ describe Stomp::Client do
 
   describe "(created with invalid params)" do
 
-    it "should return ArgumentError if host is nil" do
-      lambda {
-        @client = Stomp::Client.new('login', 'passcode', nil)
-      }.should raise_error
-    end
-
-    it "should return ArgumentError if host is empty" do
-      lambda {
-        @client = Stomp::Client.new('login', 'passcode', '')
-      }.should raise_error
-    end
-
     it "should return ArgumentError if port is nil" do
       lambda {
         @client = Stomp::Client.new('login', 'passcode', 'localhost', nil)

data/spec/connection_spec.rb

@@ -30,7 +30,8 @@ describe Stomp::Connection do
       :fast_hbs_adjust => 0.0,
       :connread_timeout => 0,
       :tcp_nodelay => true,
-      :start_timeout => 10,
+      :start_timeout => 0,
+      :sslctx_newparm => nil,
    }
         
     #POG:
@@ -101,7 +102,9 @@ describe Stomp::Connection do
         :fastHbsAdjust => 0.0,
         :connreadTimeout => 0,
         :tcpNodelay => true,
-        :startTimeout => 10,
+        :startTimeout => 0,
+        :sslctxNewparm => nil,
+
       }
       
       @connection = Stomp::Connection.new(used_hash)
@@ -358,7 +361,8 @@ describe Stomp::Connection do
           :fast_hbs_adjust => 0.0,
           :connread_timeout => 0,
           :tcp_nodelay => true,
-          :start_timeout => 10,
+          :start_timeout => 0,
+          :sslctx_newparm => nil,
         }
         
         used_hash =  {
@@ -401,6 +405,7 @@ describe Stomp::Connection do
           :connread_timeout => 42,
           :tcp_nodelay => false,
           :start_timeout => 6,
+          :sslctx_newparm=>:TLSv1,
         }
         
         @connection = Stomp::Connection.new(used_hash)

data/stomp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stomp}
-  s.version = "1.3.3"
+  s.version = "1.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian McCallister", "Marius Mathiesen", "Thiago Morello", "Guy M. Allard"]
-  s.date = %q{2014-08-10}
+  s.date = %q{2014-12-02}
   s.description = %q{Ruby client for the Stomp messaging protocol.  Note that this gem is no longer supported on rubyforge.}
   s.email = ["brianm@apache.org", "marius@stones.com", "morellon@gmail.com", "allard.guy.m@gmail.com"]
   s.executables = ["catstomp", "stompcat"]
@@ -31,6 +31,8 @@ Gem::Specification.new do |s|
     "examples/publisher.rb",
     "examples/put11conn_ex1.rb",
     "examples/putget11_rh1.rb",
+    "examples/ssl_ctxoptions.rb",
+    "examples/ssl_newparm.rb",
     "examples/ssl_uc1.rb",
     "examples/ssl_uc1_ciphers.rb",
     "examples/ssl_uc2.rb",
@@ -92,6 +94,8 @@ Gem::Specification.new do |s|
     "examples/publisher.rb",
     "examples/put11conn_ex1.rb",
     "examples/putget11_rh1.rb",
+    "examples/ssl_ctxoptions.rb",
+    "examples/ssl_newparm.rb",
     "examples/ssl_uc1.rb",
     "examples/ssl_uc1_ciphers.rb",
     "examples/ssl_uc2.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stomp
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 3
-  - 3
-  version: 1.3.3
+  - 4
+  version: 1.3.4
 platform: ruby
 authors: 
 - Brian McCallister
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-08-10 00:00:00 -04:00
+date: 2014-12-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,8 @@ extra_rdoc_files:
 - examples/publisher.rb
 - examples/put11conn_ex1.rb
 - examples/putget11_rh1.rb
+- examples/ssl_ctxoptions.rb
+- examples/ssl_newparm.rb
 - examples/ssl_uc1.rb
 - examples/ssl_uc1_ciphers.rb
 - examples/ssl_uc2.rb
@@ -125,6 +127,8 @@ files:
 - examples/publisher.rb
 - examples/put11conn_ex1.rb
 - examples/putget11_rh1.rb
+- examples/ssl_ctxoptions.rb
+- examples/ssl_newparm.rb
 - examples/ssl_uc1.rb
 - examples/ssl_uc1_ciphers.rb
 - examples/ssl_uc2.rb