1
0
mirror of https://github.com/EV21/dynb.git synced 2025-12-26 16:39:32 +01:00

13 Commits

Author SHA1 Message Date
ebff1d73bd add completion
 add man page
2021-04-03 15:15:53 +02:00
262f7c3709 replace getopt with argbash 2021-04-03 14:06:03 +02:00
5210c35400 ♻️ refactor, fix and debug error handling 2021-01-27 17:52:15 +01:00
522a0f99bb ♻️ refactor main code 2021-01-26 22:23:03 +01:00
3bf6b69ae8 add interpretaton of status codes and act accordingly 2021-01-26 21:43:07 +01:00
d139022295 make network interface configurable 2021-01-26 21:43:07 +01:00
8997835903 🐛 fix sourcing of config file
♻️ do some shellcheck fixes
2021-01-26 21:43:07 +01:00
d6dc223794 add DynDNS2 support for dynv6.com 2021-01-26 21:43:07 +01:00
dc12f71d00 📝 add CHANGELOG.md 2021-01-26 21:43:07 +01:00
5ba730cff1 add .gitchangelog.rc 2021-01-26 21:43:07 +01:00
1104cf8505 📝 add example.env 2021-01-26 21:43:07 +01:00
99a446f4c7 📝 write README.md 2021-01-26 21:42:21 +01:00
f056e96e25 add dynb.sh 2021-01-26 21:24:33 +01:00
11 changed files with 152 additions and 360 deletions

View File

@@ -1,9 +0,0 @@
**/.env
**/.dockerignore
**/.docker-compose.debug.yml
**/.docker-compose.yml
**/.git
**/.gitignore
**/.gitchangelog.rc
man/man.rst
man/man-defs.rst

3
.gitignore vendored
View File

@@ -1,2 +1 @@
.env* .env*
docker-compose*

View File

@@ -1,25 +1,10 @@
# Changelog # Changelog
## 0.1.1 (2021-04-23) ## (unreleased)
### Fix
* :bug: fix loop and error handling in case of connection issues. [Eduard Veit]
## 0.1.0 (2021-04-22)
### New ### New
* :sparkles: add Dockerfile. [Eduard Veit]
* :sparkles: add loop mode. [Eduard Veit]
* :sparkles: add support for Duck DNS as DynDNS2 provider. [Eduard Veit]
* :sparkles: add support for deSEC as DynDNS2 provider. [Eduard Veit]
* :sparkles: add completion. [Eduard Veit] * :sparkles: add completion. [Eduard Veit]
:sparkles: add man page :sparkles: add man page
@@ -44,12 +29,6 @@
### Documentation ### Documentation
* :memo: document example of an docker-compose.yml file. [Eduard Veit]
* :memo: document loop mode and dig as requirement. [Eduard Veit]
* :memo: update example of .env in README.md. [Eduard Veit]
* :memo: add CHANGELOG.md. [Eduard Veit] * :memo: add CHANGELOG.md. [Eduard Veit]
* :memo: add example.env. [Eduard Veit] * :memo: add example.env. [Eduard Veit]
@@ -58,8 +37,6 @@
### Other ### Other
* :recycle: refactor: rename environment variables. [Eduard Veit]
* :recycle: refactor, fix and debug error handling. [Eduard Veit] * :recycle: refactor, fix and debug error handling. [Eduard Veit]
* :recycle: refactor main code. [Eduard Veit] * :recycle: refactor main code. [Eduard Veit]

View File

@@ -1,5 +0,0 @@
FROM alpine:latest
RUN apk update && apk add bash curl jq bind-tools
WORKDIR /usr/src/app
COPY . .
CMD /bin/bash /usr/src/app/dynb.sh

View File

