zeroconf 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f58175fb721fb08fa2a5abb36b0b2165d9b38592bb7ff66bd3a3f4c303ed2f9
-  data.tar.gz: afd32fb72b31c90e84aaea02db2f81e603b872f8f81c1f6f147d15c13ce3713e
+  metadata.gz: 7e5fe766c828fdaf41bdacf9ecce12d863c4a636f7c2292ec3ca8aef89413950
+  data.tar.gz: 51786741d2dbc2dffb92a1b4ec25b31a994db81aa1d099dc6f530dded84964e7
 SHA512:
-  metadata.gz: 2e4faed4b18775a5fec2faf0b4064556356699b049c6ca1d6d2d4c03b685cd8702e3ba8591d098799d3ec6ee54efdb9aee1f0e5ea68578b92c1df7ea8fbbba7b
-  data.tar.gz: 210e338f7d21bbe98df962e4785e0716e2364e538fb44c1029217465fca0fe6ea2f414986d4bb7ce0f3588efd5bfbbd8caeb140ef5f1028b5e75b58648de57e6
+  metadata.gz: 89974e69dce75b540f73e70313944bea011fcfe00bd8519af0cba02cb27e823600325d117efabe2febaac05d8d782edf2ecd5014143e35bfa8a31f27019314bc
+  data.tar.gz: e4f99e2f61956d457d2ae10fdb4969e682f86cb959a9bd7f4937c389a160c07c4a8e9f5f4ca4d5dab925390ed3ac80909b3603698c80629b70e83072ef51ea62

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/Rakefile

@@ -1,9 +1,11 @@
+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']
-  t.verbose = true
   t.warning = true
 end

data/lib/zeroconf/service.rb

@@ -7,9 +7,10 @@ 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, instance_name: nil, 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
 
@@ -19,13 +20,14 @@ module ZeroConf
 
       instance_name ||= @hostname
       if instance_name.include?(".")
-        raise ArgumentError, "instance_name must not contain dots (is #{instance_name.inspect})" 
+        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
@@ -61,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
 
@@ -93,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
 
@@ -174,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
@@ -313,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

@@ -23,18 +23,22 @@ module ZeroConf
     ::Resolv::DNS::Resource::ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
   end
 
+  # ZeroConf::A and ZeroConf::SRV are referenced by name when constructing
+  # outgoing queries (see ZeroConf::Resolver). They share the numeric
+  # ClassValue (0x8001) with the MDNS::Announce::IN equivalents below, so
+  # only one of the two should populate Resolv's ClassHash to avoid
+  # "already initialized constant" warnings. The MDNS::Announce::IN side
+  # owns the registration.
   class A < Resolv::DNS::Resource::IN::A
     MDNS_UNICAST_RESPONSE = 0x8000
 
     ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
-    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
   end
 
   class SRV < Resolv::DNS::Resource::IN::SRV
     MDNS_UNICAST_RESPONSE = 0x8000
 
     ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
-    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
   end
 
   module MDNS

data/lib/zeroconf/version.rb

@@ -1,3 +1,3 @@
 module ZeroConf
-  VERSION = "1.2.0"
+  VERSION = "1.3.1"
 end

data/lib/zeroconf.rb

@@ -46,7 +46,7 @@ module ZeroConf
       port = nil
       ipv4 = []
       ipv6 = []
-      r.additional.each { |name, ttl, data|
+      (r.answer + r.additional).each { |name, ttl, data|
         case data
         when Resolv::DNS::Resource::IN::SRV
           host = data.target.to_s

data/test/client_test.rb

@@ -1,6 +1,45 @@
 require "helper"
 
 module ZeroConf
+  # Mimics responders like Nanoleaf which place SRV in the answer section of
+  # the PTR response instead of in the additional section. See
+  # https://github.com/tenderlove/zeroconf/issues/10
+  class NanoleafService < Service
+    private
+
+    def service_unicast_answer
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      # SRV goes in ANSWER (Nanoleaf-style), not additional
+      msg.add_answer 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 service, 10,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
+
+      msg.add_question service, PTR
+
+      msg
+    end
+  end
+
   class ClientTest < Test
     attr_reader :iface
 
@@ -9,6 +48,34 @@ module ZeroConf
       @iface = ZeroConf.interfaces.find_all { |x| x.addr.ipv4? }.first
     end
 
+    # Regression test for https://github.com/tenderlove/zeroconf/issues/10
+    # If a responder places SRV in the answer section (rather than additional),
+    # find_addrinfos must still return a usable [host, Addrinfo] tuple instead
+    # of crashing with "no implicit conversion from nil to integer".
+    def test_find_addrinfos_with_srv_in_answer
+      latch = Queue.new
+      s = NanoleafService.new SERVICE + ".",
+        42424,
+        HOST_NAME,
+        service_interfaces: [iface],
+        text: ["test=1", "other=value"],
+        started_callback: -> { latch << :start }
+      runner = Thread.new { s.start }
+      latch.pop
+
+      addrinfos = ZeroConf.find_addrinfos(SERVICE, timeout: 1)
+
+      s.stop
+      runner.join
+
+      ours = addrinfos.find { |host, _| host == "#{HOST_NAME}.local" }
+      assert ours, "expected to find #{HOST_NAME}.local in #{addrinfos.inspect}"
+      host, addr = ours
+      assert_equal "#{HOST_NAME}.local", host
+      assert_equal 42424, addr.ip_port
+      assert_equal iface.addr.ip_address, addr.ip_address
+    end
+
     def test_resolve
       latch = Queue.new
       s = make_server iface, "coolhostname", started_callback: -> { latch << :start }

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

@@ -440,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeroconf
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Aaron Patterson
@@ -13,16 +13,16 @@ dependencies:
   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
@@ -58,6 +58,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.0.dev
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Multicast DNS client and server
 test_files: