DNSUpdater 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f825b3799de70e518a4216e6962814d8dfe9ef3e834f93d251fddaa269e4974
+  data.tar.gz: 909d0c529ea9fb6b974969e4cde18a39a97ad685fce54e1156e619afc9fb3479
+SHA512:
+  metadata.gz: f30c522ac33ee2a56dcff7244e351a108f8de42847c55e2ca6661812f8d834f3a358215162e69f479c6a8bc306c5d06504e4b2af08304ca1fb7a5a573b027c64
+  data.tar.gz: 4da0b59cbb3c4ebbb8feddb9f7f884e1a386ce425268b93de1688a4c21d53374c2637131380d203511d53c0b24f5792b0c3053f701c88f0c56f2537a93296ec0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+

data/.rubocop.yml

@@ -0,0 +1,56 @@
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/IndentationWidth:
+    Width: 4
+
+Layout/EndOfLine:
+    EnforcedStyle: lf
+
+Layout/LineLength:
+    Enabled: false
+
+Lint/UnusedMethodArgument:
+    Enabled: false
+
+Naming/MethodName:
+    EnforcedStyle: camelCase
+
+Naming/VariableName:
+    Enabled: false
+    EnforcedStyle: camelCase
+
+Naming/BlockParameterName:
+    Enabled: false
+
+Naming/MethodParameterName:
+    Enabled: false
+    AllowedNames:
+        - a
+        - b
+
+Metrics/AbcSize:
+    Max: 35
+
+Metrics/MethodLength:
+    Max: 25
+
+Metrics/ClassLength:
+    Max: 200
+
+Metrics/CyclomaticComplexity:
+    Max: 10
+
+Style/ClassVars:
+    Enabled: false
+
+Style/GlobalVars:
+    AllowedVariables:
+        - $spec
+
+Metrics/BlockLength:
+    Max: 35
+    Exclude:
+        - spec/*_spec.rb
+        - spec/updaters/*_spec.rb

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--markup-provider=redcarpet
+- UNLICENSE
+- CHANGELOG.md
+- config_example.yaml
+

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+
+# DNSUpdater - Dynamic DNS (DDNS)
+
+## Changelog
+
+### 1.0.0 / 2020-01-02
+
+* DNS updater implementation
+* PowerDNS support
+* SSH support
+* HTTP client and server support
+* Test implementation
+* Basic documentation and README
+

data/DNSUpdater.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dnsupdater/version'
+
+Gem::Specification.new do |spec|
+    spec.name = 'DNSUpdater'
+    spec.version       = DNSUpdater::VERSION
+    spec.authors       = ['Dāvis']
+    spec.email         = ['davispuh@gmail.com']
+
+    spec.summary       = 'An application to dynamically and remotely update DNS.'
+    spec.description   = 'Using this application you can configure local or remote (over SSH or HTTP) DNS such as PowerDNS.'
+    spec.homepage      = 'https://github.com/davispuh/DNSUpdater'
+    spec.license       = 'UNLICENSE'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage + '/blob/master/CHANGELOG.md'
+
+    # Specify which files should be added to the gem when it is released.
+    # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+    spec.files = Dir.chdir(File.expand_path(__dir__)) do
+        `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+    spec.bindir        = 'exe'
+    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ['lib']
+
+    spec.add_dependency 'addressable'
+    spec.add_dependency 'idn-ruby'
+    spec.add_dependency 'pdns_api'
+    spec.add_dependency 'public_suffix'
+    spec.add_dependency 'puma'
+    spec.add_dependency 'rack'
+
+    spec.add_development_dependency 'bundler', '~> 2.0'
+    spec.add_development_dependency 'irb'
+    spec.add_development_dependency 'rake', '~> 10.0'
+    spec.add_development_dependency 'redcarpet'
+    spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'simplecov'
+    spec.add_development_dependency 'webmock', '>= 3.7'
+    spec.add_development_dependency 'yard'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in DNSUpdater.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    DNSUpdater (1.0.0)
+      addressable
+      idn-ruby
+      pdns_api
+      public_suffix
+      puma
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    hashdiff (1.0.0)
+    idn-ruby (0.1.0)
+    io-console (0.5.3)
+    irb (1.2.1)
+      reline (>= 0.0.1)
+    json (2.3.0)
+    nio4r (2.5.2)
+    pdns_api (0.1.3)
+    public_suffix (4.0.2)
+    puma (4.3.1)
+      nio4r (~> 2.0)
+    rack (2.0.8)
+    rake (10.5.0)
+    redcarpet (3.5.0)
+    reline (0.1.2)
+      io-console (~> 0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    safe_yaml (1.0.5)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  DNSUpdater!
+  bundler (~> 2.0)
+  irb
+  rake (~> 10.0)
+  redcarpet
+  rspec (~> 3.0)
+  simplecov
+  webmock (>= 3.7)
+  yard
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,138 @@
+# DNSUpdater - Dynamic DNS (DDNS)
+
+Using this application you can update DNS records on local or remote (over SSH or HTTP) DNS server (eg. PowerDNS).
+
+For example if you have dynamic IP you can use this application to automatically update DNS record with your external IP.
+
+## Installation
+
+First you need to have Ruby and RubyGems.
+Then you can install it with:
+
+```sh
+$ gem install DNSUpdater
+```
+
+### Install Systemd service files
+
+```sh
+$ cp service/dnsupdater.{service,timer} /etc/systemd/system/
+$ systemctl enable dnsupdater.timer
+```
+
+Note that you'll need to edit `/etc/systemd/system/dnsupdater.service` to set target domain.
+
+### Configure
+
+Create `/etc/dnsupdater.yaml` with your settings, take a look at [config_example.yaml](config_example.yaml).
+
+By default configuration file will be looked into current directory as `config.yaml` or in `/etc/dnsupdater.yaml`.
+But you can specify any config path with `-c` flag.
+
+## Usage
+
+```sh
+$ updateDNS -h
+Usage: updateDNS [options] <target>
+    -c, --config config.yaml         Path to config file
+    -t, --target=PROTOCOL            Target protocol (useful for SSH)
+    -s, --serve                      Serve/handle HTTP
+    -h, --help                       Show this message
+
+Supported targets are: http, https, powerdns, ssh
+Target examples:
+* default:///example.com/10.0.0.1
+* ssh://dns.example.com:123/example.org/client
+* http://example.org/dns.example.com/127.0.0.1,192.168.1.1
+```
+
+### Update DNS record on locally installed PowerDNS
+
+`$ updateDNS powerdns:///domain.example.com/192.168.1.1`
+
+Note that you'll need to set PowerDNS HTTP API key in config.
+
+### Update DNS record on remote PowerDNS over SSH with current external IP
+
+`$ updateDNS ssh://ssh.example.org/domain.example.com/client`
+
+`client` as IP means that DNS record will be updated with your external IP (client IP from target DNS server point).
+
+SSH settings can also be configured in `~/.ssh/config` which will be respected.
+
+### HTTP server mode
+
+DNSUpdater can also work as HTTP server and update DNS records from clients.
+
+`$ updateDNS --serve http://192.168.1.2/`
+
+For authentication you'll need to set `SharedSecret` in config.
+Also I recommend placing it behind Nginx.
+
+Then clients can do
+```
+$ updateDNS http://192.168.1.2/domain.example.com/client
+```
+
+PS. It also accepts DynDNS format: `/nic/update?hostname=yourhostname&myip=ipaddress`
+
+### Update DNS record on firewalled remote PowerDNS over SSH with HTTP
+
+Suppose you have 3 machines:
+
+`A` - internal firewalled PowerDNS server which isn't accessible publicly.
+
+`B` - publicly accessible HTTP server.
+
+`C` - client who's external IP you want to set.
+
+
+On `B` you would run `updateDNS -s` in HTTP server mode configured that it updates PowerDNS on `A` over SSH.
+
+On `C` you would run `updateDNS https://B/mydomain.example.com/client`
+
+## Updaters/Providers
+
+Basically currently there's support only for PowerDNS and don't have BIND support,
+but it should be pretty easy to add support for others so just send a PR :)
+
+## Documentation
+
+YARD with markdown is used for documentation (`redcarpet` required)
+
+## Specs
+
+RSpec and simplecov are required, to run tests just `rake spec`
+code coverage will also be generated
+
+## Code status
+[![Gem Version](https://badge.fury.io/rb/DNSUpdater.png)](http://badge.fury.io/rb/DNSUpdater)
+[![Build Status](https://travis-ci.org/davispuh/DNSUpdater.png?branch=master)](https://travis-ci.org/davispuh/DNSUpdater)
+[![Coverage Status](https://coveralls.io/repos/davispuh/DNSUpdater/badge.png?branch=master)](https://coveralls.io/r/davispuh/DNSUpdater?branch=master)
+
+## Unlicense
+
+![Copyright-Free](http://unlicense.org/pd-icon.png)
+
+All text, documentation, code and files in this repository are in public domain (including this text, README).
+It means you can copy, modify, distribute and include in your own work/code, even for commercial purposes, all without asking permission.
+
+[About Unlicense](http://unlicense.org/)
+
+## Contributing
+
+Feel free to improve as you see.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Export `.yaml` data files to binary `.dat` with `rake export`
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+
+**Warning**: By sending pull request to this repository you dedicate any and all copyright interest in pull request (code files and all other) to the public domain. (files will be in public domain even if pull request doesn't get merged)
+
+Also before sending pull request you acknowledge that you own all copyrights or have authorization to dedicate them to public domain.
+
+If you don't want to dedicate code to public domain or if you're not allowed to (eg. you don't own required copyrights) then DON'T send pull request.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+task(default: :spec)

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require_relative '../lib/dnsupdater'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)