fd64f50c20fb62a92c551ed6bfdd903d46a4a09e
[strongswan.git] / src / libhydra / kernel / kernel_interface.h
1 /*
2 * Copyright (C) 2006-2012 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 * Copyright (c) 2012 Nanoteq Pty Ltd
21 *
22 * Permission is hereby granted, free of charge, to any person obtaining a copy
23 * of this software and associated documentation files (the "Software"), to deal
24 * in the Software without restriction, including without limitation the rights
25 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
26 * copies of the Software, and to permit persons to whom the Software is
27 * furnished to do so, subject to the following conditions:
28 *
29 * The above copyright notice and this permission notice shall be included in
30 * all copies or substantial portions of the Software.
31 *
32 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
33 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
35 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
37 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
38 * THE SOFTWARE.
39 */
40
41 /**
42 * @defgroup kernel_interface kernel_interface
43 * @{ @ingroup hkernel
44 */
45
46 #ifndef KERNEL_INTERFACE_H_
47 #define KERNEL_INTERFACE_H_
48
49 typedef struct kernel_interface_t kernel_interface_t;
50 typedef enum kernel_feature_t kernel_feature_t;
51
52 #include <networking/host.h>
53 #include <crypto/prf_plus.h>
54
55 #include <kernel/kernel_listener.h>
56 #include <kernel/kernel_ipsec.h>
57 #include <kernel/kernel_net.h>
58
59 /**
60 * Bitfield of optional features a kernel backend supports.
61 *
62 * This feature-set is for both, kernel_ipsec_t and kernel_net_t. Each
63 * backend returns a subset of these features.
64 */
65 enum kernel_feature_t {
66 /** IPsec can process ESPv3 (RFC 4303) TFC padded packets */
67 KERNEL_ESP_V3_TFC = (1<<0),
68 /** Networking requires an "exclude" route for IKE/ESP packets */
69 KERNEL_REQUIRE_EXCLUDE_ROUTE = (1<<1),
70 };
71
72 /**
73 * Constructor function for ipsec kernel interface
74 */
75 typedef kernel_ipsec_t* (*kernel_ipsec_constructor_t)(void);
76
77 /**
78 * Constructor function for network kernel interface
79 */
80 typedef kernel_net_t* (*kernel_net_constructor_t)(void);
81
82 /**
83 * Manager and wrapper for different kernel interfaces.
84 *
85 * The kernel interface handles the communication with the kernel
86 * for SA and policy management and interface and IP address management.
87 */
88 struct kernel_interface_t {
89
90 /**
91 * Get the feature set supported by the net and ipsec kernel backends.
92 *
93 * @return ORed feature-set of backends
94 */
95 kernel_feature_t (*get_features)(kernel_interface_t *this);
96
97 /**
98 * Get a SPI from the kernel.
99 *
100 * @param src source address of SA
101 * @param dst destination address of SA
102 * @param protocol protocol for SA (ESP/AH)
103 * @param reqid unique ID for this SA
104 * @param spi allocated spi
105 * @return SUCCESS if operation completed
106 */
107 status_t (*get_spi)(kernel_interface_t *this, host_t *src, host_t *dst,
108 u_int8_t protocol, u_int32_t reqid, u_int32_t *spi);
109
110 /**
111 * Get a Compression Parameter Index (CPI) from the kernel.
112 *
113 * @param src source address of SA
114 * @param dst destination address of SA
115 * @param reqid unique ID for the corresponding SA
116 * @param cpi allocated cpi
117 * @return SUCCESS if operation completed
118 */
119 status_t (*get_cpi)(kernel_interface_t *this, host_t *src, host_t *dst,
120 u_int32_t reqid, u_int16_t *cpi);
121
122 /**
123 * Add an SA to the SAD.
124 *
125 * add_sa() may update an already allocated
126 * SPI (via get_spi). In this case, the replace
127 * flag must be set.
128 * This function does install a single SA for a
129 * single protocol in one direction.
130 *
131 * @param src source address for this SA
132 * @param dst destination address for this SA
133 * @param spi SPI allocated by us or remote peer
134 * @param protocol protocol for this SA (ESP/AH)
135 * @param reqid unique ID for this SA
136 * @param mark optional mark for this SA
137 * @param tfc Traffic Flow Confidentiality padding for this SA
138 * @param lifetime lifetime_cfg_t for this SA
139 * @param enc_alg Algorithm to use for encryption (ESP only)
140 * @param enc_key key to use for encryption
141 * @param int_alg Algorithm to use for integrity protection
142 * @param int_key key to use for integrity protection
143 * @param mode mode of the SA (tunnel, transport)
144 * @param ipcomp IPComp transform to use
145 * @param cpi CPI for IPComp
146 * @param encap enable UDP encapsulation for NAT traversal
147 * @param esn TRUE to use Extended Sequence Numbers
148 * @param inbound TRUE if this is an inbound SA
149 * @param src_ts traffic selector with BEET source address
150 * @param dst_ts traffic selector with BEET destination address
151 * @return SUCCESS if operation completed
152 */
153 status_t (*add_sa) (kernel_interface_t *this,
154 host_t *src, host_t *dst, u_int32_t spi,
155 u_int8_t protocol, u_int32_t reqid, mark_t mark,
156 u_int32_t tfc, lifetime_cfg_t *lifetime,
157 u_int16_t enc_alg, chunk_t enc_key,
158 u_int16_t int_alg, chunk_t int_key,
159 ipsec_mode_t mode, u_int16_t ipcomp, u_int16_t cpi,
160 bool encap, bool esn, bool inbound,
161 traffic_selector_t *src_ts, traffic_selector_t *dst_ts);
162
163 /**
164 * Update the hosts on an installed SA.
165 *
166 * We cannot directly update the destination address as the kernel
167 * requires the spi, the protocol AND the destination address (and family)
168 * to identify SAs. Therefore if the destination address changed we
169 * create a new SA and delete the old one.
170 *
171 * @param spi SPI of the SA
172 * @param protocol protocol for this SA (ESP/AH)
173 * @param cpi CPI for IPComp, 0 if no IPComp is used
174 * @param src current source address
175 * @param dst current destination address
176 * @param new_src new source address
177 * @param new_dst new destination address
178 * @param encap current use of UDP encapsulation
179 * @param new_encap new use of UDP encapsulation
180 * @param mark optional mark for this SA
181 * @return SUCCESS if operation completed, NOT_SUPPORTED if
182 * the kernel interface can't update the SA
183 */
184 status_t (*update_sa)(kernel_interface_t *this,
185 u_int32_t spi, u_int8_t protocol, u_int16_t cpi,
186 host_t *src, host_t *dst,
187 host_t *new_src, host_t *new_dst,
188 bool encap, bool new_encap, mark_t mark);
189
190 /**
191 * Query the number of bytes processed by an SA from the SAD.
192 *
193 * @param src source address for this SA
194 * @param dst destination address for this SA
195 * @param spi SPI allocated by us or remote peer
196 * @param protocol protocol for this SA (ESP/AH)
197 * @param mark optional mark for this SA
198 * @param[out] bytes the number of bytes processed by SA
199 * @param[out] packets number of packets processed by SA
200 * @return SUCCESS if operation completed
201 */
202 status_t (*query_sa) (kernel_interface_t *this, host_t *src, host_t *dst,
203 u_int32_t spi, u_int8_t protocol, mark_t mark,
204 u_int64_t *bytes, u_int64_t *packets);
205
206 /**
207 * Delete a previously installed SA from the SAD.
208 *
209 * @param src source address for this SA
210 * @param dst destination address for this SA
211 * @param spi SPI allocated by us or remote peer
212 * @param protocol protocol for this SA (ESP/AH)
213 * @param cpi CPI for IPComp or 0
214 * @param mark optional mark for this SA
215 * @return SUCCESS if operation completed
216 */
217 status_t (*del_sa) (kernel_interface_t *this, host_t *src, host_t *dst,
218 u_int32_t spi, u_int8_t protocol, u_int16_t cpi,
219 mark_t mark);
220
221 /**
222 * Flush all SAs from the SAD.
223 *
224 * @return SUCCESS if operation completed
225 */
226 status_t (*flush_sas) (kernel_interface_t *this);
227
228 /**
229 * Add a policy to the SPD.
230 *
231 * A policy is always associated to an SA. Traffic which matches a
232 * policy is handled by the SA with the same reqid.
233 *
234 * @param src source address of SA
235 * @param dst dest address of SA
236 * @param src_ts traffic selector to match traffic source
237 * @param dst_ts traffic selector to match traffic dest
238 * @param direction direction of traffic, POLICY_(IN|OUT|FWD)
239 * @param type type of policy, POLICY_(IPSEC|PASS|DROP)
240 * @param sa details about the SA(s) tied to this policy
241 * @param mark mark for this policy
242 * @param priority priority of this policy
243 * @return SUCCESS if operation completed
244 */
245 status_t (*add_policy) (kernel_interface_t *this,
246 host_t *src, host_t *dst,
247 traffic_selector_t *src_ts,
248 traffic_selector_t *dst_ts,
249 policy_dir_t direction, policy_type_t type,
250 ipsec_sa_cfg_t *sa, mark_t mark,
251 policy_priority_t priority);
252
253 /**
254 * Query the use time of a policy.
255 *
256 * The use time of a policy is the time the policy was used
257 * for the last time.
258 *
259 * @param src_ts traffic selector to match traffic source
260 * @param dst_ts traffic selector to match traffic dest
261 * @param direction direction of traffic, POLICY_(IN|OUT|FWD)
262 * @param mark optional mark
263 * @param[out] use_time the time of this SA's last use
264 * @return SUCCESS if operation completed
265 */
266 status_t (*query_policy) (kernel_interface_t *this,
267 traffic_selector_t *src_ts,
268 traffic_selector_t *dst_ts,
269 policy_dir_t direction, mark_t mark,
270 u_int32_t *use_time);
271
272 /**
273 * Remove a policy from the SPD.
274 *
275 * The kernel interface implements reference counting for policies.
276 * If the same policy is installed multiple times (in the case of rekeying),
277 * the reference counter is increased. del_policy() decreases the ref counter
278 * and removes the policy only when no more references are available.
279 *
280 * @param src_ts traffic selector to match traffic source
281 * @param dst_ts traffic selector to match traffic dest
282 * @param direction direction of traffic, POLICY_(IN|OUT|FWD)
283 * @param reqid unique ID of the associated SA
284 * @param mark optional mark
285 * @param priority priority of the policy
286 * @return SUCCESS if operation completed
287 */
288 status_t (*del_policy) (kernel_interface_t *this,
289 traffic_selector_t *src_ts,
290 traffic_selector_t *dst_ts,
291 policy_dir_t direction, u_int32_t reqid,
292 mark_t mark, policy_priority_t priority);
293
294 /**
295 * Flush all policies from the SPD.
296 *
297 * @return SUCCESS if operation completed
298 */
299 status_t (*flush_policies) (kernel_interface_t *this);
300
301 /**
302 * Get our outgoing source address for a destination.
303 *
304 * Does a route lookup to get the source address used to reach dest.
305 * The returned host is allocated and must be destroyed.
306 * An optional src address can be used to check if a route is available
307 * for the given source to dest.
308 *
309 * @param dest target destination address
310 * @param src source address to check, or NULL
311 * @return outgoing source address, NULL if unreachable
312 */
313 host_t* (*get_source_addr)(kernel_interface_t *this,
314 host_t *dest, host_t *src);
315
316 /**
317 * Get the next hop for a destination.
318 *
319 * Does a route lookup to get the next hop used to reach dest.
320 * The returned host is allocated and must be destroyed.
321 * An optional src address can be used to check if a route is available
322 * for the given source to dest.
323 *
324 * @param dest target destination address
325 * @return next hop address, NULL if unreachable
326 */
327 host_t* (*get_nexthop)(kernel_interface_t *this, host_t *dest, host_t *src);
328
329 /**
330 * Get the interface name of a local address. Interfaces that are down or
331 * ignored by config are not considered.
332 *
333 * @param host address to get interface name from
334 * @param name allocated interface name (optional)
335 * @return TRUE if interface found and usable
336 */
337 bool (*get_interface)(kernel_interface_t *this, host_t *host, char **name);
338
339 /**
340 * Creates an enumerator over all local addresses.
341 *
342 * This function blocks an internal cached address list until the
343 * enumerator gets destroyed.
344 * The hosts are read-only, do not modify of free.
345 *
346 * @param which a combination of address types to enumerate
347 * @return enumerator over host_t's
348 */
349 enumerator_t *(*create_address_enumerator) (kernel_interface_t *this,
350 kernel_address_type_t which);
351
352 /**
353 * Add a virtual IP to an interface.
354 *
355 * Virtual IPs are attached to an interface. If an IP is added multiple
356 * times, the IP is refcounted and not removed until del_ip() was called
357 * as many times as add_ip().
358 *
359 * @param virtual_ip virtual ip address to assign
360 * @param prefix prefix length to install IP with, -1 for auto
361 * @param iface interface to install virtual IP on
362 * @return SUCCESS if operation completed
363 */
364 status_t (*add_ip) (kernel_interface_t *this, host_t *virtual_ip, int prefix,
365 char *iface);
366
367 /**
368 * Remove a virtual IP from an interface.
369 *
370 * The kernel interface uses refcounting, see add_ip().
371 *
372 * @param virtual_ip virtual ip address to assign
373 * @param prefix prefix length of the IP to uninstall, -1 for auto
374 * @param wait TRUE to wait untily IP is gone
375 * @return SUCCESS if operation completed
376 */
377 status_t (*del_ip) (kernel_interface_t *this, host_t *virtual_ip,
378 int prefix, bool wait);
379
380 /**
381 * Add a route.
382 *
383 * @param dst_net destination net
384 * @param prefixlen destination net prefix length
385 * @param gateway gateway for this route
386 * @param src_ip sourc ip of the route
387 * @param if_name name of the interface the route is bound to
388 * @return SUCCESS if operation completed
389 * ALREADY_DONE if the route already exists
390 */
391 status_t (*add_route) (kernel_interface_t *this, chunk_t dst_net,
392 u_int8_t prefixlen, host_t *gateway, host_t *src_ip,
393 char *if_name);
394
395 /**
396 * Delete a route.
397 *
398 * @param dst_net destination net
399 * @param prefixlen destination net prefix length
400 * @param gateway gateway for this route
401 * @param src_ip sourc ip of the route
402 * @param if_name name of the interface the route is bound to
403 * @return SUCCESS if operation completed
404 */
405 status_t (*del_route) (kernel_interface_t *this, chunk_t dst_net,
406 u_int8_t prefixlen, host_t *gateway, host_t *src_ip,
407 char *if_name);
408
409 /**
410 * Set up a bypass policy for a given socket.
411 *
412 * @param fd socket file descriptor to setup policy for
413 * @param family protocol family of the socket
414 * @return TRUE if policy set up successfully
415 */
416 bool (*bypass_socket)(kernel_interface_t *this, int fd, int family);
417
418 /**
419 * Enable decapsulation of ESP-in-UDP packets for the given port/socket.
420 *
421 * @param fd socket file descriptor
422 * @param family protocol family of the socket
423 * @param port the UDP port
424 * @return TRUE if UDP decapsulation was enabled successfully
425 */
426 bool (*enable_udp_decap)(kernel_interface_t *this, int fd, int family,
427 u_int16_t port);
428
429
430 /**
431 * manager methods
432 */
433
434 /**
435 * Verifies that the given interface is usable and not excluded by
436 * configuration.
437 *
438 * @param iface interface name
439 * @return TRUE if usable
440 */
441 bool (*is_interface_usable)(kernel_interface_t *this, const char *iface);
442
443 /**
444 * Check if interfaces are excluded by config.
445 *
446 * @return TRUE if no interfaces are exclued by config
447 */
448 bool (*all_interfaces_usable)(kernel_interface_t *this);
449
450 /**
451 * Tries to find an IP address of a local interface that is included in the
452 * supplied traffic selector.
453 *
454 * @param ts traffic selector
455 * @param ip returned IP address (has to be destroyed)
456 * @param vip set to TRUE if returned address is a virtual IP
457 * @return SUCCESS if address found
458 */
459 status_t (*get_address_by_ts)(kernel_interface_t *this,
460 traffic_selector_t *ts, host_t **ip, bool *vip);
461
462 /**
463 * Register an ipsec kernel interface constructor on the manager.
464 *
465 * @param create constructor to register
466 */
467 void (*add_ipsec_interface)(kernel_interface_t *this,
468 kernel_ipsec_constructor_t create);
469
470 /**
471 * Unregister an ipsec kernel interface constructor.
472 *
473 * @param create constructor to unregister
474 */
475 void (*remove_ipsec_interface)(kernel_interface_t *this,
476 kernel_ipsec_constructor_t create);
477
478 /**
479 * Register a network kernel interface constructor on the manager.
480 *
481 * @param create constructor to register
482 */
483 void (*add_net_interface)(kernel_interface_t *this,
484 kernel_net_constructor_t create);
485
486 /**
487 * Unregister a network kernel interface constructor.
488 *
489 * @param create constructor to unregister
490 */
491 void (*remove_net_interface)(kernel_interface_t *this,
492 kernel_net_constructor_t create);
493
494 /**
495 * Add a listener to the kernel interface.
496 *
497 * @param listener listener to add
498 */
499 void (*add_listener)(kernel_interface_t *this,
500 kernel_listener_t *listener);
501
502 /**
503 * Remove a listener from the kernel interface.
504 *
505 * @param listener listener to remove
506 */
507 void (*remove_listener)(kernel_interface_t *this,
508 kernel_listener_t *listener);
509
510 /**
511 * Raise an acquire event.
512 *
513 * @param reqid reqid of the policy to acquire
514 * @param src_ts source traffic selector
515 * @param dst_ts destination traffic selector
516 */
517 void (*acquire)(kernel_interface_t *this, u_int32_t reqid,
518 traffic_selector_t *src_ts, traffic_selector_t *dst_ts);
519
520 /**
521 * Raise an expire event.
522 *
523 * @param reqid reqid of the expired SA
524 * @param protocol protocol of the expired SA
525 * @param spi spi of the expired SA
526 * @param hard TRUE if it is a hard expire, FALSE otherwise
527 */
528 void (*expire)(kernel_interface_t *this, u_int32_t reqid,
529 u_int8_t protocol, u_int32_t spi, bool hard);
530
531 /**
532 * Raise a mapping event.
533 *
534 * @param reqid reqid of the SA
535 * @param spi spi of the SA
536 * @param remote new remote host
537 */
538 void (*mapping)(kernel_interface_t *this, u_int32_t reqid, u_int32_t spi,
539 host_t *remote);
540
541 /**
542 * Raise a migrate event.
543 *
544 * @param reqid reqid of the policy
545 * @param src_ts source traffic selector
546 * @param dst_ts destination traffic selector
547 * @param direction direction of the policy (in|out)
548 * @param local local host address to be used in the IKE_SA
549 * @param remote remote host address to be used in the IKE_SA
550 */
551 void (*migrate)(kernel_interface_t *this, u_int32_t reqid,
552 traffic_selector_t *src_ts, traffic_selector_t *dst_ts,
553 policy_dir_t direction, host_t *local, host_t *remote);
554
555 /**
556 * Raise a roam event.
557 *
558 * @param address TRUE if address list, FALSE if routing changed
559 */
560 void (*roam)(kernel_interface_t *this, bool address);
561
562 /**
563 * Register a new algorithm with the kernel interface.
564 *
565 * @param alg_id the IKE id of the algorithm
566 * @param type the transform type of the algorithm
567 * @param kernel_id the kernel id of the algorithm
568 * @param kernel_name the kernel name of the algorithm
569 */
570 void (*register_algorithm)(kernel_interface_t *this, u_int16_t alg_id,
571 transform_type_t type, u_int16_t kernel_id,
572 char *kernel_name);
573
574 /**
575 * Return the kernel-specific id and/or name for an algorithms depending on
576 * the arguments specified.
577 *
578 * @param alg_id the IKE id of the algorithm
579 * @param type the transform type of the algorithm
580 * @param kernel_id the kernel id of the algorithm (optional)
581 * @param kernel_name the kernel name of the algorithm (optional)
582 * @return TRUE if algorithm was found
583 */
584 bool (*lookup_algorithm)(kernel_interface_t *this, u_int16_t alg_id,
585 transform_type_t type, u_int16_t *kernel_id,
586 char **kernel_name);
587
588 /**
589 * Destroys a kernel_interface_manager_t object.
590 */
591 void (*destroy) (kernel_interface_t *this);
592 };
593
594 /**
595 * Creates an object of type kernel_interface_t.
596 */
597 kernel_interface_t *kernel_interface_create(void);
598
599 #endif /** KERNEL_INTERFACE_H_ @}*/