xref: /linux-6.15/include/uapi/linux/xfrm.h (revision bb7e5ce7)
1 #ifndef _LINUX_XFRM_H
2 #define _LINUX_XFRM_H
3 
4 #include <linux/in6.h>
5 #include <linux/types.h>
6 
7 /* All of the structures in this file may not change size as they are
8  * passed into the kernel from userspace via netlink sockets.
9  */
10 
11 /* Structure to encapsulate addresses. I do not want to use
12  * "standard" structure. My apologies.
13  */
14 typedef union {
15 	__be32		a4;
16 	__be32		a6[4];
17 	struct in6_addr	in6;
18 } xfrm_address_t;
19 
20 /* Ident of a specific xfrm_state. It is used on input to lookup
21  * the state by (spi,daddr,ah/esp) or to store information about
22  * spi, protocol and tunnel address on output.
23  */
24 struct xfrm_id {
25 	xfrm_address_t	daddr;
26 	__be32		spi;
27 	__u8		proto;
28 };
29 
30 struct xfrm_sec_ctx {
31 	__u8	ctx_doi;
32 	__u8	ctx_alg;
33 	__u16	ctx_len;
34 	__u32	ctx_sid;
35 	char	ctx_str[0];
36 };
37 
38 /* Security Context Domains of Interpretation */
39 #define XFRM_SC_DOI_RESERVED 0
40 #define XFRM_SC_DOI_LSM 1
41 
42 /* Security Context Algorithms */
43 #define XFRM_SC_ALG_RESERVED 0
44 #define XFRM_SC_ALG_SELINUX 1
45 
46 /* Selector, used as selector both on policy rules (SPD) and SAs. */
47 
48 struct xfrm_selector {
49 	xfrm_address_t	daddr;
50 	xfrm_address_t	saddr;
51 	__be16	dport;
52 	__be16	dport_mask;
53 	__be16	sport;
54 	__be16	sport_mask;
55 	__u16	family;
56 	__u8	prefixlen_d;
57 	__u8	prefixlen_s;
58 	__u8	proto;
59 	int	ifindex;
60 	__kernel_uid32_t	user;
61 };
62 
63 #define XFRM_INF (~(__u64)0)
64 
65 struct xfrm_lifetime_cfg {
66 	__u64	soft_byte_limit;
67 	__u64	hard_byte_limit;
68 	__u64	soft_packet_limit;
69 	__u64	hard_packet_limit;
70 	__u64	soft_add_expires_seconds;
71 	__u64	hard_add_expires_seconds;
72 	__u64	soft_use_expires_seconds;
73 	__u64	hard_use_expires_seconds;
74 };
75 
76 struct xfrm_lifetime_cur {
77 	__u64	bytes;
78 	__u64	packets;
79 	__u64	add_time;
80 	__u64	use_time;
81 };
82 
83 struct xfrm_replay_state {
84 	__u32	oseq;
85 	__u32	seq;
86 	__u32	bitmap;
87 };
88 
89 #define XFRMA_REPLAY_ESN_MAX	4096
90 
91 struct xfrm_replay_state_esn {
92 	unsigned int	bmp_len;
93 	__u32		oseq;
94 	__u32		seq;
95 	__u32		oseq_hi;
96 	__u32		seq_hi;
97 	__u32		replay_window;
98 	__u32		bmp[0];
99 };
100 
101 struct xfrm_algo {
102 	char		alg_name[64];
103 	unsigned int	alg_key_len;    /* in bits */
104 	char		alg_key[0];
105 };
106 
107 struct xfrm_algo_auth {
108 	char		alg_name[64];
109 	unsigned int	alg_key_len;    /* in bits */
110 	unsigned int	alg_trunc_len;  /* in bits */
111 	char		alg_key[0];
112 };
113 
114 struct xfrm_algo_aead {
115 	char		alg_name[64];
116 	unsigned int	alg_key_len;	/* in bits */
117 	unsigned int	alg_icv_len;	/* in bits */
118 	char		alg_key[0];
119 };
120 
121 struct xfrm_stats {
122 	__u32	replay_window;
123 	__u32	replay;
124 	__u32	integrity_failed;
125 };
126 
127 enum {
128 	XFRM_POLICY_TYPE_MAIN	= 0,
129 	XFRM_POLICY_TYPE_SUB	= 1,
130 	XFRM_POLICY_TYPE_MAX	= 2,
131 	XFRM_POLICY_TYPE_ANY	= 255
132 };
133 
134 enum {
135 	XFRM_POLICY_IN	= 0,
136 	XFRM_POLICY_OUT	= 1,
137 	XFRM_POLICY_FWD	= 2,
138 	XFRM_POLICY_MASK = 3,
139 	XFRM_POLICY_MAX	= 3
140 };
141 
142 enum {
143 	XFRM_SHARE_ANY,		/* No limitations */
144 	XFRM_SHARE_SESSION,	/* For this session only */
145 	XFRM_SHARE_USER,	/* For this user only */
146 	XFRM_SHARE_UNIQUE	/* Use once */
147 };
148 
149 #define XFRM_MODE_TRANSPORT 0
150 #define XFRM_MODE_TUNNEL 1
151 #define XFRM_MODE_ROUTEOPTIMIZATION 2
152 #define XFRM_MODE_IN_TRIGGER 3
153 #define XFRM_MODE_BEET 4
154 #define XFRM_MODE_MAX 5
155 
156 /* Netlink configuration messages.  */
157 enum {
158 	XFRM_MSG_BASE = 0x10,
159 
160 	XFRM_MSG_NEWSA = 0x10,
161 #define XFRM_MSG_NEWSA XFRM_MSG_NEWSA
162 	XFRM_MSG_DELSA,
163 #define XFRM_MSG_DELSA XFRM_MSG_DELSA
164 	XFRM_MSG_GETSA,
165 #define XFRM_MSG_GETSA XFRM_MSG_GETSA
166 
167 	XFRM_MSG_NEWPOLICY,
168 #define XFRM_MSG_NEWPOLICY XFRM_MSG_NEWPOLICY
169 	XFRM_MSG_DELPOLICY,
170 #define XFRM_MSG_DELPOLICY XFRM_MSG_DELPOLICY
171 	XFRM_MSG_GETPOLICY,
172 #define XFRM_MSG_GETPOLICY XFRM_MSG_GETPOLICY
173 
174 	XFRM_MSG_ALLOCSPI,
175 #define XFRM_MSG_ALLOCSPI XFRM_MSG_ALLOCSPI
176 	XFRM_MSG_ACQUIRE,
177 #define XFRM_MSG_ACQUIRE XFRM_MSG_ACQUIRE
178 	XFRM_MSG_EXPIRE,
179 #define XFRM_MSG_EXPIRE XFRM_MSG_EXPIRE
180 
181 	XFRM_MSG_UPDPOLICY,
182 #define XFRM_MSG_UPDPOLICY XFRM_MSG_UPDPOLICY
183 	XFRM_MSG_UPDSA,
184 #define XFRM_MSG_UPDSA XFRM_MSG_UPDSA
185 
186 	XFRM_MSG_POLEXPIRE,
187 #define XFRM_MSG_POLEXPIRE XFRM_MSG_POLEXPIRE
188 
189 	XFRM_MSG_FLUSHSA,
190 #define XFRM_MSG_FLUSHSA XFRM_MSG_FLUSHSA
191 	XFRM_MSG_FLUSHPOLICY,
192 #define XFRM_MSG_FLUSHPOLICY XFRM_MSG_FLUSHPOLICY
193 
194 	XFRM_MSG_NEWAE,
195 #define XFRM_MSG_NEWAE XFRM_MSG_NEWAE
196 	XFRM_MSG_GETAE,
197 #define XFRM_MSG_GETAE XFRM_MSG_GETAE
198 
199 	XFRM_MSG_REPORT,
200 #define XFRM_MSG_REPORT XFRM_MSG_REPORT
201 
202 	XFRM_MSG_MIGRATE,
203 #define XFRM_MSG_MIGRATE XFRM_MSG_MIGRATE
204 
205 	XFRM_MSG_NEWSADINFO,
206 #define XFRM_MSG_NEWSADINFO XFRM_MSG_NEWSADINFO
207 	XFRM_MSG_GETSADINFO,
208 #define XFRM_MSG_GETSADINFO XFRM_MSG_GETSADINFO
209 
210 	XFRM_MSG_NEWSPDINFO,
211 #define XFRM_MSG_NEWSPDINFO XFRM_MSG_NEWSPDINFO
212 	XFRM_MSG_GETSPDINFO,
213 #define XFRM_MSG_GETSPDINFO XFRM_MSG_GETSPDINFO
214 
215 	XFRM_MSG_MAPPING,
216 #define XFRM_MSG_MAPPING XFRM_MSG_MAPPING
217 	__XFRM_MSG_MAX
218 };
219 #define XFRM_MSG_MAX (__XFRM_MSG_MAX - 1)
220 
221 #define XFRM_NR_MSGTYPES (XFRM_MSG_MAX + 1 - XFRM_MSG_BASE)
222 
223 /*
224  * Generic LSM security context for comunicating to user space
225  * NOTE: Same format as sadb_x_sec_ctx
226  */
227 struct xfrm_user_sec_ctx {
228 	__u16			len;
229 	__u16			exttype;
230 	__u8			ctx_alg;  /* LSMs: e.g., selinux == 1 */
231 	__u8			ctx_doi;
232 	__u16			ctx_len;
233 };
234 
235 struct xfrm_user_tmpl {
236 	struct xfrm_id		id;
237 	__u16			family;
238 	xfrm_address_t		saddr;
239 	__u32			reqid;
240 	__u8			mode;
241 	__u8			share;
242 	__u8			optional;
243 	__u32			aalgos;
244 	__u32			ealgos;
245 	__u32			calgos;
246 };
247 
248 struct xfrm_encap_tmpl {
249 	__u16		encap_type;
250 	__be16		encap_sport;
251 	__be16		encap_dport;
252 	xfrm_address_t	encap_oa;
253 };
254 
255 /* AEVENT flags  */
256 enum xfrm_ae_ftype_t {
257 	XFRM_AE_UNSPEC,
258 	XFRM_AE_RTHR=1,	/* replay threshold*/
259 	XFRM_AE_RVAL=2, /* replay value */
260 	XFRM_AE_LVAL=4, /* lifetime value */
261 	XFRM_AE_ETHR=8, /* expiry timer threshold */
262 	XFRM_AE_CR=16, /* Event cause is replay update */
263 	XFRM_AE_CE=32, /* Event cause is timer expiry */
264 	XFRM_AE_CU=64, /* Event cause is policy update */
265 	__XFRM_AE_MAX
266 
267 #define XFRM_AE_MAX (__XFRM_AE_MAX - 1)
268 };
269 
270 struct xfrm_userpolicy_type {
271 	__u8		type;
272 	__u16		reserved1;
273 	__u8		reserved2;
274 };
275 
276 /* Netlink message attributes.  */
277 enum xfrm_attr_type_t {
278 	XFRMA_UNSPEC,
279 	XFRMA_ALG_AUTH,		/* struct xfrm_algo */
280 	XFRMA_ALG_CRYPT,	/* struct xfrm_algo */
281 	XFRMA_ALG_COMP,		/* struct xfrm_algo */
282 	XFRMA_ENCAP,		/* struct xfrm_algo + struct xfrm_encap_tmpl */
283 	XFRMA_TMPL,		/* 1 or more struct xfrm_user_tmpl */
284 	XFRMA_SA,		/* struct xfrm_usersa_info  */
285 	XFRMA_POLICY,		/*struct xfrm_userpolicy_info */
286 	XFRMA_SEC_CTX,		/* struct xfrm_sec_ctx */
287 	XFRMA_LTIME_VAL,
288 	XFRMA_REPLAY_VAL,
289 	XFRMA_REPLAY_THRESH,
290 	XFRMA_ETIMER_THRESH,
291 	XFRMA_SRCADDR,		/* xfrm_address_t */
292 	XFRMA_COADDR,		/* xfrm_address_t */
293 	XFRMA_LASTUSED,		/* unsigned long  */
294 	XFRMA_POLICY_TYPE,	/* struct xfrm_userpolicy_type */
295 	XFRMA_MIGRATE,
296 	XFRMA_ALG_AEAD,		/* struct xfrm_algo_aead */
297 	XFRMA_KMADDRESS,        /* struct xfrm_user_kmaddress */
298 	XFRMA_ALG_AUTH_TRUNC,	/* struct xfrm_algo_auth */
299 	XFRMA_MARK,		/* struct xfrm_mark */
300 	XFRMA_TFCPAD,		/* __u32 */
301 	XFRMA_REPLAY_ESN_VAL,	/* struct xfrm_replay_state_esn */
302 	XFRMA_SA_EXTRA_FLAGS,	/* __u32 */
303 	XFRMA_PROTO,		/* __u8 */
304 	XFRMA_ADDRESS_FILTER,	/* struct xfrm_address_filter */
305 	XFRMA_PAD,
306 	XFRMA_OFFLOAD_DEV,	/* struct xfrm_state_offload */
307 	XFRMA_OUTPUT_MARK,	/* __u32 */
308 	__XFRMA_MAX
309 
310 #define XFRMA_MAX (__XFRMA_MAX - 1)
311 };
312 
313 struct xfrm_mark {
314 	__u32           v; /* value */
315 	__u32           m; /* mask */
316 };
317 
318 enum xfrm_sadattr_type_t {
319 	XFRMA_SAD_UNSPEC,
320 	XFRMA_SAD_CNT,
321 	XFRMA_SAD_HINFO,
322 	__XFRMA_SAD_MAX
323 
324 #define XFRMA_SAD_MAX (__XFRMA_SAD_MAX - 1)
325 };
326 
327 struct xfrmu_sadhinfo {
328 	__u32 sadhcnt; /* current hash bkts */
329 	__u32 sadhmcnt; /* max allowed hash bkts */
330 };
331 
332 enum xfrm_spdattr_type_t {
333 	XFRMA_SPD_UNSPEC,
334 	XFRMA_SPD_INFO,
335 	XFRMA_SPD_HINFO,
336 	XFRMA_SPD_IPV4_HTHRESH,
337 	XFRMA_SPD_IPV6_HTHRESH,
338 	__XFRMA_SPD_MAX
339 
340 #define XFRMA_SPD_MAX (__XFRMA_SPD_MAX - 1)
341 };
342 
343 struct xfrmu_spdinfo {
344 	__u32 incnt;
345 	__u32 outcnt;
346 	__u32 fwdcnt;
347 	__u32 inscnt;
348 	__u32 outscnt;
349 	__u32 fwdscnt;
350 };
351 
352 struct xfrmu_spdhinfo {
353 	__u32 spdhcnt;
354 	__u32 spdhmcnt;
355 };
356 
357 struct xfrmu_spdhthresh {
358 	__u8 lbits;
359 	__u8 rbits;
360 };
361 
362 struct xfrm_usersa_info {
363 	struct xfrm_selector		sel;
364 	struct xfrm_id			id;
365 	xfrm_address_t			saddr;
366 	struct xfrm_lifetime_cfg	lft;
367 	struct xfrm_lifetime_cur	curlft;
368 	struct xfrm_stats		stats;
369 	__u32				seq;
370 	__u32				reqid;
371 	__u16				family;
372 	__u8				mode;		/* XFRM_MODE_xxx */
373 	__u8				replay_window;
374 	__u8				flags;
375 #define XFRM_STATE_NOECN	1
376 #define XFRM_STATE_DECAP_DSCP	2
377 #define XFRM_STATE_NOPMTUDISC	4
378 #define XFRM_STATE_WILDRECV	8
379 #define XFRM_STATE_ICMP		16
380 #define XFRM_STATE_AF_UNSPEC	32
381 #define XFRM_STATE_ALIGN4	64
382 #define XFRM_STATE_ESN		128
383 };
384 
385 #define XFRM_SA_XFLAG_DONT_ENCAP_DSCP	1
386 
387 struct xfrm_usersa_id {
388 	xfrm_address_t			daddr;
389 	__be32				spi;
390 	__u16				family;
391 	__u8				proto;
392 };
393 
394 struct xfrm_aevent_id {
395 	struct xfrm_usersa_id		sa_id;
396 	xfrm_address_t			saddr;
397 	__u32				flags;
398 	__u32				reqid;
399 };
400 
401 struct xfrm_userspi_info {
402 	struct xfrm_usersa_info		info;
403 	__u32				min;
404 	__u32				max;
405 };
406 
407 struct xfrm_userpolicy_info {
408 	struct xfrm_selector		sel;
409 	struct xfrm_lifetime_cfg	lft;
410 	struct xfrm_lifetime_cur	curlft;
411 	__u32				priority;
412 	__u32				index;
413 	__u8				dir;
414 	__u8				action;
415 #define XFRM_POLICY_ALLOW	0
416 #define XFRM_POLICY_BLOCK	1
417 	__u8				flags;
418 #define XFRM_POLICY_LOCALOK	1	/* Allow user to override global policy */
419 	/* Automatically expand selector to include matching ICMP payloads. */
420 #define XFRM_POLICY_ICMP	2
421 	__u8				share;
422 };
423 
424 struct xfrm_userpolicy_id {
425 	struct xfrm_selector		sel;
426 	__u32				index;
427 	__u8				dir;
428 };
429 
430 struct xfrm_user_acquire {
431 	struct xfrm_id			id;
432 	xfrm_address_t			saddr;
433 	struct xfrm_selector		sel;
434 	struct xfrm_userpolicy_info	policy;
435 	__u32				aalgos;
436 	__u32				ealgos;
437 	__u32				calgos;
438 	__u32				seq;
439 };
440 
441 struct xfrm_user_expire {
442 	struct xfrm_usersa_info		state;
443 	__u8				hard;
444 };
445 
446 struct xfrm_user_polexpire {
447 	struct xfrm_userpolicy_info	pol;
448 	__u8				hard;
449 };
450 
451 struct xfrm_usersa_flush {
452 	__u8				proto;
453 };
454 
455 struct xfrm_user_report {
456 	__u8				proto;
457 	struct xfrm_selector		sel;
458 };
459 
460 /* Used by MIGRATE to pass addresses IKE should use to perform
461  * SA negotiation with the peer */
462 struct xfrm_user_kmaddress {
463 	xfrm_address_t                  local;
464 	xfrm_address_t                  remote;
465 	__u32				reserved;
466 	__u16				family;
467 };
468 
469 struct xfrm_user_migrate {
470 	xfrm_address_t			old_daddr;
471 	xfrm_address_t			old_saddr;
472 	xfrm_address_t			new_daddr;
473 	xfrm_address_t			new_saddr;
474 	__u8				proto;
475 	__u8				mode;
476 	__u16				reserved;
477 	__u32				reqid;
478 	__u16				old_family;
479 	__u16				new_family;
480 };
481 
482 struct xfrm_user_mapping {
483 	struct xfrm_usersa_id		id;
484 	__u32				reqid;
485 	xfrm_address_t			old_saddr;
486 	xfrm_address_t			new_saddr;
487 	__be16				old_sport;
488 	__be16				new_sport;
489 };
490 
491 struct xfrm_address_filter {
492 	xfrm_address_t			saddr;
493 	xfrm_address_t			daddr;
494 	__u16				family;
495 	__u8				splen;
496 	__u8				dplen;
497 };
498 
499 struct xfrm_user_offload {
500 	int				ifindex;
501 	__u8				flags;
502 };
503 #define XFRM_OFFLOAD_IPV6	1
504 #define XFRM_OFFLOAD_INBOUND	2
505 
506 #ifndef __KERNEL__
507 /* backwards compatibility for userspace */
508 #define XFRMGRP_ACQUIRE		1
509 #define XFRMGRP_EXPIRE		2
510 #define XFRMGRP_SA		4
511 #define XFRMGRP_POLICY		8
512 #define XFRMGRP_REPORT		0x20
513 #endif
514 
515 enum xfrm_nlgroups {
516 	XFRMNLGRP_NONE,
517 #define XFRMNLGRP_NONE		XFRMNLGRP_NONE
518 	XFRMNLGRP_ACQUIRE,
519 #define XFRMNLGRP_ACQUIRE	XFRMNLGRP_ACQUIRE
520 	XFRMNLGRP_EXPIRE,
521 #define XFRMNLGRP_EXPIRE	XFRMNLGRP_EXPIRE
522 	XFRMNLGRP_SA,
523 #define XFRMNLGRP_SA		XFRMNLGRP_SA
524 	XFRMNLGRP_POLICY,
525 #define XFRMNLGRP_POLICY	XFRMNLGRP_POLICY
526 	XFRMNLGRP_AEVENTS,
527 #define XFRMNLGRP_AEVENTS	XFRMNLGRP_AEVENTS
528 	XFRMNLGRP_REPORT,
529 #define XFRMNLGRP_REPORT	XFRMNLGRP_REPORT
530 	XFRMNLGRP_MIGRATE,
531 #define XFRMNLGRP_MIGRATE	XFRMNLGRP_MIGRATE
532 	XFRMNLGRP_MAPPING,
533 #define XFRMNLGRP_MAPPING	XFRMNLGRP_MAPPING
534 	__XFRMNLGRP_MAX
535 };
536 #define XFRMNLGRP_MAX	(__XFRMNLGRP_MAX - 1)
537 
538 #endif /* _LINUX_XFRM_H */
539