Added an esn parameter to the kernel interface add_sa functions
[strongswan.git] / src / libhydra / kernel / kernel_interface.h
1 /*
2 * Copyright (C) 2006-2010 Tobias Brunner
3 * Copyright (C) 2006 Daniel Roethlisberger
4 * Copyright (C) 2005-2006 Martin Willi
5 * Copyright (C) 2005 Jan Hutter
6 * Hochschule fuer Technik Rapperswil
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * for more details.
17 */
18
19 /**
20 * @defgroup kernel_interface kernel_interface
21 * @{ @ingroup hkernel
22 */
23
24 #ifndef KERNEL_INTERFACE_H_
25 #define KERNEL_INTERFACE_H_
26
27 typedef struct kernel_interface_t kernel_interface_t;
28
29 #include <utils/host.h>
30 #include <crypto/prf_plus.h>
31
32 #include <kernel/kernel_listener.h>
33 #include <kernel/kernel_ipsec.h>
34 #include <kernel/kernel_net.h>
35
36 /**
37 * Constructor function for ipsec kernel interface
38 */
39 typedef kernel_ipsec_t* (*kernel_ipsec_constructor_t)(void);
40
41 /**
42 * Constructor function for network kernel interface
43 */
44 typedef kernel_net_t* (*kernel_net_constructor_t)(void);
45
46 /**
47 * Manager and wrapper for different kernel interfaces.
48 *
49 * The kernel interface handles the communication with the kernel
50 * for SA and policy management and interface and IP address management.
51 */
52 struct kernel_interface_t {
53
54 /**
55 * Get a SPI from the kernel.
56 *
57 * @param src source address of SA
58 * @param dst destination address of SA
59 * @param protocol protocol for SA (ESP/AH)
60 * @param reqid unique ID for this SA
61 * @param spi allocated spi
62 * @return SUCCESS if operation completed
63 */
64 status_t (*get_spi)(kernel_interface_t *this, host_t *src, host_t *dst,
65 u_int8_t protocol, u_int32_t reqid, u_int32_t *spi);
66
67 /**
68 * Get a Compression Parameter Index (CPI) from the kernel.
69 *
70 * @param src source address of SA
71 * @param dst destination address of SA
72 * @param reqid unique ID for the corresponding SA
73 * @param cpi allocated cpi
74 * @return SUCCESS if operation completed
75 */
76 status_t (*get_cpi)(kernel_interface_t *this, host_t *src, host_t *dst,
77 u_int32_t reqid, u_int16_t *cpi);
78
79 /**
80 * Add an SA to the SAD.
81 *
82 * add_sa() may update an already allocated
83 * SPI (via get_spi). In this case, the replace
84 * flag must be set.
85 * This function does install a single SA for a
86 * single protocol in one direction.
87 *
88 * @param src source address for this SA
89 * @param dst destination address for this SA
90 * @param spi SPI allocated by us or remote peer
91 * @param protocol protocol for this SA (ESP/AH)
92 * @param reqid unique ID for this SA
93 * @param mark optional mark for this SA
94 * @param tfc Traffic Flow Confidentiality padding for this SA
95 * @param lifetime lifetime_cfg_t for this SA
96 * @param enc_alg Algorithm to use for encryption (ESP only)
97 * @param enc_key key to use for encryption
98 * @param int_alg Algorithm to use for integrity protection
99 * @param int_key key to use for integrity protection
100 * @param mode mode of the SA (tunnel, transport)
101 * @param ipcomp IPComp transform to use
102 * @param cpi CPI for IPComp
103 * @param encap enable UDP encapsulation for NAT traversal
104 * @param esn TRUE to use Extended Sequence Numbers
105 * @param inbound TRUE if this is an inbound SA
106 * @param src_ts traffic selector with BEET source address
107 * @param dst_ts traffic selector with BEET destination address
108 * @return SUCCESS if operation completed
109 */
110 status_t (*add_sa) (kernel_interface_t *this,
111 host_t *src, host_t *dst, u_int32_t spi,
112 u_int8_t protocol, u_int32_t reqid, mark_t mark,
113 u_int32_t tfc, lifetime_cfg_t *lifetime,
114 u_int16_t enc_alg, chunk_t enc_key,
115 u_int16_t int_alg, chunk_t int_key,
116 ipsec_mode_t mode, u_int16_t ipcomp, u_int16_t cpi,
117 bool encap, bool esn, bool inbound,
118 traffic_selector_t *src_ts, traffic_selector_t *dst_ts);
119
120 /**
121 * Update the hosts on an installed SA.
122 *
123 * We cannot directly update the destination address as the kernel
124 * requires the spi, the protocol AND the destination address (and family)
125 * to identify SAs. Therefore if the destination address changed we
126 * create a new SA and delete the old one.
127 *
128 * @param spi SPI of the SA
129 * @param protocol protocol for this SA (ESP/AH)
130 * @param cpi CPI for IPComp, 0 if no IPComp is used
131 * @param src current source address
132 * @param dst current destination address
133 * @param new_src new source address
134 * @param new_dst new destination address
135 * @param encap current use of UDP encapsulation
136 * @param new_encap new use of UDP encapsulation
137 * @param mark optional mark for this SA
138 * @return SUCCESS if operation completed, NOT_SUPPORTED if
139 * the kernel interface can't update the SA
140 */
141 status_t (*update_sa)(kernel_interface_t *this,
142 u_int32_t spi, u_int8_t protocol, u_int16_t cpi,
143 host_t *src, host_t *dst,
144 host_t *new_src, host_t *new_dst,
145 bool encap, bool new_encap, mark_t mark);
146
147 /**
148 * Query the number of bytes processed by an SA from the SAD.
149 *
150 * @param src source address for this SA
151 * @param dst destination address for this SA
152 * @param spi SPI allocated by us or remote peer
153 * @param protocol protocol for this SA (ESP/AH)
154 * @param mark optional mark for this SA
155 * @param[out] bytes the number of bytes processed by SA
156 * @return SUCCESS if operation completed
157 */
158 status_t (*query_sa) (kernel_interface_t *this, host_t *src, host_t *dst,
159 u_int32_t spi, u_int8_t protocol, mark_t mark,
160 u_int64_t *bytes);
161
162 /**
163 * Delete a previously installed SA from the SAD.
164 *
165 * @param src source address for this SA
166 * @param dst destination address for this SA
167 * @param spi SPI allocated by us or remote peer
168 * @param protocol protocol for this SA (ESP/AH)
169 * @param cpi CPI for IPComp or 0
170 * @param mark optional mark for this SA
171 * @return SUCCESS if operation completed
172 */
173 status_t (*del_sa) (kernel_interface_t *this, host_t *src, host_t *dst,
174 u_int32_t spi, u_int8_t protocol, u_int16_t cpi,
175 mark_t mark);
176
177 /**
178 * Add a policy to the SPD.
179 *
180 * A policy is always associated to an SA. Traffic which matches a
181 * policy is handled by the SA with the same reqid.
182 *
183 * @param src source address of SA
184 * @param dst dest address of SA
185 * @param src_ts traffic selector to match traffic source
186 * @param dst_ts traffic selector to match traffic dest
187 * @param direction direction of traffic, POLICY_(IN|OUT|FWD)
188 * @param type type of policy, POLICY_(IPSEC|PASS|DROP)
189 * @param sa details about the SA(s) tied to this policy
190 * @param mark mark for this policy
191 * @param routed TRUE, if this policy is routed in the kernel
192 * @return SUCCESS if operation completed
193 */
194 status_t (*add_policy) (kernel_interface_t *this,
195 host_t *src, host_t *dst,
196 traffic_selector_t *src_ts,
197 traffic_selector_t *dst_ts,
198 policy_dir_t direction, policy_type_t type,
199 ipsec_sa_cfg_t *sa, mark_t mark, bool routed);
200
201 /**
202 * Query the use time of a policy.
203 *
204 * The use time of a policy is the time the policy was used
205 * for the last time.
206 *
207 * @param src_ts traffic selector to match traffic source
208 * @param dst_ts traffic selector to match traffic dest
209 * @param direction direction of traffic, POLICY_(IN|OUT|FWD)
210 * @param mark optional mark
211 * @param[out] use_time the time of this SA's last use
212 * @return SUCCESS if operation completed
213 */
214 status_t (*query_policy) (kernel_interface_t *this,
215 traffic_selector_t *src_ts,
216 traffic_selector_t *dst_ts,
217 policy_dir_t direction, mark_t mark,
218 u_int32_t *use_time);
219
220 /**
221 * Remove a policy from the SPD.
222 *
223 * The kernel interface implements reference counting for policies.
224 * If the same policy is installed multiple times (in the case of rekeying),
225 * the reference counter is increased. del_policy() decreases the ref counter
226 * and removes the policy only when no more references are available.
227 *
228 * @param src_ts traffic selector to match traffic source
229 * @param dst_ts traffic selector to match traffic dest
230 * @param direction direction of traffic, POLICY_(IN|OUT|FWD)
231 * @param mark optional mark
232 * @param unrouted TRUE, if this policy is unrouted from the kernel
233 * @return SUCCESS if operation completed
234 */
235 status_t (*del_policy) (kernel_interface_t *this,
236 traffic_selector_t *src_ts,
237 traffic_selector_t *dst_ts,
238 policy_dir_t direction, mark_t mark,
239 bool unrouted);
240
241 /**
242 * Get our outgoing source address for a destination.
243 *
244 * Does a route lookup to get the source address used to reach dest.
245 * The returned host is allocated and must be destroyed.
246 * An optional src address can be used to check if a route is available
247 * for given source to dest.
248 *
249 * @param dest target destination address
250 * @param src source address to check, or NULL
251 * @return outgoing source address, NULL if unreachable
252 */
253 host_t* (*get_source_addr)(kernel_interface_t *this,
254 host_t *dest, host_t *src);
255
256 /**
257 * Get the next hop for a destination.
258 *
259 * Does a route lookup to get the next hop used to reach dest.
260 * The returned host is allocated and must be destroyed.
261 *
262 * @param dest target destination address
263 * @return next hop address, NULL if unreachable
264 */
265 host_t* (*get_nexthop)(kernel_interface_t *this, host_t *dest);
266
267 /**
268 * Get the interface name of a local address.
269 *
270 * @param host address to get interface name from
271 * @return allocated interface name, or NULL if not found
272 */
273 char* (*get_interface) (kernel_interface_t *this, host_t *host);
274
275 /**
276 * Creates an enumerator over all local addresses.
277 *
278 * This function blocks an internal cached address list until the
279 * enumerator gets destroyed.
280 * The hosts are read-only, do not modify of free.
281 *
282 * @param include_down_ifaces TRUE to enumerate addresses from down interfaces
283 * @param include_virtual_ips TRUE to enumerate virtual ip addresses
284 * @return enumerator over host_t's
285 */
286 enumerator_t *(*create_address_enumerator) (kernel_interface_t *this,
287 bool include_down_ifaces, bool include_virtual_ips);
288
289 /**
290 * Add a virtual IP to an interface.
291 *
292 * Virtual IPs are attached to an interface. If an IP is added multiple
293 * times, the IP is refcounted and not removed until del_ip() was called
294 * as many times as add_ip().
295 * The virtual IP is attached to the interface where the iface_ip is found.
296 *
297 * @param virtual_ip virtual ip address to assign
298 * @param iface_ip IP of an interface to attach virtual IP
299 * @return SUCCESS if operation completed
300 */
301 status_t (*add_ip) (kernel_interface_t *this, host_t *virtual_ip,
302 host_t *iface_ip);
303
304 /**
305 * Remove a virtual IP from an interface.
306 *
307 * The kernel interface uses refcounting, see add_ip().
308 *
309 * @param virtual_ip virtual ip address to assign
310 * @return SUCCESS if operation completed
311 */
312 status_t (*del_ip) (kernel_interface_t *this, host_t *virtual_ip);
313
314 /**
315 * Add a route.
316 *
317 * @param dst_net destination net
318 * @param prefixlen destination net prefix length
319 * @param gateway gateway for this route
320 * @param src_ip sourc ip of the route
321 * @param if_name name of the interface the route is bound to
322 * @return SUCCESS if operation completed
323 * ALREADY_DONE if the route already exists
324 */
325 status_t (*add_route) (kernel_interface_t *this, chunk_t dst_net,
326 u_int8_t prefixlen, host_t *gateway, host_t *src_ip,
327 char *if_name);
328
329 /**
330 * Delete a route.
331 *
332 * @param dst_net destination net
333 * @param prefixlen destination net prefix length
334 * @param gateway gateway for this route
335 * @param src_ip sourc ip of the route
336 * @param if_name name of the interface the route is bound to
337 * @return SUCCESS if operation completed
338 */
339 status_t (*del_route) (kernel_interface_t *this, chunk_t dst_net,
340 u_int8_t prefixlen, host_t *gateway, host_t *src_ip,
341 char *if_name);
342
343 /**
344 * Set up a bypass policy for a given socket.
345 *
346 * @param fd socket file descriptor to setup policy for
347 * @param family protocol family of the socket
348 * @return TRUE of policy set up successfully
349 */
350 bool (*bypass_socket)(kernel_interface_t *this, int fd, int family);
351
352 /**
353 * manager methods
354 */
355
356 /**
357 * Tries to find an ip address of a local interface that is included in the
358 * supplied traffic selector.
359 *
360 * @param ts traffic selector
361 * @param ip returned ip (has to be destroyed)
362 * @return SUCCESS if address found
363 */
364 status_t (*get_address_by_ts)(kernel_interface_t *this,
365 traffic_selector_t *ts, host_t **ip);
366
367 /**
368 * Register an ipsec kernel interface constructor on the manager.
369 *
370 * @param create constructor to register
371 */
372 void (*add_ipsec_interface)(kernel_interface_t *this,
373 kernel_ipsec_constructor_t create);
374
375 /**
376 * Unregister an ipsec kernel interface constructor.
377 *
378 * @param create constructor to unregister
379 */
380 void (*remove_ipsec_interface)(kernel_interface_t *this,
381 kernel_ipsec_constructor_t create);
382
383 /**
384 * Register a network kernel interface constructor on the manager.
385 *
386 * @param create constructor to register
387 */
388 void (*add_net_interface)(kernel_interface_t *this,
389 kernel_net_constructor_t create);
390
391 /**
392 * Unregister a network kernel interface constructor.
393 *
394 * @param create constructor to unregister
395 */
396 void (*remove_net_interface)(kernel_interface_t *this,
397 kernel_net_constructor_t create);
398
399 /**
400 * Add a listener to the kernel interface.
401 *
402 * @param listener listener to add
403 */
404 void (*add_listener)(kernel_interface_t *this,
405 kernel_listener_t *listener);
406
407 /**
408 * Remove a listener from the kernel interface.
409 *
410 * @param listener listener to remove
411 */
412 void (*remove_listener)(kernel_interface_t *this,
413 kernel_listener_t *listener);
414
415 /**
416 * Raise an acquire event.
417 *
418 * @param reqid reqid of the policy to acquire
419 * @param src_ts source traffic selector
420 * @param dst_ts destination traffic selector
421 */
422 void (*acquire)(kernel_interface_t *this, u_int32_t reqid,
423 traffic_selector_t *src_ts, traffic_selector_t *dst_ts);
424
425 /**
426 * Raise an expire event.
427 *
428 * @param reqid reqid of the expired SA
429 * @param protocol protocol of the expired SA
430 * @param spi spi of the expired SA
431 * @param hard TRUE if it is a hard expire, FALSE otherwise
432 */
433 void (*expire)(kernel_interface_t *this, u_int32_t reqid,
434 u_int8_t protocol, u_int32_t spi, bool hard);
435
436 /**
437 * Raise a mapping event.
438 *
439 * @param reqid reqid of the SA
440 * @param spi spi of the SA
441 * @param remote new remote host
442 */
443 void (*mapping)(kernel_interface_t *this, u_int32_t reqid, u_int32_t spi,
444 host_t *remote);
445
446 /**
447 * Raise a migrate event.
448 *
449 * @param reqid reqid of the policy
450 * @param src_ts source traffic selector
451 * @param dst_ts destination traffic selector
452 * @param direction direction of the policy (in|out)
453 * @param local local host address to be used in the IKE_SA
454 * @param remote remote host address to be used in the IKE_SA
455 */
456 void (*migrate)(kernel_interface_t *this, u_int32_t reqid,
457 traffic_selector_t *src_ts, traffic_selector_t *dst_ts,
458 policy_dir_t direction, host_t *local, host_t *remote);
459
460 /**
461 * Raise a roam event.
462 *
463 * @param address TRUE if address list, FALSE if routing changed
464 */
465 void (*roam)(kernel_interface_t *this, bool address);
466
467 /**
468 * Destroys a kernel_interface_manager_t object.
469 */
470 void (*destroy) (kernel_interface_t *this);
471 };
472
473 /**
474 * Creates an object of type kernel_interface_t.
475 */
476 kernel_interface_t *kernel_interface_create(void);
477
478 #endif /** KERNEL_INTERFACE_H_ @}*/