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