updated Doxyfile
[strongswan.git] / src / charon / sa / tasks / ike_auth_lifetime.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 ike_auth_lifetime ike_auth_lifetime
20 * @{ @ingroup tasks
21 */
22
23 #ifndef IKE_AUTH_LIFETIME_H_
24 #define IKE_AUTH_LIFETIME_H_
25
26 typedef struct ike_auth_lifetime_t ike_auth_lifetime_t;
27
28 #include <library.h>
29 #include <sa/ike_sa.h>
30 #include <sa/tasks/task.h>
31
32 /**
33 * Task of type IKE_AUTH_LIFETIME, implements RFC4478.
34 *
35 * This task exchanges lifetimes for IKE_AUTH to force a client to
36 * reauthenticate before the responders lifetime reaches the limit.
37 */
38 struct ike_auth_lifetime_t {
39
40 /**
41 * Implements the task_t interface
42 */
43 task_t task;
44 };
45
46 /**
47 * Create a new IKE_AUTH_LIFETIME task.
48 *
49 * @param ike_sa IKE_SA this task works for
50 * @param initiator TRUE if taks is initiated by us
51 * @return ike_auth_lifetime task to handle by the task_manager
52 */
53 ike_auth_lifetime_t *ike_auth_lifetime_create(ike_sa_t *ike_sa, bool initiator);
54
55 #endif /** IKE_MOBIKE_H_ @}*/