updated Doxyfile
[strongswan.git] / src / charon / credentials / sets / auth_info_wrapper.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 * $Id$
16 */
17
18 /**
19 * @defgroup auth_info_wrapper auth_info_wrapper
20 * @{ @ingroup sets
21 */
22
23 #ifndef AUTH_INFO_WRAPPER_H_
24 #define AUTH_INFO_WRAPPER_H_
25
26 #include <credentials/credential_set.h>
27 #include <credentials/auth_info.h>
28
29 typedef struct auth_info_wrapper_t auth_info_wrapper_t;
30
31 /**
32 * A wrapper around auth_info_t to handle it like a credential set.
33 */
34 struct auth_info_wrapper_t {
35
36 /**
37 * implements credential_set_t
38 */
39 credential_set_t set;
40
41 /**
42 * Destroy a auth_info_wrapper instance.
43 */
44 void (*destroy)(auth_info_wrapper_t *this);
45 };
46
47 /**
48 * Create a auth_info_wrapper instance.
49 *
50 * @param auth the wrapped auth info
51 * @return wrapper around auth
52 */
53 auth_info_wrapper_t *auth_info_wrapper_create(auth_info_t *auth);
54
55 #endif /** AUTH_INFO_WRAPPER_H_ @}*/