c732b8c92d0c91211e588dd7315211e553daf98e
[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 <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 /** peer authentication failed, no arguments */
90 ALERT_PEER_AUTH_FAILED,
91 /** failed to resolve peer address, no arguments */
92 ALERT_PEER_ADDR_FAILED,
93 /** peer did not respond to initial message, current try (int, 0-based) */
94 ALERT_PEER_INIT_UNREACHABLE,
95 /** received IKE message with invalid SPI, argument is message_t* */
96 ALERT_INVALID_IKE_SPI,
97 };
98
99 /**
100 * Kind of narrow hook.
101 *
102 * There is a non-authenticated (IKE_AUTH) and a authenticated
103 * (CREATE_CHILD_SA) narrowing hook for the initiator. Only one of these
104 * hooks is invoked before the exchange.
105 * To verify the traffic selectors negotiated, each PRE hook has a POST
106 * counterpart that follows. POST hooks are invoked with an authenticated peer.
107 * It is usually not a good idea to narrow in the POST hooks,
108 * as the resulting traffic selector is not negotiated and results
109 * in non-matching policies.
110 */
111 enum narrow_hook_t {
112 /** invoked as initiator before exchange, peer is not yet authenticated */
113 NARROW_INITIATOR_PRE_NOAUTH,
114 /** invoked as initiator before exchange, peer is authenticated */
115 NARROW_INITIATOR_PRE_AUTH,
116 /** invoked as responder during exchange, peer is authenticated */
117 NARROW_RESPONDER,
118 /** invoked as responder after exchange, peer is authenticated */
119 NARROW_RESPONDER_POST,
120 /** invoked as initiator after exchange, follows a INITIATOR_PRE_NOAUTH */
121 NARROW_INITIATOR_POST_NOAUTH,
122 /** invoked as initiator after exchange, follows a INITIATOR_PRE_AUTH */
123 NARROW_INITIATOR_POST_AUTH,
124 };
125
126 /**
127 * The bus receives events and sends them to all registered listeners.
128 *
129 * Loggers are handled separately.
130 */
131 struct bus_t {
132
133 /**
134 * Register a listener to the bus.
135 *
136 * A registered listener receives all events which are sent to the bus.
137 * The listener is passive; the thread which emitted the event
138 * processes the listener routine.
139 *
140 * @param listener listener to register.
141 */
142 void (*add_listener) (bus_t *this, listener_t *listener);
143
144 /**
145 * Unregister a listener from the bus.
146 *
147 * @param listener listener to unregister.
148 */
149 void (*remove_listener) (bus_t *this, listener_t *listener);
150
151 /**
152 * Register a logger with the bus.
153 *
154 * The logger is passive; the thread which emitted the event
155 * processes the logger routine. This routine may be called concurrently
156 * by multiple threads. Recursive calls are not prevented, so logger that
157 * may cause recursive calls are responsible to avoid infinite loops.
158 *
159 * During registration get_level() is called for all log groups and the
160 * logger is registered to receive log messages for groups for which
161 * the requested log level is > LEVEL_SILENT and whose level is lower
162 * or equal than the requested level.
163 *
164 * To update the registered log levels call add_logger again with the
165 * same logger and return the new levels from get_level().
166 *
167 * @param logger logger to register.
168 */
169 void (*add_logger) (bus_t *this, logger_t *logger);
170
171 /**
172 * Unregister a logger from the bus.
173 *
174 * @param logger logger to unregister.
175 */
176 void (*remove_logger) (bus_t *this, logger_t *logger);
177
178 /**
179 * Set the IKE_SA the calling thread is using.
180 *
181 * To associate a received log message with an IKE_SA without passing it as
182 * parameter each time, the thread registers the currently used IKE_SA
183 * during check-out. Before check-in, the thread unregisters the IKE_SA.
184 * This IKE_SA is stored per-thread, so each thread has its own IKE_SA
185 * registered.
186 *
187 * @param ike_sa ike_sa to register, or NULL to unregister
188 */
189 void (*set_sa) (bus_t *this, ike_sa_t *ike_sa);
190
191 /**
192 * Get the IKE_SA the calling thread is currently using.
193 *
194 * If a thread currently does not know what IKE_SA it is processing,
195 * it can call get_sa() to look up the SA set during checkout via set_sa().
196 *
197 * @return registered ike_sa, NULL if none registered
198 */
199 ike_sa_t* (*get_sa)(bus_t *this);
200
201 /**
202 * Send a log message to the bus.
203 *
204 * The format string specifies an additional informational or error
205 * message with a printf() like variable argument list.
206 * Use the DBG() macros.
207 *
208 * @param group debugging group
209 * @param level verbosity level of the signal
210 * @param format printf() style format string
211 * @param ... printf() style argument list
212 */
213 void (*log)(bus_t *this, debug_t group, level_t level, char* format, ...);
214
215 /**
216 * Send a log message to the bus using va_list arguments.
217 *
218 * Same as bus_t.log(), but uses va_list argument list.
219 *
220 * @param group kind of the signal (up, down, rekeyed, ...)
221 * @param level verbosity level of the signal
222 * @param format printf() style format string
223 * @param args va_list arguments
224 */
225 void (*vlog)(bus_t *this, debug_t group, level_t level,
226 char* format, va_list args);
227
228 /**
229 * Raise an alert over the bus.
230 *
231 * @param alert kind of alert
232 * @param ... alert specific arguments
233 */
234 void (*alert)(bus_t *this, alert_t alert, ...);
235
236 /**
237 * Send a IKE_SA state change event to the bus.
238 *
239 * @param ike_sa IKE_SA which changes its state
240 * @param state new state IKE_SA changes to
241 */
242 void (*ike_state_change)(bus_t *this, ike_sa_t *ike_sa,
243 ike_sa_state_t state);
244 /**
245 * Send a CHILD_SA state change event to the bus.
246 *
247 * @param child_sa CHILD_SA which changes its state
248 * @param state new state CHILD_SA changes to
249 */
250 void (*child_state_change)(bus_t *this, child_sa_t *child_sa,
251 child_sa_state_t state);
252 /**
253 * Message send/receive hook.
254 *
255 * The hook is invoked twice for each message: Once with plain, parsed data
256 * and once encoded and encrypted.
257 *
258 * @param message message to send/receive
259 * @param incoming TRUE for incoming messages, FALSE for outgoing
260 * @param plain TRUE if message is parsed and decrypted, FALSE it not
261 */
262 void (*message)(bus_t *this, message_t *message, bool incoming, bool plain);
263
264 /**
265 * IKE_SA authorization hook.
266 *
267 * @param final TRUE if this is the final invocation
268 * @return TRUE to establish IKE_SA, FALSE to send AUTH_FAILED
269 */
270 bool (*authorize)(bus_t *this, bool final);
271
272 /**
273 * CHILD_SA traffic selector narrowing hook.
274 *
275 * @param child_sa CHILD_SA set up with these traffic selectors
276 * @param type type of hook getting invoked
277 * @param local list of local traffic selectors to narrow
278 * @param remote list of remote traffic selectors to narrow
279 */
280 void (*narrow)(bus_t *this, child_sa_t *child_sa, narrow_hook_t type,
281 linked_list_t *local, linked_list_t *remote);
282
283 /**
284 * IKE_SA keymat hook.
285 *
286 * @param ike_sa IKE_SA this keymat belongs to
287 * @param dh diffie hellman shared secret
288 * @param dh_other others DH public value (IKEv1 only)
289 * @param nonce_i initiators nonce
290 * @param nonce_r responders nonce
291 * @param rekey IKE_SA we are rekeying, if any (IKEv2 only)
292 * @param shared shared key used for key derivation (IKEv1-PSK only)
293 */
294 void (*ike_keys)(bus_t *this, ike_sa_t *ike_sa, diffie_hellman_t *dh,
295 chunk_t dh_other, chunk_t nonce_i, chunk_t nonce_r,
296 ike_sa_t *rekey, shared_key_t *shared);
297
298 /**
299 * CHILD_SA keymat hook.
300 *
301 * @param child_sa CHILD_SA this keymat is used for
302 * @param initiator initiator of the CREATE_CHILD_SA exchange
303 * @param dh diffie hellman shared secret
304 * @param nonce_i initiators nonce
305 * @param nonce_r responders nonce
306 */
307 void (*child_keys)(bus_t *this, child_sa_t *child_sa, bool initiator,
308 diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r);
309
310 /**
311 * IKE_SA up/down hook.
312 *
313 * @param ike_sa IKE_SA coming up/going down
314 * @param up TRUE for an up event, FALSE for a down event
315 */
316 void (*ike_updown)(bus_t *this, ike_sa_t *ike_sa, bool up);
317
318 /**
319 * IKE_SA rekeying hook.
320 *
321 * @param old rekeyed and obsolete IKE_SA
322 * @param new new IKE_SA replacing old
323 */
324 void (*ike_rekey)(bus_t *this, ike_sa_t *old, ike_sa_t *new);
325
326 /**
327 * IKE_SA reestablishing hook.
328 *
329 * @param old reestablished and obsolete IKE_SA
330 * @param new new IKE_SA replacing old
331 */
332 void (*ike_reestablish)(bus_t *this, ike_sa_t *old, ike_sa_t *new);
333
334 /**
335 * CHILD_SA up/down hook.
336 *
337 * @param child_sa CHILD_SA coming up/going down
338 * @param up TRUE for an up event, FALSE for a down event
339 */
340 void (*child_updown)(bus_t *this, child_sa_t *child_sa, bool up);
341
342 /**
343 * CHILD_SA rekeying hook.
344 *
345 * @param old rekeyed and obsolete CHILD_SA
346 * @param new new CHILD_SA replacing old
347 */
348 void (*child_rekey)(bus_t *this, child_sa_t *old, child_sa_t *new);
349
350 /**
351 * Destroy the event bus.
352 */
353 void (*destroy) (bus_t *this);
354 };
355
356 /**
357 * Create the event bus which forwards events to its listeners.
358 *
359 * @return event bus instance
360 */
361 bus_t *bus_create();
362
363 #endif /** BUS_H_ @}*/