Added a EAP-SIM/AKA backend reading triplets/quintuplets from a SQL database
[strongswan.git] / src / libcharon / plugins / eap_simaka_sql / eap_simaka_sql_card.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_simaka_sql_card eap_simaka_sql_card
18 * @{ @ingroup eap_simaka_sql
19 */
20
21 #ifndef EAP_SIMAKA_SQL_CARD_H_
22 #define EAP_SIMAKA_SQL_CARD_H_
23
24 #include <database/database.h>
25 #include <sa/authenticators/eap/sim_manager.h>
26
27 typedef struct eap_simaka_sql_card_t eap_simaka_sql_card_t;
28
29 /**
30 * SIM card implementation using a triplet/quintuplet database backend.
31 */
32 struct eap_simaka_sql_card_t {
33
34 /**
35 * Implements sim_card_t interface
36 */
37 sim_card_t card;
38
39 /**
40 * Destroy a eap_simaka_sql_card_t.
41 */
42 void (*destroy)(eap_simaka_sql_card_t *this);
43 };
44
45 /**
46 * Create a eap_simaka_sql_card instance.
47 *
48 * @param db triplet/quintuplet database
49 * @param remove_used TRUE to remove used triplets/quintuplets from db
50 */
51 eap_simaka_sql_card_t *eap_simaka_sql_card_create(database_t *db,
52 bool remove_used);
53
54 #endif /** EAP_SIMAKA_SQL_CARD_H_ @}*/