dyndnsd 3.3.2 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63fbab256de2326bb34f3df754c9aea6729bc73e0f8f203b761b0d23b4de7b11
-  data.tar.gz: a7dd2761c5a4789f755c85cbbcd8ab0d2e18d6ecdc206cc68cb02ccceff9c80f
+  metadata.gz: 9eb3566b683e5a63a61b3f9627faee372f137498652e1d6760f0b4baa4edc986
+  data.tar.gz: 8a412e370ccf739826c79450a6464de68d06e20ae681726c78a3ca97d691b704
 SHA512:
-  metadata.gz: f5aee257b314d8d9ab0451d747302c141bb9f1dafe8c61b8875de21864164426ede50af13a453ab22bc3eac22946e6106fe5f18911cc5e29e674e1594df92f23
-  data.tar.gz: a5b58e8dce042beeb32aa09d56a754c42929be3e6952a7cedc0bc9e9cca774027c33f769d003340e1abdb86fa5d750636e74a8ccfd6361bc3fc2ac860158161b
+  metadata.gz: bb50e6aa85ca663cea2d504c4aa3d42c6f12b17dca08839886e59ad6b0f0b78f50d7ba97757aa1953555fe61dae02a3d1d83aeb88c27ca9d08d6b9ca95049d76
+  data.tar.gz: 8e6e1395d2e52ea14fae024560d8587457562084ec6767ac817bd7837f686069e33eac7885ba63e633e89adbd0b494200aebd344c4c76b95e0474b68ef1b982a

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 3.4.2 (July 30, 2021)
+
+IMPROVEMENTS:
+
+- move from OpenTracing to OpenTelemetry for experimental tracing feature
+
+OTHER:
+
+- re-release 3.4.1 to rebuild Docker image with security vulnerabilities fixes
+- adopt Renovate for dependency updates
+
+## 3.4.1 (April 15, 2021)
+
+OTHER:
+
+- update base of Docker image to Alpine 3.13.5 to fix security vulnerabilities
+
+## 3.4.0 (April 2, 2021)
+
+IMPROVEMENTS:
+
+- **change** Docker image to run as non-root user `65534` by default, limits attack surface for security and gives OpenShift compatibility
+
+## 3.3.3 (April 1, 2021)
+
+OTHER:
+
+- update base of Docker image to Alpine 3.13.4 to fix security vulnerabilities
+
 ## 3.3.2 (February 20, 2021)
 
 OTHER:
@@ -157,7 +186,7 @@ IMPROVEMENTS:
 
 IMPROVEMENTS:
 
