Scruel Tao
1 year ago
committed by
GitHub
13 changed files with 575 additions and 78 deletions
@ -0,0 +1,180 @@
|
||||
#!/usr/bin/env sh |
||||
|
||||
################################################################################ |
||||
# ACME.sh 3rd party DNS API plugin for ArtFiles.de |
||||
################################################################################ |
||||
# Author: Martin Arndt, https://troublezone.net/ |
||||
# Released: 2022-02-27 |
||||
# Issues: https://github.com/acmesh-official/acme.sh/issues/4718 |
||||
################################################################################ |
||||
# Usage: |
||||
# 1. export AF_API_USERNAME='api12345678' |
||||
# 2. export AF_API_PASSWORD='apiPassword' |
||||
# 3. acme.sh --issue -d example.com --dns dns_artfiles |
||||
################################################################################ |
||||
|
||||
########## API configuration ################################################### |
||||
|
||||
AF_API_SUCCESS='status":"OK' |
||||
AF_URL_DCP='https://dcp.c.artfiles.de/api/' |
||||
AF_URL_DNS=${AF_URL_DCP}'dns/{*}_dns.html?domain=' |
||||
AF_URL_DOMAINS=${AF_URL_DCP}'domain/get_domains.html' |
||||
|
||||
########## Public functions #################################################### |
||||
|
||||
# Adds a new TXT record for given ACME challenge value & domain. |
||||
# Usage: dns_artfiles_add _acme-challenge.www.example.com "ACME challenge value" |
||||
dns_artfiles_add() { |
||||
domain="$1" |
||||
txtValue="$2" |
||||
_info 'Using ArtFiles.de DNS addition API…' |
||||
_debug 'Domain' "$domain" |
||||
_debug 'txtValue' "$txtValue" |
||||
|
||||
_set_credentials |
||||
_saveaccountconf_mutable 'AF_API_USERNAME' "$AF_API_USERNAME" |
||||
_saveaccountconf_mutable 'AF_API_PASSWORD' "$AF_API_PASSWORD" |
||||
|
||||
_set_headers |
||||
_get_zone "$domain" |
||||
_dns 'GET' |
||||
if ! _contains "$response" 'TXT'; then |
||||
_err 'Retrieving TXT records failed.' |
||||
|
||||
return 1 |
||||
fi |
||||
|
||||
_clean_records |
||||
_dns 'SET' "$(printf -- '%s\n_acme-challenge "%s"' "$response" "$txtValue")" |
||||
if ! _contains "$response" "$AF_API_SUCCESS"; then |
||||
_err 'Adding ACME challenge value failed.' |
||||
|
||||
return 1 |
||||
fi |
||||
} |
||||
|
||||
# Removes the existing TXT record for given ACME challenge value & domain. |
||||
# Usage: dns_artfiles_rm _acme-challenge.www.example.com "ACME challenge value" |
||||
dns_artfiles_rm() { |
||||
domain="$1" |
||||
txtValue="$2" |
||||
_info 'Using ArtFiles.de DNS removal API…' |
||||
_debug 'Domain' "$domain" |
||||
_debug 'txtValue' "$txtValue" |
||||
|
||||
_set_credentials |
||||
_set_headers |
||||
_get_zone "$domain" |
||||
if ! _dns 'GET'; then |
||||
return 1 |
||||
fi |
||||
|
||||
if ! _contains "$response" "$txtValue"; then |
||||
_err 'Retrieved TXT records are missing given ACME challenge value.' |
||||
|
||||
return 1 |
||||
fi |
||||
|
||||
_clean_records |
||||
response="$(printf -- '%s' "$response" | sed '/_acme-challenge "'"$txtValue"'"/d')" |
||||
_dns 'SET' "$response" |
||||
if ! _contains "$response" "$AF_API_SUCCESS"; then |
||||
_err 'Removing ACME challenge value failed.' |
||||
|
||||
return 1 |
||||
fi |
||||
} |
||||
|
||||
########## Private functions ################################################### |
||||
|
||||
# Cleans awful TXT records response of ArtFiles's API & pretty prints it. |
||||
# Usage: _clean_records |
||||
_clean_records() { |
||||
_info 'Cleaning TXT records…' |
||||
# Extract TXT part, strip trailing quote sign (ACME.sh API guidelines forbid |
||||
# usage of SED's GNU extensions, hence couldn't omit it via regex), strip '\' |
||||
# from '\"' & turn '\n' into real LF characters. |
||||
# Yup, awful API to use - but that's all we got to get this working, so… ;) |
||||
_debug2 'Raw ' "$response" |
||||
response="$(printf -- '%s' "$response" | sed 's/^.*TXT":"\([^}]*\).*$/\1/;s/,".*$//;s/.$//;s/\\"/"/g;s/\\n/\n/g')" |
||||
_debug2 'Clean' "$response" |
||||
} |
||||
|
||||
# Executes an HTTP GET or POST request for getting or setting DNS records, |
||||
# containing given payload upon POST. |
||||
# Usage: _dns [GET | SET] [payload] |
||||
_dns() { |
||||
_info 'Executing HTTP request…' |
||||
action="$1" |
||||
payload="$(printf -- '%s' "$2" | _url_encode)" |
||||
url="$(printf -- '%s%s' "$AF_URL_DNS" "$domain" | sed 's/{\*}/'"$(printf -- '%s' "$action" | _lower_case)"'/')" |
||||
|
||||
if [ "$action" = 'SET' ]; then |
||||
_debug2 'Payload' "$payload" |
||||
response="$(_post '' "$url&TXT=$payload" '' 'POST' 'application/x-www-form-urlencoded')" |
||||
else |
||||
response="$(_get "$url" '' 10)" |
||||
fi |
||||
|
||||
if ! _contains "$response" "$AF_API_SUCCESS"; then |
||||
_err "DNS API error: $response" |
||||
|
||||
return 1 |
||||
fi |
||||
|
||||
_debug 'Response' "$response" |
||||
|
||||
return 0 |
||||
} |
||||
|
||||
# Gets the root domain zone for given domain. |
||||
# Usage: _get_zone _acme-challenge.www.example.com |
||||
_get_zone() { |
||||
fqdn="$1" |
||||
domains="$(_get "$AF_URL_DOMAINS" '' 10)" |
||||
_info 'Getting domain zone…' |
||||
_debug2 'FQDN' "$fqdn" |
||||
_debug2 'Domains' "$domains" |
||||
|
||||
while _contains "$fqdn" "."; do |
||||
if _contains "$domains" "$fqdn"; then |
||||
domain="$fqdn" |
||||
_info "Found root domain zone: $domain" |
||||
break |
||||
else |
||||
fqdn="${fqdn#*.}" |
||||
_debug2 'FQDN' "$fqdn" |
||||
fi |
||||
done |
||||
|
||||
if [ "$domain" = "$fqdn" ]; then |
||||
return 0 |
||||
fi |
||||
|
||||
_err 'Couldn'\''t find root domain zone.' |
||||
|
||||
return 1 |
||||
} |
||||
|
||||
# Sets the credentials for accessing ArtFiles's API |
||||
# Usage: _set_credentials |
||||
_set_credentials() { |
||||
_info 'Setting credentials…' |
||||
AF_API_USERNAME="${AF_API_USERNAME:-$(_readaccountconf_mutable AF_API_USERNAME)}" |
||||
AF_API_PASSWORD="${AF_API_PASSWORD:-$(_readaccountconf_mutable AF_API_PASSWORD)}" |
||||
if [ -z "$AF_API_USERNAME" ] || [ -z "$AF_API_PASSWORD" ]; then |
||||
_err 'Missing ArtFiles.de username and/or password.' |
||||
_err 'Please ensure both are set via export command & try again.' |
||||
|
||||
return 1 |
||||
fi |
||||
} |
||||
|
||||
# Adds the HTTP Authorization & Content-Type headers to a follow-up request. |
||||
# Usage: _set_headers |
||||
_set_headers() { |
||||
_info 'Setting headers…' |
||||
encoded="$(printf -- '%s:%s' "$AF_API_USERNAME" "$AF_API_PASSWORD" | _base64)" |
||||
export _H1="Authorization: Basic $encoded" |
||||
export _H2='Content-Type: application/json' |
||||
} |
||||
@ -0,0 +1,185 @@
|
||||
#!/usr/bin/env sh |
||||
|
||||
#use dns-01 at DNSExit.com |
||||
|
||||
#Author: Samuel Jimenez |
||||
#Report Bugs here: https://github.com/acmesh-official/acme.sh |
||||
|
||||
#DNSEXIT_API_KEY=ABCDEFGHIJ0123456789abcdefghij |
||||
#DNSEXIT_AUTH_USER=login@email.address |
||||
#DNSEXIT_AUTH_PASS=aStrongPassword |
||||
DNSEXIT_API_URL="https://api.dnsexit.com/dns/" |
||||
DNSEXIT_HOSTS_URL="https://update.dnsexit.com/ipupdate/hosts.jsp" |
||||
|
||||
######## Public functions ##################### |
||||
#Usage: dns_dnsexit_add _acme-challenge.*.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs" |
||||
dns_dnsexit_add() { |
||||
fulldomain=$1 |
||||
txtvalue=$2 |
||||
_info "Using DNSExit.com" |
||||
_debug fulldomain "$fulldomain" |
||||
_debug txtvalue "$txtvalue" |
||||
|
||||
_debug 'Load account auth' |
||||
if ! get_account_info; then |
||||
return 1 |
||||
fi |
||||
|
||||
_debug 'First detect the root zone' |
||||
if ! _get_root "$fulldomain"; then |
||||
return 1 |
||||
fi |
||||
_debug _sub_domain "$_sub_domain" |
||||
_debug _domain "$_domain" |
||||
|
||||
if ! _dnsexit_rest "{\"domain\":\"$_domain\",\"add\":{\"type\":\"TXT\",\"name\":\"$_sub_domain\",\"content\":\"$txtvalue\",\"ttl\":0,\"overwrite\":false}}"; then |
||||
_err "$response" |
||||
return 1 |
||||
fi |
||||
|
||||
_debug2 _response "$response" |
||||
return 0 |
||||
} |
||||
|
||||
#Usage: fulldomain txtvalue |
||||
#Remove the txt record after validation. |
||||
dns_dnsexit_rm() { |
||||
fulldomain=$1 |
||||
txtvalue=$2 |
||||
_info "Using DNSExit.com" |
||||
_debug fulldomain "$fulldomain" |
||||
_debug txtvalue "$txtvalue" |
||||
|
||||
_debug 'Load account auth' |
||||
if ! get_account_info; then |
||||
return 1 |
||||
fi |
||||
|
||||
_debug 'First detect the root zone' |
||||
if ! _get_root "$fulldomain"; then |
||||
_err "$response" |
||||
return 1 |
||||
fi |
||||
_debug _sub_domain "$_sub_domain" |
||||
_debug _domain "$_domain" |
||||
|
||||
if ! _dnsexit_rest "{\"domain\":\"$_domain\",\"delete\":{\"type\":\"TXT\",\"name\":\"$_sub_domain\",\"content\":\"$txtvalue\"}}"; then |
||||
_err "$response" |
||||
return 1 |
||||
fi |
||||
|
||||
_debug2 _response "$response" |
||||
return 0 |
||||
} |
||||
|
||||
#################### Private functions below ################################## |
||||
#_acme-challenge.www.domain.com |
||||
#returns |
||||
# _sub_domain=_acme-challenge.www |
||||
# _domain=domain.com |
||||
_get_root() { |
||||
domain=$1 |
||||
i=1 |
||||
while true; do |
||||
_domain=$(printf "%s" "$domain" | cut -d . -f $i-100) |
||||
_debug h "$_domain" |
||||
if [ -z "$_domain" ]; then |
||||
return 1 |
||||
fi |
||||
|
||||
_debug login "$DNSEXIT_AUTH_USER" |
||||
_debug password "$DNSEXIT_AUTH_PASS" |
||||
_debug domain "$_domain" |
||||
|
||||
_dnsexit_http "login=$DNSEXIT_AUTH_USER&password=$DNSEXIT_AUTH_PASS&domain=$_domain" |
||||
|
||||
if _contains "$response" "0=$_domain"; then |
||||
_sub_domain="$(echo "$fulldomain" | sed "s/\\.$_domain\$//")" |
||||
return 0 |
||||
else |
||||
_debug "Go to next level of $_domain" |
||||
fi |
||||
i=$(_math "$i" + 1) |
||||
done |
||||
|
||||
return 1 |
||||
} |
||||
|
||||
_dnsexit_rest() { |
||||
m=POST |
||||
ep="" |
||||
data="$1" |
||||
_debug _dnsexit_rest "$ep" |
||||
_debug data "$data" |
||||
|
||||
api_key_trimmed=$(echo "$DNSEXIT_API_KEY" | tr -d '"') |
||||
|
||||
export _H1="apikey: $api_key_trimmed" |
||||
export _H2='Content-Type: application/json' |
||||
|
||||
if [ "$m" != "GET" ]; then |
||||
_debug data "$data" |
||||
response="$(_post "$data" "$DNSEXIT_API_URL/$ep" "" "$m")" |
||||
else |
||||
response="$(_get "$DNSEXIT_API_URL/$ep")" |
||||
fi |
||||
|
||||
if [ "$?" != "0" ]; then |
||||
_err "Error $ep" |
||||
return 1 |
||||
fi |
||||
|
||||
_debug2 response "$response" |
||||
return 0 |
||||
} |
||||
|
||||
_dnsexit_http() { |
||||
m=GET |
||||
param="$1" |
||||
_debug param "$param" |
||||
_debug get "$DNSEXIT_HOSTS_URL?$param" |
||||
|
||||
response="$(_get "$DNSEXIT_HOSTS_URL?$param")" |
||||
|
||||
_debug response "$response" |
||||
|
||||
if [ "$?" != "0" ]; then |
||||
_err "Error $param" |
||||
return 1 |
||||
fi |
||||
|
||||
_debug2 response "$response" |
||||
return 0 |
||||
} |
||||
|
||||
get_account_info() { |
||||
|
||||
DNSEXIT_API_KEY="${DNSEXIT_API_KEY:-$(_readaccountconf_mutable DNSEXIT_API_KEY)}" |
||||
if test -z "$DNSEXIT_API_KEY"; then |
||||
DNSEXIT_API_KEY='' |
||||
_err 'DNSEXIT_API_KEY was not exported' |
||||
return 1 |
||||
fi |
||||
|
||||
_saveaccountconf_mutable DNSEXIT_API_KEY "$DNSEXIT_API_KEY" |
||||
|
||||
DNSEXIT_AUTH_USER="${DNSEXIT_AUTH_USER:-$(_readaccountconf_mutable DNSEXIT_AUTH_USER)}" |
||||
if test -z "$DNSEXIT_AUTH_USER"; then |
||||
DNSEXIT_AUTH_USER="" |
||||
_err 'DNSEXIT_AUTH_USER was not exported' |
||||
return 1 |
||||
fi |
||||
|
||||
_saveaccountconf_mutable DNSEXIT_AUTH_USER "$DNSEXIT_AUTH_USER" |
||||
|
||||
DNSEXIT_AUTH_PASS="${DNSEXIT_AUTH_PASS:-$(_readaccountconf_mutable DNSEXIT_AUTH_PASS)}" |
||||
if test -z "$DNSEXIT_AUTH_PASS"; then |
||||
DNSEXIT_AUTH_PASS="" |
||||
_err 'DNSEXIT_AUTH_PASS was not exported' |
||||
return 1 |
||||
fi |
||||
|
||||
_saveaccountconf_mutable DNSEXIT_AUTH_PASS "$DNSEXIT_AUTH_PASS" |
||||
|
||||
return 0 |
||||
} |
||||
Loading…
Reference in new issue