Openvpn: add missing script event options

Maintainer: @mkrkn  @neheb
Compile tested: aarch64, cortex-a53, OpenWRT Master
Run tested: Dynalink DL-WRX36

Description:
[A previous commit](https://github.com/openwrt/packages/commit/f8a8b71e26b9bdbf86fbb7d4d1482637af7f3ba4) has added more script event options.
However it looked like that commit was not complete as it stops the use of the script events route-up, route-pre-down, and ipchange when those are placed in the openvpn config file.

This PR fixes a regression that makes it problematic to specify certain event options in the OpenVPN configuration file.

Discussion in [this thread](https://forum.openwrt.org/t/openvpn-custom-route-up-script-in-23-05-rc2/167105/13) and [here](https://forum.openwrt.org/t/openvpn-route-up-and-route-pre-down-broken-in-23-05/176568)

Please have a look and consider implementing or make it possible to use all script event options in the openvpn config file in another way.

Pull request has been discussed and improved with the help of @AuthorReflex, see: https://github.com/openwrt/packages/pull/21732

Signed-off-by: Erik Conijn <egc112@msn.com>

diff --git a/net/openvpn/Makefile b/net/openvpn/Makefile
index 111ec97b2579892f102c7dce1786b1f5b99e0330..077a52d986bc0710b7a0c4af4a4991a21bad13f0 100644 (file)
--- a/net/openvpn/Makefile
+++ b/net/openvpn/Makefile
@@ -10,7 +10,7 @@ include $(TOPDIR)/rules.mk
 PKG_NAME:=openvpn
 
 PKG_VERSION:=2.6.8
-PKG_RELEASE:=2
+PKG_RELEASE:=3
 
 PKG_SOURCE_URL:=\
        https://build.openvpn.net/downloads/releases/ \

diff --git a/net/openvpn/files/etc/hotplug.d/openvpn/01-user b/net/openvpn/files/etc/hotplug.d/openvpn/01-user
index 4c72f1c4bd7efc4986fcce5aad28d9a9325ea537..f6ad8935e9dadeab02aef2e2a1bec501430466fb 100644 (file)
--- a/net/openvpn/files/etc/hotplug.d/openvpn/01-user
+++ b/net/openvpn/files/etc/hotplug.d/openvpn/01-user
@@ -7,10 +7,14 @@
                $*
 }
 
-# Wrap user defined scripts on up/down events
+# Wrap user defined scripts on up/down/route-up/route-pre-down/ipchange events
+# Scriptp set with up/down/route-up/route-pre-down/ipchange in the openvpn config are also executed with the command=user_xxxx
 case "$ACTION" in
        up) command=$user_up ;;
        down) command=$user_down ;;
+       route-up) command=$user_route_up ;;
+       route-pre-down) command=$user_route_pre_down ;;
+       ipchange) command=$user_ipchange ;;
        *) command= ;;
 esac
 
@@ -20,3 +24,4 @@ if [ -n "$command" ]; then
 fi
 
 exit 0
+

diff --git a/net/openvpn/files/openvpn.init b/net/openvpn/files/openvpn.init
index 6f4dc4206f26c88f2169b074e10b7b3bdf5bdc8d..0aee6d418298cb4d0d99cd5abbc4d4895a1d45f0 100644 (file)
--- a/net/openvpn/files/openvpn.init
+++ b/net/openvpn/files/openvpn.init
@@ -145,6 +145,9 @@ openvpn_add_instance() {
        local security="$4"
        local up="$5"
        local down="$6"
+       local route_up="$7"
+       local route_pre_down="$8"
+       local ipchange="$9"
        local client=$(grep -qEx "client|tls-client" "$dir/$conf" && echo 1)
 
        procd_open_instance "$name"
@@ -160,6 +163,9 @@ openvpn_add_instance() {
                ${client:+--ipchange "/usr/libexec/openvpn-hotplug ipchange $name"} \
                ${up:+--setenv user_up "$up"} \
                ${down:+--setenv user_down "$down"} \
+               ${route_up:+--setenv user_route_up "$route_up"} \
+               ${route_pre_down:+--setenv user_route_pre_down "$route_pre_down"} \
+               ${client:+${ipchange:+--setenv user_ipchange "$ipchange"}} \
                --script-security "${security:-2}" \
                $(openvpn_get_dev "$name" "$conf") \
                $(openvpn_get_credentials "$name" "$conf")
@@ -183,9 +189,12 @@ start_uci_instance() {
                return 1
        }
 
-       local up down script_security
+       local up down route_up route_pre_down ipchange script_security
        config_get up "$s" up
        config_get down "$s" down
+       config_get route_up "$s" route_up
+       config_get route_pre_down "$s" route_pre_down
+       config_get ipchange "$s" ipchange
        config_get script_security "$s" script_security
 
        [ ! -d "/var/run" ] && mkdir -p "/var/run"
@@ -194,7 +203,10 @@ start_uci_instance() {
                append UCI_STARTED "$config" "$LIST_SEP"
                [ -n "$up" ] || get_openvpn_option "$config" up up
                [ -n "$down" ] || get_openvpn_option "$config" down down
-               openvpn_add_instance "$s" "${config%/*}" "$config" "$script_security" "$up" "$down"
+               [ -n "$route_up" ] || get_openvpn_option "$config" route_up route-up
+               [ -n "$route_pre_down" ] || get_openvpn_option "$config" route_pre_down route-pre-down
+               [ -n "$ipchange" ] || get_openvpn_option "$config" ipchange ipchange
+               openvpn_add_instance "$s" "${config%/*}" "$config" "$script_security" "$up" "$down" "$route_up" "$route_pre_down" "$ipchange"
                return
        fi
 
@@ -204,7 +216,7 @@ start_uci_instance() {
        append_params "$s" $OPENVPN_PARAMS
        append_list "$s" $OPENVPN_LIST
 
-       openvpn_add_instance "$s" "/var/etc" "openvpn-$s.conf" "$script_security" "$up" "$down"
+       openvpn_add_instance "$s" "/var/etc" "openvpn-$s.conf" "$script_security" "$up" "$down" "$route_up" "$route_pre_down" "$ipchange"
 }
 
 start_path_instances() {
@@ -222,7 +234,7 @@ start_path_instances() {
 start_path_instance() {
        local name="$1"
 
-       local path up down
+       local path name up down route_up route_pre_down ipchange
 
        path="${PATH_INSTANCE_DIR}/${name}.conf"
 
@@ -240,8 +252,11 @@ start_path_instance() {
 
        get_openvpn_option "$path" up up || up=""
        get_openvpn_option "$path" down down || down=""
+       get_openvpn_option "$path" route_up route-up || route_up=""
+       get_openvpn_option "$path" route_pre_down route-pre-down || route_pre_down=""
+       get_openvpn_option "$path" ipchange ipchange || ipchange=""
 
-       openvpn_add_instance "$name" "${path%/*}" "$path" "" "$up" "$down"
+       openvpn_add_instance "$name" "${path%/*}" "$path" "" "$up" "$down" "$route_up" "$route_pre_down" "$ipchange"
 }
 
 start_service() {
@@ -283,3 +298,4 @@ start_service() {
 service_triggers() {
        procd_add_reload_trigger openvpn
 }
+