protocol-zmtp 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe0884f347da68db2bbd04949c944108a997d67f545e511e5a74973a84c1d359
-  data.tar.gz: ff1542dd2feffb84db290fc1dacb8e06d10da80282619c342a59d8d239388125
+  metadata.gz: c147d32b0109fa000aadcd519b73c1e808996aee42b0565e4fd1840af28c984d
+  data.tar.gz: 83ec8f366229b893b6347f5cb62a2651980d1408da473e2c629a9a01098feeeb
 SHA512:
-  metadata.gz: 41b15de98c2e4f0ed6db44f9cf9d9524e4dac42c1f01bf75652a363c9afbedc1af755b7531e113e32abea1a3fd64f164446190c81e036a172989868b5bd712a0
-  data.tar.gz: 7325e3b59a72b14776128de68361f0507ebfca31d52646aadd1688b6b022e8b04fa9308c3b8a2da7ddccccaaa1d5ed81d58f9f8a0f15a308fd0e196f8b45ceb9
+  metadata.gz: 96984a2b7e2a30b792ca73b066fdcaf79a1661b65397d139e97bf6e92f4ad9b234357e0610bd7025dff29812fad88753b0875f2b7f3be8c3bffffe4ae042274c
+  data.tar.gz: a320a61ed574017490604a1fd80959a11655292135e3f370321c07eefdbf00e2b1f21bd0e3df712d3d3d3158399c8128c7515eb91641c53bca543874fa0467ca

data/lib/protocol/zmtp/codec/command.rb

@@ -70,17 +70,21 @@ module Protocol
         end
 
 
-        # Builds a READY command with Socket-Type, Identity, and optional X-QoS properties.
+        # Builds a READY command with Socket-Type, Identity, optional X-QoS,
+        # and any extra properties supplied by upper layers (e.g. an
+        # extension that injects an `X-Compression` property).
         #
         # @param qos [Integer] QoS level (0 = omitted)
         # @param qos_hash [String] supported hash algorithms in preference order (e.g. "xXsS")
+        # @param metadata [Hash{String => String}] additional READY properties
         # @return [Command]
-        def self.ready(socket_type:, identity: "", qos: 0, qos_hash: "")
+        def self.ready(socket_type:, identity: "", qos: 0, qos_hash: "", metadata: nil)
           props = { "Socket-Type" => socket_type, "Identity" => identity }
           if qos > 0
             props["X-QoS"]      = qos.to_s
             props["X-QoS-Hash"] = qos_hash unless qos_hash.empty?
           end
+          props.merge!(metadata) if metadata && !metadata.empty?
           new("READY", encode_properties(props))
         end
 

data/lib/protocol/zmtp/connection.rb

@@ -24,6 +24,10 @@ module Protocol
       # @return [String] peer's supported hash algorithms in preference order
       attr_reader :peer_qos_hash
 
+      # @return [Hash{String => String}, nil] full peer READY property hash
+      #   (set after a successful handshake; nil before)
+      attr_reader :peer_properties
+
       # @return [Object] transport IO (#read_exactly, #write, #flush, #close)
       attr_reader :io
 
@@ -47,6 +51,7 @@ module Protocol
         @peer_identity    = nil
         @peer_qos         = nil
         @peer_qos_hash    = nil
+        @peer_properties  = nil
         @qos              = qos
         @qos_hash         = qos_hash
         @mutex            = Mutex.new
@@ -78,6 +83,7 @@ module Protocol
         @peer_identity    = result[:peer_identity]
         @peer_qos         = result[:peer_qos] || 0
         @peer_qos_hash    = result[:peer_qos_hash] || ""
+        @peer_properties  = result[:peer_properties]
 
         unless @peer_socket_type
           raise Error, "peer READY missing Socket-Type"

data/lib/protocol/zmtp/mechanism/curve.rb

@@ -23,6 +23,10 @@ module Protocol
       class Curve
         MECHANISM_NAME = "CURVE"
 
