updated Doxyfile
[strongswan.git] / src / charon / sa / tasks / ike_auth.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 ike_auth
20 * @{ @ingroup tasks
21 */
22
23 #ifndef IKE_AUTH_H_
24 #define IKE_AUTH_H_
25
26 typedef struct ike_auth_t ike_auth_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, authenticates an IKE_SA using authenticators.
34 *
35 * The ike_auth task authenticates the IKE_SA using the IKE_AUTH
36 * exchange. It processes and build IDi and IDr payloads and also
37 * handles AUTH payloads. The AUTH payloads are passed to authenticator_t's,
38 * which do the actual authentication process. If the ike_auth task is used
39 * with EAP authentication, it stays alive over multiple exchanges until
40 * EAP has completed.
41 */
42 struct ike_auth_t {
43
44 /**
45 * Implements the task_t interface
46 */
47 task_t task;
48 };
49
50 /**
51 * Create a new task of type IKE_AUTHENTICATE.
52 *
53 * @param ike_sa IKE_SA this task works for
54 * @param initiator TRUE if thask is the initator of an exchange
55 * @return ike_auth task to handle by the task_manager
56 */
57 ike_auth_t *ike_auth_create(ike_sa_t *ike_sa, bool initiator);
58
59 #endif /** IKE_AUTH_H_ @}*/