radd 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9fddd23ad9d4e45fcfef31f6e5d976b13511fc6089a3f77267395ff8d62bfb6
-  data.tar.gz: 530c66e7a340a9709de98025c4cc697b50d1358371d7ef7e351cd756a30611f8
+  metadata.gz: 84f6d38880accb181b5d1976dd49f1492e45cbd69a5e7c93ca3727b131a00698
+  data.tar.gz: 6fcd72a269a6f52b99810912620ba7a243680827c01b43e9579efbeb4962d4d2
 SHA512:
-  metadata.gz: f0a3ff47b7c18794df7a34972dacc6ec4434c9dc1b749797655518e79d5509fbc4d01326d34906c3904c22498663cce5224d4214b593cf91588398c3c29ab6cf
-  data.tar.gz: 431664ea22d21ba782c577c940746bfd43083855054cf60befb9b6414d52d3ba281524448eb8639b19a77549440749f43a0528564c6fa0e22992146eaf00175b
+  metadata.gz: 7dac0c7f9dd9b61b1a28d47276be853867cb3055d0720bffcfe41028dae4a29d2f4b7ca930c35756206de76aaedcf4680b42c5af3e601491b3179a2660168a1e
+  data.tar.gz: 41db151db1e4d9cdd156a71ea4ccb1e3abb16b63659a974bc98a35d48fb38269f1ad8308234a0b4b023634ee7fe457857ead1fdfeb1935b9661a968ff07dc605

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/radd.svg)](http://badge.fury.io/rb/radd)
+
 # radd
 
 Minimal dynamic DNS service
@@ -13,15 +15,41 @@ gem install radd
 
 ```yaml
 # radd.yml
+origin: domains.example.com
 ip: 10.1.2.3
-http: 127.0.0.1:3000
-dns: 0.0.0.0:53
-domain: example.com
 mname: ns.example.com
 rname: hostmaster.example.com
+ttl: 300
+http: 127.0.0.1:3000
+dns: 0.0.0.0:53
 db: radd.sqlite3
 ```
 
+#### origin
+Your domain where subdomains are the dynamic hostnames
+
+#### ip
+The nameserver's public IP
+
+#### mname
+Hostname of the nameserver, must not be a subdomain of `origin`
+
+#### rname
+Email address of the nameserver contact, default: `hostmaster.ORIGIN`
+
+#### ttl
+TTL of the dynamic A records, default: `300`
+
+#### http
+`ÌP:port` the HTTP server should listen on, default: `127.0.0.1:3003`
+
+#### dns
+`IP:port` the DNS server should listen on, default: `0.0.0.0:53`
+
+#### db
+Path to the zone db, default: `radd.sqlite3`
+
+
 ## Usage
 
 ```
@@ -37,3 +65,37 @@ delete       Delete record
 list         List available records
 start        Run the server
 ```
+
+## Deployment
+
+### Webserver
+The HTTP server should be exposed via a reverse proxy like Nginx, which provides SSL encryption.
+
+### Nameserver
+The DNS ports (53/udp, 53/tcp) can be exposed directly when using `systemd` to run `radd`.
+The provided unit file (`radd.service`) includes the necessary directives which enable an unprivileged user
+to access port 53.
+
+### DNS configuration
+You need to set your dynamic DNS server as the authoritative nameserver for the used (sub)domain:
+
+```
+NS  ddns.example.com   ns.example.com.   86400
+```
+
+## Updating a record via HTTP
+
+In order to update a record, an authorized request must be made to the `/update` endpoint.
+
+The hostname is determined by the HTTP user name.
+The IP address can be supplied by the `ip` parameter, otherwise, the remote IP of the request will be used:
+
+```
+# use remote IP
+curl --user "hostname:password" https://ddns.example.com/update
+```
+
+```
+# use given IP
+curl --user "hostname:password" https://ddns.example.com/update?ip=10.20.30.40
+```

data/lib/radd/cli.rb

@@ -100,7 +100,7 @@ module Radd::Cli
 
     def start
       load_config
-      puts "Starting Radd server for #{Radd.domain}"
+      puts "Starting Radd server for #{Radd.origin}"
 
       dns, http = Radd::Nameserver.new, Radd::Webserver.new
 

data/lib/radd/config.rb

@@ -1,7 +1,7 @@
 module Radd
 
   class << self
-    attr_reader :domain, :ip, :db, :http_host, :http_port, :dns_host, :dns_port, :ttl,
+    attr_reader :origin, :ip, :db, :http_host, :http_port, :dns_host, :dns_port, :ttl,
                 :mname, :rname
     
     def configure!(file, skip_models: false, skip_db: false)
@@ -9,8 +9,8 @@ module Radd
       file_path = Radd.root + file_path unless file_path.absolute?
       raise ConfigurationError, "could not open config file #{file_path}" unless file_path.file?
       config = YAML.load(file_path.read)
-      raise ConfigurationError, 'domain missing' unless config['domain']
-      @domain = config['domain']
+      raise ConfigurationError, 'origin missing' unless config['origin']
+      @origin = config['origin']
       raise ConfigurationError, 'invalid IP' unless Radd.valid_ip?(config['ip'])
       @ip = config['ip']
       uri = URI.parse("http://#{config['http']}")
@@ -22,8 +22,8 @@ module Radd
       raise ConfigurationError, 'invalid TTL' if config['ttl'] && config['ttl'] < 1
       @ttl = config['ttl'] || 300
       raise ConfigurationError, 'master name missing' unless config['mname']
-      @mname = config['mname']
-      @rname = config['rname'] || "hostmaster.#{domain}"
+      @mname = Resolv::DNS::Name.create(config['mname'])
+      @rname = Resolv::DNS::Name.create(config['rname'] || "hostmaster@#{origin}")
       db_path = Pathname.new(config['db'] || 'radd.sqlite3')
       db_path = Radd.root + db_path unless db_path.absolute?
       @db = db_path
@@ -40,5 +40,5 @@ module Radd
       !!(ip && ip.match(Resolv::IPv4::Regex))
     end
   end
-  
+
 end

data/lib/radd/nameserver.rb

@@ -1,17 +1,23 @@
-class Radd::Nameserver < Async::DNS::Server
-  def initialize
-    super(Async::DNS::Endpoint.for(Radd.dns_host, port: Radd.dns_port))
-  end
-  
-  def process(name, resource_class, transaction)
-    name = name.downcase
-    case resource_class
-    when Resolv::DNS::Resource::IN::A
-      ip = Radd.domain == name ? Radd.ip : Radd.query(name)
-      return transaction.respond!(ip, ttl: Radd.ttl) if ip
-    when Resolv::DNS::Resource::IN::SOA
-      return transaction.respond!(Radd.mname, Radd.rname, Radd.serial, 10800, 1800, 604800, 1800)
+module Radd
+  class Nameserver < Async::DNS::Server
+
+    def initialize
+      super(Async::DNS::Endpoint.for(Radd.dns_host, port: Radd.dns_port))
+    end
+
+    def process(name, resource_class, transaction)
+      name = name.downcase
+      # NOTE: do not use case..when, as resource classes are not identical
+      if Resolv::DNS::Resource::IN::A == resource_class
+        ip = Radd.mname == name ? Radd.ip : Radd.query(name)
+        return transaction.respond!(ip, ttl: Radd.ttl) if ip
+      elsif resource_class <= Resolv::DNS::Resource::SOA && Radd.origin == name
+        # mname, rname, serial, refresh, retry_, expire, minimum
+        return transaction.respond!(Radd.mname, Radd.rname, Radd.serial, 10800, 1800, 604800, 1800)
+      elsif resource_class <= Resolv::DNS::Resource::NS && Radd.origin == name
+        return transaction.respond!(Radd.mname)
+      end
+      transaction.fail!(:NXDomain)
     end
-    transaction.fail!(:NXDomain)
   end
 end

data/lib/radd/version.rb

@@ -1,3 +1,3 @@
 module Radd
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/lib/radd.rb

@@ -63,7 +63,7 @@ module Radd
     end
 
     def fqdn2name(fqdn)
-      if match = fqdn.downcase.match(/\A([a-z0-9-]{1,63})\.#{Regexp.escape(domain)}\z/)
+      if match = fqdn.downcase.match(/\A([a-z0-9-]{1,63})\.#{Regexp.escape(origin)}\z/)
         match.captures[0]
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: radd
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Matthias Grosser