0058c06a0ff8e6b4c9de8faf642577b71b5e1872
[dragonfly.git] / 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: src/share/man/man4/ng_l2tp.4,v 1.1.2.1 2002/08/20 23:48:53 archie Exp $
39 .\" $DragonFly: src/share/man/man4/ng_l2tp.4,v 1.7 2007/07/29 17:27:45 swildner Exp $
40 .\"
41 .Dd April 22, 2002
42 .Dt NG_L2TP 4
43 .Os
44 .Sh NAME
45 .Nm ng_l2tp
46 .Nd L2TP protocol netgraph node type
47 .Sh SYNOPSIS
48 .In netgraph/l2tp/ng_l2tp.h
49 .Sh DESCRIPTION
50 The
51 .Nm
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
61 node type supports the following hooks:
62 .Pp
63 .Bl -tag -compact -offset 3n -width 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 xx
108 .It Dv NGM_L2TP_SET_CONFIG
109 This command updates the configuration of the node.
110 It takes a
111 .Li "struct ng_l2tp_config"
112 as an argument:
113 .Bd -literal -offset 0n
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. In this way, reuse of a node is possible.
131 .Pp
132 The
133 .Va tunnel_id
134 field configures the local tunnel ID for the control connection.
135 The
136 .Va match_id
137 field determines how incoming L2TP packets with a tunnel ID
138 field different from
139 .Va tunnel_id
140 are handled.
141 If
142 .Va match_id
143 is non-zero, they will be dropped; otherwise, they will be dropped
144 only if the tunnel ID is non-zero.
145 Typically
146 .Va tunnel_id
147 is set to the local tunnel ID as soon as it is known and
148 .Va match_id
149 is set to non-zero after receipt of the SCCRP or SCCCN control message.
150 .Pp
151 The peer's tunnel ID should be set in
152 .Va peer_id
153 as soon as it is learned, typically after receipt of a SCCRQ or SCCRP
154 control message.
155 This value is copied into the L2TP header for outgoing packets.
156 .Pp
157 The
158 .Va peer_win
159 field should be set from the
160 .Dq Receive Window Size
161 AVP received from the peer.
162 The default value for this field is one; zero is an invalid value.
163 As long as
164 .Va enabled
165 is non-zero, this value may not be decreased.
166 .Pp
167 The
168 .Va rexmit_max
169 and
170 .Va rexmit_max_to
171 fields configure packet retransmission.
172 .Va rexmit_max_to
173 is the maximum retransmission delay between packets, in seconds.
174 The retransmit delay will start at a small value and increase
175 exponentially up to this limit.
176 The
177 .Va rexmit_max
178 sets the maximum number of times a packet will be retransmitted
179 without being acknowledged before a failure condition is declared.
180 Once a failure condition is declared, each additional retransmission
181 will cause the
182 .Nm
183 node to send a
184 .Dv NGM_L2TP_ACK_FAILURE
185 control message back to the node that sent the last
186 .Dv NGM_L2TP_SET_CONFIG .
187 Appropriate action should then be taken to shutdown the control connection.
188 .It Dv NGM_L2TP_GET_CONFIG
189 Returns the current configuration as a
190 .Dv "struct ng_l2tp_config" .
191 .It Dv NGM_L2TP_SET_SESS_CONFIG
192 This control message configures a single data session.
193 The corresponding hook must already be connected before sending this command.
194 The argument is a
195 .Li "struct ng_l2tp_sess_config" :
196 .Bd -literal -offset 0n
197 /* Configuration for a session hook */
198 struct ng_l2tp_sess_config {
199     u_int16_t   session_id;     /* local session id */
200     u_int16_t   peer_id;        /* peer's session id */
201     u_char      control_dseq;   /* we control data sequencing? */
202     u_char      enable_dseq;    /* enable data sequencing? */
203     u_char      include_length; /* include length field? */
204 };
205 .Ed
206 .Pp
207 The
208 .Va session_id
209 and
210 .Va peer_id
211 fields configure the local and remote session ID's, respectively.
212 .Pp
213 The
214 .Va control_dseq
215 and
216 .Va enable_dseq
217 fields determine whether sequence numbers are used with L2TP data packets.
218 If
219 .Va enable_dseq
220 is zero, then no sequence numbers are sent and incoming sequence numbers
221 are ignored.
222 Otherwise, sequence numbers are included on outgoing packets and checked
223 on incoming packets.
224 .Pp
225 If
226 .Va control_dseq
227 is non-zero, then the setting of
228 .Va enable_dseq
229 will never change except by another
230 .Dv NGM_L2TP_SET_SESS_CONFIG
231 control message.
232 If
233 .Va control_dseq
234 is zero, then the peer controls whether sequence numbers are used:
235 if an incoming L2TP data packet contains sequence numbers,
236 .Va enable_dseq
237 is set to one, and conversely if an incoming L2TP data packet does not
238 contain sequence numbers,
239 .Va enable_dseq
240 is set to zero.
241 The current value of
242 .Va enable_dseq
243 is always accessible via the
244 .Dv NGM_L2TP_GET_SESS_CONFIG
245 control message (see below).
246 Typically an LNS would set
247 .Va control_dseq
248 to one while a LAC would set
249 .Va control_dseq
250 to zero (if the Sequencing Required AVP were not sent), thus giving
251 control of data packet sequencing to the LNS.
252 .Pp
253 The
254 .Va include_length
255 field determines whether the L2TP header length field is included
256 in outgoing L2TP data packets.
257 For incoming packets, the L2TP length field is always checked when present.
258 .It Dv NGM_L2TP_GET_SESS_CONFIG
259 This command takes a two byte session ID as an argument and returns
260 the current configuration for the corresponding data session as a
261 .Dv "struct ng_l2tp_sess_config" .
262 The corresponding session hook must be connected.
263 .It Dv NGM_L2TP_GET_STATS
264 This command takes a two byte session ID as an argument and returns a
265 .Dv "struct ng_l2tp_stats"
266 containing statistics for the corresponding data session.
267 The corresponding session hook must be connected.
268 .It Dv NGM_L2TP_CLR_STATS
269 This command takes a two byte session ID as an argument and
270 clears the statistics for that data session.
271 The corresponding session hook must be connected.
272 .It Dv NGM_L2TP_GETCLR_STATS
273 Same as
274 .Dv NGM_L2TP_GET_STATS ,
275 but also atomically clears the statistics as well.
276 .El
277 .Sh SHUTDOWN
278 This node shuts down upon receipt of a
279 .Dv NGM_SHUTDOWN
280 control message, or when all hooks have been disconnected.
281 .Sh SEE ALSO
282 .Xr netgraph 4 ,
283 .Xr ng_ksocket 4 ,
284 .Xr ng_ppp 4 ,
285 .Xr ng_pptpgre 4 ,
286 .Xr ngctl 8
287 .Rs
288 .%A W. Townsley
289 .%A A. Valencia
290 .%A A. Rubens
291 .%A G. Pall
292 .%A G. Zorn
293 .%A B. Palter
294 .%T "Layer Two Tunneling Protocol L2TP"
295 .%O RFC 2661
296 .Re
297 .Sh HISTORY
298 The
299 .Nm
300 node type was developed at Packet Design, LLC.
301 .Dv "http://www.packetdesign.com/"
302 .Sh AUTHORS
303 .An Archie Cobbs Aq archie@packetdesign.com