[mirror_acme.sh.git] / dnsapi / dns_opnsense.sh

#!/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
#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)

########  Public functions #####################
#Usage: add _acme-challenge.www.domain.com "123456789ABCDEF0000000000000000000000000000000000000"
#fulldomain
#txtvalue
OPNs_DefaultPort=443
OPNs_DefaultApi_Insecure=0

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"

  _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 creating record $_record_string"
    return 1
  fi

  return 0
}

rm_record() {
  fulldomain=$1
  new_challenge="$2"
  _info "Remove record $fulldomain with challenge: $new_challenge"

  _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 deleting record $_host from domain $fulldomain"
        return 1
      fi
    else
      _err "Error deleting record $_host from domain $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/searchMasterDomain"; 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 "\"uuid\":\"[a-z0-9\-]*\",\"enabled\":\"1\",\"type\":\"master\",\"domainname\":\"${h}\"" | cut -d ':' -f 2 | 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:-$OPNs_DefaultPort}/api/bind${ep}"
  export _H1="Content-Type: application/json"
  _debug2 "Try to call api: https://${OPNs_Host}:${OPNs_Port:-$OPNs_DefaultPort}/api/bind${ep}"
  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
    _err "You don't specify OPNsense address."
    return 1
  else
    _saveaccountconf_mutable OPNs_Host "$OPNs_Host"
  fi

  if ! printf '%s' "$OPNs_Port" | grep '^[0-9]*$' >/dev/null; then
    _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"
  else
    _saveaccountconf_mutable OPNs_Port "$OPNs_Port"
  fi

  if ! printf '%s' "$OPNs_Api_Insecure" | grep '^[01]$' >/dev/null; then
    _err 'OPNs_Api_Insecure specified but not 0/1 value'
    return 1
  elif [ -n "$OPNs_Api_Insecure" ]; then
    _saveaccountconf_mutable OPNs_Api_Insecure "$OPNs_Api_Insecure"
  fi
  export HTTPS_INSECURE="${OPNs_Api_Insecure:-$OPNs_DefaultApi_Insecure}"

  if [ -z "$OPNs_Key" ]; then
    _err "you have not specified your OPNsense api key id."
    _err "Please set OPNs_Key and try again."
    return 1
  else
    _saveaccountconf_mutable OPNs_Key "$OPNs_Key"
  fi

  if [ -z "$OPNs_Token" ]; then
    _err "you have not specified your OPNsense token."
    _err "Please create OPNs_Token and try again."
    return 1
  else
    _saveaccountconf_mutable OPNs_Token "$OPNs_Token"
  fi

  if ! _opns_rest "GET" "/general/get"; then
    _err "Call to OPNsense API interface failed. Unable to access OPNsense API."
    return 1
  fi
  return 0
}
Commit	Line	Data
4bf1f579 JL	1	#!/usr/bin/env sh
	2
	3	#OPNsense Bind API
	4	#https://docs.opnsense.org/development/api.html
	5	#
	6	#OPNs_Host="opnsense.example.com"
18fc42e6 JL	7	#OPNs_Port="443"
18fc42e6 JL	8	# optional, defaults to 443 if unset
4bf1f579 JL	9	#OPNs_Key="qocfU9RSbt8vTIBcnW8bPqCrpfAHMDvj5OzadE7Str+rbjyCyk7u6yMrSCHtBXabgDDXx/dY0POUp7ZA"
4bf1f579 JL	10	#OPNs_Token="pZEQ+3ce8dDlfBBdg3N8EpqpF5I1MhFqdxX06le6Gl8YzyQvYCfCzNaFX9O9+IOSyAs7X71fwdRiZ+Lv"
18fc42e6 JL	11	#OPNs_Api_Insecure=0
	12	# optional, defaults to 0 if unset
	13	# 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)
4bf1f579 JL	14
	15	######## Public functions #####################
	16	#Usage: add _acme-challenge.www.domain.com "123456789ABCDEF0000000000000000000000000000000000000"
	17	#fulldomain
	18	#txtvalue
0b3ae1f9 JL	19	OPNs_DefaultPort=443
	20	OPNs_DefaultApi_Insecure=0
	21
