protocol-zmtp 0.10.4 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea36d2dec54002414471143e5dcffcbc6fcedb10a53a52f9c22684e5657c4a0d
-  data.tar.gz: 17e2377d7534476344dd47164d8b6fde121526b4d2715af4dfb5c4682bd98bf8
+  metadata.gz: c8d53545d14bf02a264d165e08adb9ab22b1f948a614856644dea0a093dc1da5
+  data.tar.gz: cf71224105abc69d8cd6df5d2ab5e45cdcbed0c88ff257a6325fdd3deeb8312c
 SHA512:
-  metadata.gz: 8ecaa0325141c8e1e41f8389aa1b431328b2c9b0c83c912f301119bd49503a001889aec9db285485fe786022033927588e3843dd8af60dfb1597619ca57aff40
-  data.tar.gz: 67af1e45d9834d9ae7ed47352758eca7b92817691bf80518addfb66de28979d4a0bbaf2ec53ff802c8fbefd788a88bfeb6d794b9669cda1fdc57be20af00f669
+  metadata.gz: 677c05b2057178c6c388805c53c9dd1b314c06a4c436cf448b1d0fa2f2cdc6515c7818e0f3995a398b336487bebf74f6c00f8380837f635fd9377e1c11d8b3b1
+  data.tar.gz: 912e32a6301493475a676952ad1ac1c9ddff7e1f68e0b5415b20fd344dfe32d3e887d51faa00a0dce1f8fe4fb219cd50f899517e21a5c0b47dfd33b1140b3cb9

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## Unreleased
 
+## [0.10.5] - 2026-10-15
+
+### Added
+
+- Allow updating `Connection#max_message_size` after the handshake so
+  compressed transports can bound wire envelopes separately from messages.
+
+### Fixed
+
+- Reject invalid frame flags, lengths above 2^63-1, and malformed PING commands.
+- Match handshake metadata names case-insensitively for NULL, PLAIN, and CURVE.
+- Raise `FatalHandshakeError` on handshake ERROR responses and send ERROR when
+  PLAIN authentication rejects credentials.
+
 ## 0.10.4 - 2026-07-23
 
 ### Changed

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

@@ -72,7 +72,7 @@ module Protocol
 
         # 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+).
+        # that injects +X-Compression+).
         #
         # @param metadata [Hash{String => String}, nil] additional READY properties
         # @return [Command]
@@ -83,6 +83,27 @@ module Protocol
         end
 
 
+        # Builds a fatal handshake refusal.
+        def self.error(reason)
+          raise Error, "ERROR reason exceeds 255 bytes" if reason.bytesize > 255
+
+          new("ERROR", reason.bytesize.chr.b + reason.b)
+        end
+
+
+        # ERROR is fatal even if its reason is malformed.
+        def raise_if_error!
+          return self unless @name == "ERROR"
+
+          length = @data.getbyte(0)
+          unless length && @data.bytesize == length + 1
+            raise FatalHandshakeError, "malformed ERROR command"
+          end
+
+          raise FatalHandshakeError, "peer rejected handshake: #{@data.byteslice(1, length).inspect}"
+        end
+
+
         # Builds a SUBSCRIBE command.
         #
         # @param prefix [String] subscription prefix to match
@@ -125,6 +146,9 @@ module Protocol
         # @param context [String] optional context bytes (up to 16 bytes)
         # @return [Command]
         def self.ping(ttl: 0, context: EMPTY_BINARY)
+          raise Error, "PING TTL must be between 0 and 6553.5 seconds" unless (0..6553.5).cover?(ttl)
+          raise Error, "PING context exceeds 16 bytes" if context.bytesize > 16
+
           ttl_ds = (ttl * 10).to_i
           new("PING", [ttl_ds].pack("n") + (context.encoding == Encoding::BINARY ? context : context.b))
         end
@@ -135,6 +159,8 @@ module Protocol
         # @param context [String] context bytes echoed from the PING
         # @return [Command]
         def self.pong(context: EMPTY_BINARY)
+          raise Error, "PONG context exceeds 16 bytes" if context.bytesize > 16
+
           new("PONG", context.encoding == Encoding::BINARY ? context : context.b)
         end
 
@@ -143,6 +169,8 @@ module Protocol
         #
         # @return [Array(Numeric, String)] [ttl_seconds, context_bytes]
         def ping_ttl_and_context
+          raise Error, "PING data must contain a TTL and at most 16 context bytes" unless (2..18).cover?(@data.bytesize)
+
           ttl_ds  = @data.unpack1("n")
           context = @data.bytesize > 2 ? @data.byteslice(2..) : EMPTY_BINARY
           [ttl_ds / 10.0, context]
@@ -157,6 +185,16 @@ module Protocol
         end
 
 
