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.9 2004/03/06 01:58:55 hsu 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
  57 #include <vm/vm_zone.h>
  58
  59 #include <net/if.h>
  60 #include <net/netisr.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 /*
  81  * Divert sockets work in conjunction with ipfw, see the divert(4)
  82  * manpage for features.
  83  * Internally, packets selected by ipfw in ip_input() or ip_output(),
  84  * and never diverted before, are passed to the input queue of the
  85  * divert socket with a given 'divert_port' number (as specified in
  86  * the matching ipfw rule), and they are tagged with a 16 bit cookie
  87  * (representing the rule number of the matching ipfw rule), which
  88  * is passed to process reading from the socket.
  89  *
  90  * Packets written to the divert socket are again tagged with a cookie
  91  * (usually the same as above) and a destination address.
  92  * If the destination address is INADDR_ANY then the packet is
  93  * treated as outgoing and sent to ip_output(), otherwise it is
  94  * treated as incoming and sent to ip_input().
  95  * In both cases, the packet is tagged with the cookie.
  96  *
  97  * On reinjection, processing in ip_input() and ip_output()
  98  * will be exactly the same as for the original packet, except that
  99  * ipfw processing will start at the rule number after the one
 100  * written in the cookie (so, tagging a packet with a cookie of 0
 101  * will cause it to be effectively considered as a standard packet).
 102  */
 103
 104 /* Internal variables */
 105 static struct inpcbhead divcb;
 106 static struct inpcbinfo divcbinfo;
 107
 108 static u_long   div_sendspace = DIVSNDQ;        /* XXX sysctl ? */
 109 static u_long   div_recvspace = DIVRCVQ;        /* XXX sysctl ? */
 110
 111 /* Optimization: have this preinitialized */
 112 static struct sockaddr_in divsrc = { sizeof(divsrc), AF_INET };
 113
 114 /*
 115  * Initialize divert connection block queue.
 116  */
 117 void
 118 div_init(void)
 119 {
 120         LIST_INIT(&divcb);
 121         divcbinfo.listhead = &divcb;
 122         /*
 123          * XXX We don't use the hash list for divert IP, but it's easier
 124          * to allocate a one entry hash list than it is to check all
 125          * over the place for hashbase == NULL.
 126          */
 127         divcbinfo.hashbase = hashinit(1, M_PCB, &divcbinfo.hashmask);
 128         divcbinfo.porthashbase = hashinit(1, M_PCB, &divcbinfo.porthashmask);
 129         divcbinfo.bindhashbase = hashinit(1, M_PCB, &divcbinfo.bindhashmask);
 130         divcbinfo.ipi_zone = zinit("divcb", sizeof(struct inpcb),
 131                                    maxsockets, ZONE_INTERRUPT, 0);
 132 }
 133
 134 /*
 135  * IPPROTO_DIVERT is not a real IP protocol; don't allow any packets
 136  * with that protocol number to enter the system from the outside.
 137  */
 138 void
 139 div_input(struct mbuf *m, int off, int proto)
 140 {
 141         ipstat.ips_noproto++;
 142         m_freem(m);
 143 }
 144
 145 /*
 146  * Divert a packet by passing it up to the divert socket at port 'port'.
 147  *
 148  * Setup generic address and protocol structures for div_input routine,
 149  * then pass them along with mbuf chain.
 150  */
 151 void
 152 divert_packet(struct mbuf *m, int incoming, int port, int rule)
 153 {
 154         struct ip *ip;
 155         struct inpcb *inp;
 156         struct socket *sa;
 157         u_int16_t nport;
 158
 159         /* Sanity check */
 160         KASSERT(port != 0, ("%s: port=0", __FUNCTION__));
 161
 162         divsrc.sin_port = rule;         /* record matching rule */
 163
 164         /* Assure header */
 165         if (m->m_len < sizeof(struct ip) &&
 166             (m = m_pullup(m, sizeof(struct ip))) == 0)
 167                 return;
 168         ip = mtod(m, struct ip *);
 169
 170         /*
 171          * Record receive interface address, if any.
 172          * But only for incoming packets.
 173          */
 174         divsrc.sin_addr.s_addr = 0;
 175         if (incoming) {
 176                 struct ifaddr *ifa;
 177
 178                 /* Sanity check */
 179                 KASSERT((m->m_flags & M_PKTHDR), ("%s: !PKTHDR", __FUNCTION__));
 180
 181                 /* Find IP address for receive interface */
 182                 TAILQ_FOREACH(ifa, &m->m_pkthdr.rcvif->if_addrhead, ifa_link) {
 183                         if (ifa->ifa_addr == NULL)
 184                                 continue;
 185                         if (ifa->ifa_addr->sa_family != AF_INET)
 186                                 continue;
 187                         divsrc.sin_addr =
 188                             ((struct sockaddr_in *) ifa->ifa_addr)->sin_addr;
 189                         break;
 190                 }
 191         }
 192         /*
 193          * Record the incoming interface name whenever we have one.
 194          */
 195         bzero(&divsrc.sin_zero, sizeof(divsrc.sin_zero));
 196         if (m->m_pkthdr.rcvif) {
 197                 /*
 198                  * Hide the actual interface name in there in the
 199                  * sin_zero array. XXX This needs to be moved to a
 200                  * different sockaddr type for divert, e.g.
 201                  * sockaddr_div with multiple fields like
 202                  * sockaddr_dl. Presently we have only 7 bytes
 203                  * but that will do for now as most interfaces
 204                  * are 4 or less + 2 or less bytes for unit.
 205                  * There is probably a faster way of doing this,
 206                  * possibly taking it from the sockaddr_dl on the iface.
 207                  * This solves the problem of a P2P link and a LAN interface
 208                  * having the same address, which can result in the wrong
 209                  * interface being assigned to the packet when fed back
 210                  * into the divert socket. Theoretically if the daemon saves
 211                  * and re-uses the sockaddr_in as suggested in the man pages,
 212                  * this iface name will come along for the ride.
 213                  * (see div_output for the other half of this.)
 214                  */
 215                 snprintf(divsrc.sin_zero, sizeof(divsrc.sin_zero),
 216                             m->m_pkthdr.rcvif->if_xname);
 217         }
 218
 219         /* Put packet on socket queue, if any */
 220         sa = NULL;
 221         nport = htons((u_int16_t)port);
 222         LIST_FOREACH(inp, &divcb, inp_list) {
 223                 if (inp->inp_lport == nport)
 224                         sa = inp->inp_socket;
 225         }
 226         if (sa) {
 227                 if (sbappendaddr(&sa->so_rcv, (struct sockaddr *)&divsrc,
 228                                 m, (struct mbuf *)0) == 0)
 229                         m_freem(m);
 230                 else
 231                         sorwakeup(sa);
 232         } else {
 233                 m_freem(m);
 234                 ipstat.ips_noproto++;
 235                 ipstat.ips_delivered--;
 236         }
 237 }
 238
 239 /*
 240  * Deliver packet back into the IP processing machinery.
 241  *
 242  * If no address specified, or address is 0.0.0.0, send to ip_output();
 243  * otherwise, send to ip_input() and mark as having been received on
 244  * the interface with that address.
 245  */
 246 static int
 247 div_output(struct socket *so, struct mbuf *m,
 248         struct sockaddr_in *sin, struct mbuf *control)
 249 {
 250         int error = 0;
 251         struct m_hdr divert_tag;
 252
 253         /*
 254          * Prepare the tag for divert info. Note that a packet
 255          * with a 0 tag in mh_data is effectively untagged,
 256          * so we could optimize that case.
 257          */
 258         divert_tag.mh_type = MT_TAG;
 259         divert_tag.mh_flags = PACKET_TAG_DIVERT;
 260         divert_tag.mh_next = m;
 261         divert_tag.mh_data = 0;         /* the matching rule # */
 262         m->m_pkthdr.rcvif = NULL;       /* XXX is it necessary ? */
 263
 264         if (control)
 265                 m_freem(control);               /* XXX */
 266
 267         /* Loopback avoidance and state recovery */
 268         if (sin) {
 269                 int i;
 270
 271                 divert_tag.mh_data = (caddr_t)(int)sin->sin_port;
 272                 /*
 273                  * Find receive interface with the given name, stuffed
 274                  * (if it exists) in the sin_zero[] field.
 275                  * The name is user supplied data so don't trust its size
 276                  * or that it is zero terminated.
 277                  */
 278                 for (i = 0; sin->sin_zero[i] && i < sizeof(sin->sin_zero); i++)
 279                         ;
 280                 if ( i > 0 && i < sizeof(sin->sin_zero))
 281                         m->m_pkthdr.rcvif = ifunit(sin->sin_zero);
 282         }
 283
 284         /* Reinject packet into the system as incoming or outgoing */
 285         if (!sin || sin->sin_addr.s_addr == 0) {
 286                 struct inpcb *const inp = sotoinpcb(so);
 287                 struct ip *const ip = mtod(m, struct ip *);
 288
 289                 /*
 290                  * Don't allow both user specified and setsockopt options,
 291                  * and don't allow packet length sizes that will crash
 292                  */
 293                 if (((ip->ip_hl != (sizeof (*ip) >> 2)) && inp->inp_options) ||
 294                      ((u_short)ntohs(ip->ip_len) > m->m_pkthdr.len)) {
 295                         error = EINVAL;
 296                         goto cantsend;
 297                 }
 298
 299                 /* Convert fields to host order for ip_output() */
 300                 ip->ip_len = ntohs(ip->ip_len);
 301                 ip->ip_off = ntohs(ip->ip_off);
 302
 303                 /* Send packet to output processing */
 304                 ipstat.ips_rawout++;                    /* XXX */
 305                 error = ip_output((struct mbuf *)&divert_tag,
 306                             inp->inp_options, &inp->inp_route,
 307                             (so->so_options & SO_DONTROUTE) |
 308                             IP_ALLOWBROADCAST | IP_RAWOUTPUT,
 309                             inp->inp_moptions, NULL);
 310         } else {
 311                 struct netmsg_packet msg;
 312
 313                 if (m->m_pkthdr.rcvif == NULL) {
 314                         /*
 315                          * No luck with the name, check by IP address.
 316                          * Clear the port and the ifname to make sure
 317                          * there are no distractions for ifa_ifwithaddr.
 318                          */
 319                         struct  ifaddr *ifa;
 320
 321                         bzero(sin->sin_zero, sizeof(sin->sin_zero));
 322                         sin->sin_port = 0;
 323                         ifa = ifa_ifwithaddr((struct sockaddr *) sin);
 324                         if (ifa == NULL) {
 325                                 error = EADDRNOTAVAIL;
 326                                 goto cantsend;
 327                         }
 328                         m->m_pkthdr.rcvif = ifa->ifa_ifp;
 329                 }
 330                 /* Send packet to input processing */
 331                 msg.nm_packet = (struct mbuf *)&divert_tag;
 332                 ip_input((struct netmsg *)&msg);
 333         }
 334
 335         return error;
 336
 337 cantsend:
 338         m_freem(m);
 339         return error;
 340 }
 341
 342 static int
 343 div_attach(struct socket *so, int proto, struct pru_attach_info *ai)
 344 {
 345         struct inpcb *inp;
 346         int error, s;
 347
 348         inp  = sotoinpcb(so);
 349         if (inp)
 350                 panic("div_attach");
 351         if ((error = suser_cred(ai->p_ucred, NULL_CRED_OKAY)) != 0)
 352                 return error;
 353
 354         error = soreserve(so, div_sendspace, div_recvspace, ai->sb_rlimit);
 355         if (error)
 356                 return error;
 357         s = splnet();
 358         error = in_pcballoc(so, &divcbinfo);
 359         splx(s);
 360         if (error)
 361                 return error;
 362         inp = (struct inpcb *)so->so_pcb;
 363         inp->inp_ip_p = proto;
 364         inp->inp_vflag |= INP_IPV4;
 365         inp->inp_flags |= INP_HDRINCL;
 366         /* The socket is always "connected" because
 367            we always know "where" to send the packet */
 368         so->so_state |= SS_ISCONNECTED;
 369         return 0;
 370 }
 371
 372 static int
 373 div_detach(struct socket *so)
 374 {
 375         struct inpcb *inp;
 376
 377         inp = sotoinpcb(so);
 378         if (inp == 0)
 379                 panic("div_detach");
 380         in_pcbdetach(inp);
 381         return 0;
 382 }
 383
 384 static int
 385 div_abort(struct socket *so)
 386 {
 387         soisdisconnected(so);
 388         return div_detach(so);
 389 }
 390
 391 static int
 392 div_disconnect(struct socket *so)
 393 {
 394         if ((so->so_state & SS_ISCONNECTED) == 0)
 395                 return ENOTCONN;
 396         return div_abort(so);
 397 }
 398
 399 static int
 400 div_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
 401 {
 402         struct inpcb *inp;
 403         int s;
 404         int error;
 405
 406         s = splnet();
 407         inp = sotoinpcb(so);
 408         /* in_pcbbind assumes that nam is a sockaddr_in
 409          * and in_pcbbind requires a valid address. Since divert
 410          * sockets don't we need to make sure the address is
 411          * filled in properly.
 412          * XXX -- divert should not be abusing in_pcbind
 413          * and should probably have its own family.
 414          */
 415         if (nam->sa_family != AF_INET)
 416                 error = EAFNOSUPPORT;
 417         else {
 418                 ((struct sockaddr_in *)nam)->sin_addr.s_addr = INADDR_ANY;
 419                 error = in_pcbbind(inp, nam, td);
 420         }
 421         splx(s);
 422         return error;
 423 }
 424
 425 static int
 426 div_shutdown(struct socket *so)
 427 {
 428         socantsendmore(so);
 429         return 0;
 430 }
 431
 432 static int
 433 div_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
 434          struct mbuf *control, struct thread *td)
 435 {
 436         /* Packet must have a header (but that's about it) */
 437         if (m->m_len < sizeof (struct ip) &&
 438             (m = m_pullup(m, sizeof (struct ip))) == 0) {
 439                 ipstat.ips_toosmall++;
 440                 m_freem(m);
 441                 return EINVAL;
 442         }
 443
 444         /* Send packet */
 445         return div_output(so, m, (struct sockaddr_in *)nam, control);
 446 }
 447
 448 static int
 449 div_pcblist(SYSCTL_HANDLER_ARGS)
 450 {
 451         int error, i, n, s;
 452         struct inpcb *inp, **inp_list;
 453         inp_gen_t gencnt;
 454         struct xinpgen xig;
 455
 456         /*
 457          * The process of preparing the TCB list is too time-consuming and
 458          * resource-intensive to repeat twice on every request.
 459          */
 460         if (req->oldptr == 0) {
 461                 n = divcbinfo.ipi_count;
 462                 req->oldidx = 2 * (sizeof xig)
 463                         + (n + n/8) * sizeof(struct xinpcb);
 464                 return 0;
 465         }
 466
 467         if (req->newptr != 0)
 468                 return EPERM;
 469
 470         /*
 471          * OK, now we're committed to doing something.
 472          */
 473         s = splnet();
 474         gencnt = divcbinfo.ipi_gencnt;
 475         n = divcbinfo.ipi_count;
 476         splx(s);
 477
 478         xig.xig_len = sizeof xig;
 479         xig.xig_count = n;
 480         xig.xig_gen = gencnt;
 481         xig.xig_sogen = so_gencnt;
 482         error = SYSCTL_OUT(req, &xig, sizeof xig);
 483         if (error)
 484                 return error;
 485
 486         inp_list = malloc(n * sizeof *inp_list, M_TEMP, M_WAITOK);
 487         if (inp_list == 0)
 488                 return ENOMEM;
 489
 490         s = splnet();
 491         for (inp = LIST_FIRST(divcbinfo.listhead), i = 0; inp && i < n;
 492              inp = LIST_NEXT(inp, inp_list)) {
 493                 if (inp->inp_gencnt <= gencnt && !prison_xinpcb(req->td, inp))
 494                         inp_list[i++] = inp;
 495         }
 496         splx(s);
 497         n = i;
 498
 499         error = 0;
 500         for (i = 0; i < n; i++) {
 501                 inp = inp_list[i];
 502                 if (inp->inp_gencnt <= gencnt) {
 503                         struct xinpcb xi;
 504                         xi.xi_len = sizeof xi;
 505                         /* XXX should avoid extra copy */
 506                         bcopy(inp, &xi.xi_inp, sizeof *inp);
 507                         if (inp->inp_socket)
 508                                 sotoxsocket(inp->inp_socket, &xi.xi_socket);
 509                         error = SYSCTL_OUT(req, &xi, sizeof xi);
 510                 }
 511         }
 512         if (!error) {
 513                 /*
 514                  * Give the user an updated idea of our state.
 515                  * If the generation differs from what we told
 516                  * her before, she knows that something happened
 517                  * while we were processing this request, and it
 518                  * might be necessary to retry.
 519                  */
 520                 s = splnet();
 521                 xig.xig_gen = divcbinfo.ipi_gencnt;
 522                 xig.xig_sogen = so_gencnt;
 523                 xig.xig_count = divcbinfo.ipi_count;
 524                 splx(s);
 525                 error = SYSCTL_OUT(req, &xig, sizeof xig);
 526         }
 527         free(inp_list, M_TEMP);
 528         return error;
 529 }
 530
 531 SYSCTL_DECL(_net_inet_divert);
 532 SYSCTL_PROC(_net_inet_divert, OID_AUTO, pcblist, CTLFLAG_RD, 0, 0,
 533             div_pcblist, "S,xinpcb", "List of active divert sockets");
 534
 535 struct pr_usrreqs div_usrreqs = {
 536         div_abort, pru_accept_notsupp, div_attach, div_bind,
 537         pru_connect_notsupp, pru_connect2_notsupp, in_control, div_detach,
 538         div_disconnect, pru_listen_notsupp, in_setpeeraddr, pru_rcvd_notsupp,
 539         pru_rcvoob_notsupp, div_send, pru_sense_null, div_shutdown,
 540         in_setsockaddr, sosend, soreceive, sopoll
 541 };