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>
131 lines
3.8 KiB
Bash
Executable File
131 lines
3.8 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_duckdns_info='DuckDNS.org
|
|
Site: www.DuckDNS.org
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_duckdns
|
|
Options:
|
|
DuckDNS_Token API Token
|
|
Author: RaidenII
|
|
'
|
|
|
|
DuckDNS_API="https://www.duckdns.org/update"
|
|
|
|
######## Public functions ######################
|
|
|
|
#Usage: dns_duckdns_add _acme-challenge.domain.duckdns.org "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_duckdns_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
DuckDNS_Token="${DuckDNS_Token:-$(_readaccountconf_mutable DuckDNS_Token)}"
|
|
if [ -z "$DuckDNS_Token" ]; then
|
|
_err "You must export variable: DuckDNS_Token"
|
|
_err "The token for your DuckDNS account is necessary."
|
|
_err "You can look it up in your DuckDNS account."
|
|
return 1
|
|
fi
|
|
|
|
# Now save the credentials.
|
|
_saveaccountconf_mutable DuckDNS_Token "$DuckDNS_Token"
|
|
|
|
# Unfortunately, DuckDNS 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 DuckDNS
|
|
|
|
if ! _duckdns_get_domain; then
|
|
return 1
|
|
fi
|
|
|
|
# Now add the TXT record to DuckDNS
|
|
_info "Trying to add TXT record"
|
|
if _duckdns_rest GET "domains=$_duckdns_domain&token=$DuckDNS_Token&txt=$txtvalue"; then
|
|
if [ "$response" = "OK" ]; then
|
|
_info "TXT record has been successfully added to your DuckDNS 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_duckdns_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
DuckDNS_Token="${DuckDNS_Token:-$(_readaccountconf_mutable DuckDNS_Token)}"
|
|
if [ -z "$DuckDNS_Token" ]; then
|
|
_err "You must export variable: DuckDNS_Token"
|
|
_err "The token for your DuckDNS account is necessary."
|
|
_err "You can look it up in your DuckDNS account."
|
|
return 1
|
|
fi
|
|
|
|
if ! _duckdns_get_domain; then
|
|
return 1
|
|
fi
|
|
|
|
# Now remove the TXT record from DuckDNS
|
|
_info "Trying to remove TXT record"
|
|
if _duckdns_rest GET "domains=$_duckdns_domain&token=$DuckDNS_Token&txt=&clear=true"; then
|
|
if [ "$response" = "OK" ]; then
|
|
_info "TXT record has been successfully removed from your DuckDNS 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 may be 'domain.duckdns.org' (if using --domain-alias) or '_acme-challenge.domain.duckdns.org'
|
|
# either way, return 'domain'. (duckdns does not allow further subdomains and restricts domains to [a-z0-9-].)
|
|
_duckdns_get_domain() {
|
|
|
|
# We'll extract the domain/username from full domain
|
|
_duckdns_domain="$(printf "%s" "$fulldomain" | _lower_case | _egrep_o '^(_acme-challenge\.)?([a-z0-9-]+\.)+duckdns\.org' | sed -n 's/^\([^.]\{1,\}\.\)*\([a-z0-9-]\{1,\}\)\.duckdns\.org$/\2/p;')"
|
|
|
|
if [ -z "$_duckdns_domain" ]; then
|
|
_err "Error extracting the domain."
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
#Usage: method URI
|
|
_duckdns_rest() {
|
|
method=$1
|
|
param="$2"
|
|
_debug param "$param"
|
|
url="$DuckDNS_API?$param"
|
|
if [ -n "$DEBUG" ] && [ "$DEBUG" -gt 0 ]; then
|
|
url="$url&verbose=true"
|
|
fi
|
|
_debug url "$url"
|
|
|
|
# DuckDNS uses GET to update domain info
|
|
if [ "$method" = "GET" ]; then
|
|
response="$(_get "$url")"
|
|
_debug2 response "$response"
|
|
if [ -n "$DEBUG" ] && [ "$DEBUG" -gt 0 ] && _contains "$response" "UPDATED" && _contains "$response" "OK"; then
|
|
response="OK"
|
|
fi
|
|
else
|
|
_err "Unsupported method"
|
|
return 1
|
|
fi
|
|
return 0
|
|
}
|