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