masquito 1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+pkg
+test/tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2013 Dmitry Vorotilin
+
+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,45 @@
+# Masquito
+
+This gem is for DNS masquerading for rubists. Everyone knows `Pow`, but what
+I really don't like that it uses `node.js` to run ruby applications. Sometimes
+we have to run our apps on the certain domain. Masquito allows you to do it,
+you can create dns records in the similar Pow's way by creating symbolic links
+in `.masquito` directory to your apps or just files because masquito doesn't
+run rack applications just does dns masquerading.
+
+## Installation
+
+First of all, uninstall Pow if you have it installed.
+I suppose you're on rbenv(we will add rvm support as soon as we can).
+
+Install gem:
+
+    $ gem install masquito
+
+Run these commands:
+
+    $ masquito daemon install
+    $ sudo masquito resolver install
+
+The first one installs masquito dns server as a daemon in your system which will
+be started at each boot. This daemon will respond on dns queries from your
+system. The second one registers dns resolver (`man 5 resolver` for more info)
+for `.dev` domain. You have to run it with sudo because we must write config to
+`/etc/resolver` path.
+
+## Usage
+
+Once you have installed masquito you can add domains to ~/.masquito
+
+    $ cd ~/.masquito
+    $ touch example
+
+It will create for you example.dev domain and you can already ping and use it.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = false
+end

data/bin/masquito

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'masquito'
+
+abort 'Works only on Mac OS X' if RUBY_PLATFORM !~ /darwin/
+
+command = ARGV[0]
+subcommand = ARGV[1]
+filename = File.basename(__FILE__)
+
+case command
+when 'start'
+  Masquito::DNS.new
+when /daemon|resolver/
+  require 'masquito/install'
+  options = %w(install uninstall)
+  unless options.include?(subcommand)
+    abort "Usage: #{filename} #{command} #{options.join(' | ')}"
+  end
+  Masquito.send("#{command}_#{subcommand}")
+when 'version'
+  require 'masquito/version'
+  puts Masquito::VERSION
+else
+  puts "Usage: #{filename} #{%w(daemon resolver version).join(' | ')}"
+end

data/config/com.evrone.masquito.plist.erb

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>Label</key>
+  <string>com.evrone.masquito</string>
+  <key>ProgramArguments</key>
+  <array>
+    <string>sh</string>
+    <string>-i</string>
+    <string>-c</string>
+    <string>$SHELL --login -c "<%= masquito_bin %> start"</string>
+  </array>
+  <key>KeepAlive</key>
+  <true/>
+  <key>RunAtLoad</key>
+  <true/>
+</dict>
+</plist>

data/config/masquito.erb

@@ -0,0 +1,3 @@
+nameserver 127.0.0.1
+port <%= Masquito::DNS::PORT %>
+domain dev

data/lib/masquito.rb

@@ -0,0 +1,7 @@
+module Masquito
+  CONFIG_PATH = File.join(ENV['HOME'], '.masquito')
+
+  autoload :DNS, 'masquito/dns'
+  autoload :Settings, 'masquito/settings'
+  autoload :VERSION, 'masquito/version'
+end

data/lib/masquito/dns.rb

@@ -0,0 +1,62 @@
+require 'socket'
+require 'resolv'
+
+module Masquito
+  class DNS
+    ADDRESS = '127.0.0.1'
+    PORT = 53532
+
+    @@resource = {
+      'A' => Resolv::DNS::Resource::IN::A.new(ADDRESS),
+      'AAAA' => Resolv::DNS::Resource::IN::AAAA.new('::1')
+    }
+    @@ttl = 10800 # 3 hours
+
+    def initialize(addr = ADDRESS, port = PORT, config_path = CONFIG_PATH)
+      puts "Starting Masquito on #{addr}:#{port}"
+      @settings = Settings.new(config_path)
+
+      # Bind port to receive requests
+      socket = UDPSocket.new
+      socket.bind(addr, port)
+
+      loop do
+        # Receive and parse query
+        data, sender_addrinfo = socket.recvfrom(512)
+
+        Thread.new(data, sender_addrinfo) do |data, sender_addrinfo|
+          sender_port, sender_ip = sender_addrinfo[1], sender_addrinfo[2]
+          query = Resolv::DNS::Message.decode(data)
+          answer = setup_answer(query)
+          socket.send(answer.encode, 0, sender_ip, sender_port) # Send the response
+        end
+      end
+    end
+
+    # Setup answer
+    def setup_answer(query)
+      # Standard fields
+      answer = Resolv::DNS::Message.new(query.id)
+      answer.qr = 1                 # 0 = Query, 1 = Response
+      answer.opcode = query.opcode  # Type of Query; copy from query
+      answer.aa = 1                 # Is this an authoritative response: 0 = No, 1 = Yes
+      answer.rd = query.rd          # Is Recursion Desired, copied from query
+      answer.ra = 0                 # Does name server support recursion: 0 = No, 1 = Yes
+      answer.rcode = 0              # Response code: 0 = No errors
+      each_question(query, answer)  # There may be multiple questions per query
+    end
+
+    def each_question(query, answer)
+      query.each_question do |name, typeclass|
+        type = typeclass.name.split('::').last
+        if type == 'A' || type == 'AAAA'                      # We need only A and AAAA records
+          if @settings.include?(name)
+            answer.add_answer(name, @@ttl, @@resource[type])  # Setup answer to this name
+            answer.encode                                     # Don't forget encode it
+          end
+        end
+      end
+      answer
+    end
+  end
+end

