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