radd 1.4.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f979c2d87f1f25eb5c780da9d4d5ecb0543c299bee5d7e73a046825357759d1f
-  data.tar.gz: 8f92e1c1018b4a5ea9f86e138f3a439e4bd76eaadbfe4ab78a91ecc15d12b33f
+  metadata.gz: 8ce6277f2c17ee82c7e873be185b142c0bf8cd4fcfe5faf7b6287360e9a5de77
+  data.tar.gz: 9bcb6d8caa6fd25c73dd284ad556ec3be6071b38bca02adbe4b2a0ee24edf0b2
 SHA512:
-  metadata.gz: b7e11faf5690621e6027d2356c7ee403488fabf29caa0d5007a2e8d6b8ed8319f3b3ce8373e2f0f97905516f0eea9c263f824da406b067ab188ce0c8936d9fdf
-  data.tar.gz: 64f91eb6deccbaf8932960b620f65b1f87807c19d7a6492e44a8fa836608cfefe226b25ffde0d3bdec69434742e38bd3e5086bd1f251f11e5c17e451aa2e449f
+  metadata.gz: 529ba3c5d7129dc4ba5e783c75e82617ee095578558e7dc23c54ea1aa7439e9c02a5410bf7e40257dcaeff2162e59cc0ee055c9626d11a51ce09b6557124f744
+  data.tar.gz: d102da674aea8d27f70cca080c197ac5646e3786327d37e2ed25ab0e216eed128b5b2d2ba9bd5b5987cffce2eae50801eeb58037be1ed8ef9dc8468a1da460d6

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/radd.svg)](http://badge.fury.io/rb/radd)
+[![build](https://github.com/mtgrosser/radd/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/radd/actions/workflows/build.yml)
+
 # radd
 
 Minimal dynamic DNS service
@@ -13,15 +16,41 @@ gem install radd
 
 ```yaml
 # radd.yml
+origin: ddns.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 +66,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'].split('.').freeze
-      @rname = encode_email(config['rname'] || "hostmaster@#{domain}").freeze
+      @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
@@ -39,13 +39,6 @@ module Radd
     def valid_ip?(ip)
       !!(ip && ip.match(Resolv::IPv4::Regex))
     end
-
-    private
-
-    def encode_email(email)
-      addr, domain = email.split('@')
-      [addr, *domain.split('.')]
-    end
   end
 
 end

data/lib/radd/nameserver.rb

@@ -9,11 +9,13 @@ module Radd
       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.domain == name ? Radd.ip : Radd.query(name)
+        ip = [Radd.mname, Radd.origin].include?(name) ? Radd.ip : Radd.query(name)
         return transaction.respond!(ip, ttl: Radd.ttl) if ip
-      elsif resource_class <= Resolv::DNS::Resource::SOA && Radd.domain == name
+      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

data/lib/radd/update.rb

@@ -32,7 +32,7 @@ module Radd
       record.ip = ip
       record.save
       Radd.logger.info "Updated record #{record.name} to #{ip} from #{remote_ip}"
-      [200, {'Content-Type' => 'text/plain'}, ["OK #{ip}"]]
+      [200, {'Content-Type' => 'text/plain'}, ["OK #{ip}\n"]]
     rescue RaddError => boom
       status = case boom
       when InvalidRequest, Sequel::ValidationFailed then 422

data/lib/radd/version.rb

@@ -1,3 +1,3 @@
 module Radd
-  VERSION = '1.4.1'
+  VERSION = '1.5.2'
 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.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Matthias Grosser
@@ -177,6 +177,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Minimal dynamic DNS service
 email: mtgrosser@gmx.net
 executables: