enabling acquire for mediated connections
[strongswan.git] / src / charon / sa / ike_sa.h
1 /*
2 * Copyright (C) 2006-2008 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 * $Id$
19 */
20
21 /**
22 * @defgroup ike_sa ike_sa
23 * @{ @ingroup sa
24 */
25
26 #ifndef IKE_SA_H_
27 #define IKE_SA_H_
28
29 typedef enum ike_extension_t ike_extension_t;
30 typedef enum ike_condition_t ike_condition_t;
31 typedef enum ike_sa_state_t ike_sa_state_t;
32 typedef enum statistic_t statistic_t;
33 typedef struct ike_sa_t ike_sa_t;
34
35 #include <library.h>
36 #include <encoding/message.h>
37 #include <encoding/payloads/proposal_substructure.h>
38 #include <sa/ike_sa_id.h>
39 #include <sa/child_sa.h>
40 #include <sa/tasks/task.h>
41 #include <utils/randomizer.h>
42 #include <crypto/prfs/prf.h>
43 #include <crypto/crypters/crypter.h>
44 #include <crypto/signers/signer.h>
45 #include <config/peer_cfg.h>
46 #include <config/ike_cfg.h>
47 #include <credentials/auth_info.h>
48
49 /**
50 * Timeout in milliseconds after that a half open IKE_SA gets deleted.
51 */
52 #define HALF_OPEN_IKE_SA_TIMEOUT 30000
53
54 /**
55 * Interval to send keepalives when NATed, in seconds.
56 */
57 #define KEEPALIVE_INTERVAL 20
58
59 /**
60 * After which time rekeying should be retried if it failed, in seconds.
61 */
62 #define RETRY_INTERVAL 30
63
64 /**
65 * Jitter to subtract from RETRY_INTERVAL to randomize rekey retry.
66 */
67 #define RETRY_JITTER 20
68
69 /**
70 * Extensions (or optional features) the peer supports
71 */
72 enum ike_extension_t {
73
74 /**
75 * peer supports NAT traversal as specified in RFC4306
76 */
77 EXT_NATT = (1<<0),
78
79 /**
80 * peer supports MOBIKE (RFC4555)
81 */
82 EXT_MOBIKE = (1<<1),
83 };
84
85 /**
86 * Conditions of an IKE_SA, change during its lifetime
87 */
88 enum ike_condition_t {
89
90 /**
91 * Connection is natted (or faked) somewhere
92 */
93 COND_NAT_ANY = (1<<0),
94
95 /**
96 * we are behind NAT
97 */
98 COND_NAT_HERE = (1<<1),
99
100 /**
101 * other is behind NAT
102 */
103 COND_NAT_THERE = (1<<2),
104
105 /**
106 * Faking NAT to enforce UDP encapsulation
107 */
108 COND_NAT_FAKE = (1<<3),
109
110 /**
111 * peer has ben authenticated using EAP
112 */
113 COND_EAP_AUTHENTICATED = (1<<4),
114
115 /**
116 * received a certificate request from the peer
117 */
118 COND_CERTREQ_SEEN = (1<<4),
119 };
120
121 /**
122 * Information and statistics to query from an SA
123 */
124 enum statistic_t {
125
126 /**
127 * Relative time for scheduled rekeying
128 */
129 STAT_REKEY_TIME,
130
131 /**
132 * Relative time for scheduled reauthentication
133 */
134 STAT_REAUTH_TIME,
135 };
136
137 /**
138 * State of an IKE_SA.
139 *
140 * An IKE_SA passes various states in its lifetime. A newly created
141 * SA is in the state CREATED.
142 * @verbatim
143 +----------------+
144 ¦ SA_CREATED ¦
145 +----------------+
146 ¦
147 on initiate()---> ¦ <----- on IKE_SA_INIT received
148 V
149 +----------------+
150 ¦ SA_CONNECTING ¦
151 +----------------+
152 ¦
153 ¦ <----- on IKE_AUTH successfully completed
154 V
155 +----------------+
156 ¦ SA_ESTABLISHED ¦-------------------------+ <-- on rekeying
157 +----------------+ ¦
158 ¦ V
159 on delete()---> ¦ <----- on IKE_SA +-------------+
160 ¦ delete request ¦ SA_REKEYING ¦
161 ¦ received +-------------+
162 V ¦
163 +----------------+ ¦
164 ¦ SA_DELETING ¦<------------------------+ <-- after rekeying
165 +----------------+
166 ¦
167 ¦ <----- after delete() acknowledged
168 ¦
169 \V/
170 X
171 / \
172 @endverbatim
173 */
174 enum ike_sa_state_t {
175
176 /**
177 * IKE_SA just got created, but is not initiating nor responding yet.
178 */
179 IKE_CREATED,
180
181 /**
182 * IKE_SA gets initiated actively or passively
183 */
184 IKE_CONNECTING,
185
186 /**
187 * IKE_SA is fully established
188 */
189 IKE_ESTABLISHED,
190
191 /**
192 * IKE_SA rekeying in progress
193 */
194 IKE_REKEYING,
195
196 /**
197 * IKE_SA is in progress of deletion
198 */
199 IKE_DELETING,
200 };
201
202 /**
203 * enum names for ike_sa_state_t.
204 */
205 extern enum_name_t *ike_sa_state_names;
206
207 /**
208 * Class ike_sa_t representing an IKE_SA.
209 *
210 * An IKE_SA contains crypto information related to a connection
211 * with a peer. It contains multiple IPsec CHILD_SA, for which
212 * it is responsible. All traffic is handled by an IKE_SA, using
213 * the task manager and its tasks.
214 */
215 struct ike_sa_t {
216
217 /**
218 * Get the id of the SA.
219 *
220 * Returned ike_sa_id_t object is not getting cloned!
221 *
222 * @return ike_sa's ike_sa_id_t
223 */
224 ike_sa_id_t* (*get_id) (ike_sa_t *this);
225
226 /**
227 * Get the numerical ID uniquely defining this IKE_SA.
228 *
229 * @return unique ID
230 */
231 u_int32_t (*get_unique_id) (ike_sa_t *this);
232
233 /**
234 * Get the state of the IKE_SA.
235 *
236 * @return state of the IKE_SA
237 */
238 ike_sa_state_t (*get_state) (ike_sa_t *this);
239
240 /**
241 * Set the state of the IKE_SA.
242 *
243 * @param state state to set for the IKE_SA
244 */
245 void (*set_state) (ike_sa_t *this, ike_sa_state_t ike_sa);
246
247 /**
248 * Get the name of the connection this IKE_SA uses.
249 *
250 * @return name
251 */
252 char* (*get_name) (ike_sa_t *this);
253
254 /**
255 * Get statistic values from the IKE_SA.
256 *
257 * @param kind kind of requested value
258 * @return value as integer
259 */
260 u_int32_t (*get_statistic)(ike_sa_t *this, statistic_t kind);
261
262 /**
263 * Get the own host address.
264 *
265 * @return host address
266 */
267 host_t* (*get_my_host) (ike_sa_t *this);
268
269 /**
270 * Set the own host address.
271 *
272 * @param me host address
273 */
274 void (*set_my_host) (ike_sa_t *this, host_t *me);
275
276 /**
277 * Get the other peers host address.
278 *
279 * @return host address
280 */
281 host_t* (*get_other_host) (ike_sa_t *this);
282
283 /**
284 * Set the others host address.
285 *
286 * @param other host address
287 */
288 void (*set_other_host) (ike_sa_t *this, host_t *other);
289
290 /**
291 * Update the IKE_SAs host.
292 *
293 * Hosts may be NULL to use current host.
294 *
295 * @param me new local host address, or NULL
296 * @param other new remote host address, or NULL
297 */
298 void (*update_hosts)(ike_sa_t *this, host_t *me, host_t *other);
299
300 /**
301 * Get the own identification.
302 *
303 * @return identification
304 */
305 identification_t* (*get_my_id) (ike_sa_t *this);
306
307 /**
308 * Set the own identification.
309 *
310 * @param me identification
311 */
312 void (*set_my_id) (ike_sa_t *this, identification_t *me);
313
314 /**
315 * Get the other peer's identification.
316 *
317 * @return identification
318 */
319 identification_t* (*get_other_id) (ike_sa_t *this);
320
321 /**
322 * Set the other peer's identification.
323 *
324 * @param other identification
325 */
326 void (*set_other_id) (ike_sa_t *this, identification_t *other);
327
328 /**
329 * Get the config used to setup this IKE_SA.
330 *
331 * @return ike_config
332 */
333 ike_cfg_t* (*get_ike_cfg) (ike_sa_t *this);
334
335 /**
336 * Set the config to setup this IKE_SA.
337 *
338 * @param config ike_config to use
339 */
340 void (*set_ike_cfg) (ike_sa_t *this, ike_cfg_t* config);
341
342 /**
343 * Get the peer config used by this IKE_SA.
344 *
345 * @return peer_config
346 */
347 peer_cfg_t* (*get_peer_cfg) (ike_sa_t *this);
348
349 /**
350 * Set the peer config to use with this IKE_SA.
351 *
352 * @param config peer_config to use
353 */
354 void (*set_peer_cfg) (ike_sa_t *this, peer_cfg_t *config);
355
356 /**
357 * Get authentication/authorization info for local peer.
358 *
359 * @return auth_info for me
360 */
361 auth_info_t* (*get_my_auth)(ike_sa_t *this);
362
363 /**
364 * Get authentication/authorization info for remote peer.
365 *
366 * @return auth_info for me
367 */
368 auth_info_t* (*get_other_auth)(ike_sa_t *this);
369
370 /**
371 * Add an additional address for the peer.
372 *
373 * In MOBIKE, a peer may transmit additional addresses where it is
374 * reachable. These are stored in the IKE_SA.
375 * The own list of addresses is not stored, they are queried from
376 * the kernel when required.
377 *
378 * @param host host to add to list
379 */
380 void (*add_additional_address)(ike_sa_t *this, host_t *host);
381
382 /**
383 * Create an iterator over all additional addresses of the peer.
384 *
385 * @return iterator over addresses
386 */
387 iterator_t* (*create_additional_address_iterator)(ike_sa_t *this);
388
389 /**
390 * Enable an extension the peer supports.
391 *
392 * If support for an IKE extension is detected, this method is called
393 * to enable that extension and behave accordingly.
394 *
395 * @param extension extension to enable
396 */
397 void (*enable_extension)(ike_sa_t *this, ike_extension_t extension);
398
399 /**
400 * Check if the peer supports an extension.
401 *
402 * @param extension extension to check for support
403 * @return TRUE if peer supports it, FALSE otherwise
404 */
405 bool (*supports_extension)(ike_sa_t *this, ike_extension_t extension);
406
407 /**
408 * Enable/disable a condition flag for this IKE_SA.
409 *
410 * @param condition condition to enable/disable
411 * @param enable TRUE to enable condition, FALSE to disable
412 */
413 void (*set_condition) (ike_sa_t *this, ike_condition_t condition, bool enable);
414
415 /**
416 * Check if a condition flag is set.
417 *
418 * @param condition condition to check
419 * @return TRUE if condition flag set, FALSE otherwise
420 */
421 bool (*has_condition) (ike_sa_t *this, ike_condition_t condition);
422
423 /**
424 * Get the number of queued MOBIKE address updates.
425 *
426 * @return number of pending updates
427 */
428 u_int32_t (*get_pending_updates)(ike_sa_t *this);
429
430 /**
431 * Set the number of queued MOBIKE address updates.
432 *
433 * @param updates number of pending updates
434 */
435 void (*set_pending_updates)(ike_sa_t *this, u_int32_t updates);
436
437 /**
438 * Check if we are the original initiator of this IKE_SA (rekeying does not
439 * change this flag).
440 */
441 bool (*is_ike_initiator)(ike_sa_t *this);
442
443
444 #ifdef ME
445 /**
446 * Activate mediation server functionality for this IKE_SA.
447 */
448 void (*act_as_mediation_server) (ike_sa_t *this);
449
450 /**
451 * Get the server reflexive host.
452 *
453 * @return server reflexive host
454 */
455 host_t* (*get_server_reflexive_host) (ike_sa_t *this);
456
457 /**
458 * Set the server reflexive host.
459 *
460 * @param host server reflexive host
461 */
462 void (*set_server_reflexive_host) (ike_sa_t *this, host_t *host);
463
464 /**
465 * Get the connect ID.
466 *
467 * @return connect ID
468 */
469 chunk_t (*get_connect_id) (ike_sa_t *this);
470
471 /**
472 * Initiate the mediation of a mediated connection (i.e. initiate a
473 * ME_CONNECT exchange).
474 *
475 * @param mediated_cfg peer_cfg of the mediated connection
476 * @return
477 * - SUCCESS if initialization started
478 * - DESTROY_ME if initialization failed
479 */
480 status_t (*initiate_mediation) (ike_sa_t *this, peer_cfg_t *mediated_cfg);
481
482 /**
483 * Initiate the mediated connection
484 *
485 * @param me local endpoint (gets cloned)
486 * @param other remote endpoint (gets cloned)
487 * @param connect_id connect ID (gets cloned)
488 * @return
489 * - SUCCESS if initialization started
490 * - DESTROY_ME if initialization failed
491 */
492 status_t (*initiate_mediated) (ike_sa_t *this, host_t *me, host_t *other,
493 chunk_t connect_id);
494
495 /**
496 * Relay data from one peer to another (i.e. initiate a
497 * ME_CONNECT exchange).
498 *
499 * Data is cloned.
500 *
501 * @param requester ID of the requesting peer
502 * @param connect_id data of the ME_CONNECTID payload
503 * @param connect_key data of the ME_CONNECTKEY payload
504 * @param endpoints endpoints
505 * @param response TRUE if this is a response
506 * @return
507 * - SUCCESS if relay started
508 * - DESTROY_ME if relay failed
509 */
510 status_t (*relay) (ike_sa_t *this, identification_t *requester, chunk_t connect_id,
511 chunk_t connect_key, linked_list_t *endpoints, bool response);
512
513 /**
514 * Send a callback to a peer.
515 *
516 * Data is cloned.
517 *
518 * @param peer_id ID of the other peer
519 * @return
520 * - SUCCESS if response started
521 * - DESTROY_ME if response failed
522 */
523 status_t (*callback) (ike_sa_t *this, identification_t *peer_id);
524
525 /**
526 * Respond to a ME_CONNECT request.
527 *
528 * Data is cloned.
529 *
530 * @param peer_id ID of the other peer
531 * @param connect_id the connect ID supplied by the initiator
532 * @return
533 * - SUCCESS if response started
534 * - DESTROY_ME if response failed
535 */
536 status_t (*respond) (ike_sa_t *this, identification_t *peer_id, chunk_t connect_id);
537 #endif /* ME */
538
539 /**
540 * Initiate a new connection.
541 *
542 * The configs are owned by the IKE_SA after the call.
543 *
544 * @param child_cfg child config to create CHILD from
545 * @return
546 * - SUCCESS if initialization started
547 * - DESTROY_ME if initialization failed
548 */
549 status_t (*initiate) (ike_sa_t *this, child_cfg_t *child_cfg);
550
551 /**
552 * Route a policy in the kernel.
553 *
554 * Installs the policies in the kernel. If traffic matches,
555 * the kernel requests connection setup from the IKE_SA via acquire().
556 *
557 * @param child_cfg child config to route
558 * @return
559 * - SUCCESS if routed successfully
560 * - FAILED if routing failed
561 */
562 status_t (*route) (ike_sa_t *this, child_cfg_t *child_cfg);
563
564 /**
565 * Unroute a policy in the kernel previously routed.
566 *
567 * @param reqid reqid of CHILD_SA to unroute
568 * @return
569 * - SUCCESS if route removed
570 * - NOT_FOUND if CHILD_SA not found
571 * - DESTROY_ME if last CHILD_SA was unrouted
572 */
573 status_t (*unroute) (ike_sa_t *this, u_int32_t reqid);
574
575 /**
576 * Acquire connection setup for an installed kernel policy.
577 *
578 * If an installed policy raises an acquire, the kernel calls
579 * this function to establish the CHILD_SA (and maybe the IKE_SA).
580 *
581 * @param reqid reqid of the CHILD_SA the policy belongs to.
582 * @return
583 * - SUCCESS if initialization started
584 * - DESTROY_ME if initialization failed
585 */
586 status_t (*acquire) (ike_sa_t *this, u_int32_t reqid);
587
588 /**
589 * Initiates the deletion of an IKE_SA.
590 *
591 * Sends a delete message to the remote peer and waits for
592 * its response. If the response comes in, or a timeout occurs,
593 * the IKE SA gets deleted.
594 *
595 * @return
596 * - SUCCESS if deletion is initialized
597 * - INVALID_STATE, if the IKE_SA is not in
598 * an established state and can not be
599 * delete (but destroyed).
600 */
601 status_t (*delete) (ike_sa_t *this);
602
603 /**
604 * Update IKE_SAs after network interfaces have changed.
605 *
606 * Whenever the network interface configuration changes, the kernel
607 * interface calls roam() on each IKE_SA. The IKE_SA then checks if
608 * the new network config requires changes, and handles appropriate.
609 * If MOBIKE is supported, addresses are updated; If not, the tunnel is
610 * restarted.
611 *
612 * @param address TRUE if address list changed, FALSE otherwise
613 * @return SUCCESS, FAILED, DESTROY_ME
614 */
615 status_t (*roam)(ike_sa_t *this, bool address);
616
617 /**
618 * Processes a incoming IKEv2-Message.
619 *
620 * Message processing may fail. If a critical failure occurs,
621 * process_message() return DESTROY_ME. Then the caller must
622 * destroy the IKE_SA immediatly, as it is unusable.
623 *
624 * @param message message to process
625 * @return
626 * - SUCCESS
627 * - FAILED
628 * - DESTROY_ME if this IKE_SA MUST be deleted
629 */
630 status_t (*process_message) (ike_sa_t *this, message_t *message);
631
632 /**
633 * Generate a IKE message to send it to the peer.
634 *
635 * This method generates all payloads in the message and encrypts/signs
636 * the packet.
637 *
638 * @param message message to generate
639 * @param packet generated output packet
640 * @return
641 * - SUCCESS
642 * - FAILED
643 * - DESTROY_ME if this IKE_SA MUST be deleted
644 */
645 status_t (*generate_message) (ike_sa_t *this, message_t *message,
646 packet_t **packet);
647
648 /**
649 * Retransmits a request.
650 *
651 * @param message_id ID of the request to retransmit
652 * @return
653 * - SUCCESS
654 * - NOT_FOUND if request doesn't have to be retransmited
655 */
656 status_t (*retransmit) (ike_sa_t *this, u_int32_t message_id);
657
658 /**
659 * Sends a DPD request to the peer.
660 *
661 * To check if a peer is still alive, periodic
662 * empty INFORMATIONAL messages are sent if no
663 * other traffic was received.
664 *
665 * @return
666 * - SUCCESS
667 * - DESTROY_ME, if peer did not respond
668 */
669 status_t (*send_dpd) (ike_sa_t *this);
670
671 /**
672 * Sends a keep alive packet.
673 *
674 * To refresh NAT tables in a NAT router
675 * between the peers, periodic empty
676 * UDP packets are sent if no other traffic
677 * was sent.
678 */
679 void (*send_keepalive) (ike_sa_t *this);
680
681 /**
682 * Derive all keys and create the transforms for IKE communication.
683 *
684 * Keys are derived using the diffie hellman secret, nonces and internal
685 * stored SPIs.
686 * Key derivation differs when an IKE_SA is set up to replace an
687 * existing IKE_SA (rekeying). The SK_d key from the old IKE_SA
688 * is included in the derivation process.
689 *
690 * @param proposal proposal which contains algorithms to use
691 * @param secret secret derived from DH exchange, gets freed
692 * @param nonce_i initiators nonce
693 * @param nonce_r responders nonce
694 * @param initiator TRUE if initiator, FALSE otherwise
695 * @param child_prf PRF with SK_d key when rekeying, NULL otherwise
696 * @param old_prf general purpose PRF of old SA when rekeying
697 */
698 status_t (*derive_keys)(ike_sa_t *this, proposal_t* proposal, chunk_t secret,
699 chunk_t nonce_i, chunk_t nonce_r,
700 bool initiator, prf_t *child_prf, prf_t *old_prf);
701
702 /**
703 * Get a multi purpose prf for the negotiated PRF function.
704 *
705 * @return pointer to prf_t object
706 */
707 prf_t *(*get_prf) (ike_sa_t *this);
708
709 /**
710 * Get the prf-object, which is used to derive keys for child SAs.
711 *
712 * @return pointer to prf_t object
713 */
714 prf_t *(*get_child_prf) (ike_sa_t *this);
715
716 /**
717 * Get the key to build outgoing authentication data.
718 *
719 * @return pointer to prf_t object
720 */
721 chunk_t (*get_skp_build) (ike_sa_t *this);
722
723 /**
724 * Get the key to verify incoming authentication data.
725 *
726 * @return pointer to prf_t object
727 */
728 chunk_t (*get_skp_verify) (ike_sa_t *this);
729
730 /**
731 * Associates a child SA to this IKE SA
732 *
733 * @param child_sa child_sa to add
734 */
735 void (*add_child_sa) (ike_sa_t *this, child_sa_t *child_sa);
736
737 /**
738 * Get a CHILD_SA identified by protocol and SPI.
739 *
740 * @param protocol protocol of the SA
741 * @param spi SPI of the CHILD_SA
742 * @param inbound TRUE if SPI is inbound, FALSE if outbound
743 * @return child_sa, or NULL if none found
744 */
745 child_sa_t* (*get_child_sa) (ike_sa_t *this, protocol_id_t protocol,
746 u_int32_t spi, bool inbound);
747
748 /**
749 * Create an iterator over all CHILD_SAs.
750 *
751 * @return iterator
752 */
753 iterator_t* (*create_child_sa_iterator) (ike_sa_t *this);
754
755 /**
756 * Rekey the CHILD SA with the specified reqid.
757 *
758 * Looks for a CHILD SA owned by this IKE_SA, and start the rekeing.
759 *
760 * @param protocol protocol of the SA
761 * @param spi inbound SPI of the CHILD_SA
762 * @return
763 * - NOT_FOUND, if IKE_SA has no such CHILD_SA
764 * - SUCCESS, if rekeying initiated
765 */
766 status_t (*rekey_child_sa) (ike_sa_t *this, protocol_id_t protocol, u_int32_t spi);
767
768 /**
769 * Close the CHILD SA with the specified protocol/SPI.
770 *
771 * Looks for a CHILD SA owned by this IKE_SA, deletes it and
772 * notify's the remote peer about the delete. The associated
773 * states and policies in the kernel get deleted, if they exist.
774 *
775 * @param protocol protocol of the SA
776 * @param spi inbound SPI of the CHILD_SA
777 * @return
778 * - NOT_FOUND, if IKE_SA has no such CHILD_SA
779 * - SUCCESS, if delete message sent
780 */
781 status_t (*delete_child_sa) (ike_sa_t *this, protocol_id_t protocol, u_int32_t spi);
782
783 /**
784 * Destroy a CHILD SA with the specified protocol/SPI.
785 *
786 * Looks for a CHILD SA owned by this IKE_SA and destroys it.
787 *
788 * @param protocol protocol of the SA
789 * @param spi inbound SPI of the CHILD_SA
790 * @return
791 * - NOT_FOUND, if IKE_SA has no such CHILD_SA
792 * - SUCCESS
793 */
794 status_t (*destroy_child_sa) (ike_sa_t *this, protocol_id_t protocol, u_int32_t spi);
795
796 /**
797 * Rekey the IKE_SA.
798 *
799 * Sets up a new IKE_SA, moves all CHILDs to it and deletes this IKE_SA.
800 *
801 * @return - SUCCESS, if IKE_SA rekeying initiated
802 */
803 status_t (*rekey) (ike_sa_t *this);
804
805 /**
806 * Restablish the IKE_SA.
807 *
808 * Create a completely new IKE_SA with authentication, recreates all children
809 * within the IKE_SA, closes this IKE_SA.
810 *
811 * @return DESTROY_ME to destroy the IKE_SA
812 */
813 status_t (*reestablish) (ike_sa_t *this);
814
815 /**
816 * Set the lifetime limit received from a AUTH_LIFETIME notify.
817 *
818 * @param lifetime lifetime in seconds
819 */
820 void (*set_auth_lifetime)(ike_sa_t *this, u_int32_t lifetime);
821
822 /**
823 * Set the virtual IP to use for this IKE_SA and its children.
824 *
825 * The virtual IP is assigned per IKE_SA, not per CHILD_SA. It has the same
826 * lifetime as the IKE_SA.
827 *
828 * @param local TRUE to set local address, FALSE for remote
829 * @param ip IP to set as virtual IP
830 */
831 void (*set_virtual_ip) (ike_sa_t *this, bool local, host_t *ip);
832
833 /**
834 * Get the virtual IP configured.
835 *
836 * @param local TRUE to get local virtual IP, FALSE for remote
837 * @return host_t *virtual IP
838 */
839 host_t* (*get_virtual_ip) (ike_sa_t *this, bool local);
840
841 /**
842 * Add a DNS server to the system.
843 *
844 * An IRAS may send a DNS server. To use it, it is installed on the
845 * system. The DNS entry has a lifetime until the IKE_SA gets closed.
846 *
847 * @param dns DNS server to install on the system
848 */
849 void (*add_dns_server) (ike_sa_t *this, host_t *dns);
850
851 /**
852 * Inherit all attributes of other to this after rekeying.
853 *
854 * When rekeying is completed, all CHILD_SAs, the virtual IP and all
855 * outstanding tasks are moved from other to this.
856 * As this call may initiate inherited tasks, a status is returned.
857 *
858 * @param other other task to inherit from
859 * @return DESTROY_ME if initiation of inherited task failed
860 */
861 status_t (*inherit) (ike_sa_t *this, ike_sa_t *other);
862
863 /**
864 * Reset the IKE_SA, useable when initiating fails
865 */
866 void (*reset) (ike_sa_t *this);
867
868 /**
869 * Destroys a ike_sa_t object.
870 */
871 void (*destroy) (ike_sa_t *this);
872 };
873
874 /**
875 * Creates an ike_sa_t object with a specific ID.
876 *
877 * @param ike_sa_id ike_sa_id_t object to associate with new IKE_SA
878 * @return ike_sa_t object
879 */
880 ike_sa_t *ike_sa_create(ike_sa_id_t *ike_sa_id);
881
882 #endif /* IKE_SA_H_ @} */