1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2001 Daniel Hartmeier
5  * Copyright (c) 2003 Cedric Berger
6  * Copyright (c) 2005 Henning Brauer <henning@openbsd.org>
7  * Copyright (c) 2005 Ryan McBride <mcbride@openbsd.org>
8  * Copyright (c) 2012 Gleb Smirnoff <glebius@FreeBSD.org>
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  *    - Redistributions of source code must retain the above copyright
16  *      notice, this list of conditions and the following disclaimer.
17  *    - Redistributions in binary form must reproduce the above
18  *      copyright notice, this list of conditions and the following
19  *      disclaimer in the documentation and/or other materials provided
20  *      with the distribution.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  *	$OpenBSD: pf_if.c,v 1.54 2008/06/14 16:55:28 mk Exp $
36  */
37 
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD: stable/12/sys/netpfil/pf/pf_if.c 372816 2022-12-28 09:04:43Z git2svn $");
40 
41 #include "opt_inet.h"
42 #include "opt_inet6.h"
43 
44 #include <sys/param.h>
45 #include <sys/kernel.h>
46 #include <sys/eventhandler.h>
47 #include <sys/lock.h>
48 #include <sys/mbuf.h>
49 #include <sys/socket.h>
50 
51 #include <net/if.h>
52 #include <net/if_var.h>
53 #include <net/vnet.h>
54 #include <net/pfvar.h>
55 #include <net/route.h>
56 
57 VNET_DEFINE(struct pfi_kkif *,	 pfi_all);
58 VNET_DEFINE_STATIC(long, pfi_update);
59 #define	V_pfi_update	VNET(pfi_update)
60 #define PFI_BUFFER_MAX	0x10000
61 
62 VNET_DECLARE(int, pf_vnet_active);
63 #define V_pf_vnet_active	VNET(pf_vnet_active)
64 
65 VNET_DEFINE_STATIC(struct pfr_addr *, pfi_buffer);
66 VNET_DEFINE_STATIC(int, pfi_buffer_cnt);
67 VNET_DEFINE_STATIC(int,	pfi_buffer_max);
68 #define	V_pfi_buffer		 VNET(pfi_buffer)
69 #define	V_pfi_buffer_cnt	 VNET(pfi_buffer_cnt)
70 #define	V_pfi_buffer_max	 VNET(pfi_buffer_max)
71 
72 #ifdef PF_WANT_32_TO_64_COUNTER
73 VNET_DEFINE(struct allkiflist_head, pf_allkiflist);
74 VNET_DEFINE(size_t, pf_allkifcount);
75 VNET_DEFINE(struct pfi_kkif *, pf_kifmarker);
76 #endif
77 
78 eventhandler_tag	 pfi_attach_cookie;
79 eventhandler_tag	 pfi_detach_cookie;
80 eventhandler_tag	 pfi_attach_group_cookie;
81 eventhandler_tag	 pfi_change_group_cookie;
82 eventhandler_tag	 pfi_detach_group_cookie;
83 eventhandler_tag	 pfi_ifaddr_event_cookie;
84 
85 static void	 pfi_attach_ifnet(struct ifnet *);
86 static void	 pfi_attach_ifgroup(struct ifg_group *);
87 
88 static void	 pfi_kkif_update(struct pfi_kkif *);
89 static void	 pfi_dynaddr_update(struct pfi_dynaddr *dyn);
90 static void	 pfi_table_update(struct pfr_ktable *, struct pfi_kkif *, int,
91 		    int);
92 static void	 pfi_instance_add(struct ifnet *, int, int);
93 static void	 pfi_address_add(struct sockaddr *, int, int);
94 static int	 pfi_kkif_compare(struct pfi_kkif *, struct pfi_kkif *);
95 static int	 pfi_skip_if(const char *, struct pfi_kkif *);
96 static int	 pfi_unmask(void *);
97 static void	 pfi_attach_ifnet_event(void * __unused, struct ifnet *);
98 static void	 pfi_detach_ifnet_event(void * __unused, struct ifnet *);
99 static void	 pfi_attach_group_event(void * __unused, struct ifg_group *);
100 static void	 pfi_change_group_event(void * __unused, char *);
101 static void	 pfi_detach_group_event(void * __unused, struct ifg_group *);
102 static void	 pfi_ifaddr_event(void * __unused, struct ifnet *);
103 
104 RB_HEAD(pfi_ifhead, pfi_kkif);
105 static RB_PROTOTYPE(pfi_ifhead, pfi_kkif, pfik_tree, pfi_kkif_compare);
106 static RB_GENERATE(pfi_ifhead, pfi_kkif, pfik_tree, pfi_kkif_compare);
107 VNET_DEFINE_STATIC(struct pfi_ifhead, pfi_ifs);
108 #define	V_pfi_ifs	VNET(pfi_ifs)
109 
110 #define	PFI_BUFFER_MAX		0x10000
111 MALLOC_DEFINE(PFI_MTYPE, "pf_ifnet", "pf(4) interface database");
112 
113 LIST_HEAD(pfi_list, pfi_kkif);
114 VNET_DEFINE_STATIC(struct pfi_list, pfi_unlinked_kifs);
115 #define	V_pfi_unlinked_kifs	VNET(pfi_unlinked_kifs)
116 static struct mtx pfi_unlnkdkifs_mtx;
117 MTX_SYSINIT(pfi_unlnkdkifs_mtx, &pfi_unlnkdkifs_mtx, "pf unlinked interfaces",
118     MTX_DEF);
119 
120 void
pfi_initialize_vnet(void)121 pfi_initialize_vnet(void)
122 {
123 	struct ifg_group *ifg;
124 	struct ifnet *ifp;
125 	struct pfi_kkif *kif;
126 
127 	V_pfi_buffer_max = 64;
128 	V_pfi_buffer = malloc(V_pfi_buffer_max * sizeof(*V_pfi_buffer),
129 	    PFI_MTYPE, M_WAITOK);
130 
131 	kif = pf_kkif_create(M_WAITOK);
132 	PF_RULES_WLOCK();
133 	V_pfi_all = pfi_kkif_attach(kif, IFG_ALL);
134 	PF_RULES_WUNLOCK();
135 
136 	IFNET_RLOCK();
137 	CK_STAILQ_FOREACH(ifg, &V_ifg_head, ifg_next)
138 		pfi_attach_ifgroup(ifg);
139 	CK_STAILQ_FOREACH(ifp, &V_ifnet, if_link)
140 		pfi_attach_ifnet(ifp);
141 	IFNET_RUNLOCK();
142 }
143 
144 void
pfi_initialize(void)145 pfi_initialize(void)
146 {
147 
148 	pfi_attach_cookie = EVENTHANDLER_REGISTER(ifnet_arrival_event,
149 	    pfi_attach_ifnet_event, NULL, EVENTHANDLER_PRI_ANY);
150 	pfi_detach_cookie = EVENTHANDLER_REGISTER(ifnet_departure_event,
151 	    pfi_detach_ifnet_event, NULL, EVENTHANDLER_PRI_ANY);
152 	pfi_attach_group_cookie = EVENTHANDLER_REGISTER(group_attach_event,
153 	    pfi_attach_group_event, NULL, EVENTHANDLER_PRI_ANY);
154 	pfi_change_group_cookie = EVENTHANDLER_REGISTER(group_change_event,
155 	    pfi_change_group_event, NULL, EVENTHANDLER_PRI_ANY);
156 	pfi_detach_group_cookie = EVENTHANDLER_REGISTER(group_detach_event,
157 	    pfi_detach_group_event, NULL, EVENTHANDLER_PRI_ANY);
158 	pfi_ifaddr_event_cookie = EVENTHANDLER_REGISTER(ifaddr_event,
159 	    pfi_ifaddr_event, NULL, EVENTHANDLER_PRI_ANY);
160 }
161 
162 void
pfi_cleanup_vnet(void)163 pfi_cleanup_vnet(void)
164 {
165 	struct pfi_kkif *kif;
166 
167 	PF_RULES_WASSERT();
168 
169 	V_pfi_all = NULL;
170 	while ((kif = RB_MIN(pfi_ifhead, &V_pfi_ifs))) {
171 		RB_REMOVE(pfi_ifhead, &V_pfi_ifs, kif);
172 		if (kif->pfik_group)
173 			kif->pfik_group->ifg_pf_kif = NULL;
174 		if (kif->pfik_ifp) {
175 			if_rele(kif->pfik_ifp);
176 			kif->pfik_ifp->if_pf_kif = NULL;
177 		}
178 		pf_kkif_free(kif);
179 	}
180 
181 	mtx_lock(&pfi_unlnkdkifs_mtx);
182 	while ((kif = LIST_FIRST(&V_pfi_unlinked_kifs))) {
183 		LIST_REMOVE(kif, pfik_list);
184 		pf_kkif_free(kif);
185 	}
186 	mtx_unlock(&pfi_unlnkdkifs_mtx);
187 
188 	free(V_pfi_buffer, PFI_MTYPE);
189 }
190 
191 void
pfi_cleanup(void)192 pfi_cleanup(void)
193 {
194 
195 	EVENTHANDLER_DEREGISTER(ifnet_arrival_event, pfi_attach_cookie);
196 	EVENTHANDLER_DEREGISTER(ifnet_departure_event, pfi_detach_cookie);
197 	EVENTHANDLER_DEREGISTER(group_attach_event, pfi_attach_group_cookie);
198 	EVENTHANDLER_DEREGISTER(group_change_event, pfi_change_group_cookie);
199 	EVENTHANDLER_DEREGISTER(group_detach_event, pfi_detach_group_cookie);
200 	EVENTHANDLER_DEREGISTER(ifaddr_event, pfi_ifaddr_event_cookie);
201 }
202 
203 struct pfi_kkif*
pf_kkif_create(int flags)204 pf_kkif_create(int flags)
205 {
206 	struct pfi_kkif *kif;
207 #ifdef PF_WANT_32_TO_64_COUNTER
208 	bool wowned;
209 #endif
210 
211 	kif = malloc(sizeof(*kif), PFI_MTYPE, flags | M_ZERO);
212 	if (! kif)
213 		return (kif);
214 
215 	for (int i = 0; i < 2; i++) {
216 		for (int j = 0; j < 2; j++) {
217 			for (int k = 0; k < 2; k++) {
218 				if (pf_counter_u64_init(&kif->pfik_packets[i][j][k], flags) != 0) {
219 					pf_kkif_free(kif);
220 					return (NULL);
221 				}
222 
223 				if (pf_counter_u64_init(&kif->pfik_bytes[i][j][k], flags) != 0) {
224 					pf_kkif_free(kif);
225 					return (NULL);
226 				}
227 			}
228 		}
229 	}
230 
231 #ifdef PF_WANT_32_TO_64_COUNTER
232 	wowned = PF_RULES_WOWNED();
233 	if (!wowned)
234 		PF_RULES_WLOCK();
235 	LIST_INSERT_HEAD(&V_pf_allkiflist, kif, pfik_allkiflist);
236 	V_pf_allkifcount++;
237 	if (!wowned)
238 		PF_RULES_WUNLOCK();
239 #endif
240 
241 	return (kif);
242 }
243 
244 void
pf_kkif_free(struct pfi_kkif * kif)245 pf_kkif_free(struct pfi_kkif *kif)
246 {
247 #ifdef PF_WANT_32_TO_64_COUNTER
248 	bool wowned;
249 #endif
250 
251 	if (! kif)
252 		return;
253 
254 #ifdef PF_WANT_32_TO_64_COUNTER
255 	wowned = PF_RULES_WOWNED();
256 	if (!wowned)
257 		PF_RULES_WLOCK();
258 	LIST_REMOVE(kif, pfik_allkiflist);
259 	V_pf_allkifcount--;
260 	if (!wowned)
261 		PF_RULES_WUNLOCK();
262 #endif
263 
264 	for (int i = 0; i < 2; i++) {
265 		for (int j = 0; j < 2; j++) {
266 			for (int k = 0; k < 2; k++) {
267 				pf_counter_u64_deinit(&kif->pfik_packets[i][j][k]);
268 				pf_counter_u64_deinit(&kif->pfik_bytes[i][j][k]);
269 			}
270 		}
271 	}
272 
273 	free(kif, PFI_MTYPE);
274 }
275 
276 void
pf_kkif_zero(struct pfi_kkif * kif)277 pf_kkif_zero(struct pfi_kkif *kif)
278 {
279 
280 	for (int i = 0; i < 2; i++) {
281 		for (int j = 0; j < 2; j++) {
282 			for (int k = 0; k < 2; k++) {
283 				pf_counter_u64_zero(&kif->pfik_packets[i][j][k]);
284 				pf_counter_u64_zero(&kif->pfik_bytes[i][j][k]);
285 			}
286 		}
287 	}
288 	kif->pfik_tzero = time_second;
289 }
290 
291 struct pfi_kkif *
pfi_kkif_find(const char * kif_name)292 pfi_kkif_find(const char *kif_name)
293 {
294 	struct pfi_kif_cmp s;
295 
296 	PF_RULES_ASSERT();
297 
298 	memset(&s, 0, sizeof(s));
299 	strlcpy(s.pfik_name, kif_name, sizeof(s.pfik_name));
300 
301 	return (RB_FIND(pfi_ifhead, &V_pfi_ifs, (struct pfi_kkif *)&s));
302 }
303 
304 struct pfi_kkif *
pfi_kkif_attach(struct pfi_kkif * kif,const char * kif_name)305 pfi_kkif_attach(struct pfi_kkif *kif, const char *kif_name)
306 {
307 	struct pfi_kkif *kif1;
308 
309 	PF_RULES_WASSERT();
310 	KASSERT(kif != NULL, ("%s: null kif", __func__));
311 
312 	kif1 = pfi_kkif_find(kif_name);
313 	if (kif1 != NULL) {
314 		pf_kkif_free(kif);
315 		return (kif1);
316 	}
317 
318 	pf_kkif_zero(kif);
319 	strlcpy(kif->pfik_name, kif_name, sizeof(kif->pfik_name));
320 	/*
321 	 * It seems that the value of time_second is in unintialzied state
322 	 * when pf sets interface statistics clear time in boot phase if pf
323 	 * was statically linked to kernel. Instead of setting the bogus
324 	 * time value have pfi_get_ifaces handle this case. In
325 	 * pfi_get_ifaces it uses time_second if it sees the time is 0.
326 	 */
327 	kif->pfik_tzero = time_second > 1 ? time_second : 0;
328 	TAILQ_INIT(&kif->pfik_dynaddrs);
329 
330 	RB_INSERT(pfi_ifhead, &V_pfi_ifs, kif);
331 
332 	return (kif);
333 }
334 
335 void
pfi_kkif_ref(struct pfi_kkif * kif)336 pfi_kkif_ref(struct pfi_kkif *kif)
337 {
338 
339 	PF_RULES_WASSERT();
340 	kif->pfik_rulerefs++;
341 }
342 
343 static void
pfi_kkif_remove_if_unref(struct pfi_kkif * kif)344 pfi_kkif_remove_if_unref(struct pfi_kkif *kif)
345 {
346 
347 	PF_RULES_WASSERT();
348 
349 	if (kif->pfik_rulerefs > 0)
350 		return;
351 
352 	/* kif referencing an existing ifnet or group or holding flags should
353 	 * exist. */
354 	if (kif->pfik_ifp != NULL || kif->pfik_group != NULL ||
355 	    kif == V_pfi_all || kif->pfik_flags != 0)
356 		return;
357 
358 	RB_REMOVE(pfi_ifhead, &V_pfi_ifs, kif);
359 
360 	kif->pfik_flags |= PFI_IFLAG_REFS;
361 
362 	mtx_lock(&pfi_unlnkdkifs_mtx);
363 	LIST_INSERT_HEAD(&V_pfi_unlinked_kifs, kif, pfik_list);
364 	mtx_unlock(&pfi_unlnkdkifs_mtx);
365 }
366 
367 void
pfi_kkif_unref(struct pfi_kkif * kif)368 pfi_kkif_unref(struct pfi_kkif *kif)
369 {
370 
371 	PF_RULES_WASSERT();
372 	KASSERT(kif->pfik_rulerefs > 0, ("%s: %p has zero refs", __func__, kif));
373 
374 	kif->pfik_rulerefs--;
375 
376 	pfi_kkif_remove_if_unref(kif);
377 }
378 
379 void
pfi_kkif_purge(void)380 pfi_kkif_purge(void)
381 {
382 	struct pfi_kkif *kif, *kif1;
383 
384 	/*
385 	 * Do naive mark-and-sweep garbage collecting of old kifs.
386 	 * Reference flag is raised by pf_purge_expired_states().
387 	 */
388 	mtx_lock(&pfi_unlnkdkifs_mtx);
389 	LIST_FOREACH_SAFE(kif, &V_pfi_unlinked_kifs, pfik_list, kif1) {
390 		if (!(kif->pfik_flags & PFI_IFLAG_REFS)) {
391 			LIST_REMOVE(kif, pfik_list);
392 			pf_kkif_free(kif);
393 		} else
394 			kif->pfik_flags &= ~PFI_IFLAG_REFS;
395 	}
396 	mtx_unlock(&pfi_unlnkdkifs_mtx);
397 }
398 
399 int
pfi_kkif_match(struct pfi_kkif * rule_kif,struct pfi_kkif * packet_kif)400 pfi_kkif_match(struct pfi_kkif *rule_kif, struct pfi_kkif *packet_kif)
401 {
402 	struct ifg_list	*p;
403 
404 	if (rule_kif == NULL || rule_kif == packet_kif)
405 		return (1);
406 
407 	if (rule_kif->pfik_group != NULL) {
408 		IF_ADDR_RLOCK(packet_kif->pfik_ifp);
409 		CK_STAILQ_FOREACH(p, &packet_kif->pfik_ifp->if_groups, ifgl_next)
410 			if (p->ifgl_group == rule_kif->pfik_group) {
411 				IF_ADDR_RUNLOCK(packet_kif->pfik_ifp);
412 				return (1);
413 			}
414 		IF_ADDR_RUNLOCK(packet_kif->pfik_ifp);
415 	}
416 
417 
418 	return (0);
419 }
420 
421 static void
pfi_attach_ifnet(struct ifnet * ifp)422 pfi_attach_ifnet(struct ifnet *ifp)
423 {
424 	struct pfi_kkif *kif;
425 
426 	kif = pf_kkif_create(M_WAITOK);
427 
428 	PF_RULES_WLOCK();
429 	V_pfi_update++;
430 	kif = pfi_kkif_attach(kif, ifp->if_xname);
431 
432 	if_ref(ifp);
433 
434 	kif->pfik_ifp = ifp;
435 	ifp->if_pf_kif = kif;
436 
437 	pfi_kkif_update(kif);
438 	PF_RULES_WUNLOCK();
439 }
440 
441 static void
pfi_attach_ifgroup(struct ifg_group * ifg)442 pfi_attach_ifgroup(struct ifg_group *ifg)
443 {
444 	struct pfi_kkif *kif;
445 
446 	kif = pf_kkif_create(M_WAITOK);
447 
448 	PF_RULES_WLOCK();
449 	V_pfi_update++;
450 	kif = pfi_kkif_attach(kif, ifg->ifg_group);
451 
452 	kif->pfik_group = ifg;
453 	ifg->ifg_pf_kif = kif;
454 	PF_RULES_WUNLOCK();
455 }
456 
457 int
pfi_match_addr(struct pfi_dynaddr * dyn,struct pf_addr * a,sa_family_t af)458 pfi_match_addr(struct pfi_dynaddr *dyn, struct pf_addr *a, sa_family_t af)
459 {
460 	switch (af) {
461 #ifdef INET
462 	case AF_INET:
463 		switch (dyn->pfid_acnt4) {
464 		case 0:
465 			return (0);
466 		case 1:
467 			return (PF_MATCHA(0, &dyn->pfid_addr4,
468 			    &dyn->pfid_mask4, a, AF_INET));
469 		default:
470 			return (pfr_match_addr(dyn->pfid_kt, a, AF_INET));
471 		}
472 		break;
473 #endif /* INET */
474 #ifdef INET6
475 	case AF_INET6:
476 		switch (dyn->pfid_acnt6) {
477 		case 0:
478 			return (0);
479 		case 1:
480 			return (PF_MATCHA(0, &dyn->pfid_addr6,
481 			    &dyn->pfid_mask6, a, AF_INET6));
482 		default:
483 			return (pfr_match_addr(dyn->pfid_kt, a, AF_INET6));
484 		}
485 		break;
486 #endif /* INET6 */
487 	default:
488 		return (0);
489 	}
490 }
491 
492 int
pfi_dynaddr_setup(struct pf_addr_wrap * aw,sa_family_t af)493 pfi_dynaddr_setup(struct pf_addr_wrap *aw, sa_family_t af)
494 {
495 	struct pfi_dynaddr	*dyn;
496 	char			 tblname[PF_TABLE_NAME_SIZE];
497 	struct pf_kruleset	*ruleset = NULL;
498 	struct pfi_kkif		*kif;
499 	int			 rv = 0;
500 
501 	PF_RULES_WASSERT();
502 	KASSERT(aw->type == PF_ADDR_DYNIFTL, ("%s: type %u",
503 	    __func__, aw->type));
504 	KASSERT(aw->p.dyn == NULL, ("%s: dyn is %p", __func__, aw->p.dyn));
505 
506 	if ((dyn = malloc(sizeof(*dyn), PFI_MTYPE, M_NOWAIT | M_ZERO)) == NULL)
507 		return (ENOMEM);
508 
509 	if ((kif = pf_kkif_create(M_NOWAIT)) == NULL) {
510 		free(dyn, PFI_MTYPE);
511 		return (ENOMEM);
512 	}
513 
514 	if (!strcmp(aw->v.ifname, "self"))
515 		dyn->pfid_kif = pfi_kkif_attach(kif, IFG_ALL);
516 	else
517 		dyn->pfid_kif = pfi_kkif_attach(kif, aw->v.ifname);
518 	kif = NULL;
519 	pfi_kkif_ref(dyn->pfid_kif);
520 
521 	dyn->pfid_net = pfi_unmask(&aw->v.a.mask);
522 	if (af == AF_INET && dyn->pfid_net == 32)
523 		dyn->pfid_net = 128;
524 	strlcpy(tblname, aw->v.ifname, sizeof(tblname));
525 	if (aw->iflags & PFI_AFLAG_NETWORK)
526 		strlcat(tblname, ":network", sizeof(tblname));
527 	if (aw->iflags & PFI_AFLAG_BROADCAST)
528 		strlcat(tblname, ":broadcast", sizeof(tblname));
529 	if (aw->iflags & PFI_AFLAG_PEER)
530 		strlcat(tblname, ":peer", sizeof(tblname));
531 	if (aw->iflags & PFI_AFLAG_NOALIAS)
532 		strlcat(tblname, ":0", sizeof(tblname));
533 	if (dyn->pfid_net != 128)
534 		snprintf(tblname + strlen(tblname),
535 		    sizeof(tblname) - strlen(tblname), "/%d", dyn->pfid_net);
536 	if ((ruleset = pf_find_or_create_kruleset(PF_RESERVED_ANCHOR)) == NULL) {
537 		rv = ENOMEM;
538 		goto _bad;
539 	}
540 
541 	if ((dyn->pfid_kt = pfr_attach_table(ruleset, tblname)) == NULL) {
542 		rv = ENOMEM;
543 		goto _bad;
544 	}
545 
546 	dyn->pfid_kt->pfrkt_flags |= PFR_TFLAG_ACTIVE;
547 	dyn->pfid_iflags = aw->iflags;
548 	dyn->pfid_af = af;
549 
550 	TAILQ_INSERT_TAIL(&dyn->pfid_kif->pfik_dynaddrs, dyn, entry);
551 	aw->p.dyn = dyn;
552 	pfi_kkif_update(dyn->pfid_kif);
553 
554 	return (0);
555 
556 _bad:
557 	if (dyn->pfid_kt != NULL)
558 		pfr_detach_table(dyn->pfid_kt);
559 	if (ruleset != NULL)
560 		pf_remove_if_empty_kruleset(ruleset);
561 	pfi_kkif_unref(dyn->pfid_kif);
562 	free(dyn, PFI_MTYPE);
563 
564 	return (rv);
565 }
566 
567 static void
pfi_kkif_update(struct pfi_kkif * kif)568 pfi_kkif_update(struct pfi_kkif *kif)
569 {
570 	struct ifg_list		*ifgl;
571 	struct ifg_member	*ifgm;
572 	struct pfi_dynaddr	*p;
573 	struct pfi_kkif		*tmpkif;
574 
575 	PF_RULES_WASSERT();
576 
577 	/* update all dynaddr */
578 	TAILQ_FOREACH(p, &kif->pfik_dynaddrs, entry)
579 		pfi_dynaddr_update(p);
580 
581 	/* Apply group flags to new members. */
582 	if (kif->pfik_group != NULL) {
583 		CK_STAILQ_FOREACH(ifgm, &kif->pfik_group->ifg_members,
584 		    ifgm_next) {
585 			tmpkif = (struct pfi_kkif *)ifgm->ifgm_ifp->if_pf_kif;
586 			if (tmpkif == NULL)
587 				continue;
588 
589 			tmpkif->pfik_flags |= kif->pfik_flags;
590 		}
591 	}
592 
593 	/* again for all groups kif is member of */
594 	if (kif->pfik_ifp != NULL) {
595 		IF_ADDR_RLOCK(kif->pfik_ifp);
596 		CK_STAILQ_FOREACH(ifgl, &kif->pfik_ifp->if_groups, ifgl_next)
597 			pfi_kkif_update((struct pfi_kkif *)
598 			    ifgl->ifgl_group->ifg_pf_kif);
599 		IF_ADDR_RUNLOCK(kif->pfik_ifp);
600 	}
601 }
602 
603 static void
pfi_dynaddr_update(struct pfi_dynaddr * dyn)604 pfi_dynaddr_update(struct pfi_dynaddr *dyn)
605 {
606 	struct pfi_kkif		*kif;
607 	struct pfr_ktable	*kt;
608 
609 	PF_RULES_WASSERT();
610 	KASSERT(dyn && dyn->pfid_kif && dyn->pfid_kt,
611 	    ("%s: bad argument", __func__));
612 
613 	kif = dyn->pfid_kif;
614 	kt = dyn->pfid_kt;
615 
616 	if (kt->pfrkt_larg != V_pfi_update) {
617 		/* this table needs to be brought up-to-date */
618 		pfi_table_update(kt, kif, dyn->pfid_net, dyn->pfid_iflags);
619 		kt->pfrkt_larg = V_pfi_update;
620 	}
621 	pfr_dynaddr_update(kt, dyn);
622 }
623 
624 static void
pfi_table_update(struct pfr_ktable * kt,struct pfi_kkif * kif,int net,int flags)625 pfi_table_update(struct pfr_ktable *kt, struct pfi_kkif *kif, int net, int flags)
626 {
627 	int			 e, size2 = 0;
628 	struct ifg_member	*ifgm;
629 
630 	V_pfi_buffer_cnt = 0;
631 
632 	if (kif->pfik_ifp != NULL)
633 		pfi_instance_add(kif->pfik_ifp, net, flags);
634 	else if (kif->pfik_group != NULL) {
635 		IFNET_RLOCK_NOSLEEP();
636 		CK_STAILQ_FOREACH(ifgm, &kif->pfik_group->ifg_members, ifgm_next)
637 			pfi_instance_add(ifgm->ifgm_ifp, net, flags);
638 		IFNET_RUNLOCK_NOSLEEP();
639 	}
640 
641 	if ((e = pfr_set_addrs(&kt->pfrkt_t, V_pfi_buffer, V_pfi_buffer_cnt, &size2,
642 	    NULL, NULL, NULL, 0, PFR_TFLAG_ALLMASK)))
643 		printf("%s: cannot set %d new addresses into table %s: %d\n",
644 		    __func__, V_pfi_buffer_cnt, kt->pfrkt_name, e);
645 }
646 
647 static void
pfi_instance_add(struct ifnet * ifp,int net,int flags)648 pfi_instance_add(struct ifnet *ifp, int net, int flags)
649 {
650 	struct ifaddr	*ia;
651 	int		 got4 = 0, got6 = 0;
652 	int		 net2, af;
653 
654 	IF_ADDR_RLOCK(ifp);
655 	CK_STAILQ_FOREACH(ia, &ifp->if_addrhead, ifa_link) {
656 		if (ia->ifa_addr == NULL)
657 			continue;
658 		af = ia->ifa_addr->sa_family;
659 		if (af != AF_INET && af != AF_INET6)
660 			continue;
661 		/*
662 		 * XXX: For point-to-point interfaces, (ifname:0) and IPv4,
663 		 *      jump over addresses without a proper route to work
664 		 *      around a problem with ppp not fully removing the
665 		 *      address used during IPCP.
666 		 */
667 		if ((ifp->if_flags & IFF_POINTOPOINT) &&
668 		    !(ia->ifa_flags & IFA_ROUTE) &&
669 		    (flags & PFI_AFLAG_NOALIAS) && (af == AF_INET))
670 			continue;
671 		if ((flags & PFI_AFLAG_BROADCAST) && af == AF_INET6)
672 			continue;
673 		if ((flags & PFI_AFLAG_BROADCAST) &&
674 		    !(ifp->if_flags & IFF_BROADCAST))
675 			continue;
676 		if ((flags & PFI_AFLAG_PEER) &&
677 		    !(ifp->if_flags & IFF_POINTOPOINT))
678 			continue;
679 		if ((flags & PFI_AFLAG_NETWORK) && af == AF_INET6 &&
680 		    IN6_IS_ADDR_LINKLOCAL(
681 		    &((struct sockaddr_in6 *)ia->ifa_addr)->sin6_addr))
682 			continue;
683 		if (flags & PFI_AFLAG_NOALIAS) {
684 			if (af == AF_INET && got4)
685 				continue;
686 			if (af == AF_INET6 && got6)
687 				continue;
688 		}
689 		if (af == AF_INET)
690 			got4 = 1;
691 		else if (af == AF_INET6)
692 			got6 = 1;
693 		net2 = net;
694 		if (net2 == 128 && (flags & PFI_AFLAG_NETWORK)) {
695 			if (af == AF_INET)
696 				net2 = pfi_unmask(&((struct sockaddr_in *)
697 				    ia->ifa_netmask)->sin_addr);
698 			else if (af == AF_INET6)
699 				net2 = pfi_unmask(&((struct sockaddr_in6 *)
700 				    ia->ifa_netmask)->sin6_addr);
701 		}
702 		if (af == AF_INET && net2 > 32)
703 			net2 = 32;
704 		if (flags & PFI_AFLAG_BROADCAST)
705 			pfi_address_add(ia->ifa_broadaddr, af, net2);
706 		else if (flags & PFI_AFLAG_PEER)
707 			pfi_address_add(ia->ifa_dstaddr, af, net2);
708 		else
709 			pfi_address_add(ia->ifa_addr, af, net2);
710 	}
711 	IF_ADDR_RUNLOCK(ifp);
712 }
713 
714 static void
pfi_address_add(struct sockaddr * sa,int af,int net)715 pfi_address_add(struct sockaddr *sa, int af, int net)
716 {
717 	struct pfr_addr	*p;
718 	int		 i;
719 
720 	if (V_pfi_buffer_cnt >= V_pfi_buffer_max) {
721 		int		 new_max = V_pfi_buffer_max * 2;
722 
723 		if (new_max > PFI_BUFFER_MAX) {
724 			printf("%s: address buffer full (%d/%d)\n", __func__,
725 			    V_pfi_buffer_cnt, PFI_BUFFER_MAX);
726 			return;
727 		}
728 		p = malloc(new_max * sizeof(*V_pfi_buffer), PFI_MTYPE,
729 		    M_NOWAIT);
730 		if (p == NULL) {
731 			printf("%s: no memory to grow buffer (%d/%d)\n",
732 			    __func__, V_pfi_buffer_cnt, PFI_BUFFER_MAX);
733 			return;
734 		}
735 		memcpy(p, V_pfi_buffer, V_pfi_buffer_max * sizeof(*V_pfi_buffer));
736 		/* no need to zero buffer */
737 		free(V_pfi_buffer, PFI_MTYPE);
738 		V_pfi_buffer = p;
739 		V_pfi_buffer_max = new_max;
740 	}
741 	if (af == AF_INET && net > 32)
742 		net = 128;
743 	p = V_pfi_buffer + V_pfi_buffer_cnt++;
744 	memset(p, 0, sizeof(*p));
745 	p->pfra_af = af;
746 	p->pfra_net = net;
747 	if (af == AF_INET)
748 		p->pfra_ip4addr = ((struct sockaddr_in *)sa)->sin_addr;
749 	else if (af == AF_INET6) {
750 		p->pfra_ip6addr = ((struct sockaddr_in6 *)sa)->sin6_addr;
751 		if (IN6_IS_SCOPE_EMBED(&p->pfra_ip6addr))
752 			p->pfra_ip6addr.s6_addr16[1] = 0;
753 	}
754 	/* mask network address bits */
755 	if (net < 128)
756 		((caddr_t)p)[p->pfra_net/8] &= ~(0xFF >> (p->pfra_net%8));
757 	for (i = (p->pfra_net+7)/8; i < sizeof(p->pfra_u); i++)
758 		((caddr_t)p)[i] = 0;
759 }
760 
761 void
pfi_dynaddr_remove(struct pfi_dynaddr * dyn)762 pfi_dynaddr_remove(struct pfi_dynaddr *dyn)
763 {
764 
765 	KASSERT(dyn->pfid_kif != NULL, ("%s: null pfid_kif", __func__));
766 	KASSERT(dyn->pfid_kt != NULL, ("%s: null pfid_kt", __func__));
767 
768 	TAILQ_REMOVE(&dyn->pfid_kif->pfik_dynaddrs, dyn, entry);
769 	pfi_kkif_unref(dyn->pfid_kif);
770 	pfr_detach_table(dyn->pfid_kt);
771 	free(dyn, PFI_MTYPE);
772 }
773 
774 void
pfi_dynaddr_copyout(struct pf_addr_wrap * aw)775 pfi_dynaddr_copyout(struct pf_addr_wrap *aw)
776 {
777 
778 	KASSERT(aw->type == PF_ADDR_DYNIFTL,
779 	    ("%s: type %u", __func__, aw->type));
780 
781 	if (aw->p.dyn == NULL || aw->p.dyn->pfid_kif == NULL)
782 		return;
783 	aw->p.dyncnt = aw->p.dyn->pfid_acnt4 + aw->p.dyn->pfid_acnt6;
784 }
785 
786 static int
pfi_kkif_compare(struct pfi_kkif * p,struct pfi_kkif * q)787 pfi_kkif_compare(struct pfi_kkif *p, struct pfi_kkif *q)
788 {
789 	return (strncmp(p->pfik_name, q->pfik_name, IFNAMSIZ));
790 }
791 
792 void
pfi_update_status(const char * name,struct pf_status * pfs)793 pfi_update_status(const char *name, struct pf_status *pfs)
794 {
795 	struct pfi_kkif		*p;
796 	struct pfi_kif_cmp	 key;
797 	struct ifg_member	 p_member, *ifgm;
798 	CK_STAILQ_HEAD(, ifg_member) ifg_members;
799 	int			 i, j, k;
800 
801 	if (pfs) {
802 		memset(pfs->pcounters, 0, sizeof(pfs->pcounters));
803 		memset(pfs->bcounters, 0, sizeof(pfs->bcounters));
804 	}
805 
806 	strlcpy(key.pfik_name, name, sizeof(key.pfik_name));
807 	p = RB_FIND(pfi_ifhead, &V_pfi_ifs, (struct pfi_kkif *)&key);
808 	if (p == NULL) {
809 		return;
810 	}
811 
812 	if (p->pfik_group != NULL) {
813 		memcpy(&ifg_members, &p->pfik_group->ifg_members,
814 		    sizeof(ifg_members));
815 	} else {
816 		/* build a temporary list for p only */
817 		memset(&p_member, 0, sizeof(p_member));
818 		p_member.ifgm_ifp = p->pfik_ifp;
819 		CK_STAILQ_INIT(&ifg_members);
820 		CK_STAILQ_INSERT_TAIL(&ifg_members, &p_member, ifgm_next);
821 	}
822 	CK_STAILQ_FOREACH(ifgm, &ifg_members, ifgm_next) {
823 		if (ifgm->ifgm_ifp == NULL || ifgm->ifgm_ifp->if_pf_kif == NULL)
824 			continue;
825 		p = (struct pfi_kkif *)ifgm->ifgm_ifp->if_pf_kif;
826 
827 		/* just clear statistics */
828 		if (pfs == NULL) {
829 			pf_kkif_zero(p);
830 			continue;
831 		}
832 		for (i = 0; i < 2; i++)
833 			for (j = 0; j < 2; j++)
834 				for (k = 0; k < 2; k++) {
835 					pfs->pcounters[i][j][k] +=
836 					    pf_counter_u64_fetch(&p->pfik_packets[i][j][k]);
837 					pfs->bcounters[i][j] +=
838 					    pf_counter_u64_fetch(&p->pfik_bytes[i][j][k]);
839 				}
840 	}
841 }
842 
843 static void
pf_kkif_to_kif(struct pfi_kkif * kkif,struct pfi_kif * kif)844 pf_kkif_to_kif(struct pfi_kkif *kkif, struct pfi_kif *kif)
845 {
846 
847 	memset(kif, 0, sizeof(*kif));
848 	strlcpy(kif->pfik_name, kkif->pfik_name, sizeof(kif->pfik_name));
849 	for (int i = 0; i < 2; i++) {
850 		for (int j = 0; j < 2; j++) {
851 			for (int k = 0; k < 2; k++) {
852 				kif->pfik_packets[i][j][k] =
853 				    pf_counter_u64_fetch(&kkif->pfik_packets[i][j][k]);
854 				kif->pfik_bytes[i][j][k] =
855 				    pf_counter_u64_fetch(&kkif->pfik_bytes[i][j][k]);
856 			}
857 		}
858 	}
859 	kif->pfik_flags = kkif->pfik_flags;
860 	kif->pfik_tzero = kkif->pfik_tzero;
861 	kif->pfik_rulerefs = kkif->pfik_rulerefs;
862 	/*
863 	 * Userspace relies on this pointer to decide if this is a group or
864 	 * not. We don't want to share the actual pointer, because it's
865 	 * useless to userspace and leaks kernel memory layout information.
866 	 * So instead we provide 0xfeedcode as 'true' and NULL as 'false'.
867 	 */
868 	kif->pfik_group =
869 	    kkif->pfik_group ? (struct ifg_group *)0xfeedc0de : NULL;
870 }
871 
872 void
pfi_get_ifaces(const char * name,struct pfi_kif * buf,int * size)873 pfi_get_ifaces(const char *name, struct pfi_kif *buf, int *size)
874 {
875 	struct pfi_kkif	*p, *nextp;
876 	int		 n = 0;
877 
878 	for (p = RB_MIN(pfi_ifhead, &V_pfi_ifs); p; p = nextp) {
879 		nextp = RB_NEXT(pfi_ifhead, &V_pfi_ifs, p);
880 		if (pfi_skip_if(name, p))
881 			continue;
882 		if (*size <= n++)
883 			break;
884 		if (!p->pfik_tzero)
885 			p->pfik_tzero = time_second;
886 		pf_kkif_to_kif(p, buf++);
887 		nextp = RB_NEXT(pfi_ifhead, &V_pfi_ifs, p);
888 	}
889 	*size = n;
890 }
891 
892 static int
pfi_skip_if(const char * filter,struct pfi_kkif * p)893 pfi_skip_if(const char *filter, struct pfi_kkif *p)
894 {
895 	struct ifg_list *i;
896 	int	n;
897 
898 	if (filter == NULL || !*filter)
899 		return (0);
900 	if (!strcmp(p->pfik_name, filter))
901 		return (0);	/* exact match */
902 	n = strlen(filter);
903 	if (n < 1 || n >= IFNAMSIZ)
904 		return (1);	/* sanity check */
905 	if (filter[n-1] >= '0' && filter[n-1] <= '9')
906 		return (1);	/* group names may not end in a digit */
907 	if (p->pfik_ifp != NULL) {
908 		IF_ADDR_RLOCK(p->pfik_ifp);
909 		CK_STAILQ_FOREACH(i, &p->pfik_ifp->if_groups, ifgl_next) {
910 			if (!strncmp(i->ifgl_group->ifg_group, filter,
911 			      IFNAMSIZ)) {
912 				IF_ADDR_RUNLOCK(p->pfik_ifp);
913 				return (0); /* iface is in group "filter" */
914 			}
915 		}
916 		IF_ADDR_RUNLOCK(p->pfik_ifp);
917 	}
918 	return (1);
919 }
920 
921 int
pfi_set_flags(const char * name,int flags)922 pfi_set_flags(const char *name, int flags)
923 {
924 	struct pfi_kkif	*p, *kif;
925 
926 	kif = pf_kkif_create(M_NOWAIT);
927 	if (kif == NULL)
928 		return (ENOMEM);
929 
930 	kif = pfi_kkif_attach(kif, name);
931 
932 	RB_FOREACH(p, pfi_ifhead, &V_pfi_ifs) {
933 		if (pfi_skip_if(name, p))
934 			continue;
935 		p->pfik_flags |= flags;
936 	}
937 	return (0);
938 }
939 
940 int
pfi_clear_flags(const char * name,int flags)941 pfi_clear_flags(const char *name, int flags)
942 {
943 	struct pfi_kkif *p, *tmp;
944 
945 	RB_FOREACH_SAFE(p, pfi_ifhead, &V_pfi_ifs, tmp) {
946 		if (pfi_skip_if(name, p))
947 			continue;
948 		p->pfik_flags &= ~flags;
949 
950 		if (p->pfik_ifp == NULL && p->pfik_group == NULL &&
951 		    p->pfik_flags == 0 && p->pfik_rulerefs == 0) {
952 			/* Delete this kif. */
953 			RB_REMOVE(pfi_ifhead, &V_pfi_ifs, p);
954 			pf_kkif_free(p);
955 		}
956 	}
957 	return (0);
958 }
959 
960 /* from pf_print_state.c */
961 static int
pfi_unmask(void * addr)962 pfi_unmask(void *addr)
963 {
964 	struct pf_addr *m = addr;
965 	int i = 31, j = 0, b = 0;
966 	u_int32_t tmp;
967 
968 	while (j < 4 && m->addr32[j] == 0xffffffff) {
969 		b += 32;
970 		j++;
971 	}
972 	if (j < 4) {
973 		tmp = ntohl(m->addr32[j]);
974 		for (i = 31; tmp & (1 << i); --i)
975 			b++;
976 	}
977 	return (b);
978 }
979 
980 static void
pfi_attach_ifnet_event(void * arg __unused,struct ifnet * ifp)981 pfi_attach_ifnet_event(void *arg __unused, struct ifnet *ifp)
982 {
983 
984 	if (V_pf_vnet_active == 0) {
985 		/* Avoid teardown race in the least expensive way. */
986 		return;
987 	}
988 	pfi_attach_ifnet(ifp);
989 #ifdef ALTQ
990 	PF_RULES_WLOCK();
991 	pf_altq_ifnet_event(ifp, 0);
992 	PF_RULES_WUNLOCK();
993 #endif
994 }
995 
996 static void
pfi_detach_ifnet_event(void * arg __unused,struct ifnet * ifp)997 pfi_detach_ifnet_event(void *arg __unused, struct ifnet *ifp)
998 {
999 	struct pfi_kkif *kif = (struct pfi_kkif *)ifp->if_pf_kif;
1000 
1001 	if (pfsync_detach_ifnet_ptr)
1002 		pfsync_detach_ifnet_ptr(ifp);
1003 
1004 	if (kif == NULL)
1005 		return;
1006 
1007 	if (V_pf_vnet_active == 0) {
1008 		/* Avoid teardown race in the least expensive way. */
1009 		return;
1010 	}
1011 
1012 	PF_RULES_WLOCK();
1013 	V_pfi_update++;
1014 	pfi_kkif_update(kif);
1015 
1016 	if (kif->pfik_ifp)
1017 		if_rele(kif->pfik_ifp);
1018 
1019 	kif->pfik_ifp = NULL;
1020 	ifp->if_pf_kif = NULL;
1021 #ifdef ALTQ
1022 	pf_altq_ifnet_event(ifp, 1);
1023 #endif
1024 	pfi_kkif_remove_if_unref(kif);
1025 
1026 	PF_RULES_WUNLOCK();
1027 }
1028 
1029 static void
pfi_attach_group_event(void * arg __unused,struct ifg_group * ifg)1030 pfi_attach_group_event(void *arg __unused, struct ifg_group *ifg)
1031 {
1032 
1033 	if (V_pf_vnet_active == 0) {
1034 		/* Avoid teardown race in the least expensive way. */
1035 		return;
1036 	}
1037 	pfi_attach_ifgroup(ifg);
1038 }
1039 
1040 static void
pfi_change_group_event(void * arg __unused,char * gname)1041 pfi_change_group_event(void *arg __unused, char *gname)
1042 {
1043 	struct pfi_kkif *kif;
1044 
1045 	if (V_pf_vnet_active == 0) {
1046 		/* Avoid teardown race in the least expensive way. */
1047 		return;
1048 	}
1049 
1050 	kif = pf_kkif_create(M_WAITOK);
1051 	PF_RULES_WLOCK();
1052 	V_pfi_update++;
1053 	kif = pfi_kkif_attach(kif, gname);
1054 	pfi_kkif_update(kif);
1055 	PF_RULES_WUNLOCK();
1056 }
1057 
1058 static void
pfi_detach_group_event(void * arg __unused,struct ifg_group * ifg)1059 pfi_detach_group_event(void *arg __unused, struct ifg_group *ifg)
1060 {
1061 	struct pfi_kkif *kif = (struct pfi_kkif *)ifg->ifg_pf_kif;
1062 
1063 	if (kif == NULL)
1064 		return;
1065 
1066 	if (V_pf_vnet_active == 0) {
1067 		/* Avoid teardown race in the least expensive way. */
1068 		return;
1069 	}
1070 	PF_RULES_WLOCK();
1071 	V_pfi_update++;
1072 
1073 	kif->pfik_group = NULL;
1074 	ifg->ifg_pf_kif = NULL;
1075 
1076 	pfi_kkif_remove_if_unref(kif);
1077 	PF_RULES_WUNLOCK();
1078 }
1079 
1080 static void
pfi_ifaddr_event(void * arg __unused,struct ifnet * ifp)1081 pfi_ifaddr_event(void *arg __unused, struct ifnet *ifp)
1082 {
1083 	if (ifp->if_pf_kif == NULL)
1084 		return;
1085 
1086 	if (V_pf_vnet_active == 0) {
1087 		/* Avoid teardown race in the least expensive way. */
1088 		return;
1089 	}
1090 	PF_RULES_WLOCK();
1091 	if (ifp && ifp->if_pf_kif) {
1092 		V_pfi_update++;
1093 		pfi_kkif_update(ifp->if_pf_kif);
1094 	}
1095 	PF_RULES_WUNLOCK();
1096 }
1097