protocol-zmtp 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edfecc19ca6c0befbc5835da0fbfc1fc364007207f10e6f1de64c733d48f2336
-  data.tar.gz: d6616b661ee77e73191ed6f33e0a3c5b73b04e6b3fe8e8e5cac30067ae75bb42
+  metadata.gz: 303ee019ebede5cddca93226c136233c19b7ec6e54cad7ef0deba5f5a5f6e347
+  data.tar.gz: 229f46c1a06f1fe7d02a3b1a518fee8958786959fa0b43fe6587d47392c9d602
 SHA512:
-  metadata.gz: 4520a2435a1490fcfb7aebd070f58d10e97a05da685a3c36a47417db2e82b8d7ef48d0c5d19ee6c7db99c7b5da552cd4fec2f061aee3fd9e55908d7d30cf301d
-  data.tar.gz: d8c6f26fe3197a25f32e5c5a6668d53eb8cecf109dbe084b00c63b2fcb396cbe05dfd37c9b01ecbc39a960f35ce56ca70fa02c49761e9e0065246ffffeb36437
+  metadata.gz: 38345cf8abc4d1ed198a90abe714d15dd5cc8877fd22ba25f672c9ff4c02a36e9c7754a6c3998fc3b0cf9dd8972e54595be4c953c4e18d0acecaf3363b5971d2
+  data.tar.gz: 50c74c72d1926d1bd3756cf130d57039337f75f34c47d701b7b7a936e9f3d9b57e9f203e6b841b454b9de5d99624ada8239dbfb6e2f8cf8285ae991aa94b9828

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

@@ -70,20 +70,14 @@ module Protocol
         end
 
 
-        # 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).
+        # Builds a READY command with Socket-Type, Identity, and any
+        # extra properties supplied by upper layers (e.g. an extension
+        # that injects +X-QoS+ or +X-Compression+).
         #
-        # @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
+        # @param metadata [Hash{String => String}, nil] additional READY properties
         # @return [Command]
-        def self.ready(socket_type:, identity: "", qos: 0, qos_hash: "", metadata: nil)
+        def self.ready(socket_type:, identity: "", 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/codec/frame.rb

@@ -56,7 +56,6 @@ module Protocol
 
           while i < parts.size
             body  = parts[i]
-            body  = body.b unless body.encoding == Encoding::BINARY
             size  = body.bytesize
             flags = i < last ? FLAGS_MORE : 0
 
@@ -142,7 +141,7 @@ module Protocol
         # @param more [Boolean] more frames follow
         # @param command [Boolean] this is a command frame
         def initialize(body, more: false, command: false)
-          @body    = body.encoding == Encoding::BINARY ? body : body.b
+          @body    = body
           @more    = more
           @command = command
         end

data/lib/protocol/zmtp/connection.rb

@@ -20,16 +20,14 @@ module Protocol
       attr_reader :peer_identity
 
 
-      # @return [Integer] peer's QoS level (from READY handshake, 0 if absent)
-      attr_reader :peer_qos
-
-
-      # @return [String] peer's supported hash algorithms in preference order
-      attr_reader :peer_qos_hash
+      # @return [Object, nil] peer's CURVE long-term public key post-handshake
+      #   (+crypto::PublicKey+ when the mechanism is CURVE; +nil+ for NULL).
+      attr_reader :peer_public_key
 
 
       # @return [Hash{String => String}, nil] full peer READY property hash
-      #   (set after a successful handshake; nil before)
+      #   (set after a successful handshake; nil before).
+      #   Upper layers extract their own X-* properties from here.
       attr_reader :peer_properties
 
 
@@ -56,8 +54,12 @@ module Protocol
       # @param as_server [Boolean] whether we are the server side
       # @param mechanism [Mechanism::Null, Mechanism::Curve] security mechanism
       # @param max_message_size [Integer, nil] max frame size in bytes, nil = unlimited
+      # @param opts [Hash{String => String}] extra READY properties to
+      #   advertise (e.g. +"X-QoS" => "1"+). Upper-layer extensions use
+      #   this to inject their own negotiated properties without the
+      #   codec needing to know about them.
       def initialize(io, socket_type:, identity: "", as_server: false,
-                     mechanism: nil, max_message_size: nil, qos: 0, qos_hash: "")
+                     mechanism: nil, max_message_size: nil, **opts)
         @io               = io
         @socket_type      = socket_type
         @identity         = identity
