sys/netinet/ip_divert.c

   1 /*
   2  * Copyright (c) 1982, 1986, 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * $FreeBSD: src/sys/netinet/ip_divert.c,v 1.42.2.6 2003/01/23 21:06:45 sam Exp $
  34  * $DragonFly: src/sys/netinet/ip_divert.c,v 1.33 2007/12/20 12:44:20 sephe Exp $
  35  */
  36
  37 #include "opt_inet.h"
  38 #include "opt_ipfw.h"
  39 #include "opt_ipdivert.h"
  40 #include "opt_ipsec.h"
  41
  42 #ifndef INET
  43 #error "IPDIVERT requires INET."
  44 #endif
  45
  46 #include <sys/param.h>
  47 #include <sys/kernel.h>
  48 #include <sys/malloc.h>
  49 #include <sys/mbuf.h>
  50 #include <sys/socket.h>
  51 #include <sys/protosw.h>
  52 #include <sys/socketvar.h>
  53 #include <sys/sysctl.h>
  54 #include <sys/systm.h>
  55 #include <sys/proc.h>
  56 #include <sys/thread2.h>
  57
  58 #include <vm/vm_zone.h>
  59
  60 #include <net/if.h>
  61 #include <net/route.h>
  62
  63 #include <netinet/in.h>
  64 #include <netinet/in_systm.h>
  65 #include <netinet/ip.h>
  66 #include <netinet/in_pcb.h>
  67 #include <netinet/in_var.h>
  68 #include <netinet/ip_var.h>
  69
  70 /*
  71  * Divert sockets
  72  */
  73
  74 /*
  75  * Allocate enough space to hold a full IP packet
  76  */
  77 #define DIVSNDQ         (65536 + 100)
  78 #define DIVRCVQ         (65536 + 100)
  79
  80 #define DIV_IS_OUTPUT(sin)      ((sin) == NULL || (sin)->sin_addr.s_addr == 0)
  81
  82 /*
  83  * Divert sockets work in conjunction with ipfw, see the divert(4)
  84  * manpage for features.
  85  * Internally, packets selected by ipfw in ip_input() or ip_output(),
  86  * and never diverted before, are passed to the input queue of the
  87  * divert socket with a given 'divert_port' number (as specified in
  88  * the matching ipfw rule), and they are tagged with a 16 bit cookie
  89  * (representing the rule number of the matching ipfw rule), which
  90  * is passed to process reading from the socket.
  91  *
  92  * Packets written to the divert socket are again tagged with a cookie
  93  * (usually the same as above) and a destination address.
  94  * If the destination address is INADDR_ANY then the packet is
  95  * treated as outgoing and sent to ip_output(), otherwise it is
  96  * treated as incoming and sent to ip_input().
  97  * In both cases, the packet is tagged with the cookie.
  98  *
  99  * On reinjection, processing in ip_input() and ip_output()
 100  * will be exactly the same as for the original packet, except that
 101  * ipfw processing will start at the rule number after the one
 102  * written in the cookie (so, tagging a packet with a cookie of 0
 103  * will cause it to be effectively considered as a standard packet).
 104  */
 105
 106 /* Internal variables */
 107 static struct inpcbinfo divcbinfo;
 108
 109 static u_long   div_sendspace = DIVSNDQ;        /* XXX sysctl ? */
 110 static u_long   div_recvspace = DIVRCVQ;        /* XXX sysctl ? */
 111
 112 /*
 113  * Initialize divert connection block queue.
 114  */
 115 void
 116 div_init(void)
 117 {
 118         in_pcbinfo_init(&divcbinfo);
 119         /*
 120          * XXX We don't use the hash list for divert IP, but it's easier
 121          * to allocate a one entry hash list than it is to check all
 122          * over the place for hashbase == NULL.
 123          */
 124         divcbinfo.hashbase = hashinit(1, M_PCB, &divcbinfo.hashmask);
 125         divcbinfo.porthashbase = hashinit(1, M_PCB, &divcbinfo.porthashmask);
 126         divcbinfo.wildcardhashbase = hashinit(1, M_PCB,
 127                                               &divcbinfo.wildcardhashmask);
 128         divcbinfo.ipi_zone = zinit("divcb", sizeof(struct inpcb),
 129                                    maxsockets, ZONE_INTERRUPT, 0);
 130 }
 131
 132 /*
 133  * IPPROTO_DIVERT is not a real IP protocol; don't allow any packets
 134  * with that protocol number to enter the system from the outside.
 135  */
 136 void
 137 div_input(struct mbuf *m, ...)
 138 {
 139         ipstat.ips_noproto++;
 140         m_freem(m);
 141 }
 142
 143 struct lwkt_port *
 144 div_soport(struct socket *so, struct sockaddr *nam,
 145            struct mbuf **mptr, int req)
 146 {
 147         struct sockaddr_in *sin;
 148         struct mbuf *m;
 149         int dir;
 150
 151         /* Except for send(), everything happens on CPU0 */
 152         if (req != PRU_SEND)
 153                 return cpu0_soport(so, nam, mptr, req);
 154
 155         sin = (struct sockaddr_in *)nam;
 156         m = *mptr;
 157         M_ASSERTPKTHDR(m);
 158
 159         m->m_pkthdr.rcvif = NULL;
 160         dir = DIV_IS_OUTPUT(sin) ? IP_MPORT_OUT : IP_MPORT_IN;
 161
 162         if (sin != NULL) {
 163                 int i;
 164
 165                 /*
 166                  * Try locating the interface, if we originally had one.
 167                  * This is done even for outgoing packets, since for a
 168                  * forwarded packet, there must be an interface attached.
 169                  *
 170                  * Find receive interface with the given name, stuffed
 171                  * (if it exists) in the sin_zero[] field.
 172                  * The name is user supplied data so don't trust its size
 173                  * or that it is zero terminated.
 174                  */
 175                 for (i = 0; sin->sin_zero[i] && i < sizeof(sin->sin_zero); i++)
 176                         ;
 177                 if (i > 0 && i < sizeof(sin->sin_zero))
 178                         m->m_pkthdr.rcvif = ifunit(sin->sin_zero);
 179         }
 180
 181         if (dir == IP_MPORT_IN && m->m_pkthdr.rcvif == NULL) {
 182                 /*
 183                  * No luck with the name, check by IP address.
 184                  * Clear the port and the ifname to make sure
 185                  * there are no distractions for ifa_ifwithaddr.
 186                  *
 187                  * Be careful not to trash sin->sin_port; it will
 188                  * be used later in div_output().
 189                  */
 190                 struct ifaddr *ifa;
 191                 u_short sin_port;
 192
 193                 bzero(sin->sin_zero, sizeof(sin->sin_zero));
 194                 sin_port = sin->sin_port; /* save */
 195                 sin->sin_port = 0;
 196                 ifa = ifa_ifwithaddr((struct sockaddr *)sin);
 197                 if (ifa == NULL) {
 198                         m_freem(m);
 199                         *mptr = NULL;
 200                         return NULL;
 201                 }
 202                 sin->sin_port = sin_port; /* restore */
 203                 m->m_pkthdr.rcvif = ifa->ifa_ifp;
 204         }
 205
 206         return ip_mport(mptr, dir);
 207 }
 208
 209 /*
 210  * Divert a packet by passing it up to the divert socket at port 'port'.
 211  *
 212  * Setup generic address and protocol structures for div_input routine,
 213  * then pass them along with mbuf chain.
 214  */
 215 void
 216 divert_packet(struct mbuf *m, int incoming, int port)
 217 {
 218         struct sockaddr_in divsrc = { sizeof divsrc, AF_INET };
 219         struct ip *ip;
 220         struct inpcb *inp;
 221         struct socket *sa;
 222         struct m_tag *mtag;
 223         u_int16_t nport;
 224
 225         /* Sanity check */
 226         KASSERT(port != 0, ("%s: port=0", __func__));
 227         M_ASSERTPKTHDR(m);
 228
 229         /* Assure header */
 230         if (m->m_len < sizeof(struct ip) &&
 231             (m = m_pullup(m, sizeof(struct ip))) == NULL)
 232                 return;
 233         ip = mtod(m, struct ip *);
 234
 235         /* Locate the divert tag */
 236         mtag = m_tag_find(m, PACKET_TAG_IPFW_DIVERT, NULL);
 237         KASSERT(mtag != NULL, ("%s no divert tag!", __func__));
 238         divsrc.sin_port = *(u_int16_t *)m_tag_data(mtag);
 239
 240         /*
 241          * Record receive interface address, if any.
 242          * But only for incoming packets.
 243          */
 244         divsrc.sin_addr.s_addr = 0;
 245         if (incoming) {
 246                 struct ifaddr *ifa;
 247
 248                 /* Find IP address for receive interface */
 249                 TAILQ_FOREACH(ifa, &m->m_pkthdr.rcvif->if_addrhead, ifa_link) {
 250                         if (ifa->ifa_addr == NULL)
 251                                 continue;
 252                         if (ifa->ifa_addr->sa_family != AF_INET)
 253                                 continue;
 254                         divsrc.sin_addr =
 255                             ((struct sockaddr_in *) ifa->ifa_addr)->sin_addr;
 256                         break;
 257                 }
 258         }
 259         /*
 260          * Record the incoming interface name whenever we have one.
 261          */
 262         if (m->m_pkthdr.rcvif) {
 263                 /*
 264                  * Hide the actual interface name in there in the
 265                  * sin_zero array. XXX This needs to be moved to a
 266                  * different sockaddr type for divert, e.g.
 267                  * sockaddr_div with multiple fields like
 268                  * sockaddr_dl. Presently we have only 7 bytes
 269                  * but that will do for now as most interfaces
 270                  * are 4 or less + 2 or less bytes for unit.
 271                  * There is probably a faster way of doing this,
 272                  * possibly taking it from the sockaddr_dl on the iface.
 273                  * This solves the problem of a P2P link and a LAN interface
 274                  * having the same address, which can result in the wrong
 275                  * interface being assigned to the packet when fed back
 276                  * into the divert socket. Theoretically if the daemon saves
 277                  * and re-uses the sockaddr_in as suggested in the man pages,
 278                  * this iface name will come along for the ride.
 279                  * (see div_output for the other half of this.)
 280                  */
 281                 ksnprintf(divsrc.sin_zero, sizeof divsrc.sin_zero,
 282                          m->m_pkthdr.rcvif->if_xname);
 283         }
 284
 285         /* Put packet on socket queue, if any */
 286         sa = NULL;
 287         nport = htons((u_int16_t)port);
 288         LIST_FOREACH(inp, &divcbinfo.pcblisthead, inp_list) {
 289                 if (inp->inp_flags & INP_PLACEMARKER)
 290                         continue;
 291                 if (inp->inp_lport == nport)
 292                         sa = inp->inp_socket;
 293         }
 294         if (sa) {
 295                 if (ssb_appendaddr(&sa->so_rcv, (struct sockaddr *)&divsrc, m,
 296                                  (struct mbuf *)NULL) == 0)
 297                         m_freem(m);
 298                 else
 299                         sorwakeup(sa);
 300         } else {
 301                 m_freem(m);
 302                 ipstat.ips_noproto++;
 303                 ipstat.ips_delivered--;
 304         }
 305 }
 306
 307 /*
 308  * Deliver packet back into the IP processing machinery.
 309  *
 310  * If no address specified, or address is 0.0.0.0, send to ip_output();
 311  * otherwise, send to ip_input() and mark as having been received on
 312  * the interface with that address.
 313  */
 314 static int
 315 div_output(struct socket *so, struct mbuf *m,
 316         struct sockaddr_in *sin, struct mbuf *control)
 317 {
 318         int error = 0;
 319         struct m_tag *mtag;
 320
 321         if (control)
 322                 m_freem(control);               /* XXX */
 323
 324         /*
 325          * Prepare the tag for divert info. Note that a packet
 326          * with a 0 tag in mh_data is effectively untagged,
 327          * so we could optimize that case.
 328          */
 329         mtag = m_tag_get(PACKET_TAG_IPFW_DIVERT, sizeof(u_int16_t), MB_DONTWAIT);
 330         if (mtag == NULL) {
 331                 error = ENOBUFS;
 332                 goto cantsend;
 333         }
 334         m_tag_prepend(m, mtag);
 335
 336         /* Loopback avoidance and state recovery */
 337         if (sin)
 338                 *(u_int16_t *)m_tag_data(mtag) = sin->sin_port;
 339         else
 340                 *(u_int16_t *)m_tag_data(mtag) = 0;
 341
 342         /* Reinject packet into the system as incoming or outgoing */
 343         if (DIV_IS_OUTPUT(sin)) {
 344                 struct ip *const ip = mtod(m, struct ip *);
 345
 346                 /* Don't allow packet length sizes that will crash */
 347                 if ((u_short)ntohs(ip->ip_len) > m->m_pkthdr.len) {
 348                         error = EINVAL;
 349                         goto cantsend;
 350                 }
 351
 352                 /* Convert fields to host order for ip_output() */
 353                 ip->ip_len = ntohs(ip->ip_len);
 354                 ip->ip_off = ntohs(ip->ip_off);
 355
 356                 /* Send packet to output processing */
 357                 ipstat.ips_rawout++;                    /* XXX */
 358                 error = ip_output(m, NULL, NULL,
 359                             (so->so_options & SO_DONTROUTE) |
 360                             IP_ALLOWBROADCAST | IP_RAWOUTPUT,
 361                             NULL, NULL);
 362         } else {
 363                 ip_input(m);
 364         }
 365         return error;
 366
 367 cantsend:
 368         m_freem(m);
 369         return error;
 370 }
 371
 372 static int
 373 div_attach(struct socket *so, int proto, struct pru_attach_info *ai)
 374 {
 375         struct inpcb *inp;
 376         int error;
 377
 378         inp  = so->so_pcb;
 379         if (inp)
 380                 panic("div_attach");
 381         if ((error = suser_cred(ai->p_ucred, NULL_CRED_OKAY)) != 0)
 382                 return error;
 383
 384         error = soreserve(so, div_sendspace, div_recvspace, ai->sb_rlimit);
 385         if (error)
 386                 return error;
 387         crit_enter();
 388         error = in_pcballoc(so, &divcbinfo);
 389         crit_exit();
 390         if (error)
 391                 return error;
 392         inp = (struct inpcb *)so->so_pcb;
 393         inp->inp_ip_p = proto;
 394         inp->inp_vflag |= INP_IPV4;
 395         inp->inp_flags |= INP_HDRINCL;
 396         /*
 397          * The socket is always "connected" because
 398          * we always know "where" to send the packet.
 399          */
 400         so->so_state |= SS_ISCONNECTED;
 401         return 0;
 402 }
 403
 404 static int
 405 div_detach(struct socket *so)
 406 {
 407         struct inpcb *inp;
 408
 409         inp = so->so_pcb;
 410         if (inp == NULL)
 411                 panic("div_detach");
 412         in_pcbdetach(inp);
 413         return 0;
 414 }
 415
 416 static int
 417 div_abort(struct socket *so)
 418 {
 419         soisdisconnected(so);
 420         return div_detach(so);
 421 }
 422
 423 static int
 424 div_disconnect(struct socket *so)
 425 {
 426         if (!(so->so_state & SS_ISCONNECTED))
 427                 return ENOTCONN;
 428         return div_abort(so);
 429 }
 430
 431 static int
 432 div_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
 433 {
 434         struct inpcb *inp;
 435         int error;
 436
 437         crit_enter();
 438         inp = so->so_pcb;
 439         /* in_pcbbind assumes that nam is a sockaddr_in
 440          * and in_pcbbind requires a valid address. Since divert
 441          * sockets don't we need to make sure the address is
 442          * filled in properly.
 443          * XXX -- divert should not be abusing in_pcbind
 444          * and should probably have its own family.
 445          */
 446         if (nam->sa_family != AF_INET)
 447                 error = EAFNOSUPPORT;
 448         else {
 449                 ((struct sockaddr_in *)nam)->sin_addr.s_addr = INADDR_ANY;
 450                 error = in_pcbbind(inp, nam, td);
 451         }
 452         crit_exit();
 453         return error;
 454 }
 455
 456 static int
 457 div_shutdown(struct socket *so)
 458 {
 459         socantsendmore(so);
 460         return 0;
 461 }
 462
 463 static int
 464 div_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
 465          struct mbuf *control, struct thread *td)
 466 {
 467         /* Length check already done in ip_mport() */
 468         KASSERT(m->m_len >= sizeof(struct ip), ("IP header not in one mbuf"));
 469
 470         /* Send packet */
 471         return div_output(so, m, (struct sockaddr_in *)nam, control);
 472 }
 473
 474 SYSCTL_DECL(_net_inet_divert);
 475 SYSCTL_PROC(_net_inet_divert, OID_AUTO, pcblist, CTLFLAG_RD, &divcbinfo, 0,
 476             in_pcblist_global, "S,xinpcb", "List of active divert sockets");
 477
 478 struct pr_usrreqs div_usrreqs = {
 479         .pru_abort = div_abort,
 480         .pru_accept = pru_accept_notsupp,
 481         .pru_attach = div_attach,
 482         .pru_bind = div_bind,
 483         .pru_connect = pru_connect_notsupp,
 484         .pru_connect2 = pru_connect2_notsupp,
 485         .pru_control = in_control,
 486         .pru_detach = div_detach,
 487         .pru_disconnect = div_disconnect,
 488         .pru_listen = pru_listen_notsupp,
 489         .pru_peeraddr = in_setpeeraddr,
 490         .pru_rcvd = pru_rcvd_notsupp,
 491         .pru_rcvoob = pru_rcvoob_notsupp,
 492         .pru_send = div_send,
 493         .pru_sense = pru_sense_null,
 494         .pru_shutdown = div_shutdown,
 495         .pru_sockaddr = in_setsockaddr,
 496         .pru_sosend = sosend,
 497         .pru_soreceive = soreceive,
 498         .pru_sopoll = sopoll
 499 };