improved IKE_SA uniqueness check
[strongswan.git] / src / charon / sa / ike_sa_manager.h
index 671062c..b5c479e 100644 (file)
@@ -1,11 +1,5 @@
-/**
- * @file ike_sa_manager.h
- * 
- * @brief Interface of ike_sa_manager_t.
- * 
- */
-
 /*
+ * Copyright (C) 2008 Tobias Brunner
  * Copyright (C) 2005-2006 Martin Willi
  * Copyright (C) 2005 Jan Hutter
  * Hochschule fuer Technik Rapperswil
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup ike_sa_manager ike_sa_manager
+ * @{ @ingroup sa
  */
 
 #ifndef IKE_SA_MANAGER_H_
@@ -28,9 +29,11 @@ typedef struct ike_sa_manager_t ike_sa_manager_t;
 
 #include <library.h>
 #include <sa/ike_sa.h>
+#include <encoding/message.h>
+#include <config/peer_cfg.h>
 
 /**
- * @brief The IKE_SA-Manager is responsible for managing all initiated and responded IKE_SA's.
+ * The IKE_SA-Manager is responsible for managing all initiated and responded IKE_SA's.
  *
  * To avoid access from multiple threads, IKE_SAs must be checked out from
  * the manager, and checked in after usage. 
@@ -40,138 +43,135 @@ typedef struct ike_sa_manager_t ike_sa_manager_t;
  * This could be done by comparing thread-ids via pthread_self()...
  * 
  * @todo Managing of ike_sa_t objects in a hash table instead of linked list.
- * 
- * @b Constructors:
- * - ike_sa_manager_create()
- * 
- * @ingroup sa
  */
 struct ike_sa_manager_t {
+       
        /**
-        * @brief Checkout an IKE_SA, create it when necesarry.
+        * Checkout an existing IKE_SA.
         * 
-        * Checks out a SA by its ID. An SA will be created, when the responder
-        * SPI is not set (when received an IKE_SA_INIT from initiator).
-        * Management of SPIs is the managers job, he will set it.
-        * This function blocks until SA is available for checkout.
-        * 
-        * @warning checking out two times without checking in will
-        * result in a deadlock!
-        * 
-        * @param this                          the manager object
-        * @param[in/out] ike_sa_id     the SA identifier, will be updated
+        * @param ike_sa_id                     the SA identifier, will be updated
         * @returns                                     
         *                                                      - checked out IKE_SA if found
-        *                                                      - NULL, if no such IKE_SA available
+        *                                                      - NULL, if specified IKE_SA is not found.
         */
        ike_sa_t* (*checkout) (ike_sa_manager_t* this, ike_sa_id_t *sa_id);
        
        /**
-        * @brief Checkout an existing IKE_SA by hosts and identifications.
+        * Create and check out a new IKE_SA.
+        * 
+        * @param initiator                     TRUE for initiator, FALSE otherwise
+        * @returns                             created and checked out IKE_SA
+        */
+       ike_sa_t* (*checkout_new) (ike_sa_manager_t* this, bool initiator);
+       
+       /**
+        * Checkout an IKE_SA by a message.
+        * 
+        * In some situations, it is necessary that the manager knows the
+        * message to use for the checkout. This has the following reasons:
+        * 
+        * 1. If the targeted IKE_SA is already processing a message, we do not
+        *    check it out if the message ID is the same.
+        * 2. If it is an IKE_SA_INIT request, we have to check if it is a 
+        *    retransmission. If so, we have to drop the message, we would
+        *    create another unneeded IKE_SA for each retransmitted packet.
+        *
+        * A call to checkout_by_message() returns a (maybe new created) IKE_SA.
+        * If processing the message does not make sense (for the reasons above),
+        * NULL is returned.
+        * 
+        * @param ike_sa_id                     the SA identifier, will be updated
+        * @returns                                     
+        *                                                      - checked out/created IKE_SA
+        *                                                      - NULL to not process message further
+        */
+       ike_sa_t* (*checkout_by_message) (ike_sa_manager_t* this, message_t *message);
+       
+       /**
+        * Checkout an IKE_SA for initiation by a peer_config.
         *
-        * Allows the lookup of an IKE_SA by user IDs and hosts. It returns the
-        * first found occurence, if there are multiple candidates. Supplied IDs
-        * may contain wildcards, hosts may be %any. 
+        * To initiate, a CHILD_SA may be established within an existing IKE_SA.
+        * This call checks for an existing IKE_SA by comparing the configuration.
+        * If the CHILD_SA can be created in an existing IKE_SA, the matching SA
+        * is returned.
         * If no IKE_SA is found, a new one is created. This is also the case when
         * the found IKE_SA is in the DELETING state.
         *
-        * @param this                          the manager object
-        * @param my_host                       address of our host
-        * @param other_id                      address of remote host
-        * @param my_id                         ID used by us
-        * @param other_id                      ID used by remote
+        * @param peer_cfg                      configuration used to find an existing IKE_SA
         * @return                                      checked out/created IKE_SA
         */
-       ike_sa_t* (*checkout_by_id) (ike_sa_manager_t* this,
-                                                                host_t *my_host, host_t* other_host,
-                                                                identification_t *my_id, 
-                                                                identification_t *other_id);
+       ike_sa_t* (*checkout_by_config) (ike_sa_manager_t* this,
+                                                                        peer_cfg_t *peer_cfg);
+       
+       /**
+        * Check for duplicates of the given IKE_SA.
+        * 
+        * Measures are taken according to the uniqueness policy of the IKE_SA.
+        * The return value indicates whether duplicates have been found and if
+        * further measures should be taken (e.g. cancelling an IKE_AUTH exchange).
+        * 
+        * @param ike_sa                        ike_sa to check
+        * @return                                      TRUE, if the given IKE_SA has duplicates and
+        *                                                      should be deleted
+        */
+       bool (*check_uniqueness)(ike_sa_manager_t *this, ike_sa_t *ike_sa);
        
        /**
-        * @brief Check out an IKE_SA by protocol and SPI of one of its CHILD_SA.
+        * Check out an IKE_SA a unique ID.
         *
-        * The kernel sends us expire messages for IPsec SAs. To fullfill
-        * this request, we must check out the IKE SA which contains the
-        * CHILD_SA the kernel wants to modify.
+        * Every IKE_SA and every CHILD_SA is uniquely identified by an ID. 
+        * These checkout function uses, depending
+        * on the child parameter, the unique ID of the IKE_SA or the reqid
+        * of one of a IKE_SAs CHILD_SA.
         *
-        * @param this                          the manager object
-        * @param reqid                         reqid of the CHILD_SA
+        * @param id                            unique ID of the object
+        * @param child                         TRUE to use CHILD, FALSE to use IKE_SA
         * @return
         *                                                      - checked out IKE_SA, if found
         *                                                      - NULL, if not found
         */
-       ike_sa_t* (*checkout_by_child) (ike_sa_manager_t* this, u_int32_t reqid);
+       ike_sa_t* (*checkout_by_id) (ike_sa_manager_t* this, u_int32_t id,
+                                                                bool child);
        
        /**
-        * @brief Create an iterator over all stored IKE_SAs.
+        * Check out an IKE_SA by the policy/connection name.
         *
-        * The avoid synchronization issues, the iterator locks access
-        * to the manager exclusively, until it gets destroyed.
-        * This iterator is for reading only! Writing will corrupt the manager.
+        * Check out the IKE_SA by the connections name or by a CHILD_SAs policy
+        * name.
         *
-        * @param this                          the manager object
-        * @return                                      iterator over all IKE_SAs.
-        */
-       iterator_t *(*create_iterator) (ike_sa_manager_t* this);
-       
-       /**
-        * @brief Checkin the SA after usage.
-        * 
-        * @warning the SA pointer MUST NOT be used after checkin! 
-        * The SA must be checked out again!
-        *  
-        * @param this                          the manager object
-        * @param[in/out] ike_sa_id     the SA identifier, will be updated
-        * @param[out] ike_sa           checked out SA
-        * @returns                             
-        *                                                      - SUCCESS if checked in
-        *                                                      - NOT_FOUND when not found (shouldn't happen!)
+        * @param name                          name of the connection/policy
+        * @param child                         TRUE to use policy name, FALSE to use conn name
+        * @return
+        *                                                      - checked out IKE_SA, if found
+        *                                                      - NULL, if not found
         */
-       status_t (*checkin) (ike_sa_manager_t* this, ike_sa_t *ike_sa);
+       ike_sa_t* (*checkout_by_name) (ike_sa_manager_t* this, char *name,
+                                                                  bool child);
        
        /**
-        * @brief Delete a SA, which was not checked out.
+        * Create an enumerator over all stored IKE_SAs.
         *
-        * If the state allows it, the IKE SA is destroyed immediately. If it is
-        * in the state ESTABLSIHED, a delete message
-        * is sent to the remote peer, which has to be acknowledged.
-        *
-        * @warning do not use this when the SA is already checked out, this will
-        * deadlock!
+        * The avoid synchronization issues, the enumerator locks access
+        * to the manager exclusively, until it gets destroyed.
         *
-        * @param this                          the manager object
-        * @param[in/out] ike_sa_id     the SA identifier
-        * @returns                             
-        *                                                      - SUCCESS if found
-        *                                                      - NOT_FOUND when no such SA is available
+        * @return                                      enumerator over all IKE_SAs.
         */
-       status_t (*delete) (ike_sa_manager_t* this, ike_sa_id_t *ike_sa_id);
+       enumerator_t *(*create_enumerator) (ike_sa_manager_t* this);
        
        /**
-        * @brief Delete a SA identified by its name, which was not checked out.
-        *
-        * Using delete_by_name allows the delete of IKE_SAs and CHILD_SAs.
-        * The supplied name may have one of the following format:
-        *
-        * name{x}              => delete IKE_SA with "name" and unique id "x"
-        * name{}               => delete all IKE_SAs with "name"
-        * name[x]              => delete CHILD_SA with "name" and unique id "x"
-        * name[]               => delete all CHILD_SAs with "name"
-        * name                 => delete all CHILD_SAs or IKE_SAs with "name"
-        *
-        * @warning do not use this when the SA is already checked out, this will
-        * deadlock!
-        *
-        * @param this                          the manager object
-        * @param name                          name in one of the format described above
-        * @returns                             
-        *                                                      - SUCCESS if found
-        *                                                      - NOT_FOUND when no such SA is available
+        * Checkin the SA after usage.
+        * 
+        * @warning the SA pointer MUST NOT be used after checkin! 
+        * The SA must be checked out again!
+        * If the IKE_SA is not registered in the manager, a new entry is created.
+        *  
+        * @param ike_sa_id                     the SA identifier, will be updated
+        * @param ike_sa                        checked out SA
         */
-       status_t (*delete_by_name) (ike_sa_manager_t* this, char *name);
+       void (*checkin) (ike_sa_manager_t* this, ike_sa_t *ike_sa);
        
        /**
-        * @brief Destroy a checked out SA.
+        * Destroy a checked out SA.
         *
         * The IKE SA is destroyed without notification of the remote peer.
         * Use this only if the other peer doesn't respond or behaves not
@@ -180,31 +180,45 @@ struct ike_sa_manager_t {
         * so this can be called if the SA is in a "unclean" state, without the
         * risk that another thread can get the SA.
         *
-        * @param this                          the manager object
         * @param ike_sa                        SA to delete
-        * @returns                             
-        *                                                      - SUCCESS if found
-        *                                                      - NOT_FOUND when no such SA is available
         */
-       status_t (*checkin_and_destroy) (ike_sa_manager_t* this, ike_sa_t *ike_sa);
+       void (*checkin_and_destroy) (ike_sa_manager_t* this, ike_sa_t *ike_sa);
        
        /**
-        * @brief Destroys the manager with all associated SAs.
+        * Get the number of IKE_SAs which are in the connecting state.
+        *
+        * To prevent the server from resource exhaustion, cookies and other
+        * mechanisms are used. The number of half open IKE_SAs is a good
+        * indicator to see if a peer is flooding the server.
+        * If a host is supplied, only the number of half open IKE_SAs initiated
+        * from this IP are counted.
+        * Only SAs for which we are the responder are counted.
         * 
-        * Threads will be driven out, so all SAs can be deleted cleanly.
+        * @param ip                            NULL for all, IP for half open IKE_SAs with IP
+        * @return                                      number of half open IKE_SAs
+        */
+       int (*get_half_open_count) (ike_sa_manager_t *this, host_t *ip);
+       
+       /**
+        * Delete all existing IKE_SAs and destroy them immediately.
         * 
-        * @param this                           the manager object
+        * Threads will be driven out, so all SAs can be deleted cleanly.
+        */
+       void (*flush)(ike_sa_manager_t *this);
+       
+       /**
+        * Destroys the manager with all associated SAs.
+        *
+        * A call to flush() is required before calling destroy.
         */
        void (*destroy) (ike_sa_manager_t *this);
 };
 
 /**
- * @brief Create a manager.
- * 
- * @returns    ike_sa_manager_t object
+ * Create a manager.
  * 
- * @ingroup sa
+ * @returns    ike_sa_manager_t object, NULL if initialization fails
  */
 ike_sa_manager_t *ike_sa_manager_create(void);
 
-#endif /*IKE_SA_MANAGER_H_*/
+#endif /*IKE_SA_MANAGER_H_ @} */