zeroconf 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a6933171abe1ab052bf99d2bdb6efa5bd0378f536859e0cf812f2dd68b23461
-  data.tar.gz: 9c016607692b33ed3a516a872aa80117a119f3ac138a997a19a845684914890c
+  metadata.gz: 1b9ec7f1320fa0807e2cdb89addcc9b6796745c9248ac0463a72877d908b74f4
+  data.tar.gz: 3be32a8bdabfc923576ce8ed0b8c9dbf430141aae8be1eaf9bc7898b1f425109
 SHA512:
-  metadata.gz: bdc315b09c4ada48b56f6f102c24b5c0a51740c6163ccb3b9a96e67c7f262a35e95126c950bb1efd394b4cbea06ec0b29e1ae3e55bd02bbd63b42b4159faa06f
-  data.tar.gz: 663cc13801926e626a61aea7aebe75d51e92e07ab5133723c53be48259dc19bec30c42cbe10348c3a6881028fac9124afb8c50a697203736f8e394060b479b99
+  metadata.gz: b3eedb494ee9507f0e4d541b05f2627fb94d9b63b90d1d1a27f303a901b02fa4c5640719857f35927fd922b511960e753b7e530dc40e30cccf106b0e2cc10168
+  data.tar.gz: ef7526948bbe2a34ae9a850c48ba0d12760ad4acb846c33f808338c277d184d9056e8681246e7bbb6154ce1cd31398feb9a4336c4dc6835bc36a63c489642c6a

data/.github/workflows/ci.yml

@@ -4,12 +4,12 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu, macos]
+        os: [ubuntu-latest, macos-14]
         ruby: [ head, 3.2  ]
 
     steps:

