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>
128 lines
3.5 KiB
Bash
128 lines
3.5 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_ddnss_info='DDNSS.de
|
|
Site: DDNSS.de
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_ddnss
|
|
Options:
|
|
DDNSS_Token API Token
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2230
|
|
Author: RaidenII, helbgd, mod242
|
|
'
|
|
|
|
DDNSS_DNS_API="https://ddnss.de/upd.php"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: dns_ddnss_add _acme-challenge.domain.ddnss.de "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_ddnss_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
DDNSS_Token="${DDNSS_Token:-$(_readaccountconf_mutable DDNSS_Token)}"
|
|
if [ -z "$DDNSS_Token" ]; then
|
|
_err "You must export variable: DDNSS_Token"
|
|
_err "The token for your DDNSS account is necessary."
|
|
_err "You can look it up in your DDNSS account."
|
|
return 1
|
|
fi
|
|
|
|
# Now save the credentials.
|
|
_saveaccountconf_mutable DDNSS_Token "$DDNSS_Token"
|
|
|
|
# Unfortunately, DDNSS does not seems to support lookup domain through API
|
|
# So I assume your credentials (which are your domain and token) are correct
|
|
# If something goes wrong, we will get a KO response from DDNSS
|
|
|
|
if ! _ddnss_get_domain; then
|
|
return 1
|
|
fi
|
|
|
|
# Now add the TXT record to DDNSS DNS
|
|
_info "Trying to add TXT record"
|
|
if _ddnss_rest GET "key=$DDNSS_Token&host=$_ddnss_domain&txtm=1&txt=$txtvalue"; then
|
|
if [ "$response" = "Updated 1 hostname." ]; then
|
|
_info "TXT record has been successfully added to your DDNSS domain."
|
|
_info "Note that all subdomains under this domain uses the same TXT record."
|
|
return 0
|
|
else
|
|
_err "Errors happened during adding the TXT record, response=$response"
|
|
return 1
|
|
fi
|
|
else
|
|
_err "Errors happened during adding the TXT record."
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
#Usage: fulldomain txtvalue
|
|
#Remove the txt record after validation.
|
|
dns_ddnss_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
DDNSS_Token="${DDNSS_Token:-$(_readaccountconf_mutable DDNSS_Token)}"
|
|
if [ -z "$DDNSS_Token" ]; then
|
|
_err "You must export variable: DDNSS_Token"
|
|
_err "The token for your DDNSS account is necessary."
|
|
_err "You can look it up in your DDNSS account."
|
|
return 1
|
|
fi
|
|
|
|
if ! _ddnss_get_domain; then
|
|
return 1
|
|
fi
|
|
|
|
# Now remove the TXT record from DDNS DNS
|
|
_info "Trying to remove TXT record"
|
|
if _ddnss_rest GET "key=$DDNSS_Token&host=$_ddnss_domain&txtm=2"; then
|
|
if [ "$response" = "Updated 1 hostname." ]; then
|
|
_info "TXT record has been successfully removed from your DDNSS domain."
|
|
return 0
|
|
else
|
|
_err "Errors happened during removing the TXT record, response=$response"
|
|
return 1
|
|
fi
|
|
else
|
|
_err "Errors happened during removing the TXT record."
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
|
|
#fulldomain=_acme-challenge.domain.ddnss.de
|
|
#returns
|
|
# _ddnss_domain=domain
|
|
_ddnss_get_domain() {
|
|
|
|
# We'll extract the domain/username from full domain
|
|
_ddnss_domain="$(echo "$fulldomain" | _lower_case | _egrep_o '[.][^.][^.]*[.](ddnss|dyn-ip24|dyndns|dyn|dyndns1|home-webserver|myhome-server|dynip)\..*' | cut -d . -f 2-)"
|
|
|
|
if [ -z "$_ddnss_domain" ]; then
|
|
_err "Error extracting the domain."
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
#Usage: method URI
|
|
_ddnss_rest() {
|
|
method=$1
|
|
param="$2"
|
|
_debug param "$param"
|
|
url="$DDNSS_DNS_API?$param"
|
|
_debug url "$url"
|
|
|
|
# DDNSS uses GET to update domain info
|
|
if [ "$method" = "GET" ]; then
|
|
response="$(_get "$url" | sed 's/<[a-zA-Z\/][^>]*>//g' | tr -s "\n" | _tail_n 1)"
|
|
else
|
|
_err "Unsupported method"
|
|
return 1
|
|
fi
|
|
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|