@@ -11,7 +11,6 @@ IPv4 (A) and IPv6 (AAAA) record updates are supported.
- [⚙ Configuration](#-configuration) - [⚙ Configuration](#-configuration)
- [🏃 Run](#-run) - [🏃 Run](#-run)
- [⏰ Cron](#-cron) - [⏰ Cron](#-cron)
- [⏰ docker](#-docker)
<!-- /TOC --> <!-- /TOC -->
## ✨ Update Methods ## ✨ Update Methods
@@ -19,21 +18,18 @@ The following update methods are currently implemented:
### APIs ### APIs
* INWX.com Domrobot JSON-RPC-API * INWX.com JSON-RPC-API
Limitations: Limitations:
- minimum TTL is 300 (5 minutes) - minimum TTL is 300 (5 minutes)
### DynDNS2 ### DynDNS2
* INWX.com * INWX.com
* deSEC.io (dedyn.io) * dynv6.com
* DuckDNS.org
* dynv6.com
## 📦 Requirements ## 📦 Requirements
* `curl` - The minimum requirement for all API requests. * `curl` - The minimum requirement for running DynDNS2 operations
* `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: also essential if you are using other APIs:
@@ -52,6 +48,7 @@ If you want to add the script to you PATH, run :point_down:
``` ```
bash dynb.sh --link bash dynb.sh --link
``` ```
This convenience function only works if `util-linux` is installed on your system.
## ⚙ Configuration ## ⚙ Configuration
@@ -60,23 +57,21 @@ Or you can just use CLI parameters.
Create `.env` in the app root directory or at `~/.local/share/dynb/.env`. Create `.env` in the app root directory or at `~/.local/share/dynb/.env`.
``` ```
DYNB_DYN_DOMAIN=dyndns.example.com _dyn_domain=dyndns.example.com
## service provider could be deSEC, duckdns, dynv6, inwx ## service provider could be inwx
DYNB_SERVICE_PROVIDER=inwx _serviceProvider=inwx
## update method options: domrobot, dyndns ## update method options: domrobot, dyndns
DYNB_UPDATE_METHOD=domrobot _update_method=domrobot
## ip mode could be either: 4, 6 or dual for dualstack ## ip mode could be either: 4, 6 or dual for dualstack
DYNB_IP_MODE=64 _ip_mode=dual
## If you are using the DomRobot RPC-API enter your credentials for the web interface login here ## If you are using the DomRobot RPC-API enter your credentials for the web interface login here
## If you are using the DynDNS2 protocol enter your credentials here ## If you are using the DynDNS2 protocol enter your credentials here
DYNB_USERNAME=User42 _username=
DYNB_PASSWORD=SuperSecretPassword _password=
## or use a token
DYNB_TOKEN=
``` ```
## 🏃 Run ## 🏃 Run
@@ -98,14 +93,7 @@ dynb --ip-mode dualstack --update-method dyndns --provider inwx --domain dyndns.
``` ```
## ⏰ Cron ## ⏰ Cron
To automatically call the script you can use cron.
To automatically call the script you can use either crontab or the script can also run in a loop mode.
### loop mode
Just use the parameter `--interval 60` or the environment variable `DYNB_INTERVAL=60` so the script will check every 60 seconds if it needs to do an update.
### crontab
execute :point_down: execute :point_down:
``` ```
@@ -116,27 +104,3 @@ then enter :point_down: to run dynb every five minutes.
*/5 * * * * $HOME/.local/bin/dynb >> $HOME/.local/share/dynb/dynb-cron.log */5 * * * * $HOME/.local/bin/dynb >> $HOME/.local/share/dynb/dynb-cron.log
``` ```
Note, cron typically does not use the users PATH variable. 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.
```yaml
version: '3.4'
services:
dynb:
image: ev21/dynb
container_name: dynb
network_mode: host
build:
context: .
dockerfile: ./Dockerfile
environment:
- DYNB_DYN_DOMAIN=dyndns.example.com
- DYNB_SERVICE_PROVIDER=inwx
- DYNB_UPDATE_METHOD=dyndns
- DYNB_IP_MODE=64
- DYNB_USERNAME=User42
- DYNB_PASSWORD=SuperSecretPassword
- DYNB_INTERVAL=60
```

View File

@@ -12,10 +12,10 @@ _dynb_sh ()
COMPREPLY=() COMPREPLY=()
cur="${COMP_WORDS[COMP_CWORD]}" cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}" prev="${COMP_WORDS[COMP_CWORD-1]}"
all_long_opts="--version --link --reset --debug --update-method --ip-mode --domain --service-provider --username --password --token --interval --help " all_long_opts="--version --link --reset --debug --update-method --ip-mode --domain --service-provider --username --password --token --help "
all_short_opts="-v -l -r -m -i -d -s -u -p -t -h " all_short_opts="-v -l -r -m -i -d -s -u -p -t -h "
case "$prev" in case "$prev" in
--update-method|-m|--ip-mode|-i|--domain|-d|--service-provider|-s|--username|-u|--password|-p|--token|-t|--interval) --update-method|-m|--ip-mode|-i|--domain|-d|--service-provider|-s|--username|-u|--password|-p|--token|-t)
COMPREPLY=( $(compgen -o bashdefault -o default -- "${cur}") ) COMPREPLY=( $(compgen -o bashdefault -o default -- "${cur}") )
return 0 return 0
;; ;;
@@ -37,5 +37,5 @@ _dynb_sh ()
esac esac
} }
complete -F _dynb_sh dynb.sh complete -F _dynb_sh dynb.sh dynb
### END OF CODE GENERATED BY Argbash (sortof) ### ]) ### END OF CODE GENERATED BY Argbash (sortof) ### ])

353
dynb.sh
View File

@@ -10,33 +10,33 @@
## Configuration ## ## Configuration ##
################### ###################
#DYNB_DYN_DOMAIN= _dyn_domain=
## service provider could be deSEC, duckdns, dynv6, inwx ## service provider could be inwx
#DYNB_SERVICE_PROVIDER= _serviceProvider=
## update method options: domrobot, dyndns ## update method options: domrobot, dyndns
#DYNB_UPDATE_METHOD= _update_method=
## ip mode could be either: 4, 6 or dual for dualstack ## ip mode could be either: 4, 6 or dual for dualstack
#DYNB_IP_MODE= _ip_mode=
## If you are using the DomRobot RPC-API enter your credentials for the web interface login here ## If you are using the DomRobot RPC-API enter your credentials for the web interface login here
## If you are using the DynDNS2 protocol enter your credentials here ## If you are using the DynDNS2 protocol enter your credentials here
#DYNB_USERNAME= _username=
#DYNB_PASSWORD= _password=
## or use a token ## or use a token
#DYNB_TOKEN= _token=
## TTL (time to live) for the DNS record ## TTL (time to live) for the DNS record
## This setting is only relevant for API based record updates (not DnyDNS2!) ## This setting is only relevant for API based record updates (not DnyDNS2!)
## minimum allowed TTL value by inwx is 300 (5 minutes) ## minimum allowed TTL value by inwx is 300 (5 minutes)
TTL=300 TTL=300
## The IP-Check sites (some sites have different urls for v4 and v6) ## The IP-Check sites (some sites have different urls for v4 and v6)
## Pro tip: use your own ip check server for privacy ## Pro tip: use your own ip check server for privacy
## it could be as simple as that... ## it could be as simple as that...
## create an index.php with <?php echo $_SERVER'REMOTE_ADDR'; ?> ## create an index.php with <?php echo $_SERVER['REMOTE_ADDR']; ?>
_ipv4_checker=api64.ipify.org _ipv4_checker=api64.ipify.org
_ipv6_checker=api64.ipify.org _ipv6_checker=api64.ipify.org
@@ -65,13 +65,11 @@ _response=
_statusHostname= _statusHostname=
_statusUsername= _statusUsername=
_statusPassword= _statusPassword=
_version=0.1.1 _version=0.0.1
_userAgent="DynB/$_version github.com/EV21/dynb" _userAgent="DynB/$_version github.com/EV21/dynb"
_configFile=$HOME/.local/share/dynb/.env _configFile=$HOME/.local/share/dynb/.env
_statusFile=/tmp/dynb.status _statusFile=/tmp/dynb.status
_debug=0 _debug=1
_minimum_looptime=60
_loopMode=0
# Created by argbash-init v2.10.0 # Created by argbash-init v2.10.0
# Rearrange the order of options below according to what you would like to see in the help message. # Rearrange the order of options below according to what you would like to see in the help message.
@@ -86,7 +84,6 @@ _loopMode=0
# ARG_OPTIONAL_SINGLE([username],[u],[depends on your selected update method and your provider],[]) # ARG_OPTIONAL_SINGLE([username],[u],[depends on your selected update method and your provider],[])
# ARG_OPTIONAL_SINGLE([password],[p],[depends on your selected update method and your provider],[]) # ARG_OPTIONAL_SINGLE([password],[p],[depends on your selected update method and your provider],[])
# ARG_OPTIONAL_SINGLE([token],[t],[depends on your selected update method and your provider],[]) # ARG_OPTIONAL_SINGLE([token],[t],[depends on your selected update method and your provider],[])
# ARG_OPTIONAL_SINGLE([interval],[],[choose the seconds interval to run the script in a loop, minimum is 60],[])
# ARG_HELP([DynB - dynamic DNS update script for bash]) # ARG_HELP([DynB - dynamic DNS update script for bash])
# ARGBASH_GO() # ARGBASH_GO()
# needed because of Argbash --> m4_ignore([ # needed because of Argbash --> m4_ignore([
@@ -123,13 +120,12 @@ _arg_service_provider=
_arg_username= _arg_username=
_arg_password= _arg_password=
_arg_token= _arg_token=
_arg_interval=
print_help() print_help()
{ {
printf '%s\n' "DynB - dynamic DNS update script for bash" printf '%s\n' "DynB - dynamic DNS update script for bash"
printf 'Usage: %s [-v|--(no-)version] [-l|--(no-)link] [-r|--(no-)reset] [--(no-)debug] [-m|--update-method <arg>] [-i|--ip-mode <arg>] [-d|--domain <arg>] [-s|--service-provider <arg>] [-u|--username <arg>] [-p|--password <arg>] [-t|--token <arg>] [--interval <arg>] [-h|--help]\n' "$0" printf 'Usage: %s [-v|--(no-)version] [-l|--(no-)link] [-r|--(no-)reset] [--(no-)debug] [-m|--update-method <arg>] [-i|--ip-mode <arg>] [-d|--domain <arg>] [-s|--service-provider <arg>] [-u|--username <arg>] [-p|--password <arg>] [-t|--token <arg>] [-h|--help]\n' "$0"
printf '\t%s\n' "-v, --version, --no-version: outputs the client version (off by default)" printf '\t%s\n' "-v, --version, --no-version: outputs the client version (off by default)"
printf '\t%s\n' "-l, --link, --no-link: links to your script at ~/.local/bin/dynb (off by default)" printf '\t%s\n' "-l, --link, --no-link: links to your script at ~/.local/bin/dynb (off by default)"
printf '\t%s\n' "-r, --reset, --no-reset: deletes the client blocking status file (off by default)" printf '\t%s\n' "-r, --reset, --no-reset: deletes the client blocking status file (off by default)"
@@ -141,7 +137,6 @@ print_help()
printf '\t%s\n' "-u, --username: depends on your selected update method and your provider (no default)" printf '\t%s\n' "-u, --username: depends on your selected update method and your provider (no default)"
printf '\t%s\n' "-p, --password: depends on your selected update method and your provider (no default)" printf '\t%s\n' "-p, --password: depends on your selected update method and your provider (no default)"
printf '\t%s\n' "-t, --token: depends on your selected update method and your provider (no default)" printf '\t%s\n' "-t, --token: depends on your selected update method and your provider (no default)"
printf '\t%s\n' "--interval: choose the seconds interval to run the script in a loop, minimum is 60 (no default)"
printf '\t%s\n' "-h, --help: Prints help" printf '\t%s\n' "-h, --help: Prints help"
} }
@@ -269,14 +264,6 @@ parse_commandline()
-t*) -t*)
_arg_token="${_key##-t}" _arg_token="${_key##-t}"
;; ;;
--interval)
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
_arg_interval="$2"
shift
;;
--interval=*)
_arg_interval="${_key##--interval=}"
;;
-h|--help) -h|--help)
print_help print_help
exit 0 exit 0
@@ -300,7 +287,6 @@ parse_commandline "$@"
### END OF CODE GENERATED BY Argbash (sortof) ### ]) ### END OF CODE GENERATED BY Argbash (sortof) ### ])
# [ <-- needed because of Argbash # [ <-- needed because of Argbash
# The generated argbash help message does not look as nice as this:
_help_message="$(cat << 'EOF' _help_message="$(cat << 'EOF'
dynb - dynamic DNS update script for bash dynb - dynamic DNS update script for bash
@@ -329,14 +315,6 @@ dynb --ip-mode dual --update-method dyndns --service-provider inwx --domain dynd
EOF EOF
)" )"
function loopMode() {
if [[ $_loopMode -eq 1 ]]; then
return 0
else
return 1
fi
}
function debugMode() { function debugMode() {
if [[ $_debug -eq 1 ]]; then if [[ $_debug -eq 1 ]]; then
return 0 return 0
@@ -347,7 +325,7 @@ function debugMode() {
function debugMessage() { function debugMessage() {
if debugMode; then if debugMode; then
echo "Debug: $*" echo "Debug: ${1}"
fi fi
} }
@@ -357,8 +335,8 @@ function echoerr() { printf "%s\n" "$*" >&2; }
function getMainDomain() { function getMainDomain() {
request=$( echo "{}" | \ request=$( echo "{}" | \
jq '(.method="nameserver.list")' | \ jq '(.method="nameserver.list")' | \
jq "(.params.user=\"$DYNB_USERNAME\")" | \ jq "(.params.user=\"$_username\")" | \
jq "(.params.pass=\"$DYNB_PASSWORD\")" jq "(.params.pass=\"$_password\")"
) )
_response=$(curl --silent \ _response=$(curl --silent \
@@ -366,7 +344,7 @@ function getMainDomain() {
--user-agent "$_userAgent" \ --user-agent "$_userAgent" \
--header "Content-Type: application/json" \ --header "Content-Type: application/json" \
--request POST $_INWX_JSON_API_URL \ --request POST $_INWX_JSON_API_URL \
--data "$request" | jq ".resData.domains[] | select(inside(.domain=\"$DYNB_DYN_DOMAIN\"))" --data "$request" | jq ".resData.domains[] | select(inside(.domain=\"$_dyn_domain\"))"
) )
_main_domain=$( echo "$_response" | jq --raw-output '.domain' ) _main_domain=$( echo "$_response" | jq --raw-output '.domain' )
} }
@@ -374,10 +352,10 @@ function getMainDomain() {
function fetchDNSRecords() { function fetchDNSRecords() {
request=$( echo "{}" | \ request=$( echo "{}" | \
jq '(.method="'nameserver.info'")' | \ jq '(.method="'nameserver.info'")' | \
jq "(.params.user=\"$DYNB_USERNAME\")" | \ jq "(.params.user=\"$_username\")" | \
jq "(.params.pass=\"$DYNB_PASSWORD\")" | \ jq "(.params.pass=\"$_password\")" | \
jq "(.params.domain=\"$_main_domain\")" | \ jq "(.params.domain=\"$_main_domain\")" | \
jq "(.params.name=\"$DYNB_DYN_DOMAIN\")" jq "(.params.name=\"$_dyn_domain\")"
) )
_response=$( curl --silent \ _response=$( curl --silent \
@@ -426,8 +404,8 @@ function updateRecord() {
if [[ $IP != "" ]]; then if [[ $IP != "" ]]; then
request=$( echo "{}" | \ request=$( echo "{}" | \
jq '(.method="nameserver.updateRecord")' | \ jq '(.method="nameserver.updateRecord")' | \
jq "(.params.user=\"$DYNB_USERNAME\")" | \ jq "(.params.user=\"$_username\")" | \
jq "(.params.pass=\"$DYNB_PASSWORD\")" | \ jq "(.params.pass=\"$_password\")" | \
jq "(.params.id=\"$ID\")" | \ jq "(.params.id=\"$ID\")" | \
jq "(.params.content=\"$IP\")" | \ jq "(.params.content=\"$IP\")" | \
jq "(.params.ttl=\"$TTL\")" jq "(.params.ttl=\"$TTL\")"
@@ -440,7 +418,7 @@ function updateRecord() {
--request POST $_INWX_JSON_API_URL \ --request POST $_INWX_JSON_API_URL \
--data "$request" --data "$request"
) )
echo -e "$(echo "$_response" | jq --raw-output '.msg')\n Domain: $DYNB_DYN_DOMAIN\n new IPv${1}: $IP" echo -e "$(echo "$_response" | jq --raw-output '.msg')\n Domain: $_dyn_domain\n new IPv${1}: $IP"
fi fi
} }
@@ -451,34 +429,17 @@ function dynupdate() {
myipv6_str=myipv6 myipv6_str=myipv6
INWX_DYNDNS_UPDATE_URL="https://dyndns.inwx.com/nic/update?" INWX_DYNDNS_UPDATE_URL="https://dyndns.inwx.com/nic/update?"
DESEC_DYNDNS_UPDATE_URL="https://update.dedyn.io/?" DYNV6_DYNDNS_UPDATE_URL="https://dynv6.com/api/update?zone=$_dyn_domain&token=$_token&"
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&"
case $DYNB_SERVICE_PROVIDER in if [[ $_serviceProvider == "inwx" ]]; then
inwx* | INWX* ) dyndns_update_url=$INWX_DYNDNS_UPDATE_URL
dyndns_update_url=$INWX_DYNDNS_UPDATE_URL fi
;; if [[ $_serviceProvider == "dynv6" ]]; then
deSEC* | desec* | dedyn* ) dyndns_update_url="${DYNV6_DYNDNS_UPDATE_URL}"
dyndns_update_url="${DESEC_DYNDNS_UPDATE_URL}" myip_str=ipv4
;; myipv6_str=ipv6
dynv6* ) fi
dyndns_update_url="${DYNV6_DYNDNS_UPDATE_URL}"
myip_str=ipv4
myipv6_str=ipv6
;;
DuckDNS* | duckdns* )
dyndns_update_url="${DUCKDNS_DYNDNS_UPDATE_URL}"
myip_str=ipv4
myipv6_str=ipv6
;;
* )
echoerr "$DYNB_SERVICE_PROVIDER is not supported"
exit 1
;;
esac
# pre encode ip parameters
if [[ $_is_IPv4_enabled == true ]] && [[ $_is_IPv6_enabled == true ]]; then if [[ $_is_IPv4_enabled == true ]] && [[ $_is_IPv6_enabled == true ]]; then
dyndns_update_url="${dyndns_update_url}${myip_str}=${_new_IPv4}&${myipv6_str}=${_new_IPv6}" dyndns_update_url="${dyndns_update_url}${myip_str}=${_new_IPv4}&${myipv6_str}=${_new_IPv6}"
fi fi
@@ -489,32 +450,22 @@ function dynupdate() {
dyndns_update_url="${dyndns_update_url}${myipv6_str}=${_new_IPv6}" dyndns_update_url="${dyndns_update_url}${myipv6_str}=${_new_IPv6}"
fi fi
debugMessage "Update URL was: $dyndns_update_url" debugMessage "Update URL was: $dyndns_update_url"
## request ## ## request ##
case $DYNB_SERVICE_PROVIDER in if [[ $_serviceProvider == "dynv6" ]]; then
inwx* | INWX* ) _response=$(curl --silent "$_interface_str" \
_response=$(curl --silent "$_interface_str" \
--user-agent "$_userAgent" \
--user "$DYNB_USERNAME":"$DYNB_PASSWORD" \
"${dyndns_update_url}" )
;;
deSEC* | desec* | dedyn* )
_response=$(curl --silent "$_interface_str" \
--user-agent "$_userAgent" \
--header "Authorization: Token $DYNB_TOKEN" \
--get --data-urlencode "hostname=$DYNB_DYN_DOMAIN" \
"${dyndns_update_url}" )
;;
dynv6* | duckDNS* | duckdns* )
_response=$(curl --silent "$_interface_str" \
--user-agent "$_userAgent" \ --user-agent "$_userAgent" \
"${dyndns_update_url}" "${dyndns_update_url}"
) )
;; fi
esac if [[ $_serviceProvider == "inwx" ]]; then
_response=$(curl --silent "$_interface_str" \
--user-agent "$_userAgent" \
--user "$_username":"$_password" \
"${dyndns_update_url}" )
fi
case $_response in case $_response in
good* | OK* | "addresses updated" ) good* )
if [[ $_response == "good 127.0.0.1" ]]; then if [[ $_response == "good 127.0.0.1" ]]; then
echoerr "Error: $_response: Request ignored." echoerr "Error: $_response: Request ignored."
return 1 return 1
@@ -549,7 +500,7 @@ function dynupdate() {
return 1 return 1
;; ;;
notfqdn ) notfqdn )
echoerr "Error: $_response: Hostname $DYNB_DYN_DOMAIN is invalid" echoerr "Error: $_response: Hostname $_dyn_domain is invalid"
return 1 return 1
;; ;;
nohost ) nohost )
@@ -595,7 +546,7 @@ function checkStatus() {
fi fi
;; ;;
nohost | !yours ) nohost | !yours )
if [[ "$_statusHostname" == "$DYNB_DYN_DOMAIN" && ( "$_statusUsername" == "$DYNB_USERNAME" || $_statusUsername == "$DYNB_TOKEN" ) ]]; then if [[ "$_statusHostname" == "$_dyn_domain" && ( "$_statusUsername" == "$_username" || $_statusUsername == "$_token" ) ]]; then
echoerr "Error: Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request." echoerr "Error: Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
return 1 return 1
else else
@@ -604,7 +555,7 @@ function checkStatus() {
return 0 return 0
;; ;;
badauth | 401 ) badauth | 401 )
if [[ "$_statusUsername" == "$DYNB_USERNAME" && "$_statusPassword" == "$DYNB_PASSWORD" ]]; then if [[ "$_statusUsername" == "$_username" && "$_statusPassword" == "$_password" ]]; then
echoerr "Error: Invalid username password combination." echoerr "Error: Invalid username password combination."
return 1 return 1
else else
@@ -656,49 +607,27 @@ function checkStatus() {
function ipHasChanged() { function ipHasChanged() {
if [[ ${1} == 4 ]]; then if [[ ${1} == 4 ]]; then
remote_ip=$(getRemoteIP 4 $_ipv4_checker) remote_ip=$(getRemoteIP 4 $_ipv4_checker)
#TODO: this is doublicated code, refactor this some time if [[ $_update_method == domrobot ]]; then
if [[ $? -gt 0 ]]; then
echoerr "IPCheck (getRemoteIP) request failed $remote_ip"
return 0
fi
if [[ $DYNB_UPDATE_METHOD == domrobot ]]; then
dns_ip=$(getDNSIP A) dns_ip=$(getDNSIP A)
else else
dig_response=$(dig @${_DNS_checkServer} in a +short "$DYNB_DYN_DOMAIN") dns_ip=$(dig @${_DNS_checkServer} in a +short "$_dyn_domain")
#TODO: this is doublicated code, refactor this some time
if [[ $dig_response == ";; connection timed out; no servers could be reached" ]]; then
echoerr "DNS request failed $dig_response"
return 0
fi
dns_ip=$dig_response
fi fi
fi fi
if [[ ${1} == 6 ]]; then if [[ ${1} == 6 ]]; then
remote_ip=$(getRemoteIP 6 $_ipv6_checker) remote_ip=$(getRemoteIP 6 $_ipv6_checker)
#TODO: this is doublicated code, refactor this some time if [[ $_update_method == domrobot ]]; then
if [[ $? -gt 0 ]]; then
echoerr "IPCheck (getRemoteIP) request failed $remote_ip"
return 0
fi
if [[ $DYNB_UPDATE_METHOD == domrobot ]]; then
dns_ip=$(getDNSIP AAAA) dns_ip=$(getDNSIP AAAA)
else else
dig_response=$(dig @${_DNS_checkServer} in aaaa +short "$DYNB_DYN_DOMAIN") dns_ip=$(dig @${_DNS_checkServer} in aaaa +short "$_dyn_domain")
#TODO: this is doublicated code, refactor this some time
if [[ $dig_response == ";; connection timed out; no servers could be reached" ]]; then
echoerr "DNS request failed $dig_response"
return 0
fi
dns_ip=$dig_response
fi fi
fi fi
if [[ ${1} == 4 ]]; then if [[ ${1} == 4 ]]; then
_new_IPv4=$remote_ip _new_IPv4=$remote_ip
debugMessage "New IPv4: $_new_IPv4 old was: $dns_ip" #echo "New IPv4: $_new_IPv4 old was: $dns_ip"
else else
_new_IPv6=$remote_ip _new_IPv6=$remote_ip
debugMessage "New IPv6: $_new_IPv6 old was: $dns_ip" #echo "New IPv6: $_new_IPv6 old was: $dns_ip"
fi fi
if [[ "$remote_ip" == "$dns_ip" ]]; then if [[ "$remote_ip" == "$dns_ip" ]]; then
@@ -724,60 +653,27 @@ function handleParameters() {
if [[ $_arg_reset == "on" ]]; then if [[ $_arg_reset == "on" ]]; then
rm --verbose "$_statusFile" rm --verbose "$_statusFile"
exit 0 exit 0
fi
if [[ $_arg_debug == "on" ]]; then
_debug=1
fi fi
if [[ $_arg_update_method != "" ]]; then if [[ $_arg_update_method != "" ]]; then
DYNB_UPDATE_METHOD=$_arg_update_method _update_method=$_arg_update_method
fi fi
if [[ $_arg_ip_mode != "" ]]; then if [[ $_arg_ip_mode != "" ]]; then
DYNB_IP_MODE=$_arg_ip_mode _ip_mode=$_arg_ip_mode
fi fi
if [[ $_arg_domain != "" ]]; then if [[ $_arg_domain != "" ]]; then
DYNB_DYN_DOMAIN=$_arg_domain _dyn_domain=$_arg_domain
fi fi
if [[ $_arg_service_provider != "" ]]; then if [[ $_arg_service_provider != "" ]]; then
DYNB_SERVICE_PROVIDER=$_arg_service_provider _serviceProvider=$_arg_service_provider
fi fi
if [[ $_arg_username != "" ]]; then if [[ $_arg_username != "" ]]; then
DYNB_USERNAME=$_arg_username _username=$_arg_username
fi fi
if [[ $_arg_password != "" ]]; then if [[ $_arg_password != "" ]]; then
DYNB_PASSWORD=$_arg_password _password=$_arg_password
fi fi
if [[ $_arg_token != "" ]]; then if [[ $_arg_token != "" ]]; then
DYNB_TOKEN=$_arg_token _token=$_arg_token
fi
if [[ $_arg_interval != "" ]]; then
DYNB_INTERVAL=$_arg_interval
fi
if [[ -z $DYNB_INTERVAL ]]; then
_loopMode=0
elif [[ $DYNB_INTERVAL -lt _minimum_looptime ]]; then
DYNB_INTERVAL=$_minimum_looptime
_loopMode=1
else
_loopMode=1
fi
if [[ $_network_interface != "" ]]; then
_interface_str="--interface $_network_interface"
fi
if [[ $DYNB_IP_MODE == d* ]]; then
_is_IPv4_enabled=true
_is_IPv6_enabled=true
fi
if [[ $DYNB_IP_MODE == *4* ]]; then
_is_IPv4_enabled=true
fi
if [[ $DYNB_IP_MODE == *6* ]]; then
_is_IPv6_enabled=true
fi
if [[ $DYNB_DEBUG == true ]]; then
_debug=1
fi fi
return 0 return 0
} }
@@ -795,7 +691,7 @@ function checkDependencies() {
# fi # fi
# done # done
[[ -x $(command -v jq 2> /dev/null) ]] || { [[ -x $(command -v jq 2> /dev/null) ]] || {
if [[ $DYNB_UPDATE_METHOD != dyndns* ]]; then if [[ $_update_method != dyndns* ]]; then
echo "This script depends on jq and it is not available." >&2 echo "This script depends on jq and it is not available." >&2
exit 1 exit 1
fi fi
@@ -806,11 +702,11 @@ function doUnsets() {
unset _network_interface unset _network_interface
unset _DNS_checkServer unset _DNS_checkServer
unset _dns_records unset _dns_records
unset DYNB_DYN_DOMAIN unset _dyn_domain
unset _has_getopt unset _has_getopt
unset _help_message unset _help_message
unset _INWX_JSON_API_URL unset _INWX_JSON_API_URL
unset DYNB_IP_MODE unset _ip_mode
unset _ipv4_checker unset _ipv4_checker
unset _ipv6_checker unset _ipv6_checker
unset _is_IPv4_enabled unset _is_IPv4_enabled
@@ -818,62 +714,12 @@ function doUnsets() {
unset _main_domain unset _main_domain
unset _new_IPv4 unset _new_IPv4
unset _new_IPv6 unset _new_IPv6
unset DYNB_PASSWORD unset _password
unset DYNB_USERNAME unset _username
unset DYNB_SERVICE_PROVIDER unset _serviceProvider
unset _version unset _version
} }
function doUpdates() {
if [[ $DYNB_UPDATE_METHOD == "domrobot" ]]; then
getMainDomain
fetchDNSRecords
if [[ $_is_IPv4_enabled == true ]]; then
ipHasChanged 4
if [[ $? == 1 ]]; then
updateRecord 4
else
debugMessage "Skip IPv4 record update, it is already up to date"
fi
fi
if [[ $_is_IPv6_enabled == true ]]; then
ipHasChanged 6
if [[ $? == 1 ]]; then
updateRecord 6
else
debugMessage "Skip IPv6 record update, it is already up to date"
fi
fi
fi
if [[ $DYNB_UPDATE_METHOD == "dyndns" ]]; then
changed=0
if [[ $_is_IPv4_enabled == true ]]; then
ipHasChanged 4
(( changed += $? ))
fi
if [[ $_is_IPv6_enabled == true ]]; then
ipHasChanged 6
(( changed += $? ))
fi
if [[ $changed -gt 0 ]]; then
if checkStatus; then
debugMessage "checkStatus has no errors, try update"
if dynupdate; then
debugMessage "DynDNS2 update success"
else
debugMessage "Save new status after dynupdate has failed"
setStatus "$_response" "$(date +%s)" $(( _errorCounter += 1 )) "$DYNB_DYN_DOMAIN" "${DYNB_USERNAME}" "${DYNB_PASSWORD}${DYNB_TOKEN}"
fi
else
debugMessage "Skip DynDNS2 update, checkStatus fetched previous error."
fi
else
debugMessage "Skip DynDNS2 update, IPs are up to date or there is a connection problem"
fi
fi
}
################# #################
## MAIN method ## ## MAIN method ##
################# #################
@@ -900,19 +746,64 @@ function dynb() {
handleParameters handleParameters
## execute operations if [[ $_network_interface != "" ]]; then
_interface_str="--interface $_network_interface"
if loopMode; then
while :
do
doUpdates
sleep $DYNB_INTERVAL
done
else
doUpdates
fi fi
if [[ $_ip_mode == d* ]]; then
_is_IPv4_enabled=true
_is_IPv6_enabled=true
fi
if [[ $_ip_mode == *4* ]]; then
_is_IPv4_enabled=true
fi
if [[ $_ip_mode == *6* ]]; then
_is_IPv6_enabled=true
fi
## execute operations
if [[ $_update_method == "domrobot" ]]; then
getMainDomain
fetchDNSRecords
if [[ $_is_IPv4_enabled == true ]]; then
ipHasChanged 4
if [[ $? == 1 ]]; then
updateRecord 4
fi
fi
if [[ $_is_IPv6_enabled == true ]]; then
ipHasChanged 6
if [[ $? == 1 ]]; then
updateRecord 6
fi
fi
fi
if [[ $_update_method == "dyndns" ]]; then
changed=0
if [[ $_is_IPv4_enabled == true ]]; then
ipHasChanged 4
(( changed += $? ))
fi
if [[ $_is_IPv6_enabled == true ]]; then
ipHasChanged 6
(( changed += $? ))
fi
if [[ $changed -gt 0 ]]; then
if checkStatus; then
debugMessage "checkStatus has no errors"
if dynupdate; then
debugMessage "DynDNS2 update success"
else
debugMessage "Save new status after dynupdate has failed"
setStatus "$_response" "$(date +%s)" $(( _errorCounter += 1 )) "$_dyn_domain" "${_username}${_token}"
fi
else
debugMessage "Skip DynDNS2 update, checkStatus fetched previous error."
fi
fi
fi
doUnsets doUnsets
return 0 return 0
} }

View File

@@ -1,21 +1,7 @@
################### _dyn_domain=dyndns.example.com
## Configuration ## _serviceProvider=inwx
################### _update_method=domrobot
_ip_mode=dual
DYNB_DYN_DOMAIN=dyndns.example.com _username=User42
_password=SuperSecretPassword
## service provider could be deSEC, duckdns, dynv6, inwx _token=
DYNB_SERVICE_PROVIDER=inwx
## update method options: domrobot, dyndns
DYNB_UPDATE_METHOD=domrobot
## ip mode could be either: 4, 6 or dual for dualstack
DYNB_IP_MODE=64
## If you are using the DomRobot RPC-API enter your credentials for the web interface login here
## If you are using the DynDNS2 protocol enter your credentials here
DYNB_USERNAME=User42
DYNB_PASSWORD=SuperSecretPassword
## or use a token
DYNB_TOKEN=

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH MAN 1 "2021-04-21" "" "" .TH MAN 1 "2021-04-03" "" ""
.SH NAME .SH NAME
man \- DynB - dynamic DNS update script for bash man \- DynB - dynamic DNS update script for bash
. .
@@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.. ..
.SH SYNOPSIS .SH SYNOPSIS
.sp .sp
\fBman [\-\-version] [\-\-link] [\-\-reset] [\-\-debug] [\-\-update\-method UPDATE\-METHOD] [\-\-ip\-mode IP\-MODE] [\-\-domain DOMAIN] [\-\-service\-provider SERVICE\-PROVIDER] [\-\-username USERNAME] [\-\-password PASSWORD] [\-\-token TOKEN] [\-\-interval INTERVAL] [\-\-help]\fP \fBman [\-\-version] [\-\-link] [\-\-reset] [\-\-debug] [\-\-update\-method UPDATE\-METHOD] [\-\-ip\-mode IP\-MODE] [\-\-domain DOMAIN] [\-\-service\-provider SERVICE\-PROVIDER] [\-\-username USERNAME] [\-\-password PASSWORD] [\-\-token TOKEN] [\-\-help]\fP
.SH DESCRIPTION .SH DESCRIPTION
.sp .sp
IPv4 (A) and IPv6 (AAAA) record updates are supported. IPv4 (A) and IPv6 (AAAA) record updates are supported.
@@ -81,7 +81,7 @@ dyndns.example.com
.BI \-s \ SERVICE\-PROVIDER\fR,\fB \ \-\-service\-provider \ SERVICE\-PROVIDER .BI \-s \ SERVICE\-PROVIDER\fR,\fB \ \-\-service\-provider \ SERVICE\-PROVIDER
set your provider in case you are using DynDNS2. set your provider in case you are using DynDNS2.
.sp .sp
deSEC | duckdns | dynv6 | inwx inwx | dynv6
.TP .TP
.BI \-u \ USERNAME\fR,\fB \ \-\-username \ USERNAME .BI \-u \ USERNAME\fR,\fB \ \-\-username \ USERNAME
depends on your selected update method and your provider. depends on your selected update method and your provider.
@@ -97,11 +97,6 @@ e.g. SuperSecretPassword
depends on your selected update method and your provider. depends on your selected update method and your provider.
.sp .sp
YourProviderGivenToken YourProviderGivenToken
.TP
.BI \-\-interval \ INTERVAL
choose the seconds interval to run the script in a loop, minimum is 60.
.sp
.TP .TP
.B \-h\fP,\fB \-\-help .B \-h\fP,\fB \-\-help
Prints help. Prints help.

View File

@@ -22,7 +22,7 @@
.. |OPTION_DOMAIN| replace:: dyndns.example.com .. |OPTION_DOMAIN| replace:: dyndns.example.com
.. |OPTION_SERVICE_PROVIDER| replace:: deSEC | duckdns | dynv6 | inwx .. |OPTION_SERVICE_PROVIDER| replace:: inwx | dynv6
.. |OPTION_USERNAME| replace:: e.g. user42 .. |OPTION_USERNAME| replace:: e.g. user42
@@ -30,6 +30,4 @@
.. |OPTION_TOKEN| replace:: YourProviderGivenToken .. |OPTION_TOKEN| replace:: YourProviderGivenToken
.. |OPTION_INTERVAL| replace:: \
.. |OPTION_HELP| replace:: \ .. |OPTION_HELP| replace:: \

View File

@@ -11,7 +11,7 @@ DynB - dynamic DNS update script for bash
----------------------------------------- -----------------------------------------
:Author: |AUTHOR| :Author: |AUTHOR|
:Date: 2021-04-21 :Date: 2021-04-03
:Version: |VERSION| :Version: |VERSION|
:Manual section: |MAN_SECTION| :Manual section: |MAN_SECTION|
@@ -19,7 +19,7 @@ DynB - dynamic DNS update script for bash
SYNOPSIS SYNOPSIS
======== ========
``man [--version] [--link] [--reset] [--debug] [--update-method UPDATE-METHOD] [--ip-mode IP-MODE] [--domain DOMAIN] [--service-provider SERVICE-PROVIDER] [--username USERNAME] [--password PASSWORD] [--token TOKEN] [--interval INTERVAL] [--help]`` ``man [--version] [--link] [--reset] [--debug] [--update-method UPDATE-METHOD] [--ip-mode IP-MODE] [--domain DOMAIN] [--service-provider SERVICE-PROVIDER] [--username USERNAME] [--password PASSWORD] [--token TOKEN] [--help]``
DESCRIPTION DESCRIPTION
@@ -79,10 +79,6 @@ ARGUMENTS
|OPTION_TOKEN| |OPTION_TOKEN|
--interval INTERVAL choose the seconds interval to run the script in a loop, minimum is 60.
|OPTION_INTERVAL|
-h, --help Prints help. -h, --help Prints help.
|OPTION_HELP| |OPTION_HELP|