release/src/router/openvpn/plugin/README

   1 OpenVPN Plugins
   2 ---------------
   3
   4 Starting with OpenVPN 2.0-beta17, compiled plugin modules are
   5 supported on any *nix OS which includes libdl or on Windows.
   6 One or more modules may be loaded into OpenVPN using
   7 the --plugin directive, and each plugin module is capable of
   8 intercepting any of the script callbacks which OpenVPN supports:
   9
  10 (1) up
  11 (2) down
  12 (3) route-up
  13 (4) ipchange
  14 (5) tls-verify
  15 (6) auth-user-pass-verify
  16 (7) client-connect
  17 (8) client-disconnect
  18 (9) learn-address
  19
  20 See the openvpn-plugin.h file in the top-level directory of the
  21 OpenVPN source distribution for more detailed information
  22 on the plugin interface.
  23
  24 Included Plugins
  25 ----------------
  26
  27 auth-pam -- Authenticate using PAM and a split privilege
  28             execution model which functions even if
  29             root privileges or the execution environment
  30             have been altered with --user/--group/--chroot.
  31             Tested on Linux only.
  32
  33 down-root -- Enable the running of down scripts with root privileges
  34              even if --user/--group/--chroot have been used
  35              to drop root privileges or change the execution
  36              environment.  Not applicable on Windows.
  37
  38 examples -- A simple example that demonstrates a portable
  39             plugin, i.e. one which can be built for *nix
  40             or Windows from the same source.
  41
  42 Building Plugins
  43 ----------------
  44
  45 cd to the top-level directory of a plugin, and use the
  46 "make" command to build it.  The examples plugin is
  47 built using a build script, not a makefile.