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 brace; 86 int tdirty; /* kernel dirty */ 87 #define PFCTL_ANCHOR_STACK_DEPTH 64 88 struct pfctl_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH]; 89 struct pfioc_pooladdr paddr; 90 struct pfioc_altq *paltq; 91 struct pfioc_queue *pqueue; 92 struct pfr_buffer *trans; 93 struct pfctl_anchor *anchor, *alast; 94 const char *ruleset; 95 96 /* 'set foo' options */ 97 u_int32_t timeout[PFTM_MAX]; 98 u_int32_t limit[PF_LIMIT_MAX]; 99 u_int32_t debug; 100 u_int32_t hostid; 101 char *ifname; 102 bool keep_counters; 103 u_int8_t syncookies; 104 u_int8_t syncookieswat[2]; /* lowat, highwat, in % */ 105 u_int8_t syncookieswat_set; 106 107 u_int8_t timeout_set[PFTM_MAX]; 108 u_int8_t limit_set[PF_LIMIT_MAX]; 109 u_int8_t debug_set; 110 u_int8_t hostid_set; 111 u_int8_t ifname_set; 112 }; 113 114 struct node_if { 115 char ifname[IFNAMSIZ]; 116 u_int8_t not; 117 u_int8_t dynamic; /* antispoof */ 118 u_int ifa_flags; 119 struct node_if *next; 120 struct node_if *tail; 121 }; 122 123 struct node_host { 124 struct pf_addr_wrap addr; 125 struct pf_addr bcast; 126 struct pf_addr peer; 127 sa_family_t af; 128 u_int8_t not; 129 u_int32_t ifindex; /* link-local IPv6 addrs */ 130 char *ifname; 131 u_int ifa_flags; 132 struct node_host *next; 133 struct node_host *tail; 134 }; 135 136 struct node_os { 137 char *os; 138 pf_osfp_t fingerprint; 139 struct node_os *next; 140 struct node_os *tail; 141 }; 142 143 struct node_queue_bw { 144 u_int64_t bw_absolute; 145 u_int16_t bw_percent; 146 }; 147 148 struct node_hfsc_sc { 149 struct node_queue_bw m1; /* slope of 1st segment; bps */ 150 u_int d; /* x-projection of m1; msec */ 151 struct node_queue_bw m2; /* slope of 2nd segment; bps */ 152 u_int8_t used; 153 }; 154 155 struct node_hfsc_opts { 156 struct node_hfsc_sc realtime; 157 struct node_hfsc_sc linkshare; 158 struct node_hfsc_sc upperlimit; 159 int flags; 160 }; 161 162 struct node_fairq_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_fairq_opts { 170 struct node_fairq_sc linkshare; 171 struct node_queue_bw hogs_bw; 172 u_int nbuckets; 173 int flags; 174 }; 175 176 struct node_queue_opt { 177 int qtype; 178 union { 179 struct cbq_opts cbq_opts; 180 struct codel_opts codel_opts; 181 struct priq_opts priq_opts; 182 struct node_hfsc_opts hfsc_opts; 183 struct node_fairq_opts fairq_opts; 184 } data; 185 }; 186 187 #define QPRI_BITSET_SIZE 256 188 BITSET_DEFINE(qpri_bitset, QPRI_BITSET_SIZE); 189 LIST_HEAD(gen_sc, segment); 190 191 struct pfctl_altq { 192 struct pf_altq pa; 193 struct { 194 STAILQ_ENTRY(pfctl_altq) link; 195 u_int64_t bwsum; 196 struct qpri_bitset qpris; 197 int children; 198 int root_classes; 199 int default_classes; 200 struct gen_sc lssc; 201 struct gen_sc rtsc; 202 } meta; 203 }; 204 205 struct pfctl_watermarks { 206 uint32_t hi; 207 uint32_t lo; 208 }; 209 210 #ifdef __FreeBSD__ 211 /* 212 * XXX 213 * Absolutely this is not correct location to define this. 214 * Should we use an another sperate header file? 215 */ 216 #define SIMPLEQ_HEAD STAILQ_HEAD 217 #define SIMPLEQ_HEAD_INITIALIZER STAILQ_HEAD_INITIALIZER 218 #define SIMPLEQ_ENTRY STAILQ_ENTRY 219 #define SIMPLEQ_FIRST STAILQ_FIRST 220 #define SIMPLEQ_END(head) NULL 221 #define SIMPLEQ_EMPTY STAILQ_EMPTY 222 #define SIMPLEQ_NEXT STAILQ_NEXT 223 /*#define SIMPLEQ_FOREACH STAILQ_FOREACH*/ 224 #define SIMPLEQ_FOREACH(var, head, field) \ 225 for((var) = SIMPLEQ_FIRST(head); \ 226 (var) != SIMPLEQ_END(head); \ 227 (var) = SIMPLEQ_NEXT(var, field)) 228 #define SIMPLEQ_INIT STAILQ_INIT 229 #define SIMPLEQ_INSERT_HEAD STAILQ_INSERT_HEAD 230 #define SIMPLEQ_INSERT_TAIL STAILQ_INSERT_TAIL 231 #define SIMPLEQ_INSERT_AFTER STAILQ_INSERT_AFTER 232 #define SIMPLEQ_REMOVE_HEAD STAILQ_REMOVE_HEAD 233 #endif 234 SIMPLEQ_HEAD(node_tinithead, node_tinit); 235 struct node_tinit { /* table initializer */ 236 SIMPLEQ_ENTRY(node_tinit) entries; 237 struct node_host *host; 238 char *file; 239 }; 240 241 242 /* optimizer created tables */ 243 struct pf_opt_tbl { 244 char pt_name[PF_TABLE_NAME_SIZE]; 245 int pt_rulecount; 246 int pt_generated; 247 struct node_tinithead pt_nodes; 248 struct pfr_buffer *pt_buf; 249 }; 250 #define PF_OPT_TABLE_PREFIX "__automatic_" 251 252 /* optimizer pf_rule container */ 253 struct pf_opt_rule { 254 struct pfctl_rule por_rule; 255 struct pf_opt_tbl *por_src_tbl; 256 struct pf_opt_tbl *por_dst_tbl; 257 u_int64_t por_profile_count; 258 TAILQ_ENTRY(pf_opt_rule) por_entry; 259 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT]; 260 }; 261 262 TAILQ_HEAD(pf_opt_queue, pf_opt_rule); 263 264 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *); 265 int pfctl_optimize_ruleset(struct pfctl *, struct pfctl_ruleset *); 266 267 int pfctl_append_rule(struct pfctl *, struct pfctl_rule *, const char *); 268 int pfctl_add_altq(struct pfctl *, struct pf_altq *); 269 int pfctl_add_pool(struct pfctl *, struct pfctl_pool *, sa_family_t); 270 void pfctl_move_pool(struct pfctl_pool *, struct pfctl_pool *); 271 void pfctl_clear_pool(struct pfctl_pool *); 272 273 int pfctl_set_timeout(struct pfctl *, const char *, int, int); 274 int pfctl_set_optimization(struct pfctl *, const char *); 275 int pfctl_set_limit(struct pfctl *, const char *, unsigned int); 276 int pfctl_set_logif(struct pfctl *, char *); 277 int pfctl_set_hostid(struct pfctl *, u_int32_t); 278 int pfctl_set_debug(struct pfctl *, char *); 279 int pfctl_set_interface_flags(struct pfctl *, char *, int, int); 280 int pfctl_cfg_syncookies(struct pfctl *, uint8_t, struct pfctl_watermarks *); 281 282 int parse_config(char *, struct pfctl *); 283 int parse_flags(char *); 284 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *); 285 286 void print_pool(struct pfctl_pool *, u_int16_t, u_int16_t, sa_family_t, int); 287 void print_src_node(struct pf_src_node *, int); 288 void print_rule(struct pfctl_rule *, const char *, int, int); 289 void print_tabledef(const char *, int, int, struct node_tinithead *); 290 void print_status(struct pfctl_status *, struct pfctl_syncookies *, int); 291 void print_running(struct pfctl_status *); 292 293 int eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 294 struct node_queue_opt *); 295 int eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 296 struct node_queue_opt *); 297 298 void print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *, 299 struct node_queue_opt *); 300 void print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *, 301 int, struct node_queue_opt *); 302 303 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *, 304 u_int32_t); 305 306 void pfctl_clear_fingerprints(int, int); 307 int pfctl_file_fingerprints(int, int, const char *); 308 pf_osfp_t pfctl_get_fingerprint(const char *); 309 int pfctl_load_fingerprints(int, int); 310 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t); 311 void pfctl_show_fingerprints(int); 312 313 314 struct icmptypeent { 315 const char *name; 316 u_int8_t type; 317 }; 318 319 struct icmpcodeent { 320 const char *name; 321 u_int8_t type; 322 u_int8_t code; 323 }; 324 325 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t); 326 const struct icmptypeent *geticmptypebyname(char *, u_int8_t); 327 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t); 328 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t); 329 330 struct pf_timeout { 331 const char *name; 332 int timeout; 333 }; 334 335 #define PFCTL_FLAG_FILTER 0x02 336 #define PFCTL_FLAG_NAT 0x04 337 #define PFCTL_FLAG_OPTION 0x08 338 #define PFCTL_FLAG_ALTQ 0x10 339 #define PFCTL_FLAG_TABLE 0x20 340 341 extern const struct pf_timeout pf_timeouts[]; 342 343 void set_ipmask(struct node_host *, u_int8_t); 344 int check_netmask(struct node_host *, sa_family_t); 345 int unmask(struct pf_addr *, sa_family_t); 346 void ifa_load(void); 347 int get_query_socket(void); 348 struct node_host *ifa_exists(char *); 349 struct node_host *ifa_grouplookup(char *ifa_name, int flags); 350 struct node_host *ifa_lookup(char *, int); 351 struct node_host *host(const char *); 352 353 int append_addr(struct pfr_buffer *, char *, int); 354 int append_addr_host(struct pfr_buffer *, 355 struct node_host *, int, int); 356 357 #endif /* _PFCTL_PARSER_H_ */ 358