added .gitignore files to NM applet
[strongswan.git] / src / charon / daemon.h
1 /*
2 * Copyright (C) 2006-2007 Tobias Brunner
3 * Copyright (C) 2005-2009 Martin Willi
4 * Copyright (C) 2006 Daniel Roethlisberger
5 * Copyright (C) 2005 Jan Hutter
6 * Hochschule fuer Technik Rapperswil
7 *
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>.
12 *
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
16 * for more details.
17 */
18
19 /**
20 * @defgroup charon charon
21 *
22 * @defgroup bus bus
23 * @ingroup charon
24 *
25 * @defgroup listeners listeners
26 * @ingroup bus
27 *
28 * @defgroup config config
29 * @ingroup charon
30 *
31 * @defgroup attributes attributes
32 * @ingroup config
33 *
34 * @defgroup control control
35 * @ingroup charon
36 *
37 * @defgroup ccredentials credentials
38 * @ingroup charon
39 *
40 * @defgroup sets sets
41 * @ingroup ccredentials
42 *
43 * @defgroup encoding encoding
44 * @ingroup charon
45 *
46 * @defgroup payloads payloads
47 * @ingroup encoding
48 *
49 * @defgroup kernel kernel
50 * @ingroup charon
51 *
52 * @defgroup network network
53 * @ingroup charon
54 *
55 * @defgroup cplugins plugins
56 * @ingroup charon
57 *
58 * @defgroup processing processing
59 * @ingroup charon
60 *
61 * @defgroup jobs jobs
62 * @ingroup processing
63 *
64 * @defgroup sa sa
65 * @ingroup charon
66 *
67 * @defgroup authenticators authenticators
68 * @ingroup sa
69 *
70 * @defgroup eap eap
71 * @ingroup authenticators
72 *
73 * @defgroup tasks tasks
74 * @ingroup sa
75 *
76 * @addtogroup charon
77 * @{
78 *
79 * IKEv2 keying daemon.
80 *
81 * All IKEv2 stuff is handled in charon. It uses a newer and more flexible
82 * architecture than pluto. Charon uses a thread-pool (called processor),
83 * which allows parallel execution SA-management. All threads originate
84 * from the processor. Work is delegated to the processor by queueing jobs
85 * to it.
86 @verbatim
87
88 +---------------------------------+ +----------------------------+
89 | controller | | config |
90 +---------------------------------+ +----------------------------+
91 | | | ^ ^ ^
92 V V V | | |
93
94 +----------+ +-----------+ +------+ +----------+ +----+
95 | receiver | | | | | +------+ | CHILD_SA | | K |
96 +---+------+ | Scheduler | | IKE- | | IKE- |--+----------+ | e |
97 | | | | SA |--| SA | | CHILD_SA | | r |
98 +------+---+ +-----------+ | | +------+ +----------+ | n |
99 <->| socket | | | Man- | | e |
100 +------+---+ +-----------+ | ager | +------+ +----------+ | l |
101 | | | | | | IKE- |--| CHILD_SA | | - |
102 +---+------+ | Processor |---| |--| SA | +----------+ | I |
103 | sender | | | | | +------+ | f |
104 +----------+ +-----------+ +------+ +----+
105
106 | | | | | |
107 V V V V V V
108 +---------------------------------+ +----------------------------+
109 | Bus | | credentials |
110 +---------------------------------+ +----------------------------+
111
112 @endverbatim
113 * The scheduler is responsible to execute timed events. Jobs may be queued to
114 * the scheduler to get executed at a defined time (e.g. rekeying). The
115 * scheduler does not execute the jobs itself, it queues them to the processor.
116 *
117 * The IKE_SA manager managers all IKE_SA. It further handles the
118 * synchronization:
119 * Each IKE_SA must be checked out strictly and checked in again after use. The
120 * manager guarantees that only one thread may check out a single IKE_SA. This
121 * allows us to write the (complex) IKE_SAs routines non-threadsave.
122 * The IKE_SA contain the state and the logic of each IKE_SA and handle the
123 * messages.
124 *
125 * The CHILD_SA contains state about a IPsec security association and manages
126 * them. An IKE_SA may have multiple CHILD_SAs. Communication to the kernel
127 * takes place here through the kernel interface.
128 *
129 * The kernel interface installs IPsec security associations, policies, routes
130 * and virtual addresses. It further provides methods to enumerate interfaces
131 * and may notify the daemon about state changes at lower layers.
132 *
133 * The bus receives signals from the different threads and relais them to interested
134 * listeners. Debugging signals, but also important state changes or error
135 * messages are sent over the bus.
136 * It's listeners are not only for logging, but also to track the state of an
137 * IKE_SA.
138 *
139 * The controller, credential_manager, bus and backend_manager (config) are
140 * places where a plugin ca register itself to privide information or observe
141 * and control the daemon.
142 */
143
144 #ifndef DAEMON_H_
145 #define DAEMON_H_
146
147 typedef struct daemon_t daemon_t;
148
149 #include <network/sender.h>
150 #include <network/receiver.h>
151 #include <network/socket.h>
152 #include <processing/scheduler.h>
153 #include <processing/processor.h>
154 #include <kernel/kernel_interface.h>
155 #include <control/controller.h>
156 #include <bus/bus.h>
157 #include <bus/listeners/file_logger.h>
158 #include <bus/listeners/sys_logger.h>
159 #include <sa/ike_sa_manager.h>
160 #include <sa/trap_manager.h>
161 #include <config/backend_manager.h>
162 #include <config/attributes/attribute_manager.h>
163 #include <credentials/credential_manager.h>
164 #include <sa/authenticators/eap/eap_manager.h>
165 #include <sa/authenticators/eap/sim_manager.h>
166
167 #ifdef ME
168 #include <sa/connect_manager.h>
169 #include <sa/mediation_manager.h>
170 #endif /* ME */
171
172 /**
173 * Name of the daemon.
174 */
175 #define DAEMON_NAME "charon"
176
177 /**
178 * Number of threads in the thread pool, if not specified in config.
179 */
180 #define DEFAULT_THREADS 16
181
182 /**
183 * UDP Port on which the daemon will listen for incoming traffic.
184 */
185 #define IKEV2_UDP_PORT 500
186
187 /**
188 * UDP Port to which the daemon will float to if NAT is detected.
189 */
190 #define IKEV2_NATT_PORT 4500
191
192 /**
193 * PID file, in which charon stores its process id
194 */
195 #define PID_FILE IPSEC_PIDDIR "/charon.pid"
196
197
198 /**
199 * Main class of daemon, contains some globals.
200 */
201 struct daemon_t {
202
203 /**
204 * A socket_t instance.
205 */
206 socket_t *socket;
207
208 /**
209 * A ike_sa_manager_t instance.
210 */
211 ike_sa_manager_t *ike_sa_manager;
212
213 /**
214 * Manager for triggering policies, called traps
215 */
216 trap_manager_t *traps;
217
218 /**
219 * Manager for the different configuration backends.
220 */
221 backend_manager_t *backends;
222
223 /**
224 * Manager for IKEv2 cfg payload attributes
225 */
226 attribute_manager_t *attributes;
227
228 /**
229 * Manager for the credential backends
230 */
231 credential_manager_t *credentials;
232
233 /**
234 * The Sender-Thread.
235 */
236 sender_t *sender;
237
238 /**
239 * The Receiver-Thread.
240 */
241 receiver_t *receiver;
242
243 /**
244 * The Scheduler-Thread.
245 */
246 scheduler_t *scheduler;
247
248 /**
249 * Job processing using a thread pool.
250 */
251 processor_t *processor;
252
253 /**
254 * The signaling bus.
255 */
256 bus_t *bus;
257
258 /**
259 * A list of installed file_logger_t's
260 */
261 linked_list_t *file_loggers;
262
263 /**
264 * A list of installed sys_logger_t's
265 */
266 linked_list_t *sys_loggers;
267
268 /**
269 * Kernel Interface to communicate with kernel
270 */
271 kernel_interface_t *kernel_interface;
272
273 /**
274 * Controller to control the daemon
275 */
276 controller_t *controller;
277
278 /**
279 * EAP manager to maintain registered EAP methods
280 */
281 eap_manager_t *eap;
282
283 /**
284 * SIM manager to maintain SIM cards/providers
285 */
286 sim_manager_t *sim;
287
288 #ifdef ME
289 /**
290 * Connect manager
291 */
292 connect_manager_t *connect_manager;
293
294 /**
295 * Mediation manager
296 */
297 mediation_manager_t *mediation_manager;
298 #endif /* ME */
299
300 /**
301 * User ID the daemon will user after initialization
302 */
303 uid_t uid;
304
305 /**
306 * Group ID the daemon will use after initialization
307 */
308 gid_t gid;
309
310 /**
311 * The thread_id of main-thread.
312 */
313 pthread_t main_thread_id;
314
315 /**
316 * Do not drop a given capability after initialization.
317 *
318 * Some plugins might need additional capabilites. They tell the daemon
319 * during plugin initialization which one they need, the daemon won't
320 * drop these.
321 */
322 void (*keep_cap)(daemon_t *this, u_int cap);
323
324 /**
325 * Shut down the daemon.
326 *
327 * @param reason describtion why it will be killed
328 */
329 void (*kill) (daemon_t *this, char *reason);
330 };
331
332 /**
333 * The one and only instance of the daemon.
334 */
335 extern daemon_t *charon;
336
337 #endif /** DAEMON_H_ @}*/