stomp 1.2.0 → 1.2.1

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 1.2.1 2012-13-03
+
+* Robust SSL certificate support.  See examples and: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+* Really remove the deprecated #send methods
+* Fix exception in Stomp 1.1 code when headers are frozen
+* Revert 245e734a0. See ce8335fb2f for details. Fixes broken Connection#poll.
+* Add reconnection attempts to callback logging.
+* Add SSL specific connection information to callback logging.
+
 == 1.2.0 2011-14-12
 
 * Stomp 1.1 protocol support.  A significant change.  Please test existing 1.0 code well.  See the examples directory for 1.1 examples.

data/examples/logexamp_ssl.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'stomp'
+require 'logger'  # for the 'local' logger
+#
+$:.unshift(File.dirname(__FILE__))
+#
+require 'slogger'
+#
+# A STOMP client program which uses the callback logging facility.
+#
+llog =        Logger::new(STDOUT)
+llog.level =  Logger::DEBUG
+llog.debug "LESSL Starting"
+
+# //////////////////////////////////////////////////////////////////////////////
+mylog = Slogger::new  # The client provided STOMP callback logger
+# -*- encoding: utf-8 -*-
+
+# //////////////////////////////////////////////////////////////////////////////
+user =      ENV['STOMP_USER'] ? ENV['STOMP_USER'] : 'guest'
+password =  ENV['STOMP_PASSWORD'] ? ENV['STOMP_PASSWORD'] : 'guest'
+host =      ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : 'localhost'
+port =      ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
+# //////////////////////////////////////////////////////////////////////////////
+# A hash type connect *MUST* be used to enable callback logging.
+# //////////////////////////////////////////////////////////////////////////////
+hash = { :hosts => [ 
+          {:login => user, :passcode => password, :host => host, :port => port,
+            :ssl => true}, # Or provide your insance of SSLParams instead
+          ],
+          :logger => mylog,	# This enables callback logging!
+          :max_reconnect_attempts => 2,
+        }
+
+# //////////////////////////////////////////////////////////////////////////////
+# For a Connection:
+llog.debug "LESSL Connection processing starts"
+conn = Stomp::Connection.new(hash)
+conn.disconnect
+# //////////////////////////////////////////////////////////////////////////////
+llog.debug "LESSL Connection processing complete"
+
+# //////////////////////////////////////////////////////////////////////////////
+# For a Client:
+llog.debug "LESSL Client processing starts"
+conn = Stomp::Client.new(hash)
+conn.close
+# //////////////////////////////////////////////////////////////////////////////
+llog.debug "LESSL Client processing complete"
+
+# //////////////////////////////////////////////////////////////////////////////
+# For a Connection with other calls:
+llog.debug "LESSL Connection Enhanced processing starts"
+conn = Stomp::Connection.new(hash)
+#
+dest = "/queue/loggerq1"
+conn.publish dest, "a logger message"
+conn.subscribe dest
+msg = conn.receive
+conn.disconnect
+# //////////////////////////////////////////////////////////////////////////////
+llog.debug "LESSL Connection Enhanced processing complete"
+
+# //////////////////////////////////////////////////////////////////////////////
+llog.debug "LESSL Ending"
+

data/examples/slogger.rb

@@ -158,6 +158,22 @@ class Slogger
     end
   end
 
+  def on_ssl_connecting(parms)
+    begin
+      @log.debug "SSL Connecting Parms #{info(parms)}"
+    rescue
+      @log.debug "SSL Connecting oops"
+    end
+  end
+
+  def on_ssl_connected(parms)
+    begin
+      @log.debug "SSL Connected Parms #{info(parms)}"
+    rescue
+      @log.debug "SSL Connected oops"
+    end
+  end
+
   private
 
   def info(parms)
@@ -172,7 +188,7 @@ class Slogger
     # parms[:cur_parseto]
     # parms[:cur_conattempts]
     #
-    "Host: #{parms[:cur_host]}, Port: #{parms[:cur_port]}, Login: Port: #{parms[:cur_login]}, Passcode: #{parms[:cur_passcode]}" 
+    "Host: #{parms[:cur_host]}, Port: #{parms[:cur_port]}, Login: Port: #{parms[:cur_login]}, Passcode: #{parms[:cur_passcode]}, ssl: #{parms[:cur_ssl]}"
   end
 end # of class
 

