2 * @file ike_sa_manager.h
4 * @brief Interface of ike_sa_manager_t.
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23 #ifndef IKE_SA_MANAGER_H_
24 #define IKE_SA_MANAGER_H_
27 #include <sa/ike_sa.h>
28 #include <utils/logger.h>
31 typedef struct ike_sa_manager_t ike_sa_manager_t
;
34 * @brief The IKE_SA-Manager is responsible for managing all initiated and responded IKE_SA's.
36 * To avoid access from multiple threads, IKE_SAs must be checked out from
37 * the manager, and checked in after usage.
38 * The manager also handles deletion of SAs.
40 * @todo checking of double-checkouts from the same threads would be nice.
41 * This could be done by comparing thread-ids via pthread_self()...
43 * @todo Managing of ike_sa_t objects in a hash table instead of linked list.
46 * - ike_sa_manager_create()
50 struct ike_sa_manager_t
{
52 * @brief Checkout an IKE_SA, create it when necesarry.
54 * Checks out a SA by its ID. An SA will be created, when:
55 * - Responder SPI is not set (when received an IKE_SA_INIT from initiator)
56 * Management of SPIs is the managers job, he will set it.
57 * This function blocks until SA is available for checkout.
59 * @warning checking out two times without checking in will
60 * result in a deadlock!
62 * @param this the manager object
63 * @param ike_sa_id[in/out] the SA identifier, will be updated
64 * @param ike_sa[out] checked out SA
66 * - SUCCESS if checkout successful
67 * - NOT_FOUND when no such SA is available
68 * - CREATED if a new IKE_SA got created
70 status_t (*checkout
) (ike_sa_manager_t
* this, ike_sa_id_t
*sa_id
, ike_sa_t
**ike_sa
);
73 * @brief Create and checkout an IKE_SA as original initator.
75 * Creates and checks out a SA as initiator.
76 * Management of SPIs is the managers job, he will set it.
78 * @param this the manager object
79 * @param ike_sa[out] checked out SA
81 void (*create_and_checkout
) (ike_sa_manager_t
* this,ike_sa_t
**ike_sa
);
84 * @brief Check out an IKE_SA, defined be the two peers.
86 * Checking out an IKE_SA by their peer addresses may be necessary
87 * for kernel traps, status querying and so on... one of the hosts
88 * may be 0.0.0.0 (defaultroute/any), but not both.
90 * @param this the manager object
91 * @param me host on local side
92 * @param other host on remote side
93 * @param ike_sa[out] checked out SA
95 * - NOT_FOUND, if no such SA found
96 * - SUCCESS, if SA found and ike_sa set appropriatly
98 status_t (*checkout_by_hosts
) (ike_sa_manager_t
* this, host_t
*me
, host_t
*other
, ike_sa_t
**ike_sa
);
101 * @brief Get a list of all IKE_SA SAs currently set up.
103 * The resulting list with all IDs must be destroyd by
104 * the caller. There is no guarantee an ike_sa with the
105 * corrensponding ID really exists, since it may be deleted
106 * in the meantime by another thread.
108 * @param this the manager object
109 * @return a list with ike_sa_id_t s
111 linked_list_t
*(*get_ike_sa_list
) (ike_sa_manager_t
* this);
114 * @brief Get a list of all IKE_SA SAs currently set up specified
115 * by the connections name.
117 * @param this the manager object
118 * @return a list with ike_sa_id_t s
120 linked_list_t
*(*get_ike_sa_list_by_name
) (ike_sa_manager_t
* this, const char *name
);
123 * @brief Log the status of the IKE_SA's in the manager.
125 * A informational log is done to the supplied logger. If logger is
126 * NULL, an internal logger is used. If a name is supplied,
127 * only connections with the matching name will be logged.
129 * @param this the manager object
130 * @param logger logger to do the log, or NULL
131 * @param name name of a connection, or NULL
133 void (*log_status
) (ike_sa_manager_t
* this, logger_t
* logger
, char* name
);
136 * @brief Checkin the SA after usage.
138 * @warning the SA pointer MUST NOT be used after checkin!
139 * The SA must be checked out again!
141 * @param this the manager object
142 * @param ike_sa_id[in/out] the SA identifier, will be updated
143 * @param ike_sa[out] checked out SA
145 * - SUCCESS if checked in
146 * - NOT_FOUND when not found (shouldn't happen!)
148 status_t (*checkin
) (ike_sa_manager_t
* this, ike_sa_t
*ike_sa
);
151 * @brief Delete a SA, which was not checked out.
153 * @warning do not use this when the SA is already checked out, this will
156 * @param this the manager object
157 * @param ike_sa_id[in/out] the SA identifier
160 * - NOT_FOUND when no such SA is available
162 status_t (*delete) (ike_sa_manager_t
* this, ike_sa_id_t
*ike_sa_id
);
165 * @brief Delete a checked out SA.
167 * @param this the manager object
168 * @param ike_sa SA to delete
171 * - NOT_FOUND when no such SA is available
173 status_t (*checkin_and_delete
) (ike_sa_manager_t
* this, ike_sa_t
*ike_sa
);
176 * @brief Destroys the manager with all associated SAs.
178 * Threads will be driven out, so all SAs can be deleted cleanly.
180 * @param this the manager object
182 void (*destroy
) (ike_sa_manager_t
*this);
186 * @brief Create a manager.
188 * @returns ike_sa_manager_t object
192 ike_sa_manager_t
*ike_sa_manager_create(void);
194 #endif /*IKE_SA_MANAGER_H_*/