acme.sh/dnsapi/dns_he.sh

176 lines
5.6 KiB
Bash
Raw Normal View History

#!/usr/bin/env sh
########################################################################
# Hurricane Electric hook script for acme.sh
#
# Environment variables:
#
# - $HE_Username (your dns.he.net username)
# - $HE_Password (your dns.he.net password)
#
# Author: Ondrej Simek <me@ondrejsimek.com>
# Git repo: https://github.com/angel333/acme.sh
#-- dns_he_add() - Add TXT record --------------------------------------
# Usage: dns_he_add _acme-challenge.subdomain.domain.com "XyZ123..."
dns_he_add() {
_full_domain=$1
_txt_value=$2
_info "Using DNS-01 Hurricane Electric hook"
2017-07-23 05:31:55 +00:00
if [ -z "$HE_Username" ] || [ -z "$HE_Password" ]; then
2017-07-28 11:58:47 +00:00
HE_Username=
HE_Password=
2017-07-26 18:15:34 +00:00
_err "No auth details provided. Please set user credentials using the \$HE_Username and \$HE_Password envoronment variables."
2017-07-23 03:00:02 +00:00
return 1
fi
_saveaccountconf HE_Username "$HE_Username"
_saveaccountconf HE_Password "$HE_Password"
2017-07-29 11:52:28 +00:00
# Fills in the $_zone_id
2017-07-26 18:15:34 +00:00
_find_zone "$_full_domain" || return 1
_debug "Zone id \"$_zone_id\" will be used."
2017-07-23 03:00:02 +00:00
body="email=${HE_Username}&pass=${HE_Password}"
body="$body&account="
body="$body&menu=edit_zone"
body="$body&Type=TXT"
body="$body&hosted_dns_zoneid=$_zone_id"
body="$body&hosted_dns_recordid="
body="$body&hosted_dns_editzone=1"
body="$body&Priority="
body="$body&Name=$_full_domain"
body="$body&Content=$_txt_value"
body="$body&TTL=300"
body="$body&hosted_dns_editrecord=Submit"
2017-07-26 18:15:34 +00:00
response="$(_post "$body" "https://dns.he.net/")"
2017-07-28 16:33:25 +00:00
exit_code="$?"
if [ "$exit_code" -eq 0 ]; then
2017-08-29 20:35:11 +00:00
_info "TXT record added successfully."
2017-07-28 16:33:25 +00:00
else
_err "Couldn't add the TXT record."
fi
2017-07-23 05:31:55 +00:00
_debug2 response "$response"
return "$exit_code"
}
#-- dns_he_rm() - Remove TXT record ------------------------------------
# Usage: dns_he_rm _acme-challenge.subdomain.domain.com "XyZ123..."
dns_he_rm() {
_full_domain=$1
_txt_value=$2
_info "Cleaning up after DNS-01 Hurricane Electric hook"
# fills in the $_zone_id
2017-07-26 18:15:34 +00:00
_find_zone "$_full_domain" || return 1
_debug "Zone id \"$_zone_id\" will be used."
# Find the record id to clean
2017-07-23 03:00:02 +00:00
body="email=${HE_Username}&pass=${HE_Password}"
body="$body&hosted_dns_zoneid=$_zone_id"
body="$body&menu=edit_zone"
body="$body&hosted_dns_editzone="
2017-07-29 12:29:13 +00:00
domain_regex="$(echo "$_full_domain" | sed 's/\./\\./g')" # escape dots
2017-07-26 18:15:34 +00:00
_record_id=$(_post "$body" "https://dns.he.net/" \
2017-07-23 05:31:55 +00:00
| tr -d '\n' \
2017-07-29 12:29:13 +00:00
| _egrep_o "data=\"&quot;${_txt_value}&quot;([^>]+>){6}[^<]+<[^;]+;deleteRecord\('[0-9]+','${domain_regex}','TXT'\)" \
| _egrep_o "[0-9]+','${domain_regex}','TXT'\)$" \
2017-07-23 05:31:55 +00:00
| _egrep_o "^[0-9]+"
)
# The series of egreps above could have been done a bit shorter but
# I wanted to double-check whether it's the correct record (in case
# HE changes their website somehow).
# Remove the record
2017-07-23 03:00:02 +00:00
body="email=${HE_Username}&pass=${HE_Password}"
body="$body&menu=edit_zone"
body="$body&hosted_dns_zoneid=$_zone_id"
body="$body&hosted_dns_recordid=$_record_id"
body="$body&hosted_dns_editzone=1"
body="$body&hosted_dns_delrecord=1"
body="$body&hosted_dns_delconfirm=delete"
2017-07-26 18:15:34 +00:00
_post "$body" "https://dns.he.net/" \
| grep '<div id="dns_status" onClick="hideThis(this);">Successfully removed record.</div>' \
2017-07-27 16:06:19 +00:00
>/dev/null
exit_code="$?"
if [ "$exit_code" -eq 0 ]; then
2017-08-29 20:35:11 +00:00
_info "Record removed successfully."
else
2017-07-29 11:52:28 +00:00
_err "Could not clean (remove) up the record. Please go to HE administration interface and clean it by hand."
return "$exit_code"
fi
}
########################## PRIVATE FUNCTIONS ###########################
#-- _find_zone() -------------------------------------------------------
# Returns the most specific zone found in administration interface.
#
# Example:
#
# _find_zone first.second.third.co.uk
#
# ... will return the first zone that exists in admin out of these:
# - "first.second.third.co.uk"
# - "second.third.co.uk"
# - "third.co.uk"
# - "co.uk" <-- unlikely
# - "uk" <-'
#
# (another approach would be something like this:
# https://github.com/hlandau/acme/blob/master/_doc/dns.hook
# - that's better if there are multiple pages. It's so much simpler.
# )
_find_zone() {
_domain="$1"
2017-07-23 03:00:02 +00:00
body="email=${HE_Username}&pass=${HE_Password}"
2017-07-27 16:04:53 +00:00
_matches=$(_post "$body" "https://dns.he.net/" \
| _egrep_o "delete_dom.*name=\"[^\"]+\" value=\"[0-9]+"
)
# Zone names and zone IDs are in same order
2017-07-29 11:52:28 +00:00
_zone_ids=$(echo "$_matches" | cut -d '"' -f 5)
_zone_names=$(echo "$_matches" | cut -d '"' -f 3)
2017-07-27 16:04:53 +00:00
_debug2 "These are the zones on this HE account:"
_debug2 "$_zone_names"
_debug2 "And these are their respective IDs:"
_debug2 "$_zone_ids"
# Walk through all possible zone names
_strip_counter=1
2017-07-26 18:15:34 +00:00
while true; do
_attempted_zone=$(echo "$_domain" | cut -d . -f ${_strip_counter}-)
# All possible zone names have been tried
2017-07-26 18:15:34 +00:00
if [ -z "$_attempted_zone" ]; then
_err "No zone for domain \"$_domain\" found."
2017-07-27 16:04:53 +00:00
return 1
fi
2017-07-27 16:04:53 +00:00
_debug "Looking for zone \"${_attempted_zone}\""
2017-07-29 12:25:07 +00:00
# Take care of "." and only match whole lines. Note that grep -F
# cannot be used because there's no way to make it match whole
# lines.
regex="^$(echo "$_attempted_zone" | sed 's/\./\\./g')$"
line_num=$(echo "$_zone_names" \
| grep -n "$regex" \
| cut -d : -f 1
)
if [ -n "$line_num" ]; then
_zone_id=$(echo "$_zone_ids" | sed "${line_num}q;d")
2017-07-29 11:52:28 +00:00
_debug "Found relevant zone \"$_attempted_zone\" with id \"$_zone_id\" - will be used for domain \"$_domain\"."
2017-07-27 16:04:53 +00:00
return 0
fi
2017-07-29 11:52:28 +00:00
_debug "Zone \"$_attempted_zone\" doesn't exist, let's try a less specific zone."
2017-07-27 16:44:55 +00:00
_strip_counter=$(_math "$_strip_counter" + 1)
done
2017-07-27 16:04:53 +00:00
}
# vim: et:ts=2:sw=2: