share/man/man4/ng_l2tp.4

   1 .\" Copyright (c) 2001-2002 Packet Design, LLC.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Subject to the following obligations and disclaimer of warranty,
   5 .\" use and redistribution of this software, in source or object code
   6 .\" forms, with or without modifications are expressly permitted by
   7 .\" Packet Design; provided, however, that:
   8 .\"
   9 .\"    (i)  Any and all reproductions of the source or object code
  10 .\"         must include the copyright notice above and the following
  11 .\"         disclaimer of warranties; and
  12 .\"    (ii) No rights are granted, in any manner or form, to use
  13 .\"         Packet Design trademarks, including the mark "PACKET DESIGN"
  14 .\"         on advertising, endorsements, or otherwise except as such
  15 .\"         appears in the above copyright notice or in the software.
  16 .\"
  17 .\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
  18 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
  19 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
  20 .\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
  21 .\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
  22 .\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
  23 .\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
  24 .\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
  25 .\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
  26 .\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
  27 .\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
  28 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
  29 .\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
  30 .\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
  31 .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
  33 .\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
  34 .\" THE POSSIBILITY OF SUCH DAMAGE.
  35 .\"
  36 .\" Author: Archie Cobbs <archie@FreeBSD.org>
  37 .\"
  38 .\" $FreeBSD$
  39 .\"
  40 .Dd August 2, 2004
  41 .Dt NG_L2TP 4
  42 .Os
  43 .Sh NAME
  44 .Nm ng_l2tp
  45 .Nd L2TP protocol netgraph node type
  46 .Sh SYNOPSIS
  47 .In sys/types.h
  48 .In netgraph/ng_l2tp.h
  49 .Sh DESCRIPTION
  50 The
  51 .Nm l2tp
  52 node type implements the encapsulation layer of the L2TP protocol
  53 as described in RFC 2661.
  54 This includes adding the L2TP packet header for outgoing packets
  55 and verifying and removing it for incoming packets.
  56 The node maintains the L2TP sequence number state and handles
  57 control session packet acknowledgment and retransmission.
  58 .Sh HOOKS
  59 The
  60 .Nm l2tp
  61 node type supports the following hooks:
  62 .Pp
  63 .Bl -tag -compact -offset indent -width ".Dv session_hhhh"
  64 .It Dv lower
  65 L2TP frames.
  66 .It Dv ctrl
  67 Control packets.
  68 .It Dv session_hhhh
  69 Session 0xhhhh data packets.
  70 .El
  71 .Pp
  72 L2TP control and data packets are transmitted to, and received from,
  73 the L2TP peer via the
  74 .Dv lower
  75 hook.
  76 Typically this hook would be connected to the
  77 .Dv "inet/dgram/udp"
  78 hook of an
  79 .Xr ng_ksocket 4
  80 node for L2TP over UDP.
  81 .Pp
  82 The
  83 .Dv ctrl
  84 hook connects to the local L2TP management entity.
  85 L2TP control messages (without any L2TP headers) are transmitted
  86 and received on this hook.
  87 Messages written to this hook are guaranteed to be delivered to the
  88 peer reliably, in order, and without duplicates.
  89 .Pp
  90 Packets written to the
  91 .Dv ctrl
  92 hook must contain a two byte session ID prepended to the frame
  93 (in network order).
  94 This session ID is copied to the outgoing L2TP header.
  95 Similarly, packets read from the
  96 .Dv ctrl
  97 hook will have the received session ID prepended.
  98 .Pp
  99 Once an L2TP session has been created, the corresponding session
 100 hook may be used to transmit and receive the session's data frames:
 101 for the session with session ID
 102 .Dv 0xabcd ,
 103 the hook is named
 104 .Dv session_abcd .
 105 .Sh CONTROL MESSAGES
 106 This node type supports the generic control messages, plus the following:
 107 .Bl -tag -width indent
 108 .It Dv NGM_L2TP_SET_CONFIG
 109 This command updates the configuration of the node.
 110 It takes a
 111 .Vt "struct ng_l2tp_config"
 112 as an argument:
 113 .Bd -literal
 114 /* Configuration for a node */
 115 struct ng_l2tp_config {
 116     u_char      enabled;        /* enables traffic flow */
 117     u_char      match_id;       /* tunnel id must match 'tunnel_id' */
 118     u_int16_t   tunnel_id;      /* local tunnel id */
 119     u_int16_t   peer_id;        /* peer's tunnel id */
 120     u_int16_t   peer_win;       /* peer's max recv window size */
 121     u_int16_t   rexmit_max;     /* max retransmits before failure */
 122     u_int16_t   rexmit_max_to;  /* max delay between retransmits */
 123 };
 124 .Ed
 125 .Pp
 126 The
 127 .Va enabled
 128 field enables packet processing.
 129 Each time this field is changed back to zero the sequence
 130 number state is reset.
 131 In this way, reuse of a node is possible.
 132 .Pp
 133 The
 134 .Va tunnel_id
 135 field configures the local tunnel ID for the control connection.
 136 The
 137 .Va match_id
 138 field determines how incoming L2TP packets with a tunnel ID
 139 field different from
 140 .Va tunnel_id
 141 are handled.
 142 If
 143 .Va match_id
 144 is non-zero, they will be dropped; otherwise, they will be dropped
 145 only if the tunnel ID is non-zero.
 146 Typically
 147 .Va tunnel_id
 148 is set to the local tunnel ID as soon as it is known and
 149 .Va match_id
 150 is set to non-zero after receipt of the SCCRP or SCCCN control message.
 151 .Pp
 152 The peer's tunnel ID should be set in
 153 .Va peer_id
 154 as soon as it is learned, typically after receipt of a SCCRQ or SCCRP
 155 control message.
 156 This value is copied into the L2TP header for outgoing packets.
 157 .Pp
 158 The
 159 .Va peer_win
 160 field should be set from the
 161 .Dq "Receive Window Size"
 162 AVP received from the peer.
 163 The default value for this field is one; zero is an invalid value.
 164 As long as
 165 .Va enabled
 166 is non-zero, this value may not be decreased.
 167 .Pp
 168 The
 169 .Va rexmit_max
 170 and
 171 .Va rexmit_max_to
 172 fields configure packet retransmission.
 173 .Va rexmit_max_to
 174 is the maximum retransmission delay between packets, in seconds.
 175 The retransmit delay will start at a small value and increase
 176 exponentially up to this limit.
 177 The
 178 .Va rexmit_max
 179 sets the maximum number of times a packet will be retransmitted
 180 without being acknowledged before a failure condition is declared.
 181 Once a failure condition is declared, each additional retransmission
 182 will cause the
 183 .Nm l2tp
 184 node to send a
 185 .Dv NGM_L2TP_ACK_FAILURE
 186 control message back to the node that sent the last
 187 .Dv NGM_L2TP_SET_CONFIG .
 188 Appropriate action should then be taken to shutdown the control connection.
 189 .It Dv NGM_L2TP_GET_CONFIG
 190 Returns the current configuration as a
 191 .Vt "struct ng_l2tp_config" .
 192 .It Dv NGM_L2TP_SET_SESS_CONFIG
 193 This control message configures a single data session.
 194 The corresponding hook must already be connected before sending this command.
 195 The argument is a
 196 .Vt "struct ng_l2tp_sess_config" :
 197 .Bd -literal
 198 /* Configuration for a session hook */
 199 struct ng_l2tp_sess_config {
 200     u_int16_t   session_id;     /* local session id */
 201     u_int16_t   peer_id;        /* peer's session id */
 202     u_char      control_dseq;   /* we control data sequencing? */
 203     u_char      enable_dseq;    /* enable data sequencing? */
 204     u_char      include_length; /* include length field? */
 205 };
 206 .Ed
 207 .Pp
 208 The
 209 .Va session_id
 210 and
 211 .Va peer_id
 212 fields configure the local and remote session IDs, respectively.
 213 .Pp
 214 The
 215 .Va control_dseq
 216 and
 217 .Va enable_dseq
 218 fields determine whether sequence numbers are used with L2TP data packets.
 219 If
 220 .Va enable_dseq
 221 is zero, then no sequence numbers are sent and incoming sequence numbers
 222 are ignored.
 223 Otherwise, sequence numbers are included on outgoing packets and checked
 224 on incoming packets.
 225 .Pp
 226 If
 227 .Va control_dseq
 228 is non-zero, then the setting of
 229 .Va enable_dseq
 230 will never change except by another
 231 .Dv NGM_L2TP_SET_SESS_CONFIG
 232 control message.
 233 If
 234 .Va control_dseq
 235 is zero, then the peer controls whether sequence numbers are used:
 236 if an incoming L2TP data packet contains sequence numbers,
 237 .Va enable_dseq
 238 is set to one, and conversely if an incoming L2TP data packet does not
 239 contain sequence numbers,
 240 .Va enable_dseq
 241 is set to zero.
 242 The current value of
 243 .Va enable_dseq
 244 is always accessible via the
 245 .Dv NGM_L2TP_GET_SESS_CONFIG
 246 control message (see below).
 247 Typically an LNS would set
 248 .Va control_dseq
 249 to one while a LAC would set
 250 .Va control_dseq
 251 to zero (if the Sequencing Required AVP were not sent), thus giving
 252 control of data packet sequencing to the LNS.
 253 .Pp
 254 The
 255 .Va include_length
 256 field determines whether the L2TP header length field is included
 257 in outgoing L2TP data packets.
 258 For incoming packets, the L2TP length field is always checked when present.
 259 .It Dv NGM_L2TP_GET_SESS_CONFIG
 260 This command takes a two byte session ID as an argument and returns
 261 the current configuration for the corresponding data session as a
 262 .Vt "struct ng_l2tp_sess_config" .
 263 The corresponding session hook must be connected.
 264 .It Dv NGM_L2TP_GET_STATS
 265 This command returns a
 266 .Vt "struct ng_l2tp_stats"
 267 containing statistics of the L2TP tunnel.
 268 .It Dv NGM_L2TP_CLR_STATS
 269 This command clears the statistics for the L2TP tunnel.
 270 .It Dv NGM_L2TP_GETCLR_STATS
 271 Same as
 272 .Dv NGM_L2TP_GET_STATS ,
 273 but also atomically clears the statistics as well.
 274 .It Dv NGM_L2TP_GET_SESSION_STATS
 275 This command takes a two byte session ID as an argument and returns a
 276 .Vt "struct ng_l2tp_session_stats"
 277 containing statistics for the corresponding data session.
 278 The corresponding session hook must be connected.
 279 .It Dv NGM_L2TP_CLR_SESSION_STATS
 280 This command takes a two byte session ID as an argument and
 281 clears the statistics for that data session.
 282 The corresponding session hook must be connected.
 283 .It Dv NGM_L2TP_GETCLR_SESSION_STATS
 284 Same as
 285 .Dv NGM_L2TP_GET_SESSION_STATS ,
 286 but also atomically clears the statistics as well.
 287 .It Dv NGM_L2TP_SET_SEQ
 288 This command sets the sequence numbers of a not yet enabled node.
 289 It takes a
 290 .Vt "struct ng_l2tp_seq_config"
 291 as argument, where
 292 .Va xack
 293 and
 294 .Va nr
 295 respectively
 296 .Va ns
 297 and
 298 .Va rack
 299 must be the same.
 300 This option is particularly useful if one receives and processes
 301 the first packet entirely in userspace and wants to hand over further
 302 processing to the node.
 303 .El
 304 .Sh SHUTDOWN
 305 This node shuts down upon receipt of a
 306 .Dv NGM_SHUTDOWN
 307 control message, or when all hooks have been disconnected.
 308 .Sh SEE ALSO
 309 .Xr netgraph 4 ,
 310 .Xr ng_ksocket 4 ,
 311 .Xr ng_ppp 4 ,
 312 .Xr ng_pptpgre 4 ,
 313 .Xr ngctl 8
 314 .Rs
 315 .%A W. Townsley
 316 .%A A. Valencia
 317 .%A A. Rubens
 318 .%A G. Pall
 319 .%A G. Zorn
 320 .%A B. Palter
 321 .%T "Layer Two Tunneling Protocol L2TP"
 322 .%O RFC 2661
 323 .Re
 324 .Sh HISTORY
 325 The
 326 .Nm l2tp
 327 node type was developed at Packet Design, LLC,
 328 .Pa http://www.packetdesign.com/ .
 329 .Sh AUTHORS
 330 .An Archie Cobbs Aq archie@packetdesign.com