Add OCB bulk crypt/auth functions for AES/AES-NI
[libgcrypt.git] / cipher / cipher.c
1 /* cipher.c  -  cipher dispatcher
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
3  *               2005, 2007, 2008, 2009, 2011 Free Software Foundation, Inc.
4  * Copyright (C) 2013 g10 Code GmbH
5  *
6  * This file is part of Libgcrypt.
7  *
8  * Libgcrypt is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser general Public License as
10  * published by the Free Software Foundation; either version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * Libgcrypt is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27
28 #include "g10lib.h"
29 #include "cipher.h"
30 #include "./cipher-internal.h"
31
32
33 /* This is the list of the default ciphers, which are included in
34    libgcrypt.  */
35 static gcry_cipher_spec_t *cipher_list[] =
36   {
37 #if USE_BLOWFISH
38      &_gcry_cipher_spec_blowfish,
39 #endif
40 #if USE_DES
41      &_gcry_cipher_spec_des,
42      &_gcry_cipher_spec_tripledes,
43 #endif
44 #if USE_ARCFOUR
45      &_gcry_cipher_spec_arcfour,
46 #endif
47 #if USE_CAST5
48      &_gcry_cipher_spec_cast5,
49 #endif
50 #if USE_AES
51      &_gcry_cipher_spec_aes,
52      &_gcry_cipher_spec_aes192,
53      &_gcry_cipher_spec_aes256,
54 #endif
55 #if USE_TWOFISH
56      &_gcry_cipher_spec_twofish,
57      &_gcry_cipher_spec_twofish128,
58 #endif
59 #if USE_SERPENT
60      &_gcry_cipher_spec_serpent128,
61      &_gcry_cipher_spec_serpent192,
62      &_gcry_cipher_spec_serpent256,
63 #endif
64 #if USE_RFC2268
65      &_gcry_cipher_spec_rfc2268_40,
66      &_gcry_cipher_spec_rfc2268_128,
67 #endif
68 #if USE_SEED
69      &_gcry_cipher_spec_seed,
70 #endif
71 #if USE_CAMELLIA
72      &_gcry_cipher_spec_camellia128,
73      &_gcry_cipher_spec_camellia192,
74      &_gcry_cipher_spec_camellia256,
75 #endif
76 #ifdef USE_IDEA
77      &_gcry_cipher_spec_idea,
78 #endif
79 #if USE_SALSA20
80      &_gcry_cipher_spec_salsa20,
81      &_gcry_cipher_spec_salsa20r12,
82 #endif
83 #if USE_GOST28147
84      &_gcry_cipher_spec_gost28147,
85 #endif
86 #if USE_CHACHA20
87      &_gcry_cipher_spec_chacha20,
88 #endif
89     NULL
90   };
91
92
93
94 \f
95 static int
96 map_algo (int algo)
97 {
98   return algo;
99 }
100
101
102 /* Return the spec structure for the cipher algorithm ALGO.  For
103    an unknown algorithm NULL is returned.  */
104 static gcry_cipher_spec_t *
105 spec_from_algo (int algo)
106 {
107   int idx;
108   gcry_cipher_spec_t *spec;
109
110   algo = map_algo (algo);
111
112   for (idx = 0; (spec = cipher_list[idx]); idx++)
113     if (algo == spec->algo)
114       return spec;
115   return NULL;
116 }
117
118
119 /* Lookup a cipher's spec by its name.  */
120 static gcry_cipher_spec_t *
121 spec_from_name (const char *name)
122 {
123   gcry_cipher_spec_t *spec;
124   int idx;
125   const char **aliases;
126
127   for (idx=0; (spec = cipher_list[idx]); idx++)
128     {
129       if (!stricmp (name, spec->name))
130         return spec;
131       if (spec->aliases)
132         {
133           for (aliases = spec->aliases; *aliases; aliases++)
134             if (!stricmp (name, *aliases))
135               return spec;
136         }
137     }
138
139   return NULL;
140 }
141
142
143 /* Lookup a cipher's spec by its OID.  */
144 static gcry_cipher_spec_t *
145 spec_from_oid (const char *oid)
146 {
147   gcry_cipher_spec_t *spec;
148   gcry_cipher_oid_spec_t *oid_specs;
149   int idx, j;
150
151   for (idx=0; (spec = cipher_list[idx]); idx++)
152     {
153       oid_specs = spec->oids;
154       if (oid_specs)
155         {
156           for (j = 0; oid_specs[j].oid; j++)
157             if (!stricmp (oid, oid_specs[j].oid))
158               return spec;
159         }
160     }
161
162   return NULL;
163 }
164
165
166 /* Locate the OID in the oid table and return the spec or NULL if not
167    found.  An optional "oid." or "OID." prefix in OID is ignored, the
168    OID is expected to be in standard IETF dotted notation.  A pointer
169    to the OID specification of the module implementing this algorithm
170    is return in OID_SPEC unless passed as NULL.*/
171 static gcry_cipher_spec_t *
172 search_oid (const char *oid, gcry_cipher_oid_spec_t *oid_spec)
173 {
174   gcry_cipher_spec_t *spec;
175   int i;
176
177   if (oid && ((! strncmp (oid, "oid.", 4))
178               || (! strncmp (oid, "OID.", 4))))
179     oid += 4;
180
181   spec = spec_from_oid (oid);
182   if (spec && spec->oids)
183     {
184       for (i = 0; spec->oids[i].oid; i++)
185         if (!stricmp (oid, spec->oids[i].oid))
186           {
187             if (oid_spec)
188               *oid_spec = spec->oids[i];
189             return spec;
190           }
191     }
192
193   return NULL;
194 }
195
196
197 /* Map STRING to the cipher algorithm identifier.  Returns the
198    algorithm ID of the cipher for the given name or 0 if the name is
199    not known.  It is valid to pass NULL for STRING which results in a
200    return value of 0. */
201 int
202 _gcry_cipher_map_name (const char *string)
203 {
204   gcry_cipher_spec_t *spec;
205
206   if (!string)
207     return 0;
208
209   /* If the string starts with a digit (optionally prefixed with
210      either "OID." or "oid."), we first look into our table of ASN.1
211      object identifiers to figure out the algorithm */
212
213   spec = search_oid (string, NULL);
214   if (spec)
215     return spec->algo;
216
217   spec = spec_from_name (string);
218   if (spec)
219     return spec->algo;
220
221   return 0;
222 }
223
224
225 /* Given a STRING with an OID in dotted decimal notation, this
226    function returns the cipher mode (GCRY_CIPHER_MODE_*) associated
227    with that OID or 0 if no mode is known.  Passing NULL for string
228    yields a return value of 0. */
229 int
230 _gcry_cipher_mode_from_oid (const char *string)
231 {
232   gcry_cipher_spec_t *spec;
233   gcry_cipher_oid_spec_t oid_spec;
234
235   if (!string)
236     return 0;
237
238   spec = search_oid (string, &oid_spec);
239   if (spec)
240     return oid_spec.mode;
241
242   return 0;
243 }
244
245
246 /* Map the cipher algorithm identifier ALGORITHM to a string
247    representing this algorithm.  This string is the default name as
248    used by Libgcrypt.  A "?" is returned for an unknown algorithm.
249    NULL is never returned. */
250 const char *
251 _gcry_cipher_algo_name (int algorithm)
252 {
253   gcry_cipher_spec_t *spec;
254
255   spec = spec_from_algo (algorithm);
256   return spec? spec->name : "?";
257 }
258
259
260 /* Flag the cipher algorithm with the identifier ALGORITHM as
261    disabled.  There is no error return, the function does nothing for
262    unknown algorithms.  Disabled algorithms are virtually not
263    available in Libgcrypt.  This is not thread safe and should thus be
264    called early. */
265 static void
266 disable_cipher_algo (int algo)
267 {
268   gcry_cipher_spec_t *spec = spec_from_algo (algo);
269
270   if (spec)
271     spec->flags.disabled = 1;
272 }
273
274
275 /* Return 0 if the cipher algorithm with identifier ALGORITHM is
276    available. Returns a basic error code value if it is not
277    available.  */
278 static gcry_err_code_t
279 check_cipher_algo (int algorithm)
280 {
281   gcry_cipher_spec_t *spec;
282
283   spec = spec_from_algo (algorithm);
284   if (spec && !spec->flags.disabled)
285     return 0;
286
287   return GPG_ERR_CIPHER_ALGO;
288 }
289
290
291 /* Return the standard length in bits of the key for the cipher
292    algorithm with the identifier ALGORITHM.  */
293 static unsigned int
294 cipher_get_keylen (int algorithm)
295 {
296   gcry_cipher_spec_t *spec;
297   unsigned len = 0;
298
299   spec = spec_from_algo (algorithm);
300   if (spec)
301     {
302       len = spec->keylen;
303       if (!len)
304         log_bug ("cipher %d w/o key length\n", algorithm);
305     }
306
307   return len;
308 }
309
310
311 /* Return the block length of the cipher algorithm with the identifier
312    ALGORITHM.  This function return 0 for an invalid algorithm.  */
313 static unsigned int
314 cipher_get_blocksize (int algorithm)
315 {
316   gcry_cipher_spec_t *spec;
317   unsigned len = 0;
318
319   spec = spec_from_algo (algorithm);
320   if (spec)
321     {
322       len = spec->blocksize;
323       if (!len)
324         log_bug ("cipher %d w/o blocksize\n", algorithm);
325     }
326
327   return len;
328 }
329
330
331 /*
332    Open a cipher handle for use with cipher algorithm ALGORITHM, using
333    the cipher mode MODE (one of the GCRY_CIPHER_MODE_*) and return a
334    handle in HANDLE.  Put NULL into HANDLE and return an error code if
335    something goes wrong.  FLAGS may be used to modify the
336    operation.  The defined flags are:
337
338    GCRY_CIPHER_SECURE:  allocate all internal buffers in secure memory.
339    GCRY_CIPHER_ENABLE_SYNC:  Enable the sync operation as used in OpenPGP.
340    GCRY_CIPHER_CBC_CTS:  Enable CTS mode.
341    GCRY_CIPHER_CBC_MAC:  Enable MAC mode.
342
343    Values for these flags may be combined using OR.
344  */
345 gcry_err_code_t
346 _gcry_cipher_open (gcry_cipher_hd_t *handle,
347                    int algo, int mode, unsigned int flags)
348 {
349   gcry_err_code_t rc;
350   gcry_cipher_hd_t h = NULL;
351
352   if (mode >= GCRY_CIPHER_MODE_INTERNAL)
353     rc = GPG_ERR_INV_CIPHER_MODE;
354   else
355     rc = _gcry_cipher_open_internal (&h, algo, mode, flags);
356
357   *handle = rc ? NULL : h;
358
359   return rc;
360 }
361
362
363 gcry_err_code_t
364 _gcry_cipher_open_internal (gcry_cipher_hd_t *handle,
365                             int algo, int mode, unsigned int flags)
366 {
367   int secure = (flags & GCRY_CIPHER_SECURE);
368   gcry_cipher_spec_t *spec;
369   gcry_cipher_hd_t h = NULL;
370   gcry_err_code_t err;
371
372   /* If the application missed to call the random poll function, we do
373      it here to ensure that it is used once in a while. */
374   _gcry_fast_random_poll ();
375
376   spec = spec_from_algo (algo);
377   if (!spec)
378     err = GPG_ERR_CIPHER_ALGO;
379   else if (spec->flags.disabled)
380     err = GPG_ERR_CIPHER_ALGO;
381   else
382     err = 0;
383
384   /* check flags */
385   if ((! err)
386       && ((flags & ~(0
387                      | GCRY_CIPHER_SECURE
388                      | GCRY_CIPHER_ENABLE_SYNC
389                      | GCRY_CIPHER_CBC_CTS
390                      | GCRY_CIPHER_CBC_MAC))
391           || (flags & GCRY_CIPHER_CBC_CTS & GCRY_CIPHER_CBC_MAC)))
392     err = GPG_ERR_CIPHER_ALGO;
393
394   /* check that a valid mode has been requested */
395   if (! err)
396     switch (mode)
397       {
398       case GCRY_CIPHER_MODE_CCM:
399 #ifdef HAVE_U64_TYPEDEF
400         if (spec->blocksize != GCRY_CCM_BLOCK_LEN)
401           err = GPG_ERR_INV_CIPHER_MODE;
402         if (!spec->encrypt || !spec->decrypt)
403           err = GPG_ERR_INV_CIPHER_MODE;
404         break;
405 #else
406         err = GPG_ERR_NOT_SUPPORTED;
407 #endif
408
409       case GCRY_CIPHER_MODE_ECB:
410       case GCRY_CIPHER_MODE_CBC:
411       case GCRY_CIPHER_MODE_CFB:
412       case GCRY_CIPHER_MODE_OFB:
413       case GCRY_CIPHER_MODE_CTR:
414       case GCRY_CIPHER_MODE_AESWRAP:
415       case GCRY_CIPHER_MODE_CMAC:
416       case GCRY_CIPHER_MODE_GCM:
417         if (!spec->encrypt || !spec->decrypt)
418           err = GPG_ERR_INV_CIPHER_MODE;
419         break;
420
421       case GCRY_CIPHER_MODE_POLY1305:
422         if (!spec->stencrypt || !spec->stdecrypt || !spec->setiv)
423           err = GPG_ERR_INV_CIPHER_MODE;
424         else if (spec->algo != GCRY_CIPHER_CHACHA20)
425           err = GPG_ERR_INV_CIPHER_MODE;
426         break;
427
428       case GCRY_CIPHER_MODE_OCB:
429         /* Note that our implementation allows only for 128 bit block
430            length algorithms.  Lower block lengths would be possible
431            but we do not implement them because they limit the
432            security too much.  */
433         if (!spec->encrypt || !spec->decrypt)
434           err = GPG_ERR_INV_CIPHER_MODE;
435         else if (spec->blocksize != (128/8))
436           err = GPG_ERR_INV_CIPHER_MODE;
437         break;
438
439       case GCRY_CIPHER_MODE_STREAM:
440         if (!spec->stencrypt || !spec->stdecrypt)
441           err = GPG_ERR_INV_CIPHER_MODE;
442         break;
443
444       case GCRY_CIPHER_MODE_NONE:
445         /* This mode may be used for debugging.  It copies the main
446            text verbatim to the ciphertext.  We do not allow this in
447            fips mode or if no debug flag has been set.  */
448         if (fips_mode () || !_gcry_get_debug_flag (0))
449           err = GPG_ERR_INV_CIPHER_MODE;
450         break;
451
452       default:
453         err = GPG_ERR_INV_CIPHER_MODE;
454       }
455
456   /* Perform selftest here and mark this with a flag in cipher_table?
457      No, we should not do this as it takes too long.  Further it does
458      not make sense to exclude algorithms with failing selftests at
459      runtime: If a selftest fails there is something seriously wrong
460      with the system and thus we better die immediately. */
461
462   if (! err)
463     {
464       size_t size = (sizeof (*h)
465                      + 2 * spec->contextsize
466                      - sizeof (cipher_context_alignment_t)
467 #ifdef NEED_16BYTE_ALIGNED_CONTEXT
468                      + 15  /* Space for leading alignment gap.  */
469 #endif /*NEED_16BYTE_ALIGNED_CONTEXT*/
470                      );
471
472       if (secure)
473         h = xtrycalloc_secure (1, size);
474       else
475         h = xtrycalloc (1, size);
476
477       if (! h)
478         err = gpg_err_code_from_syserror ();
479       else
480         {
481           size_t off = 0;
482
483 #ifdef NEED_16BYTE_ALIGNED_CONTEXT
484           if ( ((unsigned long)h & 0x0f) )
485             {
486               /* The malloced block is not aligned on a 16 byte
487                  boundary.  Correct for this.  */
488               off = 16 - ((unsigned long)h & 0x0f);
489               h = (void*)((char*)h + off);
490             }
491 #endif /*NEED_16BYTE_ALIGNED_CONTEXT*/
492
493           h->magic = secure ? CTX_MAGIC_SECURE : CTX_MAGIC_NORMAL;
494           h->actual_handle_size = size - off;
495           h->handle_offset = off;
496           h->spec = spec;
497           h->algo = algo;
498           h->mode = mode;
499           h->flags = flags;
500
501           /* Setup bulk encryption routines.  */
502           switch (algo)
503             {
504 #ifdef USE_AES
505             case GCRY_CIPHER_AES128:
506             case GCRY_CIPHER_AES192:
507             case GCRY_CIPHER_AES256:
508               h->bulk.cfb_enc = _gcry_aes_cfb_enc;
509               h->bulk.cfb_dec = _gcry_aes_cfb_dec;
510               h->bulk.cbc_enc = _gcry_aes_cbc_enc;
511               h->bulk.cbc_dec = _gcry_aes_cbc_dec;
512               h->bulk.ctr_enc = _gcry_aes_ctr_enc;
513               h->bulk.ocb_crypt = _gcry_aes_ocb_crypt;
514               h->bulk.ocb_auth  = _gcry_aes_ocb_auth;
515               break;
516 #endif /*USE_AES*/
517 #ifdef USE_BLOWFISH
518             case GCRY_CIPHER_BLOWFISH:
519               h->bulk.cfb_dec = _gcry_blowfish_cfb_dec;
520               h->bulk.cbc_dec = _gcry_blowfish_cbc_dec;
521               h->bulk.ctr_enc = _gcry_blowfish_ctr_enc;
522               break;
523 #endif /*USE_BLOWFISH*/
524 #ifdef USE_CAST5
525             case GCRY_CIPHER_CAST5:
526               h->bulk.cfb_dec = _gcry_cast5_cfb_dec;
527               h->bulk.cbc_dec = _gcry_cast5_cbc_dec;
528               h->bulk.ctr_enc = _gcry_cast5_ctr_enc;
529               break;
530 #endif /*USE_CAMELLIA*/
531 #ifdef USE_CAMELLIA
532             case GCRY_CIPHER_CAMELLIA128:
533             case GCRY_CIPHER_CAMELLIA192:
534             case GCRY_CIPHER_CAMELLIA256:
535               h->bulk.cbc_dec = _gcry_camellia_cbc_dec;
536               h->bulk.cfb_dec = _gcry_camellia_cfb_dec;
537               h->bulk.ctr_enc = _gcry_camellia_ctr_enc;
538               break;
539 #endif /*USE_CAMELLIA*/
540 #ifdef USE_DES
541             case GCRY_CIPHER_3DES:
542               h->bulk.cbc_dec =  _gcry_3des_cbc_dec;
543               h->bulk.cfb_dec =  _gcry_3des_cfb_dec;
544               h->bulk.ctr_enc =  _gcry_3des_ctr_enc;
545               break;
546 #endif /*USE_DES*/
547 #ifdef USE_SERPENT
548             case GCRY_CIPHER_SERPENT128:
549             case GCRY_CIPHER_SERPENT192:
550             case GCRY_CIPHER_SERPENT256:
551               h->bulk.cbc_dec = _gcry_serpent_cbc_dec;
552               h->bulk.cfb_dec = _gcry_serpent_cfb_dec;
553               h->bulk.ctr_enc = _gcry_serpent_ctr_enc;
554               break;
555 #endif /*USE_SERPENT*/
556 #ifdef USE_TWOFISH
557             case GCRY_CIPHER_TWOFISH:
558             case GCRY_CIPHER_TWOFISH128:
559               h->bulk.cbc_dec = _gcry_twofish_cbc_dec;
560               h->bulk.cfb_dec = _gcry_twofish_cfb_dec;
561               h->bulk.ctr_enc = _gcry_twofish_ctr_enc;
562               break;
563 #endif /*USE_TWOFISH*/
564
565             default:
566               break;
567             }
568
569           /* Setup defaults depending on the mode.  */
570           switch (mode)
571             {
572             case GCRY_CIPHER_MODE_OCB:
573               h->u_mode.ocb.taglen = 16; /* Bytes.  */
574               break;
575
576             default:
577               break;
578             }
579
580         }
581     }
582
583   /* Done.  */
584
585   *handle = err ? NULL : h;
586
587   return gcry_error (err);
588 }
589
590
591 /* Release all resources associated with the cipher handle H. H may be
592    NULL in which case this is a no-operation. */
593 void
594 _gcry_cipher_close (gcry_cipher_hd_t h)
595 {
596   size_t off;
597
598   if (!h)
599     return;
600
601   if ((h->magic != CTX_MAGIC_SECURE)
602       && (h->magic != CTX_MAGIC_NORMAL))
603     _gcry_fatal_error(GPG_ERR_INTERNAL,
604                       "gcry_cipher_close: already closed/invalid handle");
605   else
606     h->magic = 0;
607
608   /* We always want to wipe out the memory even when the context has
609      been allocated in secure memory.  The user might have disabled
610      secure memory or is using his own implementation which does not
611      do the wiping.  To accomplish this we need to keep track of the
612      actual size of this structure because we have no way to known
613      how large the allocated area was when using a standard malloc. */
614   off = h->handle_offset;
615   wipememory (h, h->actual_handle_size);
616
617   xfree ((char*)h - off);
618 }
619
620
621 /* Set the key to be used for the encryption context C to KEY with
622    length KEYLEN.  The length should match the required length. */
623 static gcry_err_code_t
624 cipher_setkey (gcry_cipher_hd_t c, byte *key, size_t keylen)
625 {
626   gcry_err_code_t rc;
627
628   rc = c->spec->setkey (&c->context.c, key, keylen);
629   if (!rc)
630     {
631       /* Duplicate initial context.  */
632       memcpy ((void *) ((char *) &c->context.c + c->spec->contextsize),
633               (void *) &c->context.c,
634               c->spec->contextsize);
635       c->marks.key = 1;
636
637       switch (c->mode)
638         {
639         case GCRY_CIPHER_MODE_CMAC:
640           _gcry_cipher_cmac_set_subkeys (c);
641           break;
642
643         case GCRY_CIPHER_MODE_GCM:
644           _gcry_cipher_gcm_setkey (c);
645           break;
646
647         case GCRY_CIPHER_MODE_POLY1305:
648           _gcry_cipher_poly1305_setkey (c);
649           break;
650
651         default:
652           break;
653         };
654     }
655   else
656     c->marks.key = 0;
657
658   return rc;
659 }
660
661
662 /* Set the IV to be used for the encryption context C to IV with
663    length IVLEN.  The length should match the required length. */
664 static gcry_err_code_t
665 cipher_setiv (gcry_cipher_hd_t c, const byte *iv, size_t ivlen)
666 {
667   /* If the cipher has its own IV handler, we use only this one.  This
668      is currently used for stream ciphers requiring a nonce.  */
669   if (c->spec->setiv)
670     {
671       c->spec->setiv (&c->context.c, iv, ivlen);
672       return 0;
673     }
674
675   memset (c->u_iv.iv, 0, c->spec->blocksize);
676   if (iv)
677     {
678       if (ivlen != c->spec->blocksize)
679         {
680           log_info ("WARNING: cipher_setiv: ivlen=%u blklen=%u\n",
681                     (unsigned int)ivlen, (unsigned int)c->spec->blocksize);
682           fips_signal_error ("IV length does not match blocklength");
683         }
684       if (ivlen > c->spec->blocksize)
685         ivlen = c->spec->blocksize;
686       memcpy (c->u_iv.iv, iv, ivlen);
687       c->marks.iv = 1;
688     }
689   else
690       c->marks.iv = 0;
691   c->unused = 0;
692
693   return 0;
694 }
695
696
697 /* Reset the cipher context to the initial context.  This is basically
698    the same as an release followed by a new. */
699 static void
700 cipher_reset (gcry_cipher_hd_t c)
701 {
702   unsigned int marks_key;
703
704   marks_key = c->marks.key;
705
706   memcpy (&c->context.c,
707           (char *) &c->context.c + c->spec->contextsize,
708           c->spec->contextsize);
709   memset (&c->marks, 0, sizeof c->marks);
710   memset (c->u_iv.iv, 0, c->spec->blocksize);
711   memset (c->lastiv, 0, c->spec->blocksize);
712   memset (c->u_ctr.ctr, 0, c->spec->blocksize);
713   c->unused = 0;
714
715   c->marks.key = marks_key;
716
717   switch (c->mode)
718     {
719     case GCRY_CIPHER_MODE_CMAC:
720       /* Only clear 'tag' for cmac, keep subkeys. */
721       c->u_mode.cmac.tag = 0;
722       break;
723
724     case GCRY_CIPHER_MODE_GCM:
725       /* Only clear head of u_mode, keep ghash_key and gcm_table. */
726       {
727         byte *u_mode_pos = (void *)&c->u_mode;
728         byte *ghash_key_pos = c->u_mode.gcm.u_ghash_key.key;
729         size_t u_mode_head_length = ghash_key_pos - u_mode_pos;
730
731         memset (&c->u_mode, 0, u_mode_head_length);
732       }
733       break;
734
735     case GCRY_CIPHER_MODE_POLY1305:
736       memset (&c->u_mode.poly1305, 0, sizeof c->u_mode.poly1305);
737       break;
738
739 #ifdef HAVE_U64_TYPEDEF
740     case GCRY_CIPHER_MODE_CCM:
741       memset (&c->u_mode.ccm, 0, sizeof c->u_mode.ccm);
742       break;
743 #endif
744
745     case GCRY_CIPHER_MODE_OCB:
746       memset (&c->u_mode.ocb, 0, sizeof c->u_mode.ocb);
747       break;
748
749     default:
750       break; /* u_mode unused by other modes. */
751     }
752 }
753
754
755 \f
756 static gcry_err_code_t
757 do_ecb_crypt (gcry_cipher_hd_t c,
758               unsigned char *outbuf, size_t outbuflen,
759               const unsigned char *inbuf, size_t inbuflen,
760               gcry_cipher_encrypt_t crypt_fn)
761 {
762   unsigned int blocksize = c->spec->blocksize;
763   size_t n, nblocks;
764   unsigned int burn, nburn;
765
766   if (outbuflen < inbuflen)
767     return GPG_ERR_BUFFER_TOO_SHORT;
768   if ((inbuflen % blocksize))
769     return GPG_ERR_INV_LENGTH;
770
771   nblocks = inbuflen / blocksize;
772   burn = 0;
773
774   for (n=0; n < nblocks; n++ )
775     {
776       nburn = crypt_fn (&c->context.c, outbuf, inbuf);
777       burn = nburn > burn ? nburn : burn;
778       inbuf  += blocksize;
779       outbuf += blocksize;
780     }
781
782   if (burn > 0)
783     _gcry_burn_stack (burn + 4 * sizeof(void *));
784
785   return 0;
786 }
787
788 static gcry_err_code_t
789 do_ecb_encrypt (gcry_cipher_hd_t c,
790                 unsigned char *outbuf, size_t outbuflen,
791                 const unsigned char *inbuf, size_t inbuflen)
792 {
793   return do_ecb_crypt (c, outbuf, outbuflen, inbuf, inbuflen, c->spec->encrypt);
794 }
795
796 static gcry_err_code_t
797 do_ecb_decrypt (gcry_cipher_hd_t c,
798                 unsigned char *outbuf, size_t outbuflen,
799                 const unsigned char *inbuf, size_t inbuflen)
800 {
801   return do_ecb_crypt (c, outbuf, outbuflen, inbuf, inbuflen, c->spec->decrypt);
802 }
803
804
805 /****************
806  * Encrypt INBUF to OUTBUF with the mode selected at open.
807  * inbuf and outbuf may overlap or be the same.
808  * Depending on the mode some constraints apply to INBUFLEN.
809  */
810 static gcry_err_code_t
811 cipher_encrypt (gcry_cipher_hd_t c, byte *outbuf, size_t outbuflen,
812                 const byte *inbuf, size_t inbuflen)
813 {
814   gcry_err_code_t rc;
815
816   switch (c->mode)
817     {
818     case GCRY_CIPHER_MODE_ECB:
819       rc = do_ecb_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
820       break;
821
822     case GCRY_CIPHER_MODE_CBC:
823       rc = _gcry_cipher_cbc_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
824       break;
825
826     case GCRY_CIPHER_MODE_CFB:
827       rc = _gcry_cipher_cfb_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
828       break;
829
830     case GCRY_CIPHER_MODE_OFB:
831       rc = _gcry_cipher_ofb_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
832       break;
833
834     case GCRY_CIPHER_MODE_CTR:
835       rc = _gcry_cipher_ctr_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
836       break;
837
838     case GCRY_CIPHER_MODE_AESWRAP:
839       rc = _gcry_cipher_aeswrap_encrypt (c, outbuf, outbuflen,
840                                          inbuf, inbuflen);
841       break;
842
843     case GCRY_CIPHER_MODE_CCM:
844       rc = _gcry_cipher_ccm_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
845       break;
846
847     case GCRY_CIPHER_MODE_CMAC:
848       rc = GPG_ERR_INV_CIPHER_MODE;
849       break;
850
851     case GCRY_CIPHER_MODE_GCM:
852       rc = _gcry_cipher_gcm_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
853       break;
854
855     case GCRY_CIPHER_MODE_POLY1305:
856       rc = _gcry_cipher_poly1305_encrypt (c, outbuf, outbuflen,
857                                           inbuf, inbuflen);
858       break;
859
860     case GCRY_CIPHER_MODE_OCB:
861       rc = _gcry_cipher_ocb_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
862       break;
863
864     case GCRY_CIPHER_MODE_STREAM:
865       c->spec->stencrypt (&c->context.c,
866                           outbuf, (byte*)/*arggg*/inbuf, inbuflen);
867       rc = 0;
868       break;
869
870     case GCRY_CIPHER_MODE_NONE:
871       if (fips_mode () || !_gcry_get_debug_flag (0))
872         {
873           fips_signal_error ("cipher mode NONE used");
874           rc = GPG_ERR_INV_CIPHER_MODE;
875         }
876       else
877         {
878           if (inbuf != outbuf)
879             memmove (outbuf, inbuf, inbuflen);
880           rc = 0;
881         }
882       break;
883
884     default:
885       log_fatal ("cipher_encrypt: invalid mode %d\n", c->mode );
886       rc = GPG_ERR_INV_CIPHER_MODE;
887       break;
888     }
889
890   return rc;
891 }
892
893
894 /****************
895  * Encrypt IN and write it to OUT.  If IN is NULL, in-place encryption has
896  * been requested.
897  */
898 gcry_err_code_t
899 _gcry_cipher_encrypt (gcry_cipher_hd_t h, void *out, size_t outsize,
900                       const void *in, size_t inlen)
901 {
902   gcry_err_code_t rc;
903
904   if (!in)  /* Caller requested in-place encryption.  */
905     {
906       in = out;
907       inlen = outsize;
908     }
909
910   rc = cipher_encrypt (h, out, outsize, in, inlen);
911
912   /* Failsafe: Make sure that the plaintext will never make it into
913      OUT if the encryption returned an error.  */
914   if (rc && out)
915     memset (out, 0x42, outsize);
916
917   return rc;
918 }
919
920
921
922 /****************
923  * Decrypt INBUF to OUTBUF with the mode selected at open.
924  * inbuf and outbuf may overlap or be the same.
925  * Depending on the mode some some contraints apply to INBUFLEN.
926  */
927 static gcry_err_code_t
928 cipher_decrypt (gcry_cipher_hd_t c, byte *outbuf, size_t outbuflen,
929                 const byte *inbuf, size_t inbuflen)
930 {
931   gcry_err_code_t rc;
932
933   switch (c->mode)
934     {
935     case GCRY_CIPHER_MODE_ECB:
936       rc = do_ecb_decrypt (c, outbuf, outbuflen, inbuf, inbuflen);
937       break;
938
939     case GCRY_CIPHER_MODE_CBC:
940       rc = _gcry_cipher_cbc_decrypt (c, outbuf, outbuflen, inbuf, inbuflen);
941       break;
942
943     case GCRY_CIPHER_MODE_CFB:
944       rc = _gcry_cipher_cfb_decrypt (c, outbuf, outbuflen, inbuf, inbuflen);
945       break;
946
947     case GCRY_CIPHER_MODE_OFB:
948       rc = _gcry_cipher_ofb_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
949       break;
950
951     case GCRY_CIPHER_MODE_CTR:
952       rc = _gcry_cipher_ctr_encrypt (c, outbuf, outbuflen, inbuf, inbuflen);
953       break;
954
955     case GCRY_CIPHER_MODE_AESWRAP:
956       rc = _gcry_cipher_aeswrap_decrypt (c, outbuf, outbuflen,
957                                          inbuf, inbuflen);
958       break;
959
960     case GCRY_CIPHER_MODE_CCM:
961       rc = _gcry_cipher_ccm_decrypt (c, outbuf, outbuflen, inbuf, inbuflen);
962       break;
963
964     case GCRY_CIPHER_MODE_CMAC:
965       rc = GPG_ERR_INV_CIPHER_MODE;
966       break;
967
968     case GCRY_CIPHER_MODE_GCM:
969       rc = _gcry_cipher_gcm_decrypt (c, outbuf, outbuflen, inbuf, inbuflen);
970       break;
971
972     case GCRY_CIPHER_MODE_POLY1305:
973       rc = _gcry_cipher_poly1305_decrypt (c, outbuf, outbuflen,
974                                           inbuf, inbuflen);
975       break;
976
977     case GCRY_CIPHER_MODE_OCB:
978       rc = _gcry_cipher_ocb_decrypt (c, outbuf, outbuflen, inbuf, inbuflen);
979       break;
980
981     case GCRY_CIPHER_MODE_STREAM:
982       c->spec->stdecrypt (&c->context.c,
983                           outbuf, (byte*)/*arggg*/inbuf, inbuflen);
984       rc = 0;
985       break;
986
987     case GCRY_CIPHER_MODE_NONE:
988       if (fips_mode () || !_gcry_get_debug_flag (0))
989         {
990           fips_signal_error ("cipher mode NONE used");
991           rc = GPG_ERR_INV_CIPHER_MODE;
992         }
993       else
994         {
995           if (inbuf != outbuf)
996             memmove (outbuf, inbuf, inbuflen);
997           rc = 0;
998         }
999       break;
1000
1001     default:
1002       log_fatal ("cipher_decrypt: invalid mode %d\n", c->mode );
1003       rc = GPG_ERR_INV_CIPHER_MODE;
1004       break;
1005     }
1006
1007   return rc;
1008 }
1009
1010
1011 gcry_err_code_t
1012 _gcry_cipher_decrypt (gcry_cipher_hd_t h, void *out, size_t outsize,
1013                       const void *in, size_t inlen)
1014 {
1015   if (!in) /* Caller requested in-place encryption. */
1016     {
1017       in = out;
1018       inlen = outsize;
1019     }
1020
1021   return cipher_decrypt (h, out, outsize, in, inlen);
1022 }
1023
1024
1025
1026 /****************
1027  * Used for PGP's somewhat strange CFB mode. Only works if
1028  * the corresponding flag is set.
1029  */
1030 static void
1031 cipher_sync (gcry_cipher_hd_t c)
1032 {
1033   if ((c->flags & GCRY_CIPHER_ENABLE_SYNC) && c->unused)
1034     {
1035       memmove (c->u_iv.iv + c->unused,
1036                c->u_iv.iv, c->spec->blocksize - c->unused);
1037       memcpy (c->u_iv.iv,
1038               c->lastiv + c->spec->blocksize - c->unused, c->unused);
1039       c->unused = 0;
1040     }
1041 }
1042
1043
1044 gcry_err_code_t
1045 _gcry_cipher_setkey (gcry_cipher_hd_t hd, const void *key, size_t keylen)
1046 {
1047   return cipher_setkey (hd, (void*)key, keylen);
1048 }
1049
1050
1051 gcry_err_code_t
1052 _gcry_cipher_setiv (gcry_cipher_hd_t hd, const void *iv, size_t ivlen)
1053 {
1054   gcry_err_code_t rc = 0;
1055
1056   switch (hd->mode)
1057     {
1058       case GCRY_CIPHER_MODE_CCM:
1059         rc = _gcry_cipher_ccm_set_nonce (hd, iv, ivlen);
1060         break;
1061
1062       case GCRY_CIPHER_MODE_GCM:
1063         rc =  _gcry_cipher_gcm_setiv (hd, iv, ivlen);
1064         break;
1065
1066       case GCRY_CIPHER_MODE_POLY1305:
1067         rc =  _gcry_cipher_poly1305_setiv (hd, iv, ivlen);
1068         break;
1069
1070       case GCRY_CIPHER_MODE_OCB:
1071         rc = _gcry_cipher_ocb_set_nonce (hd, iv, ivlen);
1072         break;
1073
1074       default:
1075         rc = cipher_setiv (hd, iv, ivlen);
1076         break;
1077     }
1078   return rc;
1079 }
1080
1081 /* Set counter for CTR mode.  (CTR,CTRLEN) must denote a buffer of
1082    block size length, or (NULL,0) to set the CTR to the all-zero
1083    block. */
1084 gpg_err_code_t
1085 _gcry_cipher_setctr (gcry_cipher_hd_t hd, const void *ctr, size_t ctrlen)
1086 {
1087   if (ctr && ctrlen == hd->spec->blocksize)
1088     {
1089       memcpy (hd->u_ctr.ctr, ctr, hd->spec->blocksize);
1090       hd->unused = 0;
1091     }
1092   else if (!ctr || !ctrlen)
1093     {
1094       memset (hd->u_ctr.ctr, 0, hd->spec->blocksize);
1095       hd->unused = 0;
1096     }
1097   else
1098     return GPG_ERR_INV_ARG;
1099
1100   return 0;
1101 }
1102
1103
1104 gcry_err_code_t
1105 _gcry_cipher_authenticate (gcry_cipher_hd_t hd, const void *abuf,
1106                            size_t abuflen)
1107 {
1108   gcry_err_code_t rc;
1109
1110   switch (hd->mode)
1111     {
1112     case GCRY_CIPHER_MODE_CCM:
1113       rc = _gcry_cipher_ccm_authenticate (hd, abuf, abuflen);
1114       break;
1115
1116     case GCRY_CIPHER_MODE_CMAC:
1117       rc = _gcry_cipher_cmac_authenticate (hd, abuf, abuflen);
1118       break;
1119
1120     case GCRY_CIPHER_MODE_GCM:
1121       rc = _gcry_cipher_gcm_authenticate (hd, abuf, abuflen);
1122       break;
1123
1124     case GCRY_CIPHER_MODE_POLY1305:
1125       rc = _gcry_cipher_poly1305_authenticate (hd, abuf, abuflen);
1126       break;
1127
1128     case GCRY_CIPHER_MODE_OCB:
1129       rc = _gcry_cipher_ocb_authenticate (hd, abuf, abuflen);
1130       break;
1131
1132     default:
1133       log_error ("gcry_cipher_authenticate: invalid mode %d\n", hd->mode);
1134       rc = GPG_ERR_INV_CIPHER_MODE;
1135       break;
1136     }
1137
1138   return rc;
1139 }
1140
1141
1142 gcry_err_code_t
1143 _gcry_cipher_gettag (gcry_cipher_hd_t hd, void *outtag, size_t taglen)
1144 {
1145   gcry_err_code_t rc;
1146
1147   switch (hd->mode)
1148     {
1149     case GCRY_CIPHER_MODE_CCM:
1150       rc = _gcry_cipher_ccm_get_tag (hd, outtag, taglen);
1151       break;
1152
1153     case GCRY_CIPHER_MODE_CMAC:
1154       rc = _gcry_cipher_cmac_get_tag (hd, outtag, taglen);
1155       break;
1156
1157     case GCRY_CIPHER_MODE_GCM:
1158       rc = _gcry_cipher_gcm_get_tag (hd, outtag, taglen);
1159       break;
1160
1161     case GCRY_CIPHER_MODE_POLY1305:
1162       rc = _gcry_cipher_poly1305_get_tag (hd, outtag, taglen);
1163       break;
1164
1165     case GCRY_CIPHER_MODE_OCB:
1166       rc = _gcry_cipher_ocb_get_tag (hd, outtag, taglen);
1167       break;
1168
1169     default:
1170       log_error ("gcry_cipher_gettag: invalid mode %d\n", hd->mode);
1171       rc = GPG_ERR_INV_CIPHER_MODE;
1172       break;
1173     }
1174
1175   return rc;
1176 }
1177
1178
1179 gcry_err_code_t
1180 _gcry_cipher_checktag (gcry_cipher_hd_t hd, const void *intag, size_t taglen)
1181 {
1182   gcry_err_code_t rc;
1183
1184   switch (hd->mode)
1185     {
1186     case GCRY_CIPHER_MODE_CCM:
1187       rc = _gcry_cipher_ccm_check_tag (hd, intag, taglen);
1188       break;
1189
1190     case GCRY_CIPHER_MODE_CMAC:
1191       rc = _gcry_cipher_cmac_check_tag (hd, intag, taglen);
1192       break;
1193
1194     case GCRY_CIPHER_MODE_GCM:
1195       rc = _gcry_cipher_gcm_check_tag (hd, intag, taglen);
1196       break;
1197
1198     case GCRY_CIPHER_MODE_POLY1305:
1199       rc = _gcry_cipher_poly1305_check_tag (hd, intag, taglen);
1200       break;
1201
1202     case GCRY_CIPHER_MODE_OCB:
1203       rc = _gcry_cipher_ocb_check_tag (hd, intag, taglen);
1204       break;
1205
1206     default:
1207       log_error ("gcry_cipher_checktag: invalid mode %d\n", hd->mode);
1208       rc = GPG_ERR_INV_CIPHER_MODE;
1209       break;
1210     }
1211
1212   return rc;
1213 }
1214
1215
1216 gcry_err_code_t
1217 _gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer, size_t buflen)
1218 {
1219   gcry_err_code_t rc = 0;
1220
1221   switch (cmd)
1222     {
1223     case GCRYCTL_RESET:
1224       cipher_reset (h);
1225       break;
1226
1227     case GCRYCTL_FINALIZE:
1228       if (!h || buffer || buflen)
1229         return GPG_ERR_INV_ARG;
1230       h->marks.finalize = 1;
1231       break;
1232
1233     case GCRYCTL_CFB_SYNC:
1234       cipher_sync( h );
1235       break;
1236
1237     case GCRYCTL_SET_CBC_CTS:
1238       if (buflen)
1239         if (h->flags & GCRY_CIPHER_CBC_MAC)
1240           rc = GPG_ERR_INV_FLAG;
1241         else
1242           h->flags |= GCRY_CIPHER_CBC_CTS;
1243       else
1244         h->flags &= ~GCRY_CIPHER_CBC_CTS;
1245       break;
1246
1247     case GCRYCTL_SET_CBC_MAC:
1248       if (buflen)
1249         if (h->flags & GCRY_CIPHER_CBC_CTS)
1250           rc = GPG_ERR_INV_FLAG;
1251         else
1252           h->flags |= GCRY_CIPHER_CBC_MAC;
1253       else
1254         h->flags &= ~GCRY_CIPHER_CBC_MAC;
1255       break;
1256
1257     case GCRYCTL_SET_CCM_LENGTHS:
1258 #ifdef HAVE_U64_TYPEDEF
1259       {
1260         u64 params[3];
1261         size_t encryptedlen;
1262         size_t aadlen;
1263         size_t authtaglen;
1264
1265         if (h->mode != GCRY_CIPHER_MODE_CCM)
1266           return gcry_error (GPG_ERR_INV_CIPHER_MODE);
1267
1268         if (!buffer || buflen != 3 * sizeof(u64))
1269           return gcry_error (GPG_ERR_INV_ARG);
1270
1271         /* This command is used to pass additional length parameters needed
1272            by CCM mode to initialize CBC-MAC.  */
1273         memcpy (params, buffer, sizeof(params));
1274         encryptedlen = params[0];
1275         aadlen = params[1];
1276         authtaglen = params[2];
1277
1278         rc = _gcry_cipher_ccm_set_lengths (h, encryptedlen, aadlen, authtaglen);
1279       }
1280 #else
1281       rc = GPG_ERR_NOT_SUPPORTED;
1282 #endif
1283       break;
1284
1285     case GCRYCTL_SET_TAGLEN:
1286       if (!h || !buffer || buflen != sizeof(int) )
1287         return GPG_ERR_INV_ARG;
1288       switch (h->mode)
1289         {
1290         case GCRY_CIPHER_MODE_OCB:
1291           switch (*(int*)buffer)
1292             {
1293             case 8: case 12: case 16:
1294               h->u_mode.ocb.taglen = *(int*)buffer;
1295               break;
1296             default:
1297               rc = GPG_ERR_INV_LENGTH; /* Invalid tag length. */
1298               break;
1299             }
1300           break;
1301
1302         default:
1303           rc =GPG_ERR_INV_CIPHER_MODE;
1304           break;
1305         }
1306       break;
1307
1308     case GCRYCTL_DISABLE_ALGO:
1309       /* This command expects NULL for H and BUFFER to point to an
1310          integer with the algo number.  */
1311       if( h || !buffer || buflen != sizeof(int) )
1312         return gcry_error (GPG_ERR_CIPHER_ALGO);
1313       disable_cipher_algo( *(int*)buffer );
1314       break;
1315
1316     case 61:  /* Disable weak key detection (private).  */
1317       if (h->spec->set_extra_info)
1318         rc = h->spec->set_extra_info
1319           (&h->context.c, CIPHER_INFO_NO_WEAK_KEY, NULL, 0);
1320       else
1321         rc = GPG_ERR_NOT_SUPPORTED;
1322       break;
1323
1324     case 62: /* Return current input vector (private).  */
1325       /* This is the input block as used in CFB and OFB mode which has
1326          initially been set as IV.  The returned format is:
1327            1 byte  Actual length of the block in bytes.
1328            n byte  The block.
1329          If the provided buffer is too short, an error is returned. */
1330       if (buflen < (1 + h->spec->blocksize))
1331         rc = GPG_ERR_TOO_SHORT;
1332       else
1333         {
1334           unsigned char *ivp;
1335           unsigned char *dst = buffer;
1336           int n = h->unused;
1337
1338           if (!n)
1339             n = h->spec->blocksize;
1340           gcry_assert (n <= h->spec->blocksize);
1341           *dst++ = n;
1342           ivp = h->u_iv.iv + h->spec->blocksize - n;
1343           while (n--)
1344             *dst++ = *ivp++;
1345         }
1346       break;
1347
1348     case GCRYCTL_SET_SBOX:
1349       if (h->spec->set_extra_info)
1350         rc = h->spec->set_extra_info
1351           (&h->context.c, GCRYCTL_SET_SBOX, buffer, buflen);
1352       else
1353         rc = GPG_ERR_NOT_SUPPORTED;
1354
1355     default:
1356       rc = GPG_ERR_INV_OP;
1357     }
1358
1359   return rc;
1360 }
1361
1362
1363 /* Return information about the cipher handle H.  CMD is the kind of
1364    information requested.  BUFFER and NBYTES are reserved for now.
1365
1366    There are no values for CMD yet defined.
1367
1368    The function always returns GPG_ERR_INV_OP.
1369
1370  */
1371 gcry_err_code_t
1372 _gcry_cipher_info (gcry_cipher_hd_t h, int cmd, void *buffer, size_t *nbytes)
1373 {
1374   gcry_err_code_t rc = 0;
1375
1376   (void)h;
1377   (void)buffer;
1378   (void)nbytes;
1379
1380   switch (cmd)
1381     {
1382     default:
1383       rc = GPG_ERR_INV_OP;
1384     }
1385
1386   return rc;
1387 }
1388
1389 /* Return information about the given cipher algorithm ALGO.
1390
1391    WHAT select the kind of information returned:
1392
1393     GCRYCTL_GET_KEYLEN:
1394         Return the length of the key.  If the algorithm ALGO
1395         supports multiple key lengths, the maximum supported key length
1396         is returned.  The key length is returned as number of octets.
1397         BUFFER and NBYTES must be zero.
1398
1399     GCRYCTL_GET_BLKLEN:
1400         Return the blocklength of the algorithm ALGO counted in octets.
1401         BUFFER and NBYTES must be zero.
1402
1403     GCRYCTL_TEST_ALGO:
1404         Returns 0 if the specified algorithm ALGO is available for use.
1405         BUFFER and NBYTES must be zero.
1406
1407    Note: Because this function is in most cases used to return an
1408    integer value, we can make it easier for the caller to just look at
1409    the return value.  The caller will in all cases consult the value
1410    and thereby detecting whether a error occurred or not (i.e. while
1411    checking the block size)
1412  */
1413 gcry_err_code_t
1414 _gcry_cipher_algo_info (int algo, int what, void *buffer, size_t *nbytes)
1415 {
1416   gcry_err_code_t rc = 0;
1417   unsigned int ui;
1418
1419   switch (what)
1420     {
1421     case GCRYCTL_GET_KEYLEN:
1422       if (buffer || (! nbytes))
1423         rc = GPG_ERR_CIPHER_ALGO;
1424       else
1425         {
1426           ui = cipher_get_keylen (algo);
1427           if ((ui > 0) && (ui <= 512))
1428             *nbytes = (size_t) ui / 8;
1429           else
1430             /* The only reason for an error is an invalid algo.  */
1431             rc = GPG_ERR_CIPHER_ALGO;
1432         }
1433       break;
1434
1435     case GCRYCTL_GET_BLKLEN:
1436       if (buffer || (! nbytes))
1437         rc = GPG_ERR_CIPHER_ALGO;
1438       else
1439         {
1440           ui = cipher_get_blocksize (algo);
1441           if ((ui > 0) && (ui < 10000))
1442             *nbytes = ui;
1443           else
1444             {
1445               /* The only reason is an invalid algo or a strange
1446                  blocksize.  */
1447               rc = GPG_ERR_CIPHER_ALGO;
1448             }
1449         }
1450       break;
1451
1452     case GCRYCTL_TEST_ALGO:
1453       if (buffer || nbytes)
1454         rc = GPG_ERR_INV_ARG;
1455       else
1456         rc = check_cipher_algo (algo);
1457       break;
1458
1459       default:
1460         rc = GPG_ERR_INV_OP;
1461     }
1462
1463   return rc;
1464 }
1465
1466
1467 /* This function returns length of the key for algorithm ALGO.  If the
1468    algorithm supports multiple key lengths, the maximum supported key
1469    length is returned.  On error 0 is returned.  The key length is
1470    returned as number of octets.
1471
1472    This is a convenience functions which should be preferred over
1473    gcry_cipher_algo_info because it allows for proper type
1474    checking.  */
1475 size_t
1476 _gcry_cipher_get_algo_keylen (int algo)
1477 {
1478   size_t n;
1479
1480   if (_gcry_cipher_algo_info (algo, GCRYCTL_GET_KEYLEN, NULL, &n))
1481     n = 0;
1482   return n;
1483 }
1484
1485
1486 /* This functions returns the blocklength of the algorithm ALGO
1487    counted in octets.  On error 0 is returned.
1488
1489    This is a convenience functions which should be preferred over
1490    gcry_cipher_algo_info because it allows for proper type
1491    checking.  */
1492 size_t
1493 _gcry_cipher_get_algo_blklen (int algo)
1494 {
1495   size_t n;
1496
1497   if (_gcry_cipher_algo_info( algo, GCRYCTL_GET_BLKLEN, NULL, &n))
1498     n = 0;
1499   return n;
1500 }
1501
1502
1503 /* Explicitly initialize this module.  */
1504 gcry_err_code_t
1505 _gcry_cipher_init (void)
1506 {
1507   return 0;
1508 }
1509
1510
1511 /* Run the selftests for cipher algorithm ALGO with optional reporting
1512    function REPORT.  */
1513 gpg_error_t
1514 _gcry_cipher_selftest (int algo, int extended, selftest_report_func_t report)
1515 {
1516   gcry_err_code_t ec = 0;
1517   gcry_cipher_spec_t *spec;
1518
1519   spec = spec_from_algo (algo);
1520   if (spec && !spec->flags.disabled && spec->selftest)
1521     ec = spec->selftest (algo, extended, report);
1522   else
1523     {
1524       ec = GPG_ERR_CIPHER_ALGO;
1525       if (report)
1526         report ("cipher", algo, "module",
1527                 (spec && !spec->flags.disabled)?
1528                 "no selftest available" :
1529                 spec? "algorithm disabled" : "algorithm not found");
1530     }
1531
1532   return gpg_error (ec);
1533 }