2 * L2TPv3 IP encapsulation support
4 * Copyright (c) 2008,2009,2010 Katalix Systems Ltd
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14 #include <asm/ioctls.h>
15 #include <linux/icmp.h>
16 #include <linux/module.h>
17 #include <linux/skbuff.h>
18 #include <linux/random.h>
19 #include <linux/socket.h>
20 #include <linux/l2tp.h>
26 #include <net/inet_common.h>
27 #include <net/inet_hashtables.h>
28 #include <net/tcp_states.h>
29 #include <net/protocol.h>
32 #include "l2tp_core.h"
35 /* inet_sock has to be the first member of l2tp_ip_sock */
36 struct inet_sock inet;
42 static DEFINE_RWLOCK(l2tp_ip_lock);
43 static struct hlist_head l2tp_ip_table;
44 static struct hlist_head l2tp_ip_bind_table;
46 static inline struct l2tp_ip_sock *l2tp_ip_sk(const struct sock *sk)
48 return (struct l2tp_ip_sock *)sk;
51 static struct sock *__l2tp_ip_bind_lookup(struct net *net, __be32 laddr, int dif, u32 tunnel_id)
55 sk_for_each_bound(sk, &l2tp_ip_bind_table) {
56 struct inet_sock *inet = inet_sk(sk);
57 struct l2tp_ip_sock *l2tp = l2tp_ip_sk(sk);
62 if ((l2tp->conn_id == tunnel_id) &&
63 net_eq(sock_net(sk), net) &&
64 !(inet->inet_rcv_saddr && inet->inet_rcv_saddr != laddr) &&
65 !(sk->sk_bound_dev_if && sk->sk_bound_dev_if != dif))
74 static inline struct sock *l2tp_ip_bind_lookup(struct net *net, __be32 laddr, int dif, u32 tunnel_id)
76 struct sock *sk = __l2tp_ip_bind_lookup(net, laddr, dif, tunnel_id);
83 /* When processing receive frames, there are two cases to
84 * consider. Data frames consist of a non-zero session-id and an
85 * optional cookie. Control frames consist of a regular L2TP header
86 * preceded by 32-bits of zeros.
88 * L2TPv3 Session Header Over IP
91 * 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
92 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
94 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
95 * | Cookie (optional, maximum 64 bits)...
96 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
98 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
100 * L2TPv3 Control Message Header Over IP
103 * 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
104 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
105 * | (32 bits of zeros) |
106 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
107 * |T|L|x|x|S|x|x|x|x|x|x|x| Ver | Length |
108 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
109 * | Control Connection ID |
110 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
112 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
114 * All control frames are passed to userspace.
116 static int l2tp_ip_recv(struct sk_buff *skb)
118 struct net *net = dev_net(skb->dev);
122 unsigned char *ptr, *optr;
123 struct l2tp_session *session;
124 struct l2tp_tunnel *tunnel = NULL;
127 if (!pskb_may_pull(skb, 4))
130 /* Point to L2TP header */
131 optr = ptr = skb->data;
132 session_id = ntohl(*((__be32 *) ptr));
135 /* RFC3931: L2TP/IP packets have the first 4 bytes containing
136 * the session_id. If it is 0, the packet is a L2TP control
137 * frame and the session_id value can be discarded.
139 if (session_id == 0) {
144 /* Ok, this is a data packet. Lookup the session. */
145 session = l2tp_session_find(net, NULL, session_id);
149 tunnel = session->tunnel;
153 /* Trace packet contents, if enabled */
154 if (tunnel->debug & L2TP_MSG_DATA) {
155 length = min(32u, skb->len);
156 if (!pskb_may_pull(skb, length))
159 /* Point to L2TP header */
160 optr = ptr = skb->data;
162 pr_debug("%s: ip recv\n", tunnel->name);
163 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, ptr, length);
166 l2tp_recv_common(session, skb, ptr, optr, 0, skb->len, tunnel->recv_payload_hook);
171 /* Get the tunnel_id from the L2TP header */
172 if (!pskb_may_pull(skb, 12))
175 if ((skb->data[0] & 0xc0) != 0xc0)
178 tunnel_id = ntohl(*(__be32 *) &skb->data[4]);
179 tunnel = l2tp_tunnel_find(net, tunnel_id);
183 struct iphdr *iph = (struct iphdr *) skb_network_header(skb);
185 read_lock_bh(&l2tp_ip_lock);
186 sk = __l2tp_ip_bind_lookup(net, iph->daddr, 0, tunnel_id);
187 read_unlock_bh(&l2tp_ip_lock);
195 if (!xfrm4_policy_check(sk, XFRM_POLICY_IN, skb))
200 return sk_receive_skb(sk, skb, 1);
210 static int l2tp_ip_open(struct sock *sk)
212 /* Prevent autobind. We don't have ports. */
213 inet_sk(sk)->inet_num = IPPROTO_L2TP;
215 write_lock_bh(&l2tp_ip_lock);
216 sk_add_node(sk, &l2tp_ip_table);
217 write_unlock_bh(&l2tp_ip_lock);
222 static void l2tp_ip_close(struct sock *sk, long timeout)
224 write_lock_bh(&l2tp_ip_lock);
225 hlist_del_init(&sk->sk_bind_node);
226 sk_del_node_init(sk);
227 write_unlock_bh(&l2tp_ip_lock);
228 sk_common_release(sk);
231 static void l2tp_ip_destroy_sock(struct sock *sk)
234 struct l2tp_tunnel *tunnel = l2tp_sock_to_tunnel(sk);
236 while ((skb = __skb_dequeue_tail(&sk->sk_write_queue)) != NULL)
240 l2tp_tunnel_closeall(tunnel);
244 sk_refcnt_debug_dec(sk);
247 static int l2tp_ip_bind(struct sock *sk, struct sockaddr *uaddr, int addr_len)
249 struct inet_sock *inet = inet_sk(sk);
250 struct sockaddr_l2tpip *addr = (struct sockaddr_l2tpip *) uaddr;
251 struct net *net = sock_net(sk);
255 if (addr_len < sizeof(struct sockaddr_l2tpip))
257 if (addr->l2tp_family != AF_INET)
261 read_lock_bh(&l2tp_ip_lock);
262 if (__l2tp_ip_bind_lookup(net, addr->l2tp_addr.s_addr,
263 sk->sk_bound_dev_if, addr->l2tp_conn_id))
266 read_unlock_bh(&l2tp_ip_lock);
269 if (!sock_flag(sk, SOCK_ZAPPED))
272 if (sk->sk_state != TCP_CLOSE || addr_len < sizeof(struct sockaddr_l2tpip))
275 chk_addr_ret = inet_addr_type(net, addr->l2tp_addr.s_addr);
276 ret = -EADDRNOTAVAIL;
277 if (addr->l2tp_addr.s_addr && chk_addr_ret != RTN_LOCAL &&
278 chk_addr_ret != RTN_MULTICAST && chk_addr_ret != RTN_BROADCAST)
281 if (addr->l2tp_addr.s_addr)
282 inet->inet_rcv_saddr = inet->inet_saddr = addr->l2tp_addr.s_addr;
283 if (chk_addr_ret == RTN_MULTICAST || chk_addr_ret == RTN_BROADCAST)
284 inet->inet_saddr = 0; /* Use device */
287 l2tp_ip_sk(sk)->conn_id = addr->l2tp_conn_id;
289 write_lock_bh(&l2tp_ip_lock);
290 sk_add_bind_node(sk, &l2tp_ip_bind_table);
291 sk_del_node_init(sk);
292 write_unlock_bh(&l2tp_ip_lock);
294 sock_reset_flag(sk, SOCK_ZAPPED);
302 read_unlock_bh(&l2tp_ip_lock);
307 static int l2tp_ip_connect(struct sock *sk, struct sockaddr *uaddr, int addr_len)
309 struct sockaddr_l2tpip *lsa = (struct sockaddr_l2tpip *) uaddr;
312 if (sock_flag(sk, SOCK_ZAPPED)) /* Must bind first - autobinding does not work */
315 if (addr_len < sizeof(*lsa))
318 if (ipv4_is_multicast(lsa->l2tp_addr.s_addr))
321 rc = ip4_datagram_connect(sk, uaddr, addr_len);
327 l2tp_ip_sk(sk)->peer_conn_id = lsa->l2tp_conn_id;
329 write_lock_bh(&l2tp_ip_lock);
330 hlist_del_init(&sk->sk_bind_node);
331 sk_add_bind_node(sk, &l2tp_ip_bind_table);
332 write_unlock_bh(&l2tp_ip_lock);
338 static int l2tp_ip_disconnect(struct sock *sk, int flags)
340 if (sock_flag(sk, SOCK_ZAPPED))
343 return udp_disconnect(sk, flags);
346 static int l2tp_ip_getname(struct socket *sock, struct sockaddr *uaddr,
347 int *uaddr_len, int peer)
349 struct sock *sk = sock->sk;
350 struct inet_sock *inet = inet_sk(sk);
351 struct l2tp_ip_sock *lsk = l2tp_ip_sk(sk);
352 struct sockaddr_l2tpip *lsa = (struct sockaddr_l2tpip *)uaddr;
354 memset(lsa, 0, sizeof(*lsa));
355 lsa->l2tp_family = AF_INET;
357 if (!inet->inet_dport)
359 lsa->l2tp_conn_id = lsk->peer_conn_id;
360 lsa->l2tp_addr.s_addr = inet->inet_daddr;
362 __be32 addr = inet->inet_rcv_saddr;
364 addr = inet->inet_saddr;
365 lsa->l2tp_conn_id = lsk->conn_id;
366 lsa->l2tp_addr.s_addr = addr;
368 *uaddr_len = sizeof(*lsa);
372 static int l2tp_ip_backlog_recv(struct sock *sk, struct sk_buff *skb)
376 /* Charge it to the socket, dropping if the queue is full. */
377 rc = sock_queue_rcv_skb(sk, skb);
384 IP_INC_STATS(sock_net(sk), IPSTATS_MIB_INDISCARDS);
389 /* Userspace will call sendmsg() on the tunnel socket to send L2TP
392 static int l2tp_ip_sendmsg(struct sock *sk, struct msghdr *msg, size_t len)
396 struct inet_sock *inet = inet_sk(sk);
397 struct rtable *rt = NULL;
405 if (sock_flag(sk, SOCK_DEAD))
408 /* Get and verify the address. */
410 DECLARE_SOCKADDR(struct sockaddr_l2tpip *, lip, msg->msg_name);
412 if (msg->msg_namelen < sizeof(*lip))
415 if (lip->l2tp_family != AF_INET) {
417 if (lip->l2tp_family != AF_UNSPEC)
421 daddr = lip->l2tp_addr.s_addr;
424 if (sk->sk_state != TCP_ESTABLISHED)
427 daddr = inet->inet_daddr;
431 /* Allocate a socket buffer */
433 skb = sock_wmalloc(sk, 2 + NET_SKB_PAD + sizeof(struct iphdr) +
434 4 + len, 0, GFP_KERNEL);
438 /* Reserve space for headers, putting IP header on 4-byte boundary. */
439 skb_reserve(skb, 2 + NET_SKB_PAD);
440 skb_reset_network_header(skb);
441 skb_reserve(skb, sizeof(struct iphdr));
442 skb_reset_transport_header(skb);
444 /* Insert 0 session_id */
445 *((__be32 *) skb_put(skb, 4)) = 0;
447 /* Copy user data into skb */
448 rc = memcpy_from_msg(skb_put(skb, len), msg, len);
454 fl4 = &inet->cork.fl.u.ip4;
456 rt = (struct rtable *) __sk_dst_check(sk, 0);
460 const struct ip_options_rcu *inet_opt;
462 inet_opt = rcu_dereference(inet->inet_opt);
464 /* Use correct destination address if we have options. */
465 if (inet_opt && inet_opt->opt.srr)
466 daddr = inet_opt->opt.faddr;
468 /* If this fails, retransmit mechanism of transport layer will
469 * keep trying until route appears or the connection times
472 rt = ip_route_output_ports(sock_net(sk), fl4, sk,
473 daddr, inet->inet_saddr,
474 inet->inet_dport, inet->inet_sport,
475 sk->sk_protocol, RT_CONN_FLAGS(sk),
476 sk->sk_bound_dev_if);
480 sk_setup_caps(sk, &rt->dst);
482 skb_dst_set(skb, &rt->dst);
487 /* We dont need to clone dst here, it is guaranteed to not disappear.
488 * __dev_xmit_skb() might force a refcount if needed.
490 skb_dst_set_noref(skb, &rt->dst);
493 /* Queue the packet to IP for output */
494 rc = ip_queue_xmit(sk, skb, &inet->cork.fl);
507 IP_INC_STATS(sock_net(sk), IPSTATS_MIB_OUTNOROUTES);
513 static int l2tp_ip_recvmsg(struct sock *sk, struct msghdr *msg,
514 size_t len, int noblock, int flags, int *addr_len)
516 struct inet_sock *inet = inet_sk(sk);
518 int err = -EOPNOTSUPP;
519 DECLARE_SOCKADDR(struct sockaddr_in *, sin, msg->msg_name);
525 skb = skb_recv_datagram(sk, flags, noblock, &err);
531 msg->msg_flags |= MSG_TRUNC;
535 err = skb_copy_datagram_msg(skb, 0, msg, copied);
539 sock_recv_timestamp(msg, sk, skb);
541 /* Copy the address. */
543 sin->sin_family = AF_INET;
544 sin->sin_addr.s_addr = ip_hdr(skb)->saddr;
546 memset(&sin->sin_zero, 0, sizeof(sin->sin_zero));
547 *addr_len = sizeof(*sin);
549 if (inet->cmsg_flags)
550 ip_cmsg_recv(msg, skb);
551 if (flags & MSG_TRUNC)
554 skb_free_datagram(sk, skb);
556 return err ? err : copied;
559 int l2tp_ioctl(struct sock *sk, int cmd, unsigned long arg)
566 amount = sk_wmem_alloc_get(sk);
569 spin_lock_bh(&sk->sk_receive_queue.lock);
570 skb = skb_peek(&sk->sk_receive_queue);
571 amount = skb ? skb->len : 0;
572 spin_unlock_bh(&sk->sk_receive_queue.lock);
579 return put_user(amount, (int __user *)arg);
581 EXPORT_SYMBOL(l2tp_ioctl);
583 static struct proto l2tp_ip_prot = {
585 .owner = THIS_MODULE,
586 .init = l2tp_ip_open,
587 .close = l2tp_ip_close,
588 .bind = l2tp_ip_bind,
589 .connect = l2tp_ip_connect,
590 .disconnect = l2tp_ip_disconnect,
592 .destroy = l2tp_ip_destroy_sock,
593 .setsockopt = ip_setsockopt,
594 .getsockopt = ip_getsockopt,
595 .sendmsg = l2tp_ip_sendmsg,
596 .recvmsg = l2tp_ip_recvmsg,
597 .backlog_rcv = l2tp_ip_backlog_recv,
599 .unhash = inet_unhash,
600 .obj_size = sizeof(struct l2tp_ip_sock),
602 .compat_setsockopt = compat_ip_setsockopt,
603 .compat_getsockopt = compat_ip_getsockopt,
607 static const struct proto_ops l2tp_ip_ops = {
609 .owner = THIS_MODULE,
610 .release = inet_release,
612 .connect = inet_dgram_connect,
613 .socketpair = sock_no_socketpair,
614 .accept = sock_no_accept,
615 .getname = l2tp_ip_getname,
616 .poll = datagram_poll,
618 .listen = sock_no_listen,
619 .shutdown = inet_shutdown,
620 .setsockopt = sock_common_setsockopt,
621 .getsockopt = sock_common_getsockopt,
622 .sendmsg = inet_sendmsg,
623 .recvmsg = sock_common_recvmsg,
624 .mmap = sock_no_mmap,
625 .sendpage = sock_no_sendpage,
627 .compat_setsockopt = compat_sock_common_setsockopt,
628 .compat_getsockopt = compat_sock_common_getsockopt,
632 static struct inet_protosw l2tp_ip_protosw = {
634 .protocol = IPPROTO_L2TP,
635 .prot = &l2tp_ip_prot,
639 static struct net_protocol l2tp_ip_protocol __read_mostly = {
640 .handler = l2tp_ip_recv,
644 static int __init l2tp_ip_init(void)
648 pr_info("L2TP IP encapsulation support (L2TPv3)\n");
650 err = proto_register(&l2tp_ip_prot, 1);
654 err = inet_add_protocol(&l2tp_ip_protocol, IPPROTO_L2TP);
658 inet_register_protosw(&l2tp_ip_protosw);
662 proto_unregister(&l2tp_ip_prot);
667 static void __exit l2tp_ip_exit(void)
669 inet_unregister_protosw(&l2tp_ip_protosw);
670 inet_del_protocol(&l2tp_ip_protocol, IPPROTO_L2TP);
671 proto_unregister(&l2tp_ip_prot);
674 module_init(l2tp_ip_init);
675 module_exit(l2tp_ip_exit);
677 MODULE_LICENSE("GPL");
678 MODULE_AUTHOR("James Chapman <jchapman@katalix.com>");
679 MODULE_DESCRIPTION("L2TP over IP");
680 MODULE_VERSION("1.0");
682 /* Use the value of SOCK_DGRAM (2) directory, because __stringify doesn't like
685 MODULE_ALIAS_NET_PF_PROTO_TYPE(PF_INET, 2, IPPROTO_L2TP);
686 MODULE_ALIAS_NET_PF_PROTO(PF_INET, IPPROTO_L2TP);