src/charon/sa/ike_sa_manager.h

   1 /*
   2  * Copyright (C) 2008 Tobias Brunner
   3  * Copyright (C) 2005-2008 Martin Willi
   4  * Copyright (C) 2005 Jan Hutter
   5  * Hochschule fuer Technik Rapperswil
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2 of the License, or (at your
  10  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15  * for more details.
  16  */
  17
  18 /**
  19  * @defgroup ike_sa_manager ike_sa_manager
  20  * @{ @ingroup sa
  21  */
  22
  23 #ifndef IKE_SA_MANAGER_H_
  24 #define IKE_SA_MANAGER_H_
  25
  26 typedef struct ike_sa_manager_t ike_sa_manager_t;
  27
  28 #include <library.h>
  29 #include <sa/ike_sa.h>
  30 #include <encoding/message.h>
  31 #include <config/peer_cfg.h>
  32
  33 /**
  34  * Manages and synchronizes access to all IKE_SAs.
  35  *
  36  * To synchronize access to thread-unsave IKE_SAs, they are checked out for
  37  * use and checked in afterwards. A checked out SA is exclusively accessible
  38  * by the owning thread.
  39  */
  40 struct ike_sa_manager_t {
  41
  42         /**
  43          * Checkout an existing IKE_SA.
  44          *
  45          * @param ike_sa_id                     the SA identifier, will be updated
  46          * @returns
  47          *                                                      - checked out IKE_SA if found
  48          *                                                      - NULL, if specified IKE_SA is not found.
  49          */
  50         ike_sa_t* (*checkout) (ike_sa_manager_t* this, ike_sa_id_t *sa_id);
  51
  52         /**
  53          * Create and check out a new IKE_SA.
  54          *
  55          * @note If initiator equals FALSE, the returned IKE_SA is not registered
  56          * in the manager.
  57          *
  58          * @param initiator                     TRUE for initiator, FALSE otherwise
  59          * @returns                             created and checked out IKE_SA
  60          */
  61         ike_sa_t* (*checkout_new) (ike_sa_manager_t* this, bool initiator);
  62
  63         /**
  64          * Checkout an IKE_SA by a message.
  65          *
  66          * In some situations, it is necessary that the manager knows the
  67          * message to use for the checkout. This has the following reasons:
  68          *
  69          * 1. If the targeted IKE_SA is already processing a message, we do not
  70          *    check it out if the message ID is the same.
  71          * 2. If it is an IKE_SA_INIT request, we have to check if it is a
  72          *    retransmission. If so, we have to drop the message, we would
  73          *    create another unneeded IKE_SA for each retransmitted packet.
  74          *
  75          * A call to checkout_by_message() returns a (maybe new created) IKE_SA.
  76          * If processing the message does not make sense (for the reasons above),
  77          * NULL is returned.
  78          *
  79          * @param ike_sa_id                     the SA identifier, will be updated
  80          * @returns
  81          *                                                      - checked out/created IKE_SA
  82          *                                                      - NULL to not process message further
  83          */
  84         ike_sa_t* (*checkout_by_message) (ike_sa_manager_t* this, message_t *message);
  85
  86         /**
  87          * Checkout an IKE_SA for initiation by a peer_config.
  88          *
  89          * To initiate, a CHILD_SA may be established within an existing IKE_SA.
  90          * This call checks for an existing IKE_SA by comparing the configuration.
  91          * If the CHILD_SA can be created in an existing IKE_SA, the matching SA
  92          * is returned.
  93          * If no IKE_SA is found, a new one is created. This is also the case when
  94          * the found IKE_SA is in the DELETING state.
  95          *
  96          * @param peer_cfg                      configuration used to find an existing IKE_SA
  97          * @return                                      checked out/created IKE_SA
  98          */
  99         ike_sa_t* (*checkout_by_config) (ike_sa_manager_t* this,
 100                                                                          peer_cfg_t *peer_cfg);
 101
 102         /**
 103          * Check for duplicates of the given IKE_SA.
 104          *
 105          * Measures are taken according to the uniqueness policy of the IKE_SA.
 106          * The return value indicates whether duplicates have been found and if
 107          * further measures should be taken (e.g. cancelling an IKE_AUTH exchange).
 108          * check_uniqueness() must be called before the IKE_SA is complete,
 109          * deadlocks occur otherwise.
 110          *
 111          * @param ike_sa                        ike_sa to check
 112          * @return                                      TRUE, if the given IKE_SA has duplicates and
 113          *                                                      should be deleted
 114          */
 115         bool (*check_uniqueness)(ike_sa_manager_t *this, ike_sa_t *ike_sa);
 116
 117         /**
 118          * Check out an IKE_SA a unique ID.
 119          *
 120          * Every IKE_SA and every CHILD_SA is uniquely identified by an ID.
 121          * These checkout function uses, depending
 122          * on the child parameter, the unique ID of the IKE_SA or the reqid
 123          * of one of a IKE_SAs CHILD_SA.
 124          *
 125          * @param id                            unique ID of the object
 126          * @param child                         TRUE to use CHILD, FALSE to use IKE_SA
 127          * @return
 128          *                                                      - checked out IKE_SA, if found
 129          *                                                      - NULL, if not found
 130          */
 131         ike_sa_t* (*checkout_by_id) (ike_sa_manager_t* this, u_int32_t id,
 132                                                                  bool child);
 133
 134         /**
 135          * Check out an IKE_SA by the policy/connection name.
 136          *
 137          * Check out the IKE_SA by the configuration name, either from the IKE- or
 138          * one of its CHILD_SAs.
 139          *
 140          * @param name                          name of the connection/policy
 141          * @param child                         TRUE to use policy name, FALSE to use conn name
 142          * @return
 143          *                                                      - checked out IKE_SA, if found
 144          *                                                      - NULL, if not found
 145          */
 146         ike_sa_t* (*checkout_by_name) (ike_sa_manager_t* this, char *name,
 147                                                                    bool child);
 148
 149         /**
 150          * Create an enumerator over all stored IKE_SAs.
 151          *
 152          * While enumerating an IKE_SA, it is temporarily checked out and
 153          * automatically checked in after the current enumeration step.
 154          *
 155          * @return                                      enumerator over all IKE_SAs.
 156          */
 157         enumerator_t *(*create_enumerator) (ike_sa_manager_t* this);
 158
 159         /**
 160          * Checkin the SA after usage.
 161          *
 162          * If the IKE_SA is not registered in the manager, a new entry is created.
 163          *
 164          * @param ike_sa_id                     the SA identifier, will be updated
 165          * @param ike_sa                        checked out SA
 166          */
 167         void (*checkin) (ike_sa_manager_t* this, ike_sa_t *ike_sa);
 168
 169         /**
 170          * Destroy a checked out SA.
 171          *
 172          * The IKE SA is destroyed without notification of the remote peer.
 173          * Use this only if the other peer doesn't respond or behaves not
 174          * as predicted.
 175          * Checking in and destruction is an atomic operation (for the IKE_SA),
 176          * so this can be called if the SA is in a "unclean" state, without the
 177          * risk that another thread can get the SA.
 178          *
 179          * @param ike_sa                        SA to delete
 180          */
 181         void (*checkin_and_destroy) (ike_sa_manager_t* this, ike_sa_t *ike_sa);
 182
 183         /**
 184          * Get the number of IKE_SAs which are in the connecting state.
 185          *
 186          * To prevent the server from resource exhaustion, cookies and other
 187          * mechanisms are used. The number of half open IKE_SAs is a good
 188          * indicator to see if a peer is flooding the server.
 189          * If a host is supplied, only the number of half open IKE_SAs initiated
 190          * from this IP are counted.
 191          * Only SAs for which we are the responder are counted.
 192          *
 193          * @param ip                            NULL for all, IP for half open IKE_SAs with IP
 194          * @return                                      number of half open IKE_SAs
 195          */
 196         int (*get_half_open_count) (ike_sa_manager_t *this, host_t *ip);
 197
 198         /**
 199          * Delete all existing IKE_SAs and destroy them immediately.
 200          *
 201          * Threads will be driven out, so all SAs can be deleted cleanly.
 202          */
 203         void (*flush)(ike_sa_manager_t *this);
 204
 205         /**
 206          * Destroys the manager with all associated SAs.
 207          *
 208          * A call to flush() is required before calling destroy.
 209          */
 210         void (*destroy) (ike_sa_manager_t *this);
 211 };
 212
 213 /**
 214  * Create the IKE_SA manager.
 215  *
 216  * @returns     ike_sa_manager_t object, NULL if initialization fails
 217  */
 218 ike_sa_manager_t *ike_sa_manager_create(void);
 219
 220 #endif /** IKE_SA_MANAGER_H_ @}*/