release: 3.1.0.rc1

Update jaeger-client to version 1.0.0 (#38)

Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com>

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/workflows/cd.yml

@@ -0,0 +1,26 @@
+---
+name: cd
+
+on:
+  push:
+    tags:
+    - 'v*.*.*'
+
+jobs:
+  release-dockerimage:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Extract dyndnsd version from tag name
+      run: |
+        echo ::set-env name=DYNDNSD_VERSION::${GITHUB_REF#refs/*/v}
+    # https://github.com/marketplace/actions/build-and-push-docker-images
+    - name: Build and push Docker image for dyndnsd ${{ env.DYNDNSD_VERSION }}
+      uses: docker/build-push-action@v1
+      with:
+        username: cmur2
+        password: ${{ secrets.DOCKER_TOKEN }}
+        repository: cmur2/dyndnsd
+        path: docker
+        build_args: DYNDNSD_VERSION=${{ env.DYNDNSD_VERSION }}
+        tag_with_ref: true

.github/workflows/vulnscan.yml

@@ -0,0 +1,42 @@
+---
+name: vulnscan
+
+on:
+  schedule:
+  - cron: '7 4 * * 4'  # weekly on thursday morning
+
+jobs:
+  scan-released-dockerimages:
+    runs-on: ubuntu-latest
+    env:
+      TRIVY_LIGHT: 'true'
+      TRIVY_IGNORE_UNFIXED: 'true'
+      TRIVY_REMOVED_PKGS: 'true'
+    steps:
+    - name: Install Trivy
+      run: |
+        mkdir -p $GITHUB_WORKSPACE/bin
+        echo "::add-path::$GITHUB_WORKSPACE/bin"
+        curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/master/contrib/install.sh | sh -s -- -b $GITHUB_WORKSPACE/bin
+    - name: Download Trivy DB
+      run: |
+        trivy image --download-db-only
+    - name: Scan vulnerabilities using Trivy
+      run: |
+        trivy --version
+
+        ALL_IMAGES="$(curl -s https://hub.docker.com/v2/repositories/cmur2/dyndnsd/tags?page_size=1000 | jq -r '.results[].name | "cmur2/dyndnsd:" + .' | grep -e 'cmur2/dyndnsd:v' | sort -r)"
+        EXIT_CODE=0
+        set -e
+        for major_version in $(seq 1 10); do
+          for image in $ALL_IMAGES; do
+            if [[ "$image" = cmur2/dyndnsd:v$major_version.* ]]; then
+              echo -n "\nScanning newest patch release $image of major v$major_version...\n"
+              if ! trivy image --skip-update --exit-code 1 "$image"; then
+                EXIT_CODE=1
+              fi
+              break
+            fi
+          done
+        done
+        exit "$EXIT_CODE"

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.1.0
+
+IMPROVEMENTS:
+
+- Add officially maintained [Docker image for dyndnsd](https://hub.docker.com/r/cmur2/dyndnsd)
+
 ## 3.0.0 (July 29, 2020)
 
 IMPROVEMENTS:

README.md

@@ -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/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/path/to/dyndnsd/db.json:/var/lib/db.json \
+           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
 
-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.
+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](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

Rakefile

@@ -21,4 +21,4 @@ end
 
 task default: [:rubocop, :spec, 'bundle:audit']
 
-task travis: [:default, :'solargraph:tc']
+task travis: [:default, :'solargraph:init', :'solargraph:tc']

docker/Dockerfile

@@ -0,0 +1,15 @@
+FROM alpine:3.12
+
+EXPOSE 5353 8080
+
+ARG DYNDNSD_VERSION=3.0.0
+
+RUN apk --no-cache add openssl ca-certificates && \
+    apk --no-cache add ruby ruby-etc ruby-io-console ruby-json ruby-webrick && \
+    apk --no-cache add --virtual .build-deps ruby-dev build-base tzdata && \
+    gem install --no-document dyndnsd -v ${DYNDNSD_VERSION} && \
+    # set timezone to Berlin
+    cp /usr/share/zoneinfo/Europe/Berlin /etc/localtime && \
+    apk del .build-deps
+
+ENTRYPOINT ["dyndnsd", "/etc/dyndnsd/config.yml"]

dyndnsd.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.5'
 
   s.add_runtime_dependency 'async-dns', '~> 1.2.0'
-  s.add_runtime_dependency 'jaeger-client', '~> 0.10.0'
+  s.add_runtime_dependency 'jaeger-client', '~> 1.0.0'
   s.add_runtime_dependency 'metriks'
   s.add_runtime_dependency 'opentracing', '~> 0.5.0'
   s.add_runtime_dependency 'rack', '~> 2.0'
@@ -39,6 +39,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 0.88.0'
+  s.add_development_dependency 'rubocop', '~> 0.89.0'
   s.add_development_dependency 'solargraph'
 end

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'

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

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,8 +24,8 @@ 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)
         case status_code
         when 200
@@ -37,8 +37,8 @@ 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_other_response(status_code, headers, _body)
         case status_code
         when 400
@@ -48,8 +48,8 @@ module Dyndnsd
         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")

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,8 +24,8 @@ 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)
         case status_code
         when 200
@@ -37,8 +37,8 @@ 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_other_response(status_code, headers, _body)
         case status_code
         when 400
@@ -48,8 +48,8 @@ module Dyndnsd
         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")

lib/dyndnsd/textfile_reporter.rb

@@ -94,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

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

lib/dyndnsd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dyndnsd
-  VERSION = '3.0.0'
+  VERSION = '3.1.0.rc1'
 end

spec/daemon_spec.rb

@@ -6,7 +6,7 @@ describe Dyndnsd::Daemon do
   include Rack::Test::Methods
 
   def app
-    Dyndnsd.logger = Logger.new(STDOUT)
+    Dyndnsd.logger = Logger.new($stdout)
     Dyndnsd.logger.level = Logger::UNKNOWN
 
     config = {