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>
270 lines
8.6 KiB
Bash
Executable File
270 lines
8.6 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_1984hosting_info='1984.hosting
|
|
Domains: 1984.is
|
|
Site: 1984.hosting
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi2#dns_1984hosting
|
|
Options:
|
|
One984HOSTING_Username Username
|
|
One984HOSTING_Password Password
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2851
|
|
Author: Adrian Fedoreanu
|
|
'
|
|
|
|
######## Public functions #####################
|
|
|
|
# Usage: dns_1984hosting_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
# Add a text record.
|
|
dns_1984hosting_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
_info "Add TXT record using 1984Hosting."
|
|
_debug fulldomain "$fulldomain"
|
|
_debug txtvalue "$txtvalue"
|
|
|
|
if ! _1984hosting_login; then
|
|
_err "1984Hosting login failed for user $One984HOSTING_Username. Check $HTTP_HEADER file."
|
|
return 1
|
|
fi
|
|
|
|
_debug "First detect the root zone."
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "Invalid domain '$fulldomain'."
|
|
return 1
|
|
fi
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
_debug "Add TXT record $fulldomain with value '$txtvalue'."
|
|
value="$(printf '%s' "$txtvalue" | _url_encode)"
|
|
url="https://1984.hosting/domains/entry/"
|
|
|
|
postdata="entry=new"
|
|
postdata="$postdata&type=TXT"
|
|
postdata="$postdata&ttl=900"
|
|
postdata="$postdata&zone=$_domain"
|
|
postdata="$postdata&host=$_sub_domain"
|
|
postdata="$postdata&rdata=%22$value%22"
|
|
_debug2 postdata "$postdata"
|
|
|
|
_authpost "$postdata" "$url"
|
|
if _contains "$_response" '"haserrors": true'; then
|
|
_err "1984Hosting failed to add TXT record for $_sub_domain bad RC from _post."
|
|
return 1
|
|
elif _contains "$_response" "html>"; then
|
|
_err "1984Hosting failed to add TXT record for $_sub_domain. Check $HTTP_HEADER file."
|
|
return 1
|
|
elif _contains "$_response" '"auth": false'; then
|
|
_err "1984Hosting failed to add TXT record for $_sub_domain. Invalid or expired cookie."
|
|
return 1
|
|
fi
|
|
|
|
_info "Added acme challenge TXT record for $fulldomain at 1984Hosting."
|
|
return 0
|
|
}
|
|
|
|
# Usage: fulldomain txtvalue
|
|
# Remove the txt record after validation.
|
|
dns_1984hosting_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
_info "Delete TXT record using 1984Hosting."
|
|
_debug fulldomain "$fulldomain"
|
|
_debug txtvalue "$txtvalue"
|
|
|
|
if ! _1984hosting_login; then
|
|
_err "1984Hosting login failed for user $One984HOSTING_Username. Check $HTTP_HEADER file."
|
|
return 1
|
|
fi
|
|
|
|
_debug "First detect the root zone."
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "Invalid domain '$fulldomain'."
|
|
return 1
|
|
fi
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
_debug "Delete $fulldomain TXT record."
|
|
|
|
url="https://1984.hosting/domains"
|
|
if ! _get_zone_id "$url" "$_domain"; then
|
|
_err "Invalid zone '$_domain'."
|
|
return 1
|
|
fi
|
|
|
|
_htmlget "$url/$_zone_id" "$txtvalue"
|
|
entry_id="$(echo "$_response" | _egrep_o 'entry_[0-9]+' | sed 's/entry_//')"
|
|
_debug2 entry_id "$entry_id"
|
|
if [ -z "$entry_id" ]; then
|
|
_err "Error getting TXT entry_id for $1."
|
|
return 1
|
|
fi
|
|
|
|
_authpost "entry=$entry_id" "$url/delentry/"
|
|
if ! _contains "$_response" '"ok": true'; then
|
|
_err "1984Hosting failed to delete TXT record for $entry_id bad RC from _post."
|
|
return 1
|
|
fi
|
|
|
|
_info "Deleted acme challenge TXT record for $fulldomain at 1984Hosting."
|
|
return 0
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
_1984hosting_login() {
|
|
if ! _check_credentials; then return 1; fi
|
|
|
|
if _check_cookies; then
|
|
_debug "Already logged in."
|
|
return 0
|
|
fi
|
|
|
|
_debug "Login to 1984Hosting as user $One984HOSTING_Username."
|
|
username=$(printf '%s' "$One984HOSTING_Username" | _url_encode)
|
|
password=$(printf '%s' "$One984HOSTING_Password" | _url_encode)
|
|
url="https://1984.hosting/api/auth/"
|
|
|
|
_get "https://1984.hosting/accounts/login/" | grep "csrfmiddlewaretoken"
|
|
csrftoken="$(grep -i '^set-cookie:' "$HTTP_HEADER" | _egrep_o 'csrftoken=[^;]*;' | tr -d ';')"
|
|
sessionid="$(grep -i '^set-cookie:' "$HTTP_HEADER" | _egrep_o 'sessionid=[^;]*;' | tr -d ';')"
|
|
|
|
if [ -z "$csrftoken" ] || [ -z "$sessionid" ]; then
|
|
_err "One or more cookies are empty: '$csrftoken', '$sessionid'."
|
|
return 1
|
|
fi
|
|
|
|
export _H1="Cookie: $csrftoken; $sessionid"
|
|
export _H2="Referer: https://1984.hosting/accounts/login/"
|
|
csrf_header=$(echo "$csrftoken" | sed 's/csrftoken=//' | _head_n 1)
|
|
export _H3="X-CSRFToken: $csrf_header"
|
|
|
|
response="$(_post "username=$username&password=$password&otpkey=" $url)"
|
|
response="$(echo "$response" | _normalizeJson)"
|
|
_debug2 response "$response"
|
|
|
|
if _contains "$response" '"loggedin": true'; then
|
|
One984HOSTING_SESSIONID_COOKIE="$(grep -i '^set-cookie:' "$HTTP_HEADER" | _egrep_o 'sessionid=[^;]*;' | tr -d ';')"
|
|
One984HOSTING_CSRFTOKEN_COOKIE="$(grep -i '^set-cookie:' "$HTTP_HEADER" | _egrep_o 'csrftoken=[^;]*;' | tr -d ';')"
|
|
export One984HOSTING_SESSIONID_COOKIE
|
|
export One984HOSTING_CSRFTOKEN_COOKIE
|
|
_saveaccountconf_mutable One984HOSTING_Username "$One984HOSTING_Username"
|
|
_saveaccountconf_mutable One984HOSTING_Password "$One984HOSTING_Password"
|
|
_saveaccountconf_mutable One984HOSTING_SESSIONID_COOKIE "$One984HOSTING_SESSIONID_COOKIE"
|
|
_saveaccountconf_mutable One984HOSTING_CSRFTOKEN_COOKIE "$One984HOSTING_CSRFTOKEN_COOKIE"
|
|
return 0
|
|
fi
|
|
return 1
|
|
}
|
|
|
|
_check_credentials() {
|
|
One984HOSTING_Username="${One984HOSTING_Username:-$(_readaccountconf_mutable One984HOSTING_Username)}"
|
|
One984HOSTING_Password="${One984HOSTING_Password:-$(_readaccountconf_mutable One984HOSTING_Password)}"
|
|
if [ -z "$One984HOSTING_Username" ] || [ -z "$One984HOSTING_Password" ]; then
|
|
One984HOSTING_Username=""
|
|
One984HOSTING_Password=""
|
|
_clearaccountconf_mutable One984HOSTING_Username
|
|
_clearaccountconf_mutable One984HOSTING_Password
|
|
_err "You haven't specified 1984Hosting username or password yet."
|
|
_err "Please export as One984HOSTING_Username / One984HOSTING_Password and try again."
|
|
return 1
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
_check_cookies() {
|
|
One984HOSTING_SESSIONID_COOKIE="${One984HOSTING_SESSIONID_COOKIE:-$(_readaccountconf_mutable One984HOSTING_SESSIONID_COOKIE)}"
|
|
One984HOSTING_CSRFTOKEN_COOKIE="${One984HOSTING_CSRFTOKEN_COOKIE:-$(_readaccountconf_mutable One984HOSTING_CSRFTOKEN_COOKIE)}"
|
|
if [ -z "$One984HOSTING_SESSIONID_COOKIE" ] || [ -z "$One984HOSTING_CSRFTOKEN_COOKIE" ]; then
|
|
_debug "No cached cookie(s) found."
|
|
return 1
|
|
fi
|
|
|
|
_authget "https://1984.hosting/api/auth/"
|
|
if _contains "$_response" '"ok": true'; then
|
|
_debug "Cached cookies still valid."
|
|
return 0
|
|
fi
|
|
|
|
_debug "Cached cookies no longer valid. Clearing cookies."
|
|
One984HOSTING_SESSIONID_COOKIE=""
|
|
One984HOSTING_CSRFTOKEN_COOKIE=""
|
|
_clearaccountconf_mutable One984HOSTING_SESSIONID_COOKIE
|
|
_clearaccountconf_mutable One984HOSTING_CSRFTOKEN_COOKIE
|
|
return 1
|
|
}
|
|
|
|
# _acme-challenge.www.domain.com
|
|
# Returns
|
|
# _sub_domain=_acme-challenge.www
|
|
# _domain=domain.com
|
|
_get_root() {
|
|
domain="$1"
|
|
i=1
|
|
p=1
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f "$i"-100)
|
|
|
|
# not valid
|
|
if [ -z "$h" ]; then
|
|
return 1
|
|
fi
|
|
|
|
_authget "https://1984.hosting/domains/soacheck/?zone=$h&nameserver=ns0.1984.is."
|
|
if _contains "$_response" "serial" && ! _contains "$_response" "null"; then
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-"$p")
|
|
_domain="$h"
|
|
return 0
|
|
fi
|
|
p=$i
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|
|
|
|
# Usage: _get_zone_id url domain.com
|
|
# Returns zone id for domain.com
|
|
_get_zone_id() {
|
|
url=$1
|
|
domain=$2
|
|
_htmlget "$url" "$domain"
|
|
_zone_id="$(echo "$_response" | _egrep_o 'zone\/[0-9]+' | _head_n 1)"
|
|
_debug2 _zone_id "$_zone_id"
|
|
if [ -z "$_zone_id" ]; then
|
|
_err "Error getting _zone_id for $2."
|
|
return 1
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
# Add extra headers to request
|
|
_authget() {
|
|
export _H1="Cookie: $One984HOSTING_CSRFTOKEN_COOKIE; $One984HOSTING_SESSIONID_COOKIE"
|
|
_response=$(_get "$1" | _normalizeJson)
|
|
_debug2 _response "$_response"
|
|
}
|
|
|
|
# Truncate huge HTML response
|
|
# Echo: Argument list too long
|
|
_htmlget() {
|
|
export _H1="Cookie: $One984HOSTING_CSRFTOKEN_COOKIE; $One984HOSTING_SESSIONID_COOKIE"
|
|
_response=$(_get "$1" | grep "$2")
|
|
if _contains "$_response" "@$2"; then
|
|
_response=$(echo "$_response" | grep -v "[@]" | _head_n 1)
|
|
fi
|
|
_debug2 _response "$_response"
|
|
}
|
|
|
|
# Add extra headers to request
|
|
_authpost() {
|
|
url="https://1984.hosting/domains"
|
|
_get_zone_id "$url" "$_domain"
|
|
csrf_header="$(echo "$One984HOSTING_CSRFTOKEN_COOKIE" | _egrep_o "=[^=][0-9a-zA-Z]*" | tr -d "=")"
|
|
export _H1="Cookie: $One984HOSTING_CSRFTOKEN_COOKIE; $One984HOSTING_SESSIONID_COOKIE"
|
|
export _H2="Referer: https://1984.hosting/domains/$_zone_id"
|
|
export _H3="X-CSRFToken: $csrf_header"
|
|
_response="$(_post "$1" "$2" | _normalizeJson)"
|
|
_debug2 _response "$_response"
|
|
}
|