Add clang target pragma for mixed C/assembly x86-64 implementations
[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
119 /*-- sha1.c --*/
120 void _gcry_sha1_hash_buffer (void *outbuf,
121                              const void *buffer, size_t length);
122 void _gcry_sha1_hash_buffers (void *outbuf,
123                               const gcry_buffer_t *iov, int iovcnt);
124
125 /*-- sha256.c --*/
126 void _gcry_sha256_hash_buffer (void *outbuf,
127                                const void *buffer, size_t length);
128 void _gcry_sha256_hash_buffers (void *outbuf,
129                                 const gcry_buffer_t *iov, int iovcnt);
130
131 /*-- sha512.c --*/
132 void _gcry_sha512_hash_buffer (void *outbuf,
133                                const void *buffer, size_t length);
134 void _gcry_sha512_hash_buffers (void *outbuf,
135                                 const gcry_buffer_t *iov, int iovcnt);
136
137 /*-- sm3.c --*/
138 void _gcry_sm3_hash_buffer (void *outbuf,
139                             const void *buffer, size_t length);
140 void _gcry_sm3_hash_buffers (void *outbuf,
141                              const gcry_buffer_t *iov, int iovcnt);
142
143 /*-- blake2.c --*/
144 gcry_err_code_t _gcry_blake2_init_with_key(void *ctx, unsigned int flags,
145                                            const unsigned char *key,
146                                            size_t keylen, int algo);
147
148 /*-- rijndael.c --*/
149 void _gcry_aes_cfb_enc (void *context, unsigned char *iv,
150                         void *outbuf, const void *inbuf,
151                         size_t nblocks);
152 void _gcry_aes_cfb_dec (void *context, unsigned char *iv,
153                         void *outbuf_arg, const void *inbuf_arg,
154                         size_t nblocks);
155 void _gcry_aes_cbc_enc (void *context, unsigned char *iv,
156                         void *outbuf_arg, const void *inbuf_arg,
157                         size_t nblocks, int cbc_mac);
158 void _gcry_aes_cbc_dec (void *context, unsigned char *iv,
159                         void *outbuf_arg, const void *inbuf_arg,
160                         size_t nblocks);
161 void _gcry_aes_ctr_enc (void *context, unsigned char *ctr,
162                         void *outbuf_arg, const void *inbuf_arg,
163                         size_t nblocks);
164 size_t _gcry_aes_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
165                             const void *inbuf_arg, size_t nblocks, int encrypt);
166 size_t _gcry_aes_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
167                            size_t nblocks);
168 void _gcry_aes_xts_crypt (void *context, unsigned char *tweak,
169                           void *outbuf_arg, const void *inbuf_arg,
170                           size_t nblocks, int encrypt);
171
172 /*-- blowfish.c --*/
173 void _gcry_blowfish_cfb_dec (void *context, unsigned char *iv,
174                              void *outbuf_arg, const void *inbuf_arg,
175                              size_t nblocks);
176
177 void _gcry_blowfish_cbc_dec (void *context, unsigned char *iv,
178                              void *outbuf_arg, const void *inbuf_arg,
179                              size_t nblocks);
180
181 void _gcry_blowfish_ctr_enc (void *context, unsigned char *ctr,
182                              void *outbuf_arg, const void *inbuf_arg,
183                              size_t nblocks);
184
185 /*-- cast5.c --*/
186 void _gcry_cast5_cfb_dec (void *context, unsigned char *iv,
187                           void *outbuf_arg, const void *inbuf_arg,
188                           size_t nblocks);
189
190 void _gcry_cast5_cbc_dec (void *context, unsigned char *iv,
191                           void *outbuf_arg, const void *inbuf_arg,
192                           size_t nblocks);
193
194 void _gcry_cast5_ctr_enc (void *context, unsigned char *ctr,
195                           void *outbuf_arg, const void *inbuf_arg,
196                           size_t nblocks);
197
198 /*-- camellia-glue.c --*/
199 void _gcry_camellia_ctr_enc (void *context, unsigned char *ctr,
200                              void *outbuf_arg, const void *inbuf_arg,
201                              size_t nblocks);
202 void _gcry_camellia_cbc_dec (void *context, unsigned char *iv,
203                              void *outbuf_arg, const void *inbuf_arg,
204                              size_t nblocks);
205 void _gcry_camellia_cfb_dec (void *context, unsigned char *iv,
206                              void *outbuf_arg, const void *inbuf_arg,
207                              size_t nblocks);
208 size_t _gcry_camellia_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
209                                  const void *inbuf_arg, size_t nblocks,
210                                  int encrypt);
211 size_t _gcry_camellia_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
212                                 size_t nblocks);
213
214 /*-- des.c --*/
215 void _gcry_3des_ctr_enc (void *context, unsigned char *ctr,
216                          void *outbuf_arg, const void *inbuf_arg,
217                          size_t nblocks);
218
219 void _gcry_3des_cbc_dec (void *context, unsigned char *iv,
220                          void *outbuf_arg, const void *inbuf_arg,
221                          size_t nblocks);
222
223 void _gcry_3des_cfb_dec (void *context, unsigned char *iv,
224                          void *outbuf_arg, const void *inbuf_arg,
225                          size_t nblocks);
226
227 /*-- serpent.c --*/
228 void _gcry_serpent_ctr_enc (void *context, unsigned char *ctr,
229                             void *outbuf_arg, const void *inbuf_arg,
230                             size_t nblocks);
231 void _gcry_serpent_cbc_dec (void *context, unsigned char *iv,
232                             void *outbuf_arg, const void *inbuf_arg,
233                             size_t nblocks);
234 void _gcry_serpent_cfb_dec (void *context, unsigned char *iv,
235                             void *outbuf_arg, const void *inbuf_arg,
236                             size_t nblocks);
237 size_t _gcry_serpent_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
238                                 const void *inbuf_arg, size_t nblocks,
239                                 int encrypt);
240 size_t _gcry_serpent_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
241                                size_t nblocks);
242
243 /*-- twofish.c --*/
244 void _gcry_twofish_ctr_enc (void *context, unsigned char *ctr,
245                             void *outbuf_arg, const void *inbuf_arg,
246                             size_t nblocks);
247 void _gcry_twofish_cbc_dec (void *context, unsigned char *iv,
248                             void *outbuf_arg, const void *inbuf_arg,
249                             size_t nblocks);
250 void _gcry_twofish_cfb_dec (void *context, unsigned char *iv,
251                             void *outbuf_arg, const void *inbuf_arg,
252                             size_t nblocks);
253 size_t _gcry_twofish_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
254                                 const void *inbuf_arg, size_t nblocks,
255                                 int encrypt);
256 size_t _gcry_twofish_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
257                                size_t nblocks);
258
259 /*-- dsa.c --*/
260 void _gcry_register_pk_dsa_progress (gcry_handler_progress_t cbc, void *cb_data);
261
262 /*-- elgamal.c --*/
263 void _gcry_register_pk_elg_progress (gcry_handler_progress_t cb,
264                                      void *cb_data);
265
266
267 /*-- ecc.c --*/
268 void _gcry_register_pk_ecc_progress (gcry_handler_progress_t cbc,
269                                      void *cb_data);
270
271
272 /*-- primegen.c --*/
273 void _gcry_register_primegen_progress (gcry_handler_progress_t cb,
274                                        void *cb_data);
275
276 /*-- pubkey.c --*/
277
278 /* Declarations for the cipher specifications.  */
279 extern gcry_cipher_spec_t _gcry_cipher_spec_blowfish;
280 extern gcry_cipher_spec_t _gcry_cipher_spec_des;
281 extern gcry_cipher_spec_t _gcry_cipher_spec_tripledes;
282 extern gcry_cipher_spec_t _gcry_cipher_spec_arcfour;
283 extern gcry_cipher_spec_t _gcry_cipher_spec_cast5;
284 extern gcry_cipher_spec_t _gcry_cipher_spec_aes;
285 extern gcry_cipher_spec_t _gcry_cipher_spec_aes192;
286 extern gcry_cipher_spec_t _gcry_cipher_spec_aes256;
287 extern gcry_cipher_spec_t _gcry_cipher_spec_twofish;
288 extern gcry_cipher_spec_t _gcry_cipher_spec_twofish128;
289 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent128;
290 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent192;
291 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent256;
292 extern gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_40;
293 extern gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_128;
294 extern gcry_cipher_spec_t _gcry_cipher_spec_seed;
295 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia128;
296 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia192;
297 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia256;
298 extern gcry_cipher_spec_t _gcry_cipher_spec_idea;
299 extern gcry_cipher_spec_t _gcry_cipher_spec_salsa20;
300 extern gcry_cipher_spec_t _gcry_cipher_spec_salsa20r12;
301 extern gcry_cipher_spec_t _gcry_cipher_spec_gost28147;
302 extern gcry_cipher_spec_t _gcry_cipher_spec_chacha20;
303
304 /* Declarations for the digest specifications.  */
305 extern gcry_md_spec_t _gcry_digest_spec_crc32;
306 extern gcry_md_spec_t _gcry_digest_spec_crc32_rfc1510;
307 extern gcry_md_spec_t _gcry_digest_spec_crc24_rfc2440;
308 extern gcry_md_spec_t _gcry_digest_spec_gost3411_94;
309 extern gcry_md_spec_t _gcry_digest_spec_gost3411_cp;
310 extern gcry_md_spec_t _gcry_digest_spec_stribog_256;
311 extern gcry_md_spec_t _gcry_digest_spec_stribog_512;
312 extern gcry_md_spec_t _gcry_digest_spec_md2;
313 extern gcry_md_spec_t _gcry_digest_spec_md4;
314 extern gcry_md_spec_t _gcry_digest_spec_md5;
315 extern gcry_md_spec_t _gcry_digest_spec_rmd160;
316 extern gcry_md_spec_t _gcry_digest_spec_sha1;
317 extern gcry_md_spec_t _gcry_digest_spec_sha224;
318 extern gcry_md_spec_t _gcry_digest_spec_sha256;
319 extern gcry_md_spec_t _gcry_digest_spec_sha384;
320 extern gcry_md_spec_t _gcry_digest_spec_sha512;
321 extern gcry_md_spec_t _gcry_digest_spec_sha3_224;
322 extern gcry_md_spec_t _gcry_digest_spec_sha3_256;
323 extern gcry_md_spec_t _gcry_digest_spec_sha3_512;
324 extern gcry_md_spec_t _gcry_digest_spec_sha3_384;
325 extern gcry_md_spec_t _gcry_digest_spec_shake128;
326 extern gcry_md_spec_t _gcry_digest_spec_shake256;
327 extern gcry_md_spec_t _gcry_digest_spec_tiger;
328 extern gcry_md_spec_t _gcry_digest_spec_tiger1;
329 extern gcry_md_spec_t _gcry_digest_spec_tiger2;
330 extern gcry_md_spec_t _gcry_digest_spec_whirlpool;
331 extern gcry_md_spec_t _gcry_digest_spec_blake2b_512;
332 extern gcry_md_spec_t _gcry_digest_spec_blake2b_384;
333 extern gcry_md_spec_t _gcry_digest_spec_blake2b_256;
334 extern gcry_md_spec_t _gcry_digest_spec_blake2b_160;
335 extern gcry_md_spec_t _gcry_digest_spec_blake2s_256;
336 extern gcry_md_spec_t _gcry_digest_spec_blake2s_224;
337 extern gcry_md_spec_t _gcry_digest_spec_blake2s_160;
338 extern gcry_md_spec_t _gcry_digest_spec_blake2s_128;
339 extern gcry_md_spec_t _gcry_digest_spec_sm3;
340
341 /* Declarations for the pubkey cipher specifications.  */
342 extern gcry_pk_spec_t _gcry_pubkey_spec_rsa;
343 extern gcry_pk_spec_t _gcry_pubkey_spec_elg;
344 extern gcry_pk_spec_t _gcry_pubkey_spec_elg_e;
345 extern gcry_pk_spec_t _gcry_pubkey_spec_dsa;
346 extern gcry_pk_spec_t _gcry_pubkey_spec_ecc;
347
348
349 #endif /*G10_CIPHER_H*/