Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Azion DNS API #3551

Merged
merged 5 commits into from
Jun 24, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
258 changes: 258 additions & 0 deletions dnsapi/dns_azion.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
#!/usr/bin/env sh

#
#AZION_Username=""
#AZION_Password=""
#AZION_Token=""
#AZION_ZoneID=""
#

AZION_Api="https://api.azionapi.net"

######## Public functions ########

# Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
# Used to add txt record
dns_azion_add() {
fulldomain=$1
txtvalue=$2

AZION_Username="${AZION_Username:-$(_readaccountconf_mutable AZION_Username)}"
AZION_Password="${AZION_Password:-$(_readaccountconf_mutable AZION_Password)}"
AZION_Token="${AZION_Token:-$(_readaccountconf_mutable AZION_Token)}"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how does the "AZION_Token" work?
Can we get it everytime or can we save it for future use? How long will it be valid? Is it valid forever ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simplified code about Token. You are right, token expires and it can't be save.

AZION_ZoneID="${AZION_ZoneID:-$(_readaccountconf_mutable AZION_ZoneID)}"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove the "AZION_ZoneID", we should not need it.
And we can not save it in the account conf.

The user may issue certs for different zones everytime.

we should get the zone id by REST api every time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed


if ! _contains "$AZION_Username" "@"; then
_err "It seems that the AZION_Username is not a valid email address. Revalidate your environments."
return 1
fi

if [ -z "$AZION_Token" ]; then
if [ -z "$AZION_Username" ] || [ -z "$AZION_Password" ]; then
_err "You didn't specified a AZION_Username/AZION_Password to generate Azion token."
return 1
fi
_get_token
AZION_Token="${AZION_Token:-$(_readaccountconf_mutable AZION_Token)}"
fi

_saveaccountconf_mutable AZION_Username "$AZION_Username"
_saveaccountconf_mutable AZION_Password "$AZION_Password"
_saveaccountconf_mutable AZION_Token "$AZION_Token"
_saveaccountconf_mutable AZION_ZoneID "$AZION_ZoneID"

_debug "Detect the root zone"
if ! _get_root "$fulldomain"; then
_err "Domain not found"
return 1
fi

_debug _sub_domain "$_sub_domain"
_debug _domain "$_domain"
_debug _domain_id "$_domain_id"

_info "Add or update record"
_get_record "$_sub_domain"
if [ "$record_id" ]; then
_payload="{\"record_type\": \"TXT\", \"entry\": \"$_sub_domain\", \"answers_list\": [$answers_list, \"$txtvalue\"], \"ttl\": 20}"
if _azion_rest PUT "intelligent_dns/$_domain_id/records/$record_id" "$_payload"; then
if _contains "$response" "$txtvalue"; then
_info "Record updated."
return 0
fi
fi
else
_payload="{\"record_type\": \"TXT\", \"entry\": \"$_sub_domain\", \"answers_list\": [\"$txtvalue\"], \"ttl\": 20}"
if _azion_rest POST "intelligent_dns/$_domain_id/records" "$_payload"; then
if _contains "$response" "$txtvalue"; then
_info "Record added."
return 0
fi
fi
fi
_err "Failed to add or update record."
return 1
}

# Usage: fulldomain txtvalue
# Used to remove the txt record after validation
dns_azion_rm() {
fulldomain=$1
txtvalue=$2

AZION_Username="${AZION_Username:-$(_readaccountconf_mutable AZION_Username)}"
AZION_Password="${AZION_Password:-$(_readaccountconf_mutable AZION_Password)}"
AZION_Token="${AZION_Token:-$(_readaccountconf_mutable AZION_Token)}"
AZION_ZoneID="${AZION_ZoneID:-$(_readaccountconf_mutable AZION_ZoneID)}"

if ! _contains "$AZION_Username" "@"; then
_err "It seems that the AZION_Username is not a valid email address. Revalidate your environments."
return 1
fi

if [ -z "$AZION_Token" ]; then
if [ -z "$AZION_Username" ] || [ -z "$AZION_Password" ]; then
_err "You didn't specified a AZION_Username/AZION_Password to generate Azion token."
return 1
fi
_get_token
AZION_Token="${AZION_Token:-$(_readaccountconf_mutable AZION_Token)}"
fi

_debug "Detect the root zone"
if ! _get_root "$fulldomain"; then
_err "Domain not found"
return 1
fi

_debug _sub_domain "$_sub_domain"
_debug _domain "$_domain"
_debug _domain_id "$_domain_id"

_info "Removing record"
_get_record "$_sub_domain"
if [ "$record_id" ]; then
if _azion_rest DELETE "intelligent_dns/$_domain_id/records/$record_id"; then
_info "Record removed."
return 0
else
_err "Failed to remove record."
return 1
fi
else
_info "Record not found or already removed."
return 0
fi
}

