share/man/man4/ng_ppp.4

   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_ppp.8,v 1.3 1999/01/25 23:46:27 archie Exp $
  37 .\"
  38 .Dd January 19, 1999
  39 .Dt NG_PPP 4
  40 .Os FreeBSD
  41 .Sh NAME
  42 .Nm ng_ppp
  43 .Nd PPP protocol netgraph node type
  44 .Sh SYNOPSIS
  45 .Fd #include <netgraph/ng_ppp.h>
  46 .Sh DESCRIPTION
  47 The
  48 .Nm ppp
  49 node type performs multiplexing for the PPP protocol.  It handles
  50 only packets that contain data, and forwards protocol negotiation
  51 and control packets to a separate controlling entity (e.g., a
  52 user-land daemon).  This approach combines the fast dispatch of
  53 kernel implementations with the configuration flexibility of a
  54 user-land implementations.  The PPP node type directly supports
  55 multi-link PPP, Van Jacobson compression, PPP compression, PPP
  56 encryption, and the IP, IPX, and AppleTalk protocols.  A single
  57 PPP node corresponds to one PPP multi-link bundle.
  58 .Pp
  59 There is a separate hook for each PPP link in the bundle, plus
  60 several hooks corresponding to the directly supported protocols.
  61 For compression and encryption, separate attached nodes are required
  62 to do the actual work.  The node type used will of course depend
  63 on the algorithm negotiated.  There is also a
  64 .Dv bypass
  65 hook which is used to handle any protocol not directly supported
  66 by the node. This includes all of the control protocols: LCP, IPCP,
  67 CCP, etc.  Typically this node is connected to a user-land daemon
  68 via a
  69 .Xr ng_socket 4
  70 type node.
  71 .Sh ENABLING FUNCTIONALITY
  72 In general, the PPP node enables a specific link or functionality when
  73 (a) a
  74 .Dv NGM_PPP_SET_CONFIG
  75 message has been received which enables it, and
  76 (b) the corresponding hook(s) are connected.
  77 This allows the controlling entity to use either method (a) or (b)
  78 (or both) to control the node's behavior.
  79 When a link is connected but disabled, traffic can still flow on
  80 the link via the
  81 .Dv bypass
  82 hook (see below).
  83 .Sh LINK HOOKS
  84 During normal operation, the individual PPP links are connected to hooks
  85 .Dv link0 ,
  86 .Dv link1 ,
  87 etc.  Up to
  88 .Dv NG_PPP_MAX_LINKS
  89 links are supported.
  90 These device-independent hooks transmit and receive full PPP
  91 frames, which include the PPP protocol, address, control, and
  92 information fields, but no checksum or other link-specific fields.
  93 .Pp
  94 On outgoing frames, when protocol compression
  95 has been enabled and the protocol number is suitable for compression,
  96 the protocol field will be compressed (i.e., sent as one byte
  97 instead of two).  Either compressed or uncompressed protocol fields
  98 are accepted on incoming frames.  Similarly, if address and control
  99 field compression has been enabled for the link, the address and
 100 control fields will be omitted (except for LCP frames as required
 101 by the standards).  Incoming frames have the address and control fields
 102 stripped automatically if present.
 103 .Pp
 104 Since all negotiation is handled outside the PPP node, the links
 105 should not be connected and enabled until the corresponding link
 106 has reached the network phase (i.e., LCP negotiation and authentication
 107 have completed successfully) and the PPP node has been informed of
 108 the link parameters via the
 109 .Dv NGM_PPP_LINK_CONFIG
 110 message.
 111 .Pp
 112 When a link is connected but disabled, all received frames are forwarded
 113 directly out the
 114 .Dv bypass
 115 hook, and conversely, frames may be transmitted via the
 116 .Dv bypass
 117 hook as well.  This mode is appropriate for the link authentication phase.
 118 As soon as the link is enabled, the PPP node will
 119 begin processing frames received on the link.
 120 .Sh COMPRESSION AND ENCRYPTION
 121 Compression is supported via two hooks,
 122 .Dv compress
 123 and
 124 .Dv decompress .
 125 When enabled and connected, the PPP node writes outgoing frames on the
 126 .Dv comp
 127 hook and expects to receive back the compressed frame on the same hook.
 128 Similarly, the
 129 .Dv decompress
 130 hook is used to uncompress incoming frames when decompression is
 131 negotiated (compression and decompression are independently negotiable).
 132 The type of node attached to these hooks should correspond
 133 to the type of compression negotiated, e.g., Deflate, Predictor-1, etc.
 134 .Pp
 135 Encryption works exactly analogously via the
 136 .Dv encrypt
 137 and
 138 .Dv decrypt
 139 nodes.  Data is always compressed before being encrypted,
 140 and decrypted before being decompressed.
 141 .Pp
 142 Only bundle-level compression and encryption is directly supported;
 143 link-level compression and encryption can be handled transparently
 144 by downstream nodes.
 145 .Sh VAN JACOBSON COMPRESSION
 146 When all of the
 147 .Dv vjc_ip ,
 148 .Dv vjc_vjcomp ,
 149 .Dv vjc_vjuncomp ,
 150 and
 151 .Dv vjc_vjip
 152 hooks are connected, and the corresponding configuration flag is
 153 enabled, Van Jacobson compression and/or decompression will become active.
 154 Normally these hooks connect to the corresponding hooks of a single
 155 .Xr ng_vjc 4
 156 node.  The PPP node is compatible with the
 157 .Dq pass through
 158 modes of the
 159 .Xr ng_vjc 4
 160 node type.
 161 .Sh BYPASS HOOK
 162 When a frame is received on a link with an unsupported protocol,
 163 or a protocol which is disabled or for which the corresponding hook
 164 is unconnected, the PPP node forwards the frame out the
 165 .Dv bypass
 166 hook, prepended with a four byte prefix.  This first two bytes of
 167 the prefix indicate the link number on which the frame was received
 168 (in network order).
 169 For such frames received over the bundle (i.e., encapsulated in the
 170 multi-link protocol), the special link number
 171 .Dv NG_PPP_BUNDLE_LINKNUM
 172 is used.  After the two byte link number is the two byte PPP protocol number
 173 (also in network order).
 174 The PPP protocol number is two bytes long even if the original frame
 175 was protocol compressed.
 176 .Pp
 177 Conversely, any data written to the
 178 .Dv bypass
 179 hook is assumed to be in this same format.  The four byte header is
 180 stripped off, the PPP protocol number is prepended (possibly compressed),
 181 and the frame is delivered over the desired link.
 182 If the link number is
 183 .Dv NG_PPP_BUNDLE_LINKNUM
 184 the frame will be delivered over the multi-link bundle; or, if multi-link
 185 is disabled, over the (single) PPP link.
 186 .Pp
 187 Typically when the controlling entity receives an unexpected packet on the
 188 .Dv bypass
 189 hook it responds either by dropping the frame (if it's not ready for
 190 the protocol) or with an LCP protocol reject (if it doesn't recognize
 191 or expect the protocol).
 192 .Sh MULTILINK OPERATION
 193 To enable multi-link PPP, the corresponding configuration flag must be set
 194 and at least one link connected.  The PPP node will not allow more than
 195 one link to be connected if multi-link is not enabled, nor will it allow
 196 certain multi-link settings to be changed while multi-link operation is
 197 active (e.g., short sequence number header format).
 198 .Pp
 199 Because packets are sent as fragments across multiple individual links,
 200 it is important that when a link goes down the PPP node is notified
 201 immediately, either by disconnecting the corresponding hook or disabling
 202 the link via the
 203 .Dv NGM_PPP_SET_CONFIG
 204 control message.
 205 .Pp
 206 Each link has configuration parameters for latency (specified in
 207 milliseconds) and bandwidth (specified in tens of bytes per second).
 208 The PPP node can be configured for
 209 .Em round-robin
 210 or
 211 .Em optimized
 212 packet delivery.
 213 .Pp
 214 When configured for round-robin delivery, the latency and bandwidth
 215 values are ignored and the PPP node simply sends each frame as a
 216 single fragment, alternating frames across all the links in the
 217 bundle.  This scheme has the advantage that even if one link fails
 218 silently, some packets will still get through.  It has the disadvantage
 219 of sub-optimal overall bundle latency, which is important for
 220 interactive response time, and sub-optimal overall bundle bandwidth
 221 when links with different bandwidths exist in the same bundle.
 222 .Pp
 223 When configured for optimal delivery, the PPP node distributes the
 224 packet across the links in a way that minimizes the time it takes
 225 for the completed packet to be received by the far end.  This
 226 involves taking into account each link's latency, bandwidth, and
 227 current queue length.  Therefore these numbers should be
 228 configured as accurately as possible.  The algorithm does require
 229 some computation, so may not be appropriate for very slow machines
 230 and/or very fast links.
 231 .Pp
 232 As a special case, if all links have identical latency and bandwidth,
 233 then the above algorithm is disabled (because it is unnecessary)
 234 and the PPP node simply fragments frames into equal sized portions
 235 across all of the links.
 236 .Sh HOOKS
 237 This node type supports the following hooks:
 238 .Pp
 239 .Bl -tag -compact -width vjc_vjuncomp
 240 .It Dv link<N>
 241 Individual PPP link number
 242 .Dv <N>
 243 .It Dv compress
 244 Connection to compression engine
 245 .It Dv decompress
 246 Connection to decompression engine
 247 .It Dv encrypt
 248 Connection to encryption engine
 249 .It Dv decrypt
 250 Connection to decryption engine
 251 .It Dv vjc_ip
 252 Connection to
 253 .Xr ng_vjc 4
 254 .Dv ip
 255 hook
 256 .It Dv vjc_vjcomp
 257 Connection to
 258 .Xr ng_vjc 4
 259 .Dv vjcomp
 260 hook
 261 .It Dv vjc_vjuncomp
 262 Connection to
 263 .Xr ng_vjc 4
 264 .Dv vjuncomp
 265 hook
 266 .It Dv vjc_vjip
 267 Connection to
 268 .Xr ng_vjc 4
 269 .Dv vjip
 270 hook
 271 .It Dv inet
 272 IP packet data
 273 .It Dv atalk
 274 AppleTalk packet data
 275 .It Dv ipx
 276 IPX packet data
 277 .It Dv bypass
 278 Bypass hook; frames have a four byte header consisting of
 279 a link number and a PPP protocol number.
 280 .El
 281 .Pp
 282 .Sh CONTROL MESSAGES
 283 This node type supports the generic control messages, plus the following:
 284 .Bl -tag -width foo
 285 .It Dv NGM_PPP_SET_CONFIG
 286 This command configures all aspects of the node.  This includes enabling
 287 multi-link PPP, encryption, compression, Van Jacobson compression, and IP,
 288 AppleTalk, and IPX packet delivery.  It includes per-link configuration,
 289 including enabling the link, setting latency and bandwidth parameters,
 290 and enabling protocol field compression.  Note that no link or functionality
 291 is active until the corresponding hook is also connected.
 292 This command takes a
 293 .Dv "struct ng_ppp_node_config"
 294 as an argument:
 295 .Bd -literal -offset 0n
 296 /* Per-link config structure */
 297 struct ng_ppp_link_config {
 298   u_char    enableLink;     /* enable this link */
 299   u_char    enableProtoComp;/* enable protocol field compression */
 300   u_char    enableACFComp;  /* enable addr/ctrl field compression */
 301   u_int16_t mru;            /* peer MRU */
 302   u_int32_t latency;        /* link latency (in milliseconds) */
 303   u_int32_t bandwidth;      /* link bandwidth (in bytes/second) */
 304 };
 305
 306 /* Node config structure */
 307 struct ng_ppp_node_config {
 308   u_int16_t mrru;                   /* multilink peer MRRU */
 309   u_char    enableMultilink;        /* enable multilink */
 310   u_char    recvShortSeq;           /* recv multilink short seq # */
 311   u_char    xmitShortSeq;           /* xmit multilink short seq # */
 312   u_char    enableRoundRobin;       /* xmit whole packets */
 313   u_char    enableIP;               /* enable IP data flow */
 314   u_char    enableAtalk;            /* enable AppleTalk data flow */
 315   u_char    enableIPX;              /* enable IPX data flow */
 316   u_char    enableCompression;      /* enable PPP compression */
 317   u_char    enableDecompression;    /* enable PPP decompression */
 318   u_char    enableEncryption;       /* enable PPP encryption */
 319   u_char    enableDecryption;       /* enable PPP decryption */
 320   u_char    enableVJCompression;    /* enable VJ compression */
 321   u_char    enableVJDecompression;  /* enable VJ decompression */
 322   struct ng_ppp_link_config          /* per link config params */
 323             links[NG_PPP_MAX_LINKS];
 324 };
 325 .Ed
 326 .Pp
 327 .It Dv NGM_PPP_GET_CONFIG
 328 Returns the current configuration as a
 329 .Dv "struct ng_ppp_node_config" .
 330 .It Dv NGM_PPP_GET_LINK_STATS
 331 This command takes a two byte link number as an argument and returns a
 332 .Dv "struct ng_ppp_link_stat"
 333 containing statistics for the corresponding link.  Here
 334 .Dv NG_PPP_BUNDLE_LINKNUM
 335 is a valid link number corresponding to the multi-link bundle.
 336 .It Dv NGM_PPP_CLR_LINK_STATS
 337 This command takes a two byte link number as an argument and
 338 clears the statistics for that link.
 339 .It Dv NGM_PPP_GETCLR_LINK_STATS
 340 Same as
 341 .Dv NGM_PPP_GET_LINK_STATS ,
 342 but also atomically clears the statistics as well.
 343 .El
 344 .Pp
 345 This node type also accepts the control messages accepted by the
 346 .Xr ng_vjc 4
 347 node type. When received, these messages are simply forwarded to
 348 the adjacent
 349 .Xr ng_vjc 4
 350 node, if any.  This is particularly useful when the individual
 351 PPP links are able to generate
 352 .Dv NGM_VJC_RECV_ERROR
 353 messages (see
 354 .Xr ng_vjc 4
 355 for a description).
 356 .Sh SHUTDOWN
 357 This node shuts down upon receipt of a
 358 .Dv NGM_SHUTDOWN
 359 control message, or when all hooks have been disconnected.
 360 .Sh SEE ALSO
 361 .Xr netgraph 4 ,
 362 .Xr ng_async 4 ,
 363 .Xr ng_iface 4 ,
 364 .Xr ng_mppc 4 ,
 365 .Xr ng_pppoe 4 ,
 366 .Xr ng_vjc 4 ,
 367 .Xr ngctl 8
 368 .Rs
 369 .%A W. Simpson
 370 .%T "The Point-to-Point Protocol (PPP)"
 371 .%O RFC 1661
 372 .Re
 373 .Rs
 374 .%A K. Sklower
 375 .%A B. Lloyd
 376 .%A G. McGregor
 377 .%A D. Carr
 378 .%A T. Coradetti
 379 .%T "The PPP Multilink Protocol (MP)"
 380 .%O RFC 1990
 381 .Re
 382 .Sh HISTORY
 383 The
 384 .Nm
 385 node type was implemented in
 386 .Fx 4.0 .
 387 .Sh AUTHORS
 388 .An Archie Cobbs Aq archie@FreeBSD.org