bus->listen() and the controller wrappers accept a timeout to wait for callbacks
[strongswan.git] / src / libcharon / bus / bus.h
1 /*
2 * Copyright (C) 2006-2009 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup bus bus
18 * @{ @ingroup libcharon
19 */
20
21 #ifndef BUS_H_
22 #define BUS_H_
23
24 typedef enum alert_t alert_t;
25 typedef enum narrow_hook_t narrow_hook_t;
26 typedef struct bus_t bus_t;
27
28 #include <stdarg.h>
29
30 #include <debug.h>
31 #include <sa/ike_sa.h>
32 #include <sa/child_sa.h>
33 #include <processing/jobs/job.h>
34 #include <bus/listeners/listener.h>
35
36 /* undefine the definitions from libstrongswan */
37 #undef DBG0
38 #undef DBG1
39 #undef DBG2
40 #undef DBG3
41 #undef DBG4
42
43 #ifndef DEBUG_LEVEL
44 # define DEBUG_LEVEL 4
45 #endif /* DEBUG_LEVEL */
46
47 #if DEBUG_LEVEL >= 0
48 #define DBG0(group, format, ...) charon->bus->log(charon->bus, group, 0, format, ##__VA_ARGS__)
49 #endif /* DEBUG_LEVEL >= 0 */
50 #if DEBUG_LEVEL >= 1
51 #define DBG1(group, format, ...) charon->bus->log(charon->bus, group, 1, format, ##__VA_ARGS__)
52 #endif /* DEBUG_LEVEL >= 1 */
53 #if DEBUG_LEVEL >= 2
54 #define DBG2(group, format, ...) charon->bus->log(charon->bus, group, 2, format, ##__VA_ARGS__)
55 #endif /* DEBUG_LEVEL >= 2 */
56 #if DEBUG_LEVEL >= 3
57 #define DBG3(group, format, ...) charon->bus->log(charon->bus, group, 3, format, ##__VA_ARGS__)
58 #endif /* DEBUG_LEVEL >= 3 */
59 #if DEBUG_LEVEL >= 4
60 #define DBG4(group, format, ...) charon->bus->log(charon->bus, group, 4, format, ##__VA_ARGS__)
61 #endif /* DEBUG_LEVEL >= 4 */
62
63 #ifndef DBG0
64 # define DBG0(...) {}
65 #endif /* DBG0 */
66 #ifndef DBG1
67 # define DBG1(...) {}
68 #endif /* DBG1 */
69 #ifndef DBG2
70 # define DBG2(...) {}
71 #endif /* DBG2 */
72 #ifndef DBG3
73 # define DBG3(...) {}
74 #endif /* DBG3 */
75 #ifndef DBG4
76 # define DBG4(...) {}
77 #endif /* DBG4 */
78
79 /**
80 * Kind of alerts to raise.
81 */
82 enum alert_t {
83 /** a RADIUS server did not respond, no additional arguments */
84 ALERT_RADIUS_NOT_RESPONDING,
85 /** a shutdown signal has been received, argument is the signal (int) */
86 ALERT_SHUTDOWN_SIGNAL,
87 /** peer authentication failed, no arguments */
88 ALERT_PEER_AUTH_FAILED,
89 /** failed to resolve peer address, no arguments */
90 ALERT_PEER_ADDR_FAILED,
91 };
92
93 /**
94 * Kind of narrow hook.
95 *
96 * There is a non-authenticated (IKE_AUTH) and a authenticated
97 * (CREATE_CHILD_SA) narrowing hook for the initiator. Only one of these
98 * hooks is invoked before the exchange.
99 * To verify the traffic selectors negotiated, each PRE hook has a POST
100 * counterpart that follows. POST hooks are invoked with an authenticated peer.
101 * It is usually not a good idea to narrow in the POST hooks,
102 * as the resulting traffic selector is not negotiated and results
103 * in non-matching policies.
104 */
105 enum narrow_hook_t {
106 /** invoked as initiator before exchange, peer is not yet authenticated */
107 NARROW_INITIATOR_PRE_NOAUTH,
108 /** invoked as initiator before exchange, peer is authenticated */
109 NARROW_INITIATOR_PRE_AUTH,
110 /** invoked as responder during exchange, peer is authenticated */
111 NARROW_RESPONDER,
112 /** invoked as initiator after exchange, follows a INITIATOR_PRE_NOAUTH */
113 NARROW_INITIATOR_POST_NOAUTH,
114 /** invoked as initiator after exchange, follows a INITIATOR_PRE_AUTH */
115 NARROW_INITIATOR_POST_AUTH,
116 };
117
118 /**
119 * The bus receives events and sends them to all registered listeners.
120 *
121 * Any events sent to are delivered to all registered listeners. Threads
122 * may wait actively to events using the blocking listen() call.
123 */
124 struct bus_t {
125
126 /**
127 * Register a listener to the bus.
128 *
129 * A registered listener receives all events which are sent to the bus.
130 * The listener is passive; the thread which emitted the event
131 * processes the listener routine.
132 *
133 * @param listener listener to register.
134 */
135 void (*add_listener) (bus_t *this, listener_t *listener);
136
137 /**
138 * Unregister a listener from the bus.
139 *
140 * @param listener listener to unregister.
141 */
142 void (*remove_listener) (bus_t *this, listener_t *listener);
143
144 /**
145 * Register a listener and block the calling thread.
146 *
147 * This call registers a listener and blocks the calling thread until
148 * its listeners function returns FALSE. This allows to wait for certain
149 * events. The associated job is executed after the listener has been
150 * registered: This allows to listen on events we initiate with the job,
151 * without missing any events to job may fire.
152 *
153 * @param listener listener to register
154 * @param job job to execute asynchronously when registered, or NULL
155 * @param timeout max timeout in ms to listen for events, 0 to disable
156 * @return TRUE if timed out
157 */
158 bool (*listen)(bus_t *this, listener_t *listener, job_t *job, u_int timeout);
159
160 /**
161 * Set the IKE_SA the calling thread is using.
162 *
163 * To associate an received log message to an IKE_SA without passing it as
164 * parameter each time, the thread registers the currenlty used IKE_SA
165 * during check-out. Before check-in, the thread unregisters the IKE_SA.
166 * This IKE_SA is stored per-thread, so each thread has its own IKE_SA
167 * registered.
168 *
169 * @param ike_sa ike_sa to register, or NULL to unregister
170 */
171 void (*set_sa) (bus_t *this, ike_sa_t *ike_sa);
172
173 /**
174 * Get the IKE_SA the calling thread is currently using.
175 *
176 * If a thread currently does not know what IKE_SA it is processing,
177 * it can call get_sa() to look up the SA set during checkout via set_sa().
178 *
179 * @return registered ike_sa, NULL if none registered
180 */
181 ike_sa_t* (*get_sa)(bus_t *this);
182
183 /**
184 * Send a log message to the bus.
185 *
186 * The signal specifies the type of the event occurred. The format string
187 * specifies an additional informational or error message with a
188 * printf() like variable argument list.
189 * Use the DBG() macros.
190 *
191 * @param group debugging group
192 * @param level verbosity level of the signal
193 * @param format printf() style format string
194 * @param ... printf() style argument list
195 */
196 void (*log)(bus_t *this, debug_t group, level_t level, char* format, ...);
197
198 /**
199 * Send a log message to the bus using va_list arguments.
200 *
201 * Same as bus_t.signal(), but uses va_list argument list.
202 *
203 * @param group kind of the signal (up, down, rekeyed, ...)
204 * @param level verbosity level of the signal
205 * @param format printf() style format string
206 * @param args va_list arguments
207 */
208 void (*vlog)(bus_t *this, debug_t group, level_t level,
209 char* format, va_list args);
210
211 /**
212 * Raise an alert over the bus.
213 *
214 * @param alert kind of alert
215 * @param ... alert specific attributes
216 */
217 void (*alert)(bus_t *this, alert_t alert, ...);
218
219 /**
220 * Send a IKE_SA state change event to the bus.
221 *
222 * @param ike_sa IKE_SA which changes its state
223 * @param state new state IKE_SA changes to
224 */
225 void (*ike_state_change)(bus_t *this, ike_sa_t *ike_sa,
226 ike_sa_state_t state);
227 /**
228 * Send a CHILD_SA state change event to the bus.
229 *
230 * @param child_sa CHILD_SA which changes its state
231 * @param state new state CHILD_SA changes to
232 */
233 void (*child_state_change)(bus_t *this, child_sa_t *child_sa,
234 child_sa_state_t state);
235 /**
236 * Message send/receive hook.
237 *
238 * @param message message to send/receive
239 * @param incoming TRUE for incoming messages, FALSE for outgoing
240 */
241 void (*message)(bus_t *this, message_t *message, bool incoming);
242
243 /**
244 * IKE_SA authorization hook.
245 *
246 * @param final TRUE if this is the final invocation
247 * @return TRUE to establish IKE_SA, FALSE to send AUTH_FAILED
248 */
249 bool (*authorize)(bus_t *this, bool final);
250
251 /**
252 * CHILD_SA traffic selector narrowing hook.
253 *
254 * @param child_sa CHILD_SA set up with these traffic selectors
255 * @param type type of hook getting invoked
256 * @param local list of local traffic selectors to narrow
257 * @param remote list of remote traffic selectors to narrow
258 */
259 void (*narrow)(bus_t *this, child_sa_t *child_sa, narrow_hook_t type,
260 linked_list_t *local, linked_list_t *remote);
261
262 /**
263 * IKE_SA keymat hook.
264 *
265 * @param ike_sa IKE_SA this keymat belongs to
266 * @param dh diffie hellman shared secret
267 * @param nonce_i initiators nonce
268 * @param nonce_r responders nonce
269 * @param rekey IKE_SA we are rekeying, if any
270 */
271 void (*ike_keys)(bus_t *this, ike_sa_t *ike_sa, diffie_hellman_t *dh,
272 chunk_t nonce_i, chunk_t nonce_r, ike_sa_t *rekey);
273 /**
274 * CHILD_SA keymat hook.
275 *
276 * @param child_sa CHILD_SA this keymat is used for
277 * @param initiator initiator of the CREATE_CHILD_SA exchange
278 * @param dh diffie hellman shared secret
279 * @param nonce_i initiators nonce
280 * @param nonce_r responders nonce
281 */
282 void (*child_keys)(bus_t *this, child_sa_t *child_sa, bool initiator,
283 diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r);
284
285 /**
286 * IKE_SA up/down hook.
287 *
288 * @param ike_sa IKE_SA coming up/going down
289 * @param up TRUE for an up event, FALSE for a down event
290 */
291 void (*ike_updown)(bus_t *this, ike_sa_t *ike_sa, bool up);
292
293 /**
294 * IKE_SA rekeying hook.
295 *
296 * @param old rekeyed and obsolete IKE_SA
297 * @param new new IKE_SA replacing old
298 */
299 void (*ike_rekey)(bus_t *this, ike_sa_t *old, ike_sa_t *new);
300
301 /**
302 * CHILD_SA up/down hook.
303 *
304 * @param child_sa CHILD_SA coming up/going down
305 * @param up TRUE for an up event, FALSE for a down event
306 */
307 void (*child_updown)(bus_t *this, child_sa_t *child_sa, bool up);
308
309 /**
310 * CHILD_SA rekeying hook.
311 *
312 * @param old rekeyed and obsolete CHILD_SA
313 * @param new new CHILD_SA replacing old
314 */
315 void (*child_rekey)(bus_t *this, child_sa_t *old, child_sa_t *new);
316
317 /**
318 * Destroy the event bus.
319 */
320 void (*destroy) (bus_t *this);
321 };
322
323 /**
324 * Create the event bus which forwards events to its listeners.
325 *
326 * @return event bus instance
327 */
328 bus_t *bus_create();
329
330 #endif /** BUS_H_ @}*/