#################### Private functions below ##################################
# Usage: _acme-challenge.www.domain.com
# returns
# _sub_domain=_acme-challenge.www
# _domain=domain.com
# _domain_id=sdjkglgdfewsdfg
_get_root() {
domain=$1
i=1
p=1

# Use Zone ID directly if provided
if [ "$AZION_ZoneID" ]; then
if ! _azion_rest GET "intelligent_dns/$AZION_ZoneID"; then
return 1
else
if _contains "$response" "\"domain\":\"" >/dev/null; then
_domain=$(echo "$response" | _egrep_o "\"domain\":\"[^\"]*\"" | cut -d : -f 2 | _head_n 1 | tr -d \")
if [ "$_domain" ]; then
_cutlength=$((${#domain} - ${#_domain} - 1))
_sub_domain=$(printf "%s" "$domain" | cut -c "1-$_cutlength")
_domain_id=$AZION_ZoneID
return 0
else
return 1
fi
else
return 1
fi
fi
fi

if ! _azion_rest GET "intelligent_dns"; then
return 1
fi

while true; do
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
_debug h "$h"
if [ -z "$h" ]; then
# not valid
return 1
fi

if _contains "$response" "\"domain\":\"$h\""; then
_domain_id=$(echo "$response" | tr '{' "\n" | grep "\"domain\":\"$h\"" | _egrep_o "\"id\":[0-9]*" | _head_n 1 | cut -d : -f 2 | tr -d \")
_debug _domain_id "$_domain_id"
if [ "$_domain_id" ]; then
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
_domain=$h
_saveaccountconf_mutable AZION_ZoneID "$_domain_id"
return 0
fi
return 1
fi
p=$i
i=$(_math "$i" + 1)
done
return 1
}

_get_record() {
_record=$1

AZION_ZoneID="${AZION_ZoneID:-$(_readaccountconf_mutable AZION_ZoneID)}"

if ! _azion_rest GET "intelligent_dns/$AZION_ZoneID/records"; then
return 1
fi

if _contains "$response" "\"entry\":\"$_record\""; then
_json_record=$(echo "$response" | tr '{}' "\n" | grep "\"entry\":\"$_record\"")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use double \n here:

tr '{}' "\n\n"

Copy link
Contributor Author

@marcusgrando marcusgrando Jun 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Neilpang, shellcheck doesn't like this:

In dnsapi/dns_azion.sh line 131:
    _json_record=$(echo "$response" | tr '{}' "\n\n" | grep "\"entry\":\"$_record\"")
                                              ^----^ SC2020: tr replaces sets of chars, not words (mentioned due to duplicates).

For more information:
  https://www.shellcheck.net/wiki/SC2020

Instead I changed to only one bracket. Running tests right now.

if [ "$_json_record" ]; then
record_id=$(echo "$_json_record" | _egrep_o "\"record_id\":[0-9]*" | _head_n 1 | cut -d : -f 2 | tr -d \")
answers_list=$(echo "$_json_record" | _egrep_o "\"answers_list\":\[.*\]" | _head_n 1 | cut -d : -f 2 | tr -d \[\])
return 0
fi
return 1
fi
return 1
}

_get_token() {
AZION_Username="${AZION_Username:-$(_readaccountconf_mutable AZION_Username)}"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think it's better to use a name like: AZION_Email instead of AZION_Username ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, make sense. Updated and running tests again.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think it's better to use a name like: AZION_Email instead of AZION_Username ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, make sense. Updated and running tests again.

AZION_Password="${AZION_Password:-$(_readaccountconf_mutable AZION_Password)}"

_basic_auth=$(printf "%s:%s" "$AZION_Username" "$AZION_Password" | _base64)
_debug _basic_auth "$_basic_auth"

export _H1="Accept: application/json; version=3"
export _H2="Content-Type: application/json"
export _H3="Authorization: Basic $_basic_auth"

response="$(_post "" "$AZION_Api/tokens" "" "POST")"
_debug2 response "$response"
if _contains "$response" "\"token\":\"" >/dev/null; then
_azion_token=$(echo "$response" | _egrep_o "\"token\":\"[^\"]*\"" | cut -d : -f 2 | tr -d \")
_debug _azion_token "$_azion_token"
_saveaccountconf_mutable AZION_Token "$_azion_token"
else
_err "Failed to generate Azion token"
return 1
fi
}

_azion_rest() {
_method=$1
_uri="$2"
_data="$3"

AZION_Token="${AZION_Token:-$(_readaccountconf_mutable AZION_Token)}"

export _H1="Accept: application/json; version=3"
export _H2="Content-Type: application/json"
export _H3="Authorization: token $AZION_Token"

if [ "$_method" != "GET" ]; then
_debug _data "$_data"
response="$(_post "$_data" "$AZION_Api/$_uri" "" "$_method")"
else
response="$(_get "$AZION_Api/$_uri")"
fi

_debug2 response "$response"

if [ "$?" != "0" ]; then
_err "error $_method $_uri $_data"
return 1
fi
return 0
}