data/examples/ssl_uc1.rb

@@ -0,0 +1,19 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# SSL Use Case 1
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => true},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 1"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+c.disconnect
+

data/examples/ssl_uc1_ciphers.rb

@@ -0,0 +1,30 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# If you need your own ciphers list, this is how.
+# Stomp's default list will work in many cases.  If you need to use this, you
+# will know it because SSL connect's will fail.  In that case, determining
+# _what_ should be in the list is your responsibility.
+#
+ciphers_list = [["DHE-RSA-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["DHE-DSS-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["AES256-SHA", "TLSv1/SSLv3", 256, 256], ["EDH-RSA-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["EDH-DSS-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DHE-RSA-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["DHE-DSS-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["AES128-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-MD5", "TLSv1/SSLv3", 128, 128], ["EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], 
+["DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EXP-EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-RC2-CBC-MD5", "TLSv1/SSLv3", 40, 128], ["EXP-RC4-MD5", "TLSv1/SSLv3", 40, 128]]
+
+ssl_opts = Stomp::SSLParams.new(:ciphers => ciphers_list)
+
+#
+# SSL Use Case 1
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 1"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+c.disconnect
+

data/examples/ssl_uc2.rb

@@ -0,0 +1,30 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# SSL Use Case 2
+#
+ssl_opts = Stomp::SSLParams.new(:key_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.key",
+  :cert_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.crt")
+
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 2"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+# Expect a verify_result == 20
+#
+# This means: the client did not verify the peer's certificate, but the 
+# handshake succeeds, and the connection is allowed.
+#
+puts "SSL Verify Result: #{ssl_opts.verify_result}"
+puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+c.disconnect
+

data/examples/ssl_uc2_ciphers.rb

@@ -0,0 +1,38 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# If you need your own ciphers list, this is how.
+# Stomp's default list will work in many cases.  If you need to use this, you
+# will know it because SSL connect's will fail.  In that case, determining
+# _what_ should be in the list is your responsibility.
+#
+ciphers_list = [["DHE-RSA-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["DHE-DSS-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["AES256-SHA", "TLSv1/SSLv3", 256, 256], ["EDH-RSA-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["EDH-DSS-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DHE-RSA-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["DHE-DSS-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["AES128-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-MD5", "TLSv1/SSLv3", 128, 128], ["EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], 
+["DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EXP-EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-RC2-CBC-MD5", "TLSv1/SSLv3", 40, 128], ["EXP-RC4-MD5", "TLSv1/SSLv3", 40, 128]]
+#
+# SSL Use Case 2
+#
+ssl_opts = Stomp::SSLParams.new(:key_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.key",
+  :cert_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.crt", :ciphers => ciphers_list)
+
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 2"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+# Expect a verify_result == 20
+#
+# This means: the client did not verify the peer's certificate, but the 
+# handshake succeeds, and the connection is allowed.
+#
+puts "SSL Verify Result: #{ssl_opts.verify_result}"
+puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+c.disconnect
+

data/examples/ssl_uc3.rb

@@ -0,0 +1,29 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# SSL Use Case 3
+#
+ts_flist = []
+ts_flist << "/home/gmallard/sslwork/twocas_tj/serverCA/ServerTJCA.crt"
+ssl_opts = Stomp::SSLParams.new(:ts_files => ts_flist.join(","))
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 3"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+# Expect a verify_result == 0
+#
+# This means: the client successfully verified the peer's certificate.
+#
+puts "SSL Verify Result: #{ssl_opts.verify_result}"
+puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+c.disconnect
+

data/examples/ssl_uc3_ciphers.rb

@@ -0,0 +1,37 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# If you need your own ciphers list, this is how.
+# Stomp's default list will work in many cases.  If you need to use this, you
+# will know it because SSL connect's will fail.  In that case, determining
+# _what_ should be in the list is your responsibility.
+#
+ciphers_list = [["DHE-RSA-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["DHE-DSS-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["AES256-SHA", "TLSv1/SSLv3", 256, 256], ["EDH-RSA-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["EDH-DSS-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DHE-RSA-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["DHE-DSS-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["AES128-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-MD5", "TLSv1/SSLv3", 128, 128], ["EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], 
+["DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EXP-EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-RC2-CBC-MD5", "TLSv1/SSLv3", 40, 128], ["EXP-RC4-MD5", "TLSv1/SSLv3", 40, 128]]
+#
+# SSL Use Case 3
+#
+ts_flist = []
+ts_flist << "/home/gmallard/sslwork/twocas_tj/serverCA/ServerTJCA.crt"
+ssl_opts = Stomp::SSLParams.new(:ts_files => ts_flist.join(","), :ciphers => ciphers_list)
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 3"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+# Expect a verify_result == 0
+#
+# This means: the client successfully verified the peer's certificate.
+#
+puts "SSL Verify Result: #{ssl_opts.verify_result}"
+puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+c.disconnect
+

data/examples/ssl_uc4.rb

@@ -0,0 +1,29 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# SSL Use Case 4
+#
+ssl_opts = Stomp::SSLParams.new(:key_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.key",
+  :cert_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.crt",
+  :ts_files => "/home/gmallard/sslwork/twocas_tj/serverCA/ServerTJCA.crt")
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 4"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+# Expect a verify_result == 0
+#
+# This means: the client successfully verified the peer's certificate.
+#
+puts "SSL Verify Result: #{ssl_opts.verify_result}"
+puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+c.disconnect
+

data/examples/ssl_uc4_ciphers.rb

@@ -0,0 +1,38 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+#
+# If you need your own ciphers list, this is how.
+# Stomp's default list will work in many cases.  If you need to use this, you
+# will know it because SSL connect's will fail.  In that case, determining
+# _what_ should be in the list is your responsibility.
+#
+ciphers_list = [["DHE-RSA-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["DHE-DSS-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["AES256-SHA", "TLSv1/SSLv3", 256, 256], ["EDH-RSA-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["EDH-DSS-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DHE-RSA-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["DHE-DSS-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["AES128-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-MD5", "TLSv1/SSLv3", 128, 128], ["EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], 
+["DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EXP-EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-RC2-CBC-MD5", "TLSv1/SSLv3", 40, 128], ["EXP-RC4-MD5", "TLSv1/SSLv3", 40, 128]]
+#
+# SSL Use Case 4
+#
+ssl_opts = Stomp::SSLParams.new(:key_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.key",
+  :cert_file => "/home/gmallard/sslwork/twocas_tj/clientCA/ClientTJ.crt",
+  :ts_files => "/home/gmallard/sslwork/twocas_tj/serverCA/ServerTJCA.crt",
+  :ciphers => ciphers_list)
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case 4"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+# Expect a verify_result == 0
+#
+# This means: the client successfully verified the peer's certificate.
+#
+puts "SSL Verify Result: #{ssl_opts.verify_result}"
+puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
+c.disconnect
+

data/examples/ssl_ucx_default_ciphers.rb

@@ -0,0 +1,25 @@
+#
+# Reference: https://github.com/morellon/stomp/wiki/extended-ssl-overview
+#
+require "rubygems"
+require "stomp"
+
+#
+# If you use SSLParams, and need the _default_ Ruby ciphers, this is how. 
+#
+ssl_opts = Stomp::SSLParams.new(:use_ruby_ciphers => true)
+#
+# SSL Use Case: Using default Stomp ciphers
+#
+hash = { :hosts => [ 
+      {:login => 'guest', :passcode => 'guest', :host => 'localhost', 
+        :port => 61612, :ssl => ssl_opts},
+      ]
+    }
+#
+puts "Connect starts, SSL Use Case X"
+c = Stomp::Connection.new(hash)
+puts "Connect completed"
+#
+c.disconnect
+

data/lib/stomp/client.rb

@@ -211,11 +211,6 @@ module Stomp
       __send__(*args)
     end
     
-    def send(*args)
-      warn("This method is deprecated and will be removed on the next release. Use 'publish' instead")
-      publish(*args)
-    end
-    
     def connection_frame
       @connection.connection_frame
     end
@@ -354,11 +349,11 @@ module Stomp
         @listener_thread = Thread.start do
           while true
             message = @connection.receive
-            if message.command == 'MESSAGE'
+            if message.command == Stomp::CMD_MESSAGE
               if listener = find_listener(message)
                 listener.call(message)
               end
-            elsif message.command == 'RECEIPT'
+            elsif message.command == Stomp::CMD_RECEIPT
               if listener = @receipt_listeners[message.headers['receipt-id']]
                 listener.call(message)
               end