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