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>
179 lines
4.7 KiB
Bash
Executable File
179 lines
4.7 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_namecom_info='Name.com
|
|
Site: Name.com
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_namecom
|
|
Options:
|
|
Namecom_Username Username
|
|
Namecom_Token API Token
|
|
Author: RaidenII
|
|
'
|
|
|
|
######## Public functions #####################
|
|
|
|
Namecom_API="https://api.name.com/v4"
|
|
|
|
#Usage: dns_namecom_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_namecom_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
Namecom_Username="${Namecom_Username:-$(_readaccountconf_mutable Namecom_Username)}"
|
|
Namecom_Token="${Namecom_Token:-$(_readaccountconf_mutable Namecom_Token)}"
|
|
# First we need name.com credentials.
|
|
if [ -z "$Namecom_Username" ]; then
|
|
Namecom_Username=""
|
|
_err "Username for name.com is missing."
|
|
_err "Please specify that in your environment variable."
|
|
return 1
|
|
fi
|
|
|
|
if [ -z "$Namecom_Token" ]; then
|
|
Namecom_Token=""
|
|
_err "API token for name.com is missing."
|
|
_err "Please specify that in your environment variable."
|
|
return 1
|
|
fi
|
|
_debug Namecom_Username "$Namecom_Username"
|
|
_secure_debug Namecom_Token "$Namecom_Token"
|
|
# Save them in configuration.
|
|
_saveaccountconf_mutable Namecom_Username "$Namecom_Username"
|
|
_saveaccountconf_mutable Namecom_Token "$Namecom_Token"
|
|
|
|
# Login in using API
|
|
if ! _namecom_login; then
|
|
return 1
|
|
fi
|
|
|
|
# Find domain in domain list.
|
|
if ! _namecom_get_root "$fulldomain"; then
|
|
_err "Unable to find domain specified."
|
|
return 1
|
|
fi
|
|
|
|
# Add TXT record.
|
|
_namecom_addtxt_json="{\"host\":\"$_sub_domain\",\"type\":\"TXT\",\"answer\":\"$txtvalue\",\"ttl\":\"300\"}"
|
|
if _namecom_rest POST "domains/$_domain/records" "$_namecom_addtxt_json"; then
|
|
_retvalue=$(echo "$response" | _egrep_o "\"$_sub_domain\"")
|
|
if [ "$_retvalue" ]; then
|
|
_info "Successfully added TXT record, ready for validation."
|
|
return 0
|
|
else
|
|
_err "Unable to add the DNS record."
|
|
return 1
|
|
fi
|
|
fi
|
|
}
|
|
|
|
#Usage: fulldomain txtvalue
|
|
#Remove the txt record after validation.
|
|
dns_namecom_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
Namecom_Username="${Namecom_Username:-$(_readaccountconf_mutable Namecom_Username)}"
|
|
Namecom_Token="${Namecom_Token:-$(_readaccountconf_mutable Namecom_Token)}"
|
|
if ! _namecom_login; then
|
|
return 1
|
|
fi
|
|
|
|
# Find domain in domain list.
|
|
if ! _namecom_get_root "$fulldomain"; then
|
|
_err "Unable to find domain specified."
|
|
return 1
|
|
fi
|
|
|
|
# Get the record id.
|
|
if _namecom_rest GET "domains/$_domain/records"; then
|
|
_record_id=$(echo "$response" | _egrep_o "\"id\":[0-9]+,\"domainName\":\"$_domain\",\"host\":\"$_sub_domain\",\"fqdn\":\"$fulldomain.\",\"type\":\"TXT\",\"answer\":\"$txtvalue\"" | cut -d \" -f 3 | _egrep_o [0-9]+)
|
|
_debug record_id "$_record_id"
|
|
if [ "$_record_id" ]; then
|
|
_info "Successfully retrieved the record id for ACME challenge."
|
|
else
|
|
_err "Unable to retrieve the record id."
|
|
return 1
|
|
fi
|
|
fi
|
|
|
|
# Remove the DNS record using record id.
|
|
if _namecom_rest DELETE "domains/$_domain/records/$_record_id"; then
|
|
_info "Successfully removed the TXT record."
|
|
return 0
|
|
else
|
|
_err "Unable to delete record id."
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
_namecom_rest() {
|
|
method=$1
|
|
param=$2
|
|
data=$3
|
|
|
|
export _H1="Authorization: Basic $_namecom_auth"
|
|
export _H2="Content-Type: application/json"
|
|
|
|
if [ "$method" != "GET" ]; then
|
|
response="$(_post "$data" "$Namecom_API/$param" "" "$method")"
|
|
else
|
|
response="$(_get "$Namecom_API/$param")"
|
|
fi
|
|
|
|
if [ "$?" != "0" ]; then
|
|
_err "error $param"
|
|
return 1
|
|
fi
|
|
|
|
_debug2 response "$response"
|
|
return 0
|
|
}
|
|
|
|
_namecom_login() {
|
|
# Auth string
|
|
# Name.com API v4 uses http basic auth to authenticate
|
|
# need to convert the token for http auth
|
|
_namecom_auth=$(printf "%s:%s" "$Namecom_Username" "$Namecom_Token" | _base64)
|
|
|
|
if _namecom_rest GET "hello"; then
|
|
retcode=$(echo "$response" | _egrep_o "\"username\"\:\"$Namecom_Username\"")
|
|
if [ "$retcode" ]; then
|
|
_info "Successfully logged in."
|
|
else
|
|
_err "$response"
|
|
_err "Please add your ip to api whitelist"
|
|
_err "Logging in failed."
|
|
return 1
|
|
fi
|
|
fi
|
|
}
|
|
|
|
_namecom_get_root() {
|
|
domain=$1
|
|
i=2
|
|
p=1
|
|
|
|
if ! _namecom_rest GET "domains"; then
|
|
return 1
|
|
fi
|
|
|
|
# Need to exclude the last field (tld)
|
|
numfields=$(echo "$domain" | _egrep_o "\." | wc -l)
|
|
while [ $i -le "$numfields" ]; do
|
|
host=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
_debug host "$host"
|
|
if [ -z "$host" ]; then
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "$host"; then
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_domain="$host"
|
|
return 0
|
|
fi
|
|
p=$i
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|