b0c4cec2e581b412da203e23e53f694461328bb1
[strongswan.git] / src / charon / sa / tasks / child_rekey.h
1 /*
2 * Copyright (C) 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 * $Id$
16 */
17
18 /**
19 * @defgroup child_rekey child_rekey
20 * @{ @ingroup tasks
21 */
22
23 #ifndef CHILD_REKEY_H_
24 #define CHILD_REKEY_H_
25
26 typedef struct child_rekey_t child_rekey_t;
27
28 #include <library.h>
29 #include <sa/ike_sa.h>
30 #include <sa/child_sa.h>
31 #include <sa/tasks/task.h>
32
33 /**
34 * Task of type CHILD_REKEY, rekey an established CHILD_SA.
35 */
36 struct child_rekey_t {
37
38 /**
39 * Implements the task_t interface
40 */
41 task_t task;
42
43 /**
44 * Register a rekeying task which collides with this one
45 *
46 * If two peers initiate rekeying at the same time, the collision must
47 * be handled gracefully. The task manager is aware of what exchanges
48 * are going on and notifies the outgoing task by passing the incoming.
49 *
50 * @param other incoming task
51 */
52 void (*collide)(child_rekey_t* this, task_t *other);
53 };
54
55 /**
56 * Create a new CHILD_REKEY task.
57 *
58 * @param ike_sa IKE_SA this task works for
59 * @param protocol protocol of CHILD_SA to rekey, PROTO_NONE as responder
60 * @param spi inbound SPI of CHILD_SA to rekey
61 * @return child_rekey task to handle by the task_manager
62 */
63 child_rekey_t *child_rekey_create(ike_sa_t *ike_sa, protocol_id_t protocol,
64 u_int32_t spi);
65
66 #endif /* CHILD_REKEY_H_ @} */