]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/netpfil/ipfw/ip_fw2.c
MFC r346884:
[FreeBSD/FreeBSD.git] / sys / netpfil / ipfw / ip_fw2.c
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30
31 /*
32  * The FreeBSD IP packet firewall, main file
33  */
34
35 #include "opt_ipfw.h"
36 #include "opt_ipdivert.h"
37 #include "opt_inet.h"
38 #ifndef INET
39 #error "IPFIREWALL requires INET"
40 #endif /* INET */
41 #include "opt_inet6.h"
42
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/condvar.h>
46 #include <sys/counter.h>
47 #include <sys/eventhandler.h>
48 #include <sys/malloc.h>
49 #include <sys/mbuf.h>
50 #include <sys/kernel.h>
51 #include <sys/lock.h>
52 #include <sys/jail.h>
53 #include <sys/module.h>
54 #include <sys/priv.h>
55 #include <sys/proc.h>
56 #include <sys/rwlock.h>
57 #include <sys/rmlock.h>
58 #include <sys/socket.h>
59 #include <sys/socketvar.h>
60 #include <sys/sysctl.h>
61 #include <sys/syslog.h>
62 #include <sys/ucred.h>
63 #include <net/ethernet.h> /* for ETHERTYPE_IP */
64 #include <net/if.h>
65 #include <net/if_var.h>
66 #include <net/route.h>
67 #include <net/pfil.h>
68 #include <net/vnet.h>
69
70 #include <netpfil/pf/pf_mtag.h>
71
72 #include <netinet/in.h>
73 #include <netinet/in_var.h>
74 #include <netinet/in_pcb.h>
75 #include <netinet/ip.h>
76 #include <netinet/ip_var.h>
77 #include <netinet/ip_icmp.h>
78 #include <netinet/ip_fw.h>
79 #include <netinet/ip_carp.h>
80 #include <netinet/pim.h>
81 #include <netinet/tcp_var.h>
82 #include <netinet/udp.h>
83 #include <netinet/udp_var.h>
84 #include <netinet/sctp.h>
85 #include <netinet/sctp_crc32.h>
86 #include <netinet/sctp_header.h>
87
88 #include <netinet/ip6.h>
89 #include <netinet/icmp6.h>
90 #include <netinet/in_fib.h>
91 #ifdef INET6
92 #include <netinet6/in6_fib.h>
93 #include <netinet6/in6_pcb.h>
94 #include <netinet6/scope6_var.h>
95 #include <netinet6/ip6_var.h>
96 #endif
97
98 #include <net/if_gre.h> /* for struct grehdr */
99
100 #include <netpfil/ipfw/ip_fw_private.h>
101
102 #include <machine/in_cksum.h>   /* XXX for in_cksum */
103
104 #ifdef MAC
105 #include <security/mac/mac_framework.h>
106 #endif
107
108 /*
109  * static variables followed by global ones.
110  * All ipfw global variables are here.
111  */
112
113 VNET_DEFINE_STATIC(int, fw_deny_unknown_exthdrs);
114 #define V_fw_deny_unknown_exthdrs       VNET(fw_deny_unknown_exthdrs)
115
116 VNET_DEFINE_STATIC(int, fw_permit_single_frag6) = 1;
117 #define V_fw_permit_single_frag6        VNET(fw_permit_single_frag6)
118
119 #ifdef IPFIREWALL_DEFAULT_TO_ACCEPT
120 static int default_to_accept = 1;
121 #else
122 static int default_to_accept;
123 #endif
124
125 VNET_DEFINE(int, autoinc_step);
126 VNET_DEFINE(int, fw_one_pass) = 1;
127
128 VNET_DEFINE(unsigned int, fw_tables_max);
129 VNET_DEFINE(unsigned int, fw_tables_sets) = 0;  /* Don't use set-aware tables */
130 /* Use 128 tables by default */
131 static unsigned int default_fw_tables = IPFW_TABLES_DEFAULT;
132
133 #ifndef LINEAR_SKIPTO
134 static int jump_fast(struct ip_fw_chain *chain, struct ip_fw *f, int num,
135     int tablearg, int jump_backwards);
136 #define JUMP(ch, f, num, targ, back)    jump_fast(ch, f, num, targ, back)
137 #else
138 static int jump_linear(struct ip_fw_chain *chain, struct ip_fw *f, int num,
139     int tablearg, int jump_backwards);
140 #define JUMP(ch, f, num, targ, back)    jump_linear(ch, f, num, targ, back)
141 #endif
142
143 /*
144  * Each rule belongs to one of 32 different sets (0..31).
145  * The variable set_disable contains one bit per set.
146  * If the bit is set, all rules in the corresponding set
147  * are disabled. Set RESVD_SET(31) is reserved for the default rule
148  * and rules that are not deleted by the flush command,
149  * and CANNOT be disabled.
150  * Rules in set RESVD_SET can only be deleted individually.
151  */
152 VNET_DEFINE(u_int32_t, set_disable);
153 #define V_set_disable                   VNET(set_disable)
154
155 VNET_DEFINE(int, fw_verbose);
156 /* counter for ipfw_log(NULL...) */
157 VNET_DEFINE(u_int64_t, norule_counter);
158 VNET_DEFINE(int, verbose_limit);
159
160 /* layer3_chain contains the list of rules for layer 3 */
161 VNET_DEFINE(struct ip_fw_chain, layer3_chain);
162
163 /* ipfw_vnet_ready controls when we are open for business */
164 VNET_DEFINE(int, ipfw_vnet_ready) = 0;
165
166 VNET_DEFINE(int, ipfw_nat_ready) = 0;
167
168 ipfw_nat_t *ipfw_nat_ptr = NULL;
169 struct cfg_nat *(*lookup_nat_ptr)(struct nat_list *, int);
170 ipfw_nat_cfg_t *ipfw_nat_cfg_ptr;
171 ipfw_nat_cfg_t *ipfw_nat_del_ptr;
172 ipfw_nat_cfg_t *ipfw_nat_get_cfg_ptr;
173 ipfw_nat_cfg_t *ipfw_nat_get_log_ptr;
174
175 #ifdef SYSCTL_NODE
176 uint32_t dummy_def = IPFW_DEFAULT_RULE;
177 static int sysctl_ipfw_table_num(SYSCTL_HANDLER_ARGS);
178 static int sysctl_ipfw_tables_sets(SYSCTL_HANDLER_ARGS);
179
180 SYSBEGIN(f3)
181
182 SYSCTL_NODE(_net_inet_ip, OID_AUTO, fw, CTLFLAG_RW, 0, "Firewall");
183 SYSCTL_INT(_net_inet_ip_fw, OID_AUTO, one_pass,
184     CTLFLAG_VNET | CTLFLAG_RW | CTLFLAG_SECURE3, &VNET_NAME(fw_one_pass), 0,
185     "Only do a single pass through ipfw when using dummynet(4)");
186 SYSCTL_INT(_net_inet_ip_fw, OID_AUTO, autoinc_step,
187     CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(autoinc_step), 0,
188     "Rule number auto-increment step");
189 SYSCTL_INT(_net_inet_ip_fw, OID_AUTO, verbose,
190     CTLFLAG_VNET | CTLFLAG_RW | CTLFLAG_SECURE3, &VNET_NAME(fw_verbose), 0,
191     "Log matches to ipfw rules");
192 SYSCTL_INT(_net_inet_ip_fw, OID_AUTO, verbose_limit,
193     CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(verbose_limit), 0,
194     "Set upper limit of matches of ipfw rules logged");
195 SYSCTL_UINT(_net_inet_ip_fw, OID_AUTO, default_rule, CTLFLAG_RD,
196     &dummy_def, 0,
197     "The default/max possible rule number.");
198 SYSCTL_PROC(_net_inet_ip_fw, OID_AUTO, tables_max,
199     CTLFLAG_VNET | CTLTYPE_UINT | CTLFLAG_RW, 0, 0, sysctl_ipfw_table_num, "IU",
200     "Maximum number of concurrently used tables");
201 SYSCTL_PROC(_net_inet_ip_fw, OID_AUTO, tables_sets,
202     CTLFLAG_VNET | CTLTYPE_UINT | CTLFLAG_RW,
203     0, 0, sysctl_ipfw_tables_sets, "IU",
204     "Use per-set namespace for tables");
205 SYSCTL_INT(_net_inet_ip_fw, OID_AUTO, default_to_accept, CTLFLAG_RDTUN,
206     &default_to_accept, 0,
207     "Make the default rule accept all packets.");
208 TUNABLE_INT("net.inet.ip.fw.tables_max", (int *)&default_fw_tables);
209 SYSCTL_INT(_net_inet_ip_fw, OID_AUTO, static_count,
210     CTLFLAG_VNET | CTLFLAG_RD, &VNET_NAME(layer3_chain.n_rules), 0,
211     "Number of static rules");
212
213 #ifdef INET6
214 SYSCTL_DECL(_net_inet6_ip6);
215 SYSCTL_NODE(_net_inet6_ip6, OID_AUTO, fw, CTLFLAG_RW, 0, "Firewall");
216 SYSCTL_INT(_net_inet6_ip6_fw, OID_AUTO, deny_unknown_exthdrs,
217     CTLFLAG_VNET | CTLFLAG_RW | CTLFLAG_SECURE,
218     &VNET_NAME(fw_deny_unknown_exthdrs), 0,
219     "Deny packets with unknown IPv6 Extension Headers");
220 SYSCTL_INT(_net_inet6_ip6_fw, OID_AUTO, permit_single_frag6,
221     CTLFLAG_VNET | CTLFLAG_RW | CTLFLAG_SECURE,
222     &VNET_NAME(fw_permit_single_frag6), 0,
223     "Permit single packet IPv6 fragments");
224 #endif /* INET6 */
225
226 SYSEND
227
228 #endif /* SYSCTL_NODE */
229
230
231 /*
232  * Some macros used in the various matching options.
233  * L3HDR maps an ipv4 pointer into a layer3 header pointer of type T
234  * Other macros just cast void * into the appropriate type
235  */
236 #define L3HDR(T, ip)    ((T *)((u_int32_t *)(ip) + (ip)->ip_hl))
237 #define TCP(p)          ((struct tcphdr *)(p))
238 #define SCTP(p)         ((struct sctphdr *)(p))
239 #define UDP(p)          ((struct udphdr *)(p))
240 #define ICMP(p)         ((struct icmphdr *)(p))
241 #define ICMP6(p)        ((struct icmp6_hdr *)(p))
242
243 static __inline int
244 icmptype_match(struct icmphdr *icmp, ipfw_insn_u32 *cmd)
245 {
246         int type = icmp->icmp_type;
247
248         return (type <= ICMP_MAXTYPE && (cmd->d[0] & (1<<type)) );
249 }
250
251 #define TT      ( (1 << ICMP_ECHO) | (1 << ICMP_ROUTERSOLICIT) | \
252     (1 << ICMP_TSTAMP) | (1 << ICMP_IREQ) | (1 << ICMP_MASKREQ) )
253
254 static int
255 is_icmp_query(struct icmphdr *icmp)
256 {
257         int type = icmp->icmp_type;
258
259         return (type <= ICMP_MAXTYPE && (TT & (1<<type)) );
260 }
261 #undef TT
262
263 /*
264  * The following checks use two arrays of 8 or 16 bits to store the
265  * bits that we want set or clear, respectively. They are in the
266  * low and high half of cmd->arg1 or cmd->d[0].
267  *
268  * We scan options and store the bits we find set. We succeed if
269  *
270  *      (want_set & ~bits) == 0 && (want_clear & ~bits) == want_clear
271  *
272  * The code is sometimes optimized not to store additional variables.
273  */
274
275 static int
276 flags_match(ipfw_insn *cmd, u_int8_t bits)
277 {
278         u_char want_clear;
279         bits = ~bits;
280
281         if ( ((cmd->arg1 & 0xff) & bits) != 0)
282                 return 0; /* some bits we want set were clear */
283         want_clear = (cmd->arg1 >> 8) & 0xff;
284         if ( (want_clear & bits) != want_clear)
285                 return 0; /* some bits we want clear were set */
286         return 1;
287 }
288
289 static int
290 ipopts_match(struct ip *ip, ipfw_insn *cmd)
291 {
292         int optlen, bits = 0;
293         u_char *cp = (u_char *)(ip + 1);
294         int x = (ip->ip_hl << 2) - sizeof (struct ip);
295
296         for (; x > 0; x -= optlen, cp += optlen) {
297                 int opt = cp[IPOPT_OPTVAL];
298
299                 if (opt == IPOPT_EOL)
300                         break;
301                 if (opt == IPOPT_NOP)
302                         optlen = 1;
303                 else {
304                         optlen = cp[IPOPT_OLEN];
305                         if (optlen <= 0 || optlen > x)
306                                 return 0; /* invalid or truncated */
307                 }
308                 switch (opt) {
309
310                 default:
311                         break;
312
313                 case IPOPT_LSRR:
314                         bits |= IP_FW_IPOPT_LSRR;
315                         break;
316
317                 case IPOPT_SSRR:
318                         bits |= IP_FW_IPOPT_SSRR;
319                         break;
320
321                 case IPOPT_RR:
322                         bits |= IP_FW_IPOPT_RR;
323                         break;
324
325                 case IPOPT_TS:
326                         bits |= IP_FW_IPOPT_TS;
327                         break;
328                 }
329         }
330         return (flags_match(cmd, bits));
331 }
332
333 static int
334 tcpopts_match(struct tcphdr *tcp, ipfw_insn *cmd)
335 {
336         int optlen, bits = 0;
337         u_char *cp = (u_char *)(tcp + 1);
338         int x = (tcp->th_off << 2) - sizeof(struct tcphdr);
339
340         for (; x > 0; x -= optlen, cp += optlen) {
341                 int opt = cp[0];
342                 if (opt == TCPOPT_EOL)
343                         break;
344                 if (opt == TCPOPT_NOP)
345                         optlen = 1;
346                 else {
347                         optlen = cp[1];
348                         if (optlen <= 0)
349                                 break;
350                 }
351
352                 switch (opt) {
353
354                 default:
355                         break;
356
357                 case TCPOPT_MAXSEG:
358                         bits |= IP_FW_TCPOPT_MSS;
359                         break;
360
361                 case TCPOPT_WINDOW:
362                         bits |= IP_FW_TCPOPT_WINDOW;
363                         break;
364
365                 case TCPOPT_SACK_PERMITTED:
366                 case TCPOPT_SACK:
367                         bits |= IP_FW_TCPOPT_SACK;
368                         break;
369
370                 case TCPOPT_TIMESTAMP:
371                         bits |= IP_FW_TCPOPT_TS;
372                         break;
373
374                 }
375         }
376         return (flags_match(cmd, bits));
377 }
378
379 static int
380 iface_match(struct ifnet *ifp, ipfw_insn_if *cmd, struct ip_fw_chain *chain,
381     uint32_t *tablearg)
382 {
383
384         if (ifp == NULL)        /* no iface with this packet, match fails */
385                 return (0);
386
387         /* Check by name or by IP address */
388         if (cmd->name[0] != '\0') { /* match by name */
389                 if (cmd->name[0] == '\1') /* use tablearg to match */
390                         return ipfw_lookup_table(chain, cmd->p.kidx, 0,
391                             &ifp->if_index, tablearg);
392                 /* Check name */
393                 if (cmd->p.glob) {
394                         if (fnmatch(cmd->name, ifp->if_xname, 0) == 0)
395                                 return(1);
396                 } else {
397                         if (strncmp(ifp->if_xname, cmd->name, IFNAMSIZ) == 0)
398                                 return(1);
399                 }
400         } else {
401 #if !defined(USERSPACE) && defined(__FreeBSD__) /* and OSX too ? */
402                 struct ifaddr *ia;
403
404                 if_addr_rlock(ifp);
405                 CK_STAILQ_FOREACH(ia, &ifp->if_addrhead, ifa_link) {
406                         if (ia->ifa_addr->sa_family != AF_INET)
407                                 continue;
408                         if (cmd->p.ip.s_addr == ((struct sockaddr_in *)
409                             (ia->ifa_addr))->sin_addr.s_addr) {
410                                 if_addr_runlock(ifp);
411                                 return(1);      /* match */
412                         }
413                 }
414                 if_addr_runlock(ifp);
415 #endif /* __FreeBSD__ */
416         }
417         return(0);      /* no match, fail ... */
418 }
419
420 /*
421  * The verify_path function checks if a route to the src exists and
422  * if it is reachable via ifp (when provided).
423  * 
424  * The 'verrevpath' option checks that the interface that an IP packet
425  * arrives on is the same interface that traffic destined for the
426  * packet's source address would be routed out of.
427  * The 'versrcreach' option just checks that the source address is
428  * reachable via any route (except default) in the routing table.
429  * These two are a measure to block forged packets. This is also
430  * commonly known as "anti-spoofing" or Unicast Reverse Path
431  * Forwarding (Unicast RFP) in Cisco-ese. The name of the knobs
432  * is purposely reminiscent of the Cisco IOS command,
433  *
434  *   ip verify unicast reverse-path
435  *   ip verify unicast source reachable-via any
436  *
437  * which implements the same functionality. But note that the syntax
438  * is misleading, and the check may be performed on all IP packets
439  * whether unicast, multicast, or broadcast.
440  */
441 static int
442 verify_path(struct in_addr src, struct ifnet *ifp, u_int fib)
443 {
444 #if defined(USERSPACE) || !defined(__FreeBSD__)
445         return 0;
446 #else
447         struct nhop4_basic nh4;
448
449         if (fib4_lookup_nh_basic(fib, src, NHR_IFAIF, 0, &nh4) != 0)
450                 return (0);
451
452         /*
453          * If ifp is provided, check for equality with rtentry.
454          * We should use rt->rt_ifa->ifa_ifp, instead of rt->rt_ifp,
455          * in order to pass packets injected back by if_simloop():
456          * routing entry (via lo0) for our own address
457          * may exist, so we need to handle routing assymetry.
458          */
459         if (ifp != NULL && ifp != nh4.nh_ifp)
460                 return (0);
461
462         /* if no ifp provided, check if rtentry is not default route */
463         if (ifp == NULL && (nh4.nh_flags & NHF_DEFAULT) != 0)
464                 return (0);
465
466         /* or if this is a blackhole/reject route */
467         if (ifp == NULL && (nh4.nh_flags & (NHF_REJECT|NHF_BLACKHOLE)) != 0)
468                 return (0);
469
470         /* found valid route */
471         return 1;
472 #endif /* __FreeBSD__ */
473 }
474
475 /*
476  * Generate an SCTP packet containing an ABORT chunk. The verification tag
477  * is given by vtag. The T-bit is set in the ABORT chunk if and only if
478  * reflected is not 0.
479  */
480
481 static struct mbuf *
482 ipfw_send_abort(struct mbuf *replyto, struct ipfw_flow_id *id, u_int32_t vtag,
483     int reflected)
484 {
485         struct mbuf *m;
486         struct ip *ip;
487 #ifdef INET6
488         struct ip6_hdr *ip6;
489 #endif
490         struct sctphdr *sctp;
491         struct sctp_chunkhdr *chunk;
492         u_int16_t hlen, plen, tlen;
493
494         MGETHDR(m, M_NOWAIT, MT_DATA);
495         if (m == NULL)
496                 return (NULL);
497
498         M_SETFIB(m, id->fib);
499 #ifdef MAC
500         if (replyto != NULL)
501                 mac_netinet_firewall_reply(replyto, m);
502         else
503                 mac_netinet_firewall_send(m);
504 #else
505         (void)replyto;          /* don't warn about unused arg */
506 #endif
507
508         switch (id->addr_type) {
509         case 4:
510                 hlen = sizeof(struct ip);
511                 break;
512 #ifdef INET6
513         case 6:
514                 hlen = sizeof(struct ip6_hdr);
515                 break;
516 #endif
517         default:
518                 /* XXX: log me?!? */
519                 FREE_PKT(m);
520                 return (NULL);
521         }
522         plen = sizeof(struct sctphdr) + sizeof(struct sctp_chunkhdr);
523         tlen = hlen + plen;
524         m->m_data += max_linkhdr;
525         m->m_flags |= M_SKIP_FIREWALL;
526         m->m_pkthdr.len = m->m_len = tlen;
527         m->m_pkthdr.rcvif = NULL;
528         bzero(m->m_data, tlen);
529
530         switch (id->addr_type) {
531         case 4:
532                 ip = mtod(m, struct ip *);
533
534                 ip->ip_v = 4;
535                 ip->ip_hl = sizeof(struct ip) >> 2;
536                 ip->ip_tos = IPTOS_LOWDELAY;
537                 ip->ip_len = htons(tlen);
538                 ip->ip_id = htons(0);
539                 ip->ip_off = htons(0);
540                 ip->ip_ttl = V_ip_defttl;
541                 ip->ip_p = IPPROTO_SCTP;
542                 ip->ip_sum = 0;
543                 ip->ip_src.s_addr = htonl(id->dst_ip);
544                 ip->ip_dst.s_addr = htonl(id->src_ip);
545
546                 sctp = (struct sctphdr *)(ip + 1);
547                 break;
548 #ifdef INET6
549         case 6:
550                 ip6 = mtod(m, struct ip6_hdr *);
551
552                 ip6->ip6_vfc = IPV6_VERSION;
553                 ip6->ip6_plen = htons(plen);
554                 ip6->ip6_nxt = IPPROTO_SCTP;
555                 ip6->ip6_hlim = IPV6_DEFHLIM;
556                 ip6->ip6_src = id->dst_ip6;
557                 ip6->ip6_dst = id->src_ip6;
558
559                 sctp = (struct sctphdr *)(ip6 + 1);
560                 break;
561 #endif
562         }
563
564         sctp->src_port = htons(id->dst_port);
565         sctp->dest_port = htons(id->src_port);
566         sctp->v_tag = htonl(vtag);
567         sctp->checksum = htonl(0);
568
569         chunk = (struct sctp_chunkhdr *)(sctp + 1);
570         chunk->chunk_type = SCTP_ABORT_ASSOCIATION;
571         chunk->chunk_flags = 0;
572         if (reflected != 0) {
573                 chunk->chunk_flags |= SCTP_HAD_NO_TCB;
574         }
575         chunk->chunk_length = htons(sizeof(struct sctp_chunkhdr));
576
577         sctp->checksum = sctp_calculate_cksum(m, hlen);
578
579         return (m);
580 }
581
582 /*
583  * Generate a TCP packet, containing either a RST or a keepalive.
584  * When flags & TH_RST, we are sending a RST packet, because of a
585  * "reset" action matched the packet.
586  * Otherwise we are sending a keepalive, and flags & TH_
587  * The 'replyto' mbuf is the mbuf being replied to, if any, and is required
588  * so that MAC can label the reply appropriately.
589  */
590 struct mbuf *
591 ipfw_send_pkt(struct mbuf *replyto, struct ipfw_flow_id *id, u_int32_t seq,
592     u_int32_t ack, int flags)
593 {
594         struct mbuf *m = NULL;          /* stupid compiler */
595         struct ip *h = NULL;            /* stupid compiler */
596 #ifdef INET6
597         struct ip6_hdr *h6 = NULL;
598 #endif
599         struct tcphdr *th = NULL;
600         int len, dir;
601
602         MGETHDR(m, M_NOWAIT, MT_DATA);
603         if (m == NULL)
604                 return (NULL);
605
606         M_SETFIB(m, id->fib);
607 #ifdef MAC
608         if (replyto != NULL)
609                 mac_netinet_firewall_reply(replyto, m);
610         else
611                 mac_netinet_firewall_send(m);
612 #else
613         (void)replyto;          /* don't warn about unused arg */
614 #endif
615
616         switch (id->addr_type) {
617         case 4:
618                 len = sizeof(struct ip) + sizeof(struct tcphdr);
619                 break;
620 #ifdef INET6
621         case 6:
622                 len = sizeof(struct ip6_hdr) + sizeof(struct tcphdr);
623                 break;
624 #endif
625         default:
626                 /* XXX: log me?!? */
627                 FREE_PKT(m);
628                 return (NULL);
629         }
630         dir = ((flags & (TH_SYN | TH_RST)) == TH_SYN);
631
632         m->m_data += max_linkhdr;
633         m->m_flags |= M_SKIP_FIREWALL;
634         m->m_pkthdr.len = m->m_len = len;
635         m->m_pkthdr.rcvif = NULL;
636         bzero(m->m_data, len);
637
638         switch (id->addr_type) {
639         case 4:
640                 h = mtod(m, struct ip *);
641
642                 /* prepare for checksum */
643                 h->ip_p = IPPROTO_TCP;
644                 h->ip_len = htons(sizeof(struct tcphdr));
645                 if (dir) {
646                         h->ip_src.s_addr = htonl(id->src_ip);
647                         h->ip_dst.s_addr = htonl(id->dst_ip);
648                 } else {
649                         h->ip_src.s_addr = htonl(id->dst_ip);
650                         h->ip_dst.s_addr = htonl(id->src_ip);
651                 }
652
653                 th = (struct tcphdr *)(h + 1);
654                 break;
655 #ifdef INET6
656         case 6:
657                 h6 = mtod(m, struct ip6_hdr *);
658
659                 /* prepare for checksum */
660                 h6->ip6_nxt = IPPROTO_TCP;
661                 h6->ip6_plen = htons(sizeof(struct tcphdr));
662                 if (dir) {
663                         h6->ip6_src = id->src_ip6;
664                         h6->ip6_dst = id->dst_ip6;
665                 } else {
666                         h6->ip6_src = id->dst_ip6;
667                         h6->ip6_dst = id->src_ip6;
668                 }
669
670                 th = (struct tcphdr *)(h6 + 1);
671                 break;
672 #endif
673         }
674
675         if (dir) {
676                 th->th_sport = htons(id->src_port);
677                 th->th_dport = htons(id->dst_port);
678         } else {
679                 th->th_sport = htons(id->dst_port);
680                 th->th_dport = htons(id->src_port);
681         }
682         th->th_off = sizeof(struct tcphdr) >> 2;
683
684         if (flags & TH_RST) {
685                 if (flags & TH_ACK) {
686                         th->th_seq = htonl(ack);
687                         th->th_flags = TH_RST;
688                 } else {
689                         if (flags & TH_SYN)
690                                 seq++;
691                         th->th_ack = htonl(seq);
692                         th->th_flags = TH_RST | TH_ACK;
693                 }
694         } else {
695                 /*
696                  * Keepalive - use caller provided sequence numbers
697                  */
698                 th->th_seq = htonl(seq);
699                 th->th_ack = htonl(ack);
700                 th->th_flags = TH_ACK;
701         }
702
703         switch (id->addr_type) {
704         case 4:
705                 th->th_sum = in_cksum(m, len);
706
707                 /* finish the ip header */
708                 h->ip_v = 4;
709                 h->ip_hl = sizeof(*h) >> 2;
710                 h->ip_tos = IPTOS_LOWDELAY;
711                 h->ip_off = htons(0);
712                 h->ip_len = htons(len);
713                 h->ip_ttl = V_ip_defttl;
714                 h->ip_sum = 0;
715                 break;
716 #ifdef INET6
717         case 6:
718                 th->th_sum = in6_cksum(m, IPPROTO_TCP, sizeof(*h6),
719                     sizeof(struct tcphdr));
720
721                 /* finish the ip6 header */
722                 h6->ip6_vfc |= IPV6_VERSION;
723                 h6->ip6_hlim = IPV6_DEFHLIM;
724                 break;
725 #endif
726         }
727
728         return (m);
729 }
730
731 #ifdef INET6
732 /*
733  * ipv6 specific rules here...
734  */
735 static __inline int
736 icmp6type_match (int type, ipfw_insn_u32 *cmd)
737 {
738         return (type <= ICMP6_MAXTYPE && (cmd->d[type/32] & (1<<(type%32)) ) );
739 }
740
741 static int
742 flow6id_match( int curr_flow, ipfw_insn_u32 *cmd )
743 {
744         int i;
745         for (i=0; i <= cmd->o.arg1; ++i )
746                 if (curr_flow == cmd->d[i] )
747                         return 1;
748         return 0;
749 }
750
751 /* support for IP6_*_ME opcodes */
752 static const struct in6_addr lla_mask = {{{
753         0xff, 0xff, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff,
754         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
755 }}};
756
757 static int
758 ipfw_localip6(struct in6_addr *in6)
759 {
760         struct rm_priotracker in6_ifa_tracker;
761         struct in6_ifaddr *ia;
762
763         if (IN6_IS_ADDR_MULTICAST(in6))
764                 return (0);
765
766         if (!IN6_IS_ADDR_LINKLOCAL(in6))
767                 return (in6_localip(in6));
768
769         IN6_IFADDR_RLOCK(&in6_ifa_tracker);
770         CK_STAILQ_FOREACH(ia, &V_in6_ifaddrhead, ia_link) {
771                 if (!IN6_IS_ADDR_LINKLOCAL(&ia->ia_addr.sin6_addr))
772                         continue;
773                 if (IN6_ARE_MASKED_ADDR_EQUAL(&ia->ia_addr.sin6_addr,
774                     in6, &lla_mask)) {
775                         IN6_IFADDR_RUNLOCK(&in6_ifa_tracker);
776                         return (1);
777                 }
778         }
779         IN6_IFADDR_RUNLOCK(&in6_ifa_tracker);
780         return (0);
781 }
782
783 static int
784 verify_path6(struct in6_addr *src, struct ifnet *ifp, u_int fib)
785 {
786         struct nhop6_basic nh6;
787
788         if (IN6_IS_SCOPE_LINKLOCAL(src))
789                 return (1);
790
791         if (fib6_lookup_nh_basic(fib, src, 0, NHR_IFAIF, 0, &nh6) != 0)
792                 return (0);
793
794         /* If ifp is provided, check for equality with route table. */
795         if (ifp != NULL && ifp != nh6.nh_ifp)
796                 return (0);
797
798         /* if no ifp provided, check if rtentry is not default route */
799         if (ifp == NULL && (nh6.nh_flags & NHF_DEFAULT) != 0)
800                 return (0);
801
802         /* or if this is a blackhole/reject route */
803         if (ifp == NULL && (nh6.nh_flags & (NHF_REJECT|NHF_BLACKHOLE)) != 0)
804                 return (0);
805
806         /* found valid route */
807         return 1;
808 }
809
810 static int
811 is_icmp6_query(int icmp6_type)
812 {
813         if ((icmp6_type <= ICMP6_MAXTYPE) &&
814             (icmp6_type == ICMP6_ECHO_REQUEST ||
815             icmp6_type == ICMP6_MEMBERSHIP_QUERY ||
816             icmp6_type == ICMP6_WRUREQUEST ||
817             icmp6_type == ICMP6_FQDN_QUERY ||
818             icmp6_type == ICMP6_NI_QUERY))
819                 return (1);
820
821         return (0);
822 }
823
824 static int
825 map_icmp_unreach(int code)
826 {
827
828         /* RFC 7915 p4.2 */
829         switch (code) {
830         case ICMP_UNREACH_NET:
831         case ICMP_UNREACH_HOST:
832         case ICMP_UNREACH_SRCFAIL:
833         case ICMP_UNREACH_NET_UNKNOWN:
834         case ICMP_UNREACH_HOST_UNKNOWN:
835         case ICMP_UNREACH_TOSNET:
836         case ICMP_UNREACH_TOSHOST:
837                 return (ICMP6_DST_UNREACH_NOROUTE);
838         case ICMP_UNREACH_PORT:
839                 return (ICMP6_DST_UNREACH_NOPORT);
840         default:
841                 /*
842                  * Map the rest of codes into admit prohibited.
843                  * XXX: unreach proto should be mapped into ICMPv6
844                  * parameter problem, but we use only unreach type.
845                  */
846                 return (ICMP6_DST_UNREACH_ADMIN);
847         }
848 }
849
850 static void
851 send_reject6(struct ip_fw_args *args, int code, u_int hlen, struct ip6_hdr *ip6)
852 {
853         struct mbuf *m;
854
855         m = args->m;
856         if (code == ICMP6_UNREACH_RST && args->f_id.proto == IPPROTO_TCP) {
857                 struct tcphdr *tcp;
858                 tcp = (struct tcphdr *)((char *)ip6 + hlen);
859
860                 if ((tcp->th_flags & TH_RST) == 0) {
861                         struct mbuf *m0;
862                         m0 = ipfw_send_pkt(args->m, &(args->f_id),
863                             ntohl(tcp->th_seq), ntohl(tcp->th_ack),
864                             tcp->th_flags | TH_RST);
865                         if (m0 != NULL)
866                                 ip6_output(m0, NULL, NULL, 0, NULL, NULL,
867                                     NULL);
868                 }
869                 FREE_PKT(m);
870         } else if (code == ICMP6_UNREACH_ABORT &&
871             args->f_id.proto == IPPROTO_SCTP) {
872                 struct mbuf *m0;
873                 struct sctphdr *sctp;
874                 u_int32_t v_tag;
875                 int reflected;
876
877                 sctp = (struct sctphdr *)((char *)ip6 + hlen);
878                 reflected = 1;
879                 v_tag = ntohl(sctp->v_tag);
880                 /* Investigate the first chunk header if available */
881                 if (m->m_len >= hlen + sizeof(struct sctphdr) +
882                     sizeof(struct sctp_chunkhdr)) {
883                         struct sctp_chunkhdr *chunk;
884
885                         chunk = (struct sctp_chunkhdr *)(sctp + 1);
886                         switch (chunk->chunk_type) {
887                         case SCTP_INITIATION:
888                                 /*
889                                  * Packets containing an INIT chunk MUST have
890                                  * a zero v-tag.
891                                  */
892                                 if (v_tag != 0) {
893                                         v_tag = 0;
894                                         break;
895                                 }
896                                 /* INIT chunk MUST NOT be bundled */
897                                 if (m->m_pkthdr.len >
898                                     hlen + sizeof(struct sctphdr) +
899                                     ntohs(chunk->chunk_length) + 3) {
900                                         break;
901                                 }
902                                 /* Use the initiate tag if available */
903                                 if ((m->m_len >= hlen + sizeof(struct sctphdr) +
904                                     sizeof(struct sctp_chunkhdr) +
905                                     offsetof(struct sctp_init, a_rwnd))) {
906                                         struct sctp_init *init;
907
908                                         init = (struct sctp_init *)(chunk + 1);
909                                         v_tag = ntohl(init->initiate_tag);
910                                         reflected = 0;
911                                 }
912                                 break;
913                         case SCTP_ABORT_ASSOCIATION:
914                                 /*
915                                  * If the packet contains an ABORT chunk, don't
916                                  * reply.
917                                  * XXX: We should search through all chunks,
918                                  *      but don't do to avoid attacks.
919                                  */
920                                 v_tag = 0;
921                                 break;
922                         }
923                 }
924                 if (v_tag == 0) {
925                         m0 = NULL;
926                 } else {
927                         m0 = ipfw_send_abort(args->m, &(args->f_id), v_tag,
928                             reflected);
929                 }
930                 if (m0 != NULL)
931                         ip6_output(m0, NULL, NULL, 0, NULL, NULL, NULL);
932                 FREE_PKT(m);
933         } else if (code != ICMP6_UNREACH_RST && code != ICMP6_UNREACH_ABORT) {
934                 /* Send an ICMPv6 unreach. */
935 #if 0
936                 /*
937                  * Unlike above, the mbufs need to line up with the ip6 hdr,
938                  * as the contents are read. We need to m_adj() the
939                  * needed amount.
940                  * The mbuf will however be thrown away so we can adjust it.
941                  * Remember we did an m_pullup on it already so we
942                  * can make some assumptions about contiguousness.
943                  */
944                 if (args->L3offset)
945                         m_adj(m, args->L3offset);
946 #endif
947                 icmp6_error(m, ICMP6_DST_UNREACH, code, 0);
948         } else
949                 FREE_PKT(m);
950
951         args->m = NULL;
952 }
953
954 #endif /* INET6 */
955
956
957 /*
958  * sends a reject message, consuming the mbuf passed as an argument.
959  */
960 static void
961 send_reject(struct ip_fw_args *args, int code, int iplen, struct ip *ip)
962 {
963
964 #if 0
965         /* XXX When ip is not guaranteed to be at mtod() we will
966          * need to account for this */
967          * The mbuf will however be thrown away so we can adjust it.
968          * Remember we did an m_pullup on it already so we
969          * can make some assumptions about contiguousness.
970          */
971         if (args->L3offset)
972                 m_adj(m, args->L3offset);
973 #endif
974         if (code != ICMP_REJECT_RST && code != ICMP_REJECT_ABORT) {
975                 /* Send an ICMP unreach */
976                 icmp_error(args->m, ICMP_UNREACH, code, 0L, 0);
977         } else if (code == ICMP_REJECT_RST && args->f_id.proto == IPPROTO_TCP) {
978                 struct tcphdr *const tcp =
979                     L3HDR(struct tcphdr, mtod(args->m, struct ip *));
980                 if ( (tcp->th_flags & TH_RST) == 0) {
981                         struct mbuf *m;
982                         m = ipfw_send_pkt(args->m, &(args->f_id),
983                                 ntohl(tcp->th_seq), ntohl(tcp->th_ack),
984                                 tcp->th_flags | TH_RST);
985                         if (m != NULL)
986                                 ip_output(m, NULL, NULL, 0, NULL, NULL);
987                 }
988                 FREE_PKT(args->m);
989         } else if (code == ICMP_REJECT_ABORT &&
990             args->f_id.proto == IPPROTO_SCTP) {
991                 struct mbuf *m;
992                 struct sctphdr *sctp;
993                 struct sctp_chunkhdr *chunk;
994                 struct sctp_init *init;
995                 u_int32_t v_tag;
996                 int reflected;
997
998                 sctp = L3HDR(struct sctphdr, mtod(args->m, struct ip *));
999                 reflected = 1;
1000                 v_tag = ntohl(sctp->v_tag);
1001                 if (iplen >= (ip->ip_hl << 2) + sizeof(struct sctphdr) +
1002                     sizeof(struct sctp_chunkhdr)) {
1003                         /* Look at the first chunk header if available */
1004                         chunk = (struct sctp_chunkhdr *)(sctp + 1);
1005                         switch (chunk->chunk_type) {
1006                         case SCTP_INITIATION:
1007                                 /*
1008                                  * Packets containing an INIT chunk MUST have
1009                                  * a zero v-tag.
1010                                  */
1011                                 if (v_tag != 0) {
1012                                         v_tag = 0;
1013                                         break;
1014                                 }
1015                                 /* INIT chunk MUST NOT be bundled */
1016                                 if (iplen >
1017                                     (ip->ip_hl << 2) + sizeof(struct sctphdr) +
1018                                     ntohs(chunk->chunk_length) + 3) {
1019                                         break;
1020                                 }
1021                                 /* Use the initiate tag if available */
1022                                 if ((iplen >= (ip->ip_hl << 2) +
1023                                     sizeof(struct sctphdr) +
1024                                     sizeof(struct sctp_chunkhdr) +
1025                                     offsetof(struct sctp_init, a_rwnd))) {
1026                                         init = (struct sctp_init *)(chunk + 1);
1027                                         v_tag = ntohl(init->initiate_tag);
1028                                         reflected = 0;
1029                                 }
1030                                 break;
1031                         case SCTP_ABORT_ASSOCIATION:
1032                                 /*
1033                                  * If the packet contains an ABORT chunk, don't
1034                                  * reply.
1035                                  * XXX: We should search through all chunks,
1036                                  * but don't do to avoid attacks.
1037                                  */
1038                                 v_tag = 0;
1039                                 break;
1040                         }
1041                 }
1042                 if (v_tag == 0) {
1043                         m = NULL;
1044                 } else {
1045                         m = ipfw_send_abort(args->m, &(args->f_id), v_tag,
1046                             reflected);
1047                 }
1048                 if (m != NULL)
1049                         ip_output(m, NULL, NULL, 0, NULL, NULL);
1050                 FREE_PKT(args->m);
1051         } else
1052                 FREE_PKT(args->m);
1053         args->m = NULL;
1054 }
1055
1056 /*
1057  * Support for uid/gid/jail lookup. These tests are expensive
1058  * (because we may need to look into the list of active sockets)
1059  * so we cache the results. ugid_lookupp is 0 if we have not
1060  * yet done a lookup, 1 if we succeeded, and -1 if we tried
1061  * and failed. The function always returns the match value.
1062  * We could actually spare the variable and use *uc, setting
1063  * it to '(void *)check_uidgid if we have no info, NULL if
1064  * we tried and failed, or any other value if successful.
1065  */
1066 static int
1067 check_uidgid(ipfw_insn_u32 *insn, struct ip_fw_args *args, int *ugid_lookupp,
1068     struct ucred **uc)
1069 {
1070 #if defined(USERSPACE)
1071         return 0;       // not supported in userspace
1072 #else
1073 #ifndef __FreeBSD__
1074         /* XXX */
1075         return cred_check(insn, proto, oif,
1076             dst_ip, dst_port, src_ip, src_port,
1077             (struct bsd_ucred *)uc, ugid_lookupp, ((struct mbuf *)inp)->m_skb);
1078 #else  /* FreeBSD */
1079         struct in_addr src_ip, dst_ip;
1080         struct inpcbinfo *pi;
1081         struct ipfw_flow_id *id;
1082         struct inpcb *pcb, *inp;
1083         struct ifnet *oif;
1084         int lookupflags;
1085         int match;
1086
1087         id = &args->f_id;
1088         inp = args->inp;
1089         oif = args->oif;
1090
1091         /*
1092          * Check to see if the UDP or TCP stack supplied us with
1093          * the PCB. If so, rather then holding a lock and looking
1094          * up the PCB, we can use the one that was supplied.
1095          */
1096         if (inp && *ugid_lookupp == 0) {
1097                 INP_LOCK_ASSERT(inp);
1098                 if (inp->inp_socket != NULL) {
1099                         *uc = crhold(inp->inp_cred);
1100                         *ugid_lookupp = 1;
1101                 } else
1102                         *ugid_lookupp = -1;
1103         }
1104         /*
1105          * If we have already been here and the packet has no
1106          * PCB entry associated with it, then we can safely
1107          * assume that this is a no match.
1108          */
1109         if (*ugid_lookupp == -1)
1110                 return (0);
1111         if (id->proto == IPPROTO_TCP) {
1112                 lookupflags = 0;
1113                 pi = &V_tcbinfo;
1114         } else if (id->proto == IPPROTO_UDP) {
1115                 lookupflags = INPLOOKUP_WILDCARD;
1116                 pi = &V_udbinfo;
1117         } else if (id->proto == IPPROTO_UDPLITE) {
1118                 lookupflags = INPLOOKUP_WILDCARD;
1119                 pi = &V_ulitecbinfo;
1120         } else
1121                 return 0;
1122         lookupflags |= INPLOOKUP_RLOCKPCB;
1123         match = 0;
1124         if (*ugid_lookupp == 0) {
1125                 if (id->addr_type == 6) {
1126 #ifdef INET6
1127                         if (oif == NULL)
1128                                 pcb = in6_pcblookup_mbuf(pi,
1129                                     &id->src_ip6, htons(id->src_port),
1130                                     &id->dst_ip6, htons(id->dst_port),
1131                                     lookupflags, oif, args->m);
1132                         else
1133                                 pcb = in6_pcblookup_mbuf(pi,
1134                                     &id->dst_ip6, htons(id->dst_port),
1135                                     &id->src_ip6, htons(id->src_port),
1136                                     lookupflags, oif, args->m);
1137 #else
1138                         *ugid_lookupp = -1;
1139                         return (0);
1140 #endif
1141                 } else {
1142                         src_ip.s_addr = htonl(id->src_ip);
1143                         dst_ip.s_addr = htonl(id->dst_ip);
1144                         if (oif == NULL)
1145                                 pcb = in_pcblookup_mbuf(pi,
1146                                     src_ip, htons(id->src_port),
1147                                     dst_ip, htons(id->dst_port),
1148                                     lookupflags, oif, args->m);
1149                         else
1150                                 pcb = in_pcblookup_mbuf(pi,
1151                                     dst_ip, htons(id->dst_port),
1152                                     src_ip, htons(id->src_port),
1153                                     lookupflags, oif, args->m);
1154                 }
1155                 if (pcb != NULL) {
1156                         INP_RLOCK_ASSERT(pcb);
1157                         *uc = crhold(pcb->inp_cred);
1158                         *ugid_lookupp = 1;
1159                         INP_RUNLOCK(pcb);
1160                 }
1161                 if (*ugid_lookupp == 0) {
1162                         /*
1163                          * We tried and failed, set the variable to -1
1164                          * so we will not try again on this packet.
1165                          */
1166                         *ugid_lookupp = -1;
1167                         return (0);
1168                 }
1169         }
1170         if (insn->o.opcode == O_UID)
1171                 match = ((*uc)->cr_uid == (uid_t)insn->d[0]);
1172         else if (insn->o.opcode == O_GID)
1173                 match = groupmember((gid_t)insn->d[0], *uc);
1174         else if (insn->o.opcode == O_JAIL)
1175                 match = ((*uc)->cr_prison->pr_id == (int)insn->d[0]);
1176         return (match);
1177 #endif /* __FreeBSD__ */
1178 #endif /* not supported in userspace */
1179 }
1180
1181 /*
1182  * Helper function to set args with info on the rule after the matching
1183  * one. slot is precise, whereas we guess rule_id as they are
1184  * assigned sequentially.
1185  */
1186 static inline void
1187 set_match(struct ip_fw_args *args, int slot,
1188         struct ip_fw_chain *chain)
1189 {
1190         args->rule.chain_id = chain->id;
1191         args->rule.slot = slot + 1; /* we use 0 as a marker */
1192         args->rule.rule_id = 1 + chain->map[slot]->id;
1193         args->rule.rulenum = chain->map[slot]->rulenum;
1194         args->flags |= IPFW_ARGS_REF;
1195 }
1196
1197 #ifndef LINEAR_SKIPTO
1198 /*
1199  * Helper function to enable cached rule lookups using
1200  * cached_id and cached_pos fields in ipfw rule.
1201  */
1202 static int
1203 jump_fast(struct ip_fw_chain *chain, struct ip_fw *f, int num,
1204     int tablearg, int jump_backwards)
1205 {
1206         int f_pos;
1207
1208         /* If possible use cached f_pos (in f->cached_pos),
1209          * whose version is written in f->cached_id
1210          * (horrible hacks to avoid changing the ABI).
1211          */
1212         if (num != IP_FW_TARG && f->cached_id == chain->id)
1213                 f_pos = f->cached_pos;
1214         else {
1215                 int i = IP_FW_ARG_TABLEARG(chain, num, skipto);
1216                 /* make sure we do not jump backward */
1217                 if (jump_backwards == 0 && i <= f->rulenum)
1218                         i = f->rulenum + 1;
1219                 if (chain->idxmap != NULL)
1220                         f_pos = chain->idxmap[i];
1221                 else
1222                         f_pos = ipfw_find_rule(chain, i, 0);
1223                 /* update the cache */
1224                 if (num != IP_FW_TARG) {
1225                         f->cached_id = chain->id;
1226                         f->cached_pos = f_pos;
1227                 }
1228         }
1229
1230         return (f_pos);
1231 }
1232 #else
1233 /*
1234  * Helper function to enable real fast rule lookups.
1235  */
1236 static int
1237 jump_linear(struct ip_fw_chain *chain, struct ip_fw *f, int num,
1238     int tablearg, int jump_backwards)
1239 {
1240         int f_pos;
1241
1242         num = IP_FW_ARG_TABLEARG(chain, num, skipto);
1243         /* make sure we do not jump backward */
1244         if (jump_backwards == 0 && num <= f->rulenum)
1245                 num = f->rulenum + 1;
1246         f_pos = chain->idxmap[num];
1247
1248         return (f_pos);
1249 }
1250 #endif
1251
1252 #define TARG(k, f)      IP_FW_ARG_TABLEARG(chain, k, f)
1253 /*
1254  * The main check routine for the firewall.
1255  *
1256  * All arguments are in args so we can modify them and return them
1257  * back to the caller.
1258  *
1259  * Parameters:
1260  *
1261  *      args->m (in/out) The packet; we set to NULL when/if we nuke it.
1262  *              Starts with the IP header.
1263  *      args->eh (in)   Mac header if present, NULL for layer3 packet.
1264  *      args->L3offset  Number of bytes bypassed if we came from L2.
1265  *                      e.g. often sizeof(eh)  ** NOTYET **
1266  *      args->oif       Outgoing interface, NULL if packet is incoming.
1267  *              The incoming interface is in the mbuf. (in)
1268  *      args->divert_rule (in/out)
1269  *              Skip up to the first rule past this rule number;
1270  *              upon return, non-zero port number for divert or tee.
1271  *
1272  *      args->rule      Pointer to the last matching rule (in/out)
1273  *      args->next_hop  Socket we are forwarding to (out).
1274  *      args->next_hop6 IPv6 next hop we are forwarding to (out).
1275  *      args->f_id      Addresses grabbed from the packet (out)
1276  *      args->rule.info a cookie depending on rule action
1277  *
1278  * Return value:
1279  *
1280  *      IP_FW_PASS      the packet must be accepted
1281  *      IP_FW_DENY      the packet must be dropped
1282  *      IP_FW_DIVERT    divert packet, port in m_tag
1283  *      IP_FW_TEE       tee packet, port in m_tag
1284  *      IP_FW_DUMMYNET  to dummynet, pipe in args->cookie
1285  *      IP_FW_NETGRAPH  into netgraph, cookie args->cookie
1286  *              args->rule contains the matching rule,
1287  *              args->rule.info has additional information.
1288  *
1289  */
1290 int
1291 ipfw_chk(struct ip_fw_args *args)
1292 {
1293
1294         /*
1295          * Local variables holding state while processing a packet:
1296          *
1297          * IMPORTANT NOTE: to speed up the processing of rules, there
1298          * are some assumption on the values of the variables, which
1299          * are documented here. Should you change them, please check
1300          * the implementation of the various instructions to make sure
1301          * that they still work.
1302          *
1303          * args->eh     The MAC header. It is non-null for a layer2
1304          *      packet, it is NULL for a layer-3 packet.
1305          * **notyet**
1306          * args->L3offset Offset in the packet to the L3 (IP or equiv.) header.
1307          *
1308          * m | args->m  Pointer to the mbuf, as received from the caller.
1309          *      It may change if ipfw_chk() does an m_pullup, or if it
1310          *      consumes the packet because it calls send_reject().
1311          *      XXX This has to change, so that ipfw_chk() never modifies
1312          *      or consumes the buffer.
1313          * ip   is the beginning of the ip(4 or 6) header.
1314          *      Calculated by adding the L3offset to the start of data.
1315          *      (Until we start using L3offset, the packet is
1316          *      supposed to start with the ip header).
1317          */
1318         struct mbuf *m = args->m;
1319         struct ip *ip = mtod(m, struct ip *);
1320
1321         /*
1322          * For rules which contain uid/gid or jail constraints, cache
1323          * a copy of the users credentials after the pcb lookup has been
1324          * executed. This will speed up the processing of rules with
1325          * these types of constraints, as well as decrease contention
1326          * on pcb related locks.
1327          */
1328 #ifndef __FreeBSD__
1329         struct bsd_ucred ucred_cache;
1330 #else
1331         struct ucred *ucred_cache = NULL;
1332 #endif
1333         int ucred_lookup = 0;
1334
1335         /*
1336          * oif | args->oif      If NULL, ipfw_chk has been called on the
1337          *      inbound path (ether_input, ip_input).
1338          *      If non-NULL, ipfw_chk has been called on the outbound path
1339          *      (ether_output, ip_output).
1340          */
1341         struct ifnet *oif = args->oif;
1342
1343         int f_pos = 0;          /* index of current rule in the array */
1344         int retval = 0;
1345
1346         /*
1347          * hlen The length of the IP header.
1348          */
1349         u_int hlen = 0;         /* hlen >0 means we have an IP pkt */
1350
1351         /*
1352          * offset       The offset of a fragment. offset != 0 means that
1353          *      we have a fragment at this offset of an IPv4 packet.
1354          *      offset == 0 means that (if this is an IPv4 packet)
1355          *      this is the first or only fragment.
1356          *      For IPv6 offset|ip6f_mf == 0 means there is no Fragment Header
1357          *      or there is a single packet fragment (fragment header added
1358          *      without needed).  We will treat a single packet fragment as if
1359          *      there was no fragment header (or log/block depending on the
1360          *      V_fw_permit_single_frag6 sysctl setting).
1361          */
1362         u_short offset = 0;
1363         u_short ip6f_mf = 0;
1364
1365         /*
1366          * Local copies of addresses. They are only valid if we have
1367          * an IP packet.
1368          *
1369          * proto        The protocol. Set to 0 for non-ip packets,
1370          *      or to the protocol read from the packet otherwise.
1371          *      proto != 0 means that we have an IPv4 packet.
1372          *
1373          * src_port, dst_port   port numbers, in HOST format. Only
1374          *      valid for TCP and UDP packets.
1375          *
1376          * src_ip, dst_ip       ip addresses, in NETWORK format.
1377          *      Only valid for IPv4 packets.
1378          */
1379         uint8_t proto;
1380         uint16_t src_port, dst_port;            /* NOTE: host format    */
1381         struct in_addr src_ip, dst_ip;          /* NOTE: network format */
1382         int iplen = 0;
1383         int pktlen;
1384         uint16_t etype;                 /* Host order stored ether type */
1385
1386         struct ipfw_dyn_info dyn_info;
1387         struct ip_fw *q = NULL;
1388         struct ip_fw_chain *chain = &V_layer3_chain;
1389
1390         /*
1391          * We store in ulp a pointer to the upper layer protocol header.
1392          * In the ipv4 case this is easy to determine from the header,
1393          * but for ipv6 we might have some additional headers in the middle.
1394          * ulp is NULL if not found.
1395          */
1396         void *ulp = NULL;               /* upper layer protocol pointer. */
1397
1398         /* XXX ipv6 variables */
1399         int is_ipv6 = 0;
1400         uint8_t icmp6_type = 0;
1401         uint16_t ext_hd = 0;    /* bits vector for extension header filtering */
1402         /* end of ipv6 variables */
1403
1404         int is_ipv4 = 0;
1405
1406         int done = 0;           /* flag to exit the outer loop */
1407
1408         if (m->m_flags & M_SKIP_FIREWALL || (! V_ipfw_vnet_ready))
1409                 return (IP_FW_PASS);    /* accept */
1410
1411         dst_ip.s_addr = 0;              /* make sure it is initialized */
1412         src_ip.s_addr = 0;              /* make sure it is initialized */
1413         src_port = dst_port = 0;
1414         pktlen = m->m_pkthdr.len;
1415
1416         DYN_INFO_INIT(&dyn_info);
1417 /*
1418  * PULLUP_TO(len, p, T) makes sure that len + sizeof(T) is contiguous,
1419  * then it sets p to point at the offset "len" in the mbuf. WARNING: the
1420  * pointer might become stale after other pullups (but we never use it
1421  * this way).
1422  */
1423 #define PULLUP_TO(_len, p, T)   PULLUP_LEN(_len, p, sizeof(T))
1424 #define PULLUP_LEN(_len, p, T)                                  \
1425 do {                                                            \
1426         int x = (_len) + T;                                     \
1427         if ((m)->m_len < x) {                                   \
1428                 args->m = m = m_pullup(m, x);                   \
1429                 if (m == NULL)                                  \
1430                         goto pullup_failed;                     \
1431         }                                                       \
1432         p = (mtod(m, char *) + (_len));                         \
1433 } while (0)
1434
1435         /*
1436          * if we have an ether header,
1437          */
1438         if (args->flags & IPFW_ARGS_ETHER)
1439                 etype = ntohs(args->eh->ether_type);
1440         else
1441                 etype = 0;
1442
1443         /* Identify IP packets and fill up variables. */
1444         if (pktlen >= sizeof(struct ip6_hdr) &&
1445             (etype == 0 || etype == ETHERTYPE_IPV6) && ip->ip_v == 6) {
1446                 struct ip6_hdr *ip6 = (struct ip6_hdr *)ip;
1447
1448                 is_ipv6 = 1;
1449                 hlen = sizeof(struct ip6_hdr);
1450                 proto = ip6->ip6_nxt;
1451                 /* Search extension headers to find upper layer protocols */
1452                 while (ulp == NULL && offset == 0) {
1453                         switch (proto) {
1454                         case IPPROTO_ICMPV6:
1455                                 PULLUP_TO(hlen, ulp, struct icmp6_hdr);
1456                                 icmp6_type = ICMP6(ulp)->icmp6_type;
1457                                 break;
1458
1459                         case IPPROTO_TCP:
1460                                 PULLUP_TO(hlen, ulp, struct tcphdr);
1461                                 dst_port = TCP(ulp)->th_dport;
1462                                 src_port = TCP(ulp)->th_sport;
1463                                 /* save flags for dynamic rules */
1464                                 args->f_id._flags = TCP(ulp)->th_flags;
1465                                 break;
1466
1467                         case IPPROTO_SCTP:
1468                                 if (pktlen >= hlen + sizeof(struct sctphdr) +
1469                                     sizeof(struct sctp_chunkhdr) +
1470                                     offsetof(struct sctp_init, a_rwnd))
1471                                         PULLUP_LEN(hlen, ulp,
1472                                             sizeof(struct sctphdr) +
1473                                             sizeof(struct sctp_chunkhdr) +
1474                                             offsetof(struct sctp_init, a_rwnd));
1475                                 else if (pktlen >= hlen + sizeof(struct sctphdr))
1476                                         PULLUP_LEN(hlen, ulp, pktlen - hlen);
1477                                 else
1478                                         PULLUP_LEN(hlen, ulp,
1479                                             sizeof(struct sctphdr));
1480                                 src_port = SCTP(ulp)->src_port;
1481                                 dst_port = SCTP(ulp)->dest_port;
1482                                 break;
1483
1484                         case IPPROTO_UDP:
1485                         case IPPROTO_UDPLITE:
1486                                 PULLUP_TO(hlen, ulp, struct udphdr);
1487                                 dst_port = UDP(ulp)->uh_dport;
1488                                 src_port = UDP(ulp)->uh_sport;
1489                                 break;
1490
1491                         case IPPROTO_HOPOPTS:   /* RFC 2460 */
1492                                 PULLUP_TO(hlen, ulp, struct ip6_hbh);
1493                                 ext_hd |= EXT_HOPOPTS;
1494                                 hlen += (((struct ip6_hbh *)ulp)->ip6h_len + 1) << 3;
1495                                 proto = ((struct ip6_hbh *)ulp)->ip6h_nxt;
1496                                 ulp = NULL;
1497                                 break;
1498
1499                         case IPPROTO_ROUTING:   /* RFC 2460 */
1500                                 PULLUP_TO(hlen, ulp, struct ip6_rthdr);
1501                                 switch (((struct ip6_rthdr *)ulp)->ip6r_type) {
1502                                 case 0:
1503                                         ext_hd |= EXT_RTHDR0;
1504                                         break;
1505                                 case 2:
1506                                         ext_hd |= EXT_RTHDR2;
1507                                         break;
1508                                 default:
1509                                         if (V_fw_verbose)
1510                                                 printf("IPFW2: IPV6 - Unknown "
1511                                                     "Routing Header type(%d)\n",
1512                                                     ((struct ip6_rthdr *)
1513                                                     ulp)->ip6r_type);
1514                                         if (V_fw_deny_unknown_exthdrs)
1515                                             return (IP_FW_DENY);
1516                                         break;
1517                                 }
1518                                 ext_hd |= EXT_ROUTING;
1519                                 hlen += (((struct ip6_rthdr *)ulp)->ip6r_len + 1) << 3;
1520                                 proto = ((struct ip6_rthdr *)ulp)->ip6r_nxt;
1521                                 ulp = NULL;
1522                                 break;
1523
1524                         case IPPROTO_FRAGMENT:  /* RFC 2460 */
1525                                 PULLUP_TO(hlen, ulp, struct ip6_frag);
1526                                 ext_hd |= EXT_FRAGMENT;
1527                                 hlen += sizeof (struct ip6_frag);
1528                                 proto = ((struct ip6_frag *)ulp)->ip6f_nxt;
1529                                 offset = ((struct ip6_frag *)ulp)->ip6f_offlg &
1530                                         IP6F_OFF_MASK;
1531                                 ip6f_mf = ((struct ip6_frag *)ulp)->ip6f_offlg &
1532                                         IP6F_MORE_FRAG;
1533                                 if (V_fw_permit_single_frag6 == 0 &&
1534                                     offset == 0 && ip6f_mf == 0) {
1535                                         if (V_fw_verbose)
1536                                                 printf("IPFW2: IPV6 - Invalid "
1537                                                     "Fragment Header\n");
1538                                         if (V_fw_deny_unknown_exthdrs)
1539                                             return (IP_FW_DENY);
1540                                         break;
1541                                 }
1542                                 args->f_id.extra =
1543                                     ntohl(((struct ip6_frag *)ulp)->ip6f_ident);
1544                                 ulp = NULL;
1545                                 break;
1546
1547                         case IPPROTO_DSTOPTS:   /* RFC 2460 */
1548                                 PULLUP_TO(hlen, ulp, struct ip6_hbh);
1549                                 ext_hd |= EXT_DSTOPTS;
1550                                 hlen += (((struct ip6_hbh *)ulp)->ip6h_len + 1) << 3;
1551                                 proto = ((struct ip6_hbh *)ulp)->ip6h_nxt;
1552                                 ulp = NULL;
1553                                 break;
1554
1555                         case IPPROTO_AH:        /* RFC 2402 */
1556                                 PULLUP_TO(hlen, ulp, struct ip6_ext);
1557                                 ext_hd |= EXT_AH;
1558                                 hlen += (((struct ip6_ext *)ulp)->ip6e_len + 2) << 2;
1559                                 proto = ((struct ip6_ext *)ulp)->ip6e_nxt;
1560                                 ulp = NULL;
1561                                 break;
1562
1563                         case IPPROTO_ESP:       /* RFC 2406 */
1564                                 PULLUP_TO(hlen, ulp, uint32_t); /* SPI, Seq# */
1565                                 /* Anything past Seq# is variable length and
1566                                  * data past this ext. header is encrypted. */
1567                                 ext_hd |= EXT_ESP;
1568                                 break;
1569
1570                         case IPPROTO_NONE:      /* RFC 2460 */
1571                                 /*
1572                                  * Packet ends here, and IPv6 header has
1573                                  * already been pulled up. If ip6e_len!=0
1574                                  * then octets must be ignored.
1575                                  */
1576                                 ulp = ip; /* non-NULL to get out of loop. */
1577                                 break;
1578
1579                         case IPPROTO_OSPFIGP:
1580                                 /* XXX OSPF header check? */
1581                                 PULLUP_TO(hlen, ulp, struct ip6_ext);
1582                                 break;
1583
1584                         case IPPROTO_PIM:
1585                                 /* XXX PIM header check? */
1586                                 PULLUP_TO(hlen, ulp, struct pim);
1587                                 break;
1588
1589                         case IPPROTO_GRE:       /* RFC 1701 */
1590                                 /* XXX GRE header check? */
1591                                 PULLUP_TO(hlen, ulp, struct grehdr);
1592                                 break;
1593
1594                         case IPPROTO_CARP:
1595                                 PULLUP_TO(hlen, ulp, offsetof(
1596                                     struct carp_header, carp_counter));
1597                                 if (CARP_ADVERTISEMENT !=
1598                                     ((struct carp_header *)ulp)->carp_type)
1599                                         return (IP_FW_DENY);
1600                                 break;
1601
1602                         case IPPROTO_IPV6:      /* RFC 2893 */
1603                                 PULLUP_TO(hlen, ulp, struct ip6_hdr);
1604                                 break;
1605
1606                         case IPPROTO_IPV4:      /* RFC 2893 */
1607                                 PULLUP_TO(hlen, ulp, struct ip);
1608                                 break;
1609
1610                         default:
1611                                 if (V_fw_verbose)
1612                                         printf("IPFW2: IPV6 - Unknown "
1613                                             "Extension Header(%d), ext_hd=%x\n",
1614                                              proto, ext_hd);
1615                                 if (V_fw_deny_unknown_exthdrs)
1616                                     return (IP_FW_DENY);
1617                                 PULLUP_TO(hlen, ulp, struct ip6_ext);
1618                                 break;
1619                         } /*switch */
1620                 }
1621                 ip = mtod(m, struct ip *);
1622                 ip6 = (struct ip6_hdr *)ip;
1623                 args->f_id.addr_type = 6;
1624                 args->f_id.src_ip6 = ip6->ip6_src;
1625                 args->f_id.dst_ip6 = ip6->ip6_dst;
1626                 args->f_id.flow_id6 = ntohl(ip6->ip6_flow);
1627                 iplen = ntohs(ip6->ip6_plen) + sizeof(*ip6);
1628         } else if (pktlen >= sizeof(struct ip) &&
1629             (etype == 0 || etype == ETHERTYPE_IP) && ip->ip_v == 4) {
1630                 is_ipv4 = 1;
1631                 hlen = ip->ip_hl << 2;
1632                 /*
1633                  * Collect parameters into local variables for faster
1634                  * matching.
1635                  */
1636                 proto = ip->ip_p;
1637                 src_ip = ip->ip_src;
1638                 dst_ip = ip->ip_dst;
1639                 offset = ntohs(ip->ip_off) & IP_OFFMASK;
1640                 iplen = ntohs(ip->ip_len);
1641
1642                 if (offset == 0) {
1643                         switch (proto) {
1644                         case IPPROTO_TCP:
1645                                 PULLUP_TO(hlen, ulp, struct tcphdr);
1646                                 dst_port = TCP(ulp)->th_dport;
1647                                 src_port = TCP(ulp)->th_sport;
1648                                 /* save flags for dynamic rules */
1649                                 args->f_id._flags = TCP(ulp)->th_flags;
1650                                 break;
1651
1652                         case IPPROTO_SCTP:
1653                                 if (pktlen >= hlen + sizeof(struct sctphdr) +
1654                                     sizeof(struct sctp_chunkhdr) +
1655                                     offsetof(struct sctp_init, a_rwnd))
1656                                         PULLUP_LEN(hlen, ulp,
1657                                             sizeof(struct sctphdr) +
1658                                             sizeof(struct sctp_chunkhdr) +
1659                                             offsetof(struct sctp_init, a_rwnd));
1660                                 else if (pktlen >= hlen + sizeof(struct sctphdr))
1661                                         PULLUP_LEN(hlen, ulp, pktlen - hlen);
1662                                 else
1663                                         PULLUP_LEN(hlen, ulp,
1664                                             sizeof(struct sctphdr));
1665                                 src_port = SCTP(ulp)->src_port;
1666                                 dst_port = SCTP(ulp)->dest_port;
1667                                 break;
1668
1669                         case IPPROTO_UDP:
1670                         case IPPROTO_UDPLITE:
1671                                 PULLUP_TO(hlen, ulp, struct udphdr);
1672                                 dst_port = UDP(ulp)->uh_dport;
1673                                 src_port = UDP(ulp)->uh_sport;
1674                                 break;
1675
1676                         case IPPROTO_ICMP:
1677                                 PULLUP_TO(hlen, ulp, struct icmphdr);
1678                                 //args->f_id.flags = ICMP(ulp)->icmp_type;
1679                                 break;
1680
1681                         default:
1682                                 break;
1683                         }
1684                 }
1685
1686                 ip = mtod(m, struct ip *);
1687                 args->f_id.addr_type = 4;
1688                 args->f_id.src_ip = ntohl(src_ip.s_addr);
1689                 args->f_id.dst_ip = ntohl(dst_ip.s_addr);
1690         } else {
1691                 proto = 0;
1692                 dst_ip.s_addr = src_ip.s_addr = 0;
1693
1694                 args->f_id.addr_type = 1; /* XXX */
1695         }
1696 #undef PULLUP_TO
1697         pktlen = iplen < pktlen ? iplen: pktlen;
1698
1699         /* Properly initialize the rest of f_id */
1700         args->f_id.proto = proto;
1701         args->f_id.src_port = src_port = ntohs(src_port);
1702         args->f_id.dst_port = dst_port = ntohs(dst_port);
1703         args->f_id.fib = M_GETFIB(m);
1704
1705         IPFW_PF_RLOCK(chain);
1706         if (! V_ipfw_vnet_ready) { /* shutting down, leave NOW. */
1707                 IPFW_PF_RUNLOCK(chain);
1708                 return (IP_FW_PASS);    /* accept */
1709         }
1710         if (args->flags & IPFW_ARGS_REF) {
1711                 /*
1712                  * Packet has already been tagged as a result of a previous
1713                  * match on rule args->rule aka args->rule_id (PIPE, QUEUE,
1714                  * REASS, NETGRAPH, DIVERT/TEE...)
1715                  * Validate the slot and continue from the next one
1716                  * if still present, otherwise do a lookup.
1717                  */
1718                 f_pos = (args->rule.chain_id == chain->id) ?
1719                     args->rule.slot :
1720                     ipfw_find_rule(chain, args->rule.rulenum,
1721                         args->rule.rule_id);
1722         } else {
1723                 f_pos = 0;
1724         }
1725
1726         /*
1727          * Now scan the rules, and parse microinstructions for each rule.
1728          * We have two nested loops and an inner switch. Sometimes we
1729          * need to break out of one or both loops, or re-enter one of
1730          * the loops with updated variables. Loop variables are:
1731          *
1732          *      f_pos (outer loop) points to the current rule.
1733          *              On output it points to the matching rule.
1734          *      done (outer loop) is used as a flag to break the loop.
1735          *      l (inner loop)  residual length of current rule.
1736          *              cmd points to the current microinstruction.
1737          *
1738          * We break the inner loop by setting l=0 and possibly
1739          * cmdlen=0 if we don't want to advance cmd.
1740          * We break the outer loop by setting done=1
1741          * We can restart the inner loop by setting l>0 and f_pos, f, cmd
1742          * as needed.
1743          */
1744         for (; f_pos < chain->n_rules; f_pos++) {
1745                 ipfw_insn *cmd;
1746                 uint32_t tablearg = 0;
1747                 int l, cmdlen, skip_or; /* skip rest of OR block */
1748                 struct ip_fw *f;
1749
1750                 f = chain->map[f_pos];
1751                 if (V_set_disable & (1 << f->set) )
1752                         continue;
1753
1754                 skip_or = 0;
1755                 for (l = f->cmd_len, cmd = f->cmd ; l > 0 ;
1756                     l -= cmdlen, cmd += cmdlen) {
1757                         int match;
1758
1759                         /*
1760                          * check_body is a jump target used when we find a
1761                          * CHECK_STATE, and need to jump to the body of
1762                          * the target rule.
1763                          */
1764
1765 /* check_body: */
1766                         cmdlen = F_LEN(cmd);
1767                         /*
1768                          * An OR block (insn_1 || .. || insn_n) has the
1769                          * F_OR bit set in all but the last instruction.
1770                          * The first match will set "skip_or", and cause
1771                          * the following instructions to be skipped until
1772                          * past the one with the F_OR bit clear.
1773                          */
1774                         if (skip_or) {          /* skip this instruction */
1775                                 if ((cmd->len & F_OR) == 0)
1776                                         skip_or = 0;    /* next one is good */
1777                                 continue;
1778                         }
1779                         match = 0; /* set to 1 if we succeed */
1780
1781                         switch (cmd->opcode) {
1782                         /*
1783                          * The first set of opcodes compares the packet's
1784                          * fields with some pattern, setting 'match' if a
1785                          * match is found. At the end of the loop there is
1786                          * logic to deal with F_NOT and F_OR flags associated
1787                          * with the opcode.
1788                          */
1789                         case O_NOP:
1790                                 match = 1;
1791                                 break;
1792
1793                         case O_FORWARD_MAC:
1794                                 printf("ipfw: opcode %d unimplemented\n",
1795                                     cmd->opcode);
1796                                 break;
1797
1798                         case O_GID:
1799                         case O_UID:
1800                         case O_JAIL:
1801                                 /*
1802                                  * We only check offset == 0 && proto != 0,
1803                                  * as this ensures that we have a
1804                                  * packet with the ports info.
1805                                  */
1806                                 if (offset != 0)
1807                                         break;
1808                                 if (proto == IPPROTO_TCP ||
1809                                     proto == IPPROTO_UDP ||
1810                                     proto == IPPROTO_UDPLITE)
1811                                         match = check_uidgid(
1812                                                     (ipfw_insn_u32 *)cmd,
1813                                                     args, &ucred_lookup,
1814 #ifdef __FreeBSD__
1815                                                     &ucred_cache);
1816 #else
1817                                                     (void *)&ucred_cache);
1818 #endif
1819                                 break;
1820
1821                         case O_RECV:
1822                                 match = iface_match(m->m_pkthdr.rcvif,
1823                                     (ipfw_insn_if *)cmd, chain, &tablearg);
1824                                 break;
1825
1826                         case O_XMIT:
1827                                 match = iface_match(oif, (ipfw_insn_if *)cmd,
1828                                     chain, &tablearg);
1829                                 break;
1830
1831                         case O_VIA:
1832                                 match = iface_match(oif ? oif :
1833                                     m->m_pkthdr.rcvif, (ipfw_insn_if *)cmd,
1834                                     chain, &tablearg);
1835                                 break;
1836
1837                         case O_MACADDR2:
1838                                 if (args->flags & IPFW_ARGS_ETHER) {
1839                                         u_int32_t *want = (u_int32_t *)
1840                                                 ((ipfw_insn_mac *)cmd)->addr;
1841                                         u_int32_t *mask = (u_int32_t *)
1842                                                 ((ipfw_insn_mac *)cmd)->mask;
1843                                         u_int32_t *hdr = (u_int32_t *)args->eh;
1844
1845                                         match =
1846                                             ( want[0] == (hdr[0] & mask[0]) &&
1847                                               want[1] == (hdr[1] & mask[1]) &&
1848                                               want[2] == (hdr[2] & mask[2]) );
1849                                 }
1850                                 break;
1851
1852                         case O_MAC_TYPE:
1853                                 if (args->flags & IPFW_ARGS_ETHER) {
1854                                         u_int16_t *p =
1855                                             ((ipfw_insn_u16 *)cmd)->ports;
1856                                         int i;
1857
1858                                         for (i = cmdlen - 1; !match && i>0;
1859                                             i--, p += 2)
1860                                                 match = (etype >= p[0] &&
1861                                                     etype <= p[1]);
1862                                 }
1863                                 break;
1864
1865                         case O_FRAG:
1866                                 match = (offset != 0);
1867                                 break;
1868
1869                         case O_IN:      /* "out" is "not in" */
1870                                 match = (oif == NULL);
1871                                 break;
1872
1873                         case O_LAYER2:
1874                                 match = (args->flags & IPFW_ARGS_ETHER);
1875                                 break;
1876
1877                         case O_DIVERTED:
1878                                 if ((args->flags & IPFW_ARGS_REF) == 0)
1879                                         break;
1880                                 /*
1881                                  * For diverted packets, args->rule.info
1882                                  * contains the divert port (in host format)
1883                                  * reason and direction.
1884                                  */
1885                                 match = ((args->rule.info & IPFW_IS_MASK) ==
1886                                     IPFW_IS_DIVERT) && (
1887                                     ((args->rule.info & IPFW_INFO_IN) ?
1888                                         1: 2) & cmd->arg1);
1889                                 break;
1890
1891                         case O_PROTO:
1892                                 /*
1893                                  * We do not allow an arg of 0 so the
1894                                  * check of "proto" only suffices.
1895                                  */
1896                                 match = (proto == cmd->arg1);
1897                                 break;
1898
1899                         case O_IP_SRC:
1900                                 match = is_ipv4 &&
1901                                     (((ipfw_insn_ip *)cmd)->addr.s_addr ==
1902                                     src_ip.s_addr);
1903                                 break;
1904
1905                         case O_IP_DST_LOOKUP:
1906                         {
1907                                 void *pkey;
1908                                 uint32_t vidx, key;
1909                                 uint16_t keylen;
1910
1911                                 if (cmdlen > F_INSN_SIZE(ipfw_insn_u32)) {
1912                                         /* Determine lookup key type */
1913                                         vidx = ((ipfw_insn_u32 *)cmd)->d[1];
1914                                         if (vidx != 4 /* uid */ &&
1915                                             vidx != 5 /* jail */ &&
1916                                             is_ipv6 == 0 && is_ipv4 == 0)
1917                                                 break;
1918                                         /* Determine key length */
1919                                         if (vidx == 0 /* dst-ip */ ||
1920                                             vidx == 1 /* src-ip */)
1921                                                 keylen = is_ipv6 ?
1922                                                     sizeof(struct in6_addr):
1923                                                     sizeof(in_addr_t);
1924                                         else {
1925                                                 keylen = sizeof(key);
1926                                                 pkey = &key;
1927                                         }
1928                                         if (vidx == 0 /* dst-ip */)
1929                                                 pkey = is_ipv4 ? (void *)&dst_ip:
1930                                                     (void *)&args->f_id.dst_ip6;
1931                                         else if (vidx == 1 /* src-ip */)
1932                                                 pkey = is_ipv4 ? (void *)&src_ip:
1933                                                     (void *)&args->f_id.src_ip6;
1934                                         else if (vidx == 6 /* dscp */) {
1935                                                 if (is_ipv4)
1936                                                         key = ip->ip_tos >> 2;
1937                                                 else {
1938                                                         key = args->f_id.flow_id6;
1939                                                         key = (key & 0x0f) << 2 |
1940                                                             (key & 0xf000) >> 14;
1941                                                 }
1942                                                 key &= 0x3f;
1943                                         } else if (vidx == 2 /* dst-port */ ||
1944                                             vidx == 3 /* src-port */) {
1945                                                 /* Skip fragments */
1946                                                 if (offset != 0)
1947                                                         break;
1948                                                 /* Skip proto without ports */
1949                                                 if (proto != IPPROTO_TCP &&
1950                                                     proto != IPPROTO_UDP &&
1951                                                     proto != IPPROTO_UDPLITE &&
1952                                                     proto != IPPROTO_SCTP)
1953                                                         break;
1954                                                 if (vidx == 2 /* dst-port */)
1955                                                         key = dst_port;
1956                                                 else
1957                                                         key = src_port;
1958                                         }
1959 #ifndef USERSPACE
1960                                         else if (vidx == 4 /* uid */ ||
1961                                             vidx == 5 /* jail */) {
1962                                                 check_uidgid(
1963                                                     (ipfw_insn_u32 *)cmd,
1964                                                     args, &ucred_lookup,
1965 #ifdef __FreeBSD__
1966                                                     &ucred_cache);
1967                                                 if (vidx == 4 /* uid */)
1968                                                         key = ucred_cache->cr_uid;
1969                                                 else if (vidx == 5 /* jail */)
1970                                                         key = ucred_cache->cr_prison->pr_id;
1971 #else /* !__FreeBSD__ */
1972                                                     (void *)&ucred_cache);
1973                                                 if (vidx == 4 /* uid */)
1974                                                         key = ucred_cache.uid;
1975                                                 else if (vidx == 5 /* jail */)
1976                                                         key = ucred_cache.xid;
1977 #endif /* !__FreeBSD__ */
1978                                         }
1979 #endif /* !USERSPACE */
1980                                         else
1981                                                 break;
1982                                         match = ipfw_lookup_table(chain,
1983                                             cmd->arg1, keylen, pkey, &vidx);
1984                                         if (!match)
1985                                                 break;
1986                                         tablearg = vidx;
1987                                         break;
1988                                 }
1989                                 /* cmdlen =< F_INSN_SIZE(ipfw_insn_u32) */
1990                                 /* FALLTHROUGH */
1991                         }
1992                         case O_IP_SRC_LOOKUP:
1993                         {
1994                                 void *pkey;
1995                                 uint32_t vidx;
1996                                 uint16_t keylen;
1997
1998                                 if (is_ipv4) {
1999                                         keylen = sizeof(in_addr_t);
2000                                         if (cmd->opcode == O_IP_DST_LOOKUP)
2001                                                 pkey = &dst_ip;
2002                                         else
2003                                                 pkey = &src_ip;
2004                                 } else if (is_ipv6) {
2005                                         keylen = sizeof(struct in6_addr);
2006                                         if (cmd->opcode == O_IP_DST_LOOKUP)
2007                                                 pkey = &args->f_id.dst_ip6;
2008                                         else
2009                                                 pkey = &args->f_id.src_ip6;
2010                                 } else
2011                                         break;
2012                                 match = ipfw_lookup_table(chain, cmd->arg1,
2013                                     keylen, pkey, &vidx);
2014                                 if (!match)
2015                                         break;
2016                                 if (cmdlen == F_INSN_SIZE(ipfw_insn_u32)) {
2017                                         match = ((ipfw_insn_u32 *)cmd)->d[0] ==
2018                                             TARG_VAL(chain, vidx, tag);
2019                                         if (!match)
2020                                                 break;
2021                                 }
2022                                 tablearg = vidx;
2023                                 break;
2024                         }
2025
2026                         case O_IP_FLOW_LOOKUP:
2027                                 {
2028                                         uint32_t v = 0;
2029                                         match = ipfw_lookup_table(chain,
2030                                             cmd->arg1, 0, &args->f_id, &v);
2031                                         if (cmdlen == F_INSN_SIZE(ipfw_insn_u32))
2032                                                 match = ((ipfw_insn_u32 *)cmd)->d[0] ==
2033                                                     TARG_VAL(chain, v, tag);
2034                                         if (match)
2035                                                 tablearg = v;
2036                                 }
2037                                 break;
2038                         case O_IP_SRC_MASK:
2039                         case O_IP_DST_MASK:
2040                                 if (is_ipv4) {
2041                                     uint32_t a =
2042                                         (cmd->opcode == O_IP_DST_MASK) ?
2043                                             dst_ip.s_addr : src_ip.s_addr;
2044                                     uint32_t *p = ((ipfw_insn_u32 *)cmd)->d;
2045                                     int i = cmdlen-1;
2046
2047                                     for (; !match && i>0; i-= 2, p+= 2)
2048                                         match = (p[0] == (a & p[1]));
2049                                 }
2050                                 break;
2051
2052                         case O_IP_SRC_ME:
2053                                 if (is_ipv4) {
2054                                         match = in_localip(src_ip);
2055                                         break;
2056                                 }
2057 #ifdef INET6
2058                                 /* FALLTHROUGH */
2059                         case O_IP6_SRC_ME:
2060                                 match = is_ipv6 &&
2061                                     ipfw_localip6(&args->f_id.src_ip6);
2062 #endif
2063                                 break;
2064
2065                         case O_IP_DST_SET:
2066                         case O_IP_SRC_SET:
2067                                 if (is_ipv4) {
2068                                         u_int32_t *d = (u_int32_t *)(cmd+1);
2069                                         u_int32_t addr =
2070                                             cmd->opcode == O_IP_DST_SET ?
2071                                                 args->f_id.dst_ip :
2072                                                 args->f_id.src_ip;
2073
2074                                             if (addr < d[0])
2075                                                     break;
2076                                             addr -= d[0]; /* subtract base */
2077                                             match = (addr < cmd->arg1) &&
2078                                                 ( d[ 1 + (addr>>5)] &
2079                                                   (1<<(addr & 0x1f)) );
2080                                 }
2081                                 break;
2082
2083                         case O_IP_DST:
2084                                 match = is_ipv4 &&
2085                                     (((ipfw_insn_ip *)cmd)->addr.s_addr ==
2086                                     dst_ip.s_addr);
2087                                 break;
2088
2089                         case O_IP_DST_ME:
2090                                 if (is_ipv4) {
2091                                         match = in_localip(dst_ip);
2092                                         break;
2093                                 }
2094 #ifdef INET6
2095                                 /* FALLTHROUGH */
2096                         case O_IP6_DST_ME:
2097                                 match = is_ipv6 &&
2098                                     ipfw_localip6(&args->f_id.dst_ip6);
2099 #endif
2100                                 break;
2101
2102
2103                         case O_IP_SRCPORT:
2104                         case O_IP_DSTPORT:
2105                                 /*
2106                                  * offset == 0 && proto != 0 is enough
2107                                  * to guarantee that we have a
2108                                  * packet with port info.
2109                                  */
2110                                 if ((proto == IPPROTO_UDP ||
2111                                     proto == IPPROTO_UDPLITE ||
2112                                     proto == IPPROTO_TCP ||
2113                                     proto == IPPROTO_SCTP) && offset == 0) {
2114                                         u_int16_t x =
2115                                             (cmd->opcode == O_IP_SRCPORT) ?
2116                                                 src_port : dst_port ;
2117                                         u_int16_t *p =
2118                                             ((ipfw_insn_u16 *)cmd)->ports;
2119                                         int i;
2120
2121                                         for (i = cmdlen - 1; !match && i>0;
2122                                             i--, p += 2)
2123                                                 match = (x>=p[0] && x<=p[1]);
2124                                 }
2125                                 break;
2126
2127                         case O_ICMPTYPE:
2128                                 match = (offset == 0 && proto==IPPROTO_ICMP &&
2129                                     icmptype_match(ICMP(ulp), (ipfw_insn_u32 *)cmd) );
2130                                 break;
2131
2132 #ifdef INET6
2133                         case O_ICMP6TYPE:
2134                                 match = is_ipv6 && offset == 0 &&
2135                                     proto==IPPROTO_ICMPV6 &&
2136                                     icmp6type_match(
2137                                         ICMP6(ulp)->icmp6_type,
2138                                         (ipfw_insn_u32 *)cmd);
2139                                 break;
2140 #endif /* INET6 */
2141
2142                         case O_IPOPT:
2143                                 match = (is_ipv4 &&
2144                                     ipopts_match(ip, cmd) );
2145                                 break;
2146
2147                         case O_IPVER:
2148                                 match = (is_ipv4 &&
2149                                     cmd->arg1 == ip->ip_v);
2150                                 break;
2151
2152                         case O_IPID:
2153                         case O_IPTTL:
2154                                 if (!is_ipv4)
2155                                         break;
2156                         case O_IPLEN:
2157                                 {       /* only for IP packets */
2158                                     uint16_t x;
2159                                     uint16_t *p;
2160                                     int i;
2161
2162                                     if (cmd->opcode == O_IPLEN)
2163                                         x = iplen;
2164                                     else if (cmd->opcode == O_IPTTL)
2165                                         x = ip->ip_ttl;
2166                                     else /* must be IPID */
2167                                         x = ntohs(ip->ip_id);
2168                                     if (cmdlen == 1) {
2169                                         match = (cmd->arg1 == x);
2170                                         break;
2171                                     }
2172                                     /* otherwise we have ranges */
2173                                     p = ((ipfw_insn_u16 *)cmd)->ports;
2174                                     i = cmdlen - 1;
2175                                     for (; !match && i>0; i--, p += 2)
2176                                         match = (x >= p[0] && x <= p[1]);
2177                                 }
2178                                 break;
2179
2180                         case O_IPPRECEDENCE:
2181                                 match = (is_ipv4 &&
2182                                     (cmd->arg1 == (ip->ip_tos & 0xe0)) );
2183                                 break;
2184
2185                         case O_IPTOS:
2186                                 match = (is_ipv4 &&
2187                                     flags_match(cmd, ip->ip_tos));
2188                                 break;
2189
2190                         case O_DSCP:
2191                             {
2192                                 uint32_t *p;
2193                                 uint16_t x;
2194
2195                                 p = ((ipfw_insn_u32 *)cmd)->d;
2196
2197                                 if (is_ipv4)
2198                                         x = ip->ip_tos >> 2;
2199                                 else if (is_ipv6) {
2200                                         uint8_t *v;
2201                                         v = &((struct ip6_hdr *)ip)->ip6_vfc;
2202                                         x = (*v & 0x0F) << 2;
2203                                         v++;
2204                                         x |= *v >> 6;
2205                                 } else
2206                                         break;
2207
2208                                 /* DSCP bitmask is stored as low_u32 high_u32 */
2209                                 if (x >= 32)
2210                                         match = *(p + 1) & (1 << (x - 32));
2211                                 else
2212                                         match = *p & (1 << x);
2213                             }
2214                                 break;
2215
2216                         case O_TCPDATALEN:
2217                                 if (proto == IPPROTO_TCP && offset == 0) {
2218                                     struct tcphdr *tcp;
2219                                     uint16_t x;
2220                                     uint16_t *p;
2221                                     int i;
2222 #ifdef INET6
2223                                     if (is_ipv6) {
2224                                             struct ip6_hdr *ip6;
2225
2226                                             ip6 = (struct ip6_hdr *)ip;
2227                                             if (ip6->ip6_plen == 0) {
2228                                                     /*
2229                                                      * Jumbo payload is not
2230                                                      * supported by this
2231                                                      * opcode.
2232                                                      */
2233                                                     break;
2234                                             }
2235                                             x = iplen - hlen;
2236                                     } else
2237 #endif /* INET6 */
2238                                             x = iplen - (ip->ip_hl << 2);
2239                                     tcp = TCP(ulp);
2240                                     x -= tcp->th_off << 2;
2241                                     if (cmdlen == 1) {
2242                                         match = (cmd->arg1 == x);
2243                                         break;
2244                                     }
2245                                     /* otherwise we have ranges */
2246                                     p = ((ipfw_insn_u16 *)cmd)->ports;
2247                                     i = cmdlen - 1;
2248                                     for (; !match && i>0; i--, p += 2)
2249                                         match = (x >= p[0] && x <= p[1]);
2250                                 }
2251                                 break;
2252
2253                         case O_TCPFLAGS:
2254                                 match = (proto == IPPROTO_TCP && offset == 0 &&
2255                                     flags_match(cmd, TCP(ulp)->th_flags));
2256                                 break;
2257
2258                         case O_TCPOPTS:
2259                                 if (proto == IPPROTO_TCP && offset == 0 && ulp){
2260                                         PULLUP_LEN(hlen, ulp,
2261                                             (TCP(ulp)->th_off << 2));
2262                                         match = tcpopts_match(TCP(ulp), cmd);
2263                                 }
2264                                 break;
2265
2266                         case O_TCPSEQ:
2267                                 match = (proto == IPPROTO_TCP && offset == 0 &&
2268                                     ((ipfw_insn_u32 *)cmd)->d[0] ==
2269                                         TCP(ulp)->th_seq);
2270                                 break;
2271
2272                         case O_TCPACK:
2273                                 match = (proto == IPPROTO_TCP && offset == 0 &&
2274                                     ((ipfw_insn_u32 *)cmd)->d[0] ==
2275                                         TCP(ulp)->th_ack);
2276                                 break;
2277
2278                         case O_TCPWIN:
2279                                 if (proto == IPPROTO_TCP && offset == 0) {
2280                                     uint16_t x;
2281                                     uint16_t *p;
2282                                     int i;
2283
2284                                     x = ntohs(TCP(ulp)->th_win);
2285                                     if (cmdlen == 1) {
2286                                         match = (cmd->arg1 == x);
2287                                         break;
2288                                     }
2289                                     /* Otherwise we have ranges. */
2290                                     p = ((ipfw_insn_u16 *)cmd)->ports;
2291                                     i = cmdlen - 1;
2292                                     for (; !match && i > 0; i--, p += 2)
2293                                         match = (x >= p[0] && x <= p[1]);
2294                                 }
2295                                 break;
2296
2297                         case O_ESTAB:
2298                                 /* reject packets which have SYN only */
2299                                 /* XXX should i also check for TH_ACK ? */
2300                                 match = (proto == IPPROTO_TCP && offset == 0 &&
2301                                     (TCP(ulp)->th_flags &
2302                                      (TH_RST | TH_ACK | TH_SYN)) != TH_SYN);
2303                                 break;
2304
2305                         case O_ALTQ: {
2306                                 struct pf_mtag *at;
2307                                 struct m_tag *mtag;
2308                                 ipfw_insn_altq *altq = (ipfw_insn_altq *)cmd;
2309
2310                                 /*
2311                                  * ALTQ uses mbuf tags from another
2312                                  * packet filtering system - pf(4).
2313                                  * We allocate a tag in its format
2314                                  * and fill it in, pretending to be pf(4).
2315                                  */
2316                                 match = 1;
2317                                 at = pf_find_mtag(m);
2318                                 if (at != NULL && at->qid != 0)
2319                                         break;
2320                                 mtag = m_tag_get(PACKET_TAG_PF,
2321                                     sizeof(struct pf_mtag), M_NOWAIT | M_ZERO);
2322                                 if (mtag == NULL) {
2323                                         /*
2324                                          * Let the packet fall back to the
2325                                          * default ALTQ.
2326                                          */
2327                                         break;
2328                                 }
2329                                 m_tag_prepend(m, mtag);
2330                                 at = (struct pf_mtag *)(mtag + 1);
2331                                 at->qid = altq->qid;
2332                                 at->hdr = ip;
2333                                 break;
2334                         }
2335
2336                         case O_LOG:
2337                                 ipfw_log(chain, f, hlen, args, m,
2338                                     oif, offset | ip6f_mf, tablearg, ip);
2339                                 match = 1;
2340                                 break;
2341
2342                         case O_PROB:
2343                                 match = (random()<((ipfw_insn_u32 *)cmd)->d[0]);
2344                                 break;
2345
2346                         case O_VERREVPATH:
2347                                 /* Outgoing packets automatically pass/match */
2348                                 match = ((oif != NULL) ||
2349                                     (m->m_pkthdr.rcvif == NULL) ||
2350                                     (
2351 #ifdef INET6
2352                                     is_ipv6 ?
2353                                         verify_path6(&(args->f_id.src_ip6),
2354                                             m->m_pkthdr.rcvif, args->f_id.fib) :
2355 #endif
2356                                     verify_path(src_ip, m->m_pkthdr.rcvif,
2357                                         args->f_id.fib)));
2358                                 break;
2359
2360                         case O_VERSRCREACH:
2361                                 /* Outgoing packets automatically pass/match */
2362                                 match = (hlen > 0 && ((oif != NULL) || (
2363 #ifdef INET6
2364                                     is_ipv6 ?
2365                                         verify_path6(&(args->f_id.src_ip6),
2366                                             NULL, args->f_id.fib) :
2367 #endif
2368                                     verify_path(src_ip, NULL, args->f_id.fib))));
2369                                 break;
2370
2371                         case O_ANTISPOOF:
2372                                 /* Outgoing packets automatically pass/match */
2373                                 if (oif == NULL && hlen > 0 &&
2374                                     (  (is_ipv4 && in_localaddr(src_ip))
2375 #ifdef INET6
2376                                     || (is_ipv6 &&
2377                                         in6_localaddr(&(args->f_id.src_ip6)))
2378 #endif
2379                                     ))
2380                                         match =
2381 #ifdef INET6
2382                                             is_ipv6 ? verify_path6(
2383                                                 &(args->f_id.src_ip6),
2384                                                 m->m_pkthdr.rcvif,
2385                                                 args->f_id.fib) :
2386 #endif
2387                                             verify_path(src_ip,
2388                                                 m->m_pkthdr.rcvif,
2389                                                 args->f_id.fib);
2390                                 else
2391                                         match = 1;
2392                                 break;
2393
2394                         case O_IPSEC:
2395                                 match = (m_tag_find(m,
2396                                     PACKET_TAG_IPSEC_IN_DONE, NULL) != NULL);
2397                                 /* otherwise no match */
2398                                 break;
2399
2400 #ifdef INET6
2401                         case O_IP6_SRC:
2402                                 match = is_ipv6 &&
2403                                     IN6_ARE_ADDR_EQUAL(&args->f_id.src_ip6,
2404                                     &((ipfw_insn_ip6 *)cmd)->addr6);
2405                                 break;
2406
2407                         case O_IP6_DST:
2408                                 match = is_ipv6 &&
2409                                 IN6_ARE_ADDR_EQUAL(&args->f_id.dst_ip6,
2410                                     &((ipfw_insn_ip6 *)cmd)->addr6);
2411                                 break;
2412                         case O_IP6_SRC_MASK:
2413                         case O_IP6_DST_MASK:
2414                                 if (is_ipv6) {
2415                                         int i = cmdlen - 1;
2416                                         struct in6_addr p;
2417                                         struct in6_addr *d =
2418                                             &((ipfw_insn_ip6 *)cmd)->addr6;
2419
2420                                         for (; !match && i > 0; d += 2,
2421                                             i -= F_INSN_SIZE(struct in6_addr)
2422                                             * 2) {
2423                                                 p = (cmd->opcode ==
2424                                                     O_IP6_SRC_MASK) ?
2425                                                     args->f_id.src_ip6:
2426                                                     args->f_id.dst_ip6;
2427                                                 APPLY_MASK(&p, &d[1]);
2428                                                 match =
2429                                                     IN6_ARE_ADDR_EQUAL(&d[0],
2430                                                     &p);
2431                                         }
2432                                 }
2433                                 break;
2434
2435                         case O_FLOW6ID:
2436                                 match = is_ipv6 &&
2437                                     flow6id_match(args->f_id.flow_id6,
2438                                     (ipfw_insn_u32 *) cmd);
2439                                 break;
2440
2441                         case O_EXT_HDR:
2442                                 match = is_ipv6 &&
2443                                     (ext_hd & ((ipfw_insn *) cmd)->arg1);
2444                                 break;
2445
2446                         case O_IP6:
2447                                 match = is_ipv6;
2448                                 break;
2449 #endif
2450
2451                         case O_IP4:
2452                                 match = is_ipv4;
2453                                 break;
2454
2455                         case O_TAG: {
2456                                 struct m_tag *mtag;
2457                                 uint32_t tag = TARG(cmd->arg1, tag);
2458
2459                                 /* Packet is already tagged with this tag? */
2460                                 mtag = m_tag_locate(m, MTAG_IPFW, tag, NULL);
2461
2462                                 /* We have `untag' action when F_NOT flag is
2463                                  * present. And we must remove this mtag from
2464                                  * mbuf and reset `match' to zero (`match' will
2465                                  * be inversed later).
2466                                  * Otherwise we should allocate new mtag and
2467                                  * push it into mbuf.
2468                                  */
2469                                 if (cmd->len & F_NOT) { /* `untag' action */
2470                                         if (mtag != NULL)
2471                                                 m_tag_delete(m, mtag);
2472                                         match = 0;
2473                                 } else {
2474                                         if (mtag == NULL) {
2475                                                 mtag = m_tag_alloc( MTAG_IPFW,
2476                                                     tag, 0, M_NOWAIT);
2477                                                 if (mtag != NULL)
2478                                                         m_tag_prepend(m, mtag);
2479                                         }
2480                                         match = 1;
2481                                 }
2482                                 break;
2483                         }
2484
2485                         case O_FIB: /* try match the specified fib */
2486                                 if (args->f_id.fib == cmd->arg1)
2487                                         match = 1;
2488                                 break;
2489
2490                         case O_SOCKARG: {
2491 #ifndef USERSPACE       /* not supported in userspace */
2492                                 struct inpcb *inp = args->inp;
2493                                 struct inpcbinfo *pi;
2494                                 
2495                                 if (is_ipv6) /* XXX can we remove this ? */
2496                                         break;
2497
2498                                 if (proto == IPPROTO_TCP)
2499                                         pi = &V_tcbinfo;
2500                                 else if (proto == IPPROTO_UDP)
2501                                         pi = &V_udbinfo;
2502                                 else if (proto == IPPROTO_UDPLITE)
2503                                         pi = &V_ulitecbinfo;
2504                                 else
2505                                         break;
2506
2507                                 /*
2508                                  * XXXRW: so_user_cookie should almost
2509                                  * certainly be inp_user_cookie?
2510                                  */
2511
2512                                 /* For incoming packet, lookup up the 
2513                                 inpcb using the src/dest ip/port tuple */
2514                                 if (inp == NULL) {
2515                                         inp = in_pcblookup(pi, 
2516                                                 src_ip, htons(src_port),
2517                                                 dst_ip, htons(dst_port),
2518                                                 INPLOOKUP_RLOCKPCB, NULL);
2519                                         if (inp != NULL) {
2520                                                 tablearg =
2521                                                     inp->inp_socket->so_user_cookie;
2522                                                 if (tablearg)
2523                                                         match = 1;
2524                                                 INP_RUNLOCK(inp);
2525                                         }
2526                                 } else {
2527                                         if (inp->inp_socket) {
2528                                                 tablearg =
2529                                                     inp->inp_socket->so_user_cookie;
2530                                                 if (tablearg)
2531                                                         match = 1;
2532                                         }
2533                                 }
2534 #endif /* !USERSPACE */
2535                                 break;
2536                         }
2537
2538                         case O_TAGGED: {
2539                                 struct m_tag *mtag;
2540                                 uint32_t tag = TARG(cmd->arg1, tag);
2541
2542                                 if (cmdlen == 1) {
2543                                         match = m_tag_locate(m, MTAG_IPFW,
2544                                             tag, NULL) != NULL;
2545                                         break;
2546                                 }
2547
2548                                 /* we have ranges */
2549                                 for (mtag = m_tag_first(m);
2550                                     mtag != NULL && !match;
2551                                     mtag = m_tag_next(m, mtag)) {
2552                                         uint16_t *p;
2553                                         int i;
2554
2555                                         if (mtag->m_tag_cookie != MTAG_IPFW)
2556                                                 continue;
2557
2558                                         p = ((ipfw_insn_u16 *)cmd)->ports;
2559                                         i = cmdlen - 1;
2560                                         for(; !match && i > 0; i--, p += 2)
2561                                                 match =
2562                                                     mtag->m_tag_id >= p[0] &&
2563                                                     mtag->m_tag_id <= p[1];
2564                                 }
2565                                 break;
2566                         }
2567                                 
2568                         /*
2569                          * The second set of opcodes represents 'actions',
2570                          * i.e. the terminal part of a rule once the packet
2571                          * matches all previous patterns.
2572                          * Typically there is only one action for each rule,
2573                          * and the opcode is stored at the end of the rule
2574                          * (but there are exceptions -- see below).
2575                          *
2576                          * In general, here we set retval and terminate the
2577                          * outer loop (would be a 'break 3' in some language,
2578                          * but we need to set l=0, done=1)
2579                          *
2580                          * Exceptions:
2581                          * O_COUNT and O_SKIPTO actions:
2582                          *   instead of terminating, we jump to the next rule
2583                          *   (setting l=0), or to the SKIPTO target (setting
2584                          *   f/f_len, cmd and l as needed), respectively.
2585                          *
2586                          * O_TAG, O_LOG and O_ALTQ action parameters:
2587                          *   perform some action and set match = 1;
2588                          *
2589                          * O_LIMIT and O_KEEP_STATE: these opcodes are
2590                          *   not real 'actions', and are stored right
2591                          *   before the 'action' part of the rule (one
2592                          *   exception is O_SKIP_ACTION which could be
2593                          *   between these opcodes and 'action' one).
2594                          *   These opcodes try to install an entry in the
2595                          *   state tables; if successful, we continue with
2596                          *   the next opcode (match=1; break;), otherwise
2597                          *   the packet must be dropped (set retval,
2598                          *   break loops with l=0, done=1)
2599                          *
2600                          * O_PROBE_STATE and O_CHECK_STATE: these opcodes
2601                          *   cause a lookup of the state table, and a jump
2602                          *   to the 'action' part of the parent rule
2603                          *   if an entry is found, or
2604                          *   (CHECK_STATE only) a jump to the next rule if
2605                          *   the entry is not found.
2606                          *   The result of the lookup is cached so that
2607                          *   further instances of these opcodes become NOPs.
2608                          *   The jump to the next rule is done by setting
2609                          *   l=0, cmdlen=0.
2610                          *
2611                          * O_SKIP_ACTION: this opcode is not a real 'action'
2612                          *  either, and is stored right before the 'action'
2613                          *  part of the rule, right after the O_KEEP_STATE
2614                          *  opcode. It causes match failure so the real
2615                          *  'action' could be executed only if the rule
2616                          *  is checked via dynamic rule from the state
2617                          *  table, as in such case execution starts
2618                          *  from the true 'action' opcode directly.
2619                          *   
2620                          */
2621                         case O_LIMIT:
2622                         case O_KEEP_STATE:
2623                                 if (ipfw_dyn_install_state(chain, f,
2624                                     (ipfw_insn_limit *)cmd, args, ulp,
2625                                     pktlen, &dyn_info, tablearg)) {
2626                                         /* error or limit violation */
2627                                         retval = IP_FW_DENY;
2628                                         l = 0;  /* exit inner loop */
2629                                         done = 1; /* exit outer loop */
2630                                 }
2631                                 match = 1;
2632                                 break;
2633
2634                         case O_PROBE_STATE:
2635                         case O_CHECK_STATE:
2636                                 /*
2637                                  * dynamic rules are checked at the first
2638                                  * keep-state or check-state occurrence,
2639                                  * with the result being stored in dyn_info.
2640                                  * The compiler introduces a PROBE_STATE
2641                                  * instruction for us when we have a
2642                                  * KEEP_STATE (because PROBE_STATE needs
2643                                  * to be run first).
2644                                  */
2645                                 if (DYN_LOOKUP_NEEDED(&dyn_info, cmd) &&
2646                                     (q = ipfw_dyn_lookup_state(args, ulp,
2647                                     pktlen, cmd, &dyn_info)) != NULL) {
2648                                         /*
2649                                          * Found dynamic entry, jump to the
2650                                          * 'action' part of the parent rule
2651                                          * by setting f, cmd, l and clearing
2652                                          * cmdlen.
2653                                          */
2654                                         f = q;
2655                                         f_pos = dyn_info.f_pos;
2656                                         cmd = ACTION_PTR(f);
2657                                         l = f->cmd_len - f->act_ofs;
2658                                         cmdlen = 0;
2659                                         match = 1;
2660                                         break;
2661                                 }
2662                                 /*
2663                                  * Dynamic entry not found. If CHECK_STATE,
2664                                  * skip to next rule, if PROBE_STATE just
2665                                  * ignore and continue with next opcode.
2666                                  */
2667                                 if (cmd->opcode == O_CHECK_STATE)
2668                                         l = 0;  /* exit inner loop */
2669                                 match = 1;
2670                                 break;
2671
2672                         case O_SKIP_ACTION:
2673                                 match = 0;      /* skip to the next rule */
2674                                 l = 0;          /* exit inner loop */
2675                                 break;
2676
2677                         case O_ACCEPT:
2678                                 retval = 0;     /* accept */
2679                                 l = 0;          /* exit inner loop */
2680                                 done = 1;       /* exit outer loop */
2681                                 break;
2682
2683                         case O_PIPE:
2684                         case O_QUEUE:
2685                                 set_match(args, f_pos, chain);
2686                                 args->rule.info = TARG(cmd->arg1, pipe);
2687                                 if (cmd->opcode == O_PIPE)
2688                                         args->rule.info |= IPFW_IS_PIPE;
2689                                 if (V_fw_one_pass)
2690                                         args->rule.info |= IPFW_ONEPASS;
2691                                 retval = IP_FW_DUMMYNET;
2692                                 l = 0;          /* exit inner loop */
2693                                 done = 1;       /* exit outer loop */
2694                                 break;
2695
2696                         case O_DIVERT:
2697                         case O_TEE:
2698                                 if (args->flags & IPFW_ARGS_ETHER)
2699                                         break;  /* not on layer 2 */
2700                                 /* otherwise this is terminal */
2701                                 l = 0;          /* exit inner loop */
2702                                 done = 1;       /* exit outer loop */
2703                                 retval = (cmd->opcode == O_DIVERT) ?
2704                                         IP_FW_DIVERT : IP_FW_TEE;
2705                                 set_match(args, f_pos, chain);
2706                                 args->rule.info = TARG(cmd->arg1, divert);
2707                                 break;
2708
2709                         case O_COUNT:
2710                                 IPFW_INC_RULE_COUNTER(f, pktlen);
2711                                 l = 0;          /* exit inner loop */
2712                                 break;
2713
2714                         case O_SKIPTO:
2715                             IPFW_INC_RULE_COUNTER(f, pktlen);
2716                             f_pos = JUMP(chain, f, cmd->arg1, tablearg, 0);
2717                             /*
2718                              * Skip disabled rules, and re-enter
2719                              * the inner loop with the correct
2720                              * f_pos, f, l and cmd.
2721                              * Also clear cmdlen and skip_or
2722                              */
2723                             for (; f_pos < chain->n_rules - 1 &&
2724                                     (V_set_disable &
2725                                      (1 << chain->map[f_pos]->set));
2726                                     f_pos++)
2727                                 ;
2728                             /* Re-enter the inner loop at the skipto rule. */
2729                             f = chain->map[f_pos];
2730                             l = f->cmd_len;
2731                             cmd = f->cmd;
2732                             match = 1;
2733                             cmdlen = 0;
2734                             skip_or = 0;
2735                             continue;
2736                             break;      /* not reached */
2737
2738                         case O_CALLRETURN: {
2739                                 /*
2740                                  * Implementation of `subroutine' call/return,
2741                                  * in the stack carried in an mbuf tag. This
2742                                  * is different from `skipto' in that any call
2743                                  * address is possible (`skipto' must prevent
2744                                  * backward jumps to avoid endless loops).
2745                                  * We have `return' action when F_NOT flag is
2746                                  * present. The `m_tag_id' field is used as
2747                                  * stack pointer.
2748                                  */
2749                                 struct m_tag *mtag;
2750                                 uint16_t jmpto, *stack;
2751
2752 #define IS_CALL         ((cmd->len & F_NOT) == 0)
2753 #define IS_RETURN       ((cmd->len & F_NOT) != 0)
2754                                 /*
2755                                  * Hand-rolled version of m_tag_locate() with
2756                                  * wildcard `type'.
2757                                  * If not already tagged, allocate new tag.
2758                                  */
2759                                 mtag = m_tag_first(m);
2760                                 while (mtag != NULL) {
2761                                         if (mtag->m_tag_cookie ==
2762                                             MTAG_IPFW_CALL)
2763                                                 break;
2764                                         mtag = m_tag_next(m, mtag);
2765                                 }
2766                                 if (mtag == NULL && IS_CALL) {
2767                                         mtag = m_tag_alloc(MTAG_IPFW_CALL, 0,
2768                                             IPFW_CALLSTACK_SIZE *
2769                                             sizeof(uint16_t), M_NOWAIT);
2770                                         if (mtag != NULL)
2771                                                 m_tag_prepend(m, mtag);
2772                                 }
2773
2774                                 /*
2775                                  * On error both `call' and `return' just
2776                                  * continue with next rule.
2777                                  */
2778                                 if (IS_RETURN && (mtag == NULL ||
2779                                     mtag->m_tag_id == 0)) {
2780                                         l = 0;          /* exit inner loop */
2781                                         break;
2782                                 }
2783                                 if (IS_CALL && (mtag == NULL ||
2784                                     mtag->m_tag_id >= IPFW_CALLSTACK_SIZE)) {
2785                                         printf("ipfw: call stack error, "
2786                                             "go to next rule\n");
2787                                         l = 0;          /* exit inner loop */
2788                                         break;
2789                                 }
2790
2791                                 IPFW_INC_RULE_COUNTER(f, pktlen);
2792                                 stack = (uint16_t *)(mtag + 1);
2793
2794                                 /*
2795                                  * The `call' action may use cached f_pos
2796                                  * (in f->next_rule), whose version is written
2797                                  * in f->next_rule.
2798                                  * The `return' action, however, doesn't have
2799                                  * fixed jump address in cmd->arg1 and can't use
2800                                  * cache.
2801                                  */
2802                                 if (IS_CALL) {
2803                                         stack[mtag->m_tag_id] = f->rulenum;
2804                                         mtag->m_tag_id++;
2805                                         f_pos = JUMP(chain, f, cmd->arg1,
2806                                             tablearg, 1);
2807                                 } else {        /* `return' action */
2808                                         mtag->m_tag_id--;
2809                                         jmpto = stack[mtag->m_tag_id] + 1;
2810                                         f_pos = ipfw_find_rule(chain, jmpto, 0);
2811                                 }
2812
2813                                 /*
2814                                  * Skip disabled rules, and re-enter
2815                                  * the inner loop with the correct
2816                                  * f_pos, f, l and cmd.
2817                                  * Also clear cmdlen and skip_or
2818                                  */
2819                                 for (; f_pos < chain->n_rules - 1 &&
2820                                     (V_set_disable &
2821                                     (1 << chain->map[f_pos]->set)); f_pos++)
2822                                         ;
2823                                 /* Re-enter the inner loop at the dest rule. */
2824                                 f = chain->map[f_pos];
2825                                 l = f->cmd_len;
2826                                 cmd = f->cmd;
2827                                 cmdlen = 0;
2828                                 skip_or = 0;
2829                                 continue;
2830                                 break;  /* NOTREACHED */
2831                         }
2832 #undef IS_CALL
2833 #undef IS_RETURN
2834
2835                         case O_REJECT:
2836                                 /*
2837                                  * Drop the packet and send a reject notice
2838                                  * if the packet is not ICMP (or is an ICMP
2839                                  * query), and it is not multicast/broadcast.
2840                                  */
2841                                 if (hlen > 0 && is_ipv4 && offset == 0 &&
2842                                     (proto != IPPROTO_ICMP ||
2843                                      is_icmp_query(ICMP(ulp))) &&
2844                                     !(m->m_flags & (M_BCAST|M_MCAST)) &&
2845                                     !IN_MULTICAST(ntohl(dst_ip.s_addr))) {
2846                                         send_reject(args, cmd->arg1, iplen, ip);
2847                                         m = args->m;
2848                                 }
2849                                 /* FALLTHROUGH */
2850 #ifdef INET6
2851                         case O_UNREACH6:
2852                                 if (hlen > 0 && is_ipv6 &&
2853                                     ((offset & IP6F_OFF_MASK) == 0) &&
2854                                     (proto != IPPROTO_ICMPV6 ||
2855                                      (is_icmp6_query(icmp6_type) == 1)) &&
2856                                     !(m->m_flags & (M_BCAST|M_MCAST)) &&
2857                                     !IN6_IS_ADDR_MULTICAST(
2858                                         &args->f_id.dst_ip6)) {
2859                                         send_reject6(args,
2860                                             cmd->opcode == O_REJECT ?
2861                                             map_icmp_unreach(cmd->arg1):
2862                                             cmd->arg1, hlen,
2863                                             (struct ip6_hdr *)ip);
2864                                         m = args->m;
2865                                 }
2866                                 /* FALLTHROUGH */
2867 #endif
2868                         case O_DENY:
2869                                 retval = IP_FW_DENY;
2870                                 l = 0;          /* exit inner loop */
2871                                 done = 1;       /* exit outer loop */
2872                                 break;
2873
2874                         case O_FORWARD_IP:
2875                                 if (args->flags & IPFW_ARGS_ETHER)
2876                                         break;  /* not valid on layer2 pkts */
2877                                 if (q != f ||
2878                                     dyn_info.direction == MATCH_FORWARD) {
2879                                     struct sockaddr_in *sa;
2880
2881                                     sa = &(((ipfw_insn_sa *)cmd)->sa);
2882                                     if (sa->sin_addr.s_addr == INADDR_ANY) {
2883 #ifdef INET6
2884                                         /*
2885                                          * We use O_FORWARD_IP opcode for
2886                                          * fwd rule with tablearg, but tables
2887                                          * now support IPv6 addresses. And
2888                                          * when we are inspecting IPv6 packet,
2889                                          * we can use nh6 field from
2890                                          * table_value as next_hop6 address.
2891                                          */
2892                                         if (is_ipv6) {
2893                                                 struct ip_fw_nh6 *nh6;
2894
2895                                                 args->flags |= IPFW_ARGS_NH6;
2896                                                 nh6 = &args->hopstore6;
2897                                                 nh6->sin6_addr = TARG_VAL(
2898                                                     chain, tablearg, nh6);
2899                                                 nh6->sin6_port = sa->sin_port;
2900                                                 nh6->sin6_scope_id = TARG_VAL(
2901                                                     chain, tablearg, zoneid);
2902                                         } else
2903 #endif
2904                                         {
2905                                                 args->flags |= IPFW_ARGS_NH4;
2906                                                 args->hopstore.sin_port =
2907                                                     sa->sin_port;
2908                                                 sa = &args->hopstore;
2909                                                 sa->sin_family = AF_INET;
2910                                                 sa->sin_len = sizeof(*sa);
2911                                                 sa->sin_addr.s_addr = htonl(
2912                                                     TARG_VAL(chain, tablearg,
2913                                                     nh4));
2914                                         }
2915                                     } else {
2916                                             args->flags |= IPFW_ARGS_NH4PTR;
2917                                             args->next_hop = sa;
2918                                     }
2919                                 }
2920                                 retval = IP_FW_PASS;
2921                                 l = 0;          /* exit inner loop */
2922                                 done = 1;       /* exit outer loop */
2923                                 break;
2924
2925 #ifdef INET6
2926                         case O_FORWARD_IP6:
2927                                 if (args->flags & IPFW_ARGS_ETHER)
2928                                         break;  /* not valid on layer2 pkts */
2929                                 if (q != f ||
2930                                     dyn_info.direction == MATCH_FORWARD) {
2931                                         struct sockaddr_in6 *sin6;
2932
2933                                         sin6 = &(((ipfw_insn_sa6 *)cmd)->sa);
2934                                         args->flags |= IPFW_ARGS_NH6PTR;
2935                                         args->next_hop6 = sin6;
2936                                 }
2937                                 retval = IP_FW_PASS;
2938                                 l = 0;          /* exit inner loop */
2939                                 done = 1;       /* exit outer loop */
2940                                 break;
2941 #endif
2942
2943                         case O_NETGRAPH:
2944                         case O_NGTEE:
2945                                 set_match(args, f_pos, chain);
2946                                 args->rule.info = TARG(cmd->arg1, netgraph);
2947                                 if (V_fw_one_pass)
2948                                         args->rule.info |= IPFW_ONEPASS;
2949                                 retval = (cmd->opcode == O_NETGRAPH) ?
2950                                     IP_FW_NETGRAPH : IP_FW_NGTEE;
2951                                 l = 0;          /* exit inner loop */
2952                                 done = 1;       /* exit outer loop */
2953                                 break;
2954
2955                         case O_SETFIB: {
2956                                 uint32_t fib;
2957
2958                                 IPFW_INC_RULE_COUNTER(f, pktlen);
2959                                 fib = TARG(cmd->arg1, fib) & 0x7FFF;
2960                                 if (fib >= rt_numfibs)
2961                                         fib = 0;
2962                                 M_SETFIB(m, fib);
2963                                 args->f_id.fib = fib; /* XXX */
2964                                 l = 0;          /* exit inner loop */
2965                                 break;
2966                         }
2967
2968                         case O_SETDSCP: {
2969                                 uint16_t code;
2970
2971                                 code = TARG(cmd->arg1, dscp) & 0x3F;
2972                                 l = 0;          /* exit inner loop */
2973                                 if (is_ipv4) {
2974                                         uint16_t old;
2975
2976                                         old = *(uint16_t *)ip;
2977                                         ip->ip_tos = (code << 2) |
2978                                             (ip->ip_tos & 0x03);
2979                                         ip->ip_sum = cksum_adjust(ip->ip_sum,
2980                                             old, *(uint16_t *)ip);
2981                                 } else if (is_ipv6) {
2982                                         uint8_t *v;
2983
2984                                         v = &((struct ip6_hdr *)ip)->ip6_vfc;
2985                                         *v = (*v & 0xF0) | (code >> 2);
2986                                         v++;
2987                                         *v = (*v & 0x3F) | ((code & 0x03) << 6);
2988                                 } else
2989                                         break;
2990
2991                                 IPFW_INC_RULE_COUNTER(f, pktlen);
2992                                 break;
2993                         }
2994
2995                         case O_NAT:
2996                                 l = 0;          /* exit inner loop */
2997                                 done = 1;       /* exit outer loop */
2998                                 /*
2999                                  * Ensure that we do not invoke NAT handler for
3000                                  * non IPv4 packets. Libalias expects only IPv4.
3001                                  */
3002                                 if (!is_ipv4 || !IPFW_NAT_LOADED) {
3003                                     retval = IP_FW_DENY;
3004                                     break;
3005                                 }
3006
3007                                 struct cfg_nat *t;
3008                                 int nat_id;
3009
3010                                 args->rule.info = 0;
3011                                 set_match(args, f_pos, chain);
3012                                 /* Check if this is 'global' nat rule */
3013                                 if (cmd->arg1 == IP_FW_NAT44_GLOBAL) {
3014                                         retval = ipfw_nat_ptr(args, NULL, m);
3015                                         break;
3016                                 }
3017                                 t = ((ipfw_insn_nat *)cmd)->nat;
3018                                 if (t == NULL) {
3019                                         nat_id = TARG(cmd->arg1, nat);
3020                                         t = (*lookup_nat_ptr)(&chain->nat, nat_id);
3021
3022                                         if (t == NULL) {
3023                                             retval = IP_FW_DENY;
3024                                             break;
3025                                         }
3026                                         if (cmd->arg1 != IP_FW_TARG)
3027                                             ((ipfw_insn_nat *)cmd)->nat = t;
3028                                 }
3029                                 retval = ipfw_nat_ptr(args, t, m);
3030                                 break;
3031
3032                         case O_REASS: {
3033                                 int ip_off;
3034
3035                                 l = 0;  /* in any case exit inner loop */
3036                                 if (is_ipv6) /* IPv6 is not supported yet */
3037                                         break;
3038                                 IPFW_INC_RULE_COUNTER(f, pktlen);
3039                                 ip_off = ntohs(ip->ip_off);
3040
3041                                 /* if not fragmented, go to next rule */
3042                                 if ((ip_off & (IP_MF | IP_OFFMASK)) == 0)
3043                                     break;
3044
3045                                 args->m = m = ip_reass(m);
3046
3047                                 /*
3048                                  * do IP header checksum fixup.
3049                                  */
3050                                 if (m == NULL) { /* fragment got swallowed */
3051                                     retval = IP_FW_DENY;
3052                                 } else { /* good, packet complete */
3053                                     int hlen;
3054
3055                                     ip = mtod(m, struct ip *);
3056                                     hlen = ip->ip_hl << 2;
3057                                     ip->ip_sum = 0;
3058                                     if (hlen == sizeof(struct ip))
3059                                         ip->ip_sum = in_cksum_hdr(ip);
3060                                     else
3061                                         ip->ip_sum = in_cksum(m, hlen);
3062                                     retval = IP_FW_REASS;
3063                                     args->rule.info = 0;
3064                                     set_match(args, f_pos, chain);
3065                                 }
3066                                 done = 1;       /* exit outer loop */
3067                                 break;
3068                         }
3069                         case O_EXTERNAL_ACTION:
3070                                 l = 0; /* in any case exit inner loop */
3071                                 retval = ipfw_run_eaction(chain, args,
3072                                     cmd, &done);
3073                                 /*
3074                                  * If both @retval and @done are zero,
3075                                  * consider this as rule matching and
3076                                  * update counters.
3077                                  */
3078                                 if (retval == 0 && done == 0) {
3079                                         IPFW_INC_RULE_COUNTER(f, pktlen);
3080                                         /*
3081                                          * Reset the result of the last
3082                                          * dynamic state lookup.
3083                                          * External action can change
3084                                          * @args content, and it may be
3085                                          * used for new state lookup later.
3086                                          */
3087                                         DYN_INFO_INIT(&dyn_info);
3088                                 }
3089                                 break;
3090
3091                         default:
3092                                 panic("-- unknown opcode %d\n", cmd->opcode);
3093                         } /* end of switch() on opcodes */
3094                         /*
3095                          * if we get here with l=0, then match is irrelevant.
3096                          */
3097
3098                         if (cmd->len & F_NOT)
3099                                 match = !match;
3100
3101                         if (match) {
3102                                 if (cmd->len & F_OR)
3103                                         skip_or = 1;
3104                         } else {
3105                                 if (!(cmd->len & F_OR)) /* not an OR block, */
3106                                         break;          /* try next rule    */
3107                         }
3108
3109                 }       /* end of inner loop, scan opcodes */
3110 #undef PULLUP_LEN
3111
3112                 if (done)
3113                         break;
3114
3115 /* next_rule:; */       /* try next rule                */
3116
3117         }               /* end of outer for, scan rules */
3118
3119         if (done) {
3120                 struct ip_fw *rule = chain->map[f_pos];
3121                 /* Update statistics */
3122                 IPFW_INC_RULE_COUNTER(rule, pktlen);
3123         } else {
3124                 retval = IP_FW_DENY;
3125                 printf("ipfw: ouch!, skip past end of rules, denying packet\n");
3126         }
3127         IPFW_PF_RUNLOCK(chain);
3128 #ifdef __FreeBSD__
3129         if (ucred_cache != NULL)
3130                 crfree(ucred_cache);
3131 #endif
3132         return (retval);
3133
3134 pullup_failed:
3135         if (V_fw_verbose)
3136                 printf("ipfw: pullup failed\n");
3137         return (IP_FW_DENY);
3138 }
3139
3140 /*
3141  * Set maximum number of tables that can be used in given VNET ipfw instance.
3142  */
3143 #ifdef SYSCTL_NODE
3144 static int
3145 sysctl_ipfw_table_num(SYSCTL_HANDLER_ARGS)
3146 {
3147         int error;
3148         unsigned int ntables;
3149
3150         ntables = V_fw_tables_max;
3151
3152         error = sysctl_handle_int(oidp, &ntables, 0, req);
3153         /* Read operation or some error */
3154         if ((error != 0) || (req->newptr == NULL))
3155                 return (error);
3156
3157         return (ipfw_resize_tables(&V_layer3_chain, ntables));
3158 }
3159
3160 /*
3161  * Switches table namespace between global and per-set.
3162  */
3163 static int
3164 sysctl_ipfw_tables_sets(SYSCTL_HANDLER_ARGS)
3165 {
3166         int error;
3167         unsigned int sets;
3168
3169         sets = V_fw_tables_sets;
3170
3171         error = sysctl_handle_int(oidp, &sets, 0, req);
3172         /* Read operation or some error */
3173         if ((error != 0) || (req->newptr == NULL))
3174                 return (error);
3175
3176         return (ipfw_switch_tables_namespace(&V_layer3_chain, sets));
3177 }
3178 #endif
3179
3180 /*
3181  * Module and VNET glue
3182  */
3183
3184 /*
3185  * Stuff that must be initialised only on boot or module load
3186  */
3187 static int
3188 ipfw_init(void)
3189 {
3190         int error = 0;
3191
3192         /*
3193          * Only print out this stuff the first time around,
3194          * when called from the sysinit code.
3195          */
3196         printf("ipfw2 "
3197 #ifdef INET6
3198                 "(+ipv6) "
3199 #endif
3200                 "initialized, divert %s, nat %s, "
3201                 "default to %s, logging ",
3202 #ifdef IPDIVERT
3203                 "enabled",
3204 #else
3205                 "loadable",
3206 #endif
3207 #ifdef IPFIREWALL_NAT
3208                 "enabled",
3209 #else
3210                 "loadable",
3211 #endif
3212                 default_to_accept ? "accept" : "deny");
3213
3214         /*
3215          * Note: V_xxx variables can be accessed here but the vnet specific
3216          * initializer may not have been called yet for the VIMAGE case.
3217          * Tuneables will have been processed. We will print out values for
3218          * the default vnet. 
3219          * XXX This should all be rationalized AFTER 8.0
3220          */
3221         if (V_fw_verbose == 0)
3222                 printf("disabled\n");
3223         else if (V_verbose_limit == 0)
3224                 printf("unlimited\n");
3225         else
3226                 printf("limited to %d packets/entry by default\n",
3227                     V_verbose_limit);
3228
3229         /* Check user-supplied table count for validness */
3230         if (default_fw_tables > IPFW_TABLES_MAX)
3231           default_fw_tables = IPFW_TABLES_MAX;
3232
3233         ipfw_init_sopt_handler();
3234         ipfw_init_obj_rewriter();
3235         ipfw_iface_init();
3236         return (error);
3237 }
3238
3239 /*
3240  * Called for the removal of the last instance only on module unload.
3241  */
3242 static void
3243 ipfw_destroy(void)
3244 {
3245
3246         ipfw_iface_destroy();
3247         ipfw_destroy_sopt_handler();
3248         ipfw_destroy_obj_rewriter();
3249         printf("IP firewall unloaded\n");
3250 }
3251
3252 /*
3253  * Stuff that must be initialized for every instance
3254  * (including the first of course).
3255  */
3256 static int
3257 vnet_ipfw_init(const void *unused)
3258 {
3259         int error, first;
3260         struct ip_fw *rule = NULL;
3261         struct ip_fw_chain *chain;
3262
3263         chain = &V_layer3_chain;
3264
3265         first = IS_DEFAULT_VNET(curvnet) ? 1 : 0;
3266
3267         /* First set up some values that are compile time options */
3268         V_autoinc_step = 100;   /* bounded to 1..1000 in add_rule() */
3269         V_fw_deny_unknown_exthdrs = 1;
3270 #ifdef IPFIREWALL_VERBOSE
3271         V_fw_verbose = 1;
3272 #endif
3273 #ifdef IPFIREWALL_VERBOSE_LIMIT
3274         V_verbose_limit = IPFIREWALL_VERBOSE_LIMIT;
3275 #endif
3276 #ifdef IPFIREWALL_NAT
3277         LIST_INIT(&chain->nat);
3278 #endif
3279
3280         /* Init shared services hash table */
3281         ipfw_init_srv(chain);
3282
3283         ipfw_init_counters();
3284         /* Set initial number of tables */
3285         V_fw_tables_max = default_fw_tables;
3286         error = ipfw_init_tables(chain, first);
3287         if (error) {
3288                 printf("ipfw2: setting up tables failed\n");
3289                 free(chain->map, M_IPFW);
3290                 free(rule, M_IPFW);
3291                 return (ENOSPC);
3292         }
3293
3294         IPFW_LOCK_INIT(chain);
3295
3296         /* fill and insert the default rule */
3297         rule = ipfw_alloc_rule(chain, sizeof(struct ip_fw));
3298         rule->cmd_len = 1;
3299         rule->cmd[0].len = 1;
3300         rule->cmd[0].opcode = default_to_accept ? O_ACCEPT : O_DENY;
3301         chain->default_rule = rule;
3302         ipfw_add_protected_rule(chain, rule, 0);
3303
3304         ipfw_dyn_init(chain);
3305         ipfw_eaction_init(chain, first);
3306 #ifdef LINEAR_SKIPTO
3307         ipfw_init_skipto_cache(chain);
3308 #endif
3309         ipfw_bpf_init(first);
3310
3311         /* First set up some values that are compile time options */
3312         V_ipfw_vnet_ready = 1;          /* Open for business */
3313
3314         /*
3315          * Hook the sockopt handler and pfil hooks for ipv4 and ipv6.
3316          * Even if the latter two fail we still keep the module alive
3317          * because the sockopt and layer2 paths are still useful.
3318          * ipfw[6]_hook return 0 on success, ENOENT on failure,
3319          * so we can ignore the exact return value and just set a flag.
3320          *
3321          * Note that V_fw[6]_enable are manipulated by a SYSCTL_PROC so
3322          * changes in the underlying (per-vnet) variables trigger
3323          * immediate hook()/unhook() calls.
3324          * In layer2 we have the same behaviour, except that V_ether_ipfw
3325          * is checked on each packet because there are no pfil hooks.
3326          */
3327         V_ip_fw_ctl_ptr = ipfw_ctl3;
3328         error = ipfw_attach_hooks(1);
3329         return (error);
3330 }
3331
3332 /*
3333  * Called for the removal of each instance.
3334  */
3335 static int
3336 vnet_ipfw_uninit(const void *unused)
3337 {
3338         struct ip_fw *reap;
3339         struct ip_fw_chain *chain = &V_layer3_chain;
3340         int i, last;
3341
3342         V_ipfw_vnet_ready = 0; /* tell new callers to go away */
3343         /*
3344          * disconnect from ipv4, ipv6, layer2 and sockopt.
3345          * Then grab, release and grab again the WLOCK so we make
3346          * sure the update is propagated and nobody will be in.
3347          */
3348         (void)ipfw_attach_hooks(0 /* detach */);
3349         V_ip_fw_ctl_ptr = NULL;
3350
3351         last = IS_DEFAULT_VNET(curvnet) ? 1 : 0;
3352
3353         IPFW_UH_WLOCK(chain);
3354         IPFW_UH_WUNLOCK(chain);
3355
3356         ipfw_dyn_uninit(0);     /* run the callout_drain */
3357
3358         IPFW_UH_WLOCK(chain);
3359
3360         reap = NULL;
3361         IPFW_WLOCK(chain);
3362         for (i = 0; i < chain->n_rules; i++)
3363                 ipfw_reap_add(chain, &reap, chain->map[i]);
3364         free(chain->map, M_IPFW);
3365 #ifdef LINEAR_SKIPTO
3366         ipfw_destroy_skipto_cache(chain);
3367 #endif
3368         IPFW_WUNLOCK(chain);
3369         IPFW_UH_WUNLOCK(chain);
3370         ipfw_destroy_tables(chain, last);
3371         ipfw_eaction_uninit(chain, last);
3372         if (reap != NULL)
3373                 ipfw_reap_rules(reap);
3374         vnet_ipfw_iface_destroy(chain);
3375         ipfw_destroy_srv(chain);
3376         IPFW_LOCK_DESTROY(chain);
3377         ipfw_dyn_uninit(1);     /* free the remaining parts */
3378         ipfw_destroy_counters();
3379         ipfw_bpf_uninit(last);
3380         return (0);
3381 }
3382
3383 /*
3384  * Module event handler.
3385  * In general we have the choice of handling most of these events by the
3386  * event handler or by the (VNET_)SYS(UN)INIT handlers. I have chosen to
3387  * use the SYSINIT handlers as they are more capable of expressing the
3388  * flow of control during module and vnet operations, so this is just
3389  * a skeleton. Note there is no SYSINIT equivalent of the module
3390  * SHUTDOWN handler, but we don't have anything to do in that case anyhow.
3391  */
3392 static int
3393 ipfw_modevent(module_t mod, int type, void *unused)
3394 {
3395         int err = 0;
3396
3397         switch (type) {
3398         case MOD_LOAD:
3399                 /* Called once at module load or
3400                  * system boot if compiled in. */
3401                 break;
3402         case MOD_QUIESCE:
3403                 /* Called before unload. May veto unloading. */
3404                 break;
3405         case MOD_UNLOAD:
3406                 /* Called during unload. */
3407                 break;
3408         case MOD_SHUTDOWN:
3409                 /* Called during system shutdown. */
3410                 break;
3411         default:
3412                 err = EOPNOTSUPP;
3413                 break;
3414         }
3415         return err;
3416 }
3417
3418 static moduledata_t ipfwmod = {
3419         "ipfw",
3420         ipfw_modevent,
3421         0
3422 };
3423
3424 /* Define startup order. */
3425 #define IPFW_SI_SUB_FIREWALL    SI_SUB_PROTO_FIREWALL
3426 #define IPFW_MODEVENT_ORDER     (SI_ORDER_ANY - 255) /* On boot slot in here. */
3427 #define IPFW_MODULE_ORDER       (IPFW_MODEVENT_ORDER + 1) /* A little later. */
3428 #define IPFW_VNET_ORDER         (IPFW_MODEVENT_ORDER + 2) /* Later still. */
3429
3430 DECLARE_MODULE(ipfw, ipfwmod, IPFW_SI_SUB_FIREWALL, IPFW_MODEVENT_ORDER);
3431 FEATURE(ipfw_ctl3, "ipfw new sockopt calls");
3432 MODULE_VERSION(ipfw, 3);
3433 /* should declare some dependencies here */
3434
3435 /*
3436  * Starting up. Done in order after ipfwmod() has been called.
3437  * VNET_SYSINIT is also called for each existing vnet and each new vnet.
3438  */
3439 SYSINIT(ipfw_init, IPFW_SI_SUB_FIREWALL, IPFW_MODULE_ORDER,
3440             ipfw_init, NULL);
3441 VNET_SYSINIT(vnet_ipfw_init, IPFW_SI_SUB_FIREWALL, IPFW_VNET_ORDER,
3442             vnet_ipfw_init, NULL);
3443  
3444 /*
3445  * Closing up shop. These are done in REVERSE ORDER, but still
3446  * after ipfwmod() has been called. Not called on reboot.
3447  * VNET_SYSUNINIT is also called for each exiting vnet as it exits.
3448  * or when the module is unloaded.
3449  */
3450 SYSUNINIT(ipfw_destroy, IPFW_SI_SUB_FIREWALL, IPFW_MODULE_ORDER,
3451             ipfw_destroy, NULL);
3452 VNET_SYSUNINIT(vnet_ipfw_uninit, IPFW_SI_SUB_FIREWALL, IPFW_VNET_ORDER,
3453             vnet_ipfw_uninit, NULL);
3454 /* end of file */