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>
109 lines
3.1 KiB
Bash
109 lines
3.1 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_kinghost_info='King.host
|
|
Domains: KingHost.net KingHost.com.br
|
|
Site: King.host
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_kinghost
|
|
Options:
|
|
KINGHOST_Username Username
|
|
KINGHOST_Password Password
|
|
Author: Felipe Keller Braz <felipebraz@kinghost.com.br>
|
|
'
|
|
|
|
# KingHost API support #
|
|
# https://api.kinghost.net/doc/ #
|
|
|
|
KING_Api="https://api.kinghost.net/acme"
|
|
|
|
# Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
# Used to add txt record
|
|
dns_kinghost_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
KINGHOST_Username="${KINGHOST_Username:-$(_readaccountconf_mutable KINGHOST_Username)}"
|
|
KINGHOST_Password="${KINGHOST_Password:-$(_readaccountconf_mutable KINGHOST_Password)}"
|
|
if [ -z "$KINGHOST_Username" ] || [ -z "$KINGHOST_Password" ]; then
|
|
KINGHOST_Username=""
|
|
KINGHOST_Password=""
|
|
_err "You don't specify KingHost api password and email yet."
|
|
_err "Please create you key and try again."
|
|
return 1
|
|
fi
|
|
|
|
#save the credentials to the account conf file.
|
|
_saveaccountconf_mutable KINGHOST_Username "$KINGHOST_Username"
|
|
_saveaccountconf_mutable KINGHOST_Password "$KINGHOST_Password"
|
|
|
|
_debug "Getting txt records"
|
|
_kinghost_rest GET "dns" "name=$fulldomain&content=$txtvalue"
|
|
|
|
#This API call returns "status":"ok" if dns record does not exist
|
|
#We are creating a new txt record here, so we expect the "ok" status
|
|
if ! echo "$response" | grep '"status":"ok"' >/dev/null; then
|
|
_err "Error"
|
|
_err "$response"
|
|
return 1
|
|
fi
|
|
|
|
_kinghost_rest POST "dns" "name=$fulldomain&content=$txtvalue"
|
|
if ! echo "$response" | grep '"status":"ok"' >/dev/null; then
|
|
_err "Error"
|
|
_err "$response"
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
# Usage: fulldomain txtvalue
|
|
# Used to remove the txt record after validation
|
|
dns_kinghost_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
KINGHOST_Password="${KINGHOST_Password:-$(_readaccountconf_mutable KINGHOST_Password)}"
|
|
KINGHOST_Username="${KINGHOST_Username:-$(_readaccountconf_mutable KINGHOST_Username)}"
|
|
if [ -z "$KINGHOST_Password" ] || [ -z "$KINGHOST_Username" ]; then
|
|
KINGHOST_Password=""
|
|
KINGHOST_Username=""
|
|
_err "You don't specify KingHost api key and email yet."
|
|
_err "Please create you key and try again."
|
|
return 1
|
|
fi
|
|
|
|
_kinghost_rest DELETE "dns" "name=$fulldomain&content=$txtvalue"
|
|
if ! echo "$response" | grep '"status":"ok"' >/dev/null; then
|
|
_err "Error"
|
|
_err "$response"
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
_kinghost_rest() {
|
|
method=$1
|
|
uri="$2"
|
|
data="$3"
|
|
_debug "$uri"
|
|
|
|
export _H1="X-Auth-Email: $KINGHOST_Username"
|
|
export _H2="X-Auth-Key: $KINGHOST_Password"
|
|
|
|
if [ "$method" != "GET" ]; then
|
|
_debug data "$data"
|
|
response="$(_post "$data" "$KING_Api/$uri.json" "" "$method")"
|
|
else
|
|
response="$(_get "$KING_Api/$uri.json?$data")"
|
|
fi
|
|
|
|
if [ "$?" != "0" ]; then
|
|
_err "error $uri"
|
|
return 1
|
|
fi
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|