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>
231 lines
6.6 KiB
Bash
Executable File
231 lines
6.6 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_rcode0_info='Rcode0 rcodezero.at
|
|
Site: rcodezero.at
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi2#dns_rcode0
|
|
Options:
|
|
RCODE0_URL API URL. E.g. "https://my.rcodezero.at"
|
|
RCODE0_API_TOKEN API Token
|
|
RCODE0_TTL TTL. Default: "60".
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2490
|
|
'
|
|
|
|
#Rcode0 API Integration
|
|
#https://my.rcodezero.at/api-doc
|
|
#
|
|
# log into https://my.rcodezero.at/enableapi and get your ACME API Token (the ACME API token has limited
|
|
# access to the REST calls needed for acme.sh only)
|
|
|
|
DEFAULT_RCODE0_URL="https://my.rcodezero.at"
|
|
DEFAULT_RCODE0_TTL=60
|
|
|
|
######## Public functions #####################
|
|
#Usage: add _acme-challenge.www.domain.com "123456789ABCDEF0000000000000000000000000000000000000"
|
|
#fulldomain
|
|
#txtvalue
|
|
dns_rcode0_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
RCODE0_API_TOKEN="${RCODE0_API_TOKEN:-$(_readaccountconf_mutable RCODE0_API_TOKEN)}"
|
|
RCODE0_URL="${RCODE0_URL:-$(_readaccountconf_mutable RCODE0_URL)}"
|
|
RCODE0_TTL="${RCODE0_TTL:-$(_readaccountconf_mutable RCODE0_TTL)}"
|
|
|
|
if [ -z "$RCODE0_URL" ]; then
|
|
RCODE0_URL="$DEFAULT_RCODE0_URL"
|
|
fi
|
|
|
|
if [ -z "$RCODE0_API_TOKEN" ]; then
|
|
RCODE0_API_TOKEN=""
|
|
_err "Missing Rcode0 ACME API Token."
|
|
_err "Please login and create your token at httsp://my.rcodezero.at/enableapi and try again."
|
|
return 1
|
|
fi
|
|
|
|
if [ -z "$RCODE0_TTL" ]; then
|
|
RCODE0_TTL="$DEFAULT_RCODE0_TTL"
|
|
fi
|
|
|
|
#save the token to the account conf file.
|
|
_saveaccountconf_mutable RCODE0_API_TOKEN "$RCODE0_API_TOKEN"
|
|
|
|
if [ "$RCODE0_URL" != "$DEFAULT_RCODE0_URL" ]; then
|
|
_saveaccountconf_mutable RCODE0_URL "$RCODE0_URL"
|
|
fi
|
|
|
|
if [ "$RCODE0_TTL" != "$DEFAULT_RCODE0_TTL" ]; then
|
|
_saveaccountconf_mutable RCODE0_TTL "$RCODE0_TTL"
|
|
fi
|
|
|
|
_debug "Detect root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "No 'MASTER' zone for $fulldomain found at RcodeZero Anycast."
|
|
return 1
|
|
fi
|
|
_debug _domain "$_domain"
|
|
|
|
_debug "Adding record"
|
|
|
|
_record_string=""
|
|
_build_record_string "$txtvalue"
|
|
_list_existingchallenges
|
|
for oldchallenge in $_existing_challenges; do
|
|
_build_record_string "$oldchallenge"
|
|
done
|
|
|
|
_debug "Challenges: $_existing_challenges"
|
|
|
|
if [ -z "$_existing_challenges" ]; then
|
|
if ! _rcode0_rest "PATCH" "/api/v1/acme/zones/$_domain/rrsets" "[{\"changetype\": \"add\", \"name\": \"$fulldomain.\", \"type\": \"TXT\", \"ttl\": $RCODE0_TTL, \"records\": [$_record_string]}]"; then
|
|
_err "Add txt record error."
|
|
return 1
|
|
fi
|
|
else
|
|
# try update in case a records exists (need for wildcard certs)
|
|
if ! _rcode0_rest "PATCH" "/api/v1/acme/zones/$_domain/rrsets" "[{\"changetype\": \"update\", \"name\": \"$fulldomain.\", \"type\": \"TXT\", \"ttl\": $RCODE0_TTL, \"records\": [$_record_string]}]"; then
|
|
_err "Set txt record error."
|
|
return 1
|
|
fi
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
#fulldomain txtvalue
|
|
dns_rcode0_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
RCODE0_API_TOKEN="${RCODE0_API_TOKEN:-$(_readaccountconf_mutable RCODE0_API_TOKEN)}"
|
|
RCODE0_URL="${RCODE0_URL:-$(_readaccountconf_mutable RCODE0_URL)}"
|
|
RCODE0_TTL="${RCODE0_TTL:-$(_readaccountconf_mutable RCODE0_TTL)}"
|
|
|
|
if [ -z "$RCODE0_URL" ]; then
|
|
RCODE0_URL="$DEFAULT_RCODE0_URL"
|
|
fi
|
|
|
|
if [ -z "$RCODE0_API_TOKEN" ]; then
|
|
RCODE0_API_TOKEN=""
|
|
_err "Missing Rcode0 API Token."
|
|
_err "Please login and create your token at httsp://my.rcodezero.at/enableapi and try again."
|
|
return 1
|
|
fi
|
|
|
|
#save the api addr and key to the account conf file.
|
|
_saveaccountconf_mutable RCODE0_URL "$RCODE0_URL"
|
|
_saveaccountconf_mutable RCODE0_API_TOKEN "$RCODE0_API_TOKEN"
|
|
|
|
if [ "$RCODE0_TTL" != "$DEFAULT_RCODE0_TTL" ]; then
|
|
_saveaccountconf_mutable RCODE0_TTL "$RCODE0_TTL"
|
|
fi
|
|
|
|
if [ -z "$RCODE0_TTL" ]; then
|
|
RCODE0_TTL="$DEFAULT_RCODE0_TTL"
|
|
fi
|
|
|
|
_debug "Detect root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
_debug "Remove record"
|
|
|
|
#Enumerate existing acme challenges
|
|
_list_existingchallenges
|
|
|
|
if _contains "$_existing_challenges" "$txtvalue"; then
|
|
#Delete all challenges (PowerDNS API does not allow to delete content)
|
|
if ! _rcode0_rest "PATCH" "/api/v1/acme/zones/$_domain/rrsets" "[{\"changetype\": \"delete\", \"name\": \"$fulldomain.\", \"type\": \"TXT\"}]"; then
|
|
_err "Delete txt record error."
|
|
return 1
|
|
fi
|
|
_record_string=""
|
|
#If the only existing challenge was the challenge to delete: nothing to do
|
|
if ! [ "$_existing_challenges" = "$txtvalue" ]; then
|
|
for oldchallenge in $_existing_challenges; do
|
|
#Build up the challenges to re-add, ommitting the one what should be deleted
|
|
if ! [ "$oldchallenge" = "$txtvalue" ]; then
|
|
_build_record_string "$oldchallenge"
|
|
fi
|
|
done
|
|
#Recreate the existing challenges
|
|
if ! _rcode0_rest "PATCH" "/api/v1/acme/zones/$_domain/rrsets" "[{\"changetype\": \"update\", \"name\": \"$fulldomain.\", \"type\": \"TXT\", \"ttl\": $RCODE0_TTL, \"records\": [$_record_string]}]"; then
|
|
_err "Set txt record error."
|
|
return 1
|
|
fi
|
|
fi
|
|
else
|
|
_info "Record not found, nothing to remove"
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
#_acme-challenge.www.domain.com
|
|
#returns
|
|
# _domain=domain.com
|
|
_get_root() {
|
|
domain=$1
|
|
i=1
|
|
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
|
|
_debug "try to find: $h"
|
|
if _rcode0_rest "GET" "/api/v1/acme/zones/$h"; then
|
|
if [ "$response" = "[\"found\"]" ]; then
|
|
_domain="$h"
|
|
if [ -z "$h" ]; then
|
|
_domain="=2E"
|
|
fi
|
|
return 0
|
|
elif [ "$response" = "[\"not a master domain\"]" ]; then
|
|
return 1
|
|
fi
|
|
fi
|
|
|
|
if [ -z "$h" ]; then
|
|
return 1
|
|
fi
|
|
i=$(_math $i + 1)
|
|
done
|
|
_debug "no matching domain for $domain found"
|
|
|
|
return 1
|
|
}
|
|
|
|
_rcode0_rest() {
|
|
method=$1
|
|
ep=$2
|
|
data=$3
|
|
|
|
export _H1="Authorization: Bearer $RCODE0_API_TOKEN"
|
|
|
|
if [ ! "$method" = "GET" ]; then
|
|
_debug data "$data"
|
|
response="$(_post "$data" "$RCODE0_URL$ep" "" "$method")"
|
|
else
|
|
response="$(_get "$RCODE0_URL$ep")"
|
|
fi
|
|
|
|
if [ "$?" != "0" ]; then
|
|
_err "error $ep"
|
|
return 1
|
|
fi
|
|
_debug2 response "$response"
|
|
|
|
return 0
|
|
}
|
|
|
|
_build_record_string() {
|
|
_record_string="${_record_string:+${_record_string}, }{\"content\": \"\\\"${1}\\\"\", \"disabled\": false}"
|
|
}
|
|
|
|
_list_existingchallenges() {
|
|
_rcode0_rest "GET" "/api/v1/acme/zones/$_domain/rrsets"
|
|
_existing_challenges=$(echo "$response" | _normalizeJson | _egrep_o "\"name\":\"${fulldomain}[^]]*}" | _egrep_o 'content\":\"\\"[^\\]*' | sed -n 's/^content":"\\"//p')
|
|
_debug2 "$_existing_challenges"
|
|
}
|