data/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: Publish gem to rubygems.org
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'tenderlove/zeroconf'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/zeroconf
+
+    permissions:
+      contents: write
+      id-token: write
+
+    strategy:
+      matrix:
+        ruby: ["ruby"]
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@v2
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@v1
+
+      - name: Create GitHub release
+        run: |
+          tag_name="$(git describe --tags --abbrev=0)"
+          gh release create "${tag_name}" --verify-tag --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -108,12 +108,14 @@ to run an HTTP server and simultaneously advertise the server:
 
 ```ruby
 require "zeroconf"
-require 'webrick'
+require "webrick"
 
 port = 8080
 host = "test-hostname"
 
-Thread.new { ZeroConf.service "_http._tcp.local.", port, host }
+Ractor.new(port, host) { |port, host|
+  ZeroConf.service "_http._tcp.local.", port, host
+}
 
 server = WEBrick::HTTPServer.new(:Port => port,
                                  :SSLEnable => false,

data/Rakefile

@@ -1,6 +1,9 @@
+require "bundler"
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+Bundler::GemHelper.install_tasks
+
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/*_test.rb']

data/lib/zeroconf/service.rb

@@ -7,18 +7,27 @@ module ZeroConf
     include Utils
 
     attr_reader :service, :service_port, :hostname, :service_interfaces,
-      :service_name, :qualified_host, :text, :abort_on_malformed_requests
+      :service_name, :qualified_host, :text, :abort_on_malformed_requests,
+      :subtypes
 
-    def initialize service, service_port, hostname = Socket.gethostname, service_interfaces: ZeroConf.service_interfaces, text: [""], abort_on_malformed_requests: false, started_callback: nil
+    def initialize service, service_port, hostname = Socket.gethostname, service_interfaces: ZeroConf.service_interfaces, instance_name: nil, text: [""], subtypes: [], abort_on_malformed_requests: false, started_callback: nil
       @service = service
       @service_port = service_port
-      @hostname = hostname
+
+      @hostname = strip_dot_local(hostname) # We re-add .local anyway, later on
       @service_interfaces = service_interfaces
       @abort_on_malformed_requests = abort_on_malformed_requests
-      @service_name = "#{hostname}.#{service}"
-      @qualified_host = "#{hostname}.local."
+
+      instance_name ||= @hostname
+      if instance_name.include?(".")
+        raise ArgumentError, "instance_name must not contain dots (is #{instance_name.inspect})"
+      end
+
+      @service_name = "#{instance_name}.#{@service}"
+      @qualified_host = "#{@hostname}.local."
       @started_callback = started_callback
       @text = text
+      @subtypes = subtypes.map { |st| "#{st}._sub.#{@service}" }
       @started = false
       @rd, @wr = IO.pipe
     end
@@ -54,6 +63,11 @@ module ZeroConf
         60,
         Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
 
+      subtypes.each do |st|
+        msg.add_answer st, 60,
+          Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
+      end
+
       msg
     end
 
@@ -86,6 +100,11 @@ module ZeroConf
         0,
         Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
 
+      subtypes.each do |st|
+        msg.add_answer st, 0,
+          Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
+      end
+
       msg
     end
 
@@ -167,6 +186,12 @@ module ZeroConf
               else
                 name_answer_multicast
               end
+            when *subtypes
+              if unicast
+                subtype_unicast_answer qn
+              else
+                subtype_multicast_answer qn
+              end
             else
               #p [:QUERY2, type, type::ClassValue, name]
             end
@@ -306,6 +331,72 @@ module ZeroConf
       msg
     end
 
+    def subtype_multicast_answer subtype
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      msg.add_additional service_name, 60, Resolv::DNS::Resource::IN::SRV.new(0, 0, service_port, qualified_host)
+
+      service_interfaces.each do |iface|
+        if iface.addr.ipv4?
+          msg.add_additional qualified_host,
+            60,
+            Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+        else
+          msg.add_additional qualified_host,
+            60,
+            Resolv::DNS::Resource::IN::AAAA.new(iface.addr.ip_address)
+        end
+      end
+
+      if @text
+        msg.add_additional service_name,
+          60,
+          Resolv::DNS::Resource::IN::TXT.new(*@text)
+      end
+
+      msg.add_answer subtype,
+        60,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
+
+      msg
+    end
+
+    def subtype_unicast_answer subtype
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      msg.add_additional service_name, 10, Resolv::DNS::Resource::IN::SRV.new(0, 0, service_port, qualified_host)
+
+      service_interfaces.each do |iface|
+        if iface.addr.ipv4?
+          msg.add_additional qualified_host,
+            10,
+            Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+        else
+          msg.add_additional qualified_host,
+            10,
+            Resolv::DNS::Resource::IN::AAAA.new(iface.addr.ip_address)
+        end
+      end
+
+      if @text
+        msg.add_additional service_name,
+          10,
+          Resolv::DNS::Resource::IN::TXT.new(*@text)
+      end
+
+      msg.add_answer subtype,
+        10,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
+
+      msg.add_question subtype, PTR
+
+      msg
+    end
+
     def service_instance_multicast_answer
       msg = Resolv::DNS::Message.new(0)
       msg.qr = 1

data/lib/zeroconf/utils.rb

@@ -69,8 +69,8 @@ module ZeroConf
       sock
     end
 
-    BROADCAST_V4 = Addrinfo.new Socket.sockaddr_in(Resolv::MDNS::Port, Resolv::MDNS::AddressV4)
-    BROADCAST_V6 = Addrinfo.new Socket.sockaddr_in(Resolv::MDNS::Port, Resolv::MDNS::AddressV6)
+    BROADCAST_V4 = Addrinfo.new(Socket.sockaddr_in(Resolv::MDNS::Port, Resolv::MDNS::AddressV4)).freeze
+    BROADCAST_V6 = Addrinfo.new(Socket.sockaddr_in(Resolv::MDNS::Port, Resolv::MDNS::AddressV6)).freeze
 
     def multicast_send sock, query
       dest = if sock.local_address.ipv4?
@@ -94,6 +94,10 @@ module ZeroConf
       sock.send(data, 0, Addrinfo.new(to))
     end
 
+    def strip_dot_local(from_string)
+      from_string.to_s.gsub(/\.local\.?$/, "")
+    end
+
     def open_ipv6 saddr, port
       sock = UDPSocket.new Socket::AF_INET6
       sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)

data/lib/zeroconf/version.rb

@@ -1,3 +1,3 @@
 module ZeroConf
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/test/helper.rb

@@ -47,6 +47,15 @@ module ZeroConf
         **opts
     end
 
+    def make_subtype_server iface, host = HOST_NAME, **opts
+      Service.new SERVICE + ".",
+        42424,
+        host,
+        service_interfaces: [iface], text: ["test=1", "other=value"],
+        subtypes: ["_universal"],
+        **opts
+    end
+
     def make_listener rd, q, started_callback: nil
       Thread.new do
         sock = open_ipv4 Addrinfo.new(Socket.sockaddr_in(Resolv::MDNS::Port, Socket::INADDR_ANY)), Resolv::MDNS::Port

data/test/service_test.rb

@@ -26,6 +26,37 @@ module ZeroConf
       assert_equal [""], s.text
     end
 
+    def test_raises_when_creating_a_service_with_dot_in_the_name
+      assert_raises ArgumentError do
+        Service.new "_test-mdns._tcp.local.", 42424,
+          "some.subdomain.workstation"
+      end
+
+      assert_raises ArgumentError do
+        Service.new "_test-mdns._tcp.local.", 42424,
+          "ruby-mdns", instance_name: "ruby.test"
+      end
+    end
+
+    def test_sets_correct_service_name_from_instance_name
+      s = Service.new "_test-mdns._tcp.local.", 42424,
+        "my-rb-service", instance_name: "My RB service"
+      assert_equal "my-rb-service.local.", s.qualified_host
+      assert_equal "My RB service._test-mdns._tcp.local.", s.service_name
+    end
+
+    def test_removes_dot_local_tld_from_passed_hostname
+      s = Service.new "_test-mdns._tcp.local.", 42424,
+        "ThisMac.local"
+      assert_equal "ThisMac.local.", s.qualified_host
+      assert_equal "ThisMac._test-mdns._tcp.local.", s.service_name
+
+      s = Service.new "_test-mdns._tcp.local.", 42424,
+        "ThisMac.local."
+      assert_equal "ThisMac.local.", s.qualified_host
+      assert_equal "ThisMac._test-mdns._tcp.local.", s.service_name
+    end
+
     def test_unicast_service_instance_answer
       latch = Queue.new
       s = make_server iface, started_callback: -> { latch << :start }
@@ -409,6 +440,132 @@ module ZeroConf
       assert_equal expected, res
     end
 
+    def test_subtypes_expanded
+      s = Service.new "_ipp._tcp.local.", 631, "printer",
+        service_interfaces: [iface],
+        subtypes: ["_universal", "_print"]
+
+      assert_equal ["_universal._sub._ipp._tcp.local.", "_print._sub._ipp._tcp.local."], s.subtypes
+    end
+
+    def test_subtypes_default_empty
+      s = make_server iface
+      assert_equal [], s.subtypes
+    end
+
+    def test_announcement_includes_subtype_ptrs
+      s = Service.new "_test-mdns._tcp.local.", 42424,
+        "tc-lan-adapter",
+        service_interfaces: [iface],
+        subtypes: ["_universal"]
+
+      ann = s.announcement
+      subtype_ptrs = ann.answer.select { |name, ttl, data|
+        name.to_s == "_universal._sub._test-mdns._tcp.local"
+      }
+
+      assert_equal 1, subtype_ptrs.length
+      assert_equal s.service_name, subtype_ptrs.first.last.name.to_s + "."
+    end
+
+    def test_disconnect_includes_subtype_ptrs
+      s = Service.new "_test-mdns._tcp.local.", 42424,
+        "tc-lan-adapter",
+        service_interfaces: [iface],
+        subtypes: ["_universal"]
+
+      msg = s.disconnect_msg
+      subtype_ptrs = msg.answer.select { |name, ttl, data|
+        name.to_s == "_universal._sub._test-mdns._tcp.local"
+      }
+
+      assert_equal 1, subtype_ptrs.length
+      assert_equal 0, subtype_ptrs.first[1] # TTL 0 for disconnect
+    end
+
+    def test_subtype_unicast_answer
+      latch = Queue.new
+      s = make_subtype_server iface, started_callback: -> { latch << :start }
+      runner = Thread.new { s.start }
+      latch.pop
+
+      subtype = "_universal._sub._test-mdns._tcp.local."
+      query = Resolv::DNS::Message.new 0
+      query.add_question subtype, PTR
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+      res = Resolv::DNS::Message.decode read_with_timeout(sock).first
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(0)
+      expected.qr = 1
+      expected.aa = 1
+
+      expected.add_additional s.service_name, 10, Resolv::DNS::Resource::IN::SRV.new(0, 0, s.service_port, s.qualified_host)
+
+      expected.add_additional s.qualified_host,
+        10,
+        Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+
+      expected.add_additional s.service_name,
+        10,
+        Resolv::DNS::Resource::IN::TXT.new(*s.text)
+
+      expected.add_answer subtype,
+        10,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service_name))
+
+      expected.add_question subtype, PTR
+
+      assert_equal expected, res
+    end
+
+    def test_subtype_multicast_answer
+      q = Thread::Queue.new
+      rd, wr = IO.pipe
+
+      latch = Queue.new
+      listen = make_listener rd, q, started_callback: -> { latch << :start }
+      s = make_subtype_server iface, started_callback: -> { latch << :start }
+      server = Thread.new { s.start }
+      latch.pop
+      latch.pop
+
+      subtype = "_universal._sub._test-mdns._tcp.local."
+      query = Resolv::DNS::Message.new 0
+      query.add_question subtype, Resolv::DNS::Resource::IN::PTR
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+
+      subtype_name = Resolv::DNS::Name.create subtype
+      service_name = Resolv::DNS::Name.create s.service_name
+
+      while res = q.pop
+        if res.answer.find { |name, ttl, data| name == subtype_name && data.name == service_name }
+          wr.write "x"
+          break
+        end
+      end
+
+      listen.join
+      s.stop
+      server.join
+
+      # Verify the response contains the subtype PTR
+      subtype_ptr = res.answer.find { |name, ttl, data|
+        name == subtype_name && data.name == service_name
+      }
+      assert subtype_ptr, "expected subtype PTR in answer"
+
+      # Verify it has SRV in additional
+      srv = res.additional.find { |_, _, data|
+        ZeroConf::MDNS::Announce::IN::SRV == data.class
+      }
+      assert srv, "expected SRV in additional"
+    end
+
     def test_raise_on_malformed_requests
       latch = Queue.new
       s = make_server iface, abort_on_malformed_requests: true, started_callback: -> { latch << :start }

data/zeroconf.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/tenderlove/zeroconf"
   s.license     = "Apache-2.0"
 
-  s.add_dependency("resolv", "~> 0.3.0")
+  s.add_dependency("resolv", ">= 0.7.1")
   s.add_development_dependency("rake", "~> 13.0")
   s.add_development_dependency("minitest", "~> 5.20")
 end

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: zeroconf
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Aaron Patterson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resolv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +58,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -80,7 +80,6 @@ homepage: https://github.com/tenderlove/zeroconf
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Multicast DNS client and server
 test_files: