merged EAP-MD5 into trunk
[strongswan.git] / src / charon / sa / authenticators / eap / eap_md5.h
1 /**
2 * @file eap_md5.h
3 *
4 * @brief Interface of eap_md5_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2007 Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef EAP_MD5_H_
24 #define EAP_MD5_H_
25
26 typedef struct eap_md5_t eap_md5_t;
27
28 #include <sa/authenticators/eap/eap_method.h>
29
30 /**
31 * @brief Implementation of the eap_method_t interface using EAP-MD5 (CHAP).
32 *
33 * @b Constructors:
34 * - eap_md5_create()
35 * - eap_client_create() using eap_method EAP_MD5
36 *
37 * @ingroup eap
38 */
39 struct eap_md5_t {
40
41 /**
42 * Implemented eap_method_t interface.
43 */
44 eap_method_t eap_method_interface;
45 };
46
47 /**
48 * @brief Creates the EAP method EAP-MD5.
49 *
50 * @param server ID of the EAP server
51 * @param peer ID of the EAP client
52 * @return eap_md5_t object
53 *
54 * @ingroup eap
55 */
56 eap_md5_t *eap_create(eap_role_t role,
57 identification_t *server, identification_t *peer);
58
59 #endif /* EAP_MD5_H_ */