data/lib/masquito/install.rb

@@ -0,0 +1,90 @@
+require 'erb'
+require 'fileutils'
+require 'lunchy'
+require 'tempfile'
+
+module Masquito
+  GEM_PATH = File.expand_path('../../../', __FILE__)
+  TEMPLATE_PLIST_PATH = File.join(GEM_PATH, 'config', 'com.evrone.masquito.plist.erb')
+  PLIST_NAME = File.basename(TEMPLATE_PLIST_PATH, '.erb')
+  SERVICE_NAME = File.basename(PLIST_NAME, '.plist')
+
+  RESOLVER_TEMPLATE_PATH = File.join(GEM_PATH, 'config', 'masquito.erb')
+  RESOLVER_PATH = '/etc/resolver/masquito'
+
+  class << self
+    def daemon_install
+      abort_if_superuser
+      FileUtils.mkdir_p(CONFIG_PATH)
+
+      plist = ERB.new(File.read(TEMPLATE_PLIST_PATH))
+      masquito_bin = File.join(GEM_PATH, 'bin', 'masquito')
+      template = plist.result(binding)
+
+      filename = File.join(Dir.tmpdir, PLIST_NAME)
+      File.open(filename, 'w') { |f| f.write(template) }
+      lunchy.install([filename])
+      lunchy.start([SERVICE_NAME])
+      File.unlink(filename)
+
+      puts 'Daemon was successfully installed.'
+      puts 'Run: sudo masquito resolver install'
+    end
+
+    def daemon_uninstall
+      abort_if_superuser
+      lunchy.stop([SERVICE_NAME])
+      lunchy.uninstall([PLIST_NAME])
+      puts "You can remove #{CONFIG_PATH} if you don't need these settings"
+    end
+
+    def resolver_install
+      abort_unless_superuser
+      resolver = ERB.new(File.read(RESOLVER_TEMPLATE_PATH))
+      template = resolver.result(binding)
+      File.open(RESOLVER_PATH, 'w') { |f| f.write(template) }
+    end
+
+    def resolver_uninstall
+      abort_unless_superuser
+      FileUtils.rm_rf(RESOLVER_PATH)
+    end
+
+    private
+
+    def lunchy
+      @lunchy ||= Lunchy.new
+    end
+
+    def abort_unless_superuser
+      unless superuser?
+        abort 'We need superuser privileges, run this command with sudo'
+      end
+    end
+
+    def abort_if_superuser
+      if superuser?
+        abort 'No need superuser privileges, run this command without sudo'
+      end
+    end
+
+    def superuser?
+      [Process.uid, Process.euid] == [0, 0]
+    end
+  end
+end
+
+class Lunchy
+  CONFIG = { :verbose => false, :write => false }
+
+  def uninstall(params)
+    raise ArgumentError, "uninstall [file]" if params.empty?
+    filename = params[0]
+    %w(~/Library/LaunchAgents /Library/LaunchAgents).each do |dir|
+      if File.exist?(File.expand_path(dir))
+        FileUtils.rm_rf(File.join(File.expand_path(dir), File.basename(filename)))
+        return puts "#{filename} uninstalled from #{dir}"
+      end
+    end
+  end
+end

data/lib/masquito/settings.rb

@@ -0,0 +1,35 @@
+require 'resolv'
+require 'pathname'
+
+module Masquito
+  class Settings
+    def initialize(config_path)
+      @pattern = File.join(config_path, '*')
+    end
+
+    def files
+      Dir.glob(@pattern).select do |file|
+        is_symlink = File.lstat(file).symlink?
+        !is_symlink || (is_symlink && Pathname.new(file).exist?)
+      end
+    end
+
+    def domains
+      files.map do |symlink|
+        name = File.basename(symlink)
+        Resolv::DNS::Name.create(has_domain?(name) ? "#{name}." : "#{name}.dev.")
+      end
+    end
+
+    def include?(name)
+      name = Resolv::DNS::Name.create(name) if name.kind_of?(String)
+      domains.any? { |n| name.eql?(n) || name.subdomain_of?(n) }
+    end
+
+    private
+
+    def has_domain?(name)
+      name.split('.').length >= 2
+    end
+  end
+end

