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>
199 lines
4.6 KiB
Bash
199 lines
4.6 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_dnsimple_info='DNSimple.com
|
|
Site: DNSimple.com
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_dnsimple
|
|
Options:
|
|
DNSimple_OAUTH_TOKEN OAuth Token
|
|
Issues: github.com/pho3nixf1re/acme.sh/issues
|
|
'
|
|
|
|
DNSimple_API="https://api.dnsimple.com/v2"
|
|
|
|
######## Public functions #####################
|
|
|
|
# Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_dnsimple_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
if [ -z "$DNSimple_OAUTH_TOKEN" ]; then
|
|
DNSimple_OAUTH_TOKEN=""
|
|
_err "You have not set the dnsimple oauth token yet."
|
|
_err "Please visit https://dnsimple.com/user to generate it."
|
|
return 1
|
|
fi
|
|
|
|
# save the oauth token for later
|
|
_saveaccountconf DNSimple_OAUTH_TOKEN "$DNSimple_OAUTH_TOKEN"
|
|
|
|
if ! _get_account_id; then
|
|
_err "failed to retrive account id"
|
|
return 1
|
|
fi
|
|
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
_get_records "$_account_id" "$_domain" "$_sub_domain"
|
|
|
|
_info "Adding record"
|
|
if _dnsimple_rest POST "$_account_id/zones/$_domain/records" "{\"type\":\"TXT\",\"name\":\"$_sub_domain\",\"content\":\"$txtvalue\",\"ttl\":120}"; then
|
|
if printf -- "%s" "$response" | grep "\"name\":\"$_sub_domain\"" >/dev/null; then
|
|
_info "Added"
|
|
return 0
|
|
else
|
|
_err "Unexpected response while adding text record."
|
|
return 1
|
|
fi
|
|
fi
|
|
_err "Add txt record error."
|
|
}
|
|
|
|
# fulldomain
|
|
dns_dnsimple_rm() {
|
|
fulldomain=$1
|
|
|
|
if ! _get_account_id; then
|
|
_err "failed to retrive account id"
|
|
return 1
|
|
fi
|
|
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
_get_records "$_account_id" "$_domain" "$_sub_domain"
|
|
|
|
_extract_record_id "$_records" "$_sub_domain"
|
|
if [ "$_record_id" ]; then
|
|
echo "$_record_id" | while read -r item; do
|
|
if _dnsimple_rest DELETE "$_account_id/zones/$_domain/records/$item"; then
|
|
_info "removed record" "$item"
|
|
return 0
|
|
else
|
|
_err "failed to remove record" "$item"
|
|
return 1
|
|
fi
|
|
done
|
|
fi
|
|
}
|
|
|
|
#################### Private functions bellow ##################################
|
|
# _acme-challenge.www.domain.com
|
|
# returns
|
|
# _sub_domain=_acme-challenge.www
|
|
# _domain=domain.com
|
|
_get_root() {
|
|
domain=$1
|
|
i=2
|
|
previous=1
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
if [ -z "$h" ]; then
|
|
# not valid
|
|
return 1
|
|
fi
|
|
|
|
if ! _dnsimple_rest GET "$_account_id/zones/$h"; then
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" 'not found'; then
|
|
_debug "$h not found"
|
|
else
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$previous)
|
|
_domain="$h"
|
|
|
|
_debug _domain "$_domain"
|
|
_debug _sub_domain "$_sub_domain"
|
|
|
|
return 0
|
|
fi
|
|
|
|
previous="$i"
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|
|
|
|
# returns _account_id
|
|
_get_account_id() {
|
|
_debug "retrive account id"
|
|
if ! _dnsimple_rest GET "whoami"; then
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "\"account\":null"; then
|
|
_err "no account associated with this token"
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "timeout"; then
|
|
_err "timeout retrieving account id"
|
|
return 1
|
|
fi
|
|
|
|
_account_id=$(printf "%s" "$response" | _egrep_o "\"id\":[^,]*,\"email\":" | cut -d: -f2 | cut -d, -f1)
|
|
_debug _account_id "$_account_id"
|
|
|
|
return 0
|
|
}
|
|
|
|
# returns
|
|
# _records
|
|
# _records_count
|
|
_get_records() {
|
|
account_id=$1
|
|
domain=$2
|
|
sub_domain=$3
|
|
|
|
_debug "fetching txt records"
|
|
_dnsimple_rest GET "$account_id/zones/$domain/records?per_page=5000&sort=id:desc"
|
|
|
|
if ! _contains "$response" "\"id\":"; then
|
|
_err "failed to retrieve records"
|
|
return 1
|
|
fi
|
|
|
|
_records_count=$(printf "%s" "$response" | _egrep_o "\"name\":\"$sub_domain\"" | wc -l | _egrep_o "[0-9]+")
|
|
_records=$response
|
|
_debug _records_count "$_records_count"
|
|
}
|
|
|
|
# returns _record_id
|
|
_extract_record_id() {
|
|
_record_id=$(printf "%s" "$_records" | _egrep_o "\"id\":[^,]*,\"zone_id\":\"[^,]*\",\"parent_id\":null,\"name\":\"$_sub_domain\"" | cut -d: -f2 | cut -d, -f1)
|
|
_debug "_record_id" "$_record_id"
|
|
}
|
|
|
|
# returns response
|
|
_dnsimple_rest() {
|
|
method=$1
|
|
path="$2"
|
|
data="$3"
|
|
request_url="$DNSimple_API/$path"
|
|
_debug "$path"
|
|
|
|
export _H1="Accept: application/json"
|
|
export _H2="Authorization: Bearer $DNSimple_OAUTH_TOKEN"
|
|
|
|
if [ "$data" ] || [ "$method" = "DELETE" ]; then
|
|
_H1="Content-Type: application/json"
|
|
_debug data "$data"
|
|
response="$(_post "$data" "$request_url" "" "$method")"
|
|
else
|
|
response="$(_get "$request_url" "" "" "$method")"
|
|
fi
|
|
|
|
if [ "$?" != "0" ]; then
|
|
_err "error $request_url"
|
|
return 1
|
|
fi
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|