ip_divert.c revision 130901
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 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD: head/sys/netinet/ip_divert.c 130901 2004-06-22 04:00:51Z rwatson $ 30 */ 31 32#include "opt_inet.h" 33#include "opt_ipfw.h" 34#include "opt_ipdivert.h" 35#include "opt_ipsec.h" 36#include "opt_mac.h" 37 38#ifndef INET 39#error "IPDIVERT requires INET." 40#endif 41 42#include <sys/param.h> 43#include <sys/kernel.h> 44#include <sys/lock.h> 45#include <sys/malloc.h> 46#include <sys/mac.h> 47#include <sys/mbuf.h> 48#include <sys/proc.h> 49#include <sys/protosw.h> 50#include <sys/signalvar.h> 51#include <sys/socket.h> 52#include <sys/socketvar.h> 53#include <sys/sx.h> 54#include <sys/sysctl.h> 55#include <sys/systm.h> 56 57#include <vm/uma.h> 58 59#include <net/if.h> 60#include <net/route.h> 61 62#include <netinet/in.h> 63#include <netinet/in_pcb.h> 64#include <netinet/in_systm.h> 65#include <netinet/in_var.h> 66#include <netinet/ip.h> 67#include <netinet/ip_divert.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 */ 105static struct inpcbhead divcb; 106static struct inpcbinfo divcbinfo; 107 108static u_long div_sendspace = DIVSNDQ; /* XXX sysctl ? */ 109static u_long div_recvspace = DIVRCVQ; /* XXX sysctl ? */ 110 111/* 112 * Initialize divert connection block queue. 113 */ 114void 115div_init(void) 116{ 117 INP_INFO_LOCK_INIT(&divcbinfo, "div"); 118 LIST_INIT(&divcb); 119 divcbinfo.listhead = &divcb; 120 /* 121 * XXX We don't use the hash list for divert IP, but it's easier 122 * to allocate a one entry hash list than it is to check all 123 * over the place for hashbase == NULL. 124 */ 125 divcbinfo.hashbase = hashinit(1, M_PCB, &divcbinfo.hashmask); 126 divcbinfo.porthashbase = hashinit(1, M_PCB, &divcbinfo.porthashmask); 127 divcbinfo.ipi_zone = uma_zcreate("divcb", sizeof(struct inpcb), 128 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, UMA_ZONE_NOFREE); 129 uma_zone_set_max(divcbinfo.ipi_zone, maxsockets); 130} 131 132/* 133 * IPPROTO_DIVERT is not in the real IP protocol number space; this 134 * function should never be called. Just in case, drop any packets. 135 */ 136void 137div_input(struct mbuf *m, int off) 138{ 139 ipstat.ips_noproto++; 140 m_freem(m); 141} 142 143/* 144 * Divert a packet by passing it up to the divert socket at port 'port'. 145 * 146 * Setup generic address and protocol structures for div_input routine, 147 * then pass them along with mbuf chain. 148 */ 149void 150divert_packet(struct mbuf *m, int incoming) 151{ 152 struct ip *ip; 153 struct inpcb *inp; 154 struct socket *sa; 155 u_int16_t nport; 156 struct sockaddr_in divsrc; 157 struct m_tag *mtag; 158 159 mtag = m_tag_find(m, PACKET_TAG_DIVERT, NULL); 160 if (mtag == NULL) { 161 printf("%s: no divert tag\n", __func__); 162 m_freem(m); 163 return; 164 } 165 /* Assure header */ 166 if (m->m_len < sizeof(struct ip) && 167 (m = m_pullup(m, sizeof(struct ip))) == 0) 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 bzero(&divsrc, sizeof(divsrc)); 176 divsrc.sin_len = sizeof(divsrc); 177 divsrc.sin_family = AF_INET; 178 divsrc.sin_port = divert_cookie(mtag); /* record matching rule */ 179 if (incoming) { 180 struct ifaddr *ifa; 181 182 /* Sanity check */ 183 M_ASSERTPKTHDR(m); 184 185 /* Find IP address for receive interface */ 186 TAILQ_FOREACH(ifa, &m->m_pkthdr.rcvif->if_addrhead, ifa_link) { 187 if (ifa->ifa_addr == NULL) 188 continue; 189 if (ifa->ifa_addr->sa_family != AF_INET) 190 continue; 191 divsrc.sin_addr = 192 ((struct sockaddr_in *) ifa->ifa_addr)->sin_addr; 193 break; 194 } 195 } 196 /* 197 * Record the incoming interface name whenever we have one. 198 */ 199 if (m->m_pkthdr.rcvif) { 200 /* 201 * Hide the actual interface name in there in the 202 * sin_zero array. XXX This needs to be moved to a 203 * different sockaddr type for divert, e.g. 204 * sockaddr_div with multiple fields like 205 * sockaddr_dl. Presently we have only 7 bytes 206 * but that will do for now as most interfaces 207 * are 4 or less + 2 or less bytes for unit. 208 * There is probably a faster way of doing this, 209 * possibly taking it from the sockaddr_dl on the iface. 210 * This solves the problem of a P2P link and a LAN interface 211 * having the same address, which can result in the wrong 212 * interface being assigned to the packet when fed back 213 * into the divert socket. Theoretically if the daemon saves 214 * and re-uses the sockaddr_in as suggested in the man pages, 215 * this iface name will come along for the ride. 216 * (see div_output for the other half of this.) 217 */ 218 strlcpy(divsrc.sin_zero, m->m_pkthdr.rcvif->if_xname, 219 sizeof(divsrc.sin_zero)); 220 } 221 222 /* Put packet on socket queue, if any */ 223 sa = NULL; 224 nport = htons((u_int16_t)divert_info(mtag)); 225 INP_INFO_RLOCK(&divcbinfo); 226 LIST_FOREACH(inp, &divcb, inp_list) { 227 INP_LOCK(inp); 228 /* XXX why does only one socket match? */ 229 if (inp->inp_lport == nport) { 230 sa = inp->inp_socket; 231 if (sbappendaddr(&sa->so_rcv, 232 (struct sockaddr *)&divsrc, m, 233 (struct mbuf *)0) == 0) 234 sa = NULL; /* force mbuf reclaim below */ 235 else 236 sorwakeup(sa); 237 INP_UNLOCK(inp); 238 break; 239 } 240 INP_UNLOCK(inp); 241 } 242 INP_INFO_RUNLOCK(&divcbinfo); 243 if (sa == NULL) { 244 m_freem(m); 245 ipstat.ips_noproto++; 246 ipstat.ips_delivered--; 247 } 248} 249 250/* 251 * Deliver packet back into the IP processing machinery. 252 * 253 * If no address specified, or address is 0.0.0.0, send to ip_output(); 254 * otherwise, send to ip_input() and mark as having been received on 255 * the interface with that address. 256 */ 257static int 258div_output(struct socket *so, struct mbuf *m, 259 struct sockaddr_in *sin, struct mbuf *control) 260{ 261 int error = 0; 262 263 KASSERT(m->m_pkthdr.rcvif == NULL, ("rcvif not null")); 264 265 if (control) 266 m_freem(control); /* XXX */ 267 268 /* Loopback avoidance and state recovery */ 269 if (sin) { 270 struct m_tag *mtag; 271 struct divert_tag *dt; 272 int i; 273 274 mtag = m_tag_get(PACKET_TAG_DIVERT, 275 sizeof(struct divert_tag), M_NOWAIT); 276 if (mtag == NULL) { 277 error = ENOBUFS; 278 goto cantsend; 279 } 280 dt = (struct divert_tag *)(mtag+1); 281 dt->info = 0; 282 dt->cookie = sin->sin_port; 283 m_tag_prepend(m, mtag); 284 285 /* 286 * Find receive interface with the given name, stuffed 287 * (if it exists) in the sin_zero[] field. 288 * The name is user supplied data so don't trust its size 289 * or that it is zero terminated. 290 */ 291 for (i = 0; i < sizeof(sin->sin_zero) && sin->sin_zero[i]; i++) 292 ; 293 if ( i > 0 && i < sizeof(sin->sin_zero)) 294 m->m_pkthdr.rcvif = ifunit(sin->sin_zero); 295 } 296 297 /* Reinject packet into the system as incoming or outgoing */ 298 if (!sin || sin->sin_addr.s_addr == 0) { 299 struct ip *const ip = mtod(m, struct ip *); 300 struct inpcb *inp; 301 302 INP_INFO_WLOCK(&divcbinfo); 303 inp = sotoinpcb(so); 304 INP_LOCK(inp); 305 /* 306 * Don't allow both user specified and setsockopt options, 307 * and don't allow packet length sizes that will crash 308 */ 309 if (((ip->ip_hl != (sizeof (*ip) >> 2)) && inp->inp_options) || 310 ((u_short)ntohs(ip->ip_len) > m->m_pkthdr.len)) { 311 error = EINVAL; 312 m_freem(m); 313 } else { 314 /* Convert fields to host order for ip_output() */ 315 ip->ip_len = ntohs(ip->ip_len); 316 ip->ip_off = ntohs(ip->ip_off); 317 318 /* Send packet to output processing */ 319 ipstat.ips_rawout++; /* XXX */ 320 321#ifdef MAC 322 mac_create_mbuf_from_inpcb(inp, m); 323#endif 324 error = ip_output(m, 325 inp->inp_options, NULL, 326 (so->so_options & SO_DONTROUTE) | 327 IP_ALLOWBROADCAST | IP_RAWOUTPUT, 328 inp->inp_moptions, NULL); 329 } 330 INP_UNLOCK(inp); 331 INP_INFO_WUNLOCK(&divcbinfo); 332 } else { 333 if (m->m_pkthdr.rcvif == NULL) { 334 /* 335 * No luck with the name, check by IP address. 336 * Clear the port and the ifname to make sure 337 * there are no distractions for ifa_ifwithaddr. 338 */ 339 struct ifaddr *ifa; 340 341 bzero(sin->sin_zero, sizeof(sin->sin_zero)); 342 sin->sin_port = 0; 343 ifa = ifa_ifwithaddr((struct sockaddr *) sin); 344 if (ifa == NULL) { 345 error = EADDRNOTAVAIL; 346 goto cantsend; 347 } 348 m->m_pkthdr.rcvif = ifa->ifa_ifp; 349 } 350#ifdef MAC 351 SOCK_LOCK(so); 352 mac_create_mbuf_from_socket(so, m); 353 SOCK_UNLOCK(so); 354#endif 355 /* Send packet to input processing */ 356 ip_input(m); 357 } 358 359 return error; 360 361cantsend: 362 m_freem(m); 363 return error; 364} 365 366/* 367 * Return a copy of the specified packet, but without 368 * the divert tag. This is used when packets are ``tee'd'' 369 * and we want the cloned copy to not have divert processing. 370 */ 371struct mbuf * 372divert_clone(struct mbuf *m) 373{ 374 struct mbuf *clone; 375 struct m_tag *mtag; 376 377 clone = m_dup(m, M_DONTWAIT); 378 if (clone != NULL) { 379 /* strip divert tag from copy */ 380 mtag = m_tag_find(clone, PACKET_TAG_DIVERT, NULL); 381 if (mtag != NULL) 382 m_tag_delete(clone, mtag); 383 } 384 return clone; 385} 386 387static int 388div_attach(struct socket *so, int proto, struct thread *td) 389{ 390 struct inpcb *inp; 391 int error; 392 393 INP_INFO_WLOCK(&divcbinfo); 394 inp = sotoinpcb(so); 395 if (inp != 0) { 396 INP_INFO_WUNLOCK(&divcbinfo); 397 return EINVAL; 398 } 399 if (td && (error = suser(td)) != 0) { 400 INP_INFO_WUNLOCK(&divcbinfo); 401 return error; 402 } 403 error = soreserve(so, div_sendspace, div_recvspace); 404 if (error) { 405 INP_INFO_WUNLOCK(&divcbinfo); 406 return error; 407 } 408 error = in_pcballoc(so, &divcbinfo, "divinp"); 409 if (error) { 410 INP_INFO_WUNLOCK(&divcbinfo); 411 return error; 412 } 413 inp = (struct inpcb *)so->so_pcb; 414 INP_LOCK(inp); 415 INP_INFO_WUNLOCK(&divcbinfo); 416 inp->inp_ip_p = proto; 417 inp->inp_vflag |= INP_IPV4; 418 inp->inp_flags |= INP_HDRINCL; 419 /* The socket is always "connected" because 420 we always know "where" to send the packet */ 421 INP_UNLOCK(inp); 422 SOCK_LOCK(so); 423 so->so_state |= SS_ISCONNECTED; 424 SOCK_UNLOCK(so); 425 return 0; 426} 427 428static int 429div_detach(struct socket *so) 430{ 431 struct inpcb *inp; 432 433 INP_INFO_WLOCK(&divcbinfo); 434 inp = sotoinpcb(so); 435 if (inp == 0) { 436 INP_INFO_WUNLOCK(&divcbinfo); 437 return EINVAL; 438 } 439 INP_LOCK(inp); 440 in_pcbdetach(inp); 441 INP_INFO_WUNLOCK(&divcbinfo); 442 return 0; 443} 444 445static int 446div_abort(struct socket *so) 447{ 448 struct inpcb *inp; 449 450 INP_INFO_WLOCK(&divcbinfo); 451 inp = sotoinpcb(so); 452 if (inp == 0) { 453 INP_INFO_WUNLOCK(&divcbinfo); 454 return EINVAL; /* ??? possible? panic instead? */ 455 } 456 INP_LOCK(inp); 457 soisdisconnected(so); 458 in_pcbdetach(inp); 459 INP_INFO_WUNLOCK(&divcbinfo); 460 return 0; 461} 462 463static int 464div_disconnect(struct socket *so) 465{ 466 if ((so->so_state & SS_ISCONNECTED) == 0) 467 return ENOTCONN; 468 return div_abort(so); 469} 470 471static int 472div_bind(struct socket *so, struct sockaddr *nam, struct thread *td) 473{ 474 struct inpcb *inp; 475 int error; 476 477 INP_INFO_WLOCK(&divcbinfo); 478 inp = sotoinpcb(so); 479 if (inp == 0) { 480 INP_INFO_WUNLOCK(&divcbinfo); 481 return EINVAL; 482 } 483 /* in_pcbbind assumes that nam is a sockaddr_in 484 * and in_pcbbind requires a valid address. Since divert 485 * sockets don't we need to make sure the address is 486 * filled in properly. 487 * XXX -- divert should not be abusing in_pcbind 488 * and should probably have its own family. 489 */ 490 if (nam->sa_family != AF_INET) 491 error = EAFNOSUPPORT; 492 else { 493 ((struct sockaddr_in *)nam)->sin_addr.s_addr = INADDR_ANY; 494 INP_LOCK(inp); 495 error = in_pcbbind(inp, nam, td->td_ucred); 496 INP_UNLOCK(inp); 497 } 498 INP_INFO_WUNLOCK(&divcbinfo); 499 return error; 500} 501 502static int 503div_shutdown(struct socket *so) 504{ 505 struct inpcb *inp; 506 507 INP_INFO_RLOCK(&divcbinfo); 508 inp = sotoinpcb(so); 509 if (inp == 0) { 510 INP_INFO_RUNLOCK(&divcbinfo); 511 return EINVAL; 512 } 513 INP_LOCK(inp); 514 INP_INFO_RUNLOCK(&divcbinfo); 515 socantsendmore(so); 516 INP_UNLOCK(inp); 517 return 0; 518} 519 520static int 521div_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam, 522 struct mbuf *control, struct thread *td) 523{ 524 /* Packet must have a header (but that's about it) */ 525 if (m->m_len < sizeof (struct ip) && 526 (m = m_pullup(m, sizeof (struct ip))) == 0) { 527 ipstat.ips_toosmall++; 528 m_freem(m); 529 return EINVAL; 530 } 531 532 /* Send packet */ 533 return div_output(so, m, (struct sockaddr_in *)nam, control); 534} 535 536void 537div_ctlinput(int cmd, struct sockaddr *sa, void *vip) 538{ 539 struct in_addr faddr; 540 541 faddr = ((struct sockaddr_in *)sa)->sin_addr; 542 if (sa->sa_family != AF_INET || faddr.s_addr == INADDR_ANY) 543 return; 544 if (PRC_IS_REDIRECT(cmd)) 545 return; 546} 547 548static int 549div_pcblist(SYSCTL_HANDLER_ARGS) 550{ 551 int error, i, n; 552 struct inpcb *inp, **inp_list; 553 inp_gen_t gencnt; 554 struct xinpgen xig; 555 556 /* 557 * The process of preparing the TCB list is too time-consuming and 558 * resource-intensive to repeat twice on every request. 559 */ 560 if (req->oldptr == 0) { 561 n = divcbinfo.ipi_count; 562 req->oldidx = 2 * (sizeof xig) 563 + (n + n/8) * sizeof(struct xinpcb); 564 return 0; 565 } 566 567 if (req->newptr != 0) 568 return EPERM; 569 570 /* 571 * OK, now we're committed to doing something. 572 */ 573 INP_INFO_RLOCK(&divcbinfo); 574 gencnt = divcbinfo.ipi_gencnt; 575 n = divcbinfo.ipi_count; 576 INP_INFO_RUNLOCK(&divcbinfo); 577 578 error = sysctl_wire_old_buffer(req, 579 2 * sizeof(xig) + n*sizeof(struct xinpcb)); 580 if (error != 0) 581 return (error); 582 583 xig.xig_len = sizeof xig; 584 xig.xig_count = n; 585 xig.xig_gen = gencnt; 586 xig.xig_sogen = so_gencnt; 587 error = SYSCTL_OUT(req, &xig, sizeof xig); 588 if (error) 589 return error; 590 591 inp_list = malloc(n * sizeof *inp_list, M_TEMP, M_WAITOK); 592 if (inp_list == 0) 593 return ENOMEM; 594 595 INP_INFO_RLOCK(&divcbinfo); 596 for (inp = LIST_FIRST(divcbinfo.listhead), i = 0; inp && i < n; 597 inp = LIST_NEXT(inp, inp_list)) { 598 INP_LOCK(inp); 599 if (inp->inp_gencnt <= gencnt && 600 cr_canseesocket(req->td->td_ucred, inp->inp_socket) == 0) 601 inp_list[i++] = inp; 602 INP_UNLOCK(inp); 603 } 604 INP_INFO_RUNLOCK(&divcbinfo); 605 n = i; 606 607 error = 0; 608 for (i = 0; i < n; i++) { 609 inp = inp_list[i]; 610 if (inp->inp_gencnt <= gencnt) { 611 struct xinpcb xi; 612 xi.xi_len = sizeof xi; 613 /* XXX should avoid extra copy */ 614 bcopy(inp, &xi.xi_inp, sizeof *inp); 615 if (inp->inp_socket) 616 sotoxsocket(inp->inp_socket, &xi.xi_socket); 617 error = SYSCTL_OUT(req, &xi, sizeof xi); 618 } 619 } 620 if (!error) { 621 /* 622 * Give the user an updated idea of our state. 623 * If the generation differs from what we told 624 * her before, she knows that something happened 625 * while we were processing this request, and it 626 * might be necessary to retry. 627 */ 628 INP_INFO_RLOCK(&divcbinfo); 629 xig.xig_gen = divcbinfo.ipi_gencnt; 630 xig.xig_sogen = so_gencnt; 631 xig.xig_count = divcbinfo.ipi_count; 632 INP_INFO_RUNLOCK(&divcbinfo); 633 error = SYSCTL_OUT(req, &xig, sizeof xig); 634 } 635 free(inp_list, M_TEMP); 636 return error; 637} 638 639/* 640 * This is the wrapper function for in_setsockaddr. We just pass down 641 * the pcbinfo for in_setpeeraddr to lock. 642 */ 643static int 644div_sockaddr(struct socket *so, struct sockaddr **nam) 645{ 646 return (in_setsockaddr(so, nam, &divcbinfo)); 647} 648 649/* 650 * This is the wrapper function for in_setpeeraddr. We just pass down 651 * the pcbinfo for in_setpeeraddr to lock. 652 */ 653static int 654div_peeraddr(struct socket *so, struct sockaddr **nam) 655{ 656 return (in_setpeeraddr(so, nam, &divcbinfo)); 657} 658 659 660SYSCTL_DECL(_net_inet_divert); 661SYSCTL_PROC(_net_inet_divert, OID_AUTO, pcblist, CTLFLAG_RD, 0, 0, 662 div_pcblist, "S,xinpcb", "List of active divert sockets"); 663 664struct pr_usrreqs div_usrreqs = { 665 div_abort, pru_accept_notsupp, div_attach, div_bind, 666 pru_connect_notsupp, pru_connect2_notsupp, in_control, div_detach, 667 div_disconnect, pru_listen_notsupp, div_peeraddr, pru_rcvd_notsupp, 668 pru_rcvoob_notsupp, div_send, pru_sense_null, div_shutdown, 669 div_sockaddr, sosend, soreceive, sopoll, in_pcbsosetlabel 670}; 671