+        # Extra READY/INITIATE properties merged in by extensions
+        # (e.g. ZMTP-Zstd's X-Compression). nil = none.
+        attr_accessor :metadata
+
 
         # Nonce prefixes.
         NONCE_PREFIX_HELLO     = "CurveZMQHELLO---"
@@ -96,9 +100,10 @@ module Protocol
             end
           end
 
-          @session_box = nil
-          @send_nonce  = 0
-          @recv_nonce  = -1
+          @session_box      = nil
+          @send_nonce       = 0
+          @recv_nonce       = -1
+          @metadata = nil
         end
 
 
@@ -285,6 +290,7 @@ module Protocol
             props["X-QoS"]      = qos.to_s
             props["X-QoS-Hash"] = qos_hash unless qos_hash.empty?
           end
+          props.merge!(@metadata) if @metadata
           metadata = Codec::Command.encode_properties(props)
 
           initiate_box_plaintext = "".b
@@ -336,7 +342,13 @@ module Protocol
           @recv_nonce  = 0
           init_nonce_buffers!
 
-          { peer_socket_type: peer_socket_type, peer_identity: peer_identity, peer_qos: peer_qos, peer_qos_hash: peer_qos_hash }
+          {
+            peer_socket_type: peer_socket_type,
+            peer_identity:    peer_identity,
+            peer_qos:         peer_qos,
+            peer_qos_hash:    peer_qos_hash,
+            peer_properties:  props,
+          }
         end
 
 
@@ -474,6 +486,7 @@ module Protocol
             ready_props["X-QoS"]      = qos.to_s
             ready_props["X-QoS-Hash"] = qos_hash unless qos_hash.empty?
           end
+          ready_props.merge!(@metadata) if @metadata
           ready_metadata = Codec::Command.encode_properties(ready_props)
 
           r_short_nonce = [1].pack("Q>")
@@ -500,6 +513,7 @@ module Protocol
             peer_identity:    props["Identity"] || "",
             peer_qos:         (props["X-QoS"] || "0").to_i,
             peer_qos_hash:    props["X-QoS-Hash"] || "",
+            peer_properties:  props,
           }
         end
 

data/lib/protocol/zmtp/mechanism/null.rb

@@ -11,18 +11,28 @@ module Protocol
       class Null
         MECHANISM_NAME = "NULL"
 
+        # Extra READY properties an upper layer (e.g. an OMQ extension)
+        # wants this side to advertise. Mutated before #handshake!.
+        # @return [Hash{String => String}]
+        attr_accessor :metadata
+
+
+        def initialize
+          @metadata = nil
+        end
+
 
         # Performs the full NULL handshake over +io+.
         #
         # 1. Exchange 64-byte greetings
         # 2. Validate peer greeting (version, mechanism)
-        # 3. Exchange READY commands (socket type + identity)
+        # 3. Exchange READY commands (socket type + identity + any extras)
         #
         # @param io [#read_exactly, #write, #flush] transport IO
         # @param as_server [Boolean]
         # @param socket_type [String]
         # @param identity [String]
-        # @return [Hash] { peer_socket_type:, peer_identity: }
+        # @return [Hash] { peer_socket_type:, peer_identity:, peer_qos:, peer_qos_hash:, peer_properties: }
         # @raise [Error]
         def handshake!(io, as_server:, socket_type:, identity:, qos: 0, qos_hash: "")
           io.write(Codec::Greeting.encode(mechanism: MECHANISM_NAME, as_server: as_server))
@@ -35,7 +45,13 @@ module Protocol
             raise Error, "unsupported mechanism: #{peer_greeting[:mechanism]}"
           end
 
-          ready_cmd = Codec::Command.ready(socket_type: socket_type, identity: identity, qos: qos, qos_hash: qos_hash)
+          ready_cmd = Codec::Command.ready(
+            socket_type:      socket_type,
+            identity:         identity,
+            qos:              qos,
+            qos_hash:         qos_hash,
+            metadata: @metadata,
+          )
           io.write(ready_cmd.to_frame.to_wire)
           io.flush
 
