mirror of
https://github.com/plantroon/acme.sh.git
synced 2024-11-09 16:01:46 +00:00
348 lines
9.4 KiB
Bash
348 lines
9.4 KiB
Bash
#!/usr/bin/env sh
|
|
|
|
########
|
|
# Custom cyon.ch DNS API for use with [acme.sh](https://github.com/Neilpang/acme.sh)
|
|
#
|
|
# Usage: acme.sh --issue --dns dns_cyon -d www.domain.com
|
|
#
|
|
# Dependencies:
|
|
# -------------
|
|
# - oathtool (When using 2 Factor Authentication)
|
|
#
|
|
# Author: Armando Lüscher <armando@noplanman.ch>
|
|
########
|
|
|
|
########
|
|
# Define cyon.ch login credentials:
|
|
#
|
|
# Either set them here: (uncomment these lines)
|
|
#
|
|
# cyon_username='your_cyon_username'
|
|
# cyon_password='your_cyon_password'
|
|
# cyon_otp_secret='your_otp_secret' # Only required if using 2FA
|
|
#
|
|
# ...or export them as environment variables in your shell:
|
|
#
|
|
# $ export cyon_username='your_cyon_username'
|
|
# $ export cyon_password='your_cyon_password'
|
|
# $ export cyon_otp_secret='your_otp_secret' # Only required if using 2FA
|
|
#
|
|
# *Note:*
|
|
# After the first run, the credentials are saved in the "account.conf"
|
|
# file, so any hard-coded or environment variables can then be removed.
|
|
########
|
|
|
|
dns_cyon_add() {
|
|
_load_credentials
|
|
_load_parameters "$@"
|
|
|
|
_info_header "add"
|
|
_login
|
|
_domain_env
|
|
_add_txt
|
|
_cleanup
|
|
|
|
return 0
|
|
}
|
|
|
|
dns_cyon_rm() {
|
|
_load_credentials
|
|
_load_parameters "$@"
|
|
|
|
_info_header "delete"
|
|
_login
|
|
_domain_env
|
|
_delete_txt
|
|
_cleanup
|
|
|
|
return 0
|
|
}
|
|
|
|
#########################
|
|
### PRIVATE FUNCTIONS ###
|
|
#########################
|
|
|
|
_load_credentials() {
|
|
# Convert loaded password to/from base64 as needed.
|
|
if [ "${cyon_password_b64}" ]; then
|
|
cyon_password="$(printf "%s" "${cyon_password_b64}" | _dbase64)"
|
|
elif [ "${cyon_password}" ]; then
|
|
cyon_password_b64="$(printf "%s" "${cyon_password}" | _base64)"
|
|
fi
|
|
|
|
if [ -z "${cyon_username}" ] || [ -z "${cyon_password}" ]; then
|
|
cyon_username=""
|
|
cyon_password=""
|
|
cyon_otp_secret=""
|
|
_err ""
|
|
_err "You haven't set your cyon.ch login credentials yet."
|
|
_err "Please set the required cyon environment variables."
|
|
_err ""
|
|
exit 1
|
|
fi
|
|
|
|
# Save the login credentials to the account.conf file.
|
|
_debug "Save credentials to account.conf"
|
|
_saveaccountconf cyon_username "${cyon_username}"
|
|
_saveaccountconf cyon_password_b64 "$cyon_password_b64"
|
|
if [ ! -z "${cyon_otp_secret}" ]; then
|
|
_saveaccountconf cyon_otp_secret "$cyon_otp_secret"
|
|
fi
|
|
}
|
|
|
|
_is_idn() {
|
|
_idn_temp=$(printf "%s" "$1" | tr -d "[0-9a-zA-Z.,-]")
|
|
_idn_temp2="$(printf "%s" "$1" | grep -o "xn--")"
|
|
[ "$_idn_temp" ] || [ "$_idn_temp2" ]
|
|
}
|
|
|
|
_load_parameters() {
|
|
# Read the required parameters to add the TXT entry.
|
|
fulldomain="$(printf "%s" "$1" | tr '[:upper:]' '[:lower:]')"
|
|
fulldomain_idn="${fulldomain}"
|
|
|
|
# Special case for IDNs, as cyon needs a domain environment change,
|
|
# which uses the "pretty" instead of the punycode version.
|
|
if _is_idn "$1"; then
|
|
if ! _exists idn; then
|
|
_fail "Please install idn to process IDN names."
|
|
fi
|
|
|
|
fulldomain="$(idn -u "${fulldomain}")"
|
|
fulldomain_idn="$(idn -a "${fulldomain}")"
|
|
fi
|
|
|
|
_debug fulldomain "$fulldomain"
|
|
_debug fulldomain_idn "$fulldomain_idn"
|
|
|
|
txtvalue="$2"
|
|
_debug txtvalue "$txtvalue"
|
|
|
|
# Cookiejar required for login session, as cyon.ch has no official API (yet).
|
|
cookiejar=$(tempfile)
|
|
_debug cookiejar "$cookiejar"
|
|
}
|
|
|
|
_info_header() {
|
|
if [ "$1" = "add" ]; then
|
|
_info ""
|
|
_info "+---------------------------------------------+"
|
|
_info "| Adding DNS TXT entry to your cyon.ch domain |"
|
|
_info "+---------------------------------------------+"
|
|
_info ""
|
|
_info " * Full Domain: ${fulldomain}"
|
|
_info " * TXT Value: ${txtvalue}"
|
|
_info " * Cookie Jar: ${cookiejar}"
|
|
_info ""
|
|
elif [ "$1" = "delete" ]; then
|
|
_info ""
|
|
_info "+-------------------------------------------------+"
|
|
_info "| Deleting DNS TXT entry from your cyon.ch domain |"
|
|
_info "+-------------------------------------------------+"
|
|
_info ""
|
|
_info " * Full Domain: ${fulldomain}"
|
|
_info " * Cookie Jar: ${cookiejar}"
|
|
_info ""
|
|
fi
|
|
}
|
|
|
|
_login() {
|
|
_info " - Logging in..."
|
|
login_response=$(curl \
|
|
"https://my.cyon.ch/auth/index/dologin-async" \
|
|
-s \
|
|
-c "${cookiejar}" \
|
|
-H "X-Requested-With: XMLHttpRequest" \
|
|
--data-urlencode "username=${cyon_username}" \
|
|
--data-urlencode "password=${cyon_password}" \
|
|
--data-urlencode "pathname=/")
|
|
|
|
_debug login_response "${login_response}"
|
|
|
|
# Bail if login fails.
|
|
if [ "$(printf "%s" "${login_response}" | _get_response_success)" != "success" ]; then
|
|
_fail " $(printf "%s" "${login_response}" | _get_response_message)"
|
|
fi
|
|
|
|
_info " success"
|
|
|
|
# NECESSARY!! Load the main page after login, before the OTP check.
|
|
curl "https://my.cyon.ch/" -s --compressed -b "${cookiejar}" >/dev/null
|
|
|
|
# todo: instead of just checking if the env variable is defined, check if we actually need to do a 2FA auth request.
|
|
|
|
# 2FA authentication with OTP?
|
|
if [ ! -z "${cyon_otp_secret}" ]; then
|
|
_info " - Authorising with OTP code..."
|
|
|
|
if ! _exists oathtool; then
|
|
_fail "Please install oathtool to use 2 Factor Authentication."
|
|
fi
|
|
|
|
# Get OTP code with the defined secret.
|
|
otp_code=$(oathtool --base32 --totp "${cyon_otp_secret}" 2>/dev/null)
|
|
|
|
otp_response=$(curl \
|
|
"https://my.cyon.ch/auth/multi-factor/domultifactorauth-async" \
|
|
-s \
|
|
--compressed \
|
|
-b "${cookiejar}" \
|
|
-c "${cookiejar}" \
|
|
-H "X-Requested-With: XMLHttpRequest" \
|
|
-d "totpcode=${otp_code}&pathname=%2F&rememberme=0")
|
|
|
|
_debug otp_response "${otp_response}"
|
|
|
|
# Bail if OTP authentication fails.
|
|
if [ "$(printf "%s" "${otp_response}" | _get_response_success)" != "success" ]; then
|
|
_fail " $(printf "%s" "${otp_response}" | _get_response_message)"
|
|
fi
|
|
|
|
_info " success"
|
|
fi
|
|
|
|
_info ""
|
|
}
|
|
|
|
_domain_env() {
|
|
_info " - Changing domain environment..."
|
|
|
|
# Get the "example.com" part of the full domain name.
|
|
domain_env=$(printf "%s" "${fulldomain}" | sed -E -e 's/.*\.(.*\..*)$/\1/')
|
|
_debug "Changing domain environment to ${domain_env}"
|
|
|
|
domain_env_response=$(curl \
|
|
"https://my.cyon.ch/user/environment/setdomain/d/${domain_env}/gik/domain%3A${domain_env}" \
|
|
-s \
|
|
--compressed \
|
|
-b "${cookiejar}" \
|
|
-H "X-Requested-With: XMLHttpRequest")
|
|
|
|
_debug domain_env_response "${domain_env_response}"
|
|
|
|
_check_2fa_miss "${domain_env_response}"
|
|
|
|
domain_env_success=$(printf "%s" "${domain_env_response}" | _egrep_o '"authenticated":\w*' | cut -d : -f 2)
|
|
|
|
# Bail if domain environment change fails.
|
|
if [ "${domain_env_success}" != "true" ]; then
|
|
_fail " $(printf "%s" "${domain_env_response}" | _get_response_message)"
|
|
fi
|
|
|
|
_info " success"
|
|
_info ""
|
|
}
|
|
|
|
_add_txt() {
|
|
_info " - Adding DNS TXT entry..."
|
|
addtxt_response=$(curl \
|
|
"https://my.cyon.ch/domain/dnseditor/add-record-async" \
|
|
-s \
|
|
--compressed \
|
|
-b "${cookiejar}" \
|
|
-H "X-Requested-With: XMLHttpRequest" \
|
|
-d "zone=${fulldomain_idn}.&ttl=900&type=TXT&value=${txtvalue}")
|
|
|
|
_debug addtxt_response "${addtxt_response}"
|
|
|
|
_check_2fa_miss "${addtxt_response}"
|
|
|
|
addtxt_message=$(printf "%s" "${addtxt_response}" | _get_response_message)
|
|
addtxt_status=$(printf "%s" "${addtxt_response}" | _get_response_status)
|
|
|
|
# Bail if adding TXT entry fails.
|
|
if [ "${addtxt_status}" != "true" ]; then
|
|
_fail " ${addtxt_message}"
|
|
fi
|
|
|
|
_info " success"
|
|
_info ""
|
|
}
|
|
|
|
_delete_txt() {
|
|
_info " - Deleting DNS TXT entry..."
|
|
|
|
list_txt_response=$(curl \
|
|
"https://my.cyon.ch/domain/dnseditor/list-async" \
|
|
-s \
|
|
-b "${cookiejar}" \
|
|
--compressed \
|
|
-H "X-Requested-With: XMLHttpRequest" \
|
|
| sed -e 's/data-hash/\\ndata-hash/g')
|
|
|
|
_debug list_txt_response "${list_txt_response}"
|
|
|
|
_check_2fa_miss "${list_txt_response}"
|
|
|
|
# Find and delete all acme challenge entries for the $fulldomain.
|
|
_dns_entries=$(printf "%s" "$list_txt_response" | sed -n 's/data-hash=\\"\([^"]*\)\\" data-identifier=\\"\([^"]*\)\\".*/\1 \2/p')
|
|
|
|
printf "%s" "${_dns_entries}" | while read -r _hash _identifier; do
|
|
dns_type="$(printf "%s" "$_identifier" | cut -d'|' -f1)"
|
|
dns_domain="$(printf "%s" "$_identifier" | cut -d'|' -f2)"
|
|
|
|
if [ "${dns_type}" != "TXT" ] || [ "${dns_domain}" != "${fulldomain_idn}." ]; then
|
|
continue
|
|
fi
|
|
|
|
delete_txt_response=$(curl \
|
|
"https://my.cyon.ch/domain/dnseditor/delete-record-async" \
|
|
-s \
|
|
--compressed \
|
|
-b "${cookiejar}" \
|
|
-H "X-Requested-With: XMLHttpRequest" \
|
|
--data-urlencode "hash=${_hash}" \
|
|
--data-urlencode "identifier=${_identifier}")
|
|
|
|
_debug delete_txt_response "${delete_txt_response}"
|
|
|
|
_check_2fa_miss "${delete_txt_response}"
|
|
|
|
delete_txt_message=$(printf "%s" "${delete_txt_response}" | _get_response_message)
|
|
delete_txt_status=$(printf "%s" "${delete_txt_response}" | _get_response_status)
|
|
|
|
# Skip if deleting TXT entry fails.
|
|
if [ "${delete_txt_status}" != "true" ]; then
|
|
_err " ${delete_txt_message} (${_identifier})"
|
|
else
|
|
_info " success (${_identifier})"
|
|
fi
|
|
done
|
|
|
|
_info " done"
|
|
_info ""
|
|
}
|
|
|
|
_get_response_message() {
|
|
_egrep_o '"message":"[^"]*"' | cut -d : -f 2 | tr -d '"'
|
|
}
|
|
|
|
_get_response_status() {
|
|
_egrep_o '"status":\w*' | cut -d : -f 2
|
|
}
|
|
|
|
_get_response_success() {
|
|
_egrep_o '"onSuccess":"[^"]*"' | cut -d : -f 2 | tr -d '"'
|
|
}
|
|
|
|
_check_2fa_miss() {
|
|
# Did we miss the 2FA?
|
|
if test "${1#*multi_factor_form}" != "$1"; then
|
|
_fail " Missed OTP authentication!"
|
|
fi
|
|
}
|
|
|
|
_fail() {
|
|
_err "$1"
|
|
_err ""
|
|
_cleanup
|
|
exit 1
|
|
}
|
|
|
|
_cleanup() {
|
|
_info " - Cleanup."
|
|
_debug "Remove cookie jar: ${cookiejar}"
|
|
rm "${cookiejar}" 2>/dev/null
|
|
_info ""
|
|
}
|