Linux 4.19.133
[linux/fpc-iii.git] / net / l2tp / l2tp_core.c
blob9aa1c1fcb77c459c1c27ff212376f30045b8f0c4
1 /*
2 * L2TP core.
4 * Copyright (c) 2008,2009,2010 Katalix Systems Ltd
6 * This file contains some code of the original L2TPv2 pppol2tp
7 * driver, which has the following copyright:
9 * Authors: Martijn van Oosterhout <kleptog@svana.org>
10 * James Chapman (jchapman@katalix.com)
11 * Contributors:
12 * Michal Ostrowski <mostrows@speakeasy.net>
13 * Arnaldo Carvalho de Melo <acme@xconectiva.com.br>
14 * David S. Miller (davem@redhat.com)
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License version 2 as
18 * published by the Free Software Foundation.
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/module.h>
24 #include <linux/string.h>
25 #include <linux/list.h>
26 #include <linux/rculist.h>
27 #include <linux/uaccess.h>
29 #include <linux/kernel.h>
30 #include <linux/spinlock.h>
31 #include <linux/kthread.h>
32 #include <linux/sched.h>
33 #include <linux/slab.h>
34 #include <linux/errno.h>
35 #include <linux/jiffies.h>
37 #include <linux/netdevice.h>
38 #include <linux/net.h>
39 #include <linux/inetdevice.h>
40 #include <linux/skbuff.h>
41 #include <linux/init.h>
42 #include <linux/in.h>
43 #include <linux/ip.h>
44 #include <linux/udp.h>
45 #include <linux/l2tp.h>
46 #include <linux/hash.h>
47 #include <linux/sort.h>
48 #include <linux/file.h>
49 #include <linux/nsproxy.h>
50 #include <net/net_namespace.h>
51 #include <net/netns/generic.h>
52 #include <net/dst.h>
53 #include <net/ip.h>
54 #include <net/udp.h>
55 #include <net/udp_tunnel.h>
56 #include <net/inet_common.h>
57 #include <net/xfrm.h>
58 #include <net/protocol.h>
59 #include <net/inet6_connection_sock.h>
60 #include <net/inet_ecn.h>
61 #include <net/ip6_route.h>
62 #include <net/ip6_checksum.h>
64 #include <asm/byteorder.h>
65 #include <linux/atomic.h>
67 #include "l2tp_core.h"
69 #define L2TP_DRV_VERSION "V2.0"
71 /* L2TP header constants */
72 #define L2TP_HDRFLAG_T 0x8000
73 #define L2TP_HDRFLAG_L 0x4000
74 #define L2TP_HDRFLAG_S 0x0800
75 #define L2TP_HDRFLAG_O 0x0200
76 #define L2TP_HDRFLAG_P 0x0100
78 #define L2TP_HDR_VER_MASK 0x000F
79 #define L2TP_HDR_VER_2 0x0002
80 #define L2TP_HDR_VER_3 0x0003
82 /* L2TPv3 default L2-specific sublayer */
83 #define L2TP_SLFLAG_S 0x40000000
84 #define L2TP_SL_SEQ_MASK 0x00ffffff
86 #define L2TP_HDR_SIZE_MAX 14
88 /* Default trace flags */
89 #define L2TP_DEFAULT_DEBUG_FLAGS 0
91 /* Private data stored for received packets in the skb.
93 struct l2tp_skb_cb {
94 u32 ns;
95 u16 has_seq;
96 u16 length;
97 unsigned long expires;
100 #define L2TP_SKB_CB(skb) ((struct l2tp_skb_cb *) &skb->cb[sizeof(struct inet_skb_parm)])
102 static struct workqueue_struct *l2tp_wq;
104 /* per-net private data for this module */
105 static unsigned int l2tp_net_id;
106 struct l2tp_net {
107 struct list_head l2tp_tunnel_list;
108 spinlock_t l2tp_tunnel_list_lock;
109 struct hlist_head l2tp_session_hlist[L2TP_HASH_SIZE_2];
110 spinlock_t l2tp_session_hlist_lock;
113 #if IS_ENABLED(CONFIG_IPV6)
114 static bool l2tp_sk_is_v6(struct sock *sk)
116 return sk->sk_family == PF_INET6 &&
117 !ipv6_addr_v4mapped(&sk->sk_v6_daddr);
119 #endif
121 static inline struct l2tp_tunnel *l2tp_tunnel(struct sock *sk)
123 return sk->sk_user_data;
126 static inline struct l2tp_net *l2tp_pernet(const struct net *net)
128 BUG_ON(!net);
130 return net_generic(net, l2tp_net_id);
133 /* Session hash global list for L2TPv3.
134 * The session_id SHOULD be random according to RFC3931, but several
135 * L2TP implementations use incrementing session_ids. So we do a real
136 * hash on the session_id, rather than a simple bitmask.
138 static inline struct hlist_head *
139 l2tp_session_id_hash_2(struct l2tp_net *pn, u32 session_id)
141 return &pn->l2tp_session_hlist[hash_32(session_id, L2TP_HASH_BITS_2)];
145 /* Session hash list.
146 * The session_id SHOULD be random according to RFC2661, but several
147 * L2TP implementations (Cisco and Microsoft) use incrementing
148 * session_ids. So we do a real hash on the session_id, rather than a
149 * simple bitmask.
151 static inline struct hlist_head *
152 l2tp_session_id_hash(struct l2tp_tunnel *tunnel, u32 session_id)
154 return &tunnel->session_hlist[hash_32(session_id, L2TP_HASH_BITS)];
157 void l2tp_tunnel_free(struct l2tp_tunnel *tunnel)
159 sock_put(tunnel->sock);
160 /* the tunnel is freed in the socket destructor */
162 EXPORT_SYMBOL(l2tp_tunnel_free);
164 /* Lookup a tunnel. A new reference is held on the returned tunnel. */
165 struct l2tp_tunnel *l2tp_tunnel_get(const struct net *net, u32 tunnel_id)
167 const struct l2tp_net *pn = l2tp_pernet(net);
168 struct l2tp_tunnel *tunnel;
170 rcu_read_lock_bh();
171 list_for_each_entry_rcu(tunnel, &pn->l2tp_tunnel_list, list) {
172 if (tunnel->tunnel_id == tunnel_id &&
173 refcount_inc_not_zero(&tunnel->ref_count)) {
174 rcu_read_unlock_bh();
176 return tunnel;
179 rcu_read_unlock_bh();
181 return NULL;
183 EXPORT_SYMBOL_GPL(l2tp_tunnel_get);
185 struct l2tp_tunnel *l2tp_tunnel_get_nth(const struct net *net, int nth)
187 const struct l2tp_net *pn = l2tp_pernet(net);
188 struct l2tp_tunnel *tunnel;
189 int count = 0;
191 rcu_read_lock_bh();
192 list_for_each_entry_rcu(tunnel, &pn->l2tp_tunnel_list, list) {
193 if (++count > nth &&
194 refcount_inc_not_zero(&tunnel->ref_count)) {
195 rcu_read_unlock_bh();
196 return tunnel;
199 rcu_read_unlock_bh();
201 return NULL;
203 EXPORT_SYMBOL_GPL(l2tp_tunnel_get_nth);
205 struct l2tp_session *l2tp_tunnel_get_session(struct l2tp_tunnel *tunnel,
206 u32 session_id)
208 struct hlist_head *session_list;
209 struct l2tp_session *session;
211 session_list = l2tp_session_id_hash(tunnel, session_id);
213 read_lock_bh(&tunnel->hlist_lock);
214 hlist_for_each_entry(session, session_list, hlist)
215 if (session->session_id == session_id) {
216 l2tp_session_inc_refcount(session);
217 read_unlock_bh(&tunnel->hlist_lock);
219 return session;
221 read_unlock_bh(&tunnel->hlist_lock);
223 return NULL;
225 EXPORT_SYMBOL_GPL(l2tp_tunnel_get_session);
227 struct l2tp_session *l2tp_session_get(const struct net *net, u32 session_id)
229 struct hlist_head *session_list;
230 struct l2tp_session *session;
232 session_list = l2tp_session_id_hash_2(l2tp_pernet(net), session_id);
234 rcu_read_lock_bh();
235 hlist_for_each_entry_rcu(session, session_list, global_hlist)
236 if (session->session_id == session_id) {
237 l2tp_session_inc_refcount(session);
238 rcu_read_unlock_bh();
240 return session;
242 rcu_read_unlock_bh();
244 return NULL;
246 EXPORT_SYMBOL_GPL(l2tp_session_get);
248 struct l2tp_session *l2tp_session_get_nth(struct l2tp_tunnel *tunnel, int nth)
250 int hash;
251 struct l2tp_session *session;
252 int count = 0;
254 read_lock_bh(&tunnel->hlist_lock);
255 for (hash = 0; hash < L2TP_HASH_SIZE; hash++) {
256 hlist_for_each_entry(session, &tunnel->session_hlist[hash], hlist) {
257 if (++count > nth) {
258 l2tp_session_inc_refcount(session);
259 read_unlock_bh(&tunnel->hlist_lock);
260 return session;
265 read_unlock_bh(&tunnel->hlist_lock);
267 return NULL;
269 EXPORT_SYMBOL_GPL(l2tp_session_get_nth);
271 /* Lookup a session by interface name.
272 * This is very inefficient but is only used by management interfaces.
274 struct l2tp_session *l2tp_session_get_by_ifname(const struct net *net,
275 const char *ifname)
277 struct l2tp_net *pn = l2tp_pernet(net);
278 int hash;
279 struct l2tp_session *session;
281 rcu_read_lock_bh();
282 for (hash = 0; hash < L2TP_HASH_SIZE_2; hash++) {
283 hlist_for_each_entry_rcu(session, &pn->l2tp_session_hlist[hash], global_hlist) {
284 if (!strcmp(session->ifname, ifname)) {
285 l2tp_session_inc_refcount(session);
286 rcu_read_unlock_bh();
288 return session;
293 rcu_read_unlock_bh();
295 return NULL;
297 EXPORT_SYMBOL_GPL(l2tp_session_get_by_ifname);
299 int l2tp_session_register(struct l2tp_session *session,
300 struct l2tp_tunnel *tunnel)
302 struct l2tp_session *session_walk;
303 struct hlist_head *g_head;
304 struct hlist_head *head;
305 struct l2tp_net *pn;
306 int err;
308 head = l2tp_session_id_hash(tunnel, session->session_id);
310 write_lock_bh(&tunnel->hlist_lock);
311 if (!tunnel->acpt_newsess) {
312 err = -ENODEV;
313 goto err_tlock;
316 hlist_for_each_entry(session_walk, head, hlist)
317 if (session_walk->session_id == session->session_id) {
318 err = -EEXIST;
319 goto err_tlock;
322 if (tunnel->version == L2TP_HDR_VER_3) {
323 pn = l2tp_pernet(tunnel->l2tp_net);
324 g_head = l2tp_session_id_hash_2(pn, session->session_id);
326 spin_lock_bh(&pn->l2tp_session_hlist_lock);
328 /* IP encap expects session IDs to be globally unique, while
329 * UDP encap doesn't.
331 hlist_for_each_entry(session_walk, g_head, global_hlist)
332 if (session_walk->session_id == session->session_id &&
333 (session_walk->tunnel->encap == L2TP_ENCAPTYPE_IP ||
334 tunnel->encap == L2TP_ENCAPTYPE_IP)) {
335 err = -EEXIST;
336 goto err_tlock_pnlock;
339 l2tp_tunnel_inc_refcount(tunnel);
340 hlist_add_head_rcu(&session->global_hlist, g_head);
342 spin_unlock_bh(&pn->l2tp_session_hlist_lock);
343 } else {
344 l2tp_tunnel_inc_refcount(tunnel);
347 hlist_add_head(&session->hlist, head);
348 write_unlock_bh(&tunnel->hlist_lock);
350 return 0;
352 err_tlock_pnlock:
353 spin_unlock_bh(&pn->l2tp_session_hlist_lock);
354 err_tlock:
355 write_unlock_bh(&tunnel->hlist_lock);
357 return err;
359 EXPORT_SYMBOL_GPL(l2tp_session_register);
361 /*****************************************************************************
362 * Receive data handling
363 *****************************************************************************/
365 /* Queue a skb in order. We come here only if the skb has an L2TP sequence
366 * number.
368 static void l2tp_recv_queue_skb(struct l2tp_session *session, struct sk_buff *skb)
370 struct sk_buff *skbp;
371 struct sk_buff *tmp;
372 u32 ns = L2TP_SKB_CB(skb)->ns;
374 spin_lock_bh(&session->reorder_q.lock);
375 skb_queue_walk_safe(&session->reorder_q, skbp, tmp) {
376 if (L2TP_SKB_CB(skbp)->ns > ns) {
377 __skb_queue_before(&session->reorder_q, skbp, skb);
378 l2tp_dbg(session, L2TP_MSG_SEQ,
379 "%s: pkt %hu, inserted before %hu, reorder_q len=%d\n",
380 session->name, ns, L2TP_SKB_CB(skbp)->ns,
381 skb_queue_len(&session->reorder_q));
382 atomic_long_inc(&session->stats.rx_oos_packets);
383 goto out;
387 __skb_queue_tail(&session->reorder_q, skb);
389 out:
390 spin_unlock_bh(&session->reorder_q.lock);
393 /* Dequeue a single skb.
395 static void l2tp_recv_dequeue_skb(struct l2tp_session *session, struct sk_buff *skb)
397 struct l2tp_tunnel *tunnel = session->tunnel;
398 int length = L2TP_SKB_CB(skb)->length;
400 /* We're about to requeue the skb, so return resources
401 * to its current owner (a socket receive buffer).
403 skb_orphan(skb);
405 atomic_long_inc(&tunnel->stats.rx_packets);
406 atomic_long_add(length, &tunnel->stats.rx_bytes);
407 atomic_long_inc(&session->stats.rx_packets);
408 atomic_long_add(length, &session->stats.rx_bytes);
410 if (L2TP_SKB_CB(skb)->has_seq) {
411 /* Bump our Nr */
412 session->nr++;
413 session->nr &= session->nr_max;
415 l2tp_dbg(session, L2TP_MSG_SEQ, "%s: updated nr to %hu\n",
416 session->name, session->nr);
419 /* call private receive handler */
420 if (session->recv_skb != NULL)
421 (*session->recv_skb)(session, skb, L2TP_SKB_CB(skb)->length);
422 else
423 kfree_skb(skb);
426 /* Dequeue skbs from the session's reorder_q, subject to packet order.
427 * Skbs that have been in the queue for too long are simply discarded.
429 static void l2tp_recv_dequeue(struct l2tp_session *session)
431 struct sk_buff *skb;
432 struct sk_buff *tmp;
434 /* If the pkt at the head of the queue has the nr that we
435 * expect to send up next, dequeue it and any other
436 * in-sequence packets behind it.
438 start:
439 spin_lock_bh(&session->reorder_q.lock);
440 skb_queue_walk_safe(&session->reorder_q, skb, tmp) {
441 if (time_after(jiffies, L2TP_SKB_CB(skb)->expires)) {
442 atomic_long_inc(&session->stats.rx_seq_discards);
443 atomic_long_inc(&session->stats.rx_errors);
444 l2tp_dbg(session, L2TP_MSG_SEQ,
445 "%s: oos pkt %u len %d discarded (too old), waiting for %u, reorder_q_len=%d\n",
446 session->name, L2TP_SKB_CB(skb)->ns,
447 L2TP_SKB_CB(skb)->length, session->nr,
448 skb_queue_len(&session->reorder_q));
449 session->reorder_skip = 1;
450 __skb_unlink(skb, &session->reorder_q);
451 kfree_skb(skb);
452 continue;
455 if (L2TP_SKB_CB(skb)->has_seq) {
456 if (session->reorder_skip) {
457 l2tp_dbg(session, L2TP_MSG_SEQ,
458 "%s: advancing nr to next pkt: %u -> %u",
459 session->name, session->nr,
460 L2TP_SKB_CB(skb)->ns);
461 session->reorder_skip = 0;
462 session->nr = L2TP_SKB_CB(skb)->ns;
464 if (L2TP_SKB_CB(skb)->ns != session->nr) {
465 l2tp_dbg(session, L2TP_MSG_SEQ,
466 "%s: holding oos pkt %u len %d, waiting for %u, reorder_q_len=%d\n",
467 session->name, L2TP_SKB_CB(skb)->ns,
468 L2TP_SKB_CB(skb)->length, session->nr,
469 skb_queue_len(&session->reorder_q));
470 goto out;
473 __skb_unlink(skb, &session->reorder_q);
475 /* Process the skb. We release the queue lock while we
476 * do so to let other contexts process the queue.
478 spin_unlock_bh(&session->reorder_q.lock);
479 l2tp_recv_dequeue_skb(session, skb);
480 goto start;
483 out:
484 spin_unlock_bh(&session->reorder_q.lock);
487 static int l2tp_seq_check_rx_window(struct l2tp_session *session, u32 nr)
489 u32 nws;
491 if (nr >= session->nr)
492 nws = nr - session->nr;
493 else
494 nws = (session->nr_max + 1) - (session->nr - nr);
496 return nws < session->nr_window_size;
499 /* If packet has sequence numbers, queue it if acceptable. Returns 0 if
500 * acceptable, else non-zero.
502 static int l2tp_recv_data_seq(struct l2tp_session *session, struct sk_buff *skb)
504 if (!l2tp_seq_check_rx_window(session, L2TP_SKB_CB(skb)->ns)) {
505 /* Packet sequence number is outside allowed window.
506 * Discard it.
508 l2tp_dbg(session, L2TP_MSG_SEQ,
509 "%s: pkt %u len %d discarded, outside window, nr=%u\n",
510 session->name, L2TP_SKB_CB(skb)->ns,
511 L2TP_SKB_CB(skb)->length, session->nr);
512 goto discard;
515 if (session->reorder_timeout != 0) {
516 /* Packet reordering enabled. Add skb to session's
517 * reorder queue, in order of ns.
519 l2tp_recv_queue_skb(session, skb);
520 goto out;
523 /* Packet reordering disabled. Discard out-of-sequence packets, while
524 * tracking the number if in-sequence packets after the first OOS packet
525 * is seen. After nr_oos_count_max in-sequence packets, reset the
526 * sequence number to re-enable packet reception.
528 if (L2TP_SKB_CB(skb)->ns == session->nr) {
529 skb_queue_tail(&session->reorder_q, skb);
530 } else {
531 u32 nr_oos = L2TP_SKB_CB(skb)->ns;
532 u32 nr_next = (session->nr_oos + 1) & session->nr_max;
534 if (nr_oos == nr_next)
535 session->nr_oos_count++;
536 else
537 session->nr_oos_count = 0;
539 session->nr_oos = nr_oos;
540 if (session->nr_oos_count > session->nr_oos_count_max) {
541 session->reorder_skip = 1;
542 l2tp_dbg(session, L2TP_MSG_SEQ,
543 "%s: %d oos packets received. Resetting sequence numbers\n",
544 session->name, session->nr_oos_count);
546 if (!session->reorder_skip) {
547 atomic_long_inc(&session->stats.rx_seq_discards);
548 l2tp_dbg(session, L2TP_MSG_SEQ,
549 "%s: oos pkt %u len %d discarded, waiting for %u, reorder_q_len=%d\n",
550 session->name, L2TP_SKB_CB(skb)->ns,
551 L2TP_SKB_CB(skb)->length, session->nr,
552 skb_queue_len(&session->reorder_q));
553 goto discard;
555 skb_queue_tail(&session->reorder_q, skb);
558 out:
559 return 0;
561 discard:
562 return 1;
565 /* Do receive processing of L2TP data frames. We handle both L2TPv2
566 * and L2TPv3 data frames here.
568 * L2TPv2 Data Message Header
570 * 0 1 2 3
571 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
572 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
573 * |T|L|x|x|S|x|O|P|x|x|x|x| Ver | Length (opt) |
574 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
575 * | Tunnel ID | Session ID |
576 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
577 * | Ns (opt) | Nr (opt) |
578 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
579 * | Offset Size (opt) | Offset pad... (opt)
580 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
582 * Data frames are marked by T=0. All other fields are the same as
583 * those in L2TP control frames.
585 * L2TPv3 Data Message Header
587 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
588 * | L2TP Session Header |
589 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
590 * | L2-Specific Sublayer |
591 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
592 * | Tunnel Payload ...
593 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
595 * L2TPv3 Session Header Over IP
597 * 0 1 2 3
598 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
599 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
600 * | Session ID |
601 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
602 * | Cookie (optional, maximum 64 bits)...
603 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
605 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
607 * L2TPv3 L2-Specific Sublayer Format
609 * 0 1 2 3
610 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
611 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
612 * |x|S|x|x|x|x|x|x| Sequence Number |
613 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
615 * Cookie value and sublayer format are negotiated with the peer when
616 * the session is set up. Unlike L2TPv2, we do not need to parse the
617 * packet header to determine if optional fields are present.
619 * Caller must already have parsed the frame and determined that it is
620 * a data (not control) frame before coming here. Fields up to the
621 * session-id have already been parsed and ptr points to the data
622 * after the session-id.
624 void l2tp_recv_common(struct l2tp_session *session, struct sk_buff *skb,
625 unsigned char *ptr, unsigned char *optr, u16 hdrflags,
626 int length)
628 struct l2tp_tunnel *tunnel = session->tunnel;
629 int offset;
630 u32 ns, nr;
632 /* Parse and check optional cookie */
633 if (session->peer_cookie_len > 0) {
634 if (memcmp(ptr, &session->peer_cookie[0], session->peer_cookie_len)) {
635 l2tp_info(tunnel, L2TP_MSG_DATA,
636 "%s: cookie mismatch (%u/%u). Discarding.\n",
637 tunnel->name, tunnel->tunnel_id,
638 session->session_id);
639 atomic_long_inc(&session->stats.rx_cookie_discards);
640 goto discard;
642 ptr += session->peer_cookie_len;
645 /* Handle the optional sequence numbers. Sequence numbers are
646 * in different places for L2TPv2 and L2TPv3.
648 * If we are the LAC, enable/disable sequence numbers under
649 * the control of the LNS. If no sequence numbers present but
650 * we were expecting them, discard frame.
652 ns = nr = 0;
653 L2TP_SKB_CB(skb)->has_seq = 0;
654 if (tunnel->version == L2TP_HDR_VER_2) {
655 if (hdrflags & L2TP_HDRFLAG_S) {
656 ns = ntohs(*(__be16 *) ptr);
657 ptr += 2;
658 nr = ntohs(*(__be16 *) ptr);
659 ptr += 2;
661 /* Store L2TP info in the skb */
662 L2TP_SKB_CB(skb)->ns = ns;
663 L2TP_SKB_CB(skb)->has_seq = 1;
665 l2tp_dbg(session, L2TP_MSG_SEQ,
666 "%s: recv data ns=%u, nr=%u, session nr=%u\n",
667 session->name, ns, nr, session->nr);
669 } else if (session->l2specific_type == L2TP_L2SPECTYPE_DEFAULT) {
670 u32 l2h = ntohl(*(__be32 *) ptr);
672 if (l2h & 0x40000000) {
673 ns = l2h & 0x00ffffff;
675 /* Store L2TP info in the skb */
676 L2TP_SKB_CB(skb)->ns = ns;
677 L2TP_SKB_CB(skb)->has_seq = 1;
679 l2tp_dbg(session, L2TP_MSG_SEQ,
680 "%s: recv data ns=%u, session nr=%u\n",
681 session->name, ns, session->nr);
683 ptr += 4;
686 if (L2TP_SKB_CB(skb)->has_seq) {
687 /* Received a packet with sequence numbers. If we're the LNS,
688 * check if we sre sending sequence numbers and if not,
689 * configure it so.
691 if ((!session->lns_mode) && (!session->send_seq)) {
692 l2tp_info(session, L2TP_MSG_SEQ,
693 "%s: requested to enable seq numbers by LNS\n",
694 session->name);
695 session->send_seq = 1;
696 l2tp_session_set_header_len(session, tunnel->version);
698 } else {
699 /* No sequence numbers.
700 * If user has configured mandatory sequence numbers, discard.
702 if (session->recv_seq) {
703 l2tp_warn(session, L2TP_MSG_SEQ,
704 "%s: recv data has no seq numbers when required. Discarding.\n",
705 session->name);
706 atomic_long_inc(&session->stats.rx_seq_discards);
707 goto discard;
710 /* If we're the LAC and we're sending sequence numbers, the
711 * LNS has requested that we no longer send sequence numbers.
712 * If we're the LNS and we're sending sequence numbers, the
713 * LAC is broken. Discard the frame.
715 if ((!session->lns_mode) && (session->send_seq)) {
716 l2tp_info(session, L2TP_MSG_SEQ,
717 "%s: requested to disable seq numbers by LNS\n",
718 session->name);
719 session->send_seq = 0;
720 l2tp_session_set_header_len(session, tunnel->version);
721 } else if (session->send_seq) {
722 l2tp_warn(session, L2TP_MSG_SEQ,
723 "%s: recv data has no seq numbers when required. Discarding.\n",
724 session->name);
725 atomic_long_inc(&session->stats.rx_seq_discards);
726 goto discard;
730 /* Session data offset is defined only for L2TPv2 and is
731 * indicated by an optional 16-bit value in the header.
733 if (tunnel->version == L2TP_HDR_VER_2) {
734 /* If offset bit set, skip it. */
735 if (hdrflags & L2TP_HDRFLAG_O) {
736 offset = ntohs(*(__be16 *)ptr);
737 ptr += 2 + offset;
741 offset = ptr - optr;
742 if (!pskb_may_pull(skb, offset))
743 goto discard;
745 __skb_pull(skb, offset);
747 /* Prepare skb for adding to the session's reorder_q. Hold
748 * packets for max reorder_timeout or 1 second if not
749 * reordering.
751 L2TP_SKB_CB(skb)->length = length;
752 L2TP_SKB_CB(skb)->expires = jiffies +
753 (session->reorder_timeout ? session->reorder_timeout : HZ);
755 /* Add packet to the session's receive queue. Reordering is done here, if
756 * enabled. Saved L2TP protocol info is stored in skb->sb[].
758 if (L2TP_SKB_CB(skb)->has_seq) {
759 if (l2tp_recv_data_seq(session, skb))
760 goto discard;
761 } else {
762 /* No sequence numbers. Add the skb to the tail of the
763 * reorder queue. This ensures that it will be
764 * delivered after all previous sequenced skbs.
766 skb_queue_tail(&session->reorder_q, skb);
769 /* Try to dequeue as many skbs from reorder_q as we can. */
770 l2tp_recv_dequeue(session);
772 return;
774 discard:
775 atomic_long_inc(&session->stats.rx_errors);
776 kfree_skb(skb);
778 EXPORT_SYMBOL(l2tp_recv_common);
780 /* Drop skbs from the session's reorder_q
782 static int l2tp_session_queue_purge(struct l2tp_session *session)
784 struct sk_buff *skb = NULL;
785 BUG_ON(!session);
786 BUG_ON(session->magic != L2TP_SESSION_MAGIC);
787 while ((skb = skb_dequeue(&session->reorder_q))) {
788 atomic_long_inc(&session->stats.rx_errors);
789 kfree_skb(skb);
791 return 0;
794 /* Internal UDP receive frame. Do the real work of receiving an L2TP data frame
795 * here. The skb is not on a list when we get here.
796 * Returns 0 if the packet was a data packet and was successfully passed on.
797 * Returns 1 if the packet was not a good data packet and could not be
798 * forwarded. All such packets are passed up to userspace to deal with.
800 static int l2tp_udp_recv_core(struct l2tp_tunnel *tunnel, struct sk_buff *skb)
802 struct l2tp_session *session = NULL;
803 unsigned char *ptr, *optr;
804 u16 hdrflags;
805 u32 tunnel_id, session_id;
806 u16 version;
807 int length;
809 /* UDP has verifed checksum */
811 /* UDP always verifies the packet length. */
812 __skb_pull(skb, sizeof(struct udphdr));
814 /* Short packet? */
815 if (!pskb_may_pull(skb, L2TP_HDR_SIZE_MAX)) {
816 l2tp_info(tunnel, L2TP_MSG_DATA,
817 "%s: recv short packet (len=%d)\n",
818 tunnel->name, skb->len);
819 goto error;
822 /* Trace packet contents, if enabled */
823 if (tunnel->debug & L2TP_MSG_DATA) {
824 length = min(32u, skb->len);
825 if (!pskb_may_pull(skb, length))
826 goto error;
828 pr_debug("%s: recv\n", tunnel->name);
829 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, skb->data, length);
832 /* Point to L2TP header */
833 optr = ptr = skb->data;
835 /* Get L2TP header flags */
836 hdrflags = ntohs(*(__be16 *) ptr);
838 /* Check protocol version */
839 version = hdrflags & L2TP_HDR_VER_MASK;
840 if (version != tunnel->version) {
841 l2tp_info(tunnel, L2TP_MSG_DATA,
842 "%s: recv protocol version mismatch: got %d expected %d\n",
843 tunnel->name, version, tunnel->version);
844 goto error;
847 /* Get length of L2TP packet */
848 length = skb->len;
850 /* If type is control packet, it is handled by userspace. */
851 if (hdrflags & L2TP_HDRFLAG_T) {
852 l2tp_dbg(tunnel, L2TP_MSG_DATA,
853 "%s: recv control packet, len=%d\n",
854 tunnel->name, length);
855 goto error;
858 /* Skip flags */
859 ptr += 2;
861 if (tunnel->version == L2TP_HDR_VER_2) {
862 /* If length is present, skip it */
863 if (hdrflags & L2TP_HDRFLAG_L)
864 ptr += 2;
866 /* Extract tunnel and session ID */
867 tunnel_id = ntohs(*(__be16 *) ptr);
868 ptr += 2;
869 session_id = ntohs(*(__be16 *) ptr);
870 ptr += 2;
871 } else {
872 ptr += 2; /* skip reserved bits */
873 tunnel_id = tunnel->tunnel_id;
874 session_id = ntohl(*(__be32 *) ptr);
875 ptr += 4;
878 /* Find the session context */
879 session = l2tp_tunnel_get_session(tunnel, session_id);
880 if (!session || !session->recv_skb) {
881 if (session)
882 l2tp_session_dec_refcount(session);
884 /* Not found? Pass to userspace to deal with */
885 l2tp_info(tunnel, L2TP_MSG_DATA,
886 "%s: no session found (%u/%u). Passing up.\n",
887 tunnel->name, tunnel_id, session_id);
888 goto error;
891 if (tunnel->version == L2TP_HDR_VER_3 &&
892 l2tp_v3_ensure_opt_in_linear(session, skb, &ptr, &optr))
893 goto error;
895 l2tp_recv_common(session, skb, ptr, optr, hdrflags, length);
896 l2tp_session_dec_refcount(session);
898 return 0;
900 error:
901 /* Put UDP header back */
902 __skb_push(skb, sizeof(struct udphdr));
904 return 1;
907 /* UDP encapsulation receive handler. See net/ipv4/udp.c.
908 * Return codes:
909 * 0 : success.
910 * <0: error
911 * >0: skb should be passed up to userspace as UDP.
913 int l2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb)
915 struct l2tp_tunnel *tunnel;
917 tunnel = rcu_dereference_sk_user_data(sk);
918 if (tunnel == NULL)
919 goto pass_up;
921 l2tp_dbg(tunnel, L2TP_MSG_DATA, "%s: received %d bytes\n",
922 tunnel->name, skb->len);
924 if (l2tp_udp_recv_core(tunnel, skb))
925 goto pass_up;
927 return 0;
929 pass_up:
930 return 1;
932 EXPORT_SYMBOL_GPL(l2tp_udp_encap_recv);
934 /************************************************************************
935 * Transmit handling
936 ***********************************************************************/
938 /* Build an L2TP header for the session into the buffer provided.
940 static int l2tp_build_l2tpv2_header(struct l2tp_session *session, void *buf)
942 struct l2tp_tunnel *tunnel = session->tunnel;
943 __be16 *bufp = buf;
944 __be16 *optr = buf;
945 u16 flags = L2TP_HDR_VER_2;
946 u32 tunnel_id = tunnel->peer_tunnel_id;
947 u32 session_id = session->peer_session_id;
949 if (session->send_seq)
950 flags |= L2TP_HDRFLAG_S;
952 /* Setup L2TP header. */
953 *bufp++ = htons(flags);
954 *bufp++ = htons(tunnel_id);
955 *bufp++ = htons(session_id);
956 if (session->send_seq) {
957 *bufp++ = htons(session->ns);
958 *bufp++ = 0;
959 session->ns++;
960 session->ns &= 0xffff;
961 l2tp_dbg(session, L2TP_MSG_SEQ, "%s: updated ns to %u\n",
962 session->name, session->ns);
965 return bufp - optr;
968 static int l2tp_build_l2tpv3_header(struct l2tp_session *session, void *buf)
970 struct l2tp_tunnel *tunnel = session->tunnel;
971 char *bufp = buf;
972 char *optr = bufp;
974 /* Setup L2TP header. The header differs slightly for UDP and
975 * IP encapsulations. For UDP, there is 4 bytes of flags.
977 if (tunnel->encap == L2TP_ENCAPTYPE_UDP) {
978 u16 flags = L2TP_HDR_VER_3;
979 *((__be16 *) bufp) = htons(flags);
980 bufp += 2;
981 *((__be16 *) bufp) = 0;
982 bufp += 2;
985 *((__be32 *) bufp) = htonl(session->peer_session_id);
986 bufp += 4;
987 if (session->cookie_len) {
988 memcpy(bufp, &session->cookie[0], session->cookie_len);
989 bufp += session->cookie_len;
991 if (session->l2specific_type == L2TP_L2SPECTYPE_DEFAULT) {
992 u32 l2h = 0;
994 if (session->send_seq) {
995 l2h = 0x40000000 | session->ns;
996 session->ns++;
997 session->ns &= 0xffffff;
998 l2tp_dbg(session, L2TP_MSG_SEQ,
999 "%s: updated ns to %u\n",
1000 session->name, session->ns);
1003 *((__be32 *)bufp) = htonl(l2h);
1004 bufp += 4;
1007 return bufp - optr;
1010 static void l2tp_xmit_core(struct l2tp_session *session, struct sk_buff *skb,
1011 struct flowi *fl, size_t data_len)
1013 struct l2tp_tunnel *tunnel = session->tunnel;
1014 unsigned int len = skb->len;
1015 int error;
1017 /* Debug */
1018 if (session->send_seq)
1019 l2tp_dbg(session, L2TP_MSG_DATA, "%s: send %zd bytes, ns=%u\n",
1020 session->name, data_len, session->ns - 1);
1021 else
1022 l2tp_dbg(session, L2TP_MSG_DATA, "%s: send %zd bytes\n",
1023 session->name, data_len);
1025 if (session->debug & L2TP_MSG_DATA) {
1026 int uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
1027 unsigned char *datap = skb->data + uhlen;
1029 pr_debug("%s: xmit\n", session->name);
1030 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET,
1031 datap, min_t(size_t, 32, len - uhlen));
1034 /* Queue the packet to IP for output */
1035 skb->ignore_df = 1;
1036 #if IS_ENABLED(CONFIG_IPV6)
1037 if (l2tp_sk_is_v6(tunnel->sock))
1038 error = inet6_csk_xmit(tunnel->sock, skb, NULL);
1039 else
1040 #endif
1041 error = ip_queue_xmit(tunnel->sock, skb, fl);
1043 /* Update stats */
1044 if (error >= 0) {
1045 atomic_long_inc(&tunnel->stats.tx_packets);
1046 atomic_long_add(len, &tunnel->stats.tx_bytes);
1047 atomic_long_inc(&session->stats.tx_packets);
1048 atomic_long_add(len, &session->stats.tx_bytes);
1049 } else {
1050 atomic_long_inc(&tunnel->stats.tx_errors);
1051 atomic_long_inc(&session->stats.tx_errors);
1055 /* If caller requires the skb to have a ppp header, the header must be
1056 * inserted in the skb data before calling this function.
1058 int l2tp_xmit_skb(struct l2tp_session *session, struct sk_buff *skb, int hdr_len)
1060 int data_len = skb->len;
1061 struct l2tp_tunnel *tunnel = session->tunnel;
1062 struct sock *sk = tunnel->sock;
1063 struct flowi *fl;
1064 struct udphdr *uh;
1065 struct inet_sock *inet;
1066 int headroom;
1067 int uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
1068 int udp_len;
1069 int ret = NET_XMIT_SUCCESS;
1071 /* Check that there's enough headroom in the skb to insert IP,
1072 * UDP and L2TP headers. If not enough, expand it to
1073 * make room. Adjust truesize.
1075 headroom = NET_SKB_PAD + sizeof(struct iphdr) +
1076 uhlen + hdr_len;
1077 if (skb_cow_head(skb, headroom)) {
1078 kfree_skb(skb);
1079 return NET_XMIT_DROP;
1082 /* Setup L2TP header */
1083 session->build_header(session, __skb_push(skb, hdr_len));
1085 /* Reset skb netfilter state */
1086 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
1087 IPCB(skb)->flags &= ~(IPSKB_XFRM_TUNNEL_SIZE | IPSKB_XFRM_TRANSFORMED |
1088 IPSKB_REROUTED);
1089 nf_reset(skb);
1091 bh_lock_sock(sk);
1092 if (sock_owned_by_user(sk)) {
1093 kfree_skb(skb);
1094 ret = NET_XMIT_DROP;
1095 goto out_unlock;
1098 /* The user-space may change the connection status for the user-space
1099 * provided socket at run time: we must check it under the socket lock
1101 if (tunnel->fd >= 0 && sk->sk_state != TCP_ESTABLISHED) {
1102 kfree_skb(skb);
1103 ret = NET_XMIT_DROP;
1104 goto out_unlock;
1107 /* Get routing info from the tunnel socket */
1108 skb_dst_drop(skb);
1109 skb_dst_set(skb, sk_dst_check(sk, 0));
1111 inet = inet_sk(sk);
1112 fl = &inet->cork.fl;
1113 switch (tunnel->encap) {
1114 case L2TP_ENCAPTYPE_UDP:
1115 /* Setup UDP header */
1116 __skb_push(skb, sizeof(*uh));
1117 skb_reset_transport_header(skb);
1118 uh = udp_hdr(skb);
1119 uh->source = inet->inet_sport;
1120 uh->dest = inet->inet_dport;
1121 udp_len = uhlen + hdr_len + data_len;
1122 uh->len = htons(udp_len);
1124 /* Calculate UDP checksum if configured to do so */
1125 #if IS_ENABLED(CONFIG_IPV6)
1126 if (l2tp_sk_is_v6(sk))
1127 udp6_set_csum(udp_get_no_check6_tx(sk),
1128 skb, &inet6_sk(sk)->saddr,
1129 &sk->sk_v6_daddr, udp_len);
1130 else
1131 #endif
1132 udp_set_csum(sk->sk_no_check_tx, skb, inet->inet_saddr,
1133 inet->inet_daddr, udp_len);
1134 break;
1136 case L2TP_ENCAPTYPE_IP:
1137 break;
1140 l2tp_xmit_core(session, skb, fl, data_len);
1141 out_unlock:
1142 bh_unlock_sock(sk);
1144 return ret;
1146 EXPORT_SYMBOL_GPL(l2tp_xmit_skb);
1148 /*****************************************************************************
1149 * Tinnel and session create/destroy.
1150 *****************************************************************************/
1152 /* Tunnel socket destruct hook.
1153 * The tunnel context is deleted only when all session sockets have been
1154 * closed.
1156 static void l2tp_tunnel_destruct(struct sock *sk)
1158 struct l2tp_tunnel *tunnel = l2tp_tunnel(sk);
1160 if (tunnel == NULL)
1161 goto end;
1163 l2tp_info(tunnel, L2TP_MSG_CONTROL, "%s: closing...\n", tunnel->name);
1165 /* Disable udp encapsulation */
1166 switch (tunnel->encap) {
1167 case L2TP_ENCAPTYPE_UDP:
1168 /* No longer an encapsulation socket. See net/ipv4/udp.c */
1169 (udp_sk(sk))->encap_type = 0;
1170 (udp_sk(sk))->encap_rcv = NULL;
1171 (udp_sk(sk))->encap_destroy = NULL;
1172 break;
1173 case L2TP_ENCAPTYPE_IP:
1174 break;
1177 /* Remove hooks into tunnel socket */
1178 sk->sk_destruct = tunnel->old_sk_destruct;
1179 sk->sk_user_data = NULL;
1181 /* Call the original destructor */
1182 if (sk->sk_destruct)
1183 (*sk->sk_destruct)(sk);
1185 kfree_rcu(tunnel, rcu);
1186 end:
1187 return;
1190 /* When the tunnel is closed, all the attached sessions need to go too.
1192 static void l2tp_tunnel_closeall(struct l2tp_tunnel *tunnel)
1194 int hash;
1195 struct hlist_node *walk;
1196 struct hlist_node *tmp;
1197 struct l2tp_session *session;
1199 BUG_ON(tunnel == NULL);
1201 l2tp_info(tunnel, L2TP_MSG_CONTROL, "%s: closing all sessions...\n",
1202 tunnel->name);
1204 write_lock_bh(&tunnel->hlist_lock);
1205 tunnel->acpt_newsess = false;
1206 for (hash = 0; hash < L2TP_HASH_SIZE; hash++) {
1207 again:
1208 hlist_for_each_safe(walk, tmp, &tunnel->session_hlist[hash]) {
1209 session = hlist_entry(walk, struct l2tp_session, hlist);
1211 l2tp_info(session, L2TP_MSG_CONTROL,
1212 "%s: closing session\n", session->name);
1214 hlist_del_init(&session->hlist);
1216 if (test_and_set_bit(0, &session->dead))
1217 goto again;
1219 write_unlock_bh(&tunnel->hlist_lock);
1221 __l2tp_session_unhash(session);
1222 l2tp_session_queue_purge(session);
1224 if (session->session_close != NULL)
1225 (*session->session_close)(session);
1227 l2tp_session_dec_refcount(session);
1229 write_lock_bh(&tunnel->hlist_lock);
1231 /* Now restart from the beginning of this hash
1232 * chain. We always remove a session from the
1233 * list so we are guaranteed to make forward
1234 * progress.
1236 goto again;
1239 write_unlock_bh(&tunnel->hlist_lock);
1242 /* Tunnel socket destroy hook for UDP encapsulation */
1243 static void l2tp_udp_encap_destroy(struct sock *sk)
1245 struct l2tp_tunnel *tunnel = l2tp_tunnel(sk);
1247 if (tunnel)
1248 l2tp_tunnel_delete(tunnel);
1251 /* Workqueue tunnel deletion function */
1252 static void l2tp_tunnel_del_work(struct work_struct *work)
1254 struct l2tp_tunnel *tunnel = container_of(work, struct l2tp_tunnel,
1255 del_work);
1256 struct sock *sk = tunnel->sock;
1257 struct socket *sock = sk->sk_socket;
1258 struct l2tp_net *pn;
1260 l2tp_tunnel_closeall(tunnel);
1262 /* If the tunnel socket was created within the kernel, use
1263 * the sk API to release it here.
1265 if (tunnel->fd < 0) {
1266 if (sock) {
1267 kernel_sock_shutdown(sock, SHUT_RDWR);
1268 sock_release(sock);
1272 /* Remove the tunnel struct from the tunnel list */
1273 pn = l2tp_pernet(tunnel->l2tp_net);
1274 spin_lock_bh(&pn->l2tp_tunnel_list_lock);
1275 list_del_rcu(&tunnel->list);
1276 spin_unlock_bh(&pn->l2tp_tunnel_list_lock);
1278 /* drop initial ref */
1279 l2tp_tunnel_dec_refcount(tunnel);
1281 /* drop workqueue ref */
1282 l2tp_tunnel_dec_refcount(tunnel);
1285 /* Create a socket for the tunnel, if one isn't set up by
1286 * userspace. This is used for static tunnels where there is no
1287 * managing L2TP daemon.
1289 * Since we don't want these sockets to keep a namespace alive by
1290 * themselves, we drop the socket's namespace refcount after creation.
1291 * These sockets are freed when the namespace exits using the pernet
1292 * exit hook.
1294 static int l2tp_tunnel_sock_create(struct net *net,
1295 u32 tunnel_id,
1296 u32 peer_tunnel_id,
1297 struct l2tp_tunnel_cfg *cfg,
1298 struct socket **sockp)
1300 int err = -EINVAL;
1301 struct socket *sock = NULL;
1302 struct udp_port_cfg udp_conf;
1304 switch (cfg->encap) {
1305 case L2TP_ENCAPTYPE_UDP:
1306 memset(&udp_conf, 0, sizeof(udp_conf));
1308 #if IS_ENABLED(CONFIG_IPV6)
1309 if (cfg->local_ip6 && cfg->peer_ip6) {
1310 udp_conf.family = AF_INET6;
1311 memcpy(&udp_conf.local_ip6, cfg->local_ip6,
1312 sizeof(udp_conf.local_ip6));
1313 memcpy(&udp_conf.peer_ip6, cfg->peer_ip6,
1314 sizeof(udp_conf.peer_ip6));
1315 udp_conf.use_udp6_tx_checksums =
1316 ! cfg->udp6_zero_tx_checksums;
1317 udp_conf.use_udp6_rx_checksums =
1318 ! cfg->udp6_zero_rx_checksums;
1319 } else
1320 #endif
1322 udp_conf.family = AF_INET;
1323 udp_conf.local_ip = cfg->local_ip;
1324 udp_conf.peer_ip = cfg->peer_ip;
1325 udp_conf.use_udp_checksums = cfg->use_udp_checksums;
1328 udp_conf.local_udp_port = htons(cfg->local_udp_port);
1329 udp_conf.peer_udp_port = htons(cfg->peer_udp_port);
1331 err = udp_sock_create(net, &udp_conf, &sock);
1332 if (err < 0)
1333 goto out;
1335 break;
1337 case L2TP_ENCAPTYPE_IP:
1338 #if IS_ENABLED(CONFIG_IPV6)
1339 if (cfg->local_ip6 && cfg->peer_ip6) {
1340 struct sockaddr_l2tpip6 ip6_addr = {0};
1342 err = sock_create_kern(net, AF_INET6, SOCK_DGRAM,
1343 IPPROTO_L2TP, &sock);
1344 if (err < 0)
1345 goto out;
1347 ip6_addr.l2tp_family = AF_INET6;
1348 memcpy(&ip6_addr.l2tp_addr, cfg->local_ip6,
1349 sizeof(ip6_addr.l2tp_addr));
1350 ip6_addr.l2tp_conn_id = tunnel_id;
1351 err = kernel_bind(sock, (struct sockaddr *) &ip6_addr,
1352 sizeof(ip6_addr));
1353 if (err < 0)
1354 goto out;
1356 ip6_addr.l2tp_family = AF_INET6;
1357 memcpy(&ip6_addr.l2tp_addr, cfg->peer_ip6,
1358 sizeof(ip6_addr.l2tp_addr));
1359 ip6_addr.l2tp_conn_id = peer_tunnel_id;
1360 err = kernel_connect(sock,
1361 (struct sockaddr *) &ip6_addr,
1362 sizeof(ip6_addr), 0);
1363 if (err < 0)
1364 goto out;
1365 } else
1366 #endif
1368 struct sockaddr_l2tpip ip_addr = {0};
1370 err = sock_create_kern(net, AF_INET, SOCK_DGRAM,
1371 IPPROTO_L2TP, &sock);
1372 if (err < 0)
1373 goto out;
1375 ip_addr.l2tp_family = AF_INET;
1376 ip_addr.l2tp_addr = cfg->local_ip;
1377 ip_addr.l2tp_conn_id = tunnel_id;
1378 err = kernel_bind(sock, (struct sockaddr *) &ip_addr,
1379 sizeof(ip_addr));
1380 if (err < 0)
1381 goto out;
1383 ip_addr.l2tp_family = AF_INET;
1384 ip_addr.l2tp_addr = cfg->peer_ip;
1385 ip_addr.l2tp_conn_id = peer_tunnel_id;
1386 err = kernel_connect(sock, (struct sockaddr *) &ip_addr,
1387 sizeof(ip_addr), 0);
1388 if (err < 0)
1389 goto out;
1391 break;
1393 default:
1394 goto out;
1397 out:
1398 *sockp = sock;
1399 if ((err < 0) && sock) {
1400 kernel_sock_shutdown(sock, SHUT_RDWR);
1401 sock_release(sock);
1402 *sockp = NULL;
1405 return err;
1408 static struct lock_class_key l2tp_socket_class;
1410 int l2tp_tunnel_create(struct net *net, int fd, int version, u32 tunnel_id, u32 peer_tunnel_id, struct l2tp_tunnel_cfg *cfg, struct l2tp_tunnel **tunnelp)
1412 struct l2tp_tunnel *tunnel = NULL;
1413 int err;
1414 enum l2tp_encap_type encap = L2TP_ENCAPTYPE_UDP;
1416 if (cfg != NULL)
1417 encap = cfg->encap;
1419 tunnel = kzalloc(sizeof(struct l2tp_tunnel), GFP_KERNEL);
1420 if (tunnel == NULL) {
1421 err = -ENOMEM;
1422 goto err;
1425 tunnel->version = version;
1426 tunnel->tunnel_id = tunnel_id;
1427 tunnel->peer_tunnel_id = peer_tunnel_id;
1428 tunnel->debug = L2TP_DEFAULT_DEBUG_FLAGS;
1430 tunnel->magic = L2TP_TUNNEL_MAGIC;
1431 sprintf(&tunnel->name[0], "tunl %u", tunnel_id);
1432 rwlock_init(&tunnel->hlist_lock);
1433 tunnel->acpt_newsess = true;
1435 if (cfg != NULL)
1436 tunnel->debug = cfg->debug;
1438 tunnel->encap = encap;
1440 refcount_set(&tunnel->ref_count, 1);
1441 tunnel->fd = fd;
1443 /* Init delete workqueue struct */
1444 INIT_WORK(&tunnel->del_work, l2tp_tunnel_del_work);
1446 INIT_LIST_HEAD(&tunnel->list);
1448 err = 0;
1449 err:
1450 if (tunnelp)
1451 *tunnelp = tunnel;
1453 return err;
1455 EXPORT_SYMBOL_GPL(l2tp_tunnel_create);
1457 static int l2tp_validate_socket(const struct sock *sk, const struct net *net,
1458 enum l2tp_encap_type encap)
1460 if (!net_eq(sock_net(sk), net))
1461 return -EINVAL;
1463 if (sk->sk_type != SOCK_DGRAM)
1464 return -EPROTONOSUPPORT;
1466 if (sk->sk_family != PF_INET && sk->sk_family != PF_INET6)
1467 return -EPROTONOSUPPORT;
1469 if ((encap == L2TP_ENCAPTYPE_UDP && sk->sk_protocol != IPPROTO_UDP) ||
1470 (encap == L2TP_ENCAPTYPE_IP && sk->sk_protocol != IPPROTO_L2TP))
1471 return -EPROTONOSUPPORT;
1473 if (sk->sk_user_data)
1474 return -EBUSY;
1476 return 0;
1479 int l2tp_tunnel_register(struct l2tp_tunnel *tunnel, struct net *net,
1480 struct l2tp_tunnel_cfg *cfg)
1482 struct l2tp_tunnel *tunnel_walk;
1483 struct l2tp_net *pn;
1484 struct socket *sock;
1485 struct sock *sk;
1486 int ret;
1488 if (tunnel->fd < 0) {
1489 ret = l2tp_tunnel_sock_create(net, tunnel->tunnel_id,
1490 tunnel->peer_tunnel_id, cfg,
1491 &sock);
1492 if (ret < 0)
1493 goto err;
1494 } else {
1495 sock = sockfd_lookup(tunnel->fd, &ret);
1496 if (!sock)
1497 goto err;
1499 ret = l2tp_validate_socket(sock->sk, net, tunnel->encap);
1500 if (ret < 0)
1501 goto err_sock;
1504 tunnel->l2tp_net = net;
1505 pn = l2tp_pernet(net);
1507 spin_lock_bh(&pn->l2tp_tunnel_list_lock);
1508 list_for_each_entry(tunnel_walk, &pn->l2tp_tunnel_list, list) {
1509 if (tunnel_walk->tunnel_id == tunnel->tunnel_id) {
1510 spin_unlock_bh(&pn->l2tp_tunnel_list_lock);
1512 ret = -EEXIST;
1513 goto err_sock;
1516 list_add_rcu(&tunnel->list, &pn->l2tp_tunnel_list);
1517 spin_unlock_bh(&pn->l2tp_tunnel_list_lock);
1519 sk = sock->sk;
1520 sock_hold(sk);
1521 tunnel->sock = sk;
1523 if (tunnel->encap == L2TP_ENCAPTYPE_UDP) {
1524 struct udp_tunnel_sock_cfg udp_cfg = {
1525 .sk_user_data = tunnel,
1526 .encap_type = UDP_ENCAP_L2TPINUDP,
1527 .encap_rcv = l2tp_udp_encap_recv,
1528 .encap_destroy = l2tp_udp_encap_destroy,
1531 setup_udp_tunnel_sock(net, sock, &udp_cfg);
1532 } else {
1533 sk->sk_user_data = tunnel;
1536 tunnel->old_sk_destruct = sk->sk_destruct;
1537 sk->sk_destruct = &l2tp_tunnel_destruct;
1538 lockdep_set_class_and_name(&sk->sk_lock.slock, &l2tp_socket_class,
1539 "l2tp_sock");
1540 sk->sk_allocation = GFP_ATOMIC;
1542 if (tunnel->fd >= 0)
1543 sockfd_put(sock);
1545 return 0;
1547 err_sock:
1548 if (tunnel->fd < 0)
1549 sock_release(sock);
1550 else
1551 sockfd_put(sock);
1552 err:
1553 return ret;
1555 EXPORT_SYMBOL_GPL(l2tp_tunnel_register);
1557 /* This function is used by the netlink TUNNEL_DELETE command.
1559 void l2tp_tunnel_delete(struct l2tp_tunnel *tunnel)
1561 if (!test_and_set_bit(0, &tunnel->dead)) {
1562 l2tp_tunnel_inc_refcount(tunnel);
1563 queue_work(l2tp_wq, &tunnel->del_work);
1566 EXPORT_SYMBOL_GPL(l2tp_tunnel_delete);
1568 /* Really kill the session.
1570 void l2tp_session_free(struct l2tp_session *session)
1572 struct l2tp_tunnel *tunnel = session->tunnel;
1574 BUG_ON(refcount_read(&session->ref_count) != 0);
1576 if (tunnel) {
1577 BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
1578 l2tp_tunnel_dec_refcount(tunnel);
1581 kfree(session);
1583 EXPORT_SYMBOL_GPL(l2tp_session_free);
1585 /* Remove an l2tp session from l2tp_core's hash lists.
1586 * Provides a tidyup interface for pseudowire code which can't just route all
1587 * shutdown via. l2tp_session_delete and a pseudowire-specific session_close
1588 * callback.
1590 void __l2tp_session_unhash(struct l2tp_session *session)
1592 struct l2tp_tunnel *tunnel = session->tunnel;
1594 /* Remove the session from core hashes */
1595 if (tunnel) {
1596 /* Remove from the per-tunnel hash */
1597 write_lock_bh(&tunnel->hlist_lock);
1598 hlist_del_init(&session->hlist);
1599 write_unlock_bh(&tunnel->hlist_lock);
1601 /* For L2TPv3 we have a per-net hash: remove from there, too */
1602 if (tunnel->version != L2TP_HDR_VER_2) {
1603 struct l2tp_net *pn = l2tp_pernet(tunnel->l2tp_net);
1604 spin_lock_bh(&pn->l2tp_session_hlist_lock);
1605 hlist_del_init_rcu(&session->global_hlist);
1606 spin_unlock_bh(&pn->l2tp_session_hlist_lock);
1607 synchronize_rcu();
1611 EXPORT_SYMBOL_GPL(__l2tp_session_unhash);
1613 /* This function is used by the netlink SESSION_DELETE command and by
1614 pseudowire modules.
1616 int l2tp_session_delete(struct l2tp_session *session)
1618 if (test_and_set_bit(0, &session->dead))
1619 return 0;
1621 __l2tp_session_unhash(session);
1622 l2tp_session_queue_purge(session);
1623 if (session->session_close != NULL)
1624 (*session->session_close)(session);
1626 l2tp_session_dec_refcount(session);
1628 return 0;
1630 EXPORT_SYMBOL_GPL(l2tp_session_delete);
1632 /* We come here whenever a session's send_seq, cookie_len or
1633 * l2specific_type parameters are set.
1635 void l2tp_session_set_header_len(struct l2tp_session *session, int version)
1637 if (version == L2TP_HDR_VER_2) {
1638 session->hdr_len = 6;
1639 if (session->send_seq)
1640 session->hdr_len += 4;
1641 } else {
1642 session->hdr_len = 4 + session->cookie_len;
1643 session->hdr_len += l2tp_get_l2specific_len(session);
1644 if (session->tunnel->encap == L2TP_ENCAPTYPE_UDP)
1645 session->hdr_len += 4;
1649 EXPORT_SYMBOL_GPL(l2tp_session_set_header_len);
1651 struct l2tp_session *l2tp_session_create(int priv_size, struct l2tp_tunnel *tunnel, u32 session_id, u32 peer_session_id, struct l2tp_session_cfg *cfg)
1653 struct l2tp_session *session;
1655 session = kzalloc(sizeof(struct l2tp_session) + priv_size, GFP_KERNEL);
1656 if (session != NULL) {
1657 session->magic = L2TP_SESSION_MAGIC;
1658 session->tunnel = tunnel;
1660 session->session_id = session_id;
1661 session->peer_session_id = peer_session_id;
1662 session->nr = 0;
1663 if (tunnel->version == L2TP_HDR_VER_2)
1664 session->nr_max = 0xffff;
1665 else
1666 session->nr_max = 0xffffff;
1667 session->nr_window_size = session->nr_max / 2;
1668 session->nr_oos_count_max = 4;
1670 /* Use NR of first received packet */
1671 session->reorder_skip = 1;
1673 sprintf(&session->name[0], "sess %u/%u",
1674 tunnel->tunnel_id, session->session_id);
1676 skb_queue_head_init(&session->reorder_q);
1678 INIT_HLIST_NODE(&session->hlist);
1679 INIT_HLIST_NODE(&session->global_hlist);
1681 /* Inherit debug options from tunnel */
1682 session->debug = tunnel->debug;
1684 if (cfg) {
1685 session->pwtype = cfg->pw_type;
1686 session->debug = cfg->debug;
1687 session->send_seq = cfg->send_seq;
1688 session->recv_seq = cfg->recv_seq;
1689 session->lns_mode = cfg->lns_mode;
1690 session->reorder_timeout = cfg->reorder_timeout;
1691 session->l2specific_type = cfg->l2specific_type;
1692 session->cookie_len = cfg->cookie_len;
1693 memcpy(&session->cookie[0], &cfg->cookie[0], cfg->cookie_len);
1694 session->peer_cookie_len = cfg->peer_cookie_len;
1695 memcpy(&session->peer_cookie[0], &cfg->peer_cookie[0], cfg->peer_cookie_len);
1698 if (tunnel->version == L2TP_HDR_VER_2)
1699 session->build_header = l2tp_build_l2tpv2_header;
1700 else
1701 session->build_header = l2tp_build_l2tpv3_header;
1703 l2tp_session_set_header_len(session, tunnel->version);
1705 refcount_set(&session->ref_count, 1);
1707 return session;
1710 return ERR_PTR(-ENOMEM);
1712 EXPORT_SYMBOL_GPL(l2tp_session_create);
1714 /*****************************************************************************
1715 * Init and cleanup
1716 *****************************************************************************/
1718 static __net_init int l2tp_init_net(struct net *net)
1720 struct l2tp_net *pn = net_generic(net, l2tp_net_id);
1721 int hash;
1723 INIT_LIST_HEAD(&pn->l2tp_tunnel_list);
1724 spin_lock_init(&pn->l2tp_tunnel_list_lock);
1726 for (hash = 0; hash < L2TP_HASH_SIZE_2; hash++)
1727 INIT_HLIST_HEAD(&pn->l2tp_session_hlist[hash]);
1729 spin_lock_init(&pn->l2tp_session_hlist_lock);
1731 return 0;
1734 static __net_exit void l2tp_exit_net(struct net *net)
1736 struct l2tp_net *pn = l2tp_pernet(net);
1737 struct l2tp_tunnel *tunnel = NULL;
1738 int hash;
1740 rcu_read_lock_bh();
1741 list_for_each_entry_rcu(tunnel, &pn->l2tp_tunnel_list, list) {
1742 l2tp_tunnel_delete(tunnel);
1744 rcu_read_unlock_bh();
1746 if (l2tp_wq)
1747 flush_workqueue(l2tp_wq);
1748 rcu_barrier();
1750 for (hash = 0; hash < L2TP_HASH_SIZE_2; hash++)
1751 WARN_ON_ONCE(!hlist_empty(&pn->l2tp_session_hlist[hash]));
1754 static struct pernet_operations l2tp_net_ops = {
1755 .init = l2tp_init_net,
1756 .exit = l2tp_exit_net,
1757 .id = &l2tp_net_id,
1758 .size = sizeof(struct l2tp_net),
1761 static int __init l2tp_init(void)
1763 int rc = 0;
1765 rc = register_pernet_device(&l2tp_net_ops);
1766 if (rc)
1767 goto out;
1769 l2tp_wq = alloc_workqueue("l2tp", WQ_UNBOUND, 0);
1770 if (!l2tp_wq) {
1771 pr_err("alloc_workqueue failed\n");
1772 unregister_pernet_device(&l2tp_net_ops);
1773 rc = -ENOMEM;
1774 goto out;
1777 pr_info("L2TP core driver, %s\n", L2TP_DRV_VERSION);
1779 out:
1780 return rc;
1783 static void __exit l2tp_exit(void)
1785 unregister_pernet_device(&l2tp_net_ops);
1786 if (l2tp_wq) {
1787 destroy_workqueue(l2tp_wq);
1788 l2tp_wq = NULL;
1792 module_init(l2tp_init);
1793 module_exit(l2tp_exit);
1795 MODULE_AUTHOR("James Chapman <jchapman@katalix.com>");
1796 MODULE_DESCRIPTION("L2TP core");
1797 MODULE_LICENSE("GPL");
1798 MODULE_VERSION(L2TP_DRV_VERSION);