Some Doxygen fixes.
[strongswan.git] / src / libcharon / plugins / eap_tls / eap_tls.h
1 /*
2 * Copyright (C) 2010 Martin Willi
3 * Copyright (C) 2010 revosec AG
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_tls_i eap_tls
18 * @{ @ingroup eap_tls
19 */
20
21 #ifndef EAP_TLS_H_
22 #define EAP_TLS_H_
23
24 typedef struct eap_tls_t eap_tls_t;
25
26 #include <sa/authenticators/eap/eap_method.h>
27
28 /**
29 * Implementation of eap_method_t using EAP-TLS.
30 */
31 struct eap_tls_t {
32
33 /**
34 * Implements eap_method_t interface.
35 */
36 eap_method_t eap_method;
37 };
38
39 /**
40 * Creates the EAP method EAP-TLS acting as server.
41 *
42 * @param server ID of the EAP server
43 * @param peer ID of the EAP client
44 * @return eap_tls_t object
45 */
46 eap_tls_t *eap_tls_create_server(identification_t *server,
47 identification_t *peer);
48
49 /**
50 * Creates the EAP method EAP-TLS acting as peer.
51 *
52 * @param server ID of the EAP server
53 * @param peer ID of the EAP client
54 * @return eap_tls_t object
55 */
56 eap_tls_t *eap_tls_create_peer(identification_t *server,
57 identification_t *peer);
58
59 #endif /** EAP_TLS_H_ @}*/