Moving charon to libcharon.
[strongswan.git] / src / libcharon / plugins / eap_sim_file / eap_sim_file_triplets.h
1 /*
2 * Copyright (C) 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_file_triplets eap_sim_file_triplets
18 * @{ @ingroup eap_sim_file
19 */
20
21 #ifndef EAP_SIM_FILE_TRIPLETS_H_
22 #define EAP_SIM_FILE_TRIPLETS_H_
23
24 #include <sa/authenticators/eap/sim_manager.h>
25
26 typedef struct eap_sim_file_triplets_t eap_sim_file_triplets_t;
27
28 /**
29 * Reads triplets from a triplets.dat file.
30 *
31 * The file is in freeradius triplet file syntax:
32 * http://www.freeradius.org/radiusd/doc/rlm_sim_triplets
33 */
34 struct eap_sim_file_triplets_t {
35
36 /**
37 * Create an enumerator over the file's triplets.
38 *
39 * @return enumerator over (identity, rand, sres, kc)
40 */
41 enumerator_t* (*create_enumerator)(eap_sim_file_triplets_t *this);
42
43 /**
44 * Destroy a eap_sim_file_triplets_t.
45 */
46 void (*destroy)(eap_sim_file_triplets_t *this);
47 };
48
49 /**
50 * Create a eap_sim_file_triplets instance.
51 *
52 * @param file triplet file to read from
53 */
54 eap_sim_file_triplets_t *eap_sim_file_triplets_create(char *file);
55
56 #endif /** EAP_SIM_FILE_TRIPLETS_H_ @}*/