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>
172 lines
4.8 KiB
Bash
172 lines
4.8 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_ultra_info='UltraDNS.com
|
|
Site: UltraDNS.com
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_ultra
|
|
Options:
|
|
ULTRA_USR Username
|
|
ULTRA_PWD Password
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2118
|
|
'
|
|
|
|
ULTRA_API="https://api.ultradns.com/v3/"
|
|
ULTRA_AUTH_API="https://api.ultradns.com/v2/"
|
|
|
|
#Usage: add _acme-challenge.www.domain.com "some_long_string_of_characters_go_here_from_lets_encrypt"
|
|
dns_ultra_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
export txtvalue
|
|
ULTRA_USR="${ULTRA_USR:-$(_readaccountconf_mutable ULTRA_USR)}"
|
|
ULTRA_PWD="${ULTRA_PWD:-$(_readaccountconf_mutable ULTRA_PWD)}"
|
|
if [ -z "$ULTRA_USR" ] || [ -z "$ULTRA_PWD" ]; then
|
|
ULTRA_USR=""
|
|
ULTRA_PWD=""
|
|
_err "You didn't specify an UltraDNS username and password yet"
|
|
return 1
|
|
fi
|
|
# save the username and password to the account conf file.
|
|
_saveaccountconf_mutable ULTRA_USR "$ULTRA_USR"
|
|
_saveaccountconf_mutable ULTRA_PWD "$ULTRA_PWD"
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
_debug _domain_id "${_domain_id}"
|
|
_debug _sub_domain "${_sub_domain}"
|
|
_debug _domain "${_domain}"
|
|
_debug "Getting txt records"
|
|
_ultra_rest GET "zones/${_domain_id}/rrsets/TXT?q=value:${fulldomain}"
|
|
if printf "%s" "$response" | grep \"totalCount\" >/dev/null; then
|
|
_err "Error, it would appear that this record already exists. Please review existing TXT records for this domain."
|
|
return 1
|
|
fi
|
|
|
|
_info "Adding record"
|
|
if _ultra_rest POST "zones/$_domain_id/rrsets/TXT/${_sub_domain}" '{"ttl":300,"rdata":["'"${txtvalue}"'"]}'; then
|
|
if _contains "$response" "Successful"; then
|
|
_info "Added, OK"
|
|
return 0
|
|
elif _contains "$response" "Resource Record of type 16 with these attributes already exists"; then
|
|
_info "Already exists, OK"
|
|
return 0
|
|
else
|
|
_err "Add txt record error."
|
|
return 1
|
|
fi
|
|
fi
|
|
_err "Add txt record error."
|
|
|
|
}
|
|
|
|
dns_ultra_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
export txtvalue
|
|
ULTRA_USR="${ULTRA_USR:-$(_readaccountconf_mutable ULTRA_USR)}"
|
|
ULTRA_PWD="${ULTRA_PWD:-$(_readaccountconf_mutable ULTRA_PWD)}"
|
|
if [ -z "$ULTRA_USR" ] || [ -z "$ULTRA_PWD" ]; then
|
|
ULTRA_USR=""
|
|
ULTRA_PWD=""
|
|
_err "You didn't specify an UltraDNS username and password yet"
|
|
return 1
|
|
fi
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
_debug _domain_id "${_domain_id}"
|
|
_debug _sub_domain "${_sub_domain}"
|
|
_debug _domain "${domain}"
|
|
|
|
_debug "Getting TXT records"
|
|
_ultra_rest GET "zones/${_domain_id}/rrsets?q=kind:RECORDS+owner:${_sub_domain}"
|
|
|
|
if ! printf "%s" "$response" | grep \"resultInfo\" >/dev/null; then
|
|
_err "There was an error in obtaining the resource records for ${_domain_id}"
|
|
return 1
|
|
fi
|
|
|
|
count=$(echo "$response" | _egrep_o "\"returnedCount\":[^,]*" | cut -d: -f2 | cut -d'}' -f1)
|
|
_debug count "${count}"
|
|
if [ "${count}" = "" ]; then
|
|
_info "Text record is not present, will not delete anything."
|
|
else
|
|
if ! _ultra_rest DELETE "zones/$_domain_id/rrsets/TXT/${_sub_domain}" '{"ttl":300,"rdata":["'"${txtvalue}"'"]}'; then
|
|
_err "Deleting the record did not succeed, please verify/check."
|
|
return 1
|
|
fi
|
|
_contains "$response" ""
|
|
fi
|
|
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
#_acme-challenge.www.domain.com
|
|
#returns
|
|
# _sub_domain=_acme-challenge.www
|
|
# _domain=domain.com
|
|
# _domain_id=sdjkglgdfewsdfg
|
|
_get_root() {
|
|
domain=$1
|
|
i=2
|
|
p=1
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
_debug h "$h"
|
|
_debug response "$response"
|
|
if [ -z "$h" ]; then
|
|
#not valid
|
|
return 1
|
|
fi
|
|
if ! _ultra_rest GET "zones"; then
|
|
return 1
|
|
fi
|
|
if _contains "${response}" "${h}." >/dev/null; then
|
|
_domain_id=$(echo "$response" | _egrep_o "${h}" | head -1)
|
|
if [ "$_domain_id" ]; then
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_domain="${h}"
|
|
_debug sub_domain "${_sub_domain}"
|
|
_debug domain "${_domain}"
|
|
return 0
|
|
fi
|
|
return 1
|
|
fi
|
|
p=$i
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|
|
|
|
_ultra_rest() {
|
|
m=$1
|
|
ep="$2"
|
|
data="$3"
|
|
_debug "$ep"
|
|
if [ -z "$AUTH_TOKEN" ]; then
|
|
_ultra_login
|
|
fi
|
|
_debug TOKEN "$AUTH_TOKEN"
|
|
|
|
export _H1="Content-Type: application/json"
|
|
export _H2="Authorization: Bearer $AUTH_TOKEN"
|
|
|
|
if [ "$m" != "GET" ]; then
|
|
_debug data "$data"
|
|
response="$(_post "$data" "$ULTRA_API$ep" "" "$m")"
|
|
else
|
|
response="$(_get "$ULTRA_API$ep")"
|
|
fi
|
|
}
|
|
|
|
_ultra_login() {
|
|
export _H1=""
|
|
export _H2=""
|
|
AUTH_TOKEN=$(_post "grant_type=password&username=${ULTRA_USR}&password=${ULTRA_PWD}" "${ULTRA_AUTH_API}authorization/token" | cut -d, -f3 | cut -d\" -f4)
|
|
export AUTH_TOKEN
|
|
}
|