From: "d12fk (Code Review)" Date: Fri, 13 Jun 2025 04:04:42 +0000 References: Reply-To: heiko@...515..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <1f41db1a75ff0b1482a80c1563b62bdcd233b992-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="qaOP30cRm4o="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: dns: add updown script for macOS List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos , flichtenheld Cc: openvpn-devel --qaOP30cRm4o= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, plaisthos. Hello plaisthos, flichtenheld, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/1062?usp=3Demail to review the following change. Change subject: dns: add updown script for macOS ...................................................................... dns: add updown script for macOS Change-Id: Iade06a8454ccf53668deef61f07217ead8ec6c63 Signed-off-by: Heiko Hund --- M configure.ac M distro/dns-scripts/Makefile.am A distro/dns-scripts/macos-dns-updown.sh 3 files changed, 218 insertions(+), 2 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/62/1062/1 diff --git a/configure.ac b/configure.ac index 8bdec32..02b45f8 100644 --- a/configure.ac +++ b/configure.ac @@ -364,8 +364,7 @@ *-*-darwin*) AC_DEFINE([TARGET_DARWIN], [1], [Are we running on Mac OS X?]) AC_DEFINE_UNQUOTED([TARGET_PREFIX], ["M"], [Target prefix]) - AM_CONDITIONAL([ENABLE_DNS_UPDOWN], [false]) - AC_SUBST([DNS_UPDOWN_TYPE], ["resolvconf_file"]) + AC_SUBST([DNS_UPDOWN_TYPE], ["macos"]) have_tap_header=3D"yes" ac_cv_type_struct_in_pktinfo=3Dno ;; diff --git a/distro/dns-scripts/Makefile.am b/distro/dns-scripts/Makefile.am index 9fcd3f7..e3f9043 100644 --- a/distro/dns-scripts/Makefile.am +++ b/distro/dns-scripts/Makefile.am @@ -12,6 +12,7 @@ $(srcdir)/Makefile.in EXTRA_DIST =3D \ + macos-dns-updown.sh \ systemd-dns-updown.sh \ openresolv-dns-updown.sh \ haikuos_file-dns-updown.sh \ diff --git a/distro/dns-scripts/macos-dns-updown.sh b/distro/dns-scripts/ma= cos-dns-updown.sh new file mode 100644 index 0000000..6ffb8de --- /dev/null +++ b/distro/dns-scripts/macos-dns-updown.sh @@ -0,0 +1,216 @@ +#!/bin/bash +# +# dns-updown - add/remove openvpn provided DNS information +# +# (C) Copyright 2025 OpenVPN Inc +# +# SPDX-License-Identifier: BSD-2-Clause +# +# Example env from openvpn (most are not applied): +# +# dns_vars_file /tmp/openvpn_dvf_58b95c0c97b2db43afb5d745f986c53c.tmp +# +# or +# +# dev utun0 +# script_type dns-up +# dns_search_domain_1 mycorp.in +# dns_search_domain_2 eu.mycorp.com +# dns_server_1_address_1 192.168.99.254 +# dns_server_1_address_2 fd00::99:53 +# dns_server_1_port_2 53 +# dns_server_1_resolve_domain_1 mycorp.in +# dns_server_1_resolve_domain_2 eu.mycorp.com +# dns_server_1_dnssec true +# dns_server_1_transport DoH +# dns_server_1_sni dns.mycorp.in +# + +[ -z "${dns_vars_file}" ] || . "${dns_vars_file}" + +itf_dns_key=3D"State:/Network/Service/openvpn-${dev}/DNS" +dns_backup_key=3D"State:/Network/Service/openvpn-${dev}/DnsBackup" + +function primary_dns_key { + local uuid=3D$(echo "show State:/Network/Global/IPv4" | /usr/sbin/scut= il | grep "PrimaryService" | cut -d: -f2 | xargs) + echo "State:/Network/Service/${uuid}/DNS" +} + +function only_standard_server_ports { + local i=3D1 + while :; do + local addr_var=3Ddns_server_${n}_address_${i} + [ -n "${!addr_var}" ] || return 0 + + local port_var=3Ddns_server_${n}_port_${i} + [ -z "${!port_var}" -o "${!port_var}" =3D "53" ] || return 1 + + i=3D$((i+1)) + done +} + +function find_compat_profile { + local n=3D1 + while :; do + local addr_var=3Ddns_server_${n}_address_1 + [ -n "${!addr_var}" ] || { + echo "setting DNS failed, no compatible server profile" + exit 1 + } + + # Skip server profiles which require DNSSEC, + # secure transport or use a custom port + local dnssec_var=3Ddns_server_${n}_dnssec + local transport_var=3Ddns_server_${n}_transport + [ -z "${!transport_var}" -o "${!transport_var}" =3D "plain" ] \ + && [ -z "${!dnssec_var}" -o "${!dnssec_var}" =3D "no" ] \ + && only_standard_server_ports && break + + n=3D$((n+1)) + done + return $n +} + +function get_search_domains { + local search_domains=3D"" + local resolver=3D0 + /usr/sbin/scutil --dns | while read line; do + if [[ "$line" =3D~ resolver.# ]]; then + resolver=3D$((resolver+1)) + elif [ "$resolver" =3D 1 ] && [[ "$line" =3D~ search.domain ]]; th= en + search_domains+=3D"$(echo $line | cut -d: -f2 | xargs) " + elif [ "$resolver" -gt 1 ]; then + echo "$search_domains" + break + fi + done +} + +function set_search_domains { + [ -n "$1" ] || return + dns_key=3D$(primary_dns_key) + search_domains=3D"${1}$(get_search_domains)" + + local cmds=3D"" + cmds+=3D"get ${dns_key}\n" + cmds+=3D"d.add SearchDomains * ${search_domains}\n" + cmds+=3D"set ${dns_key}\n" + echo -e "${cmds}" | /usr/sbin/scutil +} + +function unset_search_domains { + [ -n "$1" ] || return + dns_key=3D$(primary_dns_key) + search_domains=3D"$(get_search_domains)" + search_domains=3D$(echo $search_domains | sed -e "s/$1//") + + local cmds=3D"" + cmds+=3D"get ${dns_key}\n" + cmds+=3D"d.add SearchDomains * ${search_domains}\n" + cmds+=3D"set ${dns_key}\n" + echo -e "${cmds}" | /usr/sbin/scutil +} + +function set_dns { + find_compat_profile + local n=3D$? + + local i=3D1 + local addrs=3D"" + while :; do + local addr_var=3Ddns_server_${n}_address_${i} + local addr=3D"${!addr_var}" + [ -n "$addr" ] || break + + local port_var=3Ddns_server_${n}_port_${i} + if [ -n "${!port_var}" ]; then + if [[ "$addr" =3D~ : ]]; then + addr=3D"[$addr]" + fi + addrs+=3D"${addr}:${!port_var}${sni} " + else + addrs+=3D"${addr}${sni} " + fi + i=3D$((i+1)) + done + + i=3D1 + local match_domains=3D"" + while :; do + domain_var=3Ddns_server_${n}_resolve_domain_${i} + [ -n "${!domain_var}" ] || break + # Add as match domain, if it doesn't already exist + [[ "$match_domains" =3D~ (^| )${!domain_var}( |$) ]] \ + || match_domains+=3D"${!domain_var} " + i=3D$((i+1)) + done + + i=3D1 + local search_domains=3D"" + while :; do + domain_var=3Ddns_search_domain_${i} + [ -n "${!domain_var}" ] || break + # Add as search domain, if it doesn't already exist + [[ "$search_domains" =3D~ (^| )${!domain_var}( |$) ]] \ + || search_domains+=3D"${!domain_var} " + i=3D$((i+1)) + done + + if [ -n "$match_domains" ]; then + local cmds=3D"" + cmds+=3D"d.init\n" + cmds+=3D"d.add ServerAddresses * ${addrs}\n" + cmds+=3D"d.add SupplementalMatchDomains * ${match_domains}\n" + cmds+=3D"d.add SupplementalMatchDomainsNoSearch # 1\n" + cmds+=3D"add ${itf_dns_key}\n" + echo -e "${cmds}" | /usr/sbin/scutil + set_search_domains "$search_domains" + else + local cmds=3D"" + cmds+=3D"get $(primary_dns_key)\n" + cmds+=3D"set ${dns_backup_key}\n" + cmds+=3D"d.init\n" + cmds+=3D"d.add ServerAddresses * ${addrs}\n" + cmds+=3D"d.add SearchDomains * ${search_domains}\n" + cmds+=3D"set $(primary_dns_key)\n" + echo -e "${cmds}" | /usr/sbin/scutil + fi + + /usr/bin/dscacheutil -flushcache +} + +function unset_dns { + find_compat_profile + local n=3D$? + + local i=3D1 + local search_domains=3D"" + while :; do + domain_var=3Ddns_search_domain_${i} + [ -n "${!domain_var}" ] || break + # Add as search domain, if it doesn't already exist + [[ "$search_domains" =3D~ (^| )${!domain_var}( |$) ]] \ + || search_domains+=3D"${!domain_var} " + i=3D$((i+1)) + done + + domain_var=3Ddns_server_${n}_resolve_domain_1 + if [ -n "${!domain_var}" ]; then + echo "remove ${itf_dns_key}" | /usr/sbin/scutil + unset_search_domains "$search_domains" + else + local cmds=3D"" + cmds+=3D"get ${dns_backup_key}\n" + cmds+=3D"set $(primary_dns_key)\n" + cmds+=3D"remove ${dns_backup_key}\n" + echo -e "${cmds}" | /usr/sbin/scutil + fi + + /usr/bin/dscacheutil -flushcache +} + +if [ "$script_type" =3D "dns-up" ]; then + set_dns +else + unset_dns +fi -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/1062?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: Iade06a8454ccf53668deef61f07217ead8ec6c63 Gerrit-Change-Number: 1062 Gerrit-PatchSet: 1 Gerrit-Owner: d12fk Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-MessageType: newchange --qaOP30cRm4o= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, plaisthos.