data/lib/masquito/version.rb

@@ -0,0 +1,3 @@
+module Masquito
+  VERSION = '1.0'
+end

data/masquito.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'masquito/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'masquito'
+  gem.version       = Masquito::VERSION
+  gem.authors       = ['Dmitry Vorotilin', 'Kir Shatrov']
+  gem.email         = ['d.vorotilin@gmail.com', 'kirs@evrone.ru']
+  gem.description   = 'Masquito is a dns masquerading server for rubists'
+  gem.summary       = 'It masquerades your dns records'
+  gem.homepage      = 'https://github.com/evrone/masquito'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'lunchy'
+end

data/test/dns_test.rb

@@ -0,0 +1,45 @@
+require 'resolv'
+require 'fileutils'
+require 'test_helper'
+
+require 'masquito'
+
+class TestMasquitoDNS < Test::Unit::TestCase
+  TEMP_DIR = File.join(Dir.pwd, 'test/tmp')
+
+  def setup
+    FileUtils.mkdir_p(TEMP_DIR)
+
+    file = File.new(File.join(TEMP_DIR, 'file'), 'w')
+    ['link', 'symlink.dev', 'symlink.domain'].each do |name|
+      symlink = File.join(TEMP_DIR, name)
+      FileUtils.ln_s(file.path, symlink)
+    end
+
+    @thread = Thread.new do
+      Masquito::DNS.new('127.0.0.1', '51234', TEMP_DIR)
+    end
+  end
+
+  def teardown
+    @thread.kill
+
+    FileUtils.rm_rf(TEMP_DIR)
+  end
+
+  def test_responses
+    silence_warnings do
+      Resolv::DNS.const_set(:Port, 51234)
+    end
+
+    response = Resolv::IPv4.create('127.0.0.1')
+    Resolv::DNS.open(:nameserver => ['127.0.0.1']) do |dns|
+      assert_equal response, dns.getaddress('link.dev.')
+      assert_equal response, dns.getaddress('sym.sym.link.dev.')
+      assert_equal response, dns.getaddress('symlink.dev.')
+      assert_equal response, dns.getaddress('www.symlink.dev.')
+      assert_equal response, dns.getaddress('symlink.domain.')
+      assert_equal response, dns.getaddress('asd.symlink.domain.')
+    end
+  end
+end

data/test/settings_test.rb

@@ -0,0 +1,51 @@
+require 'fileutils'
+require 'test_helper'
+
+require 'masquito'
+
+class TestMasquitoSettings < Test::Unit::TestCase
+  TEMP_DIR = File.join(Dir.pwd, 'test/tmp')
+
+  attr_reader :settings
+
+  def setup
+    FileUtils.mkdir_p(TEMP_DIR)
+
+    @settings = Masquito::Settings.new(TEMP_DIR)
+
+    file = File.new(File.join(TEMP_DIR, 'file'), 'w')
+    ['link', 'symlink.dev', 'symlink.domain'].each do |name|
+      symlink = File.join(TEMP_DIR, name)
+      FileUtils.ln_s(file.path, symlink)
+    end
+  end
+
+  def teardown
+    FileUtils.rm_rf(TEMP_DIR)
+  end
+
+  def test_files
+    result = ['file', 'link', 'symlink.dev', 'symlink.domain'].map do |name|
+      File.join(TEMP_DIR, name)
+    end
+
+    assert_equal result, settings.files
+  end
+
+  def test_domains
+    result = ['file.dev.', 'link.dev.', 'symlink.dev.', 'symlink.domain.'].map do |name|
+      Resolv::DNS::Name.create(name)
+    end
+
+    assert_equal result, settings.domains
+  end
+
+  def test_include
+    assert settings.include?('link.dev.')
+    assert settings.include?('sym.sym.link.dev.')
+    assert settings.include?('symlink.dev.')
+    assert settings.include?('www.symlink.dev.')
+    assert settings.include?('symlink.domain.')
+    assert settings.include?('asd.symlink.domain.')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+
+class Test::Unit::TestCase
+  def silence_warnings
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: masquito
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Dmitry Vorotilin
+- Kir Shatrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lunchy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Masquito is a dns masquerading server for rubists
+email:
+- d.vorotilin@gmail.com
+- kirs@evrone.ru
+executables:
+- masquito
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/masquito
+- config/com.evrone.masquito.plist.erb
+- config/masquito.erb
+- lib/masquito.rb
+- lib/masquito/dns.rb
+- lib/masquito/install.rb
+- lib/masquito/settings.rb
+- lib/masquito/version.rb
+- masquito.gemspec
+- test/dns_test.rb
+- test/settings_test.rb
+- test/test_helper.rb
+homepage: https://github.com/evrone/masquito
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: It masquerades your dns records
+test_files:
+- test/dns_test.rb
+- test/settings_test.rb
+- test/test_helper.rb