xref: /openbsd-src/sbin/pfctl/pfctl.h (revision e496dff3a7dbaf23b2ee7a45993a39db823238e4)
1 /*	$OpenBSD: pfctl.h,v 1.65 2024/11/20 13:57:29 kirill 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_H_
34 #define _PFCTL_H_
35 
36 #ifdef PFCTL_DEBUG
37 #define DBGPRINT(...)	fprintf(stderr, __VA_ARGS__)
38 #else
39 #define DBGPRINT(...)	(void)(0)
40 #endif
41 
42 enum pfctl_show { PFCTL_SHOW_RULES, PFCTL_SHOW_LABELS, PFCTL_SHOW_NOTHING };
43 
44 enum {	PFRB_TABLES = 1, PFRB_TSTATS, PFRB_ADDRS, PFRB_ASTATS,
45 	PFRB_IFACES, PFRB_TRANS, PFRB_MAX };
46 struct pfr_buffer {
47 	int	 pfrb_type;	/* type of content, see enum above */
48 	int	 pfrb_size;	/* number of objects in buffer */
49 	int	 pfrb_msize;	/* maximum number of objects in buffer */
50 	void	*pfrb_caddr;	/* malloc'ated memory area */
51 };
52 #define PFRB_FOREACH(var, buf)				\
53 	for ((var) = pfr_buf_next((buf), NULL);		\
54 	    (var) != NULL;				\
55 	    (var) = pfr_buf_next((buf), (var)))
56 
57 
58 struct pfr_anchoritem {
59 	SLIST_ENTRY(pfr_anchoritem)	pfra_sle;
60 	char	*pfra_anchorname;
61 };
62 
63 struct pfr_uktable {
64 	struct pfr_ktable	pfrukt_kt;
65 	struct pfr_buffer	pfrukt_addrs;
66 	int			pfrukt_init_addr;
67 	SLIST_ENTRY(pfr_uktable)
68 				pfrukt_entry;
69 };
70 
71 #define pfrukt_t	pfrukt_kt.pfrkt_ts.pfrts_t
72 #define pfrukt_name	pfrukt_kt.pfrkt_t.pfrt_name
73 #define pfrukt_anchor	pfrukt_kt.pfrkt_t.pfrt_anchor
74 
75 extern struct pfr_ktablehead pfr_ktables;
76 
77 SLIST_HEAD(pfr_anchors, pfr_anchoritem);
78 
79 int	 pfr_clr_tables(struct pfr_table *, int *, int);
80 int	 pfr_add_tables(struct pfr_table *, int, int *, int);
81 int	 pfr_del_tables(struct pfr_table *, int, int *, int);
82 int	 pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
83 int	 pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
84 int	 pfr_clr_tstats(struct pfr_table *, int, int *, int);
85 int	 pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *, int);
86 int	 pfr_clr_addrs(struct pfr_table *, int *, int);
87 int	 pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
88 int	 pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
89 int	 pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
90 	    int *, int *, int *, int);
91 int	 pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
92 int	 pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
93 int	 pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *, int);
94 int	 pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
95 	    int *, int, int);
96 void	 pfr_buf_clear(struct pfr_buffer *);
97 int	 pfr_buf_add(struct pfr_buffer *, const void *);
98 void	*pfr_buf_next(struct pfr_buffer *, const void *);
99 int	 pfr_buf_grow(struct pfr_buffer *, int);
100 int	 pfr_buf_load(struct pfr_buffer *, char *, int, int);
101 char	*pf_strerror(int);
102 int	 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
103 
104 void	 pfctl_print_title(char *);
105 int	 pfctl_clear_tables(const char *, int);
106 void	 pfctl_show_tables(const char *, int);
107 int	 pfctl_table(int, char *[], char *, const char *, char *,
108 	    const char *, int);
109 void	 warn_duplicate_tables(const char *, const char *);
110 void	 pfctl_show_ifaces(const char *, int);
111 FILE	*pfctl_fopen(const char *, const char *);
112 
113 void	 print_addr(struct pf_addr_wrap *, sa_family_t, int);
114 void	 print_addr_str(sa_family_t, struct pf_addr *);
115 void	 print_host(struct pf_addr *, u_int16_t p, sa_family_t, u_int16_t, const char *, int);
116 void	 print_seq(struct pfsync_state_peer *);
117 void	 print_state(struct pfsync_state *, int);
118 
119 int	 pfctl_cmdline_symset(char *);
120 int	 pfctl_add_trans(struct pfr_buffer *, int, const char *);
121 u_int32_t
122 	 pfctl_get_ticket(struct pfr_buffer *, int, const char *);
123 int	 pfctl_trans(int, struct pfr_buffer *, u_long, int);
124 
125 int	 pfctl_show_queues(int, const char *, int, int);
126 
127 void	 pfctl_err(int, int, const char *, ...);
128 void	 pfctl_errx(int, int, const char *, ...);
129 
130 #endif /* _PFCTL_H_ */
131