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(const struct net
*net
, __be32 laddr
,
52 __be32 raddr
, int dif
, u32 tunnel_id
)
56 sk_for_each_bound(sk
, &l2tp_ip_bind_table
) {
57 struct inet_sock
*inet
= inet_sk(sk
);
58 struct l2tp_ip_sock
*l2tp
= l2tp_ip_sk(sk
);
63 if ((l2tp
->conn_id
== tunnel_id
) &&
64 net_eq(sock_net(sk
), net
) &&
65 !(inet
->inet_rcv_saddr
&& inet
->inet_rcv_saddr
!= laddr
) &&
66 (!inet
->inet_daddr
|| !raddr
|| inet
->inet_daddr
== raddr
) &&
67 (!sk
->sk_bound_dev_if
|| !dif
||
68 sk
->sk_bound_dev_if
== dif
))
77 /* When processing receive frames, there are two cases to
78 * consider. Data frames consist of a non-zero session-id and an
79 * optional cookie. Control frames consist of a regular L2TP header
80 * preceded by 32-bits of zeros.
82 * L2TPv3 Session Header Over IP
85 * 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
86 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
88 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
89 * | Cookie (optional, maximum 64 bits)...
90 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
92 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
94 * L2TPv3 Control Message Header Over IP
97 * 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
98 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
99 * | (32 bits of zeros) |
100 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
101 * |T|L|x|x|S|x|x|x|x|x|x|x| Ver | Length |
102 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
103 * | Control Connection ID |
104 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
106 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
108 * All control frames are passed to userspace.
110 static int l2tp_ip_recv(struct sk_buff
*skb
)
112 struct net
*net
= dev_net(skb
->dev
);
116 unsigned char *ptr
, *optr
;
117 struct l2tp_session
*session
;
118 struct l2tp_tunnel
*tunnel
= NULL
;
121 if (!pskb_may_pull(skb
, 4))
124 /* Point to L2TP header */
125 optr
= ptr
= skb
->data
;
126 session_id
= ntohl(*((__be32
*) ptr
));
129 /* RFC3931: L2TP/IP packets have the first 4 bytes containing
130 * the session_id. If it is 0, the packet is a L2TP control
131 * frame and the session_id value can be discarded.
133 if (session_id
== 0) {
138 /* Ok, this is a data packet. Lookup the session. */
139 session
= l2tp_session_find(net
, NULL
, session_id
);
143 tunnel
= session
->tunnel
;
147 /* Trace packet contents, if enabled */
148 if (tunnel
->debug
& L2TP_MSG_DATA
) {
149 length
= min(32u, skb
->len
);
150 if (!pskb_may_pull(skb
, length
))
153 /* Point to L2TP header */
154 optr
= ptr
= skb
->data
;
156 pr_debug("%s: ip recv\n", tunnel
->name
);
157 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET
, ptr
, length
);
160 l2tp_recv_common(session
, skb
, ptr
, optr
, 0, skb
->len
, tunnel
->recv_payload_hook
);
165 /* Get the tunnel_id from the L2TP header */
166 if (!pskb_may_pull(skb
, 12))
169 if ((skb
->data
[0] & 0xc0) != 0xc0)
172 tunnel_id
= ntohl(*(__be32
*) &skb
->data
[4]);
173 tunnel
= l2tp_tunnel_find(net
, tunnel_id
);
178 struct iphdr
*iph
= (struct iphdr
*) skb_network_header(skb
);
180 read_lock_bh(&l2tp_ip_lock
);
181 sk
= __l2tp_ip_bind_lookup(net
, iph
->daddr
, iph
->saddr
,
182 inet_iif(skb
), tunnel_id
);
184 read_unlock_bh(&l2tp_ip_lock
);
189 read_unlock_bh(&l2tp_ip_lock
);
192 if (!xfrm4_policy_check(sk
, XFRM_POLICY_IN
, skb
))
197 return sk_receive_skb(sk
, skb
, 1);
207 static int l2tp_ip_open(struct sock
*sk
)
209 /* Prevent autobind. We don't have ports. */
210 inet_sk(sk
)->inet_num
= IPPROTO_L2TP
;
212 write_lock_bh(&l2tp_ip_lock
);
213 sk_add_node(sk
, &l2tp_ip_table
);
214 write_unlock_bh(&l2tp_ip_lock
);
219 static void l2tp_ip_close(struct sock
*sk
, long timeout
)
221 write_lock_bh(&l2tp_ip_lock
);
222 hlist_del_init(&sk
->sk_bind_node
);
223 sk_del_node_init(sk
);
224 write_unlock_bh(&l2tp_ip_lock
);
225 sk_common_release(sk
);
228 static void l2tp_ip_destroy_sock(struct sock
*sk
)
231 struct l2tp_tunnel
*tunnel
= l2tp_sock_to_tunnel(sk
);
233 while ((skb
= __skb_dequeue_tail(&sk
->sk_write_queue
)) != NULL
)
237 l2tp_tunnel_closeall(tunnel
);
241 sk_refcnt_debug_dec(sk
);
244 static int l2tp_ip_bind(struct sock
*sk
, struct sockaddr
*uaddr
, int addr_len
)
246 struct inet_sock
*inet
= inet_sk(sk
);
247 struct sockaddr_l2tpip
*addr
= (struct sockaddr_l2tpip
*) uaddr
;
248 struct net
*net
= sock_net(sk
);
252 if (addr_len
< sizeof(struct sockaddr_l2tpip
))
254 if (addr
->l2tp_family
!= AF_INET
)
260 if (!sock_flag(sk
, SOCK_ZAPPED
))
263 if (sk
->sk_state
!= TCP_CLOSE
|| addr_len
< sizeof(struct sockaddr_l2tpip
))
266 chk_addr_ret
= inet_addr_type(net
, addr
->l2tp_addr
.s_addr
);
267 ret
= -EADDRNOTAVAIL
;
268 if (addr
->l2tp_addr
.s_addr
&& chk_addr_ret
!= RTN_LOCAL
&&
269 chk_addr_ret
!= RTN_MULTICAST
&& chk_addr_ret
!= RTN_BROADCAST
)
272 if (addr
->l2tp_addr
.s_addr
)
273 inet
->inet_rcv_saddr
= inet
->inet_saddr
= addr
->l2tp_addr
.s_addr
;
274 if (chk_addr_ret
== RTN_MULTICAST
|| chk_addr_ret
== RTN_BROADCAST
)
275 inet
->inet_saddr
= 0; /* Use device */
277 write_lock_bh(&l2tp_ip_lock
);
278 if (__l2tp_ip_bind_lookup(net
, addr
->l2tp_addr
.s_addr
, 0,
279 sk
->sk_bound_dev_if
, addr
->l2tp_conn_id
)) {
280 write_unlock_bh(&l2tp_ip_lock
);
286 l2tp_ip_sk(sk
)->conn_id
= addr
->l2tp_conn_id
;
288 sk_add_bind_node(sk
, &l2tp_ip_bind_table
);
289 sk_del_node_init(sk
);
290 write_unlock_bh(&l2tp_ip_lock
);
293 sock_reset_flag(sk
, SOCK_ZAPPED
);
301 static int l2tp_ip_connect(struct sock
*sk
, struct sockaddr
*uaddr
, int addr_len
)
303 struct sockaddr_l2tpip
*lsa
= (struct sockaddr_l2tpip
*) uaddr
;
306 if (addr_len
< sizeof(*lsa
))
309 if (ipv4_is_multicast(lsa
->l2tp_addr
.s_addr
))
314 /* Must bind first - autobinding does not work */
315 if (sock_flag(sk
, SOCK_ZAPPED
)) {
320 rc
= __ip4_datagram_connect(sk
, uaddr
, addr_len
);
324 l2tp_ip_sk(sk
)->peer_conn_id
= lsa
->l2tp_conn_id
;
326 write_lock_bh(&l2tp_ip_lock
);
327 hlist_del_init(&sk
->sk_bind_node
);
328 sk_add_bind_node(sk
, &l2tp_ip_bind_table
);
329 write_unlock_bh(&l2tp_ip_lock
);
337 static int l2tp_ip_disconnect(struct sock
*sk
, int flags
)
339 if (sock_flag(sk
, SOCK_ZAPPED
))
342 return __udp_disconnect(sk
, flags
);
345 static int l2tp_ip_getname(struct socket
*sock
, struct sockaddr
*uaddr
,
346 int *uaddr_len
, int peer
)
348 struct sock
*sk
= sock
->sk
;
349 struct inet_sock
*inet
= inet_sk(sk
);
350 struct l2tp_ip_sock
*lsk
= l2tp_ip_sk(sk
);
351 struct sockaddr_l2tpip
*lsa
= (struct sockaddr_l2tpip
*)uaddr
;
353 memset(lsa
, 0, sizeof(*lsa
));
354 lsa
->l2tp_family
= AF_INET
;
356 if (!inet
->inet_dport
)
358 lsa
->l2tp_conn_id
= lsk
->peer_conn_id
;
359 lsa
->l2tp_addr
.s_addr
= inet
->inet_daddr
;
361 __be32 addr
= inet
->inet_rcv_saddr
;
363 addr
= inet
->inet_saddr
;
364 lsa
->l2tp_conn_id
= lsk
->conn_id
;
365 lsa
->l2tp_addr
.s_addr
= addr
;
367 *uaddr_len
= sizeof(*lsa
);
371 static int l2tp_ip_backlog_recv(struct sock
*sk
, struct sk_buff
*skb
)
375 /* Charge it to the socket, dropping if the queue is full. */
376 rc
= sock_queue_rcv_skb(sk
, skb
);
383 IP_INC_STATS(sock_net(sk
), IPSTATS_MIB_INDISCARDS
);
388 /* Userspace will call sendmsg() on the tunnel socket to send L2TP
391 static int l2tp_ip_sendmsg(struct sock
*sk
, struct msghdr
*msg
, size_t len
)
395 struct inet_sock
*inet
= inet_sk(sk
);
396 struct rtable
*rt
= NULL
;
404 if (sock_flag(sk
, SOCK_DEAD
))
407 /* Get and verify the address. */
409 DECLARE_SOCKADDR(struct sockaddr_l2tpip
*, lip
, msg
->msg_name
);
411 if (msg
->msg_namelen
< sizeof(*lip
))
414 if (lip
->l2tp_family
!= AF_INET
) {
416 if (lip
->l2tp_family
!= AF_UNSPEC
)
420 daddr
= lip
->l2tp_addr
.s_addr
;
423 if (sk
->sk_state
!= TCP_ESTABLISHED
)
426 daddr
= inet
->inet_daddr
;
430 /* Allocate a socket buffer */
432 skb
= sock_wmalloc(sk
, 2 + NET_SKB_PAD
+ sizeof(struct iphdr
) +
433 4 + len
, 0, GFP_KERNEL
);
437 /* Reserve space for headers, putting IP header on 4-byte boundary. */
438 skb_reserve(skb
, 2 + NET_SKB_PAD
);
439 skb_reset_network_header(skb
);
440 skb_reserve(skb
, sizeof(struct iphdr
));
441 skb_reset_transport_header(skb
);
443 /* Insert 0 session_id */
444 *((__be32
*) skb_put(skb
, 4)) = 0;
446 /* Copy user data into skb */
447 rc
= memcpy_from_msg(skb_put(skb
, len
), msg
, len
);
453 fl4
= &inet
->cork
.fl
.u
.ip4
;
455 rt
= (struct rtable
*) __sk_dst_check(sk
, 0);
459 const struct ip_options_rcu
*inet_opt
;
461 inet_opt
= rcu_dereference(inet
->inet_opt
);
463 /* Use correct destination address if we have options. */
464 if (inet_opt
&& inet_opt
->opt
.srr
)
465 daddr
= inet_opt
->opt
.faddr
;
467 /* If this fails, retransmit mechanism of transport layer will
468 * keep trying until route appears or the connection times
471 rt
= ip_route_output_ports(sock_net(sk
), fl4
, sk
,
472 daddr
, inet
->inet_saddr
,
473 inet
->inet_dport
, inet
->inet_sport
,
474 sk
->sk_protocol
, RT_CONN_FLAGS(sk
),
475 sk
->sk_bound_dev_if
);
479 sk_setup_caps(sk
, &rt
->dst
);
481 skb_dst_set(skb
, &rt
->dst
);
486 /* We dont need to clone dst here, it is guaranteed to not disappear.
487 * __dev_xmit_skb() might force a refcount if needed.
489 skb_dst_set_noref(skb
, &rt
->dst
);
492 /* Queue the packet to IP for output */
493 rc
= ip_queue_xmit(sk
, skb
, &inet
->cork
.fl
);
506 IP_INC_STATS(sock_net(sk
), IPSTATS_MIB_OUTNOROUTES
);
512 static int l2tp_ip_recvmsg(struct sock
*sk
, struct msghdr
*msg
,
513 size_t len
, int noblock
, int flags
, int *addr_len
)
515 struct inet_sock
*inet
= inet_sk(sk
);
517 int err
= -EOPNOTSUPP
;
518 DECLARE_SOCKADDR(struct sockaddr_in
*, sin
, msg
->msg_name
);
524 skb
= skb_recv_datagram(sk
, flags
, noblock
, &err
);
530 msg
->msg_flags
|= MSG_TRUNC
;
534 err
= skb_copy_datagram_msg(skb
, 0, msg
, copied
);
538 sock_recv_timestamp(msg
, sk
, skb
);
540 /* Copy the address. */
542 sin
->sin_family
= AF_INET
;
543 sin
->sin_addr
.s_addr
= ip_hdr(skb
)->saddr
;
545 memset(&sin
->sin_zero
, 0, sizeof(sin
->sin_zero
));
546 *addr_len
= sizeof(*sin
);
548 if (inet
->cmsg_flags
)
549 ip_cmsg_recv(msg
, skb
);
550 if (flags
& MSG_TRUNC
)
553 skb_free_datagram(sk
, skb
);
555 return err
? err
: copied
;
558 int l2tp_ioctl(struct sock
*sk
, int cmd
, unsigned long arg
)
565 amount
= sk_wmem_alloc_get(sk
);
568 spin_lock_bh(&sk
->sk_receive_queue
.lock
);
569 skb
= skb_peek(&sk
->sk_receive_queue
);
570 amount
= skb
? skb
->len
: 0;
571 spin_unlock_bh(&sk
->sk_receive_queue
.lock
);
578 return put_user(amount
, (int __user
*)arg
);
580 EXPORT_SYMBOL(l2tp_ioctl
);
582 static struct proto l2tp_ip_prot
= {
584 .owner
= THIS_MODULE
,
585 .init
= l2tp_ip_open
,
586 .close
= l2tp_ip_close
,
587 .bind
= l2tp_ip_bind
,
588 .connect
= l2tp_ip_connect
,
589 .disconnect
= l2tp_ip_disconnect
,
591 .destroy
= l2tp_ip_destroy_sock
,
592 .setsockopt
= ip_setsockopt
,
593 .getsockopt
= ip_getsockopt
,
594 .sendmsg
= l2tp_ip_sendmsg
,
595 .recvmsg
= l2tp_ip_recvmsg
,
596 .backlog_rcv
= l2tp_ip_backlog_recv
,
598 .unhash
= inet_unhash
,
599 .obj_size
= sizeof(struct l2tp_ip_sock
),
601 .compat_setsockopt
= compat_ip_setsockopt
,
602 .compat_getsockopt
= compat_ip_getsockopt
,
606 static const struct proto_ops l2tp_ip_ops
= {
608 .owner
= THIS_MODULE
,
609 .release
= inet_release
,
611 .connect
= inet_dgram_connect
,
612 .socketpair
= sock_no_socketpair
,
613 .accept
= sock_no_accept
,
614 .getname
= l2tp_ip_getname
,
615 .poll
= datagram_poll
,
617 .listen
= sock_no_listen
,
618 .shutdown
= inet_shutdown
,
619 .setsockopt
= sock_common_setsockopt
,
620 .getsockopt
= sock_common_getsockopt
,
621 .sendmsg
= inet_sendmsg
,
622 .recvmsg
= sock_common_recvmsg
,
623 .mmap
= sock_no_mmap
,
624 .sendpage
= sock_no_sendpage
,
626 .compat_setsockopt
= compat_sock_common_setsockopt
,
627 .compat_getsockopt
= compat_sock_common_getsockopt
,
631 static struct inet_protosw l2tp_ip_protosw
= {
633 .protocol
= IPPROTO_L2TP
,
634 .prot
= &l2tp_ip_prot
,
638 static struct net_protocol l2tp_ip_protocol __read_mostly
= {
639 .handler
= l2tp_ip_recv
,
643 static int __init
l2tp_ip_init(void)
647 pr_info("L2TP IP encapsulation support (L2TPv3)\n");
649 err
= proto_register(&l2tp_ip_prot
, 1);
653 err
= inet_add_protocol(&l2tp_ip_protocol
, IPPROTO_L2TP
);
657 inet_register_protosw(&l2tp_ip_protosw
);
661 proto_unregister(&l2tp_ip_prot
);
666 static void __exit
l2tp_ip_exit(void)
668 inet_unregister_protosw(&l2tp_ip_protosw
);
669 inet_del_protocol(&l2tp_ip_protocol
, IPPROTO_L2TP
);
670 proto_unregister(&l2tp_ip_prot
);
673 module_init(l2tp_ip_init
);
674 module_exit(l2tp_ip_exit
);
676 MODULE_LICENSE("GPL");
677 MODULE_AUTHOR("James Chapman <jchapman@katalix.com>");
678 MODULE_DESCRIPTION("L2TP over IP");
679 MODULE_VERSION("1.0");
681 /* Use the value of SOCK_DGRAM (2) directory, because __stringify doesn't like
684 MODULE_ALIAS_NET_PF_PROTO_TYPE(PF_INET
, 2, IPPROTO_L2TP
);
685 MODULE_ALIAS_NET_PF_PROTO(PF_INET
, IPPROTO_L2TP
);