1 /* $OpenBSD: pfctl_parser.h,v 1.99 2011/12/03 12:46:16 mcbride Exp $ */ 2 3 /* 4 * Copyright (c) 2001 Daniel Hartmeier 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * - Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * - Redistributions in binary form must reproduce the above 14 * copyright notice, this list of conditions and the following 15 * disclaimer in the documentation and/or other materials provided 16 * with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 21 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 22 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 26 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 28 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 * 31 */ 32 33 #ifndef _PFCTL_PARSER_H_ 34 #define _PFCTL_PARSER_H_ 35 36 #define PF_OSFP_FILE "/etc/pf.os" 37 38 #define PF_OPT_DISABLE 0x0001 39 #define PF_OPT_ENABLE 0x0002 40 #define PF_OPT_VERBOSE 0x0004 41 #define PF_OPT_NOACTION 0x0008 42 #define PF_OPT_QUIET 0x0010 43 #define PF_OPT_CLRRULECTRS 0x0020 44 #define PF_OPT_USEDNS 0x0040 45 #define PF_OPT_VERBOSE2 0x0080 46 #define PF_OPT_DUMMYACTION 0x0100 47 #define PF_OPT_DEBUG 0x0200 48 #define PF_OPT_SHOWALL 0x0400 49 #define PF_OPT_OPTIMIZE 0x0800 50 #define PF_OPT_RECURSE 0x4000 51 #define PF_OPT_PORTNAMES 0x8000 52 53 #define PF_TH_ALL 0xFF 54 55 #define PF_NAT_PROXY_PORT_LOW 50001 56 #define PF_NAT_PROXY_PORT_HIGH 65535 57 58 #define PF_OPTIMIZE_BASIC 0x0001 59 #define PF_OPTIMIZE_PROFILE 0x0002 60 61 #define FCNT_NAMES { \ 62 "searches", \ 63 "inserts", \ 64 "removals", \ 65 NULL \ 66 } 67 68 struct pfr_buffer; /* forward definition */ 69 70 71 struct pfctl { 72 int dev; 73 int opts; 74 int optimize; 75 int asd; /* anchor stack depth */ 76 int bn; /* brace number */ 77 int brace; 78 int tdirty; /* kernel dirty */ 79 #define PFCTL_ANCHOR_STACK_DEPTH 64 80 struct pf_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH]; 81 struct pfioc_altq *paltq; 82 struct pfioc_queue *pqueue; 83 struct pfr_buffer *trans; 84 struct pf_anchor *anchor, *alast; 85 const char *ruleset; 86 87 /* 'set foo' options */ 88 u_int32_t timeout[PFTM_MAX]; 89 u_int32_t limit[PF_LIMIT_MAX]; 90 u_int32_t debug; 91 u_int32_t hostid; 92 u_int32_t reassemble; 93 char *ifname; 94 95 u_int8_t timeout_set[PFTM_MAX]; 96 u_int8_t limit_set[PF_LIMIT_MAX]; 97 u_int8_t debug_set; 98 u_int8_t hostid_set; 99 u_int8_t ifname_set; 100 u_int8_t reass_set; 101 }; 102 103 struct node_if { 104 char ifname[IFNAMSIZ]; 105 u_int8_t not; 106 u_int8_t dynamic; /* antispoof */ 107 u_int8_t use_rdomain; 108 u_int ifa_flags; 109 int rdomain; 110 struct node_if *next; 111 struct node_if *tail; 112 }; 113 114 struct node_host { 115 struct pf_addr_wrap addr; 116 struct pf_addr bcast; 117 struct pf_addr peer; 118 sa_family_t af; 119 u_int8_t not; 120 u_int32_t ifindex; /* link-local IPv6 addrs */ 121 u_int16_t weight; /* load balancing weight */ 122 char *ifname; 123 u_int ifa_flags; 124 struct node_host *next; 125 struct node_host *tail; 126 }; 127 void freehostlist(struct node_host *); 128 129 struct node_os { 130 char *os; 131 pf_osfp_t fingerprint; 132 struct node_os *next; 133 struct node_os *tail; 134 }; 135 136 struct node_queue_bw { 137 u_int32_t bw_absolute; 138 u_int16_t bw_percent; 139 }; 140 141 struct node_hfsc_sc { 142 struct node_queue_bw m1; /* slope of 1st segment; bps */ 143 u_int d; /* x-projection of m1; msec */ 144 struct node_queue_bw m2; /* slope of 2nd segment; bps */ 145 u_int8_t used; 146 }; 147 148 struct node_hfsc_opts { 149 struct node_hfsc_sc realtime; 150 struct node_hfsc_sc linkshare; 151 struct node_hfsc_sc upperlimit; 152 int flags; 153 }; 154 155 struct node_queue_opt { 156 int qtype; 157 union { 158 struct cbq_opts cbq_opts; 159 struct priq_opts priq_opts; 160 struct node_hfsc_opts hfsc_opts; 161 } data; 162 }; 163 164 SIMPLEQ_HEAD(node_tinithead, node_tinit); 165 struct node_tinit { /* table initializer */ 166 SIMPLEQ_ENTRY(node_tinit) entries; 167 struct node_host *host; 168 char *file; 169 }; 170 171 172 /* optimizer created tables */ 173 struct pf_opt_tbl { 174 char pt_name[PF_TABLE_NAME_SIZE]; 175 int pt_rulecount; 176 int pt_generated; 177 u_int32_t pt_flags; 178 struct node_tinithead pt_nodes; 179 struct pfr_buffer *pt_buf; 180 }; 181 #define PF_OPT_TABLE_PREFIX "__automatic_" 182 183 /* optimizer pf_rule container */ 184 struct pf_opt_rule { 185 struct pf_rule por_rule; 186 struct pf_opt_tbl *por_src_tbl; 187 struct pf_opt_tbl *por_dst_tbl; 188 u_int64_t por_profile_count; 189 TAILQ_ENTRY(pf_opt_rule) por_entry; 190 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT]; 191 }; 192 193 TAILQ_HEAD(pf_opt_queue, pf_opt_rule); 194 195 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *); 196 int pfctl_optimize_ruleset(struct pfctl *, struct pf_ruleset *); 197 int pf_opt_create_table(struct pfctl *, struct pf_opt_tbl *); 198 int add_opt_table(struct pfctl *, struct pf_opt_tbl **, sa_family_t, 199 struct pf_rule_addr *, char *); 200 201 int pfctl_add_rule(struct pfctl *, struct pf_rule *, const char *); 202 int pfctl_add_altq(struct pfctl *, struct pf_altq *); 203 int pfctl_add_pool(struct pfctl *, struct pf_pool *, sa_family_t, int); 204 void pfctl_move_pool(struct pf_pool *, struct pf_pool *); 205 void pfctl_clear_pool(struct pf_pool *); 206 207 int pfctl_set_timeout(struct pfctl *, const char *, int, int); 208 int pfctl_set_reassembly(struct pfctl *, int, int); 209 int pfctl_set_optimization(struct pfctl *, const char *); 210 int pfctl_set_limit(struct pfctl *, const char *, unsigned int); 211 int pfctl_set_logif(struct pfctl *, char *); 212 void pfctl_set_hostid(struct pfctl *, u_int32_t); 213 int pfctl_set_debug(struct pfctl *, char *); 214 int pfctl_set_interface_flags(struct pfctl *, char *, int, int); 215 216 int parse_config(char *, struct pfctl *); 217 int parse_flags(char *); 218 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *); 219 220 void print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int, int); 221 void print_src_node(struct pf_src_node *, int); 222 void print_rule(struct pf_rule *, const char *, int); 223 void print_tabledef(const char *, int, int, struct node_tinithead *); 224 void print_status(struct pf_status *, int); 225 226 int eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 227 struct node_queue_opt *); 228 int eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 229 struct node_queue_opt *); 230 231 void print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *, 232 struct node_queue_opt *); 233 void print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *, 234 int, struct node_queue_opt *); 235 236 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *, 237 u_int32_t); 238 239 void pfctl_clear_fingerprints(int, int); 240 int pfctl_file_fingerprints(int, int, const char *); 241 pf_osfp_t pfctl_get_fingerprint(const char *); 242 int pfctl_load_fingerprints(int, int); 243 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t); 244 void pfctl_show_fingerprints(int); 245 246 247 struct icmptypeent { 248 const char *name; 249 u_int8_t type; 250 }; 251 252 struct icmpcodeent { 253 const char *name; 254 u_int8_t type; 255 u_int8_t code; 256 }; 257 258 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t); 259 const struct icmptypeent *geticmptypebyname(char *, u_int8_t); 260 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t); 261 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t); 262 263 int string_to_loglevel(const char *); 264 const char *loglevel_to_string(int); 265 266 struct pf_timeout { 267 const char *name; 268 int timeout; 269 }; 270 271 extern const struct pf_timeout pf_timeouts[]; 272 273 void set_ipmask(struct node_host *, u_int8_t); 274 int check_netmask(struct node_host *, sa_family_t); 275 int unmask(struct pf_addr *, sa_family_t); 276 void ifa_load(void); 277 struct node_host *ifa_exists(const char *); 278 struct node_host *ifa_lookup(const char *, int); 279 struct node_host *host(const char *); 280 281 int append_addr(struct pfr_buffer *, char *, int); 282 int append_addr_host(struct pfr_buffer *, 283 struct node_host *, int, int); 284 285 #endif /* _PFCTL_PARSER_H_ */ 286