1 /* $OpenBSD: pfctl_parser.h,v 1.119 2024/01/15 07:23:32 sashan Exp $ */ 2 3 /* 4 * Copyright (c) 2001 Daniel Hartmeier 5 * Copyright (c) 2002 - 2013 Henning Brauer <henning@openbsd.org> 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * - Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * - Redistributions in binary form must reproduce the above 15 * copyright notice, this list of conditions and the following 16 * disclaimer in the documentation and/or other materials provided 17 * with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 22 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 23 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 25 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 27 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 29 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 * 32 */ 33 34 #ifndef _PFCTL_PARSER_H_ 35 #define _PFCTL_PARSER_H_ 36 37 #define PF_OSFP_FILE "/etc/pf.os" 38 39 #define PF_OPT_DISABLE 0x00001 40 #define PF_OPT_ENABLE 0x00002 41 #define PF_OPT_VERBOSE 0x00004 42 #define PF_OPT_NOACTION 0x00008 43 #define PF_OPT_QUIET 0x00010 44 #define PF_OPT_CLRRULECTRS 0x00020 45 #define PF_OPT_USEDNS 0x00040 46 #define PF_OPT_VERBOSE2 0x00080 47 #define PF_OPT_DUMMYACTION 0x00100 48 #define PF_OPT_DEBUG 0x00200 49 #define PF_OPT_SHOWALL 0x00400 50 #define PF_OPT_OPTIMIZE 0x00800 51 #define PF_OPT_NODNS 0x01000 52 #define PF_OPT_RECURSE 0x04000 53 #define PF_OPT_PORTNAMES 0x08000 54 #define PF_OPT_IGNFAIL 0x10000 55 #define PF_OPT_CALLSHOW 0x20000 56 57 #define PF_TH_ALL 0xFF 58 59 #define PF_NAT_PROXY_PORT_LOW 50001 60 #define PF_NAT_PROXY_PORT_HIGH 65535 61 62 #define PF_OPTIMIZE_BASIC 0x0001 63 #define PF_OPTIMIZE_PROFILE 0x0002 64 65 #define FCNT_NAMES { \ 66 "searches", \ 67 "inserts", \ 68 "removals", \ 69 NULL \ 70 } 71 72 struct pfr_buffer; /* forward definition */ 73 74 75 struct pfctl { 76 int dev; 77 int opts; 78 int optimize; 79 int asd; /* anchor stack depth */ 80 int bn; /* brace number */ 81 int brace; 82 int tdirty; /* kernel dirty */ 83 #define PFCTL_ANCHOR_STACK_DEPTH 64 84 struct pf_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH]; 85 struct pfioc_queue *pqueue; 86 struct pfr_buffer *trans; 87 struct pf_anchor *anchor, *alast; 88 const char *ruleset; 89 90 /* 'set foo' options */ 91 u_int32_t timeout[PFTM_MAX]; 92 u_int32_t limit[PF_LIMIT_MAX]; 93 u_int32_t debug; 94 u_int32_t hostid; 95 u_int32_t reassemble; 96 u_int8_t syncookies; 97 u_int8_t syncookieswat[2]; /* lowat, hiwat */ 98 char *ifname; 99 100 u_int8_t timeout_set[PFTM_MAX]; 101 u_int8_t limit_set[PF_LIMIT_MAX]; 102 u_int8_t debug_set; 103 u_int8_t hostid_set; 104 u_int8_t ifname_set; 105 u_int8_t reass_set; 106 u_int8_t syncookies_set; 107 u_int8_t syncookieswat_set; 108 }; 109 110 struct node_if { 111 char ifname[IFNAMSIZ]; 112 u_int8_t not; 113 u_int8_t dynamic; /* antispoof */ 114 u_int8_t use_rdomain; 115 u_int ifa_flags; 116 int rdomain; 117 struct node_if *next; 118 struct node_if *tail; 119 }; 120 121 struct node_host { 122 struct pf_addr_wrap addr; 123 struct pf_addr bcast; 124 struct pf_addr peer; 125 sa_family_t af; 126 u_int8_t not; 127 u_int32_t ifindex; /* link-local IPv6 addrs */ 128 u_int16_t weight; /* load balancing weight */ 129 char *ifname; 130 u_int ifa_flags; 131 struct node_host *next; 132 struct node_host *tail; 133 }; 134 void freehostlist(struct node_host *); 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_int32_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_queue_opt { 163 int qtype; 164 union { 165 struct priq_opts priq_opts; 166 struct node_hfsc_opts hfsc_opts; 167 } data; 168 }; 169 170 SIMPLEQ_HEAD(node_tinithead, node_tinit); 171 struct node_tinit { /* table initializer */ 172 SIMPLEQ_ENTRY(node_tinit) entries; 173 struct node_host *host; 174 char *file; 175 }; 176 177 178 /* optimizer created tables */ 179 struct pf_opt_tbl { 180 char pt_name[PF_TABLE_NAME_SIZE]; 181 int pt_rulecount; 182 int pt_generated; 183 u_int32_t pt_flags; 184 u_int32_t pt_refcnt; 185 struct node_tinithead pt_nodes; 186 struct pfr_buffer *pt_buf; 187 }; 188 189 /* optimizer pf_rule container */ 190 struct pf_opt_rule { 191 struct pf_rule por_rule; 192 struct pf_opt_tbl *por_src_tbl; 193 struct pf_opt_tbl *por_dst_tbl; 194 u_int64_t por_profile_count; 195 TAILQ_ENTRY(pf_opt_rule) por_entry; 196 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT]; 197 }; 198 199 TAILQ_HEAD(pf_opt_queue, pf_opt_rule); 200 201 extern TAILQ_HEAD(pf_qihead, pfctl_qsitem) qspecs, rootqs; 202 struct pfctl_qsitem { 203 TAILQ_ENTRY(pfctl_qsitem) entries; 204 struct pf_queuespec qs; 205 struct pf_qihead children; 206 int matches; 207 }; 208 209 struct pfctl_watermarks { 210 u_int32_t hi; 211 u_int32_t lo; 212 }; 213 214 void copy_satopfaddr(struct pf_addr *, struct sockaddr *); 215 216 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *); 217 int pfctl_optimize_ruleset(struct pfctl *, struct pf_ruleset *); 218 int pf_opt_create_table(struct pfctl *, struct pf_opt_tbl *); 219 int add_opt_table(struct pfctl *, struct pf_opt_tbl **, sa_family_t, 220 struct pf_rule_addr *, char *); 221 222 void pfctl_add_rule(struct pfctl *, struct pf_rule *); 223 224 int pfctl_set_timeout(struct pfctl *, const char *, int, int); 225 int pfctl_set_reassembly(struct pfctl *, int, int); 226 int pfctl_set_syncookies(struct pfctl *, u_int8_t, 227 struct pfctl_watermarks *); 228 int pfctl_set_optimization(struct pfctl *, const char *); 229 int pfctl_set_limit(struct pfctl *, const char *, unsigned int); 230 int pfctl_set_logif(struct pfctl *, char *); 231 void pfctl_set_hostid(struct pfctl *, u_int32_t); 232 int pfctl_set_debug(struct pfctl *, char *); 233 int pfctl_set_interface_flags(struct pfctl *, char *, int, int); 234 235 int parse_config(char *, struct pfctl *); 236 int parse_flags(char *); 237 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *); 238 239 int pfctl_load_queues(struct pfctl *); 240 int pfctl_add_queue(struct pfctl *, struct pf_queuespec *); 241 struct pfctl_qsitem * pfctl_find_queue(char *, struct pf_qihead *); 242 243 void print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int, int); 244 void print_src_node(struct pf_src_node *, int); 245 void print_rule(struct pf_rule *, const char *, int); 246 void print_tabledef(const char *, int, int, struct node_tinithead *); 247 void print_status(struct pf_status *, struct pfctl_watermarks *, int); 248 void print_queuespec(struct pf_queuespec *); 249 250 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *, 251 u_int32_t); 252 void pfctl_expand_label_nr(struct pf_rule *, unsigned int); 253 254 void pfctl_clear_fingerprints(int, int); 255 int pfctl_file_fingerprints(int, int, const char *); 256 pf_osfp_t pfctl_get_fingerprint(const char *); 257 int pfctl_load_fingerprints(int, int); 258 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t); 259 void pfctl_show_fingerprints(int); 260 261 struct icmptypeent { 262 const char *name; 263 u_int8_t type; 264 }; 265 266 struct icmpcodeent { 267 const char *name; 268 u_int8_t type; 269 u_int8_t code; 270 }; 271 272 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t); 273 const struct icmptypeent *geticmptypebyname(char *, u_int8_t); 274 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t); 275 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t); 276 277 int string_to_loglevel(const char *); 278 const char *loglevel_to_string(int); 279 280 struct pf_timeout { 281 const char *name; 282 int timeout; 283 }; 284 285 extern const struct pf_timeout pf_timeouts[]; 286 287 void set_ipmask(struct node_host *, int); 288 int check_netmask(struct node_host *, sa_family_t); 289 int unmask(struct pf_addr *); 290 struct node_host *gen_dynnode(struct node_host *, sa_family_t); 291 void ifa_load(void); 292 unsigned int ifa_nametoindex(const char *); 293 char *ifa_indextoname(unsigned int, char *); 294 struct node_host *ifa_exists(const char *); 295 struct node_host *ifa_lookup(const char *, int); 296 struct node_host *host(const char *, int); 297 298 int append_addr(struct pfr_buffer *, char *, int, int); 299 int append_addr_host(struct pfr_buffer *, 300 struct node_host *, int, int); 301 302 #endif /* _PFCTL_PARSER_H_ */ 303