diff options
| author | Alon Bar-Lev <alon.barlev@gmail.com> | 2012-05-15 01:42:03 +0300 |
|---|---|---|
| committer | David Sommerseth <davids@redhat.com> | 2012-06-26 11:29:02 +0200 |
| commit | ce8271f5d435be963c79945f8d7eb6ea2e4369fa (patch) | |
| tree | 65882d5da0481522320cb0133564db70bfce72b9 /doc/README.plugins | |
| parent | 8acdb7291c4cc62134624c3a61049f2ec12e3ad9 (diff) | |
| download | openvpn-ce8271f5d435be963c79945f8d7eb6ea2e4369fa.tar.gz openvpn-ce8271f5d435be963c79945f8d7eb6ea2e4369fa.tar.xz openvpn-ce8271f5d435be963c79945f8d7eb6ea2e4369fa.zip | |
build: integrate plugins build into core build
As disucssed[1], keep plugins in repository.
1, Proper automake/libtool build.
2. Move example plugins to samples/sample-plugins.
3. Plugins are installed at LIBDIR/openvpn/plugins.
[1] http://comments.gmane.org/gmane.network.openvpn.devel/6436
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
Acked-by: David Sommerseth <davids@redhat.com>
Message-Id: 1337035323-27465-1-git-send-email-alon.barlev@gmail.com
URL: http://article.gmane.org/gmane.network.openvpn.devel/6591
Signed-off-by: David Sommerseth <davids@redhat.com>
Diffstat (limited to 'doc/README.plugins')
| -rw-r--r-- | doc/README.plugins | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/README.plugins b/doc/README.plugins new file mode 100644 index 0000000..6e490c5 --- /dev/null +++ b/doc/README.plugins @@ -0,0 +1,47 @@ +OpenVPN Plugins +--------------- + +Starting with OpenVPN 2.0-beta17, compiled plugin modules are +supported on any *nix OS which includes libdl or on Windows. +One or more modules may be loaded into OpenVPN using +the --plugin directive, and each plugin module is capable of +intercepting any of the script callbacks which OpenVPN supports: + +(1) up +(2) down +(3) route-up +(4) ipchange +(5) tls-verify +(6) auth-user-pass-verify +(7) client-connect +(8) client-disconnect +(9) learn-address + +See the openvpn-plugin.h file in the top-level directory of the +OpenVPN source distribution for more detailed information +on the plugin interface. + +Included Plugins +---------------- + +auth-pam -- Authenticate using PAM and a split privilege + execution model which functions even if + root privileges or the execution environment + have been altered with --user/--group/--chroot. + Tested on Linux only. + +down-root -- Enable the running of down scripts with root privileges + even if --user/--group/--chroot have been used + to drop root privileges or change the execution + environment. Not applicable on Windows. + +examples -- A simple example that demonstrates a portable + plugin, i.e. one which can be built for *nix + or Windows from the same source. + +Building Plugins +---------------- + +cd to the top-level directory of a plugin, and use the +"make" command to build it. The examples plugin is +built using a build script, not a makefile. |