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