-- Support dropping priviliges on startup, also affects external commands run
+- Support dropping privileges on startup, also affects external commands run
 - Add [metriks](https://github.com/eric/metriks) support for basic metrics in the process title
 - Detach from child processes running external commands to avoid zombie processes
 

data/README.md

@@ -75,7 +75,7 @@ There is an officially maintained [Docker image for dyndnsd](https://hub.docker.
 
 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:
+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"
@@ -98,7 +98,7 @@ docker run -d --name 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.
+*Note*: You may need to expose more than 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.
 
 
 
@@ -106,7 +106,7 @@ docker run -d --name dyndnsd \
 
 By using [DNS zone transfers via AXFR (RFC5936)](https://tools.ietf.org/html/rfc5936) any secondary nameserver can retrieve the DNS zone contents from dyndnsd.rb and serve them to clients.
 To speedup propagation after changes dyndnsd.rb can issue a [DNS NOTIFY (RFC1996)](https://tools.ietf.org/html/rfc1996) to inform the nameserver that the DNS zone contents changed and should be fetched even before the time indicated in the SOA record is up.
-Currently dyndnsd.rb does not support any authentication for incoming DNS zone transfer requests so it should be isolated from the internet on these ports.
+Currently, dyndnsd.rb does not support any authentication for incoming DNS zone transfer request, so it should be isolated from the internet on these ports.
 
 This approach has several advantages:
 - dyndnsd.rb can be used in *hidden primary* fashion isolated from client's DNS traffic and does not need to implement full nameserver features
@@ -151,7 +151,7 @@ users:
 
 NSD is a nice, open source, authoritative-only, low-memory DNS server that reads BIND-style zone files (and converts them into its own database) and has a simple configuration file.
 
-A feature NSD is lacking is the [Dynamic DNS update (RFC2136)](https://tools.ietf.org/html/rfc2136) functionality BIND offers but one can fake it using the following dyndnsd.rb configuration:
+A feature NSD is lacking is the [Dynamic DNS update (RFC2136)](https://tools.ietf.org/html/rfc2136) functionality BIND offers, but one can fake it using the following dyndnsd.rb configuration:
 
 ```yaml
 host: "0.0.0.0"
@@ -197,29 +197,29 @@ The update URL you want to tell your clients (humans or scripts ^^) consists of
 
 where:
 
-* the protocol depends on your (webserver/proxy) settings
-* USER and PASSWORD are needed for HTTP Basic Auth and valid combinations are defined in your config.yaml
-* DOMAIN should match what you defined in your config.yaml as domain but may be anything else when using a webserver as proxy
-* PORT depends on your (webserver/proxy) settings
-* HOSTNAMES is a required list of comma-separated FQDNs (they all have to end with your config.yaml domain) the user wants to update
-* MYIP is optional and the HTTP client's IP address will be used if missing
-* MYIP6 is optional but if present also requires presence of MYIP
+* the protocol depends on your (web server/proxy) settings
+* `USER` and `PASSWORD` are needed for HTTP Basic Auth and valid combinations are defined in your config.yaml
+* `DOMAIN` should match what you defined in your config.yaml as domain but may be anything else when using a web server as proxy
+* `PORT` depends on your (web server/proxy) settings
+* `HOSTNAMES` is a required list of comma-separated FQDNs (they all have to end with your config.yaml domain) the user wants to update
+* `MYIP` is optional and the HTTP client's IP address will be used if missing
+* `MYIP6` is optional but if present also requires presence of `MYIP`
 
 
 ### IP address determination
 
 The following rules apply:
 
-* use any IP address provided via the myip parameter when present, or
-* use any IP address provided via the X-Real-IP header e.g. when used behind HTTP reverse proxy such as nginx, or
+* use any IP address provided via the `myip` parameter when present, or
+* use any IP address provided via the `X-Real-IP` header e.g. when used behind HTTP reverse proxy such as nginx, or
 * use any IP address used by the connecting HTTP client
 
-If you want to provide an additional IPv6 address as myip6 parameter, the myip parameter containing an IPv4 address has to be present, too! No automatism is applied then.
+If you want to provide an additional IPv6 address as myip6 parameter, the `myip` parameter containing an IPv4 address has to be present, too! No automatism is applied then.
 
 
 ### SSL, multiple listen ports
 
-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.
+Use a web server 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.
 
 
 ### Startup
@@ -231,7 +231,7 @@ The [Debian 6 init.d script](docs/debian-6-init-dyndnsd) assumes that dyndnsd.rb
 
 ### Monitoring
 
-For monitoring dyndnsd.rb uses the [metriks](https://github.com/eric/metriks) framework and exposes several metrics like the number of unauthenticated requests, requests that did (not) update a hostname, etc. By default the most important metrics are shown in the [proctitle](https://github.com/eric/metriks#proc-title-reporter) but you can also configure a [Graphite](https://graphiteapp.org/) backend for central monitoring or the [textfile_reporter](https://github.com/prometheus/node_exporter/#textfile-collector) which outputs Graphite-style metrics that are also compatible with Prometheus to a file.
+For monitoring dyndnsd.rb uses the [metriks](https://github.com/eric/metriks) framework and exposes several metrics like the number of unauthenticated requests, requests that did (not) update a hostname, etc. By default, the most important metrics are shown in the [proctitle](https://github.com/eric/metriks#proc-title-reporter, butt you can also configure a [Graphite](https://graphiteapp.org/) backend for central monitoring or the [textfile_reporter](https://github.com/prometheus/node_exporter/#textfile-collector) which outputs Graphite-style metrics that are also compatible with Prometheus to a file.
 
 ```yaml
 host: "0.0.0.0"
@@ -271,9 +271,9 @@ users:
 
 ### Tracing (experimental)
 
-For tracing, dyndnsd.rb is instrumented using the [OpenTracing](http://opentracing.io/) framework and will emit span tracing data for the most important operations happening during the request/response cycle. Using a middleware for Rack allows handling incoming OpenTracing span information properly.
+For tracing, dyndnsd.rb is instrumented using the [OpenTelemetry](https://opentelemetry.io/docs/ruby/) framework and will emit span tracing data for the most important operations happening during the request/response cycle. Using an [instrumentation for Rack](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/rack) allows handling incoming OpenTelemetry parent span information properly (when desired, turned off by default to reduce attack surface).
 
-Currently only one OpenTracing-compatible tracer implementation named [CNCF Jaeger](https://github.com/jaegertracing/jaeger) can be configured to use with dyndnsd.rb.
+Currently, the [OpenTelemetry trace exporter](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/jaeger) for [CNCF Jaeger](https://github.com/jaegertracing/jaeger) can be enabled via dyndnsd.rb configuration. Alternatively, you can also enable other exporters via the environment variable `OTEL_TRACES_EXPORTER`, e.g. `OTEL_TRACES_EXPORTER=console`.
 
 ```yaml
 host: "0.0.0.0"
@@ -282,11 +282,9 @@ db: "/opt/dyndnsd/db.json"
 domain: "dyn.example.org"
 # enable and configure tracing using the (currently only) tracer jaeger
 tracing:
-  trust_incoming_span: false # default value, change to accept incoming OpenTracing spans as parents
-  jaeger:
-    host: 127.0.0.1 # defaults for host and port of local jaeger-agent
-    port: 6831
-    service_name: "my.dyndnsd.identifier"
+  trust_incoming_span: false # default value, change to accept incoming OpenTelemetry spans as parents
+  service_name: "my.dyndnsd.identifier" # default unset, will be populated by OpenTelemetry
+  jaeger: true # enables the Jaeger AgentExporter
 # configure the updater, here we use command_with_bind_zone, params are updater-specific
 updater:
   name: "command_with_bind_zone"

data/lib/dyndnsd.rb

@@ -8,9 +8,9 @@ require 'json'
 require 'yaml'
 require 'rack'
 require 'metriks'
+require 'opentelemetry/instrumentation/rack'
+require 'opentelemetry/sdk'
 require 'metriks/reporter/graphite'
-require 'opentracing'
-require 'rack/tracer'
 
 require 'dyndnsd/generator/bind'
 require 'dyndnsd/updater/command_with_bind_zone'
@@ -69,7 +69,7 @@ module Dyndnsd
     # @return [Boolean]
     def authorized?(username, password)
       Helper.span('check_authorized') do |span|
-        span.set_tag('dyndnsd.user', username)
+        span.set_attribute('enduser.id', username)
 
         allow = Helper.user_allowed?(username, password, @users)
         if !allow
@@ -112,7 +112,7 @@ module Dyndnsd
 
       Dyndnsd.logger.info 'Starting...'
 
-      # drop priviliges as soon as possible
+      # drop privileges as soon as possible
       # NOTE: first change group than user
       if config['group']
         group = Etc.getgrnam(config['group'])
@@ -170,7 +170,7 @@ module Dyndnsd
     def process_changes(hostnames, myips)
       changes = []
       Helper.span('process_changes') do |span|
-        span.set_tag('dyndnsd.hostnames', hostnames.join(','))
+        span.set_attribute('dyndnsd.hostnames', hostnames.join(','))
 
         hostnames.each do |hostname|
           # myips order is always deterministic
@@ -252,6 +252,8 @@ module Dyndnsd
       Dyndnsd.logger.progname = 'dyndnsd'
       Dyndnsd.logger.formatter = LogFormatter.new
       Dyndnsd.logger.level = config['debug'] ? Logger::DEBUG : Logger::INFO
+
+      OpenTelemetry.logger = Dyndnsd.logger
     end
 
     # @return [void]
@@ -296,16 +298,31 @@ module Dyndnsd
     # @param config [Hash{String => Object}]
     # @return [void]
     private_class_method def self.setup_tracing(config)
-      # configure OpenTracing
-      if config.dig('tracing', 'jaeger')
-        require 'jaeger/client'
-
-        host = config['tracing']['jaeger']['host'] || '127.0.0.1'
-        port = config['tracing']['jaeger']['port'] || 6831
-        service_name = config['tracing']['jaeger']['service_name'] || 'dyndnsd'
-        OpenTracing.global_tracer = Jaeger::Client.build(
-          host: host, port: port, service_name: service_name, flush_interval: 1
-        )
+      # by default do not try to emit any traces until the user opts in
+      ENV['OTEL_TRACES_EXPORTER'] ||= 'none'
+
+      # configure OpenTelemetry
+      OpenTelemetry::SDK.configure do |c|
+        if config.dig('tracing', 'jaeger')
+          require 'opentelemetry/exporter/jaeger'
+
+          c.add_span_processor(
+            OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+              OpenTelemetry::Exporter::Jaeger::AgentExporter.new
+            )
+          )
+        end
+
+        if config.dig('tracing', 'service_name')
+          c.service_name = config['tracing']['service_name']
+        end
+
+        c.service_version = Dyndnsd::VERSION
+        c.use('OpenTelemetry::Instrumentation::Rack')
+      end
+
+      if !config.dig('tracing', 'trust_incoming_span')
+        OpenTelemetry.propagation = OpenTelemetry::Context::Propagation::NoopTextMapPropagator.new
       end
     end
 
@@ -331,8 +348,7 @@ module Dyndnsd
         app = Responder::DynDNSStyle.new(app)
       end
 
-      trust_incoming_span = config.dig('tracing', 'trust_incoming_span') || false
-      app = Rack::Tracer.new(app, trust_incoming_span: trust_incoming_span)
+      app = OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware.new(app)
 
       Rack::Handler::WEBrick.run app, Host: config['host'], Port: config['port']
     end

data/lib/dyndnsd/helper.rb

@@ -45,24 +45,17 @@ module Dyndnsd
     # @param block [Proc]
     # @return [void]
     def self.span(operation, &block)
-      scope = OpenTracing.start_active_span(operation)
-      span = scope.span
-      span.set_tag('component', 'dyndnsd')
-      span.set_tag('span.kind', 'server')
-      begin
+      tracer = OpenTelemetry.tracer_provider.tracer(Dyndnsd.name, Dyndnsd::VERSION)
+      tracer.in_span(
+        operation,
+        attributes: {'component' => 'dyndnsd'},
+        kind: :server
+      ) do |span|
+        Dyndnsd.logger.debug "Creating span ID #{span.context.hex_span_id} for trace ID #{span.context.hex_trace_id}"
         block.call(span)
       rescue StandardError => e
-        span.set_tag('error', true)
-        span.log_kv(
-          event: 'error',
-          'error.kind': e.class.to_s,
-          'error.object': e,
-          message: e.message,
-          stack: e.backtrace&.join("\n") || ''
-        )
+        span.record_exception(e)
         raise e
-      ensure
-        scope.close
       end
     end
   end

data/lib/dyndnsd/updater/command_with_bind_zone.rb

@@ -18,7 +18,7 @@ module Dyndnsd
         return if !db.changed?
 
         Helper.span('updater_update') do |span|
-          span.set_tag('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
+          span.set_attribute('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
 
           # write zone file in bind syntax
           File.open(@zone_file, 'w') { |f| f.write(@generator.generate(db)) }

data/lib/dyndnsd/updater/zone_transfer_server.rb

@@ -35,7 +35,7 @@ module Dyndnsd
       # @return [void]
       def update(db)
         Helper.span('updater_update') do |span|
-          span.set_tag('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
+          span.set_attribute('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
 
           soa_rr = Resolv::DNS::Resource::IN::SOA.new(
             @zone_nameservers[0], @zone_email_address,

data/lib/dyndnsd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dyndnsd
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.4.2
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-dns
@@ -25,75 +25,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: jaeger-client
+  name: metriks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: metriks
+  name: opentelemetry-exporter-jaeger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
-  name: opentracing
+  name: opentelemetry-instrumentation-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
-  name: rack-tracer
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -184,56 +184,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.18.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.43.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.43.0
 description: A small, lightweight and extensible DynDNS server written with Ruby and
   Rack.
 email: