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 41 struct pfctl_status_counter { 42 uint64_t id; 43 uint64_t counter; 44 char *name; 45 46 TAILQ_ENTRY(pfctl_status_counter) entry; 47 }; 48 TAILQ_HEAD(pfctl_status_counters, pfctl_status_counter); 49 50 struct pfctl_status { 51 bool running; 52 uint32_t since; 53 uint32_t debug; 54 uint32_t hostid; 55 uint64_t states; 56 uint64_t src_nodes; 57 char ifname[IFNAMSIZ]; 58 uint8_t pf_chksum[PF_MD5_DIGEST_LENGTH]; 59 60 struct pfctl_status_counters counters; 61 struct pfctl_status_counters lcounters; 62 struct pfctl_status_counters fcounters; 63 struct pfctl_status_counters scounters; 64 uint64_t pcounters[2][2][3]; 65 uint64_t bcounters[2][2]; 66 }; 67 68 struct pfctl_pool { 69 struct pf_palist list; 70 struct pf_pooladdr *cur; 71 struct pf_poolhashkey key; 72 struct pf_addr counter; 73 struct pf_mape_portset mape; 74 int tblidx; 75 uint16_t proxy_port[2]; 76 uint8_t opts; 77 }; 78 79 struct pfctl_rule { 80 struct pf_rule_addr src; 81 struct pf_rule_addr dst; 82 union pf_rule_ptr skip[PF_SKIP_COUNT]; 83 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE]; 84 uint32_t ridentifier; 85 char ifname[IFNAMSIZ]; 86 char qname[PF_QNAME_SIZE]; 87 char pqname[PF_QNAME_SIZE]; 88 char tagname[PF_TAG_NAME_SIZE]; 89 char match_tagname[PF_TAG_NAME_SIZE]; 90 91 char overload_tblname[PF_TABLE_NAME_SIZE]; 92 93 TAILQ_ENTRY(pfctl_rule) entries; 94 struct pfctl_pool rpool; 95 96 uint64_t evaluations; 97 uint64_t packets[2]; 98 uint64_t bytes[2]; 99 100 struct pfi_kif *kif; 101 struct pfctl_anchor *anchor; 102 struct pfr_ktable *overload_tbl; 103 104 pf_osfp_t os_fingerprint; 105 106 int rtableid; 107 uint32_t timeout[PFTM_MAX]; 108 uint32_t max_states; 109 uint32_t max_src_nodes; 110 uint32_t max_src_states; 111 uint32_t max_src_conn; 112 struct { 113 uint32_t limit; 114 uint32_t seconds; 115 } max_src_conn_rate; 116 uint32_t qid; 117 uint32_t pqid; 118 uint32_t nr; 119 uint32_t prob; 120 uid_t cuid; 121 pid_t cpid; 122 123 uint64_t states_cur; 124 uint64_t states_tot; 125 uint64_t src_nodes; 126 127 uint16_t return_icmp; 128 uint16_t return_icmp6; 129 uint16_t max_mss; 130 uint16_t tag; 131 uint16_t match_tag; 132 uint16_t scrub_flags; 133 134 struct pf_rule_uid uid; 135 struct pf_rule_gid gid; 136 137 uint32_t rule_flag; 138 uint8_t action; 139 uint8_t direction; 140 uint8_t log; 141 uint8_t logif; 142 uint8_t quick; 143 uint8_t ifnot; 144 uint8_t match_tag_not; 145 uint8_t natpass; 146 147 uint8_t keep_state; 148 sa_family_t af; 149 uint8_t proto; 150 uint8_t type; 151 uint8_t code; 152 uint8_t flags; 153 uint8_t flagset; 154 uint8_t min_ttl; 155 uint8_t allow_opts; 156 uint8_t rt; 157 uint8_t return_ttl; 158 uint8_t tos; 159 uint8_t set_tos; 160 uint8_t anchor_relative; 161 uint8_t anchor_wildcard; 162 163 uint8_t flush; 164 uint8_t prio; 165 uint8_t set_prio[2]; 166 167 struct { 168 struct pf_addr addr; 169 uint16_t port; 170 } divert; 171 }; 172 173 TAILQ_HEAD(pfctl_rulequeue, pfctl_rule); 174 175 struct pfctl_ruleset { 176 struct { 177 struct pfctl_rulequeue queues[2]; 178 struct { 179 struct pfctl_rulequeue *ptr; 180 struct pfctl_rule **ptr_array; 181 uint32_t rcount; 182 uint32_t ticket; 183 int open; 184 } active, inactive; 185 } rules[PF_RULESET_MAX]; 186 struct pfctl_anchor *anchor; 187 uint32_t tticket; 188 int tables; 189 int topen; 190 }; 191 192 RB_HEAD(pfctl_anchor_global, pfctl_anchor); 193 RB_HEAD(pfctl_anchor_node, pfctl_anchor); 194 struct pfctl_anchor { 195 RB_ENTRY(pfctl_anchor) entry_global; 196 RB_ENTRY(pfctl_anchor) entry_node; 197 struct pfctl_anchor *parent; 198 struct pfctl_anchor_node children; 199 char name[PF_ANCHOR_NAME_SIZE]; 200 char path[MAXPATHLEN]; 201 struct pfctl_ruleset ruleset; 202 int refcnt; /* anchor rules */ 203 int match; /* XXX: used for pfctl black magic */ 204 }; 205 RB_PROTOTYPE(pfctl_anchor_global, pfctl_anchor, entry_global, 206 pf_anchor_compare); 207 RB_PROTOTYPE(pfctl_anchor_node, pfctl_anchor, entry_node, 208 pf_anchor_compare); 209 210 struct pfctl_state_cmp { 211 uint64_t id; 212 uint32_t creatorid; 213 uint8_t direction; 214 }; 215 216 struct pfctl_kill { 217 struct pfctl_state_cmp cmp; 218 sa_family_t af; 219 int proto; 220 struct pf_rule_addr src; 221 struct pf_rule_addr dst; 222 struct pf_rule_addr rt_addr; 223 char ifname[IFNAMSIZ]; 224 char label[PF_RULE_LABEL_SIZE]; 225 bool kill_match; 226 }; 227 228 struct pfctl_state_peer { 229 uint32_t seqlo; 230 uint32_t seqhi; 231 uint32_t seqdiff; 232 uint8_t state; 233 uint8_t wscale; 234 }; 235 236 struct pfctl_state_key { 237 struct pf_addr addr[2]; 238 uint16_t port[2]; 239 sa_family_t af; 240 uint8_t proto; 241 }; 242 243 struct pfctl_state { 244 TAILQ_ENTRY(pfctl_state) entry; 245 246 uint64_t id; 247 uint32_t creatorid; 248 uint8_t direction; 249 250 struct pfctl_state_peer src; 251 struct pfctl_state_peer dst; 252 253 uint32_t rule; 254 uint32_t anchor; 255 uint32_t nat_rule; 256 struct pf_addr rt_addr; 257 struct pfctl_state_key key[2]; /* addresses stack and wire */ 258 char ifname[IFNAMSIZ]; 259 char orig_ifname[IFNAMSIZ]; 260 uint64_t packets[2]; 261 uint64_t bytes[2]; 262 uint32_t creation; 263 uint32_t expire; 264 uint32_t pfsync_time; 265 uint8_t state_flags; 266 uint32_t sync_flags; 267 }; 268 269 TAILQ_HEAD(pfctl_statelist, pfctl_state); 270 struct pfctl_states { 271 struct pfctl_statelist states; 272 size_t count; 273 }; 274 275 enum pfctl_syncookies_mode { 276 PFCTL_SYNCOOKIES_NEVER, 277 PFCTL_SYNCOOKIES_ALWAYS, 278 PFCTL_SYNCOOKIES_ADAPTIVE 279 }; 280 extern const char* PFCTL_SYNCOOKIES_MODE_NAMES[]; 281 282 struct pfctl_syncookies { 283 enum pfctl_syncookies_mode mode; 284 uint8_t highwater; /* Percent */ 285 uint8_t lowwater; /* Percent */ 286 }; 287 288 struct pfctl_status* pfctl_get_status(int dev); 289 void pfctl_free_status(struct pfctl_status *status); 290 291 int pfctl_get_rule(int dev, uint32_t nr, uint32_t ticket, 292 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 293 char *anchor_call); 294 int pfctl_get_clear_rule(int dev, uint32_t nr, uint32_t ticket, 295 const char *anchor, uint32_t ruleset, struct pfctl_rule *rule, 296 char *anchor_call, bool clear); 297 int pfctl_add_rule(int dev, const struct pfctl_rule *r, 298 const char *anchor, const char *anchor_call, uint32_t ticket, 299 uint32_t pool_ticket); 300 int pfctl_set_keepcounters(int dev, bool keep); 301 int pfctl_get_states(int dev, struct pfctl_states *states); 302 void pfctl_free_states(struct pfctl_states *states); 303 int pfctl_clear_states(int dev, const struct pfctl_kill *kill, 304 unsigned int *killed); 305 int pfctl_kill_states(int dev, const struct pfctl_kill *kill, 306 unsigned int *killed); 307 int pfctl_set_syncookies(int dev, const struct pfctl_syncookies *s); 308 int pfctl_get_syncookies(int dev, struct pfctl_syncookies *s); 309 310 #endif 311