345d7abe36cad10f27208b9a07c002d7ca0c4e4a
[strongswan.git] / src / libstrongswan / crypto / crypters / crypter.h
1 /*
2 * Copyright (C) 2005-2006 Martin Willi
3 * Copyright (C) 2005 Jan Hutter
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 crypter crypter
21 * @{ @ingroup crypto
22 */
23
24 #ifndef CRYPTER_H_
25 #define CRYPTER_H_
26
27 typedef enum encryption_algorithm_t encryption_algorithm_t;
28 typedef struct crypter_t crypter_t;
29
30 #include <library.h>
31
32 /**
33 * Encryption algorithm, as in IKEv2 RFC 3.3.2.
34 */
35 enum encryption_algorithm_t {
36 ENCR_UNDEFINED = 1024,
37 ENCR_DES_IV64 = 1,
38 ENCR_DES = 2,
39 ENCR_3DES = 3,
40 ENCR_RC5 = 4,
41 ENCR_IDEA = 5,
42 ENCR_CAST = 6,
43 ENCR_BLOWFISH = 7,
44 ENCR_3IDEA = 8,
45 ENCR_DES_IV32 = 9,
46 ENCR_NULL = 11,
47 ENCR_AES_CBC = 12,
48 ENCR_AES_CTR = 13,
49 ENCR_AES_CCM_ICV8 = 14,
50 ENCR_AES_CCM_ICV12 = 15,
51 ENCR_AES_CCM_ICV16 = 16,
52 ENCR_AES_GCM_ICV8 = 18,
53 ENCR_AES_GCM_ICV12 = 19,
54 ENCR_AES_GCM_ICV16 = 20
55 };
56
57 /**
58 * enum name for encryption_algorithm_t.
59 */
60 extern enum_name_t *encryption_algorithm_names;
61
62 /**
63 * Generic interface for symmetric encryption algorithms.
64 */
65 struct crypter_t {
66
67 /**
68 * Encrypt a chunk of data and allocate space for the encrypted value.
69 *
70 * The length of the iv must equal to get_block_size(), while the length
71 * of data must be a multiple it.
72 * If encrypted is NULL, the encryption is done in-place (overwriting data).
73 *
74 * @param data data to encrypt
75 * @param iv initializing vector
76 * @param encrypted chunk to allocate encrypted data, or NULL
77 */
78 void (*encrypt) (crypter_t *this, chunk_t data, chunk_t iv,
79 chunk_t *encrypted);
80
81 /**
82 * Decrypt a chunk of data and allocate space for the decrypted value.
83 *
84 * The length of the iv must equal to get_block_size(), while the length
85 * of data must be a multiple it.
86 * If decrpyted is NULL, the encryption is done in-place (overwriting data).
87 *
88 * @param data data to decrypt
89 * @param iv initializing vector
90 * @param encrypted chunk to allocate decrypted data, or NULL
91 */
92 void (*decrypt) (crypter_t *this, chunk_t data, chunk_t iv,
93 chunk_t *decrypted);
94
95 /**
96 * Get the block size of the crypto algorithm.
97 *
98 * @return block size in bytes
99 */
100 size_t (*get_block_size) (crypter_t *this);
101
102 /**
103 * Get the key size of the crypto algorithm.
104 *
105 * @return key size in bytes
106 */
107 size_t (*get_key_size) (crypter_t *this);
108
109 /**
110 * Set the key.
111 *
112 * The length of the key must match get_key_size().
113 *
114 * @param key key to set
115 */
116 void (*set_key) (crypter_t *this, chunk_t key);
117
118 /**
119 * Destroys a crypter_t object.
120 */
121 void (*destroy) (crypter_t *this);
122 };
123
124 #endif /*CRYPTER_H_ @} */