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