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