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_
39 #define PF_OSFP_FILE "/etc/pf.os"
41 #define PF_OPT_DISABLE 0x0001
42 #define PF_OPT_ENABLE 0x0002
43 #define PF_OPT_VERBOSE 0x0004
44 #define PF_OPT_NOACTION 0x0008
45 #define PF_OPT_QUIET 0x0010
46 #define PF_OPT_CLRRULECTRS 0x0020
47 #define PF_OPT_USEDNS 0x0040
48 #define PF_OPT_VERBOSE2 0x0080
49 #define PF_OPT_DUMMYACTION 0x0100
50 #define PF_OPT_DEBUG 0x0200
51 #define PF_OPT_SHOWALL 0x0400
52 #define PF_OPT_OPTIMIZE 0x0800
53 #define PF_OPT_NUMERIC 0x1000
54 #define PF_OPT_MERGE 0x2000
55 #define PF_OPT_RECURSE 0x4000
57 #define PF_TH_ALL 0xFF
59 #define PF_NAT_PROXY_PORT_LOW 50001
60 #define PF_NAT_PROXY_PORT_HIGH 65535
62 #define PF_OPTIMIZE_BASIC 0x0001
63 #define PF_OPTIMIZE_PROFILE 0x0002
65 #define FCNT_NAMES { \
72 struct pfr_buffer; /* forward definition */
80 int asd; /* anchor stack depth */
81 int bn; /* brace number */
83 int tdirty; /* kernel dirty */
84 #define PFCTL_ANCHOR_STACK_DEPTH 64
85 struct pf_anchor *astack[PFCTL_ANCHOR_STACK_DEPTH];
86 struct pfioc_pooladdr paddr;
87 struct pfioc_altq *paltq;
88 struct pfioc_queue *pqueue;
89 struct pfr_buffer *trans;
90 struct pf_anchor *anchor, *alast;
93 /* 'set foo' options */
94 u_int32_t timeout[PFTM_MAX];
95 u_int32_t limit[PF_LIMIT_MAX];
100 u_int8_t timeout_set[PFTM_MAX];
101 u_int8_t limit_set[PF_LIMIT_MAX];
108 char ifname[IFNAMSIZ];
110 u_int8_t dynamic; /* antispoof */
112 struct node_if *next;
113 struct node_if *tail;
117 struct pf_addr_wrap addr;
118 struct pf_addr bcast;
122 u_int32_t ifindex; /* link-local IPv6 addrs */
125 struct node_host *next;
126 struct node_host *tail;
131 pf_osfp_t fingerprint;
132 struct node_os *next;
133 struct node_os *tail;
136 struct node_queue_bw {
137 u_int64_t bw_absolute;
138 u_int16_t bw_percent;
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 */
148 struct node_hfsc_opts {
149 struct node_hfsc_sc realtime;
150 struct node_hfsc_sc linkshare;
151 struct node_hfsc_sc upperlimit;
155 struct node_fairq_sc {
156 struct node_queue_bw m1; /* slope of 1st segment; bps */
157 u_int d; /* x-projection of m1; msec */
158 struct node_queue_bw m2; /* slope of 2nd segment; bps */
162 struct node_fairq_opts {
163 struct node_fairq_sc linkshare;
164 struct node_queue_bw hogs_bw;
169 struct node_queue_opt {
172 struct cbq_opts cbq_opts;
173 struct codel_opts codel_opts;
174 struct priq_opts priq_opts;
175 struct node_hfsc_opts hfsc_opts;
176 struct node_fairq_opts fairq_opts;
183 * Absolutely this is not correct location to define this.
184 * Should we use an another sperate header file?
186 #define SIMPLEQ_HEAD STAILQ_HEAD
187 #define SIMPLEQ_HEAD_INITIALIZER STAILQ_HEAD_INITIALIZER
188 #define SIMPLEQ_ENTRY STAILQ_ENTRY
189 #define SIMPLEQ_FIRST STAILQ_FIRST
190 #define SIMPLEQ_END(head) NULL
191 #define SIMPLEQ_EMPTY STAILQ_EMPTY
192 #define SIMPLEQ_NEXT STAILQ_NEXT
193 /*#define SIMPLEQ_FOREACH STAILQ_FOREACH*/
194 #define SIMPLEQ_FOREACH(var, head, field) \
195 for((var) = SIMPLEQ_FIRST(head); \
196 (var) != SIMPLEQ_END(head); \
197 (var) = SIMPLEQ_NEXT(var, field))
198 #define SIMPLEQ_INIT STAILQ_INIT
199 #define SIMPLEQ_INSERT_HEAD STAILQ_INSERT_HEAD
200 #define SIMPLEQ_INSERT_TAIL STAILQ_INSERT_TAIL
201 #define SIMPLEQ_INSERT_AFTER STAILQ_INSERT_AFTER
202 #define SIMPLEQ_REMOVE_HEAD STAILQ_REMOVE_HEAD
204 SIMPLEQ_HEAD(node_tinithead, node_tinit);
205 struct node_tinit { /* table initializer */
206 SIMPLEQ_ENTRY(node_tinit) entries;
207 struct node_host *host;
212 /* optimizer created tables */
214 char pt_name[PF_TABLE_NAME_SIZE];
217 struct node_tinithead pt_nodes;
218 struct pfr_buffer *pt_buf;
220 #define PF_OPT_TABLE_PREFIX "__automatic_"
222 /* optimizer pf_rule container */
224 struct pf_rule por_rule;
225 struct pf_opt_tbl *por_src_tbl;
226 struct pf_opt_tbl *por_dst_tbl;
227 u_int64_t por_profile_count;
228 TAILQ_ENTRY(pf_opt_rule) por_entry;
229 TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT];
232 TAILQ_HEAD(pf_opt_queue, pf_opt_rule);
234 int pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *);
235 int pfctl_optimize_ruleset(struct pfctl *, struct pf_ruleset *);
237 int pfctl_add_rule(struct pfctl *, struct pf_rule *, const char *);
238 int pfctl_add_altq(struct pfctl *, struct pf_altq *);
239 int pfctl_add_pool(struct pfctl *, struct pf_pool *, sa_family_t);
240 void pfctl_move_pool(struct pf_pool *, struct pf_pool *);
241 void pfctl_clear_pool(struct pf_pool *);
243 int pfctl_set_timeout(struct pfctl *, const char *, int, int);
244 int pfctl_set_optimization(struct pfctl *, const char *);
245 int pfctl_set_limit(struct pfctl *, const char *, unsigned int);
246 int pfctl_set_logif(struct pfctl *, char *);
247 int pfctl_set_hostid(struct pfctl *, u_int32_t);
248 int pfctl_set_debug(struct pfctl *, char *);
249 int pfctl_set_interface_flags(struct pfctl *, char *, int, int);
251 int parse_config(char *, struct pfctl *);
252 int parse_flags(char *);
253 int pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *);
255 void print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int);
256 void print_src_node(struct pf_src_node *, int);
257 void print_rule(struct pf_rule *, const char *, int, int);
258 void print_tabledef(const char *, int, int, struct node_tinithead *);
259 void print_status(struct pf_status *, int);
260 void print_running(struct pf_status *);
262 int eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *,
263 struct node_queue_opt *);
264 int eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *,
265 struct node_queue_opt *);
267 void print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *,
268 struct node_queue_opt *);
269 void print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *,
270 int, struct node_queue_opt *);
272 int pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *,
275 void pfctl_clear_fingerprints(int, int);
276 int pfctl_file_fingerprints(int, int, const char *);
277 pf_osfp_t pfctl_get_fingerprint(const char *);
278 int pfctl_load_fingerprints(int, int);
279 char *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t);
280 void pfctl_show_fingerprints(int);
294 const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t);
295 const struct icmptypeent *geticmptypebyname(char *, u_int8_t);
296 const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t);
297 const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t);
304 #define PFCTL_FLAG_FILTER 0x02
305 #define PFCTL_FLAG_NAT 0x04
306 #define PFCTL_FLAG_OPTION 0x08
307 #define PFCTL_FLAG_ALTQ 0x10
308 #define PFCTL_FLAG_TABLE 0x20
310 extern const struct pf_timeout pf_timeouts[];
312 void set_ipmask(struct node_host *, u_int8_t);
313 int check_netmask(struct node_host *, sa_family_t);
314 int unmask(struct pf_addr *, sa_family_t);
316 int get_socket_domain(void);
317 struct node_host *ifa_exists(const char *);
318 struct node_host *ifa_grouplookup(const char *ifa_name, int flags);
319 struct node_host *ifa_lookup(const char *, int);
320 struct node_host *host(const char *);
322 int append_addr(struct pfr_buffer *, char *, int);
323 int append_addr_host(struct pfr_buffer *,
324 struct node_host *, int, int);
326 #endif /* _PFCTL_PARSER_H_ */