ec061b6f4732de75d26d376c5dba068c488d36d9
[strongswan.git] / src / charon / plugins / eap_sim / eap_sim.h
1 /*
2 * Copyright (C) 2007-2008 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 eap_sim_i eap_sim
18 * @{ @ingroup eap_sim
19 */
20
21 #ifndef EAP_SIM_H_
22 #define EAP_SIM_H_
23
24 typedef struct eap_sim_t eap_sim_t;
25
26 #include <sa/authenticators/eap/eap_method.h>
27
28 /**
29 * Implementation of the eap_method_t interface using EAP-SIM.
30 *
31 * This EAP-SIM client implementation handles the protocol level of EAP-SIM
32 * only, it does not provide triplet calculation/fetching. Other plugins may
33 * provide these services using the sim_manager_t of charon.
34 */
35 struct eap_sim_t {
36
37 /**
38 * Implemented eap_method_t interface.
39 */
40 eap_method_t eap_method_interface;
41 };
42
43 /**
44 * Creates the EAP method EAP-SIM acting as server.
45 *
46 * @param server ID of the EAP server
47 * @param peer ID of the EAP client
48 * @return eap_sim_t object
49 */
50 eap_sim_t *eap_sim_create_server(identification_t *server, identification_t *peer);
51
52 /**
53 * Creates the EAP method EAP-SIM acting as peer.
54 *
55 * @param server ID of the EAP server
56 * @param peer ID of the EAP client
57 * @return eap_sim_t object
58 */
59 eap_sim_t *eap_sim_create_peer(identification_t *server, identification_t *peer);
60
61 #endif /* EAP_SIM_H_ @}*/