c4b306adbe73f54779ad9333f3dfd474a19c6e04
[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 /*-- rijndael.c --*/
125 void _gcry_aes_cfb_enc (void *context, unsigned char *iv,
126                         void *outbuf, const void *inbuf,
127                         size_t nblocks);
128 void _gcry_aes_cfb_dec (void *context, unsigned char *iv,
129                         void *outbuf_arg, const void *inbuf_arg,
130                         size_t nblocks);
131 void _gcry_aes_cbc_enc (void *context, unsigned char *iv,
132                         void *outbuf_arg, const void *inbuf_arg,
133                         size_t nblocks, int cbc_mac);
134 void _gcry_aes_cbc_dec (void *context, unsigned char *iv,
135                         void *outbuf_arg, const void *inbuf_arg,
136                         size_t nblocks);
137 void _gcry_aes_ctr_enc (void *context, unsigned char *ctr,
138                         void *outbuf_arg, const void *inbuf_arg,
139                         size_t nblocks);
140 size_t _gcry_aes_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
141                             const void *inbuf_arg, size_t nblocks, int encrypt);
142 size_t _gcry_aes_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
143                            size_t nblocks);
144
145 /*-- blowfish.c --*/
146 void _gcry_blowfish_cfb_dec (void *context, unsigned char *iv,
147                              void *outbuf_arg, const void *inbuf_arg,
148                              size_t nblocks);
149
150 void _gcry_blowfish_cbc_dec (void *context, unsigned char *iv,
151                              void *outbuf_arg, const void *inbuf_arg,
152                              size_t nblocks);
153
154 void _gcry_blowfish_ctr_enc (void *context, unsigned char *ctr,
155                              void *outbuf_arg, const void *inbuf_arg,
156                              size_t nblocks);
157
158 /*-- cast5.c --*/
159 void _gcry_cast5_cfb_dec (void *context, unsigned char *iv,
160                           void *outbuf_arg, const void *inbuf_arg,
161                           size_t nblocks);
162
163 void _gcry_cast5_cbc_dec (void *context, unsigned char *iv,
164                           void *outbuf_arg, const void *inbuf_arg,
165                           size_t nblocks);
166
167 void _gcry_cast5_ctr_enc (void *context, unsigned char *ctr,
168                           void *outbuf_arg, const void *inbuf_arg,
169                           size_t nblocks);
170
171 /*-- camellia-glue.c --*/
172 void _gcry_camellia_ctr_enc (void *context, unsigned char *ctr,
173                              void *outbuf_arg, const void *inbuf_arg,
174                              size_t nblocks);
175 void _gcry_camellia_cbc_dec (void *context, unsigned char *iv,
176                              void *outbuf_arg, const void *inbuf_arg,
177                              size_t nblocks);
178 void _gcry_camellia_cfb_dec (void *context, unsigned char *iv,
179                              void *outbuf_arg, const void *inbuf_arg,
180                              size_t nblocks);
181 size_t _gcry_camellia_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
182                                  const void *inbuf_arg, size_t nblocks,
183                                  int encrypt);
184 size_t _gcry_camellia_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
185                                 size_t nblocks);
186
187 /*-- des.c --*/
188 void _gcry_3des_ctr_enc (void *context, unsigned char *ctr,
189                          void *outbuf_arg, const void *inbuf_arg,
190                          size_t nblocks);
191
192 void _gcry_3des_cbc_dec (void *context, unsigned char *iv,
193                          void *outbuf_arg, const void *inbuf_arg,
194                          size_t nblocks);
195
196 void _gcry_3des_cfb_dec (void *context, unsigned char *iv,
197                          void *outbuf_arg, const void *inbuf_arg,
198                          size_t nblocks);
199
200 /*-- serpent.c --*/
201 void _gcry_serpent_ctr_enc (void *context, unsigned char *ctr,
202                             void *outbuf_arg, const void *inbuf_arg,
203                             size_t nblocks);
204 void _gcry_serpent_cbc_dec (void *context, unsigned char *iv,
205                             void *outbuf_arg, const void *inbuf_arg,
206                             size_t nblocks);
207 void _gcry_serpent_cfb_dec (void *context, unsigned char *iv,
208                             void *outbuf_arg, const void *inbuf_arg,
209                             size_t nblocks);
210 size_t _gcry_serpent_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
211                                 const void *inbuf_arg, size_t nblocks,
212                                 int encrypt);
213 size_t _gcry_serpent_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
214                                size_t nblocks);
215
216 /*-- twofish.c --*/
217 void _gcry_twofish_ctr_enc (void *context, unsigned char *ctr,
218                             void *outbuf_arg, const void *inbuf_arg,
219                             size_t nblocks);
220 void _gcry_twofish_cbc_dec (void *context, unsigned char *iv,
221                             void *outbuf_arg, const void *inbuf_arg,
222                             size_t nblocks);
223 void _gcry_twofish_cfb_dec (void *context, unsigned char *iv,
224                             void *outbuf_arg, const void *inbuf_arg,
225                             size_t nblocks);
226 size_t _gcry_twofish_ocb_crypt (gcry_cipher_hd_t c, void *outbuf_arg,
227                                 const void *inbuf_arg, size_t nblocks,
228                                 int encrypt);
229 size_t _gcry_twofish_ocb_auth (gcry_cipher_hd_t c, const void *abuf_arg,
230                                size_t nblocks);
231
232 /*-- dsa.c --*/
233 void _gcry_register_pk_dsa_progress (gcry_handler_progress_t cbc, void *cb_data);
234
235 /*-- elgamal.c --*/
236 void _gcry_register_pk_elg_progress (gcry_handler_progress_t cb,
237                                      void *cb_data);
238
239
240 /*-- ecc.c --*/
241 void _gcry_register_pk_ecc_progress (gcry_handler_progress_t cbc,
242                                      void *cb_data);
243
244
245 /*-- primegen.c --*/
246 void _gcry_register_primegen_progress (gcry_handler_progress_t cb,
247                                        void *cb_data);
248
249 /*-- pubkey.c --*/
250
251 /* Declarations for the cipher specifications.  */
252 extern gcry_cipher_spec_t _gcry_cipher_spec_blowfish;
253 extern gcry_cipher_spec_t _gcry_cipher_spec_des;
254 extern gcry_cipher_spec_t _gcry_cipher_spec_tripledes;
255 extern gcry_cipher_spec_t _gcry_cipher_spec_arcfour;
256 extern gcry_cipher_spec_t _gcry_cipher_spec_cast5;
257 extern gcry_cipher_spec_t _gcry_cipher_spec_aes;
258 extern gcry_cipher_spec_t _gcry_cipher_spec_aes192;
259 extern gcry_cipher_spec_t _gcry_cipher_spec_aes256;
260 extern gcry_cipher_spec_t _gcry_cipher_spec_twofish;
261 extern gcry_cipher_spec_t _gcry_cipher_spec_twofish128;
262 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent128;
263 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent192;
264 extern gcry_cipher_spec_t _gcry_cipher_spec_serpent256;
265 extern gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_40;
266 extern gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_128;
267 extern gcry_cipher_spec_t _gcry_cipher_spec_seed;
268 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia128;
269 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia192;
270 extern gcry_cipher_spec_t _gcry_cipher_spec_camellia256;
271 extern gcry_cipher_spec_t _gcry_cipher_spec_idea;
272 extern gcry_cipher_spec_t _gcry_cipher_spec_salsa20;
273 extern gcry_cipher_spec_t _gcry_cipher_spec_salsa20r12;
274 extern gcry_cipher_spec_t _gcry_cipher_spec_gost28147;
275 extern gcry_cipher_spec_t _gcry_cipher_spec_chacha20;
276
277 /* Declarations for the digest specifications.  */
278 extern gcry_md_spec_t _gcry_digest_spec_crc32;
279 extern gcry_md_spec_t _gcry_digest_spec_crc32_rfc1510;
280 extern gcry_md_spec_t _gcry_digest_spec_crc24_rfc2440;
281 extern gcry_md_spec_t _gcry_digest_spec_gost3411_94;
282 extern gcry_md_spec_t _gcry_digest_spec_gost3411_cp;
283 extern gcry_md_spec_t _gcry_digest_spec_stribog_256;
284 extern gcry_md_spec_t _gcry_digest_spec_stribog_512;
285 extern gcry_md_spec_t _gcry_digest_spec_md2;
286 extern gcry_md_spec_t _gcry_digest_spec_md4;
287 extern gcry_md_spec_t _gcry_digest_spec_md5;
288 extern gcry_md_spec_t _gcry_digest_spec_rmd160;
289 extern gcry_md_spec_t _gcry_digest_spec_sha1;
290 extern gcry_md_spec_t _gcry_digest_spec_sha224;
291 extern gcry_md_spec_t _gcry_digest_spec_sha256;
292 extern gcry_md_spec_t _gcry_digest_spec_sha384;
293 extern gcry_md_spec_t _gcry_digest_spec_sha512;
294 extern gcry_md_spec_t _gcry_digest_spec_sha3_224;
295 extern gcry_md_spec_t _gcry_digest_spec_sha3_256;
296 extern gcry_md_spec_t _gcry_digest_spec_sha3_512;
297 extern gcry_md_spec_t _gcry_digest_spec_sha3_384;
298 extern gcry_md_spec_t _gcry_digest_spec_shake128;
299 extern gcry_md_spec_t _gcry_digest_spec_shake256;
300 extern gcry_md_spec_t _gcry_digest_spec_tiger;
301 extern gcry_md_spec_t _gcry_digest_spec_tiger1;
302 extern gcry_md_spec_t _gcry_digest_spec_tiger2;
303 extern gcry_md_spec_t _gcry_digest_spec_whirlpool;
304
305 /* Declarations for the pubkey cipher specifications.  */
306 extern gcry_pk_spec_t _gcry_pubkey_spec_rsa;
307 extern gcry_pk_spec_t _gcry_pubkey_spec_elg;
308 extern gcry_pk_spec_t _gcry_pubkey_spec_elg_e;
309 extern gcry_pk_spec_t _gcry_pubkey_spec_dsa;
310 extern gcry_pk_spec_t _gcry_pubkey_spec_ecc;
311
312
313 #endif /*G10_CIPHER_H*/