aboutsummaryrefslogtreecommitdiff
path: root/plugins/down-root/README
blob: d337ffe9e8b044900f53d5e556a4d7178e03ad61 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
down-root -- an OpenVPN Plugin Module

SYNOPSIS

The down-root module allows an OpenVPN configuration to
call a down script with root privileges, even when privileges
have been dropped using --user/--group/--chroot.

This module uses a split privilege execution model which will
fork() before OpenVPN drops root privileges, at the point where
the --up script is usually called.  The module will then remain
in a wait state until it receives a message from OpenVPN via
pipe to execute the down script.  Thus, the down script will be
run in the same execution environment as the up script.

BUILD

Build this module with the "make" command.  The plugin
module will be named openvpn-down-root.so

USAGE

To use this module, add to your OpenVPN config file:

  plugin openvpn-down-root.so "command ..."

CAVEATS

This module will only work on *nix systems, not Windows.