[IPV4]: encapsulation annotations
[deliverable/linux.git] / include / linux / xfrm.h
1 #ifndef _LINUX_XFRM_H
2 #define _LINUX_XFRM_H
3
4 #include <linux/types.h>
5
6 /* All of the structures in this file may not change size as they are
7 * passed into the kernel from userspace via netlink sockets.
8 */
9
10 /* Structure to encapsulate addresses. I do not want to use
11 * "standard" structure. My apologies.
12 */
13 typedef union
14 {
15 __be32 a4;
16 __be32 a6[4];
17 } xfrm_address_t;
18
19 /* Ident of a specific xfrm_state. It is used on input to lookup
20 * the state by (spi,daddr,ah/esp) or to store information about
21 * spi, protocol and tunnel address on output.
22 */
23 struct xfrm_id
24 {
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 {
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 uid_t user;
62 };
63
64 #define XFRM_INF (~(__u64)0)
65
66 struct xfrm_lifetime_cfg
67 {
68 __u64 soft_byte_limit;
69 __u64 hard_byte_limit;
70 __u64 soft_packet_limit;
71 __u64 hard_packet_limit;
72 __u64 soft_add_expires_seconds;
73 __u64 hard_add_expires_seconds;
74 __u64 soft_use_expires_seconds;
75 __u64 hard_use_expires_seconds;
76 };
77
78 struct xfrm_lifetime_cur
79 {
80 __u64 bytes;
81 __u64 packets;
82 __u64 add_time;
83 __u64 use_time;
84 };
85
86 struct xfrm_replay_state
87 {
88 __u32 oseq;
89 __u32 seq;
90 __u32 bitmap;
91 };
92
93 struct xfrm_algo {
94 char alg_name[64];
95 int alg_key_len; /* in bits */
96 char alg_key[0];
97 };
98
99 struct xfrm_stats {
100 __u32 replay_window;
101 __u32 replay;
102 __u32 integrity_failed;
103 };
104
105 enum
106 {
107 XFRM_POLICY_TYPE_MAIN = 0,
108 XFRM_POLICY_TYPE_SUB = 1,
109 XFRM_POLICY_TYPE_MAX = 2
110 };
111
112 enum
113 {
114 XFRM_POLICY_IN = 0,
115 XFRM_POLICY_OUT = 1,
116 XFRM_POLICY_FWD = 2,
117 XFRM_POLICY_MAX = 3
118 };
119
120 enum
121 {
122 XFRM_SHARE_ANY, /* No limitations */
123 XFRM_SHARE_SESSION, /* For this session only */
124 XFRM_SHARE_USER, /* For this user only */
125 XFRM_SHARE_UNIQUE /* Use once */
126 };
127
128 #define XFRM_MODE_TRANSPORT 0
129 #define XFRM_MODE_TUNNEL 1
130 #define XFRM_MODE_ROUTEOPTIMIZATION 2
131 #define XFRM_MODE_IN_TRIGGER 3
132 #define XFRM_MODE_BEET 4
133 #define XFRM_MODE_MAX 5
134
135 /* Netlink configuration messages. */
136 enum {
137 XFRM_MSG_BASE = 0x10,
138
139 XFRM_MSG_NEWSA = 0x10,
140 #define XFRM_MSG_NEWSA XFRM_MSG_NEWSA
141 XFRM_MSG_DELSA,
142 #define XFRM_MSG_DELSA XFRM_MSG_DELSA
143 XFRM_MSG_GETSA,
144 #define XFRM_MSG_GETSA XFRM_MSG_GETSA
145
146 XFRM_MSG_NEWPOLICY,
147 #define XFRM_MSG_NEWPOLICY XFRM_MSG_NEWPOLICY
148 XFRM_MSG_DELPOLICY,
149 #define XFRM_MSG_DELPOLICY XFRM_MSG_DELPOLICY
150 XFRM_MSG_GETPOLICY,
151 #define XFRM_MSG_GETPOLICY XFRM_MSG_GETPOLICY
152
153 XFRM_MSG_ALLOCSPI,
154 #define XFRM_MSG_ALLOCSPI XFRM_MSG_ALLOCSPI
155 XFRM_MSG_ACQUIRE,
156 #define XFRM_MSG_ACQUIRE XFRM_MSG_ACQUIRE
157 XFRM_MSG_EXPIRE,
158 #define XFRM_MSG_EXPIRE XFRM_MSG_EXPIRE
159
160 XFRM_MSG_UPDPOLICY,
161 #define XFRM_MSG_UPDPOLICY XFRM_MSG_UPDPOLICY
162 XFRM_MSG_UPDSA,
163 #define XFRM_MSG_UPDSA XFRM_MSG_UPDSA
164
165 XFRM_MSG_POLEXPIRE,
166 #define XFRM_MSG_POLEXPIRE XFRM_MSG_POLEXPIRE
167
168 XFRM_MSG_FLUSHSA,
169 #define XFRM_MSG_FLUSHSA XFRM_MSG_FLUSHSA
170 XFRM_MSG_FLUSHPOLICY,
171 #define XFRM_MSG_FLUSHPOLICY XFRM_MSG_FLUSHPOLICY
172
173 XFRM_MSG_NEWAE,
174 #define XFRM_MSG_NEWAE XFRM_MSG_NEWAE
175 XFRM_MSG_GETAE,
176 #define XFRM_MSG_GETAE XFRM_MSG_GETAE
177
178 XFRM_MSG_REPORT,
179 #define XFRM_MSG_REPORT XFRM_MSG_REPORT
180
181 __XFRM_MSG_MAX
182 };
183 #define XFRM_MSG_MAX (__XFRM_MSG_MAX - 1)
184
185 #define XFRM_NR_MSGTYPES (XFRM_MSG_MAX + 1 - XFRM_MSG_BASE)
186
187 /*
188 * Generic LSM security context for comunicating to user space
189 * NOTE: Same format as sadb_x_sec_ctx
190 */
191 struct xfrm_user_sec_ctx {
192 __u16 len;
193 __u16 exttype;
194 __u8 ctx_alg; /* LSMs: e.g., selinux == 1 */
195 __u8 ctx_doi;
196 __u16 ctx_len;
197 };
198
199 struct xfrm_user_tmpl {
200 struct xfrm_id id;
201 __u16 family;
202 xfrm_address_t saddr;
203 __u32 reqid;
204 __u8 mode;
205 __u8 share;
206 __u8 optional;
207 __u32 aalgos;
208 __u32 ealgos;
209 __u32 calgos;
210 };
211
212 struct xfrm_encap_tmpl {
213 __u16 encap_type;
214 __be16 encap_sport;
215 __be16 encap_dport;
216 xfrm_address_t encap_oa;
217 };
218
219 /* AEVENT flags */
220 enum xfrm_ae_ftype_t {
221 XFRM_AE_UNSPEC,
222 XFRM_AE_RTHR=1, /* replay threshold*/
223 XFRM_AE_RVAL=2, /* replay value */
224 XFRM_AE_LVAL=4, /* lifetime value */
225 XFRM_AE_ETHR=8, /* expiry timer threshold */
226 XFRM_AE_CR=16, /* Event cause is replay update */
227 XFRM_AE_CE=32, /* Event cause is timer expiry */
228 XFRM_AE_CU=64, /* Event cause is policy update */
229 __XFRM_AE_MAX
230
231 #define XFRM_AE_MAX (__XFRM_AE_MAX - 1)
232 };
233
234 struct xfrm_userpolicy_type {
235 __u8 type;
236 __u16 reserved1;
237 __u8 reserved2;
238 };
239
240 /* Netlink message attributes. */
241 enum xfrm_attr_type_t {
242 XFRMA_UNSPEC,
243 XFRMA_ALG_AUTH, /* struct xfrm_algo */
244 XFRMA_ALG_CRYPT, /* struct xfrm_algo */
245 XFRMA_ALG_COMP, /* struct xfrm_algo */
246 XFRMA_ENCAP, /* struct xfrm_algo + struct xfrm_encap_tmpl */
247 XFRMA_TMPL, /* 1 or more struct xfrm_user_tmpl */
248 XFRMA_SA,
249 XFRMA_POLICY,
250 XFRMA_SEC_CTX, /* struct xfrm_sec_ctx */
251 XFRMA_LTIME_VAL,
252 XFRMA_REPLAY_VAL,
253 XFRMA_REPLAY_THRESH,
254 XFRMA_ETIMER_THRESH,
255 XFRMA_SRCADDR, /* xfrm_address_t */
256 XFRMA_COADDR, /* xfrm_address_t */
257 XFRMA_LASTUSED,
258 XFRMA_POLICY_TYPE, /* struct xfrm_userpolicy_type */
259 __XFRMA_MAX
260
261 #define XFRMA_MAX (__XFRMA_MAX - 1)
262 };
263
264 struct xfrm_usersa_info {
265 struct xfrm_selector sel;
266 struct xfrm_id id;
267 xfrm_address_t saddr;
268 struct xfrm_lifetime_cfg lft;
269 struct xfrm_lifetime_cur curlft;
270 struct xfrm_stats stats;
271 __u32 seq;
272 __u32 reqid;
273 __u16 family;
274 __u8 mode; /* XFRM_MODE_xxx */
275 __u8 replay_window;
276 __u8 flags;
277 #define XFRM_STATE_NOECN 1
278 #define XFRM_STATE_DECAP_DSCP 2
279 #define XFRM_STATE_NOPMTUDISC 4
280 #define XFRM_STATE_WILDRECV 8
281 };
282
283 struct xfrm_usersa_id {
284 xfrm_address_t daddr;
285 __be32 spi;
286 __u16 family;
287 __u8 proto;
288 };
289
290 struct xfrm_aevent_id {
291 struct xfrm_usersa_id sa_id;
292 __u32 flags;
293 };
294
295 struct xfrm_userspi_info {
296 struct xfrm_usersa_info info;
297 __u32 min;
298 __u32 max;
299 };
300
301 struct xfrm_userpolicy_info {
302 struct xfrm_selector sel;
303 struct xfrm_lifetime_cfg lft;
304 struct xfrm_lifetime_cur curlft;
305 __u32 priority;
306 __u32 index;
307 __u8 dir;
308 __u8 action;
309 #define XFRM_POLICY_ALLOW 0
310 #define XFRM_POLICY_BLOCK 1
311 __u8 flags;
312 #define XFRM_POLICY_LOCALOK 1 /* Allow user to override global policy */
313 __u8 share;
314 };
315
316 struct xfrm_userpolicy_id {
317 struct xfrm_selector sel;
318 __u32 index;
319 __u8 dir;
320 };
321
322 struct xfrm_user_acquire {
323 struct xfrm_id id;
324 xfrm_address_t saddr;
325 struct xfrm_selector sel;
326 struct xfrm_userpolicy_info policy;
327 __u32 aalgos;
328 __u32 ealgos;
329 __u32 calgos;
330 __u32 seq;
331 };
332
333 struct xfrm_user_expire {
334 struct xfrm_usersa_info state;
335 __u8 hard;
336 };
337
338 struct xfrm_user_polexpire {
339 struct xfrm_userpolicy_info pol;
340 __u8 hard;
341 };
342
343 struct xfrm_usersa_flush {
344 __u8 proto;
345 };
346
347 struct xfrm_user_report {
348 __u8 proto;
349 struct xfrm_selector sel;
350 };
351
352 #ifndef __KERNEL__
353 /* backwards compatibility for userspace */
354 #define XFRMGRP_ACQUIRE 1
355 #define XFRMGRP_EXPIRE 2
356 #define XFRMGRP_SA 4
357 #define XFRMGRP_POLICY 8
358 #define XFRMGRP_REPORT 0x10
359 #endif
360
361 enum xfrm_nlgroups {
362 XFRMNLGRP_NONE,
363 #define XFRMNLGRP_NONE XFRMNLGRP_NONE
364 XFRMNLGRP_ACQUIRE,
365 #define XFRMNLGRP_ACQUIRE XFRMNLGRP_ACQUIRE
366 XFRMNLGRP_EXPIRE,
367 #define XFRMNLGRP_EXPIRE XFRMNLGRP_EXPIRE
368 XFRMNLGRP_SA,
369 #define XFRMNLGRP_SA XFRMNLGRP_SA
370 XFRMNLGRP_POLICY,
371 #define XFRMNLGRP_POLICY XFRMNLGRP_POLICY
372 XFRMNLGRP_AEVENTS,
373 #define XFRMNLGRP_AEVENTS XFRMNLGRP_AEVENTS
374 XFRMNLGRP_REPORT,
375 #define XFRMNLGRP_REPORT XFRMNLGRP_REPORT
376 __XFRMNLGRP_MAX
377 };
378 #define XFRMNLGRP_MAX (__XFRMNLGRP_MAX - 1)
379
380 #endif /* _LINUX_XFRM_H */
This page took 0.039641 seconds and 6 git commands to generate.