.\" Copyright (c) 2001-2002 Packet Design, LLC.
.\" All rights reserved.
.\" 
.\" Subject to the following obligations and disclaimer of warranty,
.\" use and redistribution of this software, in source or object code
.\" forms, with or without modifications are expressly permitted by
.\" Packet Design; provided, however, that:
.\" 
.\"    (i)  Any and all reproductions of the source or object code
.\"         must include the copyright notice above and the following
.\"         disclaimer of warranties; and
.\"    (ii) No rights are granted, in any manner or form, to use
.\"         Packet Design trademarks, including the mark "PACKET DESIGN"
.\"         on advertising, endorsements, or otherwise except as such
.\"         appears in the above copyright notice or in the software.
.\" 
.\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
.\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
.\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
.\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
.\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
.\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
.\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
.\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
.\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
.\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
.\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
.\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Author: Archie Cobbs <archie@freebsd.org>
.\"
.\" $Id: pdel_ppp.3,v 1.1 2012/02/21 23:25:53 misho Exp $
.\"
.Dd June 2, 2004
.Dt PDEL_PPP 3
.Os
.Sh NAME
.Nm pdel_ppp
.Nd PPP library for VPNs that uses
.Xr netgraph 3
.Sh LIBRARY
PDEL Library (libpdel, \-lpdel)
.Sh SYNOPSIS
.In sys/types.h
.In pdel/ppp/*.h
.Sh DESCRIPTION
The
.Xr libpdel 3
library includes a PPP stack with support for:
.Bl -dash
.It
The IP network layer (IPCP)
.It
Authentication via PAP, CHAP-MD5, MS-CHAPv1, MS-CHAPv2, and RADIUS
.It
The PPTP transport layer with PPTP server support
.It
The L2TP transport layer with L2TP server support
.It
Microsoft MPPE encryption
.El
.Pp
This library works in conjunction with the various
.Xr netgraph 4
nodes that come with the FreeBSD kernel and is a PPP library, not
a PPP server.
That is, it handles all the PPP state machinery, while deferring
all
.Dq policy
decisions to the application code via callbacks.
For example, the application is ultimately responsible for acquiring and
verifying user credentials, determining what IP addresses may be negotiated,
etc.
.Pp
The library constructs netgraph node graphs that have a
.Dq loose end
netgraph hook which transmits and receives IP packets;
the application is responsible for connecting this hook to something useful
(e.g., an
.Xr ng_iface 3
node), configuring the interface, etc.
The library makes available to the application all the information
that it needs in order to properly do such configuration (such as
the negotiated IP addresses).
.Pp
At this time, there is no documentation other than this man page
and the comments in the code.
There is a fully functioning sample PPTP/L2TP test server in
the test subdirectory that is statically configured and allows a single
connection at a time.
It demonstrates how to create a server and the application callbacks.
The application callbacks are documented in the corresponding header files.
.Pp
Because PPTP and L2TP are the only supported transport types, this
library is most useful for implementing VPN software.
.Sh SEE ALSO
.Xr libpdel 3 ,
.Sh HISTORY
The PDEL library was developed at Packet Design, LLC.
.Dv "http://www.packetdesign.com/"
.Sh AUTHORS
.An Archie Cobbs Aq archie@freebsd.org