6b7b5caf54
Instead of using comments declare info in a special variable.
Then the variable can be used to print the DNS API provider usage.
The usage can be parsed on UI and show all needed inputs for options.
The info is stored in plain string that it's both human-readable and easy to parse:
dns_example_info='API name
An extended description.
Multiline.
Domains: list of alternative domains to find
Site: the dns provider website e.g. example.com
Docs: Link to ACME.sh wiki for the provider
Options:
VARIABLE1 Title for the option1.
VARIABLE2 Title for the option2. Default "default value".
VARIABLE3 Title for the option3. Description to show on UI. Optional.
Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh
Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>;
'
Here:
VARIABLE1 will be required.
VARIABLE2 will be required too but will be populated with a "default value".
VARIABLE3 is optional and can be empty.
A DNS provider may have alternative options like CloudFlare may use API KEY or API Token.
You can use a second section OptionsAlt: section.
Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud.
Add them to Domains: section.
Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
109 lines
3.6 KiB
Bash
Executable File
109 lines
3.6 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_nsupdate_info='nsupdate RFC 2136 DynDNS client
|
|
Site: bind9.readthedocs.io/en/v9.18.19/manpages.html#nsupdate-dynamic-dns-update-utility
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_nsupdate
|
|
Options:
|
|
NSUPDATE_SERVER Server hostname. Default: "localhost".
|
|
NSUPDATE_SERVER_PORT Server port. Default: "53".
|
|
NSUPDATE_KEY File path to TSIG key.
|
|
NSUPDATE_ZONE Domain zone to update. Optional.
|
|
'
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: dns_nsupdate_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_nsupdate_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
NSUPDATE_SERVER="${NSUPDATE_SERVER:-$(_readaccountconf_mutable NSUPDATE_SERVER)}"
|
|
NSUPDATE_SERVER_PORT="${NSUPDATE_SERVER_PORT:-$(_readaccountconf_mutable NSUPDATE_SERVER_PORT)}"
|
|
NSUPDATE_KEY="${NSUPDATE_KEY:-$(_readaccountconf_mutable NSUPDATE_KEY)}"
|
|
NSUPDATE_ZONE="${NSUPDATE_ZONE:-$(_readaccountconf_mutable NSUPDATE_ZONE)}"
|
|
|
|
_checkKeyFile || return 1
|
|
|
|
# save the dns server and key to the account conf file.
|
|
_saveaccountconf_mutable NSUPDATE_SERVER "${NSUPDATE_SERVER}"
|
|
_saveaccountconf_mutable NSUPDATE_SERVER_PORT "${NSUPDATE_SERVER_PORT}"
|
|
_saveaccountconf_mutable NSUPDATE_KEY "${NSUPDATE_KEY}"
|
|
_saveaccountconf_mutable NSUPDATE_ZONE "${NSUPDATE_ZONE}"
|
|
|
|
[ -n "${NSUPDATE_SERVER}" ] || NSUPDATE_SERVER="localhost"
|
|
[ -n "${NSUPDATE_SERVER_PORT}" ] || NSUPDATE_SERVER_PORT=53
|
|
|
|
_info "adding ${fulldomain}. 60 in txt \"${txtvalue}\""
|
|
[ -n "$DEBUG" ] && [ "$DEBUG" -ge "$DEBUG_LEVEL_1" ] && nsdebug="-d"
|
|
[ -n "$DEBUG" ] && [ "$DEBUG" -ge "$DEBUG_LEVEL_2" ] && nsdebug="-D"
|
|
if [ -z "${NSUPDATE_ZONE}" ]; then
|
|
nsupdate -k "${NSUPDATE_KEY}" $nsdebug <<EOF
|
|
server ${NSUPDATE_SERVER} ${NSUPDATE_SERVER_PORT}
|
|
update add ${fulldomain}. 60 in txt "${txtvalue}"
|
|
send
|
|
EOF
|
|
else
|
|
nsupdate -k "${NSUPDATE_KEY}" $nsdebug <<EOF
|
|
server ${NSUPDATE_SERVER} ${NSUPDATE_SERVER_PORT}
|
|
zone ${NSUPDATE_ZONE}.
|
|
update add ${fulldomain}. 60 in txt "${txtvalue}"
|
|
send
|
|
EOF
|
|
fi
|
|
if [ $? -ne 0 ]; then
|
|
_err "error updating domain"
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
#Usage: dns_nsupdate_rm _acme-challenge.www.domain.com
|
|
dns_nsupdate_rm() {
|
|
fulldomain=$1
|
|
|
|
NSUPDATE_SERVER="${NSUPDATE_SERVER:-$(_readaccountconf_mutable NSUPDATE_SERVER)}"
|
|
NSUPDATE_SERVER_PORT="${NSUPDATE_SERVER_PORT:-$(_readaccountconf_mutable NSUPDATE_SERVER_PORT)}"
|
|
NSUPDATE_KEY="${NSUPDATE_KEY:-$(_readaccountconf_mutable NSUPDATE_KEY)}"
|
|
NSUPDATE_ZONE="${NSUPDATE_ZONE:-$(_readaccountconf_mutable NSUPDATE_ZONE)}"
|
|
|
|
_checkKeyFile || return 1
|
|
[ -n "${NSUPDATE_SERVER}" ] || NSUPDATE_SERVER="localhost"
|
|
[ -n "${NSUPDATE_SERVER_PORT}" ] || NSUPDATE_SERVER_PORT=53
|
|
_info "removing ${fulldomain}. txt"
|
|
[ -n "$DEBUG" ] && [ "$DEBUG" -ge "$DEBUG_LEVEL_1" ] && nsdebug="-d"
|
|
[ -n "$DEBUG" ] && [ "$DEBUG" -ge "$DEBUG_LEVEL_2" ] && nsdebug="-D"
|
|
if [ -z "${NSUPDATE_ZONE}" ]; then
|
|
nsupdate -k "${NSUPDATE_KEY}" $nsdebug <<EOF
|
|
server ${NSUPDATE_SERVER} ${NSUPDATE_SERVER_PORT}
|
|
update delete ${fulldomain}. txt
|
|
send
|
|
EOF
|
|
else
|
|
nsupdate -k "${NSUPDATE_KEY}" $nsdebug <<EOF
|
|
server ${NSUPDATE_SERVER} ${NSUPDATE_SERVER_PORT}
|
|
zone ${NSUPDATE_ZONE}.
|
|
update delete ${fulldomain}. txt
|
|
send
|
|
EOF
|
|
fi
|
|
if [ $? -ne 0 ]; then
|
|
_err "error updating domain"
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
|
|
_checkKeyFile() {
|
|
if [ -z "${NSUPDATE_KEY}" ]; then
|
|
_err "you must specify a path to the nsupdate key file"
|
|
return 1
|
|
fi
|
|
if [ ! -r "${NSUPDATE_KEY}" ]; then
|
|
_err "key ${NSUPDATE_KEY} is unreadable"
|
|
return 1
|
|
fi
|
|
}
|