d12fk would like plaisthos and flichtenheld to review t= his change.

V= iew Change

dns: add updown script for macOS

Change-Id: Iade06a84= 54ccf53668deef61f07217ead8ec6c63
Signed-off-by: Heiko Hund <heiko@...493...= 2662...>
---
M configure.ac
M distro/dns-scripts/Makefile.amA distro/dns-scripts/macos-dns-updown.sh
3 files changed, 218 insertion= s(+), 2 deletions(-)

git pull ssh://gerrit.openvpn.net:29418/open=
vpn refs/changes/62/1062/1
diff --git a/configure.ac b/configure.ac=

index 8bdec32..02b45f8 100644
--- a/config= ure.ac
+++ b/configure.ac
@@ -364,8 +364,7 = @@
*-*-darwin*)
AC_DEFINE([TARGET_DARW= IN], [1], [Are we running on Mac OS X?])
AC_DEFINE_UNQUO= TED([TARGET_PREFIX], ["M"], [Target prefix])
- AM_CONDITIONAL([ENABLE_DNS_UPDOWN], [fal= se])
- AC_SUBST([DNS_U= PDOWN_TYPE], ["resolvconf_file"])
+ AC_SUBST([DNS_UPDOWN_TYPE], ["macos"])<= /span>
have_tap_header=3D"yes"
ac_= cv_type_struct_in_pktinfo=3Dno
;;
diff -= -git a/distro/dns-scripts/Makefile.am b/distro/dns-scripts/Makefile.am
index 9fcd3f7..e3f9043 100644
--- a/distro/dns-= scripts/Makefile.am
+++ b/distro/dns-scripts/Makefile.am
@@ -12,6 +12,7 @@
$(srcdir)/Makefile.in

