toolmantim-zeroconf 0.0.2

data/samples/mdns.rb

@@ -0,0 +1,238 @@
+#!/usr/local/bin/ruby18 -w
+# Author: Sam Roberts <sroberts@uniserve.com>
+# Licence: this file is placed in the public domain
+
+$:.unshift(File.dirname($0))
+
+require 'getoptlong'
+
+$stdout.sync = true
+$stderr.sync = true
+
+=begin
+Apple's dns-sd options:
+
+  mdns -E                  (Enumerate recommended registration domains)
+  mdns -F                      (Enumerate recommended browsing domains)
+  mdns -B        <Type> <Domain>         (Browse for service instances)
+  mdns -L <Name> <Type> <Domain>           (Look up a service instance)
+  mdns -R <Name> <Type> <Domain> <Port> [<TXT>...] (Register a service)
+  mdns -P <Name> <Type> <Domain> <Port> <Host> <IP> [<TXT>...]  (Proxy)
+  mdns -Q <FQDN> <rrtype> <rrclass> (Generic query for any record type)
+=end
+
+@debug = false
+@log   = nil
+
+@recursive = false
+@domain = 'local'
+@type = nil
+@name = nil
+@port = nil
+@txt  = {}
+
+@cmd = nil
+
+
+# TODO - can I use introspection on class names to determine all supported
+# RR types in DNS::Resource::IN?
+
+HELP =<<EOF
+Usage: 
+  mdns [options] -B        <type> [domain]         (Browse for service instances)
+  mdns [options] -L <name> <type> [domain]           (Look up a service instance)
+  mdns [options] -R <name> <type> [domain] <port> [<TXT>...] (Register a service)
+  mdns [options] -Q <fqdn> [rrtype] [rrclass] (Generic query for any record type)
+
+Note: -Q is not yet implemented.
+
+For -B, -L, and -R, [domain] is optional and defaults to "local".
+
+For -Q, [rrtype] defaults to A, other values are TXT, PTR, SRV, CNAME, ...
+
+For -Q, [rrclass] defaults to 1 (IN).
+
+
+[<TXT>...] is optional for -R, it can be a series of key=value pairs.
+
+You can use long names --browse, --lookup, and --register instead of -B, -L,
+and -R.
+
+Options:
+  -m,--mdnssd   Attempt to use 'net/dns/mdns-sd', a pure-ruby DNS-SD resolver
+                library (this is the default).
+  -n,--dnssd    Attempt to use 'dnssd', the interface to the native ("-n")
+                DNS-SD resolver library APIs, "dns_sd.h" from Apple.
+  -d,--debug    Print debug messages to stderr.
+
+Examples:
+  mdns -B _http._tcp
+  mdns -L "My Music" _daap._tcp
+  mdns -R me _example._tcp local 4321 key=value key2=value2
+
+These work with the test modes of Apple's dns-sd utility:
+  mdns -L Test _testupdate._tcp     (for dns-sd -A, -U, -N)
+  mdns -L Test _testlargetxt._tcp   (for dns-sd -T)
+  mdns -L Test _testdualtxt._tcp    (for dns-sd -M)
+  mdns -L Test _testtxt._tcp        (for dns-sd -I)
+
+EOF
+
+opts = GetoptLong.new(
+  [ "--debug",    "-d",               GetoptLong::NO_ARGUMENT ],
+  [ "--help",     "-h",               GetoptLong::NO_ARGUMENT ],
+  [ "--dnssd",    "-n",               GetoptLong::NO_ARGUMENT ],
+  [ "--mdnssd",   "-m",               GetoptLong::NO_ARGUMENT ],
+
+  [ "--browse",    "-B",              GetoptLong::NO_ARGUMENT ],
+  [ "--lookup",    "-L",              GetoptLong::NO_ARGUMENT ],
+  [ "--register",  "-R",              GetoptLong::NO_ARGUMENT ]
+)
+
+opts.each do |opt, arg|
+  case opt
+  when "--debug"
+    require 'pp'
+    require 'logger'
+
+    @debug = true
+    @log = Logger.new(STDERR)
+    @log.level = Logger::DEBUG
+
+  when "--help"
+    print HELP
+    exit 0
+
+  when '--dnssd'
+    require 'dnssd'
+    require 'socket'
+
+  when "--browse"
+    @cmd = :browse
+    @type   = ARGV.shift
+    @domain = ARGV.shift || @domain
+
+  when "--lookup"
+    @cmd = :lookup
+    @name   = ARGV.shift
+    @type   = ARGV.shift
+    @domain = ARGV.shift || @domain
+
+    unless @name && @type
+      puts 'name and type required for -L'
+      exit 1
+    end
+
+  when "--register"
+    @cmd = :register
+    @name   = ARGV.shift
+    @type   = ARGV.shift
+    @port   = ARGV.shift
+    if @port.to_i == 0
+      @domain = @port
+      @port = ARGV.shift.to_i
+    else
+      @port = @port.to_i
+    end
+    ARGV.each do |kv|
+      kv.match(/([^=]+)=([^=]+)/)
+      @txt[$1] = $2
+    end
+    ARGV.replace([])
+  end
+end
+
+begin
+  DNSSD.class
+  puts "Using native DNSSD..."
+
+	Thread.abort_on_exception = true # So we notice exceptions in DNSSD threads.
+
+  module DNSSD
+    def self.namesplit(n)
+      n.scan(/(?:\\.|[^\.])+/)
+    end
+		# DNSSD > 0.6.0 uses class Reply which has these methods already
+    class ResolveReply
+      def domain
+        DNSSD.namesplit(fullname)[-1]
+      end
+      def type
+        DNSSD.namesplit(fullname)[1,2].join('.')
+      end
+      def name
+        DNSSD.namesplit(fullname)[0]
+      end
+    end
+  end
+rescue NameError
+  require 'net/dns/mdns-sd'
+  DNSSD = Net::DNS::MDNSSD
+  Net::DNS::MDNS::Responder.instance.log = @log if @log
+  puts "Using Net::DNS::MDNSSD..."
+end
+
+unless @cmd
+  print HELP
+  exit 1
+end
+
+case @cmd
+when :browse
+  STDERR.puts( "DNSSD.#{@cmd}(#{@type}, #{@domain}) =>" )  if @debug
+
+  fmt = "%-3.3s  %-8.8s   %-15.15s  %-20.20s\n"
+  printf fmt, "Ttl", "Domain", "Service Type", "Instance Name"
+
+  handle = DNSSD.browse(@type, @domain) do |reply|
+    begin
+      printf fmt, reply.flags.to_i, reply.domain, reply.type, reply.name
+    rescue
+      p $!
+    end
+  end
+
+  $stdin.gets
+  handle.stop
+
+
+when :lookup
+  STDERR.puts( "DNSSD.#{@cmd}(#{@name}, #{@type}, #{@domain}) =>" )  if @debug
+
+  fmt = "%-3.3s  %-8.8s   %-19.19s  %-20.20s %-20.20s %s\n"
+  printf fmt, "Ttl", "Domain", "Service Type", "Instance Name", "Location", "Text"
+
+  handle = DNSSD.resolve(@name, @type, @domain) do |reply|
+    begin
+      location = "#{reply.target}:#{reply.port}"
+      text = reply.text_record.to_a.map { |kv| "#{kv[0]}=#{kv[1].inspect}" }.join(', ')
+      printf fmt, reply.flags.to_i, reply.domain, reply.type, reply.name, location, text
+    rescue
+      p $!
+    end
+  end
+
+  $stdin.gets
+  handle.stop
+
+when :register
+  STDERR.puts( "DNSSD.#{@cmd}(#{@name}, #{@type}, #{@domain}, #{@port}, #{@txt.inspect}) =>" )  if @debug
+
+  fmt = "%-3.3s  %-8.8s   %-19.19s  %-20.20s %-20.20s %s\n"
+  printf fmt, "Ttl", "Domain", "Service Type", "Instance Name", "Location", "Text"
+
+  handle = DNSSD.register(@name, @type, @domain, @port, @txt) do |notice|
+    begin
+      location = "#{Socket.gethostname}:#{@port}"
+      text = @txt.to_a.map { |kv| "#{kv[0]}=#{kv[1].inspect}" }.join(', ')
+      printf fmt, 'N/A', notice.domain, notice.type, notice.name, location, text
+    rescue
+      p $!
+    end
+  end
+
+  $stdin.gets
+  handle.stop
+
+end
+

