updated Doxyfile
[strongswan.git] / src / charon / plugins / eap_mschapv2 / eap_mschapv2.h
1 /*
2 * Copyright (C) 2009 Tobias Brunner
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 eap_mschapv2_i eap_mschapv2
20 * @{ @ingroup eap_mschapv2
21 */
22
23 #ifndef EAP_MSCHAPV2_H_
24 #define EAP_MSCHAPV2_H_
25
26 typedef struct eap_mschapv2_t eap_mschapv2_t;
27
28 #include <sa/authenticators/eap/eap_method.h>
29
30 /**
31 * Implementation of the eap_method_t interface using EAP-MS-CHAPv2.
32 */
33 struct eap_mschapv2_t {
34
35 /**
36 * Implemented eap_method_t interface.
37 */
38 eap_method_t eap_method_interface;
39 };
40
41 /**
42 * Creates the EAP method EAP-MS-CHAPv2 acting as server.
43 *
44 * @param server ID of the EAP server
45 * @param peer ID of the EAP client
46 * @return eap_mschapv2_t object
47 */
48 eap_mschapv2_t *eap_mschapv2_create_server(identification_t *server, identification_t *peer);
49
50 /**
51 * Creates the EAP method EAP-MS-CHAPv2 acting as peer.
52 *
53 * @param server ID of the EAP server
54 * @param peer ID of the EAP client
55 * @return eap_mschapv2_t object
56 */
57 eap_mschapv2_t *eap_mschapv2_create_peer(identification_t *server, identification_t *peer);
58
59 #endif /** EAP_MSCHAPV2_H_ @}*/