mirror of
https://github.com/EV21/dynb.git
synced 2025-12-26 16:39:32 +01:00
Compare commits
12 Commits
noip
...
2f5e193f88
| Author | SHA1 | Date | |
|---|---|---|---|
|
2f5e193f88
|
|||
|
5210c35400
|
|||
|
522a0f99bb
|
|||
|
3bf6b69ae8
|
|||
|
d139022295
|
|||
|
8997835903
|
|||
|
d6dc223794
|
|||
|
dc12f71d00
|
|||
|
5ba730cff1
|
|||
|
1104cf8505
|
|||
|
99a446f4c7
|
|||
|
f056e96e25
|
@@ -1,9 +0,0 @@
|
||||
**/.env
|
||||
**/.dockerignore
|
||||
**/.docker-compose.debug.yml
|
||||
**/.docker-compose.yml
|
||||
**/.git
|
||||
**/.gitignore
|
||||
**/.gitchangelog.rc
|
||||
man/man.rst
|
||||
man/man-defs.rst
|
||||
@@ -82,34 +82,24 @@ ignore_regexps = [
|
||||
## whenever you are tweaking this variable.
|
||||
##
|
||||
section_regexps = [
|
||||
('Features', [
|
||||
r'^[fF]eat\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
|
||||
('New', [
|
||||
r'^:sparkles\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]*)$',
|
||||
('Changes', [
|
||||
r'^:wrench\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
|
||||
]),
|
||||
('Fix', [
|
||||
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]*)$',
|
||||
r'^:bug\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
|
||||
]),
|
||||
('Documentation', [
|
||||
r'^[dD]oc\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
|
||||
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]*)$',
|
||||
]),
|
||||
|
||||
|
||||
#('Other', None ## Match all lines
|
||||
# ),
|
||||
('Other', None ## Match all lines
|
||||
),
|
||||
|
||||
]
|
||||
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,2 +1 @@
|
||||
.env*
|
||||
docker-compose*
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
repos:
|
||||
- repo: https://github.com/syntaqx/git-hooks
|
||||
rev: v0.0.17
|
||||
hooks:
|
||||
- id: shellcheck
|
||||
- id: shfmt
|
||||
args:
|
||||
- "-l" # list files whose formatting differs from shfmt's
|
||||
- "-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
|
||||
97
CHANGELOG.md
97
CHANGELOG.md
@@ -1,89 +1,10 @@
|
||||
# Changelog
|
||||
|
||||
|
||||
## 0.2.0 (2021-09-24)
|
||||
## (unreleased)
|
||||
|
||||
### 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]
|
||||
|
||||
* Refactor: :recycle: remove unused help message. [Eduard Veit]
|
||||
|
||||
|
||||
## 0.1.2 (2021-04-23)
|
||||
|
||||
### Documentation
|
||||
|
||||
* :memo: document environment variables. [Eduard Veit]
|
||||
|
||||
### Other
|
||||
|
||||
* :recycle: refactor: method extractions and other beautifications. [Eduard Veit]
|
||||
|
||||
|
||||
## 0.1.1 (2021-04-23)
|
||||
|
||||
### Fix
|
||||
|
||||
* :bug: fix loop and error handling in case of connection issues. [Eduard Veit]
|
||||
|
||||
|
||||
## 0.1.0 (2021-04-22)
|
||||
|
||||
### 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 man page
|
||||
|
||||
* :sparkles: replace getopt with argbash. [Eduard Veit]
|
||||
|
||||
* :sparkles: add interpretaton of status codes and act accordingly. [Eduard Veit]
|
||||
|
||||
* :sparkles: make network interface configurable. [Eduard Veit]
|
||||
@@ -92,7 +13,7 @@
|
||||
|
||||
* :sparkles: add .gitchangelog.rc. [Eduard Veit]
|
||||
|
||||
* :sparkles: add dynb.sh. [Eduard Veit]
|
||||
* :sparkles: add dynb. [Eduard Veit]
|
||||
|
||||
### Fix
|
||||
|
||||
@@ -102,26 +23,14 @@
|
||||
|
||||
### 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 example.env. [Eduard Veit]
|
||||
* :memo: add .env.example. [Eduard Veit]
|
||||
|
||||
* :memo: write README.md. [Eduard Veit]
|
||||
|
||||
### Other
|
||||
|
||||
* :recycle: refactor: rename environment variables. [Eduard Veit]
|
||||
|
||||
* :recycle: refactor, fix and debug error handling. [Eduard Veit]
|
||||
|
||||
* :recycle: refactor main code. [Eduard Veit]
|
||||
|
||||
* Initial commit. [EV21]
|
||||
|
||||
|
||||
|
||||
20
Dockerfile
20
Dockerfile
@@ -1,20 +0,0 @@
|
||||
FROM alpine:latest
|
||||
|
||||
RUN \
|
||||
apk update \
|
||||
&& \
|
||||
apk add \
|
||||
bash \
|
||||
curl \
|
||||
jq \
|
||||
bind-tools
|
||||
|
||||
WORKDIR /usr/src/app
|
||||
|
||||
COPY . .
|
||||
|
||||
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"
|
||||
136
README.md
136
README.md
@@ -1,11 +1,8 @@
|
||||
# 🔃 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)
|
||||
@@ -14,173 +11,100 @@ 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 JSON-RPC-API
|
||||
Limitations:
|
||||
- minimum TTL is 300 (5 minutes)
|
||||
|
||||
### DynDNS2
|
||||
|
||||
- INWX.com
|
||||
- deSEC.io (dedyn.io)
|
||||
- DuckDNS.org
|
||||
- dynv6.com
|
||||
* INWX.com
|
||||
* 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 running DynDNS2 operations
|
||||
|
||||
also essential if you are using other APIs:
|
||||
essential for APIs:
|
||||
|
||||
- `jq` - Command-line JSON processor
|
||||
* `jq` - Command-line JSON processor
|
||||
|
||||
optional requirement:
|
||||
|
||||
* `getopt` for CLI parameter handling from [util-linux](https://pkgs.org/download/util-linux)
|
||||
|
||||
## 🚀 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
|
||||
```
|
||||
This convenience function only works if `util-linux` is installed on your system.
|
||||
|
||||
## ⚙ Configuration
|
||||
|
||||
You can use a config in form of an `.env` file.
|
||||
Or you can just use CLI parameters.
|
||||
Or if your system meets the relevant requirements you can use CLI parameters.
|
||||
|
||||
Create `.env` in the app root directory or at `~/.local/share/dynb/.env`.
|
||||
```
|
||||
_dyn_domain=dyndns.example.com
|
||||
|
||||
```bash
|
||||
DYNB_DYN_DOMAIN=dyndns.example.com
|
||||
|
||||
## service provider could be deSEC, duckdns, dynv6, inwx
|
||||
DYNB_SERVICE_PROVIDER=inwx
|
||||
## service provider could be inwx
|
||||
_serviceProvider=inwx
|
||||
|
||||
## update method options: domrobot, dyndns
|
||||
DYNB_UPDATE_METHOD=domrobot
|
||||
_update_method=domrobot
|
||||
|
||||
## 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 DynDNS2 protocol enter your credentials here
|
||||
DYNB_USERNAME=User42
|
||||
DYNB_PASSWORD=SuperSecretPassword
|
||||
## or use a token
|
||||
DYNB_TOKEN=
|
||||
_username=
|
||||
_password=
|
||||
```
|
||||
|
||||
## 🏃 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
|
||||
```
|
||||
|
||||
## ⏰ 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
|
||||
To automatically call the script you can use cron.
|
||||
|
||||
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. Note: [IPv6 networking](https://docs.docker.com/config/daemon/ipv6/) is only supported on Docker daemons running on Linux hosts.
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
## 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_IP_MODE | undefined | required; `4`, `6` or `64` for both |
|
||||
| DYNB_USERNAME | undefined | the requirement depends on your provider and the update method |
|
||||
| DYNB_PASSWORD | undefined | the requirement depends on your provider and the update method |
|
||||
| DYNB_TOKEN | undefined | the requirement depends on your provider and the update method |
|
||||
| DYNB_INTERVAL | undefined | without this setting the script/docker container will run one time and exits |
|
||||
| DYNB_DEBUG | undefined | more console outputs |
|
||||
| DYNB_IPv4_CHECK_SITE | api64.ipify.org | You need a website or Web-API that outputs your remote IP |
|
||||
| DYNB_IPv6_CHECK_SITE | api64.ipify.org | You need a website or Web-API that outputs your remote IP |
|
||||
| DYNB_DNS_CHECK_SERVER | undefined | If you are using a local DNS Resolver/Server make sure it answers with the public answer or set another server |
|
||||
|
||||
41
_dynb.sh
41
_dynb.sh
@@ -1,41 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Put this file to /etc/bash_completion.d/dynb.sh
|
||||
# needed because of Argbash --> m4_ignore([
|
||||
### START OF CODE GENERATED BY Argbash v2.10.0 one line above ###
|
||||
# Argbash is a bash code generator used to get arguments parsing right.
|
||||
# Argbash is FREE SOFTWARE, see https://argbash.io for more info
|
||||
|
||||
_dynb_sh ()
|
||||
{
|
||||
local cur prev opts base
|
||||
COMPREPLY=()
|
||||
cur="${COMP_WORDS[COMP_CWORD]}"
|
||||
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_short_opts="-v -l -r -m -i -d -s -u -p -t -h "
|
||||
case "$prev" in
|
||||
--update-method|-m|--ip-mode|-i|--domain|-d|--service-provider|-s|--username|-u|--password|-p|--token|-t|--interval)
|
||||
COMPREPLY=( $(compgen -o bashdefault -o default -- "${cur}") )
|
||||
return 0
|
||||
;;
|
||||
*)
|
||||
case "$cur" in
|
||||
--*)
|
||||
COMPREPLY=( $(compgen -W "${all_long_opts}" -- "${cur}") )
|
||||
return 0
|
||||
;;
|
||||
-*)
|
||||
COMPREPLY=( $(compgen -W "${all_short_opts}" -- "${cur}") )
|
||||
return 0
|
||||
;;
|
||||
*)
|
||||
COMPREPLY=( $(compgen -o bashdefault -o default -- "${cur}") )
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
esac
|
||||
|
||||
}
|
||||
complete -F _dynb_sh dynb.sh
|
||||
### END OF CODE GENERATED BY Argbash (sortof) ### ])
|
||||
@@ -1,24 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# m4_ignore(
|
||||
echo "This is just a script template for argbash, not the script." >&2
|
||||
exit 11 #)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.
|
||||
# ARG_OPTIONAL_BOOLEAN([version],[v],[outputs the client version],[off])
|
||||
# ARG_OPTIONAL_BOOLEAN([link],[l],[links to your script at ~/.local/bin/dynb],[off])
|
||||
# ARG_OPTIONAL_BOOLEAN([reset],[r],[deletes the client blocking status file],[off])
|
||||
# ARG_OPTIONAL_BOOLEAN([debug],[],[enables debug mode],[off])
|
||||
# ARG_OPTIONAL_SINGLE([update-method],[m],[choose if you want to use DynDNS2 or the DomRobot RPC-API],[])
|
||||
# ARG_OPTIONAL_SINGLE([ip-mode],[i],[updates type A (IPv4) and AAAA (IPv6) records],[])
|
||||
# ARG_OPTIONAL_SINGLE([domain],[d],[set the domain you want to update],[])
|
||||
# ARG_OPTIONAL_SINGLE([service-provider],[s],[set your provider in case you are using DynDNS2],[])
|
||||
# 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([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])
|
||||
# ARGBASH_GO
|
||||
|
||||
# [ <-- needed because of Argbash
|
||||
|
||||
# ] <-- needed because of Argbash
|
||||
297
dynb-parsing.sh
297
dynb-parsing.sh
@@ -1,297 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# 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.
|
||||
# ARG_OPTIONAL_BOOLEAN([version],[v],[outputs the client version],[off])
|
||||
# ARG_OPTIONAL_BOOLEAN([link],[l],[links to your script at ~/.local/bin/dynb],[off])
|
||||
# ARG_OPTIONAL_BOOLEAN([reset],[r],[deletes the client blocking status file],[off])
|
||||
# ARG_OPTIONAL_BOOLEAN([debug],[],[enables debug mode],[off])
|
||||
# ARG_OPTIONAL_SINGLE([update-method],[m],[choose if you want to use DynDNS2 or the DomRobot RPC-API],[])
|
||||
# ARG_OPTIONAL_SINGLE([ip-mode],[i],[updates type A (IPv4) and AAAA (IPv6) records],[])
|
||||
# ARG_OPTIONAL_SINGLE([domain],[d],[set the domain you want to update],[])
|
||||
# ARG_OPTIONAL_SINGLE([service-provider],[s],[set your provider in case you are using DynDNS2],[])
|
||||
# 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([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])
|
||||
# ARGBASH_GO()
|
||||
# needed because of Argbash --> m4_ignore([
|
||||
### START OF CODE GENERATED BY Argbash v2.10.0 one line above ###
|
||||
# Argbash is a bash code generator used to get arguments parsing right.
|
||||
# Argbash is FREE SOFTWARE, see https://argbash.io for more info
|
||||
|
||||
|
||||
# # When called, the process ends.
|
||||
# Args:
|
||||
# $1: The exit message (print to stderr)
|
||||
# $2: The exit code (default is 1)
|
||||
# if env var _PRINT_HELP is set to 'yes', the usage is print to stderr (prior to $1)
|
||||
# Example:
|
||||
# test -f "$_arg_infile" || _PRINT_HELP=yes die "Can't continue, have to supply file as an argument, got '$_arg_infile'" 4
|
||||
die()
|
||||
{
|
||||
local _ret="${2:-1}"
|
||||
test "${_PRINT_HELP:-no}" = yes && print_help >&2
|
||||
echo "$1" >&2
|
||||
exit "${_ret}"
|
||||
}
|
||||
|
||||
|
||||
# Function that evaluates whether a value passed to it begins by a character
|
||||
# that is a short option of an argument the script knows about.
|
||||
# This is required in order to support getopts-like short options grouping.
|
||||
begins_with_short_option()
|
||||
{
|
||||
local first_option all_short_options='vlrmidsupth'
|
||||
first_option="${1:0:1}"
|
||||
test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0
|
||||
}
|
||||
|
||||
# THE DEFAULTS INITIALIZATION - OPTIONALS
|
||||
_arg_version="off"
|
||||
_arg_link="off"
|
||||
_arg_reset="off"
|
||||
_arg_debug="off"
|
||||
_arg_update_method=
|
||||
_arg_ip_mode=
|
||||
_arg_domain=
|
||||
_arg_service_provider=
|
||||
_arg_username=
|
||||
_arg_password=
|
||||
_arg_token=
|
||||
_arg_interval=
|
||||
|
||||
|
||||
# Function that prints general usage of the script.
|
||||
# This is useful if users asks for it, or if there is an argument parsing error (unexpected / spurious arguments)
|
||||
# and it makes sense to remind the user how the script is supposed to be called.
|
||||
print_help()
|
||||
{
|
||||
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 '\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' "-r, --reset, --no-reset: deletes the client blocking status file (off by default)"
|
||||
printf '\t%s\n' "--debug, --no-debug: enables debug mode (off by default)"
|
||||
printf '\t%s\n' "-m, --update-method: choose if you want to use DynDNS2 or the DomRobot RPC-API (no default)"
|
||||
printf '\t%s\n' "-i, --ip-mode: updates type A (IPv4) and AAAA (IPv6) records (no default)"
|
||||
printf '\t%s\n' "-d, --domain: set the domain you want to update (no default)"
|
||||
printf '\t%s\n' "-s, --service-provider: set your provider in case you are using DynDNS2 (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' "-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"
|
||||
}
|
||||
|
||||
|
||||
# The parsing of the command-line
|
||||
parse_commandline()
|
||||
{
|
||||
while test $# -gt 0
|
||||
do
|
||||
_key="$1"
|
||||
case "$_key" in
|
||||
# The version argurment doesn't accept a value,
|
||||
# we expect the --version or -v, so we watch for them.
|
||||
-v|--no-version|--version)
|
||||
_arg_version="on"
|
||||
test "${1:0:5}" = "--no-" && _arg_version="off"
|
||||
;;
|
||||
# We support getopts-style short arguments clustering,
|
||||
# so as -v doesn't accept value, other short options may be appended to it, so we watch for -v*.
|
||||
# After stripping the leading -v from the argument, we have to make sure
|
||||
# that the first character that follows coresponds to a short option.
|
||||
-v*)
|
||||
_arg_version="on"
|
||||
_next="${_key##-v}"
|
||||
if test -n "$_next" -a "$_next" != "$_key"
|
||||
then
|
||||
{ begins_with_short_option "$_next" && shift && set -- "-v" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
|
||||
fi
|
||||
;;
|
||||
# See the comment of option '--version' to see what's going on here - principle is the same.
|
||||
-l|--no-link|--link)
|
||||
_arg_link="on"
|
||||
test "${1:0:5}" = "--no-" && _arg_link="off"
|
||||
;;
|
||||
# See the comment of option '-v' to see what's going on here - principle is the same.
|
||||
-l*)
|
||||
_arg_link="on"
|
||||
_next="${_key##-l}"
|
||||
if test -n "$_next" -a "$_next" != "$_key"
|
||||
then
|
||||
{ begins_with_short_option "$_next" && shift && set -- "-l" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
|
||||
fi
|
||||
;;
|
||||
# See the comment of option '--version' to see what's going on here - principle is the same.
|
||||
-r|--no-reset|--reset)
|
||||
_arg_reset="on"
|
||||
test "${1:0:5}" = "--no-" && _arg_reset="off"
|
||||
;;
|
||||
# See the comment of option '-v' to see what's going on here - principle is the same.
|
||||
-r*)
|
||||
_arg_reset="on"
|
||||
_next="${_key##-r}"
|
||||
if test -n "$_next" -a "$_next" != "$_key"
|
||||
then
|
||||
{ begins_with_short_option "$_next" && shift && set -- "-r" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
|
||||
fi
|
||||
;;
|
||||
# See the comment of option '--version' to see what's going on here - principle is the same.
|
||||
--no-debug|--debug)
|
||||
_arg_debug="on"
|
||||
test "${1:0:5}" = "--no-" && _arg_debug="off"
|
||||
;;
|
||||
# We support whitespace as a delimiter between option argument and its value.
|
||||
# Therefore, we expect the --update-method or -m value.
|
||||
# so we watch for --update-method and -m.
|
||||
# Since we know that we got the long or short option,
|
||||
# we just reach out for the next argument to get the value.
|
||||
-m|--update-method)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_update_method="$2"
|
||||
shift
|
||||
;;
|
||||
# We support the = as a delimiter between option argument and its value.
|
||||
# Therefore, we expect --update-method=value, so we watch for --update-method=*
|
||||
# For whatever we get, we strip '--update-method=' using the ${var##--update-method=} notation
|
||||
# to get the argument value
|
||||
--update-method=*)
|
||||
_arg_update_method="${_key##--update-method=}"
|
||||
;;
|
||||
# We support getopts-style short arguments grouping,
|
||||
# so as -m accepts value, we allow it to be appended to it, so we watch for -m*
|
||||
# and we strip the leading -m from the argument string using the ${var##-m} notation.
|
||||
-m*)
|
||||
_arg_update_method="${_key##-m}"
|
||||
;;
|
||||
# See the comment of option '--update-method' to see what's going on here - principle is the same.
|
||||
-i|--ip-mode)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_ip_mode="$2"
|
||||
shift
|
||||
;;
|
||||
# See the comment of option '--update-method=' to see what's going on here - principle is the same.
|
||||
--ip-mode=*)
|
||||
_arg_ip_mode="${_key##--ip-mode=}"
|
||||
;;
|
||||
# See the comment of option '-m' to see what's going on here - principle is the same.
|
||||
-i*)
|
||||
_arg_ip_mode="${_key##-i}"
|
||||
;;
|
||||
# See the comment of option '--update-method' to see what's going on here - principle is the same.
|
||||
-d|--domain)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_domain="$2"
|
||||
shift
|
||||
;;
|
||||
# See the comment of option '--update-method=' to see what's going on here - principle is the same.
|
||||
--domain=*)
|
||||
_arg_domain="${_key##--domain=}"
|
||||
;;
|
||||
# See the comment of option '-m' to see what's going on here - principle is the same.
|
||||
-d*)
|
||||
_arg_domain="${_key##-d}"
|
||||
;;
|
||||
# See the comment of option '--update-method' to see what's going on here - principle is the same.
|
||||
-s|--service-provider)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_service_provider="$2"
|
||||
shift
|
||||
;;
|
||||
# See the comment of option '--update-method=' to see what's going on here - principle is the same.
|
||||
--service-provider=*)
|
||||
_arg_service_provider="${_key##--service-provider=}"
|
||||
;;
|
||||
# See the comment of option '-m' to see what's going on here - principle is the same.
|
||||
-s*)
|
||||
_arg_service_provider="${_key##-s}"
|
||||
;;
|
||||
# See the comment of option '--update-method' to see what's going on here - principle is the same.
|
||||
-u|--username)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_username="$2"
|
||||
shift
|
||||
;;
|
||||
# See the comment of option '--update-method=' to see what's going on here - principle is the same.
|
||||
--username=*)
|
||||
_arg_username="${_key##--username=}"
|
||||
;;
|
||||
# See the comment of option '-m' to see what's going on here - principle is the same.
|
||||
-u*)
|
||||
_arg_username="${_key##-u}"
|
||||
;;
|
||||
# See the comment of option '--update-method' to see what's going on here - principle is the same.
|
||||
-p|--password)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_password="$2"
|
||||
shift
|
||||
;;
|
||||
# See the comment of option '--update-method=' to see what's going on here - principle is the same.
|
||||
--password=*)
|
||||
_arg_password="${_key##--password=}"
|
||||
;;
|
||||
# See the comment of option '-m' to see what's going on here - principle is the same.
|
||||
-p*)
|
||||
_arg_password="${_key##-p}"
|
||||
;;
|
||||
# See the comment of option '--update-method' to see what's going on here - principle is the same.
|
||||
-t|--token)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_token="$2"
|
||||
shift
|
||||
;;
|
||||
# See the comment of option '--update-method=' to see what's going on here - principle is the same.
|
||||
--token=*)
|
||||
_arg_token="${_key##--token=}"
|
||||
;;
|
||||
# See the comment of option '-m' to see what's going on here - principle is the same.
|
||||
-t*)
|
||||
_arg_token="${_key##-t}"
|
||||
;;
|
||||
# See the comment of option '--update-method' to see what's going on here - principle is the same.
|
||||
--interval)
|
||||
test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
|
||||
_arg_interval="$2"
|
||||
shift
|
||||
;;
|
||||
# See the comment of option '--update-method=' to see what's going on here - principle is the same.
|
||||
--interval=*)
|
||||
_arg_interval="${_key##--interval=}"
|
||||
;;
|
||||
# See the comment of option '--version' to see what's going on here - principle is the same.
|
||||
-h|--help)
|
||||
print_help
|
||||
exit 0
|
||||
;;
|
||||
# See the comment of option '-v' to see what's going on here - principle is the same.
|
||||
-h*)
|
||||
print_help
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
_PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
}
|
||||
|
||||
# Now call all the functions defined above that are needed to get the job done
|
||||
parse_commandline "$@"
|
||||
|
||||
# OTHER STUFF GENERATED BY Argbash
|
||||
|
||||
### END OF CODE GENERATED BY Argbash (sortof) ### ])
|
||||
# [ <-- needed because of Argbash
|
||||
|
||||
|
||||
# vvv PLACE YOUR CODE HERE vvv
|
||||
|
||||
# PUT YOUR CODE HERE
|
||||
|
||||
# ^^^ TERMINATE YOUR CODE BEFORE THE BOTTOM ARGBASH MARKER ^^^
|
||||
|
||||
# ] <-- needed because of Argbash
|
||||
691
dynb.sh
691
dynb.sh
@@ -10,23 +10,23 @@
|
||||
## Configuration ##
|
||||
###################
|
||||
|
||||
#DYNB_DYN_DOMAIN=
|
||||
_dyn_domain=
|
||||
|
||||
## service provider could be deSEC, duckdns, dynv6, inwx
|
||||
#DYNB_SERVICE_PROVIDER=
|
||||
## service provider could be inwx
|
||||
_serviceProvider=
|
||||
|
||||
## update method options: domrobot, dyndns
|
||||
#DYNB_UPDATE_METHOD=
|
||||
_update_method=
|
||||
|
||||
## 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 DynDNS2 protocol enter your credentials here
|
||||
#DYNB_USERNAME=
|
||||
#DYNB_PASSWORD=
|
||||
_username=
|
||||
_password=
|
||||
## or use a token
|
||||
#DYNB_TOKEN=
|
||||
_token=
|
||||
|
||||
## TTL (time to live) for the DNS record
|
||||
## This setting is only relevant for API based record updates (not DnyDNS2!)
|
||||
@@ -36,12 +36,12 @@ TTL=300
|
||||
## The IP-Check sites (some sites have different urls for v4 and v6)
|
||||
## Pro tip: use your own ip check server for privacy
|
||||
## 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
|
||||
_ipv6_checker=api64.ipify.org
|
||||
|
||||
## An exernal DNS check server prevents wrong info from local DNS servers/resolvers
|
||||
_DNS_checkServer=
|
||||
_DNS_checkServer=1.1.1.1
|
||||
|
||||
## if you are actively using multiple network interfaces you might want to specify this
|
||||
## normally the default value is okay
|
||||
@@ -51,11 +51,11 @@ _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=
|
||||
_main_domain=
|
||||
_has_getopt=
|
||||
_is_IPv4_enabled=false
|
||||
_is_IPv6_enabled=false
|
||||
_interface_str=
|
||||
@@ -66,46 +66,39 @@ _response=
|
||||
_statusHostname=
|
||||
_statusUsername=
|
||||
_statusPassword=
|
||||
_version=0.3.0
|
||||
_version=0.0.1
|
||||
_userAgent="DynB/$_version github.com/EV21/dynb"
|
||||
_configFile=$HOME/.local/share/dynb/.env
|
||||
_statusFile=/tmp/dynb.status
|
||||
_debug=0
|
||||
_minimum_looptime=60
|
||||
_loopMode=0
|
||||
_debug=1
|
||||
|
||||
# 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"
|
||||
_help_message="$(cat << 'EOF'
|
||||
dynb - dynamic DNS update script for bash
|
||||
|
||||
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]))$"
|
||||
Usage
|
||||
=====
|
||||
dynb [options]
|
||||
|
||||
function is_IPv4_address() {
|
||||
if [[ $1 =~ $REGEX_IPv4 ]]
|
||||
then return 0
|
||||
else return 1
|
||||
fi
|
||||
}
|
||||
-h, --help displays this help message
|
||||
--version outputs the client version
|
||||
--link links to your script at ~/.local/bin/dynb
|
||||
--reset deletes the client blocking status file
|
||||
|
||||
function is_IPv6_address() {
|
||||
if [[ $1 =~ $REGEX_IPv6 ]]
|
||||
then return 0
|
||||
else return 1
|
||||
fi
|
||||
}
|
||||
Configuration options
|
||||
---------------------
|
||||
-i | --ip-mode [ 4 | 6 | dual ] updates type A (IPv4) and AAAA (IPv6) records
|
||||
-m | --update-method [dyndns | domrobot] choose if you want to use DynDNS2 or the DomRobot RPC-API
|
||||
-s | --service-provider inwx set your provider in case you are using DynDNS2
|
||||
-d | --domain "dyndns.example.com" set the domain you want to update
|
||||
-u | --username "user42" depends on your selected update method and your provider
|
||||
-p | --password "SuperSecretPassword" depends on your selected update method and your provider
|
||||
-t | --token "YourProviderGivenToken" depends on your selected update method and your provider
|
||||
|
||||
function loopMode() {
|
||||
if [[ $_loopMode -eq 1 ]]; then
|
||||
return 0
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
##### examples #####
|
||||
dynb --ip-mode dual --update-method domrobot --domain dyndns.example.com --username user42 --password SuperSecretPassword
|
||||
dynb --ip-mode dual --update-method dyndns --service-provider inwx --domain dyndns.example.com --username user42 --password SuperSecretPassword
|
||||
EOF
|
||||
)"
|
||||
|
||||
function debugMode() {
|
||||
if [[ $_debug -eq 1 ]]; then
|
||||
@@ -115,57 +108,42 @@ function debugMode() {
|
||||
fi
|
||||
}
|
||||
|
||||
function infoMessage() {
|
||||
echo -e "${green_color}$(logtime) INFO: $*${reset_color_modification}"
|
||||
}
|
||||
|
||||
function debugMessage() {
|
||||
if debugMode; then
|
||||
echo -e "${yellow_color}$(logtime) DEBUG: ${*}${reset_color_modification}"
|
||||
echo "Debug: ${1}"
|
||||
fi
|
||||
}
|
||||
|
||||
function errorMessage() {
|
||||
echo -e "${red_color_bg}${bold}$(logtime) ERROR: $*${reset_color_modification}" >&2
|
||||
}
|
||||
|
||||
function logtime() {
|
||||
LOGTIME=$(date "+%Y-%m-%d %H:%M:%S")
|
||||
echo "[$LOGTIME]"
|
||||
}
|
||||
function echoerr() { printf "%s\n" "$*" >&2; }
|
||||
|
||||
# The main domain as an identifier for the dns zone is required for the updateRecord call
|
||||
function getMainDomain() {
|
||||
request=$(
|
||||
echo "{}" |
|
||||
jq '(.method="nameserver.list")' |
|
||||
jq "(.params.user=\"$DYNB_USERNAME\")" |
|
||||
jq "(.params.pass=\"$DYNB_PASSWORD\")"
|
||||
request=$( echo "{}" | \
|
||||
jq '(.method="nameserver.list")' | \
|
||||
jq "(.params.user=\"$_username\")" | \
|
||||
jq "(.params.pass=\"$_password\")"
|
||||
)
|
||||
|
||||
_response=$(
|
||||
curl --silent \
|
||||
_response=$(curl --silent \
|
||||
"$_interface_str" \
|
||||
--user-agent "$_userAgent" \
|
||||
--header "Content-Type: application/json" \
|
||||
--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' )
|
||||
}
|
||||
|
||||
function fetchDNSRecords() {
|
||||
request=$(
|
||||
echo "{}" |
|
||||
jq '(.method="'nameserver.info'")' |
|
||||
jq "(.params.user=\"$DYNB_USERNAME\")" |
|
||||
jq "(.params.pass=\"$DYNB_PASSWORD\")" |
|
||||
jq "(.params.domain=\"$_main_domain\")" |
|
||||
jq "(.params.name=\"$DYNB_DYN_DOMAIN\")"
|
||||
request=$( echo "{}" | \
|
||||
jq '(.method="'nameserver.info'")' | \
|
||||
jq "(.params.user=\"$_username\")" | \
|
||||
jq "(.params.pass=\"$_password\")" | \
|
||||
jq "(.params.domain=\"$_main_domain\")" | \
|
||||
jq "(.params.name=\"$_dyn_domain\")"
|
||||
)
|
||||
|
||||
_response=$(
|
||||
curl --silent \
|
||||
_response=$( curl --silent \
|
||||
"$_interface_str" \
|
||||
--user-agent "$_userAgent" \
|
||||
--header "Content-Type: application/json" \
|
||||
@@ -193,18 +171,8 @@ function getDNSIP() {
|
||||
# 2. param: IP check server address
|
||||
# result to stdout
|
||||
function getRemoteIP() {
|
||||
if [[ -n $_DNS_checkServer ]]; then
|
||||
curl --silent "$_interface_str" --user-agent "$_userAgent" \
|
||||
--ipv"${1}" --dns-servers "$_DNS_checkServer" --location "${2}"
|
||||
else
|
||||
curl --silent "$_interface_str" --user-agent "$_userAgent" \
|
||||
--ipv"${1}" --location "${2}"
|
||||
fi
|
||||
# shellcheck disable=2181
|
||||
if [[ $? -gt 0 ]]; then
|
||||
errorMessage "IPCheck (getRemoteIP ${1}) request failed"
|
||||
exit 1
|
||||
fi
|
||||
--ipv"${1}" --dns-servers 1.1.1.1 --location "${2}"
|
||||
}
|
||||
|
||||
# requires parameter
|
||||
@@ -219,25 +187,23 @@ function updateRecord() {
|
||||
IP=$_new_IPv6
|
||||
fi
|
||||
if [[ $IP != "" ]]; then
|
||||
request=$(
|
||||
echo "{}" |
|
||||
jq '(.method="nameserver.updateRecord")' |
|
||||
jq "(.params.user=\"$DYNB_USERNAME\")" |
|
||||
jq "(.params.pass=\"$DYNB_PASSWORD\")" |
|
||||
jq "(.params.id=\"$ID\")" |
|
||||
jq "(.params.content=\"$IP\")" |
|
||||
request=$( echo "{}" | \
|
||||
jq '(.method="nameserver.updateRecord")' | \
|
||||
jq "(.params.user=\"$_username\")" | \
|
||||
jq "(.params.pass=\"$_password\")" | \
|
||||
jq "(.params.id=\"$ID\")" | \
|
||||
jq "(.params.content=\"$IP\")" | \
|
||||
jq "(.params.ttl=\"$TTL\")"
|
||||
)
|
||||
|
||||
_response=$(
|
||||
curl --silent \
|
||||
_response=$(curl --silent \
|
||||
"$_interface_str" \
|
||||
--user-agent "$_userAgent" \
|
||||
--header "Content-Type: application/json" \
|
||||
--request POST $_INWX_JSON_API_URL \
|
||||
--data "$request"
|
||||
)
|
||||
infoMessage "$(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
|
||||
}
|
||||
|
||||
@@ -248,38 +214,21 @@ function dynupdate() {
|
||||
myipv6_str=myipv6
|
||||
|
||||
INWX_DYNDNS_UPDATE_URL="https://dyndns.inwx.com/nic/update?"
|
||||
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&"
|
||||
NOIP_DYNDNS_UPDATE_URL="https://dynupdate.no-ip.com/nic/update?hostname=$_dyn_domain&"
|
||||
DYNV6_DYNDNS_UPDATE_URL="https://dynv6.com/api/update?zone=$_dyn_domain&token=$_token&"
|
||||
|
||||
case $DYNB_SERVICE_PROVIDER in
|
||||
inwx* | INWX*)
|
||||
if [[ $_serviceProvider == "inwx" ]]; then
|
||||
dyndns_update_url=$INWX_DYNDNS_UPDATE_URL
|
||||
;;
|
||||
deSEC* | desec* | dedyn*)
|
||||
dyndns_update_url="${DESEC_DYNDNS_UPDATE_URL}"
|
||||
;;
|
||||
noip* | no-ip*)
|
||||
dyndns_update_url="$NOIP_DYNDNS_UPDATE_URL"
|
||||
;;
|
||||
dynv6*)
|
||||
fi
|
||||
if [[ $_serviceProvider == "noip" ]] || [[ $_serviceProvider == "no-ip" ]]; then
|
||||
dyndns_update_url=$NOIP_DYNDNS_UPDATE_URL
|
||||
fi
|
||||
if [[ $_serviceProvider == "dynv6" ]]; then
|
||||
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
|
||||
;;
|
||||
*)
|
||||
errorMessage "$DYNB_SERVICE_PROVIDER is not supported"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
fi
|
||||
|
||||
# pre encode ip parameters
|
||||
if [[ $_is_IPv4_enabled == true ]] && [[ $_is_IPv6_enabled == true ]]; then
|
||||
dyndns_update_url="${dyndns_update_url}${myip_str}=${_new_IPv4}&${myipv6_str}=${_new_IPv6}"
|
||||
fi
|
||||
@@ -290,93 +239,81 @@ function dynupdate() {
|
||||
dyndns_update_url="${dyndns_update_url}${myipv6_str}=${_new_IPv6}"
|
||||
fi
|
||||
debugMessage "Update URL was: $dyndns_update_url"
|
||||
|
||||
## request ##
|
||||
case $DYNB_SERVICE_PROVIDER in
|
||||
inwx* | INWX* | noip* | no-ip*)
|
||||
if [[ $_serviceProvider == "dynv6" ]]; then
|
||||
_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" \
|
||||
"${dyndns_update_url}"
|
||||
)
|
||||
;;
|
||||
esac
|
||||
|
||||
fi
|
||||
if [[ $_serviceProvider == "inwx" || $_serviceProvider == "noip" ]]; then
|
||||
_response=$(curl --silent "$_interface_str" \
|
||||
--user-agent "$_userAgent" \
|
||||
--user "$_username":"$_password" \
|
||||
"${dyndns_update_url}" )
|
||||
fi
|
||||
|
||||
case $_response in
|
||||
good* | OK* | "addresses updated")
|
||||
good* )
|
||||
if [[ $_response == "good 127.0.0.1" ]]; then
|
||||
errorMessage "$_response: Request ignored."
|
||||
echoerr "Error: $_response: Request ignored."
|
||||
return 1
|
||||
else
|
||||
infoMessage "$_response: The DynDNS update has been executed."
|
||||
echo "$_response: The DynDNS update has been executed."
|
||||
_errorCounter=0
|
||||
return 0
|
||||
fi
|
||||
;;
|
||||
nochg* )
|
||||
infoMessage "$_response: Nothing has changed, IP addresses are still up to date."
|
||||
echo "$_response: Nothing has changed, IP addresses are still up to date."
|
||||
return 1
|
||||
;;
|
||||
abuse )
|
||||
errorMessage "$_response: Username is blocked due to abuse."
|
||||
echoerr "Error: $_response: Username is blocked due to abuse."
|
||||
return 1
|
||||
;;
|
||||
badauth | 401 )
|
||||
errorMessage "$_response: Invalid username password combination."
|
||||
echoerr "Error: $_response: Invalid username password combination."
|
||||
return 1
|
||||
;;
|
||||
badagent )
|
||||
errorMessage "$_response: Client disabled. Something is very wrong!"
|
||||
echoerr "Error: $_response: Client disabled. Something is very wrong!"
|
||||
return 1
|
||||
;;
|
||||
!donator )
|
||||
errorMessage "$_response: An update request was sent, including a feature that is not available to that particular user such as offline options."
|
||||
echoerr "Error: $_response: An update request was sent, including a feature that is not available to that particular user such as offline options."
|
||||
return 1
|
||||
;;
|
||||
!yours )
|
||||
errorMessage "$_response: The domain does not belong to your user account"
|
||||
echoerr "Error: $_response: The domain does not belong to your user account"
|
||||
return 1
|
||||
;;
|
||||
notfqdn )
|
||||
errorMessage "$_response: Hostname $DYNB_DYN_DOMAIN is invalid"
|
||||
echoerr "Error: $_response: Hostname $_dyn_domain is invalid"
|
||||
return 1
|
||||
;;
|
||||
nohost )
|
||||
errorMessage "$_response: Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
|
||||
echoerr "Error: $_response: Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
|
||||
return 1
|
||||
;;
|
||||
numhost )
|
||||
errorMessage "$_response: Too many hostnames have been specified for this update"
|
||||
echoerr "Error: $_response: Too many hostnames have been specified for this update"
|
||||
return 1
|
||||
;;
|
||||
dnserr )
|
||||
errorMessage "$_response: There is an internal error in the dyndns update system. Retry update no sooner than 30 minutes."
|
||||
echoerr "Error: $_response: There is an internal error in the dyndns update system. Retry update no sooner than 30 minutes."
|
||||
return 1
|
||||
;;
|
||||
911 | 5* )
|
||||
errorMessage "$_response: A fatal error on provider side such as a database outage. Retry update no sooner than 30 minutes."
|
||||
echoerr "Error: $_response: A fatal error on provider side such as a database outage. Retry update no sooner than 30 minutes."
|
||||
return 1
|
||||
;;
|
||||
* )
|
||||
if [[ "$_response" == "$_status" ]]; then
|
||||
errorMessage "An unknown response code has been received. $_response"
|
||||
echoerr "Error: An unknown response code has been received. $_response"
|
||||
return 1
|
||||
else
|
||||
errorMessage "unknown respnse code: $_response"
|
||||
echoerr "Error: unknown respnse code: $_response"
|
||||
return 0
|
||||
fi
|
||||
;;
|
||||
@@ -392,14 +329,14 @@ function checkStatus() {
|
||||
case $_status in
|
||||
nochg* )
|
||||
if [[ _errorCounter -gt 1 ]]; then
|
||||
errorMessage "The update client was spamming unnecessary update requests, something might be wrong with your IP-Check site."
|
||||
errorMessage "Fix your config an then delete $_statusFile or restart your docker container"
|
||||
echoerr "Error: The update client was spamming unnecessary update requests, something might be wrong with your IP-Check site."
|
||||
echoerr "Fix your config an then delete $_statusFile"
|
||||
return 1
|
||||
fi
|
||||
;;
|
||||
nohost | !yours )
|
||||
if [[ "$_statusHostname" == "$DYNB_DYN_DOMAIN" && ("$_statusUsername" == "$DYNB_USERNAME" || $_statusUsername == "$DYNB_TOKEN") ]]; then
|
||||
errorMessage "Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
|
||||
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."
|
||||
return 1
|
||||
else
|
||||
rm "$_statusFile"
|
||||
@@ -407,8 +344,8 @@ function checkStatus() {
|
||||
return 0
|
||||
;;
|
||||
badauth | 401 )
|
||||
if [[ "$_statusUsername" == "$DYNB_USERNAME" && "$_statusPassword" == "$DYNB_PASSWORD" ]]; then
|
||||
errorMessage "Invalid username password combination."
|
||||
if [[ "$_statusUsername" == "$_username" && "$_statusPassword" == "$_password" ]]; then
|
||||
echoerr "Error: Invalid username password combination."
|
||||
return 1
|
||||
else
|
||||
rm "$_statusFile"
|
||||
@@ -416,19 +353,19 @@ function checkStatus() {
|
||||
return 0
|
||||
;;
|
||||
badagent )
|
||||
errorMessage "Client is deactivated by provider."
|
||||
echoerr "Error: Client is deactivated by provider."
|
||||
echo "Fix your config and then manually remove $_statusFile to reset the client blockade."
|
||||
echo "If it still fails file an issue at github or try another client :)"
|
||||
return 1
|
||||
;;
|
||||
!donator )
|
||||
errorMessage "An update request was sent, including a feature that is not available to that particular user such as offline options."
|
||||
echoerr "Error: An update request was sent, including a feature that is not available to that particular user such as offline options."
|
||||
echo "Fix your config and then manually remove $_statusFile to reset the client blockade"
|
||||
echo "If it still fails file an issue at github or try another client :)"
|
||||
return 1
|
||||
;;
|
||||
abuse )
|
||||
errorMessage "Username is blocked due to abuse."
|
||||
echoerr "Error: Username is blocked due to abuse."
|
||||
echo "Fix your config and then manually remove $_statusFile to reset the client blockade"
|
||||
echo "If it still fails file an issue at github or try another client :)"
|
||||
return 1
|
||||
@@ -436,7 +373,7 @@ function checkStatus() {
|
||||
911 | 5* )
|
||||
delta=$(( $(date +%s) - _eventTime ))
|
||||
if [[ $delta -lt 1800 ]]; then
|
||||
errorMessage "$_status: The provider currently has an fatal error. DynB will wait for next update until 30 minutes have passed since last request, $(date --date=@$delta -u +%M) minutes already passed."
|
||||
echoerr "$_status: The provider currently has an fatal error. DynB will wait for next update until 30 minutes have passed since last request, $(date --date=@$delta -u +%M) minutes already passed."
|
||||
return 1
|
||||
else
|
||||
rm "$_statusFile"
|
||||
@@ -445,7 +382,7 @@ function checkStatus() {
|
||||
;;
|
||||
* )
|
||||
if [[ _errorCounter -gt 1 ]]; then
|
||||
errorMessage "An unknown response code has repeatedly been received. $_response"
|
||||
echoerr "Error: An unknown response code has repeatedly been received. $_response"
|
||||
return 1
|
||||
else
|
||||
return 0
|
||||
@@ -457,167 +394,101 @@ function checkStatus() {
|
||||
# requires parameter
|
||||
# 1. param: 4 or 6 for IP version
|
||||
function ipHasChanged() {
|
||||
case ${1} in
|
||||
4)
|
||||
if [[ ${1} == 4 ]]; then
|
||||
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
|
||||
if [[ $_update_method == domrobot ]]; then
|
||||
dns_ip=$(getDNSIP A)
|
||||
else
|
||||
if [[ -n $_DNS_checkServer ]]; then
|
||||
dig_response=$(dig @"${_DNS_checkServer}" in a +short "$DYNB_DYN_DOMAIN")
|
||||
else
|
||||
dig_response=$(dig in a +short "$DYNB_DYN_DOMAIN")
|
||||
dns_ip=$(dig @${_DNS_checkServer} in a +short "$_dyn_domain")
|
||||
fi
|
||||
if [[ $dig_response == ";; connection timed out; no servers could be reached" ]]; then
|
||||
errorMessage "DNS request failed $dig_response"
|
||||
return 0
|
||||
fi
|
||||
# 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 "IPv4 from remote IP check server: $_new_IPv4, IPv4 from DNS: $dns_ip"
|
||||
;;
|
||||
6)
|
||||
if [[ ${1} == 6 ]]; then
|
||||
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
|
||||
if [[ $_update_method == domrobot ]]; then
|
||||
dns_ip=$(getDNSIP AAAA)
|
||||
else
|
||||
if [[ -n $_DNS_checkServer ]]; then
|
||||
dig_response=$(dig @"${_DNS_checkServer}" in aaaa +short "$DYNB_DYN_DOMAIN")
|
||||
dns_ip=$(dig @${_DNS_checkServer} in aaaa +short "$_dyn_domain")
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ ${1} == 4 ]]; then
|
||||
_new_IPv4=$remote_ip
|
||||
#echo "New IPv4: $_new_IPv4 old was: $dns_ip"
|
||||
else
|
||||
dig_response=$(dig in aaaa +short "$DYNB_DYN_DOMAIN")
|
||||
fi
|
||||
if [[ $dig_response == ";; connection timed out; no servers could be reached" ]]; then
|
||||
errorMessage "DNS request failed $dig_response"
|
||||
return 0
|
||||
fi
|
||||
# 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 "IPv6 from remote IP check server: $_new_IPv6, IPv4 from DNS: $dns_ip"
|
||||
;;
|
||||
*) ;;
|
||||
esac
|
||||
#echo "New IPv6: $_new_IPv6 old was: $dns_ip"
|
||||
fi
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
################
|
||||
## parameters ##
|
||||
################
|
||||
###############
|
||||
## arguments ##
|
||||
###############
|
||||
|
||||
function handleParameters() {
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_version == "on" ]]; then
|
||||
echo $_version
|
||||
exit 0
|
||||
ARGS=
|
||||
if [[ $_has_getopt == "" ]] && [[ $(uname) == Linux ]]; then
|
||||
ARGS=$(getopt --options "hvi:,d:,m:,s:,u:,p:,t:" --longoptions "help,version,link,ip-mode:,domain:,update-method:,service-provider:,username:,password:,token:,reset" -- "$@");
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_link == "on" ]]; then
|
||||
eval set -- "$ARGS";
|
||||
unset ARGS
|
||||
|
||||
function processParameters() {
|
||||
while true; do
|
||||
case $1 in
|
||||
-h | --help )
|
||||
echo "$_help_message"
|
||||
exit 0
|
||||
;;
|
||||
-v | --version )
|
||||
echo "$_version"
|
||||
exit 0
|
||||
;;
|
||||
--link )
|
||||
ln --verbose --symbolic "$(realpath "$0")" "$HOME/.local/bin/dynb"
|
||||
exit 0
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_reset == "on" ]]; then
|
||||
;;
|
||||
-i | --ip-mode )
|
||||
_ip_mode=$2
|
||||
shift 2
|
||||
;;
|
||||
-d | --domain )
|
||||
_dyn_domain=$2
|
||||
shift 2
|
||||
;;
|
||||
-m | --update-method )
|
||||
_update_method=$2
|
||||
shift 2
|
||||
;;
|
||||
-s | --service-provider )
|
||||
_serviceProvider=$2
|
||||
shift 2
|
||||
;;
|
||||
-u | --username )
|
||||
_username=$2
|
||||
shift 2
|
||||
;;
|
||||
-p | --password )
|
||||
_password=$2
|
||||
shift 2
|
||||
;;
|
||||
-t | --token )
|
||||
_token=$2
|
||||
shift 2
|
||||
;;
|
||||
--reset )
|
||||
rm --verbose "$_statusFile"
|
||||
exit 0
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_debug == "on" ]]; then
|
||||
_debug=1
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_update_method != "" ]]; then
|
||||
DYNB_UPDATE_METHOD=$_arg_update_method
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_ip_mode != "" ]]; then
|
||||
DYNB_IP_MODE=$_arg_ip_mode
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_domain != "" ]]; then
|
||||
DYNB_DYN_DOMAIN=$_arg_domain
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_service_provider != "" ]]; then
|
||||
DYNB_SERVICE_PROVIDER=$_arg_service_provider
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_username != "" ]]; then
|
||||
DYNB_USERNAME=$_arg_username
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_password != "" ]]; then
|
||||
DYNB_PASSWORD=$_arg_password
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ $_arg_token != "" ]]; then
|
||||
DYNB_TOKEN=$_arg_token
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
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
|
||||
# shellcheck disable=SC2154
|
||||
if [[ -n $DYNB_IPv4_CHECK_SITE ]]; then
|
||||
_ipv4_checker=$DYNB_IPv4_CHECK_SITE
|
||||
fi
|
||||
# shellcheck disable=SC2154
|
||||
if [[ -n $DYNB_IPv6_CHECK_SITE ]]; then
|
||||
_ipv6_checker=$DYNB_IPv6_CHECK_SITE
|
||||
fi
|
||||
if [[ -n $DYNB_DNS_CHECK_SERVER ]]; then
|
||||
_DNS_checkServer=$DYNB_DNS_CHECK_SERVER
|
||||
fi
|
||||
return 0
|
||||
;;
|
||||
--)
|
||||
shift
|
||||
break
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
##################
|
||||
@@ -625,31 +496,34 @@ function handleParameters() {
|
||||
##################
|
||||
|
||||
function checkDependencies() {
|
||||
failCounter=0
|
||||
for i in curl dig; do
|
||||
if ! command -v $i >/dev/null 2>&1; then
|
||||
errorMessage "could not find \"$i\", DynB depends on it. "
|
||||
((failCounter++))
|
||||
fi
|
||||
done
|
||||
## If there will be more general dependencies use a loop
|
||||
# for i in curl and some other stuff; do
|
||||
# if ! command -v $i >/dev/null 2>&1; then
|
||||
# echoerr "Error: could not find \"$i\", DynB depends on it. "
|
||||
# exit 1
|
||||
# fi
|
||||
# done
|
||||
[[ -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
|
||||
((failCounter++))
|
||||
fi
|
||||
}
|
||||
if [[ failCounter -gt 0 ]]; then
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
# maybe replace this with matejak/argbash
|
||||
[[ -x $(command -v getopt 2> /dev/null) ]] || {
|
||||
_has_getopt=false
|
||||
}
|
||||
}
|
||||
|
||||
function doUnsets() {
|
||||
unset _network_interface
|
||||
unset _DNS_checkServer
|
||||
unset _dns_records
|
||||
unset _dyn_domain
|
||||
unset _has_getopt
|
||||
unset _help_message
|
||||
unset _INWX_JSON_API_URL
|
||||
unset _ip_mode
|
||||
unset _ipv4_checker
|
||||
unset _ipv6_checker
|
||||
unset _is_IPv4_enabled
|
||||
@@ -657,121 +531,18 @@ function doUnsets() {
|
||||
unset _main_domain
|
||||
unset _new_IPv4
|
||||
unset _new_IPv6
|
||||
unset _password
|
||||
unset _username
|
||||
unset _serviceProvider
|
||||
unset _version
|
||||
unset DYNB_DYN_DOMAIN
|
||||
unset DYNB_USERNAME
|
||||
unset DYNB_PASSWORD
|
||||
unset DYNB_TOKEN
|
||||
unset DYNB_SERVICE_PROVIDER
|
||||
unset DYNB_IP_MODE
|
||||
unset DYNB_INTERVAL
|
||||
unset DYNB_IPv4_CHECK_SITE
|
||||
unset DYNB_IPv6_CHECK_SITE
|
||||
unset DYNB_DNS_CHECK_SERVER
|
||||
unset DYNB_DEBUG
|
||||
}
|
||||
|
||||
function doDomrobotUpdates() {
|
||||
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
|
||||
}
|
||||
|
||||
function doDynDNS2Updates() {
|
||||
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
|
||||
}
|
||||
|
||||
function doUpdates() {
|
||||
if [[ $DYNB_UPDATE_METHOD == "domrobot" ]]; then
|
||||
doDomrobotUpdates
|
||||
fi
|
||||
|
||||
if [[ $DYNB_UPDATE_METHOD == "dyndns" ]]; then
|
||||
doDynDNS2Updates
|
||||
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 ##
|
||||
#################
|
||||
function dynb() {
|
||||
# shellcheck disable=SC1091,SC1090
|
||||
source "$(dirname "$(realpath "$0")")/dynb-parsing.sh"
|
||||
## parameters and checks
|
||||
checkDependencies
|
||||
|
||||
# shellcheck source=.env
|
||||
if test -f "$_configFile"; then
|
||||
@@ -790,20 +561,68 @@ function dynb() {
|
||||
source "$_statusFile"
|
||||
fi
|
||||
|
||||
## parameters and checks
|
||||
handleParameters
|
||||
checkDependencies
|
||||
check_internet_connection
|
||||
|
||||
if loopMode; then
|
||||
while :; do
|
||||
doUpdates
|
||||
sleep $DYNB_INTERVAL
|
||||
done
|
||||
else
|
||||
doUpdates
|
||||
if [[ $_has_getopt == "" ]] && [[ $(uname) == Linux ]]; then
|
||||
processParameters "$@"
|
||||
fi
|
||||
|
||||
if [[ $_network_interface != "" ]]; then
|
||||
_interface_str="--interface $_network_interface"
|
||||
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
|
||||
return 0
|
||||
}
|
||||
|
||||
28
example.env
28
example.env
@@ -1,21 +1,7 @@
|
||||
###################
|
||||
## Configuration ##
|
||||
###################
|
||||
|
||||
DYNB_DYN_DOMAIN=dyndns.example.com
|
||||
|
||||
## service provider could be deSEC, duckdns, dynv6, inwx
|
||||
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=
|
||||
_dyn_domain=dyndns.example.com
|
||||
_serviceProvider=inwx
|
||||
_update_method=domrobot
|
||||
_ip_mode=dual
|
||||
_username=User42
|
||||
_password=SuperSecretPassword
|
||||
_token=
|
||||
|
||||
114
man/dynb.1
114
man/dynb.1
@@ -1,114 +0,0 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH MAN 1 "2021-04-21" "" ""
|
||||
.SH NAME
|
||||
man \- DynB - dynamic DNS update script for bash
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
.de1 rstReportMargin
|
||||
\\$1 \\n[an-margin]
|
||||
level \\n[rst2man-indent-level]
|
||||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
-
|
||||
\\n[rst2man-indent0]
|
||||
\\n[rst2man-indent1]
|
||||
\\n[rst2man-indent2]
|
||||
..
|
||||
.de1 INDENT
|
||||
.\" .rstReportMargin pre:
|
||||
. RS \\$1
|
||||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||
. nr rst2man-indent-level +1
|
||||
.\" .rstReportMargin post:
|
||||
..
|
||||
.de UNINDENT
|
||||
. RE
|
||||
.\" indent \\n[an-margin]
|
||||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.nr rst2man-indent-level -1
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.SH SYNOPSIS
|
||||
.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
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
IPv4 (A) and IPv6 (AAAA) record updates are supported.
|
||||
.SH ARGUMENTS
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v\fP,\fB \-\-version
|
||||
outputs the client version.
|
||||
[Default: off]
|
||||
.sp
|
||||
|
||||
.TP
|
||||
.B \-l\fP,\fB \-\-link
|
||||
links to your script at ~/.local/bin/dynb.
|
||||
[Default: off]
|
||||
.sp
|
||||
|
||||
.TP
|
||||
.B \-r\fP,\fB \-\-reset
|
||||
deletes the client blocking status file.
|
||||
[Default: off]
|
||||
.sp
|
||||
|
||||
.TP
|
||||
.B \-\-debug
|
||||
enables debug mode.
|
||||
[Default: off]
|
||||
.sp
|
||||
|
||||
.TP
|
||||
.BI \-m \ UPDATE\-METHOD\fR,\fB \ \-\-update\-method \ UPDATE\-METHOD
|
||||
choose if you want to use DynDNS2 or the DomRobot RPC\-API.
|
||||
.sp
|
||||
dyndns | domrobot
|
||||
.TP
|
||||
.BI \-i \ IP\-MODE\fR,\fB \ \-\-ip\-mode \ IP\-MODE
|
||||
updates type A (IPv4) and AAAA (IPv6) records.
|
||||
.sp
|
||||
4 | 6 | dual
|
||||
.TP
|
||||
.BI \-d \ DOMAIN\fR,\fB \ \-\-domain \ DOMAIN
|
||||
set the domain you want to update.
|
||||
.sp
|
||||
dyndns.example.com
|
||||
.TP
|
||||
.BI \-s \ SERVICE\-PROVIDER\fR,\fB \ \-\-service\-provider \ SERVICE\-PROVIDER
|
||||
set your provider in case you are using DynDNS2.
|
||||
.sp
|
||||
deSEC | duckdns | dynv6 | inwx
|
||||
.TP
|
||||
.BI \-u \ USERNAME\fR,\fB \ \-\-username \ USERNAME
|
||||
depends on your selected update method and your provider.
|
||||
.sp
|
||||
e.g. user42
|
||||
.TP
|
||||
.BI \-p \ PASSWORD\fR,\fB \ \-\-password \ PASSWORD
|
||||
depends on your selected update method and your provider.
|
||||
.sp
|
||||
e.g. SuperSecretPassword
|
||||
.TP
|
||||
.BI \-t \ TOKEN\fR,\fB \ \-\-token \ TOKEN
|
||||
depends on your selected update method and your provider.
|
||||
.sp
|
||||
YourProviderGivenToken
|
||||
.TP
|
||||
.BI \-\-interval \ INTERVAL
|
||||
choose the seconds interval to run the script in a loop, minimum is 60.
|
||||
.sp
|
||||
|
||||
.TP
|
||||
.B \-h\fP,\fB \-\-help
|
||||
Prints help.
|
||||
.sp
|
||||
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
Eduard Veit
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
@@ -1,35 +0,0 @@
|
||||
|
||||
.. |AUTHOR| replace:: Eduard Veit
|
||||
|
||||
.. |VERSION| replace:: \
|
||||
|
||||
.. |MAN_SECTION| replace:: 1
|
||||
|
||||
.. |DESCRIPTION| replace::
|
||||
IPv4 (A) and IPv6 (AAAA) record updates are supported.
|
||||
|
||||
.. |OPTION_VERSION| replace:: \
|
||||
|
||||
.. |OPTION_LINK| replace:: \
|
||||
|
||||
.. |OPTION_RESET| replace:: \
|
||||
|
||||
.. |OPTION_DEBUG| replace:: \
|
||||
|
||||
.. |OPTION_UPDATE_METHOD| replace:: dyndns | domrobot
|
||||
|
||||
.. |OPTION_IP_MODE| replace:: 4 | 6 | dual
|
||||
|
||||
.. |OPTION_DOMAIN| replace:: dyndns.example.com
|
||||
|
||||
.. |OPTION_SERVICE_PROVIDER| replace:: deSEC | duckdns | dynv6 | inwx
|
||||
|
||||
.. |OPTION_USERNAME| replace:: e.g. user42
|
||||
|
||||
.. |OPTION_PASSWORD| replace:: e.g. SuperSecretPassword
|
||||
|
||||
.. |OPTION_TOKEN| replace:: YourProviderGivenToken
|
||||
|
||||
.. |OPTION_INTERVAL| replace:: \
|
||||
|
||||
.. |OPTION_HELP| replace:: \
|
||||
88
man/man.rst
88
man/man.rst
@@ -1,88 +0,0 @@
|
||||
|
||||
.. include:: man-defs.rst
|
||||
|
||||
|
||||
===
|
||||
man
|
||||
===
|
||||
|
||||
-----------------------------------------
|
||||
DynB - dynamic DNS update script for bash
|
||||
-----------------------------------------
|
||||
|
||||
:Author: |AUTHOR|
|
||||
:Date: 2021-04-21
|
||||
:Version: |VERSION|
|
||||
:Manual section: |MAN_SECTION|
|
||||
|
||||
|
||||
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]``
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
===========
|
||||
|
||||
|DESCRIPTION|
|
||||
|
||||
|
||||
ARGUMENTS
|
||||
=========
|
||||
|
||||
-v, --version outputs the client version.
|
||||
[Default: off]
|
||||
|
||||
|OPTION_VERSION|
|
||||
|
||||
-l, --link links to your script at ~/.local/bin/dynb.
|
||||
[Default: off]
|
||||
|
||||
|OPTION_LINK|
|
||||
|
||||
-r, --reset deletes the client blocking status file.
|
||||
[Default: off]
|
||||
|
||||
|OPTION_RESET|
|
||||
|
||||
--debug enables debug mode.
|
||||
[Default: off]
|
||||
|
||||
|OPTION_DEBUG|
|
||||
|
||||
-m UPDATE-METHOD, --update-method UPDATE-METHOD choose if you want to use DynDNS2 or the DomRobot RPC-API.
|
||||
|
||||
|OPTION_UPDATE_METHOD|
|
||||
|
||||
-i IP-MODE, --ip-mode IP-MODE updates type A (IPv4) and AAAA (IPv6) records.
|
||||
|
||||
|OPTION_IP_MODE|
|
||||
|
||||
-d DOMAIN, --domain DOMAIN set the domain you want to update.
|
||||
|
||||
|OPTION_DOMAIN|
|
||||
|
||||
-s SERVICE-PROVIDER, --service-provider SERVICE-PROVIDER set your provider in case you are using DynDNS2.
|
||||
|
||||
|OPTION_SERVICE_PROVIDER|
|
||||
|
||||
-u USERNAME, --username USERNAME depends on your selected update method and your provider.
|
||||
|
||||
|OPTION_USERNAME|
|
||||
|
||||
-p PASSWORD, --password PASSWORD depends on your selected update method and your provider.
|
||||
|
||||
|OPTION_PASSWORD|
|
||||
|
||||
-t TOKEN, --token TOKEN depends on your selected update method and your provider.
|
||||
|
||||
|OPTION_TOKEN|
|
||||
|
||||
--interval INTERVAL choose the seconds interval to run the script in a loop, minimum is 60.
|
||||
|
||||
|OPTION_INTERVAL|
|
||||
|
||||
-h, --help Prints help.
|
||||
|
||||
|OPTION_HELP|
|
||||
Reference in New Issue
Block a user