1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
2 .\" All rights reserved.
4 .\" Subject to the following obligations and disclaimer of warranty, use and
5 .\" redistribution of this software, in source or object code forms, with or
6 .\" without modifications are expressly permitted by Whistle Communications;
7 .\" provided, however, that:
8 .\" 1. Any and all reproductions of the source or object code must include the
9 .\" copyright notice above and the following disclaimer of warranties; and
10 .\" 2. No rights are granted, in any manner or form, to use Whistle
11 .\" Communications, Inc. trademarks, including the mark "WHISTLE
12 .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as
13 .\" such appears in the above copyright notice or in the software.
15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
33 .\" Author: Archie Cobbs <archie@whistle.com>
36 .\" $Whistle: ng_pptpgre.8,v 1.2 1999/12/08 00:20:53 archie Exp $
43 .Nd PPP protocol netgraph node type
45 .Fd #include <netgraph/ng_pptpgre.h>
49 node type performs Generic Routing Encapsulation (GRE) over IP
50 for the PPTP protocol as specified by RFC 2637. This involves packet
51 encapsulation, sequencing, acknowlegement, and an adaptive timeout
52 sliding window mechanism. This node type does not handle any of
53 the TCP control protocol or call negotiation defined by PPTP.
55 The typical use for this node type would be to connect the
57 hook to one of the link hooks of a
67 This node type supports the following hooks:
69 .Bl -tag -compact -width vjc_vjuncomp
71 Connection to the upper protocol layers
73 Connection to the lower protocol layers
77 This node type supports the generic control messages, plus the following:
79 .It Dv NGM_PPTPGRE_SET_CONFIG
80 This command resets and configures the node for a session.
82 .Dv "struct ng_pptpgre_conf"
84 .Bd -literal -offset 0
85 /* Configuration for a session */
86 struct ng_pptpgre_conf {
87 u_char enabled; /* enables traffic flow */
88 u_char enableDelayedAck; /* enables delayed acks */
89 u_int16_t cid; /* my call id */
90 u_int16_t peerCid; /* peer call id */
91 u_int16_t recvWin; /* peer recv window size */
92 u_int16_t peerPpd; /* peer packet processing delay
93 (in 1/10 of a second) */
99 field enables traffic flow through the node. The
101 field enables delayed acknowledgement (maximum 250 miliseconds), which
102 is a useful optimization and should generally be turned on.
103 The remaining fields are as supplied by the PPTP virtual call setup process.
104 .It Dv NGM_PPTPGRE_GET_CONFIG
105 Returns the current configuration as a
106 .Dv "struct ng_pptpgre_conf" .
109 This node shuts down upon receipt of a
111 control message, or when both hooks have been disconnected.
124 .%T "Point-to-Point Tunneling Protocol (PPTP)"
132 .%T "Generic Routing Encapsulation over IPv4 networks"
138 node type was implemented in
141 .An Archie Cobbs Aq archie@whistle.com