From e7c4d1189ab6038224ac2d649e8fd49715842a5a Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Sun, 2 Aug 2020 11:57:48 +0200
Subject: [PATCH] security/acme-client: remove bundled version of
 dns_opnsense.sh, refs #1888

---
 .../OPNsense/AcmeClient/dns_opnsense.sh       | 262 ------------------
 .../scripts/OPNsense/AcmeClient/setup.sh      |   6 +-
 2 files changed, 4 insertions(+), 264 deletions(-)
 delete mode 100755 security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/dns_opnsense.sh

diff --git a/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/dns_opnsense.sh b/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/dns_opnsense.sh
deleted file mode 100755
index baa77125d..000000000
--- a/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/dns_opnsense.sh
+++ /dev/null
@@ -1,262 +0,0 @@
-#!/bin/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
-}
diff --git a/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/setup.sh b/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/setup.sh
index 0acda031e..43140eea7 100755
--- a/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/setup.sh
+++ b/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient/setup.sh
@@ -10,8 +10,10 @@ 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
+# Remove symlink in order to use upstream version
+# see https://github.com/opnsense/plugins/pull/1888
+if [ -L /var/etc/acme-client/home/dns_opnsense.sh ]; then
+    unlink /var/etc/acme-client/home/dns_opnsense.sh
 fi
 
 # Setting owner and mode for base and immediate children (non recursive)