omq 0.9.0 → 0.11.0

data/lib/omq/transport/tls.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "socket"
+require "uri"
+require "openssl"
+require "io/stream"
+
+module OMQ
+  module Transport
+    # TLS transport — TLS v1.3 on top of TCP.
+    #
+    # Requires the socket's +tls_context+ to be set to an
+    # +OpenSSL::SSL::SSLContext+ before bind or connect.
+    #
+    module TLS
+      TLS_PREFIX = "tls+tcp://"
+
+      class << self
+        # Binds a TLS server.
+        #
+        # @param endpoint [String] e.g. "tls+tcp://127.0.0.1:5555" or "tls+tcp://*:0"
+        # @param engine [Engine]
+        # @return [Listener]
+        #
+        def bind(endpoint, engine)
+          ctx = require_context!(engine)
+          host, port = parse_endpoint(endpoint)
+          host = "0.0.0.0" if host == "*"
+
+          addrs = Addrinfo.getaddrinfo(host, port, nil, :STREAM, nil, ::Socket::AI_PASSIVE)
+          raise ::Socket::ResolutionError, "no addresses for #{host}" if addrs.empty?
+
+          servers     = []
+          actual_port = nil
+
+          addrs.each do |addr|
+            server = TCPServer.new(addr.ip_address, actual_port || port)
+            actual_port ||= server.local_address.ip_port
+            servers << server
+          end
+
+          host_part = host.include?(":") ? "[#{host}]" : host
+          resolved  = "#{TLS_PREFIX}#{host_part}:#{actual_port}"
+          Listener.new(resolved, servers, actual_port, ctx)
+        end
+
+        # Connects to a TLS endpoint.
+        #
+        # @param endpoint [String] e.g. "tls+tcp://127.0.0.1:5555"
+        # @param engine [Engine]
+        # @return [void]
+        #
+        def connect(endpoint, engine)
+          ctx = require_context!(engine)
+          host, port = parse_endpoint(endpoint)
+          tcp_sock   = TCPSocket.new(host, port)
+
+          ssl            = OpenSSL::SSL::SSLSocket.new(tcp_sock, ctx)
+          ssl.sync_close = true
+          ssl.hostname   = host
+          ssl.connect
+
+          engine.handle_connected(IO::Stream::Buffered.wrap(ssl), endpoint: endpoint)
+        rescue
+          tcp_sock&.close unless ssl&.sync_close
+          raise
+        end
+
+        private
+
+        # Validates and freezes the TLS context from engine options.
+        #
+        # The context SHOULD have min_version set to TLS1_3_VERSION.
+        # We cannot validate this because SSLContext#min_version is
+        # write-only in Ruby's OpenSSL binding.
+        #
+        # @return [OpenSSL::SSL::SSLContext]
+        # @raise [ArgumentError] if no context is set
+        #
+        def require_context!(engine)
+          ctx = engine.options.tls_context
+          raise ArgumentError, "tls_context must be set for tls+tcp:// endpoints" unless ctx
+          ctx.freeze unless ctx.frozen?
+          ctx
+        end
+
+        # Parses a tls+tcp:// endpoint URI into host and port.
+        #
+        # @param endpoint [String]
+        # @return [Array(String, Integer)]
+        #
+        def parse_endpoint(endpoint)
+          uri = URI.parse("http://#{endpoint.delete_prefix(TLS_PREFIX)}")
+          [uri.hostname, uri.port]
+        end
+      end
+
+      # A bound TLS listener.
+      #
+      class Listener
+        # @return [String] resolved endpoint with actual port
+        attr_reader :endpoint
+
+        # @return [Integer] bound port
+        attr_reader :port
+
+        # @return [Array<TCPServer>] bound server sockets
+        attr_reader :servers
+
+        # @return [OpenSSL::SSL::SSLContext]
+        attr_reader :ssl_context
+
+
+        # @param endpoint [String] resolved endpoint URI
+        # @param servers [Array<TCPServer>]
+        # @param port [Integer] bound port number
+        # @param ssl_context [OpenSSL::SSL::SSLContext]
+        #
+        def initialize(endpoint, servers, port, ssl_context)
+          @endpoint    = endpoint
+          @servers     = servers
+          @port        = port
+          @ssl_context = ssl_context
+          @tasks       = []
+        end
+
+
+        # Registers accept loop tasks owned by the engine.
+        #
+        # @param tasks [Array<Async::Task>]
+        #
+        def accept_tasks=(tasks)
+          @tasks = tasks
+        end
+
+
+        # Stops the listener.
+        #
+        def stop
+          @tasks.each(&:stop)
+          @servers.each { |s| s.close rescue nil }
+        end
+      end
+    end
+  end
+end