EXTRA_DIST =3D \
+ macos-dns-updown.sh \
syste= md-dns-updown.sh \
openresolv-dns-updown.sh \
<= span> haikuos_file-dns-updown.sh \

diff --git a/distro/dns= -scripts/macos-dns-updown.sh b/distro/dns-scripts/macos-dns-updown.sh
new file mode 100644
index 0000000..6ffb8de
--- /dev/null
+++ b/distro/dns-scripts/macos-dn= s-updown.sh
@@ -0,0 +1,216 @@
+#!/bin/bash
+#
+= # dns-updown - add/remove openvpn provided DNS information
+#
+# (C) Copyright 2025 OpenVPN Inc <sales@...515...&g= t;
+#
+# SPDX-License-Identifier: BSD-2-Cl= ause

+#
+# Example env from openvpn (most = are not applied):

+#<= /span>
+# dns_vars_file /t= mp/openvpn_dvf_58b95c0c97b2db43afb5d745f986c53c.tmp
+#
+# or
+#
+# dev utun= 0
+# script_type dn= s-up
+# dns_search_= domain_1 mycorp.in
+#= dns_search_domain_2 eu.mycorp.com
+# dns_server_1_address_1 192.168.99.254
+# dns_server_1_address_2 fd00::99:= 53
+# dns_server_1_= port_2 53
+# dns_se= rver_1_resolve_domain_1 mycorp.in
+# dns_server_1_resolve_domain_2 eu.mycorp.com
+# dns_server_1_dnssec true
+# dns_server_1_transpo= rt DoH
+# dns_serve= r_1_sni dns.mycorp.in
+#
+
+[ -z "${dns_vars_file}" ]= || . "${dns_vars_file}"

