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