4bf1f579 JL	22	dns_opnsense_add() {
	23	fulldomain=$1
	24	txtvalue=$2
	25
	26	_opns_check_auth \|\| return 1
	27
	28	if ! set_record "$fulldomain" "$txtvalue"; then
	29	return 1
	30	fi
	31
	32	return 0
	33	}
	34
	35	#fulldomain
	36	dns_opnsense_rm() {
	37	fulldomain=$1
	38	txtvalue=$2
	39
	40	_opns_check_auth \|\| return 1
	41
	42	if ! rm_record "$fulldomain" "$txtvalue"; then
	43	return 1
	44	fi
	45
	46	return 0
	47	}
	48
	49	set_record() {
4bf1f579 JL	50	fulldomain=$1
4bf1f579 JL	51	new_challenge=$2
18fc42e6	52	_info "Adding record $fulldomain with challenge: $new_challenge"
4bf1f579 JL	53
	54	_debug "Detect root zone"
	55	if ! _get_root "$fulldomain"; then
	56	_err "invalid domain"
	57	return 1
	58	fi
18fc42e6	59
4bf1f579 JL	60	_debug _domain "$_domain"
	61	_debug _host "$_host"
	62	_debug _domainid "$_domainid"
	63	_return_str=""
	64	_record_string=""
	65	_build_record_string "$_domainid" "$_host" "$new_challenge"
	66	_uuid=""
	67	if _existingchallenge "$_domain" "$_host" "$new_challenge"; then
	68	# Update
	69	if _opns_rest "POST" "/record/setRecord/${_uuid}" "$_record_string"; then
	70	_return_str="$response"
	71	else
	72	return 1
	73	fi
	74
	75	else
	76	#create
	77	if _opns_rest "POST" "/record/addRecord" "$_record_string"; then
	78	_return_str="$response"
	79	else
	80	return 1
	81	fi
	82	fi
	83
ec654d23	84	if echo "$_return_str" \| _egrep_o "\"result\":\"saved\"" >/dev/null; then
4bf1f579 JL	85	_opns_rest "POST" "/service/reconfigure" "{}"
	86	_debug "Record created"
	87	else
18fc42e6	88	_err "Error creating record $_record_string"
4bf1f579 JL	89	return 1
	90	fi
	91
	92	return 0
	93	}
	94
	95	rm_record() {
4bf1f579 JL	96	fulldomain=$1
4bf1f579 JL	97	new_challenge="$2"
18fc42e6	98	_info "Remove record $fulldomain with challenge: $new_challenge"
4bf1f579 JL	99
	100	_debug "Detect root zone"
	101	if ! _get_root "$fulldomain"; then
	102	_err "invalid domain"
	103	return 1
	104	fi
	105
	106	_debug _domain "$_domain"
	107	_debug _host "$_host"
	108	_debug _domainid "$_domainid"
	109	_uuid=""
	110	if _existingchallenge "$_domain" "$_host" "$new_challenge"; then
	111	# Delete
dfb4883c JL	112	if _opns_rest "POST" "/record/delRecord/${_uuid}" "\{\}"; then
dfb4883c JL	113	if echo "$_return_str" \| _egrep_o "\"result\":\"deleted\"" >/dev/null; then
4bf1f579 JL	114	_opns_rest "POST" "/service/reconfigure" "{}"
	115	_debug "Record deleted"
	116	else
9cb32896	117	_err "Error deleting record $_host from domain $fulldomain"
4bf1f579 JL	118	return 1
	119	fi
	120	else
9cb32896	121	_err "Error deleting record $_host from domain $fulldomain"
dfb4883c	122	return 1
4bf1f579 JL	123	fi
	124	else
	125	_info "Record not found, nothing to remove"
	126	fi
	127
0c768905	128	return 0
4bf1f579 JL	129	}
	130
	131	#################### Private functions below ##################################
	132	#_acme-challenge.www.domain.com
	133	#returns
	134	# _domainid=domid
