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.24 2005/06/02 23:52:42 dillon 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 /*
  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 inpcbinfo divcbinfo;
 106
 107 static u_long   div_sendspace = DIVSNDQ;        /* XXX sysctl ? */
 108 static u_long   div_recvspace = DIVRCVQ;        /* XXX sysctl ? */
 109
 110 /*
 111  * Initialize divert connection block queue.
 112  */
 113 void
 114 div_init(void)
 115 {
 116         in_pcbinfo_init(&divcbinfo);
 117         /*
 118          * XXX We don't use the hash list for divert IP, but it's easier
 119          * to allocate a one entry hash list than it is to check all
 120          * over the place for hashbase == NULL.
 121          */
 122         divcbinfo.hashbase = hashinit(1, M_PCB, &divcbinfo.hashmask);
 123         divcbinfo.porthashbase = hashinit(1, M_PCB, &divcbinfo.porthashmask);
 124         divcbinfo.wildcardhashbase = hashinit(1, M_PCB,
 125                                               &divcbinfo.wildcardhashmask);
 126         divcbinfo.ipi_zone = zinit("divcb", sizeof(struct inpcb),
 127                                    maxsockets, ZONE_INTERRUPT, 0);
 128 }
 129
 130 /*
 131  * IPPROTO_DIVERT is not a real IP protocol; don't allow any packets
 132  * with that protocol number to enter the system from the outside.
 133  */
 134 void
 135 div_input(struct mbuf *m, ...)
 136 {
 137         ipstat.ips_noproto++;
 138         m_freem(m);
 139 }
 140
 141 /*
 142  * Divert a packet by passing it up to the divert socket at port 'port'.
 143  *
 144  * Setup generic address and protocol structures for div_input routine,
 145  * then pass them along with mbuf chain.
 146  */
 147 void
 148 divert_packet(struct mbuf *m, int incoming, int port)
 149 {
 150         struct sockaddr_in divsrc = { sizeof divsrc, AF_INET };
 151         struct ip *ip;
 152         struct inpcb *inp;
 153         struct socket *sa;
 154         struct m_tag *mtag;
 155         u_int16_t nport;
 156
 157         /* Sanity check */
 158         KASSERT(port != 0, ("%s: port=0", __func__));
 159
 160         if ((mtag = m_tag_find(m, PACKET_TAG_IPFW_DIVERT, NULL)) != NULL)
 161                 divsrc.sin_port = *(u_int16_t *)(mtag + 1);
 162         else
 163                 divsrc.sin_port = 0;
 164
 165         /* Assure header */
 166         if (m->m_len < sizeof(struct ip) &&
 167             (m = m_pullup(m, sizeof(struct ip))) == NULL)
 168                 return;
 169         ip = mtod(m, struct ip *);
 170
 171         /*
 172          * Record receive interface address, if any.
 173          * But only for incoming packets.
 174          */
 175         divsrc.sin_addr.s_addr = 0;
 176         if (incoming) {
 177                 struct ifaddr *ifa;
 178
 179                 /* Sanity check */
 180                 KASSERT((m->m_flags & M_PKTHDR), ("%s: !PKTHDR", __func__));
 181
 182                 /* Find IP address for receive interface */
 183                 TAILQ_FOREACH(ifa, &m->m_pkthdr.rcvif->if_addrhead, ifa_link) {
 184                         if (ifa->ifa_addr == NULL)
 185                                 continue;
 186                         if (ifa->ifa_addr->sa_family != AF_INET)
 187                                 continue;
 188                         divsrc.sin_addr =
 189                             ((struct sockaddr_in *) ifa->ifa_addr)->sin_addr;
 190                         break;
 191                 }
 192         }
 193         /*
 194          * Record the incoming interface name whenever we have one.
 195          */
 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, &divcbinfo.pcblisthead, inp_list) {
 223                 if (inp->inp_flags & INP_PLACEMARKER)
 224                         continue;
 225                 if (inp->inp_lport == nport)
 226                         sa = inp->inp_socket;
 227         }
 228         if (sa) {
 229                 if (sbappendaddr(&sa->so_rcv, (struct sockaddr *)&divsrc, m,
 230                                  (struct mbuf *)NULL) == 0)
 231                         m_freem(m);
 232                 else
 233                         sorwakeup(sa);
 234         } else {
 235                 m_freem(m);
 236                 ipstat.ips_noproto++;
 237                 ipstat.ips_delivered--;
 238         }
 239 }
 240
 241 /*
 242  * Deliver packet back into the IP processing machinery.
 243  *
 244  * If no address specified, or address is 0.0.0.0, send to ip_output();
 245  * otherwise, send to ip_input() and mark as having been received on
 246  * the interface with that address.
 247  */
 248 static int
 249 div_output(struct socket *so, struct mbuf *m,
 250         struct sockaddr_in *sin, struct mbuf *control)
 251 {
 252         int error = 0;
 253         struct m_tag *mtag;
 254
 255         /*
 256          * Prepare the tag for divert info. Note that a packet
 257          * with a 0 tag in mh_data is effectively untagged,
 258          * so we could optimize that case.
 259          */
 260         mtag = m_tag_get(PACKET_TAG_IPFW_DIVERT, sizeof(u_int16_t), M_NOWAIT);
 261         if (mtag == NULL) {
 262                 error = ENOBUFS;
 263                 goto cantsend;
 264         }
 265         m_tag_prepend(m, mtag);
 266         m->m_pkthdr.rcvif = NULL;       /* XXX is it necessary ? */
 267
 268         if (control)
 269                 m_freem(control);               /* XXX */
 270
 271         /* Loopback avoidance and state recovery */
 272         if (sin) {
 273                 int i;
 274
 275                 *(u_int16_t *)mtag = sin->sin_port;
 276                 /*
 277                  * Find receive interface with the given name, stuffed
 278                  * (if it exists) in the sin_zero[] field.
 279                  * The name is user supplied data so don't trust its size
 280                  * or that it is zero terminated.
 281                  */
 282                 for (i = 0; sin->sin_zero[i] && i < sizeof sin->sin_zero; i++)
 283                         ;
 284                 if ( i > 0 && i < sizeof sin->sin_zero)
 285                         m->m_pkthdr.rcvif = ifunit(sin->sin_zero);
 286         }
 287
 288         /* Reinject packet into the system as incoming or outgoing */
 289         if (!sin || sin->sin_addr.s_addr == 0) {
 290                 struct inpcb *const inp = so->so_pcb;
 291                 struct ip *const ip = mtod(m, struct ip *);
 292
 293                 /*
 294                  * Don't allow both user specified and setsockopt options,
 295                  * and don't allow packet length sizes that will crash
 296                  */
 297                 if (((ip->ip_hl != (sizeof *ip) >> 2) && inp->inp_options) ||
 298                      ((u_short)ntohs(ip->ip_len) > m->m_pkthdr.len)) {
 299                         error = EINVAL;
 300                         goto cantsend;
 301                 }
 302
 303                 /* Convert fields to host order for ip_output() */
 304                 ip->ip_len = ntohs(ip->ip_len);
 305                 ip->ip_off = ntohs(ip->ip_off);
 306
 307                 /* Send packet to output processing */
 308                 ipstat.ips_rawout++;                    /* XXX */
 309                 error = ip_output(m,
 310                             inp->inp_options, &inp->inp_route,
 311                             (so->so_options & SO_DONTROUTE) |
 312                             IP_ALLOWBROADCAST | IP_RAWOUTPUT,
 313                             inp->inp_moptions, NULL);
 314         } else {
 315                 if (m->m_pkthdr.rcvif == NULL) {
 316                         /*
 317                          * No luck with the name, check by IP address.
 318                          * Clear the port and the ifname to make sure
 319                          * there are no distractions for ifa_ifwithaddr.
 320                          */
 321                         struct  ifaddr *ifa;
 322
 323                         bzero(sin->sin_zero, sizeof sin->sin_zero);
 324                         sin->sin_port = 0;
 325                         ifa = ifa_ifwithaddr((struct sockaddr *) sin);
 326                         if (ifa == NULL) {
 327                                 error = EADDRNOTAVAIL;
 328                                 goto cantsend;
 329                         }
 330                         m->m_pkthdr.rcvif = ifa->ifa_ifp;
 331                 }
 332                 ip_input(m);
 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;
 347
 348         inp  = so->so_pcb;
 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         crit_enter();
 358         error = in_pcballoc(so, &divcbinfo);
 359         crit_exit();
 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         /*
 367          * The socket is always "connected" because
 368          * we always know "where" to send the packet.
 369          */
 370         so->so_state |= SS_ISCONNECTED;
 371         return 0;
 372 }
 373
 374 static int
 375 div_detach(struct socket *so)
 376 {
 377         struct inpcb *inp;
 378
 379         inp = so->so_pcb;
 380         if (inp == NULL)
 381                 panic("div_detach");
 382         in_pcbdetach(inp);
 383         return 0;
 384 }
 385
 386 static int
 387 div_abort(struct socket *so)
 388 {
 389         soisdisconnected(so);
 390         return div_detach(so);
 391 }
 392
 393 static int
 394 div_disconnect(struct socket *so)
 395 {
 396         if (!(so->so_state & SS_ISCONNECTED))
 397                 return ENOTCONN;
 398         return div_abort(so);
 399 }
 400
 401 static int
 402 div_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
 403 {
 404         struct inpcb *inp;
 405         int error;
 406
 407         crit_enter();
 408         inp = so->so_pcb;
 409         /* in_pcbbind assumes that nam is a sockaddr_in
 410          * and in_pcbbind requires a valid address. Since divert
 411          * sockets don't we need to make sure the address is
 412          * filled in properly.
 413          * XXX -- divert should not be abusing in_pcbind
 414          * and should probably have its own family.
 415          */
 416         if (nam->sa_family != AF_INET)
 417                 error = EAFNOSUPPORT;
 418         else {
 419                 ((struct sockaddr_in *)nam)->sin_addr.s_addr = INADDR_ANY;
 420                 error = in_pcbbind(inp, nam, td);
 421         }
 422         crit_exit();
 423         return error;
 424 }
 425
 426 static int
 427 div_shutdown(struct socket *so)
 428 {
 429         socantsendmore(so);
 430         return 0;
 431 }
 432
 433 static int
 434 div_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
 435          struct mbuf *control, struct thread *td)
 436 {
 437         /* Packet must have a header (but that's about it) */
 438         if (m->m_len < sizeof(struct ip) &&
 439             (m = m_pullup(m, sizeof(struct ip))) == NULL) {
 440                 ipstat.ips_toosmall++;
 441                 m_freem(m);
 442                 return EINVAL;
 443         }
 444
 445         /* Send packet */
 446         return div_output(so, m, (struct sockaddr_in *)nam, control);
 447 }
 448
 449 SYSCTL_DECL(_net_inet_divert);
 450 SYSCTL_PROC(_net_inet_divert, OID_AUTO, pcblist, CTLFLAG_RD, &divcbinfo, 0,
 451             in_pcblist_global, "S,xinpcb", "List of active divert sockets");
 452
 453 struct pr_usrreqs div_usrreqs = {
 454         div_abort, pru_accept_notsupp, div_attach, div_bind,
 455         pru_connect_notsupp, pru_connect2_notsupp, in_control, div_detach,
 456         div_disconnect, pru_listen_notsupp, in_setpeeraddr, pru_rcvd_notsupp,
 457         pru_rcvoob_notsupp, div_send, pru_sense_null, div_shutdown,
 458         in_setsockaddr, sosend, soreceive, sopoll
 459 };