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@whistle.com> 34.\" 35.\" $FreeBSD$ 36.\" $Whistle: ng_pptpgre.8,v 1.2 1999/12/08 00:20:53 archie Exp $ 37.\" 38.Dd November 29, 1999 39.Dt NG_PPTPGRE 8 40.Os FreeBSD 41.Sh NAME 42.Nm ng_pptpgre 43.Nd PPTP GRE protocol netgraph node type 44.Sh SYNOPSIS 45.Fd #include <netgraph/ng_pptpgre.h> 46.Sh DESCRIPTION 47The 48.Nm pptpgre 49node type performs Generic Routing Encapsulation (GRE) over IP 50for the PPTP protocol as specified by RFC 2637. This involves packet 51encapsulation, sequencing, acknowlegement, and an adaptive timeout 52sliding window mechanism. This node type does not handle any of 53the TCP control protocol or call negotiation defined by PPTP. 54.Pp 55The typical use for this node type would be to connect the 56.Dv upper 57hook to one of the link hooks of a 58.Xr ng_ppp 8 59node, and the 60.Dv lower 61hook to the 62.Dv "inet/raw/gre" 63hook of a 64.Xr ng_ksocket 8 65node. 66.Sh HOOKS 67This node type supports the following hooks: 68.Pp 69.Bl -tag -compact -width vjc_vjuncomp 70.It Dv upper 71Connection to the upper protocol layers 72.It Dv lower 73Connection to the lower protocol layers 74.El 75.Pp 76.Sh CONTROL MESSAGES 77This node type supports the generic control messages, plus the following: 78.Bl -tag -width foo 79.It Dv NGM_PPTPGRE_SET_CONFIG 80This command resets and configures the node for a session. 81This command takes a 82.Dv "struct ng_pptpgre_conf" 83as an argument: 84.Bd -literal -offset 0 85/* Configuration for a session */ 86struct 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) */ 94}; 95 96.Ed 97The 98.Dv enabled 99field enables traffic flow through the node. The 100.Dv enableDelayedAck 101field enables delayed acknowledgement (maximum 250 miliseconds), which 102is a useful optimization and should generally be turned on. 103The remaining fields are as supplied by the PPTP virtual call setup process. 104.It Dv NGM_PPTPGRE_GET_CONFIG 105Returns the current configuration as a 106.Dv "struct ng_pptpgre_conf" . 107.El 108.Sh SHUTDOWN 109This node shuts down upon receipt of a 110.Dv NGM_SHUTDOWN 111control message, or when both hooks have been disconnected. 112.Sh SEE ALSO 113.Xr netgraph 4 , 114.Xr ng_ksocket 8 , 115.Xr ng_ppp 8 , 116.Xr ngctl 8 . 117.Rs 118.%A K. Hamzeh 119.%A G. Pall 120.%A W. Verthein 121.%A J. Taarud 122.%A W. Little 123.%A G. Zorn 124.%T "Point-to-Point Tunneling Protocol (PPTP)" 125.%O RFC 2637 126.Re 127.Rs 128.%A S. Hanks 129.%A T. \&Li 130.%A D. Farinacci 131.%A P. Traina 132.%T "Generic Routing Encapsulation over IPv4 networks" 133.%O RFC 1702 134.Re 135.Sh HISTORY 136The 137.Nm 138node type was implemented in 139.Fx 4.0 . 140.Sh AUTHORS 141.An Archie Cobbs Aq archie@whistle.com 142