Support multiple virtual IPs on peer_cfg and ike_sa classes
[strongswan.git] / src / libcharon / sa / ike_sa.h
index cf23de3..d2a394b 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2011 Tobias Brunner
+ * Copyright (C) 2006-2012 Tobias Brunner
  * Copyright (C) 2006 Daniel Roethlisberger
  * Copyright (C) 2005-2009 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -37,11 +37,13 @@ typedef struct ike_sa_t ike_sa_t;
 #include <encoding/payloads/configuration_attribute.h>
 #include <sa/ike_sa_id.h>
 #include <sa/child_sa.h>
+#include <sa/task.h>
 #include <sa/task_manager.h>
 #include <sa/keymat.h>
 #include <config/peer_cfg.h>
 #include <config/ike_cfg.h>
 #include <credentials/auth_cfg.h>
+#include <utils/packet.h>
 
 /**
  * Timeout in seconds after that a half open IKE_SA gets deleted.
@@ -69,7 +71,7 @@ typedef struct ike_sa_t ike_sa_t;
 enum ike_extension_t {
 
        /**
-        * peer supports NAT traversal as specified in RFC4306
+        * peer supports NAT traversal as specified in RFC4306 or RFC3947
         */
        EXT_NATT = (1<<0),
 
@@ -102,6 +104,21 @@ enum ike_extension_t {
         * peer is probably a Windows 7 RAS client
         */
        EXT_MS_WINDOWS = (1<<6),
+
+       /**
+        * peer supports XAuth authentication, draft-ietf-ipsec-isakmp-xauth-06
+        */
+       EXT_XAUTH = (1<<7),
+
+       /**
+        * peer supports DPD detection, RFC 3706 (or IKEv2)
+        */
+       EXT_DPD = (1<<8),
+
+       /**
+        * peer supports Cisco Unity configuration attributes
+        */
+       EXT_CISCO_UNITY = (1<<9),
 };
 
 /**
@@ -148,6 +165,16 @@ enum ike_condition_t {
         * IKE_SA is stale, the peer is currently unreachable (MOBIKE)
         */
        COND_STALE = (1<<7),
+
+       /**
+        * Initial contact received
+        */
+       COND_INIT_CONTACT_SEEN = (1<<8),
+
+       /**
+        * Peer has been authenticated using XAuth
+        */
+       COND_XAUTH_AUTHENTICATED = (1<<9),
 };
 
 /**
@@ -270,6 +297,11 @@ struct ike_sa_t {
        ike_sa_id_t* (*get_id) (ike_sa_t *this);
 
        /**
+        * Gets the IKE version of the SA
+        */
+       ike_version_t (*get_version)(ike_sa_t *this);
+
+       /**
         * Get the numerical ID uniquely defining this IKE_SA.
         *
         * @return                              unique ID
@@ -288,7 +320,7 @@ struct ike_sa_t {
         *
         * @param state                 state to set for the IKE_SA
         */
-       void (*set_state) (ike_sa_t *this, ike_sa_state_t ike_sa);
+       void (*set_state) (ike_sa_t *this, ike_sa_state_t state);
 
        /**
         * Get the name of the connection this IKE_SA uses.
@@ -306,6 +338,14 @@ struct ike_sa_t {
        u_int32_t (*get_statistic)(ike_sa_t *this, statistic_t kind);
 
        /**
+        * Set statistic value of the IKE_SA.
+        *
+        * @param kind                  kind of value to update
+        * @param value                 value as integer
+        */
+       void (*set_statistic)(ike_sa_t *this, statistic_t kind, u_int32_t value);
+
+       /**
         * Get the own host address.
         *
         * @return                              host address
@@ -474,19 +514,19 @@ struct ike_sa_t {
         *
         * @param host                  host to add to list
         */
-       void (*add_additional_address)(ike_sa_t *this, host_t *host);
+       void (*add_peer_address)(ike_sa_t *this, host_t *host);
 
        /**
-        * Create an enumerator over all additional addresses of the peer.
+        * Create an enumerator over all known addresses of the peer.
         *
         * @return                              enumerator over addresses
         */
-       enumerator_t* (*create_additional_address_enumerator)(ike_sa_t *this);
+       enumerator_t* (*create_peer_address_enumerator)(ike_sa_t *this);
 
        /**
-        * Remove all additional addresses of the peer.
+        * Remove all known addresses of the peer.
         */
-       void (*remove_additional_addresses)(ike_sa_t *this);
+       void (*clear_peer_addresses)(ike_sa_t *this);
 
        /**
         * Check if mappings have changed on a NAT for our source address.
@@ -661,6 +701,15 @@ struct ike_sa_t {
                                                  traffic_selector_t *tsr);
 
        /**
+        * Retry initiation of this IKE_SA after it got deferred previously.
+        *
+        * @return
+        *                                              - SUCCESS if initiation deferred or started
+        *                                              - DESTROY_ME if initiation failed
+        */
+       status_t (*retry_initiate) (ike_sa_t *this);
+
+       /**
         * Initiates the deletion of an IKE_SA.
         *
         * Sends a delete message to the remote peer and waits for
@@ -821,11 +870,13 @@ struct ike_sa_t {
         *
         * @param protocol              protocol of the SA
         * @param spi                   inbound SPI of the CHILD_SA
+        * @param expired               TRUE if CHILD_SA is expired
         * @return
         *                                              - NOT_FOUND, if IKE_SA has no such CHILD_SA
         *                                              - SUCCESS, if delete message sent
         */
-       status_t (*delete_child_sa) (ike_sa_t *this, protocol_id_t protocol, u_int32_t spi);
+       status_t (*delete_child_sa)(ike_sa_t *this, protocol_id_t protocol,
+                                                               u_int32_t spi, bool expired);
 
        /**
         * Destroy a CHILD SA with the specified protocol/SPI.
@@ -869,14 +920,18 @@ struct ike_sa_t {
        status_t (*reestablish) (ike_sa_t *this);
 
        /**
-        * Set the lifetime limit received from a AUTH_LIFETIME notify.
+        * Set the lifetime limit received/to send in a AUTH_LIFETIME notify.
+        *
+        * If the IKE_SA is already ESTABLISHED, an INFORMATIONAL is sent with
+        * an AUTH_LIFETIME notify. The call never fails on unestablished SAs.
         *
         * @param lifetime              lifetime in seconds
+        * @return                              DESTROY_ME to destroy the IKE_SA
         */
-       void (*set_auth_lifetime)(ike_sa_t *this, u_int32_t lifetime);
+       status_t (*set_auth_lifetime)(ike_sa_t *this, u_int32_t lifetime);
 
        /**
-        * Set the virtual IP to use for this IKE_SA and its children.
+        * Add a virtual IP to use for this IKE_SA and its children.
         *
         * The virtual IP is assigned per IKE_SA, not per CHILD_SA. It has the same
         * lifetime as the IKE_SA.
@@ -884,15 +939,15 @@ struct ike_sa_t {
         * @param local                 TRUE to set local address, FALSE for remote
         * @param ip                    IP to set as virtual IP
         */
-       void (*set_virtual_ip) (ike_sa_t *this, bool local, host_t *ip);
+       void (*add_virtual_ip) (ike_sa_t *this, bool local, host_t *ip);
 
        /**
-        * Get the virtual IP configured.
+        * Create an enumerator over virtual IPs.
         *
         * @param local                 TRUE to get local virtual IP, FALSE for remote
-        * @return                              host_t *virtual IP
+        * @return                              enumerator over host_t*
         */
-       host_t* (*get_virtual_ip) (ike_sa_t *this, bool local);
+       enumerator_t* (*create_virtual_ip_enumerator) (ike_sa_t *this, bool local);
 
        /**
         * Register a configuration attribute to the IKE_SA.
@@ -929,6 +984,20 @@ struct ike_sa_t {
        enumerator_t* (*create_task_enumerator)(ike_sa_t *this, task_queue_t queue);
 
        /**
+        * Flush a task queue, cancelling all tasks in it.
+        *
+        * @param queue                 queue type to flush
+        */
+       void (*flush_queue)(ike_sa_t *this, task_queue_t queue);
+
+       /**
+        * Queue a task for initiaton to the task manager.
+        *
+        * @param task                  task to queue
+        */
+       void (*queue_task)(ike_sa_t *this, task_t *task);
+
+       /**
         * Inherit all attributes of other to this after rekeying.
         *
         * When rekeying is completed, all CHILD_SAs, the virtual IP and all
@@ -951,11 +1020,14 @@ struct ike_sa_t {
 };
 
 /**
- * Creates an ike_sa_t object with a specific ID.
+ * Creates an ike_sa_t object with a specific ID and IKE version.
  *
- * @param ike_sa_id            ike_sa_id_t object to associate with new IKE_SA
+ * @param ike_sa_id            ike_sa_id_t to associate with new IKE_SA/ISAKMP_SA
+ * @param initiator            TRUE to create this IKE_SA as initiator
+ * @param version              IKE version of this SA
  * @return                             ike_sa_t object
  */
-ike_sa_t *ike_sa_create(ike_sa_id_t *ike_sa_id);
+ike_sa_t *ike_sa_create(ike_sa_id_t *ike_sa_id, bool initiator,
+                                               ike_version_t version);
 
 #endif /** IKE_SA_H_ @}*/