data/samples/test_dns.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/ruby -w
+
+$:.unshift File.dirname($0)
+
+require 'net/dns/resolvx.rb'
+require 'test/unit'
+
+require 'pp'
+
+Name = Resolv::DNS::Name
+
+class TestDns < Test::Unit::TestCase
+
+  def test_name_what_I_think_are_odd_behaviours
+    # Why can't test against strings?
+    assert_equal(false, Name.create("example.CoM") ==   "example.com")
+    assert_equal(false, Name.create("example.CoM").eql?("example.com"))
+
+    # Why does making it absolute mean they aren't equal?
+    assert_equal(false, Name.create("example.CoM").eql?(Name.create("example.com.")))
+    assert_equal(false, Name.create("example.CoM") ==   Name.create("example.com."))
+  end
+
+  def test_name_CoMparisons
+
+    assert_equal(true,  Name.create("example.CoM").eql?(Name.create("example.com")))
+    assert_equal(true,  Name.create("example.CoM") ==   Name.create("example.com"))
+
+    assert_equal(true,  Name.create("example.CoM").equal?("example.com."))
+    assert_equal(true,  Name.create("example.CoM").equal?("example.com"))
+
+    assert_equal(true,  Name.create("www.example.CoM") <   "example.com")
+    assert_equal(true,  Name.create("www.example.CoM") <=  "example.com")
+    assert_equal(-1,    Name.create("www.example.CoM") <=> "example.com")
+    assert_equal(false, Name.create("www.example.CoM") >=  "example.com")
+    assert_equal(false, Name.create("www.example.CoM") >   "example.com")
+
+    assert_equal(false, Name.create("example.CoM") <   "example.com")
+    assert_equal(true,  Name.create("example.CoM") <=  "example.com")
+    assert_equal(0,     Name.create("example.CoM") <=> "example.com")
+    assert_equal(true,  Name.create("example.CoM") >=  "example.com")
+    assert_equal(false, Name.create("example.CoM") >   "example.com")
+
+    assert_equal(false, Name.create("CoM") <   "example.com")
+    assert_equal(false, Name.create("CoM") <=  "example.com")
+    assert_equal(+1,    Name.create("CoM") <=> "example.com")
+    assert_equal(true,  Name.create("CoM") >=  "example.com")
+    assert_equal(true,  Name.create("CoM") >   "example.com")
+
+    assert_equal(nil,   Name.create("bar.CoM") <   "example.com")
+    assert_equal(nil,   Name.create("bar.CoM") <=  "example.com")
+    assert_equal(nil,   Name.create("bar.CoM") <=> "example.com")
+    assert_equal(nil,   Name.create("bar.CoM") >=  "example.com")
+    assert_equal(nil,   Name.create("bar.CoM") >   "example.com")
+
+    assert_equal(nil,   Name.create("net.") <   "com")
+    assert_equal(nil,   Name.create("net.") <=  "com")
+    assert_equal(nil,   Name.create("net.") <=> "com")
+    assert_equal(nil,   Name.create("net.") >=  "com")
+    assert_equal(nil,   Name.create("net.") >   "com")
+
+  end
+
+  def test_txt_with_0_strs
+    # Packet collected from the wild, it is non-conformant with DNS
+    # specification, TXT record has zero strings, but should have 1 or more.
+    d = "\000\000\204\000\000\000\000\005\000\000\000\000\002me\005local\000\000\001\200\001\000\000\000\360\000\004\300\250\003\003\005proxy\010_example\004_tcp\300\017\000!\200\001\000\000\000\360\000\010\000\000\000\000'\017\300\f\300$\000\020\200\001\000\000\000\360\000\000\t_services\a_dns-sd\004_udp\300\017\000\f\000\001\000\000\034 \000\002\300*\300*\000\f\000\001\000\000\034 \000\002\300$"
+
+    m =  Resolv::DNS::Message.decode( d )
+
+    assert_equal('',    m.answer[2][2].data)
+    assert_equal([''],  m.answer[2][2].strings)
+  end
+
+  def txt_codec(*args)
+    m = Resolv::DNS::Message.new
+    m.add_answer('example.local', 0, Resolv::DNS::Resource::IN::TXT.new(*args))
+#   pp m
+    m = Resolv::DNS::Message.decode(m.encode)
+    txt = m.answer[0][2]
+#   pp txt
+    txt
+  end
+
+  def test_txt_with_large_str
+    # short or no strings
+    txt = txt_codec()
+    assert_equal('',   txt.data)
+    assert_equal([''], txt.strings)
+
+    txt = txt_codec('')
+    assert_equal('',   txt.data)
+    assert_equal([''], txt.strings)
+    
+    txt = txt_codec('s')
+    assert_equal('s',   txt.data)
+    assert_equal(['s'], txt.strings)
+    
+    txt = txt_codec('s', 'a', 'm')
+    assert_equal('sam',           txt.data)
+    assert_equal(['s', 'a', 'm'], txt.strings)
+
+    s = '0' * 255
+
+    # long strings
+    txt = txt_codec(s)
+    assert_equal(s,   txt.data)
+    assert_equal([s], txt.strings)
+
+    # long strings
+    f = s + 'a'
+    txt = txt_codec(f)
+    assert_equal(f,   txt.data)
+    assert_equal([s, 'a'], txt.strings)
+
+    f = s + s
+    txt = txt_codec(f)
+    assert_equal(f,   txt.data)
+    assert_equal([s, s], txt.strings)
+
+    assert_raise(ArgumentError) { txt_codec(f, 'a') }
+    assert_raise(ArgumentError) { txt_codec('a', f) }
+
+  end
+
+
+end
+

