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>
154 lines
3.3 KiB
Bash
154 lines
3.3 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_fornex_info='Fornex.com
|
|
Site: Fornex.com
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi2#dns_fornex
|
|
Options:
|
|
FORNEX_API_KEY API Key
|
|
Issues: github.com/acmesh-official/acme.sh/issues/3998
|
|
Author: Timur Umarov <inbox@tumarov.com>
|
|
'
|
|
|
|
FORNEX_API_URL="https://fornex.com/api/dns/v0.1"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: dns_fornex_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_fornex_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
if ! _Fornex_API; then
|
|
return 1
|
|
fi
|
|
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "Unable to determine root domain"
|
|
return 1
|
|
else
|
|
_debug _domain "$_domain"
|
|
fi
|
|
|
|
_info "Adding record"
|
|
if _rest POST "$_domain/entry_set/add/" "host=$fulldomain&type=TXT&value=$txtvalue&apikey=$FORNEX_API_KEY"; then
|
|
_debug _response "$response"
|
|
if _contains "$response" '"ok": true' || _contains "$response" 'Такая запись уже существует.'; then
|
|
_info "Added, OK"
|
|
return 0
|
|
fi
|
|
fi
|
|
_err "Add txt record error."
|
|
return 1
|
|
}
|
|
|
|
#Usage: dns_fornex_rm _acme-challenge.www.domain.com
|
|
dns_fornex_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
if ! _Fornex_API; then
|
|
return 1
|
|
fi
|
|
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "Unable to determine root domain"
|
|
return 1
|
|
else
|
|
_debug _domain "$_domain"
|
|
fi
|
|
|
|
_debug "Getting txt records"
|
|
_rest GET "$_domain/entry_set.json?apikey=$FORNEX_API_KEY"
|
|
|
|
if ! _contains "$response" "$txtvalue"; then
|
|
_err "Txt record not found"
|
|
return 1
|
|
fi
|
|
|
|
_record_id="$(echo "$response" | _egrep_o "{[^{]*\"value\"*:*\"$txtvalue\"[^}]*}" | sed -n -e 's#.*"id": \([0-9]*\).*#\1#p')"
|
|
_debug "_record_id" "$_record_id"
|
|
if [ -z "$_record_id" ]; then
|
|
_err "can not find _record_id"
|
|
return 1
|
|
fi
|
|
|
|
if ! _rest POST "$_domain/entry_set/$_record_id/delete/" "apikey=$FORNEX_API_KEY"; then
|
|
_err "Delete record error."
|
|
return 1
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
|
|
#_acme-challenge.www.domain.com
|
|
#returns
|
|
# _sub_domain=_acme-challenge.www
|
|
# _domain=domain.com
|
|
_get_root() {
|
|
domain=$1
|
|
|
|
i=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 ! _rest GET "domain_list.json?q=$h&apikey=$FORNEX_API_KEY"; then
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "\"$h\"" >/dev/null; then
|
|
_domain=$h
|
|
return 0
|
|
else
|
|
_debug "$h not found"
|
|
fi
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
|
|
return 1
|
|
}
|
|
|
|
_Fornex_API() {
|
|
FORNEX_API_KEY="${FORNEX_API_KEY:-$(_readaccountconf_mutable FORNEX_API_KEY)}"
|
|
if [ -z "$FORNEX_API_KEY" ]; then
|
|
FORNEX_API_KEY=""
|
|
|
|
_err "You didn't specify the Fornex API key yet."
|
|
_err "Please create your key and try again."
|
|
|
|
return 1
|
|
fi
|
|
|
|
_saveaccountconf_mutable FORNEX_API_KEY "$FORNEX_API_KEY"
|
|
}
|
|
|
|
#method method action data
|
|
_rest() {
|
|
m=$1
|
|
ep="$2"
|
|
data="$3"
|
|
_debug "$ep"
|
|
|
|
export _H1="Accept: application/json"
|
|
|
|
if [ "$m" != "GET" ]; then
|
|
_debug data "$data"
|
|
response="$(_post "$data" "$FORNEX_API_URL/$ep" "" "$m")"
|
|
else
|
|
response="$(_get "$FORNEX_API_URL/$ep" | _normalizeJson)"
|
|
fi
|
|
|
|
_ret="$?"
|
|
if [ "$_ret" != "0" ]; then
|
|
_err "error $ep"
|
|
return 1
|
|
fi
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|