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>
63 lines
1.9 KiB
Bash
Executable File
63 lines
1.9 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_doapi_info='Domain-Offensive do.de
|
|
Official LetsEncrypt API for do.de / Domain-Offensive.
|
|
This is different from the dns_do adapter, because dns_do is only usable for enterprise customers.
|
|
This API is also available to private customers/individuals.
|
|
Site: do.de
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_doapi
|
|
Options:
|
|
DO_LETOKEN LetsEncrypt Token
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2057
|
|
'
|
|
|
|
DO_API="https://www.do.de/api/letsencrypt"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_doapi_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
DO_LETOKEN="${DO_LETOKEN:-$(_readaccountconf_mutable DO_LETOKEN)}"
|
|
if [ -z "$DO_LETOKEN" ]; then
|
|
DO_LETOKEN=""
|
|
_err "You didn't configure a do.de API token yet."
|
|
_err "Please set DO_LETOKEN and try again."
|
|
return 1
|
|
fi
|
|
_saveaccountconf_mutable DO_LETOKEN "$DO_LETOKEN"
|
|
|
|
_info "Adding TXT record to ${fulldomain}"
|
|
response="$(_get "$DO_API?token=$DO_LETOKEN&domain=${fulldomain}&value=${txtvalue}")"
|
|
if _contains "${response}" 'success'; then
|
|
return 0
|
|
fi
|
|
_err "Could not create resource record, check logs"
|
|
_err "${response}"
|
|
return 1
|
|
}
|
|
|
|
dns_doapi_rm() {
|
|
fulldomain=$1
|
|
|
|
DO_LETOKEN="${DO_LETOKEN:-$(_readaccountconf_mutable DO_LETOKEN)}"
|
|
if [ -z "$DO_LETOKEN" ]; then
|
|
DO_LETOKEN=""
|
|
_err "You didn't configure a do.de API token yet."
|
|
_err "Please set DO_LETOKEN and try again."
|
|
return 1
|
|
fi
|
|
_saveaccountconf_mutable DO_LETOKEN "$DO_LETOKEN"
|
|
|
|
_info "Deleting resource record $fulldomain"
|
|
response="$(_get "$DO_API?token=$DO_LETOKEN&domain=${fulldomain}&action=delete")"
|
|
if _contains "${response}" 'success'; then
|
|
return 0
|
|
fi
|
|
_err "Could not delete resource record, check logs"
|
|
_err "${response}"
|
|
return 1
|
|
}
|