README.pppol2tp 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. PPPoL2TP plugin
  2. ===============
  3. The pppol2tp plugin lets pppd use the Linux kernel driver pppol2tp.ko
  4. to pass PPP frames in L2TP tunnels. The driver was integrated into the
  5. kernel in the 2.6.23 release. For kernels before 2.6.23, an
  6. out-of-tree kernel module is available from the pppol2tp-kmod package
  7. in the OpenL2TP project.
  8. Note that pppd receives only PPP control frames over the PPPoL2TP
  9. socket; data frames are handled entirely by the kernel.
  10. The pppol2tp plugin adds extra arguments to pppd and uses the Linux kernel
  11. PPP-over-L2TP driver to set up each session's data path.
  12. Arguments are:-
  13. pppol2tp <fd> - FD for PPPoL2TP socket
  14. pppol2tp_lns_mode - PPPoL2TP LNS behavior. Default off.
  15. pppol2tp_send_seq - PPPoL2TP enable sequence numbers in
  16. transmitted data packets. Default off.
  17. pppol2tp_recv_seq - PPPoL2TP enforce sequence numbers in
  18. received data packets. Default off.
  19. pppol2tp_reorderto <millisecs> - PPPoL2TP data packet reorder timeout.
  20. Default 0 (no reordering).
  21. pppol2tp_debug_mask <mask> - PPPoL2TP debug mask. Bitwise OR of
  22. 1 - verbose debug
  23. 2 - control
  24. 4 - kernel transport
  25. 8 - ppp packet data
  26. Default: 0 (no debug).
  27. pppol2tp_ifname <ifname> - Name of PPP network interface visible
  28. to "ifconfig" and "ip link".
  29. Default: "pppN"
  30. pppol2tp_tunnel_id <id> - L2TP tunnel_id tunneling this PPP
  31. session.
  32. pppol2tp_session_id <id> - L2TP session_id of this PPP session.
  33. The tunnel_id/session_id pair is used
  34. when sending event messages to openl2tpd.
  35. pppd will typically be started by an L2TP daemon for each L2TP sesion,
  36. supplying one or more of the above arguments as required. The pppd
  37. user will usually have no visibility of these arguments.
  38. Two hooks are exported by this plugin.
  39. void (*pppol2tp_send_accm_hook)(int tunnel_id, int session_id,
  40. uint32_t send_accm, uint32_t recv_accm);
  41. void (*pppol2tp_ip_updown_hook)(int tunnel_id, int session_id, int up);
  42. Credits
  43. =======
  44. This plugin was developed by Katalix Systems as part of the OpenL2TP
  45. project, http://openl2tp.sourceforge.net. OpenL2TP is a full-featured
  46. L2TP client-server, suitable for use as an enterprise L2TP VPN server
  47. or a VPN client.
  48. Please copy problems to the OpenL2TP mailing list:
  49. openl2tp-users@lists.sourceforge.net.
  50. Maintained by:
  51. James Chapman
  52. jchapman@katalix.com
  53. Katalix Systems Ltd
  54. http://www.katalix.com