dfb4883c	135	#_domain=domain.com
4bf1f579 JL	136	_get_root() {
	137	domain=$1
	138	i=2
	139	p=1
47e60cef	140	if _opns_rest "GET" "/domain/searchMasterDomain"; then
4bf1f579 JL	141	_domain_response="$response"
	142	else
	143	return 1
	144	fi
	145
	146	while true; do
	147	h=$(printf "%s" "$domain" \| cut -d . -f $i-100)
	148	if [ -z "$h" ]; then
	149	#not valid
	150	return 1
	151	fi
	152	_debug h "$h"
69aeb70c	153	id=$(echo "$_domain_response" \| _egrep_o "\"uuid\":\"[a-z0-9\-]*\",\"enabled\":\"1\",\"type\":\"master\",\"domainname\":\"${h}\"" \| cut -d ':' -f 2 \| cut -d '"' -f 2)
dfb4883c	154	if [ -n "$id" ]; then
4bf1f579 JL	155	_debug id "$id"
	156	_host=$(printf "%s" "$domain" \| cut -d . -f 1-$p)
	157	_domain="${h}"
	158	_domainid="${id}"
	159	return 0
	160	fi
	161	p=$i
	162	i=$(_math $i + 1)
	163	done
	164	_debug "$domain not found"
	165
	166	return 1
	167	}
	168
	169	_opns_rest() {
	170	method=$1
	171	ep=$2
	172	data=$3
	173	#Percent encode user and token
dfb4883c JL	174	key=$(echo "$OPNs_Key" \| tr -d "\n\r" \| _url_encode)
dfb4883c JL	175	token=$(echo "$OPNs_Token" \| tr -d "\n\r" \| _url_encode)
4bf1f579	176
0b3ae1f9	177	opnsense_url="https://${key}:${token}@${OPNs_Host}:${OPNs_Port:-$OPNs_DefaultPort}/api/bind${ep}"
4bf1f579	178	export _H1="Content-Type: application/json"
18fc42e6	179	_debug2 "Try to call api: https://${OPNs_Host}:${OPNs_Port:-$OPNs_DefaultPort}/api/bind${ep}"
4bf1f579 JL	180	if [ ! "$method" = "GET" ]; then
	181	_debug data "$data"
	182	export _H1="Content-Type: application/json"
	183	response="$(_post "$data" "$opnsense_url" "" "$method")"
	184	else
	185	export _H1=""
	186	response="$(_get "$opnsense_url")"
	187	fi
	188
	189	if [ "$?" != "0" ]; then
	190	_err "error $ep"
	191	return 1
	192	fi
	193	_debug2 response "$response"
	194
	195	return 0
	196	}
	197
	198	_build_record_string() {
	199	_record_string="{\"record\":{\"enabled\":\"1\",\"domain\":\"$1\",\"name\":\"$2\",\"type\":\"TXT\",\"value\":\"$3\"}}"
	200	}
	201
	202	_existingchallenge() {
	203	if _opns_rest "GET" "/record/searchRecord"; then
	204	_record_response="$response"
	205	else
	206	return 1
	207	fi
	208	_uuid=""
bfa6e524	209	_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)
4bf1f579	210
dfb4883c	211	if [ -n "$_uuid" ]; then
4bf1f579 JL	212	_debug uuid "$_uuid"
	213	return 0
	214	fi
	215	_debug "${2}.$1{1} record not found"
	216
	217	return 1
	218	}
	219
	220	_opns_check_auth() {
	221	OPNs_Host="${OPNs_Host:-$(_readaccountconf_mutable OPNs_Host)}"
	222	OPNs_Port="${OPNs_Port:-$(_readaccountconf_mutable OPNs_Port)}"
	223	OPNs_Key="${OPNs_Key:-$(_readaccountconf_mutable OPNs_Key)}"
	224	OPNs_Token="${OPNs_Token:-$(_readaccountconf_mutable OPNs_Token)}"
	225	OPNs_Api_Insecure="${OPNs_Api_Insecure:-$(_readaccountconf_mutable OPNs_Api_Insecure)}"
	226
	227	if [ -z "$OPNs_Host" ]; then
4bf1f579	228	_err "You don't specify OPNsense address."
c0449a3e JL	229	return 1
	230	else
	231	_saveaccountconf_mutable OPNs_Host "$OPNs_Host"
4bf1f579 JL	232	fi
4bf1f579 JL	233
0c768905	234	if ! printf '%s' "$OPNs_Port" \| grep '^[0-9]*$' >/dev/null; then
0b3ae1f9 JL	235	_err 'OPNs_Port specified but not numeric value'
	236	return 1
	237	elif [ -z "$OPNs_Port" ]; then
	238	_info "OPNSense port not specified. Defaulting to using port $OPNs_DefaultPort"
c0449a3e JL	239	else
c0449a3e JL	240	_saveaccountconf_mutable OPNs_Port "$OPNs_Port"
4bf1f579	241	fi
afdf8a78	242
0c768905	243	if ! printf '%s' "$OPNs_Api_Insecure" \| grep '^[01]$' >/dev/null; then
0b3ae1f9 JL	244	_err 'OPNs_Api_Insecure specified but not 0/1 value'
	245	return 1
	246	elif [ -n "$OPNs_Api_Insecure" ]; then
c0449a3e	247	_saveaccountconf_mutable OPNs_Api_Insecure "$OPNs_Api_Insecure"
4bf1f579	248	fi
0b3ae1f9	249	export HTTPS_INSECURE="${OPNs_Api_Insecure:-$OPNs_DefaultApi_Insecure}"
4bf1f579 JL	250
4bf1f579 JL	251	if [ -z "$OPNs_Key" ]; then
18fc42e6 JL	252	_err "you have not specified your OPNsense api key id."
18fc42e6 JL	253	_err "Please set OPNs_Key and try again."
4bf1f579	254	return 1
c0449a3e JL	255	else
c0449a3e JL	256	_saveaccountconf_mutable OPNs_Key "$OPNs_Key"
4bf1f579 JL	257	fi
	258
	259	if [ -z "$OPNs_Token" ]; then
18fc42e6 JL	260	_err "you have not specified your OPNsense token."
18fc42e6 JL	261	_err "Please create OPNs_Token and try again."
4bf1f579	262	return 1
c0449a3e JL	263	else
c0449a3e JL	264	_saveaccountconf_mutable OPNs_Token "$OPNs_Token"
4bf1f579 JL	265	fi
4bf1f579 JL	266
dfb4883c	267	if ! _opns_rest "GET" "/general/get"; then
18fc42e6	268	_err "Call to OPNsense API interface failed. Unable to access OPNsense API."
4bf1f579 JL	269	return 1
	270	fi
	271	return 0
	272	}