2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2004 Andre Oppermann, Internet Business Solutions AG
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
34 #include "opt_inet6.h"
36 #error IPFIREWALL requires INET.
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/malloc.h>
43 #include <sys/module.h>
44 #include <sys/kernel.h>
46 #include <sys/rwlock.h>
47 #include <sys/socket.h>
48 #include <sys/sysctl.h>
51 #include <net/if_var.h>
52 #include <net/route.h>
53 #include <net/ethernet.h>
57 #include <netinet/in.h>
58 #include <netinet/in_systm.h>
59 #include <netinet/ip.h>
60 #include <netinet/ip_var.h>
61 #include <netinet/ip_fw.h>
63 #include <netinet/ip6.h>
64 #include <netinet6/ip6_var.h>
65 #include <netinet6/scope6_var.h>
68 #include <netgraph/ng_ipfw.h>
70 #include <netpfil/ipfw/ip_fw_private.h>
72 #include <machine/in_cksum.h>
74 VNET_DEFINE_STATIC(int, fw_enable) = 1;
75 #define V_fw_enable VNET(fw_enable)
78 VNET_DEFINE_STATIC(int, fw6_enable) = 1;
79 #define V_fw6_enable VNET(fw6_enable)
82 VNET_DEFINE_STATIC(int, fwlink_enable) = 0;
83 #define V_fwlink_enable VNET(fwlink_enable)
85 int ipfw_chg_hook(SYSCTL_HANDLER_ARGS);
87 /* Forward declarations. */
88 static int ipfw_divert(struct mbuf **, int, struct ipfw_rule_ref *, int);
94 SYSCTL_DECL(_net_inet_ip_fw);
95 SYSCTL_PROC(_net_inet_ip_fw, OID_AUTO, enable,
96 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE3,
97 &VNET_NAME(fw_enable), 0, ipfw_chg_hook, "I", "Enable ipfw");
99 SYSCTL_DECL(_net_inet6_ip6_fw);
100 SYSCTL_PROC(_net_inet6_ip6_fw, OID_AUTO, enable,
101 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE3,
102 &VNET_NAME(fw6_enable), 0, ipfw_chg_hook, "I", "Enable ipfw+6");
105 SYSCTL_DECL(_net_link_ether);
106 SYSCTL_PROC(_net_link_ether, OID_AUTO, ipfw,
107 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_SECURE3,
108 &VNET_NAME(fwlink_enable), 0, ipfw_chg_hook, "I",
109 "Pass ether pkts through firewall");
113 #endif /* SYSCTL_NODE */
116 * The pfilter hook to pass packets to ipfw_chk and then to
117 * dummynet, divert, netgraph or other modules.
118 * The packet may be consumed.
121 ipfw_check_packet(struct mbuf **m0, struct ifnet *ifp, int dir,
122 void *ruleset __unused, struct inpcb *inp)
124 struct ip_fw_args args;
129 /* convert dir to IPFW values */
130 dir = (dir & PFIL_IN) ? DIR_IN : DIR_OUT;
134 * extract and remove the tag if present. If we are left
135 * with onepass, optimize the outgoing path.
137 tag = m_tag_locate(*m0, MTAG_IPFW_RULE, 0, NULL);
139 args.rule = *((struct ipfw_rule_ref *)(tag+1));
140 m_tag_delete(*m0, tag);
141 if (args.rule.info & IPFW_ONEPASS)
143 args.flags |= IPFW_ARGS_REF;
147 args.oif = dir == DIR_OUT ? ifp : NULL;
150 ipfw = ipfw_chk(&args);
153 KASSERT(*m0 != NULL || ipfw == IP_FW_DENY, ("%s: m0 is NULL",
159 /* next_hop may be set by ipfw_chk */
160 if ((args.flags & (IPFW_ARGS_NH4 | IPFW_ARGS_NH4PTR |
161 IPFW_ARGS_NH6 | IPFW_ARGS_NH6PTR)) == 0)
163 #if (!defined(INET6) && !defined(INET))
170 if (args.flags & (IPFW_ARGS_NH4 | IPFW_ARGS_NH4PTR)) {
171 MPASS((args.flags & (IPFW_ARGS_NH4 |
172 IPFW_ARGS_NH4PTR)) != (IPFW_ARGS_NH4 |
174 MPASS((args.flags & (IPFW_ARGS_NH6 |
175 IPFW_ARGS_NH6PTR)) == 0);
176 len = sizeof(struct sockaddr_in);
177 psa = (args.flags & IPFW_ARGS_NH4) ?
178 &args.hopstore : args.next_hop;
179 if (in_localip(satosin(psa)->sin_addr))
180 (*m0)->m_flags |= M_FASTFWD_OURS;
181 (*m0)->m_flags |= M_IP_NEXTHOP;
185 if (args.flags & (IPFW_ARGS_NH6 | IPFW_ARGS_NH6PTR)) {
186 MPASS((args.flags & (IPFW_ARGS_NH6 |
187 IPFW_ARGS_NH6PTR)) != (IPFW_ARGS_NH6 |
189 MPASS((args.flags & (IPFW_ARGS_NH4 |
190 IPFW_ARGS_NH4PTR)) == 0);
191 len = sizeof(struct sockaddr_in6);
192 psa = args.next_hop6;
193 (*m0)->m_flags |= M_IP6_NEXTHOP;
197 * Incoming packets should not be tagged so we do not
198 * m_tag_find. Outgoing packets may be tagged, so we
199 * reuse the tag if present.
201 tag = (dir == DIR_IN) ? NULL :
202 m_tag_find(*m0, PACKET_TAG_IPFORWARD, NULL);
204 m_tag_unlink(*m0, tag);
206 tag = m_tag_get(PACKET_TAG_IPFORWARD, len,
213 if ((args.flags & IPFW_ARGS_NH6) == 0)
214 bcopy(psa, tag + 1, len);
215 m_tag_prepend(*m0, tag);
218 /* IPv6 next hop needs additional handling */
219 if (args.flags & (IPFW_ARGS_NH6 | IPFW_ARGS_NH6PTR)) {
220 struct sockaddr_in6 *sa6;
222 sa6 = satosin6(tag + 1);
223 if (args.flags & IPFW_ARGS_NH6) {
224 sa6->sin6_family = AF_INET6;
225 sa6->sin6_len = sizeof(*sa6);
226 sa6->sin6_addr = args.hopstore6.sin6_addr;
227 sa6->sin6_port = args.hopstore6.sin6_port;
229 args.hopstore6.sin6_scope_id;
232 * If nh6 address is link-local we should convert
233 * it to kernel internal form before doing any
236 if (sa6_embedscope(sa6, V_ip6_use_defzone) != 0) {
240 if (in6_localip(&sa6->sin6_addr))
241 (*m0)->m_flags |= M_FASTFWD_OURS;
245 #endif /* INET || INET6 */
253 if (ip_dn_io_ptr == NULL) {
257 MPASS(args.flags & IPFW_ARGS_REF);
258 if (mtod(*m0, struct ip *)->ip_v == 4)
259 (void )ip_dn_io_ptr(m0, dir, &args);
260 else if (mtod(*m0, struct ip *)->ip_v == 6)
261 (void )ip_dn_io_ptr(m0, dir | PROTO_IPV6, &args);
267 * XXX should read the return value.
268 * dummynet normally eats the packet and sets *m0=NULL
269 * unless the packet can be sent immediately. In this
270 * case args is updated and we should re-run the
271 * check without clearing args.
280 if (ip_divert_ptr == NULL) {
284 MPASS(args.flags & IPFW_ARGS_REF);
285 (void )ipfw_divert(m0, dir, &args.rule,
286 (ipfw == IP_FW_TEE) ? 1 : 0);
287 /* continue processing for the original packet (tee). */
295 if (ng_ipfw_input_p == NULL) {
299 MPASS(args.flags & IPFW_ARGS_REF);
300 (void )ng_ipfw_input_p(m0, dir, &args,
301 (ipfw == IP_FW_NGTEE) ? 1 : 0);
302 if (ipfw == IP_FW_NGTEE) /* ignore errors for NGTEE */
303 goto again; /* continue with packet */
308 /* honor one-pass in case of successful nat */
314 goto again; /* continue with packet */
321 KASSERT(0, ("%s: unknown retval", __func__));
324 if (ret != PFIL_PASS) {
334 * ipfw processing for ethernet packets (in and out).
337 ipfw_check_frame(struct mbuf **m0, struct ifnet *ifp, int dir,
338 void *ruleset __unused, struct inpcb *inp)
340 struct ip_fw_args args;
341 struct ether_header save_eh;
342 struct ether_header *eh;
348 args.flags = IPFW_ARGS_ETHER;
350 /* fetch start point from rule, if any. remove the tag if present. */
351 mtag = m_tag_locate(*m0, MTAG_IPFW_RULE, 0, NULL);
353 args.rule = *((struct ipfw_rule_ref *)(mtag+1));
354 m_tag_delete(*m0, mtag);
355 if (args.rule.info & IPFW_ONEPASS)
357 args.flags |= IPFW_ARGS_REF;
360 /* I need some amt of data to be contiguous */
362 i = min(m->m_pkthdr.len, max_protohdr);
370 eh = mtod(m, struct ether_header *);
371 save_eh = *eh; /* save copy for restore below */
372 m_adj(m, ETHER_HDR_LEN); /* strip ethernet header */
374 args.m = m; /* the packet we are looking at */
375 args.oif = dir & PFIL_OUT ? ifp: NULL; /* destination, if any */
376 args.eh = &save_eh; /* MAC header for bridged/MAC packets */
377 args.inp = inp; /* used by ipfw uid/gid/jail rules */
382 * Restore Ethernet header, as needed, in case the
383 * mbuf chain was replaced by ipfw.
385 M_PREPEND(m, ETHER_HDR_LEN, M_NOWAIT);
390 if (eh != mtod(m, struct ether_header *))
391 bcopy(&save_eh, mtod(m, struct ether_header *),
397 /* Check result of ipfw_chk() */
407 if (ip_dn_io_ptr == NULL) {
412 dir = (dir & PFIL_IN) ? DIR_IN : DIR_OUT;
413 MPASS(args.flags & IPFW_ARGS_REF);
414 ip_dn_io_ptr(&m, dir | PROTO_LAYER2, &args);
415 return (PFIL_CONSUMED);
419 if (ng_ipfw_input_p == NULL) {
423 MPASS(args.flags & IPFW_ARGS_REF);
424 (void )ng_ipfw_input_p(m0, (dir & PFIL_IN) ? DIR_IN : DIR_OUT,
425 &args, (i == IP_FW_NGTEE) ? 1 : 0);
426 if (i == IP_FW_NGTEE) /* ignore errors for NGTEE */
427 goto again; /* continue with packet */
432 KASSERT(0, ("%s: unknown retval", __func__));
435 if (ret != PFIL_PASS) {
444 /* do the divert, return 1 on error 0 on success */
446 ipfw_divert(struct mbuf **m0, int incoming, struct ipfw_rule_ref *rule,
450 * ipfw_chk() has already tagged the packet with the divert tag.
451 * If tee is set, copy packet and return original.
452 * If not tee, consume packet and send it to divert socket.
455 struct ip *ip = mtod(*m0, struct ip *);
458 /* Cloning needed for tee? */
460 clone = *m0; /* use the original mbuf */
463 clone = m_dup(*m0, M_NOWAIT);
464 /* If we cannot duplicate the mbuf, we sacrifice the divert
465 * chain and continue with the tee-ed packet.
472 * Divert listeners can normally handle non-fragmented packets,
473 * but we can only reass in the non-tee case.
474 * This means that listeners on a tee rule may get fragments,
475 * and have to live with that.
476 * Note that we now have the 'reass' ipfw option so if we care
477 * we can do it before a 'tee'.
479 if (!tee) switch (ip->ip_v) {
481 if (ntohs(ip->ip_off) & (IP_MF | IP_OFFMASK)) {
485 reass = ip_reass(clone); /* Reassemble packet. */
487 return 0; /* not an error */
488 /* if reass = NULL then it was consumed by ip_reass */
490 * IP header checksum fixup after reassembly and leave header
491 * in network byte order.
493 ip = mtod(reass, struct ip *);
494 hlen = ip->ip_hl << 2;
496 if (hlen == sizeof(struct ip))
497 ip->ip_sum = in_cksum_hdr(ip);
499 ip->ip_sum = in_cksum(reass, hlen);
504 case IPV6_VERSION >> 4:
506 struct ip6_hdr *const ip6 = mtod(clone, struct ip6_hdr *);
508 if (ip6->ip6_nxt == IPPROTO_FRAGMENT) {
511 off = sizeof(struct ip6_hdr);
512 nxt = frag6_input(&clone, &off, 0);
513 if (nxt == IPPROTO_DONE)
521 /* attach a tag to the packet with the reinject info */
522 tag = m_tag_alloc(MTAG_IPFW_RULE, 0,
523 sizeof(struct ipfw_rule_ref), M_NOWAIT);
528 *((struct ipfw_rule_ref *)(tag+1)) = *rule;
529 m_tag_prepend(clone, tag);
531 /* Do the dirty job... */
532 ip_divert_ptr(clone, incoming);
537 * attach or detach hooks for a given protocol family
539 VNET_DEFINE_STATIC(pfil_hook_t, ipfw_inet_hook);
540 #define V_ipfw_inet_hook VNET(ipfw_inet_hook)
542 VNET_DEFINE_STATIC(pfil_hook_t, ipfw_inet6_hook);
543 #define V_ipfw_inet6_hook VNET(ipfw_inet6_hook)
545 VNET_DEFINE_STATIC(pfil_hook_t, ipfw_link_hook);
546 #define V_ipfw_link_hook VNET(ipfw_link_hook)
549 ipfw_hook(int onoff, int pf)
551 struct pfil_hook_args pha;
552 struct pfil_link_args pla;
555 pha.pa_version = PFIL_VERSION;
556 pha.pa_flags = PFIL_IN | PFIL_OUT;
557 pha.pa_modname = "ipfw";
558 pha.pa_ruleset = NULL;
560 pla.pa_version = PFIL_VERSION;
561 pla.pa_flags = PFIL_IN | PFIL_OUT |
562 PFIL_HEADPTR | PFIL_HOOKPTR;
566 pha.pa_func = ipfw_check_packet;
567 pha.pa_type = PFIL_TYPE_IP4;
568 pha.pa_rulname = "default";
569 h = &V_ipfw_inet_hook;
570 pla.pa_head = V_inet_pfil_head;
574 pha.pa_func = ipfw_check_packet;
575 pha.pa_type = PFIL_TYPE_IP6;
576 pha.pa_rulname = "default6";
577 h = &V_ipfw_inet6_hook;
578 pla.pa_head = V_inet6_pfil_head;
582 pha.pa_func = ipfw_check_frame;
583 pha.pa_type = PFIL_TYPE_ETHERNET;
584 pha.pa_rulname = "default-link";
585 h = &V_ipfw_link_hook;
586 pla.pa_head = V_link_pfil_head;
591 *h = pfil_add_hook(&pha);
593 (void)pfil_link(&pla);
596 pfil_remove_hook(*h);
602 ipfw_attach_hooks(int arg)
606 if (arg == 0) /* detach */
607 ipfw_hook(0, AF_INET);
608 else if (V_fw_enable && ipfw_hook(1, AF_INET) != 0) {
609 error = ENOENT; /* see ip_fw_pfil.c::ipfw_hook() */
610 printf("ipfw_hook() error\n");
613 if (arg == 0) /* detach */
614 ipfw_hook(0, AF_INET6);
615 else if (V_fw6_enable && ipfw_hook(1, AF_INET6) != 0) {
617 printf("ipfw6_hook() error\n");
620 if (arg == 0) /* detach */
621 ipfw_hook(0, AF_LINK);
622 else if (V_fwlink_enable && ipfw_hook(1, AF_LINK) != 0) {
624 printf("ipfw_link_hook() error\n");
630 ipfw_chg_hook(SYSCTL_HANDLER_ARGS)
636 if (arg1 == &V_fw_enable)
639 else if (arg1 == &V_fw6_enable)
642 else if (arg1 == &V_fwlink_enable)
647 newval = *(int *)arg1;
648 /* Handle sysctl change */
649 error = sysctl_handle_int(oidp, &newval, 0, req);
654 /* Formalize new value */
655 newval = (newval) ? 1 : 0;
657 if (*(int *)arg1 == newval)
660 error = ipfw_hook(newval, af);
663 *(int *)arg1 = newval;