Add dns_he - DNS API script for Hurricane Electric DNS service

... Although not yet fully Posix compatible.
This commit is contained in:
Ondrej Simek 2017-07-12 20:24:54 +02:00
parent e5244cf3c0
commit 7d64e141e4
2 changed files with 218 additions and 0 deletions

View File

@ -572,6 +572,24 @@ acme.sh --issue --dns dns_dyn -d example.com -d www.example.com
The `DYN_Customer`, `DYN_Username` and `DYN_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. The `DYN_Customer`, `DYN_Username` and `DYN_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
# 30. Use Hurricane Electric
Hurricane Electric doesn't have an API so just set your login credentials like so:
```
export HE_Username="yourusername"
export HE_Password="password"
```
Then you can issue your certificate:
```
acme.sh --issue --dns dns_he -d example.com -d www.example.com
```
The `HE_Username` and `HE_Password` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
Please report any issues to https://github.com/angel333/acme.sh or to <me@ondrejsimek.com>.
# Use custom API # Use custom API

200
dnsapi/dns_he.sh Executable file
View File

@ -0,0 +1,200 @@
#!/usr/bin/env sh
# TODO Somehow use _get instead of curl - not sure how to support
# cookies though...
########################################################################
# 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"
_authenticate || return 1
_saveaccountconf HE_Username "$HE_Username"
_saveaccountconf HE_Password "$HE_Password"
# fills in the $_zone_id
_find_zone $_full_domain || return 1
_debug "Zone id \"$_zone_id\" will be used."
curl -L --silent --show-error --cookie "$_he_cookie" \
--form "account=" \
--form "menu=edit_zone" \
--form "Type=TXT" \
--form "hosted_dns_zoneid=$_zone_id" \
--form "hosted_dns_recordid=" \
--form "hosted_dns_editzone=1" \
--form "Priority=" \
--form "Name=$_full_domain" \
--form "Content=$_txt_value" \
--form "TTL=300" \
--form "hosted_dns_editrecord=Submit" \
"https://dns.he.net/" \
> /dev/null
}
#-- 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"
_authenticate || return 1
# fills in the $_zone_id
_find_zone $_full_domain || return 1
_debug "Zone id \"$_zone_id\" will be used."
# Find the record id to clean
_record_id=$( \
curl -L --silent --show-error --cookie "$_he_cookie" \
"https://dns.he.net/?hosted_dns_zoneid=$_zone_id&menu=edit_zone&hosted_dns_editzone" \
| grep -A 1 "data=\"\(&quot;\)\?${_txt_value}\(&quot;\)\?\"" \
| tail -n 1 \
| _egrep_o "'[[:digit:]]+','[^']+','TXT'" \
| cut -b 2- \
| _egrep_o "[[:digit:]]+" \
| head -n1) # ... oh my, what have I done...
# Remove the record
curl -L --silent --show-error --cookie "$_he_cookie" \
--form "menu=edit_zone" \
--form "hosted_dns_zoneid=$_zone_id" \
--form "hosted_dns_recordid=$_record_id" \
--form "hosted_dns_editzone=1" \
--form "hosted_dns_delrecord=1" \
--form "hosted_dns_delconfirm=delete" \
--form "hosted_dns_editzone=1" \
"https://dns.he.net/" \
| grep '<div id="dns_status" onClick="hideThis(this);">Successfully removed record.</div>' \
> /dev/null
if [ $? -eq 0 ]; then
_info "Record removed successfuly."
else
_err \
"Could not clean (remove) up the record. Please go to HE" \
"administration interface and clean it by hand."
fi
}
########################## PRIVATE FUNCTIONS ###########################
#-- _find_zone() -------------------------------------------------------
# Usage: _authenticate
#
# - needs $HE_Username and $HE_Password
# - sets the $_he_cookie
_authenticate() {
if [ -z "$HE_Username" ] && [ -z "$HE_Password" ]; then
_err \
'No auth details provided. Please set user credentials using the \
\$HE_Username and \$HE_Password envoronment variables.'
return 1
fi
# Just get a session
_he_cookie=$( \
curl -L --silent --show-error -I "https://dns.he.net/" \
| grep '^Set-Cookie:' \
| _egrep_o 'CGISESSID=[a-z0-9]*')
# Attempt login
curl -L --silent --show-error --cookie "$_he_cookie" \
--form "email=${HE_Username}" \
--form "pass=${HE_Password}" \
"https://dns.he.net/" \
> /dev/null
# TODO detect unsuccessful logins
}
#-- _find_zone() -------------------------------------------------------
# Returns the most specific zone found in administration interface.
#
# - needs $_he_cookie
#
# 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"
## _all_zones is an array that looks like this:
## ( zone1:id zone2:id ... )
_all_zones=( $(curl -L --silent --show-error --cookie "$_he_cookie" \
"https://dns.he.net/" \
| _egrep_o "delete_dom.*name=\"[^\"]+\" value=\"[0-9]+" \
| cut -d '"' -f 3,5 --output-delimiter=":" \
) )
_strip_counter=1
while [ true ]
do
_attempted_zone=$(echo $_domain | cut -d . -f ${_strip_counter}-)
# All possible zone names have been tried
if [ "$_attempted_zone" == "" ]
then
_err "No zone for domain \"$_domain\" found."
break
fi
# Walk through all zones on the account
#echo "$_all_zones" | while IFS=' ' read _zone_name _zone_id
for i in ${_all_zones[@]}
do
_zone_name=$(echo $i | cut -d ':' -f 1)
_zone_id=$(echo $i | cut -d ':' -f 2)
if [ "$_zone_name" == "$_attempted_zone" ]
then
# Zone found - we got $_zone_name and $_zone_id, let's get out...
_debug "Found relevant zone \"$_zone_name\" with id" \
"\"$_zone_id\" - will be used for domain \"$_domain\"."
return 0
fi
done
_debug "Zone \"$_attempted_zone\" doesn't exist, let's try another \
variation."
_strip_counter=$(expr $_strip_counter + 1)
done
# No zone found.
return 1
}
# vim: et:ts=2:sw=2: