2 * Copyright (C) 2006-2015 Tobias Brunner
3 * Copyright (C) 2006 Daniel Roethlisberger
4 * Copyright (C) 2005-2009 Martin Willi
5 * Copyright (C) 2005 Jan Hutter
6 * Hochschule fuer Technik Rapperswil
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>.
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
20 * @defgroup ike_sa ike_sa
27 typedef enum ike_extension_t ike_extension_t
;
28 typedef enum ike_condition_t ike_condition_t
;
29 typedef enum ike_sa_state_t ike_sa_state_t
;
30 typedef enum statistic_t statistic_t
;
31 typedef struct ike_sa_t ike_sa_t
;
34 #include <attributes/attribute_handler.h>
35 #include <encoding/message.h>
36 #include <encoding/payloads/proposal_substructure.h>
37 #include <encoding/payloads/configuration_attribute.h>
38 #include <sa/ike_sa_id.h>
39 #include <sa/child_sa.h>
41 #include <sa/task_manager.h>
42 #include <sa/keymat.h>
43 #include <config/peer_cfg.h>
44 #include <config/ike_cfg.h>
45 #include <credentials/auth_cfg.h>
46 #include <networking/packet.h>
49 * Timeout in seconds after that a half open IKE_SA gets deleted.
51 #define HALF_OPEN_IKE_SA_TIMEOUT 30
54 * Interval to send keepalives when NATed, in seconds.
56 #define KEEPALIVE_INTERVAL 20
59 * After which time rekeying should be retried if it failed, in seconds.
61 #define RETRY_INTERVAL 30
64 * Jitter to subtract from RETRY_INTERVAL to randomize rekey retry.
66 #define RETRY_JITTER 20
69 * Extensions (or optional features) the peer supports
71 enum ike_extension_t
{
74 * peer supports NAT traversal as specified in RFC4306 or RFC3947
75 * including some RFC3947 drafts
80 * peer supports MOBIKE (RFC4555)
85 * peer supports HTTP cert lookups as specified in RFC4306
87 EXT_HASH_AND_URL
= (1<<2),
90 * peer supports multiple authentication exchanges, RFC4739
92 EXT_MULTIPLE_AUTH
= (1<<3),
95 * peer uses strongSwan, accept private use extensions
97 EXT_STRONGSWAN
= (1<<4),
100 * peer supports EAP-only authentication, draft-eronen-ipsec-ikev2-eap-auth
102 EXT_EAP_ONLY_AUTHENTICATION
= (1<<5),
105 * peer is probably a Windows RAS client
107 EXT_MS_WINDOWS
= (1<<6),
110 * peer supports XAuth authentication, draft-ietf-ipsec-isakmp-xauth-06
115 * peer supports DPD detection, RFC 3706 (or IKEv2)
120 * peer supports Cisco Unity configuration attributes
122 EXT_CISCO_UNITY
= (1<<9),
125 * peer supports NAT traversal as specified in
126 * draft-ietf-ipsec-nat-t-ike-02 .. -03
128 EXT_NATT_DRAFT_02_03
= (1<<10),
131 * peer supports proprietary IKEv1 or standardized IKEv2 fragmentation
133 EXT_IKE_FRAGMENTATION
= (1<<11),
136 * Signature Authentication, RFC 7427
138 EXT_SIGNATURE_AUTH
= (1<<12),
141 * IKEv2 Redirect Mechanism, RFC 5685
143 EXT_IKE_REDIRECTION
= (1<<13),
147 * Conditions of an IKE_SA, change during its lifetime
149 enum ike_condition_t
{
152 * Connection is natted (or faked) somewhere
154 COND_NAT_ANY
= (1<<0),
159 COND_NAT_HERE
= (1<<1),
162 * other is behind NAT
164 COND_NAT_THERE
= (1<<2),
167 * Faking NAT to enforce UDP encapsulation
169 COND_NAT_FAKE
= (1<<3),
172 * peer has been authenticated using EAP at least once
174 COND_EAP_AUTHENTICATED
= (1<<4),
177 * received a certificate request from the peer
179 COND_CERTREQ_SEEN
= (1<<5),
182 * Local peer is the "original" IKE initiator. Unaffected from rekeying.
184 COND_ORIGINAL_INITIATOR
= (1<<6),
187 * IKE_SA is stale, the peer is currently unreachable (MOBIKE)
192 * Initial contact received
194 COND_INIT_CONTACT_SEEN
= (1<<8),
197 * Peer has been authenticated using XAuth
199 COND_XAUTH_AUTHENTICATED
= (1<<9),
202 * This IKE_SA is currently being reauthenticated
204 COND_REAUTHENTICATING
= (1<<10),
208 * Timing information and statistics to query from an SA
211 /** Timestamp of SA establishement */
212 STAT_ESTABLISHED
= 0,
213 /** Timestamp of scheduled rekeying */
215 /** Timestamp of scheduled reauthentication */
217 /** Timestamp of scheduled delete */
219 /** Timestamp of last inbound IKE packet */
221 /** Timestamp of last outbound IKE packet */
228 * State of an IKE_SA.
230 * An IKE_SA passes various states in its lifetime. A newly created
231 * SA is in the state CREATED.
237 on initiate()---> ¦ <----- on IKE_SA_INIT received
243 ¦ <----- on IKE_AUTH successfully completed
246 ¦ SA_ESTABLISHED ¦-------------------------+ <-- on rekeying
247 +----------------+ ¦
249 on delete()---> ¦ <----- on IKE_SA +-------------+
250 ¦ delete request ¦ SA_REKEYING ¦
251 ¦ received +-------------+
253 +----------------+ ¦
254 ¦ SA_DELETING ¦<------------------------+ <-- after rekeying
257 ¦ <----- after delete() acknowledged
264 enum ike_sa_state_t
{
267 * IKE_SA just got created, but is not initiating nor responding yet.
272 * IKE_SA gets initiated actively or passively
277 * IKE_SA is fully established
282 * IKE_SA is managed externally and does not process messages
287 * IKE_SA rekeying in progress
292 * IKE_SA is in progress of deletion
297 * IKE_SA object gets destroyed
303 * enum names for ike_sa_state_t.
305 extern enum_name_t
*ike_sa_state_names
;
308 * Class ike_sa_t representing an IKE_SA.
310 * An IKE_SA contains crypto information related to a connection
311 * with a peer. It contains multiple IPsec CHILD_SA, for which
312 * it is responsible. All traffic is handled by an IKE_SA, using
313 * the task manager and its tasks.
318 * Get the id of the SA.
320 * Returned ike_sa_id_t object is not getting cloned!
322 * @return ike_sa's ike_sa_id_t
324 ike_sa_id_t
* (*get_id
) (ike_sa_t
*this);
327 * Gets the IKE version of the SA
329 ike_version_t (*get_version
)(ike_sa_t
*this);
332 * Get the numerical ID uniquely defining this IKE_SA.
336 u_int32_t (*get_unique_id
) (ike_sa_t
*this);
339 * Get the state of the IKE_SA.
341 * @return state of the IKE_SA
343 ike_sa_state_t (*get_state
) (ike_sa_t
*this);
346 * Set the state of the IKE_SA.
348 * @param state state to set for the IKE_SA
350 void (*set_state
) (ike_sa_t
*this, ike_sa_state_t state
);
353 * Get the name of the connection this IKE_SA uses.
357 char* (*get_name
) (ike_sa_t
*this);
360 * Get statistic values from the IKE_SA.
362 * @param kind kind of requested value
363 * @return value as integer
365 u_int32_t (*get_statistic
)(ike_sa_t
*this, statistic_t kind
);
368 * Set statistic value of the IKE_SA.
370 * @param kind kind of value to update
371 * @param value value as integer
373 void (*set_statistic
)(ike_sa_t
*this, statistic_t kind
, u_int32_t value
);
376 * Get the own host address.
378 * @return host address
380 host_t
* (*get_my_host
) (ike_sa_t
*this);
383 * Set the own host address.
385 * @param me host address
387 void (*set_my_host
) (ike_sa_t
*this, host_t
*me
);
390 * Get the other peers host address.
392 * @return host address
394 host_t
* (*get_other_host
) (ike_sa_t
*this);
397 * Set the others host address.
399 * @param other host address
401 void (*set_other_host
) (ike_sa_t
*this, host_t
*other
);
404 * Float to port 4500 (e.g. if a NAT is detected).
406 * The port of either endpoint is changed only if it is currently
407 * set to the default value of 500.
409 void (*float_ports
)(ike_sa_t
*this);
412 * Update the IKE_SAs host.
414 * Hosts may be NULL to use current host.
416 * @param me new local host address, or NULL
417 * @param other new remote host address, or NULL
418 * @param force force update
420 void (*update_hosts
)(ike_sa_t
*this, host_t
*me
, host_t
*other
, bool force
);
423 * Get the own identification.
425 * @return identification
427 identification_t
* (*get_my_id
) (ike_sa_t
*this);
430 * Set the own identification.
432 * @param me identification
434 void (*set_my_id
) (ike_sa_t
*this, identification_t
*me
);
437 * Get the other peer's identification.
439 * @return identification
441 identification_t
* (*get_other_id
) (ike_sa_t
*this);
444 * Get the others peer identity, but prefer an EAP-Identity.
446 * @return EAP or IKEv2 identity
448 identification_t
* (*get_other_eap_id
)(ike_sa_t
*this);
451 * Set the other peer's identification.
453 * @param other identification
455 void (*set_other_id
) (ike_sa_t
*this, identification_t
*other
);
458 * Get the config used to setup this IKE_SA.
462 ike_cfg_t
* (*get_ike_cfg
) (ike_sa_t
*this);
465 * Set the config to setup this IKE_SA.
467 * @param config ike_config to use
469 void (*set_ike_cfg
) (ike_sa_t
*this, ike_cfg_t
* config
);
472 * Get the peer config used by this IKE_SA.
474 * @return peer_config
476 peer_cfg_t
* (*get_peer_cfg
) (ike_sa_t
*this);
479 * Set the peer config to use with this IKE_SA.
481 * @param config peer_config to use
483 void (*set_peer_cfg
) (ike_sa_t
*this, peer_cfg_t
*config
);
486 * Get the authentication config with rules of the current auth round.
488 * @param local TRUE for local rules, FALSE for remote constraints
489 * @return current cfg
491 auth_cfg_t
* (*get_auth_cfg
)(ike_sa_t
*this, bool local
);
494 * Insert a completed authentication round.
496 * @param local TRUE for own rules, FALSE for others constraints
497 * @param cfg auth config to append
499 void (*add_auth_cfg
)(ike_sa_t
*this, bool local
, auth_cfg_t
*cfg
);
502 * Create an enumerator over added authentication rounds.
504 * @param local TRUE for own rules, FALSE for others constraints
505 * @return enumerator over auth_cfg_t
507 enumerator_t
* (*create_auth_cfg_enumerator
)(ike_sa_t
*this, bool local
);
510 * Get the selected proposal of this IKE_SA.
512 * @return selected proposal
514 proposal_t
* (*get_proposal
)(ike_sa_t
*this);
517 * Set the proposal selected for this IKE_SA.
519 * @param selected proposal
521 void (*set_proposal
)(ike_sa_t
*this, proposal_t
*proposal
);
524 * Set the message id of the IKE_SA.
526 * The IKE_SA stores two message IDs, one for initiating exchanges (send)
527 * and one to respond to exchanges (expect).
529 * @param initiate TRUE to set message ID for initiating
530 * @param mid message id to set
532 void (*set_message_id
)(ike_sa_t
*this, bool initiate
, u_int32_t mid
);
535 * Add an additional address for the peer.
537 * In MOBIKE, a peer may transmit additional addresses where it is
538 * reachable. These are stored in the IKE_SA.
539 * The own list of addresses is not stored, they are queried from
540 * the kernel when required.
542 * @param host host to add to list
544 void (*add_peer_address
)(ike_sa_t
*this, host_t
*host
);
547 * Create an enumerator over all known addresses of the peer.
549 * @return enumerator over addresses
551 enumerator_t
* (*create_peer_address_enumerator
)(ike_sa_t
*this);
554 * Remove all known addresses of the peer.
556 void (*clear_peer_addresses
)(ike_sa_t
*this);
559 * Check if mappings have changed on a NAT for our source address.
561 * @param hash received DESTINATION_IP hash
562 * @return TRUE if mappings have changed
564 bool (*has_mapping_changed
)(ike_sa_t
*this, chunk_t hash
);
567 * Enable an extension the peer supports.
569 * If support for an IKE extension is detected, this method is called
570 * to enable that extension and behave accordingly.
572 * @param extension extension to enable
574 void (*enable_extension
)(ike_sa_t
*this, ike_extension_t extension
);
577 * Check if the peer supports an extension.
579 * @param extension extension to check for support
580 * @return TRUE if peer supports it, FALSE otherwise
582 bool (*supports_extension
)(ike_sa_t
*this, ike_extension_t extension
);
585 * Enable/disable a condition flag for this IKE_SA.
587 * @param condition condition to enable/disable
588 * @param enable TRUE to enable condition, FALSE to disable
590 void (*set_condition
) (ike_sa_t
*this, ike_condition_t condition
, bool enable
);
593 * Check if a condition flag is set.
595 * @param condition condition to check
596 * @return TRUE if condition flag set, FALSE otherwise
598 bool (*has_condition
) (ike_sa_t
*this, ike_condition_t condition
);
601 * Get the number of queued MOBIKE address updates.
603 * @return number of pending updates
605 u_int32_t (*get_pending_updates
)(ike_sa_t
*this);
608 * Set the number of queued MOBIKE address updates.
610 * @param updates number of pending updates
612 void (*set_pending_updates
)(ike_sa_t
*this, u_int32_t updates
);
616 * Activate mediation server functionality for this IKE_SA.
618 void (*act_as_mediation_server
) (ike_sa_t
*this);
621 * Get the server reflexive host.
623 * @return server reflexive host
625 host_t
* (*get_server_reflexive_host
) (ike_sa_t
*this);
628 * Set the server reflexive host.
630 * @param host server reflexive host
632 void (*set_server_reflexive_host
) (ike_sa_t
*this, host_t
*host
);
635 * Get the connect ID.
639 chunk_t (*get_connect_id
) (ike_sa_t
*this);
642 * Initiate the mediation of a mediated connection (i.e. initiate a
643 * ME_CONNECT exchange to a mediation server).
645 * @param mediated_cfg peer_cfg of the mediated connection
647 * - SUCCESS if initialization started
648 * - DESTROY_ME if initialization failed
650 status_t (*initiate_mediation
) (ike_sa_t
*this, peer_cfg_t
*mediated_cfg
);
653 * Initiate the mediated connection
655 * @param me local endpoint (gets cloned)
656 * @param other remote endpoint (gets cloned)
657 * @param connect_id connect ID (gets cloned)
659 * - SUCCESS if initialization started
660 * - DESTROY_ME if initialization failed
662 status_t (*initiate_mediated
) (ike_sa_t
*this, host_t
*me
, host_t
*other
,
666 * Relay data from one peer to another (i.e. initiate a ME_CONNECT exchange
671 * @param requester ID of the requesting peer
672 * @param connect_id data of the ME_CONNECTID payload
673 * @param connect_key data of the ME_CONNECTKEY payload
674 * @param endpoints endpoints
675 * @param response TRUE if this is a response
677 * - SUCCESS if relay started
678 * - DESTROY_ME if relay failed
680 status_t (*relay
) (ike_sa_t
*this, identification_t
*requester
,
681 chunk_t connect_id
, chunk_t connect_key
,
682 linked_list_t
*endpoints
, bool response
);
685 * Send a callback to a peer.
689 * @param peer_id ID of the other peer
691 * - SUCCESS if response started
692 * - DESTROY_ME if response failed
694 status_t (*callback
) (ike_sa_t
*this, identification_t
*peer_id
);
697 * Respond to a ME_CONNECT request.
701 * @param peer_id ID of the other peer
702 * @param connect_id the connect ID supplied by the initiator
704 * - SUCCESS if response started
705 * - DESTROY_ME if response failed
707 status_t (*respond
) (ike_sa_t
*this, identification_t
*peer_id
,
712 * Initiate a new connection.
714 * The configs are owned by the IKE_SA after the call. If the initiate
715 * is triggered by a packet, traffic selectors of the packet can be added
718 * @param child_cfg child config to create CHILD from
719 * @param reqid reqid to use for CHILD_SA, 0 assigne uniquely
720 * @param tsi source of triggering packet
721 * @param tsr destination of triggering packet.
723 * - SUCCESS if initialization started
724 * - DESTROY_ME if initialization failed
726 status_t (*initiate
) (ike_sa_t
*this, child_cfg_t
*child_cfg
,
727 u_int32_t reqid
, traffic_selector_t
*tsi
,
728 traffic_selector_t
*tsr
);
731 * Retry initiation of this IKE_SA after it got deferred previously.
734 * - SUCCESS if initiation deferred or started
735 * - DESTROY_ME if initiation failed
737 status_t (*retry_initiate
) (ike_sa_t
*this);
740 * Initiates the deletion of an IKE_SA.
742 * Sends a delete message to the remote peer and waits for
743 * its response. If the response comes in, or a timeout occurs,
744 * the IKE SA gets deleted.
747 * - SUCCESS if deletion is initialized
748 * - DESTROY_ME, if the IKE_SA is not in
749 * an established state and can not be
750 * deleted (but destroyed).
752 status_t (*delete) (ike_sa_t
*this);
755 * Update IKE_SAs after network interfaces have changed.
757 * Whenever the network interface configuration changes, the kernel
758 * interface calls roam() on each IKE_SA. The IKE_SA then checks if
759 * the new network config requires changes, and handles appropriate.
760 * If MOBIKE is supported, addresses are updated; If not, the tunnel is
763 * @param address TRUE if address list changed, FALSE otherwise
764 * @return SUCCESS, FAILED, DESTROY_ME
766 status_t (*roam
)(ike_sa_t
*this, bool address
);
769 * Processes an incoming IKE message.
771 * Message processing may fail. If a critical failure occurs,
772 * process_message() return DESTROY_ME. Then the caller must
773 * destroy the IKE_SA immediately, as it is unusable.
775 * @param message message to process
779 * - DESTROY_ME if this IKE_SA MUST be deleted
781 status_t (*process_message
)(ike_sa_t
*this, message_t
*message
);
784 * Generate an IKE message to send it to the peer.
786 * This method generates all payloads in the message and encrypts/signs
789 * @param message message to generate
790 * @param packet generated output packet
794 * - DESTROY_ME if this IKE_SA MUST be deleted
796 status_t (*generate_message
)(ike_sa_t
*this, message_t
*message
,
800 * Generate an IKE message to send it to the peer. If enabled and supported
801 * it will be fragmented.
803 * This method generates all payloads in the message and encrypts/signs
804 * the packet/fragments.
806 * @param message message to generate
807 * @param packets enumerator of generated packet_t* (are not destroyed
808 * with the enumerator)
812 * - DESTROY_ME if this IKE_SA MUST be deleted
814 status_t (*generate_message_fragmented
)(ike_sa_t
*this, message_t
*message
,
815 enumerator_t
**packets
);
818 * Retransmits a request.
820 * @param message_id ID of the request to retransmit
823 * - NOT_FOUND if request doesn't have to be retransmited
825 status_t (*retransmit
) (ike_sa_t
*this, u_int32_t message_id
);
828 * Sends a DPD request to the peer.
830 * To check if a peer is still alive, periodic
831 * empty INFORMATIONAL messages are sent if no
832 * other traffic was received.
836 * - DESTROY_ME, if peer did not respond
838 status_t (*send_dpd
) (ike_sa_t
*this);
841 * Sends a keep alive packet.
843 * To refresh NAT tables in a NAT router between the peers, periodic empty
844 * UDP packets are sent if no other traffic was sent.
846 * @param scheduled if this is a scheduled keepalive
848 void (*send_keepalive
) (ike_sa_t
*this, bool scheduled
);
851 * Handle a redirect request.
853 * The behavior is different depending on the state of the IKE_SA.
855 * @param gateway gateway ID (IP or FQDN) of the target
856 * @return FALSE if redirect not possible, TRUE otherwise
858 bool (*handle_redirect
)(ike_sa_t
*this, identification_t
*gateway
);
861 * Get the address of the gateway that redirected us.
863 * @return original gateway address
865 host_t
*(*get_redirected_from
)(ike_sa_t
*this);
868 * Get the keying material of this IKE_SA.
870 * @return per IKE_SA keymat instance
872 keymat_t
* (*get_keymat
)(ike_sa_t
*this);
875 * Associates a child SA to this IKE SA
877 * @param child_sa child_sa to add
879 void (*add_child_sa
) (ike_sa_t
*this, child_sa_t
*child_sa
);
882 * Get a CHILD_SA identified by protocol and SPI.
884 * @param protocol protocol of the SA
885 * @param spi SPI of the CHILD_SA
886 * @param inbound TRUE if SPI is inbound, FALSE if outbound
887 * @return child_sa, or NULL if none found
889 child_sa_t
* (*get_child_sa
) (ike_sa_t
*this, protocol_id_t protocol
,
890 u_int32_t spi
, bool inbound
);
893 * Get the number of CHILD_SAs.
895 * @return number of CHILD_SAs
897 int (*get_child_count
) (ike_sa_t
*this);
900 * Create an enumerator over all CHILD_SAs.
904 enumerator_t
* (*create_child_sa_enumerator
) (ike_sa_t
*this);
907 * Remove the CHILD_SA the given enumerator points to from this IKE_SA.
909 * @param enumerator enumerator pointing to CHILD_SA
911 void (*remove_child_sa
) (ike_sa_t
*this, enumerator_t
*enumerator
);
914 * Rekey the CHILD SA with the specified reqid.
916 * Looks for a CHILD SA owned by this IKE_SA, and start the rekeing.
918 * @param protocol protocol of the SA
919 * @param spi inbound SPI of the CHILD_SA
921 * - NOT_FOUND, if IKE_SA has no such CHILD_SA
922 * - SUCCESS, if rekeying initiated
924 status_t (*rekey_child_sa
) (ike_sa_t
*this, protocol_id_t protocol
, u_int32_t spi
);
927 * Close the CHILD SA with the specified protocol/SPI.
929 * Looks for a CHILD SA owned by this IKE_SA, deletes it and
930 * notify's the remote peer about the delete. The associated
931 * states and policies in the kernel get deleted, if they exist.
933 * @param protocol protocol of the SA
934 * @param spi inbound SPI of the CHILD_SA
935 * @param expired TRUE if CHILD_SA is expired
937 * - NOT_FOUND, if IKE_SA has no such CHILD_SA
938 * - SUCCESS, if delete message sent
940 status_t (*delete_child_sa
)(ike_sa_t
*this, protocol_id_t protocol
,
941 u_int32_t spi
, bool expired
);
944 * Destroy a CHILD SA with the specified protocol/SPI.
946 * Looks for a CHILD SA owned by this IKE_SA and destroys it.
948 * @param protocol protocol of the SA
949 * @param spi inbound SPI of the CHILD_SA
951 * - NOT_FOUND, if IKE_SA has no such CHILD_SA
954 status_t (*destroy_child_sa
) (ike_sa_t
*this, protocol_id_t protocol
, u_int32_t spi
);
959 * Sets up a new IKE_SA, moves all CHILDs to it and deletes this IKE_SA.
961 * @return - SUCCESS, if IKE_SA rekeying initiated
963 status_t (*rekey
) (ike_sa_t
*this);
966 * Reauthenticate the IKE_SA.
968 * Triggers a new IKE_SA that replaces this one. IKEv1 implicitly inherits
969 * all Quick Modes, while IKEv2 recreates all active and queued CHILD_SAs
972 * @return DESTROY_ME to destroy the IKE_SA
974 status_t (*reauth
) (ike_sa_t
*this);
977 * Restablish the IKE_SA.
979 * Reestablish an IKE_SA after it has been closed.
981 * @return DESTROY_ME to destroy the IKE_SA
983 status_t (*reestablish
) (ike_sa_t
*this);
986 * Set the lifetime limit received/to send in a AUTH_LIFETIME notify.
988 * If the IKE_SA is already ESTABLISHED, an INFORMATIONAL is sent with
989 * an AUTH_LIFETIME notify. The call never fails on unestablished SAs.
991 * @param lifetime lifetime in seconds
992 * @return DESTROY_ME to destroy the IKE_SA
994 status_t (*set_auth_lifetime
)(ike_sa_t
*this, u_int32_t lifetime
);
997 * Add a virtual IP to use for this IKE_SA and its children.
999 * The virtual IP is assigned per IKE_SA, not per CHILD_SA. It has the same
1000 * lifetime as the IKE_SA.
1002 * @param local TRUE to set local address, FALSE for remote
1003 * @param ip IP to set as virtual IP
1005 void (*add_virtual_ip
) (ike_sa_t
*this, bool local
, host_t
*ip
);
1008 * Clear all virtual IPs stored on this IKE_SA.
1010 * @param local TRUE to clear local addresses, FALSE for remote
1012 void (*clear_virtual_ips
) (ike_sa_t
*this, bool local
);
1015 * Create an enumerator over virtual IPs.
1017 * @param local TRUE to get local virtual IP, FALSE for remote
1018 * @return enumerator over host_t*
1020 enumerator_t
* (*create_virtual_ip_enumerator
) (ike_sa_t
*this, bool local
);
1023 * Register a configuration attribute to the IKE_SA.
1025 * If an IRAS sends a configuration attribute it is installed and
1026 * registered at the IKE_SA. Attributes are inherit()ed and get released
1027 * when the IKE_SA is closed.
1029 * Unhandled attributes are passed as well, but with a NULL handler. They
1030 * do not get released.
1032 * @param handler handler installed the attribute, use for release()
1033 * @param type configuration attribute type
1034 * @param data associated attribute data
1036 void (*add_configuration_attribute
)(ike_sa_t
*this,
1037 attribute_handler_t
*handler
,
1038 configuration_attribute_type_t type
, chunk_t data
);
1041 * Create an enumerator over received configuration attributes.
1043 * The resulting enumerator is over the configuration_attribute_type_t type,
1044 * a value chunk_t followed by a bool flag. The boolean flag indicates if
1045 * the attribute has been handled by an attribute handler.
1047 * @return enumerator over type, value and the "handled" flag.
1049 enumerator_t
* (*create_attribute_enumerator
)(ike_sa_t
*this);
1052 * Set local and remote host addresses to be used for IKE.
1054 * These addresses are communicated via the KMADDRESS field of a MIGRATE
1055 * message sent via the NETLINK or PF _KEY kernel socket interface.
1057 * @param local local kmaddress
1058 * @param remote remote kmaddress
1060 void (*set_kmaddress
) (ike_sa_t
*this, host_t
*local
, host_t
*remote
);
1063 * Create enumerator over a task queue of this IKE_SA.
1065 * @param queue type to enumerate
1066 * @return enumerator over task_t
1068 enumerator_t
* (*create_task_enumerator
)(ike_sa_t
*this, task_queue_t queue
);
1071 * Flush a task queue, cancelling all tasks in it.
1073 * @param queue queue type to flush
1075 void (*flush_queue
)(ike_sa_t
*this, task_queue_t queue
);
1078 * Queue a task for initiaton to the task manager.
1080 * @param task task to queue
1082 void (*queue_task
)(ike_sa_t
*this, task_t
*task
);
1085 * Inherit required attributes to new SA before rekeying.
1087 * Some properties of the SA must be applied before starting IKE_SA
1088 * rekeying, such as the configuration or support extensions.
1090 * @param other other IKE_SA to inherit from
1092 void (*inherit_pre
)(ike_sa_t
*this, ike_sa_t
*other
);
1095 * Inherit all attributes of other to this after rekeying.
1097 * When rekeying is completed, all CHILD_SAs, the virtual IP and all
1098 * outstanding tasks are moved from other to this.
1100 * @param other other IKE SA to inherit from
1102 void (*inherit_post
) (ike_sa_t
*this, ike_sa_t
*other
);
1105 * Reset the IKE_SA, useable when initiating fails
1107 void (*reset
) (ike_sa_t
*this);
1110 * Destroys a ike_sa_t object.
1112 void (*destroy
) (ike_sa_t
*this);
1116 * Creates an ike_sa_t object with a specific ID and IKE version.
1118 * @param ike_sa_id ike_sa_id_t to associate with new IKE_SA/ISAKMP_SA
1119 * @param initiator TRUE to create this IKE_SA as initiator
1120 * @param version IKE version of this SA
1121 * @return ike_sa_t object
1123 ike_sa_t
*ike_sa_create(ike_sa_id_t
*ike_sa_id
, bool initiator
,
1124 ike_version_t version
);
1126 #endif /** IKE_SA_H_ @}*/