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