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 * $FreeBSD$ 32 */ 33 34 #ifndef _PFCTL_IOCTL_H_ 35 #define _PFCTL_IOCTL_H_ 36 37 #include <netpfil/pf/pf.h> 38 39 struct pfctl_anchor; 40 struct pfctl_eth_anchor; 41 42 struct pfctl_status_counter { 43 uint64_t id; 44 uint64_t counter; 45 char *name; 46 47 TAILQ_ENTRY(pfctl_status_counter) entry; 48 }; 49 TAILQ_HEAD(pfctl_status_counters, pfctl_status_counter); 50 51 struct pfctl_status { 52 bool running; 53 uint32_t since; 54 uint32_t debug; 55 uint32_t hostid; 56 uint64_t states; 57 uint64_t src_nodes; 58 char ifname[IFNAMSIZ]; 59 uint8_t pf_chksum[PF_MD5_DIGEST_LENGTH]; 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][3]; 66 uint64_t bcounters[2][2]; 67 }; 68 69 struct pfctl_eth_rules_info { 70 uint32_t nr; 71 uint32_t ticket; 72 }; 73 74 struct pfctl_eth_addr { 75 uint8_t addr[ETHER_ADDR_LEN]; 76 uint8_t mask[ETHER_ADDR_LEN]; 77 bool neg; 78 bool isset; 79 }; 80 81 struct pfctl_eth_rule { 82 uint32_t nr; 83 84 bool quick; 85 86 /* Filter */ 87 char ifname[IFNAMSIZ]; 88 uint8_t ifnot; 89 uint8_t direction; 90 uint16_t proto; 91 struct pfctl_eth_addr src, dst; 92 93 /* Stats */ 94 uint64_t evaluations; 95 uint64_t packets[2]; 96 uint64_t bytes[2]; 97 98 /* Action */ 99 char qname[PF_QNAME_SIZE]; 100 char tagname[PF_TAG_NAME_SIZE]; 101 uint16_t dnpipe; 102 uint32_t dnflags; 103 uint8_t action; 104 105 struct pfctl_eth_anchor *anchor; 106 uint8_t anchor_relative; 107 uint8_t anchor_wildcard; 108 109 TAILQ_ENTRY(pfctl_eth_rule) entries; 110 }; 111 TAILQ_HEAD(pfctl_eth_rules, pfctl_eth_rule); 112 113 struct pfctl_eth_ruleset { 114 struct pfctl_eth_rules rules; 115 struct pfctl_eth_anchor *anchor; 116 }; 117 118 struct pfctl_eth_anchor { 119 struct pfctl_eth_anchor *parent; 120 char name[PF_ANCHOR_NAME_SIZE]; 121 char path[MAXPATHLEN]; 122 struct pfctl_eth_ruleset ruleset; 123 int refcnt; /* anchor rules */ 124 int match; /* XXX: used for pfctl black magic */ 125 }; 126 127 struct pfctl_pool { 128 struct pf_palist list; 129 struct pf_pooladdr *cur; 130 struct pf_poolhashkey key; 131 struct pf_addr counter; 132 struct pf_mape_portset mape; 133 int tblidx; 134 uint16_t proxy_port[2]; 135 uint8_t opts; 136 }; 137 138 struct pfctl_rules_info { 139 uint32_t nr; 140 uint32_t ticket; 141 }; 142 143 struct pfctl_rule { 144 struct pf_rule_addr src; 145 struct pf_rule_addr dst; 146 union pf_rule_ptr skip[PF_SKIP_COUNT]; 147 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE]; 148 uint32_t ridentifier; 149 char ifname[IFNAMSIZ]; 150 char qname[PF_QNAME_SIZE]; 151 char pqname[PF_QNAME_SIZE]; 152 char tagname[PF_TAG_NAME_SIZE]; 153 char match_tagname[PF_TAG_NAME_SIZE]; 154 155 char overload_tblname[PF_TABLE_NAME_SIZE]; 156 157 TAILQ_ENTRY(pfctl_rule) entries; 158 struct pfctl_pool rpool; 159 160 uint64_t evaluations; 161 uint64_t packets[2]; 162 uint64_t bytes[2]; 163 164 struct pfi_kif *kif; 165 struct pfctl_anchor *anchor; 166 struct pfr_ktable *overload_tbl; 167 168 pf_osfp_t os_fingerprint; 169 170 int rtableid; 171 uint32_t timeout[PFTM_MAX]; 172 uint32_t max_states; 173 uint32_t max_src_nodes; 174 uint32_t max_src_states; 175 uint32_t max_src_conn; 176 struct { 177 uint32_t limit; 178 uint32_t seconds; 179 } max_src_conn_rate; 180 uint32_t qid; 181 uint32_t pqid; 182 uint16_t dnpipe; 183 uint16_t dnrpipe; 184 uint32_t free_flags; 185 uint32_t nr; 186 uint32_t prob; 187 uid_t cuid; 188 pid_t cpid; 189 190 uint64_t states_cur; 191 uint64_t states_tot; 192 uint64_t src_nodes; 193 194 uint16_t return_icmp; 195 uint16_t return_icmp6; 196 uint16_t max_mss; 197 uint16_t tag; 198 uint16_t match_tag; 199 uint16_t scrub_flags; 200 201 struct pf_rule_uid uid; 202 struct pf_rule_gid gid; 203 204 uint32_t rule_flag; 205 uint8_t action; 206 uint8_t direction; 207 uint8_t log; 208 uint8_t logif; 209 uint8_t quick; 210 uint8_t ifnot; 211 uint8_t match_tag_not; 212 uint8_t natpass; 213 214 uint8_t keep_state; 215 sa_family_t af; 216 uint8_t proto; 217 uint8_t type; 218 uint8_t code; 219 uint8_t flags; 220 uint8_t flagset; 221 uint8_t min_ttl; 222 uint8_t allow_opts; 223 uint8_t rt; 224 uint8_t return_ttl; 225 uint8_t tos; 226 uint8_t set_tos; 227 uint8_t anchor_relative; 228 uint8_t anchor_wildcard; 229 230 uint8_t flush; 231 uint8_t prio; 232 uint8_t set_prio[2]; 233 234 struct { 235 struct pf_addr addr; 236 uint16_t port; 237 } divert; 238 }; 239 240 TAILQ_HEAD(pfctl_rulequeue, pfctl_rule); 241 242 struct pfctl_ruleset { 243 struct { 244 struct pfctl_rulequeue queues[2]; 245 struct { 246 struct pfctl_rulequeue *ptr; 247 struct pfctl_rule **ptr_array; 248 uint32_t rcount; 249 uint32_t ticket; 250 int open; 251 } active, inactive; 252 } rules[PF_RULESET_MAX]; 253 struct pfctl_anchor *anchor; 254 uint32_t tticket; 255 int tables; 256 int topen; 257 }; 258 259 RB_HEAD(pfctl_anchor_global, pfctl_anchor); 260 RB_HEAD(pfctl_anchor_node, pfctl_anchor); 261 struct pfctl_anchor { 262 RB_ENTRY(pfctl_anchor) entry_global; 263 RB_ENTRY(pfctl_anchor) entry_node; 264 struct pfctl_anchor *parent; 265 struct pfctl_anchor_node children; 266 char name[PF_ANCHOR_NAME_SIZE]; 267 char path[MAXPATHLEN]; 268 struct pfctl_ruleset ruleset; 269 int refcnt; /* anchor rules */ 270 int match; /* XXX: used for pfctl black magic */ 271 }; 272 RB_PROTOTYPE(pfctl_anchor_global, pfctl_anchor, entry_global, 273 pf_anchor_compare); 274 RB_PROTOTYPE(pfctl_anchor_node, pfctl_anchor, entry_node, 275 pf_anchor_compare); 276 277 struct pfctl_state_cmp { 278 uint64_t id; 279 uint32_t creatorid; 280 uint8_t direction; 281 }; 282 283 struct pfctl_kill { 284 struct pfctl_state_cmp cmp; 285 sa_family_t af; 286 int proto; 287 struct pf_rule_addr src; 288 struct pf_rule_addr dst; 289 struct pf_rule_addr rt_addr; 290 char ifname[IFNAMSIZ]; 291 char label[PF_RULE_LABEL_SIZE]; 292 bool kill_match; 293 }; 294 295 struct pfctl_state_peer { 296 uint32_t seqlo; 297 uint32_t seqhi; 298 uint32_t seqdiff; 299 uint8_t state; 300 uint8_t wscale; 301 }; 302 303 struct pfctl_state_key { 304 struct pf_addr addr[2]; 305 uint16_t port[2]; 306 sa_family_t af; 307 uint8_t proto; 308 }; 309 310 struct pfctl_state { 311 TAILQ_ENTRY(pfctl_state) entry; 312 313 uint64_t id; 314 uint32_t creatorid; 315 uint8_t direction; 316 317 struct pfctl_state_peer src; 318 struct pfctl_state_peer dst; 319 320 uint32_t rule; 321 uint32_t anchor; 322 uint32_t nat_rule; 323 struct pf_addr rt_addr; 324 struct pfctl_state_key key[2]; /* addresses stack and wire */ 325 char ifname[IFNAMSIZ]; 326 char orig_ifname[IFNAMSIZ]; 327 uint64_t packets[2]; 328 uint64_t bytes[2]; 329 uint32_t creation; 330 uint32_t expire; 331 uint32_t pfsync_time; 332 uint8_t state_flags; 333 uint32_t sync_flags; 334 }; 335 336 TAILQ_HEAD(pfctl_statelist, pfctl_state); 337 struct pfctl_states { 338 struct pfctl_statelist states; 339 size_t count; 340 }; 341 342 enum pfctl_syncookies_mode { 343 PFCTL_SYNCOOKIES_NEVER, 344 PFCTL_SYNCOOKIES_ALWAYS, 345 PFCTL_SYNCOOKIES_ADAPTIVE 346 }; 347 extern const char* PFCTL_SYNCOOKIES_MODE_NAMES[]; 348 349 struct pfctl_syncookies { 350 enum pfctl_syncookies_mode mode; 351 uint8_t highwater; /* Percent */ 352 uint8_t lowwater; /* Percent */ 353 }; 354 355 struct pfctl_status* pfctl_get_status(int dev); 356 void pfctl_free_status(struct pfctl_status *status); 357 358 int pfctl_get_eth_rules_info(int dev, struct pfctl_eth_rules_info *rules, 359 const char *path); 360 int pfctl_get_eth_rule(int dev, uint32_t nr, uint32_t ticket, 361 const char *path, struct pfctl_eth_rule *rule, bool clear, 362 char *anchor_call); 363 int pfctl_add_eth_rule(int dev, const struct pfctl_eth_rule *r, 364 const char *anchor, const char *anchor_call, uint32_t ticket); 365 int pfctl_get_rules_info(int dev, struct pfctl_rules_info *rules, 366 uint32_t ruleset, const char *path); 367 int pfctl_get_rule(int dev, uint32_t nr, uint32_t ticket, 368 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 369 char *anchor_call); 370 int pfctl_get_clear_rule(int dev, uint32_t nr, uint32_t ticket, 371 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 372 char *anchor_call, bool clear); 373 int pfctl_add_rule(int dev, const struct pfctl_rule *r, 374 const char *anchor, const char *anchor_call, uint32_t ticket, 375 uint32_t pool_ticket); 376 int pfctl_set_keepcounters(int dev, bool keep); 377 int pfctl_get_states(int dev, struct pfctl_states *states); 378 void pfctl_free_states(struct pfctl_states *states); 379 int pfctl_clear_states(int dev, const struct pfctl_kill *kill, 380 unsigned int *killed); 381 int pfctl_kill_states(int dev, const struct pfctl_kill *kill, 382 unsigned int *killed); 383 int pfctl_clear_rules(int dev, const char *anchorname); 384 int pfctl_clear_nat(int dev, const char *anchorname); 385 int pfctl_clear_eth_rules(int dev, const char *anchorname); 386 int pfctl_set_syncookies(int dev, const struct pfctl_syncookies *s); 387 int pfctl_get_syncookies(int dev, struct pfctl_syncookies *s); 388 389 #endif 390