xref: /freebsd-13.1/lib/libpfctl/libpfctl.c (revision 7cc6e39c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2021 Rubicon Communications, LLC (Netgate)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  *    - Redistributions of source code must retain the above copyright
12  *      notice, this list of conditions and the following disclaimer.
13  *    - Redistributions in binary form must reproduce the above
14  *      copyright notice, this list of conditions and the following
15  *      disclaimer in the documentation and/or other materials provided
16  *      with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 
34 #include <sys/cdefs.h>
35 
36 #include <sys/ioctl.h>
37 #include <sys/nv.h>
38 #include <sys/queue.h>
39 #include <sys/types.h>
40 
41 #include <net/if.h>
42 #include <net/pfvar.h>
43 #include <netinet/in.h>
44 
45 #include <assert.h>
46 #include <err.h>
47 #include <errno.h>
48 #include <stdlib.h>
49 #include <string.h>
50 
51 #include "libpfctl.h"
52 
53 const char* PFCTL_SYNCOOKIES_MODE_NAMES[] = {
54 	"never",
55 	"always",
56 	"adaptive"
57 };
58 
59 static int	_pfctl_clear_states(int , const struct pfctl_kill *,
60 		    unsigned int *, uint64_t);
61 
62 static void
63 pf_nvuint_8_array(const nvlist_t *nvl, const char *name, size_t maxelems,
64     uint8_t *numbers, size_t *nelems)
65 {
66 	const uint64_t *tmp;
67 	size_t elems;
68 
69 	tmp = nvlist_get_number_array(nvl, name, &elems);
70 	assert(elems <= maxelems);
71 
72 	for (size_t i = 0; i < elems; i++)
73 		numbers[i] = tmp[i];
74 
75 	if (nelems)
76 		*nelems = elems;
77 }
78 
79 static void
80 pf_nvuint_16_array(const nvlist_t *nvl, const char *name, size_t maxelems,
81     uint16_t *numbers, size_t *nelems)
82 {
83 	const uint64_t *tmp;
84 	size_t elems;
85 
86 	tmp = nvlist_get_number_array(nvl, name, &elems);
87 	assert(elems <= maxelems);
88 
89 	for (size_t i = 0; i < elems; i++)
90 		numbers[i] = tmp[i];
91 
92 	if (nelems)
93 		*nelems = elems;
94 }
95 
96 static void
97 pf_nvuint_32_array(const nvlist_t *nvl, const char *name, size_t maxelems,
98     uint32_t *numbers, size_t *nelems)
99 {
100 	const uint64_t *tmp;
101 	size_t elems;
102 
103 	tmp = nvlist_get_number_array(nvl, name, &elems);
104 	assert(elems <= maxelems);
105 
106 	for (size_t i = 0; i < elems; i++)
107 		numbers[i] = tmp[i];
108 
109 	if (nelems)
110 		*nelems = elems;
111 }
112 
113 static void
114 pf_nvuint_64_array(const nvlist_t *nvl, const char *name, size_t maxelems,
115     uint64_t *numbers, size_t *nelems)
116 {
117 	const uint64_t *tmp;
118 	size_t elems;
119 
120 	tmp = nvlist_get_number_array(nvl, name, &elems);
121 	assert(elems <= maxelems);
122 
123 	for (size_t i = 0; i < elems; i++)
124 		numbers[i] = tmp[i];
125 
126 	if (nelems)
127 		*nelems = elems;
128 }
129 
130 static void
131 _pfctl_get_status_counters(const nvlist_t *nvl,
132     struct pfctl_status_counters *counters)
133 {
134 	const uint64_t		*ids, *counts;
135 	const char *const	*names;
136 	size_t id_len, counter_len, names_len;
137 
138 	ids = nvlist_get_number_array(nvl, "ids", &id_len);
139 	counts = nvlist_get_number_array(nvl, "counters", &counter_len);
140 	names = nvlist_get_string_array(nvl, "names", &names_len);
141 	assert(id_len == counter_len);
142 	assert(counter_len == names_len);
143 
144 	TAILQ_INIT(counters);
145 
146 	for (size_t i = 0; i < id_len; i++) {
147 		struct pfctl_status_counter *c;
148 
149 		c = malloc(sizeof(*c));
150 
151 		c->id = ids[i];
152 		c->counter = counts[i];
153 		c->name = strdup(names[i]);
154 
155 		TAILQ_INSERT_TAIL(counters, c, entry);
156 	}
157 }
158 
159 struct pfctl_status *
160 pfctl_get_status(int dev)
161 {
162 	struct pfioc_nv	 nv;
163 	struct pfctl_status	*status;
164 	nvlist_t	*nvl;
165 	size_t		 len;
166 	const void	*chksum;
167 
168 	status = calloc(1, sizeof(*status));
169 	if (status == NULL)
170 		return (NULL);
171 
172 	nv.data = malloc(4096);
173 	nv.len = nv.size = 4096;
174 
175 	if (ioctl(dev, DIOCGETSTATUSNV, &nv)) {
176 		free(nv.data);
177 		free(status);
178 		return (NULL);
179 	}
180 
181 	nvl = nvlist_unpack(nv.data, nv.len, 0);
182 	free(nv.data);
183 	if (nvl == NULL) {
184 		free(status);
185 		return (NULL);
186 	}
187 
188 	status->running = nvlist_get_bool(nvl, "running");
189 	status->since = nvlist_get_number(nvl, "since");
190 	status->debug = nvlist_get_number(nvl, "debug");
191 	status->hostid = nvlist_get_number(nvl, "hostid");
192 	status->states = nvlist_get_number(nvl, "states");
193 	status->src_nodes = nvlist_get_number(nvl, "src_nodes");
194 
195 	strlcpy(status->ifname, nvlist_get_string(nvl, "ifname"),
196 	    IFNAMSIZ);
197 	chksum = nvlist_get_binary(nvl, "chksum", &len);
198 	assert(len == PF_MD5_DIGEST_LENGTH);
199 	memcpy(status->pf_chksum, chksum, len);
200 
201 	_pfctl_get_status_counters(nvlist_get_nvlist(nvl, "counters"),
202 	    &status->counters);
203 	_pfctl_get_status_counters(nvlist_get_nvlist(nvl, "lcounters"),
204 	    &status->lcounters);
205 	_pfctl_get_status_counters(nvlist_get_nvlist(nvl, "fcounters"),
206 	    &status->fcounters);
207 	_pfctl_get_status_counters(nvlist_get_nvlist(nvl, "scounters"),
208 	    &status->scounters);
209 
210 	pf_nvuint_64_array(nvl, "pcounters", 2 * 2 * 3,
211 	    (uint64_t *)status->pcounters, NULL);
212 	pf_nvuint_64_array(nvl, "bcounters", 2 * 2,
213 	    (uint64_t *)status->bcounters, NULL);
214 
215 	nvlist_destroy(nvl);
216 
217 	return (status);
218 }
219 
220 void
221 pfctl_free_status(struct pfctl_status *status)
222 {
223 	struct pfctl_status_counter *c, *tmp;
224 
225 	TAILQ_FOREACH_SAFE(c, &status->counters, entry, tmp) {
226 		free(c->name);
227 		free(c);
228 	}
229 	TAILQ_FOREACH_SAFE(c, &status->lcounters, entry, tmp) {
230 		free(c->name);
231 		free(c);
232 	}
233 	TAILQ_FOREACH_SAFE(c, &status->fcounters, entry, tmp) {
234 		free(c->name);
235 		free(c);
236 	}
237 	TAILQ_FOREACH_SAFE(c, &status->scounters, entry, tmp) {
238 		free(c->name);
239 		free(c);
240 	}
241 
242 	free(status);
243 }
244 
245 static void
246 pfctl_nv_add_addr(nvlist_t *nvparent, const char *name,
247     const struct pf_addr *addr)
248 {
249 	nvlist_t *nvl = nvlist_create(0);
250 
251 	nvlist_add_binary(nvl, "addr", addr, sizeof(*addr));
252 
253 	nvlist_add_nvlist(nvparent, name, nvl);
254 	nvlist_destroy(nvl);
255 }
256 
257 static void
258 pf_nvaddr_to_addr(const nvlist_t *nvl, struct pf_addr *addr)
259 {
260 	size_t len;
261 	const void *data;
262 
263 	data = nvlist_get_binary(nvl, "addr", &len);
264 	assert(len == sizeof(struct pf_addr));
265 	memcpy(addr, data, len);
266 }
267 
268 static void
269 pfctl_nv_add_addr_wrap(nvlist_t *nvparent, const char *name,
270     const struct pf_addr_wrap *addr)
271 {
272 	nvlist_t *nvl = nvlist_create(0);
273 
274 	nvlist_add_number(nvl, "type", addr->type);
275 	nvlist_add_number(nvl, "iflags", addr->iflags);
276 	if (addr->type == PF_ADDR_DYNIFTL)
277 		nvlist_add_string(nvl, "ifname", addr->v.ifname);
278 	if (addr->type == PF_ADDR_TABLE)
279 		nvlist_add_string(nvl, "tblname", addr->v.tblname);
280 	pfctl_nv_add_addr(nvl, "addr", &addr->v.a.addr);
281 	pfctl_nv_add_addr(nvl, "mask", &addr->v.a.mask);
282 
283 	nvlist_add_nvlist(nvparent, name, nvl);
284 	nvlist_destroy(nvl);
285 }
286 
287 static void
288 pf_nvaddr_wrap_to_addr_wrap(const nvlist_t *nvl, struct pf_addr_wrap *addr)
289 {
290 	addr->type = nvlist_get_number(nvl, "type");
291 	addr->iflags = nvlist_get_number(nvl, "iflags");
292 	if (addr->type == PF_ADDR_DYNIFTL)
293 		strlcpy(addr->v.ifname, nvlist_get_string(nvl, "ifname"),
294 		    IFNAMSIZ);
295 	if (addr->type == PF_ADDR_TABLE)
296 		strlcpy(addr->v.tblname, nvlist_get_string(nvl, "tblname"),
297 		    PF_TABLE_NAME_SIZE);
298 
299 	pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "addr"), &addr->v.a.addr);
300 	pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "mask"), &addr->v.a.mask);
301 }
302 
303 static void
304 pfctl_nv_add_rule_addr(nvlist_t *nvparent, const char *name,
305     const struct pf_rule_addr *addr)
306 {
307 	uint64_t ports[2];
308 	nvlist_t *nvl = nvlist_create(0);
309 
310 	pfctl_nv_add_addr_wrap(nvl, "addr", &addr->addr);
311 	ports[0] = addr->port[0];
312 	ports[1] = addr->port[1];
313 	nvlist_add_number_array(nvl, "port", ports, 2);
314 	nvlist_add_number(nvl, "neg", addr->neg);
315 	nvlist_add_number(nvl, "port_op", addr->port_op);
316 
317 	nvlist_add_nvlist(nvparent, name, nvl);
318 	nvlist_destroy(nvl);
319 }
320 
321 static void
322 pf_nvrule_addr_to_rule_addr(const nvlist_t *nvl, struct pf_rule_addr *addr)
323 {
324 	pf_nvaddr_wrap_to_addr_wrap(nvlist_get_nvlist(nvl, "addr"), &addr->addr);
325 
326 	pf_nvuint_16_array(nvl, "port", 2, addr->port, NULL);
327 	addr->neg = nvlist_get_number(nvl, "neg");
328 	addr->port_op = nvlist_get_number(nvl, "port_op");
329 }
330 
331 static void
332 pfctl_nv_add_mape(nvlist_t *nvparent, const char *name,
333     const struct pf_mape_portset *mape)
334 {
335 	nvlist_t *nvl = nvlist_create(0);
336 
337 	nvlist_add_number(nvl, "offset", mape->offset);
338 	nvlist_add_number(nvl, "psidlen", mape->psidlen);
339 	nvlist_add_number(nvl, "psid", mape->psid);
340 	nvlist_add_nvlist(nvparent, name, nvl);
341 	nvlist_destroy(nvl);
342 }
343 
344 static void
345 pfctl_nv_add_pool(nvlist_t *nvparent, const char *name,
346     const struct pfctl_pool *pool)
347 {
348 	uint64_t ports[2];
349 	nvlist_t *nvl = nvlist_create(0);
350 
351 	nvlist_add_binary(nvl, "key", &pool->key, sizeof(pool->key));
352 	pfctl_nv_add_addr(nvl, "counter", &pool->counter);
353 	nvlist_add_number(nvl, "tblidx", pool->tblidx);
354 
355 	ports[0] = pool->proxy_port[0];
356 	ports[1] = pool->proxy_port[1];
357 	nvlist_add_number_array(nvl, "proxy_port", ports, 2);
358 	nvlist_add_number(nvl, "opts", pool->opts);
359 	pfctl_nv_add_mape(nvl, "mape", &pool->mape);
360 
361 	nvlist_add_nvlist(nvparent, name, nvl);
362 	nvlist_destroy(nvl);
363 }
364 
365 static void
366 pf_nvmape_to_mape(const nvlist_t *nvl, struct pf_mape_portset *mape)
367 {
368 	mape->offset = nvlist_get_number(nvl, "offset");
369 	mape->psidlen = nvlist_get_number(nvl, "psidlen");
370 	mape->psid = nvlist_get_number(nvl, "psid");
371 }
372 
373 static void
374 pf_nvpool_to_pool(const nvlist_t *nvl, struct pfctl_pool *pool)
375 {
376 	size_t len;
377 	const void *data;
378 
379 	data = nvlist_get_binary(nvl, "key", &len);
380 	assert(len == sizeof(pool->key));
381 	memcpy(&pool->key, data, len);
382 
383 	pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "counter"), &pool->counter);
384 
385 	pool->tblidx = nvlist_get_number(nvl, "tblidx");
386 	pf_nvuint_16_array(nvl, "proxy_port", 2, pool->proxy_port, NULL);
387 	pool->opts = nvlist_get_number(nvl, "opts");
388 
389 	if (nvlist_exists_nvlist(nvl, "mape"))
390 		pf_nvmape_to_mape(nvlist_get_nvlist(nvl, "mape"), &pool->mape);
391 }
392 
393 static void
394 pfctl_nv_add_uid(nvlist_t *nvparent, const char *name,
395     const struct pf_rule_uid *uid)
396 {
397 	uint64_t uids[2];
398 	nvlist_t *nvl = nvlist_create(0);
399 
400 	uids[0] = uid->uid[0];
401 	uids[1] = uid->uid[1];
402 	nvlist_add_number_array(nvl, "uid", uids, 2);
403 	nvlist_add_number(nvl, "op", uid->op);
404 
405 	nvlist_add_nvlist(nvparent, name, nvl);
406 	nvlist_destroy(nvl);
407 }
408 
409 static void
410 pf_nvrule_uid_to_rule_uid(const nvlist_t *nvl, struct pf_rule_uid *uid)
411 {
412 	pf_nvuint_32_array(nvl, "uid", 2, uid->uid, NULL);
413 	uid->op = nvlist_get_number(nvl, "op");
414 }
415 
416 static void
417 pfctl_nv_add_divert(nvlist_t *nvparent, const char *name,
418     const struct pfctl_rule *r)
419 {
420 	nvlist_t *nvl = nvlist_create(0);
421 
422 	pfctl_nv_add_addr(nvl, "addr", &r->divert.addr);
423 	nvlist_add_number(nvl, "port", r->divert.port);
424 
425 	nvlist_add_nvlist(nvparent, name, nvl);
426 	nvlist_destroy(nvl);
427 }
428 
429 static void
430 pf_nvdivert_to_divert(const nvlist_t *nvl, struct pfctl_rule *rule)
431 {
432 	pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "addr"), &rule->divert.addr);
433 	rule->divert.port = nvlist_get_number(nvl, "port");
434 }
435 
436 static void
437 pf_nvrule_to_rule(const nvlist_t *nvl, struct pfctl_rule *rule)
438 {
439 	const uint64_t *skip;
440 	const char *const *labels;
441 	size_t skipcount, labelcount;
442 
443 	rule->nr = nvlist_get_number(nvl, "nr");
444 
445 	pf_nvrule_addr_to_rule_addr(nvlist_get_nvlist(nvl, "src"), &rule->src);
446 	pf_nvrule_addr_to_rule_addr(nvlist_get_nvlist(nvl, "dst"), &rule->dst);
447 
448 	skip = nvlist_get_number_array(nvl, "skip", &skipcount);
449 	assert(skip);
450 	assert(skipcount == PF_SKIP_COUNT);
451 	for (int i = 0; i < PF_SKIP_COUNT; i++)
452 		rule->skip[i].nr = skip[i];
453 
454 	labels = nvlist_get_string_array(nvl, "labels", &labelcount);
455 	assert(labelcount <= PF_RULE_MAX_LABEL_COUNT);
456 	for (size_t i = 0; i < labelcount; i++)
457 		strlcpy(rule->label[i], labels[i], PF_RULE_LABEL_SIZE);
458 	rule->ridentifier = nvlist_get_number(nvl, "ridentifier");
459 	strlcpy(rule->ifname, nvlist_get_string(nvl, "ifname"), IFNAMSIZ);
460 	strlcpy(rule->qname, nvlist_get_string(nvl, "qname"), PF_QNAME_SIZE);
461 	strlcpy(rule->pqname, nvlist_get_string(nvl, "pqname"), PF_QNAME_SIZE);
462 	strlcpy(rule->tagname, nvlist_get_string(nvl, "tagname"),
463 	    PF_TAG_NAME_SIZE);
464 	strlcpy(rule->match_tagname, nvlist_get_string(nvl, "match_tagname"),
465 	    PF_TAG_NAME_SIZE);
466 
467 	strlcpy(rule->overload_tblname, nvlist_get_string(nvl, "overload_tblname"),
468 	    PF_TABLE_NAME_SIZE);
469 
470 	pf_nvpool_to_pool(nvlist_get_nvlist(nvl, "rpool"), &rule->rpool);
471 
472 	rule->evaluations = nvlist_get_number(nvl, "evaluations");
473 	pf_nvuint_64_array(nvl, "packets", 2, rule->packets, NULL);
474 	pf_nvuint_64_array(nvl, "bytes", 2, rule->bytes, NULL);
475 
476 	rule->os_fingerprint = nvlist_get_number(nvl, "os_fingerprint");
477 
478 	rule->rtableid = nvlist_get_number(nvl, "rtableid");
479 	pf_nvuint_32_array(nvl, "timeout", PFTM_MAX, rule->timeout, NULL);
480 	rule->max_states = nvlist_get_number(nvl, "max_states");
481 	rule->max_src_nodes = nvlist_get_number(nvl, "max_src_nodes");
482 	rule->max_src_states = nvlist_get_number(nvl, "max_src_states");
483 	rule->max_src_conn = nvlist_get_number(nvl, "max_src_conn");
484 	rule->max_src_conn_rate.limit =
485 	    nvlist_get_number(nvl, "max_src_conn_rate.limit");
486 	rule->max_src_conn_rate.seconds =
487 	    nvlist_get_number(nvl, "max_src_conn_rate.seconds");
488 	rule->qid = nvlist_get_number(nvl, "qid");
489 	rule->pqid = nvlist_get_number(nvl, "pqid");
490 	rule->prob = nvlist_get_number(nvl, "prob");
491 	rule->cuid = nvlist_get_number(nvl, "cuid");
492 	rule->cpid = nvlist_get_number(nvl, "cpid");
493 
494 	rule->return_icmp = nvlist_get_number(nvl, "return_icmp");
495 	rule->return_icmp6 = nvlist_get_number(nvl, "return_icmp6");
496 	rule->max_mss = nvlist_get_number(nvl, "max_mss");
497 	rule->scrub_flags = nvlist_get_number(nvl, "scrub_flags");
498 
499 	pf_nvrule_uid_to_rule_uid(nvlist_get_nvlist(nvl, "uid"), &rule->uid);
500 	pf_nvrule_uid_to_rule_uid(nvlist_get_nvlist(nvl, "gid"),
501 	    (struct pf_rule_uid *)&rule->gid);
502 
503 	rule->rule_flag = nvlist_get_number(nvl, "rule_flag");
504 	rule->action = nvlist_get_number(nvl, "action");
505 	rule->direction = nvlist_get_number(nvl, "direction");
506 	rule->log = nvlist_get_number(nvl, "log");
507 	rule->logif = nvlist_get_number(nvl, "logif");
508 	rule->quick = nvlist_get_number(nvl, "quick");
509 	rule->ifnot = nvlist_get_number(nvl, "ifnot");
510 	rule->match_tag_not = nvlist_get_number(nvl, "match_tag_not");
511 	rule->natpass = nvlist_get_number(nvl, "natpass");
512 
513 	rule->keep_state = nvlist_get_number(nvl, "keep_state");
514 	rule->af = nvlist_get_number(nvl, "af");
515 	rule->proto = nvlist_get_number(nvl, "proto");
516 	rule->type = nvlist_get_number(nvl, "type");
517 	rule->code = nvlist_get_number(nvl, "code");
518 	rule->flags = nvlist_get_number(nvl, "flags");
519 	rule->flagset = nvlist_get_number(nvl, "flagset");
520 	rule->min_ttl = nvlist_get_number(nvl, "min_ttl");
521 	rule->allow_opts = nvlist_get_number(nvl, "allow_opts");
522 	rule->rt = nvlist_get_number(nvl, "rt");
523 	rule->return_ttl  = nvlist_get_number(nvl, "return_ttl");
524 	rule->tos = nvlist_get_number(nvl, "tos");
525 	rule->set_tos = nvlist_get_number(nvl, "set_tos");
526 	rule->anchor_relative = nvlist_get_number(nvl, "anchor_relative");
527 	rule->anchor_wildcard = nvlist_get_number(nvl, "anchor_wildcard");
528 
529 	rule->flush = nvlist_get_number(nvl, "flush");
530 	rule->prio = nvlist_get_number(nvl, "prio");
531 	pf_nvuint_8_array(nvl, "set_prio", 2, rule->set_prio, NULL);
532 
533 	pf_nvdivert_to_divert(nvlist_get_nvlist(nvl, "divert"), rule);
534 
535 	rule->states_cur = nvlist_get_number(nvl, "states_cur");
536 	rule->states_tot = nvlist_get_number(nvl, "states_tot");
537 	rule->src_nodes = nvlist_get_number(nvl, "src_nodes");
538 }
539 
540 int
541 pfctl_add_rule(int dev, const struct pfctl_rule *r, const char *anchor,
542     const char *anchor_call, uint32_t ticket, uint32_t pool_ticket)
543 {
544 	struct pfioc_nv nv;
545 	uint64_t timeouts[PFTM_MAX];
546 	uint64_t set_prio[2];
547 	nvlist_t *nvl, *nvlr;
548 	size_t labelcount;
549 	int ret;
550 
551 	nvl = nvlist_create(0);
552 	nvlr = nvlist_create(0);
553 
554 	nvlist_add_number(nvl, "ticket", ticket);
555 	nvlist_add_number(nvl, "pool_ticket", pool_ticket);
556 	nvlist_add_string(nvl, "anchor", anchor);
557 	nvlist_add_string(nvl, "anchor_call", anchor_call);
558 
559 	nvlist_add_number(nvlr, "nr", r->nr);
560 	pfctl_nv_add_rule_addr(nvlr, "src", &r->src);
561 	pfctl_nv_add_rule_addr(nvlr, "dst", &r->dst);
562 
563 	labelcount = 0;
564 	while (r->label[labelcount][0] != 0 &&
565 	    labelcount < PF_RULE_MAX_LABEL_COUNT) {
566 		nvlist_append_string_array(nvlr, "labels",
567 		    r->label[labelcount]);
568 		labelcount++;
569 	}
570 	nvlist_add_number(nvlr, "ridentifier", r->ridentifier);
571 
572 	nvlist_add_string(nvlr, "ifname", r->ifname);
573 	nvlist_add_string(nvlr, "qname", r->qname);
574 	nvlist_add_string(nvlr, "pqname", r->pqname);
575 	nvlist_add_string(nvlr, "tagname", r->tagname);
576 	nvlist_add_string(nvlr, "match_tagname", r->match_tagname);
577 	nvlist_add_string(nvlr, "overload_tblname", r->overload_tblname);
578 
579 	pfctl_nv_add_pool(nvlr, "rpool", &r->rpool);
580 
581 	nvlist_add_number(nvlr, "os_fingerprint", r->os_fingerprint);
582 
583 	nvlist_add_number(nvlr, "rtableid", r->rtableid);
584 	for (int i = 0; i < PFTM_MAX; i++)
585 		timeouts[i] = r->timeout[i];
586 	nvlist_add_number_array(nvlr, "timeout", timeouts, PFTM_MAX);
587 	nvlist_add_number(nvlr, "max_states", r->max_states);
588 	nvlist_add_number(nvlr, "max_src_nodes", r->max_src_nodes);
589 	nvlist_add_number(nvlr, "max_src_states", r->max_src_states);
590 	nvlist_add_number(nvlr, "max_src_conn", r->max_src_conn);
591 	nvlist_add_number(nvlr, "max_src_conn_rate.limit",
592 	    r->max_src_conn_rate.limit);
593 	nvlist_add_number(nvlr, "max_src_conn_rate.seconds",
594 	    r->max_src_conn_rate.seconds);
595 	nvlist_add_number(nvlr, "prob", r->prob);
596 	nvlist_add_number(nvlr, "cuid", r->cuid);
597 	nvlist_add_number(nvlr, "cpid", r->cpid);
598 
599 	nvlist_add_number(nvlr, "return_icmp", r->return_icmp);
600 	nvlist_add_number(nvlr, "return_icmp6", r->return_icmp6);
601 
602 	nvlist_add_number(nvlr, "max_mss", r->max_mss);
603 	nvlist_add_number(nvlr, "scrub_flags", r->scrub_flags);
604 
605 	pfctl_nv_add_uid(nvlr, "uid", &r->uid);
606 	pfctl_nv_add_uid(nvlr, "gid", (const struct pf_rule_uid *)&r->gid);
607 
608 	nvlist_add_number(nvlr, "rule_flag", r->rule_flag);
609 	nvlist_add_number(nvlr, "action", r->action);
610 	nvlist_add_number(nvlr, "direction", r->direction);
611 	nvlist_add_number(nvlr, "log", r->log);
612 	nvlist_add_number(nvlr, "logif", r->logif);
613 	nvlist_add_number(nvlr, "quick", r->quick);
614 	nvlist_add_number(nvlr, "ifnot", r->ifnot);
615 	nvlist_add_number(nvlr, "match_tag_not", r->match_tag_not);
616 	nvlist_add_number(nvlr, "natpass", r->natpass);
617 
618 	nvlist_add_number(nvlr, "keep_state", r->keep_state);
619 	nvlist_add_number(nvlr, "af", r->af);
620 	nvlist_add_number(nvlr, "proto", r->proto);
621 	nvlist_add_number(nvlr, "type", r->type);
622 	nvlist_add_number(nvlr, "code", r->code);
623 	nvlist_add_number(nvlr, "flags", r->flags);
624 	nvlist_add_number(nvlr, "flagset", r->flagset);
625 	nvlist_add_number(nvlr, "min_ttl", r->min_ttl);
626 	nvlist_add_number(nvlr, "allow_opts", r->allow_opts);
627 	nvlist_add_number(nvlr, "rt", r->rt);
628 	nvlist_add_number(nvlr, "return_ttl", r->return_ttl);
629 	nvlist_add_number(nvlr, "tos", r->tos);
630 	nvlist_add_number(nvlr, "set_tos", r->set_tos);
631 	nvlist_add_number(nvlr, "anchor_relative", r->anchor_relative);
632 	nvlist_add_number(nvlr, "anchor_wildcard", r->anchor_wildcard);
633 
634 	nvlist_add_number(nvlr, "flush", r->flush);
635 
636 	nvlist_add_number(nvlr, "prio", r->prio);
637 	set_prio[0] = r->set_prio[0];
638 	set_prio[1] = r->set_prio[1];
639 	nvlist_add_number_array(nvlr, "set_prio", set_prio, 2);
640 
641 	pfctl_nv_add_divert(nvlr, "divert", r);
642 
643 	nvlist_add_nvlist(nvl, "rule", nvlr);
644 	nvlist_destroy(nvlr);
645 
646 	/* Now do the call. */
647 	nv.data = nvlist_pack(nvl, &nv.len);
648 	nv.size = nv.len;
649 
650 	ret = ioctl(dev, DIOCADDRULENV, &nv);
651 
652 	free(nv.data);
653 	nvlist_destroy(nvl);
654 
655 	return (ret);
656 }
657 
658 int
659 pfctl_get_rule(int dev, uint32_t nr, uint32_t ticket, const char *anchor,
660     uint32_t ruleset, struct pfctl_rule *rule, char *anchor_call)
661 {
662 	return (pfctl_get_clear_rule(dev, nr, ticket, anchor, ruleset, rule,
663 	    anchor_call, false));
664 }
665 
666 int	pfctl_get_clear_rule(int dev, uint32_t nr, uint32_t ticket,
667 	    const char *anchor, uint32_t ruleset, struct pfctl_rule *rule,
668 	    char *anchor_call, bool clear)
669 {
670 	struct pfioc_nv nv;
671 	nvlist_t *nvl;
672 	void *nvlpacked;
673 	int ret;
674 
675 	nvl = nvlist_create(0);
676 	if (nvl == 0)
677 		return (ENOMEM);
678 
679 	nvlist_add_number(nvl, "nr", nr);
680 	nvlist_add_number(nvl, "ticket", ticket);
681 	nvlist_add_string(nvl, "anchor", anchor);
682 	nvlist_add_number(nvl, "ruleset", ruleset);
683 
684 	if (clear)
685 		nvlist_add_bool(nvl, "clear_counter", true);
686 
687 	nvlpacked = nvlist_pack(nvl, &nv.len);
688 	if (nvlpacked == NULL) {
689 		nvlist_destroy(nvl);
690 		return (ENOMEM);
691 	}
692 	nv.data = malloc(8182);
693 	nv.size = 8192;
694 	assert(nv.len <= nv.size);
695 	memcpy(nv.data, nvlpacked, nv.len);
696 	nvlist_destroy(nvl);
697 	nvl = NULL;
698 	free(nvlpacked);
699 
700 	ret = ioctl(dev, DIOCGETRULENV, &nv);
701 	if (ret != 0) {
702 		free(nv.data);
703 		return (ret);
704 	}
705 
706 	nvl = nvlist_unpack(nv.data, nv.len, 0);
707 	if (nvl == NULL) {
708 		free(nv.data);
709 		return (EIO);
710 	}
711 
712 	pf_nvrule_to_rule(nvlist_get_nvlist(nvl, "rule"), rule);
713 
714 	if (anchor_call)
715 		strlcpy(anchor_call, nvlist_get_string(nvl, "anchor_call"),
716 		    MAXPATHLEN);
717 
718 	free(nv.data);
719 	nvlist_destroy(nvl);
720 
721 	return (0);
722 }
723 
724 int
725 pfctl_set_keepcounters(int dev, bool keep)
726 {
727 	struct pfioc_nv	 nv;
728 	nvlist_t	*nvl;
729 	int		 ret;
730 
731 	nvl = nvlist_create(0);
732 
733 	nvlist_add_bool(nvl, "keep_counters", keep);
734 
735 	nv.data = nvlist_pack(nvl, &nv.len);
736 	nv.size = nv.len;
737 
738 	nvlist_destroy(nvl);
739 
740 	ret = ioctl(dev, DIOCKEEPCOUNTERS, &nv);
741 
742 	free(nv.data);
743 	return (ret);
744 }
745 
746 static void
747 pfctl_nv_add_state_cmp(nvlist_t *nvl, const char *name,
748     const struct pfctl_state_cmp *cmp)
749 {
750 	nvlist_t	*nv;
751 
752 	nv = nvlist_create(0);
753 
754 	nvlist_add_number(nv, "id", cmp->id);
755 	nvlist_add_number(nv, "creatorid", cmp->creatorid);
756 	nvlist_add_number(nv, "direction", cmp->direction);
757 
758 	nvlist_add_nvlist(nvl, name, nv);
759 	nvlist_destroy(nv);
760 }
761 
762 static void
763 pf_state_key_export_to_state_key(struct pfctl_state_key *ps,
764     const struct pf_state_key_export *s)
765 {
766 	bcopy(s->addr, ps->addr, sizeof(ps->addr[0]) * 2);
767 	ps->port[0] = s->port[0];
768 	ps->port[1] = s->port[1];
769 }
770 
771 static void
772 pf_state_peer_export_to_state_peer(struct pfctl_state_peer *ps,
773     const struct pf_state_peer_export *s)
774 {
775 	/* Ignore scrub. */
776 	ps->seqlo = s->seqlo;
777 	ps->seqhi = s->seqhi;
778 	ps->seqdiff = s->seqdiff;
779 	/* Ignore max_win & mss */
780 	ps->state = s->state;
781 	ps->wscale = s->wscale;
782 }
783 
784 static void
785 pf_state_export_to_state(struct pfctl_state *ps, const struct pf_state_export *s)
786 {
787 	assert(s->version >= PF_STATE_VERSION);
788 
789 	ps->id = s->id;
790 	strlcpy(ps->ifname, s->ifname, sizeof(ps->ifname));
791 	strlcpy(ps->orig_ifname, s->orig_ifname, sizeof(ps->orig_ifname));
792 	pf_state_key_export_to_state_key(&ps->key[0], &s->key[0]);
793 	pf_state_key_export_to_state_key(&ps->key[1], &s->key[1]);
794 	pf_state_peer_export_to_state_peer(&ps->src, &s->src);
795 	pf_state_peer_export_to_state_peer(&ps->dst, &s->dst);
796 	bcopy(&s->rt_addr, &ps->rt_addr, sizeof(ps->rt_addr));
797 	ps->rule = ntohl(s->rule);
798 	ps->anchor = ntohl(s->anchor);
799 	ps->nat_rule = ntohl(s->nat_rule);
800 	ps->creation = ntohl(s->creation);
801 	ps->expire = ntohl(s->expire);
802 	ps->packets[0] = s->packets[0];
803 	ps->packets[1] = s->packets[1];
804 	ps->bytes[0] = s->bytes[0];
805 	ps->bytes[1] = s->bytes[1];
806 	ps->creatorid = s->creatorid;
807 	ps->key[0].proto = s->proto;
808 	ps->key[1].proto = s->proto;
809 	ps->key[0].af = s->af;
810 	ps->key[1].af = s->af;
811 	ps->direction = s->direction;
812 	ps->state_flags = s->state_flags;
813 	ps->sync_flags = s->sync_flags;
814 }
815 
816 int
817 pfctl_get_states(int dev, struct pfctl_states *states)
818 {
819 	struct pfioc_states_v2 ps;
820 	struct pf_state_export *p;
821 	char *inbuf = NULL, *newinbuf = NULL;
822 	unsigned int len = 0;
823 	int i, error;
824 
825 	bzero(&ps, sizeof(ps));
826 	ps.ps_req_version = PF_STATE_VERSION;
827 
828 	bzero(states, sizeof(*states));
829 	TAILQ_INIT(&states->states);
830 
831 	for (;;) {
832 		ps.ps_len = len;
833 		if (len) {
834 			newinbuf = realloc(inbuf, len);
835 			if (newinbuf == NULL)
836 				return (ENOMEM);
837 			ps.ps_buf = inbuf = newinbuf;
838 		}
839 		if ((error = ioctl(dev, DIOCGETSTATESV2, &ps)) < 0) {
840 			free(inbuf);
841 			return (error);
842 		}
843 		if (ps.ps_len + sizeof(struct pfioc_states_v2) < len)
844 			break;
845 		if (len == 0 && ps.ps_len == 0)
846 			goto out;
847 		if (len == 0 && ps.ps_len != 0)
848 			len = ps.ps_len;
849 		if (ps.ps_len == 0)
850 			goto out;      /* no states */
851 		len *= 2;
852 	}
853 	p = ps.ps_states;
854 
855 	for (i = 0; i < ps.ps_len; i += sizeof(*p), p++) {
856 		struct pfctl_state *s = malloc(sizeof(*s));
857 		if (s == NULL) {
858 			pfctl_free_states(states);
859 			error = ENOMEM;
860 			goto out;
861 		}
862 
863 		pf_state_export_to_state(s, p);
864 		TAILQ_INSERT_TAIL(&states->states, s, entry);
865 	}
866 
867 out:
868 	free(inbuf);
869 	return (error);
870 }
871 
872 void
873 pfctl_free_states(struct pfctl_states *states)
874 {
875 	struct pfctl_state *s, *tmp;
876 
877 	TAILQ_FOREACH_SAFE(s, &states->states, entry, tmp) {
878 		free(s);
879 	}
880 
881 	bzero(states, sizeof(*states));
882 }
883 
884 static int
885 _pfctl_clear_states(int dev, const struct pfctl_kill *kill,
886     unsigned int *killed, uint64_t ioctlval)
887 {
888 	struct pfioc_nv	 nv;
889 	nvlist_t	*nvl;
890 	int		 ret;
891 
892 	nvl = nvlist_create(0);
893 
894 	pfctl_nv_add_state_cmp(nvl, "cmp", &kill->cmp);
895 	nvlist_add_number(nvl, "af", kill->af);
896 	nvlist_add_number(nvl, "proto", kill->proto);
897 	pfctl_nv_add_rule_addr(nvl, "src", &kill->src);
898 	pfctl_nv_add_rule_addr(nvl, "dst", &kill->dst);
899 	pfctl_nv_add_rule_addr(nvl, "rt_addr", &kill->rt_addr);
900 	nvlist_add_string(nvl, "ifname", kill->ifname);
901 	nvlist_add_string(nvl, "label", kill->label);
902 	nvlist_add_bool(nvl, "kill_match", kill->kill_match);
903 
904 	nv.data = nvlist_pack(nvl, &nv.len);
905 	nv.size = nv.len;
906 	nvlist_destroy(nvl);
907 	nvl = NULL;
908 
909 	ret = ioctl(dev, ioctlval, &nv);
910 	if (ret != 0) {
911 		free(nv.data);
912 		return (ret);
913 	}
914 
915 	nvl = nvlist_unpack(nv.data, nv.len, 0);
916 	if (nvl == NULL) {
917 		free(nv.data);
918 		return (EIO);
919 	}
920 
921 	if (killed)
922 		*killed = nvlist_get_number(nvl, "killed");
923 
924 	nvlist_destroy(nvl);
925 	free(nv.data);
926 
927 	return (ret);
928 }
929 
930 int
931 pfctl_clear_states(int dev, const struct pfctl_kill *kill,
932     unsigned int *killed)
933 {
934 	return (_pfctl_clear_states(dev, kill, killed, DIOCCLRSTATESNV));
935 }
936 
937 int
938 pfctl_kill_states(int dev, const struct pfctl_kill *kill, unsigned int *killed)
939 {
940 	return (_pfctl_clear_states(dev, kill, killed, DIOCKILLSTATESNV));
941 }
942 
943 static int
944 pfctl_get_limit(int dev, const int index, uint *limit)
945 {
946 	struct pfioc_limit pl;
947 
948 	bzero(&pl, sizeof(pl));
949 	pl.index = index;
950 
951 	if (ioctl(dev, DIOCGETLIMIT, &pl) == -1)
952 		return (errno);
953 
954 	*limit = pl.limit;
955 
956 	return (0);
957 }
958 
959 int
960 pfctl_set_syncookies(int dev, const struct pfctl_syncookies *s)
961 {
962 	struct pfioc_nv	 nv;
963 	nvlist_t	*nvl;
964 	int		 ret;
965 	uint		 state_limit;
966 
967 	ret = pfctl_get_limit(dev, PF_LIMIT_STATES, &state_limit);
968 	if (ret != 0)
969 		return (ret);
970 
971 	nvl = nvlist_create(0);
972 
973 	nvlist_add_bool(nvl, "enabled", s->mode != PFCTL_SYNCOOKIES_NEVER);
974 	nvlist_add_bool(nvl, "adaptive", s->mode == PFCTL_SYNCOOKIES_ADAPTIVE);
975 	nvlist_add_number(nvl, "highwater", state_limit * s->highwater / 100);
976 	nvlist_add_number(nvl, "lowwater", state_limit * s->lowwater / 100);
977 
978 	nv.data = nvlist_pack(nvl, &nv.len);
979 	nv.size = nv.len;
980 	nvlist_destroy(nvl);
981 	nvl = NULL;
982 
983 	ret = ioctl(dev, DIOCSETSYNCOOKIES, &nv);
984 
985 	free(nv.data);
986 	return (ret);
987 }
988 
989 int
990 pfctl_get_syncookies(int dev, struct pfctl_syncookies *s)
991 {
992 	struct pfioc_nv	 nv;
993 	nvlist_t	*nvl;
994 	int		 ret;
995 	uint		 state_limit;
996 	bool		 enabled, adaptive;
997 
998 	ret = pfctl_get_limit(dev, PF_LIMIT_STATES, &state_limit);
999 	if (ret != 0)
1000 		return (ret);
1001 
1002 	bzero(s, sizeof(*s));
1003 
1004 	nv.data = malloc(256);
1005 	nv.len = nv.size = 256;
1006 
1007 	if (ioctl(dev, DIOCGETSYNCOOKIES, &nv)) {
1008 		free(nv.data);
1009 		return (errno);
1010 	}
1011 
1012 	nvl = nvlist_unpack(nv.data, nv.len, 0);
1013 	free(nv.data);
1014 	if (nvl == NULL) {
1015 		return (EIO);
1016 	}
1017 
1018 	enabled = nvlist_get_bool(nvl, "enabled");
1019 	adaptive = nvlist_get_bool(nvl, "adaptive");
1020 
1021 	if (enabled) {
1022 		if (adaptive)
1023 			s->mode = PFCTL_SYNCOOKIES_ADAPTIVE;
1024 		else
1025 			s->mode = PFCTL_SYNCOOKIES_ALWAYS;
1026 	} else {
1027 		s->mode = PFCTL_SYNCOOKIES_NEVER;
1028 	}
1029 
1030 	s->highwater = nvlist_get_number(nvl, "highwater") * 100 / state_limit;
1031 	s->lowwater = nvlist_get_number(nvl, "lowwater") * 100 / state_limit;
1032 
1033 	nvlist_destroy(nvl);
1034 
1035 	return (0);
1036 }
1037