@@ -65,13 +67,11 @@ module Protocol
         @mechanism        = mechanism || Mechanism::Null.new
         @peer_socket_type = nil
         @peer_identity    = nil
-        @peer_qos         = nil
-        @peer_qos_hash    = nil
+        @peer_public_key  = nil
         @peer_properties  = nil
         @peer_major       = nil
         @peer_minor       = nil
-        @qos              = qos
-        @qos_hash         = qos_hash
+        @metadata         = opts.empty? ? nil : opts.transform_keys(&:to_s)
         @mutex            = Mutex.new
         @max_message_size = max_message_size
         @last_received_at = nil
@@ -92,13 +92,11 @@ module Protocol
           as_server:   @as_server,
           socket_type: @socket_type,
           identity:    @identity,
-          qos:         @qos,
-          qos_hash:    @qos_hash
+          metadata:    @metadata
 
         @peer_socket_type = result[:peer_socket_type]
         @peer_identity    = result[:peer_identity]
-        @peer_qos         = result[:peer_qos] || 0
-        @peer_qos_hash    = result[:peer_qos_hash] || ""
+        @peer_public_key  = result[:peer_public_key]
         @peer_properties  = result[:peer_properties]
         @peer_major       = result[:peer_major]
         @peer_minor       = result[:peer_minor]
@@ -114,6 +112,17 @@ module Protocol
       end
 
 
+      # Returns a {PeerInfo} value bundling the peer's CURVE public key
+      # and identity for use as a stable per-peer key (frozen, hash-usable).
+      # Nil before the handshake has completed.
+      #
+      # @return [PeerInfo, nil]
+      def peer_info
+        return nil unless @peer_socket_type
+        PeerInfo.new(public_key: @peer_public_key, identity: @peer_identity)
+      end
+
+
       # Sends a multi-frame message (write + flush).
       #
       # @param parts [Array<String>] message frames
@@ -214,11 +223,11 @@ module Protocol
             next
           end
 
-          frames << frame.body.freeze
+          frames << frame.body
           break unless frame.more?
         end
 
-        frames.freeze
+        frames
       end
 
 

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

@@ -23,10 +23,6 @@ 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---"
@@ -100,10 +96,9 @@ module Protocol
             end
           end
 
-          @session_box      = nil
-          @send_nonce       = 0
-          @recv_nonce       = -1
-          @metadata = nil
+          @session_box = nil
+          @send_nonce  = 0
+          @recv_nonce  = -1
         end
 
 
@@ -139,15 +134,14 @@ module Protocol
         # @param as_server [Boolean] ignored -- uses the value from #initialize
         # @param socket_type [String] our socket type name
         # @param identity [String] our identity
-        # @param qos [Integer] QoS level
-        # @param qos_hash [String] supported hash algorithms
-        # @return [Hash] { peer_socket_type:, peer_identity:, peer_qos:, peer_qos_hash: }
+        # @param metadata [Hash{String => String}, nil] extra READY properties
+        # @return [Hash] { peer_socket_type:, peer_identity:, peer_properties: }
         # @raise [Error] on handshake failure
-        def handshake!(io, as_server:, socket_type:, identity:, qos: 0, qos_hash: "")
+        def handshake!(io, as_server:, socket_type:, identity:, metadata: nil)
           if @as_server
-            server_handshake!(io, socket_type:, identity:, qos:, qos_hash:)
+            server_handshake!(io, socket_type:, identity:, metadata:)
           else
-            client_handshake!(io, socket_type:, identity:, qos:, qos_hash:)
+            client_handshake!(io, socket_type:, identity:, metadata:)
           end
         end
 
@@ -227,7 +221,7 @@ module Protocol
         # Client-side handshake
         # ----------------------------------------------------------------
 
-        def client_handshake!(io, socket_type:, identity:, qos: 0, qos_hash: "")
+        def client_handshake!(io, socket_type:, identity:, metadata: nil)
           cn_secret = @crypto::PrivateKey.generate
           cn_public = cn_secret.public_key
 
@@ -288,18 +282,14 @@ module Protocol
           vouch           = @crypto::Box.new(sn_public, @permanent_secret).encrypt(vouch_nonce, vouch_plaintext)
 
           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 = Codec::Command.encode_properties(props)
+          props.merge!(metadata) if metadata && !metadata.empty?
+          metadata_bytes = Codec::Command.encode_properties(props)
 
           initiate_box_plaintext = "".b
           initiate_box_plaintext << @permanent_public.to_s
           initiate_box_plaintext << vouch_nonce.byteslice(8, 16)
           initiate_box_plaintext << vouch
