Add AES-NI acceleration for AES-XTS
[libgcrypt.git] / src / cipher.h
1 /* cipher.h
2  *      Copyright (C) 1998, 2002, 2003, 2009 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser general Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20 #ifndef G10_CIPHER_H
21 #define G10_CIPHER_H
22
23 #include "gcrypt-int.h"
24
25 #define DBG_CIPHER _gcry_get_debug_flag( 1 )
26
27 #include "../random/random.h"
28
29 #define PUBKEY_FLAG_NO_BLINDING    (1 << 0)
30 #define PUBKEY_FLAG_RFC6979        (1 << 1)
31 #define PUBKEY_FLAG_FIXEDLEN       (1 << 2)
32 #define PUBKEY_FLAG_LEGACYRESULT   (1 << 3)
33 #define PUBKEY_FLAG_RAW_FLAG       (1 << 4)
34 #define PUBKEY_FLAG_TRANSIENT_KEY  (1 << 5)
35 #define PUBKEY_FLAG_USE_X931       (1 << 6)
36 #define PUBKEY_FLAG_USE_FIPS186    (1 << 7)
37 #define PUBKEY_FLAG_USE_FIPS186_2  (1 << 8)
38 #define PUBKEY_FLAG_PARAM          (1 << 9)
39 #define PUBKEY_FLAG_COMP           (1 << 10)
40 #define PUBKEY_FLAG_NOCOMP         (1 << 11)
41 #define PUBKEY_FLAG_EDDSA          (1 << 12)
42 #define PUBKEY_FLAG_GOST           (1 << 13)
43 #define PUBKEY_FLAG_NO_KEYTEST     (1 << 14)
44 #define PUBKEY_FLAG_DJB_TWEAK      (1 << 15)
45
46
47 enum pk_operation
48   {
49     PUBKEY_OP_ENCRYPT,
50     PUBKEY_OP_DECRYPT,
51     PUBKEY_OP_SIGN,
52     PUBKEY_OP_VERIFY
53   };
54
55 enum pk_encoding
56   {
57     PUBKEY_ENC_RAW,
58     PUBKEY_ENC_PKCS1,
59     PUBKEY_ENC_PKCS1_RAW,
60     PUBKEY_ENC_OAEP,
61     PUBKEY_ENC_PSS,
62     PUBKEY_ENC_UNKNOWN
63   };
64
65 struct pk_encoding_ctx
66 {
67   enum pk_operation op;
68   unsigned int nbits;
69
70   enum pk_encoding encoding;
71   int flags;
72
73   int hash_algo;
74
75   /* for OAEP */
76   unsigned char *label;
77   size_t labellen;
78
79   /* for PSS */
80   size_t saltlen;
81
82   int (* verify_cmp) (void *opaque, gcry_mpi_t tmp);
83   void *verify_arg;
84 };
85
86 #define CIPHER_INFO_NO_WEAK_KEY    1
87
88 #include "cipher-proto.h"
89
90 /* The internal encryption modes. */
91 enum gcry_cipher_internal_modes
92   {
93     GCRY_CIPHER_MODE_INTERNAL = 0x10000,
94     GCRY_CIPHER_MODE_CMAC     = 0x10000 + 1   /* Cipher-based MAC. */
95   };
96
97
98 /*-- cipher.c --*/
99 gcry_err_code_t _gcry_cipher_open_internal (gcry_cipher_hd_t *handle,
100                                             int algo, int mode,
101                                             unsigned int flags);
102
103 /*-- cipher-cmac.c --*/
104 gcry_err_code_t _gcry_cipher_cmac_authenticate
105 /*           */ (gcry_cipher_hd_t c, const unsigned char *abuf, size_t abuflen);
106 gcry_err_code_t _gcry_cipher_cmac_get_tag
107 /*           */ (gcry_cipher_hd_t c,
108                  unsigned char *outtag, size_t taglen);
109 gcry_err_code_t _gcry_cipher_cmac_check_tag
110 /*           */ (gcry_cipher_hd_t c,
111                  const unsigned char *intag, size_t taglen);
112 gcry_err_code_t _gcry_cipher_cmac_set_subkeys
113 /*           */ (gcry_cipher_hd_t c);
114
115 /*-- rmd160.c --*/
116 void _gcry_rmd160_hash_buffer (void *outbuf,
117                                const void *buffer, size_t length);
118 /*-- sha1.c --*/
119 void _gcry_sha1_hash_buffer (void *outbuf,
120                              const void *buffer, size_t length);
121 void _gcry_sha1_hash_buffers (void *outbuf,
122                               const gcry_buffer_t *iov, int iovcnt);
123
124 /*-- sha256.c --*/
125 void _gcry_sha256_hash_buffer (void *outbuf,
126                                const void *buffer, size_t length);
127 void _gcry_sha256_hash_buffers (void *outbuf,
128                                 const gcry_buffer_t *iov, int iovcnt);
129
130 /*-- sha512.c --*/
131 void _gcry_sha512_hash_buffer (void *outbuf,
132                                const void *buffer, size_t length);
133 void _gcry_sha512_hash_buffers (void *outbuf,
134                                 const gcry_buffer_t *iov, int iovcnt);
135
136 /*-- sm3.c --*/
137 void _gcry_sm3_hash_buffer (void *outbuf,
138                             const void *buffer, size_t length);
139 void _gcry_sm3_hash_buffers (void *outbuf,
140                              const gcry_buffer_t *iov, int iovcnt);
141
142 /*-- blake2.c --*/
143 gcry_err_code_t _gcry_blake2_init_with_key(void *ctx, unsigned int flags,
144                                            const unsigned char *key,
145                                            size_t keylen, int algo);
146
147 /*-- rijndael.c --*/
148 void _gcry_aes_cfb_enc (void *context, unsigned char *iv,
149                         void *outbuf, const void *inbuf,
150                         size_t nblocks);
151 void _gcry_aes_cfb_dec (void *context, unsigned char *iv,
152                         void *outbuf_arg, const void *inbuf_arg,
153                         size_t nblocks);
154 void _gcry_aes_cbc_enc (void *context, unsigned char *iv,
155                         void *outbuf_arg, const void *inbuf_arg,
156                         size_t nblocks, int cbc_mac);
157 void _gcry_aes_cbc_dec (void *context, unsigned char *iv,
158                         void *outbuf_arg, const void *inbuf_arg,
159                         size_t nblocks);
160 void _gcry_aes_ctr_enc (void *context, unsigned char *ctr,
161                         void *outbuf_arg, const void *inbuf_arg,
162                         size_t nblocks);
163 size_t _gcry_aes_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
164                             const void *inbuf_arg, size_t nblocks, int encrypt);
165 size_t _gcry_aes_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
166                            size_t nblocks);
167 void _gcry_aes_xts_crypt (void *context, unsigned char *tweak,
168                           void *outbuf_arg, const void *inbuf_arg,
169                           size_t nblocks, int encrypt);
170
171 /*-- blowfish.c --*/
172 void _gcry_blowfish_cfb_dec (void *context, unsigned char *iv,
173                              void *outbuf_arg, const void *inbuf_arg,
174                              size_t nblocks);
175
176 void _gcry_blowfish_cbc_dec (void *context, unsigned char *iv,
177                              void *outbuf_arg, const void *inbuf_arg,
178                              size_t nblocks);
179
180 void _gcry_blowfish_ctr_enc (void *context, unsigned char *ctr,
181                              void *outbuf_arg, const void *inbuf_arg,
182                              size_t nblocks);
183
184 /*-- cast5.c --*/
185 void _gcry_cast5_cfb_dec (void *context, unsigned char *iv,
186                           void *outbuf_arg, const void *inbuf_arg,
187                           size_t nblocks);
188
189 void _gcry_cast5_cbc_dec (void *context, unsigned char *iv,
190                           void *outbuf_arg, const void *inbuf_arg,
191                           size_t nblocks);
192
193 void _gcry_cast5_ctr_enc (void *context, unsigned char *ctr,
194                           void *outbuf_arg, const void *inbuf_arg,
195                           size_t nblocks);
196
197 /*-- camellia-glue.c --*/
198 void _gcry_camellia_ctr_enc (void *context, unsigned char *ctr,
199                              void *outbuf_arg, const void *inbuf_arg,
200                              size_t nblocks);
201 void _gcry_camellia_cbc_dec (void *context, unsigned char *iv,
202                              void *outbuf_arg, const void *inbuf_arg,
203                              size_t nblocks);
204 void _gcry_camellia_cfb_dec (void *context, unsigned char *iv,
205                              void *outbuf_arg, const void *inbuf_arg,
206                              size_t nblocks);
207 size_t _gcry_camellia_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
208                                  const void *inbuf_arg, size_t nblocks,
209                                  int encrypt);
210 size_t _gcry_camellia_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
211                                 size_t nblocks);
212
213 /*-- des.c --*/
214 void _gcry_3des_ctr_enc (void *context, unsigned char *ctr,
215                          void *outbuf_arg, const void *inbuf_arg,
216                          size_t nblocks);
217
218 void _gcry_3des_cbc_dec (void *context, unsigned char *iv,
219                          void *outbuf_arg, const void *inbuf_arg,
220                          size_t nblocks);
221
222 void _gcry_3des_cfb_dec (void *context, unsigned char *iv,
223                          void *outbuf_arg, const void *inbuf_arg,
224                          size_t nblocks);
225
226 /*-- serpent.c --*/
227 void _gcry_serpent_ctr_enc (void *context, unsigned char *ctr,
228                             void *outbuf_arg, const void *inbuf_arg,
229                             size_t nblocks);
230 void _gcry_serpent_cbc_dec (void *context, unsigned char *iv,
231                             void *outbuf_arg, const void *inbuf_arg,
232                             size_t nblocks);
233 void _gcry_serpent_cfb_dec (void *context, unsigned char *iv,
234                             void *outbuf_arg, const void *inbuf_arg,
235                             size_t nblocks);
236 size_t _gcry_serpent_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
237                                 const void *inbuf_arg, size_t nblocks,
238                                 int encrypt);
239 size_t _gcry_serpent_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
240                                size_t nblocks);
241
242 /*-- twofish.c --*/
243 void _gcry_twofish_ctr_enc (void *context, unsigned char *ctr,
244                             void *outbuf_arg, const void *inbuf_arg,
245                             size_t nblocks);
246 void _gcry_twofish_cbc_dec (void *context, unsigned char *iv,
247                             void *outbuf_arg, const void *inbuf_arg,
248                             size_t nblocks);
249 void _gcry_twofish_cfb_dec (void *context, unsigned char *iv,
250                             void *outbuf_arg, const void *inbuf_arg,
251                             size_t nblocks);
252 size_t _gcry_twofish_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
253                                 const void *inbuf_arg, size_t nblocks,
254                                 int encrypt);
255 size_t _gcry_twofish_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
256                                size_t nblocks);
257
258 /*-- dsa.c --*/
259 void _gcry_register_pk_dsa_progress (gcry_handler_progress_t cbc, void *cb_data);
260
261 /*-- elgamal.c --*/
262 void _gcry_register_pk_elg_progress (gcry_handler_progress_t cb,
263                                      void *cb_data);
264
265
266 /*-- ecc.c --*/
267 void _gcry_register_pk_ecc_progress (gcry_handler_progress_t cbc,
268                                      void *cb_data);
269
270
271 /*-- primegen.c --*/
272 void _gcry_register_primegen_progress (gcry_handler_progress_t cb,
273                                        void *cb_data);
274
275 /*-- pubkey.c --*/
276
277 /* Declarations for the cipher specifications.  */
278 extern gcry_cipher_spec_t _gcry_cipher_spec_blowfish;
279 extern gcry_cipher_spec_t _gcry_cipher_spec_des;
280 extern gcry_cipher_spec_t _gcry_cipher_spec_tripledes;
281 extern gcry_cipher_spec_t _gcry_cipher_spec_arcfour;
282 extern gcry_cipher_spec_t _gcry_cipher_spec_cast5;
283 extern gcry_cipher_spec_t _gcry_cipher_spec_aes;
284 extern gcry_cipher_spec_t _gcry_cipher_spec_aes192;
285 extern gcry_cipher_spec_t _gcry_cipher_spec_aes256;
286 extern gcry_cipher_spec_t _gcry_cipher_spec_twofish;
287 extern gcry_cipher_spec_t _gcry_cipher_spec_twofish128;
288 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent128;
289 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent192;
290 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent256;
291 extern gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_40;
292 extern gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_128;
293 extern gcry_cipher_spec_t _gcry_cipher_spec_seed;
294 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia128;
295 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia192;
296 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia256;
297 extern gcry_cipher_spec_t _gcry_cipher_spec_idea;
298 extern gcry_cipher_spec_t _gcry_cipher_spec_salsa20;
299 extern gcry_cipher_spec_t _gcry_cipher_spec_salsa20r12;
300 extern gcry_cipher_spec_t _gcry_cipher_spec_gost28147;
301 extern gcry_cipher_spec_t _gcry_cipher_spec_chacha20;
302
303 /* Declarations for the digest specifications.  */
304 extern gcry_md_spec_t _gcry_digest_spec_crc32;
305 extern gcry_md_spec_t _gcry_digest_spec_crc32_rfc1510;
306 extern gcry_md_spec_t _gcry_digest_spec_crc24_rfc2440;
307 extern gcry_md_spec_t _gcry_digest_spec_gost3411_94;
308 extern gcry_md_spec_t _gcry_digest_spec_gost3411_cp;
309 extern gcry_md_spec_t _gcry_digest_spec_stribog_256;
310 extern gcry_md_spec_t _gcry_digest_spec_stribog_512;
311 extern gcry_md_spec_t _gcry_digest_spec_md2;
312 extern gcry_md_spec_t _gcry_digest_spec_md4;
313 extern gcry_md_spec_t _gcry_digest_spec_md5;
314 extern gcry_md_spec_t _gcry_digest_spec_rmd160;
315 extern gcry_md_spec_t _gcry_digest_spec_sha1;
316 extern gcry_md_spec_t _gcry_digest_spec_sha224;
317 extern gcry_md_spec_t _gcry_digest_spec_sha256;
318 extern gcry_md_spec_t _gcry_digest_spec_sha384;
319 extern gcry_md_spec_t _gcry_digest_spec_sha512;
320 extern gcry_md_spec_t _gcry_digest_spec_sha3_224;
321 extern gcry_md_spec_t _gcry_digest_spec_sha3_256;
322 extern gcry_md_spec_t _gcry_digest_spec_sha3_512;
323 extern gcry_md_spec_t _gcry_digest_spec_sha3_384;
324 extern gcry_md_spec_t _gcry_digest_spec_shake128;
325 extern gcry_md_spec_t _gcry_digest_spec_shake256;
326 extern gcry_md_spec_t _gcry_digest_spec_tiger;
327 extern gcry_md_spec_t _gcry_digest_spec_tiger1;
328 extern gcry_md_spec_t _gcry_digest_spec_tiger2;
329 extern gcry_md_spec_t _gcry_digest_spec_whirlpool;
330 extern gcry_md_spec_t _gcry_digest_spec_blake2b_512;
331 extern gcry_md_spec_t _gcry_digest_spec_blake2b_384;
332 extern gcry_md_spec_t _gcry_digest_spec_blake2b_256;
333 extern gcry_md_spec_t _gcry_digest_spec_blake2b_160;
334 extern gcry_md_spec_t _gcry_digest_spec_blake2s_256;
335 extern gcry_md_spec_t _gcry_digest_spec_blake2s_224;
336 extern gcry_md_spec_t _gcry_digest_spec_blake2s_160;
337 extern gcry_md_spec_t _gcry_digest_spec_blake2s_128;
338 extern gcry_md_spec_t _gcry_digest_spec_sm3;
339
340 /* Declarations for the pubkey cipher specifications.  */
341 extern gcry_pk_spec_t _gcry_pubkey_spec_rsa;
342 extern gcry_pk_spec_t _gcry_pubkey_spec_elg;
343 extern gcry_pk_spec_t _gcry_pubkey_spec_elg_e;
344 extern gcry_pk_spec_t _gcry_pubkey_spec_dsa;
345 extern gcry_pk_spec_t _gcry_pubkey_spec_ecc;
346
347
348 #endif /*G10_CIPHER_H*/