implemented child_down() bus hook
[strongswan.git] / src / charon / sa / tasks / child_delete.c
1 /*
2 * Copyright (C) 2006-2007 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 #include "child_delete.h"
17
18 #include <daemon.h>
19 #include <encoding/payloads/delete_payload.h>
20
21
22 typedef struct private_child_delete_t private_child_delete_t;
23
24 /**
25 * Private members of a child_delete_t task.
26 */
27 struct private_child_delete_t {
28
29 /**
30 * Public methods and task_t interface.
31 */
32 child_delete_t public;
33
34 /**
35 * Assigned IKE_SA.
36 */
37 ike_sa_t *ike_sa;
38
39 /**
40 * Are we the initiator?
41 */
42 bool initiator;
43
44 /**
45 * Protocol of CHILD_SA to delete
46 */
47 protocol_id_t protocol;
48
49 /**
50 * Inbound SPI of CHILD_SA to delete
51 */
52 u_int32_t spi;
53
54 /**
55 * whether to enforce delete action policy
56 */
57 bool check_delete_action;
58
59 /**
60 * is this delete exchange following a rekey?
61 */
62 bool rekeyed;
63
64 /**
65 * CHILD_SAs which get deleted
66 */
67 linked_list_t *child_sas;
68 };
69
70 /**
71 * build the delete payloads from the listed child_sas
72 */
73 static void build_payloads(private_child_delete_t *this, message_t *message)
74 {
75 delete_payload_t *ah = NULL, *esp = NULL;
76 iterator_t *iterator;
77 child_sa_t *child_sa;
78
79 iterator = this->child_sas->create_iterator(this->child_sas, TRUE);
80 while (iterator->iterate(iterator, (void**)&child_sa))
81 {
82 protocol_id_t protocol = child_sa->get_protocol(child_sa);
83 u_int32_t spi = child_sa->get_spi(child_sa, TRUE);
84
85 switch (protocol)
86 {
87 case PROTO_ESP:
88 if (esp == NULL)
89 {
90 esp = delete_payload_create(PROTO_ESP);
91 message->add_payload(message, (payload_t*)esp);
92 }
93 esp->add_spi(esp, spi);
94 DBG1(DBG_IKE, "sending DELETE for %N CHILD_SA with SPI %.8x",
95 protocol_id_names, protocol, ntohl(spi));
96 break;
97 case PROTO_AH:
98 if (ah == NULL)
99 {
100 ah = delete_payload_create(PROTO_AH);
101 message->add_payload(message, (payload_t*)ah);
102 }
103 ah->add_spi(ah, spi);
104 DBG1(DBG_IKE, "sending DELETE for %N CHILD_SA with SPI %.8x",
105 protocol_id_names, protocol, ntohl(spi));
106 break;
107 default:
108 break;
109 }
110 child_sa->set_state(child_sa, CHILD_DELETING);
111 }
112 iterator->destroy(iterator);
113 }
114
115 /**
116 * read in payloads and find the children to delete
117 */
118 static void process_payloads(private_child_delete_t *this, message_t *message)
119 {
120 enumerator_t *payloads;
121 iterator_t *spis;
122 payload_t *payload;
123 delete_payload_t *delete_payload;
124 u_int32_t *spi;
125 protocol_id_t protocol;
126 child_sa_t *child_sa;
127
128 payloads = message->create_payload_enumerator(message);
129 while (payloads->enumerate(payloads, &payload))
130 {
131 if (payload->get_type(payload) == DELETE)
132 {
133 delete_payload = (delete_payload_t*)payload;
134 protocol = delete_payload->get_protocol_id(delete_payload);
135 if (protocol != PROTO_ESP && protocol != PROTO_AH)
136 {
137 continue;
138 }
139 spis = delete_payload->create_spi_iterator(delete_payload);
140 while (spis->iterate(spis, (void**)&spi))
141 {
142 child_sa = this->ike_sa->get_child_sa(this->ike_sa, protocol,
143 *spi, FALSE);
144 if (child_sa == NULL)
145 {
146 DBG1(DBG_IKE, "received DELETE for %N CHILD_SA with SPI %.8x, "
147 "but no such SA", protocol_id_names, protocol, ntohl(*spi));
148 continue;
149 }
150 DBG1(DBG_IKE, "received DELETE for %N CHILD_SA with SPI %.8x",
151 protocol_id_names, protocol, ntohl(*spi));
152
153 switch (child_sa->get_state(child_sa))
154 {
155 case CHILD_REKEYING:
156 this->rekeyed = TRUE;
157 /* we reply as usual, rekeying will fail */
158 break;
159 case CHILD_DELETING:
160 /* we don't send back a delete if we initiated ourself */
161 if (!this->initiator)
162 {
163 this->ike_sa->destroy_child_sa(this->ike_sa,
164 protocol, *spi);
165 continue;
166 }
167 case CHILD_INSTALLED:
168 if (!this->initiator)
169 { /* reestablish installed children if required */
170 this->check_delete_action = TRUE;
171 }
172 default:
173 break;
174 }
175
176 this->child_sas->insert_last(this->child_sas, child_sa);
177 }
178 spis->destroy(spis);
179 }
180 }
181 payloads->destroy(payloads);
182 }
183
184 /**
185 * destroy the children listed in this->child_sas, reestablish by policy
186 */
187 static status_t destroy_and_reestablish(private_child_delete_t *this)
188 {
189 iterator_t *iterator;
190 child_sa_t *child_sa;
191 child_cfg_t *child_cfg;
192 protocol_id_t protocol;
193 u_int32_t spi;
194 status_t status = SUCCESS;
195
196 iterator = this->child_sas->create_iterator(this->child_sas, TRUE);
197 while (iterator->iterate(iterator, (void**)&child_sa))
198 {
199 /* signal child down event if we are not rekeying */
200 if (!this->rekeyed)
201 {
202 charon->bus->child_updown(charon->bus, child_sa, FALSE);
203 }
204 spi = child_sa->get_spi(child_sa, TRUE);
205 protocol = child_sa->get_protocol(child_sa);
206 child_cfg = child_sa->get_config(child_sa);
207 child_cfg->get_ref(child_cfg);
208 this->ike_sa->destroy_child_sa(this->ike_sa, protocol, spi);
209 if (this->check_delete_action)
210 { /* enforce child_cfg policy if deleted passively */
211 switch (child_cfg->get_close_action(child_cfg))
212 {
213 case ACTION_RESTART:
214 child_cfg->get_ref(child_cfg);
215 status = this->ike_sa->initiate(this->ike_sa, child_cfg, 0,
216 NULL, NULL);
217 break;
218 case ACTION_ROUTE:
219 charon->traps->install(charon->traps,
220 this->ike_sa->get_peer_cfg(this->ike_sa), child_cfg);
221 break;
222 default:
223 break;
224 }
225 }
226 child_cfg->destroy(child_cfg);
227 if (status != SUCCESS)
228 {
229 break;
230 }
231 }
232 iterator->destroy(iterator);
233 return status;
234 }
235
236 /**
237 * send closing signals for all CHILD_SAs over the bus
238 */
239 static void log_children(private_child_delete_t *this)
240 {
241 iterator_t *iterator;
242 child_sa_t *child_sa;
243
244 iterator = this->child_sas->create_iterator(this->child_sas, TRUE);
245 while (iterator->iterate(iterator, (void**)&child_sa))
246 {
247 DBG0(DBG_IKE, "closing CHILD_SA %s{%d} "
248 "with SPIs %.8x_i %.8x_o and TS %#R=== %#R",
249 child_sa->get_name(child_sa), child_sa->get_reqid(child_sa),
250 ntohl(child_sa->get_spi(child_sa, TRUE)),
251 ntohl(child_sa->get_spi(child_sa, FALSE)),
252 child_sa->get_traffic_selectors(child_sa, TRUE),
253 child_sa->get_traffic_selectors(child_sa, FALSE));
254 }
255 iterator->destroy(iterator);
256 }
257
258 /**
259 * Implementation of task_t.build for initiator
260 */
261 static status_t build_i(private_child_delete_t *this, message_t *message)
262 {
263 child_sa_t *child_sa;
264
265 child_sa = this->ike_sa->get_child_sa(this->ike_sa, this->protocol,
266 this->spi, TRUE);
267 if (!child_sa)
268 { /* child does not exist anymore */
269 return SUCCESS;
270 }
271 this->child_sas->insert_last(this->child_sas, child_sa);
272 if (child_sa->get_state(child_sa) == CHILD_REKEYING)
273 {
274 this->rekeyed = TRUE;
275 }
276 log_children(this);
277 build_payloads(this, message);
278 return NEED_MORE;
279 }
280
281 /**
282 * Implementation of task_t.process for initiator
283 */
284 static status_t process_i(private_child_delete_t *this, message_t *message)
285 {
286 /* flush the list before adding new SAs */
287 this->child_sas->destroy(this->child_sas);
288 this->child_sas = linked_list_create();
289
290 process_payloads(this, message);
291 DBG1(DBG_IKE, "CHILD_SA closed");
292 return destroy_and_reestablish(this);
293 }
294
295 /**
296 * Implementation of task_t.process for initiator
297 */
298 static status_t process_r(private_child_delete_t *this, message_t *message)
299 {
300 process_payloads(this, message);
301 log_children(this);
302 return NEED_MORE;
303 }
304
305 /**
306 * Implementation of task_t.build for responder
307 */
308 static status_t build_r(private_child_delete_t *this, message_t *message)
309 {
310 /* if we are rekeying, we send an empty informational */
311 if (this->ike_sa->get_state(this->ike_sa) != IKE_REKEYING)
312 {
313 build_payloads(this, message);
314 }
315 DBG1(DBG_IKE, "CHILD_SA closed");
316 return destroy_and_reestablish(this);
317 }
318
319 /**
320 * Implementation of task_t.get_type
321 */
322 static task_type_t get_type(private_child_delete_t *this)
323 {
324 return CHILD_DELETE;
325 }
326
327 /**
328 * Implementation of child_delete_t.get_child
329 */
330 static child_sa_t* get_child(private_child_delete_t *this)
331 {
332 child_sa_t *child_sa = NULL;
333 this->child_sas->get_first(this->child_sas, (void**)&child_sa);
334 return child_sa;
335 }
336
337 /**
338 * Implementation of task_t.migrate
339 */
340 static void migrate(private_child_delete_t *this, ike_sa_t *ike_sa)
341 {
342 this->check_delete_action = FALSE;
343 this->ike_sa = ike_sa;
344
345 this->child_sas->destroy(this->child_sas);
346 this->child_sas = linked_list_create();
347 }
348
349 /**
350 * Implementation of task_t.destroy
351 */
352 static void destroy(private_child_delete_t *this)
353 {
354 this->child_sas->destroy(this->child_sas);
355 free(this);
356 }
357
358 /*
359 * Described in header.
360 */
361 child_delete_t *child_delete_create(ike_sa_t *ike_sa, protocol_id_t protocol,
362 u_int32_t spi)
363 {
364 private_child_delete_t *this = malloc_thing(private_child_delete_t);
365
366 this->public.get_child = (child_sa_t*(*)(child_delete_t*))get_child;
367 this->public.task.get_type = (task_type_t(*)(task_t*))get_type;
368 this->public.task.migrate = (void(*)(task_t*,ike_sa_t*))migrate;
369 this->public.task.destroy = (void(*)(task_t*))destroy;
370
371 this->ike_sa = ike_sa;
372 this->check_delete_action = FALSE;
373 this->child_sas = linked_list_create();
374 this->protocol = protocol;
375 this->spi = spi;
376 this->rekeyed = FALSE;
377
378 if (protocol != PROTO_NONE)
379 {
380 this->public.task.build = (status_t(*)(task_t*,message_t*))build_i;
381 this->public.task.process = (status_t(*)(task_t*,message_t*))process_i;
382 this->initiator = TRUE;
383 }
384 else
385 {
386 this->public.task.build = (status_t(*)(task_t*,message_t*))build_r;
387 this->public.task.process = (status_t(*)(task_t*,message_t*))process_r;
388 this->initiator = FALSE;
389 }
390 return &this->public;
391 }