1 /* $OpenBSD: pfctl_parser.h,v 1.86 2006/10/31 23:46:25 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 * $FreeBSD$ 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 0x0001 40 #define PF_OPT_ENABLE 0x0002 41 #define PF_OPT_VERBOSE 0x0004 42 #define PF_OPT_NOACTION 0x0008 43 #define PF_OPT_QUIET 0x0010 44 #define PF_OPT_CLRRULECTRS 0x0020 45 #define PF_OPT_USEDNS 0x0040 46 #define PF_OPT_VERBOSE2 0x0080 47 #define PF_OPT_DUMMYACTION 0x0100 48 #define PF_OPT_DEBUG 0x0200 49 #define PF_OPT_SHOWALL 0x0400 50 #define PF_OPT_OPTIMIZE 0x0800 51 #define PF_OPT_NUMERIC 0x1000 52 #define PF_OPT_MERGE 0x2000 53 #define PF_OPT_RECURSE 0x4000 54 55 #define PF_TH_ALL 0xFF 56 57 #define PF_NAT_PROXY_PORT_LOW 50001 58 #define PF_NAT_PROXY_PORT_HIGH 65535 59 60 #define PF_OPTIMIZE_BASIC 0x0001 61 #define PF_OPTIMIZE_PROFILE 0x0002 62 63 #define FCNT_NAMES { \ 64 "searches", \ 65 "inserts", \ 66 "removals", \ 67 NULL \ 68 } 69 70 struct pfr_buffer; /* forward definition */ 71 72 73 struct pfctl { 74 int dev; 75 int opts; 76 int optimize; 77 int loadopt; 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_pooladdr paddr; 85 struct pfioc_altq *paltq; 86 struct pfioc_queue *pqueue; 87 struct pfr_buffer *trans; 88 struct pf_anchor *anchor, *alast; 89 const char *ruleset; 90 91 /* 'set foo' options */ 92 u_int32_t timeout[PFTM_MAX]; 93 u_int32_t limit[PF_LIMIT_MAX]; 94 u_int32_t debug; 95 u_int32_t hostid; 96 char *ifname; 97 98 u_int8_t timeout_set[PFTM_MAX]; 99 u_int8_t limit_set[PF_LIMIT_MAX]; 100 u_int8_t debug_set; 101 u_int8_t hostid_set; 102 u_int8_t ifname_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_fairq_sc { 154 struct node_queue_bw m1; /* slope of 1st segment; bps */ 155 u_int d; /* x-projection of m1; msec */ 156 struct node_queue_bw m2; /* slope of 2nd segment; bps */ 157 u_int8_t used; 158 }; 159 160 struct node_fairq_opts { 161 struct node_fairq_sc linkshare; 162 struct node_queue_bw hogs_bw; 163 u_int nbuckets; 164 int flags; 165 }; 166 167 struct node_queue_opt { 168 int qtype; 169 union { 170 struct cbq_opts cbq_opts; 171 struct codel_opts codel_opts; 172 struct priq_opts priq_opts; 173 struct node_hfsc_opts hfsc_opts; 174 struct node_fairq_opts fairq_opts; 175 } data; 176 }; 177 178 #ifdef __FreeBSD__ 179 /* 180 * XXX 181 * Absolutely this is not correct location to define this. 182 * Should we use an another sperate header file? 183 */ 184 #define SIMPLEQ_HEAD STAILQ_HEAD 185 #define SIMPLEQ_HEAD_INITIALIZER STAILQ_HEAD_INITIALIZER 186 #define SIMPLEQ_ENTRY STAILQ_ENTRY 187 #define SIMPLEQ_FIRST STAILQ_FIRST 188 #define SIMPLEQ_END(head) NULL 189 #define SIMPLEQ_EMPTY STAILQ_EMPTY 190 #define SIMPLEQ_NEXT STAILQ_NEXT 191 /*#define SIMPLEQ_FOREACH STAILQ_FOREACH*/ 192 #define SIMPLEQ_FOREACH(var, head, field) \ 193 for((var) = SIMPLEQ_FIRST(head); \ 194 (var) != SIMPLEQ_END(head); \ 195 (var) = SIMPLEQ_NEXT(var, field)) 196 #define SIMPLEQ_INIT STAILQ_INIT 197 #define SIMPLEQ_INSERT_HEAD STAILQ_INSERT_HEAD 198 #define SIMPLEQ_INSERT_TAIL STAILQ_INSERT_TAIL 199 #define SIMPLEQ_INSERT_AFTER STAILQ_INSERT_AFTER 200 #define SIMPLEQ_REMOVE_HEAD STAILQ_REMOVE_HEAD 201 #endif 202 SIMPLEQ_HEAD(node_tinithead, node_tinit); 203 struct node_tinit { /* table initializer */ 204 SIMPLEQ_ENTRY(node_tinit) entries; 205 struct node_host *host; 206 char *file; 207 }; 208 209 210 /* optimizer created tables */ 211 struct pf_opt_tbl { 212 char pt_name[PF_TABLE_NAME_SIZE]; 213 int pt_rulecount; 214 int pt_generated; 215 struct node_tinithead pt_nodes; 216 struct pfr_buffer *pt_buf; 217 }; 218 #define PF_OPT_TABLE_PREFIX "__automatic_" 219 220 /* optimizer pf_rule container */ 221 struct pf_opt_rule { 222 struct pf_rule por_rule; 223 struct pf_opt_tbl *por_src_tbl; 224 struct pf_opt_tbl *por_dst_tbl; 225 u_int64_t por_profile_count; 226 TAILQ_ENTRY(pf_opt_rule) por_entry; 227 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT]; 228 }; 229 230 TAILQ_HEAD(pf_opt_queue, pf_opt_rule); 231 232 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *); 233 int pfctl_optimize_ruleset(struct pfctl *, struct pf_ruleset *); 234 235 int pfctl_add_rule(struct pfctl *, struct pf_rule *, const char *); 236 int pfctl_add_altq(struct pfctl *, struct pf_altq *); 237 int pfctl_add_pool(struct pfctl *, struct pf_pool *, sa_family_t); 238 void pfctl_move_pool(struct pf_pool *, struct pf_pool *); 239 void pfctl_clear_pool(struct pf_pool *); 240 241 int pfctl_set_timeout(struct pfctl *, const char *, int, int); 242 int pfctl_set_optimization(struct pfctl *, const char *); 243 int pfctl_set_limit(struct pfctl *, const char *, unsigned int); 244 int pfctl_set_logif(struct pfctl *, char *); 245 int pfctl_set_hostid(struct pfctl *, u_int32_t); 246 int pfctl_set_debug(struct pfctl *, char *); 247 int pfctl_set_interface_flags(struct pfctl *, char *, int, int); 248 249 int parse_config(char *, struct pfctl *); 250 int parse_flags(char *); 251 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *); 252 253 void print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int); 254 void print_src_node(struct pf_src_node *, int); 255 void print_rule(struct pf_rule *, const char *, int, int); 256 void print_tabledef(const char *, int, int, struct node_tinithead *); 257 void print_status(struct pf_status *, int); 258 259 int eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 260 struct node_queue_opt *); 261 int eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *, 262 struct node_queue_opt *); 263 264 void print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *, 265 struct node_queue_opt *); 266 void print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *, 267 int, struct node_queue_opt *); 268 269 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *, 270 u_int32_t); 271 272 void pfctl_clear_fingerprints(int, int); 273 int pfctl_file_fingerprints(int, int, const char *); 274 pf_osfp_t pfctl_get_fingerprint(const char *); 275 int pfctl_load_fingerprints(int, int); 276 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t); 277 void pfctl_show_fingerprints(int); 278 279 280 struct icmptypeent { 281 const char *name; 282 u_int8_t type; 283 }; 284 285 struct icmpcodeent { 286 const char *name; 287 u_int8_t type; 288 u_int8_t code; 289 }; 290 291 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t); 292 const struct icmptypeent *geticmptypebyname(char *, u_int8_t); 293 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t); 294 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t); 295 296 struct pf_timeout { 297 const char *name; 298 int timeout; 299 }; 300 301 #define PFCTL_FLAG_FILTER 0x02 302 #define PFCTL_FLAG_NAT 0x04 303 #define PFCTL_FLAG_OPTION 0x08 304 #define PFCTL_FLAG_ALTQ 0x10 305 #define PFCTL_FLAG_TABLE 0x20 306 307 extern const struct pf_timeout pf_timeouts[]; 308 309 void set_ipmask(struct node_host *, u_int8_t); 310 int check_netmask(struct node_host *, sa_family_t); 311 int unmask(struct pf_addr *, sa_family_t); 312 void ifa_load(void); 313 int get_socket_domain(void); 314 struct node_host *ifa_exists(const char *); 315 struct node_host *ifa_lookup(const char *, int); 316 struct node_host *host(const char *); 317 318 int append_addr(struct pfr_buffer *, char *, int); 319 int append_addr_host(struct pfr_buffer *, 320 struct node_host *, int, int); 321 322 #endif /* _PFCTL_PARSER_H_ */ 323