67673d9be409ece3e434cca5eb1356e48f605b9f
[strongswan.git] / src / libcharon / bus / bus.h
1 /*
2 * Copyright (C) 2012 Tobias Brunner
3 * Copyright (C) 2006-2009 Martin Willi
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 */
16
17 /**
18 * @defgroup bus bus
19 * @{ @ingroup libcharon
20 */
21
22 #ifndef BUS_H_
23 #define BUS_H_
24
25 typedef enum alert_t alert_t;
26 typedef enum narrow_hook_t narrow_hook_t;
27 typedef struct bus_t bus_t;
28
29 #include <stdarg.h>
30
31 #include <utils/debug.h>
32 #include <sa/ike_sa.h>
33 #include <sa/child_sa.h>
34 #include <processing/jobs/job.h>
35 #include <bus/listeners/logger.h>
36 #include <bus/listeners/listener.h>
37
38 /* undefine the definitions from libstrongswan */
39 #undef DBG0
40 #undef DBG1
41 #undef DBG2
42 #undef DBG3
43 #undef DBG4
44
45 #ifndef DEBUG_LEVEL
46 # define DEBUG_LEVEL 4
47 #endif /* DEBUG_LEVEL */
48
49 #if DEBUG_LEVEL >= 0
50 #define DBG0(group, format, ...) charon->bus->log(charon->bus, group, 0, format, ##__VA_ARGS__)
51 #endif /* DEBUG_LEVEL >= 0 */
52 #if DEBUG_LEVEL >= 1
53 #define DBG1(group, format, ...) charon->bus->log(charon->bus, group, 1, format, ##__VA_ARGS__)
54 #endif /* DEBUG_LEVEL >= 1 */
55 #if DEBUG_LEVEL >= 2
56 #define DBG2(group, format, ...) charon->bus->log(charon->bus, group, 2, format, ##__VA_ARGS__)
57 #endif /* DEBUG_LEVEL >= 2 */
58 #if DEBUG_LEVEL >= 3
59 #define DBG3(group, format, ...) charon->bus->log(charon->bus, group, 3, format, ##__VA_ARGS__)
60 #endif /* DEBUG_LEVEL >= 3 */
61 #if DEBUG_LEVEL >= 4
62 #define DBG4(group, format, ...) charon->bus->log(charon->bus, group, 4, format, ##__VA_ARGS__)
63 #endif /* DEBUG_LEVEL >= 4 */
64
65 #ifndef DBG0
66 # define DBG0(...) {}
67 #endif /* DBG0 */
68 #ifndef DBG1
69 # define DBG1(...) {}
70 #endif /* DBG1 */
71 #ifndef DBG2
72 # define DBG2(...) {}
73 #endif /* DBG2 */
74 #ifndef DBG3
75 # define DBG3(...) {}
76 #endif /* DBG3 */
77 #ifndef DBG4
78 # define DBG4(...) {}
79 #endif /* DBG4 */
80
81 /**
82 * Kind of alerts to raise.
83 */
84 enum alert_t {
85 /** a RADIUS server did not respond, no additional arguments */
86 ALERT_RADIUS_NOT_RESPONDING,
87 /** a shutdown signal has been received, argument is the signal (int) */
88 ALERT_SHUTDOWN_SIGNAL,
89 /** creating local authentication data failed, no arguments */
90 ALERT_LOCAL_AUTH_FAILED,
91 /** peer authentication failed, no arguments */
92 ALERT_PEER_AUTH_FAILED,
93 /** failed to resolve peer address, no arguments */
94 ALERT_PEER_ADDR_FAILED,
95 /** peer did not respond to initial message, current try (int, 0-based) */
96 ALERT_PEER_INIT_UNREACHABLE,
97 /** received IKE message with invalid SPI, argument is message_t* */
98 ALERT_INVALID_IKE_SPI,
99 /** received IKE message with invalid header, argument is message_t* */
100 ALERT_PARSE_ERROR_HEADER,
101 /** received IKE message with invalid body, argument is message_t*,
102 * followed by a status_t result returned by message_t.parse_body(). */
103 ALERT_PARSE_ERROR_BODY,
104 /** sending a retransmit for a message, argument is packet_t */
105 ALERT_RETRANSMIT_SEND,
106 /** sending retransmits timed out, argument is packet_t */
107 ALERT_RETRANSMIT_SEND_TIMEOUT,
108 /** received a retransmit for a message, argument is message_t */
109 ALERT_RETRANSMIT_RECEIVE,
110 /** received half-open timeout before IKE_SA established, no argument */
111 ALERT_HALF_OPEN_TIMEOUT,
112 /** IKE proposals do not match, argument is linked_list_t of proposal_t */
113 ALERT_PROPOSAL_MISMATCH_IKE,
114 /** CHILD proposals do not match, argument is linked_list_t of proposal_t */
115 ALERT_PROPOSAL_MISMATCH_CHILD,
116 /** traffic selectors do not match, arguments are two linked_list_t
117 * containing traffic_selector_t for initiator and for responder */
118 ALERT_TS_MISMATCH,
119 /** Installation of IPsec SAs failed, argument is child_sa_t */
120 ALERT_INSTALL_CHILD_SA_FAILED,
121 /** Installation of IPsec Policy failed, argument is child_sa_t */
122 ALERT_INSTALL_CHILD_POLICY_FAILED,
123 /** IKE_SA deleted because of "replace" unique policy, no argument */
124 ALERT_UNIQUE_REPLACE,
125 /** IKE_SA deleted because of "keep" unique policy, no argument */
126 ALERT_UNIQUE_KEEP,
127 /** IKE_SA kept on failed child SA establishment, no argument */
128 ALERT_KEEP_ON_CHILD_SA_FAILURE,
129 /** allocating virtual IP failed, linked_list_t of host_t requested */
130 ALERT_VIP_FAILURE,
131 /** an authorize() hook failed, no argument */
132 ALERT_AUTHORIZATION_FAILED,
133 /** IKE_SA hit the hard lifetime limit before it could be rekeyed */
134 ALERT_IKE_SA_EXPIRED,
135 };
136
137 /**
138 * Kind of narrow hook.
139 *
140 * There is a non-authenticated (IKE_AUTH) and a authenticated
141 * (CREATE_CHILD_SA) narrowing hook for the initiator. Only one of these
142 * hooks is invoked before the exchange.
143 * To verify the traffic selectors negotiated, each PRE hook has a POST
144 * counterpart that follows. POST hooks are invoked with an authenticated peer.
145 * It is usually not a good idea to narrow in the POST hooks,
146 * as the resulting traffic selector is not negotiated and results
147 * in non-matching policies.
148 */
149 enum narrow_hook_t {
150 /** invoked as initiator before exchange, peer is not yet authenticated */
151 NARROW_INITIATOR_PRE_NOAUTH,
152 /** invoked as initiator before exchange, peer is authenticated */
153 NARROW_INITIATOR_PRE_AUTH,
154 /** invoked as responder during exchange, peer is authenticated */
155 NARROW_RESPONDER,
156 /** invoked as responder after exchange, peer is authenticated */
157 NARROW_RESPONDER_POST,
158 /** invoked as initiator after exchange, follows a INITIATOR_PRE_NOAUTH */
159 NARROW_INITIATOR_POST_NOAUTH,
160 /** invoked as initiator after exchange, follows a INITIATOR_PRE_AUTH */
161 NARROW_INITIATOR_POST_AUTH,
162 };
163
164 /**
165 * The bus receives events and sends them to all registered listeners.
166 *
167 * Loggers are handled separately.
168 */
169 struct bus_t {
170
171 /**
172 * Register a listener to the bus.
173 *
174 * A registered listener receives all events which are sent to the bus.
175 * The listener is passive; the thread which emitted the event
176 * processes the listener routine.
177 *
178 * @param listener listener to register.
179 */
180 void (*add_listener) (bus_t *this, listener_t *listener);
181
182 /**
183 * Unregister a listener from the bus.
184 *
185 * @param listener listener to unregister.
186 */
187 void (*remove_listener) (bus_t *this, listener_t *listener);
188
189 /**
190 * Register a logger with the bus.
191 *
192 * The logger is passive; the thread which emitted the event
193 * processes the logger routine. This routine may be called concurrently
194 * by multiple threads. Recursive calls are not prevented, so logger that
195 * may cause recursive calls are responsible to avoid infinite loops.
196 *
197 * During registration get_level() is called for all log groups and the
198 * logger is registered to receive log messages for groups for which
199 * the requested log level is > LEVEL_SILENT and whose level is lower
200 * or equal than the requested level.
201 *
202 * To update the registered log levels call add_logger again with the
203 * same logger and return the new levels from get_level().
204 *
205 * @param logger logger to register.
206 */
207 void (*add_logger) (bus_t *this, logger_t *logger);
208
209 /**
210 * Unregister a logger from the bus.
211 *
212 * @param logger logger to unregister.
213 */
214 void (*remove_logger) (bus_t *this, logger_t *logger);
215
216 /**
217 * Set the IKE_SA the calling thread is using.
218 *
219 * To associate a received log message with an IKE_SA without passing it as
220 * parameter each time, the thread registers the currently used IKE_SA
221 * during check-out. Before check-in, the thread unregisters the IKE_SA.
222 * This IKE_SA is stored per-thread, so each thread has its own IKE_SA
223 * registered.
224 *
225 * @param ike_sa ike_sa to register, or NULL to unregister
226 */
227 void (*set_sa) (bus_t *this, ike_sa_t *ike_sa);
228
229 /**
230 * Get the IKE_SA the calling thread is currently using.
231 *
232 * If a thread currently does not know what IKE_SA it is processing,
233 * it can call get_sa() to look up the SA set during checkout via set_sa().
234 *
235 * @return registered ike_sa, NULL if none registered
236 */
237 ike_sa_t* (*get_sa)(bus_t *this);
238
239 /**
240 * Send a log message to the bus.
241 *
242 * The format string specifies an additional informational or error
243 * message with a printf() like variable argument list.
244 * Use the DBG() macros.
245 *
246 * @param group debugging group
247 * @param level verbosity level of the signal
248 * @param format printf() style format string
249 * @param ... printf() style argument list
250 */
251 void (*log)(bus_t *this, debug_t group, level_t level, char* format, ...);
252
253 /**
254 * Send a log message to the bus using va_list arguments.
255 *
256 * Same as bus_t.log(), but uses va_list argument list.
257 *
258 * @param group kind of the signal (up, down, rekeyed, ...)
259 * @param level verbosity level of the signal
260 * @param format printf() style format string
261 * @param args va_list arguments
262 */
263 void (*vlog)(bus_t *this, debug_t group, level_t level,
264 char* format, va_list args);
265
266 /**
267 * Raise an alert over the bus.
268 *
269 * @param alert kind of alert
270 * @param ... alert specific arguments
271 */
272 void (*alert)(bus_t *this, alert_t alert, ...);
273
274 /**
275 * Send a IKE_SA state change event to the bus.
276 *
277 * @param ike_sa IKE_SA which changes its state
278 * @param state new state IKE_SA changes to
279 */
280 void (*ike_state_change)(bus_t *this, ike_sa_t *ike_sa,
281 ike_sa_state_t state);
282 /**
283 * Send a CHILD_SA state change event to the bus.
284 *
285 * @param child_sa CHILD_SA which changes its state
286 * @param state new state CHILD_SA changes to
287 */
288 void (*child_state_change)(bus_t *this, child_sa_t *child_sa,
289 child_sa_state_t state);
290 /**
291 * Message send/receive hook.
292 *
293 * The hook is invoked twice for each message: Once with plain, parsed data
294 * and once encoded and encrypted.
295 *
296 * @param message message to send/receive
297 * @param incoming TRUE for incoming messages, FALSE for outgoing
298 * @param plain TRUE if message is parsed and decrypted, FALSE it not
299 */
300 void (*message)(bus_t *this, message_t *message, bool incoming, bool plain);
301
302 /**
303 * IKE_SA authorization hook.
304 *
305 * @param final TRUE if this is the final invocation
306 * @return TRUE to establish IKE_SA, FALSE to send AUTH_FAILED
307 */
308 bool (*authorize)(bus_t *this, bool final);
309
310 /**
311 * CHILD_SA traffic selector narrowing hook.
312 *
313 * @param child_sa CHILD_SA set up with these traffic selectors
314 * @param type type of hook getting invoked
315 * @param local list of local traffic selectors to narrow
316 * @param remote list of remote traffic selectors to narrow
317 */
318 void (*narrow)(bus_t *this, child_sa_t *child_sa, narrow_hook_t type,
319 linked_list_t *local, linked_list_t *remote);
320
321 /**
322 * IKE_SA keymat hook.
323 *
324 * @param ike_sa IKE_SA this keymat belongs to
325 * @param dh diffie hellman shared secret
326 * @param dh_other others DH public value (IKEv1 only)
327 * @param nonce_i initiators nonce
328 * @param nonce_r responders nonce
329 * @param rekey IKE_SA we are rekeying, if any (IKEv2 only)
330 * @param shared shared key used for key derivation (IKEv1-PSK only)
331 */
332 void (*ike_keys)(bus_t *this, ike_sa_t *ike_sa, diffie_hellman_t *dh,
333 chunk_t dh_other, chunk_t nonce_i, chunk_t nonce_r,
334 ike_sa_t *rekey, shared_key_t *shared);
335
336 /**
337 * CHILD_SA keymat hook.
338 *
339 * @param child_sa CHILD_SA this keymat is used for
340 * @param initiator initiator of the CREATE_CHILD_SA exchange
341 * @param dh diffie hellman shared secret
342 * @param nonce_i initiators nonce
343 * @param nonce_r responders nonce
344 */
345 void (*child_keys)(bus_t *this, child_sa_t *child_sa, bool initiator,
346 diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r);
347
348 /**
349 * IKE_SA up/down hook.
350 *
351 * @param ike_sa IKE_SA coming up/going down
352 * @param up TRUE for an up event, FALSE for a down event
353 */
354 void (*ike_updown)(bus_t *this, ike_sa_t *ike_sa, bool up);
355
356 /**
357 * IKE_SA rekeying hook.
358 *
359 * @param old rekeyed and obsolete IKE_SA
360 * @param new new IKE_SA replacing old
361 */
362 void (*ike_rekey)(bus_t *this, ike_sa_t *old, ike_sa_t *new);
363
364 /**
365 * IKE_SA reestablishing hook.
366 *
367 * @param old reestablished and obsolete IKE_SA
368 * @param new new IKE_SA replacing old
369 */
370 void (*ike_reestablish)(bus_t *this, ike_sa_t *old, ike_sa_t *new);
371
372 /**
373 * CHILD_SA up/down hook.
374 *
375 * @param child_sa CHILD_SA coming up/going down
376 * @param up TRUE for an up event, FALSE for a down event
377 */
378 void (*child_updown)(bus_t *this, child_sa_t *child_sa, bool up);
379
380 /**
381 * CHILD_SA rekeying hook.
382 *
383 * @param old rekeyed and obsolete CHILD_SA
384 * @param new new CHILD_SA replacing old
385 */
386 void (*child_rekey)(bus_t *this, child_sa_t *old, child_sa_t *new);
387
388 /**
389 * Destroy the event bus.
390 */
391 void (*destroy) (bus_t *this);
392 };
393
394 /**
395 * Create the event bus which forwards events to its listeners.
396 *
397 * @return event bus instance
398 */
399 bus_t *bus_create();
400
401 #endif /** BUS_H_ @}*/