1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*****************************************************************************
3 * Linux PPP over L2TP (PPPoX/PPPoL2TP) Sockets
5 * PPPoX --- Generic PPP encapsulation socket family
6 * PPPoL2TP --- PPP over L2TP (RFC 2661)
10 * Authors: James Chapman (jchapman@katalix.com)
12 * Based on original work by Martijn van Oosterhout <kleptog@svana.org>
17 /* This driver handles only L2TP data frames; control frames are handled by a
18 * userspace application.
20 * To send data in an L2TP session, userspace opens a PPPoL2TP socket and
21 * attaches it to a bound UDP socket with local tunnel_id / session_id and
22 * peer tunnel_id / session_id set. Data can then be sent or received using
23 * regular socket sendmsg() / recvmsg() calls. Kernel parameters of the socket
24 * can be read or modified using ioctl() or [gs]etsockopt() calls.
26 * When a PPPoL2TP socket is connected with local and peer session_id values
27 * zero, the socket is treated as a special tunnel management socket.
29 * Here's example userspace code to create a socket for sending/receiving data
30 * over an L2TP session:-
32 * struct sockaddr_pppol2tp sax;
36 * fd = socket(AF_PPPOX, SOCK_DGRAM, PX_PROTO_OL2TP);
38 * sax.sa_family = AF_PPPOX;
39 * sax.sa_protocol = PX_PROTO_OL2TP;
40 * sax.pppol2tp.fd = tunnel_fd; // bound UDP socket
41 * sax.pppol2tp.addr.sin_addr.s_addr = addr->sin_addr.s_addr;
42 * sax.pppol2tp.addr.sin_port = addr->sin_port;
43 * sax.pppol2tp.addr.sin_family = AF_INET;
44 * sax.pppol2tp.s_tunnel = tunnel_id;
45 * sax.pppol2tp.s_session = session_id;
46 * sax.pppol2tp.d_tunnel = peer_tunnel_id;
47 * sax.pppol2tp.d_session = peer_session_id;
49 * session_fd = connect(fd, (struct sockaddr *)&sax, sizeof(sax));
51 * A pppd plugin that allows PPP traffic to be carried over L2TP using
52 * this driver is available from the OpenL2TP project at
53 * http://openl2tp.sourceforge.net.
56 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
58 #include <linux/module.h>
59 #include <linux/string.h>
60 #include <linux/list.h>
61 #include <linux/uaccess.h>
63 #include <linux/kernel.h>
64 #include <linux/spinlock.h>
65 #include <linux/kthread.h>
66 #include <linux/sched.h>
67 #include <linux/slab.h>
68 #include <linux/errno.h>
69 #include <linux/jiffies.h>
71 #include <linux/netdevice.h>
72 #include <linux/net.h>
73 #include <linux/inetdevice.h>
74 #include <linux/skbuff.h>
75 #include <linux/init.h>
77 #include <linux/udp.h>
78 #include <linux/if_pppox.h>
79 #include <linux/if_pppol2tp.h>
81 #include <linux/ppp_channel.h>
82 #include <linux/ppp_defs.h>
83 #include <linux/ppp-ioctl.h>
84 #include <linux/file.h>
85 #include <linux/hash.h>
86 #include <linux/sort.h>
87 #include <linux/proc_fs.h>
88 #include <linux/l2tp.h>
89 #include <linux/nsproxy.h>
90 #include <net/net_namespace.h>
91 #include <net/netns/generic.h>
94 #include <net/inet_common.h>
96 #include <asm/byteorder.h>
97 #include <linux/atomic.h>
99 #include "l2tp_core.h"
101 #define PPPOL2TP_DRV_VERSION "V2.0"
103 /* Space for UDP, L2TP and PPP headers */
104 #define PPPOL2TP_HEADER_OVERHEAD 40
106 /* Number of bytes to build transmit L2TP headers.
107 * Unfortunately the size is different depending on whether sequence numbers
110 #define PPPOL2TP_L2TP_HDR_SIZE_SEQ 10
111 #define PPPOL2TP_L2TP_HDR_SIZE_NOSEQ 6
113 /* Private data of each session. This data lives at the end of struct
114 * l2tp_session, referenced via session->priv[].
116 struct pppol2tp_session {
117 int owner; /* pid that opened the socket */
119 struct mutex sk_lock; /* Protects .sk */
120 struct sock __rcu *sk; /* Pointer to the session PPPoX socket */
121 struct sock *__sk; /* Copy of .sk, for cleanup */
122 struct rcu_head rcu; /* For asynchronous release */
125 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb);
127 static const struct ppp_channel_ops pppol2tp_chan_ops = {
128 .start_xmit = pppol2tp_xmit,
131 static const struct proto_ops pppol2tp_ops;
133 /* Retrieves the pppol2tp socket associated to a session.
134 * A reference is held on the returned socket, so this function must be paired
137 static struct sock *pppol2tp_session_get_sock(struct l2tp_session *session)
139 struct pppol2tp_session *ps = l2tp_session_priv(session);
143 sk = rcu_dereference(ps->sk);
151 /* Helpers to obtain tunnel/session contexts from sockets.
153 static inline struct l2tp_session *pppol2tp_sock_to_session(struct sock *sk)
155 struct l2tp_session *session;
161 session = (struct l2tp_session *)(sk->sk_user_data);
166 if (WARN_ON(session->magic != L2TP_SESSION_MAGIC)) {
176 /*****************************************************************************
177 * Receive data handling
178 *****************************************************************************/
180 /* Receive message. This is the recvmsg for the PPPoL2TP socket.
182 static int pppol2tp_recvmsg(struct socket *sock, struct msghdr *msg,
183 size_t len, int flags)
187 struct sock *sk = sock->sk;
190 if (sk->sk_state & PPPOX_BOUND)
194 skb = skb_recv_datagram(sk, flags, &err);
200 else if (len < skb->len)
201 msg->msg_flags |= MSG_TRUNC;
203 err = skb_copy_datagram_msg(skb, 0, msg, len);
204 if (likely(err == 0))
212 static void pppol2tp_recv(struct l2tp_session *session, struct sk_buff *skb, int data_len)
214 struct pppol2tp_session *ps = l2tp_session_priv(session);
215 struct sock *sk = NULL;
217 /* If the socket is bound, send it in to PPP's input queue. Otherwise
218 * queue it on the session socket.
221 sk = rcu_dereference(ps->sk);
225 /* If the first two bytes are 0xFF03, consider that it is the PPP's
226 * Address and Control fields and skip them. The L2TP module has always
227 * worked this way, although, in theory, the use of these fields should
228 * be negotiated and handled at the PPP layer. These fields are
229 * constant: 0xFF is the All-Stations Address and 0x03 the Unnumbered
230 * Information command with Poll/Final bit set to zero (RFC 1662).
232 if (pskb_may_pull(skb, 2) && skb->data[0] == PPP_ALLSTATIONS &&
233 skb->data[1] == PPP_UI)
236 if (sk->sk_state & PPPOX_BOUND) {
237 struct pppox_sock *po;
240 ppp_input(&po->chan, skb);
242 if (sock_queue_rcv_skb(sk, skb) < 0) {
243 atomic_long_inc(&session->stats.rx_errors);
253 pr_warn_ratelimited("%s: no socket in recv\n", session->name);
257 /************************************************************************
259 ***********************************************************************/
261 /* This is the sendmsg for the PPPoL2TP pppol2tp_session socket. We come here
262 * when a user application does a sendmsg() on the session socket. L2TP and
263 * PPP headers must be inserted into the user's data.
265 static int pppol2tp_sendmsg(struct socket *sock, struct msghdr *m,
268 struct sock *sk = sock->sk;
271 struct l2tp_session *session;
272 struct l2tp_tunnel *tunnel;
276 if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
279 /* Get session and tunnel contexts */
281 session = pppol2tp_sock_to_session(sk);
285 tunnel = session->tunnel;
287 uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
289 /* Allocate a socket buffer */
291 skb = sock_wmalloc(sk, NET_SKB_PAD + sizeof(struct iphdr) +
292 uhlen + session->hdr_len +
293 2 + total_len, /* 2 bytes for PPP_ALLSTATIONS & PPP_UI */
298 /* Reserve space for headers. */
299 skb_reserve(skb, NET_SKB_PAD);
300 skb_reset_network_header(skb);
301 skb_reserve(skb, sizeof(struct iphdr));
302 skb_reset_transport_header(skb);
303 skb_reserve(skb, uhlen);
306 skb->data[0] = PPP_ALLSTATIONS;
307 skb->data[1] = PPP_UI;
310 /* Copy user data into skb */
311 error = memcpy_from_msg(skb_put(skb, total_len), m, total_len);
318 l2tp_xmit_skb(session, skb);
331 /* Transmit function called by generic PPP driver. Sends PPP frame
332 * over PPPoL2TP socket.
334 * This is almost the same as pppol2tp_sendmsg(), but rather than
335 * being called with a msghdr from userspace, it is called with a skb
338 * The supplied skb from ppp doesn't have enough headroom for the
339 * insertion of L2TP, UDP and IP headers so we need to allocate more
340 * headroom in the skb. This will create a cloned skb. But we must be
341 * careful in the error case because the caller will expect to free
342 * the skb it supplied, not our cloned skb. So we take care to always
343 * leave the original skb unfreed if we return an error.
345 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb)
347 struct sock *sk = (struct sock *)chan->private;
348 struct l2tp_session *session;
349 struct l2tp_tunnel *tunnel;
352 if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
355 /* Get session and tunnel contexts from the socket */
356 session = pppol2tp_sock_to_session(sk);
360 tunnel = session->tunnel;
362 uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
363 headroom = NET_SKB_PAD +
364 sizeof(struct iphdr) + /* IP header */
365 uhlen + /* UDP header (if L2TP_ENCAPTYPE_UDP) */
366 session->hdr_len + /* L2TP header */
367 2; /* 2 bytes for PPP_ALLSTATIONS & PPP_UI */
368 if (skb_cow_head(skb, headroom))
371 /* Setup PPP header */
373 skb->data[0] = PPP_ALLSTATIONS;
374 skb->data[1] = PPP_UI;
377 l2tp_xmit_skb(session, skb);
387 /* Free the original skb */
392 /*****************************************************************************
393 * Session (and tunnel control) socket create/destroy.
394 *****************************************************************************/
396 static void pppol2tp_put_sk(struct rcu_head *head)
398 struct pppol2tp_session *ps;
400 ps = container_of(head, typeof(*ps), rcu);
404 /* Really kill the session socket. (Called from sock_put() if
407 static void pppol2tp_session_destruct(struct sock *sk)
409 struct l2tp_session *session = sk->sk_user_data;
411 skb_queue_purge(&sk->sk_receive_queue);
412 skb_queue_purge(&sk->sk_write_queue);
415 sk->sk_user_data = NULL;
416 if (WARN_ON(session->magic != L2TP_SESSION_MAGIC))
418 l2tp_session_dec_refcount(session);
422 /* Called when the PPPoX socket (session) is closed.
424 static int pppol2tp_release(struct socket *sock)
426 struct sock *sk = sock->sk;
427 struct l2tp_session *session;
435 if (sock_flag(sk, SOCK_DEAD) != 0)
438 pppox_unbind_sock(sk);
440 /* Signal the death of the socket. */
441 sk->sk_state = PPPOX_DEAD;
445 session = pppol2tp_sock_to_session(sk);
447 struct pppol2tp_session *ps;
449 l2tp_session_delete(session);
451 ps = l2tp_session_priv(session);
452 mutex_lock(&ps->sk_lock);
453 ps->__sk = rcu_dereference_protected(ps->sk,
454 lockdep_is_held(&ps->sk_lock));
455 RCU_INIT_POINTER(ps->sk, NULL);
456 mutex_unlock(&ps->sk_lock);
457 call_rcu(&ps->rcu, pppol2tp_put_sk);
459 /* Rely on the sock_put() call at the end of the function for
460 * dropping the reference held by pppol2tp_sock_to_session().
461 * The last reference will be dropped by pppol2tp_put_sk().
467 /* This will delete the session context via
468 * pppol2tp_session_destruct() if the socket's refcnt drops to
480 static struct proto pppol2tp_sk_proto = {
482 .owner = THIS_MODULE,
483 .obj_size = sizeof(struct pppox_sock),
486 static int pppol2tp_backlog_recv(struct sock *sk, struct sk_buff *skb)
490 rc = l2tp_udp_encap_recv(sk, skb);
494 return NET_RX_SUCCESS;
497 /* socket() handler. Initialize a new struct sock.
499 static int pppol2tp_create(struct net *net, struct socket *sock, int kern)
504 sk = sk_alloc(net, PF_PPPOX, GFP_KERNEL, &pppol2tp_sk_proto, kern);
508 sock_init_data(sock, sk);
510 sock->state = SS_UNCONNECTED;
511 sock->ops = &pppol2tp_ops;
513 sk->sk_backlog_rcv = pppol2tp_backlog_recv;
514 sk->sk_protocol = PX_PROTO_OL2TP;
515 sk->sk_family = PF_PPPOX;
516 sk->sk_state = PPPOX_NONE;
517 sk->sk_type = SOCK_STREAM;
518 sk->sk_destruct = pppol2tp_session_destruct;
526 static void pppol2tp_show(struct seq_file *m, void *arg)
528 struct l2tp_session *session = arg;
531 sk = pppol2tp_session_get_sock(session);
533 struct pppox_sock *po = pppox_sk(sk);
535 seq_printf(m, " interface %s\n", ppp_dev_name(&po->chan));
540 static void pppol2tp_session_init(struct l2tp_session *session)
542 struct pppol2tp_session *ps;
544 session->recv_skb = pppol2tp_recv;
545 if (IS_ENABLED(CONFIG_L2TP_DEBUGFS))
546 session->show = pppol2tp_show;
548 ps = l2tp_session_priv(session);
549 mutex_init(&ps->sk_lock);
550 ps->owner = current->pid;
553 struct l2tp_connect_info {
562 static int pppol2tp_sockaddr_get_info(const void *sa, int sa_len,
563 struct l2tp_connect_info *info)
566 case sizeof(struct sockaddr_pppol2tp):
568 const struct sockaddr_pppol2tp *sa_v2in4 = sa;
570 if (sa_v2in4->sa_protocol != PX_PROTO_OL2TP)
574 info->fd = sa_v2in4->pppol2tp.fd;
575 info->tunnel_id = sa_v2in4->pppol2tp.s_tunnel;
576 info->peer_tunnel_id = sa_v2in4->pppol2tp.d_tunnel;
577 info->session_id = sa_v2in4->pppol2tp.s_session;
578 info->peer_session_id = sa_v2in4->pppol2tp.d_session;
582 case sizeof(struct sockaddr_pppol2tpv3):
584 const struct sockaddr_pppol2tpv3 *sa_v3in4 = sa;
586 if (sa_v3in4->sa_protocol != PX_PROTO_OL2TP)
590 info->fd = sa_v3in4->pppol2tp.fd;
591 info->tunnel_id = sa_v3in4->pppol2tp.s_tunnel;
592 info->peer_tunnel_id = sa_v3in4->pppol2tp.d_tunnel;
593 info->session_id = sa_v3in4->pppol2tp.s_session;
594 info->peer_session_id = sa_v3in4->pppol2tp.d_session;
598 case sizeof(struct sockaddr_pppol2tpin6):
600 const struct sockaddr_pppol2tpin6 *sa_v2in6 = sa;
602 if (sa_v2in6->sa_protocol != PX_PROTO_OL2TP)
606 info->fd = sa_v2in6->pppol2tp.fd;
607 info->tunnel_id = sa_v2in6->pppol2tp.s_tunnel;
608 info->peer_tunnel_id = sa_v2in6->pppol2tp.d_tunnel;
609 info->session_id = sa_v2in6->pppol2tp.s_session;
610 info->peer_session_id = sa_v2in6->pppol2tp.d_session;
614 case sizeof(struct sockaddr_pppol2tpv3in6):
616 const struct sockaddr_pppol2tpv3in6 *sa_v3in6 = sa;
618 if (sa_v3in6->sa_protocol != PX_PROTO_OL2TP)
622 info->fd = sa_v3in6->pppol2tp.fd;
623 info->tunnel_id = sa_v3in6->pppol2tp.s_tunnel;
624 info->peer_tunnel_id = sa_v3in6->pppol2tp.d_tunnel;
625 info->session_id = sa_v3in6->pppol2tp.s_session;
626 info->peer_session_id = sa_v3in6->pppol2tp.d_session;
637 /* Rough estimation of the maximum payload size a tunnel can transmit without
638 * fragmenting at the lower IP layer. Assumes L2TPv2 with sequence
639 * numbers and no IP option. Not quite accurate, but the result is mostly
642 static int pppol2tp_tunnel_mtu(const struct l2tp_tunnel *tunnel)
646 mtu = l2tp_tunnel_dst_mtu(tunnel);
647 if (mtu <= PPPOL2TP_HEADER_OVERHEAD)
648 return 1500 - PPPOL2TP_HEADER_OVERHEAD;
650 return mtu - PPPOL2TP_HEADER_OVERHEAD;
653 /* connect() handler. Attach a PPPoX socket to a tunnel UDP socket
655 static int pppol2tp_connect(struct socket *sock, struct sockaddr *uservaddr,
656 int sockaddr_len, int flags)
658 struct sock *sk = sock->sk;
659 struct pppox_sock *po = pppox_sk(sk);
660 struct l2tp_session *session = NULL;
661 struct l2tp_connect_info info;
662 struct l2tp_tunnel *tunnel;
663 struct pppol2tp_session *ps;
664 struct l2tp_session_cfg cfg = { 0, };
665 bool drop_refcnt = false;
666 bool drop_tunnel = false;
667 bool new_session = false;
668 bool new_tunnel = false;
671 error = pppol2tp_sockaddr_get_info(uservaddr, sockaddr_len, &info);
677 /* Check for already bound sockets */
679 if (sk->sk_state & PPPOX_CONNECTED)
682 /* We don't supporting rebinding anyway */
684 if (sk->sk_user_data)
685 goto end; /* socket is already attached */
687 /* Don't bind if tunnel_id is 0 */
692 tunnel = l2tp_tunnel_get(sock_net(sk), info.tunnel_id);
696 /* Special case: create tunnel context if session_id and
697 * peer_session_id is 0. Otherwise look up tunnel using supplied
700 if (!info.session_id && !info.peer_session_id) {
702 struct l2tp_tunnel_cfg tcfg = {
703 .encap = L2TP_ENCAPTYPE_UDP,
706 /* Prevent l2tp_tunnel_register() from trying to set up
714 error = l2tp_tunnel_create(info.fd,
717 info.peer_tunnel_id, &tcfg,
722 l2tp_tunnel_inc_refcount(tunnel);
723 error = l2tp_tunnel_register(tunnel, sock_net(sk),
733 /* Error if we can't find the tunnel */
738 /* Error if socket is not prepped */
743 if (tunnel->peer_tunnel_id == 0)
744 tunnel->peer_tunnel_id = info.peer_tunnel_id;
746 session = l2tp_tunnel_get_session(tunnel, info.session_id);
750 if (session->pwtype != L2TP_PWTYPE_PPP) {
755 ps = l2tp_session_priv(session);
757 /* Using a pre-existing session is fine as long as it hasn't
758 * been connected yet.
760 mutex_lock(&ps->sk_lock);
761 if (rcu_dereference_protected(ps->sk,
762 lockdep_is_held(&ps->sk_lock)) ||
764 mutex_unlock(&ps->sk_lock);
769 cfg.pw_type = L2TP_PWTYPE_PPP;
771 session = l2tp_session_create(sizeof(struct pppol2tp_session),
772 tunnel, info.session_id,
773 info.peer_session_id, &cfg);
774 if (IS_ERR(session)) {
775 error = PTR_ERR(session);
779 pppol2tp_session_init(session);
780 ps = l2tp_session_priv(session);
781 l2tp_session_inc_refcount(session);
783 mutex_lock(&ps->sk_lock);
784 error = l2tp_session_register(session, tunnel);
786 mutex_unlock(&ps->sk_lock);
794 /* Special case: if source & dest session_id == 0x0000, this
795 * socket is being created to manage the tunnel. Just set up
796 * the internal context for use by ioctl() and sockopt()
799 if (session->session_id == 0 && session->peer_session_id == 0) {
804 /* The only header we need to worry about is the L2TP
805 * header. This size is different depending on whether
806 * sequence numbers are enabled for the data channel.
808 po->chan.hdrlen = PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
810 po->chan.private = sk;
811 po->chan.ops = &pppol2tp_chan_ops;
812 po->chan.mtu = pppol2tp_tunnel_mtu(tunnel);
814 error = ppp_register_net_channel(sock_net(sk), &po->chan);
816 mutex_unlock(&ps->sk_lock);
821 /* This is how we get the session context from the socket. */
822 sk->sk_user_data = session;
823 rcu_assign_pointer(ps->sk, sk);
824 mutex_unlock(&ps->sk_lock);
826 /* Keep the reference we've grabbed on the session: sk doesn't expect
827 * the session to disappear. pppol2tp_session_destruct() is responsible
832 sk->sk_state = PPPOX_CONNECTED;
837 l2tp_session_delete(session);
839 l2tp_tunnel_delete(tunnel);
842 l2tp_session_dec_refcount(session);
844 l2tp_tunnel_dec_refcount(tunnel);
850 #ifdef CONFIG_L2TP_V3
852 /* Called when creating sessions via the netlink interface. */
853 static int pppol2tp_session_create(struct net *net, struct l2tp_tunnel *tunnel,
854 u32 session_id, u32 peer_session_id,
855 struct l2tp_session_cfg *cfg)
858 struct l2tp_session *session;
860 /* Error if tunnel socket is not prepped */
866 /* Allocate and initialize a new session context. */
867 session = l2tp_session_create(sizeof(struct pppol2tp_session),
869 peer_session_id, cfg);
870 if (IS_ERR(session)) {
871 error = PTR_ERR(session);
875 pppol2tp_session_init(session);
877 error = l2tp_session_register(session, tunnel);
889 #endif /* CONFIG_L2TP_V3 */
891 /* getname() support.
893 static int pppol2tp_getname(struct socket *sock, struct sockaddr *uaddr,
898 struct l2tp_session *session;
899 struct l2tp_tunnel *tunnel;
900 struct sock *sk = sock->sk;
901 struct inet_sock *inet;
902 struct pppol2tp_session *pls;
907 if (!(sk->sk_state & PPPOX_CONNECTED))
911 session = pppol2tp_sock_to_session(sk);
915 pls = l2tp_session_priv(session);
916 tunnel = session->tunnel;
918 inet = inet_sk(tunnel->sock);
919 if (tunnel->version == 2 && tunnel->sock->sk_family == AF_INET) {
920 struct sockaddr_pppol2tp sp;
924 sp.sa_family = AF_PPPOX;
925 sp.sa_protocol = PX_PROTO_OL2TP;
926 sp.pppol2tp.fd = tunnel->fd;
927 sp.pppol2tp.pid = pls->owner;
928 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
929 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
930 sp.pppol2tp.s_session = session->session_id;
931 sp.pppol2tp.d_session = session->peer_session_id;
932 sp.pppol2tp.addr.sin_family = AF_INET;
933 sp.pppol2tp.addr.sin_port = inet->inet_dport;
934 sp.pppol2tp.addr.sin_addr.s_addr = inet->inet_daddr;
935 memcpy(uaddr, &sp, len);
936 #if IS_ENABLED(CONFIG_IPV6)
937 } else if (tunnel->version == 2 && tunnel->sock->sk_family == AF_INET6) {
938 struct sockaddr_pppol2tpin6 sp;
942 sp.sa_family = AF_PPPOX;
943 sp.sa_protocol = PX_PROTO_OL2TP;
944 sp.pppol2tp.fd = tunnel->fd;
945 sp.pppol2tp.pid = pls->owner;
946 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
947 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
948 sp.pppol2tp.s_session = session->session_id;
949 sp.pppol2tp.d_session = session->peer_session_id;
950 sp.pppol2tp.addr.sin6_family = AF_INET6;
951 sp.pppol2tp.addr.sin6_port = inet->inet_dport;
952 memcpy(&sp.pppol2tp.addr.sin6_addr, &tunnel->sock->sk_v6_daddr,
953 sizeof(tunnel->sock->sk_v6_daddr));
954 memcpy(uaddr, &sp, len);
955 } else if (tunnel->version == 3 && tunnel->sock->sk_family == AF_INET6) {
956 struct sockaddr_pppol2tpv3in6 sp;
960 sp.sa_family = AF_PPPOX;
961 sp.sa_protocol = PX_PROTO_OL2TP;
962 sp.pppol2tp.fd = tunnel->fd;
963 sp.pppol2tp.pid = pls->owner;
964 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
965 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
966 sp.pppol2tp.s_session = session->session_id;
967 sp.pppol2tp.d_session = session->peer_session_id;
968 sp.pppol2tp.addr.sin6_family = AF_INET6;
969 sp.pppol2tp.addr.sin6_port = inet->inet_dport;
970 memcpy(&sp.pppol2tp.addr.sin6_addr, &tunnel->sock->sk_v6_daddr,
971 sizeof(tunnel->sock->sk_v6_daddr));
972 memcpy(uaddr, &sp, len);
974 } else if (tunnel->version == 3) {
975 struct sockaddr_pppol2tpv3 sp;
979 sp.sa_family = AF_PPPOX;
980 sp.sa_protocol = PX_PROTO_OL2TP;
981 sp.pppol2tp.fd = tunnel->fd;
982 sp.pppol2tp.pid = pls->owner;
983 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
984 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
985 sp.pppol2tp.s_session = session->session_id;
986 sp.pppol2tp.d_session = session->peer_session_id;
987 sp.pppol2tp.addr.sin_family = AF_INET;
988 sp.pppol2tp.addr.sin_port = inet->inet_dport;
989 sp.pppol2tp.addr.sin_addr.s_addr = inet->inet_daddr;
990 memcpy(uaddr, &sp, len);
1000 /****************************************************************************
1003 * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1004 * sockets. However, in order to control kernel tunnel features, we allow
1005 * userspace to create a special "tunnel" PPPoX socket which is used for
1006 * control only. Tunnel PPPoX sockets have session_id == 0 and simply allow
1007 * the user application to issue L2TP setsockopt(), getsockopt() and ioctl()
1009 ****************************************************************************/
1011 static void pppol2tp_copy_stats(struct pppol2tp_ioc_stats *dest,
1012 const struct l2tp_stats *stats)
1014 memset(dest, 0, sizeof(*dest));
1016 dest->tx_packets = atomic_long_read(&stats->tx_packets);
1017 dest->tx_bytes = atomic_long_read(&stats->tx_bytes);
1018 dest->tx_errors = atomic_long_read(&stats->tx_errors);
1019 dest->rx_packets = atomic_long_read(&stats->rx_packets);
1020 dest->rx_bytes = atomic_long_read(&stats->rx_bytes);
1021 dest->rx_seq_discards = atomic_long_read(&stats->rx_seq_discards);
1022 dest->rx_oos_packets = atomic_long_read(&stats->rx_oos_packets);
1023 dest->rx_errors = atomic_long_read(&stats->rx_errors);
1026 static int pppol2tp_tunnel_copy_stats(struct pppol2tp_ioc_stats *stats,
1027 struct l2tp_tunnel *tunnel)
1029 struct l2tp_session *session;
1031 if (!stats->session_id) {
1032 pppol2tp_copy_stats(stats, &tunnel->stats);
1036 /* If session_id is set, search the corresponding session in the
1037 * context of this tunnel and record the session's statistics.
1039 session = l2tp_tunnel_get_session(tunnel, stats->session_id);
1043 if (session->pwtype != L2TP_PWTYPE_PPP) {
1044 l2tp_session_dec_refcount(session);
1048 pppol2tp_copy_stats(stats, &session->stats);
1049 l2tp_session_dec_refcount(session);
1054 static int pppol2tp_ioctl(struct socket *sock, unsigned int cmd,
1057 struct pppol2tp_ioc_stats stats;
1058 struct l2tp_session *session;
1063 session = sock->sk->sk_user_data;
1067 if (WARN_ON(session->magic != L2TP_SESSION_MAGIC))
1070 /* Not defined for tunnels */
1071 if (!session->session_id && !session->peer_session_id)
1074 if (put_user(0, (int __user *)arg))
1080 session = sock->sk->sk_user_data;
1084 if (WARN_ON(session->magic != L2TP_SESSION_MAGIC))
1087 /* Not defined for tunnels */
1088 if (!session->session_id && !session->peer_session_id)
1091 if (!access_ok((int __user *)arg, sizeof(int)))
1095 case PPPIOCGL2TPSTATS:
1096 session = sock->sk->sk_user_data;
1100 if (WARN_ON(session->magic != L2TP_SESSION_MAGIC))
1103 /* Session 0 represents the parent tunnel */
1104 if (!session->session_id && !session->peer_session_id) {
1108 if (copy_from_user(&stats, (void __user *)arg,
1112 session_id = stats.session_id;
1113 err = pppol2tp_tunnel_copy_stats(&stats,
1118 stats.session_id = session_id;
1120 pppol2tp_copy_stats(&stats, &session->stats);
1121 stats.session_id = session->session_id;
1123 stats.tunnel_id = session->tunnel->tunnel_id;
1124 stats.using_ipsec = l2tp_tunnel_uses_xfrm(session->tunnel);
1126 if (copy_to_user((void __user *)arg, &stats, sizeof(stats)))
1131 return -ENOIOCTLCMD;
1137 /*****************************************************************************
1138 * setsockopt() / getsockopt() support.
1140 * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1141 * sockets. In order to control kernel tunnel features, we allow userspace to
1142 * create a special "tunnel" PPPoX socket which is used for control only.
1143 * Tunnel PPPoX sockets have session_id == 0 and simply allow the user
1144 * application to issue L2TP setsockopt(), getsockopt() and ioctl() calls.
1145 *****************************************************************************/
1147 /* Tunnel setsockopt() helper.
1149 static int pppol2tp_tunnel_setsockopt(struct sock *sk,
1150 struct l2tp_tunnel *tunnel,
1151 int optname, int val)
1156 case PPPOL2TP_SO_DEBUG:
1157 /* Tunnel debug flags option is deprecated */
1168 /* Session setsockopt helper.
1170 static int pppol2tp_session_setsockopt(struct sock *sk,
1171 struct l2tp_session *session,
1172 int optname, int val)
1177 case PPPOL2TP_SO_RECVSEQ:
1178 if (val != 0 && val != 1) {
1182 session->recv_seq = !!val;
1185 case PPPOL2TP_SO_SENDSEQ:
1186 if (val != 0 && val != 1) {
1190 session->send_seq = !!val;
1192 struct pppox_sock *po = pppox_sk(sk);
1194 po->chan.hdrlen = val ? PPPOL2TP_L2TP_HDR_SIZE_SEQ :
1195 PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
1197 l2tp_session_set_header_len(session, session->tunnel->version);
1200 case PPPOL2TP_SO_LNSMODE:
1201 if (val != 0 && val != 1) {
1205 session->lns_mode = !!val;
1208 case PPPOL2TP_SO_DEBUG:
1209 /* Session debug flags option is deprecated */
1212 case PPPOL2TP_SO_REORDERTO:
1213 session->reorder_timeout = msecs_to_jiffies(val);
1224 /* Main setsockopt() entry point.
1225 * Does API checks, then calls either the tunnel or session setsockopt
1226 * handler, according to whether the PPPoL2TP socket is a for a regular
1227 * session or the special tunnel type.
1229 static int pppol2tp_setsockopt(struct socket *sock, int level, int optname,
1230 sockptr_t optval, unsigned int optlen)
1232 struct sock *sk = sock->sk;
1233 struct l2tp_session *session;
1234 struct l2tp_tunnel *tunnel;
1238 if (level != SOL_PPPOL2TP)
1241 if (optlen < sizeof(int))
1244 if (copy_from_sockptr(&val, optval, sizeof(int)))
1248 if (!sk->sk_user_data)
1251 /* Get session context from the socket */
1253 session = pppol2tp_sock_to_session(sk);
1257 /* Special case: if session_id == 0x0000, treat as operation on tunnel
1259 if (session->session_id == 0 && session->peer_session_id == 0) {
1260 tunnel = session->tunnel;
1261 err = pppol2tp_tunnel_setsockopt(sk, tunnel, optname, val);
1263 err = pppol2tp_session_setsockopt(sk, session, optname, val);
1271 /* Tunnel getsockopt helper. Called with sock locked.
1273 static int pppol2tp_tunnel_getsockopt(struct sock *sk,
1274 struct l2tp_tunnel *tunnel,
1275 int optname, int *val)
1280 case PPPOL2TP_SO_DEBUG:
1281 /* Tunnel debug flags option is deprecated */
1293 /* Session getsockopt helper. Called with sock locked.
1295 static int pppol2tp_session_getsockopt(struct sock *sk,
1296 struct l2tp_session *session,
1297 int optname, int *val)
1302 case PPPOL2TP_SO_RECVSEQ:
1303 *val = session->recv_seq;
1306 case PPPOL2TP_SO_SENDSEQ:
1307 *val = session->send_seq;
1310 case PPPOL2TP_SO_LNSMODE:
1311 *val = session->lns_mode;
1314 case PPPOL2TP_SO_DEBUG:
1315 /* Session debug flags option is deprecated */
1319 case PPPOL2TP_SO_REORDERTO:
1320 *val = (int)jiffies_to_msecs(session->reorder_timeout);
1330 /* Main getsockopt() entry point.
1331 * Does API checks, then calls either the tunnel or session getsockopt
1332 * handler, according to whether the PPPoX socket is a for a regular session
1333 * or the special tunnel type.
1335 static int pppol2tp_getsockopt(struct socket *sock, int level, int optname,
1336 char __user *optval, int __user *optlen)
1338 struct sock *sk = sock->sk;
1339 struct l2tp_session *session;
1340 struct l2tp_tunnel *tunnel;
1344 if (level != SOL_PPPOL2TP)
1347 if (get_user(len, optlen))
1350 len = min_t(unsigned int, len, sizeof(int));
1356 if (!sk->sk_user_data)
1359 /* Get the session context */
1361 session = pppol2tp_sock_to_session(sk);
1365 /* Special case: if session_id == 0x0000, treat as operation on tunnel */
1366 if (session->session_id == 0 && session->peer_session_id == 0) {
1367 tunnel = session->tunnel;
1368 err = pppol2tp_tunnel_getsockopt(sk, tunnel, optname, &val);
1372 err = pppol2tp_session_getsockopt(sk, session, optname, &val);
1378 if (put_user(len, optlen))
1381 if (copy_to_user((void __user *)optval, &val, len))
1392 /*****************************************************************************
1393 * /proc filesystem for debug
1394 * Since the original pppol2tp driver provided /proc/net/pppol2tp for
1395 * L2TPv2, we dump only L2TPv2 tunnels and sessions here.
1396 *****************************************************************************/
1398 static unsigned int pppol2tp_net_id;
1400 #ifdef CONFIG_PROC_FS
1402 struct pppol2tp_seq_data {
1403 struct seq_net_private p;
1404 int tunnel_idx; /* current tunnel */
1405 int session_idx; /* index of session within current tunnel */
1406 struct l2tp_tunnel *tunnel;
1407 struct l2tp_session *session; /* NULL means get next tunnel */
1410 static void pppol2tp_next_tunnel(struct net *net, struct pppol2tp_seq_data *pd)
1412 /* Drop reference taken during previous invocation */
1414 l2tp_tunnel_dec_refcount(pd->tunnel);
1417 pd->tunnel = l2tp_tunnel_get_nth(net, pd->tunnel_idx);
1420 /* Only accept L2TPv2 tunnels */
1421 if (!pd->tunnel || pd->tunnel->version == 2)
1424 l2tp_tunnel_dec_refcount(pd->tunnel);
1428 static void pppol2tp_next_session(struct net *net, struct pppol2tp_seq_data *pd)
1430 /* Drop reference taken during previous invocation */
1432 l2tp_session_dec_refcount(pd->session);
1434 pd->session = l2tp_session_get_nth(pd->tunnel, pd->session_idx);
1438 pd->session_idx = 0;
1439 pppol2tp_next_tunnel(net, pd);
1443 static void *pppol2tp_seq_start(struct seq_file *m, loff_t *offs)
1445 struct pppol2tp_seq_data *pd = SEQ_START_TOKEN;
1452 if (WARN_ON(!m->private)) {
1458 net = seq_file_net(m);
1461 pppol2tp_next_tunnel(net, pd);
1463 pppol2tp_next_session(net, pd);
1465 /* NULL tunnel and session indicates end of list */
1466 if (!pd->tunnel && !pd->session)
1473 static void *pppol2tp_seq_next(struct seq_file *m, void *v, loff_t *pos)
1479 static void pppol2tp_seq_stop(struct seq_file *p, void *v)
1481 struct pppol2tp_seq_data *pd = v;
1483 if (!pd || pd == SEQ_START_TOKEN)
1486 /* Drop reference taken by last invocation of pppol2tp_next_session()
1487 * or pppol2tp_next_tunnel().
1490 l2tp_session_dec_refcount(pd->session);
1494 l2tp_tunnel_dec_refcount(pd->tunnel);
1499 static void pppol2tp_seq_tunnel_show(struct seq_file *m, void *v)
1501 struct l2tp_tunnel *tunnel = v;
1503 seq_printf(m, "\nTUNNEL '%s', %c %d\n",
1505 (tunnel == tunnel->sock->sk_user_data) ? 'Y' : 'N',
1506 refcount_read(&tunnel->ref_count) - 1);
1507 seq_printf(m, " %08x %ld/%ld/%ld %ld/%ld/%ld\n",
1509 atomic_long_read(&tunnel->stats.tx_packets),
1510 atomic_long_read(&tunnel->stats.tx_bytes),
1511 atomic_long_read(&tunnel->stats.tx_errors),
1512 atomic_long_read(&tunnel->stats.rx_packets),
1513 atomic_long_read(&tunnel->stats.rx_bytes),
1514 atomic_long_read(&tunnel->stats.rx_errors));
1517 static void pppol2tp_seq_session_show(struct seq_file *m, void *v)
1519 struct l2tp_session *session = v;
1520 struct l2tp_tunnel *tunnel = session->tunnel;
1521 unsigned char state;
1528 struct inet_sock *inet = inet_sk(tunnel->sock);
1530 ip = ntohl(inet->inet_saddr);
1531 port = ntohs(inet->inet_sport);
1534 sk = pppol2tp_session_get_sock(session);
1536 state = sk->sk_state;
1537 user_data_ok = (session == sk->sk_user_data) ? 'Y' : 'N';
1543 seq_printf(m, " SESSION '%s' %08X/%d %04X/%04X -> %04X/%04X %d %c\n",
1544 session->name, ip, port,
1546 session->session_id,
1547 tunnel->peer_tunnel_id,
1548 session->peer_session_id,
1549 state, user_data_ok);
1550 seq_printf(m, " 0/0/%c/%c/%s %08x %u\n",
1551 session->recv_seq ? 'R' : '-',
1552 session->send_seq ? 'S' : '-',
1553 session->lns_mode ? "LNS" : "LAC",
1555 jiffies_to_msecs(session->reorder_timeout));
1556 seq_printf(m, " %u/%u %ld/%ld/%ld %ld/%ld/%ld\n",
1557 session->nr, session->ns,
1558 atomic_long_read(&session->stats.tx_packets),
1559 atomic_long_read(&session->stats.tx_bytes),
1560 atomic_long_read(&session->stats.tx_errors),
1561 atomic_long_read(&session->stats.rx_packets),
1562 atomic_long_read(&session->stats.rx_bytes),
1563 atomic_long_read(&session->stats.rx_errors));
1566 struct pppox_sock *po = pppox_sk(sk);
1568 seq_printf(m, " interface %s\n", ppp_dev_name(&po->chan));
1573 static int pppol2tp_seq_show(struct seq_file *m, void *v)
1575 struct pppol2tp_seq_data *pd = v;
1577 /* display header on line 1 */
1578 if (v == SEQ_START_TOKEN) {
1579 seq_puts(m, "PPPoL2TP driver info, " PPPOL2TP_DRV_VERSION "\n");
1580 seq_puts(m, "TUNNEL name, user-data-ok session-count\n");
1581 seq_puts(m, " debug tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
1582 seq_puts(m, " SESSION name, addr/port src-tid/sid dest-tid/sid state user-data-ok\n");
1583 seq_puts(m, " mtu/mru/rcvseq/sendseq/lns debug reorderto\n");
1584 seq_puts(m, " nr/ns tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
1589 pppol2tp_seq_tunnel_show(m, pd->tunnel);
1591 pppol2tp_seq_session_show(m, pd->session);
1597 static const struct seq_operations pppol2tp_seq_ops = {
1598 .start = pppol2tp_seq_start,
1599 .next = pppol2tp_seq_next,
1600 .stop = pppol2tp_seq_stop,
1601 .show = pppol2tp_seq_show,
1603 #endif /* CONFIG_PROC_FS */
1605 /*****************************************************************************
1607 *****************************************************************************/
1609 static __net_init int pppol2tp_init_net(struct net *net)
1611 struct proc_dir_entry *pde;
1614 pde = proc_create_net("pppol2tp", 0444, net->proc_net,
1615 &pppol2tp_seq_ops, sizeof(struct pppol2tp_seq_data));
1625 static __net_exit void pppol2tp_exit_net(struct net *net)
1627 remove_proc_entry("pppol2tp", net->proc_net);
1630 static struct pernet_operations pppol2tp_net_ops = {
1631 .init = pppol2tp_init_net,
1632 .exit = pppol2tp_exit_net,
1633 .id = &pppol2tp_net_id,
1636 /*****************************************************************************
1638 *****************************************************************************/
1640 static const struct proto_ops pppol2tp_ops = {
1642 .owner = THIS_MODULE,
1643 .release = pppol2tp_release,
1644 .bind = sock_no_bind,
1645 .connect = pppol2tp_connect,
1646 .socketpair = sock_no_socketpair,
1647 .accept = sock_no_accept,
1648 .getname = pppol2tp_getname,
1649 .poll = datagram_poll,
1650 .listen = sock_no_listen,
1651 .shutdown = sock_no_shutdown,
1652 .setsockopt = pppol2tp_setsockopt,
1653 .getsockopt = pppol2tp_getsockopt,
1654 .sendmsg = pppol2tp_sendmsg,
1655 .recvmsg = pppol2tp_recvmsg,
1656 .mmap = sock_no_mmap,
1657 .ioctl = pppox_ioctl,
1658 #ifdef CONFIG_COMPAT
1659 .compat_ioctl = pppox_compat_ioctl,
1663 static const struct pppox_proto pppol2tp_proto = {
1664 .create = pppol2tp_create,
1665 .ioctl = pppol2tp_ioctl,
1666 .owner = THIS_MODULE,
1669 #ifdef CONFIG_L2TP_V3
1671 static const struct l2tp_nl_cmd_ops pppol2tp_nl_cmd_ops = {
1672 .session_create = pppol2tp_session_create,
1673 .session_delete = l2tp_session_delete,
1676 #endif /* CONFIG_L2TP_V3 */
1678 static int __init pppol2tp_init(void)
1682 err = register_pernet_device(&pppol2tp_net_ops);
1686 err = proto_register(&pppol2tp_sk_proto, 0);
1688 goto out_unregister_pppol2tp_pernet;
1690 err = register_pppox_proto(PX_PROTO_OL2TP, &pppol2tp_proto);
1692 goto out_unregister_pppol2tp_proto;
1694 #ifdef CONFIG_L2TP_V3
1695 err = l2tp_nl_register_ops(L2TP_PWTYPE_PPP, &pppol2tp_nl_cmd_ops);
1697 goto out_unregister_pppox;
1700 pr_info("PPPoL2TP kernel driver, %s\n", PPPOL2TP_DRV_VERSION);
1705 #ifdef CONFIG_L2TP_V3
1706 out_unregister_pppox:
1707 unregister_pppox_proto(PX_PROTO_OL2TP);
1709 out_unregister_pppol2tp_proto:
1710 proto_unregister(&pppol2tp_sk_proto);
1711 out_unregister_pppol2tp_pernet:
1712 unregister_pernet_device(&pppol2tp_net_ops);
1716 static void __exit pppol2tp_exit(void)
1718 #ifdef CONFIG_L2TP_V3
1719 l2tp_nl_unregister_ops(L2TP_PWTYPE_PPP);
1721 unregister_pppox_proto(PX_PROTO_OL2TP);
1722 proto_unregister(&pppol2tp_sk_proto);
1723 unregister_pernet_device(&pppol2tp_net_ops);
1726 module_init(pppol2tp_init);
1727 module_exit(pppol2tp_exit);
1729 MODULE_AUTHOR("James Chapman <jchapman@katalix.com>");
1730 MODULE_DESCRIPTION("PPP over L2TP over UDP");
1731 MODULE_LICENSE("GPL");
1732 MODULE_VERSION(PPPOL2TP_DRV_VERSION);
1733 MODULE_ALIAS_NET_PF_PROTO(PF_PPPOX, PX_PROTO_OL2TP);
1734 MODULE_ALIAS_L2TP_PWTYPE(7);