Annotation of embedaddon/libpdel/ppp/pdel_ppp.3, revision 1.1.1.1
1.1 misho 1: .\" Copyright (c) 2001-2002 Packet Design, LLC.
2: .\" All rights reserved.
3: .\"
4: .\" Subject to the following obligations and disclaimer of warranty,
5: .\" use and redistribution of this software, in source or object code
6: .\" forms, with or without modifications are expressly permitted by
7: .\" Packet Design; provided, however, that:
8: .\"
9: .\" (i) Any and all reproductions of the source or object code
10: .\" must include the copyright notice above and the following
11: .\" disclaimer of warranties; and
12: .\" (ii) No rights are granted, in any manner or form, to use
13: .\" Packet Design trademarks, including the mark "PACKET DESIGN"
14: .\" on advertising, endorsements, or otherwise except as such
15: .\" appears in the above copyright notice or in the software.
16: .\"
17: .\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
18: .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
19: .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
20: .\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
21: .\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
22: .\" OR NON-INFRINGEMENT. PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
23: .\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
24: .\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
25: .\" RELIABILITY OR OTHERWISE. IN NO EVENT SHALL PACKET DESIGN BE
26: .\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
27: .\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
28: .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
29: .\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
30: .\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
31: .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
33: .\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
34: .\" THE POSSIBILITY OF SUCH DAMAGE.
35: .\"
36: .\" Author: Archie Cobbs <archie@freebsd.org>
37: .\"
38: .\" $Id: pdel_ppp.3,v 1.1 2004/06/02 16:54:45 archie Exp $
39: .\"
40: .Dd June 2, 2004
41: .Dt PDEL_PPP 3
42: .Os
43: .Sh NAME
44: .Nm pdel_ppp
45: .Nd PPP library for VPNs that uses
46: .Xr netgraph 3
47: .Sh LIBRARY
48: PDEL Library (libpdel, \-lpdel)
49: .Sh SYNOPSIS
50: .In sys/types.h
51: .In pdel/ppp/*.h
52: .Sh DESCRIPTION
53: The
54: .Xr libpdel 3
55: library includes a PPP stack with support for:
56: .Bl -dash
57: .It
58: The IP network layer (IPCP)
59: .It
60: Authentication via PAP, CHAP-MD5, MS-CHAPv1, MS-CHAPv2, and RADIUS
61: .It
62: The PPTP transport layer with PPTP server support
63: .It
64: The L2TP transport layer with L2TP server support
65: .It
66: Microsoft MPPE encryption
67: .El
68: .Pp
69: This library works in conjunction with the various
70: .Xr netgraph 4
71: nodes that come with the FreeBSD kernel and is a PPP library, not
72: a PPP server.
73: That is, it handles all the PPP state machinery, while deferring
74: all
75: .Dq policy
76: decisions to the application code via callbacks.
77: For example, the application is ultimately responsible for acquiring and
78: verifying user credentials, determining what IP addresses may be negotiated,
79: etc.
80: .Pp
81: The library constructs netgraph node graphs that have a
82: .Dq loose end
83: netgraph hook which transmits and receives IP packets;
84: the application is responsible for connecting this hook to something useful
85: (e.g., an
86: .Xr ng_iface 3
87: node), configuring the interface, etc.
88: The library makes available to the application all the information
89: that it needs in order to properly do such configuration (such as
90: the negotiated IP addresses).
91: .Pp
92: At this time, there is no documentation other than this man page
93: and the comments in the code.
94: There is a fully functioning sample PPTP/L2TP test server in
95: the test subdirectory that is statically configured and allows a single
96: connection at a time.
97: It demonstrates how to create a server and the application callbacks.
98: The application callbacks are documented in the corresponding header files.
99: .Pp
100: Because PPTP and L2TP are the only supported transport types, this
101: library is most useful for implementing VPN software.
102: .Sh SEE ALSO
103: .Xr libpdel 3 ,
104: .Sh HISTORY
105: The PDEL library was developed at Packet Design, LLC.
106: .Dv "http://www.packetdesign.com/"
107: .Sh AUTHORS
108: .An Archie Cobbs Aq archie@freebsd.org
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>