source: rtems-libbsd/freebsd/sbin/pfctl/pfctl_parser.h @ a5ddb0e

5
Last change on this file since a5ddb0e was a5ddb0e, checked in by Sebastian Huber <sebastian.huber@…>, on 09/24/19 at 09:05:03

Update to FreeBSD head 2019-09-24

Git mirror commit 6b0307a0a5184339393f555d5d424190d8a8277a.

  • Property mode set to 100644
File size: 9.7 KB
Line 
1/*      $OpenBSD: pfctl_parser.h,v 1.86 2006/10/31 23:46:25 mcbride Exp $ */
2
3/*-
4 * SPDX-License-Identifier: BSD-2-Clause
5 *
6 * Copyright (c) 2001 Daniel Hartmeier
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
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.
19 *
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.
32 *
33 * $FreeBSD$
34 */
35
36#ifndef _PFCTL_PARSER_H_
37#define _PFCTL_PARSER_H_
38
39#define PF_OSFP_FILE            "/etc/pf.os"
40
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
56
57#define PF_TH_ALL               0xFF
58
59#define PF_NAT_PROXY_PORT_LOW   50001
60#define PF_NAT_PROXY_PORT_HIGH  65535
61
62#define PF_OPTIMIZE_BASIC       0x0001
63#define PF_OPTIMIZE_PROFILE     0x0002
64
65#define FCNT_NAMES { \
66        "searches", \
67        "inserts", \
68        "removals", \
69        NULL \
70}
71
72struct pfr_buffer;      /* forward definition */
73
74
75struct pfctl {
76        int dev;
77        int opts;
78        int optimize;
79        int loadopt;
80        int asd;                        /* anchor stack depth */
81        int bn;                         /* brace number */
82        int brace;
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;
91        const char *ruleset;
92
93        /* 'set foo' options */
94        u_int32_t        timeout[PFTM_MAX];
95        u_int32_t        limit[PF_LIMIT_MAX];
96        u_int32_t        debug;
97        u_int32_t        hostid;
98        char            *ifname;
99
100        u_int8_t         timeout_set[PFTM_MAX];
101        u_int8_t         limit_set[PF_LIMIT_MAX];
102        u_int8_t         debug_set;
103        u_int8_t         hostid_set;
104        u_int8_t         ifname_set;
105};
106
107struct node_if {
108        char                     ifname[IFNAMSIZ];
109        u_int8_t                 not;
110        u_int8_t                 dynamic; /* antispoof */
111        u_int                    ifa_flags;
112        struct node_if          *next;
113        struct node_if          *tail;
114};
115
116struct node_host {
117        struct pf_addr_wrap      addr;
118        struct pf_addr           bcast;
119        struct pf_addr           peer;
120        sa_family_t              af;
121        u_int8_t                 not;
122        u_int32_t                ifindex;       /* link-local IPv6 addrs */
123        char                    *ifname;
124        u_int                    ifa_flags;
125        struct node_host        *next;
126        struct node_host        *tail;
127};
128
129struct node_os {
130        char                    *os;
131        pf_osfp_t                fingerprint;
132        struct node_os          *next;
133        struct node_os          *tail;
134};
135
136struct node_queue_bw {
137        u_int64_t       bw_absolute;
138        u_int16_t       bw_percent;
139};
140
141struct 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
148struct 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
155struct 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 */
159        u_int8_t                used;
160};
161
162struct node_fairq_opts {
163        struct node_fairq_sc    linkshare;
164        struct node_queue_bw    hogs_bw;
165        u_int                   nbuckets;
166        int                     flags;
167};
168
169struct node_queue_opt {
170        int                      qtype;
171        union {
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;
177        }                        data;
178};
179
180#define QPRI_BITSET_SIZE        256
181BITSET_DEFINE(qpri_bitset, QPRI_BITSET_SIZE);
182LIST_HEAD(gen_sc, segment);
183
184struct pfctl_altq {
185        struct pf_altq  pa;
186        struct {
187                STAILQ_ENTRY(pfctl_altq)        link;
188                u_int64_t                       bwsum;
189                struct qpri_bitset              qpris;
190                int                             children;
191                int                             root_classes;
192                int                             default_classes;
193                struct gen_sc                   lssc;
194                struct gen_sc                   rtsc;
195        } meta;
196};
197
198#ifdef __FreeBSD__
199/*
200 * XXX
201 * Absolutely this is not correct location to define this.
202 * Should we use an another sperate header file?
203 */
204#define SIMPLEQ_HEAD                    STAILQ_HEAD
205#define SIMPLEQ_HEAD_INITIALIZER        STAILQ_HEAD_INITIALIZER
206#define SIMPLEQ_ENTRY                   STAILQ_ENTRY
207#define SIMPLEQ_FIRST                   STAILQ_FIRST
208#define SIMPLEQ_END(head)               NULL
209#define SIMPLEQ_EMPTY                   STAILQ_EMPTY
210#define SIMPLEQ_NEXT                    STAILQ_NEXT
211/*#define       SIMPLEQ_FOREACH                 STAILQ_FOREACH*/
212#define SIMPLEQ_FOREACH(var, head, field)               \
213    for((var) = SIMPLEQ_FIRST(head);                    \
214        (var) != SIMPLEQ_END(head);                     \
215        (var) = SIMPLEQ_NEXT(var, field))
216#define SIMPLEQ_INIT                    STAILQ_INIT
217#define SIMPLEQ_INSERT_HEAD             STAILQ_INSERT_HEAD
218#define SIMPLEQ_INSERT_TAIL             STAILQ_INSERT_TAIL
219#define SIMPLEQ_INSERT_AFTER            STAILQ_INSERT_AFTER
220#define SIMPLEQ_REMOVE_HEAD             STAILQ_REMOVE_HEAD
221#endif
222SIMPLEQ_HEAD(node_tinithead, node_tinit);
223struct node_tinit {     /* table initializer */
224        SIMPLEQ_ENTRY(node_tinit)        entries;
225        struct node_host                *host;
226        char                            *file;
227};
228
229
230/* optimizer created tables */
231struct pf_opt_tbl {
232        char                     pt_name[PF_TABLE_NAME_SIZE];
233        int                      pt_rulecount;
234        int                      pt_generated;
235        struct node_tinithead    pt_nodes;
236        struct pfr_buffer       *pt_buf;
237};
238#define PF_OPT_TABLE_PREFIX     "__automatic_"
239
240/* optimizer pf_rule container */
241struct pf_opt_rule {
242        struct pf_rule           por_rule;
243        struct pf_opt_tbl       *por_src_tbl;
244        struct pf_opt_tbl       *por_dst_tbl;
245        u_int64_t                por_profile_count;
246        TAILQ_ENTRY(pf_opt_rule) por_entry;
247        TAILQ_ENTRY(pf_opt_rule) por_skip_entry[PF_SKIP_COUNT];
248};
249
250TAILQ_HEAD(pf_opt_queue, pf_opt_rule);
251
252int     pfctl_rules(int, char *, int, int, char *, struct pfr_buffer *);
253int     pfctl_optimize_ruleset(struct pfctl *, struct pf_ruleset *);
254
255int     pfctl_add_rule(struct pfctl *, struct pf_rule *, const char *);
256int     pfctl_add_altq(struct pfctl *, struct pf_altq *);
257int     pfctl_add_pool(struct pfctl *, struct pf_pool *, sa_family_t);
258void    pfctl_move_pool(struct pf_pool *, struct pf_pool *);
259void    pfctl_clear_pool(struct pf_pool *);
260
261int     pfctl_set_timeout(struct pfctl *, const char *, int, int);
262int     pfctl_set_optimization(struct pfctl *, const char *);
263int     pfctl_set_limit(struct pfctl *, const char *, unsigned int);
264int     pfctl_set_logif(struct pfctl *, char *);
265int     pfctl_set_hostid(struct pfctl *, u_int32_t);
266int     pfctl_set_debug(struct pfctl *, char *);
267int     pfctl_set_interface_flags(struct pfctl *, char *, int, int);
268
269int     parse_config(char *, struct pfctl *);
270int     parse_flags(char *);
271int     pfctl_load_anchors(int, struct pfctl *, struct pfr_buffer *);
272
273void    print_pool(struct pf_pool *, u_int16_t, u_int16_t, sa_family_t, int);
274void    print_src_node(struct pf_src_node *, int);
275void    print_rule(struct pf_rule *, const char *, int, int);
276void    print_tabledef(const char *, int, int, struct node_tinithead *);
277void    print_status(struct pf_status *, int);
278void    print_running(struct pf_status *);
279
280int     eval_pfaltq(struct pfctl *, struct pf_altq *, struct node_queue_bw *,
281            struct node_queue_opt *);
282int     eval_pfqueue(struct pfctl *, struct pf_altq *, struct node_queue_bw *,
283            struct node_queue_opt *);
284
285void     print_altq(const struct pf_altq *, unsigned, struct node_queue_bw *,
286            struct node_queue_opt *);
287void     print_queue(const struct pf_altq *, unsigned, struct node_queue_bw *,
288            int, struct node_queue_opt *);
289
290int     pfctl_define_table(char *, int, int, const char *, struct pfr_buffer *,
291            u_int32_t);
292
293void             pfctl_clear_fingerprints(int, int);
294int              pfctl_file_fingerprints(int, int, const char *);
295pf_osfp_t        pfctl_get_fingerprint(const char *);
296int              pfctl_load_fingerprints(int, int);
297char            *pfctl_lookup_fingerprint(pf_osfp_t, char *, size_t);
298void             pfctl_show_fingerprints(int);
299
300
301struct icmptypeent {
302        const char *name;
303        u_int8_t type;
304};
305
306struct icmpcodeent {
307        const char *name;
308        u_int8_t type;
309        u_int8_t code;
310};
311
312const struct icmptypeent *geticmptypebynumber(u_int8_t, u_int8_t);
313const struct icmptypeent *geticmptypebyname(char *, u_int8_t);
314const struct icmpcodeent *geticmpcodebynumber(u_int8_t, u_int8_t, u_int8_t);
315const struct icmpcodeent *geticmpcodebyname(u_long, char *, u_int8_t);
316
317struct pf_timeout {
318        const char      *name;
319        int              timeout;
320};
321
322#define PFCTL_FLAG_FILTER       0x02
323#define PFCTL_FLAG_NAT          0x04
324#define PFCTL_FLAG_OPTION       0x08
325#define PFCTL_FLAG_ALTQ         0x10
326#define PFCTL_FLAG_TABLE        0x20
327
328extern const struct pf_timeout pf_timeouts[];
329
330void                     set_ipmask(struct node_host *, u_int8_t);
331int                      check_netmask(struct node_host *, sa_family_t);
332int                      unmask(struct pf_addr *, sa_family_t);
333void                     ifa_load(void);
334int                      get_query_socket(void);
335struct node_host        *ifa_exists(char *);
336struct node_host        *ifa_grouplookup(char *ifa_name, int flags);
337struct node_host        *ifa_lookup(char *, int);
338struct node_host        *host(const char *);
339
340int                      append_addr(struct pfr_buffer *, char *, int);
341int                      append_addr_host(struct pfr_buffer *,
342                            struct node_host *, int, int);
343
344#endif /* _PFCTL_PARSER_H_ */
Note: See TracBrowser for help on using the repository browser.