mirror of
https://github.com/netbirdio/plugins.git
synced 2026-05-22 18:44:07 -07:00
Add dns_opnsense.sh and support to the ACME Client (#1491)
Add dns_opnsense.sh and BIND plugin support to the ACME Client
This commit is contained in:
blablup
Frank Wall
+35
@@ -712,6 +712,41 @@
|
||||
<type>textbox</type>
|
||||
<help>Requires the whole key file in a format that is compatible with nsupdate.</help>
|
||||
</field>
|
||||
<field>
|
||||
<label>opnsense</label>
|
||||
<type>header</type>
|
||||
<style>table_dns table_dns_opnsense</style>
|
||||
</field>
|
||||
<field>
|
||||
<label>Please manually install and configure the bind plugin.</label>
|
||||
<type>info</type>
|
||||
</field>
|
||||
<field>
|
||||
<id>validation.dns_opnsense_host</id>
|
||||
<label>OPNSense Server (FQDN)</label>
|
||||
<type>text</type>
|
||||
</field>
|
||||
<field>
|
||||
<id>validation.dns_opnsense_port</id>
|
||||
<label>OPNSense Server Port</label>
|
||||
<type>text</type>
|
||||
</field>
|
||||
<field>
|
||||
<id>validation.dns_opnsense_key</id>
|
||||
<label>User API key </label>
|
||||
<type>text</type>
|
||||
</field>
|
||||
<field>
|
||||
<id>validation.dns_opnsense_token</id>
|
||||
<label>User API token</label>
|
||||
<type>text</type>
|
||||
</field>
|
||||
<field>
|
||||
<id>validation.dns_opnsense_insecure</id>
|
||||
<label>Disable TLS Verification</label>
|
||||
<type>checkbox</type>
|
||||
<help>Uncheck this box if you have a valid certificate for your OPNsense interface.</help>
|
||||
</field>
|
||||
<field>
|
||||
<label>OVH</label>
|
||||
<type>header</type>
|
||||
|
||||
@@ -381,6 +381,7 @@
|
||||
<dns_netcup>netcup DNS API</dns_netcup>
|
||||
<dns_nsone>NS1.com API</dns_nsone>
|
||||
<dns_nsupdate>nsupdate (RFC 2136)</dns_nsupdate>
|
||||
<dns_opnsense>OPNsense Bind Plugin</dns_opnsense>
|
||||
<dns_ovh>OVH, kimsufi, soyoustart and runabove API</dns_ovh>
|
||||
<dns_pdns>PowerDNS.com API</dns_pdns>
|
||||
<dns_selectel>selectel.com / selectel.ru domain API</dns_selectel>
|
||||
@@ -644,6 +645,24 @@
|
||||
<dns_nsupdate_key type="TextField">
|
||||
<Required>N</Required>
|
||||
</dns_nsupdate_key>
|
||||
<dns_opnsense_host type="TextField">
|
||||
<Required>N</Required>
|
||||
<default>localhost</default>
|
||||
</dns_opnsense_host>
|
||||
<dns_opnsense_port type="TextField">
|
||||
<Required>N</Required>
|
||||
<default>443</default>
|
||||
</dns_opnsense_port>
|
||||
<dns_opnsense_key type="TextField">
|
||||
<Required>N</Required>
|
||||
</dns_opnsense_key>
|
||||
<dns_opnsense_token type="TextField">
|
||||
<Required>N</Required>
|
||||
</dns_opnsense_token>
|
||||
<dns_opnsense_insecure type="BooleanField">
|
||||
<Required>N</Required>
|
||||
<default>0</default>
|
||||
</dns_opnsense_insecure>
|
||||
<dns_ovh_app_key type="TextField">
|
||||
<Required>N</Required>
|
||||
</dns_ovh_app_key>
|
||||
|
||||
@@ -828,6 +828,13 @@ function run_acme_validation($certObj, $valObj, $acctObj)
|
||||
$proc_env['NSUPDATE_KEY'] = $secret_key_filename;
|
||||
$proc_env['NSUPDATE_SERVER'] = (string)$valObj->dns_nsupdate_server;
|
||||
break;
|
||||
case 'dns_opnsense':
|
||||
$proc_env['OPNs_Host'] = (string)$valObj->dns_opnsense_host;
|
||||
$proc_env['OPNs_Port'] = (string)$valObj->dns_opnsense_port;
|
||||
$proc_env['OPNs_Key'] = (string)$valObj->dns_opnsense_key;
|
||||
$proc_env['OPNs_Token'] = (string)$valObj->dns_opnsense_token;
|
||||
$proc_env['OPNs_Api_Insecure'] = (string)$valObj->dns_opnsense_insecure;
|
||||
break;
|
||||
case 'dns_ovh':
|
||||
$proc_env['OVH_AK'] = (string)$valObj->dns_ovh_app_key;
|
||||
$proc_env['OVH_AS'] = (string)$valObj->dns_ovh_app_secret;
|
||||
|
||||
+271
@@ -0,0 +1,271 @@
|
||||
#!/usr/bin/env sh
|
||||
|
||||
#OPNsense Bind API
|
||||
#https://docs.opnsense.org/development/api.html
|
||||
#
|
||||
#OPNs_Host="opnsense.example.com"
|
||||
#OPNs_Port="443"
|
||||
#OPNs_Key="qocfU9RSbt8vTIBcnW8bPqCrpfAHMDvj5OzadE7Str+rbjyCyk7u6yMrSCHtBXabgDDXx/dY0POUp7ZA"
|
||||
#OPNs_Token="pZEQ+3ce8dDlfBBdg3N8EpqpF5I1MhFqdxX06le6Gl8YzyQvYCfCzNaFX9O9+IOSyAs7X71fwdRiZ+Lv"
|
||||
#OPNs_Api_Insecure=1 # 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)
|
||||
|
||||
######## Public functions #####################
|
||||
#Usage: add _acme-challenge.www.domain.com "123456789ABCDEF0000000000000000000000000000000000000"
|
||||
#fulldomain
|
||||
#txtvalue
|
||||
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() {
|
||||
_info "Adding record"
|
||||
fulldomain=$1
|
||||
new_challenge=$2
|
||||
|
||||
_debug "Detect root zone"
|
||||
if ! _get_root "$fulldomain"; then
|
||||
_err "invalid domain"
|
||||
return 1
|
||||
fi
|
||||
_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
|
||||
if echo "$_return_str" | _egrep_o "\"result\":\"saved\"" >/dev/null
|
||||
then
|
||||
_opns_rest "POST" "/service/reconfigure" "{}"
|
||||
_debug "Record created"
|
||||
else
|
||||
_err "Error createing record $_record_string"
|
||||
return 1
|
||||
fi
|
||||
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
rm_record() {
|
||||
_info "Remove record"
|
||||
fulldomain=$1
|
||||
new_challenge="$2"
|
||||
|
||||
_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
|
||||
if _opns_rest "POST" "/record/delRecord/${_uuid}" "\{\}"; then
|
||||
if echo "$_return_str" | _egrep_o "result":"deleted" >/dev/null; then
|
||||
_opns_rest "POST" "/service/reconfigure" "{}"
|
||||
_debug "Record deleted"
|
||||
else
|
||||
_err "Error delteting record $fulldomain"
|
||||
return 1
|
||||
fi
|
||||
else
|
||||
_err "Error delteting record $fulldomain"
|
||||
return 1
|
||||
fi
|
||||
else
|
||||
_info "Record not found, nothing to remove"
|
||||
|
||||
fi
|
||||
|
||||
return 0
|
||||
|
||||
}
|
||||
|
||||
#################### Private functions below ##################################
|
||||
#_acme-challenge.www.domain.com
|
||||
#returns
|
||||
# _domainid=domid
|
||||
#_domain=domain.com
|
||||
_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\":\"[^\"]*\",\"domainname\":\"${h}\"" | cut -d ':' -f 1 | cut -d '"' -f 2 )
|
||||
|
||||
if [ -n "$id" ];then
|
||||
_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
|
||||
key=$(echo $OPNs_Key | tr -d "\n\r" | _url_encode )
|
||||
token=$(echo $OPNs_Token| tr -d "\n\r" | _url_encode )
|
||||
|
||||
opnsense_url="https://${key}:${token}@${OPNs_Host}:${OPNs_Port}/api/bind${ep}"
|
||||
export _H1="Content-Type: application/json"
|
||||
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=""
|
||||
_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 )
|
||||
|
||||
if [ -n "$_uuid" ];then
|
||||
_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
|
||||
OPNs_Host="localhost"
|
||||
_err "You don't specify OPNsense address."
|
||||
fi
|
||||
|
||||
if [ -z "$OPNs_Port" ]; then
|
||||
OPNs_Port="443"
|
||||
_err "You don't specify OPNsense Port."
|
||||
fi
|
||||
|
||||
if [ -z "$OPNs_Api_Insecure" ]; then
|
||||
OPNs_Api_Insecure="0"
|
||||
fi
|
||||
|
||||
if [ -z "$OPNs_Key" ]; then
|
||||
OPNs_Key=""
|
||||
_err "You don't specify OPNsense api key id."
|
||||
_err "Please set you OPNs_Key and try again."
|
||||
return 1
|
||||
fi
|
||||
|
||||
if [ -z "$OPNs_Token" ]; then
|
||||
OPNs_Token=""
|
||||
_err "You don't specify OPNsense token."
|
||||
_err "Please create you OPNs_Token and try again."
|
||||
return 1
|
||||
fi
|
||||
|
||||
#save the api addr and key to the account conf file.
|
||||
_saveaccountconf_mutable OPNs_Host "$OPNs_Host"
|
||||
_saveaccountconf_mutable OPNs_Port "$OPNs_Port"
|
||||
_saveaccountconf_mutable OPNs_Key "$OPNs_Key"
|
||||
_saveaccountconf_mutable OPNs_Token "$OPNs_Token"
|
||||
_saveaccountconf_mutable OPNs_Api_Insecure "$OPNs_Api_Insecure"
|
||||
export HTTPS_INSECURE="${OPNs_Api_Insecure}"
|
||||
|
||||
if ! _opns_rest "GET" "/general/get";then
|
||||
_err "Can't Access OPNsense"
|
||||
return 1
|
||||
fi
|
||||
return 0
|
||||
|
||||
}
|
||||
@@ -10,8 +10,12 @@ for directory in ${ACME_DIRS}; do
|
||||
chmod -R 750 ${directory}
|
||||
done
|
||||
|
||||
if [ ! -L /var/etc/acme-client/home/dns_opnsense.sh ]; then
|
||||
ln -s /usr/local/opnsense/scripts/OPNsense/AcmeClient/dns_opnsense.sh /var/etc/acme-client/home/dns_opnsense.sh
|
||||
fi
|
||||
|
||||
# Setting owner and mode for base and immediate children (non recursive)
|
||||
chown root:wheel ${ACME_BASE} ${ACME_BASE}/*
|
||||
chmod 750 ${ACME_BASE} ${ACME_BASE}/*
|
||||
|
||||
exit 0
|
||||
exit 0
|
||||
Reference in New Issue
Block a user