@@ -59,7 +75,13 @@ module Protocol
             raise Error, "peer READY missing Socket-Type"
           end
 
-          { peer_socket_type: peer_socket_type, peer_identity: peer_identity, peer_qos: peer_qos, peer_qos_hash: peer_qos_hash }
+          {
+            peer_socket_type: peer_socket_type,
+            peer_identity:    peer_identity,
+            peer_qos:         peer_qos,
+            peer_qos_hash:    peer_qos_hash,
+            peer_properties:  props,
+          }
         end
 
 

data/lib/protocol/zmtp/mechanism/plain.rb

@@ -16,15 +16,22 @@ module Protocol
         MECHANISM_NAME = "PLAIN"
 
 
+        # Extra READY/INITIATE properties an upper layer wants this side to
+        # advertise. Mutated before #handshake!.
+        # @return [Hash{String => String}]
+        attr_accessor :metadata
+
+
         # @param username [String] client username (max 255 bytes)
         # @param password [String] client password (max 255 bytes)
         # @param authenticator [#call, nil] server-side credential verifier;
         #   called as +authenticator.call(username, password)+ and must return
         #   truthy to accept the connection.  When +nil+, all credentials pass.
         def initialize(username: "", password: "", authenticator: nil)
-          @username      = username
-          @password      = password
-          @authenticator = authenticator
+          @username         = username
+          @password         = password
+          @authenticator    = authenticator
+          @metadata = nil
         end
 
 
@@ -48,9 +55,11 @@ module Protocol
           end
 
           if as_server
-            server_handshake!(io, socket_type: socket_type, identity: identity, qos: qos, qos_hash: qos_hash)
+            server_handshake! io, socket_type: socket_type, identity: identity,
+              qos: qos, qos_hash: qos_hash
           else
-            client_handshake!(io, socket_type: socket_type, identity: identity, qos: qos, qos_hash: qos_hash)
+            client_handshake! io, socket_type: socket_type, identity: identity,
+              qos: qos, qos_hash: qos_hash
           end
         end
 
@@ -70,11 +79,17 @@ module Protocol
           cmd = read_command(io)
           raise Error, "expected WELCOME, got #{cmd.name}" unless cmd.name == "WELCOME"
 
-          props = { "Socket-Type" => socket_type, "Identity" => identity }
+          props = {
+            "Socket-Type" => socket_type,
+            "Identity" => identity
+          }
+
           if qos > 0
             props["X-QoS"]      = qos.to_s
             props["X-QoS-Hash"] = qos_hash unless qos_hash.empty?
           end
+
+          props.merge!(@metadata) if @metadata && !@metadata.empty?
           initiate = Codec::Command.new("INITIATE", Codec::Command.encode_properties(props))
           send_command(io, initiate)
 
@@ -102,7 +117,9 @@ module Protocol
 
           peer_info = extract_peer_info(cmd)
 
-          send_command(io, Codec::Command.ready(socket_type: socket_type, identity: identity, qos: qos, qos_hash: qos_hash))
+          ready = Codec::Command.ready socket_type: socket_type, identity: identity,
+            qos: qos, qos_hash: qos_hash, metadata: @metadata
+          send_command io, ready
 
           peer_info
         end
@@ -146,7 +163,13 @@ module Protocol
 
           raise Error, "peer command missing Socket-Type" unless peer_socket_type
 
-          { peer_socket_type: peer_socket_type, peer_identity: props["Identity"] || "", peer_qos: (props["X-QoS"] || "0").to_i, peer_qos_hash: props["X-QoS-Hash"] || "" }
+          {
+            peer_socket_type: peer_socket_type,
+            peer_identity:    props["Identity"] || "",
+            peer_qos:         (props["X-QoS"] || "0").to_i,
+            peer_qos_hash:    props["X-QoS-Hash"] || "",
+            peer_properties:  props
+          }
         end
 
 

data/lib/protocol/zmtp/version.rb

@@ -2,6 +2,6 @@
 
 module Protocol
   module ZMTP
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-zmtp
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Patrik Wenger