README.plugins 1.5 KB

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