2003-07-28 Moritz Schulte <moritz@g10code.com>
[libgcrypt.git] / src / gcrypt.h
1 /* gcrypt.h -  GNU cryptographic library interface
2  * Copyright (C) 1998,1999,2000,2001,2002,2003 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
21 #ifndef _GCRYPT_H
22 #define _GCRYPT_H
23
24 #include <stdarg.h>
25 #include <string.h>
26
27 #include <gpg-error.h>
28
29 /* This is required for error code compatibility. */
30 #define _GCRY_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_GCRYPT
31
32 #ifdef __cplusplus
33 extern "C" {
34 #if 0 /* keep Emacsens's auto-indent happy */
35 }
36 #endif
37 #endif
38
39 /* The version of this header should match the one of the library It
40    should not be used by a program because gcry_check_version() should
41    return the same version.  The purpose of this macro is to let
42    autoconf (using the AM_PATH_GCRYPT macro) check that this header
43    matches the installed library.  Note: Do not edit the next line as
44    configure may fix the string here.  */
45 #define GCRYPT_VERSION "1.1.42-cvs"
46
47 /* Internal: We can't use the convenience macros for the multi
48    precision integer functions when building this library. */
49 #ifdef _GCRYPT_IN_LIBGCRYPT
50 #ifndef GCRYPT_NO_MPI_MACROS
51 #define GCRYPT_NO_MPI_MACROS 1
52 #endif
53 #endif
54
55 /* We want to use gcc attributes when possible.  Warning: Don't use
56    these macros in your progranms: As indicated by the leading
57    underscore they are subject to change without notice. */
58 #ifdef __GNUC__
59
60 #define _GCRY_GCC_VERSION (__GNUC__ * 10000 \
61                              + __GNUC_MINOR__ * 100 \
62                              + __GNUC_PATCHLEVEL__)
63
64 #if _GCRY_GCC_VERSION >= 30100
65 #define _GCRY_GCC_ATTR_DEPRECATED __attribute__ ((__deprecated__))
66 #endif
67
68 #if _GCRY_GCC_VERSION >= 29600
69 #define _GCRY_GCC_ATTR_PURE  __attribute__ ((__pure__))
70 #endif
71
72 #if _GCRY_GCC_VERSION >= 300200
73 #define _GCRY_GCC_ATTR_MALLOC  __attribute__ ((__malloc__))
74 #endif
75
76 #endif
77
78 #ifndef _GCRY_GCC_ATTR_DEPRECATED
79 #define _GCRY_GCC_ATTR_DEPRECATED
80 #endif
81 #ifndef _GCRY_GCC_ATTR_PURE
82 #define _GCRY_GCC_ATTR_PURE
83 #endif
84 #ifndef _GCRY_GCC_ATTR_MALLOC
85 #define _GCRY_GCC_ATTR_MALLOC
86 #endif
87
88 /* Wrappers for the libgpg-error library.  */
89
90 typedef gpg_error_t gcry_error_t;
91 typedef gpg_err_code_t gcry_err_code_t;
92 typedef gpg_err_source_t gcry_err_source_t;
93
94 static __inline__ gcry_error_t
95 gcry_err_make (gcry_err_source_t source, gcry_err_code_t code)
96 {
97   return gpg_err_make (source, code);
98 }
99
100 /* The user can define GPG_ERR_SOURCE_DEFAULT before including this
101    file to specify a default source for gpg_error.  */
102 #ifndef GCRY_ERR_SOURCE_DEFAULT
103 #define GCRY_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
104 #endif
105
106 static __inline__ gcry_error_t
107 gcry_error (gcry_err_code_t code)
108 {
109   return gcry_err_make (GCRY_ERR_SOURCE_DEFAULT, code);
110 }
111
112 static __inline__ gcry_err_code_t
113 gcry_err_code (gcry_error_t err)
114 {
115   return gpg_err_code (err);
116 }
117
118
119 static __inline__ gcry_err_source_t
120 gcry_err_source (gcry_error_t err)
121 {
122   return gpg_err_source (err);
123 }
124
125 /* Return a pointer to a string containing a description of the error
126    code in the error value ERR.  */
127 const char * gcry_strerror (gcry_error_t err);
128
129 /* Return a pointer to a string containing a description of the error
130    source in the error value ERR.  */
131 const char *gcry_strsource (gcry_error_t err);
132
133 /* Retrieve the error code for the system error ERR.  This returns
134    GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
135    this).  */
136 gcry_err_code_t gcry_err_code_from_errno (int err);
137
138 /* Retrieve the system error for the error code CODE.  This returns 0
139    if CODE is not a system error code.  */
140 int gcry_err_code_to_errno (gcry_err_code_t code);
141
142 /* Return an error value with the error source SOURCE and the system
143    error ERR.  */
144 gcry_error_t gcry_err_make_from_errno (gcry_err_source_t source, int err);
145
146 /* Return an error value with the system error ERR.  */
147 gcry_err_code_t gcry_error_from_errno (int err);
148
149 /* The data object used to hold a multi precision integer.  */
150 struct gcry_mpi;
151 typedef struct gcry_mpi *gcry_mpi_t;
152
153 typedef struct gcry_mpi *GCRY_MPI _GCRY_GCC_ATTR_DEPRECATED;
154 typedef struct gcry_mpi *GcryMPI _GCRY_GCC_ATTR_DEPRECATED;
155
156 \f
157
158 /* Check that the library fulfills the version requirement.  */
159 const char *gcry_check_version (const char *req_version);
160
161 /* Codes for function dispatchers.  */
162
163 /* Codes used with the gcry_control function. */
164 enum gcry_ctl_cmds 
165   {
166     GCRYCTL_SET_KEY  = 1,
167     GCRYCTL_SET_IV   = 2,
168     GCRYCTL_CFB_SYNC = 3,
169     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
170     GCRYCTL_FINALIZE = 5,
171     GCRYCTL_GET_KEYLEN = 6,
172     GCRYCTL_GET_BLKLEN = 7,
173     GCRYCTL_TEST_ALGO = 8,
174     GCRYCTL_IS_SECURE = 9,
175     GCRYCTL_GET_ASNOID = 10,
176     GCRYCTL_ENABLE_ALGO = 11,
177     GCRYCTL_DISABLE_ALGO = 12,
178     GCRYCTL_DUMP_RANDOM_STATS = 13,
179     GCRYCTL_DUMP_SECMEM_STATS = 14,
180     GCRYCTL_GET_ALGO_NPKEY    = 15,
181     GCRYCTL_GET_ALGO_NSKEY    = 16,
182     GCRYCTL_GET_ALGO_NSIGN    = 17,
183     GCRYCTL_GET_ALGO_NENCR    = 18,
184     GCRYCTL_SET_VERBOSITY     = 19,
185     GCRYCTL_SET_DEBUG_FLAGS   = 20,
186     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
187     GCRYCTL_USE_SECURE_RNDPOOL= 22,
188     GCRYCTL_DUMP_MEMORY_STATS = 23,
189     GCRYCTL_INIT_SECMEM       = 24,
190     GCRYCTL_TERM_SECMEM       = 25,
191     GCRYCTL_DISABLE_SECMEM_WARN = 27,
192     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
193     GCRYCTL_RESUME_SECMEM_WARN  = 29,
194     GCRYCTL_DROP_PRIVS          = 30,
195     GCRYCTL_ENABLE_M_GUARD      = 31,
196     GCRYCTL_START_DUMP          = 32,
197     GCRYCTL_STOP_DUMP           = 33,
198     GCRYCTL_GET_ALGO_USAGE      = 34,
199     GCRYCTL_IS_ALGO_ENABLED     = 35,
200     GCRYCTL_DISABLE_INTERNAL_LOCKING = 36,
201     GCRYCTL_DISABLE_SECMEM      = 37,
202     GCRYCTL_INITIALIZATION_FINISHED = 38,
203     GCRYCTL_INITIALIZATION_FINISHED_P = 39,
204     GCRYCTL_ANY_INITIALIZATION_P = 40,
205     GCRYCTL_SET_CBC_CTS = 41,
206     GCRYCTL_SET_CBC_MAC = 42,
207     GCRYCTL_SET_CTR = 43,
208     GCRYCTL_ENABLE_QUICK_RANDOM = 44,
209   };
210
211 /* Perform various operations defined by CMD. */
212 gcry_error_t gcry_control (enum gcry_ctl_cmds CMD, ...);
213
214 \f
215 /* S-expression management. */ 
216
217 /* The object to represent an S-expression as used with the public key
218    functions.  */
219 struct gcry_sexp;
220 typedef struct gcry_sexp *gcry_sexp_t;
221
222 typedef struct gcry_sexp *GCRY_SEXP _GCRY_GCC_ATTR_DEPRECATED;
223 typedef struct gcry_sexp *GcrySexp _GCRY_GCC_ATTR_DEPRECATED;
224
225 /* The possible values for the S-expression format. */
226 enum gcry_sexp_format
227   {
228     GCRYSEXP_FMT_DEFAULT   = 0,
229     GCRYSEXP_FMT_CANON     = 1,
230     GCRYSEXP_FMT_BASE64    = 2,
231     GCRYSEXP_FMT_ADVANCED  = 3
232   };
233
234 /* Create an new S-expression object from BUFFER of size LENGTH and
235    return it in RETSEXP.  With AUTODETECT set to 0 the data in BUFFER
236    is expected to be in canonized format.  */
237 gcry_error_t gcry_sexp_new (gcry_sexp_t *retsexp, const void *buffer, size_t length,
238                            int autodetect);
239
240  /* Same as gcry_sexp_new but allows to pass a FREEFNC which has the
241    effect to transfer ownership of BUFFER to the created object.  */
242 gcry_error_t gcry_sexp_create (gcry_sexp_t *retsexp, void *buffer, size_t length,
243                               int autodetect, void (*freefnc) (void *));
244
245 /* Scan BUFFER and return a new S-expression object in RETSEXP.  This
246    function expects a printf like string in BUFFER.  */
247 gcry_error_t gcry_sexp_sscan (gcry_sexp_t *retsexp, size_t *erroff,
248                              const char *buffer, size_t length);
249
250 /* Same as gcry_sexp_sscan but expects a string in FORMAT and can thus
251    only be used for certain encodings.  */
252 gcry_error_t gcry_sexp_build (gcry_sexp_t *retsexp, size_t *erroff,
253                              const char *format, ...);
254
255 /* Like gcry_sexp_build, but uses an array instead of variable
256    function arguments.  */
257 gcry_error_t gcry_sexp_build_array (gcry_sexp_t *retsexp, size_t *erroff,
258                                    const char *format, void **arg_list);
259
260 /* Release the S-expression object SEXP */
261 void gcry_sexp_release (gcry_sexp_t sexp);
262
263 /* Calculate the length of an canonized S-expresion in BUFFER and
264    check for a valid encoding. */
265 size_t gcry_sexp_canon_len (const unsigned char *buffer, size_t length, 
266                             size_t *erroff, gcry_error_t *errcode);
267
268 /* Copies the S-expression object SEXP into BUFFER using the format
269    specified in MODE.  */
270 size_t gcry_sexp_sprint (gcry_sexp_t sexp, int mode, char *buffer,
271                          size_t maxlength);
272
273 /* Dumps the S-expression object A in a aformat suitable for debugging
274    to Libgcrypt's logging stream.  */
275 void gcry_sexp_dump (const gcry_sexp_t a);
276
277 gcry_sexp_t gcry_sexp_cons (const gcry_sexp_t a, const gcry_sexp_t b);
278 gcry_sexp_t gcry_sexp_alist (const gcry_sexp_t *array);
279 gcry_sexp_t gcry_sexp_vlist (const gcry_sexp_t a, ...);
280 gcry_sexp_t gcry_sexp_append (const gcry_sexp_t a, const gcry_sexp_t n);
281 gcry_sexp_t gcry_sexp_prepend (const gcry_sexp_t a, const gcry_sexp_t n);
282
283 /* Scan the S-expression for a sublist with a type (the car of the
284    list) matching the string TOKEN.  If TOKLEN is not 0, the token is
285    assumed to be raw memory of this length.  The function returns a
286    newly allocated S-expression consisting of the found sublist or
287    `NULL' when not found.  */
288 gcry_sexp_t gcry_sexp_find_token (gcry_sexp_t list,
289                                 const char *tok, size_t toklen);
290 /* Return the length of the LIST.  For a valid S-expression this
291    should be at least 1.  */
292 int gcry_sexp_length (const gcry_sexp_t list);
293
294 /* Create and return a new S-expression from the element with index
295    NUMBER in LIST.  Note that the first element has the index 0.  If
296    there is no such element, `NULL' is returned.  */
297 gcry_sexp_t gcry_sexp_nth (const gcry_sexp_t list, int number);
298
299 /* Create and return a new S-expression from the first element in
300    LIST; this called the "type" and should always exist and be a
301    string. `NULL' is returned in case of a problem.  */
302 gcry_sexp_t gcry_sexp_car (const gcry_sexp_t list);
303
304 /* Create and return a new list form all elements except for the first
305    one.  Note, that this function may return an invalid S-expression
306    because it is not guaranteed, that the type exists and is a string.
307    However, for parsing a complex S-expression it might be useful for
308    intermediate lists.  Returns `NULL' on error.  */
309 gcry_sexp_t gcry_sexp_cdr (const gcry_sexp_t list);
310
311 gcry_sexp_t gcry_sexp_cadr (const gcry_sexp_t list);
312
313
314 /* This function is used to get data from a LIST.  A pointer to the
315    actual data with index NUMBER is returned and the length of this
316    data will be stored to DATALEN.  If there is no data at the given
317    index or the index represents another list, `NULL' is returned.
318    *Note:* The returned pointer is valid as long as LIST is not
319    modified or released.  */
320 const char *gcry_sexp_nth_data (const gcry_sexp_t list, int number,
321                                 size_t *datalen);
322
323 /* This function is used to get and convert data from a LIST. This
324    data is assumed to be an MPI stored in the format described by
325    MPIFMT and returned as a standard Libgcrypt MPI.  The caller must
326    release this returned value using `gcry_mpi_release'.  If there is
327    no data at the given index, the index represents a list or the
328    value can't be converted to an MPI, `NULL' is returned.  */
329 gcry_mpi_t gcry_sexp_nth_mpi (gcry_sexp_t list, int number, int mpifmt);
330
331
332 \f
333 /*******************************************
334  *                                         *
335  *  multi precision integer functions      *
336  *                                         *
337  *******************************************/
338
339 /* Different formats of external big integer representation. */
340 enum gcry_mpi_format 
341   {
342     GCRYMPI_FMT_NONE= 0,
343     GCRYMPI_FMT_STD = 1,    /* twos complement stored without length */
344     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP (only defined as unsigned)*/
345     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (same as 1 but with length)*/
346     GCRYMPI_FMT_HEX = 4,    /* hex format */
347     GCRYMPI_FMT_USG = 5     /* like STD but this is an unsigned one */
348   };
349
350 /* Flags used for creating big integers.  */
351 enum gcry_mpi_flag 
352   {
353     GCRYMPI_FLAG_SECURE = 1,  /* Allocate the number in "secure" memory. */
354     GCRYMPI_FLAG_OPAQUE = 2   /* The number is not a real one but just a
355                                way to store some bytes.  This is
356                                useful for encrypted big integers. */
357   };
358
359
360 /* Allocate a new big integer object, initialize it with 0 and
361    initially allocate memory for a number of at least NBITS. */
362 gcry_mpi_t gcry_mpi_new (unsigned int nbits);
363
364 /* Same as gcry_mpi_new() but allocate in "secure" memory. */
365 gcry_mpi_t gcry_mpi_snew (unsigned int nbits);
366
367 /* Release the number A and free all associated resources. */
368 void gcry_mpi_release (gcry_mpi_t a);
369
370 /* Create a new number with the same value as A. */
371 gcry_mpi_t gcry_mpi_copy (const gcry_mpi_t a);
372
373 /* Store the big integer value U in W. */
374 gcry_mpi_t gcry_mpi_set (gcry_mpi_t w, const gcry_mpi_t u);
375
376 /* Store the unsigned integer value U in W. */
377 gcry_mpi_t gcry_mpi_set_ui (gcry_mpi_t w, unsigned long u);
378
379 /* Swap the values of A and B. */
380 void gcry_mpi_swap (gcry_mpi_t a, gcry_mpi_t b);
381
382 /* Compare the big integer number U and V returning 0 for equality, a
383    positive value for U > V and a negative for U < V. */
384 int gcry_mpi_cmp (const gcry_mpi_t u, const gcry_mpi_t v);
385
386 /* Compare the big integer number U with the unsigned integer V
387    returning 0 for equality, a positive value for U > V and a negative
388    for U < V. */
389 int gcry_mpi_cmp_ui (const gcry_mpi_t u, unsigned long v);
390
391 /* Convert the external representation of an integer stored in BUFFER
392    with a length of BUFLEN into a newly create MPI returned in
393    RET_MPI.  If NSCANNED is not NULL, it will receive the number of
394    bytes actually scanned after a successful operation. */
395 gcry_error_t gcry_mpi_scan (gcry_mpi_t *ret_mpi, enum gcry_mpi_format format,
396                             const unsigned char *buffer, size_t buflen, 
397                             size_t *nscanned);
398
399 /* Convert the big integer A into the external representation
400    described by FORMAT and store it in the provided BUFFER which has
401    been allocated by the user with a size of BUFLEN bytes.  NWRITTEN
402    receives the actual length of the external representation unless it
403    has been passed as NULL. */
404 gcry_error_t gcry_mpi_print (enum gcry_mpi_format format,
405                              unsigned char *buffer, size_t buflen,
406                              size_t *nwritten,
407                              const gcry_mpi_t a);
408
409 /* Convert the big integer A int the external representation described
410    by FORMAT and store it in a newly allocated buffer which address
411    will be put into BUFFER.  NWRITTEN receives the actual lengths of the
412    external representation. */
413 gcry_error_t gcry_mpi_aprint (enum gcry_mpi_format format,
414                               unsigned char **buffer, size_t *nwritten,
415                               const gcry_mpi_t a);
416
417 /* Dump the value of A in a format suitable for debugging to
418    Libgcrypt's logging stream.  Note that one leading space but no
419    trailing space or linefeed will be printed.  It is okay to pass
420    NULL for A. */
421 void gcry_mpi_dump (const gcry_mpi_t a);
422
423
424 /* W = U + V.  */
425 void gcry_mpi_add (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
426
427 /* W = U + V.  V is an unsigned integer. */
428 void gcry_mpi_add_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v);
429
430 /* W = U + V mod M. */
431 void gcry_mpi_addm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
432
433 /* W = U - V. */
434 void gcry_mpi_sub (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
435
436 /* W = U - V.  V is an unsigned integer. */
437 void gcry_mpi_sub_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
438
439 /* W = U - V mod M */
440 void gcry_mpi_subm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
441
442 /* W = U * V. */
443 void gcry_mpi_mul (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
444
445 /* W = U * V.  V is an unsigned integer. */
446 void gcry_mpi_mul_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
447
448 /* W = U * V mod M. */
449 void gcry_mpi_mulm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
450
451 /* W = U * (2 ^ CNT). */
452 void gcry_mpi_mul_2exp (gcry_mpi_t w, gcry_mpi_t u, unsigned long cnt);
453
454 /* Q = DIVIDEND / DIVISOR, R = DIVIDEND % DIVISOR,
455    Q or R may be passed as NULL.  ROUND should be negative or 0. */
456 void gcry_mpi_div (gcry_mpi_t q, gcry_mpi_t r,
457                    gcry_mpi_t dividend, gcry_mpi_t divisor, int round);
458
459 /* R = DIVIDEND % DIVISOR */
460 void gcry_mpi_mod (gcry_mpi_t r, gcry_mpi_t dividend, gcry_mpi_t divisor);
461
462 /* W = B ^ E mod M. */
463 void gcry_mpi_powm (gcry_mpi_t w,
464                     const gcry_mpi_t b, const gcry_mpi_t e, const gcry_mpi_t m);
465
466 /* Set G to the greatest common divisor of A and B.  
467    Return true if the G is 1. */
468 int gcry_mpi_gcd (gcry_mpi_t g, gcry_mpi_t a, gcry_mpi_t b);
469
470 /* Set X to the multiplicative inverse of A mod M.
471    Return true if the value exists. */
472 int gcry_mpi_invm (gcry_mpi_t x, gcry_mpi_t a, gcry_mpi_t m);
473
474
475 /* Return the number of bits required to represent A. */
476 unsigned int gcry_mpi_get_nbits (gcry_mpi_t a);
477
478 /* Return true when bit number N (counting from 0) is set in A. */
479 int      gcry_mpi_test_bit (gcry_mpi_t a, unsigned int n);
480
481 /* Set bit number N in A. */
482 void     gcry_mpi_set_bit (gcry_mpi_t a, unsigned int n);
483
484 /* Clear bit number N in A. */
485 void     gcry_mpi_clear_bit (gcry_mpi_t a, unsigned int n);
486
487 /* Set bit number N in A and clear all bits greater than N. */
488 void     gcry_mpi_set_highbit (gcry_mpi_t a, unsigned int n);
489
490 /* Clear bit number N in A and all bits greater than N. */
491 void     gcry_mpi_clear_highbit (gcry_mpi_t a, unsigned int n);
492
493 /* Shift the value of A by N bits to the right and store the result in X. */
494 void     gcry_mpi_rshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
495
496 /* Store NBITS of the value P points to in A and mark A as an opaque
497    value.  WARNING: Never use an opaque MPI for anything thing else then 
498    gcry_mpi_release, gcry_mpi_get_opaque. */
499 gcry_mpi_t gcry_mpi_set_opaque (gcry_mpi_t a, void *p, unsigned int nbits);
500
501 /* Return a pointer to an opaque value stored in A and return its size
502    in NBITS.  Note that the returned pointer is still owned by A and
503    that the function should never be used for an non-opaque MPI. */
504 void *gcry_mpi_get_opaque (gcry_mpi_t a, unsigned int *nbits);
505
506 /* Set the FLAG for the big integer A.  Currently only the flag
507    GCRYMPI_FLAG_SECURE is allowed to convert A into an big intger
508    stored in "secure" memory. */
509 void gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
510
511 /* Clear FLAG for the big integer A.  Note that this function is
512    currently useless as no flags are allowed. */
513 void gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
514
515 /* Return true when the FLAG is set for A. */
516 int gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
517
518 /* Unless the GCRYPT_NO_MPI_MACROS is used, provide a couple of
519    convenience macors for the big integer functions. */
520 #ifndef GCRYPT_NO_MPI_MACROS
521 #define mpi_new(n)          gcry_mpi_new( (n) )
522 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
523 #define mpi_release(a)      \
524   do \
525     { \
526       gcry_mpi_release ((a)); \
527       (a) = NULL; \
528     } \
529   while (0)
530
531 #define mpi_copy( a )       gcry_mpi_copy( (a) )
532 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
533 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
534 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
535 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
536
537 #define mpi_add_ui(w,u,v)   gcry_mpi_add_ui((w),(u),(v))
538 #define mpi_add(w,u,v)      gcry_mpi_add ((w),(u),(v))
539 #define mpi_addm(w,u,v,m)   gcry_mpi_addm ((w),(u),(v),(m))
540 #define mpi_sub_ui(w,u,v)   gcry_mpi_sub_ui ((w),(u),(v))
541 #define mpi_sub(w,u,v)      gcry_mpi_sub ((w),(u),(v))
542 #define mpi_subm(w,u,v,m)   gcry_mpi_subm ((w),(u),(v),(m))
543 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
544 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
545 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
546 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
547 #define mpi_powm(w,b,e,m)   gcry_mpi_powm ( (w), (b), (e), (m) )
548 #define mpi_tdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), 0)
549 #define mpi_fdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), -1)
550 #define mpi_mod(r,a,m)      gcry_mpi_mod ((r), (a), (m))
551 #define mpi_gcd(g,a,b)      gcry_mpi_gcd ( (g), (a), (b) )
552 #define mpi_invm(g,a,b)     gcry_mpi_invm ( (g), (a), (b) )
553
554 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
555 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
556 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
557 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
558 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
559 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
560 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
561
562 #define mpi_set_opaque(a,b,c) gcry_mpi_set_opaque( (a), (b), (c) )
563 #define mpi_get_opaque(a,b)   gcry_mpi_get_opaque( (a), (b) )
564 #endif /* GCRYPT_NO_MPI_MACROS */
565
566
567 \f
568 /************************************
569  *                                  *
570  *   symmetric cipher functions     *
571  *                                  *
572  ************************************/
573
574 /* The data object used to hold a handle to an encryption object.  */
575 struct gcry_cipher_handle;
576 typedef struct gcry_cipher_handle *gcry_cipher_hd_t;
577
578 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD _GCRY_GCC_ATTR_DEPRECATED;
579 typedef struct gcry_cipher_handle *GcryCipherHd _GCRY_GCC_ATTR_DEPRECATED;
580
581 /* All symmetric encryption algorithms are identified by their IDs.
582    More IDs may be registered at runtime. */
583 enum gcry_cipher_algos
584   {
585     GCRY_CIPHER_NONE        = 0,
586     GCRY_CIPHER_IDEA        = 1,
587     GCRY_CIPHER_3DES        = 2,
588     GCRY_CIPHER_CAST5       = 3,
589     GCRY_CIPHER_BLOWFISH    = 4,
590     GCRY_CIPHER_SAFER_SK128 = 5,
591     GCRY_CIPHER_DES_SK      = 6,
592     GCRY_CIPHER_AES         = 7,
593     GCRY_CIPHER_AES192      = 8,
594     GCRY_CIPHER_AES256      = 9,
595     GCRY_CIPHER_TWOFISH     = 10,
596
597     /* other cipher numbers are above 300 for OpenPGP reasons. */
598     GCRY_CIPHER_ARCFOUR     = 301,  /* fully compatible with RSA's RC4 (tm). */
599     GCRY_CIPHER_DES         = 302,  /* Yes, this is single key 56 bit DES. */
600     GCRY_CIPHER_TWOFISH128  = 303,
601     GCRY_CIPHER_SERPENT128  = 304,
602     GCRY_CIPHER_SERPENT192  = 305,
603     GCRY_CIPHER_SERPENT256  = 306,
604     
605   };
606
607 /* The Rijndael algorithm is basically AES, so provide some macros. */
608 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES    
609 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES    
610 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128 
611 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192 
612 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256 
613
614 /* The supported encryption modes.  Note that not all of them are
615    supported for each algorithm. */
616 enum gcry_cipher_modes 
617   {
618     GCRY_CIPHER_MODE_NONE   = 0,  /* Not yet specified. */
619     GCRY_CIPHER_MODE_ECB    = 1,  /* Electronic codebook. */
620     GCRY_CIPHER_MODE_CFB    = 2,  /* Cipher feedback. */
621     GCRY_CIPHER_MODE_CBC    = 3,  /* Cipher block chaining. */
622     GCRY_CIPHER_MODE_STREAM = 4,  /* Used with stream ciphers. */
623     GCRY_CIPHER_MODE_OFB    = 5,  /* Outer feedback. */
624     GCRY_CIPHER_MODE_CTR    = 6   /* Counter. */
625   };
626
627 /* Flags used with the open function. */ 
628 enum gcry_cipher_flags
629   {
630     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
631     GCRY_CIPHER_ENABLE_SYNC = 2,  /* Enable CFB sync mode. */
632     GCRY_CIPHER_CBC_CTS     = 4,  /* Enable CBC cipher text stealing (CTS). */
633     GCRY_CIPHER_CBC_MAC     = 8   /* Enable CBC message auth. code (MAC). */
634   };
635
636
637 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
638    be given as an bitwise OR of the gcry_cipher_flags values. */
639 gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *handle,
640                               int algo, int mode, unsigned int flags);
641
642 /* Close the cioher handle H and release all resource. */
643 void gcry_cipher_close (gcry_cipher_hd_t h);
644
645 /* Perform various operations on the cipher object H. */
646 gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer,
647                              size_t buflen);
648
649 /* Retrieve various information about the cipher object H. */
650 gcry_error_t gcry_cipher_info (gcry_cipher_hd_t h, int what, void *buffer,
651                               size_t *nbytes);
652
653 /* Retrieve various information about the cipher algorithm ALGO. */
654 gcry_error_t gcry_cipher_algo_info (int algo, int what, void *buffer,
655                                    size_t *nbytes);
656
657 /* Map the cipher algorithm id ALGO to a string representation of that
658    algorithm name.  For unknown algorithms this functions returns an
659    empty string. */
660 const char *gcry_cipher_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
661
662 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
663    the algorithm name is not known. */
664 int gcry_cipher_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
665
666 /* Given an ASN.1 object identifier in standard IETF dotted decimal
667    format in STRING, return the encryption mode associated with that
668    OID or 0 if not known or applicable. */
669 int gcry_cipher_mode_from_oid (const char *string) _GCRY_GCC_ATTR_PURE;
670
671 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
672    into the buffer OUT which has an allocated length of OUTSIZE.  For
673    most algorithms it is possible to pass NULL for in and 0 for INLEN
674    and do a in-place decryption of the data provided in OUT.  */
675 gcry_error_t gcry_cipher_encrypt (gcry_cipher_hd_t h,
676                                  unsigned char *out, size_t outsize,
677                                  const unsigned char *in, size_t inlen);
678
679 /* The counterpart to gcry_cipher_encrypt.  */
680 gcry_error_t gcry_cipher_decrypt (gcry_cipher_hd_t h,
681                                  unsigned char *out, size_t outsize,
682                                  const unsigned char *in, size_t inlen);
683
684 /* Set key K of length L for the cipher handle H.  (We have to cast
685    away a const char* here - this catch-all ctl function was probably
686    not the best choice) */
687 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
688                                                          (char*)(k), (l) )
689
690 /* Set initialization vector K of length L for the cipher handle H. */
691 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
692                                                          (char*)(k), (l) )
693
694 /* Reset the handle to the state after open.  */
695 #define gcry_cipher_reset(h)  gcry_cipher_ctl ((h), GCRYCTL_RESET, NULL, 0)
696
697 /* Perform the the OpenPGP sync operation if this is enabled for the
698    cipher handle H. */
699 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
700                                                                    NULL, 0 )
701
702 /* Enable or disable CTS in future calls to gcry_encrypt(). CBC mode only. */
703 #define gcry_cipher_cts(h,on)  gcry_cipher_ctl( (h), GCRYCTL_SET_CBC_CTS, \
704                                                                    NULL, on )
705
706 /* Set counter for CTR mode.  (K,L) must denote a buffer of block size
707    length, or (NULL,0) to set the CTR to the all-zero block. */
708 #define gcry_cipher_setctr(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_CTR, \
709                                                     (char*)(k), (l) )
710
711 /* Retrieved the key length used with algorithm A. */
712 size_t gcry_cipher_get_algo_keylen (int algo);
713
714 /* Retrieve the block length used with algorithm A. */
715 size_t gcry_cipher_get_algo_blklen (int algo);
716
717 /* Return 0 if the algorithm A is available for use. */
718 #define gcry_cipher_test_algo(a) \
719             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
720
721 /* Get a list consisting of the IDs of the loaded cipher modules.  If
722    LIST is zero, write the number of loaded cipher modules to
723    LIST_LENGTH and return.  If LIST is non-zero, the first
724    *LIST_LENGTH algorithm IDs are stored in LIST, which must be of
725    according size.  In case there are less cipher modules than
726    *LIST_LENGTH, *LIST_LENGTH is updated to the correct number.  */
727 gcry_error_t gcry_cipher_list (int *list, int *list_length);
728
729 \f
730 /************************************
731  *                                  *
732  *    asymmetric cipher functions   *
733  *                                  *
734  ************************************/
735
736 /* The algorithms and their IDs we support. */
737 enum gcry_pk_algos 
738   {
739     GCRY_PK_RSA = 1,
740     GCRY_PK_RSA_E = 2,      /* deprecated */
741     GCRY_PK_RSA_S = 3,      /* deprecated */
742     GCRY_PK_ELG_E = 16,     /* use only for OpenPGP */
743     GCRY_PK_DSA   = 17,
744     GCRY_PK_ELG   = 20
745   };
746
747 /* Flags describing usage capabilities of a PK algorithm. */
748 #define GCRY_PK_USAGE_SIGN 1
749 #define GCRY_PK_USAGE_ENCR 2
750
751 /* Encrypt the DATA using the public key PKEY and store the result as
752    a newly created S-expression at RESULT. */
753 gcry_error_t gcry_pk_encrypt (gcry_sexp_t *result, gcry_sexp_t data, gcry_sexp_t pkey);
754
755 /* Decrypt the DATA using the private key SKEY and store the result as
756    a newly created S-expression at RESULT. */
757 gcry_error_t gcry_pk_decrypt (gcry_sexp_t *result, gcry_sexp_t data, gcry_sexp_t skey);
758
759 /* Sign the DATA using the private key SKEY and store the result as
760    a newly created S-expression at RESULT. */
761 gcry_error_t gcry_pk_sign (gcry_sexp_t *result, gcry_sexp_t data, gcry_sexp_t skey);
762
763 /* Check the signature SIGVAL on DATA using the public key PKEY. */
764 gcry_error_t gcry_pk_verify (gcry_sexp_t sigval, gcry_sexp_t data, gcry_sexp_t pkey);
765
766 /* Check that KEY (either private or public) is sane. */
767 gcry_error_t gcry_pk_testkey (gcry_sexp_t key);
768
769 /* Generate a new key pair according to the parameters given in
770    S_PARMS.  The new key pair is returned in as an S-expression in
771    R_KEY. */
772 gcry_error_t gcry_pk_genkey (gcry_sexp_t *r_key, gcry_sexp_t s_parms);
773
774 /* Catch all function for miscellaneous operations. */
775 gcry_error_t gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
776
777 /* Retrieve information about the public key algorithm ALGO. */
778 gcry_error_t gcry_pk_algo_info (int algo, int what, void *buffer, size_t *nbytes);
779
780 /* Map the public key algorithm id ALGO to a string representation of the
781    algorithm name.  For unknown algorithms this functions returns an
782    empty string. */
783 const char *gcry_pk_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
784
785 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
786    the algorithm name is not known. */
787 int gcry_pk_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
788
789 /* Return what is commonly referred as the key length for the given
790    public or private KEY.  */
791 unsigned int gcry_pk_get_nbits (gcry_sexp_t key) _GCRY_GCC_ATTR_PURE;
792
793 /* Please note that keygrip is still experimental and should not be
794    used without contacting the author. */
795 unsigned char *gcry_pk_get_keygrip (gcry_sexp_t key, unsigned char *array);
796
797 /* Return 0 if the public key algorithm A is available for use. */
798 #define gcry_pk_test_algo(a) \
799             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
800
801 /* Get a list consisting of the IDs of the loaded pubkey modules.  If
802    LIST is zero, write the number of loaded pubkey modules to
803    LIST_LENGTH and return.  If LIST is non-zero, the first
804    *LIST_LENGTH algorithm IDs are stored in LIST, which must be of
805    according size.  In case there are less pubkey modules than
806    *LIST_LENGTH, *LIST_LENGTH is updated to the correct number.  */
807 gcry_error_t gcry_pk_list (int *list, int *list_length);
808
809 /* Alternative interface for asymetric cryptography.  */
810
811 /* The algorithm IDs. */
812 typedef enum gcry_ac_id
813   {
814     GCRY_AC_RSA = 1,
815     GCRY_AC_DSA = 17,
816     GCRY_AC_ELG = 20,
817   }
818 gcry_ac_id_t;
819
820 /* Key types.  */
821 typedef enum gcry_ac_key_type
822   {
823     GCRY_AC_KEY_SECRET,
824     GCRY_AC_KEY_PUBLIC,
825   }
826 gcry_ac_key_type_t;
827
828 /* Flags for data. */
829 #define GCRY_AC_FLAG_DATA_NO_BLINDING 1 << 0
830
831 /* This type represents a `data set'.  */
832 typedef struct gcry_ac_data *gcry_ac_data_t;
833
834 /* This type represents a single `key', either a secret one or a
835    public one.  */
836 typedef struct gcry_ac_key *gcry_ac_key_t;
837
838 /* This type represents a `key pair' containing a secret and a public
839    key.  */
840 typedef struct gcry_ac_key_pair *gcry_ac_key_pair_t;
841
842 /* This type represents a `handle' that is needed by functions
843    performing cryptographic operations.  */
844 typedef struct gcry_ac_handle *gcry_ac_handle_t;
845
846 /* The caller of gcry_ac_key_pair_generate can provide one of these
847    structures in order to influence the key generation process in an
848    algorithm-specific way.  */
849 typedef struct gcry_ac_key_spec_rsa
850 {
851   gcry_mpi_t e;                 /* E to use.  */
852 } gcry_ac_key_spec_rsa_t;
853
854 /* Returns a new, empty data set in DATA.  */
855 gcry_error_t gcry_ac_data_new (gcry_ac_data_t *data);
856
857 /* Destroy the data set DATA.  */
858 void gcry_ac_data_destroy (gcry_ac_data_t data);
859
860 /* Add the value MPI to DATA with the label NAME.  If there is already
861    a value with that label, replace it, otherwise add it.  */
862 gcry_error_t gcry_ac_data_set (gcry_ac_data_t data,
863                               const char *name,
864                               gcry_mpi_t mpi);
865
866 /* Create a copy of the data set DATA and store it in DATA_CP.  */
867 gcry_error_t gcry_ac_data_copy (gcry_ac_data_t *data_cp,
868                                gcry_ac_data_t data);
869
870 /* Return the number of named MPI values inside of the data set
871    DATA.  */
872 unsigned int gcry_ac_data_length (gcry_ac_data_t data);
873
874 /* Store the value labelled with NAME found in DATA in MPI or NULL if
875    a value with that label was not found.  */
876 gcry_error_t gcry_ac_data_get_name (gcry_ac_data_t data, const char *name,
877                                    gcry_mpi_t *mpi);
878
879 /* Return the MPI value with index INDEX contained in the data set
880    DATA.  */
881 gcry_error_t gcry_ac_data_get_index (gcry_ac_data_t data, unsigned int index,
882                                     const char **name, gcry_mpi_t *mpi);
883
884 /* Destroy any values contained in the data set DATA.  */
885 void gcry_ac_data_clear (gcry_ac_data_t data);
886
887 /* Create a new ac handle.  */
888 gcry_error_t gcry_ac_open (gcry_ac_handle_t *handle,
889                           gcry_ac_id_t algorithm,
890                           unsigned int flags);
891
892 /* Destroy an ac handle.  */
893 void gcry_ac_close (gcry_ac_handle_t handle);
894
895 /* Initialize a key from a given data set.  */
896 gcry_error_t gcry_ac_key_init (gcry_ac_key_t *key,
897                               gcry_ac_handle_t handle,
898                               gcry_ac_key_type_t type,
899                               gcry_ac_data_t data);
900
901 /* Generate a new key pair.  */
902 gcry_error_t gcry_ac_key_pair_generate (gcry_ac_handle_t handle,
903                                        gcry_ac_key_pair_t *key_pair,
904                                        unsigned int nbits,
905                                        void *spec);
906
907 /* Returns a specified key from a key pair.  */
908 gcry_ac_key_t gcry_ac_key_pair_extract (gcry_ac_key_pair_t key_pair,
909                                         gcry_ac_key_type_t which);
910
911 /* Returns the data set contained in the key KEY.  */
912 gcry_ac_data_t gcry_ac_key_data_get (gcry_ac_key_t key);
913
914 /* Verify that the key KEY is sane.  */
915 gcry_error_t gcry_ac_key_test (gcry_ac_key_t key);
916
917 /* Return the number of bits of the key KEY in NBITS.  */
918 gcry_error_t gcry_ac_key_get_nbits (gcry_ac_key_t key,
919                                    unsigned int *nbits);
920
921 /* Write the 20 byte long key grip of the key KEY to KEY_GRIP.  */
922 gcry_error_t gcry_ac_key_get_grip (gcry_ac_key_t key,
923                                   unsigned char *key_grip);
924
925 /* Destroy a key.  */
926 void gcry_ac_key_destroy (gcry_ac_key_t key);
927
928 /* Destroy a key pair.  */
929 void gcry_ac_key_pair_destroy (gcry_ac_key_pair_t key_pair);
930
931 /* Encrypt the plain text MPI value DATA_PLAIN with the key KEY under
932    the control of the flags FLAGS and store the resulting data set
933    into DATA_ENCRYPTED.  */
934 gcry_error_t gcry_ac_data_encrypt (gcry_ac_handle_t handle,
935                                   unsigned int flags,
936                                   gcry_ac_key_t key,
937                                   gcry_mpi_t data_plain,
938                                   gcry_ac_data_t *data_encrypted);
939
940 /* Decrypt the decrypted data contained in the data set DATA_ENCRYPTED
941    with the key KEY under the control of the flags FLAGS and store the
942    resulting plain text MPI value in DATA_PLAIN.  */
943 gcry_error_t gcry_ac_data_decrypt (gcry_ac_handle_t handle,
944                                   unsigned int flags,
945                                   gcry_ac_key_t key,
946                                   gcry_mpi_t *data_plain,
947                                   gcry_ac_data_t data_encrypted);
948
949 /* Sign the data contained in DATA with the key KEY and store the
950    resulting signature in the data set DATA_SIGNATURE.  */
951 gcry_error_t gcry_ac_data_sign (gcry_ac_handle_t handle,
952                                gcry_ac_key_t key,
953                                gcry_mpi_t data,
954                                gcry_ac_data_t *data_signature);
955
956 /* Verify that the signature contained in the data set DATA_SIGNATURE
957    is indeed the result of signing the data contained in DATA with the
958    secret key belonging to the public key KEY.  */
959 gcry_error_t gcry_ac_data_verify (gcry_ac_handle_t handle,
960                                  gcry_ac_key_t key,
961                                  gcry_mpi_t data,
962                                  gcry_ac_data_t data_signature);
963
964 /* Store the textual representation of the algorithm whose id is given
965    in ALGORITHM in NAME.  */
966 gcry_error_t gcry_ac_id_to_name (gcry_ac_id_t algorithm,
967                                 const char **name);
968
969 /* Store the numeric ID of the algorithm whose textual representation
970    is contained in NAME in ALGORITHM.  */
971 gcry_error_t gcry_ac_name_to_id (const char *name,
972                                 gcry_ac_id_t *algorithm);
973
974 \f
975
976 /************************************
977  *                                  *
978  *   cryptograhic hash functions    *
979  *                                  *
980  ************************************/
981
982 /* Algorithm IDs for the hash functions we know about. Not all of them
983    are implemnted. */
984 enum gcry_md_algos
985   {
986     GCRY_MD_NONE    = 0,  
987     GCRY_MD_MD5     = 1,
988     GCRY_MD_SHA1    = 2,
989     GCRY_MD_RMD160  = 3,
990     GCRY_MD_MD2     = 5,
991     GCRY_MD_TIGER   = 6,   /* TIGER/192. */
992     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
993     GCRY_MD_SHA256  = 8,
994     GCRY_MD_SHA384  = 9,
995     GCRY_MD_SHA512  = 10,
996     GCRY_MD_MD4     = 301,
997     GCRY_MD_CRC32               = 302,
998     GCRY_MD_CRC32_RFC1510       = 303,
999     GCRY_MD_CRC24_RFC2440       = 304
1000   };
1001
1002 /* Flags used with the open function. */
1003
1004 /* Allocate all buffers in "secure" memory.  */
1005 #define GCRY_MD_FLAG_SECURE 1 << 0
1006 /* Make an HMAC out of this algorithm.  */
1007 #define GCRY_MD_FLAG_HMAC   1 << 1
1008
1009 /* Forward declaration.  */
1010 struct gcry_md_context;
1011
1012 /* This object is used to hold a handle to a message digest object.
1013    This structure is private - only to be used by the public gcry_md_*
1014    macros.  */
1015 typedef struct gcry_md_handle 
1016 {
1017   /* Actual context.  */
1018   struct gcry_md_context *ctx;
1019   
1020   /* Buffer management.  */
1021   int  bufpos;
1022   int  bufsize;
1023   unsigned char buf[1];
1024 } *gcry_md_hd_t;
1025
1026 /* Compatibility types, do not use them.  */
1027 typedef struct gcry_md_handle *GCRY_MD_HD _GCRY_GCC_ATTR_DEPRECATED;
1028 typedef struct gcry_md_handle *GcryMDHd _GCRY_GCC_ATTR_DEPRECATED;
1029
1030 /* Create a message digest object for algorithm ALGO.  FLAGS may be
1031    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
1032    given as 0 if the algorithms to be used are later set using
1033    gcry_md_enable.  */
1034 gcry_error_t gcry_md_open (gcry_md_hd_t *h, int algo, unsigned int flags);
1035
1036 /* Release the message digest object HD.  */
1037 void gcry_md_close (gcry_md_hd_t hd);
1038
1039 /* Add the message digest algorithm ALGO to the digest object HD.  */
1040 gcry_error_t gcry_md_enable (gcry_md_hd_t hd, int algo);
1041
1042 /* Create a new digest object as an exact copy of the object HD.  */
1043 gcry_error_t gcry_md_copy (gcry_md_hd_t *bhd, gcry_md_hd_t ahd);
1044
1045 /* Reset the digest object HD to its initial state.  */
1046 void gcry_md_reset (gcry_md_hd_t hd);
1047
1048 /* Perform various operations on the digets object HD. */
1049 gcry_error_t gcry_md_ctl (gcry_md_hd_t hd, int cmd, unsigned char *buffer,
1050                          size_t buflen);
1051
1052 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
1053    it can update the digest values.  This is the actual hash
1054    function. */
1055 void gcry_md_write (gcry_md_hd_t hd, const void *buffer, size_t length);
1056
1057 /* Read out the final digest from HD return the digest value for
1058    algorithm ALGO. */
1059 unsigned char *gcry_md_read (gcry_md_hd_t hd, int algo);
1060
1061 /* Convenience function to calculate the hash from the data in BUFFER
1062    of size LENGTH using the algorithm ALGO avoiding the creating of a
1063    hash object.  The hash is returned in the caller provided buffer
1064    DIGEST which must be large enough to hold the digest of the given
1065    algorithm. */
1066 void gcry_md_hash_buffer (int algo, void *digest,
1067                           const void *buffer, size_t length);
1068
1069 /* Retrieve the algorithm used with HD.  This does not work reliable
1070    if more than one algorithm is enabled in HD. */
1071 int gcry_md_get_algo (gcry_md_hd_t hd);
1072
1073 /* Retrieve the length in bytes of the digest yielded by algorithm
1074    ALGO. */
1075 unsigned int gcry_md_get_algo_dlen (int algo);
1076
1077 /* Return true if the the algorithm ALGO is enabled in the digest
1078    object A. */
1079 int gcry_md_is_enabled (gcry_md_hd_t a, int algo);
1080
1081 /* Return true if the digest object A is allocated in "secure" memory. */
1082 int gcry_md_is_secure (gcry_md_hd_t a);
1083
1084 /* Retrieve various information about the object H.  */
1085 gcry_error_t gcry_md_info (gcry_md_hd_t h, int what, void *buffer,
1086                           size_t *nbytes);
1087
1088 /* Retrieve various information about the algorithm ALGO.  */
1089 gcry_error_t gcry_md_algo_info (int algo, int what, void *buffer,
1090                                size_t *nbytes);
1091
1092 /* Map the digest algorithm id ALGO to a string representation of the
1093    algorithm name.  For unknown algorithms this functions returns an
1094    empty string. */
1095 const char *gcry_md_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
1096
1097 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
1098    the algorithm name is not known. */
1099 int gcry_md_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1100
1101 /* For use with the HMAC feature, the set MAC key to the KEY of
1102    KEYLEN. */
1103 gcry_error_t gcry_md_setkey (gcry_md_hd_t hd, const void *key, size_t keylen);
1104
1105 /* Update the hash(s) of H with the character C.  This is a buffered
1106    version of the gcry_md_write function. */
1107 #define gcry_md_putc(h,c)  \
1108             do {                                          \
1109                 gcry_md_hd_t h__ = (h);                       \
1110                 if( (h__)->bufpos == (h__)->bufsize )     \
1111                     gcry_md_write( (h__), NULL, 0 );      \
1112                 (h__)->buf[(h__)->bufpos++] = (c) & 0xff; \
1113             } while(0)
1114
1115 /* Finalize the digest calculation.  This is not really needed because
1116    gcry_md_read() does this implicitly. */
1117 #define gcry_md_final(a) \
1118             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
1119
1120 /* Return 0 if the algorithm A is available for use. */
1121 #define gcry_md_test_algo(a) \
1122             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1123
1124 /* Return an DER encoded ASN.1 OID for the algorithm A in buffer B. N
1125    must point to size_t variable with the available size of buffer B.
1126    After return it will receive the actual size of the returned
1127    OID. */
1128 #define gcry_md_get_asnoid(a,b,n) \
1129             gcry_md_algo_info((a), GCRYCTL_GET_ASNOID, (b), (n))
1130
1131 /* Enable debugging for digets object A; i.e. create files named
1132    dbgmd-<n>.<string> while hashing.  B is a string used as the suffix
1133    for the filename. */
1134 #define gcry_md_start_debug(a,b) \
1135             gcry_md_ctl( (a), GCRYCTL_START_DUMP, (b), 0 )
1136
1137 /* Disable the debugging of A. */
1138 #define gcry_md_stop_debug(a,b) \
1139             gcry_md_ctl( (a), GCRYCTL_STOP_DUMP, (b), 0 )
1140
1141 /* Get a list consisting of the IDs of the loaded message digest
1142    modules.  If LIST is zero, write the number of loaded message
1143    digest modules to LIST_LENGTH and return.  If LIST is non-zero, the
1144    first *LIST_LENGTH algorithm IDs are stored in LIST, which must be
1145    of according size.  In case there are less message digest modules
1146    than *LIST_LENGTH, *LIST_LENGTH is updated to the correct
1147    number.  */
1148 gcry_error_t gcry_md_list (int *list, int *list_length);
1149
1150 \f
1151 /************************************
1152  *                                  *
1153  *   random generating functions    *
1154  *                                  *
1155  ************************************/
1156
1157 /* The possible values for the random quality.  The rule of thumb is
1158    to use WEAK for random number which don't need to be
1159    cryptographically strong, STRONG for session keys and VERY_STRONG
1160    for key material. */
1161 enum gcry_random_level
1162   {
1163     GCRY_WEAK_RANDOM = 0,
1164     GCRY_STRONG_RANDOM = 1,
1165     GCRY_VERY_STRONG_RANDOM = 2
1166   };
1167
1168
1169 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
1170    quality LEVEL. */
1171 void gcry_randomize (unsigned char *buffer, size_t length,
1172                      enum gcry_random_level level);
1173
1174 /* Add the external random from BUFFER with LENGTH bytes into the
1175    pool. QUALITY should either be -1 for unknown or in the range of 0
1176    to 100 */
1177 gcry_error_t gcry_random_add_bytes (const void *buffer, size_t length,
1178                                    int quality);
1179
1180 /* Return NBYTES of allocated random using a random numbers of quality
1181    LEVEL. */
1182 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level)
1183                          _GCRY_GCC_ATTR_MALLOC;
1184
1185 /* Return NBYTES of allocated random using a random numbers of quality
1186    LEVEL.  The random numbers are created returned in "secure"
1187    memory. */
1188 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level)
1189                                 _GCRY_GCC_ATTR_MALLOC;
1190
1191
1192 /* Set the big inetger W to a random value of NBITS using a random
1193    generator with quality LEVEL. */
1194 void gcry_mpi_randomize (gcry_mpi_t w,
1195                          unsigned int nbits, enum gcry_random_level level);
1196
1197
1198 \f
1199 /************************************
1200  *                                  *
1201  *     miscellaneous stuff          *
1202  *                                  *
1203  ************************************/
1204
1205 /* Log levels used by the internal logging facility. */
1206 enum gcry_log_levels 
1207   {
1208     GCRY_LOG_CONT   = 0,    /* continue the last log line */
1209     GCRY_LOG_INFO   = 10,
1210     GCRY_LOG_WARN   = 20,
1211     GCRY_LOG_ERROR  = 30,
1212     GCRY_LOG_FATAL  = 40,
1213     GCRY_LOG_BUG    = 50,
1214     GCRY_LOG_DEBUG  = 100
1215   };
1216
1217 /* Type for progress handlers.  */
1218 typedef void (*gcry_handler_progress_t) (void *, const char *, int, int, int);
1219
1220 /* Type for memory allocation handlers.  */
1221 typedef void *(*gcry_handler_alloc_t) (size_t n);
1222
1223 /* Type for secure memory check handlers.  */
1224 typedef int (*gcry_handler_secure_check_t) (const void *);
1225
1226 /* Type for memory reallocation handlers.  */
1227 typedef void *(*gcry_handler_realloc_t) (void *p, size_t n);
1228
1229 /* Type for memory free handlers.  */
1230 typedef void (*gcry_handler_free_t) (void *);
1231
1232 /* Type for out-of-memory handlers.  */
1233 typedef int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int);
1234
1235 /* Type for fatal error handlers.  */
1236 typedef void (*gcry_handler_error_t) (void *, int, const char *);
1237
1238 /* Type for logging handlers.  */
1239 typedef void (*gcry_handler_log_t) (void *, int, const char *, va_list);
1240
1241 /* Certain operations can provide progress information.  This function
1242    is used to register a handler for retrieving these information. */
1243 void gcry_set_progress_handler (gcry_handler_progress_t cb, void *cb_data);
1244
1245
1246 /* Register a custom memory allocation functions. */
1247 void gcry_set_allocation_handler (gcry_handler_alloc_t func_alloc,
1248                                   gcry_handler_alloc_t func_alloc_secure,
1249                                   gcry_handler_secure_check_t func_secure_check,
1250                                   gcry_handler_realloc_t func_realloc,
1251                                   gcry_handler_free_t func_free);
1252
1253 /* Register a function used instead of the internal out of memory
1254    handler. */
1255 void gcry_set_outofcore_handler (gcry_handler_no_mem_t h, void *opaque);
1256
1257 /* Register a function used instead of the internal fatal error
1258    handler. */
1259 void gcry_set_fatalerror_handler (gcry_handler_error_t fnc, void *opaque);
1260
1261 /* Register a function used instead of the internal logging
1262    facility. */
1263 void gcry_set_log_handler (gcry_handler_log_t f, void *opaque);
1264
1265 /* Reserved for future use. */
1266 void gcry_set_gettext_handler (const char *(*f)(const char*));
1267
1268 /* Libgcrypt uses its own memory allocation.  It is important to use
1269    gcry_free () to release memory allocated by libgcrypt. */
1270 void *gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1271 void *gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1272 void *gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1273 void *gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1274 void *gcry_realloc (void *a, size_t n);
1275 char *gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
1276 void *gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1277 void *gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1278 void *gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1279 void *gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1280 void *gcry_xrealloc (void *a, size_t n);
1281 char *gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
1282 void  gcry_free (void *a);
1283
1284 /* Return true if A is allocated in "secure" memory. */
1285 int gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
1286
1287 /* Include support for Libgcrypt modules.  */
1288 #include <gcrypt-module.h>
1289
1290 #if 0 /* keep Emacsens's auto-indent happy */
1291 {
1292 #endif
1293 #ifdef __cplusplus
1294 }
1295 #endif
1296 #endif /* _GCRYPT_H */