1 /* $OpenBSD: pfctl_parser.h,v 1.86 2006/10/31 23:46:25 mcbride Exp $ */
4 * SPDX-License-Identifier: BSD-2-Clause
6 * Copyright (c) 2001 Daniel Hartmeier
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * - Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * - Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer in the documentation and/or other materials provided
18 * with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
36 #ifndef _PFCTL_PARSER_H_
37 #define _PFCTL_PARSER_H_
41 #define PF_OSFP_FILE "/etc/pf.os"
43 #define PF_OPT_DISABLE 0x0001
44 #define PF_OPT_ENABLE 0x0002
45 #define PF_OPT_VERBOSE 0x0004
46 #define PF_OPT_NOACTION 0x0008
47 #define PF_OPT_QUIET 0x0010
48 #define PF_OPT_CLRRULECTRS 0x0020
49 #define PF_OPT_USEDNS 0x0040
50 #define PF_OPT_VERBOSE2 0x0080
51 #define PF_OPT_DUMMYACTION 0x0100
52 #define PF_OPT_DEBUG 0x0200
53 #define PF_OPT_SHOWALL 0x0400
54 #define PF_OPT_OPTIMIZE 0x0800
55 #define PF_OPT_NUMERIC 0x1000
56 #define PF_OPT_MERGE 0x2000
57 #define PF_OPT_RECURSE 0x4000
59 #define PF_TH_ALL 0xFF
61 #define PF_NAT_PROXY_PORT_LOW 50001
62 #define PF_NAT_PROXY_PORT_HIGH 65535
64 #define PF_OPTIMIZE_BASIC 0x0001
65 #define PF_OPTIMIZE_PROFILE 0x0002
67 #define FCNT_NAMES { \
74 struct pfr_buffer; /* forward definition */
82 int asd; /* anchor stack depth */
83 int bn; /* brace number */
85 int tdirty; /* kernel dirty */
86 #define PFCTL_ANCHOR_STACK_DEPTH 64
87 struct pfctl_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH];
88 struct pfioc_pooladdr paddr;
89 struct pfioc_altq *paltq;
90 struct pfioc_queue *pqueue;
91 struct pfr_buffer *trans;
92 struct pfctl_anchor *anchor, *alast;
95 /* 'set foo' options */
96 u_int32_t timeout[PFTM_MAX];
97 u_int32_t limit[PF_LIMIT_MAX];
102 u_int8_t timeout_set[PFTM_MAX];
103 u_int8_t limit_set[PF_LIMIT_MAX];
110 char ifname[IFNAMSIZ];
112 u_int8_t dynamic; /* antispoof */
114 struct node_if *next;
115 struct node_if *tail;
119 struct pf_addr_wrap addr;
120 struct pf_addr bcast;
124 u_int32_t ifindex; /* link-local IPv6 addrs */
127 struct node_host *next;
128 struct node_host *tail;
133 pf_osfp_t fingerprint;
134 struct node_os *next;
135 struct node_os *tail;
138 struct node_queue_bw {
139 u_int64_t bw_absolute;
140 u_int16_t bw_percent;
143 struct node_hfsc_sc {
144 struct node_queue_bw m1; /* slope of 1st segment; bps */
145 u_int d; /* x-projection of m1; msec */
146 struct node_queue_bw m2; /* slope of 2nd segment; bps */
150 struct node_hfsc_opts {
151 struct node_hfsc_sc realtime;
152 struct node_hfsc_sc linkshare;
153 struct node_hfsc_sc upperlimit;
157 struct node_fairq_sc {
158 struct node_queue_bw m1; /* slope of 1st segment; bps */
159 u_int d; /* x-projection of m1; msec */
160 struct node_queue_bw m2; /* slope of 2nd segment; bps */
164 struct node_fairq_opts {
165 struct node_fairq_sc linkshare;
166 struct node_queue_bw hogs_bw;
171 struct node_queue_opt {
174 struct cbq_opts cbq_opts;
175 struct codel_opts codel_opts;
176 struct priq_opts priq_opts;
177 struct node_hfsc_opts hfsc_opts;
178 struct node_fairq_opts fairq_opts;
182 #define QPRI_BITSET_SIZE 256
183 BITSET_DEFINE(qpri_bitset, QPRI_BITSET_SIZE);
184 LIST_HEAD(gen_sc, segment);
189 STAILQ_ENTRY(pfctl_altq) link;
191 struct qpri_bitset qpris;
203 * Absolutely this is not correct location to define this.
204 * Should we use an another sperate header file?
206 #define SIMPLEQ_HEAD STAILQ_HEAD
207 #define SIMPLEQ_HEAD_INITIALIZER STAILQ_HEAD_INITIALIZER
208 #define SIMPLEQ_ENTRY STAILQ_ENTRY
209 #define SIMPLEQ_FIRST STAILQ_FIRST
210 #define SIMPLEQ_END(head) NULL
211 #define SIMPLEQ_EMPTY STAILQ_EMPTY
212 #define SIMPLEQ_NEXT STAILQ_NEXT
213 /*#define SIMPLEQ_FOREACH STAILQ_FOREACH*/
214 #define SIMPLEQ_FOREACH(var, head, field) \
215 for((var) = SIMPLEQ_FIRST(head); \
216 (var) != SIMPLEQ_END(head); \
217 (var) = SIMPLEQ_NEXT(var, field))
218 #define SIMPLEQ_INIT STAILQ_INIT
219 #define SIMPLEQ_INSERT_HEAD STAILQ_INSERT_HEAD
220 #define SIMPLEQ_INSERT_TAIL STAILQ_INSERT_TAIL
221 #define SIMPLEQ_INSERT_AFTER STAILQ_INSERT_AFTER
222 #define SIMPLEQ_REMOVE_HEAD STAILQ_REMOVE_HEAD
224 SIMPLEQ_HEAD(node_tinithead, node_tinit);
225 struct node_tinit { /* table initializer */
226 SIMPLEQ_ENTRY(node_tinit) entries;
227 struct node_host *host;
232 /* optimizer created tables */
234 char pt_name[PF_TABLE_NAME_SIZE];
237 struct node_tinithead pt_nodes;
238 struct pfr_buffer *pt_buf;
240 #define PF_OPT_TABLE_PREFIX "__automatic_"
242 /* optimizer pf_rule container */
244 struct pfctl_rule por_rule;
245 struct pf_opt_tbl *por_src_tbl;
246 struct pf_opt_tbl *por_dst_tbl;
247 u_int64_t por_profile_count;
248 TAILQ_ENTRY(pf_opt_rule) por_entry;
249 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT];
252 TAILQ_HEAD(pf_opt_queue, pf_opt_rule);
254 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *);
255 int pfctl_optimize_ruleset(struct pfctl *, struct pfctl_ruleset *);
257 int pfctl_append_rule(struct pfctl *, struct pfctl_rule *, const char *);
258 int pfctl_add_altq(struct pfctl *, struct pf_altq *);
259 int pfctl_add_pool(struct pfctl *, struct pf_pool *, sa_family_t);
260 void pfctl_move_pool(struct pf_pool *, struct pf_pool *);
261 void pfctl_clear_pool(struct pf_pool *);
263 int pfctl_set_timeout(struct pfctl *, const char *, int, int);
264 int pfctl_set_optimization(struct pfctl *, const char *);
265 int pfctl_set_limit(struct pfctl *, const char *, unsigned int);
266 int pfctl_set_logif(struct pfctl *, char *);
267 int pfctl_set_hostid(struct pfctl *, u_int32_t);
268 int pfctl_set_debug(struct pfctl *, char *);
269 int pfctl_set_interface_flags(struct pfctl *, char *, int, int);
271 int parse_config(char *, struct pfctl *);
272 int parse_flags(char *);
273 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *);
275 void print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int);
276 void print_src_node(struct pf_src_node *, int);
277 void print_rule(struct pfctl_rule *, const char *, int, int);
278 void print_tabledef(const char *, int, int, struct node_tinithead *);
279 void print_status(struct pf_status *, int);
280 void print_running(struct pf_status *);
282 int eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *,
283 struct node_queue_opt *);
284 int eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *,
285 struct node_queue_opt *);
287 void print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *,
288 struct node_queue_opt *);
289 void print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *,
290 int, struct node_queue_opt *);
292 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *,
295 void pfctl_clear_fingerprints(int, int);
296 int pfctl_file_fingerprints(int, int, const char *);
297 pf_osfp_t pfctl_get_fingerprint(const char *);
298 int pfctl_load_fingerprints(int, int);
299 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t);
300 void pfctl_show_fingerprints(int);
314 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t);
315 const struct icmptypeent *geticmptypebyname(char *, u_int8_t);
316 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t);
317 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t);
324 #define PFCTL_FLAG_FILTER 0x02
325 #define PFCTL_FLAG_NAT 0x04
326 #define PFCTL_FLAG_OPTION 0x08
327 #define PFCTL_FLAG_ALTQ 0x10
328 #define PFCTL_FLAG_TABLE 0x20
330 extern const struct pf_timeout pf_timeouts[];
332 void set_ipmask(struct node_host *, u_int8_t);
333 int check_netmask(struct node_host *, sa_family_t);
334 int unmask(struct pf_addr *, sa_family_t);
336 int get_query_socket(void);
337 struct node_host *ifa_exists(char *);
338 struct node_host *ifa_grouplookup(char *ifa_name, int flags);
339 struct node_host *ifa_lookup(char *, int);
340 struct node_host *host(const char *);
342 int append_addr(struct pfr_buffer *, char *, int);
343 int append_addr_host(struct pfr_buffer *,
344 struct node_host *, int, int);
346 #endif /* _PFCTL_PARSER_H_ */