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>
164 lines
3.8 KiB
Bash
Executable File
164 lines
3.8 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_dpi_info='DNSPod.com
|
|
Site: DNSPod.com
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_dpi
|
|
Options:
|
|
DPI_Id Id
|
|
DPI_Key Key
|
|
'
|
|
|
|
REST_API="https://api.dnspod.com"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_dpi_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
DPI_Id="${DPI_Id:-$(_readaccountconf_mutable DPI_Id)}"
|
|
DPI_Key="${DPI_Key:-$(_readaccountconf_mutable DPI_Key)}"
|
|
if [ -z "$DPI_Id" ] || [ -z "$DPI_Key" ]; then
|
|
DPI_Id=""
|
|
DPI_Key=""
|
|
_err "You don't specify dnspod api key and key id yet."
|
|
_err "Please create you key and try again."
|
|
return 1
|
|
fi
|
|
|
|
#save the api key and email to the account conf file.
|
|
_saveaccountconf_mutable DPI_Id "$DPI_Id"
|
|
_saveaccountconf_mutable DPI_Key "$DPI_Key"
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
add_record "$_domain" "$_sub_domain" "$txtvalue"
|
|
|
|
}
|
|
|
|
#fulldomain txtvalue
|
|
dns_dpi_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
DPI_Id="${DPI_Id:-$(_readaccountconf_mutable DPI_Id)}"
|
|
DPI_Key="${DPI_Key:-$(_readaccountconf_mutable DPI_Key)}"
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
if ! _rest POST "Record.List" "login_token=$DPI_Id,$DPI_Key&format=json&domain_id=$_domain_id&sub_domain=$_sub_domain"; then
|
|
_err "Record.Lis error."
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" 'No records'; then
|
|
_info "Don't need to remove."
|
|
return 0
|
|
fi
|
|
|
|
record_id=$(echo "$response" | tr "{" "\n" | grep -- "$txtvalue" | grep '^"id"' | cut -d : -f 2 | cut -d '"' -f 2)
|
|
_debug record_id "$record_id"
|
|
if [ -z "$record_id" ]; then
|
|
_err "Can not get record id."
|
|
return 1
|
|
fi
|
|
|
|
if ! _rest POST "Record.Remove" "login_token=$DPI_Id,$DPI_Key&format=json&domain_id=$_domain_id&record_id=$record_id"; then
|
|
_err "Record.Remove error."
|
|
return 1
|
|
fi
|
|
|
|
_contains "$response" "Operation successful"
|
|
|
|
}
|
|
|
|
#add the txt record.
|
|
#usage: root sub txtvalue
|
|
add_record() {
|
|
root=$1
|
|
sub=$2
|
|
txtvalue=$3
|
|
fulldomain="$sub.$root"
|
|
|
|
_info "Adding record"
|
|
|
|
if ! _rest POST "Record.Create" "login_token=$DPI_Id,$DPI_Key&format=json&domain_id=$_domain_id&sub_domain=$_sub_domain&record_type=TXT&value=$txtvalue&record_line=default"; then
|
|
return 1
|
|
fi
|
|
|
|
_contains "$response" "Operation successful" || _contains "$response" "Domain record already exists"
|
|
}
|
|
|
|
#################### 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)
|
|
if [ -z "$h" ]; then
|
|
#not valid
|
|
return 1
|
|
fi
|
|
|
|
if ! _rest POST "Domain.Info" "login_token=$DPI_Id,$DPI_Key&format=json&domain=$h"; then
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "Operation successful"; then
|
|
_domain_id=$(printf "%s\n" "$response" | _egrep_o "\"id\":\"[^\"]*\"" | cut -d : -f 2 | tr -d \")
|
|
_debug _domain_id "$_domain_id"
|
|
if [ "$_domain_id" ]; then
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_debug _sub_domain "$_sub_domain"
|
|
_domain="$h"
|
|
_debug _domain "$_domain"
|
|
return 0
|
|
fi
|
|
return 1
|
|
fi
|
|
p="$i"
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|
|
|
|
#Usage: method URI data
|
|
_rest() {
|
|
m="$1"
|
|
ep="$2"
|
|
data="$3"
|
|
_debug "$ep"
|
|
url="$REST_API/$ep"
|
|
|
|
_debug url "$url"
|
|
|
|
if [ "$m" = "GET" ]; then
|
|
response="$(_get "$url" | tr -d '\r')"
|
|
else
|
|
_debug2 data "$data"
|
|
response="$(_post "$data" "$url" | tr -d '\r')"
|
|
fi
|
|
|
|
if [ "$?" != "0" ]; then
|
|
_err "error $ep"
|
|
return 1
|
|
fi
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|