ffi-rzmq 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a406c4de564eef119c3f303a386546d6bfda94fd
-  data.tar.gz: 4ef6371ae1029809d302dc7911d0a5a056328428
+  metadata.gz: d4e271f6dc0fcbad07111b4b23c969f192eb6d57
+  data.tar.gz: d5a508626d471997f3568646cd05a95a70ad19f1
 SHA512:
-  metadata.gz: 801813a1a358e60fc0906369c1da88638bdb2c91588da12c50adf2b5869b8542690baa14b3d6098f2ba34e74fcb9468631c5f23ac21dba216782be21a654406d
-  data.tar.gz: 88e1a7bdc0500f6703e94ace2c145f96420fafa89b0bd39927edd5f4a396ca36a4a0bbb543d57b517b115eae5ffb9c55288b1b568fc4ae11f8acee903ceaa1b1
+  metadata.gz: 72b0886538590486c2e8c64e4e03eeab7259c39a9720b0ae763f7c4d0e149cda5926ddbc1710b39ecbf4cfeee0f348d1c85e1816c437764ac99becb7be784286
+  data.tar.gz: 0ca81c180fb1a7a8c7dd7767f7200589ec91fb42553c49eac03a2b91c5e51a95f002c64503e2d79fe77cee74adb0331a9adda1107ffd498effaa10ce2b471f01

data/History.txt

@@ -1,3 +1,8 @@
+== 2.0.1 / 20140122
+  * Fix setsockopt with string parameters for options that have very strict
+    requirements (like CURVE_SECRETKEY) (37aed3c)
+
+  * Provide a wrapper for zmq_curve_keypair for ZeroMQ4
 
 == 2.0.0 / 20140108
 	* Split out all of the FFI code to its own gem so other projects can use

data/examples/repreq_over_curve.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
+
+# This example shows the basics of a CURVE-secured REP/REQ setup between
+# a Server and Client. This is the minimal required setup for authenticating
+# a connection between a Client and a Server. For validating the Client's authentication
+# once the initial connection has succeeded, you'll need a ZAP handler on the Server.
+
+# Build the Server's keys
+server_public_key, server_private_key = ZMQ::Util.curve_keypair
+
+# Build the Client's keys
+client_public_key, client_private_key = ZMQ::Util.curve_keypair
+
+context = ZMQ::Context.new
+bind_point = "tcp://127.0.0.1:4455"
+
+##
+# Configure the Server
+##
+server = context.socket ZMQ::REP
+
+server.setsockopt(ZMQ::CURVE_SERVER, 1)
+server.setsockopt(ZMQ::CURVE_SECRETKEY, server_private_key)
+
+server.bind(bind_point)
+
+##
+# Configure the Client to talk to the Server
+##
+client = context.socket ZMQ::REQ
+
+client.setsockopt(ZMQ::CURVE_SERVERKEY, server_public_key)
+client.setsockopt(ZMQ::CURVE_PUBLICKEY, client_public_key)
+client.setsockopt(ZMQ::CURVE_SECRETKEY, client_private_key)
+
+client.connect(bind_point)
+
+##
+# Show that communication still works
+##
+
+client_message = "Hello Server!"
+server_response = "Hello Client!"
+
+puts "Client sending: #{client_message}"
+client.send_string client_message
+
+server.recv_string(server_message = '')
+puts "Server received: #{server_message}, replying with #{server_response}"
+
+server.send_string(server_response)
+
+client.recv_string(response = '')
+puts "Client has received: #{response}"
+
+puts "Finished"
+
+client.close
+server.close
+context.terminate

data/lib/ffi-rzmq/exceptions.rb

@@ -13,6 +13,9 @@ module ZMQ
     end
   end # call ZeroMQError
 
+  class NotSupportedError < ZeroMQError
+  end
+
 
   class ContextError < ZeroMQError
     # True when the exception was raised due to the library

data/lib/ffi-rzmq/socket.rb

@@ -135,15 +135,14 @@ module ZMQ
         pointer.write_int value
 
       elsif 2 == @option_lookup[name]
+        # Strings are treated as pointers by FFI so we'll just pass it through
         length ||= value.size
+        pointer = value
 
-        # note: not checking errno for failed memory allocations :(
-        pointer = LibC.malloc length
-        pointer.write_string value
       end
 
       rc = LibZMQ.zmq_setsockopt @socket, name, pointer, length
-      LibC.free(pointer) unless pointer.nil? || pointer.null?
+      LibC.free(pointer) unless pointer.is_a?(String) || pointer.nil? || pointer.null?
       rc
     end
 

data/lib/ffi-rzmq/util.rb

@@ -5,6 +5,23 @@ module ZMQ
   #
   class Util
 
+    # Generate and return a CURVE public/private keypair
+    #
+    # Raises an error if ZeroMQ is not configured for CURVE connections.
+    # Install libsodium if this is the case.
+    def self.curve_keypair
+      public_key = FFI::MemoryPointer.from_string(' ' * 41)
+      private_key = FFI::MemoryPointer.from_string(' ' * 41)
+      rc = LibZMQ.zmq_curve_keypair public_key, private_key
+
+      if rc < 0
+        raise NotSupportedError.new "zmq_curve_keypair" , rc, ZMQ::Util.errno,
+          "Rebuild zeromq with libsodium to enable CURVE security options."
+      end
+
+      [public_key.read_string, private_key.read_string]
+    end
+
     # Returns true when +rc+ is greater than or equal to 0, false otherwise.
     #
     # We use the >= test because zmq_poll() returns the number of sockets

data/lib/ffi-rzmq/version.rb

@@ -1,3 +1,3 @@
 module ZMQ
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/util_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+module ZMQ
+  describe Util do
+
+    if LibZMQ.version4?
+      describe "curve_keypair" do
+
+        it "returns a set of public and private keys" do
+          public_key, private_key = ZMQ::Util.curve_keypair
+
+          public_key.should_not == private_key
+          public_key.should_not be_nil
+          private_key.should_not be_nil
+        end
+
+        it "raises if zmq does not support CURVE (libsodium not linked)" do
+          lambda {
+            LibZMQ.should_receive(:zmq_curve_keypair).and_return(-1)
+            ZMQ::Util.curve_keypair
+          }.should raise_exception(ZMQ::NotSupportedError)
+        end
+
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-rzmq
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Chuck Remes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq-core
@@ -79,6 +79,7 @@ files:
 - examples/publish_subscribe.rb
 - examples/remote_lat.rb
 - examples/remote_throughput.rb
+- examples/repreq_over_curve.rb
 - examples/reqrep_poll.rb
 - examples/request_response.rb
 - examples/sub.rb
@@ -110,6 +111,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/test.crt
 - spec/support/test.key
+- spec/util_spec.rb
 homepage: http://github.com/chuckremes/ffi-rzmq
 licenses:
 - MIT
@@ -130,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ffi-rzmq
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: This gem wraps the ZeroMQ (0mq) networking library using Ruby FFI (foreign
@@ -148,3 +150,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/test.crt
 - spec/support/test.key
+- spec/util_spec.rb