13e99d3398974d66992b37f6431c7ffb1c9b933c
[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 ENCR_DES_ECB = 1025
56 };
57
58 /**
59 * enum name for encryption_algorithm_t.
60 */
61 extern enum_name_t *encryption_algorithm_names;
62
63 /**
64 * Generic interface for symmetric encryption algorithms.
65 */
66 struct crypter_t {
67
68 /**
69 * Encrypt a chunk of data and allocate space for the encrypted value.
70 *
71 * The length of the iv must equal to get_block_size(), while the length
72 * of data must be a multiple it.
73 * If encrypted is NULL, the encryption is done in-place (overwriting data).
74 *
75 * @param data data to encrypt
76 * @param iv initializing vector
77 * @param encrypted chunk to allocate encrypted data, or NULL
78 */
79 void (*encrypt) (crypter_t *this, chunk_t data, chunk_t iv,
80 chunk_t *encrypted);
81
82 /**
83 * Decrypt a chunk of data and allocate space for the decrypted value.
84 *
85 * The length of the iv must equal to get_block_size(), while the length
86 * of data must be a multiple it.
87 * If decrpyted is NULL, the encryption is done in-place (overwriting data).
88 *
89 * @param data data to decrypt
90 * @param iv initializing vector
91 * @param encrypted chunk to allocate decrypted data, or NULL
92 */
93 void (*decrypt) (crypter_t *this, chunk_t data, chunk_t iv,
94 chunk_t *decrypted);
95
96 /**
97 * Get the block size of the crypto algorithm.
98 *
99 * @return block size in bytes
100 */
101 size_t (*get_block_size) (crypter_t *this);
102
103 /**
104 * Get the key size of the crypto algorithm.
105 *
106 * @return key size in bytes
107 */
108 size_t (*get_key_size) (crypter_t *this);
109
110 /**
111 * Set the key.
112 *
113 * The length of the key must match get_key_size().
114 *
115 * @param key key to set
116 */
117 void (*set_key) (crypter_t *this, chunk_t key);
118
119 /**
120 * Destroys a crypter_t object.
121 */
122 void (*destroy) (crypter_t *this);
123 };
124
125 #endif /*CRYPTER_H_ @} */