d5eb73a54063cc2c4f4c04e2a7d005056dfdd836
[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 * Calls to bus_t.log() are handled seperately from calls to other event
122 * functions. This means that listeners have to be aware that calls to
123 * listener_t.log() can happen concurrently with calls to one of the other
124 * callbacks. Due to this unregistering from the log() callback is not fully
125 * in sync with the other callbacks, thus, one of these might be called before
126 * the listener is finally unregistered.
127 */
128 struct bus_t {
129
130 /**
131 * Register a listener to the bus.
132 *
133 * A registered listener receives all events which are sent to the bus.
134 * The listener is passive; the thread which emitted the event
135 * processes the listener routine.
136 *
137 * @param listener listener to register.
138 */
139 void (*add_listener) (bus_t *this, listener_t *listener);
140
141 /**
142 * Unregister a listener from the bus.
143 *
144 * @param listener listener to unregister.
145 */
146 void (*remove_listener) (bus_t *this, listener_t *listener);
147
148 /**
149 * Set the IKE_SA the calling thread is using.
150 *
151 * To associate a received log message with an IKE_SA without passing it as
152 * parameter each time, the thread registers the currently used IKE_SA
153 * during check-out. Before check-in, the thread unregisters the IKE_SA.
154 * This IKE_SA is stored per-thread, so each thread has its own IKE_SA
155 * registered.
156 *
157 * @param ike_sa ike_sa to register, or NULL to unregister
158 */
159 void (*set_sa) (bus_t *this, ike_sa_t *ike_sa);
160
161 /**
162 * Get the IKE_SA the calling thread is currently using.
163 *
164 * If a thread currently does not know what IKE_SA it is processing,
165 * it can call get_sa() to look up the SA set during checkout via set_sa().
166 *
167 * @return registered ike_sa, NULL if none registered
168 */
169 ike_sa_t* (*get_sa)(bus_t *this);
170
171 /**
172 * Send a log message to the bus.
173 *
174 * The format string specifies an additional informational or error
175 * message with a printf() like variable argument list.
176 * Use the DBG() macros.
177 *
178 * @param group debugging group
179 * @param level verbosity level of the signal
180 * @param format printf() style format string
181 * @param ... printf() style argument list
182 */
183 void (*log)(bus_t *this, debug_t group, level_t level, char* format, ...);
184
185 /**
186 * Send a log message to the bus using va_list arguments.
187 *
188 * Same as bus_t.log(), but uses va_list argument list.
189 *
190 * @param group kind of the signal (up, down, rekeyed, ...)
191 * @param level verbosity level of the signal
192 * @param format printf() style format string
193 * @param args va_list arguments
194 */
195 void (*vlog)(bus_t *this, debug_t group, level_t level,
196 char* format, va_list args);
197
198 /**
199 * Raise an alert over the bus.
200 *
201 * @param alert kind of alert
202 * @param ... alert specific arguments
203 */
204 void (*alert)(bus_t *this, alert_t alert, ...);
205
206 /**
207 * Send a IKE_SA state change event to the bus.
208 *
209 * @param ike_sa IKE_SA which changes its state
210 * @param state new state IKE_SA changes to
211 */
212 void (*ike_state_change)(bus_t *this, ike_sa_t *ike_sa,
213 ike_sa_state_t state);
214 /**
215 * Send a CHILD_SA state change event to the bus.
216 *
217 * @param child_sa CHILD_SA which changes its state
218 * @param state new state CHILD_SA changes to
219 */
220 void (*child_state_change)(bus_t *this, child_sa_t *child_sa,
221 child_sa_state_t state);
222 /**
223 * Message send/receive hook.
224 *
225 * The hook is invoked twice for each message: Once with plain, parsed data
226 * and once encoded and encrypted.
227 *
228 * @param message message to send/receive
229 * @param incoming TRUE for incoming messages, FALSE for outgoing
230 * @param plain TRUE if message is parsed and decrypted, FALSE it not
231 * @param
232 */
233 void (*message)(bus_t *this, message_t *message, bool incoming, bool plain);
234
235 /**
236 * IKE_SA authorization hook.
237 *
238 * @param final TRUE if this is the final invocation
239 * @return TRUE to establish IKE_SA, FALSE to send AUTH_FAILED
240 */
241 bool (*authorize)(bus_t *this, bool final);
242
243 /**
244 * CHILD_SA traffic selector narrowing hook.
245 *
246 * @param child_sa CHILD_SA set up with these traffic selectors
247 * @param type type of hook getting invoked
248 * @param local list of local traffic selectors to narrow
249 * @param remote list of remote traffic selectors to narrow
250 */
251 void (*narrow)(bus_t *this, child_sa_t *child_sa, narrow_hook_t type,
252 linked_list_t *local, linked_list_t *remote);
253
254 /**
255 * IKE_SA keymat hook.
256 *
257 * @param ike_sa IKE_SA this keymat belongs to
258 * @param dh diffie hellman shared secret
259 * @param dh_other others DH public value (IKEv1 only)
260 * @param nonce_i initiators nonce
261 * @param nonce_r responders nonce
262 * @param rekey IKE_SA we are rekeying, if any (IKEv2 only)
263 * @param shared shared key used for key derivation (IKEv1-PSK only)
264 */
265 void (*ike_keys)(bus_t *this, ike_sa_t *ike_sa, diffie_hellman_t *dh,
266 chunk_t dh_other, chunk_t nonce_i, chunk_t nonce_r,
267 ike_sa_t *rekey, shared_key_t *shared);
268
269 /**
270 * CHILD_SA keymat hook.
271 *
272 * @param child_sa CHILD_SA this keymat is used for
273 * @param initiator initiator of the CREATE_CHILD_SA exchange
274 * @param dh diffie hellman shared secret
275 * @param nonce_i initiators nonce
276 * @param nonce_r responders nonce
277 */
278 void (*child_keys)(bus_t *this, child_sa_t *child_sa, bool initiator,
279 diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r);
280
281 /**
282 * IKE_SA up/down hook.
283 *
284 * @param ike_sa IKE_SA coming up/going down
285 * @param up TRUE for an up event, FALSE for a down event
286 */
287 void (*ike_updown)(bus_t *this, ike_sa_t *ike_sa, bool up);
288
289 /**
290 * IKE_SA rekeying hook.
291 *
292 * @param old rekeyed and obsolete IKE_SA
293 * @param new new IKE_SA replacing old
294 */
295 void (*ike_rekey)(bus_t *this, ike_sa_t *old, ike_sa_t *new);
296
297 /**
298 * CHILD_SA up/down hook.
299 *
300 * @param child_sa CHILD_SA coming up/going down
301 * @param up TRUE for an up event, FALSE for a down event
302 */
303 void (*child_updown)(bus_t *this, child_sa_t *child_sa, bool up);
304
305 /**
306 * CHILD_SA rekeying hook.
307 *
308 * @param old rekeyed and obsolete CHILD_SA
309 * @param new new CHILD_SA replacing old
310 */
311 void (*child_rekey)(bus_t *this, child_sa_t *old, child_sa_t *new);
312
313 /**
314 * Destroy the event bus.
315 */
316 void (*destroy) (bus_t *this);
317 };
318
319 /**
320 * Create the event bus which forwards events to its listeners.
321 *
322 * @return event bus instance
323 */
324 bus_t *bus_create();
325
326 #endif /** BUS_H_ @}*/