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