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>
200 lines
5.1 KiB
Bash
200 lines
5.1 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_desec_info='deSEC.io
|
|
Site: desec.readthedocs.io/en/latest/
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_desec
|
|
Options:
|
|
DDNSS_Token API Token
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2180
|
|
Author: Zheng Qian
|
|
'
|
|
|
|
REST_API="https://desec.io/api/v1/domains"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: dns_desec_add _acme-challenge.foobar.dedyn.io "d41d8cd98f00b204e9800998ecf8427e"
|
|
dns_desec_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
_info "Using desec.io api"
|
|
_debug fulldomain "$fulldomain"
|
|
_debug txtvalue "$txtvalue"
|
|
|
|
DEDYN_TOKEN="${DEDYN_TOKEN:-$(_readaccountconf_mutable DEDYN_TOKEN)}"
|
|
|
|
if [ -z "$DEDYN_TOKEN" ]; then
|
|
DEDYN_TOKEN=""
|
|
_err "You did not specify DEDYN_TOKEN yet."
|
|
_err "Please create your key and try again."
|
|
_err "e.g."
|
|
_err "export DEDYN_TOKEN=d41d8cd98f00b204e9800998ecf8427e"
|
|
return 1
|
|
fi
|
|
#save the api token to the account conf file.
|
|
_saveaccountconf_mutable DEDYN_TOKEN "$DEDYN_TOKEN"
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain" "$REST_API/"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
# Get existing TXT record
|
|
_debug "Getting txt records"
|
|
txtvalues="\"\\\"$txtvalue\\\"\""
|
|
_desec_rest GET "$REST_API/$_domain/rrsets/$_sub_domain/TXT/"
|
|
|
|
if [ "$_code" = "200" ]; then
|
|
oldtxtvalues="$(echo "$response" | _egrep_o "\"records\":\\[\"\\S*\"\\]" | cut -d : -f 2 | tr -d "[]\\\\\"" | sed "s/,/ /g")"
|
|
_debug "existing TXT found"
|
|
_debug oldtxtvalues "$oldtxtvalues"
|
|
if [ -n "$oldtxtvalues" ]; then
|
|
for oldtxtvalue in $oldtxtvalues; do
|
|
txtvalues="$txtvalues, \"\\\"$oldtxtvalue\\\"\""
|
|
done
|
|
fi
|
|
fi
|
|
_debug txtvalues "$txtvalues"
|
|
_info "Adding record"
|
|
body="[{\"subname\":\"$_sub_domain\", \"type\":\"TXT\", \"records\":[$txtvalues], \"ttl\":3600}]"
|
|
|
|
if _desec_rest PUT "$REST_API/$_domain/rrsets/" "$body"; then
|
|
if _contains "$response" "$txtvalue"; then
|
|
_info "Added, OK"
|
|
return 0
|
|
else
|
|
_err "Add txt record error."
|
|
return 1
|
|
fi
|
|
fi
|
|
|
|
_err "Add txt record error."
|
|
return 1
|
|
}
|
|
|
|
#Usage: fulldomain txtvalue
|
|
#Remove the txt record after validation.
|
|
dns_desec_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
_info "Using desec.io api"
|
|
_debug fulldomain "$fulldomain"
|
|
_debug txtvalue "$txtvalue"
|
|
|
|
DEDYN_TOKEN="${DEDYN_TOKEN:-$(_readaccountconf_mutable DEDYN_TOKEN)}"
|
|
|
|
if [ -z "$DEDYN_TOKEN" ]; then
|
|
DEDYN_TOKEN=""
|
|
_err "You did not specify DEDYN_TOKEN yet."
|
|
_err "Please create your key and try again."
|
|
_err "e.g."
|
|
_err "export DEDYN_TOKEN=d41d8cd98f00b204e9800998ecf8427e"
|
|
return 1
|
|
fi
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain" "$REST_API/"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
# Get existing TXT record
|
|
_debug "Getting txt records"
|
|
txtvalues=""
|
|
_desec_rest GET "$REST_API/$_domain/rrsets/$_sub_domain/TXT/"
|
|
|
|
if [ "$_code" = "200" ]; then
|
|
oldtxtvalues="$(echo "$response" | _egrep_o "\"records\":\\[\"\\S*\"\\]" | cut -d : -f 2 | tr -d "[]\\\\\"" | sed "s/,/ /g")"
|
|
_debug "existing TXT found"
|
|
_debug oldtxtvalues "$oldtxtvalues"
|
|
if [ -n "$oldtxtvalues" ]; then
|
|
for oldtxtvalue in $oldtxtvalues; do
|
|
if [ "$txtvalue" != "$oldtxtvalue" ]; then
|
|
txtvalues="$txtvalues, \"\\\"$oldtxtvalue\\\"\""
|
|
fi
|
|
done
|
|
fi
|
|
fi
|
|
txtvalues="$(echo "$txtvalues" | cut -c3-)"
|
|
_debug txtvalues "$txtvalues"
|
|
|
|
_info "Deleting record"
|
|
body="[{\"subname\":\"$_sub_domain\", \"type\":\"TXT\", \"records\":[$txtvalues], \"ttl\":3600}]"
|
|
_desec_rest PUT "$REST_API/$_domain/rrsets/" "$body"
|
|
if [ "$_code" = "200" ]; then
|
|
_info "Deleted, OK"
|
|
return 0
|
|
fi
|
|
|
|
_err "Delete txt record error."
|
|
return 1
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
|
|
_desec_rest() {
|
|
m="$1"
|
|
ep="$2"
|
|
data="$3"
|
|
|
|
export _H1="Authorization: Token $DEDYN_TOKEN"
|
|
export _H2="Accept: application/json"
|
|
export _H3="Content-Type: application/json"
|
|
|
|
if [ "$m" != "GET" ]; then
|
|
_secure_debug2 data "$data"
|
|
response="$(_post "$data" "$ep" "" "$m")"
|
|
else
|
|
response="$(_get "$ep")"
|
|
fi
|
|
_ret="$?"
|
|
_code="$(grep "^HTTP" "$HTTP_HEADER" | _tail_n 1 | cut -d " " -f 2 | tr -d "\\r\\n")"
|
|
_debug "http response code $_code"
|
|
_secure_debug2 response "$response"
|
|
if [ "$_ret" != "0" ]; then
|
|
_err "error $ep"
|
|
return 1
|
|
fi
|
|
|
|
response="$(printf "%s" "$response" | _normalizeJson)"
|
|
return 0
|
|
}
|
|
|
|
#_acme-challenge.www.domain.com
|
|
#returns
|
|
# _sub_domain=_acme-challenge.www
|
|
# _domain=domain.com
|
|
_get_root() {
|
|
domain="$1"
|
|
ep="$2"
|
|
i=2
|
|
p=1
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
_debug h "$h"
|
|
if [ -z "$h" ]; then
|
|
#not valid
|
|
return 1
|
|
fi
|
|
|
|
if ! _desec_rest GET "$ep"; then
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "\"name\":\"$h\"" >/dev/null; then
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_domain=$h
|
|
return 0
|
|
fi
|
|
p=$i
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|