✨ add DynDNS2 support for noip.com

✨ add man page

.gitchangelog.rc

@@ -82,24 +82,34 @@ ignore_regexps = [
 ## whenever you are tweaking this variable.
 ##
 section_regexps = [
-    ('New', [
-        r'^:sparkles\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+    ('Features', [
+        r'^[fF]eat\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
-    ('Changes', [
-        r'^:wrench\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+    ('Added', [
+        r'^[aA]dd\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Changed', [
+        r'^[cC]hange\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Deprecated', [
+        r'^[dD]epricated\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Removed', [
+        r'^[rR]emove\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
     ('Fix', [
-        r'^:bug\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+        r'^[fF]ix\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Security', [
+        r'^[sS]ec\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
     ('Documentation', [
-        r'^:memo\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
-     ]),     
-    ('Remove', [
-        r'^:fire\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+        r'^[dD]oc\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
 
-    ('Other', None ## Match all lines
-     ),
+
+    #('Other', None ## Match all lines
+    # ),
 
 ]
 

.pre-commit-config.yaml

@@ -9,3 +9,9 @@ repos:
         - "-i 2" # indent: 0 for tabs (default), >0 for number of spaces
         - "-ci" # switch cases will be indented
         - "-w" # write result to file instead of stdout
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.9
+    hooks:
+    - id: mdformat
+      additional_dependencies:
+      - mdformat-gfm # GitHub Flavored Markdown support

CHANGELOG.md

@@ -1,20 +1,50 @@
 # Changelog
 
 
-## (unreleased)
+## 0.2.0 (2021-09-24)
+
+### New
+
+* :sparkles: enable parameter extensions for `docker run --interactive` [Eduard Veit]
+
+* :sparkles: add pre-commit hooks for markdown. [Eduard Veit]
+
+* :sparkles: change git hooks and add shfmt. [Eduard Veit]
+
+* :sparkles: add pre-commit git hook for shellcheck. [Eduard Veit]
+
+### Changes
+
+* :wrench: remove md-toc from pre-commit. [Eduard Veit]
+
+* :wrench: handle dns server selection. [Eduard Veit]
 
 ### Documentation
 
+* :memo: update CHANGELOG.md. [Eduard Veit]
+
+* :memo: document docker parameters. [Eduard Veit]
+
+* :memo: change default dns server setting. [Eduard Veit]
+
+* :memo: update CHANGELOG. [Eduard Veit]
+
 * :memo: update README.md. [Eduard Veit]
 
 ### Other
 
+* :art: lint README.md. [Eduard Veit]
+
+* :art: add shfmt params to pre-commit check. [Eduard Veit]
+
+* :art: fix shell style. [Eduard Veit]
+
+* :recycle: seperate parsing logic. [Eduard Veit]
+
 * :recycle: normalizing pre-commit configuration to a top-level map. [Eduard Veit]
 
 * :recycle: refactorings. [Eduard Veit]
 
-* Feature: :sparkles: add pre-commit git hook for shellcheck. [Eduard Veit]
-
 * Refactor: :recycle: remove unused help message. [Eduard Veit]
 
 

Dockerfile

@@ -1,5 +1,20 @@
 FROM alpine:latest
-RUN apk update && apk add bash curl jq bind-tools
+
+RUN \
+apk update \
+&& \
+apk add \
+bash \
+curl \
+jq \
+bind-tools
+
 WORKDIR /usr/src/app
+
 COPY . .
-CMD /bin/bash /usr/src/app/dynb.sh
+
+ENTRYPOINT ["/bin/bash", "/usr/src/app/dynb.sh"]
+
+LABEL org.opencontainers.image.source="https://github.com/EV21/dynb"
+LABEL org.opencontainers.image.description="DynB - dynamic DNS update client."
+LABEL org.opencontainers.image.licenses="MIT"

README.md

@@ -1,8 +1,11 @@
 # 🔃 DynB
+
 DynB - dynamic DNS update script, written in bash
 
 IPv4 (A) and IPv6 (AAAA) record updates are supported.
+
 <!-- TOC -->
+
 - [✨ Update Methods](#-update-methods)
   - [APIs](#apis)
   - [DynDNS2](#dyndns2)
@@ -11,45 +14,52 @@ IPv4 (A) and IPv6 (AAAA) record updates are supported.
 - [⚙ Configuration](#-configuration)
 - [🏃 Run](#-run)
 - [⏰ Cron](#-cron)
+  - [loop mode](#loop-mode)
+  - [crontab](#crontab)
 - [🐟 docker](#-docker)
+- [environment variables](#environment-variables)
+
 <!-- /TOC -->
 
 ## ✨ Update Methods
+
 The following update methods are currently implemented:
 
 ### APIs
 
-* INWX.com Domrobot JSON-RPC-API  
+- INWX.com Domrobot JSON-RPC-API\
   Limitations:
   - minimum TTL is 300 (5 minutes)
 
 ### DynDNS2
 
-* INWX.com  
-* deSEC.io (dedyn.io)  
-* DuckDNS.org  
-* dynv6.com  
+- INWX.com
+- deSEC.io (dedyn.io)
+- DuckDNS.org
+- dynv6.com
 
 ## 📦 Requirements
 
-* `curl` - The minimum requirement for all API requests.
-* `dig` - You can get it by installing `dnsutils` (debian/ubuntu/ArchLinux), `bind-utils` (CentOS/RHEL), `bind-tools` (Alpine)
+- `curl` - The minimum requirement for all API requests.
+- `dig` - You can get it by installing `dnsutils` (debian/ubuntu/ArchLinux), `bind-utils` (CentOS/RHEL), `bind-tools` (Alpine)
 
 also essential if you are using other APIs:
 
-* `jq` - Command-line JSON processor
+- `jq` - Command-line JSON processor
 
 ## 🚀 Installation
 
 Download the latest release
 
 or simply clone this repo
-```
+
+```shell
 git clone https://github.com/EV21/dynb.git
 ```
 
 If you want to add the script to you PATH, run :point_down:
-```
+
+```shell
 bash dynb.sh --link
 ```
 
@@ -59,7 +69,8 @@ You can use a config in form of an `.env` file.
 Or you can just use CLI parameters.
 
 Create `.env` in the app root directory or at `~/.local/share/dynb/.env`.
-```
+
+```bash
 DYNB_DYN_DOMAIN=dyndns.example.com
 
 ## service provider could be deSEC, duckdns, dynv6, inwx
@@ -82,18 +93,23 @@ DYNB_TOKEN=
 ## 🏃 Run
 
 If you have a config file just run :point_down:
-```
+
+```bash
 dynb
 ```
-Alternatively you can use parameters if your system meets the relevant requirements. This example shows the long form parameter, there are also short ones.  
+
+Alternatively you can use parameters if your system meets the relevant requirements. This example shows the long form parameter, there are also short ones.\
 Call the help function :point_down:
-```
+
+```bash
 dynb --help
 ```
-```
+
+```bash
 dynb --ip-mode dualstack --update-method domrobot --domain dyndns.example.com --username user42 --password SuperSecretPassword
 ```
-```
+
+```bash
 dynb --ip-mode dualstack --update-method dyndns --provider inwx --domain dyndns.example.com --username user42 --password SuperSecretPassword
 ```
 
@@ -108,18 +124,29 @@ Just use the parameter `--interval 60` or the environment variable `DYNB_INTERVA
 ### crontab
 
 execute :point_down:
-```
+
+```bash
 crontab -e
 ```
+
 then enter :point_down: to run dynb every five minutes.
-```
+
+```bash
 */5 * * * * $HOME/.local/bin/dynb >> $HOME/.local/share/dynb/dynb-cron.log
 ```
+
+alternative with docker and parameters::
+
+```bash
+*/5 * * * * docker run --interactive --tty --rm --network host ev21/dynb:latest --ip-mode 64 --update-method domrobot --domain dyndns.example.com --username user42 --password SuperSecretPassword
+```
+
 Note, cron typically does not use the users PATH variable.
 
 ## 🐟 docker
 
-This is an example of a `docker-compose.yml` file. If you are using IPv6 make sure the routing works properly with your docker container.
+This is an example of a `docker-compose.yml` file. If you are using IPv6 make sure the routing works properly with your docker container. Note: [IPv6 networking](https://docs.docker.com/config/daemon/ipv6/) is only supported on Docker daemons running on Linux hosts.
+
 ```yaml
 version: '3.4'
 
@@ -140,9 +167,11 @@ services:
       - DYNB_PASSWORD=SuperSecretPassword
       - DYNB_INTERVAL=60
 ```
+
 ## environment variables
+
 | variable              | default value   | description                                                                                                    |
-| --------------------- | --------------- | --------------------------------------------- |
+| --------------------- | --------------- | -------------------------------------------------------------------------------------------------------------- |
 | DYNB_DYN_DOMAIN       | undefined       | required; `dyndns.example.com`                                                                                 |
 | DYNB_SERVICE_PROVIDER | undefined       | required; `deSEC`, `duckdns`, `dynv6`, `inwx`                                                                  |
 | DYNB_UPDATE_METHOD    | undefined       | required; `dyndns` or `domrobot` (with inwx)                                                                   |

dynb.sh

@@ -51,6 +51,7 @@ _network_interface=
 ######################################################
 ## You don't need to change the following variables ##
 _INWX_JSON_API_URL=https://api.domrobot.com/jsonrpc/
+_internet_connectivity_test_server=https://www.google.de
 _new_IPv4=
 _new_IPv6=
 _dns_records=
@@ -65,7 +66,7 @@ _response=
 _statusHostname=
 _statusUsername=
 _statusPassword=
-_version=0.1.2
+_version=0.3.0
 _userAgent="DynB/$_version github.com/EV21/dynb"
 _configFile=$HOME/.local/share/dynb/.env
 _statusFile=/tmp/dynb.status
@@ -73,6 +74,31 @@ _debug=0
 _minimum_looptime=60
 _loopMode=0
 
+# Ansi color code variables
+yellow_color="\e[0;33m"
+green_color="\e[0;92m"
+expand_bg="\e[K"
+red_color_bg="\e[0;101m${expand_bg}"
+bold="\e[1m"
+reset_color_modification="\e[0m"
+
+REGEX_IPv4="^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$"
+REGEX_IPv6="^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$"
+
+function is_IPv4_address() {
+  if [[ $1 =~ $REGEX_IPv4 ]]
+  then return 0
+  else return 1
+  fi
+}
+
+function is_IPv6_address() {
+  if [[ $1 =~ $REGEX_IPv6 ]]
+  then return 0
+  else return 1
+  fi
+}
+
 function loopMode() {
   if [[ $_loopMode -eq 1 ]]; then
     return 0
@@ -90,16 +116,18 @@ function debugMode() {
 }
 
 function infoMessage() {
-  echo "$(logtime) INFO: $*"
+  echo -e "${green_color}$(logtime) INFO: $*${reset_color_modification}"
 }
 
 function debugMessage() {
   if debugMode; then
-    echo "$(logtime) DEBUG: $*"
+    echo -e "${yellow_color}$(logtime) DEBUG: ${*}${reset_color_modification}"
   fi
 }
 
-function errorMessage() { printf "$(logtime) ERROR: %s\n" "$*" >&2; }
+function errorMessage() {
+  echo -e "${red_color_bg}${bold}$(logtime) ERROR: $*${reset_color_modification}" >&2
+}
 
 function logtime() {
   LOGTIME=$(date "+%Y-%m-%d %H:%M:%S")
@@ -209,7 +237,7 @@ function updateRecord() {
         --request POST $_INWX_JSON_API_URL \
         --data "$request"
     )
-    echo -e "$(echo "$_response" | jq --raw-output '.msg')\n Domain: $DYNB_DYN_DOMAIN\n new IPv${1}: $IP"
+    infoMessage "$(echo "$_response" | jq --raw-output '.msg')\n Domain: $DYNB_DYN_DOMAIN\n New IPv${1}: $IP"
   fi
 }
 
@@ -223,6 +251,7 @@ function dynupdate() {
   DESEC_DYNDNS_UPDATE_URL="https://update.dedyn.io/?"
   DUCKDNS_DYNDNS_UPDATE_URL="https://www.duckdns.org/update?domains=$DYNB_DYN_DOMAIN&token=$DYNB_TOKEN&"
   DYNV6_DYNDNS_UPDATE_URL="https://dynv6.com/api/update?zone=$DYNB_DYN_DOMAIN&token=$DYNB_TOKEN&"
+  NOIP_DYNDNS_UPDATE_URL="https://dynupdate.no-ip.com/nic/update?hostname=$DYNB_DYN_DOMAIN&"
 
   case $DYNB_SERVICE_PROVIDER in
     inwx* | INWX*)
@@ -231,6 +260,9 @@ function dynupdate() {
     deSEC* | desec* | dedyn*)
       dyndns_update_url="${DESEC_DYNDNS_UPDATE_URL}"
       ;;
+    noip* | no-ip*)
+      dyndns_update_url="$NOIP_DYNDNS_UPDATE_URL"
+      ;;
     dynv6*)
       dyndns_update_url="${DYNV6_DYNDNS_UPDATE_URL}"
       myip_str=ipv4
@@ -261,7 +293,7 @@ function dynupdate() {
 
   ## request ##
   case $DYNB_SERVICE_PROVIDER in
-    inwx* | INWX*)
+    inwx* | INWX* | noip* | no-ip*)
       _response=$(curl --silent "$_interface_str" \
         --user-agent "$_userAgent" \
         --user "$DYNB_USERNAME":"$DYNB_PASSWORD" \
@@ -283,6 +315,7 @@ function dynupdate() {
       ;;
   esac
 
+
   case $_response in
     good* | OK* | "addresses updated")
       if [[ $_response == "good 127.0.0.1" ]]; then
@@ -427,6 +460,11 @@ function ipHasChanged() {
   case ${1} in
     4)
       remote_ip=$(getRemoteIP 4 $_ipv4_checker)
+      if ! is_IPv4_address "$remote_ip"
+      then
+        errorMessage "The response from the IP check server is not an IPv4 address: $remote_ip"
+        return 0
+      fi
       if [[ $DYNB_UPDATE_METHOD == domrobot ]]; then
         dns_ip=$(getDNSIP A)
       else
@@ -439,13 +477,20 @@ function ipHasChanged() {
           errorMessage "DNS request failed $dig_response"
           return 0
         fi
-        dns_ip=$dig_response
+        # If the dns resolver lists multiple records in the answer section we filter the first line
+        # using short option "-n" and not "--lines" because of alpines limited BusyBox head command
+        dns_ip=$(echo "$dig_response" | head -n 1)
       fi
       _new_IPv4=$remote_ip
-      debugMessage "New IPv4: $_new_IPv4 old was: $dns_ip"
+      debugMessage "IPv4 from remote IP check server: $_new_IPv4, IPv4 from DNS: $dns_ip"
       ;;
     6)
       remote_ip=$(getRemoteIP 6 $_ipv6_checker)
+      if ! is_IPv6_address "$remote_ip"
+      then
+        errorMessage "The response from the IP check server is not an IPv6 address: $remote_ip"
+        return 0
+      fi
       if [[ $DYNB_UPDATE_METHOD == domrobot ]]; then
         dns_ip=$(getDNSIP AAAA)
       else
@@ -458,18 +503,22 @@ function ipHasChanged() {
           errorMessage "DNS request failed $dig_response"
           return 0
         fi
-        dns_ip=$dig_response
+        # If the dns server lists multiple records in the answer section we filter the first line
+        dns_ip=$(echo "$dig_response" | head -n 1)
       fi
       _new_IPv6=$remote_ip
-      debugMessage "New IPv6: $_new_IPv6 old was: $dns_ip"
+      debugMessage "IPv6 from remote IP check server: $_new_IPv6, IPv4 from DNS: $dns_ip"
       ;;
     *) ;;
-
   esac
 
   if [[ "$remote_ip" == "$dns_ip" ]]; then
     return 0
   else
+    case ${1} in
+    4) infoMessage "New IPv4: $_new_IPv4 old was: $dns_ip";;
+    6) infoMessage "New IPv6: $_new_IPv6 old was: $dns_ip";;
+    esac
     return 1
   fi
 }
@@ -680,6 +729,43 @@ function doUpdates() {
   fi
 }
 
+function ipv6_is_not_working() {
+  curl --ipv6 --head --silent --max-time 1 "$_internet_connectivity_test_server" > /dev/null
+  status_code=$?
+  if [[ $status_code -gt 0 ]]
+  then return 0
+  else return 1
+  fi
+}
+
+function ipv4_is_not_working() {
+  curl --ipv4 --head --silent --max-time 1 "$_internet_connectivity_test_server" > /dev/null
+  status_code=$?
+  if [[ $status_code -gt 0 ]]
+  then return 0
+  else return 1
+  fi
+}
+
+function check_internet_connection() {
+  if [[ $_is_IPv4_enabled == true ]]
+  then
+    if ipv4_is_not_working
+    then
+      _is_IPv4_enabled="false"
+      errorMessage "Your IPv4 internet connection does not work."
+    fi
+  fi
+  if [[ $_is_IPv6_enabled == true ]]
+  then
+    if ipv6_is_not_working
+    then
+      _is_IPv6_enabled="false"
+      errorMessage "Your IPv6 internet connection does not work."
+    fi
+  fi
+}
+
 #################
 ## MAIN method ##
 #################
@@ -707,6 +793,7 @@ function dynb() {
   ## parameters and checks
   handleParameters
   checkDependencies
+  check_internet_connection
 
   if loopMode; then
     while :; do
@@ -726,5 +813,3 @@ function dynb() {
 
 dynb "${@}"
 exit $?
-
-# ] <-- needed because of Argbash