2 * SPDX-License-Identifier: ISC
4 * The authors of this code are John Ioannidis (ji@tla.org),
5 * Angelos D. Keromytis (kermit@csd.uch.gr) and
6 * Niels Provos (provos@physnet.uni-hamburg.de).
8 * This code was written by John Ioannidis for BSD/OS in Athens, Greece,
11 * Ported to OpenBSD and NetBSD, with additional transforms, in December 1996,
12 * by Angelos D. Keromytis.
14 * Additional transforms and features in 1997 and 1998 by Angelos D. Keromytis
17 * Copyright (C) 1995, 1996, 1997, 1998 by John Ioannidis, Angelos D. Keromytis
19 * Copyright (c) 2001, Angelos D. Keromytis, Niels Provos.
21 * Permission to use, copy, and modify this software with or without fee
22 * is hereby granted, provided that this entire notice is included in
23 * all copies of any software which is or includes a copy or
24 * modification of this software.
25 * You may use this code under the GNU public license if you so wish. Please
26 * contribute changes back to the authors under this freer than GPL license
27 * so that we may further the use of strong encryption without limitations to
30 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
31 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
32 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
33 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
36 * $OpenBSD: if_pflog.c,v 1.26 2007/10/18 21:58:18 mpf Exp $
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
43 #include "opt_inet6.h"
47 #include <sys/param.h>
48 #include <sys/kernel.h>
50 #include <sys/module.h>
52 #include <sys/socket.h>
53 #include <sys/sockio.h>
57 #include <net/if_var.h>
58 #include <net/if_clone.h>
59 #include <net/if_pflog.h>
60 #include <net/if_types.h>
62 #include <net/pfvar.h>
64 #if defined(INET) || defined(INET6)
65 #include <netinet/in.h>
68 #include <netinet/in_var.h>
69 #include <netinet/ip.h>
73 #include <netinet6/in6_var.h>
74 #include <netinet6/nd6.h>
78 #include <machine/in_cksum.h>
81 #define PFLOGMTU (32768 + MHLEN + MLEN)
84 #define DPRINTF(x) do { if (pflogdebug) printf x ; } while (0)
89 static int pflogoutput(struct ifnet *, struct mbuf *,
90 const struct sockaddr *, struct route *);
91 static void pflogattach(int);
92 static int pflogioctl(struct ifnet *, u_long, caddr_t);
93 static void pflogstart(struct ifnet *);
94 static int pflog_clone_create(struct if_clone *, int, caddr_t);
95 static void pflog_clone_destroy(struct ifnet *);
97 static const char pflogname[] = "pflog";
99 static VNET_DEFINE(struct if_clone *, pflog_cloner);
100 #define V_pflog_cloner VNET(pflog_cloner)
102 VNET_DEFINE(struct ifnet *, pflogifs[PFLOGIFS_MAX]); /* for fast access */
103 #define V_pflogifs VNET(pflogifs)
106 pflogattach(int npflog __unused)
109 for (i = 0; i < PFLOGIFS_MAX; i++)
110 V_pflogifs[i] = NULL;
111 V_pflog_cloner = if_clone_simple(pflogname, pflog_clone_create,
112 pflog_clone_destroy, 1);
116 pflog_clone_create(struct if_clone *ifc, int unit, caddr_t param)
120 if (unit >= PFLOGIFS_MAX)
123 ifp = if_alloc(IFT_PFLOG);
127 if_initname(ifp, pflogname, unit);
128 ifp->if_mtu = PFLOGMTU;
129 ifp->if_ioctl = pflogioctl;
130 ifp->if_output = pflogoutput;
131 ifp->if_start = pflogstart;
132 ifp->if_snd.ifq_maxlen = ifqmaxlen;
133 ifp->if_hdrlen = PFLOG_HDRLEN;
136 bpfattach(ifp, DLT_PFLOG, PFLOG_HDRLEN);
138 V_pflogifs[unit] = ifp;
144 pflog_clone_destroy(struct ifnet *ifp)
148 for (i = 0; i < PFLOGIFS_MAX; i++)
149 if (V_pflogifs[i] == ifp)
150 V_pflogifs[i] = NULL;
158 * Start output on the pflog interface.
161 pflogstart(struct ifnet *ifp)
166 IF_LOCK(&ifp->if_snd);
167 _IF_DEQUEUE(&ifp->if_snd, m);
168 IF_UNLOCK(&ifp->if_snd);
178 pflogoutput(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst,
187 pflogioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
191 if (ifp->if_flags & IFF_UP)
192 ifp->if_drv_flags |= IFF_DRV_RUNNING;
194 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
204 pflog_packet(struct pfi_kif *kif, struct mbuf *m, sa_family_t af, u_int8_t dir,
205 u_int8_t reason, struct pf_rule *rm, struct pf_rule *am,
206 struct pf_ruleset *ruleset, struct pf_pdesc *pd, int lookupsafe)
211 if (kif == NULL || m == NULL || rm == NULL || pd == NULL)
214 if ((ifn = V_pflogifs[rm->logif]) == NULL || !ifn->if_bpf)
217 bzero(&hdr, sizeof(hdr));
218 hdr.length = PFLOG_REAL_HDRLEN;
220 hdr.action = rm->action;
222 memcpy(hdr.ifname, kif->pfik_name, sizeof(hdr.ifname));
225 hdr.rulenr = htonl(rm->nr);
228 hdr.rulenr = htonl(am->nr);
229 hdr.subrulenr = htonl(rm->nr);
230 if (ruleset != NULL && ruleset->anchor != NULL)
231 strlcpy(hdr.ruleset, ruleset->anchor->name,
232 sizeof(hdr.ruleset));
235 * XXXGL: we avoid pf_socket_lookup() when we are holding
236 * state lock, since this leads to unsafe LOR.
237 * These conditions are very very rare, however.
239 if (rm->log & PF_LOG_SOCKET_LOOKUP && !pd->lookup.done && lookupsafe)
240 pd->lookup.done = pf_socket_lookup(dir, pd, m);
241 if (pd->lookup.done > 0)
242 hdr.uid = pd->lookup.uid;
246 hdr.rule_uid = rm->cuid;
247 hdr.rule_pid = rm->cpid;
251 if (af == AF_INET && dir == PF_OUT) {
254 ip = mtod(m, struct ip *);
256 ip->ip_sum = in_cksum(m, ip->ip_hl << 2);
260 if_inc_counter(ifn, IFCOUNTER_OPACKETS, 1);
261 if_inc_counter(ifn, IFCOUNTER_OBYTES, m->m_pkthdr.len);
262 BPF_MTAP2(ifn, &hdr, PFLOG_HDRLEN, m);
268 vnet_pflog_init(const void *unused __unused)
273 VNET_SYSINIT(vnet_pflog_init, SI_SUB_PROTO_FIREWALL, SI_ORDER_ANY,
274 vnet_pflog_init, NULL);
277 vnet_pflog_uninit(const void *unused __unused)
280 if_clone_detach(V_pflog_cloner);
283 * Detach after pf is gone; otherwise we might touch pflog memory
284 * from within pf after freeing pflog.
286 VNET_SYSUNINIT(vnet_pflog_uninit, SI_SUB_INIT_IF, SI_ORDER_SECOND,
287 vnet_pflog_uninit, NULL);
290 pflog_modevent(module_t mod, int type, void *data)
297 pflog_packet_ptr = pflog_packet;
302 pflog_packet_ptr = NULL;
313 static moduledata_t pflog_mod = { pflogname, pflog_modevent, 0 };
315 #define PFLOG_MODVER 1
317 /* Do not run before pf is initialized as we depend on its locks. */
318 DECLARE_MODULE(pflog, pflog_mod, SI_SUB_PROTO_FIREWALL, SI_ORDER_ANY);
319 MODULE_VERSION(pflog, PFLOG_MODVER);
320 MODULE_DEPEND(pflog, pf, PF_MODVER, PF_MODVER, PF_MODVER);