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