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