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