The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/modules/netgraph/pptpgre/ng_pptpgre.4

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10  
    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 29, 1999
   39 .Dt NG_PPTPGRE 4
   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
   47 The
   48 .Nm pptpgre
   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.
   54 .Pp
   55 This node type expects to receive complete IP packets,
   56 including the IP header, on the
   57 .Dv lower
   58 hook, but it transmits outgoing frames without any IP header.
   59 The typical use for this node type would be to connect the
   60 .Dv upper
   61 hook to one of the link hooks of a
   62 .Xr ng_ppp 4
   63 node, and the
   64 .Dv lower
   65 hook to the
   66 .Dv "inet/raw/gre"
   67 hook of a
   68 .Xr ng_ksocket 4
   69 node.
   70 .Sh HOOKS
   71 This node type supports the following hooks:
   72 .Pp
   73 .Bl -tag -compact -width vjc_vjuncomp
   74 .It Dv upper
   75 Connection to the upper protocol layers
   76 .It Dv lower
   77 Connection to the lower protocol layers
   78 .El
   79 .Pp
   80 .Sh CONTROL MESSAGES
   81 This node type supports the generic control messages, plus the following:
   82 .Bl -tag -width foo
   83 .It Dv NGM_PPTPGRE_SET_CONFIG
   84 This command resets and configures the node for a session.
   85 This command takes a
   86 .Dv "struct ng_pptpgre_conf"
   87 as an argument:
   88 .Bd -literal -offset 0
   89 /* Configuration for a session */
   90 struct ng_pptpgre_conf {
   91     u_char      enabled;          /* enables traffic flow */
   92     u_char      enableDelayedAck; /* enables delayed acks */
   93     u_int16_t   cid;              /* my call id */
   94     u_int16_t   peerCid;          /* peer call id */
   95     u_int16_t   recvWin;          /* peer recv window size */
   96     u_int16_t   peerPpd;          /* peer packet processing delay
   97                                      (in 1/10 of a second) */
   98 };
   99 
  100 .Ed
  101 The
  102 .Dv enabled
  103 field enables traffic flow through the node.  The
  104 .Dv enableDelayedAck
  105 field enables delayed acknowledgement (maximum 250 miliseconds), which
  106 is a useful optimization and should generally be turned on.
  107 The remaining fields are as supplied by the PPTP virtual call setup process.
  108 .It Dv NGM_PPTPGRE_GET_CONFIG
  109 Returns the current configuration as a
  110 .Dv "struct ng_pptpgre_conf" .
  111 .It Dv NGM_PPTPGRE_GET_STATS
  112 This command returns a
  113 .Dv "struct ng_pptpgre_stats"
  114 containing various node statistics.
  115 .It Dv NGM_PPTPGRE_CLR_STATS
  116 This command resets the node statistics.
  117 .It Dv NGM_PPTPGRE_GETCLR_STATS
  118 This command atomically gets and resets the node statistics, returning a
  119 .Dv "struct ng_pptpgre_stats" .
  120 .El
  121 .Sh SHUTDOWN
  122 This node shuts down upon receipt of a
  123 .Dv NGM_SHUTDOWN
  124 control message, or when both hooks have been disconnected.
  125 .Sh SEE ALSO
  126 .Xr netgraph 4 ,
  127 .Xr ng_ksocket 4 ,
  128 .Xr ng_ppp 4 ,
  129 .Xr ngctl 8
  130 .Rs
  131 .%A K. Hamzeh
  132 .%A G. Pall
  133 .%A W. Verthein
  134 .%A J. Taarud
  135 .%A W. Little
  136 .%A G. Zorn
  137 .%T "Point-to-Point Tunneling Protocol (PPTP)"
  138 .%O RFC 2637
  139 .Re
  140 .Rs
  141 .%A S. Hanks
  142 .%A T. \&Li
  143 .%A D. Farinacci
  144 .%A P. Traina
  145 .%T "Generic Routing Encapsulation over IPv4 networks"
  146 .%O RFC 1702
  147 .Re
  148 .Sh BUGS
  149 The node should not expect incoming GRE packets to have an IP header.
  150 This behavior is inherited from the (converse) behavior of raw IP sockets.
  151 An intermediate node that strips IP headers in one direction
  152 should be used instead.
  153 .Sh HISTORY
  154 The
  155 .Nm
  156 node type was implemented in
  157 .Fx 4.0 .
  158 .Sh AUTHORS
  159 .An Archie Cobbs Aq archie@freebsd.org

Cache object: 62da9670a112c0bae8326bfa726a46bd

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.