+        # Property names are case-insensitive; retain their original spelling
+        # in the public metadata hash for callers that enumerate it.
+        def self.property(props, name)
+          props.each_pair do |key, value|
+            return value if key.casecmp?(name)
+          end
+          nil
+        end
+
+
         # Encodes a hash of properties into ZMTP property list format.
         #
         # @param props [Hash{String => String}] property name-value pairs

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

@@ -23,6 +23,7 @@ module Protocol
 
         # Short frame: 1-byte size, max body 255 bytes.
         SHORT_MAX = 255
+        LONG_MAX  = (1 << 63) - 1
 
         # Pre-computed single-byte flag strings (avoids Integer#chr + String#b per frame).
         FLAG_BYTES = Array.new(256) { |i| i.chr.b.freeze }.freeze
@@ -102,6 +103,9 @@ module Protocol
           long    = (flags & FLAGS_LONG) != 0
           command = (flags & FLAGS_COMMAND) != 0
 
+          raise Error, "reserved frame flags must be zero" unless (flags & 0xF8).zero?
+          raise Error, "command frames cannot have MORE set" if command && more
+
           if long
             raise EOFError, "Stream finished before reading long frame size" if buf.bytesize < 9
 
@@ -119,6 +123,8 @@ module Protocol
             header_size = 2
           end
 
+          raise Error, "frame size exceeds ZMTP's 63-bit limit" if size > LONG_MAX
+
           if max_message_size && size > max_message_size
             raise Error, "frame size #{size} exceeds max_message_size #{max_message_size}"
           end
@@ -141,6 +147,8 @@ module Protocol
         # @param more [Boolean] more frames follow
         # @param command [Boolean] this is a command frame
         def initialize(body, more: false, command: false)
+          raise Error, "command frames cannot have MORE set" if command && more
+
           @body    = body
           @more    = more
           @command = command

data/lib/protocol/zmtp/connection.rb

@@ -47,6 +47,10 @@ module Protocol
       # @return [Float, nil] monotonic timestamp of last received frame
       attr_reader :last_received_at
 
+      # Transport wrappers may need room for bounded wire envelopes in
+      # addition to the application message limit they enforce after decoding.
+      attr_writer :max_message_size
+
 
       # @param io [#peek, #read_exactly, #write, #flush, #close] transport IO
       # @param socket_type [String] our socket type name (e.g. "REQ")
@@ -55,7 +59,7 @@ module Protocol
       # @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
+      #   advertise (e.g. +"X-Compression" => "lz4"+). 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,
@@ -278,12 +282,7 @@ module Protocol
       # @raise [EOFError] if connection is closed
       def read_frame
         loop do
-          begin
-            frame = Codec::Frame.read_from(@io, max_message_size: @max_message_size)
-          rescue Error
-            close
-            raise
-          end
+          frame = Codec::Frame.read_from(@io, max_message_size: @max_message_size)
 
           touch_heartbeat
 
@@ -297,12 +296,16 @@ module Protocol
               send_command(Codec::Command.pong(context: context))
               next
             when "PONG"
+              raise Error, "PONG context exceeds 16 bytes" if cmd.data.bytesize > 16
               next
             end
           end
 
           return frame
         end
+      rescue Error
+        close
+        raise
       end
 
 

data/lib/protocol/zmtp/error.rb

@@ -5,5 +5,10 @@ module Protocol
     # Raised on ZMTP protocol violations.
     class Error < RuntimeError
     end
+
+
+    # An explicit handshake refusal. Do not retry with the same credentials.
+    class FatalHandshakeError < Error
+    end
   end
 end

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

@@ -153,6 +153,8 @@ module Protocol
         # @param command [Boolean] whether this is a command frame
         # @return [String] binary wire bytes ready for writing
         def encrypt(body, more: false, command: false)
+          raise Error, "command frames cannot have MORE set" if command && more
+
           flags = 0
           flags |= 0x01 if more
           flags |= 0x02 if command
@@ -211,6 +213,8 @@ module Protocol
           end
 
           flags = plaintext.getbyte(0)
+          raise Error, "invalid MESSAGE flags" unless flags && (flags & 0xFC).zero?
+
           body  = plaintext.byteslice(1..) || "".b
           Codec::Frame.new(body, more: (flags & 0x01) != 0, command: (flags & 0x02) != 0)
         end
@@ -255,7 +259,7 @@ module Protocol
           # --- Read WELCOME ---
           welcome_frame = Codec::Frame.read_from(io)
           raise Error, "expected command frame" unless welcome_frame.command?
-          welcome_cmd = Codec::Command.from_body(welcome_frame.body)
+          welcome_cmd = Codec::Command.from_body(welcome_frame.body).raise_if_error!
           raise Error, "expected WELCOME, got #{welcome_cmd.name}" unless welcome_cmd.name == "WELCOME"
 
           wdata = welcome_cmd.data
@@ -307,7 +311,7 @@ module Protocol
           # --- Read READY ---
           ready_frame = Codec::Frame.read_from(io)
           raise Error, "expected command frame" unless ready_frame.command?
