1
0
mirror of https://github.com/cmur2/dyndnsd.git synced 2025-08-08 08:33:56 +02:00

Compare commits

...

86 Commits

Author SHA1 Message Date
cn
d89c1c6091 release: 3.1.3 2020-12-20 22:18:20 +01:00
cn
2a7ea2bb8f ci: use Github environment files (fix part 2)
- fixing vulnerability via https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#environment-files
2020-12-20 22:15:39 +01:00
cn
94823dc041 release: 3.1.2 2020-12-20 22:05:13 +01:00
depfu[bot]
4c25b9b66b gems: update rubocop to version 1.6.1 2020-12-11 11:47:05 +01:00
cn
fb42c57ff1 ci: drop Travis CI
- end of an era
2020-12-10 11:04:23 +01:00
Christian Nicolai
268e18f2e5 ci: allow manually triggering CI run on GHA 2020-12-04 09:07:09 +01:00
cn
e8e9e0cb71 ci: use GHA ruby/setup-ruby instead of broken actions/setup-ruby
- actions/setup-ruby does not work on new GHA runners Ubuntu 20.04 (missing bundler in 2.5) as per https://github.com/actions/setup-ruby/issues/70
- might be deprecated as per https://github.com/actions/setup-ruby/issues/80
- https://github.com/ruby/setup-ruby is recommended is superior
2020-12-04 09:04:23 +01:00
depfu[bot]
8819d6058a gems: update rubocop to version 1.5.1 2020-12-03 21:25:14 +01:00
cn
dc325d686e ci: use Github Actions in parallel to Travis CI
- this adds a new workflow for Github Actions that mirrors what the existing Travis CI workflow tests
- Travis CI might become unfriendly to opensource soonish so migration might be necessary
2020-11-25 09:39:55 +01:00
depfu[bot]
f0aeea96d4 gems: update rubocop to version 1.4.1 2020-11-24 20:55:22 +01:00
cn
ff136f7b16 ci: add periodic pulling of all Docker image tags to avoid staleness 2020-11-19 11:05:26 +01:00
depfu[bot]
377a6ac179 gems: update rubocop to version 1.3.0 2020-11-13 11:32:34 +01:00
depfu[bot]
2cc45e5c0f gems: update rubocop to version 1.2.0 2020-11-06 10:57:59 +01:00
cn
19683672d1 docs: use travis-ci.com links 2020-10-31 00:04:51 +01:00
cn
4c1fb5783d gem: fix new solargraph warning 2020-10-31 00:04:01 +01:00
cn
d8f5618006 gem: fix new rubocop warnings 2020-10-31 00:04:01 +01:00
cn
e063b6cb4c gems: use solargraph fork until gem metadata allows rubocop 1.0 compat
See https://github.com/castwide/solargraph/issues/380
2020-10-31 00:04:01 +01:00
depfu[bot]
f64bcc0780 gems: update rubocop to version 1.1.0 2020-10-31 00:04:01 +01:00
depfu[bot]
568ea08543 gems: update rubocop to version 1.0.0 2020-10-22 15:55:39 +02:00
depfu[bot]
5c16524788 gems: update rubocop to version 0.93.0 2020-10-10 16:45:54 +02:00
cn
d1c1a98e47 ci: use Github environment files
- fixing vulnerability via https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#environment-files
2020-10-08 12:32:44 +02:00
d62bf71820 ci: ignore false-positive 3rd party lockfiles for trivy 2020-10-08 12:29:35 +02:00
cn
156557c6d7 release: 3.1.1 2020-10-03 10:59:52 +02:00
cn
fd1d58abd6 gems: update webrick to version 1.6.1
- explicitly use webrick gem version with patch against CVE-2020-25613
- https://www.ruby-lang.org/en/news/2020/09/29/http-request-smuggling-cve-2020-25613/
- webrick versions bundled with ruby are vulnerable at this point
2020-10-02 00:50:23 +02:00
depfu[bot]
fc4d731434 gems: update rubocop to version 0.92.0 2020-09-26 12:39:42 +02:00
depfu[bot]
8b42a916d0 gems: update rubocop to version 0.91.0 2020-09-16 09:31:58 +02:00
depfu[bot]
e899488fa9 gems: update rubocop to version 0.90.0 2020-09-02 10:34:03 +02:00
6ed0799f49 ci: improve ignore of false-positives on 3rd party lockfiles
- amends 5b332d8f57
2020-08-30 11:41:23 +02:00
5b332d8f57 ci: ignore false-positive 3rd party lockfiles for trivy
- uses newly released `--skip-dirs` flag of Trivy 0.11.0
2020-08-30 11:34:26 +02:00
cn
0de5078d9d ci: add Dockerfile linting 2020-08-22 12:50:55 +02:00
depfu[bot]
72c8dda7dd gems: update jaeger-client to version 1.1.0
Update jaeger-client to version 1.1.0 (#62)

Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com>
2020-08-22 11:27:57 +02:00
cn
e36b210f66 ci: update github actions versions 2020-08-21 16:39:11 +02:00
cn
fcc3f12284 ci: fix vulnscan behavior to scan most-recent semver 2020-08-19 14:33:26 +02:00
cn
bf68049260 release: 3.1.0 2020-08-19 14:13:07 +02:00
cn
35ced6468e ci: allow manual run of vulnscan action workflow 2020-08-18 22:53:33 +02:00
cn
4833328557 docs: improve docker run instructions 2020-08-18 22:40:30 +02:00
cn
25e70f484d release: 3.1.0.rc1 2020-08-18 22:26:56 +02:00
cn
617fbf538b docker: add image release on tag and periodic vulnerability scan 2020-08-18 22:22:41 +02:00
cn
5cce42f4c7 gem: fix solargraph warnings on CI 2020-08-17 12:10:35 +02:00
cn
093efc77ef gem: add editorconfig 2020-08-12 07:55:37 +02:00
depfu[bot]
2368099f7d gems: upgrade jaeger-client to version 1.0.0
Update jaeger-client to version 1.0.0 (#38)

Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com>
2020-08-11 16:08:28 +02:00
depfu[bot]
708cd13237 gems: update rubocop to version 0.89.0
Update rubocop to version 0.89.0 (#59)

Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com>
2020-08-07 08:36:49 +02:00
cn
a89a263250 docs: add example Dockerfile 2020-07-30 19:52:01 +02:00
cn
af102f23ec release: 3.0.0 2020-07-29 00:31:48 +02:00
depfu[bot]
950c985ad1 gems: update rubocop to version 0.88.0
Update rubocop to version 0.88.0 (#57)
Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com>
2020-07-29 00:04:44 +02:00
cn
b2d9b7745f gem: bump minimum required Ruby version to Ruby 2.5 2020-07-28 17:52:15 +02:00
cn
09aa2b127c release: 2.3.1 2020-07-27 21:31:15 +02:00
cn
618b2c823d dyndnsd: remove noisy message by not redundantly logging on shutdown 2020-07-27 20:34:48 +02:00
cn
ae62744cc9 release: 2.3.0 2020-07-20 20:37:59 +02:00
cn
3a9c2d65fb updater: add zone_transfer_server updater 2020-07-20 17:10:38 +02:00
cn
8976ff5bbe dyndnsd: allow enabling debug logging 2020-07-20 12:04:22 +02:00
cn
0c4c38cc6b dyndnsd: allow updater to see if database changed 2020-07-20 11:56:23 +02:00
cn
0cec44893d updater: improve parameter name 2020-07-18 14:45:56 +02:00
depfu[bot]
33b8325a92 gems: update bundler-audit to version 0.7.0.1
(#53)
Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com>
2020-06-14 12:40:25 +02:00
depfu[bot]
186c79814f gems: update rubocop to version 0.81.0
(#47)
Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com>
2020-04-02 12:28:55 +02:00
Sam Umbach
cb3977b553 docs: fix minor typos in README
Fix minor typos (#46)
2020-03-20 11:09:05 +01:00
cn
c112b211a0 release: 2.2.0 2020-03-06 21:55:42 +01:00
cn
b597ecb15e gem: adopt frozen string literals 2020-03-06 21:48:17 +01:00
cn
c73c09f311 gem: refactor gemspec, exclude tests from gem, move binaries to ./exe
- based on recommendations of https://piotrmurach.com/articles/writing-a-ruby-gem-specification/
2020-03-06 21:46:55 +01:00
cn
88133edc1a gems: fix order, drop unnecessary json dependency
- json was added pre Ruby 2.0 in e50430b177
2020-03-02 01:44:39 +01:00
cn
9dfafd7e8d release: 2.1.1 2020-03-01 21:55:35 +01:00
cn
af5e4ca3e0 dyndnsd: handle potential nil cases detected by sorbet
- including review suggestions from @jgraichen
2020-03-01 21:51:28 +01:00
cn
0317189057 release: 2.1.0 2020-03-01 11:43:39 +01:00
cn
73dbf2a5fa gem: add solargraph support 2020-02-29 20:21:50 +01:00
cn
6d0457d70c gems: specify bundler-audit version 2020-02-29 00:32:21 +01:00
cn
9ab080072f updater: rename parameter to match expected type 2020-02-28 16:01:44 +01:00
cn
fdcd6e8da4 gem: add Ruby 2.7 support 2020-02-28 13:30:11 +01:00
cn
31be09c1c2 travis: fix build config validation problems
- https://docs.travis-ci.com/user/reference/overview/#deprecated-virtualization-environments
2020-02-28 13:13:02 +01:00
cn
3406e22588 gem: enable new rubocop rules, cleanup 2020-02-26 11:33:44 +01:00
depfu[bot]
a42a864f56 gems: update rubocop to version 0.80.0
Update rubocop to version 0.80.0 (#44)
2020-02-19 15:09:25 +01:00
depfu[bot]
07fd8681e4 gems: update rubocop to version 0.79.0
Update rubocop to version 0.79.0 (#43)
2020-01-07 19:32:10 +01:00
depfu[bot]
6831744e7b gems: update rubocop to version 0.78.0
Update rubocop to version 0.78.0 (#42)
2019-12-19 23:43:30 +01:00
depfu[bot]
7d49b861fc gems: update rubocop to version 0.77.0
Update rubocop to version 0.77.0 (#41)
2019-11-29 09:21:46 +01:00
depfu[bot]
2ad816b866 gems: update rubocop to version 0.76.0
Update rubocop to version 0.76.0 (#40)
2019-10-29 20:28:30 +01:00
depfu[bot]
f4f10c94c4 gems: update rubocop to version 0.75.0
Update rubocop to version 0.75.0 (#39)
2019-10-02 08:58:33 +02:00
depfu[bot]
bb7302407a gems: update rubocop to version 0.74.0
Update rubocop to version 0.74.0 (#37)
2019-08-02 09:14:36 +02:00
depfu[bot]
9f132b4a7d gems: update rubocop to version 0.73.0
Update rubocop to version 0.73.0 (#36)
2019-07-17 12:53:49 +02:00
depfu[bot]
32d6d01d9d gems: update rubocop to version 0.72.0
Update rubocop to version 0.72.0 (#35)
2019-06-26 18:10:54 +02:00
depfu[bot]
9d80220d24 gems: update rubocop to version 0.71.0
Update rubocop to version 0.71.0 (#34)
2019-06-01 10:17:52 +02:00
depfu[bot]
b00aa0e464 gems: update rubocop to version 0.70.0
Update rubocop to version 0.70.0 (#33)
2019-05-22 14:28:33 +02:00
depfu[bot]
a55d882d4d gems: update rubocop to version 0.69.0
Update rubocop to version 0.69.0 (#32)
2019-05-14 12:42:55 +02:00
depfu[bot]
aa5de52f4d gems: update rubocop to version 0.68.0
Update rubocop to version 0.68.0 (#31)
2019-04-30 20:01:57 +02:00
depfu[bot]
ee56fe8d07 gems: update rubocop to version 0.66.0
Update rubocop to version 0.66.0 (#29)
2019-03-19 13:30:15 +01:00
depfu[bot]
051d561700 gems: update rubocop to version 0.65.0
Update rubocop to version 0.65.0 (#28)
2019-02-20 11:33:15 +01:00
depfu[bot]
ccaa39e871 gems: update rubocop to version 0.64.0
Update rubocop to version 0.64.0 (#27)
2019-02-11 16:45:44 +01:00
depfu[bot]
b69aa6dc5b gems: update rack-tracer to version 0.9.0
Update rack-tracer to version 0.9.0 (#26)
2019-02-08 18:24:56 +01:00
33 changed files with 772 additions and 117 deletions

9
.editorconfig Normal file
View File

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

26
.github/workflows/cd.yml vendored Normal file
View File

@@ -0,0 +1,26 @@
---
name: cd
on:
push:
tags:
- 'v*.*.*'
jobs:
release-dockerimage:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Extract dyndnsd version from tag name
run: |
echo "DYNDNSD_VERSION=${GITHUB_REF#refs/*/v}" >> $GITHUB_ENV
# 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

33
.github/workflows/ci.yml vendored Normal file
View File

@@ -0,0 +1,33 @@
---
name: ci
on:
push:
branches: [master]
pull_request:
branches: [master]
workflow_dispatch:
schedule:
- cron: '35 4 * * 4' # weekly on thursday morning
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
ruby-version:
- '2.5'
- '2.6'
- '2.7'
steps:
- uses: actions/checkout@v2
- name: Set up Ruby ${{ matrix.ruby-version }}
uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ matrix.ruby-version }}
- name: Install dependencies
run: |
bundle
- name: Test
run: |
bundle exec rake ci

19
.github/workflows/dockerhub.yml vendored Normal file
View File

@@ -0,0 +1,19 @@
---
name: dockerhub
on:
schedule:
- cron: '7 4 * * 4' # weekly on thursday morning
workflow_dispatch:
jobs:
pull-released-dockerimages:
runs-on: ubuntu-latest
steps:
- name: Avoid stale tags by pulling
run: |
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')"
for image in $ALL_IMAGES; do
echo "Pulling $image to avoid staleness..."
docker pull "$image"
done

46
.github/workflows/vulnscan.yml vendored Normal file
View File

@@ -0,0 +1,46 @@
---
name: vulnscan
on:
schedule:
- cron: '7 4 * * 4' # weekly on thursday morning
workflow_dispatch:
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 "$GITHUB_WORKSPACE/bin" >> "$GITHUB_PATH"
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
env:
TRIVY_SKIP_DIRS: 'usr/lib/ruby/gems/2.7.0/gems/jaeger-client-0.10.0/crossdock,usr/lib/ruby/gems/2.7.0/gems/jaeger-client-1.0.0/crossdock,usr/lib/ruby/gems/2.7.0/gems/jaeger-client-1.1.0/crossdock'
run: |
trivy --version
# semver sorting as per https://stackoverflow.com/a/40391207/2148786
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' | sed '/-/!{s/$/_/}' | sort -r -V | sed 's/_$//')"
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 -e "\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"

1
.gitignore vendored
View File

@@ -1,3 +1,4 @@
.DS_Store .DS_Store
*.lock *.lock
pkg/* pkg/*
.yardoc

View File

@@ -1,13 +1,6 @@
inherit_from: .rubocop_todo.yml
AllCops: AllCops:
TargetRubyVersion: '2.3' TargetRubyVersion: '2.5'
NewCops: enable
Gemspec/OrderedDependencies:
Enabled: false
Layout/AlignHash:
Enabled: false
Layout/EmptyLineAfterGuardClause: Layout/EmptyLineAfterGuardClause:
Enabled: false Enabled: false
@@ -16,9 +9,15 @@ Layout/EmptyLineAfterGuardClause:
Layout/EmptyLinesAroundArguments: Layout/EmptyLinesAroundArguments:
Enabled: false Enabled: false
Layout/LeadingBlankLines: Layout/HashAlignment:
Enabled: false Enabled: false
Layout/LeadingEmptyLines:
Enabled: false
Layout/LineLength:
Max: 200
Layout/SpaceInsideHashLiteralBraces: Layout/SpaceInsideHashLiteralBraces:
Enabled: false Enabled: false
@@ -34,16 +33,13 @@ Metrics/ClassLength:
Metrics/CyclomaticComplexity: Metrics/CyclomaticComplexity:
Enabled: false Enabled: false
Metrics/LineLength:
Max: 200
Metrics/MethodLength: Metrics/MethodLength:
Enabled: false Enabled: false
Metrics/PerceivedComplexity: Metrics/PerceivedComplexity:
Enabled: false Enabled: false
Naming/UncommunicativeMethodParamName: Naming/MethodParameterName:
Enabled: false Enabled: false
Naming/MemoizedInstanceVariableName: Naming/MemoizedInstanceVariableName:
@@ -58,15 +54,24 @@ Style/Documentation:
Style/FormatStringToken: Style/FormatStringToken:
Enabled: false Enabled: false
Style/FrozenStringLiteralComment:
Enabled: false
Style/GuardClause: Style/GuardClause:
Enabled: false Enabled: false
Style/HashEachMethods:
Enabled: true
Style/HashTransformKeys:
Enabled: true
Style/HashTransformValues:
Enabled: true
Style/IdenticalConditionalBranches: Style/IdenticalConditionalBranches:
Enabled: false Enabled: false
Style/IfUnlessModifier:
Enabled: false
Style/InverseMethods: Style/InverseMethods:
Enabled: false Enabled: false
@@ -78,3 +83,6 @@ Style/RescueModifier:
Style/SymbolArray: Style/SymbolArray:
Enabled: false Enabled: false
Style/TrailingCommaInArrayLiteral:
Enabled: false

View File

@@ -1,7 +0,0 @@
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2018-02-23 12:54:10 +0100 using RuboCop version 0.52.1.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

16
.solargraph.yml Normal file
View File

@@ -0,0 +1,16 @@
---
include:
- "**/*.rb"
- "bin/dyndnsd"
exclude:
- spec/**/*
- test/**/*
- vendor/**/*
- ".bundle/**/*"
require: []
domains: []
reporters:
- rubocop
- require_not_found
require_paths: []
max_files: 5000

View File

@@ -1,8 +0,0 @@
---
sudo: false
language: ruby
rvm:
- 2.6
- 2.5
- 2.4
- 2.3

View File

@@ -1,5 +1,70 @@
# Changelog # Changelog
## 3.1.3 (December 20, 2020)
OTHER:
- fix Docker image release process in Github Actions CI, 3.1.2 was not released as a Docker image
## 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:
- Fix annoying error message `log writing failed. can't be called from trap context` on shutdown by not attempting to log redundant information there
## 2.3.0 (July 20, 2020)
IMPROVEMENTS:
- Allow enabling debug logging
- Add updater that uses [DNS zone transfers via AXFR (RFC5936)](https://tools.ietf.org/html/rfc5936) to allow any secondary nameserver(s) to fetch the zone contents after (optionally) receiving a [DNS NOTIFY (RFC1996)](https://tools.ietf.org/html/rfc1996) request
## 2.2.0 (March 6, 2020)
IMPROVEMENTS:
- Refactor gemspec based on [recommendations](https://piotrmurach.com/articles/writing-a-ruby-gem-specification/) so tests are now excluded from gem and binaries move to `./exe` directory
- Adopt Ruby 2.3 frozen string literals for source code potentially reducing memory consumption
## 2.1.1 (March 1, 2020)
IMPROVEMENTS:
- Fix potential `nil` cases detected by [Sorbet](https://sorbet.org) including refactorings
## 2.1.0 (March 1, 2020)
IMPROVEMENTS:
- Add Ruby 2.7 support
- Add [solargraph](https://github.com/castwide/solargraph) to dev tooling as Ruby Language Server usable e.g. for IDEs (used solargraph version not compatible with Ruby 2.7 as bundler-audit 0.6.x requires old `thor` gem)
- Document code using YARD tags, e.g. for type information and better code completion
## 2.0.0 (January 25, 2019) ## 2.0.0 (January 25, 2019)
IMPROVEMENTS: IMPROVEMENTS:
@@ -9,7 +74,7 @@ IMPROVEMENTS:
- Better code maintainability by refactorings - Better code maintainability by refactorings
- Update dependencies, mainly `rack` to new major version 2 - Update dependencies, mainly `rack` to new major version 2
- Add Ruby 2.5 and Ruby 2.6 support - Add Ruby 2.5 and Ruby 2.6 support
- Add experimental [OpenTracing](http://opentracing.io/) support with [CNCF Jaeger](https://github.com/jaegertracing/jaeger) - Add experimental [OpenTracing](https://opentracing.io/) support with [CNCF Jaeger](https://github.com/jaegertracing/jaeger)
- Support host offlining by deleting the associated DNS records - Support host offlining by deleting the associated DNS records
- Add textfile reporter to write Graphite-style metrics (also compatible with [Prometheus](https://prometheus.io/)) into a file - Add textfile reporter to write Graphite-style metrics (also compatible with [Prometheus](https://prometheus.io/)) into a file

View File

@@ -1,3 +1,7 @@
# frozen_string_literal: true
source 'https://rubygems.org' source 'https://rubygems.org'
gemspec gemspec
gem 'solargraph', git: 'https://github.com/zaratan/solargraph.git', branch: 'fix_rubocop_1_0'

139
README.md
View File

@@ -1,19 +1,23 @@
# dyndnsd.rb # 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. A small, lightweight and extensible DynDNS server written with Ruby and Rack.
## Description ## Description
dyndnsd.rb aims to implement a small [DynDNS-compliant](https://help.dyn.com/remote-access-api/) server in Ruby supporting IPv4 and IPv6 addresses. It has an integrated user and hostname database in it's configuration file that is used for authentication and authorization. Besides talking the DynDNS protocol it is able to invoke a so-called *updater*, a small Ruby module that takes care of supplying the current hostname => ip mapping to a DNS server. dyndnsd.rb aims to implement a small [DynDNS-compliant](https://help.dyn.com/remote-access-api/) server in Ruby supporting IPv4 and IPv6 addresses. It has an integrated user and hostname database in its configuration file that is used for authentication and authorization. Besides talking the DynDNS protocol it is able to invoke a so-called *updater*, a small Ruby module that takes care of supplying the current hostname => ip mapping to a DNS server.
There is currently one updater shipped with dyndnsd.rb `command_with_bind_zone` that writes out a zone file in BIND syntax onto the current system and invokes a user-supplied command afterwards that is assumed to trigger the DNS server (not necessarily BIND since it's zone files are read by other DNS servers, too) to reload it's zone configuration. There are currently two updaters shipped with dyndnsd.rb:
- `zone_transfer_server` that uses [DNS zone transfers via AXFR (RFC5936)](https://tools.ietf.org/html/rfc5936) to allow any secondary nameserver(s) to fetch the zone contents after (optionally) receiving a [DNS NOTIFY (RFC1996)](https://tools.ietf.org/html/rfc1996) request
- `command_with_bind_zone` that writes out a zone file in BIND syntax onto the current system and invokes a user-supplied command afterwards that is assumed to trigger the DNS server (not necessarily BIND since its zone files are read by other DNS servers, too) to reload its zone configuration
Because of the mechanisms used, dyndnsd.rb is known to work only on \*nix systems. Because of the mechanisms used, dyndnsd.rb is known to work only on \*nix systems.
See the [changelog](CHANGELOG.md) before upgrading. The older version 1.x of dyndnsd.rb is still available on [branch dyndnsd-1.x](https://github.com/cmur2/dyndnsd/tree/dyndnsd-1.x). See the [changelog](CHANGELOG.md) before upgrading. The older version 1.x of dyndnsd.rb is still available on [branch dyndnsd-1.x](https://github.com/cmur2/dyndnsd/tree/dyndnsd-1.x).
## General Usage ## General Usage
Install the gem: Install the gem:
@@ -25,14 +29,16 @@ Create a configuration file in YAML format somewhere:
```yaml ```yaml
# listen address and port # listen address and port
host: "0.0.0.0" host: "0.0.0.0"
port: "80" port: 80
# optional: drop priviliges in case you want to but you may need sudo for external commands # optional: drop privileges in case you want to but you may need sudo for external commands
user: "nobody" user: "nobody"
group: "nogroup" group: "nogroup"
# logfile is optional, logs to STDOUT else # logfile is optional, logs to STDOUT otherwise
logfile: "dyndnsd.log" logfile: "dyndnsd.log"
# interal database file # internal database file
db: "db.json" db: "db.json"
# enable debug mode?
debug: false
# all hostnames are required to be cool-name.example.org # all hostnames are required to be cool-name.example.org
domain: "example.org" domain: "example.org"
# configure the updater, here we use command_with_bind_zone, params are updater-specific # configure the updater, here we use command_with_bind_zone, params are updater-specific
@@ -58,17 +64,98 @@ users:
Run dyndnsd.rb by: Run dyndnsd.rb by:
dyndnsd /path/to/config.yaml ```bash
dyndnsd /path/to/config.yml
```
## Using dyndnsd.rb with [NSD](https://www.nlnetlabs.nl/nsd/)
NSD is a nice opensource, authoritative-only, low-memory DNS server that reads BIND-style zone files (and converts them into it's own database) and has a simple config file. ### Docker image
A feature NSD is lacking is the [Dynamic DNS update](https://tools.ietf.org/html/rfc2136) functionality BIND offers but one can fake it using the following dyndnsd.rb config: 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 ```yaml
host: "0.0.0.0" host: "0.0.0.0"
port: "8245" # the DynDNS.com alternative HTTP port 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)
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.
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
- any existing, production-grade, caching, geo-replicated nameserver setup can be used to pull DNS zone contents from the *hidden primary* dyndnsd.rb and serve it to clients
- any nameserver(s) and dyndnsd.rb do not need to be located on the same host
Example dyndnsd.rb configuration:
```yaml
host: "0.0.0.0"
port: 8245 # the DynDNS.com alternative HTTP port
db: "/opt/dyndnsd/db.json"
domain: "dyn.example.org"
updater:
name: "zone_transfer_server"
params:
# endpoint(s) to listen for incoming zone transfer (AXFR) requests, default 0.0.0.0@53
server_listens:
- 127.0.0.1@5300
# where to send DNS NOTIFY request(s) to on zone content change
send_notifies:
- '127.0.0.1'
# TTL for all records in the zone (in seconds)
zone_ttl: 300 # 5m
# zone's NS record(s) (at least one)
zone_nameservers:
- "dns.example.org."
# info for zone's SOA record
zone_email_address: "admin.example.org."
# zone's additional A/AAAA records
zone_additional_ips:
- "127.0.0.1"
users:
foo:
password: "secret"
hosts:
- foo.example.org
```
## Using dyndnsd.rb with [NSD](https://www.nlnetlabs.nl/projects/nsd/about/)
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:
```yaml
host: "0.0.0.0"
port: 8245 # the DynDNS.com alternative HTTP port
db: "/opt/dyndnsd/db.json" db: "/opt/dyndnsd/db.json"
domain: "dyn.example.org" domain: "dyn.example.org"
updater: updater:
@@ -88,17 +175,20 @@ users:
foo: foo:
password: "secret" password: "secret"
hosts: hosts:
- foo.example.org - foo.example.org
``` ```
Start dyndnsd.rb before NSD to make sure the zone file exists else NSD complains. Start dyndnsd.rb before NSD to make sure the zone file exists else NSD complains.
## Using dyndnsd.rb with X ## Using dyndnsd.rb with X
Please provide ideas if you are using dyndnsd.rb with other DNS servers :) Please provide ideas if you are using dyndnsd.rb with other DNS servers :)
## Advanced topics ## Advanced topics
### Update URL ### Update URL
The update URL you want to tell your clients (humans or scripts ^^) consists of the following The update URL you want to tell your clients (humans or scripts ^^) consists of the following
@@ -111,10 +201,11 @@ where:
* USER and PASSWORD are needed for HTTP Basic Auth and valid combinations are defined in your config.yaml * 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 * 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 * 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 * 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 * 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 * MYIP6 is optional but if present also requires presence of MYIP
### IP address determination ### IP address determination
The following rules apply: The following rules apply:
@@ -123,15 +214,20 @@ The following rules apply:
* 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 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 * 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 ### 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 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
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. ### 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](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 ### Monitoring
@@ -139,7 +235,7 @@ For monitoring dyndnsd.rb uses the [metriks](https://github.com/eric/metriks) fr
```yaml ```yaml
host: "0.0.0.0" host: "0.0.0.0"
port: "8245" # the DynDNS.com alternative HTTP port port: 8245 # the DynDNS.com alternative HTTP port
db: "/opt/dyndnsd/db.json" db: "/opt/dyndnsd/db.json"
domain: "dyn.example.org" domain: "dyn.example.org"
# configure the Graphite backend to be used instead of proctitle # configure the Graphite backend to be used instead of proctitle
@@ -172,14 +268,16 @@ users:
password: "ihavenohosts" password: "ihavenohosts"
``` ```
### Tracing (experimental) ### 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 [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.
Currently only one OpenTracing-compatible tracer implementation named [CNCF Jaeger](https://github.com/jaegertracing/jaeger) can be configured to use with dyndnsd.rb. Currently only one OpenTracing-compatible tracer implementation named [CNCF Jaeger](https://github.com/jaegertracing/jaeger) can be configured to use with dyndnsd.rb.
```yaml ```yaml
host: "0.0.0.0" host: "0.0.0.0"
port: "8245" # the DynDNS.com alternative HTTP port port: 8245 # the DynDNS.com alternative HTTP port
db: "/opt/dyndnsd/db.json" db: "/opt/dyndnsd/db.json"
domain: "dyn.example.org" domain: "dyn.example.org"
# enable and configure tracing using the (currently only) tracer jaeger # enable and configure tracing using the (currently only) tracer jaeger
@@ -210,6 +308,7 @@ users:
password: "ihavenohosts" password: "ihavenohosts"
``` ```
## License ## License
dyndnsd.rb is licensed under the Apache License, Version 2.0. See LICENSE for more information. dyndnsd.rb is licensed under the Apache License, Version 2.0. See LICENSE for more information.

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require 'bundler/gem_tasks' require 'bundler/gem_tasks'
require 'rspec/core/rake_task' require 'rspec/core/rake_task'
require 'rubocop/rake_task' require 'rubocop/rake_task'
@@ -7,4 +9,23 @@ RSpec::Core::RakeTask.new(:spec)
RuboCop::RakeTask.new RuboCop::RakeTask.new
Bundler::Audit::Task.new Bundler::Audit::Task.new
task default: [:rubocop, :spec, 'bundle:audit'] desc 'Run experimental solargraph type checker'
task :solargraph do
sh 'solargraph typecheck'
end
namespace :solargraph do
desc 'Should be run by developer once to prepare initial solargraph usage (fill caches etc.)'
task :init do
sh 'solargraph download-core'
end
end
desc 'Run hadolint for Dockerfile linting'
task :hadolint do
sh 'docker run --rm -i hadolint/hadolint:v1.18.0 hadolint --ignore DL3018 - < docker/Dockerfile'
end
task default: [:rubocop, :spec, 'bundle:audit', :solargraph]
task ci: ['solargraph:init', :default, :hadolint]

View File

@@ -1,4 +0,0 @@
require 'dyndnsd'
Dyndnsd::Daemon.run!

15
docker/Dockerfile Normal file
View File

@@ -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"]

0
init.d/debian-6-dyndnsd → docs/debian-6-init-dyndnsd Normal file → Executable file
View File

View File

@@ -1,7 +1,6 @@
# frozen_string_literal: true
$LOAD_PATH.push File.expand_path('lib', __dir__) require_relative 'lib/dyndnsd/version'
require 'dyndnsd/version'
Gem::Specification.new do |s| Gem::Specification.new do |s|
s.name = 'dyndnsd' s.name = 'dyndnsd'
@@ -9,28 +8,38 @@ Gem::Specification.new do |s|
s.summary = 'dyndnsd.rb' s.summary = 'dyndnsd.rb'
s.description = 'A small, lightweight and extensible DynDNS server written with Ruby and Rack.' s.description = 'A small, lightweight and extensible DynDNS server written with Ruby and Rack.'
s.author = 'Christian Nicolai' s.author = 'Christian Nicolai'
s.email = 'chrnicolai@gmail.com'
s.homepage = 'https://github.com/cmur2/dyndnsd' s.homepage = 'https://github.com/cmur2/dyndnsd'
s.license = 'Apache-2.0' s.license = 'Apache-2.0'
s.metadata = {
'bug_tracker_uri' => "#{s.homepage}/issues",
'changelog_uri' => "#{s.homepage}/blob/master/CHANGELOG.md",
'source_code_uri' => s.homepage
}
s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR) s.files = `git ls-files -z`.split("\x0").select do |f|
s.test_files = s.files.grep(%r{^(test|spec|features)/}) f.match(%r{^(init.d|lib)/})
end
s.require_paths = ['lib'] s.require_paths = ['lib']
s.bindir = 'exe'
s.executables = ['dyndnsd'] s.executables = ['dyndnsd']
s.extra_rdoc_files = Dir['README.md', 'CHANGELOG.md', 'LICENSE']
s.required_ruby_version = '>= 2.3' s.required_ruby_version = '>= 2.5'
s.add_runtime_dependency 'rack', '~> 2.0' s.add_runtime_dependency 'async-dns', '~> 1.2.0'
s.add_runtime_dependency 'json' s.add_runtime_dependency 'jaeger-client', '~> 1.1.0'
s.add_runtime_dependency 'metriks' s.add_runtime_dependency 'metriks'
s.add_runtime_dependency 'opentracing', '~> 0.5.0' s.add_runtime_dependency 'opentracing', '~> 0.5.0'
s.add_runtime_dependency 'rack-tracer', '~> 0.8.0' s.add_runtime_dependency 'rack', '~> 2.0'
s.add_runtime_dependency 'jaeger-client', '~> 0.10.0' s.add_runtime_dependency 'rack-tracer', '~> 0.9.0'
s.add_runtime_dependency 'webrick', '>= 1.6.1'
s.add_development_dependency 'bundler' s.add_development_dependency 'bundler'
s.add_development_dependency 'bundler-audit', '~> 0.7.0'
s.add_development_dependency 'rack-test'
s.add_development_dependency 'rake' s.add_development_dependency 'rake'
s.add_development_dependency 'rspec' s.add_development_dependency 'rspec'
s.add_development_dependency 'rack-test' s.add_development_dependency 'rubocop', '~> 1.6.1'
s.add_development_dependency 'rubocop', '~> 0.63.0' # s.add_development_dependency 'solargraph', '~> 0.39.0'
s.add_development_dependency 'bundler-audit'
end end

6
exe/dyndnsd Executable file
View File

@@ -0,0 +1,6 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require 'dyndnsd'
Dyndnsd::Daemon.run!

67
lib/dyndnsd.rb Executable file → Normal file
View File

@@ -1,5 +1,6 @@
#!/usr/bin/env ruby # frozen_string_literal: true
require 'date'
require 'etc' require 'etc'
require 'logger' require 'logger'
require 'ipaddr' require 'ipaddr'
@@ -13,6 +14,7 @@ require 'rack/tracer'
require 'dyndnsd/generator/bind' require 'dyndnsd/generator/bind'
require 'dyndnsd/updater/command_with_bind_zone' require 'dyndnsd/updater/command_with_bind_zone'
require 'dyndnsd/updater/zone_transfer_server'
require 'dyndnsd/responder/dyndns_style' require 'dyndnsd/responder/dyndns_style'
require 'dyndnsd/responder/rest_style' require 'dyndnsd/responder/rest_style'
require 'dyndnsd/database' require 'dyndnsd/database'
@@ -21,21 +23,32 @@ require 'dyndnsd/textfile_reporter'
require 'dyndnsd/version' require 'dyndnsd/version'
module Dyndnsd module Dyndnsd
# @return [Logger]
def self.logger def self.logger
@logger @logger
end end
# @param logger [Logger]
# @return [Logger]
def self.logger=(logger) def self.logger=(logger)
@logger = logger @logger = logger
end end
class LogFormatter class LogFormatter
# @param lvl [Object]
# @param _time [DateTime]
# @param _progname [String]
# @param msg [Object]
# @return [String]
def call(lvl, _time, _progname, msg) def call(lvl, _time, _progname, msg)
format("[%s] %-5s %s\n", Time.now.strftime('%Y-%m-%d %H:%M:%S'), lvl, msg.to_s) format("[%s] %-5s %s\n", Time.now.strftime('%Y-%m-%d %H:%M:%S'), lvl, msg.to_s)
end end
end end
class Daemon class Daemon
# @param config [Hash{String => Object}]
# @param db [Dyndnsd::Database]
# @param updater [#update]
def initialize(config, db, updater) def initialize(config, db, updater)
@users = config['users'] @users = config['users']
@domain = config['domain'] @domain = config['domain']
@@ -45,12 +58,15 @@ module Dyndnsd
@db.load @db.load
@db['serial'] ||= 1 @db['serial'] ||= 1
@db['hosts'] ||= {} @db['hosts'] ||= {}
@updater.update(@db)
if @db.changed? if @db.changed?
@db.save @db.save
@updater.update(@db)
end end
end end
# @param username [String]
# @param password [String]
# @return [Boolean]
def authorized?(username, password) def authorized?(username, password)
Helper.span('check_authorized') do |span| Helper.span('check_authorized') do |span|
span.set_tag('dyndnsd.user', username) span.set_tag('dyndnsd.user', username)
@@ -64,6 +80,8 @@ module Dyndnsd
end end
end end
# @param env [Hash{String => String}]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def call(env) def call(env)
return [422, {'X-DynDNS-Response' => 'method_forbidden'}, []] if env['REQUEST_METHOD'] != 'GET' 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' return [422, {'X-DynDNS-Response' => 'not_found'}, []] if env['PATH_INFO'] != '/nic/update'
@@ -71,6 +89,7 @@ module Dyndnsd
handle_dyndns_request(env) handle_dyndns_request(env)
end end
# @return [void]
def self.run! def self.run!
if ARGV.length != 1 if ARGV.length != 1
puts 'Usage: dyndnsd config_file' puts 'Usage: dyndnsd config_file'
@@ -95,8 +114,14 @@ module Dyndnsd
# drop priviliges as soon as possible # drop priviliges as soon as possible
# NOTE: first change group than user # NOTE: first change group than user
Process::Sys.setgid(Etc.getgrnam(config['group']).gid) if config['group'] if config['group']
Process::Sys.setuid(Etc.getpwnam(config['user']).uid) if config['user'] group = Etc.getgrnam(config['group'])
Process::Sys.setgid(group.gid) if group
end
if config['user']
user = Etc.getpwnam(config['user'])
Process::Sys.setuid(user.uid) if user
end
setup_traps setup_traps
@@ -109,6 +134,8 @@ module Dyndnsd
private private
# @param params [Hash{String => String}]
# @return [Array<String>]
def extract_v4_and_v6_address(params) def extract_v4_and_v6_address(params)
return [] if !(params['myip']) return [] if !(params['myip'])
begin begin
@@ -120,6 +147,9 @@ module Dyndnsd
end end
end end
# @param env [Hash{String => String}]
# @param params [Hash{String => String}]
# @return [Array<String>]
def extract_myips(env, params) def extract_myips(env, params)
# require presence of myip parameter as valid IPAddr (v4) and valid myip6 # require presence of myip parameter as valid IPAddr (v4) and valid myip6
return extract_v4_and_v6_address(params) if params.key?('myip6') return extract_v4_and_v6_address(params) if params.key?('myip6')
@@ -134,6 +164,9 @@ module Dyndnsd
[env['REMOTE_ADDR']] [env['REMOTE_ADDR']]
end end
# @param hostnames [String]
# @param myips [Array<String>]
# @return [Array<Symbol>]
def process_changes(hostnames, myips) def process_changes(hostnames, myips)
changes = [] changes = []
Helper.span('process_changes') do |span| Helper.span('process_changes') do |span|
@@ -158,14 +191,17 @@ module Dyndnsd
changes changes
end end
# @return [void]
def update_db def update_db
@db['serial'] += 1 @db['serial'] += 1
Dyndnsd.logger.info "Committing update ##{@db['serial']}" Dyndnsd.logger.info "Committing update ##{@db['serial']}"
@db.save
@updater.update(@db) @updater.update(@db)
@db.save
Metriks.meter('updates.committed').mark Metriks.meter('updates.committed').mark
end end
# @param env [Hash{String => String}]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def handle_dyndns_request(env) def handle_dyndns_request(env)
params = Rack::Utils.parse_query(env['QUERY_STRING']) params = Rack::Utils.parse_query(env['QUERY_STRING'])
@@ -204,28 +240,32 @@ module Dyndnsd
# SETUP # SETUP
# @param config [Hash{String => Object}]
# @return [void]
private_class_method def self.setup_logger(config) private_class_method def self.setup_logger(config)
if config['logfile'] if config['logfile']
Dyndnsd.logger = Logger.new(config['logfile']) Dyndnsd.logger = Logger.new(config['logfile'])
else else
Dyndnsd.logger = Logger.new(STDOUT) Dyndnsd.logger = Logger.new($stdout)
end end
Dyndnsd.logger.progname = 'dyndnsd' Dyndnsd.logger.progname = 'dyndnsd'
Dyndnsd.logger.formatter = LogFormatter.new Dyndnsd.logger.formatter = LogFormatter.new
Dyndnsd.logger.level = config['debug'] ? Logger::DEBUG : Logger::INFO
end end
# @return [void]
private_class_method def self.setup_traps private_class_method def self.setup_traps
Signal.trap('INT') do Signal.trap('INT') do
Dyndnsd.logger.info 'Quitting...'
Rack::Handler::WEBrick.shutdown Rack::Handler::WEBrick.shutdown
end end
Signal.trap('TERM') do Signal.trap('TERM') do
Dyndnsd.logger.info 'Quitting...'
Rack::Handler::WEBrick.shutdown Rack::Handler::WEBrick.shutdown
end end
end end
# @param config [Hash{String => Object}]
# @return [void]
private_class_method def self.setup_monitoring(config) private_class_method def self.setup_monitoring(config)
# configure metriks # configure metriks
if config['graphite'] if config['graphite']
@@ -253,6 +293,8 @@ module Dyndnsd
end end
end end
# @param config [Hash{String => Object}]
# @return [void]
private_class_method def self.setup_tracing(config) private_class_method def self.setup_tracing(config)
# configure OpenTracing # configure OpenTracing
if config.dig('tracing', 'jaeger') if config.dig('tracing', 'jaeger')
@@ -267,10 +309,17 @@ module Dyndnsd
end end
end end
# @param config [Hash{String => Object}]
# @return [void]
private_class_method def self.setup_rack(config) private_class_method def self.setup_rack(config)
# configure daemon # configure daemon
db = Database.new(config['db']) db = Database.new(config['db'])
updater = Updater::CommandWithBindZone.new(config['domain'], config['updater']['params']) if config['updater']['name'] == 'command_with_bind_zone' case config.dig('updater', 'name')
when 'command_with_bind_zone'
updater = Updater::CommandWithBindZone.new(config['domain'], config.dig('updater', 'params'))
when 'zone_transfer_server'
updater = Updater::ZoneTransferServer.new(config['domain'], config.dig('updater', 'params'))
end
daemon = Daemon.new(config, db, updater) daemon = Daemon.new(config, db, updater)
# configure rack # configure rack

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
require 'forwardable' require 'forwardable'
@@ -7,19 +8,22 @@ module Dyndnsd
def_delegators :@db, :[], :[]=, :each, :has_key? def_delegators :@db, :[], :[]=, :each, :has_key?
# @param db_file [String]
def initialize(db_file) def initialize(db_file)
@db_file = db_file @db_file = db_file
end end
# @return [void]
def load def load
if File.file?(@db_file) if File.file?(@db_file)
@db = JSON.parse(File.open(@db_file, 'r', &:read)) @db = JSON.parse(File.read(@db_file, mode: 'r'))
else else
@db = {} @db = {}
end end
@db_hash = @db.hash @db_hash = @db.hash
end end
# @return [void]
def save def save
Helper.span('database_save') do |_span| Helper.span('database_save') do |_span|
File.open(@db_file, 'w') { |f| JSON.dump(@db, f) } File.open(@db_file, 'w') { |f| JSON.dump(@db, f) }
@@ -27,6 +31,7 @@ module Dyndnsd
end end
end end
# @return [Boolean]
def changed? def changed?
@db_hash != @db.hash @db_hash != @db.hash
end end

View File

@@ -1,15 +1,20 @@
# frozen_string_literal: true
module Dyndnsd module Dyndnsd
module Generator module Generator
class Bind class Bind
def initialize(domain, config) # @param domain [String]
# @param updater_params [Hash{String => Object}]
def initialize(domain, updater_params)
@domain = domain @domain = domain
@ttl = config['ttl'] @ttl = updater_params['ttl']
@dns = config['dns'] @dns = updater_params['dns']
@email_addr = config['email_addr'] @email_addr = updater_params['email_addr']
@additional_zone_content = config['additional_zone_content'] @additional_zone_content = updater_params['additional_zone_content']
end end
# @param db [Dyndnsd::Database]
# @return [String]
def generate(db) def generate(db)
out = [] out = []
out << "$TTL #{@ttl}" out << "$TTL #{@ttl}"
@@ -22,7 +27,7 @@ module Dyndnsd
ips.each do |ip| ips.each do |ip|
ip = IPAddr.new(ip).native ip = IPAddr.new(ip).native
type = ip.ipv6? ? 'AAAA' : 'A' type = ip.ipv6? ? 'AAAA' : 'A'
name = hostname.chomp('.' + @domain) name = hostname.chomp(".#{@domain}")
out << "#{name} IN #{type} #{ip}" out << "#{name} IN #{type} #{ip}"
end end
end end

View File

@@ -1,8 +1,12 @@
# frozen_string_literal: true
require 'ipaddr' require 'ipaddr'
module Dyndnsd module Dyndnsd
class Helper class Helper
# @param hostname [String]
# @param domain [String]
# @return [Boolean]
def self.fqdn_valid?(hostname, domain) def self.fqdn_valid?(hostname, domain)
return false if hostname.length < domain.length + 2 return false if hostname.length < domain.length + 2
return false if !hostname.end_with?(domain) return false if !hostname.end_with?(domain)
@@ -11,6 +15,8 @@ module Dyndnsd
true true
end end
# @param ip [String]
# @return [Boolean]
def self.ip_valid?(ip) def self.ip_valid?(ip)
IPAddr.new(ip) IPAddr.new(ip)
true true
@@ -18,15 +24,26 @@ module Dyndnsd
false false
end end
# @param username [String]
# @param password [String]
# @param users [Hash]
# @return [Boolean]
def self.user_allowed?(username, password, users) def self.user_allowed?(username, password, users)
(users.key? username) && (users[username]['password'] == password) (users.key? username) && (users[username]['password'] == password)
end end
# @param hostname [String]
# @param myips [Array]
# @param hosts [Hash]
# @return [Boolean]
def self.changed?(hostname, myips, hosts) def self.changed?(hostname, myips, hosts)
# myips order is always deterministic # myips order is always deterministic
((!hosts.include? hostname) || (hosts[hostname] != myips)) && !myips.empty? ((!hosts.include? hostname) || (hosts[hostname] != myips)) && !myips.empty?
end end
# @param operation [String]
# @param block [Proc]
# @return [void]
def self.span(operation, &block) def self.span(operation, &block)
scope = OpenTracing.start_active_span(operation) scope = OpenTracing.start_active_span(operation)
span = scope.span span = scope.span
@@ -41,9 +58,9 @@ module Dyndnsd
'error.kind': e.class.to_s, 'error.kind': e.class.to_s,
'error.object': e, 'error.object': e,
message: e.message, message: e.message,
stack: e.backtrace.join("\n") stack: e.backtrace&.join("\n") || ''
) )
raise raise e
ensure ensure
scope.close scope.close
end end

View File

@@ -1,11 +1,15 @@
# frozen_string_literal: true
module Dyndnsd module Dyndnsd
module Responder module Responder
class DynDNSStyle class DynDNSStyle
# @param app [#call]
def initialize(app) def initialize(app)
@app = app @app = app
end end
# @param env [Hash{String => String}]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def call(env) def call(env)
@app.call(env).tap do |status_code, headers, body| @app.call(env).tap do |status_code, headers, body|
if headers.key?('X-DynDNS-Response') if headers.key?('X-DynDNS-Response')
@@ -18,26 +22,40 @@ module Dyndnsd
private private
# @param status_code [Integer]
# @param headers [Hash{String => String}]
# @param body [Array<String>]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def decorate_dyndnsd_response(status_code, headers, body) 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])]] [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']] error_response_map[headers['X-DynDNS-Response']]
end end
end end
# @param status_code [Integer]
# @param headers [Hash{String => String}]
# @param _body [Array<String>]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def decorate_other_response(status_code, headers, _body) def decorate_other_response(status_code, headers, _body)
if status_code == 400 case status_code
when 400
[status_code, headers, ['Bad Request']] [status_code, headers, ['Bad Request']]
elsif status_code == 401 when 401
[status_code, headers, ['badauth']] [status_code, headers, ['badauth']]
end end
end end
# @param changes [Array<Symbol>]
# @param myips [Array<String>]
# @return [String]
def get_success_body(changes, myips) def get_success_body(changes, myips)
changes.map { |change| "#{change} #{myips.join(' ')}" }.join("\n") changes.map { |change| "#{change} #{myips.join(' ')}" }.join("\n")
end end
# @return [Hash{String => Object}]
def error_response_map def error_response_map
{ {
# general http errors # general http errors

View File

@@ -1,11 +1,15 @@
# frozen_string_literal: true
module Dyndnsd module Dyndnsd
module Responder module Responder
class RestStyle class RestStyle
# @param app [#call]
def initialize(app) def initialize(app)
@app = app @app = app
end end
# @param env [Hash{String => String}]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def call(env) def call(env)
@app.call(env).tap do |status_code, headers, body| @app.call(env).tap do |status_code, headers, body|
if headers.key?('X-DynDNS-Response') if headers.key?('X-DynDNS-Response')
@@ -18,26 +22,40 @@ module Dyndnsd
private private
# @param status_code [Integer]
# @param headers [Hash{String => String}]
# @param body [Array<String>]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def decorate_dyndnsd_response(status_code, headers, body) 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])]] [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']] error_response_map[headers['X-DynDNS-Response']]
end end
end end
# @param status_code [Integer]
# @param headers [Hash{String => String}]
# @param _body [Array<String>]
# @return [Array{Integer,Hash{String => String},Array<String>}]
def decorate_other_response(status_code, headers, _body) def decorate_other_response(status_code, headers, _body)
if status_code == 400 case status_code
when 400
[status_code, headers, ['Bad Request']] [status_code, headers, ['Bad Request']]
elsif status_code == 401 when 401
[status_code, headers, ['Unauthorized']] [status_code, headers, ['Unauthorized']]
end end
end end
# @param changes [Array<Symbol>]
# @param myips [Array<String>]
# @return [String]
def get_success_body(changes, myips) def get_success_body(changes, myips)
changes.map { |change| change == :good ? "Changed to #{myips.join(' ')}" : "No change needed for #{myips.join(' ')}" }.join("\n") changes.map { |change| change == :good ? "Changed to #{myips.join(' ')}" : "No change needed for #{myips.join(' ')}" }.join("\n")
end end
# @return [Hash{String => Object}]
def error_response_map def error_response_map
{ {
# general http errors # general http errors

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
# Adapted from https://github.com/eric/metriks-graphite/blob/master/lib/metriks/reporter/graphite.rb # Adapted from https://github.com/eric/metriks-graphite/blob/master/lib/metriks/reporter/graphite.rb
@@ -5,8 +6,11 @@ require 'metriks'
module Dyndnsd module Dyndnsd
class TextfileReporter class TextfileReporter
# @return [String]
attr_reader :file attr_reader :file
# @param file [String]
# @param options [Hash{Symbol => Object}]
def initialize(file, options = {}) def initialize(file, options = {})
@file = file @file = file
@@ -14,35 +18,37 @@ module Dyndnsd
@registry = options[:registry] || Metriks::Registry.default @registry = options[:registry] || Metriks::Registry.default
@interval = options[:interval] || 60 @interval = options[:interval] || 60
@on_error = options[:on_error] || proc { |ex| } @on_error = options[:on_error] || proc { |ex| } # default: ignore errors
end end
# @return [void]
def start def start
@thread ||= Thread.new do @thread ||= Thread.new do
loop do loop do
sleep @interval sleep @interval
Thread.new do Thread.new do
begin write
write rescue StandardError => e
rescue StandardError => e @on_error[e] rescue nil
@on_error[e] rescue nil
end
end end
end end
end end
end end
# @return [void]
def stop def stop
@thread&.kill @thread&.kill
@thread = nil @thread = nil
end end
# @return [void]
def restart def restart
stop stop
start start
end end
# @return [void]
def write def write
File.open(@file, 'w') do |f| File.open(@file, 'w') do |f|
@registry.each do |name, metric| @registry.each do |name, metric|
@@ -85,6 +91,12 @@ module Dyndnsd
end end
end end
# @param file [String]
# @param base_name [String]
# @param metric [Object]
# @param keys [Array<Symbol>]
# @param snapshot_keys [Array<Symbol>]
# @return [void]
def write_metric(file, base_name, metric, keys, snapshot_keys = []) def write_metric(file, base_name, metric, keys, snapshot_keys = [])
time = Time.now.to_i time = Time.now.to_i

View File

@@ -1,26 +1,34 @@
# frozen_string_literal: true
module Dyndnsd module Dyndnsd
module Updater module Updater
class CommandWithBindZone class CommandWithBindZone
def initialize(domain, config) # @param domain [String]
@zone_file = config['zone_file'] # @param updater_params [Hash{String => Object}]
@command = config['command'] def initialize(domain, updater_params)
@generator = Generator::Bind.new(domain, config) @zone_file = updater_params['zone_file']
@command = updater_params['command']
@generator = Generator::Bind.new(domain, updater_params)
end end
def update(zone) # @param db [Dyndnsd::Database]
# @return [void]
def update(db)
# do not regenerate zone file (assumed to be persistent) if DB did not change
return if !db.changed?
Helper.span('updater_update') do |span| Helper.span('updater_update') do |span|
span.set_tag('dyndnsd.updater.name', self.class.name.split('::').last) span.set_tag('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
# write zone file in bind syntax # write zone file in bind syntax
File.open(@zone_file, 'w') { |f| f.write(@generator.generate(zone)) } File.open(@zone_file, 'w') { |f| f.write(@generator.generate(db)) }
# call user-defined command # call user-defined command
pid = fork do pid = fork do
exec @command exec @command
end end
# detach so children don't become zombies # detach so children don't become zombies
Process.detach(pid) Process.detach(pid) if pid
end end
end end
end end

View File

@@ -0,0 +1,158 @@
# frozen_string_literal: true
require 'resolv'
require 'securerandom'
require 'async/dns'
module Dyndnsd
module Updater
class ZoneTransferServer
DEFAULT_SERVER_LISTENS = ['0.0.0.0@53'].freeze
# @param domain [String]
# @param updater_params [Hash{String => Object}]
def initialize(domain, updater_params)
@domain = domain
@server_listens = self.class.parse_endpoints(updater_params['server_listens'] || DEFAULT_SERVER_LISTENS)
@notify_targets = (updater_params['send_notifies'] || []).map { |e| self.class.parse_endpoints([e]) }
@zone_rr_ttl = updater_params['zone_ttl']
@zone_nameservers = updater_params['zone_nameservers'].map { |n| Resolv::DNS::Name.create(n) }
@zone_email_address = Resolv::DNS::Name.create(updater_params['zone_email_address'])
@zone_additional_ips = updater_params['zone_additional_ips'] || []
@server = ZoneTransferServerHelper.new(@server_listens, @domain)
# run Async::DNS server in background thread
Thread.new do
@server.run
end
end
# @param db [Dyndnsd::Database]
# @return [void]
def update(db)
Helper.span('updater_update') do |span|
span.set_tag('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
soa_rr = Resolv::DNS::Resource::IN::SOA.new(
@zone_nameservers[0], @zone_email_address,
db['serial'],
10_800, # 3h
300, # 5m
604_800, # 1w
3_600 # 1h
)
default_options = {ttl: @zone_rr_ttl}
# array containing all resource records for an AXFR request in the right order
rrs = []
# AXFR responses need to start with zone's SOA RR
rrs << [soa_rr, default_options]
# return RRs for all of the zone's nameservers
@zone_nameservers.each do |ns|
rrs << [Resolv::DNS::Resource::IN::NS.new(ns), default_options]
end
# return A/AAAA RRs for all additional IPv4s/IPv6s for the domain itself
@zone_additional_ips.each do |ip|
rrs << [create_addr_rr_for_ip(ip), default_options]
end
# return A/AAAA RRs for the dyndns hostnames
db['hosts'].each do |hostname, ips|
ips.each do |ip|
rrs << [create_addr_rr_for_ip(ip), default_options.merge({name: hostname})]
end
end
# AXFR responses need to end with zone's SOA RR again
rrs << [soa_rr, default_options]
# point Async::DNS server thread's variable to this new RR array
@server.axfr_rrs = rrs
# only send DNS NOTIFY if there really was a change
if db.changed?
send_dns_notify
end
end
end
# converts into suitable parameter form for Async::DNS::Resolver or Async::DNS::Server
#
# @param endpoint_list [Array<String>]
# @return [Array{Array{Object}}]
def self.parse_endpoints(endpoint_list)
endpoint_list.map { |addr_string| addr_string.split('@') }
.map { |addr_parts| [addr_parts[0], addr_parts[1].to_i || 53] }
.map { |addr| [:tcp, :udp].map { |type| [type] + addr } }
.flatten(1)
end
private
# creates correct Resolv::DNS::Resource object for IP address type
#
# @param ip_string [String]
# @return [Resolv::DNS::Resource::IN::A,Resolv::DNS::Resource::IN::AAAA]
def create_addr_rr_for_ip(ip_string)
ip = IPAddr.new(ip_string).native
if ip.ipv6?
Resolv::DNS::Resource::IN::AAAA.new(ip.to_s)
else
Resolv::DNS::Resource::IN::A.new(ip.to_s)
end
end
# https://tools.ietf.org/html/rfc1996
#
# @return [void]
def send_dns_notify
Async::Reactor.run do
@notify_targets.each do |notify_target|
target = Async::DNS::Resolver.new(notify_target)
# assemble DNS NOTIFY message
request = Resolv::DNS::Message.new(SecureRandom.random_number(2**16))
request.opcode = Resolv::DNS::OpCode::Notify
request.add_question("#{@domain}.", Resolv::DNS::Resource::IN::SOA)
_response = target.dispatch_request(request)
end
end
end
end
class ZoneTransferServerHelper < Async::DNS::Server
attr_accessor :axfr_rrs
def initialize(endpoints, domain)
super(endpoints, logger: Dyndnsd.logger)
@domain = domain
end
# @param name [String]
# @param resource_class [Resolv::DNS::Resource]
# 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
transaction.fail!(:NXDomain)
return
end
# https://tools.ietf.org/html/rfc5936
transaction.append_question!
@axfr_rrs.each do |rr|
transaction.add([rr[0]], rr[1])
end
end
end
end
end

View File

@@ -1,4 +1,5 @@
# frozen_string_literal: true
module Dyndnsd module Dyndnsd
VERSION = '2.0.0'.freeze VERSION = '3.1.3'
end end

View File

@@ -1,10 +1,12 @@
require 'spec_helper' # frozen_string_literal: true
require_relative 'spec_helper'
describe Dyndnsd::Daemon do describe Dyndnsd::Daemon do
include Rack::Test::Methods include Rack::Test::Methods
def app def app
Dyndnsd.logger = Logger.new(STDOUT) Dyndnsd.logger = Logger.new($stdout)
Dyndnsd.logger.level = Logger::UNKNOWN Dyndnsd.logger.level = Logger::UNKNOWN
config = { config = {

View File

@@ -1,8 +1,10 @@
# frozen_string_literal: true
require 'rubygems' require 'rubygems'
require 'bundler/setup' require 'bundler/setup'
require 'rack/test' require 'rack/test'
require 'dyndnsd' require 'dyndnsd'
require 'support/dummy_database'
require 'support/dummy_updater' require_relative 'support/dummy_database'
require_relative 'support/dummy_updater'

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
require 'forwardable' require 'forwardable'

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
module Dyndnsd module Dyndnsd
module Updater module Updater