-          initiate_box_plaintext << metadata
+          initiate_box_plaintext << metadata_bytes
 
           init_short_nonce = [1].pack("Q>")
           init_nonce       = NONCE_PREFIX_INITIATE + init_short_nonce
@@ -336,8 +326,6 @@ module Protocol
           props            = Codec::Command.decode_properties(r_plaintext)
           peer_socket_type = props["Socket-Type"]
           peer_identity    = props["Identity"] || ""
-          peer_qos         = (props["X-QoS"] || "0").to_i
-          peer_qos_hash    = props["X-QoS-Hash"] || ""
 
           @session_box = session
           @send_nonce  = 1
@@ -347,8 +335,7 @@ module Protocol
           {
             peer_socket_type: peer_socket_type,
             peer_identity:    peer_identity,
-            peer_qos:         peer_qos,
-            peer_qos_hash:    peer_qos_hash,
+            peer_public_key:  @server_public,
             peer_properties:  props,
             peer_major:       @peer_major,
             peer_minor:       @peer_minor,
@@ -360,7 +347,7 @@ module Protocol
         # Server-side handshake
         # ----------------------------------------------------------------
 
-        def server_handshake!(io, socket_type:, identity:, qos: 0, qos_hash: "")
+        def server_handshake!(io, socket_type:, identity:, metadata: nil)
           io.write(Codec::Greeting.encode(mechanism: MECHANISM_NAME, as_server: true))
           io.flush
           peer_greeting = Codec::Greeting.read_from(io)
@@ -478,7 +465,7 @@ module Protocol
           end
 
           if @authenticator
-            peer = PeerInfo.new(public_key: client_permanent)
+            peer = PeerInfo.new(public_key: client_permanent, identity: "")
             unless @authenticator.call(peer)
               send_error(io, "client key not authorized")
               raise Error, "client key not authorized"
@@ -488,11 +475,7 @@ module Protocol
 
           # --- READY ---
           ready_props = { "Socket-Type" => socket_type, "Identity" => identity }
-          if qos > 0
-            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_props.merge!(metadata) if metadata && !metadata.empty?
           ready_metadata = Codec::Command.encode_properties(ready_props)
 
           r_short_nonce = [1].pack("Q>")
@@ -517,8 +500,7 @@ module Protocol
           {
             peer_socket_type: props["Socket-Type"],
             peer_identity:    props["Identity"] || "",
-            peer_qos:         (props["X-QoS"] || "0").to_i,
-            peer_qos_hash:    props["X-QoS-Hash"] || "",
+            peer_public_key:  client_permanent,
             peer_properties:  props,
             peer_major:       @peer_major,
             peer_minor:       @peer_minor,

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

@@ -11,16 +11,6 @@ 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+.
         #
@@ -32,9 +22,10 @@ module Protocol
         # @param as_server [Boolean]
         # @param socket_type [String]
         # @param identity [String]
-        # @return [Hash] { peer_socket_type:, peer_identity:, peer_qos:, peer_qos_hash:, peer_properties:, peer_major:, peer_minor: }
+        # @param metadata [Hash{String => String}, nil] extra READY properties
+        # @return [Hash] { peer_socket_type:, peer_identity:, peer_public_key:, peer_properties:, peer_major:, peer_minor: }
         # @raise [Error]
-        def handshake!(io, as_server:, socket_type:, identity:, qos: 0, qos_hash: "")
+        def handshake!(io, as_server:, socket_type:, identity:, metadata: nil)
           io.write(Codec::Greeting.encode(mechanism: MECHANISM_NAME, as_server: as_server))
           io.flush
 
@@ -45,11 +36,9 @@ module Protocol
           end
 
           ready_cmd = Codec::Command.ready(
-            socket_type:      socket_type,
-            identity:         identity,
-            qos:              qos,
-            qos_hash:         qos_hash,
-            metadata: @metadata,
+            socket_type: socket_type,
+            identity:    identity,
+            metadata:    metadata,
           )
           io.write(ready_cmd.to_frame.to_wire)
           io.flush
@@ -67,8 +56,6 @@ module Protocol
           props            = peer_cmd.properties
           peer_socket_type = props["Socket-Type"]
           peer_identity    = props["Identity"] || ""
-          peer_qos         = (props["X-QoS"] || "0").to_i
-          peer_qos_hash    = props["X-QoS-Hash"] || ""
 
           unless peer_socket_type
             raise Error, "peer READY missing Socket-Type"
@@ -77,8 +64,7 @@ module Protocol
           {
             peer_socket_type: peer_socket_type,
             peer_identity:    peer_identity,
-            peer_qos:         peer_qos,
-            peer_qos_hash:    peer_qos_hash,
+            peer_public_key:  nil,
             peer_properties:  props,
             peer_major:       peer_greeting[:major],
             peer_minor:       peer_greeting[:minor],

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

@@ -16,22 +16,15 @@ 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
-          @metadata = nil
+          @username      = username
+          @password      = password
+          @authenticator = authenticator
         end
 
 
@@ -41,9 +34,10 @@ module Protocol
         # @param as_server [Boolean]
         # @param socket_type [String]
         # @param identity [String]
-        # @return [Hash] { peer_socket_type:, peer_identity: }
+        # @param metadata [Hash{String => String}, nil] extra READY properties
+        # @return [Hash] { peer_socket_type:, peer_identity:, peer_properties: }
         # @raise [Error]
-        def handshake!(io, as_server:, socket_type:, identity:, qos: 0, qos_hash: "")
+        def handshake!(io, as_server:, socket_type:, identity:, metadata: nil)
           io.write(Codec::Greeting.encode(mechanism: MECHANISM_NAME, as_server: as_server))
           io.flush
 
@@ -54,11 +48,9 @@ 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, metadata: metadata
           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, metadata: metadata
           end
         end
 
@@ -72,7 +64,7 @@ module Protocol
         private
 
 
-        def client_handshake!(io, socket_type:, identity:, qos: 0, qos_hash: "")
+        def client_handshake!(io, socket_type:, identity:, metadata: nil)
           send_command(io, hello_command)
 
           cmd = read_command(io)
@@ -80,15 +72,9 @@ module Protocol
 
           props = {
             "Socket-Type" => socket_type,
-            "Identity" => identity
+            "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?
+          props.merge!(metadata) if metadata && !metadata.empty?
           initiate = Codec::Command.new("INITIATE", Codec::Command.encode_properties(props))
           send_command(io, initiate)
 
@@ -99,7 +85,7 @@ module Protocol
         end
 
 
-        def server_handshake!(io, socket_type:, identity:, qos: 0, qos_hash: "")
+        def server_handshake!(io, socket_type:, identity:, metadata: nil)
           cmd = read_command(io)
           raise Error, "expected HELLO, got #{cmd.name}" unless cmd.name == "HELLO"
 
@@ -116,8 +102,7 @@ module Protocol
 
           peer_info = extract_peer_info(cmd)
 
-          ready = Codec::Command.ready socket_type: socket_type, identity: identity,
-            qos: qos, qos_hash: qos_hash, metadata: @metadata
+          ready = Codec::Command.ready socket_type: socket_type, identity: identity, metadata: metadata
           send_command io, ready
 
           peer_info
@@ -165,9 +150,7 @@ module Protocol
           {
             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
+            peer_properties:  props,
           }
         end
 

data/lib/protocol/zmtp/peer_info.rb

@@ -2,8 +2,19 @@
 
 module Protocol
   module ZMTP
-    # Context passed to an authenticator during authentication.
-    # +public_key+ is a +crypto::PublicKey+ instance.
-    PeerInfo = Data.define(:public_key)
+    # Post-handshake identity of the peer on a {Connection}.
+    #
+    # - +public_key+ is the peer's CURVE long-term +crypto::PublicKey+,
+    #   or +nil+ when the mechanism does not authenticate a key (e.g. NULL).
+    # - +identity+ is the peer's +ZMQ_IDENTITY+ string, or +""+ when no
+    #   identity was advertised in the READY metadata.
+    #
+    # Used as a peer key by upper layers (e.g. omq-qos levels 2/3): the
+    # whole value object is frozen and equality-comparable, so it can be
+    # stored directly in a Hash without picking one anchor over the other.
+    #
+    # Also passed to CURVE authenticators during the handshake (at that
+    # point +identity+ is +""+, since it arrives post-auth).
+    PeerInfo = Data.define(:public_key, :identity)
   end
 end

data/lib/protocol/zmtp/version.rb

@@ -2,6 +2,6 @@
 
 module Protocol
   module ZMTP
-    VERSION = "0.9.0"
+    VERSION = "0.10.0"
   end
 end

metadata

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