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$ 36.\" $Whistle: ng_pptpgre.8,v 1.2 1999/12/08 00:20:53 archie Exp $ 37.\" 38.Dd November 13, 2012 39.Dt NG_PPTPGRE 4 40.Os 41.Sh NAME 42.Nm ng_pptpgre 43.Nd PPTP GRE protocol netgraph node type 44.Sh SYNOPSIS 45.In sys/types.h 46.In netgraph/ng_pptpgre.h 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.Bl -tag -width ".Va session_hhhh" 76.It Va session_hhhh 77Session 0xhhhh data packets to the upper protocol layers 78.It Va upper 79Same as session_hhhh, but for single session with configurable cid (legacy) 80.It Va lower 81Connection to the lower protocol layers 82.El 83.Sh CONTROL MESSAGES 84This node type supports the generic control messages, plus the following: 85.Bl -tag -width foo 86.It Dv NGM_PPTPGRE_SET_CONFIG Pq Ic setconfig 87This command resets and configures hook for a session. If corresponding 88session_hhhh hook is not connected, upper hook will be configured. 89This command takes a 90.Vt "struct ng_pptpgre_conf" 91as an argument: 92.Bd -literal 93/* Configuration for a session */ 94struct ng_pptpgre_conf { 95 u_char enabled; /* enables traffic flow */ 96 u_char enableDelayedAck; /* enables delayed acks */ 97 u_char enableAlwaysAck; /* always include ack with data */ 98 u_char enableWindowing; /* enable windowing algorithm */ 99 uint16_t cid; /* my call id */ 100 uint16_t peerCid; /* peer call id */ 101 uint16_t recvWin; /* peer recv window size */ 102 uint16_t peerPpd; /* peer packet processing delay 103 (in 1/10 of a second) */ 104}; 105.Ed 106.Pp 107The 108.Va enabled 109field enables traffic flow through the node. 110The 111.Va enableDelayedAck 112field enables delayed acknowledgement (maximum 250 milliseconds), which 113is a useful optimization and should generally be turned on. 114.Va enableAlwaysAck 115field enables sending acknowledgements with every data packet, which 116is probably helpful as well. 117.Pp 118.Va enableWindowing 119enables the PPTP packet windowing mechanism specified by the protocol. 120Disabling this will cause the node to violate the protocol, possibly 121confusing other PPTP peers, but often results in better performance. 122The windowing mechanism is a design error in the PPTP protocol; 123L2TP, the successor to PPTP, removes it. 124.Pp 125The remaining fields are as supplied by the PPTP virtual call setup process. 126.It Dv NGM_PPTPGRE_GET_CONFIG Pq Ic getconfig 127Takes two byte argument as cid and returns the current configuration as a 128.Vt "struct ng_pptpgre_conf" . 129.It Dv NGM_PPTPGRE_GET_STATS Pq Ic getstats 130This command returns a 131.Vt "struct ng_pptpgre_stats" 132containing various node statistics. 133.It Dv NGM_PPTPGRE_CLR_STATS Pq Ic clrstats 134This command resets the node statistics. 135.It Dv NGM_PPTPGRE_GETCLR_STATS Pq Ic getclrstats 136This command atomically gets and resets the node statistics, returning a 137.Vt "struct ng_pptpgre_stats" . 138.El 139.Sh SHUTDOWN 140This node shuts down upon receipt of a 141.Dv NGM_SHUTDOWN 142control message, or when both hooks have been disconnected. 143.Sh SEE ALSO 144.Xr netgraph 4 , 145.Xr ng_ksocket 4 , 146.Xr ng_ppp 4 , 147.Xr ngctl 8 148.Rs 149.%A K. Hamzeh 150.%A G. Pall 151.%A W. Verthein 152.%A J. Taarud 153.%A W. Little 154.%A G. Zorn 155.%T "Point-to-Point Tunneling Protocol (PPTP)" 156.%O RFC 2637 157.Re 158.Rs 159.%A S. Hanks 160.%A T. \&Li 161.%A D. Farinacci 162.%A P. Traina 163.%T "Generic Routing Encapsulation over IPv4 networks" 164.%O RFC 1702 165.Re 166.Sh HISTORY 167The 168.Nm 169node type was implemented in 170.Fx 4.0 . 171.Sh AUTHORS 172.An Archie Cobbs Aq Mt archie@FreeBSD.org 173.Sh BUGS 174The node should not expect incoming GRE packets to have an IP header. 175This behavior is inherited from the (converse) behavior of raw IP sockets. 176An intermediate node that strips IP headers in one direction 177should be used instead. 178