1 /* $OpenBSD: pfctl_parser.h,v 1.88 2009/04/06 12:05:55 henning 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_MERGE 0x2000 51 #define PF_OPT_RECURSE 0x4000 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 loadopt; 76 int asd; /* anchor stack depth */ 77 int bn; /* brace number */ 78 int brace; 79 int tdirty; /* kernel dirty */ 80 #define PFCTL_ANCHOR_STACK_DEPTH 64 81 struct pf_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH]; 82 struct pfioc_pooladdr paddr; 83 struct pfioc_altq *paltq; 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 char *ifname; 96 97 u_int8_t timeout_set[PFTM_MAX]; 98 u_int8_t limit_set[PF_LIMIT_MAX]; 99 u_int8_t debug_set; 100 u_int8_t hostid_set; 101 u_int8_t ifname_set; 102 u_int8_t reass_set; 103 }; 104 105 struct node_if { 106 char ifname[IFNAMSIZ]; 107 u_int8_t not; 108 u_int8_t dynamic; /* antispoof */ 109 u_int ifa_flags; 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 char *ifname; 122 u_int ifa_flags; 123 struct node_host *next; 124 struct node_host *tail; 125 }; 126 127 struct node_os { 128 char *os; 129 pf_osfp_t fingerprint; 130 struct node_os *next; 131 struct node_os *tail; 132 }; 133 134 struct node_queue_bw { 135 u_int32_t bw_absolute; 136 u_int16_t bw_percent; 137 }; 138 139 struct node_hfsc_sc { 140 struct node_queue_bw m1; /* slope of 1st segment; bps */ 141 u_int d; /* x-projection of m1; msec */ 142 struct node_queue_bw m2; /* slope of 2nd segment; bps */ 143 u_int8_t used; 144 }; 145 146 struct node_hfsc_opts { 147 struct node_hfsc_sc realtime; 148 struct node_hfsc_sc linkshare; 149 struct node_hfsc_sc upperlimit; 150 int flags; 151 }; 152 153 struct node_queue_opt { 154 int qtype; 155 union { 156 struct cbq_opts cbq_opts; 157 struct priq_opts priq_opts; 158 struct node_hfsc_opts hfsc_opts; 159 } data; 160 }; 161 162 SIMPLEQ_HEAD(node_tinithead, node_tinit); 163 struct node_tinit { /* table initializer */ 164 SIMPLEQ_ENTRY(node_tinit) entries; 165 struct node_host *host; 166 char *file; 167 }; 168 169 170 /* optimizer created tables */ 171 struct pf_opt_tbl { 172 char pt_name[PF_TABLE_NAME_SIZE]; 173 int pt_rulecount; 174 int pt_generated; 175 struct node_tinithead pt_nodes; 176 struct pfr_buffer *pt_buf; 177 }; 178 #define PF_OPT_TABLE_PREFIX "__automatic_" 179 180 /* optimizer pf_rule container */ 181 struct pf_opt_rule { 182 struct pf_rule por_rule; 183 struct pf_opt_tbl *por_src_tbl; 184 struct pf_opt_tbl *por_dst_tbl; 185 u_int64_t por_profile_count; 186 TAILQ_ENTRY(pf_opt_rule) por_entry; 187 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT]; 188 }; 189 190 TAILQ_HEAD(pf_opt_queue, pf_opt_rule); 191 192 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *); 193 int pfctl_optimize_ruleset(struct pfctl *, struct pf_ruleset *); 194 195 int pfctl_add_rule(struct pfctl *, struct pf_rule *, const char *); 196 int pfctl_add_altq(struct pfctl *, struct pf_altq *); 197 int pfctl_add_pool(struct pfctl *, struct pf_pool *, sa_family_t); 198 void pfctl_move_pool(struct pf_pool *, struct pf_pool *); 199 void pfctl_clear_pool(struct pf_pool *); 200 201 int pfctl_set_timeout(struct pfctl *, const char *, int, int); 202 int pfctl_set_reassembly(struct pfctl *, int, int); 203 int pfctl_set_optimization(struct pfctl *, const char *); 204 int pfctl_set_limit(struct pfctl *, const char *, unsigned int); 205 int pfctl_set_logif(struct pfctl *, char *); 206 int pfctl_set_hostid(struct pfctl *, u_int32_t); 207 int pfctl_set_debug(struct pfctl *, char *); 208 int pfctl_set_interface_flags(struct pfctl *, char *, int, int); 209 210 int parse_config(char *, struct pfctl *); 211 int parse_flags(char *); 212 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *); 213 214 void print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int); 215 void print_src_node(struct pf_src_node *, int); 216 void print_rule(struct pf_rule *, const char *, int); 217 void print_tabledef(const char *, int, int, struct node_tinithead *); 218 void print_status(struct pf_status *, int); 219 220 int eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 221 struct node_queue_opt *); 222 int eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 223 struct node_queue_opt *); 224 225 void print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *, 226 struct node_queue_opt *); 227 void print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *, 228 int, struct node_queue_opt *); 229 230 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *, 231 u_int32_t); 232 233 void pfctl_clear_fingerprints(int, int); 234 int pfctl_file_fingerprints(int, int, const char *); 235 pf_osfp_t pfctl_get_fingerprint(const char *); 236 int pfctl_load_fingerprints(int, int); 237 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t); 238 void pfctl_show_fingerprints(int); 239 240 241 struct icmptypeent { 242 const char *name; 243 u_int8_t type; 244 }; 245 246 struct icmpcodeent { 247 const char *name; 248 u_int8_t type; 249 u_int8_t code; 250 }; 251 252 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t); 253 const struct icmptypeent *geticmptypebyname(char *, u_int8_t); 254 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t); 255 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t); 256 257 struct pf_timeout { 258 const char *name; 259 int timeout; 260 }; 261 262 #define PFCTL_FLAG_FILTER 0x02 263 #define PFCTL_FLAG_NAT 0x04 264 #define PFCTL_FLAG_OPTION 0x08 265 #define PFCTL_FLAG_ALTQ 0x10 266 #define PFCTL_FLAG_TABLE 0x20 267 268 extern const struct pf_timeout pf_timeouts[]; 269 270 void set_ipmask(struct node_host *, u_int8_t); 271 int check_netmask(struct node_host *, sa_family_t); 272 int unmask(struct pf_addr *, sa_family_t); 273 void ifa_load(void); 274 struct node_host *ifa_exists(const char *); 275 struct node_host *ifa_lookup(const char *, int); 276 struct node_host *host(const char *); 277 278 int append_addr(struct pfr_buffer *, char *, int); 279 int append_addr_host(struct pfr_buffer *, 280 struct node_host *, int, int); 281 282 #endif /* _PFCTL_PARSER_H_ */ 283