dyndnsd 2.3.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bfdbe62ef8dcbfc69c8a62e0dd06a2ee5bcdddaf1acc3bbbc5ed238e5286e5f
-  data.tar.gz: a61794c2d98d0aba28fc37ce5ebe7928f4455a2fda5ce945591715db3c85df97
+  metadata.gz: 6c42962fd7f8ba91a340791ff120aff65d5c309fb48f636ecafa7e797b4db080
+  data.tar.gz: d63fcb45a32507f06e238c517f5c5ca9944b0c235e03dc2ea8a8f7f02cdf6f53
 SHA512:
-  metadata.gz: fbeeb01c67a5aeb4098b19d7eb91abaf532b24fc007dec60eff1a3dcba771aa9a1d648fa7041319f770eabc3461ea211c6818dd8c1fb15c9d5b201f5df9c014c
-  data.tar.gz: 907c75c30d95843b0fa32544db157b67dba8921ba167e909e5aeb96133e9abe887a3a4709fa300b4437563bd2f0d558a03ebb18978f030beab043361d421dd6f
+  metadata.gz: 6d287f704fa72399ae818a41fe2b3d152bab9cf7171826189f0332a1f1514540f16374d2465bb502ebbbc2df5b2d64c5a6a21a17109272375ac17ff397a914e1
+  data.tar.gz: e26fb3814134509aee783362f91cae332899135684f1605cbbc4cc752d4c8f888bd8c4148744ab8a6c9f3e7722e2498fbf195b228e68e39e2d48b786b7621ad0

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 3.1.2 (December 20, 2020)
+
+OTHER:
+
+- fixes vulnerabilities in Docker image by using updated Alpine base image
+- start using Github Actions CI for tests and drop Travis CI
+
+## 3.1.1 (October 3, 2020)
+
+IMPROVEMENTS:
+
+- Use webrick gem which contains fixes against [CVE-2020-25613](https://www.ruby-lang.org/en/news/2020/09/29/http-request-smuggling-cve-2020-25613/)
+
+## 3.1.0 (August 19, 2020)
+
+IMPROVEMENTS:
+
+- Add officially maintained [Docker image for dyndnsd](https://hub.docker.com/r/cmur2/dyndnsd)
+
+## 3.0.0 (July 29, 2020)
+
+IMPROVEMENTS:
+
+- Drop EOL Ruby 2.4 and lower support, now minimum version supported is Ruby 2.5
+
 ## 2.3.1 (July 27, 2020)
 
 IMPROVEMENTS:

data/README.md

@@ -1,6 +1,6 @@
 # dyndnsd.rb
 
-[![Build Status](https://travis-ci.org/cmur2/dyndnsd.svg?branch=master)](https://travis-ci.org/cmur2/dyndnsd) [![Dependencies](https://badges.depfu.com/badges/4f25da8493f7a29f652ac892fbf9227b/overview.svg)](https://depfu.com/github/cmur2/dyndnsd)
+![ci](https://github.com/cmur2/dyndnsd/workflows/ci/badge.svg) [![Dependencies](https://badges.depfu.com/badges/4f25da8493f7a29f652ac892fbf9227b/overview.svg)](https://depfu.com/github/cmur2/dyndnsd)
 
 A small, lightweight and extensible DynDNS server written with Ruby and Rack.
 
@@ -64,7 +64,42 @@ users:
 
 Run dyndnsd.rb by:
 
-	dyndnsd /path/to/config.yaml
+```bash
+dyndnsd /path/to/config.yml
+```
+
+
+### Docker image
+
+There is an officially maintained [Docker image for dyndnsd](https://hub.docker.com/r/cmur2/dyndnsd) available at Dockerhub. The goal is to have a minimal secured image available (currently based on Alpine) that works well for the `zone_transfer_server` updater use case.
+
+Users can make extensions by deriving from the official Docker image or building their own.
+
+The Docker image consumes the same configuration file in YAML format as the gem, inside the container it needs to be mounted/available as `/etc/dyndnsd/config.yml`. the following YAML should be used as a base and extended with user's settings:
+
+```yaml
+host: "0.0.0.0"
+port: 8080
+# omit the logfile: option so logging to STDOUT will happen automatically
+db: "/var/lib/dyndnsd/db.json"
+
+# User's settings for updater and permissions follow here!
+```
+
+more ports might be needed depending on if DNS zone transfer is needed
+
+Run the Docker image exposing the DynDNS-API on host port 8080 via:
+
+```bash
+docker run -d --name dyndnsd \
+           -p 8080:8080 \
+           -v /host/path/to/dyndnsd/config.yml:/etc/dyndnsd/config.yml \
+           -v /host/ptherpath/to/dyndnsd/datadir:/var/lib/dyndnsd \
+           cmur2/dyndnsd:vX.Y.Z
+```
+
+*Note*: You may need to expose more then just port 8080 e.g. if you use the `zone_transfer_server` which can be done by appending additional `-p 5353:5353` flags to the `docker run` command.
+
 
 
 ## Using dyndnsd.rb with any nameserver via DNS zone transfers (AXFR)
@@ -187,9 +222,11 @@ If you want to provide an additional IPv6 address as myip6 parameter, the myip p
 Use a webserver as a proxy to handle SSL and/or multiple listen addresses and ports. DynDNS.com provides HTTP on port 80 and 8245 and HTTPS on port 443.
 
 
-### Init scripts
+### Startup
+
+There is a [Dockerfile](docs/Dockerfile) that can be used to build a Docker image for running dyndnsd.rb.
 
-The [Debian 6 init.d script](init.d/debian-6-dyndnsd) assumes that dyndnsd.rb is installed into the system ruby (no RVM support) and the config.yaml is at /opt/dyndnsd/config.yaml. Modify to your needs.
+The [Debian 6 init.d script](docs/debian-6-init-dyndnsd) assumes that dyndnsd.rb is installed into the system ruby (no RVM support) and the config.yaml is at /opt/dyndnsd/config.yaml. Modify to your needs.
 
 
 ### Monitoring

data/lib/dyndnsd.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'date'
 require 'etc'
 require 'logger'
 require 'ipaddr'
@@ -80,7 +81,7 @@ module Dyndnsd
     end
 
     # @param env [Hash{String => String}]
-    # @return [Array{Integer,Hash{String => String},Array{String}}]
+    # @return [Array{Integer,Hash{String => String},Array<String>}]
     def call(env)
       return [422, {'X-DynDNS-Response' => 'method_forbidden'}, []] if env['REQUEST_METHOD'] != 'GET'
       return [422, {'X-DynDNS-Response' => 'not_found'}, []] if env['PATH_INFO'] != '/nic/update'
@@ -134,7 +135,7 @@ module Dyndnsd
     private
 
     # @param params [Hash{String => String}]
-    # @return [Array{String}]
+    # @return [Array<String>]
     def extract_v4_and_v6_address(params)
       return [] if !(params['myip'])
       begin
@@ -148,7 +149,7 @@ module Dyndnsd
 
     # @param env [Hash{String => String}]
     # @param params [Hash{String => String}]
-    # @return [Array{String}]
+    # @return [Array<String>]
     def extract_myips(env, params)
       # require presence of myip parameter as valid IPAddr (v4) and valid myip6
       return extract_v4_and_v6_address(params) if params.key?('myip6')
@@ -164,8 +165,8 @@ module Dyndnsd
     end
 
     # @param hostnames [String]
-    # @param myips [Array{String}]
-    # @return [Array{Symbol}]
+    # @param myips [Array<String>]
+    # @return [Array<Symbol>]
     def process_changes(hostnames, myips)
       changes = []
       Helper.span('process_changes') do |span|
@@ -200,7 +201,7 @@ module Dyndnsd
     end
 
     # @param env [Hash{String => String}]
-    # @return [Array{Integer,Hash{String => String},Array{String}}]
+    # @return [Array{Integer,Hash{String => String},Array<String>}]
     def handle_dyndns_request(env)
       params = Rack::Utils.parse_query(env['QUERY_STRING'])
 
@@ -245,7 +246,7 @@ module Dyndnsd
       if config['logfile']
         Dyndnsd.logger = Logger.new(config['logfile'])
       else
-        Dyndnsd.logger = Logger.new(STDOUT)
+        Dyndnsd.logger = Logger.new($stdout)
       end
 
       Dyndnsd.logger.progname = 'dyndnsd'

data/lib/dyndnsd/generator/bind.rb

@@ -27,7 +27,7 @@ module Dyndnsd
           ips.each do |ip|
             ip = IPAddr.new(ip).native
             type = ip.ipv6? ? 'AAAA' : 'A'
-            name = hostname.chomp('.' + @domain)
+            name = hostname.chomp(".#{@domain}")
             out << "#{name} IN #{type} #{ip}"
           end
         end

data/lib/dyndnsd/helper.rb

@@ -60,7 +60,7 @@ module Dyndnsd
           message: e.message,
           stack: e.backtrace&.join("\n") || ''
         )
-        raise
+        raise e
       ensure
         scope.close
       end

data/lib/dyndnsd/responder/dyndns_style.rb

@@ -9,7 +9,7 @@ module Dyndnsd
       end
 
       # @param env [Hash{String => String}]
-      # @return [Array{Integer,Hash{String => String},Array{String}}]
+      # @return [Array{Integer,Hash{String => String},Array<String>}]
       def call(env)
         @app.call(env).tap do |status_code, headers, body|
           if headers.key?('X-DynDNS-Response')
@@ -24,30 +24,32 @@ module Dyndnsd
 
       # @param status_code [Integer]
       # @param headers [Hash{String => String}]
-      # @param body [Array{String}]
-      # @return [Array{Integer,Hash{String => String},Array{String}}]
+      # @param body [Array<String>]
+      # @return [Array{Integer,Hash{String => String},Array<String>}]
       def decorate_dyndnsd_response(status_code, headers, body)
-        if status_code == 200
+        case status_code
+        when 200
           [200, {'Content-Type' => 'text/plain'}, [get_success_body(body[0], body[1])]]
-        elsif status_code == 422
+        when 422
           error_response_map[headers['X-DynDNS-Response']]
         end
       end
 
       # @param status_code [Integer]
       # @param headers [Hash{String => String}]
-      # @param _body [Array{String}]
-      # @return [Array{Integer,Hash{String => String},Array{String}}]
+      # @param _body [Array<String>]
+      # @return [Array{Integer,Hash{String => String},Array<String>}]
       def decorate_other_response(status_code, headers, _body)
-        if status_code == 400
+        case status_code
+        when 400
           [status_code, headers, ['Bad Request']]
-        elsif status_code == 401
+        when 401
           [status_code, headers, ['badauth']]
         end
       end
 
-      # @param changes [Array{Symbol}]
-      # @param myips [Array{String}]
+      # @param changes [Array<Symbol>]
+      # @param myips [Array<String>]
       # @return [String]
       def get_success_body(changes, myips)
         changes.map { |change| "#{change} #{myips.join(' ')}" }.join("\n")

data/lib/dyndnsd/responder/rest_style.rb

@@ -9,7 +9,7 @@ module Dyndnsd
       end
 
       # @param env [Hash{String => String}]
-      # @return [Array{Integer,Hash{String => String},Array{String}}]
+      # @return [Array{Integer,Hash{String => String},Array<String>}]
       def call(env)
         @app.call(env).tap do |status_code, headers, body|
           if headers.key?('X-DynDNS-Response')
@@ -24,30 +24,32 @@ module Dyndnsd
 
       # @param status_code [Integer]
       # @param headers [Hash{String => String}]
-      # @param body [Array{String}]
-      # @return [Array{Integer,Hash{String => String},Array{String}}]
+      # @param body [Array<String>]
+      # @return [Array{Integer,Hash{String => String},Array<String>}]
       def decorate_dyndnsd_response(status_code, headers, body)
-        if status_code == 200
+        case status_code
+        when 200
           [200, {'Content-Type' => 'text/plain'}, [get_success_body(body[0], body[1])]]
-        elsif status_code == 422
+        when 422
           error_response_map[headers['X-DynDNS-Response']]
         end
       end
 
       # @param status_code [Integer]
       # @param headers [Hash{String => String}]
-      # @param _body [Array{String}]
-      # @return [Array{Integer,Hash{String => String},Array{String}}]
+      # @param _body [Array<String>]
+      # @return [Array{Integer,Hash{String => String},Array<String>}]
       def decorate_other_response(status_code, headers, _body)
-        if status_code == 400
+        case status_code
+        when 400
           [status_code, headers, ['Bad Request']]
-        elsif status_code == 401
+        when 401
           [status_code, headers, ['Unauthorized']]
         end
       end
 
-      # @param changes [Array{Symbol}]
-      # @param myips [Array{String}]
+      # @param changes [Array<Symbol>]
+      # @param myips [Array<String>]
       # @return [String]
       def get_success_body(changes, myips)
         changes.map { |change| change == :good ? "Changed to #{myips.join(' ')}" : "No change needed for #{myips.join(' ')}" }.join("\n")

data/lib/dyndnsd/textfile_reporter.rb

@@ -18,7 +18,7 @@ module Dyndnsd
 
       @registry  = options[:registry] || Metriks::Registry.default
       @interval  = options[:interval] || 60
-      @on_error  = options[:on_error] || proc { |ex| }
+      @on_error  = options[:on_error] || proc { |ex| } # default: ignore errors
     end
 
     # @return [void]
@@ -28,11 +28,9 @@ module Dyndnsd
           sleep @interval
 
           Thread.new do
-            begin
-              write
-            rescue StandardError => e
-              @on_error[e] rescue nil
-            end
+            write
+          rescue StandardError => e
+            @on_error[e] rescue nil
           end
         end
       end
@@ -96,8 +94,8 @@ module Dyndnsd
     # @param file [String]
     # @param base_name [String]
     # @param metric [Object]
-    # @param keys [Array{Symbol}]
-    # @param snapshot_keys [Array{Symbol}]
+    # @param keys [Array<Symbol>]
+    # @param snapshot_keys [Array<Symbol>]
     # @return [void]
     def write_metric(file, base_name, metric, keys, snapshot_keys = [])
       time = Time.now.to_i

data/lib/dyndnsd/updater/zone_transfer_server.rb

@@ -85,7 +85,7 @@ module Dyndnsd
 
       # converts into suitable parameter form for Async::DNS::Resolver or Async::DNS::Server
       #
-      # @param endpoint_list [Array{String}]
+      # @param endpoint_list [Array<String>]
       # @return [Array{Array{Object}}]
       def self.parse_endpoints(endpoint_list)
         endpoint_list.map { |addr_string| addr_string.split('@') }
@@ -139,7 +139,7 @@ module Dyndnsd
 
       # @param name [String]
       # @param resource_class [Resolv::DNS::Resource]
-      # @param transaction [Async::DNS::Transaction]
+      # Since solargraph cannot parse this: param transaction [Async::DNS::Transaction]
       # @return [void]
       def process(name, resource_class, transaction)
         if name != @domain || resource_class != Resolv::DNS::Resource::Generic::Type252_Class1

data/lib/dyndnsd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dyndnsd
-  VERSION = '2.3.1'
+  VERSION = '3.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dyndnsd
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-dns
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: metriks
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -170,28 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
-- !ruby/object:Gem::Dependency
-  name: solargraph
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
 description: A small, lightweight and extensible DynDNS server written with Ruby and
   Rack.
 email: 
@@ -207,7 +207,6 @@ files:
 - LICENSE
 - README.md
 - exe/dyndnsd
-- init.d/debian-6-dyndnsd
 - lib/dyndnsd.rb
 - lib/dyndnsd/database.rb
 - lib/dyndnsd/generator/bind.rb
@@ -233,14 +232,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: dyndnsd.rb

data/init.d/debian-6-dyndnsd

@@ -1,43 +0,0 @@
-#! /bin/sh
-### BEGIN INIT INFO
-# Provides:          dyndnsd
-# Required-Start:    $remote_fs $syslog
-# Required-Stop:     $remote_fs $syslog
-# Default-Start:     2 3 4 5
-# Default-Stop:      0 1 6
-# Short-Description: Handle dyndnsd.rb gem
-### END INIT INFO
-
-# using the system ruby's gem binaries directory
-DAEMON="/var/lib/gems/1.8/bin/dyndnsd"
-
-CONFIG_FILE="/opt/dyndnsd/config.yaml"
-
-DAEMON_OPTS="$CONFIG_FILE"
-
-test -x $DAEMON || exit 0
-
-. /lib/lsb/init-functions
-
-case "$1" in
-  start)
-    log_daemon_msg "Starting dyndnsd.rb" "dyndnsd"
-    start-stop-daemon --start --quiet --oknodo --make-pidfile --pidfile "/var/run/dyndnsd.pid" --background --exec $DAEMON -- $DAEMON_OPTS
-    log_end_msg $?
-    ;;
-  stop)
-    log_daemon_msg "Stopping dyndnsd.rb" "dyndnsd"
-    start-stop-daemon --stop --quiet --oknodo --pidfile "/var/run/dyndnsd.pid"
-    log_end_msg $?
-    ;;
-  restart|force-reload)
-    log_daemon_msg "Restarting dyndnsd.rb" "dyndnsd"
-    start-stop-daemon --stop --quiet --oknodo --retry 30 --pidfile "/var/run/dyndsd.pid"
-    start-stop-daemon --start --quiet --oknodo --make-pidfile --pidfile "/var/run/dyndnsd.pid" --background --exec $DAEMON -- $DAEMON_OPTS
-    log_end_msg $?
-    ;;
-  *)
-    log_action_msg "Usage: $0 {start|stop|restart|force-reload}"
-    exit 2
-    ;;
-esac