data/lib/omq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OMQ
-  VERSION = "0.9.0"
+  VERSION = "0.11.0"
 end

data/lib/omq/writable.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "timeout"
+
+module OMQ
+  # Pure Ruby Writable mixin. Enqueues messages to the engine's send path.
+  #
+  module Writable
+    include QueueWritable
+    # Sends a message.
+    #
+    # @param message [String, Array<String>] message parts
+    # @return [self]
+    # @raise [IO::TimeoutError] if write_timeout exceeded
+    #
+    def send(message)
+      parts = freeze_message(message)
+      Reactor.run { with_timeout(@options.write_timeout) { @engine.enqueue_send(parts) } }
+      self
+    end
+
+    # Sends a message (chainable).
+    #
+    # @param message [String, Array<String>]
+    # @return [self]
+    #
+    def <<(message)
+      send(message)
+    end
+
+    private
+
+    # Converts a message into a frozen array of frozen binary strings.
+    #
+    # @param message [String, Array<String>]
+    # @return [Array<String>] frozen array of frozen binary strings
+    #
+    def freeze_message(message)
+      parts = message.is_a?(Array) ? message : [message]
+      raise ArgumentError, "message has no parts" if parts.empty?
+      if parts.frozen?
+        parts = parts.map { |p| frozen_binary(p) }
+      else
+        parts.map! { |p| frozen_binary(p) }
+      end
+      parts.freeze
+    end
+
+    def frozen_binary(str)
+      s = str.to_str
+      return s if s.frozen? && s.encoding == Encoding::BINARY
+      s.b.freeze
+    end
+
+    public
+
+    # Waits until the socket is writable.
+    #
+    # @param timeout [Numeric, nil] timeout in seconds
+    # @return [true]
+    #
+    def wait_writable(timeout = @options.write_timeout)
+      true
+    end
+  end
+end

data/lib/omq.rb

@@ -5,9 +5,10 @@
 # Socket types live directly under OMQ:: for a clean API:
 #   OMQ::PUSH, OMQ::PULL, OMQ::PUB, OMQ::SUB, etc.
 #
-# Protocol internals live under OMQ::ZMTP:: and are not part
-# of the public API.
-#
+
+require "protocol/zmtp"
+require "io/stream"
+require "openssl"
 
 require_relative "omq/version"
 
@@ -16,9 +17,68 @@ module OMQ
   # The socket is no longer usable; the original error is available via #cause.
   #
   class SocketDeadError < RuntimeError; end
+
+  # Errors raised when a peer disconnects or resets the connection.
+  CONNECTION_LOST = [
+    EOFError,
+    IOError,
+    Errno::EPIPE,
+    Errno::ECONNRESET,
+    Errno::ECONNABORTED,
+    Errno::ENOTCONN,
+    IO::Stream::ConnectionResetError,
+    OpenSSL::SSL::SSLError,
+  ].freeze
+
+  # Errors raised when a peer cannot be reached.
+  CONNECTION_FAILED = [
+    Errno::ECONNREFUSED,
+    Errno::ENOENT,
+    Errno::ETIMEDOUT,
+    Errno::EHOSTUNREACH,
+    Errno::ENETUNREACH,
+    Socket::ResolutionError,
+  ].freeze
 end
 
-require_relative "omq/zmtp"
+# Transport
+require_relative "omq/transport/inproc"
+require_relative "omq/transport/tcp"
+require_relative "omq/transport/tls"
+require_relative "omq/transport/ipc"
+
+# Core
+require_relative "omq/reactor"
+require_relative "omq/options"
+require_relative "omq/routing"
+require_relative "omq/routing/round_robin"
+require_relative "omq/routing/fan_out"
+require_relative "omq/routing/pair"
+require_relative "omq/routing/req"
+require_relative "omq/routing/rep"
+require_relative "omq/routing/dealer"
+require_relative "omq/routing/router"
+require_relative "omq/routing/pub"
+require_relative "omq/routing/sub"
+require_relative "omq/routing/xpub"
+require_relative "omq/routing/xsub"
+require_relative "omq/routing/push"
+require_relative "omq/routing/pull"
+require_relative "omq/routing/scatter"
+require_relative "omq/routing/gather"
+require_relative "omq/routing/channel"
+require_relative "omq/routing/client"
+require_relative "omq/routing/server"
+require_relative "omq/routing/radio"
+require_relative "omq/routing/dish"
+require_relative "omq/routing/peer"
+require_relative "omq/single_frame"
+require_relative "omq/engine"
+require_relative "omq/queue_interface"
+require_relative "omq/readable"
+require_relative "omq/writable"
+
+# Socket types
 require_relative "omq/socket"
 require_relative "omq/req_rep"
 require_relative "omq/router_dealer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Patrik Wenger
