1 /* $OpenBSD: pfctl_parser.h,v 1.117 2020/07/21 14:10:51 henning 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 56 #define PF_TH_ALL 0xFF 57 58 #define PF_NAT_PROXY_PORT_LOW 50001 59 #define PF_NAT_PROXY_PORT_HIGH 65535 60 61 #define PF_OPTIMIZE_BASIC 0x0001 62 #define PF_OPTIMIZE_PROFILE 0x0002 63 64 #define FCNT_NAMES { \ 65 "searches", \ 66 "inserts", \ 67 "removals", \ 68 NULL \ 69 } 70 71 struct pfr_buffer; /* forward definition */ 72 73 74 struct pfctl { 75 int dev; 76 int opts; 77 int optimize; 78 int asd; /* anchor stack depth */ 79 int bn; /* brace number */ 80 int brace; 81 int tdirty; /* kernel dirty */ 82 #define PFCTL_ANCHOR_STACK_DEPTH 64 83 struct pf_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH]; 84 struct pfioc_queue *pqueue; 85 struct pfr_buffer *trans; 86 struct pf_anchor *anchor, *alast; 87 const char *ruleset; 88 89 /* 'set foo' options */ 90 u_int32_t timeout[PFTM_MAX]; 91 u_int32_t limit[PF_LIMIT_MAX]; 92 u_int32_t debug; 93 u_int32_t hostid; 94 u_int32_t reassemble; 95 u_int8_t syncookies; 96 u_int8_t syncookieswat[2]; /* lowat, hiwat */ 97 char *ifname; 98 99 u_int8_t timeout_set[PFTM_MAX]; 100 u_int8_t limit_set[PF_LIMIT_MAX]; 101 u_int8_t debug_set; 102 u_int8_t hostid_set; 103 u_int8_t ifname_set; 104 u_int8_t reass_set; 105 u_int8_t syncookies_set; 106 u_int8_t syncookieswat_set; 107 }; 108 109 struct node_if { 110 char ifname[IFNAMSIZ]; 111 u_int8_t not; 112 u_int8_t dynamic; /* antispoof */ 113 u_int8_t use_rdomain; 114 u_int ifa_flags; 115 int rdomain; 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 u_int16_t weight; /* load balancing weight */ 128 char *ifname; 129 u_int ifa_flags; 130 struct node_host *next; 131 struct node_host *tail; 132 }; 133 void freehostlist(struct node_host *); 134 135 struct node_os { 136 char *os; 137 pf_osfp_t fingerprint; 138 struct node_os *next; 139 struct node_os *tail; 140 }; 141 142 struct node_queue_bw { 143 u_int32_t bw_absolute; 144 u_int16_t bw_percent; 145 }; 146 147 struct node_hfsc_sc { 148 struct node_queue_bw m1; /* slope of 1st segment; bps */ 149 u_int d; /* x-projection of m1; msec */ 150 struct node_queue_bw m2; /* slope of 2nd segment; bps */ 151 u_int8_t used; 152 }; 153 154 struct node_hfsc_opts { 155 struct node_hfsc_sc realtime; 156 struct node_hfsc_sc linkshare; 157 struct node_hfsc_sc upperlimit; 158 int flags; 159 }; 160 161 struct node_queue_opt { 162 int qtype; 163 union { 164 struct priq_opts priq_opts; 165 struct node_hfsc_opts hfsc_opts; 166 } data; 167 }; 168 169 SIMPLEQ_HEAD(node_tinithead, node_tinit); 170 struct node_tinit { /* table initializer */ 171 SIMPLEQ_ENTRY(node_tinit) entries; 172 struct node_host *host; 173 char *file; 174 }; 175 176 177 /* optimizer created tables */ 178 struct pf_opt_tbl { 179 char pt_name[PF_TABLE_NAME_SIZE]; 180 int pt_rulecount; 181 int pt_generated; 182 u_int32_t pt_flags; 183 u_int32_t pt_refcnt; 184 struct node_tinithead pt_nodes; 185 struct pfr_buffer *pt_buf; 186 }; 187 188 /* optimizer pf_rule container */ 189 struct pf_opt_rule { 190 struct pf_rule por_rule; 191 struct pf_opt_tbl *por_src_tbl; 192 struct pf_opt_tbl *por_dst_tbl; 193 u_int64_t por_profile_count; 194 TAILQ_ENTRY(pf_opt_rule) por_entry; 195 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT]; 196 }; 197 198 TAILQ_HEAD(pf_opt_queue, pf_opt_rule); 199 200 extern TAILQ_HEAD(pf_qihead, pfctl_qsitem) qspecs, rootqs; 201 struct pfctl_qsitem { 202 TAILQ_ENTRY(pfctl_qsitem) entries; 203 struct pf_queuespec qs; 204 struct pf_qihead children; 205 int matches; 206 }; 207 208 struct pfctl_watermarks { 209 u_int32_t hi; 210 u_int32_t lo; 211 }; 212 213 void copy_satopfaddr(struct pf_addr *, struct sockaddr *); 214 215 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *); 216 int pfctl_optimize_ruleset(struct pfctl *, struct pf_ruleset *); 217 int pf_opt_create_table(struct pfctl *, struct pf_opt_tbl *); 218 int add_opt_table(struct pfctl *, struct pf_opt_tbl **, sa_family_t, 219 struct pf_rule_addr *, char *); 220 221 void pfctl_add_rule(struct pfctl *, struct pf_rule *); 222 223 int pfctl_set_timeout(struct pfctl *, const char *, int, int); 224 int pfctl_set_reassembly(struct pfctl *, int, int); 225 int pfctl_set_syncookies(struct pfctl *, u_int8_t, 226 struct pfctl_watermarks *); 227 int pfctl_set_optimization(struct pfctl *, const char *); 228 int pfctl_set_limit(struct pfctl *, const char *, unsigned int); 229 int pfctl_set_logif(struct pfctl *, char *); 230 void pfctl_set_hostid(struct pfctl *, u_int32_t); 231 int pfctl_set_debug(struct pfctl *, char *); 232 int pfctl_set_interface_flags(struct pfctl *, char *, int, int); 233 234 int parse_config(char *, struct pfctl *); 235 int parse_flags(char *); 236 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *); 237 238 int pfctl_load_queues(struct pfctl *); 239 int pfctl_add_queue(struct pfctl *, struct pf_queuespec *); 240 struct pfctl_qsitem * pfctl_find_queue(char *, struct pf_qihead *); 241 242 void print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int, int); 243 void print_src_node(struct pf_src_node *, int); 244 void print_rule(struct pf_rule *, const char *, int); 245 void print_tabledef(const char *, int, int, struct node_tinithead *); 246 void print_status(struct pf_status *, struct pfctl_watermarks *, int); 247 void print_queuespec(struct pf_queuespec *); 248 249 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *, 250 u_int32_t); 251 252 void pfctl_clear_fingerprints(int, int); 253 int pfctl_file_fingerprints(int, int, const char *); 254 pf_osfp_t pfctl_get_fingerprint(const char *); 255 int pfctl_load_fingerprints(int, int); 256 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t); 257 void pfctl_show_fingerprints(int); 258 259 struct icmptypeent { 260 const char *name; 261 u_int8_t type; 262 }; 263 264 struct icmpcodeent { 265 const char *name; 266 u_int8_t type; 267 u_int8_t code; 268 }; 269 270 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t); 271 const struct icmptypeent *geticmptypebyname(char *, u_int8_t); 272 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t); 273 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t); 274 275 int string_to_loglevel(const char *); 276 const char *loglevel_to_string(int); 277 278 struct pf_timeout { 279 const char *name; 280 int timeout; 281 }; 282 283 extern const struct pf_timeout pf_timeouts[]; 284 285 void set_ipmask(struct node_host *, int); 286 int check_netmask(struct node_host *, sa_family_t); 287 int unmask(struct pf_addr *); 288 struct node_host *gen_dynnode(struct node_host *, sa_family_t); 289 void ifa_load(void); 290 unsigned int ifa_nametoindex(const char *); 291 char *ifa_indextoname(unsigned int, char *); 292 struct node_host *ifa_exists(const char *); 293 struct node_host *ifa_lookup(const char *, int); 294 struct node_host *host(const char *, int); 295 296 int append_addr(struct pfr_buffer *, char *, int, int); 297 int append_addr_host(struct pfr_buffer *, 298 struct node_host *, int, int); 299 300 #endif /* _PFCTL_PARSER_H_ */ 301