vdns 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4d9ac01b82fdb26798ae44dee31fd629763537e
+  data.tar.gz: 7c34306f0902d28a7bc1ee610484728afa988ab1
+SHA512:
+  metadata.gz: 2fa2824b695a7823273c8383802bc894e4f042296d9629f2e4fc2820eb507de1d7a656b612591376c88d6b8329625f4e4699042a69b33a422125f24e49203d9a
+  data.tar.gz: 3953cd201544813ce872a646c51de439c9983e9e7fb9cf1e26e09f582e4998888895bf58b7fa4feef593d57c292a28c83e53ef12cd47cff651bbdfce8a761ad5

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/README.md

@@ -0,0 +1,39 @@
+Dynamic DNS for developers and teams
+====================================
+
+ * Work locally with virtual hosts (online and offline)
+ * Test on devices in the same network
+ * Share with teammates in the same network
+ * Share with anybody over the web (with port forwarding)
+
+This tool will create/ update ``user_name.domain A`` and ``*.user_name.domain A`` DNS records.
+
+
+```bash 
+vdns host   # Update Nameserver with local loopback IP (host-only access)
+vdns lan    # Update Nameserver with local area IP (local network access)
+vdns wan    # Update Nameserver with wide area IP (Internet access)
+vdns off    # Delete Nameserver records
+
+
+# specials (@todo):
+
+vdns host --offline         # Start a local Nameserver server and work offline
+vdns wan --forward-port 80  # Set up Port forwarding in your router via UPnP
+```
+
+
+## Supported Nameservers
+
+ * [AWS Route 53](https://github.com/mattes/vdns/tree/master/lib/vdns/provider/aws-route53)
+
+
+## Installation
+
+```bash
+gem install vdns
+
+# run vdns once and update config file ...
+vdns
+vi ~/.vdns/conf.yml
+```

data/bin/vdns

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+
+# when developing and calling ./vdns directly, uncomment the following line.
+# $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require "yaml"
+require "optparse"
+require "socket"
+require 'open-uri'
+require "vdns"
+
+config = VDNS::Config.new("~/.vdns/conf.yml")
+%w(provider user domain).each do |var|
+  if config.blank?(var)
+    puts "Error: Missing '#{var}' setting! Please define in #{config.file_name}."
+    exit 1
+  end
+end
+
+
+ip = nil
+args = {}
+args["offline"] = false
+args["skip-check"] = false
+args["ip"] = nil
+args["port"] = nil
+args["help"] = false
+args["provider"] = "aws-route53"
+
+opts = OptionParser.new do |o|
+  o.banner = "Update Nameserver with IP."
+  o.separator ""
+  o.separator "vdns host    --offline, --skip-check"
+  o.separator "vdns lan     --skip-check"
+  o.separator "vdns wan     --forward-port, --skip-check"
+  o.separator "vdns custom  --ip, --forward-port, --skip-check"
+  o.separator "vdns off"
+  o.separator ""
+  o.separator "Options:"
+  o.on("-o", "--offline", "Work in offline mode") { args["offline"] = true }
+  o.on("-p", "--forward-port [port]", "Set up Port forwarding via UPnP") {|var| args["port"] = var }
+  o.on("-i", "--ip [address]", "Use custom IP address") {|var| args["ip"] = var }
+  o.on("-s", "--skip-check", "Skip DNS check after update") { args["skip-check"] = true }
+  o.on("-h", "--help", "Show this help") { args["help"] = true }
+end
+opts.parse!
+
+if args["help"]
+  puts opts
+  exit
+end
+
+# update helper method
+def _update(config, provider_name, ip, verify=true)
+  provider = VDNS::ProviderFactory::get(provider_name, config)
+
+  puts "Updating: #{config.get("user")}.#{config.get("domain")} -> #{ip} (#{provider_name})"
+  ["*.#{config.get("user")}.#{config.get("domain")}",
+   "#{config.get("user")}.#{config.get("domain")}"].each do |domain|
+    provider.save(domain, ip)
+  end
+  
+  if verify
+    check_ns = %w(8.8.8.8 8.8.4.4)
+    ns = VDNS::NSLookup.new(check_ns)
+
+    printf "Waiting for updates to become active ..."
+
+    def _sleep(seconds)
+      while seconds > 0
+        printf "." if seconds % 5 == 0
+        seconds -= 1
+        sleep 1
+      end
+    end
+
+    _sleep 65
+    updated = false
+    until ns.updated?("#{config.get("user")}.#{config.get("domain")}", ip)
+      _sleep 30   
+    end 
+
+    printf "\nUpdates should be active at nameservers #{check_ns.join(", ")}.\n"
+  end
+end
+
+def _port_forwarding(port)
+  unless port.nil?
+    puts "Warning: Port forwarding not supported, yet."
+  end
+end
+
+
+case ARGV[0]
+  when "host"
+    ip = "127.0.0.1"
+    if args["offline"]
+      puts "Error: Offline mode is not supported, yet."
+      exit 1
+    else
+      _update(config, args["provider"], ip, !args["skip-check"])
+    end
+
+
+  when "lan"
+    ips = Socket.ip_address_list
+    ips.reject! {|ip| not ip.ipv4_private? }
+    ips.map! {|ip| ip.ip_address}
+    ip = ips.first
+    _update(config, args["provider"], ip, !args["skip-check"])
+
+
+  when "wan"
+    ip = URI.parse('http://echoip.com').read.strip
+    _port_forwarding(args["port"])
+    _update(config, args["provider"], ip, !args["skip-check"])
+
+
+  when "custom"
+    if args["ip"].nil?
+      puts "Error: Missing --ip option."
+      exit 1
+    end
+    ip = args["ip"]
+    _port_forwarding(args["port"])
+    _update(config, args["provider"], ip, !args["skip-check"])
+
+  when "off"
+    provider = VDNS::ProviderFactory::get(args["provider"], config)
+    ["*.#{config.get("user")}.#{config.get("domain")}",
+     "#{config.get("user")}.#{config.get("domain")}"].each do |domain|
+      provider.delete(domain)
+    end
+
+  else
+    puts opts
+    exit
+end
+
+
+
+

data/lib/vdns.rb

@@ -0,0 +1,3 @@
+require "vdns/config"
+require "vdns/provider"
+require "vdns/nslookup"

data/lib/vdns/config.rb

@@ -0,0 +1,64 @@
+module VDNS
+  
+  class Config
+    @file = nil
+    @config = {}
+
+    def initialize(file)
+      @file = File.expand_path(file)
+
+      unless File.exist?(@file)
+        dirname = File.dirname(@file)
+        Dir.mkdir(dirname) unless Dir.exist?(dirname)
+        File.open(@file, "w") do |f|
+          f.puts %Q(
+user: #{`whoami`}
+domain:
+provider: aws-route53
+
+aws_r53_access_key: 
+aws_r53_secret_access_key: 
+aws_r53_hosted_zone_id:
+)
+        end
+      end
+
+      read_file
+    end
+
+    def get(name)
+      if include?(name)
+        @config[name]
+      else
+        raise ArgumentError, "Undefined config variable #{name}"
+      end
+    end
+
+    def set(name, var)
+      @config[name] = var
+    end
+
+    def include?(name)
+      @config.include? name
+    end
+
+    def blank?(name)
+      @config[name].nil? || @config[name].empty?
+    end
+
+    def read_file
+      @config = YAML.load_file(@file)
+    end
+
+    def save_file
+      File.open(@file, 'w') do |f|
+        f.puts YAML.dump(@config)
+      end
+    end
+
+    def file_name
+      @file
+    end
+
+  end
+end

data/lib/vdns/nslookup.rb

@@ -0,0 +1,25 @@
+require "resolv"
+
+module VDNS
+  class NSLookup
+
+    def initialize(nameservers)
+      raise ArgumentError, "Specify nameserver array" unless nameservers.is_a? Array
+      @nameservers = nameservers
+    end
+
+    def updated?(domain, to_ip)
+      updated = true
+      @nameservers.each do |ns|
+        resolv = Resolv::DNS.new(:nameserver => ns, :ndots => 1)
+        resolv.timeouts = 10
+        if resolv.getaddress(domain).to_s != to_ip
+          updated = false
+          break
+        end
+      end
+      return updated
+    end
+
+  end
+end

data/lib/vdns/provider.rb

@@ -0,0 +1,22 @@
+module VDNS
+
+  class ProviderFactory
+    def self.get(provider, config)
+      require "vdns/provider/#{provider}/#{provider}"
+      return VDNS::Provider.new(config)
+    end
+  end
+
+
+  class ProviderBase
+    def warning(message)
+      puts "Warn: #{message}"
+    end
+
+    def error_and_exit(message)
+      puts "Error: #{message}"
+      exit 1
+    end
+  end
+
+end

data/lib/vdns/provider/aws-route53/README.md

@@ -0,0 +1,20 @@
+AWS Route 53
+============
+
+Amazon Web Services Route 53 Provider
+
+http://docs.aws.amazon.com/AWSRubySDK/latest/frames.html
+
+Required config variables:  
+ * ``domain``
+ * ``aws_r53_access_key``
+ * ``aws_r53_secret_access_key``
+ * ``aws_r53_hosted_zone_id`` (see AWS Route 53 Console)
+
+## Setup
+
+ 1. Create new hosted zone in AWS console.
+ 1. Add hosted zone id to config file (aws_r53_hosted_zone_id).
+ 1. Set ``TTL (Seconds)`` to 60 for the SOA record.
+ 1. Set ``refresh-time, retry-time, expire-time, minimum TTL`` for SOA record to ``60 60 1209600 60``
+

data/lib/vdns/provider/aws-route53/aws-route53.rb

@@ -0,0 +1,71 @@
+require "vdns/provider"
+require "aws-sdk"
+
+module VDNS
+  class Provider < VDNS::ProviderBase
+
+    def initialize(config)
+      %w(domain
+        aws_r53_access_key 
+        aws_r53_secret_access_key 
+        aws_r53_hosted_zone_id).each do |var|
+        error_and_exit("Missing '#{var}' setting! Please define in #{config.file_name}.") if config.blank?(var)
+      end
+
+      AWS.config(access_key_id: config.get("aws_r53_access_key"), 
+        secret_access_key: config.get("aws_r53_secret_access_key"))
+
+      @hosted_zone = AWS::Route53::HostedZone.new(config.get("aws_r53_hosted_zone_id"))
+      @rrsets = @hosted_zone.rrsets
+
+      @domain = parse_domain(config.get("domain"))
+    end
+
+    def save(domain, ip)
+      domain = parse_domain(domain)
+      rrset = @rrsets[domain, "A"]
+      if rrset.exists?
+        rrset.resource_records = [{:value => ip}]
+        rrset.update
+      else
+        @rrsets.create(
+          domain, 
+          "A", 
+          :ttl => 60, 
+          :resource_records => [{:value => ip}])
+      end
+      update_soa_serial_number
+      return true
+    end
+
+    def delete(domain)
+      domain = parse_domain(domain)
+      rrset = @rrsets[domain, "A"]
+      if rrset.exists?
+        rrset.delete
+        update_soa_serial_number
+      end
+      return true
+    end
+
+    private 
+
+    def parse_domain(domain)
+      unless domain.end_with?(".")
+        domain = "#{domain}."
+      end
+      domain = domain.gsub(/\*/, "\\\\052") # * -> 052 ascii, aws bug?!
+      return domain
+    end
+
+    def update_soa_serial_number
+      soa = @rrsets[@domain, "SOA"]
+      soa_parts = soa.resource_records[0][:value].split(" ")
+      soa_parts[2] = Time.now.to_i
+      soa.resource_records = [{:value => soa_parts.join(" ")}]
+      soa.update
+    end
+
+  end
+end
+

data/lib/vdns/version.rb

@@ -0,0 +1,3 @@
+module VDNS
+  VERSION = "1.0.0"
+end

data/vdns.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vdns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vdns"
+  spec.version       = VDNS::VERSION
+  spec.authors       = ["mattes"]
+  spec.email         = ["matthias.kadenbach@gmail.com"]
+  spec.description   = "Dynamic DNS for developers and teams."
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/mattes/vdns"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  # spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "aws-sdk", "~> 1.28.0"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: vdns
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- mattes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+description: Dynamic DNS for developers and teams.
+email:
+- matthias.kadenbach@gmail.com
+executables:
+- vdns
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- bin/vdns
+- lib/vdns.rb
+- lib/vdns/config.rb
+- lib/vdns/nslookup.rb
+- lib/vdns/provider.rb
+- lib/vdns/provider/aws-route53/README.md
+- lib/vdns/provider/aws-route53/aws-route53.rb
+- lib/vdns/version.rb
+- vdns.gemspec
+homepage: https://github.com/mattes/vdns
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Dynamic DNS for developers and teams.
+test_files: []