Next round of fixing all kinds of spelling mistakes.
[dragonfly.git] / share / man / man4 / ng_pptpgre.4
CommitLineData
984263bc
MD
1.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
2.\" All rights reserved.
3.\"
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.
14.\"
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
31.\" OF SUCH DAMAGE.
32.\"
33.\" Author: Archie Cobbs <archie@FreeBSD.org>
34.\"
35.\" $FreeBSD: src/share/man/man4/ng_pptpgre.4,v 1.16.2.2 2002/03/19 18:24:07 schweikh Exp $
3f5e28f4 36.\" $DragonFly: src/share/man/man4/ng_pptpgre.4,v 1.5 2007/05/17 08:19:01 swildner Exp $
984263bc
MD
37.\" $Whistle: ng_pptpgre.8,v 1.2 1999/12/08 00:20:53 archie Exp $
38.\"
39.Dd December 7, 2001
40.Dt NG_PPTPGRE 4
41.Os
42.Sh NAME
43.Nm ng_pptpgre
44.Nd PPTP GRE protocol netgraph node type
45.Sh SYNOPSIS
44cb301e 46.In netgraph/pptpgre/ng_pptpgre.h
984263bc
MD
47.Sh DESCRIPTION
48The
49.Nm pptpgre
50node type performs Generic Routing Encapsulation (GRE) over IP
51for the PPTP protocol as specified by RFC 2637.
52This involves packet
53encapsulation, sequencing, acknowledgement, and an adaptive timeout
54sliding window mechanism.
55This node type does not handle any of
56the TCP control protocol or call negotiation defined by PPTP.
57.Pp
58This node type expects to receive complete IP packets,
59including the IP header, on the
60.Dq Li lower
61hook, but it transmits outgoing frames without any IP header.
62The typical use for this node type would be to connect the
63.Dq Li upper
64hook to one of the link hooks of a
65.Xr ng_ppp 4
66node, and the
67.Dq Li lower
68hook to the
69.Dq Li "inet/raw/gre"
70hook of a
71.Xr ng_ksocket 4
72node.
73.Sh HOOKS
74This node type supports the following hooks:
75.Pp
76.Bl -tag -compact -width ".Li upper"
77.It Li upper
78Connection to the upper protocol layers
79.It Li lower
80Connection to the lower protocol layers
81.El
82.Sh CONTROL MESSAGES
83This node type supports the generic control messages, plus the following:
84.Bl -tag -width indent
85.It Dv NGM_PPTPGRE_SET_CONFIG
86This command resets and configures the node for a session.
87This command takes a
88.Vt "struct ng_pptpgre_conf"
89as an argument:
90.Bd -literal
91/* Configuration for a session */
92struct ng_pptpgre_conf {
93 u_char enabled; /* enables traffic flow */
94 u_char enableDelayedAck; /* enables delayed acks */
95 u_char enableAlwaysAck; /* always send ack with data */
96 u_int16_t cid; /* my call id */
97 u_int16_t peerCid; /* peer call id */
98 u_int16_t recvWin; /* peer recv window size */
99 u_int16_t peerPpd; /* peer packet processing delay
100 (in 1/10 of a second) */
101};
102.Ed
103.Pp
104The
105.Va enabled
106field enables traffic flow through the node.
107The
108.Va enableDelayedAck
3f5e28f4 109field enables delayed acknowledgement (maximum 250 milliseconds), which
984263bc
MD
110is a useful optimization and should generally be turned on.
111.Va enableAlwaysAck
112field enables sending acknowledgements with every data packet, which
113is probably helpful as well.
114The remaining fields are as supplied by the PPTP virtual call setup process.
115.It Dv NGM_PPTPGRE_GET_CONFIG
116Returns the current configuration as a
117.Vt "struct ng_pptpgre_conf" .
118.It Dv NGM_PPTPGRE_GET_STATS
119This command returns a
120.Vt "struct ng_pptpgre_stats"
121containing various node statistics.
122.It Dv NGM_PPTPGRE_CLR_STATS
123This command resets the node statistics.
124.It Dv NGM_PPTPGRE_GETCLR_STATS
125This command atomically gets and resets the node statistics, returning a
126.Vt "struct ng_pptpgre_stats" .
127.El
128.Sh SHUTDOWN
129This node shuts down upon receipt of a
130.Dv NGM_SHUTDOWN
131control message, or when both hooks have been disconnected.
132.Sh SEE ALSO
133.Xr netgraph 4 ,
134.Xr ng_ksocket 4 ,
135.Xr ng_ppp 4 ,
136.Xr ngctl 8
137.Rs
138.%A K. Hamzeh
139.%A G. Pall
140.%A W. Verthein
141.%A J. Taarud
142.%A W. Little
143.%A G. Zorn
144.%T "Point-to-Point Tunneling Protocol (PPTP)"
145.%O RFC 2637
146.Re
147.Rs
148.%A S. Hanks
149.%A T. \&Li
150.%A D. Farinacci
151.%A P. Traina
152.%T "Generic Routing Encapsulation over IPv4 networks"
153.%O RFC 1702
154.Re
984263bc
MD
155.Sh HISTORY
156The
157.Nm
158node type was implemented in
159.Fx 4.0 .
160.Sh AUTHORS
161.An Archie Cobbs Aq archie@FreeBSD.org
ac561d34
SW
162.Sh BUGS
163The node should not expect incoming GRE packets to have an IP header.
164This behavior is inherited from the (converse) behavior of raw IP sockets.
165An intermediate node that strips IP headers in one direction
166should be used instead.