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>
149 lines
4.6 KiB
Bash
149 lines
4.6 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_kappernet_info='kapper.net
|
|
Site: kapper.net
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi2#dns_kappernet
|
|
Options:
|
|
KAPPERNETDNS_Key API Key
|
|
KAPPERNETDNS_Secret API Secret
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2977
|
|
'
|
|
|
|
###############################################################################
|
|
# called with
|
|
# fullhostname: something.example.com
|
|
# txtvalue: someacmegenerated string
|
|
dns_kappernet_add() {
|
|
fullhostname=$1
|
|
txtvalue=$2
|
|
|
|
KAPPERNETDNS_Key="${KAPPERNETDNS_Key:-$(_readaccountconf_mutable KAPPERNETDNS_Key)}"
|
|
KAPPERNETDNS_Secret="${KAPPERNETDNS_Secret:-$(_readaccountconf_mutable KAPPERNETDNS_Secret)}"
|
|
KAPPERNETDNS_Api="https://dnspanel.kapper.net/API/1.2?APIKey=$KAPPERNETDNS_Key&APISecret=$KAPPERNETDNS_Secret"
|
|
|
|
if [ -z "$KAPPERNETDNS_Key" ] || [ -z "$KAPPERNETDNS_Secret" ]; then
|
|
_err "Please specify your kapper.net api key and secret."
|
|
_err "If you have not received yours - send your mail to"
|
|
_err "support@kapper.net to get your key and secret."
|
|
return 1
|
|
fi
|
|
|
|
#store the api key and email to the account conf file.
|
|
_saveaccountconf_mutable KAPPERNETDNS_Key "$KAPPERNETDNS_Key"
|
|
_saveaccountconf_mutable KAPPERNETDNS_Secret "$KAPPERNETDNS_Secret"
|
|
_debug "Checking Domain ..."
|
|
if ! _get_root "$fullhostname"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
_debug _sub_domain "SUBDOMAIN: $_sub_domain"
|
|
_debug _domain "DOMAIN: $_domain"
|
|
|
|
_info "Trying to add TXT DNS Record"
|
|
data="%7B%22name%22%3A%22$fullhostname%22%2C%22type%22%3A%22TXT%22%2C%22content%22%3A%22$txtvalue%22%2C%22ttl%22%3A%22300%22%2C%22prio%22%3A%22%22%7D"
|
|
if _kappernet_api GET "action=new&subject=$_domain&data=$data"; then
|
|
|
|
if _contains "$response" "{\"OK\":true"; then
|
|
_info "Waiting 1 second for DNS to spread the new record"
|
|
_sleep 1
|
|
return 0
|
|
else
|
|
_err "Error creating a TXT DNS Record: $fullhostname TXT $txtvalue"
|
|
_err "Error Message: $response"
|
|
return 1
|
|
fi
|
|
fi
|
|
_err "Failed creating TXT Record"
|
|
}
|
|
|
|
###############################################################################
|
|
# called with
|
|
# fullhostname: something.example.com
|
|
dns_kappernet_rm() {
|
|
fullhostname=$1
|
|
txtvalue=$2
|
|
|
|
KAPPERNETDNS_Key="${KAPPERNETDNS_Key:-$(_readaccountconf_mutable KAPPERNETDNS_Key)}"
|
|
KAPPERNETDNS_Secret="${KAPPERNETDNS_Secret:-$(_readaccountconf_mutable KAPPERNETDNS_Secret)}"
|
|
KAPPERNETDNS_Api="https://dnspanel.kapper.net/API/1.2?APIKey=$KAPPERNETDNS_Key&APISecret=$KAPPERNETDNS_Secret"
|
|
|
|
if [ -z "$KAPPERNETDNS_Key" ] || [ -z "$KAPPERNETDNS_Secret" ]; then
|
|
_err "Please specify your kapper.net api key and secret."
|
|
_err "If you have not received yours - send your mail to"
|
|
_err "support@kapper.net to get your key and secret."
|
|
return 1
|
|
fi
|
|
|
|
#store the api key and email to the account conf file.
|
|
_saveaccountconf_mutable KAPPERNETDNS_Key "$KAPPERNETDNS_Key"
|
|
_saveaccountconf_mutable KAPPERNETDNS_Secret "$KAPPERNETDNS_Secret"
|
|
|
|
_info "Trying to remove the TXT Record: $fullhostname containing $txtvalue"
|
|
data="%7B%22name%22%3A%22$fullhostname%22%2C%22type%22%3A%22TXT%22%2C%22content%22%3A%22$txtvalue%22%2C%22ttl%22%3A%22300%22%2C%22prio%22%3A%22%22%7D"
|
|
if _kappernet_api GET "action=del&subject=$fullhostname&data=$data"; then
|
|
if _contains "$response" "{\"OK\":true"; then
|
|
return 0
|
|
else
|
|
_err "Error deleting DNS Record: $fullhostname containing $txtvalue"
|
|
_err "Problem: $response"
|
|
return 1
|
|
fi
|
|
fi
|
|
_err "Problem deleting TXT DNS record"
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
# called with hostname
|
|
# e.g._acme-challenge.www.domain.com returns
|
|
# _sub_domain=_acme-challenge.www
|
|
# _domain=domain.com
|
|
_get_root() {
|
|
domain=$1
|
|
i=2
|
|
p=1
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
if [ -z "$h" ]; then
|
|
#not valid
|
|
return 1
|
|
fi
|
|
if ! _kappernet_api GET "action=list&subject=$h"; then
|
|
return 1
|
|
fi
|
|
if _contains "$response" '"OK":false'; then
|
|
_debug "$h not found"
|
|
else
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_domain="$h"
|
|
return 0
|
|
fi
|
|
p="$i"
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|
|
|
|
################################################################################
|
|
# calls the kapper.net DNS Panel API
|
|
# with
|
|
# method
|
|
# param
|
|
_kappernet_api() {
|
|
method=$1
|
|
param="$2"
|
|
|
|
_debug param "PARAMETER=$param"
|
|
url="$KAPPERNETDNS_Api&$param"
|
|
_debug url "URL=$url"
|
|
|
|
if [ "$method" = "GET" ]; then
|
|
response="$(_get "$url")"
|
|
else
|
|
_err "Unsupported method or missing Secret/Key"
|
|
return 1
|
|
fi
|
|
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|