+
+itf_= dns_key=3D"State:/Network/Service/openvpn-${dev}/DNS"
<= span style=3D"color: hsl(120, 100%, 40%);">+dns_backup_key=3D"State:/N= etwork/Service/openvpn-${dev}/DnsBackup"

+
+function primary_dns_key {
+ local uuid=3D$(echo "show State:/Network/Global/IPv4= " | /usr/sbin/scutil | grep "PrimaryService" | cut -d: -f2 |= xargs)
+ echo &qu= ot;State:/Network/Service/${uuid}/DNS"
+}
+
+function only= _standard_server_ports {
+ local i=3D1
= + while :; do
+ = local addr_var=3Ddns_server_${n}_address_${i}
+ [ -n "${!addr_var}" ] || r= eturn 0
+
<= span style=3D"color: hsl(120, 100%, 40%);">+ local port_var=3Ddns_se= rver_${n}_port_${i}

+= [ -z "${!port_var}" -o "${!port_var}" =3D "= ;53" ] || return 1
+
+ i=3D$((= i+1))
+ done
+}
+
+function find_compat_profile {
+ local n=3D1
+ while :; do
+ local addr_var=3Ddns_server_${n}_address_1=
+ [ -n "${!addr= _var}" ] || {
+ = echo "setting DNS failed, no compatible server profile"= ;
+ exit 1=
+ }+
+ # Skip server profiles which require DNS= SEC,
+ # secur= e transport or use a custom port
+ local dnssec_var=3Ddns_server_${n}_dnssec
+ local transport_var=3Ddn= s_server_${n}_transport

+ [ -z "${!transport_var}" -o "${!transport_var}&q= uot; =3D "plain" ] \
+ && [ -z "${!dnssec_var}" -o "= ${!dnssec_var}" =3D "no" ] \
+ && only_standard_server_ports &= amp;& break
+
+ n=3D$((n+1))
+ done
+ return $n

+}
+
+f= unction get_search_domains {
+ local search_domains=3D""
+ local resolver=3D0
+ /usr/sbin/scutil --dns | while read l= ine; do
+ if [= [ "$line" =3D~ resolver.# ]]; then
+ resolver=3D$((resolver+1))
<= span style=3D"color: hsl(120, 100%, 40%);">+ elif [ "$resolver&= quot; =3D 1 ] && [[ "$line" =3D~ search.domain ]]; then
+ search_do= mains+=3D"$(echo $line | cut -d: -f2 | xargs) "
+ elif [ "$resolver" = -gt 1 ]; then
+ = echo "$search_domains"
+ break
+ fi
+ done
+}
+
+function set_search_domains {
= + [ -n "$1" ] || r= eturn
+ dns_key=3D= $(primary_dns_key)
+ = search_domains=3D"${1}$(get_search_domains)"
+
+ local cmds=3D""
+ cmds+=3D"get ${dns_key}\n"
+ cmds+=3D"d.add S= earchDomains * ${search_domains}\n"
+ cmds+=3D"set ${dns_key}\n"
+ echo -e "${cmds}" |= /usr/sbin/scutil

+}<= /span>
+
+function unset_search_domains {<= br>+ [ -n "$1" ] |= | return
+ dns_key= =3D$(primary_dns_key)
+ search_domains=3D"$(get_search_domains)"
+ search_domains=3D$(echo $search_do= mains | sed -e "s/$1//")
+
+ = local cmds=3D""
+ cmds+=3D"get ${dns_key}\n"
+ cmds+=3D"d.add SearchDomains * ${search= _domains}\n"
+ = cmds+=3D"set ${dns_key}\n"
+ echo -e "${cmds}" | /usr/sbin/scutil
+}
+
+function set_dns {
+ find_compat_profile
+ local n=3D$?
+
+ = local i=3D1
+ loca= l addrs=3D""
+ = local addr_var=3Ddns_server_${n}_address_${i}
+ local addr=3D"${!addr_var}&q= uot;
+ [ -n &q= uot;$addr" ] || break
+
+ loca= l port_var=3Ddns_server_${n}_port_${i}
+ if [ -n "${!port_var}" ]; then<= br>+ if [[ "$ad= dr" =3D~ : ]]; then
+ addr=3D"[$addr]"
+ fi
+ addrs+=3D"${addr}:${!port_var}${sni= } "
+ els= e
+ addrs+= =3D"${addr}${sni} "
+ fi
= + i=3D$((i+1))
+ done
++ i=3D1
+ local match_domains=3D""=
+ while :; do
+ domain_var=3Ddn= s_server_${n}_resolve_domain_${i}
+ [ -n "${!domain_var}" ] || break
= + # Add as match domain,= if it doesn't already exist
+ [[ "$match_domains" =3D~ (^| )${!domain_var}= ( |$) ]] \
+ = || match_domains+=3D"${!domain_var} "
+ i=3D$((i+1))
+ done
+
+ i=3D1
+ lo= cal search_domains=3D""
+ while :; do
+ domain_var=3Ddns_search_domain_${i}
+ [ -n "${!domain_var}" ]= || break
+ # = Add as search domain, if it doesn't already exist
+ [[ "$search_domains" = =3D~ (^| )${!domain_var}( |$) ]] \
+ || search_domains+=3D"${!domain_var} "=
+ i=3D$((i+1)= )
+ done+
+ if [ -n "$match_domains" ]; then
+ local cmds=3D= ""
+ = cmds+=3D"d.init\n"
+ cmds+=3D"d.add ServerAddresses * ${addrs}\n"
+ cmds+=3D"= d.add SupplementalMatchDomains * ${match_domains}\n"
+ cmds+=3D"d.add Supplemen= talMatchDomainsNoSearch # 1\n"
+ cmds+=3D"add ${itf_dns_key}\n"
= + echo -e "${cmds}&= quot; | /usr/sbin/scutil
+ set_search_domains "$search_domains"
+ else

+ local cmds=3D""
+ cmds+=3D"get $(prim= ary_dns_key)\n"

= + cmds+=3D"set ${dns_backup_key}\n"
+ cmds+=3D"d.init\n"
+ cmds+=3D"d.= add ServerAddresses * ${addrs}\n"
+ cmds+=3D"d.add SearchDomains * ${search_dom= ains}\n"
+ = cmds+=3D"set $(primary_dns_key)\n"
+ echo -e "${cmds}" | /usr/sbin/= scutil
+ fi=
+
+ /usr/bin/dscacheutil -flushcache+}
+
+function unset_dns {
+ find_compat_profile
+ local n=3D$?
+
+ loc= al i=3D1
+ local s= earch_domains=3D""
+ while :; do
+ domain_var=3Ddns_search_domain_${i}
+ [ -n "${!domain_var}" ] || b= reak
+ # Add a= s search domain, if it doesn't already exist
+ [[ "$search_domains" =3D~ (^= | )${!domain_var}( |$) ]] \
+ || search_domains+=3D"${!domain_var} "=
+ i=3D$((i+1))
+ done
+
+ domain_var=3Ddns_server_${n}_resolve_domain_1
+ if [ -n "${!doma= in_var}" ]; then
+ echo "remove ${itf_dns_key}" | /usr/sbin/scutil<= br>+ unset_search_domain= s "$search_domains"
+ else
+ = local cmds=3D""
+ cmds+=3D"get ${dns_backup_key}\n"
= + cmds+=3D"set $(pr= imary_dns_key)\n"
+ echo -e "${cmds}" |= /usr/sbin/scutil
+ = fi
+
+ /usr/bin/dscacheutil -flushcac= he

+}
+

+if [ "$script_type" =3D "dns-up" ]= ; then
+ set_dns
+else
+ unset_dns
+fi

To= view, visit change 1062. To unsubscribe, or for help writing mail filters, vis= it settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Iade06a8454ccf53668deef61f07= 217ead8ec6c63
Gerrit-Change-Number: 1062
Gerrit-PatchSet: 1
Gerrit-Owner: d12fk <heiko@...515...>
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-MessageType: newchange
--qaOP30cRm4o=--