-          ready_cmd = Codec::Command.from_body(ready_frame.body)
+          ready_cmd = Codec::Command.from_body(ready_frame.body).raise_if_error!
           raise Error, "expected READY, got #{ready_cmd.name}" unless ready_cmd.name == "READY"
 
           rdata = ready_cmd.data
@@ -324,8 +328,8 @@ module Protocol
           end
 
           props            = Codec::Command.decode_properties(r_plaintext)
-          peer_socket_type = props["Socket-Type"]
-          peer_identity    = props["Identity"] || ""
+          peer_socket_type = Codec::Command.property(props, "Socket-Type")
+          peer_identity    = Codec::Command.property(props, "Identity") || ""
 
           @session_box = session
           @send_nonce  = 1
@@ -361,7 +365,7 @@ module Protocol
           # --- Read HELLO ---
           hello_frame = Codec::Frame.read_from(io)
           raise Error, "expected command frame" unless hello_frame.command?
-          hello_cmd = Codec::Command.from_body(hello_frame.body)
+          hello_cmd = Codec::Command.from_body(hello_frame.body).raise_if_error!
           raise Error, "expected HELLO, got #{hello_cmd.name}" unless hello_cmd.name == "HELLO"
 
           hdata = hello_cmd.data
@@ -407,7 +411,7 @@ module Protocol
           # --- Read INITIATE ---
           init_frame = Codec::Frame.read_from(io)
           raise Error, "expected command frame" unless init_frame.command?
-          init_cmd = Codec::Command.from_body(init_frame.body)
+          init_cmd = Codec::Command.from_body(init_frame.body).raise_if_error!
           raise Error, "expected INITIATE, got #{init_cmd.name}" unless init_cmd.name == "INITIATE"
 
           idata = init_cmd.data
@@ -468,7 +472,7 @@ module Protocol
             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"
+              raise FatalHandshakeError, "client key not authorized"
             end
           end
 
@@ -498,8 +502,8 @@ module Protocol
           init_nonce_buffers!
 
           {
-            peer_socket_type: props["Socket-Type"],
-            peer_identity:    props["Identity"] || "",
+            peer_socket_type: Codec::Command.property(props, "Socket-Type"),
+            peer_identity:    Codec::Command.property(props, "Identity") || "",
             peer_public_key:  client_permanent,
             peer_properties:  props,
             peer_major:       @peer_major,

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

@@ -48,14 +48,14 @@ module Protocol
             raise Error, "expected command frame, got data frame"
           end
 
-          peer_cmd = Codec::Command.from_body(frame.body)
+          peer_cmd = Codec::Command.from_body(frame.body).raise_if_error!
           unless peer_cmd.name == "READY"
             raise Error, "expected READY command, got #{peer_cmd.name}"
           end
 
           props            = peer_cmd.properties
-          peer_socket_type = props["Socket-Type"]
-          peer_identity    = props["Identity"] || ""
+          peer_socket_type = Codec::Command.property(props, "Socket-Type")
+          peer_identity    = Codec::Command.property(props, "Identity") || ""
 
           unless peer_socket_type
             raise Error, "peer READY missing Socket-Type"

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

@@ -92,7 +92,8 @@ module Protocol
           username, password = decode_credentials(cmd.data)
 
           if @authenticator && !@authenticator.call(username, password)
-            raise Error, "authentication failed"
+            send_command(io, Codec::Command.error("authentication failed"))
+            raise FatalHandshakeError, "authentication failed"
           end
 
           send_command(io, Codec::Command.new("WELCOME"))
@@ -143,13 +144,13 @@ module Protocol
 
         def extract_peer_info(cmd)
           props            = cmd.properties
-          peer_socket_type = props["Socket-Type"]
+          peer_socket_type = Codec::Command.property(props, "Socket-Type")
 
           raise Error, "peer command missing Socket-Type" unless peer_socket_type
 
           {
             peer_socket_type: peer_socket_type,
-            peer_identity:    props["Identity"] || "",
+            peer_identity:    Codec::Command.property(props, "Identity") || "",
             peer_properties:  props,
           }
         end
@@ -165,7 +166,7 @@ module Protocol
           frame = Codec::Frame.read_from(io)
           raise Error, "expected command frame, got data frame" unless frame.command?
 
-          Codec::Command.from_body(frame.body)
+          Codec::Command.from_body(frame.body).raise_if_error!
         end
       end
     end

data/lib/protocol/zmtp/peer_info.rb

@@ -9,7 +9,7 @@ module Protocol
     # - +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
+    # Used as a peer key by upper layers: 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.
     #

data/lib/protocol/zmtp/version.rb

@@ -2,6 +2,6 @@
 
 module Protocol
   module ZMTP
-    VERSION = "0.10.4"
+    VERSION = "0.10.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-zmtp
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.10.5
 platform: ruby
 authors:
 - Patrik Wenger
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: ZMTP 3.1 wire protocol codec and connection
 test_files: []