@@ -67,48 +67,49 @@ files:
 - lib/omq.rb
 - lib/omq/channel.rb
 - lib/omq/client_server.rb
+- lib/omq/engine.rb
+- lib/omq/options.rb
 - lib/omq/pair.rb
 - lib/omq/peer.rb
 - lib/omq/pub_sub.rb
 - lib/omq/push_pull.rb
+- lib/omq/queue_interface.rb
 - lib/omq/radio_dish.rb
+- lib/omq/reactor.rb
+- lib/omq/readable.rb
 - lib/omq/req_rep.rb
 - lib/omq/router_dealer.rb
+- lib/omq/routing.rb
+- lib/omq/routing/channel.rb
+- lib/omq/routing/client.rb
+- lib/omq/routing/dealer.rb
+- lib/omq/routing/dish.rb
+- lib/omq/routing/fan_out.rb
+- lib/omq/routing/gather.rb
+- lib/omq/routing/pair.rb
+- lib/omq/routing/peer.rb
+- lib/omq/routing/pub.rb
+- lib/omq/routing/pull.rb
+- lib/omq/routing/push.rb
+- lib/omq/routing/radio.rb
+- lib/omq/routing/rep.rb
+- lib/omq/routing/req.rb
+- lib/omq/routing/round_robin.rb
+- lib/omq/routing/router.rb
+- lib/omq/routing/scatter.rb
+- lib/omq/routing/server.rb
+- lib/omq/routing/sub.rb
+- lib/omq/routing/xpub.rb
+- lib/omq/routing/xsub.rb
 - lib/omq/scatter_gather.rb
+- lib/omq/single_frame.rb
 - lib/omq/socket.rb
+- lib/omq/transport/inproc.rb
+- lib/omq/transport/ipc.rb
+- lib/omq/transport/tcp.rb
+- lib/omq/transport/tls.rb
 - lib/omq/version.rb
-- lib/omq/zmtp.rb
-- lib/omq/zmtp/engine.rb
-- lib/omq/zmtp/options.rb
-- lib/omq/zmtp/reactor.rb
-- lib/omq/zmtp/readable.rb
-- lib/omq/zmtp/routing.rb
-- lib/omq/zmtp/routing/channel.rb
-- lib/omq/zmtp/routing/client.rb
-- lib/omq/zmtp/routing/dealer.rb
-- lib/omq/zmtp/routing/dish.rb
-- lib/omq/zmtp/routing/fan_out.rb
-- lib/omq/zmtp/routing/gather.rb
-- lib/omq/zmtp/routing/pair.rb
-- lib/omq/zmtp/routing/peer.rb
-- lib/omq/zmtp/routing/pub.rb
-- lib/omq/zmtp/routing/pull.rb
-- lib/omq/zmtp/routing/push.rb
-- lib/omq/zmtp/routing/radio.rb
-- lib/omq/zmtp/routing/rep.rb
-- lib/omq/zmtp/routing/req.rb
-- lib/omq/zmtp/routing/round_robin.rb
-- lib/omq/zmtp/routing/router.rb
-- lib/omq/zmtp/routing/scatter.rb
-- lib/omq/zmtp/routing/server.rb
-- lib/omq/zmtp/routing/sub.rb
-- lib/omq/zmtp/routing/xpub.rb
-- lib/omq/zmtp/routing/xsub.rb
-- lib/omq/zmtp/single_frame.rb
-- lib/omq/zmtp/transport/inproc.rb
-- lib/omq/zmtp/transport/ipc.rb
-- lib/omq/zmtp/transport/tcp.rb
-- lib/omq/zmtp/writable.rb
+- lib/omq/writable.rb
 homepage: https://github.com/zeromq/omq
 licenses:
 - ISC