data/samples/v1demo.rb

@@ -0,0 +1,167 @@
+#!/usr/local/bin/ruby18 -w
+#
+# Example code to use the multicast library
+# (c) 2005 Ben Giddings
+# License: Ruby's License
+
+# Include local dir
+$: << File.dirname($0)
+
+require 'net/dns/resolv-mdns'
+require 'pp'
+
+# default to browsing
+operation = ARGV[0] || 'browse'
+
+resolver = Resolv::MDNS.new
+resolver.lazy_initialize
+
+def usage
+  $stderr.puts <<-EOF
+Usage: #{$0} [browse|discover|resolve|lookup] [service_str]
+
+Use "browse" to find names offering the service requested.
+
+Examples:
+  zsh% #{$0} browse
+  Searching for _http._tcp.local services
+  Matching entries in _http._tcp.local
+  Cool Webserver
+
+  zsh% #{$0} browse http
+  Searching for _http._tcp.local services
+  Matching entries in _http._tcp.local
+  Cool Webserver
+
+  zsh% #{$0} browse _http._tcp.local
+  Searching for _http._tcp.local services
+  Matching entries in _http._tcp.local
+  Cool Webserver
+
+  zsh% #{$0} browse _telnet._tcp.local
+  Searching for _telnet._tcp.local services
+  Matching entries in _telnet._tcp.local
+  Embedded Device (MAC addr: 00:01:02:03:04:05)
+
+By default 'browse' looks for _http._tcp.local services/
+If the only parameter supplied is a protocol, it looks for 
+local tcp services of that protocol
+
+Use "resolve" to look up the dns name, port and ip address of a device
+
+  zsh% #{$0} resolve 'Cool Webserver'
+  Searching for Cool Webserver._http._tcp.local instance
+  Cool Webserver._http._tcp.local is
+  coolweb.local:80 at IP 192.168.0.12
+
+  zsh% #{$0} resolve 'Cool Webserver._http._tcp.local'
+  Searching for Cool Webserver._http._tcp.local instance
+  Cool Webserver._http._tcp.local is
+  coolweb.local:80 at IP 192.168.0.12
+
+  zsh% #{$0} resolve 'Embedded Device (MAC addr: 00:01:02:03:04:05)._telnet._tcp.local'
+  Searching for Embedded Device (MAC addr: 00:01:02:03:04:05)._telnet._tcp.local instance
+  Embedded Device (MAC addr: 00:01:02:03:04:05)._telnet._tcp.local is
+  emb000102030405.local:23 at IP 192.168.0.93
+
+By default 'resolve' will append _http._tcp.local if it is missing
+
+  EOF
+end
+
+case (operation.downcase)
+when 'browse', 'discover'
+  #
+  # To browse / discover services, use a ptr lookup on the service protocol
+  # A typical call might be
+  # resolver.getresources('_http._tcp.local', Resolv::DNS::Resource::IN::PTR)
+  #
+
+  # default to browsing for http hosts
+  service_str = ARGV[1] || 'http'
+
+  # prepend an underscore if necessary
+  # p service_str
+
+  if ?_ != service_str[0]
+    puts "prepending underscore to #{service_str}"
+    service_str = '_' + service_str
+  end
+
+  # append a ._tcp.local if necessary (assume tcp and local)
+  if service_str.index('.').nil?
+    puts "No dot found in service name, appending ._tcp.local"
+    service_str += '._tcp.local'
+  end
+
+  puts "Searching for #{service_str} services"
+
+  entries = resolver.getresources(service_str, Resolv::DNS::Resource::IN::PTR)
+
+  # p entries
+
+  puts "Matching entries in #{service_str}"
+  entries.each {
+    |entry|
+    # p entry
+    # I think this will always match but just in case...
+    friendly_name_regexp = /(.*?)\.#{service_str}/
+
+    match = friendly_name_regexp.match(entry.name.to_s)
+    if match
+      puts match[1]
+    else
+      puts entry.name
+    end
+  }
+when 'resolve', 'lookup'
+  #
+  # To resolve / lookup services, first use a SRV lookup to lookup the service
+  # details, then extract the hostname from the result.  Using this hostname,
+  # lookup the A record to find the IP address.
+  #
+
+  service_str = ARGV[1]
+  if service_str.nil?
+    $stderr.puts("Service string required for resolve / lookup")
+    usage()
+    exit(1)
+  end
+
+  # append a ._http._tcp.local if necessary (assume http, tcp and local)
+  if service_str.index('.').nil?
+    puts "No dot found in service name, appending ._http._tcp.local"
+    service_str += '._http._tcp.local'
+
+  end
+
+  puts "Searching for #{service_str} instance"
+  entries = resolver.getresources(service_str, Resolv::DNS::Resource::IN::SRV)
+
+  if 0 == entries.size
+    puts "Unable to find #{service_str}"
+    exit(0)
+  end
+
+  entry = entries[0]
+  # puts "Found match at #{entry.target}, port #{entry.port}"
+
+  hostname = entry.target
+  port = entry.port
+  entries = resolver.getresources(hostname, Resolv::DNS::Resource::IN::A)
+
+  if 0 == entries.size
+    puts "Unable to resolve #{hostname}"
+    exit(1)
+  end
+
+  entry = entries[0]
+  # p entry
+  # p entry.address
+  puts "#{service_str} is\n#{hostname}:#{port} at IP #{entry.address.to_s}"
+
+else
+  $stderr.puts("unknown operation #{operation.inspect}")
+  usage()
+  exit(1)
+end