ike-rekey: Add method to check if there was a rekey collision
[strongswan.git] / src / libcharon / sa / ikev2 / tasks / ike_rekey.h
1 /*
2 * Copyright (C) 2016 Tobias Brunner
3 * Copyright (C) 2007 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 /**
18 * @defgroup ike_rekey ike_rekey
19 * @{ @ingroup tasks_v2
20 */
21
22 #ifndef IKE_REKEY_H_
23 #define IKE_REKEY_H_
24
25 typedef struct ike_rekey_t ike_rekey_t;
26
27 #include <library.h>
28 #include <sa/ike_sa.h>
29 #include <sa/task.h>
30
31 /**
32 * Task of type TASK_IKE_REKEY, rekey an established IKE_SA.
33 */
34 struct ike_rekey_t {
35
36 /**
37 * Implements the task_t interface
38 */
39 task_t task;
40
41 /**
42 * Check if there was a rekey collision.
43 *
44 * @return TRUE if there was a rekey collision before
45 */
46 bool (*did_collide)(ike_rekey_t *this);
47
48 /**
49 * Register a rekeying task which collides with this one.
50 *
51 * If two peers initiate rekeying at the same time, the collision must
52 * be handled gracefully. The task manager is aware of what exchanges
53 * are going on and notifies the outgoing task by passing the incoming.
54 *
55 * @param other incoming task
56 */
57 void (*collide)(ike_rekey_t* this, task_t *other);
58 };
59
60 /**
61 * Create a new TASK_IKE_REKEY task.
62 *
63 * @param ike_sa IKE_SA this task works for
64 * @param initiator TRUE for initiator, FALSE for responder
65 * @return TASK_IKE_REKEY task to handle by the task_manager
66 */
67 ike_rekey_t *ike_rekey_create(ike_sa_t *ike_sa, bool initiator);
68
69 #endif /** IKE_REKEY_H_ @}*/