openvpn

mirror of https://github.com/OpenVPN/openvpn.git synced 2024-11-30 13:14:43 +08:00

History

Arne Schwabe 341e6bb67f Document that keep alive will double the second value in server mode and give a short explanation why the value is chosen. Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: 1346674564-17260-1-git-send-email-arne@rfc2549.org URL: http://article.gmane.org/gmane.network.openvpn.devel/7041 Signed-off-by: David Sommerseth <davids@redhat.com>		2012-09-11 18:51:01 +02:00
..
doxygen	build: proper crypto detection and usage	2012-03-22 22:53:39 +01:00
Makefile.am	build: integrate plugins build into core build	2012-06-26 11:29:02 +02:00
management-notes.txt	add option --management-query-proxy	2012-07-19 21:37:54 +02:00
openvpn.8	Document that keep alive will double the second value in server mode and give a short explanation why the value is chosen.	2012-09-11 18:51:01 +02:00
README.plugins	build: integrate plugins build into core build	2012-06-26 11:29:02 +02:00

README.plugins

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.