updated Doxyfile
[strongswan.git] / src / libstrongswan / plugins / des / des_crypter.h
1 /*
2 * Copyright (C) 2006-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 des_crypter des_crypter
18 * @{ @ingroup des_p
19 */
20
21 #ifndef DES_CRYPTER_H_
22 #define DES_CRYPTER_H_
23
24 typedef struct des_crypter_t des_crypter_t;
25
26 #include <crypto/crypters/crypter.h>
27
28
29 /**
30 * Class implementing the DES and 3DES encryption algorithms.
31 */
32 struct des_crypter_t {
33
34 /**
35 * The crypter_t interface.
36 */
37 crypter_t crypter_interface;
38 };
39
40 /**
41 * Constructor to create des_crypter_t objects.
42 *
43 * @param algo ENCR_DES for single DES, ENCR_3DES for triple DES
44 * @return des_crypter_t object, NULL if algo not supported
45 */
46 des_crypter_t *des_crypter_create(encryption_algorithm_t algo);
47
48
49 #endif /** DES_CRYPTER_H_ @}*/