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 32 #ifndef _PFCTL_IOCTL_H_ 33 #define _PFCTL_IOCTL_H_ 34 35 #include <netpfil/pf/pf.h> 36 37 struct pfctl_anchor; 38 struct pfctl_eth_anchor; 39 40 struct pfctl_status_counter { 41 uint64_t id; 42 uint64_t counter; 43 char *name; 44 45 TAILQ_ENTRY(pfctl_status_counter) entry; 46 }; 47 TAILQ_HEAD(pfctl_status_counters, pfctl_status_counter); 48 49 struct pfctl_status { 50 bool running; 51 uint32_t since; 52 uint32_t debug; 53 uint32_t hostid; 54 uint64_t states; 55 uint64_t src_nodes; 56 char ifname[IFNAMSIZ]; 57 uint8_t pf_chksum[PF_MD5_DIGEST_LENGTH]; 58 bool syncookies_active; 59 uint32_t reass; 60 61 struct pfctl_status_counters counters; 62 struct pfctl_status_counters lcounters; 63 struct pfctl_status_counters fcounters; 64 struct pfctl_status_counters scounters; 65 struct pfctl_status_counters ncounters; 66 uint64_t fragments; 67 uint64_t pcounters[2][2][2]; 68 uint64_t bcounters[2][2]; 69 }; 70 71 struct pfctl_eth_rulesets_info { 72 uint32_t nr; 73 }; 74 75 struct pfctl_eth_rules_info { 76 uint32_t nr; 77 uint32_t ticket; 78 }; 79 80 struct pfctl_eth_addr { 81 uint8_t addr[ETHER_ADDR_LEN]; 82 uint8_t mask[ETHER_ADDR_LEN]; 83 bool neg; 84 bool isset; 85 }; 86 87 struct pfctl_eth_rule { 88 uint32_t nr; 89 90 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE]; 91 uint32_t ridentifier; 92 93 bool quick; 94 95 /* Filter */ 96 char ifname[IFNAMSIZ]; 97 uint8_t ifnot; 98 uint8_t direction; 99 uint16_t proto; 100 struct pfctl_eth_addr src, dst; 101 struct pf_rule_addr ipsrc, ipdst; 102 char match_tagname[PF_TAG_NAME_SIZE]; 103 uint16_t match_tag; 104 bool match_tag_not; 105 106 /* Stats */ 107 uint64_t evaluations; 108 uint64_t packets[2]; 109 uint64_t bytes[2]; 110 time_t last_active_timestamp; 111 112 /* Action */ 113 char qname[PF_QNAME_SIZE]; 114 char tagname[PF_TAG_NAME_SIZE]; 115 uint16_t dnpipe; 116 uint32_t dnflags; 117 char bridge_to[IFNAMSIZ]; 118 uint8_t action; 119 120 struct pfctl_eth_anchor *anchor; 121 uint8_t anchor_relative; 122 uint8_t anchor_wildcard; 123 124 TAILQ_ENTRY(pfctl_eth_rule) entries; 125 }; 126 TAILQ_HEAD(pfctl_eth_rules, pfctl_eth_rule); 127 128 struct pfctl_eth_ruleset_info { 129 uint32_t nr; 130 char name[PF_ANCHOR_NAME_SIZE]; 131 char path[MAXPATHLEN]; 132 }; 133 134 struct pfctl_eth_ruleset { 135 struct pfctl_eth_rules rules; 136 struct pfctl_eth_anchor *anchor; 137 }; 138 139 struct pfctl_eth_anchor { 140 struct pfctl_eth_anchor *parent; 141 char name[PF_ANCHOR_NAME_SIZE]; 142 char path[MAXPATHLEN]; 143 struct pfctl_eth_ruleset ruleset; 144 int refcnt; /* anchor rules */ 145 int match; /* XXX: used for pfctl black magic */ 146 }; 147 148 struct pfctl_pooladdr { 149 struct pf_addr_wrap addr; 150 TAILQ_ENTRY(pfctl_pooladdr) entries; 151 char ifname[IFNAMSIZ]; 152 sa_family_t af; 153 }; 154 155 TAILQ_HEAD(pfctl_palist, pfctl_pooladdr); 156 157 struct pfctl_pool { 158 struct pfctl_palist list; 159 struct pfctl_pooladdr *cur; 160 struct pf_poolhashkey key; 161 struct pf_addr counter; 162 struct pf_mape_portset mape; 163 int tblidx; 164 uint16_t proxy_port[2]; 165 uint8_t opts; 166 }; 167 168 struct pfctl_rules_info { 169 uint32_t nr; 170 uint32_t ticket; 171 }; 172 173 struct pfctl_threshold { 174 uint32_t limit; 175 uint32_t seconds; 176 uint32_t count; 177 uint32_t last; 178 }; 179 180 struct pfctl_rule { 181 struct pf_rule_addr src; 182 struct pf_rule_addr dst; 183 union pf_rule_ptr skip[PF_SKIP_COUNT]; 184 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE]; 185 uint32_t ridentifier; 186 char ifname[IFNAMSIZ]; 187 char qname[PF_QNAME_SIZE]; 188 char pqname[PF_QNAME_SIZE]; 189 char tagname[PF_TAG_NAME_SIZE]; 190 char match_tagname[PF_TAG_NAME_SIZE]; 191 192 char overload_tblname[PF_TABLE_NAME_SIZE]; 193 194 TAILQ_ENTRY(pfctl_rule) entries; 195 struct pfctl_pool nat; 196 union { 197 /* Alias old and new names. */ 198 struct pfctl_pool rpool; 199 struct pfctl_pool rdr; 200 }; 201 struct pfctl_pool route; 202 struct pfctl_threshold pktrate; 203 204 uint64_t evaluations; 205 uint64_t packets[2]; 206 uint64_t bytes[2]; 207 time_t last_active_timestamp; 208 209 struct pfi_kif *kif; 210 struct pfctl_anchor *anchor; 211 struct pfr_ktable *overload_tbl; 212 213 pf_osfp_t os_fingerprint; 214 215 int rtableid; 216 uint32_t timeout[PFTM_MAX]; 217 uint32_t max_states; 218 uint32_t max_src_nodes; 219 uint32_t max_src_states; 220 uint32_t max_src_conn; 221 struct { 222 uint32_t limit; 223 uint32_t seconds; 224 } max_src_conn_rate; 225 uint16_t max_pkt_size; 226 uint32_t qid; 227 uint32_t pqid; 228 uint16_t dnpipe; 229 uint16_t dnrpipe; 230 uint32_t free_flags; 231 uint32_t nr; 232 uint32_t prob; 233 uid_t cuid; 234 pid_t cpid; 235 236 uint64_t states_cur; 237 uint64_t states_tot; 238 uint64_t src_nodes; 239 uint64_t src_nodes_type[PF_SN_MAX]; 240 241 uint16_t return_icmp; 242 uint16_t return_icmp6; 243 uint16_t max_mss; 244 uint16_t tag; 245 uint16_t match_tag; 246 uint16_t scrub_flags; 247 248 struct pf_rule_uid uid; 249 struct pf_rule_gid gid; 250 char rcv_ifname[IFNAMSIZ]; 251 bool rcvifnot; 252 253 uint32_t rule_flag; 254 uint8_t action; 255 uint8_t direction; 256 uint8_t log; 257 uint8_t logif; 258 uint8_t quick; 259 uint8_t ifnot; 260 uint8_t match_tag_not; 261 uint8_t natpass; 262 263 uint8_t keep_state; 264 sa_family_t af; 265 uint8_t proto; 266 uint16_t type; 267 uint16_t code; 268 uint8_t flags; 269 uint8_t flagset; 270 uint8_t min_ttl; 271 uint8_t allow_opts; 272 uint8_t rt; 273 uint8_t return_ttl; 274 uint8_t tos; 275 uint8_t set_tos; 276 uint8_t anchor_relative; 277 uint8_t anchor_wildcard; 278 279 uint8_t flush; 280 uint8_t prio; 281 uint8_t set_prio[2]; 282 sa_family_t naf; 283 284 struct { 285 struct pf_addr addr; 286 uint16_t port; 287 } divert; 288 289 time_t exptime; 290 }; 291 292 TAILQ_HEAD(pfctl_rulequeue, pfctl_rule); 293 294 struct pfctl_ruleset { 295 struct { 296 struct pfctl_rulequeue queues[2]; 297 struct { 298 struct pfctl_rulequeue *ptr; 299 struct pfctl_rule **ptr_array; 300 uint32_t rcount; 301 uint32_t ticket; 302 int open; 303 } active, inactive; 304 } rules[PF_RULESET_MAX]; 305 struct pfctl_anchor *anchor; 306 uint32_t tticket; 307 int tables; 308 int topen; 309 }; 310 311 RB_HEAD(pfctl_anchor_global, pfctl_anchor); 312 RB_HEAD(pfctl_anchor_node, pfctl_anchor); 313 struct pfctl_anchor { 314 RB_ENTRY(pfctl_anchor) entry_global; 315 RB_ENTRY(pfctl_anchor) entry_node; 316 struct pfctl_anchor *parent; 317 struct pfctl_anchor_node children; 318 char name[PF_ANCHOR_NAME_SIZE]; 319 char path[MAXPATHLEN]; 320 struct pfctl_ruleset ruleset; 321 int refcnt; /* anchor rules */ 322 int match; /* XXX: used for pfctl black magic */ 323 }; 324 RB_PROTOTYPE(pfctl_anchor_global, pfctl_anchor, entry_global, 325 pf_anchor_compare); 326 RB_PROTOTYPE(pfctl_anchor_node, pfctl_anchor, entry_node, 327 pf_anchor_compare); 328 329 struct pfctl_state_cmp { 330 uint64_t id; 331 uint32_t creatorid; 332 uint8_t direction; 333 }; 334 335 struct pfctl_kill { 336 struct pfctl_state_cmp cmp; 337 sa_family_t af; 338 int proto; 339 struct pf_rule_addr src; 340 struct pf_rule_addr dst; 341 struct pf_rule_addr rt_addr; 342 char ifname[IFNAMSIZ]; 343 char label[PF_RULE_LABEL_SIZE]; 344 bool kill_match; 345 bool nat; 346 }; 347 348 struct pfctl_state_peer { 349 uint32_t seqlo; 350 uint32_t seqhi; 351 uint32_t seqdiff; 352 uint8_t state; 353 uint8_t wscale; 354 }; 355 356 struct pfctl_state_key { 357 struct pf_addr addr[2]; 358 uint16_t port[2]; 359 sa_family_t af; 360 uint8_t proto; 361 }; 362 363 struct pfctl_state { 364 TAILQ_ENTRY(pfctl_state) entry; 365 366 uint64_t id; 367 uint32_t creatorid; 368 uint8_t direction; 369 370 struct pfctl_state_peer src; 371 struct pfctl_state_peer dst; 372 373 uint32_t rule; 374 uint32_t anchor; 375 uint32_t nat_rule; 376 struct pf_addr rt_addr; 377 struct pfctl_state_key key[2]; /* addresses stack and wire */ 378 char ifname[IFNAMSIZ]; 379 char orig_ifname[IFNAMSIZ]; 380 uint64_t packets[2]; 381 uint64_t bytes[2]; 382 uint32_t creation; 383 uint32_t expire; 384 uint32_t pfsync_time; 385 uint16_t state_flags; 386 uint32_t sync_flags; 387 uint16_t qid; 388 uint16_t pqid; 389 uint16_t dnpipe; 390 uint16_t dnrpipe; 391 uint8_t log; 392 int32_t rtableid; 393 uint8_t min_ttl; 394 uint8_t set_tos; 395 uint16_t max_mss; 396 uint8_t set_prio[2]; 397 uint8_t rt; 398 char rt_ifname[IFNAMSIZ]; 399 sa_family_t rt_af; 400 uint8_t src_node_flags; 401 }; 402 403 TAILQ_HEAD(pfctl_statelist, pfctl_state); 404 struct pfctl_states { 405 struct pfctl_statelist states; 406 }; 407 408 enum pfctl_syncookies_mode { 409 PFCTL_SYNCOOKIES_NEVER, 410 PFCTL_SYNCOOKIES_ALWAYS, 411 PFCTL_SYNCOOKIES_ADAPTIVE 412 }; 413 extern const char* PFCTL_SYNCOOKIES_MODE_NAMES[]; 414 415 struct pfctl_syncookies { 416 enum pfctl_syncookies_mode mode; 417 uint8_t highwater; /* Percent */ 418 uint8_t lowwater; /* Percent */ 419 uint32_t halfopen_states; 420 }; 421 422 struct pfctl_src_node { 423 struct pf_addr addr; 424 struct pf_addr raddr; 425 int rule; 426 uint64_t bytes[2]; 427 uint64_t packets[2]; 428 uint32_t states; 429 uint32_t conn; 430 sa_family_t af; 431 sa_family_t raf; 432 uint8_t ruletype; 433 uint64_t creation; 434 uint64_t expire; 435 struct pfctl_threshold conn_rate; 436 pf_sn_types_t type; 437 }; 438 439 #define PF_DEVICE "/dev/pf" 440 441 struct pfctl_handle; 442 struct pfctl_handle *pfctl_open(const char *pf_device); 443 void pfctl_close(struct pfctl_handle *); 444 int pfctl_fd(struct pfctl_handle *); 445 446 int pfctl_startstop(struct pfctl_handle *h, int start); 447 struct pfctl_status* pfctl_get_status_h(struct pfctl_handle *h); 448 struct pfctl_status* pfctl_get_status(int dev); 449 int pfctl_clear_status(struct pfctl_handle *h); 450 uint64_t pfctl_status_counter(struct pfctl_status *status, int id); 451 uint64_t pfctl_status_lcounter(struct pfctl_status *status, int id); 452 uint64_t pfctl_status_fcounter(struct pfctl_status *status, int id); 453 uint64_t pfctl_status_scounter(struct pfctl_status *status, int id); 454 void pfctl_free_status(struct pfctl_status *status); 455 456 int pfctl_get_eth_rulesets_info(int dev, 457 struct pfctl_eth_rulesets_info *ri, const char *path); 458 int pfctl_get_eth_ruleset(int dev, const char *path, int nr, 459 struct pfctl_eth_ruleset_info *ri); 460 int pfctl_get_eth_rules_info(int dev, struct pfctl_eth_rules_info *rules, 461 const char *path); 462 int pfctl_get_eth_rule(int dev, uint32_t nr, uint32_t ticket, 463 const char *path, struct pfctl_eth_rule *rule, bool clear, 464 char *anchor_call); 465 int pfctl_add_eth_rule(int dev, const struct pfctl_eth_rule *r, 466 const char *anchor, const char *anchor_call, uint32_t ticket); 467 int pfctl_get_rules_info_h(struct pfctl_handle *h, 468 struct pfctl_rules_info *rules, uint32_t ruleset, 469 const char *path); 470 int pfctl_get_rules_info(int dev, struct pfctl_rules_info *rules, 471 uint32_t ruleset, const char *path); 472 int pfctl_get_rule(int dev, uint32_t nr, uint32_t ticket, 473 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 474 char *anchor_call); 475 int pfctl_get_rule_h(struct pfctl_handle *h, uint32_t nr, uint32_t ticket, 476 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 477 char *anchor_call); 478 int pfctl_get_clear_rule(int dev, uint32_t nr, uint32_t ticket, 479 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 480 char *anchor_call, bool clear); 481 int pfctl_get_clear_rule_h(struct pfctl_handle *h, uint32_t nr, uint32_t ticket, 482 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 483 char *anchor_call, bool clear); 484 int pfctl_add_rule(int dev, const struct pfctl_rule *r, 485 const char *anchor, const char *anchor_call, uint32_t ticket, 486 uint32_t pool_ticket); 487 int pfctl_add_rule_h(struct pfctl_handle *h, const struct pfctl_rule *r, 488 const char *anchor, const char *anchor_call, uint32_t ticket, 489 uint32_t pool_ticket); 490 int pfctl_set_keepcounters(int dev, bool keep); 491 int pfctl_get_creatorids(struct pfctl_handle *h, uint32_t *creators, size_t *len); 492 493 struct pfctl_state_filter { 494 char ifname[IFNAMSIZ]; 495 uint16_t proto; 496 sa_family_t af; 497 struct pf_addr addr; 498 struct pf_addr mask; 499 }; 500 typedef int (*pfctl_get_state_fn)(struct pfctl_state *, void *); 501 int pfctl_get_states_iter(pfctl_get_state_fn f, void *arg); 502 int pfctl_get_filtered_states_iter(struct pfctl_state_filter *filter, pfctl_get_state_fn f, void *arg); 503 int pfctl_get_states(int dev, struct pfctl_states *states); 504 void pfctl_free_states(struct pfctl_states *states); 505 int pfctl_clear_states(int dev, const struct pfctl_kill *kill, 506 unsigned int *killed); 507 int pfctl_kill_states(int dev, const struct pfctl_kill *kill, 508 unsigned int *killed); 509 int pfctl_clear_states_h(struct pfctl_handle *h, const struct pfctl_kill *kill, 510 unsigned int *killed); 511 int pfctl_kill_states_h(struct pfctl_handle *h, const struct pfctl_kill *kill, 512 unsigned int *killed); 513 int pfctl_clear_rules(int dev, const char *anchorname); 514 int pfctl_clear_nat(int dev, const char *anchorname); 515 int pfctl_clear_eth_rules(int dev, const char *anchorname); 516 int pfctl_set_syncookies(int dev, const struct pfctl_syncookies *s); 517 int pfctl_get_syncookies(int dev, struct pfctl_syncookies *s); 518 int pfctl_table_add_addrs_h(struct pfctl_handle *h, struct pfr_table *tbl, struct pfr_addr 519 *addr, int size, int *nadd, int flags); 520 int pfctl_table_add_addrs(int dev, struct pfr_table *tbl, struct pfr_addr 521 *addr, int size, int *nadd, int flags); 522 int pfctl_table_del_addrs_h(struct pfctl_handle *h, struct pfr_table *tbl, 523 struct pfr_addr *addr, int size, int *ndel, int flags); 524 int pfctl_table_del_addrs(int dev, struct pfr_table *tbl, struct pfr_addr 525 *addr, int size, int *ndel, int flags); 526 int pfctl_table_set_addrs(int dev, struct pfr_table *tbl, struct pfr_addr 527 *addr, int size, int *size2, int *nadd, int *ndel, int *nchange, 528 int flags); 529 int pfctl_table_get_addrs(int dev, struct pfr_table *tbl, struct pfr_addr 530 *addr, int *size, int flags); 531 int pfctl_set_statusif(struct pfctl_handle *h, const char *ifname); 532 533 struct pfctl_natlook_key { 534 sa_family_t af; 535 uint8_t direction; 536 uint8_t proto; 537 struct pf_addr saddr; 538 struct pf_addr daddr; 539 uint16_t sport; 540 uint16_t dport; 541 }; 542 struct pfctl_natlook { 543 struct pf_addr saddr; 544 struct pf_addr daddr; 545 uint16_t sport; 546 uint16_t dport; 547 }; 548 int pfctl_natlook(struct pfctl_handle *h, 549 const struct pfctl_natlook_key *k, struct pfctl_natlook *r); 550 int pfctl_set_debug(struct pfctl_handle *h, uint32_t level); 551 int pfctl_set_timeout(struct pfctl_handle *h, uint32_t timeout, uint32_t seconds); 552 int pfctl_get_timeout(struct pfctl_handle *h, uint32_t timeout, uint32_t *seconds); 553 int pfctl_set_limit(struct pfctl_handle *h, const int index, const uint limit); 554 int pfctl_get_limit(struct pfctl_handle *h, const int index, uint *limit); 555 int pfctl_begin_addrs(struct pfctl_handle *h, uint32_t *ticket); 556 int pfctl_add_addr(struct pfctl_handle *h, const struct pfioc_pooladdr *pa, int which); 557 int pfctl_get_addrs(struct pfctl_handle *h, uint32_t ticket, uint32_t r_num, 558 uint8_t r_action, const char *anchor, uint32_t *nr, int which); 559 int pfctl_get_addr(struct pfctl_handle *h, uint32_t ticket, uint32_t r_num, 560 uint8_t r_action, const char *anchor, uint32_t nr, struct pfioc_pooladdr *pa, 561 int which); 562 int pfctl_get_rulesets(struct pfctl_handle *h, const char *path, uint32_t *nr); 563 int pfctl_get_ruleset(struct pfctl_handle *h, const char *path, uint32_t nr, struct pfioc_ruleset *rs); 564 typedef int (*pfctl_get_srcnode_fn)(struct pfctl_src_node*, void *); 565 int pfctl_get_srcnodes(struct pfctl_handle *h, pfctl_get_srcnode_fn fn, void *arg); 566 567 int pfctl_clear_tables(struct pfctl_handle *h, struct pfr_table *filter, 568 int *ndel, int flags); 569 int pfctl_add_table(struct pfctl_handle *h, struct pfr_table *table, 570 int *nadd, int flags); 571 int pfctl_del_table(struct pfctl_handle *h, struct pfr_table *table, 572 int *ndel, int flags); 573 574 typedef int (*pfctl_get_tstats_fn)(const struct pfr_tstats *t, void *arg); 575 int pfctl_get_tstats(struct pfctl_handle *h, const struct pfr_table *filter, 576 pfctl_get_tstats_fn fn, void *arg); 577 int pfctl_clear_tstats(struct pfctl_handle *h, const struct pfr_table *filter, 578 int *nzero, int flags); 579 int pfctl_clear_addrs(struct pfctl_handle *h, const struct pfr_table *filter, 580 int *ndel, int flags); 581 582 #endif 583