acme.sh/dnsapi/dns_simply.sh

270 lines
6.0 KiB
Bash
Raw Permalink Normal View History

2020-11-17 12:19:55 +00:00
#!/usr/bin/env sh
# API-integration for Simply.com (https://www.simply.com)
2020-11-17 12:19:55 +00:00
#SIMPLY_AccountName="accountname"
#SIMPLY_ApiKey="apikey"
#
#SIMPLY_Api="https://api.simply.com/2/"
SIMPLY_Api_Default="https://api.simply.com/2"
2020-11-17 12:19:55 +00:00
2021-02-24 16:34:28 +00:00
#This is used for determining success of REST call
SIMPLY_SUCCESS_CODE='"status":200'
2021-02-24 16:34:28 +00:00
2020-11-18 17:01:02 +00:00
######## Public functions #####################
2020-11-17 12:19:55 +00:00
#Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
dns_simply_add() {
fulldomain=$1
txtvalue=$2
if ! _simply_load_config; then
return 1
fi
_simply_save_config
2020-11-18 14:46:16 +00:00
_debug "First detect the root zone"
2020-11-17 12:19:55 +00:00
if ! _get_root "$fulldomain"; then
_err "invalid domain"
return 1
fi
2020-11-18 14:46:16 +00:00
2020-11-17 12:19:55 +00:00
_debug _sub_domain "$_sub_domain"
_debug _domain "$_domain"
_info "Adding record"
2020-11-18 14:46:16 +00:00
if ! _simply_add_record "$_domain" "$_sub_domain" "$txtvalue"; then
2020-11-17 12:19:55 +00:00
_err "Could not add DNS record"
return 1
2020-11-18 14:46:16 +00:00
fi
2020-11-17 12:19:55 +00:00
return 0
}
dns_simply_rm() {
fulldomain=$1
txtvalue=$2
2020-11-18 14:46:16 +00:00
2020-11-17 12:19:55 +00:00
if ! _simply_load_config; then
return 1
fi
_simply_save_config
_debug "Find the DNS zone"
2020-11-18 14:55:02 +00:00
2020-11-17 12:19:55 +00:00
if ! _get_root "$fulldomain"; then
_err "invalid domain"
return 1
fi
_debug _sub_domain "$_sub_domain"
_debug _domain "$_domain"
2020-11-17 12:49:32 +00:00
_debug txtvalue "$txtvalue"
2020-11-17 12:19:55 +00:00
_info "Getting all existing records"
2020-11-18 14:46:16 +00:00
2020-11-17 12:19:55 +00:00
if ! _simply_get_all_records "$_domain"; then
_err "invalid domain"
return 1
fi
2020-11-18 14:46:16 +00:00
2020-11-18 14:52:46 +00:00
records=$(echo "$response" | tr '{' "\n" | grep 'record_id\|type\|data\|\name' | sed 's/\"record_id/;\"record_id/' | tr "\n" ' ' | tr -d ' ' | tr ';' ' ')
2020-11-18 13:52:32 +00:00
2020-11-17 12:19:55 +00:00
nr_of_deleted_records=0
2020-11-18 13:52:32 +00:00
_info "Fetching txt record"
2020-11-17 12:19:55 +00:00
2020-11-18 14:52:46 +00:00
for record in $records; do
_debug record "$record"
2020-11-18 14:46:16 +00:00
record_data=$(echo "$record" | sed -n "s/.*\"data\":\"\([^\"]*\)\".*/\1/p")
record_type=$(echo "$record" | sed -n "s/.*\"type\":\"\([^\"]*\)\".*/\1/p")
2020-11-18 14:52:46 +00:00
_debug2 record_data "$record_data"
_debug2 record_type "$record_type"
2020-11-18 14:55:02 +00:00
2020-11-18 14:46:16 +00:00
if [ "$record_data" = "$txtvalue" ] && [ "$record_type" = "TXT" ]; then
2020-11-18 14:12:22 +00:00
record_id=$(echo "$record" | cut -d "," -f 1 | grep "record_id" | cut -d ":" -f 2)
2020-11-18 14:46:16 +00:00
2020-11-18 14:12:22 +00:00
_info "Deleting record $record"
2020-11-18 13:52:32 +00:00
_debug2 record_id "$record_id"
2020-11-18 14:46:16 +00:00
2020-11-18 13:52:32 +00:00
if [ "$record_id" -gt 0 ]; then
2020-11-18 14:46:16 +00:00
if ! _simply_delete_record "$_domain" "$_sub_domain" "$record_id"; then
_err "Record with id $record_id could not be deleted"
return 1
fi
2020-11-18 14:46:16 +00:00
nr_of_deleted_records=1
break
2020-11-18 14:52:46 +00:00
else
_err "Fetching record_id could not be done, this should not happen, exiting function. Failing record is $record"
break
fi
2020-11-17 12:19:55 +00:00
fi
2020-11-18 14:46:16 +00:00
2020-11-17 12:19:55 +00:00
done
2020-11-18 13:52:32 +00:00
if [ "$nr_of_deleted_records" -eq 0 ]; then
2020-11-18 14:52:46 +00:00
_err "No record deleted, the DNS record needs to be removed manually."
2020-11-17 12:19:55 +00:00
else
_info "Deleted $nr_of_deleted_records record"
fi
2020-11-18 14:46:16 +00:00
2020-11-17 12:19:55 +00:00
return 0
}
#################### Private functions below ##################################
_simply_load_config() {
SIMPLY_Api="${SIMPLY_Api:-$(_readaccountconf_mutable SIMPLY_Api)}"
SIMPLY_AccountName="${SIMPLY_AccountName:-$(_readaccountconf_mutable SIMPLY_AccountName)}"
SIMPLY_ApiKey="${SIMPLY_ApiKey:-$(_readaccountconf_mutable SIMPLY_ApiKey)}"
if [ -z "$SIMPLY_Api" ]; then
SIMPLY_Api="$SIMPLY_Api_Default"
fi
2020-11-18 14:37:26 +00:00
2020-11-17 12:19:55 +00:00
if [ -z "$SIMPLY_AccountName" ] || [ -z "$SIMPLY_ApiKey" ]; then
SIMPLY_AccountName=""
SIMPLY_ApiKey=""
_err "A valid Simply API account and apikey not provided."
_err "Please provide a valid API user and try again."
return 1
fi
return 0
}
_simply_save_config() {
if [ "$SIMPLY_Api" != "$SIMPLY_Api_Default" ]; then
_saveaccountconf_mutable SIMPLY_Api "$SIMPLY_Api"
fi
_saveaccountconf_mutable SIMPLY_AccountName "$SIMPLY_AccountName"
_saveaccountconf_mutable SIMPLY_ApiKey "$SIMPLY_ApiKey"
}
_simply_get_all_records() {
2020-11-18 14:37:26 +00:00
domain=$1
if ! _simply_rest GET "my/products/$domain/dns/records/"; then
2020-11-17 12:19:55 +00:00
return 1
fi
return 0
}
_get_root() {
domain=$1
i=2
p=1
while true; do
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
if [ -z "$h" ]; then
#not valid
return 1
fi
if ! _simply_rest GET "my/products/$h/dns/"; then
2020-11-17 12:19:55 +00:00
return 1
fi
if ! _contains "$response" "$SIMPLY_SUCCESS_CODE"; then
2020-11-17 12:19:55 +00:00
_debug "$h not found"
else
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
_domain="$h"
return 0
fi
p="$i"
i=$(_math "$i" + 1)
done
return 1
}
_simply_add_record() {
domain=$1
sub_domain=$2
txtval=$3
2020-11-18 14:37:26 +00:00
2020-11-17 12:19:55 +00:00
data="{\"name\": \"$sub_domain\", \"type\":\"TXT\", \"data\": \"$txtval\", \"priority\":0, \"ttl\": 3600}"
if ! _simply_rest POST "my/products/$domain/dns/records/" "$data"; then
2020-11-17 12:19:55 +00:00
_err "Adding record not successfull!"
return 1
fi
2020-11-18 14:37:26 +00:00
if ! _contains "$response" "$SIMPLY_SUCCESS_CODE"; then
_err "Call to API not sucessfull, see below message for more details"
_err "$response"
return 1
fi
2022-01-06 21:03:39 +00:00
2020-11-17 12:19:55 +00:00
return 0
}
_simply_delete_record() {
domain=$1
sub_domain=$2
record_id=$3
2020-11-18 14:37:26 +00:00
2020-11-17 12:49:32 +00:00
_debug record_id "Delete record with id $record_id"
2020-11-18 14:37:26 +00:00
if ! _simply_rest DELETE "my/products/$domain/dns/records/$record_id/"; then
2020-11-17 12:19:55 +00:00
_err "Deleting record not successfull!"
return 1
fi
2020-11-18 14:37:26 +00:00
if ! _contains "$response" "$SIMPLY_SUCCESS_CODE"; then
_err "Call to API not sucessfull, see below message for more details"
_err "$response"
return 1
fi
2020-11-17 12:19:55 +00:00
return 0
}
_simply_rest() {
m=$1
ep="$2"
data="$3"
2020-11-18 14:37:26 +00:00
2020-11-17 12:49:32 +00:00
_debug2 data "$data"
_debug2 ep "$ep"
_debug2 m "$m"
2020-11-17 12:19:55 +00:00
basicauth=$(printf "%s:%s" "$SIMPLY_AccountName" "$SIMPLY_ApiKey" | _base64)
if [ "$basicauth" ]; then
export _H1="Authorization: Basic $basicauth"
fi
export _H2="Content-Type: application/json"
2020-11-17 12:19:55 +00:00
if [ "$m" != "GET" ]; then
response="$(_post "$data" "$SIMPLY_Api/$ep" "" "$m")"
2020-11-17 12:19:55 +00:00
else
response="$(_get "$SIMPLY_Api/$ep")"
2020-11-17 12:19:55 +00:00
fi
if [ "$?" != "0" ]; then
_err "error $ep"
return 1
fi
2022-01-06 21:03:39 +00:00
response="$(echo "$response" | _normalizeJson)"
2020-11-18 14:37:26 +00:00
2020-11-17 12:19:55 +00:00
_debug2 response "$response"
2020-11-18 14:37:26 +00:00
2020-11-17 12:19:55 +00:00
if _contains "$response" "Invalid account authorization"; then
_err "It seems that your api key or accountnumber is not correct."
return 1
fi
2020-11-18 14:46:16 +00:00
2020-11-17 12:19:55 +00:00
return 0
}