updated Doxyfile
[strongswan.git] / src / charon / sa / authenticators / pubkey_authenticator.h
1 /*
2 * Copyright (C) 2008 Tobias Brunner
3 * Copyright (C) 2006 Martin Willi
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 *
16 * $Id$
17 */
18
19 /**
20 * @defgroup pubkey_authenticator pubkey_authenticator
21 * @{ @ingroup authenticators
22 */
23
24 #ifndef PUBKEY_AUTHENTICATOR_H_
25 #define PUBKEY_AUTHENTICATOR_H_
26
27 typedef struct pubkey_authenticator_t pubkey_authenticator_t;
28
29 #include <sa/authenticators/authenticator.h>
30
31 /**
32 * Implementation of the authenticator_t interface using AUTH_PUBKEY.
33 */
34 struct pubkey_authenticator_t {
35
36 /**
37 * Implemented authenticator_t interface.
38 */
39 authenticator_t authenticator_interface;
40 };
41
42 /**
43 * Creates an authenticator for AUTH_PUBKEY.
44 *
45 * @param ike_sa associated ike_sa
46 * @return pubkey_authenticator_t object
47 */
48 pubkey_authenticator_t *pubkey_authenticator_create(ike_sa_t *ike_sa);
49
50 #endif /** PUBKEY_AUTHENTICATOR_H_ @}*/