2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2021 Rubicon Communications, LLC (Netgate)
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
34 #include <sys/cdefs.h>
36 #include <sys/ioctl.h>
38 #include <sys/queue.h>
39 #include <sys/types.h>
42 #include <net/pfvar.h>
43 #include <netinet/in.h>
54 pf_nvuint_8_array(const nvlist_t *nvl, const char *name, size_t maxelems,
55 u_int8_t *numbers, size_t *nelems)
60 tmp = nvlist_get_number_array(nvl, name, &elems);
61 assert(elems <= maxelems);
63 for (size_t i = 0; i < elems; i++)
71 pf_nvuint_16_array(const nvlist_t *nvl, const char *name, size_t maxelems,
72 u_int16_t *numbers, size_t *nelems)
77 tmp = nvlist_get_number_array(nvl, name, &elems);
78 assert(elems <= maxelems);
80 for (size_t i = 0; i < elems; i++)
88 pf_nvuint_32_array(const nvlist_t *nvl, const char *name, size_t maxelems,
89 u_int32_t *numbers, size_t *nelems)
94 tmp = nvlist_get_number_array(nvl, name, &elems);
95 assert(elems <= maxelems);
97 for (size_t i = 0; i < elems; i++)
105 pf_nvuint_64_array(const nvlist_t *nvl, const char *name, size_t maxelems,
106 u_int64_t *numbers, size_t *nelems)
111 tmp = nvlist_get_number_array(nvl, name, &elems);
112 assert(elems <= maxelems);
114 for (size_t i = 0; i < elems; i++)
122 pfctl_nv_add_addr(nvlist_t *nvparent, const char *name,
123 const struct pf_addr *addr)
125 nvlist_t *nvl = nvlist_create(0);
127 nvlist_add_binary(nvl, "addr", addr, sizeof(*addr));
129 nvlist_add_nvlist(nvparent, name, nvl);
133 pf_nvaddr_to_addr(const nvlist_t *nvl, struct pf_addr *addr)
138 data = nvlist_get_binary(nvl, "addr", &len);
139 assert(len == sizeof(struct pf_addr));
140 memcpy(addr, data, len);
144 pfctl_nv_add_addr_wrap(nvlist_t *nvparent, const char *name,
145 const struct pf_addr_wrap *addr)
147 nvlist_t *nvl = nvlist_create(0);
149 nvlist_add_number(nvl, "type", addr->type);
150 nvlist_add_number(nvl, "iflags", addr->iflags);
151 if (addr->type == PF_ADDR_DYNIFTL)
152 nvlist_add_string(nvl, "ifname", addr->v.ifname);
153 if (addr->type == PF_ADDR_TABLE)
154 nvlist_add_string(nvl, "tblname", addr->v.tblname);
155 pfctl_nv_add_addr(nvl, "addr", &addr->v.a.addr);
156 pfctl_nv_add_addr(nvl, "mask", &addr->v.a.mask);
158 nvlist_add_nvlist(nvparent, name, nvl);
162 pf_nvaddr_wrap_to_addr_wrap(const nvlist_t *nvl, struct pf_addr_wrap *addr)
164 addr->type = nvlist_get_number(nvl, "type");
165 addr->iflags = nvlist_get_number(nvl, "iflags");
166 if (addr->type == PF_ADDR_DYNIFTL)
167 strlcpy(addr->v.ifname, nvlist_get_string(nvl, "ifname"),
169 if (addr->type == PF_ADDR_TABLE)
170 strlcpy(addr->v.tblname, nvlist_get_string(nvl, "tblname"),
173 pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "addr"), &addr->v.a.addr);
174 pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "mask"), &addr->v.a.mask);
178 pfctl_nv_add_rule_addr(nvlist_t *nvparent, const char *name,
179 const struct pf_rule_addr *addr)
182 nvlist_t *nvl = nvlist_create(0);
184 pfctl_nv_add_addr_wrap(nvl, "addr", &addr->addr);
185 ports[0] = addr->port[0];
186 ports[1] = addr->port[1];
187 nvlist_add_number_array(nvl, "port", ports, 2);
188 nvlist_add_number(nvl, "neg", addr->neg);
189 nvlist_add_number(nvl, "port_op", addr->port_op);
191 nvlist_add_nvlist(nvparent, name, nvl);
195 pf_nvrule_addr_to_rule_addr(const nvlist_t *nvl, struct pf_rule_addr *addr)
197 pf_nvaddr_wrap_to_addr_wrap(nvlist_get_nvlist(nvl, "addr"), &addr->addr);
199 pf_nvuint_16_array(nvl, "port", 2, addr->port, NULL);
200 addr->neg = nvlist_get_number(nvl, "neg");
201 addr->port_op = nvlist_get_number(nvl, "port_op");
205 pfctl_nv_add_mape(nvlist_t *nvparent, const char *name,
206 const struct pf_mape_portset *mape)
208 nvlist_t *nvl = nvlist_create(0);
210 nvlist_add_number(nvl, "offset", mape->offset);
211 nvlist_add_number(nvl, "psidlen", mape->psidlen);
212 nvlist_add_number(nvl, "psid", mape->psid);
213 nvlist_add_nvlist(nvparent, name, nvl);
217 pfctl_nv_add_pool(nvlist_t *nvparent, const char *name,
218 const struct pfctl_pool *pool)
221 nvlist_t *nvl = nvlist_create(0);
223 nvlist_add_binary(nvl, "key", &pool->key, sizeof(pool->key));
224 pfctl_nv_add_addr(nvl, "counter", &pool->counter);
225 nvlist_add_number(nvl, "tblidx", pool->tblidx);
227 ports[0] = pool->proxy_port[0];
228 ports[1] = pool->proxy_port[1];
229 nvlist_add_number_array(nvl, "proxy_port", ports, 2);
230 nvlist_add_number(nvl, "opts", pool->opts);
231 pfctl_nv_add_mape(nvl, "mape", &pool->mape);
233 nvlist_add_nvlist(nvparent, name, nvl);
237 pf_nvmape_to_mape(const nvlist_t *nvl, struct pf_mape_portset *mape)
239 mape->offset = nvlist_get_number(nvl, "offset");
240 mape->psidlen = nvlist_get_number(nvl, "psidlen");
241 mape->psid = nvlist_get_number(nvl, "psid");
245 pf_nvpool_to_pool(const nvlist_t *nvl, struct pfctl_pool *pool)
250 data = nvlist_get_binary(nvl, "key", &len);
251 assert(len == sizeof(pool->key));
252 memcpy(&pool->key, data, len);
254 pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "counter"), &pool->counter);
256 pool->tblidx = nvlist_get_number(nvl, "tblidx");
257 pf_nvuint_16_array(nvl, "proxy_port", 2, pool->proxy_port, NULL);
258 pool->opts = nvlist_get_number(nvl, "opts");
260 if (nvlist_exists_nvlist(nvl, "mape"))
261 pf_nvmape_to_mape(nvlist_get_nvlist(nvl, "mape"), &pool->mape);
265 pfctl_nv_add_uid(nvlist_t *nvparent, const char *name,
266 const struct pf_rule_uid *uid)
269 nvlist_t *nvl = nvlist_create(0);
271 uids[0] = uid->uid[0];
272 uids[1] = uid->uid[1];
273 nvlist_add_number_array(nvl, "uid", uids, 2);
274 nvlist_add_number(nvl, "op", uid->op);
276 nvlist_add_nvlist(nvparent, name, nvl);
280 pf_nvrule_uid_to_rule_uid(const nvlist_t *nvl, struct pf_rule_uid *uid)
282 pf_nvuint_32_array(nvl, "uid", 2, uid->uid, NULL);
283 uid->op = nvlist_get_number(nvl, "op");
287 pfctl_nv_add_divert(nvlist_t *nvparent, const char *name,
288 const struct pfctl_rule *r)
290 nvlist_t *nvl = nvlist_create(0);
292 pfctl_nv_add_addr(nvl, "addr", &r->divert.addr);
293 nvlist_add_number(nvl, "port", r->divert.port);
295 nvlist_add_nvlist(nvparent, name, nvl);
299 pf_nvdivert_to_divert(const nvlist_t *nvl, struct pfctl_rule *rule)
301 pf_nvaddr_to_addr(nvlist_get_nvlist(nvl, "addr"), &rule->divert.addr);
302 rule->divert.port = nvlist_get_number(nvl, "port");
306 pf_nvrule_to_rule(const nvlist_t *nvl, struct pfctl_rule *rule)
308 const uint64_t *skip;
309 const char *const *labels;
310 size_t skipcount, labelcount;
312 rule->nr = nvlist_get_number(nvl, "nr");
314 pf_nvrule_addr_to_rule_addr(nvlist_get_nvlist(nvl, "src"), &rule->src);
315 pf_nvrule_addr_to_rule_addr(nvlist_get_nvlist(nvl, "dst"), &rule->dst);
317 skip = nvlist_get_number_array(nvl, "skip", &skipcount);
319 assert(skipcount == PF_SKIP_COUNT);
320 for (int i = 0; i < PF_SKIP_COUNT; i++)
321 rule->skip[i].nr = skip[i];
323 labels = nvlist_get_string_array(nvl, "labels", &labelcount);
324 assert(labelcount <= PF_RULE_MAX_LABEL_COUNT);
325 for (size_t i = 0; i < labelcount; i++)
326 strlcpy(rule->label[i], labels[i], PF_RULE_LABEL_SIZE);
327 strlcpy(rule->ifname, nvlist_get_string(nvl, "ifname"), IFNAMSIZ);
328 strlcpy(rule->qname, nvlist_get_string(nvl, "qname"), PF_QNAME_SIZE);
329 strlcpy(rule->pqname, nvlist_get_string(nvl, "pqname"), PF_QNAME_SIZE);
330 strlcpy(rule->tagname, nvlist_get_string(nvl, "tagname"),
332 strlcpy(rule->match_tagname, nvlist_get_string(nvl, "match_tagname"),
335 strlcpy(rule->overload_tblname, nvlist_get_string(nvl, "overload_tblname"),
338 pf_nvpool_to_pool(nvlist_get_nvlist(nvl, "rpool"), &rule->rpool);
340 rule->evaluations = nvlist_get_number(nvl, "evaluations");
341 pf_nvuint_64_array(nvl, "packets", 2, rule->packets, NULL);
342 pf_nvuint_64_array(nvl, "bytes", 2, rule->bytes, NULL);
344 rule->os_fingerprint = nvlist_get_number(nvl, "os_fingerprint");
346 rule->rtableid = nvlist_get_number(nvl, "rtableid");
347 pf_nvuint_32_array(nvl, "timeout", PFTM_MAX, rule->timeout, NULL);
348 rule->max_states = nvlist_get_number(nvl, "max_states");
349 rule->max_src_nodes = nvlist_get_number(nvl, "max_src_nodes");
350 rule->max_src_states = nvlist_get_number(nvl, "max_src_states");
351 rule->max_src_conn = nvlist_get_number(nvl, "max_src_conn");
352 rule->max_src_conn_rate.limit =
353 nvlist_get_number(nvl, "max_src_conn_rate.limit");
354 rule->max_src_conn_rate.seconds =
355 nvlist_get_number(nvl, "max_src_conn_rate.seconds");
356 rule->qid = nvlist_get_number(nvl, "qid");
357 rule->pqid = nvlist_get_number(nvl, "pqid");
358 rule->prob = nvlist_get_number(nvl, "prob");
359 rule->cuid = nvlist_get_number(nvl, "cuid");
360 rule->cpid = nvlist_get_number(nvl, "cpid");
362 rule->return_icmp = nvlist_get_number(nvl, "return_icmp");
363 rule->return_icmp6 = nvlist_get_number(nvl, "return_icmp6");
364 rule->max_mss = nvlist_get_number(nvl, "max_mss");
365 rule->scrub_flags = nvlist_get_number(nvl, "scrub_flags");
367 pf_nvrule_uid_to_rule_uid(nvlist_get_nvlist(nvl, "uid"), &rule->uid);
368 pf_nvrule_uid_to_rule_uid(nvlist_get_nvlist(nvl, "gid"),
369 (struct pf_rule_uid *)&rule->gid);
371 rule->rule_flag = nvlist_get_number(nvl, "rule_flag");
372 rule->action = nvlist_get_number(nvl, "action");
373 rule->direction = nvlist_get_number(nvl, "direction");
374 rule->log = nvlist_get_number(nvl, "log");
375 rule->logif = nvlist_get_number(nvl, "logif");
376 rule->quick = nvlist_get_number(nvl, "quick");
377 rule->ifnot = nvlist_get_number(nvl, "ifnot");
378 rule->match_tag_not = nvlist_get_number(nvl, "match_tag_not");
379 rule->natpass = nvlist_get_number(nvl, "natpass");
381 rule->keep_state = nvlist_get_number(nvl, "keep_state");
382 rule->af = nvlist_get_number(nvl, "af");
383 rule->proto = nvlist_get_number(nvl, "proto");
384 rule->type = nvlist_get_number(nvl, "type");
385 rule->code = nvlist_get_number(nvl, "code");
386 rule->flags = nvlist_get_number(nvl, "flags");
387 rule->flagset = nvlist_get_number(nvl, "flagset");
388 rule->min_ttl = nvlist_get_number(nvl, "min_ttl");
389 rule->allow_opts = nvlist_get_number(nvl, "allow_opts");
390 rule->rt = nvlist_get_number(nvl, "rt");
391 rule->return_ttl = nvlist_get_number(nvl, "return_ttl");
392 rule->tos = nvlist_get_number(nvl, "tos");
393 rule->set_tos = nvlist_get_number(nvl, "set_tos");
394 rule->anchor_relative = nvlist_get_number(nvl, "anchor_relative");
395 rule->anchor_wildcard = nvlist_get_number(nvl, "anchor_wildcard");
397 rule->flush = nvlist_get_number(nvl, "flush");
398 rule->prio = nvlist_get_number(nvl, "prio");
399 pf_nvuint_8_array(nvl, "set_prio", 2, rule->set_prio, NULL);
401 pf_nvdivert_to_divert(nvlist_get_nvlist(nvl, "divert"), rule);
403 rule->states_cur = nvlist_get_number(nvl, "states_cur");
404 rule->states_tot = nvlist_get_number(nvl, "states_tot");
405 rule->src_nodes = nvlist_get_number(nvl, "src_nodes");
409 pfctl_add_rule(int dev, const struct pfctl_rule *r, const char *anchor,
410 const char *anchor_call, u_int32_t ticket, u_int32_t pool_ticket)
413 u_int64_t timeouts[PFTM_MAX];
414 u_int64_t set_prio[2];
415 nvlist_t *nvl, *nvlr;
419 nvl = nvlist_create(0);
420 nvlr = nvlist_create(0);
422 nvlist_add_number(nvl, "ticket", ticket);
423 nvlist_add_number(nvl, "pool_ticket", pool_ticket);
424 nvlist_add_string(nvl, "anchor", anchor);
425 nvlist_add_string(nvl, "anchor_call", anchor_call);
427 nvlist_add_number(nvlr, "nr", r->nr);
428 pfctl_nv_add_rule_addr(nvlr, "src", &r->src);
429 pfctl_nv_add_rule_addr(nvlr, "dst", &r->dst);
432 while (r->label[labelcount][0] != 0 &&
433 labelcount < PF_RULE_MAX_LABEL_COUNT) {
434 nvlist_append_string_array(nvlr, "labels",
435 r->label[labelcount]);
439 nvlist_add_string(nvlr, "ifname", r->ifname);
440 nvlist_add_string(nvlr, "qname", r->qname);
441 nvlist_add_string(nvlr, "pqname", r->pqname);
442 nvlist_add_string(nvlr, "tagname", r->tagname);
443 nvlist_add_string(nvlr, "match_tagname", r->match_tagname);
444 nvlist_add_string(nvlr, "overload_tblname", r->overload_tblname);
446 pfctl_nv_add_pool(nvlr, "rpool", &r->rpool);
448 nvlist_add_number(nvlr, "os_fingerprint", r->os_fingerprint);
450 nvlist_add_number(nvlr, "rtableid", r->rtableid);
451 for (int i = 0; i < PFTM_MAX; i++)
452 timeouts[i] = r->timeout[i];
453 nvlist_add_number_array(nvlr, "timeout", timeouts, PFTM_MAX);
454 nvlist_add_number(nvlr, "max_states", r->max_states);
455 nvlist_add_number(nvlr, "max_src_nodes", r->max_src_nodes);
456 nvlist_add_number(nvlr, "max_src_states", r->max_src_states);
457 nvlist_add_number(nvlr, "max_src_conn", r->max_src_conn);
458 nvlist_add_number(nvlr, "max_src_conn_rate.limit",
459 r->max_src_conn_rate.limit);
460 nvlist_add_number(nvlr, "max_src_conn_rate.seconds",
461 r->max_src_conn_rate.seconds);
462 nvlist_add_number(nvlr, "prob", r->prob);
463 nvlist_add_number(nvlr, "cuid", r->cuid);
464 nvlist_add_number(nvlr, "cpid", r->cpid);
466 nvlist_add_number(nvlr, "return_icmp", r->return_icmp);
467 nvlist_add_number(nvlr, "return_icmp6", r->return_icmp6);
469 nvlist_add_number(nvlr, "max_mss", r->max_mss);
470 nvlist_add_number(nvlr, "scrub_flags", r->scrub_flags);
472 pfctl_nv_add_uid(nvlr, "uid", &r->uid);
473 pfctl_nv_add_uid(nvlr, "gid", (const struct pf_rule_uid *)&r->gid);
475 nvlist_add_number(nvlr, "rule_flag", r->rule_flag);
476 nvlist_add_number(nvlr, "action", r->action);
477 nvlist_add_number(nvlr, "direction", r->direction);
478 nvlist_add_number(nvlr, "log", r->log);
479 nvlist_add_number(nvlr, "logif", r->logif);
480 nvlist_add_number(nvlr, "quick", r->quick);
481 nvlist_add_number(nvlr, "ifnot", r->ifnot);
482 nvlist_add_number(nvlr, "match_tag_not", r->match_tag_not);
483 nvlist_add_number(nvlr, "natpass", r->natpass);
485 nvlist_add_number(nvlr, "keep_state", r->keep_state);
486 nvlist_add_number(nvlr, "af", r->af);
487 nvlist_add_number(nvlr, "proto", r->proto);
488 nvlist_add_number(nvlr, "type", r->type);
489 nvlist_add_number(nvlr, "code", r->code);
490 nvlist_add_number(nvlr, "flags", r->flags);
491 nvlist_add_number(nvlr, "flagset", r->flagset);
492 nvlist_add_number(nvlr, "min_ttl", r->min_ttl);
493 nvlist_add_number(nvlr, "allow_opts", r->allow_opts);
494 nvlist_add_number(nvlr, "rt", r->rt);
495 nvlist_add_number(nvlr, "return_ttl", r->return_ttl);
496 nvlist_add_number(nvlr, "tos", r->tos);
497 nvlist_add_number(nvlr, "set_tos", r->set_tos);
498 nvlist_add_number(nvlr, "anchor_relative", r->anchor_relative);
499 nvlist_add_number(nvlr, "anchor_wildcard", r->anchor_wildcard);
501 nvlist_add_number(nvlr, "flush", r->flush);
503 nvlist_add_number(nvlr, "prio", r->prio);
504 set_prio[0] = r->set_prio[0];
505 set_prio[1] = r->set_prio[1];
506 nvlist_add_number_array(nvlr, "set_prio", set_prio, 2);
508 pfctl_nv_add_divert(nvlr, "divert", r);
510 nvlist_add_nvlist(nvl, "rule", nvlr);
512 /* Now do the call. */
513 nv.data = nvlist_pack(nvl, &nv.len);
516 ret = ioctl(dev, DIOCADDRULENV, &nv);
525 pfctl_get_rule(int dev, u_int32_t nr, u_int32_t ticket, const char *anchor,
526 u_int32_t ruleset, struct pfctl_rule *rule, char *anchor_call)
528 return (pfctl_get_clear_rule(dev, nr, ticket, anchor, ruleset, rule,
529 anchor_call, false));
532 int pfctl_get_clear_rule(int dev, u_int32_t nr, u_int32_t ticket,
533 const char *anchor, u_int32_t ruleset, struct pfctl_rule *rule,
534 char *anchor_call, bool clear)
541 nvl = nvlist_create(0);
545 nvlist_add_number(nvl, "nr", nr);
546 nvlist_add_number(nvl, "ticket", ticket);
547 nvlist_add_string(nvl, "anchor", anchor);
548 nvlist_add_number(nvl, "ruleset", ruleset);
551 nvlist_add_bool(nvl, "clear_counter", true);
553 nvlpacked = nvlist_pack(nvl, &nv.len);
554 if (nvlpacked == NULL) {
558 nv.data = malloc(8182);
560 assert(nv.len <= nv.size);
561 memcpy(nv.data, nvlpacked, nv.len);
566 ret = ioctl(dev, DIOCGETRULENV, &nv);
572 nvl = nvlist_unpack(nv.data, nv.len, 0);
578 pf_nvrule_to_rule(nvlist_get_nvlist(nvl, "rule"), rule);
581 strlcpy(anchor_call, nvlist_get_string(nvl, "anchor_call"),
591 pfctl_set_keepcounters(int dev, bool keep)
597 nvl = nvlist_create(0);
599 nvlist_add_bool(nvl, "keep_counters", keep);
601 nv.data = nvlist_pack(nvl, &nv.len);
606 ret = ioctl(dev, DIOCKEEPCOUNTERS, &nv);
613 pfctl_nv_add_state_cmp(nvlist_t *nvl, const char *name,
614 const struct pfctl_state_cmp *cmp)
618 nv = nvlist_create(0);
620 nvlist_add_number(nv, "id", cmp->id);
621 nvlist_add_number(nv, "creatorid", cmp->creatorid);
622 nvlist_add_number(nv, "direction", cmp->direction);
624 nvlist_add_nvlist(nvl, name, nv);
628 pfctl_clear_states(int dev, const struct pfctl_kill *kill,
629 unsigned int *killed)
635 nvl = nvlist_create(0);
637 pfctl_nv_add_state_cmp(nvl, "cmp", &kill->cmp);
638 nvlist_add_number(nvl, "af", kill->af);
639 nvlist_add_number(nvl, "proto", kill->proto);
640 pfctl_nv_add_rule_addr(nvl, "src", &kill->src);
641 pfctl_nv_add_rule_addr(nvl, "dst", &kill->dst);
642 nvlist_add_string(nvl, "ifname", kill->ifname);
643 nvlist_add_string(nvl, "label", kill->label);
645 nv.data = nvlist_pack(nvl, &nv.len);
650 ret = ioctl(dev, DIOCCLRSTATESNV, &nv);
656 nvl = nvlist_unpack(nv.data, nv.len, 0);
663 *killed = nvlist_get_number(nvl, "killed");