xref: /freebsd/sys/netpfil/pf/pf_nl.h (revision ae1a0648b05acf798816e7b83b3c10856de5c8e5)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2023 Alexander V. Chernikov <melifaro@FreeBSD.org>
5  * Copyright (c) 2023 Rubicon Communications, LLC (Netgate)
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  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  */
29 
30 #ifndef _NETPFIL_PF_PF_NL_H_
31 #define _NETPFIL_PF_PF_NL_H_
32 
33 /* Genetlink family */
34 #define PFNL_FAMILY_NAME	"pfctl"
35 
36 /* available commands */
37 enum {
38 	PFNL_CMD_UNSPEC = 0,
39 	PFNL_CMD_GETSTATES = 1,
40 	PFNL_CMD_GETCREATORS = 2,
41 	PFNL_CMD_START = 3,
42 	PFNL_CMD_STOP = 4,
43 	PFNL_CMD_ADDRULE = 5,
44 	PFNL_CMD_GETRULES = 6,
45 	PFNL_CMD_GETRULE = 7,
46 	PFNL_CMD_CLRSTATES = 8,
47 	PFNL_CMD_KILLSTATES = 9,
48 	PFNL_CMD_SET_STATUSIF = 10,
49 	PFNL_CMD_GET_STATUS = 11,
50 	PFNL_CMD_CLEAR_STATUS = 12,
51 	PFNL_CMD_NATLOOK = 13,
52 	PFNL_CMD_SET_DEBUG = 14,
53 	PFNL_CMD_SET_TIMEOUT = 15,
54 	PFNL_CMD_GET_TIMEOUT = 16,
55 	PFNL_CMD_SET_LIMIT = 17,
56 	PFNL_CMD_GET_LIMIT = 18,
57 	PFNL_CMD_BEGIN_ADDRS = 19,
58 	PFNL_CMD_ADD_ADDR = 20,
59 	PFNL_CMD_GET_ADDRS = 21,
60 	PFNL_CMD_GET_ADDR = 22,
61 	__PFNL_CMD_MAX,
62 };
63 #define PFNL_CMD_MAX (__PFNL_CMD_MAX -1)
64 
65 enum pfstate_key_type_t {
66 	PF_STK_UNSPEC,
67 	PF_STK_ADDR0		= 1, /* ip */
68 	PF_STK_ADDR1		= 2, /* ip */
69 	PF_STK_PORT0		= 3, /* u16 */
70 	PF_STK_PORT1		= 4, /* u16 */
71 };
72 
73 enum pfstate_peer_type_t {
74 	PF_STP_UNSPEC,
75 	PF_STP_PFSS_FLAGS	= 1, /* u16 */
76 	PF_STP_PFSS_TTL		= 2, /* u8 */
77 	PF_STP_SCRUB_FLAG	= 3, /* u8 */
78 	PF_STP_PFSS_TS_MOD	= 4, /* u32 */
79 	PF_STP_SEQLO		= 5, /* u32 */
80 	PF_STP_SEQHI		= 6, /* u32 */
81 	PF_STP_SEQDIFF		= 7, /* u32 */
82 	PF_STP_MAX_WIN		= 8, /* u16 */
83 	PF_STP_MSS		= 9, /* u16 */
84 	PF_STP_STATE		= 10, /* u8 */
85 	PF_STP_WSCALE		= 11, /* u8 */
86 };
87 
88 enum pfstate_type_t {
89 	PF_ST_UNSPEC,
90 	PF_ST_ID		= 1, /* u32, state id */
91 	PF_ST_CREATORID		= 2, /* u32, */
92 	PF_ST_IFNAME		= 3, /* string */
93 	PF_ST_ORIG_IFNAME	= 4, /* string */
94 	PF_ST_KEY_WIRE		= 5, /* nested, pfstate_key_type_t */
95 	PF_ST_KEY_STACK		= 6, /* nested, pfstate_key_type_t */
96 	PF_ST_PEER_SRC		= 7, /* nested, pfstate_peer_type_t*/
97 	PF_ST_PEER_DST		= 8, /* nested, pfstate_peer_type_t */
98 	PF_ST_RT_ADDR		= 9, /* ip */
99 	PF_ST_RULE		= 10, /* u32 */
100 	PF_ST_ANCHOR		= 11, /* u32 */
101 	PF_ST_NAT_RULE		= 12, /* u32 */
102 	PF_ST_CREATION		= 13, /* u32 */
103 	PF_ST_EXPIRE		= 14, /* u32 */
104 	PF_ST_PACKETS0		= 15, /* u64 */
105 	PF_ST_PACKETS1		= 16, /* u64 */
106 	PF_ST_BYTES0		= 17, /* u64 */
107 	PF_ST_BYTES1		= 18, /* u64 */
108 	PF_ST_AF		= 19, /* u8 */
109 	PF_ST_PROTO		= 21, /* u8 */
110 	PF_ST_DIRECTION		= 22, /* u8 */
111 	PF_ST_LOG		= 23, /* u8 */
112 	PF_ST_TIMEOUT		= 24, /* u8 */
113 	PF_ST_STATE_FLAGS	= 25, /* u8 */
114 	PF_ST_SYNC_FLAGS	= 26, /* u8 */
115 	PF_ST_UPDATES		= 27, /* u8 */
116 	PF_ST_VERSION		= 28, /* u64 */
117 	PF_ST_FILTER_ADDR	= 29, /* in6_addr */
118 	PF_ST_FILTER_MASK	= 30, /* in6_addr */
119 	PF_ST_RTABLEID		= 31, /* i32 */
120 	PF_ST_MIN_TTL		= 32, /* u8 */
121 	PF_ST_MAX_MSS		= 33, /* u16 */
122 	PF_ST_DNPIPE		= 34, /* u16 */
123 	PF_ST_DNRPIPE		= 35, /* u16 */
124 	PF_ST_RT		= 36, /* u8 */
125 	PF_ST_RT_IFNAME		= 37, /* string */
126 };
127 
128 enum pf_addr_type_t {
129 	PF_AT_UNSPEC,
130 	PF_AT_ADDR		= 1, /* in6_addr */
131 	PF_AT_MASK		= 2, /* in6_addr */
132 	PF_AT_IFNAME		= 3, /* string */
133 	PF_AT_TABLENAME		= 4, /* string */
134 	PF_AT_TYPE		= 5, /* u8 */
135 	PF_AT_IFLAGS		= 6, /* u8 */
136 	PF_AT_TBLCNT		= 7, /* u32 */
137 	PF_AT_DYNCNT		= 8, /* u32 */
138 };
139 
140 enum pfrule_addr_type_t {
141 	PF_RAT_UNSPEC,
142 	PF_RAT_ADDR		= 1, /* nested, pf_addr_type_t */
143 	PF_RAT_SRC_PORT		= 2, /* u16 */
144 	PF_RAT_DST_PORT		= 3, /* u16 */
145 	PF_RAT_NEG		= 4, /* u8 */
146 	PF_RAT_OP		= 5, /* u8 */
147 };
148 
149 enum pf_labels_type_t {
150 	PF_LT_UNSPEC,
151 	PF_LT_LABEL		= 1, /* string */
152 };
153 
154 enum pf_mape_portset_type_t
155 {
156 	PF_MET_UNSPEC,
157 	PF_MET_OFFSET		= 1, /* u8 */
158 	PF_MET_PSID_LEN		= 2, /* u8 */
159 	PF_MET_PSID		= 3, /* u16 */
160 };
161 
162 enum pf_rpool_type_t
163 {
164 	PF_PT_UNSPEC,
165 	PF_PT_KEY		= 1, /* bytes, sizeof(struct pf_poolhashkey) */
166 	PF_PT_COUNTER		= 2, /* in6_addr */
167 	PF_PT_TBLIDX		= 3, /* u32 */
168 	PF_PT_PROXY_SRC_PORT	= 4, /* u16 */
169 	PF_PT_PROXY_DST_PORT	= 5, /* u16 */
170 	PF_PT_OPTS		= 6, /* u8 */
171 	PF_PT_MAPE		= 7, /* nested, pf_mape_portset_type_t */
172 };
173 
174 enum pf_timeout_type_t {
175 	PF_TT_UNSPEC,
176 	PF_TT_TIMEOUT		= 1, /* u32 */
177 };
178 
179 enum pf_rule_uid_type_t {
180 	PF_RUT_UNSPEC,
181 	PF_RUT_UID_LOW		= 1, /* u32 */
182 	PF_RUT_UID_HIGH		= 2, /* u32 */
183 	PF_RUT_OP		= 3, /* u8 */
184 };
185 
186 enum pf_rule_type_t {
187 	PF_RT_UNSPEC,
188 	PF_RT_SRC		= 1, /* nested, pf_rule_addr_type_t */
189 	PF_RT_DST		= 2, /* nested, pf_rule_addr_type_t */
190 	PF_RT_RIDENTIFIER	= 3, /* u32 */
191 	PF_RT_LABELS		= 4, /* nested, pf_labels_type_t */
192 	PF_RT_IFNAME		= 5, /* string */
193 	PF_RT_QNAME		= 6, /* string */
194 	PF_RT_PQNAME		= 7, /* string */
195 	PF_RT_TAGNAME		= 8, /* string */
196 	PF_RT_MATCH_TAGNAME	= 9, /* string */
197 	PF_RT_OVERLOAD_TBLNAME	= 10, /* string */
198 	PF_RT_RPOOL		= 11, /* nested, pf_rpool_type_t */
199 	PF_RT_OS_FINGERPRINT	= 12, /* u32 */
200 	PF_RT_RTABLEID		= 13, /* u32 */
201 	PF_RT_TIMEOUT		= 14, /* nested, pf_timeout_type_t */
202 	PF_RT_MAX_STATES	= 15, /* u32 */
203 	PF_RT_MAX_SRC_NODES	= 16, /* u32 */
204 	PF_RT_MAX_SRC_STATES	= 17, /* u32 */
205 	PF_RT_MAX_SRC_CONN_RATE_LIMIT	= 18, /* u32 */
206 	PF_RT_MAX_SRC_CONN_RATE_SECS	= 19, /* u32 */
207 	PF_RT_DNPIPE		= 20, /* u16 */
208 	PF_RT_DNRPIPE		= 21, /* u16 */
209 	PF_RT_DNFLAGS		= 22, /* u32 */
210 	PF_RT_NR		= 23, /* u32 */
211 	PF_RT_PROB		= 24, /* u32 */
212 	PF_RT_CUID		= 25, /* u32 */
213 	PF_RT_CPID		= 26, /* u32 */
214 	PF_RT_RETURN_ICMP	= 27, /* u16 */
215 	PF_RT_RETURN_ICMP6	= 28, /* u16 */
216 	PF_RT_MAX_MSS		= 29, /* u16 */
217 	PF_RT_SCRUB_FLAGS	= 30, /* u16 */
218 	PF_RT_UID		= 31, /* nested, pf_rule_uid_type_t */
219 	PF_RT_GID		= 32, /* nested, pf_rule_uid_type_t */
220 	PF_RT_RULE_FLAG		= 33, /* u32 */
221 	PF_RT_ACTION		= 34, /* u8 */
222 	PF_RT_DIRECTION		= 35, /* u8 */
223 	PF_RT_LOG		= 36, /* u8 */
224 	PF_RT_LOGIF		= 37, /* u8 */
225 	PF_RT_QUICK		= 38, /* u8 */
226 	PF_RT_IF_NOT		= 39, /* u8 */
227 	PF_RT_MATCH_TAG_NOT	= 40, /* u8 */
228 	PF_RT_NATPASS		= 41, /* u8 */
229 	PF_RT_KEEP_STATE	= 42, /* u8 */
230 	PF_RT_AF		= 43, /* u8 */
231 	PF_RT_PROTO		= 44, /* u8 */
232 	PF_RT_TYPE		= 45, /* u8 */
233 	PF_RT_CODE		= 46, /* u8 */
234 	PF_RT_FLAGS		= 47, /* u8 */
235 	PF_RT_FLAGSET		= 48, /* u8 */
236 	PF_RT_MIN_TTL		= 49, /* u8 */
237 	PF_RT_ALLOW_OPTS	= 50, /* u8 */
238 	PF_RT_RT		= 51, /* u8 */
239 	PF_RT_RETURN_TTL	= 52, /* u8 */
240 	PF_RT_TOS		= 53, /* u8 */
241 	PF_RT_SET_TOS		= 54, /* u8 */
242 	PF_RT_ANCHOR_RELATIVE	= 55, /* u8 */
243 	PF_RT_ANCHOR_WILDCARD	= 56, /* u8 */
244 	PF_RT_FLUSH		= 57, /* u8 */
245 	PF_RT_PRIO		= 58, /* u8 */
246 	PF_RT_SET_PRIO		= 59, /* u8 */
247 	PF_RT_SET_PRIO_REPLY	= 60, /* u8 */
248 	PF_RT_DIVERT_ADDRESS	= 61, /* in6_addr */
249 	PF_RT_DIVERT_PORT	= 62, /* u16 */
250 	PF_RT_PACKETS_IN	= 63, /* u64 */
251 	PF_RT_PACKETS_OUT	= 64, /* u64 */
252 	PF_RT_BYTES_IN		= 65, /* u64 */
253 	PF_RT_BYTES_OUT		= 66, /* u64 */
254 	PF_RT_EVALUATIONS	= 67, /* u64 */
255 	PF_RT_TIMESTAMP		= 68, /* u64 */
256 	PF_RT_STATES_CUR	= 69, /* u64 */
257 	PF_RT_STATES_TOTAL	= 70, /* u64 */
258 	PF_RT_SRC_NODES		= 71, /* u64 */
259 	PF_RT_ANCHOR_CALL	= 72, /* string */
260 	PF_RT_RCV_IFNAME	= 73, /* string */
261 };
262 
263 enum pf_addrule_type_t {
264 	PF_ART_UNSPEC,
265 	PF_ART_TICKET		= 1, /* u32 */
266 	PF_ART_POOL_TICKET	= 2, /* u32 */
267 	PF_ART_ANCHOR		= 3, /* string */
268 	PF_ART_ANCHOR_CALL	= 4, /* string */
269 	PF_ART_RULE		= 5, /* nested, pfrule_type_t */
270 };
271 
272 enum pf_getrules_type_t {
273 	PF_GR_UNSPEC,
274 	PF_GR_ANCHOR		= 1, /* string */
275 	PF_GR_ACTION		= 2, /* u8 */
276 	PF_GR_NR		= 3, /* u32 */
277 	PF_GR_TICKET		= 4, /* u32 */
278 	PF_GR_CLEAR		= 5, /* u8 */
279 };
280 
281 enum pf_clear_states_type_t {
282 	PF_CS_UNSPEC,
283 	PF_CS_CMP_ID		= 1, /* u64 */
284 	PF_CS_CMP_CREATORID	= 2, /* u32 */
285 	PF_CS_CMP_DIR		= 3, /* u8 */
286 	PF_CS_AF		= 4, /* u8 */
287 	PF_CS_PROTO		= 5, /* u8 */
288 	PF_CS_SRC		= 6, /* nested, pf_addr_wrap */
289 	PF_CS_DST		= 7, /* nested, pf_addr_wrap */
290 	PF_CS_RT_ADDR		= 8, /* nested, pf_addr_wrap */
291 	PF_CS_IFNAME		= 9, /* string */
292 	PF_CS_LABEL		= 10, /* string */
293 	PF_CS_KILL_MATCH	= 11, /* bool */
294 	PF_CS_NAT		= 12, /* bool */
295 	PF_CS_KILLED		= 13, /* u32 */
296 };
297 
298 enum pf_set_statusif_types_t {
299 	PF_SS_UNSPEC,
300 	PF_SS_IFNAME		= 1, /* string */
301 };
302 
303 enum pf_counter_types_t {
304 	PF_C_UNSPEC,
305 	PF_C_COUNTER		= 1, /* u64 */
306 	PF_C_NAME		= 2, /* string */
307 	PF_C_ID			= 3, /* u32 */
308 };
309 
310 enum pf_get_status_types_t {
311 	PF_GS_UNSPEC,
312 	PF_GS_IFNAME		= 1, /* string */
313 	PF_GS_RUNNING		= 2, /* bool */
314 	PF_GS_SINCE		= 3, /* u32 */
315 	PF_GS_DEBUG		= 4, /* u32 */
316 	PF_GS_HOSTID		= 5, /* u32 */
317 	PF_GS_STATES		= 6, /* u32 */
318 	PF_GS_SRC_NODES		= 7, /* u32 */
319 	PF_GS_REASSEMBLE	= 8, /* u32 */
320 	PF_GS_SYNCOOKIES_ACTIVE	= 9, /* bool */
321 	PF_GS_COUNTERS		= 10, /* nested, */
322 	PF_GS_LCOUNTERS		= 11, /* nested, */
323 	PF_GS_FCOUNTERS		= 12, /* nested, */
324 	PF_GS_SCOUNTERS		= 13, /* nested, */
325 	PF_GS_CHKSUM		= 14, /* byte array */
326 	PF_GS_PCOUNTERS		= 15, /* u64 array */
327 	PF_GS_BCOUNTERS		= 16, /* u64 array */
328 };
329 
330 enum pf_natlook_types_t {
331 	PF_NL_UNSPEC,
332 	PF_NL_AF		= 1, /* u8 */
333 	PF_NL_DIRECTION		= 2, /* u8 */
334 	PF_NL_PROTO		= 3, /* u8 */
335 	PF_NL_SRC_ADDR		= 4, /* in6_addr */
336 	PF_NL_DST_ADDR		= 5, /* in6_addr */
337 	PF_NL_SRC_PORT		= 6, /* u16 */
338 	PF_NL_DST_PORT		= 7, /* u16 */
339 };
340 
341 enum pf_set_debug_types_t {
342 	PF_SD_UNSPEC,
343 	PF_SD_LEVEL		= 1, /* u32 */
344 };
345 
346 enum pf_timeout_types_t {
347 	PF_TO_UNSPEC,
348 	PF_TO_TIMEOUT		= 1, /* u32 */
349 	PF_TO_SECONDS		= 2, /* u32 */
350 };
351 
352 enum pf_limit_types_t {
353 	PF_LI_UNSPEC,
354 	PF_LI_INDEX		= 1, /* u32 */
355 	PF_LI_LIMIT		= 2, /* u32 */
356 };
357 
358 enum pf_begin_addrs_types_t {
359 	PF_BA_UNSPEC,
360 	PF_BA_TICKET		= 1, /* u32 */
361 };
362 
363 enum pf_pool_addr_types_t {
364 	PF_PA_UNSPEC,
365 	PF_PA_ADDR		= 1, /* nested, pf_addr_wrap */
366 	PF_PA_IFNAME		= 2, /* string */
367 };
368 
369 enum pf_add_addr_types_t {
370 	PF_AA_UNSPEC,
371 	PF_AA_ACTION		= 1, /* u32 */
372 	PF_AA_TICKET		= 2, /* u32 */
373 	PF_AA_NR		= 3, /* u32 */
374 	PF_AA_R_NUM		= 4, /* u32 */
375 	PF_AA_R_ACTION		= 5, /* u8 */
376 	PF_AA_R_LAST		= 6, /* u8 */
377 	PF_AA_AF		= 7, /* u8 */
378 	PF_AA_ANCHOR		= 8, /* string */
379 	PF_AA_ADDR		= 9, /* nested, pf_pooladdr */
380 };
381 
382 #ifdef _KERNEL
383 
384 void	pf_nl_register(void);
385 void	pf_nl_unregister(void);
386 
387 #endif
388 
389 #endif
390