acme.sh/dnsapi/dns_opnsense.sh

274 lines
7.1 KiB
Bash
Raw Normal View History

2019-09-12 14:28:57 +00:00
#!/usr/bin/env sh
#OPNsense Bind API
#https://docs.opnsense.org/development/api.html
#
#OPNs_Host="opnsense.example.com"
#OPNs_Port="443"
# optional, defaults to 443 if unset
2019-09-12 14:28:57 +00:00
#OPNs_Key="qocfU9RSbt8vTIBcnW8bPqCrpfAHMDvj5OzadE7Str+rbjyCyk7u6yMrSCHtBXabgDDXx/dY0POUp7ZA"
#OPNs_Token="pZEQ+3ce8dDlfBBdg3N8EpqpF5I1MhFqdxX06le6Gl8YzyQvYCfCzNaFX9O9+IOSyAs7X71fwdRiZ+Lv"
#OPNs_Api_Insecure=0
# optional, defaults to 0 if unset
# Set 1 for insecure and 0 for secure -> difference is whether ssl cert is checked for validity (0) or whether it is just accepted (1)
2019-09-12 14:28:57 +00:00
######## Public functions #####################
#Usage: add _acme-challenge.www.domain.com "123456789ABCDEF0000000000000000000000000000000000000"
#fulldomain
#txtvalue
2019-11-07 13:10:30 +00:00
OPNs_DefaultPort=443
OPNs_DefaultApi_Insecure=0
2019-09-12 14:28:57 +00:00
dns_opnsense_add() {
fulldomain=$1
txtvalue=$2
_opns_check_auth || return 1
if ! set_record "$fulldomain" "$txtvalue"; then
return 1
fi
return 0
}
#fulldomain
dns_opnsense_rm() {
fulldomain=$1
txtvalue=$2
_opns_check_auth || return 1
if ! rm_record "$fulldomain" "$txtvalue"; then
return 1
fi
return 0
}
set_record() {
fulldomain=$1
new_challenge=$2
_info "Adding record $fulldomain with challenge: $new_challenge"
2019-09-12 14:28:57 +00:00
_debug "Detect root zone"
if ! _get_root "$fulldomain"; then
_err "invalid domain"
return 1
fi
2019-09-12 14:28:57 +00:00
_debug _domain "$_domain"
_debug _host "$_host"
_debug _domainid "$_domainid"
_return_str=""
_record_string=""
_build_record_string "$_domainid" "$_host" "$new_challenge"
_uuid=""
if _existingchallenge "$_domain" "$_host" "$new_challenge"; then
# Update
if _opns_rest "POST" "/record/setRecord/${_uuid}" "$_record_string"; then
_return_str="$response"
else
return 1
fi
else
#create
if _opns_rest "POST" "/record/addRecord" "$_record_string"; then
_return_str="$response"
else
return 1
fi
fi
2019-09-12 15:24:00 +00:00
if echo "$_return_str" | _egrep_o "\"result\":\"saved\"" >/dev/null; then
2019-09-12 14:28:57 +00:00
_opns_rest "POST" "/service/reconfigure" "{}"
_debug "Record created"
else
_err "Error creating record $_record_string"
2019-09-12 14:28:57 +00:00
return 1
fi
return 0
}
rm_record() {
fulldomain=$1
new_challenge="$2"
_info "Remove record $fulldomain with challenge: $new_challenge"
2019-09-12 14:28:57 +00:00
_debug "Detect root zone"
if ! _get_root "$fulldomain"; then
_err "invalid domain"
return 1
fi
_debug _domain "$_domain"
_debug _host "$_host"
_debug _domainid "$_domainid"
_uuid=""
if _existingchallenge "$_domain" "$_host" "$new_challenge"; then
# Delete
2019-09-12 15:17:32 +00:00
if _opns_rest "POST" "/record/delRecord/${_uuid}" "\{\}"; then
if echo "$_return_str" | _egrep_o "\"result\":\"deleted\"" >/dev/null; then
2019-09-12 14:28:57 +00:00
_opns_rest "POST" "/service/reconfigure" "{}"
_debug "Record deleted"
else
2019-11-08 07:58:51 +00:00
_err "Error deleting record $_host from domain $fulldomain"
2019-09-12 14:28:57 +00:00
return 1
fi
else
2019-11-08 07:58:51 +00:00
_err "Error deleting record $_host from domain $fulldomain"
2019-09-12 15:17:32 +00:00
return 1
2019-09-12 14:28:57 +00:00
fi
else
_info "Record not found, nothing to remove"
fi
2019-11-08 07:52:10 +00:00
return 0
2019-09-12 14:28:57 +00:00
}
#################### Private functions below ##################################
#_acme-challenge.www.domain.com
#returns
# _domainid=domid
2019-09-12 15:17:32 +00:00
#_domain=domain.com
2019-09-12 14:28:57 +00:00
_get_root() {
domain=$1
i=2
p=1
if _opns_rest "GET" "/domain/get"; then
_domain_response="$response"
else
return 1
fi
while true; do
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
if [ -z "$h" ]; then
#not valid
return 1
fi
_debug h "$h"
id=$(echo "$_domain_response" | _egrep_o "\"[^\"]*\":{\"enabled\":\"1\",\"type\":{\"master\":{\"value\":\"master\",\"selected\":1},\"slave\":{\"value\":\"slave\",\"selected\":0}},\"masterip\":\"[^\"]*\",\"allownotifyslave\":{\"\":{[^}]*}},\"domainname\":\"${h}\"" | cut -d ':' -f 1 | cut -d '"' -f 2)
2019-09-12 14:28:57 +00:00
2019-09-12 15:17:32 +00:00
if [ -n "$id" ]; then
2019-09-12 14:28:57 +00:00
_debug id "$id"
_host=$(printf "%s" "$domain" | cut -d . -f 1-$p)
_domain="${h}"
_domainid="${id}"
return 0
fi
p=$i
i=$(_math $i + 1)
done
_debug "$domain not found"
return 1
}
_opns_rest() {
method=$1
ep=$2
data=$3
#Percent encode user and token
2019-09-12 15:17:32 +00:00
key=$(echo "$OPNs_Key" | tr -d "\n\r" | _url_encode)
token=$(echo "$OPNs_Token" | tr -d "\n\r" | _url_encode)
2019-09-12 14:28:57 +00:00
2019-11-07 13:10:30 +00:00
opnsense_url="https://${key}:${token}@${OPNs_Host}:${OPNs_Port:-$OPNs_DefaultPort}/api/bind${ep}"
2019-09-12 14:28:57 +00:00
export _H1="Content-Type: application/json"
_debug2 "Try to call api: https://${OPNs_Host}:${OPNs_Port:-$OPNs_DefaultPort}/api/bind${ep}"
2019-09-12 14:28:57 +00:00
if [ ! "$method" = "GET" ]; then
_debug data "$data"
export _H1="Content-Type: application/json"
response="$(_post "$data" "$opnsense_url" "" "$method")"
else
export _H1=""
response="$(_get "$opnsense_url")"
fi
if [ "$?" != "0" ]; then
_err "error $ep"
return 1
fi
_debug2 response "$response"
return 0
}
_build_record_string() {
_record_string="{\"record\":{\"enabled\":\"1\",\"domain\":\"$1\",\"name\":\"$2\",\"type\":\"TXT\",\"value\":\"$3\"}}"
}
_existingchallenge() {
if _opns_rest "GET" "/record/searchRecord"; then
_record_response="$response"
else
return 1
fi
_uuid=""
2019-09-12 18:50:20 +00:00
_uuid=$(echo "$_record_response" | _egrep_o "\"uuid\":\"[^\"]*\",\"enabled\":\"[01]\",\"domain\":\"$1\",\"name\":\"$2\",\"type\":\"TXT\",\"value\":\"$3\"" | cut -d ':' -f 2 | cut -d '"' -f 2)
2019-09-12 14:28:57 +00:00
2019-09-12 15:17:32 +00:00
if [ -n "$_uuid" ]; then
2019-09-12 14:28:57 +00:00
_debug uuid "$_uuid"
return 0
fi
_debug "${2}.$1{1} record not found"
return 1
}
_opns_check_auth() {
OPNs_Host="${OPNs_Host:-$(_readaccountconf_mutable OPNs_Host)}"
OPNs_Port="${OPNs_Port:-$(_readaccountconf_mutable OPNs_Port)}"
OPNs_Key="${OPNs_Key:-$(_readaccountconf_mutable OPNs_Key)}"
OPNs_Token="${OPNs_Token:-$(_readaccountconf_mutable OPNs_Token)}"
OPNs_Api_Insecure="${OPNs_Api_Insecure:-$(_readaccountconf_mutable OPNs_Api_Insecure)}"
if [ -z "$OPNs_Host" ]; then
_err "You don't specify OPNsense address."
2019-10-25 06:04:20 +00:00
return 1
else
_saveaccountconf_mutable OPNs_Host "$OPNs_Host"
2019-09-12 14:28:57 +00:00
fi
2019-11-08 07:52:10 +00:00
if ! printf '%s' "$OPNs_Port" | grep '^[0-9]*$' >/dev/null; then
2019-11-07 13:10:30 +00:00
_err 'OPNs_Port specified but not numeric value'
return 1
elif [ -z "$OPNs_Port" ]; then
_info "OPNSense port not specified. Defaulting to using port $OPNs_DefaultPort"
2019-10-25 06:04:20 +00:00
else
_saveaccountconf_mutable OPNs_Port "$OPNs_Port"
2019-09-12 14:28:57 +00:00
fi
2019-11-07 13:18:09 +00:00
2019-11-08 07:52:10 +00:00
if ! printf '%s' "$OPNs_Api_Insecure" | grep '^[01]$' >/dev/null; then
2019-11-07 13:10:30 +00:00
_err 'OPNs_Api_Insecure specified but not 0/1 value'
return 1
elif [ -n "$OPNs_Api_Insecure" ]; then
2019-10-25 06:04:20 +00:00
_saveaccountconf_mutable OPNs_Api_Insecure "$OPNs_Api_Insecure"
2019-09-12 14:28:57 +00:00
fi
2019-11-07 13:10:30 +00:00
export HTTPS_INSECURE="${OPNs_Api_Insecure:-$OPNs_DefaultApi_Insecure}"
2019-09-12 14:28:57 +00:00
if [ -z "$OPNs_Key" ]; then
_err "you have not specified your OPNsense api key id."
_err "Please set OPNs_Key and try again."
2019-09-12 14:28:57 +00:00
return 1
2019-10-25 06:04:20 +00:00
else
_saveaccountconf_mutable OPNs_Key "$OPNs_Key"
2019-09-12 14:28:57 +00:00
fi
if [ -z "$OPNs_Token" ]; then
_err "you have not specified your OPNsense token."
_err "Please create OPNs_Token and try again."
2019-09-12 14:28:57 +00:00
return 1
2019-10-25 06:04:20 +00:00
else
_saveaccountconf_mutable OPNs_Token "$OPNs_Token"
2019-09-12 14:28:57 +00:00
fi
2019-09-12 15:17:32 +00:00
if ! _opns_rest "GET" "/general/get"; then
_err "Call to OPNsense API interface failed. Unable to access OPNsense API."
2019-09-12 14:28:57 +00:00
return 1
fi
return 0
}