1 /* $OpenBSD: pfctl_parser.h,v 1.86 2006/10/31 23:46:25 mcbride Exp $ */ 2 3 /*- 4 * SPDX-License-Identifier: BSD-2-Clause 5 * 6 * Copyright (c) 2001 Daniel Hartmeier 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * - Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * - Redistributions in binary form must reproduce the above 16 * copyright notice, this list of conditions and the following 17 * disclaimer in the documentation and/or other materials provided 18 * with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 24 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 30 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 * 33 * $FreeBSD$ 34 */ 35 36 #ifndef _PFCTL_PARSER_H_ 37 #define _PFCTL_PARSER_H_ 38 39 #include <libpfctl.h> 40 41 #define PF_OSFP_FILE "/etc/pf.os" 42 43 #define PF_OPT_DISABLE 0x0001 44 #define PF_OPT_ENABLE 0x0002 45 #define PF_OPT_VERBOSE 0x0004 46 #define PF_OPT_NOACTION 0x0008 47 #define PF_OPT_QUIET 0x0010 48 #define PF_OPT_CLRRULECTRS 0x0020 49 #define PF_OPT_USEDNS 0x0040 50 #define PF_OPT_VERBOSE2 0x0080 51 #define PF_OPT_DUMMYACTION 0x0100 52 #define PF_OPT_DEBUG 0x0200 53 #define PF_OPT_SHOWALL 0x0400 54 #define PF_OPT_OPTIMIZE 0x0800 55 #define PF_OPT_NUMERIC 0x1000 56 #define PF_OPT_MERGE 0x2000 57 #define PF_OPT_RECURSE 0x4000 58 #define PF_OPT_KILLMATCH 0x8000 59 60 #define PF_TH_ALL 0xFF 61 62 #define PF_NAT_PROXY_PORT_LOW 50001 63 #define PF_NAT_PROXY_PORT_HIGH 65535 64 65 #define PF_OPTIMIZE_BASIC 0x0001 66 #define PF_OPTIMIZE_PROFILE 0x0002 67 68 #define FCNT_NAMES { \ 69 "searches", \ 70 "inserts", \ 71 "removals", \ 72 NULL \ 73 } 74 75 struct pfr_buffer; /* forward definition */ 76 77 78 struct pfctl { 79 int dev; 80 int opts; 81 int optimize; 82 int loadopt; 83 int asd; /* anchor stack depth */ 84 int bn; /* brace number */ 85 int tdirty; /* kernel dirty */ 86 #define PFCTL_ANCHOR_STACK_DEPTH 64 87 struct pfctl_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH]; 88 struct pfioc_pooladdr paddr; 89 struct pfioc_altq *paltq; 90 struct pfioc_queue *pqueue; 91 struct pfr_buffer *trans; 92 struct pfctl_anchor *anchor, *alast; 93 int eth_nr; 94 struct pfctl_eth_anchor *eanchor, *ealast; 95 struct pfctl_eth_anchor *eastack[PFCTL_ANCHOR_STACK_DEPTH]; 96 u_int32_t eth_ticket; 97 const char *ruleset; 98 99 /* 'set foo' options */ 100 u_int32_t timeout[PFTM_MAX]; 101 u_int32_t limit[PF_LIMIT_MAX]; 102 u_int32_t debug; 103 u_int32_t hostid; 104 u_int32_t reassemble; 105 char *ifname; 106 bool keep_counters; 107 u_int8_t syncookies; 108 u_int8_t syncookieswat[2]; /* lowat, highwat, in % */ 109 u_int8_t syncookieswat_set; 110 111 u_int8_t timeout_set[PFTM_MAX]; 112 u_int8_t limit_set[PF_LIMIT_MAX]; 113 u_int8_t debug_set; 114 u_int8_t hostid_set; 115 u_int8_t ifname_set; 116 u_int8_t reass_set; 117 }; 118 119 struct node_if { 120 char ifname[IFNAMSIZ]; 121 u_int8_t not; 122 u_int8_t dynamic; /* antispoof */ 123 u_int ifa_flags; 124 struct node_if *next; 125 struct node_if *tail; 126 }; 127 128 struct node_host { 129 struct pf_addr_wrap addr; 130 struct pf_addr bcast; 131 struct pf_addr peer; 132 sa_family_t af; 133 u_int8_t not; 134 u_int32_t ifindex; /* link-local IPv6 addrs */ 135 char *ifname; 136 u_int ifa_flags; 137 struct node_host *next; 138 struct node_host *tail; 139 }; 140 141 struct node_mac { 142 u_int8_t mac[ETHER_ADDR_LEN]; 143 u_int8_t mask[ETHER_ADDR_LEN]; 144 bool neg; 145 bool isset; 146 struct node_mac *next; 147 struct node_mac *tail; 148 }; 149 150 struct node_os { 151 char *os; 152 pf_osfp_t fingerprint; 153 struct node_os *next; 154 struct node_os *tail; 155 }; 156 157 struct node_queue_bw { 158 u_int64_t bw_absolute; 159 u_int16_t bw_percent; 160 }; 161 162 struct node_hfsc_sc { 163 struct node_queue_bw m1; /* slope of 1st segment; bps */ 164 u_int d; /* x-projection of m1; msec */ 165 struct node_queue_bw m2; /* slope of 2nd segment; bps */ 166 u_int8_t used; 167 }; 168 169 struct node_hfsc_opts { 170 struct node_hfsc_sc realtime; 171 struct node_hfsc_sc linkshare; 172 struct node_hfsc_sc upperlimit; 173 int flags; 174 }; 175 176 struct node_fairq_sc { 177 struct node_queue_bw m1; /* slope of 1st segment; bps */ 178 u_int d; /* x-projection of m1; msec */ 179 struct node_queue_bw m2; /* slope of 2nd segment; bps */ 180 u_int8_t used; 181 }; 182 183 struct node_fairq_opts { 184 struct node_fairq_sc linkshare; 185 struct node_queue_bw hogs_bw; 186 u_int nbuckets; 187 int flags; 188 }; 189 190 struct node_queue_opt { 191 int qtype; 192 union { 193 struct cbq_opts cbq_opts; 194 struct codel_opts codel_opts; 195 struct priq_opts priq_opts; 196 struct node_hfsc_opts hfsc_opts; 197 struct node_fairq_opts fairq_opts; 198 } data; 199 }; 200 201 #define QPRI_BITSET_SIZE 256 202 __BITSET_DEFINE(qpri_bitset, QPRI_BITSET_SIZE); 203 LIST_HEAD(gen_sc, segment); 204 205 struct pfctl_altq { 206 struct pf_altq pa; 207 struct { 208 STAILQ_ENTRY(pfctl_altq) link; 209 u_int64_t bwsum; 210 struct qpri_bitset qpris; 211 int children; 212 int root_classes; 213 int default_classes; 214 struct gen_sc lssc; 215 struct gen_sc rtsc; 216 } meta; 217 }; 218 219 struct pfctl_watermarks { 220 uint32_t hi; 221 uint32_t lo; 222 }; 223 224 #ifdef __FreeBSD__ 225 /* 226 * XXX 227 * Absolutely this is not correct location to define this. 228 * Should we use an another sperate header file? 229 */ 230 #define SIMPLEQ_HEAD STAILQ_HEAD 231 #define SIMPLEQ_HEAD_INITIALIZER STAILQ_HEAD_INITIALIZER 232 #define SIMPLEQ_ENTRY STAILQ_ENTRY 233 #define SIMPLEQ_FIRST STAILQ_FIRST 234 #define SIMPLEQ_END(head) NULL 235 #define SIMPLEQ_EMPTY STAILQ_EMPTY 236 #define SIMPLEQ_NEXT STAILQ_NEXT 237 /*#define SIMPLEQ_FOREACH STAILQ_FOREACH*/ 238 #define SIMPLEQ_FOREACH(var, head, field) \ 239 for((var) = SIMPLEQ_FIRST(head); \ 240 (var) != SIMPLEQ_END(head); \ 241 (var) = SIMPLEQ_NEXT(var, field)) 242 #define SIMPLEQ_INIT STAILQ_INIT 243 #define SIMPLEQ_INSERT_HEAD STAILQ_INSERT_HEAD 244 #define SIMPLEQ_INSERT_TAIL STAILQ_INSERT_TAIL 245 #define SIMPLEQ_INSERT_AFTER STAILQ_INSERT_AFTER 246 #define SIMPLEQ_REMOVE_HEAD STAILQ_REMOVE_HEAD 247 #endif 248 SIMPLEQ_HEAD(node_tinithead, node_tinit); 249 struct node_tinit { /* table initializer */ 250 SIMPLEQ_ENTRY(node_tinit) entries; 251 struct node_host *host; 252 char *file; 253 }; 254 255 256 /* optimizer created tables */ 257 struct pf_opt_tbl { 258 char pt_name[PF_TABLE_NAME_SIZE]; 259 int pt_rulecount; 260 int pt_generated; 261 struct node_tinithead pt_nodes; 262 struct pfr_buffer *pt_buf; 263 }; 264 #define PF_OPT_TABLE_PREFIX "__automatic_" 265 266 /* optimizer pf_rule container */ 267 struct pf_opt_rule { 268 struct pfctl_rule por_rule; 269 struct pf_opt_tbl *por_src_tbl; 270 struct pf_opt_tbl *por_dst_tbl; 271 u_int64_t por_profile_count; 272 TAILQ_ENTRY(pf_opt_rule) por_entry; 273 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT]; 274 }; 275 276 TAILQ_HEAD(pf_opt_queue, pf_opt_rule); 277 278 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *); 279 int pfctl_optimize_ruleset(struct pfctl *, struct pfctl_ruleset *); 280 281 int pfctl_append_rule(struct pfctl *, struct pfctl_rule *, const char *); 282 int pfctl_append_eth_rule(struct pfctl *, struct pfctl_eth_rule *, 283 const char *); 284 int pfctl_add_altq(struct pfctl *, struct pf_altq *); 285 int pfctl_add_pool(struct pfctl *, struct pfctl_pool *, sa_family_t); 286 void pfctl_move_pool(struct pfctl_pool *, struct pfctl_pool *); 287 void pfctl_clear_pool(struct pfctl_pool *); 288 289 int pfctl_set_timeout(struct pfctl *, const char *, int, int); 290 int pfctl_set_reassembly(struct pfctl *, int, int); 291 int pfctl_set_optimization(struct pfctl *, const char *); 292 int pfctl_set_limit(struct pfctl *, const char *, unsigned int); 293 int pfctl_set_logif(struct pfctl *, char *); 294 int pfctl_set_hostid(struct pfctl *, u_int32_t); 295 int pfctl_set_debug(struct pfctl *, char *); 296 int pfctl_set_interface_flags(struct pfctl *, char *, int, int); 297 int pfctl_cfg_syncookies(struct pfctl *, uint8_t, struct pfctl_watermarks *); 298 299 int parse_config(char *, struct pfctl *); 300 int parse_flags(char *); 301 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *); 302 303 void print_pool(struct pfctl_pool *, u_int16_t, u_int16_t, sa_family_t, int); 304 void print_src_node(struct pf_src_node *, int); 305 void print_eth_rule(struct pfctl_eth_rule *, const char *, int); 306 void print_rule(struct pfctl_rule *, const char *, int, int); 307 void print_tabledef(const char *, int, int, struct node_tinithead *); 308 void print_status(struct pfctl_status *, struct pfctl_syncookies *, int); 309 void print_running(struct pfctl_status *); 310 311 int eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 312 struct node_queue_opt *); 313 int eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 314 struct node_queue_opt *); 315 316 void print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *, 317 struct node_queue_opt *); 318 void print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *, 319 int, struct node_queue_opt *); 320 321 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *, 322 u_int32_t); 323 324 void pfctl_clear_fingerprints(int, int); 325 int pfctl_file_fingerprints(int, int, const char *); 326 pf_osfp_t pfctl_get_fingerprint(const char *); 327 int pfctl_load_fingerprints(int, int); 328 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t); 329 void pfctl_show_fingerprints(int); 330 331 332 struct icmptypeent { 333 const char *name; 334 u_int8_t type; 335 }; 336 337 struct icmpcodeent { 338 const char *name; 339 u_int8_t type; 340 u_int8_t code; 341 }; 342 343 const struct icmptypeent *geticmptypebynumber(u_int8_t, sa_family_t); 344 const struct icmptypeent *geticmptypebyname(char *, sa_family_t); 345 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, sa_family_t); 346 const struct icmpcodeent *geticmpcodebyname(u_long, char *, sa_family_t); 347 348 struct pf_timeout { 349 const char *name; 350 int timeout; 351 }; 352 353 #define PFCTL_FLAG_FILTER 0x02 354 #define PFCTL_FLAG_NAT 0x04 355 #define PFCTL_FLAG_OPTION 0x08 356 #define PFCTL_FLAG_ALTQ 0x10 357 #define PFCTL_FLAG_TABLE 0x20 358 #define PFCTL_FLAG_ETH 0x40 359 360 extern const struct pf_timeout pf_timeouts[]; 361 362 void set_ipmask(struct node_host *, u_int8_t); 363 int check_netmask(struct node_host *, sa_family_t); 364 int unmask(struct pf_addr *, sa_family_t); 365 void ifa_load(void); 366 int get_query_socket(void); 367 struct node_host *ifa_exists(char *); 368 struct node_host *ifa_grouplookup(char *ifa_name, int flags); 369 struct node_host *ifa_lookup(char *, int); 370 struct node_host *host(const char *); 371 372 int append_addr(struct pfr_buffer *, char *, int); 373 int append_addr_host(struct pfr_buffer *, 374 struct node_host *, int, int); 375 376 #endif /* _PFCTL_PARSER_H_ */ 377