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>
101 lines
2.8 KiB
Bash
Executable File
101 lines
2.8 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_mydevil_info='MyDevil.net
|
|
MyDevil.net already supports automatic Lets Encrypt certificates,
|
|
except for wildcard domains.
|
|
This script depends on devil command that MyDevil.net provides,
|
|
which means that it works only on server side.
|
|
Site: MyDevil.net
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_mydevil
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2079
|
|
Author: Marcin Konicki <https://ahwayakchih.neoni.net>
|
|
'
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: dns_mydevil_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_mydevil_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
domain=""
|
|
|
|
if ! _exists "devil"; then
|
|
_err "Could not find 'devil' command."
|
|
return 1
|
|
fi
|
|
|
|
_info "Using mydevil"
|
|
|
|
domain=$(mydevil_get_domain "$fulldomain")
|
|
if [ -z "$domain" ]; then
|
|
_err "Invalid domain name: could not find root domain of $fulldomain."
|
|
return 1
|
|
fi
|
|
|
|
# No need to check if record name exists, `devil` always adds new record.
|
|
# In worst case scenario, we end up with multiple identical records.
|
|
|
|
_info "Adding $fulldomain record for domain $domain"
|
|
if devil dns add "$domain" "$fulldomain" TXT "$txtvalue"; then
|
|
_info "Successfully added TXT record, ready for validation."
|
|
return 0
|
|
else
|
|
_err "Unable to add DNS record."
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
#Usage: fulldomain txtvalue
|
|
#Remove the txt record after validation.
|
|
dns_mydevil_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
domain=""
|
|
|
|
if ! _exists "devil"; then
|
|
_err "Could not find 'devil' command."
|
|
return 1
|
|
fi
|
|
|
|
_info "Using mydevil"
|
|
|
|
domain=$(mydevil_get_domain "$fulldomain")
|
|
if [ -z "$domain" ]; then
|
|
_err "Invalid domain name: could not find root domain of $fulldomain."
|
|
return 1
|
|
fi
|
|
|
|
# catch one or more numbers
|
|
num='[0-9][0-9]*'
|
|
# catch one or more whitespace
|
|
w=$(printf '[\t ][\t ]*')
|
|
# catch anything, except newline
|
|
any='.*'
|
|
# filter to make sure we do not delete other records
|
|
validRecords="^${num}${w}${fulldomain}${w}TXT${w}${any}${txtvalue}$"
|
|
for id in $(devil dns list "$domain" | tail -n+2 | grep "${validRecords}" | cut -w -s -f 1); do
|
|
_info "Removing record $id from domain $domain"
|
|
echo "y" | devil dns del "$domain" "$id" || _err "Could not remove DNS record."
|
|
done
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
|
|
# Usage: domain=$(mydevil_get_domain "_acme-challenge.www.domain.com" || _err "Invalid domain name")
|
|
# echo $domain
|
|
mydevil_get_domain() {
|
|
fulldomain=$1
|
|
domain=""
|
|
|
|
for domain in $(devil dns list | cut -w -s -f 1 | tail -n+2); do
|
|
_debug "Checking domain: $domain"
|
|
if _endswith "$fulldomain" "$domain"; then
|
|
_debug "Fulldomain '$fulldomain' matches '$domain'"
|
|
printf -- "%s" "$domain"
|
|
return 0
|
|
fi
|
|
done
|
|
|
|
return 1
|
|
}
|