dynamic_dns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ccee403a3b6f04ab955a2712570ceb80643151e
+  data.tar.gz: 4e932eaa73d5ecf5fa375aa1d24da204f0f60df8
+SHA512:
+  metadata.gz: 852ce7f2eb7c0e97d1d6511ca4737342ddcbc2b99624a06a79e06be5d770f392feac8ba1ebdb822a3715d6001b04b5b1e787d686209c509713cafd457994000a
+  data.tar.gz: c71c90c498e98e4f6a190e132e851cb302ff8acce8e502321b129541ef23082ebe370938d46644437b7a6c8a8745a2615ca66d8f51395e3b2c554329ab9d1113

data/.gitignore

@@ -0,0 +1,10 @@
+*.tmp
+*.swp
+*.DS_Store
+*.gem
+
+Gemfile.lock
+
+.bundle/
+
+vendor/

data/Gemfile

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

data/Makefile

@@ -0,0 +1,9 @@
+run:
+	bundle exec ruby -I lib bin/dynamic-dns
+
+install:
+	bundle install --path vendor/bundle
+
+dependencies:
+	@ echo '0. ruby (use your package manager)'
+	@ echo '1. bundle (gem install bundle)'

data/README.md

@@ -0,0 +1,80 @@
+# DynamicDNS
+
+DynamicDNS is tool that queries your public IPv4 address periodically, and updates a specific `A` record in Amazon Route53 if this IP address changes.
+
+This gem is useful as a command-line executable, and as a library.
+
+
+## Usage
+
+The following usage examples will configure the daemon to run every 10 minutes, updating the hosted zone for `foo.com` in Route53 to have an `A` record that points `ssh.foo.com` to the computer's public IPv4 address. See the *Configuration* section below for more information on the environment variables used to configure the daemon.
+
+Ensure you have installed this gem to use the command-line tool. You must have Ruby 2.4.0, or greater, installed.
+
+```bash
+$ gem install dynamic_dns
+```
+
+
+### Command-line
+
+```bash
+# use environment variables to configure the daemon
+# exit with Ctrl+c
+$ DYNAMIC_DNS_DOMAIN=foo.com DYNAMIC_DNS_SUBDOMAIN=ssh DYNAMIC_DNS_INTERVAL=600 dynamic-dns
+```
+
+
+### `systemd` Start-Up Script
+
+If you are using `rvm` with `systemd`, ensure that `rvm` was installed using `sudo`, then install this gem.
+
+```ini
+[Unit]
+Description=DynamicDNS daemon
+
+[Service]
+Type=simple
+Environment="GEM_HOME=/usr/local/rvm/gems/ruby-2.4.1"
+Environment="GEM_PATH=/usr/local/rvm/gems/ruby-2.4.1:/usr/local/rvm/gems/ruby-2.4.1@global"
+Environment="PATH=/usr/local/rvm/gems/ruby-2.4.1/bin:/usr/local/rvm/gems/ruby-2.4.1@global/bin:/usr/local/rvm/rubies/ruby-2.4.1/bin:$PATH"
+Environment="AWS_ACCESS_KEY_ID=[REDACTED]"
+Environment="AWS_SECRET_ACCESS_KEY=[REDACTED]"
+Environment="DYNAMIC_DNS_DOMAIN=foo.com"
+Environment="DYNAMIC_DNS_SUBDOMAIN=ssh"
+Environment="DYNAMIC_DNS_INTERVAL=600"
+ExecStart=/usr/local/rvm/gems/ruby-2.4.1/bin/dynamic-dns
+
+[Install]
+WantedBy=multi-user.target
+```
+
+
+### Ruby
+
+```ruby
+require 'dynamic-dns'
+
+daemon = DynamicDns::Daemon.new "foo.com", "ssh", 600
+daemon.start # runs the daemon and blocks the thread
+```
+
+
+## Confirguation
+
+It is possible to configure this daemon using environment variables.
+
+| Variable | Required? | Default | Example | Description |
+|:---|:---|:---|:---|:---|
+| `DYNAMIC_DNS_DOMAIN` | Y | N/A | `foo.com` | This domain's hosted zone will be updated. It must already have an existing hosted zone in Route53 prior to running the daemon. |
+| `DYNAMIC_DNS_SUBDOMAIN` | Y | N/A | `ssh` | The name of the A record that will point to the public IP address discovered by the daemon. |
+| `DYNAMIC_DNS_INTERVAL` | N | `60` | `60` | The interval in seconds that the daemon should query for the public IPv4 address. |
+| `AWS_ACCESS_KEY_ID` | Y | N/A | `abc123` | Your AWS access key ID. It must have permissions to manage Route53. This requirement is defined by the `aws-sdk` gem ([link](https://github.com/aws/aws-sdk-ruby)). An alternative method to providnig your AWS credentials to create an `~/.aws/credentials` file. |
+| `AWS_SECRET_ACCESS_KEY` | Y | N/A | `abc123` | Your AWS secret access key. See above for notes on AWS credentials. |
+
+
+## Author
+
+Dhruv Dang  
+[hi@dhruv.io](mailto:hi@dhruv.io)  
+[dhruv.io](https://dhruv.io)

data/bin/dynamic-dns

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+
+require 'dynamic_dns'
+
+DOMAIN    = ENV['DYNAMIC_DNS_DOMAIN']
+SUBDOMAIN = ENV['DYNAMIC_DNS_SUBDOMAIN']
+INTERVAL  = ENV['DYNAMIC_DNS_INTERVAL']
+
+daemon = DynamicDns::Daemon.new DOMAIN, SUBDOMAIN, (INTERVAL and Integer INTERVAL)
+daemon.start

data/dynamic_dns.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |gem|
+  gem.name                   = 'dynamic_dns'
+  gem.version                = '0.1.0'
+  gem.date                   = '2017-07-17'
+  gem.summary                = 'Dynamic DNS'
+  gem.description            = 'Daemon to update an Amazon Route53 A record with a computer\'s dynamic IPv4 address.'
+  gem.author                 = 'Dhruv Dang'
+  gem.email                  = 'hi@dhruv.io'
+  gem.executables            = `git ls-files -- bin/*`.split("\n").map { |f| File.basename f }
+  gem.files                  = `git ls-files`.split("\n")
+  gem.require_paths          = [ 'lib' ]
+  gem.license                = 'MIT'
+  gem.homepage               = 'https://github.com/dhruvio/rb_dynamic-dns'
+  gem.required_ruby_version  = '>=2.4'
+
+  gem.add_runtime_dependency 'aws-sdk', '~> 2.10', '>= 2.10.9'
+end

data/lib/dynamic_dns/daemon.rb

@@ -0,0 +1,83 @@
+require 'net/http'
+require 'aws-sdk'
+require 'dynamic_dns/dns_updater'
+
+module DynamicDns
+
+  class Daemon
+
+    # create URI to fetch IP address with
+    @@GET_IP_URI = URI('https://ipinfo.io/ip')
+
+    def initialize(domain, subdomain, interval)
+      log 'created instance'
+      # initialize ip address
+      @ip = 'NO_IP_SET'
+      # initialize the daemon IP interval if necessary
+      interval.is_a? Integer or interval = 60
+      @INTERVAL = interval
+      # set up the dns updater instance
+      @UPDATER = DynamicDns::DnsUpdater.new domain, subdomain
+    end
+
+    # accessor methods
+    attr_reader :ip
+    attr_reader :INTERVAL
+
+    # helper to fetch the IP address
+    # returns a string represents the ip address
+    def fetch_ip
+      log 'fetching ip'
+      Net::HTTP.get(@@GET_IP_URI)
+    end
+
+    def start
+      log "starting daemon, will check for new ip every #@INTERVAL seconds"
+      # set up the thread to loop
+      thread = Thread.new do
+        log 'set up thread'
+        loop do
+          log 'start thread loop iteration'
+          # get the ip address
+          # if it has changed, update DNS
+          new_ip = fetch_ip 
+          if new_ip != @ip
+            on_new_ip(new_ip)
+          else
+            log "ip has not changed from #@ip"
+          end
+          # sleep the number of seconds in the interval
+          sleep @INTERVAL
+        end
+      end  
+
+      # ensure thread exits on an exception
+      thread.abort_on_exception = true
+
+      # trap SIGINT to exit threads
+      trap 'SIGINT' do
+        log "received SIGINT, killing thread"
+        thread.kill
+      end
+
+      # keep main thread attached while background thread runs
+      thread.join
+    end
+
+    def on_new_ip(new_ip)
+      log "ip has changed from #@ip to #{new_ip}"
+      #persist new ip to instance
+      @ip = new_ip
+      #notify aws
+      log "update DNS with new IP #@ip"
+      # interval corresponds to ttl in seconds
+      @UPDATER.update_record_ip @ip, @INTERVAL
+    end
+
+    def log(msg)
+      puts "[dynamic-dns:daemon] #{msg}"
+    end
+
+  end
+
+end

data/lib/dynamic_dns/dns_updater.rb

@@ -0,0 +1,74 @@
+require 'aws-sdk'
+require 'json'
+
+module DynamicDns
+
+  class DnsUpdater
+
+    def initialize(domain, subdomain = nil)
+      log 'created instance'
+      # error handling
+      domain.is_a? String or raise RuntimeError, "Invalid domain, must be a String: #{domain}"
+      subdomain and subdomain.is_a? String or raise RuntimeError, "Invalid subdomain, must be nil or a String: #{subdomain}"
+      # set up constants
+      @DOMAIN = domain
+      @NAME = create_name(@DOMAIN, subdomain)
+      @RECORD_TYPE = 'A'
+      @CLIENT = Aws::Route53::Client.new(region: 'us-east-1')
+      # fetch the available hosted zones
+      log('fetch hosted zones')
+      zones = @CLIENT.list_hosted_zones_by_name
+      zones = zones.hosted_zones
+      # search for the hosted zone matching the configured domain
+      log("match hosted zone for domain: #{@DOMAIN}")
+      @ZONE = zones.bsearch { |z| z.name.match?("^#{@DOMAIN}") }
+      @ZONE or raise RuntimeError, "No hosted zones match #{@DOMAIN}"
+    end
+
+    # accessor methods
+    attr_reader :DOMAIN
+    attr_reader :NAME
+
+    def create_name(domain, subdomain)
+      if subdomain
+        "#{subdomain}.#{domain}"
+      else
+        domain
+      end
+    end
+
+    def update_record_ip(ip, ttl = 60)
+      log "update #{@RECORD_TYPE} record for #{@NAME} to point to #{ip}"
+      resp = @CLIENT.change_resource_record_sets({
+        change_batch: {
+          changes: [
+            {
+              action: 'UPSERT',
+              resource_record_set: {
+                name: @NAME,
+                resource_records: [
+                  {
+                    value: ip
+                  }
+                ],
+                type: @RECORD_TYPE,
+                ttl: ttl 
+              }
+            }
+          ],
+          comment: 'Update from dynamic dns ruby script'
+        },
+        hosted_zone_id: @ZONE.id
+      })
+      resp = resp.change_info
+      log "update of id #{resp.id} is #{resp.status} at #{resp.submitted_at}"
+    end
+
+    # prefixed log function
+    def log(msg)
+      puts "[dynamic-dns:dns-updater] #{msg}"
+    end
+
+  end
+
+end

data/lib/dynamic_dns.rb

@@ -0,0 +1,2 @@
+require 'dynamic_dns/daemon'
+require 'dynamic_dns/dns_updater'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: dynamic_dns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhruv Dang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.9
+description: Daemon to update an Amazon Route53 A record with a computer's dynamic
+  IPv4 address.
+email: hi@dhruv.io
+executables:
+- dynamic-dns
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Makefile
+- README.md
+- bin/dynamic-dns
+- dynamic_dns.gemspec
+- lib/dynamic_dns.rb
+- lib/dynamic_dns/daemon.rb
+- lib/dynamic_dns/dns_updater.rb
+homepage: https://github.com/dhruvio/rb_dynamic-dns
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Dynamic DNS
+test_files: []