net/l2tp/l2tp_ppp.c

   1 /*****************************************************************************
   2  * Linux PPP over L2TP (PPPoX/PPPoL2TP) Sockets
   3  *
   4  * PPPoX    --- Generic PPP encapsulation socket family
   5  * PPPoL2TP --- PPP over L2TP (RFC 2661)
   6  *
   7  * Version:     2.0.0
   8  *
   9  * Authors:     James Chapman (jchapman@katalix.com)
  10  *
  11  * Based on original work by Martijn van Oosterhout <kleptog@svana.org>
  12  *
  13  * License:
  14  *              This program is free software; you can redistribute it and/or
  15  *              modify it under the terms of the GNU General Public License
  16  *              as published by the Free Software Foundation; either version
  17  *              2 of the License, or (at your option) any later version.
  18  *
  19  */
  20
  21 /* This driver handles only L2TP data frames; control frames are handled by a
  22  * userspace application.
  23  *
  24  * To send data in an L2TP session, userspace opens a PPPoL2TP socket and
  25  * attaches it to a bound UDP socket with local tunnel_id / session_id and
  26  * peer tunnel_id / session_id set. Data can then be sent or received using
  27  * regular socket sendmsg() / recvmsg() calls. Kernel parameters of the socket
  28  * can be read or modified using ioctl() or [gs]etsockopt() calls.
  29  *
  30  * When a PPPoL2TP socket is connected with local and peer session_id values
  31  * zero, the socket is treated as a special tunnel management socket.
  32  *
  33  * Here's example userspace code to create a socket for sending/receiving data
  34  * over an L2TP session:-
  35  *
  36  *      struct sockaddr_pppol2tp sax;
  37  *      int fd;
  38  *      int session_fd;
  39  *
  40  *      fd = socket(AF_PPPOX, SOCK_DGRAM, PX_PROTO_OL2TP);
  41  *
  42  *      sax.sa_family = AF_PPPOX;
  43  *      sax.sa_protocol = PX_PROTO_OL2TP;
  44  *      sax.pppol2tp.fd = tunnel_fd;    // bound UDP socket
  45  *      sax.pppol2tp.addr.sin_addr.s_addr = addr->sin_addr.s_addr;
  46  *      sax.pppol2tp.addr.sin_port = addr->sin_port;
  47  *      sax.pppol2tp.addr.sin_family = AF_INET;
  48  *      sax.pppol2tp.s_tunnel  = tunnel_id;
  49  *      sax.pppol2tp.s_session = session_id;
  50  *      sax.pppol2tp.d_tunnel  = peer_tunnel_id;
  51  *      sax.pppol2tp.d_session = peer_session_id;
  52  *
  53  *      session_fd = connect(fd, (struct sockaddr *)&sax, sizeof(sax));
  54  *
  55  * A pppd plugin that allows PPP traffic to be carried over L2TP using
  56  * this driver is available from the OpenL2TP project at
  57  * http://openl2tp.sourceforge.net.
  58  */
  59
  60 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  61
  62 #include <linux/module.h>
  63 #include <linux/string.h>
  64 #include <linux/list.h>
  65 #include <linux/uaccess.h>
  66
  67 #include <linux/kernel.h>
  68 #include <linux/spinlock.h>
  69 #include <linux/kthread.h>
  70 #include <linux/sched.h>
  71 #include <linux/slab.h>
  72 #include <linux/errno.h>
  73 #include <linux/jiffies.h>
  74
  75 #include <linux/netdevice.h>
  76 #include <linux/net.h>
  77 #include <linux/inetdevice.h>
  78 #include <linux/skbuff.h>
  79 #include <linux/init.h>
  80 #include <linux/ip.h>
  81 #include <linux/udp.h>
  82 #include <linux/if_pppox.h>
  83 #include <linux/if_pppol2tp.h>
  84 #include <net/sock.h>
  85 #include <linux/ppp_channel.h>
  86 #include <linux/ppp_defs.h>
  87 #include <linux/ppp-ioctl.h>
  88 #include <linux/file.h>
  89 #include <linux/hash.h>
  90 #include <linux/sort.h>
  91 #include <linux/proc_fs.h>
  92 #include <linux/l2tp.h>
  93 #include <linux/nsproxy.h>
  94 #include <net/net_namespace.h>
  95 #include <net/netns/generic.h>
  96 #include <net/dst.h>
  97 #include <net/ip.h>
  98 #include <net/udp.h>
  99 #include <net/xfrm.h>
 100 #include <net/inet_common.h>
 101
 102 #include <asm/byteorder.h>
 103 #include <linux/atomic.h>
 104
 105 #include "l2tp_core.h"
 106
 107 #define PPPOL2TP_DRV_VERSION    "V2.0"
 108
 109 /* Space for UDP, L2TP and PPP headers */
 110 #define PPPOL2TP_HEADER_OVERHEAD        40
 111
 112 /* Number of bytes to build transmit L2TP headers.
 113  * Unfortunately the size is different depending on whether sequence numbers
 114  * are enabled.
 115  */
 116 #define PPPOL2TP_L2TP_HDR_SIZE_SEQ              10
 117 #define PPPOL2TP_L2TP_HDR_SIZE_NOSEQ            6
 118
 119 /* Private data of each session. This data lives at the end of struct
 120  * l2tp_session, referenced via session->priv[].
 121  */
 122 struct pppol2tp_session {
 123         int                     owner;          /* pid that opened the socket */
 124
 125         struct sock             *sock;          /* Pointer to the session
 126                                                  * PPPoX socket */
 127         struct sock             *tunnel_sock;   /* Pointer to the tunnel UDP
 128                                                  * socket */
 129         int                     flags;          /* accessed by PPPIOCGFLAGS.
 130                                                  * Unused. */
 131 };
 132
 133 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb);
 134
 135 static const struct ppp_channel_ops pppol2tp_chan_ops = {
 136         .start_xmit =  pppol2tp_xmit,
 137 };
 138
 139 static const struct proto_ops pppol2tp_ops;
 140
 141 /* Helpers to obtain tunnel/session contexts from sockets.
 142  */
 143 static inline struct l2tp_session *pppol2tp_sock_to_session(struct sock *sk)
 144 {
 145         struct l2tp_session *session;
 146
 147         if (sk == NULL)
 148                 return NULL;
 149
 150         sock_hold(sk);
 151         session = (struct l2tp_session *)(sk->sk_user_data);
 152         if (session == NULL) {
 153                 sock_put(sk);
 154                 goto out;
 155         }
 156
 157         BUG_ON(session->magic != L2TP_SESSION_MAGIC);
 158
 159 out:
 160         return session;
 161 }
 162
 163 /*****************************************************************************
 164  * Receive data handling
 165  *****************************************************************************/
 166
 167 static int pppol2tp_recv_payload_hook(struct sk_buff *skb)
 168 {
 169         /* Skip PPP header, if present.  In testing, Microsoft L2TP clients
 170          * don't send the PPP header (PPP header compression enabled), but
 171          * other clients can include the header. So we cope with both cases
 172          * here. The PPP header is always FF03 when using L2TP.
 173          *
 174          * Note that skb->data[] isn't dereferenced from a u16 ptr here since
 175          * the field may be unaligned.
 176          */
 177         if (!pskb_may_pull(skb, 2))
 178                 return 1;
 179
 180         if ((skb->data[0] == 0xff) && (skb->data[1] == 0x03))
 181                 skb_pull(skb, 2);
 182
 183         return 0;
 184 }
 185
 186 /* Receive message. This is the recvmsg for the PPPoL2TP socket.
 187  */
 188 static int pppol2tp_recvmsg(struct kiocb *iocb, struct socket *sock,
 189                             struct msghdr *msg, size_t len,
 190                             int flags)
 191 {
 192         int err;
 193         struct sk_buff *skb;
 194         struct sock *sk = sock->sk;
 195
 196         err = -EIO;
 197         if (sk->sk_state & PPPOX_BOUND)
 198                 goto end;
 199
 200         msg->msg_namelen = 0;
 201
 202         err = 0;
 203         skb = skb_recv_datagram(sk, flags & ~MSG_DONTWAIT,
 204                                 flags & MSG_DONTWAIT, &err);
 205         if (!skb)
 206                 goto end;
 207
 208         if (len > skb->len)
 209                 len = skb->len;
 210         else if (len < skb->len)
 211                 msg->msg_flags |= MSG_TRUNC;
 212
 213         err = skb_copy_datagram_iovec(skb, 0, msg->msg_iov, len);
 214         if (likely(err == 0))
 215                 err = len;
 216
 217         kfree_skb(skb);
 218 end:
 219         return err;
 220 }
 221
 222 static void pppol2tp_recv(struct l2tp_session *session, struct sk_buff *skb, int data_len)
 223 {
 224         struct pppol2tp_session *ps = l2tp_session_priv(session);
 225         struct sock *sk = NULL;
 226
 227         /* If the socket is bound, send it in to PPP's input queue. Otherwise
 228          * queue it on the session socket.
 229          */
 230         sk = ps->sock;
 231         if (sk == NULL)
 232                 goto no_sock;
 233
 234         if (sk->sk_state & PPPOX_BOUND) {
 235                 struct pppox_sock *po;
 236                 l2tp_dbg(session, PPPOL2TP_MSG_DATA,
 237                          "%s: recv %d byte data frame, passing to ppp\n",
 238                          session->name, data_len);
 239
 240                 /* We need to forget all info related to the L2TP packet
 241                  * gathered in the skb as we are going to reuse the same
 242                  * skb for the inner packet.
 243                  * Namely we need to:
 244                  * - reset xfrm (IPSec) information as it applies to
 245                  *   the outer L2TP packet and not to the inner one
 246                  * - release the dst to force a route lookup on the inner
 247                  *   IP packet since skb->dst currently points to the dst
 248                  *   of the UDP tunnel
 249                  * - reset netfilter information as it doesn't apply
 250                  *   to the inner packet either
 251                  */
 252                 secpath_reset(skb);
 253                 skb_dst_drop(skb);
 254                 nf_reset(skb);
 255
 256                 po = pppox_sk(sk);
 257                 ppp_input(&po->chan, skb);
 258         } else {
 259                 l2tp_info(session, PPPOL2TP_MSG_DATA, "%s: socket not bound\n",
 260                           session->name);
 261
 262                 /* Not bound. Nothing we can do, so discard. */
 263                 atomic_long_inc(&session->stats.rx_errors);
 264                 kfree_skb(skb);
 265         }
 266
 267         return;
 268
 269 no_sock:
 270         l2tp_info(session, PPPOL2TP_MSG_DATA, "%s: no socket\n", session->name);
 271         kfree_skb(skb);
 272 }
 273
 274 static void pppol2tp_session_sock_hold(struct l2tp_session *session)
 275 {
 276         struct pppol2tp_session *ps = l2tp_session_priv(session);
 277
 278         if (ps->sock)
 279                 sock_hold(ps->sock);
 280 }
 281
 282 static void pppol2tp_session_sock_put(struct l2tp_session *session)
 283 {
 284         struct pppol2tp_session *ps = l2tp_session_priv(session);
 285
 286         if (ps->sock)
 287                 sock_put(ps->sock);
 288 }
 289
 290 /************************************************************************
 291  * Transmit handling
 292  ***********************************************************************/
 293
 294 /* This is the sendmsg for the PPPoL2TP pppol2tp_session socket.  We come here
 295  * when a user application does a sendmsg() on the session socket. L2TP and
 296  * PPP headers must be inserted into the user's data.
 297  */
 298 static int pppol2tp_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr *m,
 299                             size_t total_len)
 300 {
 301         static const unsigned char ppph[2] = { 0xff, 0x03 };
 302         struct sock *sk = sock->sk;
 303         struct sk_buff *skb;
 304         int error;
 305         struct l2tp_session *session;
 306         struct l2tp_tunnel *tunnel;
 307         struct pppol2tp_session *ps;
 308         int uhlen;
 309
 310         error = -ENOTCONN;
 311         if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
 312                 goto error;
 313
 314         /* Get session and tunnel contexts */
 315         error = -EBADF;
 316         session = pppol2tp_sock_to_session(sk);
 317         if (session == NULL)
 318                 goto error;
 319
 320         ps = l2tp_session_priv(session);
 321         tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
 322         if (tunnel == NULL)
 323                 goto error_put_sess;
 324
 325         uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
 326
 327         /* Allocate a socket buffer */
 328         error = -ENOMEM;
 329         skb = sock_wmalloc(sk, NET_SKB_PAD + sizeof(struct iphdr) +
 330                            uhlen + session->hdr_len +
 331                            sizeof(ppph) + total_len,
 332                            0, GFP_KERNEL);
 333         if (!skb)
 334                 goto error_put_sess_tun;
 335
 336         /* Reserve space for headers. */
 337         skb_reserve(skb, NET_SKB_PAD);
 338         skb_reset_network_header(skb);
 339         skb_reserve(skb, sizeof(struct iphdr));
 340         skb_reset_transport_header(skb);
 341         skb_reserve(skb, uhlen);
 342
 343         /* Add PPP header */
 344         skb->data[0] = ppph[0];
 345         skb->data[1] = ppph[1];
 346         skb_put(skb, 2);
 347
 348         /* Copy user data into skb */
 349         error = memcpy_fromiovec(skb->data, m->msg_iov, total_len);
 350         if (error < 0) {
 351                 kfree_skb(skb);
 352                 goto error_put_sess_tun;
 353         }
 354         skb_put(skb, total_len);
 355
 356         l2tp_xmit_skb(session, skb, session->hdr_len);
 357
 358         sock_put(ps->tunnel_sock);
 359         sock_put(sk);
 360
 361         return error;
 362
 363 error_put_sess_tun:
 364         sock_put(ps->tunnel_sock);
 365 error_put_sess:
 366         sock_put(sk);
 367 error:
 368         return error;
 369 }
 370
 371 /* Transmit function called by generic PPP driver.  Sends PPP frame
 372  * over PPPoL2TP socket.
 373  *
 374  * This is almost the same as pppol2tp_sendmsg(), but rather than
 375  * being called with a msghdr from userspace, it is called with a skb
 376  * from the kernel.
 377  *
 378  * The supplied skb from ppp doesn't have enough headroom for the
 379  * insertion of L2TP, UDP and IP headers so we need to allocate more
 380  * headroom in the skb. This will create a cloned skb. But we must be
 381  * careful in the error case because the caller will expect to free
 382  * the skb it supplied, not our cloned skb. So we take care to always
 383  * leave the original skb unfreed if we return an error.
 384  */
 385 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb)
 386 {
 387         static const u8 ppph[2] = { 0xff, 0x03 };
 388         struct sock *sk = (struct sock *) chan->private;
 389         struct sock *sk_tun;
 390         struct l2tp_session *session;
 391         struct l2tp_tunnel *tunnel;
 392         struct pppol2tp_session *ps;
 393         int uhlen, headroom;
 394
 395         if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
 396                 goto abort;
 397
 398         /* Get session and tunnel contexts from the socket */
 399         session = pppol2tp_sock_to_session(sk);
 400         if (session == NULL)
 401                 goto abort;
 402
 403         ps = l2tp_session_priv(session);
 404         sk_tun = ps->tunnel_sock;
 405         if (sk_tun == NULL)
 406                 goto abort_put_sess;
 407         tunnel = l2tp_sock_to_tunnel(sk_tun);
 408         if (tunnel == NULL)
 409                 goto abort_put_sess;
 410
 411         uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
 412         headroom = NET_SKB_PAD +
 413                    sizeof(struct iphdr) + /* IP header */
 414                    uhlen +              /* UDP header (if L2TP_ENCAPTYPE_UDP) */
 415                    session->hdr_len +   /* L2TP header */
 416                    sizeof(ppph);        /* PPP header */
 417         if (skb_cow_head(skb, headroom))
 418                 goto abort_put_sess_tun;
 419
 420         /* Setup PPP header */
 421         __skb_push(skb, sizeof(ppph));
 422         skb->data[0] = ppph[0];
 423         skb->data[1] = ppph[1];
 424
 425         l2tp_xmit_skb(session, skb, session->hdr_len);
 426
 427         sock_put(sk_tun);
 428         sock_put(sk);
 429         return 1;
 430
 431 abort_put_sess_tun:
 432         sock_put(sk_tun);
 433 abort_put_sess:
 434         sock_put(sk);
 435 abort:
 436         /* Free the original skb */
 437         kfree_skb(skb);
 438         return 1;
 439 }
 440
 441 /*****************************************************************************
 442  * Session (and tunnel control) socket create/destroy.
 443  *****************************************************************************/
 444
 445 /* Called by l2tp_core when a session socket is being closed.
 446  */
 447 static void pppol2tp_session_close(struct l2tp_session *session)
 448 {
 449         struct pppol2tp_session *ps = l2tp_session_priv(session);
 450         struct sock *sk = ps->sock;
 451         struct socket *sock = sk->sk_socket;
 452
 453         BUG_ON(session->magic != L2TP_SESSION_MAGIC);
 454
 455
 456         if (sock) {
 457                 inet_shutdown(sock, 2);
 458                 /* Don't let the session go away before our socket does */
 459                 l2tp_session_inc_refcount(session);
 460         }
 461         return;
 462 }
 463
 464 /* Really kill the session socket. (Called from sock_put() if
 465  * refcnt == 0.)
 466  */
 467 static void pppol2tp_session_destruct(struct sock *sk)
 468 {
 469         struct l2tp_session *session;
 470
 471         if (sk->sk_user_data != NULL) {
 472                 session = sk->sk_user_data;
 473                 if (session == NULL)
 474                         goto out;
 475
 476                 sk->sk_user_data = NULL;
 477                 BUG_ON(session->magic != L2TP_SESSION_MAGIC);
 478                 l2tp_session_dec_refcount(session);
 479         }
 480
 481 out:
 482         return;
 483 }
 484
 485 /* Called when the PPPoX socket (session) is closed.
 486  */
 487 static int pppol2tp_release(struct socket *sock)
 488 {
 489         struct sock *sk = sock->sk;
 490         struct l2tp_session *session;
 491         int error;
 492
 493         if (!sk)
 494                 return 0;
 495
 496         error = -EBADF;
 497         lock_sock(sk);
 498         if (sock_flag(sk, SOCK_DEAD) != 0)
 499                 goto error;
 500
 501         pppox_unbind_sock(sk);
 502
 503         /* Signal the death of the socket. */
 504         sk->sk_state = PPPOX_DEAD;
 505         sock_orphan(sk);
 506         sock->sk = NULL;
 507
 508         session = pppol2tp_sock_to_session(sk);
 509
 510         /* Purge any queued data */
 511         if (session != NULL) {
 512                 l2tp_session_queue_purge(session);
 513                 sock_put(sk);
 514         }
 515         skb_queue_purge(&sk->sk_receive_queue);
 516         skb_queue_purge(&sk->sk_write_queue);
 517
 518         release_sock(sk);
 519
 520         /* This will delete the session context via
 521          * pppol2tp_session_destruct() if the socket's refcnt drops to
 522          * zero.
 523          */
 524         sock_put(sk);
 525
 526         return 0;
 527
 528 error:
 529         release_sock(sk);
 530         return error;
 531 }
 532
 533 static struct proto pppol2tp_sk_proto = {
 534         .name     = "PPPOL2TP",
 535         .owner    = THIS_MODULE,
 536         .obj_size = sizeof(struct pppox_sock),
 537 };
 538
 539 static int pppol2tp_backlog_recv(struct sock *sk, struct sk_buff *skb)
 540 {
 541         int rc;
 542
 543         rc = l2tp_udp_encap_recv(sk, skb);
 544         if (rc)
 545                 kfree_skb(skb);
 546
 547         return NET_RX_SUCCESS;
 548 }
 549
 550 /* socket() handler. Initialize a new struct sock.
 551  */
 552 static int pppol2tp_create(struct net *net, struct socket *sock)
 553 {
 554         int error = -ENOMEM;
 555         struct sock *sk;
 556
 557         sk = sk_alloc(net, PF_PPPOX, GFP_KERNEL, &pppol2tp_sk_proto);
 558         if (!sk)
 559                 goto out;
 560
 561         sock_init_data(sock, sk);
 562
 563         sock->state  = SS_UNCONNECTED;
 564         sock->ops    = &pppol2tp_ops;
 565
 566         sk->sk_backlog_rcv = pppol2tp_backlog_recv;
 567         sk->sk_protocol    = PX_PROTO_OL2TP;
 568         sk->sk_family      = PF_PPPOX;
 569         sk->sk_state       = PPPOX_NONE;
 570         sk->sk_type        = SOCK_STREAM;
 571         sk->sk_destruct    = pppol2tp_session_destruct;
 572
 573         error = 0;
 574
 575 out:
 576         return error;
 577 }
 578
 579 #if defined(CONFIG_L2TP_DEBUGFS) || defined(CONFIG_L2TP_DEBUGFS_MODULE)
 580 static void pppol2tp_show(struct seq_file *m, void *arg)
 581 {
 582         struct l2tp_session *session = arg;
 583         struct pppol2tp_session *ps = l2tp_session_priv(session);
 584
 585         if (ps) {
 586                 struct pppox_sock *po = pppox_sk(ps->sock);
 587                 if (po)
 588                         seq_printf(m, "   interface %s\n", ppp_dev_name(&po->chan));
 589         }
 590 }
 591 #endif
 592
 593 /* connect() handler. Attach a PPPoX socket to a tunnel UDP socket
 594  */
 595 static int pppol2tp_connect(struct socket *sock, struct sockaddr *uservaddr,
 596                             int sockaddr_len, int flags)
 597 {
 598         struct sock *sk = sock->sk;
 599         struct sockaddr_pppol2tp *sp = (struct sockaddr_pppol2tp *) uservaddr;
 600         struct pppox_sock *po = pppox_sk(sk);
 601         struct l2tp_session *session = NULL;
 602         struct l2tp_tunnel *tunnel;
 603         struct pppol2tp_session *ps;
 604         struct dst_entry *dst;
 605         struct l2tp_session_cfg cfg = { 0, };
 606         int error = 0;
 607         u32 tunnel_id, peer_tunnel_id;
 608         u32 session_id, peer_session_id;
 609         int ver = 2;
 610         int fd;
 611
 612         lock_sock(sk);
 613
 614         error = -EINVAL;
 615         if (sp->sa_protocol != PX_PROTO_OL2TP)
 616                 goto end;
 617
 618         /* Check for already bound sockets */
 619         error = -EBUSY;
 620         if (sk->sk_state & PPPOX_CONNECTED)
 621                 goto end;
 622
 623         /* We don't supporting rebinding anyway */
 624         error = -EALREADY;
 625         if (sk->sk_user_data)
 626                 goto end; /* socket is already attached */
 627
 628         /* Get params from socket address. Handle L2TPv2 and L2TPv3.
 629          * This is nasty because there are different sockaddr_pppol2tp
 630          * structs for L2TPv2, L2TPv3, over IPv4 and IPv6. We use
 631          * the sockaddr size to determine which structure the caller
 632          * is using.
 633          */
 634         peer_tunnel_id = 0;
 635         if (sockaddr_len == sizeof(struct sockaddr_pppol2tp)) {
 636                 fd = sp->pppol2tp.fd;
 637                 tunnel_id = sp->pppol2tp.s_tunnel;
 638                 peer_tunnel_id = sp->pppol2tp.d_tunnel;
 639                 session_id = sp->pppol2tp.s_session;
 640                 peer_session_id = sp->pppol2tp.d_session;
 641         } else if (sockaddr_len == sizeof(struct sockaddr_pppol2tpv3)) {
 642                 struct sockaddr_pppol2tpv3 *sp3 =
 643                         (struct sockaddr_pppol2tpv3 *) sp;
 644                 ver = 3;
 645                 fd = sp3->pppol2tp.fd;
 646                 tunnel_id = sp3->pppol2tp.s_tunnel;
 647                 peer_tunnel_id = sp3->pppol2tp.d_tunnel;
 648                 session_id = sp3->pppol2tp.s_session;
 649                 peer_session_id = sp3->pppol2tp.d_session;
 650         } else if (sockaddr_len == sizeof(struct sockaddr_pppol2tpin6)) {
 651                 struct sockaddr_pppol2tpin6 *sp6 =
 652                         (struct sockaddr_pppol2tpin6 *) sp;
 653                 fd = sp6->pppol2tp.fd;
 654                 tunnel_id = sp6->pppol2tp.s_tunnel;
 655                 peer_tunnel_id = sp6->pppol2tp.d_tunnel;
 656                 session_id = sp6->pppol2tp.s_session;
 657                 peer_session_id = sp6->pppol2tp.d_session;
 658         } else if (sockaddr_len == sizeof(struct sockaddr_pppol2tpv3in6)) {
 659                 struct sockaddr_pppol2tpv3in6 *sp6 =
 660                         (struct sockaddr_pppol2tpv3in6 *) sp;
 661                 ver = 3;
 662                 fd = sp6->pppol2tp.fd;
 663                 tunnel_id = sp6->pppol2tp.s_tunnel;
 664                 peer_tunnel_id = sp6->pppol2tp.d_tunnel;
 665                 session_id = sp6->pppol2tp.s_session;
 666                 peer_session_id = sp6->pppol2tp.d_session;
 667         } else {
 668                 error = -EINVAL;
 669                 goto end; /* bad socket address */
 670         }
 671
 672         /* Don't bind if tunnel_id is 0 */
 673         error = -EINVAL;
 674         if (tunnel_id == 0)
 675                 goto end;
 676
 677         tunnel = l2tp_tunnel_find(sock_net(sk), tunnel_id);
 678
 679         /* Special case: create tunnel context if session_id and
 680          * peer_session_id is 0. Otherwise look up tunnel using supplied
 681          * tunnel id.
 682          */
 683         if ((session_id == 0) && (peer_session_id == 0)) {
 684                 if (tunnel == NULL) {
 685                         struct l2tp_tunnel_cfg tcfg = {
 686                                 .encap = L2TP_ENCAPTYPE_UDP,
 687                                 .debug = 0,
 688                         };
 689                         error = l2tp_tunnel_create(sock_net(sk), fd, ver, tunnel_id, peer_tunnel_id, &tcfg, &tunnel);
 690                         if (error < 0)
 691                                 goto end;
 692                 }
 693         } else {
 694                 /* Error if we can't find the tunnel */
 695                 error = -ENOENT;
 696                 if (tunnel == NULL)
 697                         goto end;
 698
 699                 /* Error if socket is not prepped */
 700                 if (tunnel->sock == NULL)
 701                         goto end;
 702         }
 703
 704         if (tunnel->recv_payload_hook == NULL)
 705                 tunnel->recv_payload_hook = pppol2tp_recv_payload_hook;
 706
 707         if (tunnel->peer_tunnel_id == 0)
 708                 tunnel->peer_tunnel_id = peer_tunnel_id;
 709
 710         /* Create session if it doesn't already exist. We handle the
 711          * case where a session was previously created by the netlink
 712          * interface by checking that the session doesn't already have
 713          * a socket and its tunnel socket are what we expect. If any
 714          * of those checks fail, return EEXIST to the caller.
 715          */
 716         session = l2tp_session_find(sock_net(sk), tunnel, session_id);
 717         if (session == NULL) {
 718                 /* Default MTU must allow space for UDP/L2TP/PPP
 719                  * headers.
 720                  */
 721                 cfg.mtu = cfg.mru = 1500 - PPPOL2TP_HEADER_OVERHEAD;
 722
 723                 /* Allocate and initialize a new session context. */
 724                 session = l2tp_session_create(sizeof(struct pppol2tp_session),
 725                                               tunnel, session_id,
 726                                               peer_session_id, &cfg);
 727                 if (session == NULL) {
 728                         error = -ENOMEM;
 729                         goto end;
 730                 }
 731         } else {
 732                 ps = l2tp_session_priv(session);
 733                 error = -EEXIST;
 734                 if (ps->sock != NULL)
 735                         goto end;
 736
 737                 /* consistency checks */
 738                 if (ps->tunnel_sock != tunnel->sock)
 739                         goto end;
 740         }
 741
 742         /* Associate session with its PPPoL2TP socket */
 743         ps = l2tp_session_priv(session);
 744         ps->owner            = current->pid;
 745         ps->sock             = sk;
 746         ps->tunnel_sock = tunnel->sock;
 747
 748         session->recv_skb       = pppol2tp_recv;
 749         session->session_close  = pppol2tp_session_close;
 750 #if defined(CONFIG_L2TP_DEBUGFS) || defined(CONFIG_L2TP_DEBUGFS_MODULE)
 751         session->show           = pppol2tp_show;
 752 #endif
 753
 754         /* We need to know each time a skb is dropped from the reorder
 755          * queue.
 756          */
 757         session->ref = pppol2tp_session_sock_hold;
 758         session->deref = pppol2tp_session_sock_put;
 759
 760         /* If PMTU discovery was enabled, use the MTU that was discovered */
 761         dst = sk_dst_get(sk);
 762         if (dst != NULL) {
 763                 u32 pmtu = dst_mtu(__sk_dst_get(sk));
 764                 if (pmtu != 0)
 765                         session->mtu = session->mru = pmtu -
 766                                 PPPOL2TP_HEADER_OVERHEAD;
 767                 dst_release(dst);
 768         }
 769
 770         /* Special case: if source & dest session_id == 0x0000, this
 771          * socket is being created to manage the tunnel. Just set up
 772          * the internal context for use by ioctl() and sockopt()
 773          * handlers.
 774          */
 775         if ((session->session_id == 0) &&
 776             (session->peer_session_id == 0)) {
 777                 error = 0;
 778                 goto out_no_ppp;
 779         }
 780
 781         /* The only header we need to worry about is the L2TP
 782          * header. This size is different depending on whether
 783          * sequence numbers are enabled for the data channel.
 784          */
 785         po->chan.hdrlen = PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
 786
 787         po->chan.private = sk;
 788         po->chan.ops     = &pppol2tp_chan_ops;
 789         po->chan.mtu     = session->mtu;
 790
 791         error = ppp_register_net_channel(sock_net(sk), &po->chan);
 792         if (error)
 793                 goto end;
 794
 795 out_no_ppp:
 796         /* This is how we get the session context from the socket. */
 797         sk->sk_user_data = session;
 798         sk->sk_state = PPPOX_CONNECTED;
 799         l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: created\n",
 800                   session->name);
 801
 802 end:
 803         release_sock(sk);
 804
 805         return error;
 806 }
 807
 808 #ifdef CONFIG_L2TP_V3
 809
 810 /* Called when creating sessions via the netlink interface.
 811  */
 812 static int pppol2tp_session_create(struct net *net, u32 tunnel_id, u32 session_id, u32 peer_session_id, struct l2tp_session_cfg *cfg)
 813 {
 814         int error;
 815         struct l2tp_tunnel *tunnel;
 816         struct l2tp_session *session;
 817         struct pppol2tp_session *ps;
 818
 819         tunnel = l2tp_tunnel_find(net, tunnel_id);
 820
 821         /* Error if we can't find the tunnel */
 822         error = -ENOENT;
 823         if (tunnel == NULL)
 824                 goto out;
 825
 826         /* Error if tunnel socket is not prepped */
 827         if (tunnel->sock == NULL)
 828                 goto out;
 829
 830         /* Check that this session doesn't already exist */
 831         error = -EEXIST;
 832         session = l2tp_session_find(net, tunnel, session_id);
 833         if (session != NULL)
 834                 goto out;
 835
 836         /* Default MTU values. */
 837         if (cfg->mtu == 0)
 838                 cfg->mtu = 1500 - PPPOL2TP_HEADER_OVERHEAD;
 839         if (cfg->mru == 0)
 840                 cfg->mru = cfg->mtu;
 841
 842         /* Allocate and initialize a new session context. */
 843         error = -ENOMEM;
 844         session = l2tp_session_create(sizeof(struct pppol2tp_session),
 845                                       tunnel, session_id,
 846                                       peer_session_id, cfg);
 847         if (session == NULL)
 848                 goto out;
 849
 850         ps = l2tp_session_priv(session);
 851         ps->tunnel_sock = tunnel->sock;
 852
 853         l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: created\n",
 854                   session->name);
 855
 856         error = 0;
 857
 858 out:
 859         return error;
 860 }
 861
 862 #endif /* CONFIG_L2TP_V3 */
 863
 864 /* getname() support.
 865  */
 866 static int pppol2tp_getname(struct socket *sock, struct sockaddr *uaddr,
 867                             int *usockaddr_len, int peer)
 868 {
 869         int len = 0;
 870         int error = 0;
 871         struct l2tp_session *session;
 872         struct l2tp_tunnel *tunnel;
 873         struct sock *sk = sock->sk;
 874         struct inet_sock *inet;
 875         struct pppol2tp_session *pls;
 876
 877         error = -ENOTCONN;
 878         if (sk == NULL)
 879                 goto end;
 880         if (sk->sk_state != PPPOX_CONNECTED)
 881                 goto end;
 882
 883         error = -EBADF;
 884         session = pppol2tp_sock_to_session(sk);
 885         if (session == NULL)
 886                 goto end;
 887
 888         pls = l2tp_session_priv(session);
 889         tunnel = l2tp_sock_to_tunnel(pls->tunnel_sock);
 890         if (tunnel == NULL) {
 891                 error = -EBADF;
 892                 goto end_put_sess;
 893         }
 894
 895         inet = inet_sk(tunnel->sock);
 896         if ((tunnel->version == 2) && (tunnel->sock->sk_family == AF_INET)) {
 897                 struct sockaddr_pppol2tp sp;
 898                 len = sizeof(sp);
 899                 memset(&sp, 0, len);
 900                 sp.sa_family    = AF_PPPOX;
 901                 sp.sa_protocol  = PX_PROTO_OL2TP;
 902                 sp.pppol2tp.fd  = tunnel->fd;
 903                 sp.pppol2tp.pid = pls->owner;
 904                 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
 905                 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
 906                 sp.pppol2tp.s_session = session->session_id;
 907                 sp.pppol2tp.d_session = session->peer_session_id;
 908                 sp.pppol2tp.addr.sin_family = AF_INET;
 909                 sp.pppol2tp.addr.sin_port = inet->inet_dport;
 910                 sp.pppol2tp.addr.sin_addr.s_addr = inet->inet_daddr;
 911                 memcpy(uaddr, &sp, len);
 912 #if IS_ENABLED(CONFIG_IPV6)
 913         } else if ((tunnel->version == 2) &&
 914                    (tunnel->sock->sk_family == AF_INET6)) {
 915                 struct ipv6_pinfo *np = inet6_sk(tunnel->sock);
 916                 struct sockaddr_pppol2tpin6 sp;
 917                 len = sizeof(sp);
 918                 memset(&sp, 0, len);
 919                 sp.sa_family    = AF_PPPOX;
 920                 sp.sa_protocol  = PX_PROTO_OL2TP;
 921                 sp.pppol2tp.fd  = tunnel->fd;
 922                 sp.pppol2tp.pid = pls->owner;
 923                 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
 924                 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
 925                 sp.pppol2tp.s_session = session->session_id;
 926                 sp.pppol2tp.d_session = session->peer_session_id;
 927                 sp.pppol2tp.addr.sin6_family = AF_INET6;
 928                 sp.pppol2tp.addr.sin6_port = inet->inet_dport;
 929                 memcpy(&sp.pppol2tp.addr.sin6_addr, &np->daddr,
 930                        sizeof(np->daddr));
 931                 memcpy(uaddr, &sp, len);
 932         } else if ((tunnel->version == 3) &&
 933                    (tunnel->sock->sk_family == AF_INET6)) {
 934                 struct ipv6_pinfo *np = inet6_sk(tunnel->sock);
 935                 struct sockaddr_pppol2tpv3in6 sp;
 936                 len = sizeof(sp);
 937                 memset(&sp, 0, len);
 938                 sp.sa_family    = AF_PPPOX;
 939                 sp.sa_protocol  = PX_PROTO_OL2TP;
 940                 sp.pppol2tp.fd  = tunnel->fd;
 941                 sp.pppol2tp.pid = pls->owner;
 942                 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
 943                 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
 944                 sp.pppol2tp.s_session = session->session_id;
 945                 sp.pppol2tp.d_session = session->peer_session_id;
 946                 sp.pppol2tp.addr.sin6_family = AF_INET6;
 947                 sp.pppol2tp.addr.sin6_port = inet->inet_dport;
 948                 memcpy(&sp.pppol2tp.addr.sin6_addr, &np->daddr,
 949                        sizeof(np->daddr));
 950                 memcpy(uaddr, &sp, len);
 951 #endif
 952         } else if (tunnel->version == 3) {
 953                 struct sockaddr_pppol2tpv3 sp;
 954                 len = sizeof(sp);
 955                 memset(&sp, 0, len);
 956                 sp.sa_family    = AF_PPPOX;
 957                 sp.sa_protocol  = PX_PROTO_OL2TP;
 958                 sp.pppol2tp.fd  = tunnel->fd;
 959                 sp.pppol2tp.pid = pls->owner;
 960                 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
 961                 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
 962                 sp.pppol2tp.s_session = session->session_id;
 963                 sp.pppol2tp.d_session = session->peer_session_id;
 964                 sp.pppol2tp.addr.sin_family = AF_INET;
 965                 sp.pppol2tp.addr.sin_port = inet->inet_dport;
 966                 sp.pppol2tp.addr.sin_addr.s_addr = inet->inet_daddr;
 967                 memcpy(uaddr, &sp, len);
 968         }
 969
 970         *usockaddr_len = len;
 971
 972         sock_put(pls->tunnel_sock);
 973 end_put_sess:
 974         sock_put(sk);
 975         error = 0;
 976
 977 end:
 978         return error;
 979 }
 980
 981 /****************************************************************************
 982  * ioctl() handlers.
 983  *
 984  * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
 985  * sockets. However, in order to control kernel tunnel features, we allow
 986  * userspace to create a special "tunnel" PPPoX socket which is used for
 987  * control only.  Tunnel PPPoX sockets have session_id == 0 and simply allow
 988  * the user application to issue L2TP setsockopt(), getsockopt() and ioctl()
 989  * calls.
 990  ****************************************************************************/
 991
 992 static void pppol2tp_copy_stats(struct pppol2tp_ioc_stats *dest,
 993                                 struct l2tp_stats *stats)
 994 {
 995         dest->tx_packets = atomic_long_read(&stats->tx_packets);
 996         dest->tx_bytes = atomic_long_read(&stats->tx_bytes);
 997         dest->tx_errors = atomic_long_read(&stats->tx_errors);
 998         dest->rx_packets = atomic_long_read(&stats->rx_packets);
 999         dest->rx_bytes = atomic_long_read(&stats->rx_bytes);
1000         dest->rx_seq_discards = atomic_long_read(&stats->rx_seq_discards);
1001         dest->rx_oos_packets = atomic_long_read(&stats->rx_oos_packets);
1002         dest->rx_errors = atomic_long_read(&stats->rx_errors);
1003 }
1004
1005 /* Session ioctl helper.
1006  */
1007 static int pppol2tp_session_ioctl(struct l2tp_session *session,
1008                                   unsigned int cmd, unsigned long arg)
1009 {
1010         struct ifreq ifr;
1011         int err = 0;
1012         struct sock *sk;
1013         int val = (int) arg;
1014         struct pppol2tp_session *ps = l2tp_session_priv(session);
1015         struct l2tp_tunnel *tunnel = session->tunnel;
1016         struct pppol2tp_ioc_stats stats;
1017
1018         l2tp_dbg(session, PPPOL2TP_MSG_CONTROL,
1019                  "%s: pppol2tp_session_ioctl(cmd=%#x, arg=%#lx)\n",
1020                  session->name, cmd, arg);
1021
1022         sk = ps->sock;
1023         sock_hold(sk);
1024
1025         switch (cmd) {
1026         case SIOCGIFMTU:
1027                 err = -ENXIO;
1028                 if (!(sk->sk_state & PPPOX_CONNECTED))
1029                         break;
1030
1031                 err = -EFAULT;
1032                 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1033                         break;
1034                 ifr.ifr_mtu = session->mtu;
1035                 if (copy_to_user((void __user *) arg, &ifr, sizeof(struct ifreq)))
1036                         break;
1037
1038                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: get mtu=%d\n",
1039                           session->name, session->mtu);
1040                 err = 0;
1041                 break;
1042
1043         case SIOCSIFMTU:
1044                 err = -ENXIO;
1045                 if (!(sk->sk_state & PPPOX_CONNECTED))
1046                         break;
1047
1048                 err = -EFAULT;
1049                 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1050                         break;
1051
1052                 session->mtu = ifr.ifr_mtu;
1053
1054                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: set mtu=%d\n",
1055                           session->name, session->mtu);
1056                 err = 0;
1057                 break;
1058
1059         case PPPIOCGMRU:
1060                 err = -ENXIO;
1061                 if (!(sk->sk_state & PPPOX_CONNECTED))
1062                         break;
1063
1064                 err = -EFAULT;
1065                 if (put_user(session->mru, (int __user *) arg))
1066                         break;
1067
1068                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: get mru=%d\n",
1069                           session->name, session->mru);
1070                 err = 0;
1071                 break;
1072
1073         case PPPIOCSMRU:
1074                 err = -ENXIO;
1075                 if (!(sk->sk_state & PPPOX_CONNECTED))
1076                         break;
1077
1078                 err = -EFAULT;
1079                 if (get_user(val, (int __user *) arg))
1080                         break;
1081
1082                 session->mru = val;
1083                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: set mru=%d\n",
1084                           session->name, session->mru);
1085                 err = 0;
1086                 break;
1087
1088         case PPPIOCGFLAGS:
1089                 err = -EFAULT;
1090                 if (put_user(ps->flags, (int __user *) arg))
1091                         break;
1092
1093                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: get flags=%d\n",
1094                           session->name, ps->flags);
1095                 err = 0;
1096                 break;
1097
1098         case PPPIOCSFLAGS:
1099                 err = -EFAULT;
1100                 if (get_user(val, (int __user *) arg))
1101                         break;
1102                 ps->flags = val;
1103                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: set flags=%d\n",
1104                           session->name, ps->flags);
1105                 err = 0;
1106                 break;
1107
1108         case PPPIOCGL2TPSTATS:
1109                 err = -ENXIO;
1110                 if (!(sk->sk_state & PPPOX_CONNECTED))
1111                         break;
1112
1113                 memset(&stats, 0, sizeof(stats));
1114                 stats.tunnel_id = tunnel->tunnel_id;
1115                 stats.session_id = session->session_id;
1116                 pppol2tp_copy_stats(&stats, &session->stats);
1117                 if (copy_to_user((void __user *) arg, &stats,
1118                                  sizeof(stats)))
1119                         break;
1120                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: get L2TP stats\n",
1121                           session->name);
1122                 err = 0;
1123                 break;
1124
1125         default:
1126                 err = -ENOSYS;
1127                 break;
1128         }
1129
1130         sock_put(sk);
1131
1132         return err;
1133 }
1134
1135 /* Tunnel ioctl helper.
1136  *
1137  * Note the special handling for PPPIOCGL2TPSTATS below. If the ioctl data
1138  * specifies a session_id, the session ioctl handler is called. This allows an
1139  * application to retrieve session stats via a tunnel socket.
1140  */
1141 static int pppol2tp_tunnel_ioctl(struct l2tp_tunnel *tunnel,
1142                                  unsigned int cmd, unsigned long arg)
1143 {
1144         int err = 0;
1145         struct sock *sk;
1146         struct pppol2tp_ioc_stats stats;
1147
1148         l2tp_dbg(tunnel, PPPOL2TP_MSG_CONTROL,
1149                  "%s: pppol2tp_tunnel_ioctl(cmd=%#x, arg=%#lx)\n",
1150                  tunnel->name, cmd, arg);
1151
1152         sk = tunnel->sock;
1153         sock_hold(sk);
1154
1155         switch (cmd) {
1156         case PPPIOCGL2TPSTATS:
1157                 err = -ENXIO;
1158                 if (!(sk->sk_state & PPPOX_CONNECTED))
1159                         break;
1160
1161                 if (copy_from_user(&stats, (void __user *) arg,
1162                                    sizeof(stats))) {
1163                         err = -EFAULT;
1164                         break;
1165                 }
1166                 if (stats.session_id != 0) {
1167                         /* resend to session ioctl handler */
1168                         struct l2tp_session *session =
1169                                 l2tp_session_find(sock_net(sk), tunnel, stats.session_id);
1170                         if (session != NULL)
1171                                 err = pppol2tp_session_ioctl(session, cmd, arg);
1172                         else
1173                                 err = -EBADR;
1174                         break;
1175                 }
1176 #ifdef CONFIG_XFRM
1177                 stats.using_ipsec = (sk->sk_policy[0] || sk->sk_policy[1]) ? 1 : 0;
1178 #endif
1179                 pppol2tp_copy_stats(&stats, &tunnel->stats);
1180                 if (copy_to_user((void __user *) arg, &stats, sizeof(stats))) {
1181                         err = -EFAULT;
1182                         break;
1183                 }
1184                 l2tp_info(tunnel, PPPOL2TP_MSG_CONTROL, "%s: get L2TP stats\n",
1185                           tunnel->name);
1186                 err = 0;
1187                 break;
1188
1189         default:
1190                 err = -ENOSYS;
1191                 break;
1192         }
1193
1194         sock_put(sk);
1195
1196         return err;
1197 }
1198
1199 /* Main ioctl() handler.
1200  * Dispatch to tunnel or session helpers depending on the socket.
1201  */
1202 static int pppol2tp_ioctl(struct socket *sock, unsigned int cmd,
1203                           unsigned long arg)
1204 {
1205         struct sock *sk = sock->sk;
1206         struct l2tp_session *session;
1207         struct l2tp_tunnel *tunnel;
1208         struct pppol2tp_session *ps;
1209         int err;
1210
1211         if (!sk)
1212                 return 0;
1213
1214         err = -EBADF;
1215         if (sock_flag(sk, SOCK_DEAD) != 0)
1216                 goto end;
1217
1218         err = -ENOTCONN;
1219         if ((sk->sk_user_data == NULL) ||
1220             (!(sk->sk_state & (PPPOX_CONNECTED | PPPOX_BOUND))))
1221                 goto end;
1222
1223         /* Get session context from the socket */
1224         err = -EBADF;
1225         session = pppol2tp_sock_to_session(sk);
1226         if (session == NULL)
1227                 goto end;
1228
1229         /* Special case: if session's session_id is zero, treat ioctl as a
1230          * tunnel ioctl
1231          */
1232         ps = l2tp_session_priv(session);
1233         if ((session->session_id == 0) &&
1234             (session->peer_session_id == 0)) {
1235                 err = -EBADF;
1236                 tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
1237                 if (tunnel == NULL)
1238                         goto end_put_sess;
1239
1240                 err = pppol2tp_tunnel_ioctl(tunnel, cmd, arg);
1241                 sock_put(ps->tunnel_sock);
1242                 goto end_put_sess;
1243         }
1244
1245         err = pppol2tp_session_ioctl(session, cmd, arg);
1246
1247 end_put_sess:
1248         sock_put(sk);
1249 end:
1250         return err;
1251 }
1252
1253 /*****************************************************************************
1254  * setsockopt() / getsockopt() support.
1255  *
1256  * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1257  * sockets. In order to control kernel tunnel features, we allow userspace to
1258  * create a special "tunnel" PPPoX socket which is used for control only.
1259  * Tunnel PPPoX sockets have session_id == 0 and simply allow the user
1260  * application to issue L2TP setsockopt(), getsockopt() and ioctl() calls.
1261  *****************************************************************************/
1262
1263 /* Tunnel setsockopt() helper.
1264  */
1265 static int pppol2tp_tunnel_setsockopt(struct sock *sk,
1266                                       struct l2tp_tunnel *tunnel,
1267                                       int optname, int val)
1268 {
1269         int err = 0;
1270
1271         switch (optname) {
1272         case PPPOL2TP_SO_DEBUG:
1273                 tunnel->debug = val;
1274                 l2tp_info(tunnel, PPPOL2TP_MSG_CONTROL, "%s: set debug=%x\n",
1275                           tunnel->name, tunnel->debug);
1276                 break;
1277
1278         default:
1279                 err = -ENOPROTOOPT;
1280                 break;
1281         }
1282
1283         return err;
1284 }
1285
1286 /* Session setsockopt helper.
1287  */
1288 static int pppol2tp_session_setsockopt(struct sock *sk,
1289                                        struct l2tp_session *session,
1290                                        int optname, int val)
1291 {
1292         int err = 0;
1293         struct pppol2tp_session *ps = l2tp_session_priv(session);
1294
1295         switch (optname) {
1296         case PPPOL2TP_SO_RECVSEQ:
1297                 if ((val != 0) && (val != 1)) {
1298                         err = -EINVAL;
1299                         break;
1300                 }
1301                 session->recv_seq = val ? -1 : 0;
1302                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1303                           "%s: set recv_seq=%d\n",
1304                           session->name, session->recv_seq);
1305                 break;
1306
1307         case PPPOL2TP_SO_SENDSEQ:
1308                 if ((val != 0) && (val != 1)) {
1309                         err = -EINVAL;
1310                         break;
1311                 }
1312                 session->send_seq = val ? -1 : 0;
1313                 {
1314                         struct sock *ssk      = ps->sock;
1315                         struct pppox_sock *po = pppox_sk(ssk);
1316                         po->chan.hdrlen = val ? PPPOL2TP_L2TP_HDR_SIZE_SEQ :
1317                                 PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
1318                 }
1319                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1320                           "%s: set send_seq=%d\n",
1321                           session->name, session->send_seq);
1322                 break;
1323
1324         case PPPOL2TP_SO_LNSMODE:
1325                 if ((val != 0) && (val != 1)) {
1326                         err = -EINVAL;
1327                         break;
1328                 }
1329                 session->lns_mode = val ? -1 : 0;
1330                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1331                           "%s: set lns_mode=%d\n",
1332                           session->name, session->lns_mode);
1333                 break;
1334
1335         case PPPOL2TP_SO_DEBUG:
1336                 session->debug = val;
1337                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: set debug=%x\n",
1338                           session->name, session->debug);
1339                 break;
1340
1341         case PPPOL2TP_SO_REORDERTO:
1342                 session->reorder_timeout = msecs_to_jiffies(val);
1343                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1344                           "%s: set reorder_timeout=%d\n",
1345                           session->name, session->reorder_timeout);
1346                 break;
1347
1348         default:
1349                 err = -ENOPROTOOPT;
1350                 break;
1351         }
1352
1353         return err;
1354 }
1355
1356 /* Main setsockopt() entry point.
1357  * Does API checks, then calls either the tunnel or session setsockopt
1358  * handler, according to whether the PPPoL2TP socket is a for a regular
1359  * session or the special tunnel type.
1360  */
1361 static int pppol2tp_setsockopt(struct socket *sock, int level, int optname,
1362                                char __user *optval, unsigned int optlen)
1363 {
1364         struct sock *sk = sock->sk;
1365         struct l2tp_session *session;
1366         struct l2tp_tunnel *tunnel;
1367         struct pppol2tp_session *ps;
1368         int val;
1369         int err;
1370
1371         if (level != SOL_PPPOL2TP)
1372                 return udp_prot.setsockopt(sk, level, optname, optval, optlen);
1373
1374         if (optlen < sizeof(int))
1375                 return -EINVAL;
1376
1377         if (get_user(val, (int __user *)optval))
1378                 return -EFAULT;
1379
1380         err = -ENOTCONN;
1381         if (sk->sk_user_data == NULL)
1382                 goto end;
1383
1384         /* Get session context from the socket */
1385         err = -EBADF;
1386         session = pppol2tp_sock_to_session(sk);
1387         if (session == NULL)
1388                 goto end;
1389
1390         /* Special case: if session_id == 0x0000, treat as operation on tunnel
1391          */
1392         ps = l2tp_session_priv(session);
1393         if ((session->session_id == 0) &&
1394             (session->peer_session_id == 0)) {
1395                 err = -EBADF;
1396                 tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
1397                 if (tunnel == NULL)
1398                         goto end_put_sess;
1399
1400                 err = pppol2tp_tunnel_setsockopt(sk, tunnel, optname, val);
1401                 sock_put(ps->tunnel_sock);
1402         } else
1403                 err = pppol2tp_session_setsockopt(sk, session, optname, val);
1404
1405         err = 0;
1406
1407 end_put_sess:
1408         sock_put(sk);
1409 end:
1410         return err;
1411 }
1412
1413 /* Tunnel getsockopt helper. Called with sock locked.
1414  */
1415 static int pppol2tp_tunnel_getsockopt(struct sock *sk,
1416                                       struct l2tp_tunnel *tunnel,
1417                                       int optname, int *val)
1418 {
1419         int err = 0;
1420
1421         switch (optname) {
1422         case PPPOL2TP_SO_DEBUG:
1423                 *val = tunnel->debug;
1424                 l2tp_info(tunnel, PPPOL2TP_MSG_CONTROL, "%s: get debug=%x\n",
1425                           tunnel->name, tunnel->debug);
1426                 break;
1427
1428         default:
1429                 err = -ENOPROTOOPT;
1430                 break;
1431         }
1432
1433         return err;
1434 }
1435
1436 /* Session getsockopt helper. Called with sock locked.
1437  */
1438 static int pppol2tp_session_getsockopt(struct sock *sk,
1439                                        struct l2tp_session *session,
1440                                        int optname, int *val)
1441 {
1442         int err = 0;
1443
1444         switch (optname) {
1445         case PPPOL2TP_SO_RECVSEQ:
1446                 *val = session->recv_seq;
1447                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1448                           "%s: get recv_seq=%d\n", session->name, *val);
1449                 break;
1450
1451         case PPPOL2TP_SO_SENDSEQ:
1452                 *val = session->send_seq;
1453                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1454                           "%s: get send_seq=%d\n", session->name, *val);
1455                 break;
1456
1457         case PPPOL2TP_SO_LNSMODE:
1458                 *val = session->lns_mode;
1459                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1460                           "%s: get lns_mode=%d\n", session->name, *val);
1461                 break;
1462
1463         case PPPOL2TP_SO_DEBUG:
1464                 *val = session->debug;
1465                 l2tp_info(session, PPPOL2TP_MSG_CONTROL, "%s: get debug=%d\n",
1466                           session->name, *val);
1467                 break;
1468
1469         case PPPOL2TP_SO_REORDERTO:
1470                 *val = (int) jiffies_to_msecs(session->reorder_timeout);
1471                 l2tp_info(session, PPPOL2TP_MSG_CONTROL,
1472                           "%s: get reorder_timeout=%d\n", session->name, *val);
1473                 break;
1474
1475         default:
1476                 err = -ENOPROTOOPT;
1477         }
1478
1479         return err;
1480 }
1481
1482 /* Main getsockopt() entry point.
1483  * Does API checks, then calls either the tunnel or session getsockopt
1484  * handler, according to whether the PPPoX socket is a for a regular session
1485  * or the special tunnel type.
1486  */
1487 static int pppol2tp_getsockopt(struct socket *sock, int level, int optname,
1488                                char __user *optval, int __user *optlen)
1489 {
1490         struct sock *sk = sock->sk;
1491         struct l2tp_session *session;
1492         struct l2tp_tunnel *tunnel;
1493         int val, len;
1494         int err;
1495         struct pppol2tp_session *ps;
1496
1497         if (level != SOL_PPPOL2TP)
1498                 return udp_prot.getsockopt(sk, level, optname, optval, optlen);
1499
1500         if (get_user(len, optlen))
1501                 return -EFAULT;
1502
1503         len = min_t(unsigned int, len, sizeof(int));
1504
1505         if (len < 0)
1506                 return -EINVAL;
1507
1508         err = -ENOTCONN;
1509         if (sk->sk_user_data == NULL)
1510                 goto end;
1511
1512         /* Get the session context */
1513         err = -EBADF;
1514         session = pppol2tp_sock_to_session(sk);
1515         if (session == NULL)
1516                 goto end;
1517
1518         /* Special case: if session_id == 0x0000, treat as operation on tunnel */
1519         ps = l2tp_session_priv(session);
1520         if ((session->session_id == 0) &&
1521             (session->peer_session_id == 0)) {
1522                 err = -EBADF;
1523                 tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
1524                 if (tunnel == NULL)
1525                         goto end_put_sess;
1526
1527                 err = pppol2tp_tunnel_getsockopt(sk, tunnel, optname, &val);
1528                 sock_put(ps->tunnel_sock);
1529         } else
1530                 err = pppol2tp_session_getsockopt(sk, session, optname, &val);
1531
1532         err = -EFAULT;
1533         if (put_user(len, optlen))
1534                 goto end_put_sess;
1535
1536         if (copy_to_user((void __user *) optval, &val, len))
1537                 goto end_put_sess;
1538
1539         err = 0;
1540
1541 end_put_sess:
1542         sock_put(sk);
1543 end:
1544         return err;
1545 }
1546
1547 /*****************************************************************************
1548  * /proc filesystem for debug
1549  * Since the original pppol2tp driver provided /proc/net/pppol2tp for
1550  * L2TPv2, we dump only L2TPv2 tunnels and sessions here.
1551  *****************************************************************************/
1552
1553 static unsigned int pppol2tp_net_id;
1554
1555 #ifdef CONFIG_PROC_FS
1556
1557 struct pppol2tp_seq_data {
1558         struct seq_net_private p;
1559         int tunnel_idx;                 /* current tunnel */
1560         int session_idx;                /* index of session within current tunnel */
1561         struct l2tp_tunnel *tunnel;
1562         struct l2tp_session *session;   /* NULL means get next tunnel */
1563 };
1564
1565 static void pppol2tp_next_tunnel(struct net *net, struct pppol2tp_seq_data *pd)
1566 {
1567         for (;;) {
1568                 pd->tunnel = l2tp_tunnel_find_nth(net, pd->tunnel_idx);
1569                 pd->tunnel_idx++;
1570
1571                 if (pd->tunnel == NULL)
1572                         break;
1573
1574                 /* Ignore L2TPv3 tunnels */
1575                 if (pd->tunnel->version < 3)
1576                         break;
1577         }
1578 }
1579
1580 static void pppol2tp_next_session(struct net *net, struct pppol2tp_seq_data *pd)
1581 {
1582         pd->session = l2tp_session_find_nth(pd->tunnel, pd->session_idx);
1583         pd->session_idx++;
1584
1585         if (pd->session == NULL) {
1586                 pd->session_idx = 0;
1587                 pppol2tp_next_tunnel(net, pd);
1588         }
1589 }
1590
1591 static void *pppol2tp_seq_start(struct seq_file *m, loff_t *offs)
1592 {
1593         struct pppol2tp_seq_data *pd = SEQ_START_TOKEN;
1594         loff_t pos = *offs;
1595         struct net *net;
1596
1597         if (!pos)
1598                 goto out;
1599
1600         BUG_ON(m->private == NULL);
1601         pd = m->private;
1602         net = seq_file_net(m);
1603
1604         if (pd->tunnel == NULL)
1605                 pppol2tp_next_tunnel(net, pd);
1606         else
1607                 pppol2tp_next_session(net, pd);
1608
1609         /* NULL tunnel and session indicates end of list */
1610         if ((pd->tunnel == NULL) && (pd->session == NULL))
1611                 pd = NULL;
1612
1613 out:
1614         return pd;
1615 }
1616
1617 static void *pppol2tp_seq_next(struct seq_file *m, void *v, loff_t *pos)
1618 {
1619         (*pos)++;
1620         return NULL;
1621 }
1622
1623 static void pppol2tp_seq_stop(struct seq_file *p, void *v)
1624 {
1625         /* nothing to do */
1626 }
1627
1628 static void pppol2tp_seq_tunnel_show(struct seq_file *m, void *v)
1629 {
1630         struct l2tp_tunnel *tunnel = v;
1631
1632         seq_printf(m, "\nTUNNEL '%s', %c %d\n",
1633                    tunnel->name,
1634                    (tunnel == tunnel->sock->sk_user_data) ? 'Y' : 'N',
1635                    atomic_read(&tunnel->ref_count) - 1);
1636         seq_printf(m, " %08x %ld/%ld/%ld %ld/%ld/%ld\n",
1637                    tunnel->debug,
1638                    atomic_long_read(&tunnel->stats.tx_packets),
1639                    atomic_long_read(&tunnel->stats.tx_bytes),
1640                    atomic_long_read(&tunnel->stats.tx_errors),
1641                    atomic_long_read(&tunnel->stats.rx_packets),
1642                    atomic_long_read(&tunnel->stats.rx_bytes),
1643                    atomic_long_read(&tunnel->stats.rx_errors));
1644 }
1645
1646 static void pppol2tp_seq_session_show(struct seq_file *m, void *v)
1647 {
1648         struct l2tp_session *session = v;
1649         struct l2tp_tunnel *tunnel = session->tunnel;
1650         struct pppol2tp_session *ps = l2tp_session_priv(session);
1651         struct pppox_sock *po = pppox_sk(ps->sock);
1652         u32 ip = 0;
1653         u16 port = 0;
1654
1655         if (tunnel->sock) {
1656                 struct inet_sock *inet = inet_sk(tunnel->sock);
1657                 ip = ntohl(inet->inet_saddr);
1658                 port = ntohs(inet->inet_sport);
1659         }
1660
1661         seq_printf(m, "  SESSION '%s' %08X/%d %04X/%04X -> "
1662                    "%04X/%04X %d %c\n",
1663                    session->name, ip, port,
1664                    tunnel->tunnel_id,
1665                    session->session_id,
1666                    tunnel->peer_tunnel_id,
1667                    session->peer_session_id,
1668                    ps->sock->sk_state,
1669                    (session == ps->sock->sk_user_data) ?
1670                    'Y' : 'N');
1671         seq_printf(m, "   %d/%d/%c/%c/%s %08x %u\n",
1672                    session->mtu, session->mru,
1673                    session->recv_seq ? 'R' : '-',
1674                    session->send_seq ? 'S' : '-',
1675                    session->lns_mode ? "LNS" : "LAC",
1676                    session->debug,
1677                    jiffies_to_msecs(session->reorder_timeout));
1678         seq_printf(m, "   %hu/%hu %ld/%ld/%ld %ld/%ld/%ld\n",
1679                    session->nr, session->ns,
1680                    atomic_long_read(&session->stats.tx_packets),
1681                    atomic_long_read(&session->stats.tx_bytes),
1682                    atomic_long_read(&session->stats.tx_errors),
1683                    atomic_long_read(&session->stats.rx_packets),
1684                    atomic_long_read(&session->stats.rx_bytes),
1685                    atomic_long_read(&session->stats.rx_errors));
1686
1687         if (po)
1688                 seq_printf(m, "   interface %s\n", ppp_dev_name(&po->chan));
1689 }
1690
1691 static int pppol2tp_seq_show(struct seq_file *m, void *v)
1692 {
1693         struct pppol2tp_seq_data *pd = v;
1694
1695         /* display header on line 1 */
1696         if (v == SEQ_START_TOKEN) {
1697                 seq_puts(m, "PPPoL2TP driver info, " PPPOL2TP_DRV_VERSION "\n");
1698                 seq_puts(m, "TUNNEL name, user-data-ok session-count\n");
1699                 seq_puts(m, " debug tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
1700                 seq_puts(m, "  SESSION name, addr/port src-tid/sid "
1701                          "dest-tid/sid state user-data-ok\n");
1702                 seq_puts(m, "   mtu/mru/rcvseq/sendseq/lns debug reorderto\n");
1703                 seq_puts(m, "   nr/ns tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
1704                 goto out;
1705         }
1706
1707         /* Show the tunnel or session context.
1708          */
1709         if (pd->session == NULL)
1710                 pppol2tp_seq_tunnel_show(m, pd->tunnel);
1711         else
1712                 pppol2tp_seq_session_show(m, pd->session);
1713
1714 out:
1715         return 0;
1716 }
1717
1718 static const struct seq_operations pppol2tp_seq_ops = {
1719         .start          = pppol2tp_seq_start,
1720         .next           = pppol2tp_seq_next,
1721         .stop           = pppol2tp_seq_stop,
1722         .show           = pppol2tp_seq_show,
1723 };
1724
1725 /* Called when our /proc file is opened. We allocate data for use when
1726  * iterating our tunnel / session contexts and store it in the private
1727  * data of the seq_file.
1728  */
1729 static int pppol2tp_proc_open(struct inode *inode, struct file *file)
1730 {
1731         return seq_open_net(inode, file, &pppol2tp_seq_ops,
1732                             sizeof(struct pppol2tp_seq_data));
1733 }
1734
1735 static const struct file_operations pppol2tp_proc_fops = {
1736         .owner          = THIS_MODULE,
1737         .open           = pppol2tp_proc_open,
1738         .read           = seq_read,
1739         .llseek         = seq_lseek,
1740         .release        = seq_release_net,
1741 };
1742
1743 #endif /* CONFIG_PROC_FS */
1744
1745 /*****************************************************************************
1746  * Network namespace
1747  *****************************************************************************/
1748
1749 static __net_init int pppol2tp_init_net(struct net *net)
1750 {
1751         struct proc_dir_entry *pde;
1752         int err = 0;
1753
1754         pde = proc_create("pppol2tp", S_IRUGO, net->proc_net,
1755                           &pppol2tp_proc_fops);
1756         if (!pde) {
1757                 err = -ENOMEM;
1758                 goto out;
1759         }
1760
1761 out:
1762         return err;
1763 }
1764
1765 static __net_exit void pppol2tp_exit_net(struct net *net)
1766 {
1767         remove_proc_entry("pppol2tp", net->proc_net);
1768 }
1769
1770 static struct pernet_operations pppol2tp_net_ops = {
1771         .init = pppol2tp_init_net,
1772         .exit = pppol2tp_exit_net,
1773         .id   = &pppol2tp_net_id,
1774 };
1775
1776 /*****************************************************************************
1777  * Init and cleanup
1778  *****************************************************************************/
1779
1780 static const struct proto_ops pppol2tp_ops = {
1781         .family         = AF_PPPOX,
1782         .owner          = THIS_MODULE,
1783         .release        = pppol2tp_release,
1784         .bind           = sock_no_bind,
1785         .connect        = pppol2tp_connect,
1786         .socketpair     = sock_no_socketpair,
1787         .accept         = sock_no_accept,
1788         .getname        = pppol2tp_getname,
1789         .poll           = datagram_poll,
1790         .listen         = sock_no_listen,
1791         .shutdown       = sock_no_shutdown,
1792         .setsockopt     = pppol2tp_setsockopt,
1793         .getsockopt     = pppol2tp_getsockopt,
1794         .sendmsg        = pppol2tp_sendmsg,
1795         .recvmsg        = pppol2tp_recvmsg,
1796         .mmap           = sock_no_mmap,
1797         .ioctl          = pppox_ioctl,
1798 };
1799
1800 static const struct pppox_proto pppol2tp_proto = {
1801         .create         = pppol2tp_create,
1802         .ioctl          = pppol2tp_ioctl
1803 };
1804
1805 #ifdef CONFIG_L2TP_V3
1806
1807 static const struct l2tp_nl_cmd_ops pppol2tp_nl_cmd_ops = {
1808         .session_create = pppol2tp_session_create,
1809         .session_delete = l2tp_session_delete,
1810 };
1811
1812 #endif /* CONFIG_L2TP_V3 */
1813
1814 static int __init pppol2tp_init(void)
1815 {
1816         int err;
1817
1818         err = register_pernet_device(&pppol2tp_net_ops);
1819         if (err)
1820                 goto out;
1821
1822         err = proto_register(&pppol2tp_sk_proto, 0);
1823         if (err)
1824                 goto out_unregister_pppol2tp_pernet;
1825
1826         err = register_pppox_proto(PX_PROTO_OL2TP, &pppol2tp_proto);
1827         if (err)
1828                 goto out_unregister_pppol2tp_proto;
1829
1830 #ifdef CONFIG_L2TP_V3
1831         err = l2tp_nl_register_ops(L2TP_PWTYPE_PPP, &pppol2tp_nl_cmd_ops);
1832         if (err)
1833                 goto out_unregister_pppox;
1834 #endif
1835
1836         pr_info("PPPoL2TP kernel driver, %s\n", PPPOL2TP_DRV_VERSION);
1837
1838 out:
1839         return err;
1840
1841 #ifdef CONFIG_L2TP_V3
1842 out_unregister_pppox:
1843         unregister_pppox_proto(PX_PROTO_OL2TP);
1844 #endif
1845 out_unregister_pppol2tp_proto:
1846         proto_unregister(&pppol2tp_sk_proto);
1847 out_unregister_pppol2tp_pernet:
1848         unregister_pernet_device(&pppol2tp_net_ops);
1849         goto out;
1850 }
1851
1852 static void __exit pppol2tp_exit(void)
1853 {
1854 #ifdef CONFIG_L2TP_V3
1855         l2tp_nl_unregister_ops(L2TP_PWTYPE_PPP);
1856 #endif
1857         unregister_pppox_proto(PX_PROTO_OL2TP);
1858         proto_unregister(&pppol2tp_sk_proto);
1859         unregister_pernet_device(&pppol2tp_net_ops);
1860 }
1861
1862 module_init(pppol2tp_init);
1863 module_exit(pppol2tp_exit);
1864
1865 MODULE_AUTHOR("James Chapman <jchapman@katalix.com>");
1866 MODULE_DESCRIPTION("PPP over L2TP over UDP");
1867 MODULE_LICENSE("GPL");
1868 MODULE_VERSION(PPPOL2TP_DRV_VERSION);
1869 MODULE_ALIAS("pppox-proto-" __stringify(PX_PROTO_OL2TP));