mdns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eecfa9139011bd96bd24cfcd7c8ba37fc8ee947b
+  data.tar.gz: dbda624febbc8dd4c218e3f06653c984f52367d0
+SHA512:
+  metadata.gz: b14273868c4ee104d216226a12b6c91831ee91f848d56caa613aac1727e07fc3655c471ba74b6511882390fde1f903126d7bfea70baa6d3996baba45828c10a0
+  data.tar.gz: 2f6143386390695317b2f1a163a18df969e100e81cf0d6b44736032bc7d6901edf5d95737d964d6ccc07b3452abe3a3050cb810f7772f90ca14217a557d3911b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+notifications:
+  email: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode
+  - rbx

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mdns.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jack Chen (chendo)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# mDNS
+
+Ever wanted to create your own custom `.local` hostnames on your network? Now you can!
+
+This gem implements a super naive mDNS server that listens for queries matching entries you add, and responds to them.
+
+This gem was created by observing existing mDNS queries and responses. I did not read the RFC, so it might not follow the spec properly.
+
+Tested on OS X Mavericks.
+
+Should work with any client that implements mDNS resolver.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mdns'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mdns
+
+## Usage
+
+```ruby
+require "mdns"
+MDNS.add_record(Net::DNS::RR.new("leet.local. 60 A 10.0.13.37")) # Add a record for leet.local to resolve to 10.0.13.37 with a TTL of 60 seconds
+MDNS.add_record("leet.local. 60 A 10.0.13.37"))                  # Can pass in a string too
+
+MDNS.start                                                       # Start listening
+```
+
+## Caveats
+
+* Does not "unpublish" a record when stopping. Couldn't seem to find an example response.
+* Only supports A records
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Jack "chendo" Chen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mdns.rb

@@ -0,0 +1,86 @@
+require "mdns/version"
+require "net/dns"
+
+class MDNS
+  MULTICAST_IP = '224.0.0.251'
+  MDNS_PORT = 5353
+
+  class << self
+    def start
+      @socket = UDPSocket.new
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, true)
+      ip_mreq = IPAddr.new(MULTICAST_IP).hton + IPAddr.new('0.0.0.0').hton
+      @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, ip_mreq)
+      @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, 255)
+      @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, 255)
+      @socket.bind(Socket::INADDR_ANY, MDNS_PORT)
+      Thread.abort_on_exception = true
+      @thr = Thread.new do
+        loop do
+          data = @socket.recvfrom(1024)
+          packet = begin
+            Net::DNS::Packet::parse(data)
+          rescue => e
+            # Net::DNS::Packet doesn't handle a bunch of mDNS packets
+          end
+          next if packet.nil?
+          if packet.header.query? && packet.question.any? { |q| hosts.include?(q.qName.downcase) && q.qType.to_s == 'A' }
+            respond_to(packet)
+          end
+        end
+      end
+
+      records.values.each do |record|
+        respond_with(record)
+      end
+
+      at_exit do
+        stop
+      end
+    end
+
+    def respond_to(query)
+      puts "#{Time.now} Responding to query"
+      record = records[query.question.first.qName.downcase]
+      respond_with(record)
+    end
+
+    def respond_with(record)
+      # I have no idea what I'm doing
+      response = Net::DNS::Packet.new(record.name)
+      response.header.qr = true
+      response.header.aa = true
+      response.header.anCount = 1
+      response.header.arCount = 1
+      response.answer = record
+      @socket.send(response.data, 0, MULTICAST_IP, MDNS_PORT)
+    end
+
+    def add_record(record)
+      if record.is_a?(String)
+        record = Net::DNS::RR.new(record)
+      end
+      records[record.name.downcase] = record
+      respond_with(record) if @socket && !@socket.closed?
+    end
+
+    def records
+      @records ||= {}
+    end
+
+    def hosts
+      records.keys
+    end
+
+    def stop
+      if @thr
+        @thr.kill
+        @thr = nil
+      end
+      if @socket && !@socket.closed?
+        @socket.close
+      end
+    end
+  end
+end

data/lib/mdns/version.rb

@@ -0,0 +1,3 @@
+class MDNS
+  VERSION = "0.1.0"
+end

data/mdns.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mdns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mdns"
+  spec.version       = MDNS::VERSION
+  spec.authors       = ["Jack Chen (chendo)"]
+  spec.email         = ["github+mdns@chen.do"]
+  spec.summary       = %q{Create your own .local address with mdns!}
+  spec.description   = %q{mdns allows you to create your own .local hostnames and point them to whatever IP you want.}
+  spec.homepage      = "https://github.com/chendo/mdns"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "net-dns", "~> 0.8"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/spec/mdns_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'resolv'
+
+describe MDNS do
+  let(:domain) { "foo-bar-#{rand(1000)}.local." }
+  let(:ip) { "10.10.10.10" }
+  describe "integration test" do
+
+    context "MDNS not running" do
+      it "does not resolve" do
+        expect do
+          Socket.gethostbyname(domain)
+        end.to raise_error(SocketError)
+      end
+    end
+
+    context "MDNS is running" do
+      before do
+        MDNS.add_record(Net::DNS::RR.new("#{domain} 60 A #{ip}"))
+        MDNS.start
+      end
+
+      after do
+        MDNS.stop
+      end
+
+      it "does resolve" do
+        expect(Socket.gethostbyname(domain)).to be_a(Array)
+      end
+    end
+  end
+
+  describe '.add_record' do
+    it "takes a string" do
+      MDNS.add_record("#{domain} 60 A #{ip}")
+      expect(MDNS.records.keys).to eq([domain])
+      expect(MDNS.records.values.first).to be_a(Net::DNS::RR)
+    end
+
+    it "takes a Net::DNS::RR" do
+      MDNS.add_record(Net::DNS::RR.new("#{domain} 60 A #{ip}"))
+      expect(MDNS.records.keys).to eq([domain])
+      expect(MDNS.records.values.first).to be_a(Net::DNS::RR)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+require 'mdns'
+
+RSpec.configure do |config|
+  config.formatter = 'documentation'
+  config.color = true
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: mdns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Chen (chendo)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-dns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: mdns allows you to create your own .local hostnames and point them to
+  whatever IP you want.
+email:
+- github+mdns@chen.do
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mdns.rb
+- lib/mdns/version.rb
+- mdns.gemspec
+- spec/mdns_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chendo/mdns
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Create your own .local address with mdns!
+test_files:
+- spec/mdns_spec.rb
+- spec/spec_helper.rb
+has_rdoc: