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>
134 lines
3.1 KiB
Bash
Executable File
134 lines
3.1 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_nederhost_info='NederHost.nl
|
|
Site: NederHost.nl
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_nederhost
|
|
Options:
|
|
NederHost_Key API Key
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2089
|
|
'
|
|
|
|
NederHost_Api="https://api.nederhost.nl/dns/v1"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_nederhost_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
NederHost_Key="${NederHost_Key:-$(_readaccountconf_mutable NederHost_Key)}"
|
|
if [ -z "$NederHost_Key" ]; then
|
|
NederHost_Key=""
|
|
_err "You didn't specify a NederHost api key."
|
|
_err "You can get yours from https://www.nederhost.nl/mijn_nederhost"
|
|
return 1
|
|
fi
|
|
|
|
#save the api key and email to the account conf file.
|
|
_saveaccountconf_mutable NederHost_Key "$NederHost_Key"
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
_info "Adding record"
|
|
if _nederhost_rest PATCH "zones/$_domain/records/$fulldomain/TXT" "[{\"content\":\"$txtvalue\",\"ttl\":60}]"; then
|
|
if _contains "$response" "$fulldomain"; then
|
|
_info "Added, OK"
|
|
return 0
|
|
else
|
|
_err "Add txt record error."
|
|
return 1
|
|
fi
|
|
fi
|
|
_err "Add txt record error."
|
|
return 1
|
|
|
|
}
|
|
|
|
#fulldomain txtvalue
|
|
dns_nederhost_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
NederHost_Key="${NederHost_Key:-$(_readaccountconf_mutable NederHost_Key)}"
|
|
if [ -z "$NederHost_Key" ]; then
|
|
NederHost_Key=""
|
|
_err "You didn't specify a NederHost api key."
|
|
_err "You can get yours from https://www.nederhost.nl/mijn_nederhost"
|
|
return 1
|
|
fi
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
_debug "Removing txt record"
|
|
_nederhost_rest DELETE "zones/${_domain}/records/$fulldomain/TXT?content=$txtvalue"
|
|
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
#_acme-challenge.www.domain.com
|
|
#returns
|
|
# _sub_domain=_acme-challenge.www
|
|
# _domain=domain.com
|
|
_get_root() {
|
|
domain=$1
|
|
i=2
|
|
p=1
|
|
while true; do
|
|
_domain=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_debug _domain "$_domain"
|
|
if [ -z "$_domain" ]; then
|
|
#not valid
|
|
return 1
|
|
fi
|
|
|
|
if _nederhost_rest GET "zones/${_domain}"; then
|
|
if [ "${_code}" = "204" ]; then
|
|
return 0
|
|
fi
|
|
else
|
|
return 1
|
|
fi
|
|
p=$i
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|
|
|
|
_nederhost_rest() {
|
|
m=$1
|
|
ep="$2"
|
|
data="$3"
|
|
_debug "$ep"
|
|
|
|
export _H1="Authorization: Bearer $NederHost_Key"
|
|
export _H2="Content-Type: application/json"
|
|
|
|
_debug data "$data"
|
|
response="$(_post "$data" "$NederHost_Api/$ep" "" "$m")"
|
|
|
|
_code="$(grep "^HTTP" "$HTTP_HEADER" | _tail_n 1 | cut -d " " -f 2 | tr -d "\\r\\n")"
|
|
_debug "http response code $_code"
|
|
|
|
if [ "$?" != "0" ]; then
|
|
_err "error $ep"
|
|
return 1
|
|
fi
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|