]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/xfrm.h
[XFRM]: xfrm_state_lookup() annotations
[mirror_ubuntu-artful-kernel.git] / include / linux / xfrm.h
CommitLineData
1da177e4
LT
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 */
13typedef union
14{
737b5761
AV
15 __be32 a4;
16 __be32 a6[4];
1da177e4
LT
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 */
23struct xfrm_id
24{
25 xfrm_address_t daddr;
26 __u32 spi;
27 __u8 proto;
28};
29
df71837d
TJ
30struct 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
1da177e4
LT
46/* Selector, used as selector both on policy rules (SPD) and SAs. */
47
48struct xfrm_selector
49{
50 xfrm_address_t daddr;
51 xfrm_address_t saddr;
8f83f23e
AV
52 __be16 dport;
53 __be16 dport_mask;
54 __be16 sport;
55 __be16 sport_mask;
1da177e4
LT
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
66struct 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
78struct xfrm_lifetime_cur
79{
80 __u64 bytes;
81 __u64 packets;
82 __u64 add_time;
83 __u64 use_time;
84};
85
86struct xfrm_replay_state
87{
88 __u32 oseq;
89 __u32 seq;
90 __u32 bitmap;
91};
92
93struct xfrm_algo {
94 char alg_name[64];
95 int alg_key_len; /* in bits */
96 char alg_key[0];
97};
98
99struct xfrm_stats {
100 __u32 replay_window;
101 __u32 replay;
102 __u32 integrity_failed;
103};
104
4e81bb83
MN
105enum
106{
107 XFRM_POLICY_TYPE_MAIN = 0,
108 XFRM_POLICY_TYPE_SUB = 1,
109 XFRM_POLICY_TYPE_MAX = 2
110};
111
1da177e4
LT
112enum
113{
114 XFRM_POLICY_IN = 0,
115 XFRM_POLICY_OUT = 1,
116 XFRM_POLICY_FWD = 2,
117 XFRM_POLICY_MAX = 3
118};
119
120enum
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
b59f45d0
HX
128#define XFRM_MODE_TRANSPORT 0
129#define XFRM_MODE_TUNNEL 1
7e49e6de
MN
130#define XFRM_MODE_ROUTEOPTIMIZATION 2
131#define XFRM_MODE_IN_TRIGGER 3
132#define XFRM_MODE_MAX 4
b59f45d0 133
1da177e4
LT
134/* Netlink configuration messages. */
135enum {
136 XFRM_MSG_BASE = 0x10,
137
138 XFRM_MSG_NEWSA = 0x10,
139#define XFRM_MSG_NEWSA XFRM_MSG_NEWSA
140 XFRM_MSG_DELSA,
141#define XFRM_MSG_DELSA XFRM_MSG_DELSA
142 XFRM_MSG_GETSA,
143#define XFRM_MSG_GETSA XFRM_MSG_GETSA
144
145 XFRM_MSG_NEWPOLICY,
146#define XFRM_MSG_NEWPOLICY XFRM_MSG_NEWPOLICY
147 XFRM_MSG_DELPOLICY,
148#define XFRM_MSG_DELPOLICY XFRM_MSG_DELPOLICY
149 XFRM_MSG_GETPOLICY,
150#define XFRM_MSG_GETPOLICY XFRM_MSG_GETPOLICY
151
152 XFRM_MSG_ALLOCSPI,
153#define XFRM_MSG_ALLOCSPI XFRM_MSG_ALLOCSPI
154 XFRM_MSG_ACQUIRE,
155#define XFRM_MSG_ACQUIRE XFRM_MSG_ACQUIRE
156 XFRM_MSG_EXPIRE,
157#define XFRM_MSG_EXPIRE XFRM_MSG_EXPIRE
158
159 XFRM_MSG_UPDPOLICY,
160#define XFRM_MSG_UPDPOLICY XFRM_MSG_UPDPOLICY
161 XFRM_MSG_UPDSA,
162#define XFRM_MSG_UPDSA XFRM_MSG_UPDSA
163
164 XFRM_MSG_POLEXPIRE,
165#define XFRM_MSG_POLEXPIRE XFRM_MSG_POLEXPIRE
166
167 XFRM_MSG_FLUSHSA,
168#define XFRM_MSG_FLUSHSA XFRM_MSG_FLUSHSA
169 XFRM_MSG_FLUSHPOLICY,
170#define XFRM_MSG_FLUSHPOLICY XFRM_MSG_FLUSHPOLICY
171
f8cd5488
JHS
172 XFRM_MSG_NEWAE,
173#define XFRM_MSG_NEWAE XFRM_MSG_NEWAE
174 XFRM_MSG_GETAE,
175#define XFRM_MSG_GETAE XFRM_MSG_GETAE
97a64b45
MN
176
177 XFRM_MSG_REPORT,
178#define XFRM_MSG_REPORT XFRM_MSG_REPORT
179
526bdb80 180 __XFRM_MSG_MAX
1da177e4 181};
526bdb80 182#define XFRM_MSG_MAX (__XFRM_MSG_MAX - 1)
1da177e4 183
492b558b
TG
184#define XFRM_NR_MSGTYPES (XFRM_MSG_MAX + 1 - XFRM_MSG_BASE)
185
df71837d
TJ
186/*
187 * Generic LSM security context for comunicating to user space
188 * NOTE: Same format as sadb_x_sec_ctx
189 */
190struct xfrm_user_sec_ctx {
191 __u16 len;
192 __u16 exttype;
193 __u8 ctx_alg; /* LSMs: e.g., selinux == 1 */
194 __u8 ctx_doi;
195 __u16 ctx_len;
196};
197
1da177e4
LT
198struct xfrm_user_tmpl {
199 struct xfrm_id id;
200 __u16 family;
201 xfrm_address_t saddr;
202 __u32 reqid;
203 __u8 mode;
204 __u8 share;
205 __u8 optional;
206 __u32 aalgos;
207 __u32 ealgos;
208 __u32 calgos;
209};
210
211struct xfrm_encap_tmpl {
212 __u16 encap_type;
213 __u16 encap_sport;
214 __u16 encap_dport;
215 xfrm_address_t encap_oa;
216};
217
f8cd5488
JHS
218/* AEVENT flags */
219enum xfrm_ae_ftype_t {
220 XFRM_AE_UNSPEC,
221 XFRM_AE_RTHR=1, /* replay threshold*/
222 XFRM_AE_RVAL=2, /* replay value */
223 XFRM_AE_LVAL=4, /* lifetime value */
224 XFRM_AE_ETHR=8, /* expiry timer threshold */
225 XFRM_AE_CR=16, /* Event cause is replay update */
226 XFRM_AE_CE=32, /* Event cause is timer expiry */
227 XFRM_AE_CU=64, /* Event cause is policy update */
228 __XFRM_AE_MAX
229
230#define XFRM_AE_MAX (__XFRM_AE_MAX - 1)
231};
232
f7b6983f
MN
233struct xfrm_userpolicy_type {
234 __u8 type;
235 __u16 reserved1;
236 __u8 reserved2;
237};
238
1da177e4
LT
239/* Netlink message attributes. */
240enum xfrm_attr_type_t {
241 XFRMA_UNSPEC,
242 XFRMA_ALG_AUTH, /* struct xfrm_algo */
243 XFRMA_ALG_CRYPT, /* struct xfrm_algo */
244 XFRMA_ALG_COMP, /* struct xfrm_algo */
245 XFRMA_ENCAP, /* struct xfrm_algo + struct xfrm_encap_tmpl */
246 XFRMA_TMPL, /* 1 or more struct xfrm_user_tmpl */
0603eac0
HX
247 XFRMA_SA,
248 XFRMA_POLICY,
df71837d 249 XFRMA_SEC_CTX, /* struct xfrm_sec_ctx */
f8cd5488
JHS
250 XFRMA_LTIME_VAL,
251 XFRMA_REPLAY_VAL,
252 XFRMA_REPLAY_THRESH,
253 XFRMA_ETIMER_THRESH,
eb2971b6 254 XFRMA_SRCADDR, /* xfrm_address_t */
060f02a3 255 XFRMA_COADDR, /* xfrm_address_t */
9afaca05 256 XFRMA_LASTUSED,
f7b6983f 257 XFRMA_POLICY_TYPE, /* struct xfrm_userpolicy_type */
1da177e4
LT
258 __XFRMA_MAX
259
260#define XFRMA_MAX (__XFRMA_MAX - 1)
261};
262
263struct xfrm_usersa_info {
264 struct xfrm_selector sel;
265 struct xfrm_id id;
266 xfrm_address_t saddr;
267 struct xfrm_lifetime_cfg lft;
268 struct xfrm_lifetime_cur curlft;
269 struct xfrm_stats stats;
270 __u32 seq;
271 __u32 reqid;
272 __u16 family;
7e49e6de 273 __u8 mode; /* XFRM_MODE_xxx */
1da177e4
LT
274 __u8 replay_window;
275 __u8 flags;
276#define XFRM_STATE_NOECN 1
277#define XFRM_STATE_DECAP_DSCP 2
dd87147e 278#define XFRM_STATE_NOPMTUDISC 4
fbd9a5b4 279#define XFRM_STATE_WILDRECV 8
1da177e4
LT
280};
281
282struct xfrm_usersa_id {
283 xfrm_address_t daddr;
284 __u32 spi;
285 __u16 family;
286 __u8 proto;
287};
288
f8cd5488 289struct xfrm_aevent_id {
f8cd5488 290 struct xfrm_usersa_id sa_id;
4bf07ef3 291 __u32 flags;
f8cd5488
JHS
292};
293
1da177e4
LT
294struct xfrm_userspi_info {
295 struct xfrm_usersa_info info;
296 __u32 min;
297 __u32 max;
298};
299
300struct xfrm_userpolicy_info {
301 struct xfrm_selector sel;
302 struct xfrm_lifetime_cfg lft;
303 struct xfrm_lifetime_cur curlft;
304 __u32 priority;
305 __u32 index;
306 __u8 dir;
307 __u8 action;
308#define XFRM_POLICY_ALLOW 0
309#define XFRM_POLICY_BLOCK 1
310 __u8 flags;
311#define XFRM_POLICY_LOCALOK 1 /* Allow user to override global policy */
312 __u8 share;
313};
314
315struct xfrm_userpolicy_id {
316 struct xfrm_selector sel;
317 __u32 index;
318 __u8 dir;
319};
320
321struct xfrm_user_acquire {
322 struct xfrm_id id;
323 xfrm_address_t saddr;
324 struct xfrm_selector sel;
325 struct xfrm_userpolicy_info policy;
326 __u32 aalgos;
327 __u32 ealgos;
328 __u32 calgos;
329 __u32 seq;
330};
331
332struct xfrm_user_expire {
333 struct xfrm_usersa_info state;
334 __u8 hard;
335};
336
337struct xfrm_user_polexpire {
338 struct xfrm_userpolicy_info pol;
339 __u8 hard;
340};
341
342struct xfrm_usersa_flush {
343 __u8 proto;
344};
345
97a64b45
MN
346struct xfrm_user_report {
347 __u8 proto;
348 struct xfrm_selector sel;
349};
350
ac6d439d
PM
351#ifndef __KERNEL__
352/* backwards compatibility for userspace */
1da177e4
LT
353#define XFRMGRP_ACQUIRE 1
354#define XFRMGRP_EXPIRE 2
26b15dad
JHS
355#define XFRMGRP_SA 4
356#define XFRMGRP_POLICY 8
97a64b45 357#define XFRMGRP_REPORT 0x10
ac6d439d
PM
358#endif
359
360enum xfrm_nlgroups {
361 XFRMNLGRP_NONE,
362#define XFRMNLGRP_NONE XFRMNLGRP_NONE
363 XFRMNLGRP_ACQUIRE,
364#define XFRMNLGRP_ACQUIRE XFRMNLGRP_ACQUIRE
365 XFRMNLGRP_EXPIRE,
366#define XFRMNLGRP_EXPIRE XFRMNLGRP_EXPIRE
367 XFRMNLGRP_SA,
368#define XFRMNLGRP_SA XFRMNLGRP_SA
369 XFRMNLGRP_POLICY,
370#define XFRMNLGRP_POLICY XFRMNLGRP_POLICY
f8cd5488
JHS
371 XFRMNLGRP_AEVENTS,
372#define XFRMNLGRP_AEVENTS XFRMNLGRP_AEVENTS
97a64b45
MN
373 XFRMNLGRP_REPORT,
374#define XFRMNLGRP_REPORT XFRMNLGRP_REPORT
ac6d439d
PM
375 __XFRMNLGRP_MAX
376};
377#define XFRMNLGRP_MAX (__XFRMNLGRP_MAX - 1)
1da177e4
LT
378
379#endif /* _LINUX_XFRM_H */