trap-manager: Remove unused find_reqid() method
[strongswan.git] / src / libcharon / sa / trap_manager.c
1 /*
2 * Copyright (C) 2011-2017 Tobias Brunner
3 * Copyright (C) 2009 Martin Willi
4 * HSR 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 #include "trap_manager.h"
18
19 #include <daemon.h>
20 #include <threading/mutex.h>
21 #include <threading/rwlock.h>
22 #include <threading/rwlock_condvar.h>
23 #include <collections/linked_list.h>
24
25 #define INSTALL_DISABLED ((u_int)~0)
26
27 typedef struct private_trap_manager_t private_trap_manager_t;
28 typedef struct trap_listener_t trap_listener_t;
29
30 /**
31 * listener to track acquires
32 */
33 struct trap_listener_t {
34
35 /**
36 * Implements listener interface
37 */
38 listener_t listener;
39
40 /**
41 * points to trap_manager
42 */
43 private_trap_manager_t *traps;
44 };
45
46 /**
47 * Private data of an trap_manager_t object.
48 */
49 struct private_trap_manager_t {
50
51 /**
52 * Public trap_manager_t interface.
53 */
54 trap_manager_t public;
55
56 /**
57 * Installed traps, as entry_t
58 */
59 linked_list_t *traps;
60
61 /**
62 * read write lock for traps list
63 */
64 rwlock_t *lock;
65
66 /**
67 * listener to track acquiring IKE_SAs
68 */
69 trap_listener_t listener;
70
71 /**
72 * list of acquires we currently handle
73 */
74 linked_list_t *acquires;
75
76 /**
77 * mutex for list of acquires
78 */
79 mutex_t *mutex;
80
81 /**
82 * number of threads currently installing trap policies, or INSTALL_DISABLED
83 */
84 u_int installing;
85
86 /**
87 * condvar to signal trap policy installation
88 */
89 rwlock_condvar_t *condvar;
90
91 /**
92 * Whether to ignore traffic selectors from acquires
93 */
94 bool ignore_acquire_ts;
95 };
96
97 /**
98 * A installed trap entry
99 */
100 typedef struct {
101 /** name of the trapped CHILD_SA */
102 char *name;
103 /** ref to peer_cfg to initiate */
104 peer_cfg_t *peer_cfg;
105 /** ref to instantiated CHILD_SA (i.e the trap policy) */
106 child_sa_t *child_sa;
107 /** TRUE in case of wildcard Transport Mode SA */
108 bool wildcard;
109 } entry_t;
110
111 /**
112 * A handled acquire
113 */
114 typedef struct {
115 /** pending IKE_SA connecting upon acquire */
116 ike_sa_t *ike_sa;
117 /** reqid of pending trap policy */
118 uint32_t reqid;
119 /** destination address (wildcard case) */
120 host_t *dst;
121 } acquire_t;
122
123 /**
124 * actually uninstall and destroy an installed entry
125 */
126 static void destroy_entry(entry_t *this)
127 {
128 this->child_sa->destroy(this->child_sa);
129 this->peer_cfg->destroy(this->peer_cfg);
130 free(this->name);
131 free(this);
132 }
133
134 /**
135 * destroy a cached acquire entry
136 */
137 static void destroy_acquire(acquire_t *this)
138 {
139 DESTROY_IF(this->dst);
140 free(this);
141 }
142
143 CALLBACK(acquire_by_reqid, bool,
144 acquire_t *this, va_list args)
145 {
146 uint32_t reqid;
147
148 VA_ARGS_VGET(args, reqid);
149 return this->reqid == reqid;
150 }
151
152 CALLBACK(acquire_by_dst, bool,
153 acquire_t *this, va_list args)
154 {
155 host_t *dst;
156
157 VA_ARGS_VGET(args, dst);
158 return this->dst && this->dst->ip_equals(this->dst, dst);
159 }
160
161 /**
162 * Check if any remote TS are dynamic
163 */
164 static bool dynamic_remote_ts(child_cfg_t *child)
165 {
166 enumerator_t *enumerator;
167 linked_list_t *other_ts;
168 traffic_selector_t *ts;
169 bool found = FALSE;
170
171 other_ts = child->get_traffic_selectors(child, FALSE, NULL, NULL);
172 enumerator = other_ts->create_enumerator(other_ts);
173 while (enumerator->enumerate(enumerator, &ts))
174 {
175 if (ts->is_dynamic(ts))
176 {
177 found = TRUE;
178 break;
179 }
180 }
181 enumerator->destroy(enumerator);
182 other_ts->destroy_offset(other_ts, offsetof(traffic_selector_t, destroy));
183 return found;
184 }
185
186 METHOD(trap_manager_t, install, bool,
187 private_trap_manager_t *this, peer_cfg_t *peer, child_cfg_t *child)
188 {
189 entry_t *entry, *found = NULL;
190 ike_cfg_t *ike_cfg;
191 child_sa_t *child_sa;
192 host_t *me, *other;
193 linked_list_t *my_ts, *other_ts, *list;
194 enumerator_t *enumerator;
195 status_t status;
196 linked_list_t *proposals;
197 proposal_t *proposal;
198 protocol_id_t proto = PROTO_ESP;
199 bool result = FALSE, wildcard = FALSE;
200
201 /* try to resolve addresses */
202 ike_cfg = peer->get_ike_cfg(peer);
203 other = ike_cfg->resolve_other(ike_cfg, AF_UNSPEC);
204 if (other && other->is_anyaddr(other) &&
205 child->get_mode(child) == MODE_TRANSPORT)
206 {
207 /* allow wildcard for Transport Mode SAs */
208 me = host_create_any(other->get_family(other));
209 wildcard = TRUE;
210 }
211 else if (other && other->is_anyaddr(other))
212 {
213 other->destroy(other);
214 DBG1(DBG_CFG, "installing trap failed, remote address unknown");
215 return FALSE;
216 }
217 else
218 { /* depending on the traffic selectors we don't really need a remote
219 * host yet, but we might fail later if no IP can be resolved */
220 if (!other && dynamic_remote_ts(child))
221 { /* with dynamic TS we do need a host, otherwise 0.0.0.0/0 is used,
222 * which is probably not what users expect*/
223 DBG1(DBG_CFG, "installing trap failed, remote address unknown with "
224 "dynamic traffic selector");
225 return FALSE;
226 }
227 me = ike_cfg->resolve_me(ike_cfg, other ? other->get_family(other)
228 : AF_UNSPEC);
229 if (!other)
230 {
231 other = host_create_any(me ? me->get_family(me) : AF_INET);
232 }
233 other->set_port(other, ike_cfg->get_other_port(ike_cfg));
234 if ((!me || me->is_anyaddr(me)) && !other->is_anyaddr(other))
235 {
236 DESTROY_IF(me);
237 me = charon->kernel->get_source_addr(charon->kernel, other, NULL);
238 }
239 if (!me)
240 {
241 me = host_create_any(other->get_family(other));
242 }
243 me->set_port(me, ike_cfg->get_my_port(ike_cfg));
244 }
245
246 this->lock->write_lock(this->lock);
247 if (this->installing == INSTALL_DISABLED)
248 { /* flush() has been called */
249 this->lock->unlock(this->lock);
250 other->destroy(other);
251 me->destroy(me);
252 return FALSE;
253 }
254 enumerator = this->traps->create_enumerator(this->traps);
255 while (enumerator->enumerate(enumerator, &entry))
256 {
257 if (streq(entry->name, child->get_name(child)) &&
258 streq(entry->peer_cfg->get_name(entry->peer_cfg),
259 peer->get_name(peer)))
260 {
261 found = entry;
262 if (entry->child_sa)
263 { /* replace it with an updated version, if already installed */
264 this->traps->remove_at(this->traps, enumerator);
265 }
266 break;
267 }
268 }
269 enumerator->destroy(enumerator);
270
271 if (found)
272 {
273 if (!found->child_sa)
274 {
275 DBG1(DBG_CFG, "CHILD_SA '%s' is already being routed", found->name);
276 this->lock->unlock(this->lock);
277 other->destroy(other);
278 me->destroy(me);
279 return FALSE;
280 }
281 /* config might have changed so update everything */
282 DBG1(DBG_CFG, "updating already routed CHILD_SA '%s'", found->name);
283 }
284
285 INIT(entry,
286 .name = strdup(child->get_name(child)),
287 .peer_cfg = peer->get_ref(peer),
288 .wildcard = wildcard,
289 );
290 this->traps->insert_first(this->traps, entry);
291 this->installing++;
292 /* don't hold lock while creating CHILD_SA and installing policies */
293 this->lock->unlock(this->lock);
294
295 /* create and route CHILD_SA */
296 child_sa = child_sa_create(me, other, child, 0, FALSE, 0, 0);
297
298 list = linked_list_create_with_items(me, NULL);
299 my_ts = child->get_traffic_selectors(child, TRUE, NULL, list);
300 list->destroy_offset(list, offsetof(host_t, destroy));
301
302 list = linked_list_create_with_items(other, NULL);
303 other_ts = child->get_traffic_selectors(child, FALSE, NULL, list);
304 list->destroy_offset(list, offsetof(host_t, destroy));
305
306 /* We don't know the finally negotiated protocol (ESP|AH), we install
307 * the SA with the protocol of the first proposal */
308 proposals = child->get_proposals(child, TRUE);
309 if (proposals->get_first(proposals, (void**)&proposal) == SUCCESS)
310 {
311 proto = proposal->get_protocol(proposal);
312 }
313 proposals->destroy_offset(proposals, offsetof(proposal_t, destroy));
314 child_sa->set_protocol(child_sa, proto);
315 child_sa->set_mode(child_sa, child->get_mode(child));
316 child_sa->set_policies(child_sa, my_ts, other_ts);
317 status = child_sa->install_policies(child_sa);
318 my_ts->destroy_offset(my_ts, offsetof(traffic_selector_t, destroy));
319 other_ts->destroy_offset(other_ts, offsetof(traffic_selector_t, destroy));
320 if (status != SUCCESS)
321 {
322 DBG1(DBG_CFG, "installing trap failed");
323 this->lock->write_lock(this->lock);
324 this->traps->remove(this->traps, entry, NULL);
325 this->lock->unlock(this->lock);
326 entry->child_sa = child_sa;
327 destroy_entry(entry);
328 }
329 else
330 {
331 this->lock->write_lock(this->lock);
332 entry->child_sa = child_sa;
333 this->lock->unlock(this->lock);
334 result = TRUE;
335 }
336 if (found)
337 {
338 destroy_entry(found);
339 }
340 this->lock->write_lock(this->lock);
341 /* do this at the end, so entries created temporarily are also destroyed */
342 this->installing--;
343 this->condvar->signal(this->condvar);
344 this->lock->unlock(this->lock);
345 return result;
346 }
347
348 METHOD(trap_manager_t, uninstall, bool,
349 private_trap_manager_t *this, char *peer, char *child)
350 {
351 enumerator_t *enumerator;
352 entry_t *entry, *found = NULL;
353
354 this->lock->write_lock(this->lock);
355 enumerator = this->traps->create_enumerator(this->traps);
356 while (enumerator->enumerate(enumerator, &entry))
357 {
358 if (streq(entry->name, child) &&
359 (!peer || streq(peer, entry->peer_cfg->get_name(entry->peer_cfg))))
360 {
361 this->traps->remove_at(this->traps, enumerator);
362 found = entry;
363 break;
364 }
365 }
366 enumerator->destroy(enumerator);
367 this->lock->unlock(this->lock);
368
369 if (!found)
370 {
371 return FALSE;
372 }
373 destroy_entry(found);
374 return TRUE;
375 }
376
377 CALLBACK(trap_filter, bool,
378 rwlock_t *lock, enumerator_t *orig, va_list args)
379 {
380 entry_t *entry;
381 peer_cfg_t **peer_cfg;
382 child_sa_t **child_sa;
383
384 VA_ARGS_VGET(args, peer_cfg, child_sa);
385
386 while (orig->enumerate(orig, &entry))
387 {
388 if (!entry->child_sa)
389 { /* skip entries that are currently being installed */
390 continue;
391 }
392 if (peer_cfg)
393 {
394 *peer_cfg = entry->peer_cfg;
395 }
396 if (child_sa)
397 {
398 *child_sa = entry->child_sa;
399 }
400 return TRUE;
401 }
402 return FALSE;
403 }
404
405 METHOD(trap_manager_t, create_enumerator, enumerator_t*,
406 private_trap_manager_t *this)
407 {
408 this->lock->read_lock(this->lock);
409 return enumerator_create_filter(this->traps->create_enumerator(this->traps),
410 trap_filter, this->lock,
411 (void*)this->lock->unlock);
412 }
413
414 METHOD(trap_manager_t, acquire, void,
415 private_trap_manager_t *this, uint32_t reqid,
416 traffic_selector_t *src, traffic_selector_t *dst)
417 {
418 enumerator_t *enumerator;
419 entry_t *entry, *found = NULL;
420 acquire_t *acquire;
421 peer_cfg_t *peer;
422 child_cfg_t *child;
423 ike_sa_t *ike_sa;
424 host_t *host;
425 bool wildcard, ignore = FALSE;
426
427 this->lock->read_lock(this->lock);
428 enumerator = this->traps->create_enumerator(this->traps);
429 while (enumerator->enumerate(enumerator, &entry))
430 {
431 if (entry->child_sa &&
432 entry->child_sa->get_reqid(entry->child_sa) == reqid)
433 {
434 found = entry;
435 break;
436 }
437 }
438 enumerator->destroy(enumerator);
439
440 if (!found)
441 {
442 DBG1(DBG_CFG, "trap not found, unable to acquire reqid %d", reqid);
443 this->lock->unlock(this->lock);
444 return;
445 }
446 reqid = found->child_sa->get_reqid(found->child_sa);
447 wildcard = found->wildcard;
448
449 this->mutex->lock(this->mutex);
450 if (wildcard)
451 { /* for wildcard acquires we check that we don't have a pending acquire
452 * with the same peer */
453 uint8_t mask;
454
455 dst->to_subnet(dst, &host, &mask);
456 if (this->acquires->find_first(this->acquires, acquire_by_dst,
457 (void**)&acquire, host))
458 {
459 host->destroy(host);
460 ignore = TRUE;
461 }
462 else
463 {
464 INIT(acquire,
465 .dst = host,
466 .reqid = reqid,
467 );
468 this->acquires->insert_last(this->acquires, acquire);
469 }
470 }
471 else
472 {
473 if (this->acquires->find_first(this->acquires, acquire_by_reqid,
474 (void**)&acquire, reqid))
475 {
476 ignore = TRUE;
477 }
478 else
479 {
480 INIT(acquire,
481 .reqid = reqid,
482 );
483 this->acquires->insert_last(this->acquires, acquire);
484 }
485 }
486 this->mutex->unlock(this->mutex);
487 if (ignore)
488 {
489 DBG1(DBG_CFG, "ignoring acquire, connection attempt pending");
490 this->lock->unlock(this->lock);
491 return;
492 }
493 peer = found->peer_cfg->get_ref(found->peer_cfg);
494 child = found->child_sa->get_config(found->child_sa);
495 child = child->get_ref(child);
496 /* don't hold the lock while checking out the IKE_SA */
497 this->lock->unlock(this->lock);
498
499 if (wildcard)
500 { /* the peer config would match IKE_SAs with other peers */
501 ike_sa = charon->ike_sa_manager->checkout_new(charon->ike_sa_manager,
502 peer->get_ike_version(peer), TRUE);
503 if (ike_sa)
504 {
505 ike_cfg_t *ike_cfg;
506 uint16_t port;
507 uint8_t mask;
508
509 ike_sa->set_peer_cfg(ike_sa, peer);
510 ike_cfg = ike_sa->get_ike_cfg(ike_sa);
511
512 port = ike_cfg->get_other_port(ike_cfg);
513 dst->to_subnet(dst, &host, &mask);
514 host->set_port(host, port);
515 ike_sa->set_other_host(ike_sa, host);
516
517 port = ike_cfg->get_my_port(ike_cfg);
518 src->to_subnet(src, &host, &mask);
519 host->set_port(host, port);
520 ike_sa->set_my_host(ike_sa, host);
521
522 charon->bus->set_sa(charon->bus, ike_sa);
523 }
524 }
525 else
526 {
527 ike_sa = charon->ike_sa_manager->checkout_by_config(
528 charon->ike_sa_manager, peer);
529 }
530 if (ike_sa)
531 {
532 if (ike_sa->get_peer_cfg(ike_sa) == NULL)
533 {
534 ike_sa->set_peer_cfg(ike_sa, peer);
535 }
536 if (this->ignore_acquire_ts || ike_sa->get_version(ike_sa) == IKEV1)
537 { /* in IKEv1, don't prepend the acquiring packet TS, as we only
538 * have a single TS that we can establish in a Quick Mode. */
539 src = dst = NULL;
540 }
541
542 this->mutex->lock(this->mutex);
543 acquire->ike_sa = ike_sa;
544 this->mutex->unlock(this->mutex);
545
546 if (ike_sa->initiate(ike_sa, child, reqid, src, dst) != DESTROY_ME)
547 {
548 charon->ike_sa_manager->checkin(charon->ike_sa_manager, ike_sa);
549 }
550 else
551 {
552 charon->ike_sa_manager->checkin_and_destroy(charon->ike_sa_manager,
553 ike_sa);
554 }
555 }
556 else
557 {
558 this->mutex->lock(this->mutex);
559 this->acquires->remove(this->acquires, acquire, NULL);
560 this->mutex->unlock(this->mutex);
561 destroy_acquire(acquire);
562 child->destroy(child);
563 }
564 peer->destroy(peer);
565 }
566
567 /**
568 * Complete the acquire, if successful or failed
569 */
570 static void complete(private_trap_manager_t *this, ike_sa_t *ike_sa,
571 child_sa_t *child_sa)
572 {
573 enumerator_t *enumerator;
574 acquire_t *acquire;
575
576 this->mutex->lock(this->mutex);
577 enumerator = this->acquires->create_enumerator(this->acquires);
578 while (enumerator->enumerate(enumerator, &acquire))
579 {
580 if (!acquire->ike_sa || acquire->ike_sa != ike_sa)
581 {
582 continue;
583 }
584 if (child_sa)
585 {
586 if (acquire->dst)
587 {
588 /* since every wildcard acquire results in a separate IKE_SA
589 * there is no need to compare the destination address */
590 }
591 else if (child_sa->get_reqid(child_sa) != acquire->reqid)
592 {
593 continue;
594 }
595 }
596 this->acquires->remove_at(this->acquires, enumerator);
597 destroy_acquire(acquire);
598 }
599 enumerator->destroy(enumerator);
600 this->mutex->unlock(this->mutex);
601 }
602
603 METHOD(listener_t, ike_state_change, bool,
604 trap_listener_t *listener, ike_sa_t *ike_sa, ike_sa_state_t state)
605 {
606 switch (state)
607 {
608 case IKE_DESTROYING:
609 complete(listener->traps, ike_sa, NULL);
610 return TRUE;
611 default:
612 return TRUE;
613 }
614 }
615
616 METHOD(listener_t, child_state_change, bool,
617 trap_listener_t *listener, ike_sa_t *ike_sa, child_sa_t *child_sa,
618 child_sa_state_t state)
619 {
620 switch (state)
621 {
622 case CHILD_INSTALLED:
623 case CHILD_DESTROYING:
624 complete(listener->traps, ike_sa, child_sa);
625 return TRUE;
626 default:
627 return TRUE;
628 }
629 }
630
631 METHOD(trap_manager_t, flush, void,
632 private_trap_manager_t *this)
633 {
634 this->lock->write_lock(this->lock);
635 while (this->installing)
636 {
637 this->condvar->wait(this->condvar, this->lock);
638 }
639 this->traps->destroy_function(this->traps, (void*)destroy_entry);
640 this->traps = linked_list_create();
641 this->installing = INSTALL_DISABLED;
642 this->lock->unlock(this->lock);
643 }
644
645 METHOD(trap_manager_t, destroy, void,
646 private_trap_manager_t *this)
647 {
648 charon->bus->remove_listener(charon->bus, &this->listener.listener);
649 this->traps->destroy_function(this->traps, (void*)destroy_entry);
650 this->acquires->destroy_function(this->acquires, (void*)destroy_acquire);
651 this->condvar->destroy(this->condvar);
652 this->mutex->destroy(this->mutex);
653 this->lock->destroy(this->lock);
654 free(this);
655 }
656
657 /**
658 * See header
659 */
660 trap_manager_t *trap_manager_create(void)
661 {
662 private_trap_manager_t *this;
663
664 INIT(this,
665 .public = {
666 .install = _install,
667 .uninstall = _uninstall,
668 .create_enumerator = _create_enumerator,
669 .acquire = _acquire,
670 .flush = _flush,
671 .destroy = _destroy,
672 },
673 .listener = {
674 .traps = this,
675 .listener = {
676 .ike_state_change = _ike_state_change,
677 .child_state_change = _child_state_change,
678 },
679 },
680 .traps = linked_list_create(),
681 .acquires = linked_list_create(),
682 .mutex = mutex_create(MUTEX_TYPE_DEFAULT),
683 .lock = rwlock_create(RWLOCK_TYPE_DEFAULT),
684 .condvar = rwlock_condvar_create(),
685 .ignore_acquire_ts = lib->settings->get_bool(lib->settings,
686 "%s.ignore_acquire_ts", FALSE, lib->ns),
687 );
688 charon->bus->add_listener(charon->bus, &this->listener.listener);
689
690 return &this->public;
691 }