8bd259e2c67e3e02ec6a74af6e868bf4bcd59b2e
[libgcrypt.git] / src / gcrypt.h
1 /* gcrypt.h -  GNU cryptographic library interface
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004, 2006  Free Software Foundation, Inc.
4  *
5  * This file is part of Libgcrypt.
6  *
7  * Libgcrypt is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Libgcrypt is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #ifndef _GCRYPT_H
23 #define _GCRYPT_H
24
25 #include <stdarg.h>
26 #include <string.h>
27
28 #include <gpg-error.h>
29
30 #include <sys/types.h>
31
32 #if defined _WIN32 || defined __WIN32__
33 # include <winsock2.h>
34 # include <ws2tcpip.h>
35 #else
36 # include <sys/socket.h>
37 #endif /*!_WIN32*/
38
39 #include <sys/time.h>
40
41 /* This is required for error code compatibility. */
42 #define _GCRY_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_GCRYPT
43
44 #ifdef __cplusplus
45 extern "C" {
46 #if 0 /* keep Emacsens' auto-indent happy */
47 }
48 #endif
49 #endif
50
51 /* The version of this header should match the one of the library. It
52    should not be used by a program because gcry_check_version() should
53    return the same version.  The purpose of this macro is to let
54    autoconf (using the AM_PATH_GCRYPT macro) check that this header
55    matches the installed library.  Note: Do not edit the next line as
56    configure may fix the string here.  */
57 #define GCRYPT_VERSION "1.3.0-cvs"
58
59 /* Internal: We can't use the convenience macros for the multi
60    precision integer functions when building this library. */
61 #ifdef _GCRYPT_IN_LIBGCRYPT
62 #ifndef GCRYPT_NO_MPI_MACROS
63 #define GCRYPT_NO_MPI_MACROS 1
64 #endif
65 #endif
66
67 /* We want to use gcc attributes when possible.  Warning: Don't use
68    these macros in your programs: As indicated by the leading
69    underscore they are subject to change without notice. */
70 #ifdef __GNUC__
71
72 #define _GCRY_GCC_VERSION (__GNUC__ * 10000 \
73                              + __GNUC_MINOR__ * 100 \
74                              + __GNUC_PATCHLEVEL__)
75
76 #if _GCRY_GCC_VERSION >= 30100
77 #define _GCRY_GCC_ATTR_DEPRECATED __attribute__ ((__deprecated__))
78 #endif
79
80 #if _GCRY_GCC_VERSION >= 29600
81 #define _GCRY_GCC_ATTR_PURE  __attribute__ ((__pure__))
82 #endif
83
84 #if _GCRY_GCC_VERSION >= 300200
85 #define _GCRY_GCC_ATTR_MALLOC  __attribute__ ((__malloc__))
86 #endif
87
88 #endif /*__GNUC__*/
89
90 #ifndef _GCRY_GCC_ATTR_DEPRECATED
91 #define _GCRY_GCC_ATTR_DEPRECATED
92 #endif
93 #ifndef _GCRY_GCC_ATTR_PURE
94 #define _GCRY_GCC_ATTR_PURE
95 #endif
96 #ifndef _GCRY_GCC_ATTR_MALLOC
97 #define _GCRY_GCC_ATTR_MALLOC
98 #endif
99
100 /* Wrappers for the libgpg-error library.  */
101
102 typedef gpg_error_t gcry_error_t;
103 typedef gpg_err_code_t gcry_err_code_t;
104 typedef gpg_err_source_t gcry_err_source_t;
105
106 static GPG_ERR_INLINE gcry_error_t
107 gcry_err_make (gcry_err_source_t source, gcry_err_code_t code)
108 {
109   return gpg_err_make (source, code);
110 }
111
112 /* The user can define GPG_ERR_SOURCE_DEFAULT before including this
113    file to specify a default source for gpg_error.  */
114 #ifndef GCRY_ERR_SOURCE_DEFAULT
115 #define GCRY_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
116 #endif
117
118 static GPG_ERR_INLINE gcry_error_t
119 gcry_error (gcry_err_code_t code)
120 {
121   return gcry_err_make (GCRY_ERR_SOURCE_DEFAULT, code);
122 }
123
124 static GPG_ERR_INLINE gcry_err_code_t
125 gcry_err_code (gcry_error_t err)
126 {
127   return gpg_err_code (err);
128 }
129
130
131 static GPG_ERR_INLINE gcry_err_source_t
132 gcry_err_source (gcry_error_t err)
133 {
134   return gpg_err_source (err);
135 }
136
137 /* Return a pointer to a string containing a description of the error
138    code in the error value ERR.  */
139 const char *gcry_strerror (gcry_error_t err);
140
141 /* Return a pointer to a string containing a description of the error
142    source in the error value ERR.  */
143 const char *gcry_strsource (gcry_error_t err);
144
145 /* Retrieve the error code for the system error ERR.  This returns
146    GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
147    this).  */
148 gcry_err_code_t gcry_err_code_from_errno (int err);
149
150 /* Retrieve the system error for the error code CODE.  This returns 0
151    if CODE is not a system error code.  */
152 int gcry_err_code_to_errno (gcry_err_code_t code);
153
154 /* Return an error value with the error source SOURCE and the system
155    error ERR.  */
156 gcry_error_t gcry_err_make_from_errno (gcry_err_source_t source, int err);
157
158 /* Return an error value with the system error ERR.  */
159 gcry_err_code_t gcry_error_from_errno (int err);
160
161 \f
162 enum gcry_thread_option
163   {
164     GCRY_THREAD_OPTION_DEFAULT = 0,
165     GCRY_THREAD_OPTION_USER = 1,
166     GCRY_THREAD_OPTION_PTH = 2,
167     GCRY_THREAD_OPTION_PTHREAD = 3
168   };
169
170 /* Wrapper for struct ath_ops.  */
171 struct gcry_thread_cbs
172 {
173   enum gcry_thread_option option;
174   int (*init) (void);
175   int (*mutex_init) (void **priv);
176   int (*mutex_destroy) (void **priv);
177   int (*mutex_lock) (void **priv);
178   int (*mutex_unlock) (void **priv);
179   ssize_t (*read) (int fd, void *buf, size_t nbytes);
180   ssize_t (*write) (int fd, const void *buf, size_t nbytes);
181 #ifdef _WIN32
182   ssize_t (*select) (int nfd, void *rset, void *wset, void *eset,
183                      struct timeval *timeout);
184   ssize_t (*waitpid) (pid_t pid, int *status, int options);
185   int (*accept) (int s, void  *addr, int *length_ptr);
186   int (*connect) (int s, void *addr, socklen_t length);
187   int (*sendmsg) (int s, const void *msg, int flags);
188   int (*recvmsg) (int s, void *msg, int flags);
189 #else
190   ssize_t (*select) (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
191                      struct timeval *timeout);
192   ssize_t (*waitpid) (pid_t pid, int *status, int options);
193   int (*accept) (int s, struct sockaddr *addr, socklen_t *length_ptr);
194   int (*connect) (int s, struct sockaddr *addr, socklen_t length);
195   int (*sendmsg) (int s, const struct msghdr *msg, int flags);
196   int (*recvmsg) (int s, struct msghdr *msg, int flags);
197 #endif
198 };
199
200 #define GCRY_THREAD_OPTION_PTH_IMPL                                           \
201 static int gcry_pth_init (void)                                               \
202 { return (pth_init () == FALSE) ? errno : 0; }                                \
203 static int gcry_pth_mutex_init (void **priv)                                  \
204 {                                                                             \
205   int err = 0;                                                                \
206   pth_mutex_t *lock = malloc (sizeof (pth_mutex_t));                          \
207                                                                               \
208   if (!lock)                                                                  \
209     err = ENOMEM;                                                             \
210   if (!err)                                                                   \
211     {                                                                         \
212       err = pth_mutex_init (lock);                                            \
213       if (err == FALSE)                                                       \
214         err = errno;                                                          \
215       else                                                                    \
216         err = 0;                                                              \
217       if (err)                                                                \
218         free (lock);                                                          \
219       else                                                                    \
220         *priv = lock;                                                         \
221     }                                                                         \
222   return err;                                                                 \
223 }                                                                             \
224 static int gcry_pth_mutex_destroy (void **lock)                               \
225   { /* GNU Pth has no destructor function.  */ free (*lock); return 0; }      \
226 static int gcry_pth_mutex_lock (void **lock)                                  \
227   { return ((pth_mutex_acquire (*lock, 0, NULL)) == FALSE)                    \
228       ? errno : 0; }                                                          \
229 static int gcry_pth_mutex_unlock (void **lock)                                \
230   { return ((pth_mutex_release (*lock)) == FALSE)                             \
231       ? errno : 0; }                                                          \
232 static ssize_t gcry_pth_read (int fd, void *buf, size_t nbytes)               \
233   { return pth_read (fd, buf, nbytes); }                                      \
234 static ssize_t gcry_pth_write (int fd, const void *buf, size_t nbytes)        \
235   { return pth_write (fd, buf, nbytes); }                                     \
236 static ssize_t gcry_pth_select (int nfd, fd_set *rset, fd_set *wset,          \
237                                 fd_set *eset, struct timeval *timeout)        \
238   { return pth_select (nfd, rset, wset, eset, timeout); }                     \
239 static ssize_t gcry_pth_waitpid (pid_t pid, int *status, int options)         \
240   { return pth_waitpid (pid, status, options); }                              \
241 static int gcry_pth_accept (int s, struct sockaddr *addr,                     \
242                             socklen_t *length_ptr)                            \
243   { return pth_accept (s, addr, length_ptr); }                                \
244 static int gcry_pth_connect (int s, struct sockaddr *addr, socklen_t length)  \
245   { return pth_connect (s, addr, length); }                                   \
246                                                                               \
247 /* FIXME: GNU Pth is missing pth_sendmsg and pth_recvmsg.  */                 \
248 static struct gcry_thread_cbs gcry_threads_pth = { GCRY_THREAD_OPTION_PTH,    \
249   gcry_pth_init, gcry_pth_mutex_init, gcry_pth_mutex_destroy,                 \
250   gcry_pth_mutex_lock, gcry_pth_mutex_unlock, gcry_pth_read, gcry_pth_write,  \
251   gcry_pth_select, gcry_pth_waitpid, gcry_pth_accept, gcry_pth_connect,       \
252   NULL, NULL }
253
254 #define GCRY_THREAD_OPTION_PTHREAD_IMPL                                       \
255 static int gcry_pthread_mutex_init (void **priv)                              \
256 {                                                                             \
257   int err = 0;                                                                \
258   pthread_mutex_t *lock = malloc (sizeof (pthread_mutex_t));                  \
259                                                                               \
260   if (!lock)                                                                  \
261     err = ENOMEM;                                                             \
262   if (!err)                                                                   \
263     {                                                                         \
264       err = pthread_mutex_init (lock, NULL);                                  \
265       if (err)                                                                \
266         free (lock);                                                          \
267       else                                                                    \
268         *priv = lock;                                                         \
269     }                                                                         \
270   return err;                                                                 \
271 }                                                                             \
272 static int gcry_pthread_mutex_destroy (void **lock)                           \
273   { int err = pthread_mutex_destroy (*lock);  free (*lock); return err; }     \
274 static int gcry_pthread_mutex_lock (void **lock)                              \
275   { return pthread_mutex_lock (*lock); }                                      \
276 static int gcry_pthread_mutex_unlock (void **lock)                            \
277   { return pthread_mutex_unlock (*lock); }                                    \
278                                                                               \
279 static struct gcry_thread_cbs gcry_threads_pthread =                          \
280 { GCRY_THREAD_OPTION_PTHREAD, NULL,                                           \
281   gcry_pthread_mutex_init, gcry_pthread_mutex_destroy,                        \
282   gcry_pthread_mutex_lock, gcry_pthread_mutex_unlock,                         \
283   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL }
284
285 \f
286 /* The data object used to hold a multi precision integer.  */
287 struct gcry_mpi;
288 typedef struct gcry_mpi *gcry_mpi_t;
289
290 typedef struct gcry_mpi *GCRY_MPI _GCRY_GCC_ATTR_DEPRECATED;
291 typedef struct gcry_mpi *GcryMPI _GCRY_GCC_ATTR_DEPRECATED;
292
293 \f
294
295 /* Check that the library fulfills the version requirement.  */
296 const char *gcry_check_version (const char *req_version);
297
298 /* Codes for function dispatchers.  */
299
300 /* Codes used with the gcry_control function. */
301 enum gcry_ctl_cmds 
302   {
303     GCRYCTL_SET_KEY  = 1,
304     GCRYCTL_SET_IV   = 2,
305     GCRYCTL_CFB_SYNC = 3,
306     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
307     GCRYCTL_FINALIZE = 5,
308     GCRYCTL_GET_KEYLEN = 6,
309     GCRYCTL_GET_BLKLEN = 7,
310     GCRYCTL_TEST_ALGO = 8,
311     GCRYCTL_IS_SECURE = 9,
312     GCRYCTL_GET_ASNOID = 10,
313     GCRYCTL_ENABLE_ALGO = 11,
314     GCRYCTL_DISABLE_ALGO = 12,
315     GCRYCTL_DUMP_RANDOM_STATS = 13,
316     GCRYCTL_DUMP_SECMEM_STATS = 14,
317     GCRYCTL_GET_ALGO_NPKEY    = 15,
318     GCRYCTL_GET_ALGO_NSKEY    = 16,
319     GCRYCTL_GET_ALGO_NSIGN    = 17,
320     GCRYCTL_GET_ALGO_NENCR    = 18,
321     GCRYCTL_SET_VERBOSITY     = 19,
322     GCRYCTL_SET_DEBUG_FLAGS   = 20,
323     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
324     GCRYCTL_USE_SECURE_RNDPOOL= 22,
325     GCRYCTL_DUMP_MEMORY_STATS = 23,
326     GCRYCTL_INIT_SECMEM       = 24,
327     GCRYCTL_TERM_SECMEM       = 25,
328     GCRYCTL_DISABLE_SECMEM_WARN = 27,
329     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
330     GCRYCTL_RESUME_SECMEM_WARN  = 29,
331     GCRYCTL_DROP_PRIVS          = 30,
332     GCRYCTL_ENABLE_M_GUARD      = 31,
333     GCRYCTL_START_DUMP          = 32,
334     GCRYCTL_STOP_DUMP           = 33,
335     GCRYCTL_GET_ALGO_USAGE      = 34,
336     GCRYCTL_IS_ALGO_ENABLED     = 35,
337     GCRYCTL_DISABLE_INTERNAL_LOCKING = 36,
338     GCRYCTL_DISABLE_SECMEM      = 37,
339     GCRYCTL_INITIALIZATION_FINISHED = 38,
340     GCRYCTL_INITIALIZATION_FINISHED_P = 39,
341     GCRYCTL_ANY_INITIALIZATION_P = 40,
342     GCRYCTL_SET_CBC_CTS = 41,
343     GCRYCTL_SET_CBC_MAC = 42,
344     GCRYCTL_SET_CTR = 43,
345     GCRYCTL_ENABLE_QUICK_RANDOM = 44,
346     GCRYCTL_SET_RANDOM_SEED_FILE = 45,
347     GCRYCTL_UPDATE_RANDOM_SEED_FILE = 46,
348     GCRYCTL_SET_THREAD_CBS = 47,
349     GCRYCTL_FAST_POLL = 48,
350     GCRYCTL_SET_RANDOM_DAEMON_SOCKET = 49,
351     GCRYCTL_USE_RANDOM_DAEMON = 50
352   };
353
354 /* Perform various operations defined by CMD. */
355 gcry_error_t gcry_control (enum gcry_ctl_cmds CMD, ...);
356
357 \f
358 /* S-expression management. */ 
359
360 /* The object to represent an S-expression as used with the public key
361    functions.  */
362 struct gcry_sexp;
363 typedef struct gcry_sexp *gcry_sexp_t;
364
365 typedef struct gcry_sexp *GCRY_SEXP _GCRY_GCC_ATTR_DEPRECATED;
366 typedef struct gcry_sexp *GcrySexp _GCRY_GCC_ATTR_DEPRECATED;
367
368 /* The possible values for the S-expression format. */
369 enum gcry_sexp_format
370   {
371     GCRYSEXP_FMT_DEFAULT   = 0,
372     GCRYSEXP_FMT_CANON     = 1,
373     GCRYSEXP_FMT_BASE64    = 2,
374     GCRYSEXP_FMT_ADVANCED  = 3
375   };
376
377 /* Create an new S-expression object from BUFFER of size LENGTH and
378    return it in RETSEXP.  With AUTODETECT set to 0 the data in BUFFER
379    is expected to be in canonized format.  */
380 gcry_error_t gcry_sexp_new (gcry_sexp_t *retsexp,
381                             const void *buffer, size_t length,
382                             int autodetect);
383
384  /* Same as gcry_sexp_new but allows to pass a FREEFNC which has the
385     effect to transfer ownership of BUFFER to the created object.  */
386 gcry_error_t gcry_sexp_create (gcry_sexp_t *retsexp,
387                                void *buffer, size_t length,
388                                int autodetect, void (*freefnc) (void *));
389
390 /* Scan BUFFER and return a new S-expression object in RETSEXP.  This
391    function expects a printf like string in BUFFER.  */
392 gcry_error_t gcry_sexp_sscan (gcry_sexp_t *retsexp, size_t *erroff,
393                               const char *buffer, size_t length);
394
395 /* Same as gcry_sexp_sscan but expects a string in FORMAT and can thus
396    only be used for certain encodings.  */
397 gcry_error_t gcry_sexp_build (gcry_sexp_t *retsexp, size_t *erroff,
398                               const char *format, ...);
399
400 /* Like gcry_sexp_build, but uses an array instead of variable
401    function arguments.  */
402 gcry_error_t gcry_sexp_build_array (gcry_sexp_t *retsexp, size_t *erroff,
403                                     const char *format, void **arg_list);
404
405 /* Release the S-expression object SEXP */
406 void gcry_sexp_release (gcry_sexp_t sexp);
407
408 /* Calculate the length of an canonized S-expresion in BUFFER and
409    check for a valid encoding. */
410 size_t gcry_sexp_canon_len (const unsigned char *buffer, size_t length, 
411                             size_t *erroff, gcry_error_t *errcode);
412
413 /* Copies the S-expression object SEXP into BUFFER using the format
414    specified in MODE.  */
415 size_t gcry_sexp_sprint (gcry_sexp_t sexp, int mode, char *buffer,
416                          size_t maxlength);
417
418 /* Dumps the S-expression object A in a aformat suitable for debugging
419    to Libgcrypt's logging stream.  */
420 void gcry_sexp_dump (const gcry_sexp_t a);
421
422 gcry_sexp_t gcry_sexp_cons (const gcry_sexp_t a, const gcry_sexp_t b);
423 gcry_sexp_t gcry_sexp_alist (const gcry_sexp_t *array);
424 gcry_sexp_t gcry_sexp_vlist (const gcry_sexp_t a, ...);
425 gcry_sexp_t gcry_sexp_append (const gcry_sexp_t a, const gcry_sexp_t n);
426 gcry_sexp_t gcry_sexp_prepend (const gcry_sexp_t a, const gcry_sexp_t n);
427
428 /* Scan the S-expression for a sublist with a type (the car of the
429    list) matching the string TOKEN.  If TOKLEN is not 0, the token is
430    assumed to be raw memory of this length.  The function returns a
431    newly allocated S-expression consisting of the found sublist or
432    `NULL' when not found.  */
433 gcry_sexp_t gcry_sexp_find_token (gcry_sexp_t list,
434                                 const char *tok, size_t toklen);
435 /* Return the length of the LIST.  For a valid S-expression this
436    should be at least 1.  */
437 int gcry_sexp_length (const gcry_sexp_t list);
438
439 /* Create and return a new S-expression from the element with index
440    NUMBER in LIST.  Note that the first element has the index 0.  If
441    there is no such element, `NULL' is returned.  */
442 gcry_sexp_t gcry_sexp_nth (const gcry_sexp_t list, int number);
443
444 /* Create and return a new S-expression from the first element in
445    LIST; this called the "type" and should always exist and be a
446    string. `NULL' is returned in case of a problem.  */
447 gcry_sexp_t gcry_sexp_car (const gcry_sexp_t list);
448
449 /* Create and return a new list form all elements except for the first
450    one.  Note, that this function may return an invalid S-expression
451    because it is not guaranteed, that the type exists and is a string.
452    However, for parsing a complex S-expression it might be useful for
453    intermediate lists.  Returns `NULL' on error.  */
454 gcry_sexp_t gcry_sexp_cdr (const gcry_sexp_t list);
455
456 gcry_sexp_t gcry_sexp_cadr (const gcry_sexp_t list);
457
458
459 /* This function is used to get data from a LIST.  A pointer to the
460    actual data with index NUMBER is returned and the length of this
461    data will be stored to DATALEN.  If there is no data at the given
462    index or the index represents another list, `NULL' is returned.
463    *Note:* The returned pointer is valid as long as LIST is not
464    modified or released.  */
465 const char *gcry_sexp_nth_data (const gcry_sexp_t list, int number,
466                                 size_t *datalen);
467
468 /* This function is used to get and convert data from a LIST. This
469    data is assumed to be an MPI stored in the format described by
470    MPIFMT and returned as a standard Libgcrypt MPI.  The caller must
471    release this returned value using `gcry_mpi_release'.  If there is
472    no data at the given index, the index represents a list or the
473    value can't be converted to an MPI, `NULL' is returned.  */
474 gcry_mpi_t gcry_sexp_nth_mpi (gcry_sexp_t list, int number, int mpifmt);
475
476
477 \f
478 /*******************************************
479  *                                         *
480  *  multi precision integer functions      *
481  *                                         *
482  *******************************************/
483
484 /* Different formats of external big integer representation. */
485 enum gcry_mpi_format 
486   {
487     GCRYMPI_FMT_NONE= 0,
488     GCRYMPI_FMT_STD = 1,    /* twos complement stored without length */
489     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP (only defined as unsigned)*/
490     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (same as 1 but with length)*/
491     GCRYMPI_FMT_HEX = 4,    /* hex format */
492     GCRYMPI_FMT_USG = 5     /* like STD but this is an unsigned one */
493   };
494
495 /* Flags used for creating big integers.  */
496 enum gcry_mpi_flag 
497   {
498     GCRYMPI_FLAG_SECURE = 1,  /* Allocate the number in "secure" memory. */
499     GCRYMPI_FLAG_OPAQUE = 2   /* The number is not a real one but just a
500                                way to store some bytes.  This is
501                                useful for encrypted big integers. */
502   };
503
504
505 /* Allocate a new big integer object, initialize it with 0 and
506    initially allocate memory for a number of at least NBITS. */
507 gcry_mpi_t gcry_mpi_new (unsigned int nbits);
508
509 /* Same as gcry_mpi_new() but allocate in "secure" memory. */
510 gcry_mpi_t gcry_mpi_snew (unsigned int nbits);
511
512 /* Release the number A and free all associated resources. */
513 void gcry_mpi_release (gcry_mpi_t a);
514
515 /* Create a new number with the same value as A. */
516 gcry_mpi_t gcry_mpi_copy (const gcry_mpi_t a);
517
518 /* Store the big integer value U in W. */
519 gcry_mpi_t gcry_mpi_set (gcry_mpi_t w, const gcry_mpi_t u);
520
521 /* Store the unsigned integer value U in W. */
522 gcry_mpi_t gcry_mpi_set_ui (gcry_mpi_t w, unsigned long u);
523
524 /* Swap the values of A and B. */
525 void gcry_mpi_swap (gcry_mpi_t a, gcry_mpi_t b);
526
527 /* Compare the big integer number U and V returning 0 for equality, a
528    positive value for U > V and a negative for U < V. */
529 int gcry_mpi_cmp (const gcry_mpi_t u, const gcry_mpi_t v);
530
531 /* Compare the big integer number U with the unsigned integer V
532    returning 0 for equality, a positive value for U > V and a negative
533    for U < V. */
534 int gcry_mpi_cmp_ui (const gcry_mpi_t u, unsigned long v);
535
536 /* Convert the external representation of an integer stored in BUFFER
537    with a length of BUFLEN into a newly create MPI returned in
538    RET_MPI.  If NSCANNED is not NULL, it will receive the number of
539    bytes actually scanned after a successful operation. */
540 gcry_error_t gcry_mpi_scan (gcry_mpi_t *ret_mpi, enum gcry_mpi_format format,
541                             const unsigned char *buffer, size_t buflen, 
542                             size_t *nscanned);
543
544 /* Convert the big integer A into the external representation
545    described by FORMAT and store it in the provided BUFFER which has
546    been allocated by the user with a size of BUFLEN bytes.  NWRITTEN
547    receives the actual length of the external representation unless it
548    has been passed as NULL. */
549 gcry_error_t gcry_mpi_print (enum gcry_mpi_format format,
550                              unsigned char *buffer, size_t buflen,
551                              size_t *nwritten,
552                              const gcry_mpi_t a);
553
554 /* Convert the big integer A int the external representation described
555    by FORMAT and store it in a newly allocated buffer which address
556    will be put into BUFFER.  NWRITTEN receives the actual lengths of the
557    external representation. */
558 gcry_error_t gcry_mpi_aprint (enum gcry_mpi_format format,
559                               unsigned char **buffer, size_t *nwritten,
560                               const gcry_mpi_t a);
561
562 /* Dump the value of A in a format suitable for debugging to
563    Libgcrypt's logging stream.  Note that one leading space but no
564    trailing space or linefeed will be printed.  It is okay to pass
565    NULL for A. */
566 void gcry_mpi_dump (const gcry_mpi_t a);
567
568
569 /* W = U + V.  */
570 void gcry_mpi_add (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
571
572 /* W = U + V.  V is an unsigned integer. */
573 void gcry_mpi_add_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v);
574
575 /* W = U + V mod M. */
576 void gcry_mpi_addm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
577
578 /* W = U - V. */
579 void gcry_mpi_sub (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
580
581 /* W = U - V.  V is an unsigned integer. */
582 void gcry_mpi_sub_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
583
584 /* W = U - V mod M */
585 void gcry_mpi_subm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
586
587 /* W = U * V. */
588 void gcry_mpi_mul (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
589
590 /* W = U * V.  V is an unsigned integer. */
591 void gcry_mpi_mul_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
592
593 /* W = U * V mod M. */
594 void gcry_mpi_mulm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
595
596 /* W = U * (2 ^ CNT). */
597 void gcry_mpi_mul_2exp (gcry_mpi_t w, gcry_mpi_t u, unsigned long cnt);
598
599 /* Q = DIVIDEND / DIVISOR, R = DIVIDEND % DIVISOR,
600    Q or R may be passed as NULL.  ROUND should be negative or 0. */
601 void gcry_mpi_div (gcry_mpi_t q, gcry_mpi_t r,
602                    gcry_mpi_t dividend, gcry_mpi_t divisor, int round);
603
604 /* R = DIVIDEND % DIVISOR */
605 void gcry_mpi_mod (gcry_mpi_t r, gcry_mpi_t dividend, gcry_mpi_t divisor);
606
607 /* W = B ^ E mod M. */
608 void gcry_mpi_powm (gcry_mpi_t w,
609                     const gcry_mpi_t b, const gcry_mpi_t e,
610                     const gcry_mpi_t m);
611
612 /* Set G to the greatest common divisor of A and B.  
613    Return true if the G is 1. */
614 int gcry_mpi_gcd (gcry_mpi_t g, gcry_mpi_t a, gcry_mpi_t b);
615
616 /* Set X to the multiplicative inverse of A mod M.
617    Return true if the value exists. */
618 int gcry_mpi_invm (gcry_mpi_t x, gcry_mpi_t a, gcry_mpi_t m);
619
620
621 /* Return the number of bits required to represent A. */
622 unsigned int gcry_mpi_get_nbits (gcry_mpi_t a);
623
624 /* Return true when bit number N (counting from 0) is set in A. */
625 int      gcry_mpi_test_bit (gcry_mpi_t a, unsigned int n);
626
627 /* Set bit number N in A. */
628 void     gcry_mpi_set_bit (gcry_mpi_t a, unsigned int n);
629
630 /* Clear bit number N in A. */
631 void     gcry_mpi_clear_bit (gcry_mpi_t a, unsigned int n);
632
633 /* Set bit number N in A and clear all bits greater than N. */
634 void     gcry_mpi_set_highbit (gcry_mpi_t a, unsigned int n);
635
636 /* Clear bit number N in A and all bits greater than N. */
637 void     gcry_mpi_clear_highbit (gcry_mpi_t a, unsigned int n);
638
639 /* Shift the value of A by N bits to the right and store the result in X. */
640 void     gcry_mpi_rshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
641
642 /* Store NBITS of the value P points to in A and mark A as an opaque
643    value.  WARNING: Never use an opaque MPI for anything thing else then 
644    gcry_mpi_release, gcry_mpi_get_opaque. */
645 gcry_mpi_t gcry_mpi_set_opaque (gcry_mpi_t a, void *p, unsigned int nbits);
646
647 /* Return a pointer to an opaque value stored in A and return its size
648    in NBITS.  Note that the returned pointer is still owned by A and
649    that the function should never be used for an non-opaque MPI. */
650 void *gcry_mpi_get_opaque (gcry_mpi_t a, unsigned int *nbits);
651
652 /* Set the FLAG for the big integer A.  Currently only the flag
653    GCRYMPI_FLAG_SECURE is allowed to convert A into an big intger
654    stored in "secure" memory. */
655 void gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
656
657 /* Clear FLAG for the big integer A.  Note that this function is
658    currently useless as no flags are allowed. */
659 void gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
660
661 /* Return true when the FLAG is set for A. */
662 int gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
663
664 /* Unless the GCRYPT_NO_MPI_MACROS is used, provide a couple of
665    convenience macors for the big integer functions. */
666 #ifndef GCRYPT_NO_MPI_MACROS
667 #define mpi_new(n)          gcry_mpi_new( (n) )
668 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
669 #define mpi_release(a)      \
670   do \
671     { \
672       gcry_mpi_release ((a)); \
673       (a) = NULL; \
674     } \
675   while (0)
676
677 #define mpi_copy( a )       gcry_mpi_copy( (a) )
678 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
679 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
680 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
681 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
682
683 #define mpi_add_ui(w,u,v)   gcry_mpi_add_ui((w),(u),(v))
684 #define mpi_add(w,u,v)      gcry_mpi_add ((w),(u),(v))
685 #define mpi_addm(w,u,v,m)   gcry_mpi_addm ((w),(u),(v),(m))
686 #define mpi_sub_ui(w,u,v)   gcry_mpi_sub_ui ((w),(u),(v))
687 #define mpi_sub(w,u,v)      gcry_mpi_sub ((w),(u),(v))
688 #define mpi_subm(w,u,v,m)   gcry_mpi_subm ((w),(u),(v),(m))
689 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
690 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
691 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
692 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
693 #define mpi_powm(w,b,e,m)   gcry_mpi_powm ( (w), (b), (e), (m) )
694 #define mpi_tdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), 0)
695 #define mpi_fdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), -1)
696 #define mpi_mod(r,a,m)      gcry_mpi_mod ((r), (a), (m))
697 #define mpi_gcd(g,a,b)      gcry_mpi_gcd ( (g), (a), (b) )
698 #define mpi_invm(g,a,b)     gcry_mpi_invm ( (g), (a), (b) )
699
700 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
701 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
702 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
703 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
704 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
705 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
706 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
707
708 #define mpi_set_opaque(a,b,c) gcry_mpi_set_opaque( (a), (b), (c) )
709 #define mpi_get_opaque(a,b)   gcry_mpi_get_opaque( (a), (b) )
710 #endif /* GCRYPT_NO_MPI_MACROS */
711
712
713 \f
714 /************************************
715  *                                  *
716  *   symmetric cipher functions     *
717  *                                  *
718  ************************************/
719
720 /* The data object used to hold a handle to an encryption object.  */
721 struct gcry_cipher_handle;
722 typedef struct gcry_cipher_handle *gcry_cipher_hd_t;
723
724 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD _GCRY_GCC_ATTR_DEPRECATED;
725 typedef struct gcry_cipher_handle *GcryCipherHd _GCRY_GCC_ATTR_DEPRECATED;
726
727 /* All symmetric encryption algorithms are identified by their IDs.
728    More IDs may be registered at runtime. */
729 enum gcry_cipher_algos
730   {
731     GCRY_CIPHER_NONE        = 0,
732     GCRY_CIPHER_IDEA        = 1,
733     GCRY_CIPHER_3DES        = 2,
734     GCRY_CIPHER_CAST5       = 3,
735     GCRY_CIPHER_BLOWFISH    = 4,
736     GCRY_CIPHER_SAFER_SK128 = 5,
737     GCRY_CIPHER_DES_SK      = 6,
738     GCRY_CIPHER_AES         = 7,
739     GCRY_CIPHER_AES192      = 8,
740     GCRY_CIPHER_AES256      = 9,
741     GCRY_CIPHER_TWOFISH     = 10,
742
743     /* Other cipher numbers are above 300 for OpenPGP reasons. */
744     GCRY_CIPHER_ARCFOUR     = 301,  /* Fully compatible with RSA's RC4 (tm). */
745     GCRY_CIPHER_DES         = 302,  /* Yes, this is single key 56 bit DES. */
746     GCRY_CIPHER_TWOFISH128  = 303,
747     GCRY_CIPHER_SERPENT128  = 304,
748     GCRY_CIPHER_SERPENT192  = 305,
749     GCRY_CIPHER_SERPENT256  = 306,
750     GCRY_CIPHER_RFC2268_40  = 307,  /* Ron's Cipher 2 (40 bit). */
751     GCRY_CIPHER_RFC2268_128 = 308   /* Ron's Cipher 2 (128 bit). */
752   };
753
754 /* The Rijndael algorithm is basically AES, so provide some macros. */
755 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES    
756 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES    
757 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128 
758 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192 
759 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256 
760
761 /* The supported encryption modes.  Note that not all of them are
762    supported for each algorithm. */
763 enum gcry_cipher_modes 
764   {
765     GCRY_CIPHER_MODE_NONE   = 0,  /* Not yet specified. */
766     GCRY_CIPHER_MODE_ECB    = 1,  /* Electronic codebook. */
767     GCRY_CIPHER_MODE_CFB    = 2,  /* Cipher feedback. */
768     GCRY_CIPHER_MODE_CBC    = 3,  /* Cipher block chaining. */
769     GCRY_CIPHER_MODE_STREAM = 4,  /* Used with stream ciphers. */
770     GCRY_CIPHER_MODE_OFB    = 5,  /* Outer feedback. */
771     GCRY_CIPHER_MODE_CTR    = 6   /* Counter. */
772   };
773
774 /* Flags used with the open function. */ 
775 enum gcry_cipher_flags
776   {
777     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
778     GCRY_CIPHER_ENABLE_SYNC = 2,  /* Enable CFB sync mode. */
779     GCRY_CIPHER_CBC_CTS     = 4,  /* Enable CBC cipher text stealing (CTS). */
780     GCRY_CIPHER_CBC_MAC     = 8   /* Enable CBC message auth. code (MAC). */
781   };
782
783
784 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
785    be given as an bitwise OR of the gcry_cipher_flags values. */
786 gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *handle,
787                               int algo, int mode, unsigned int flags);
788
789 /* Close the cioher handle H and release all resource. */
790 void gcry_cipher_close (gcry_cipher_hd_t h);
791
792 /* Perform various operations on the cipher object H. */
793 gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer,
794                              size_t buflen);
795
796 /* Retrieve various information about the cipher object H. */
797 gcry_error_t gcry_cipher_info (gcry_cipher_hd_t h, int what, void *buffer,
798                               size_t *nbytes);
799
800 /* Retrieve various information about the cipher algorithm ALGO. */
801 gcry_error_t gcry_cipher_algo_info (int algo, int what, void *buffer,
802                                    size_t *nbytes);
803
804 /* Map the cipher algorithm whose ID is contained in ALGORITHM to a
805    string representation of the algorithm name.  For unknown algorithm
806    IDs this function returns "?".  */
807 const char *gcry_cipher_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
808
809 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
810    the algorithm name is not known. */
811 int gcry_cipher_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
812
813 /* Given an ASN.1 object identifier in standard IETF dotted decimal
814    format in STRING, return the encryption mode associated with that
815    OID or 0 if not known or applicable. */
816 int gcry_cipher_mode_from_oid (const char *string) _GCRY_GCC_ATTR_PURE;
817
818 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
819    into the buffer OUT which has an allocated length of OUTSIZE.  For
820    most algorithms it is possible to pass NULL for in and 0 for INLEN
821    and do a in-place decryption of the data provided in OUT.  */
822 gcry_error_t gcry_cipher_encrypt (gcry_cipher_hd_t h,
823                                  unsigned char *out, size_t outsize,
824                                  const unsigned char *in, size_t inlen);
825
826 /* The counterpart to gcry_cipher_encrypt.  */
827 gcry_error_t gcry_cipher_decrypt (gcry_cipher_hd_t h,
828                                  unsigned char *out, size_t outsize,
829                                  const unsigned char *in, size_t inlen);
830
831 /* Set key K of length L for the cipher handle H.  (We have to cast
832    away a const char* here - this catch-all ctl function was probably
833    not the best choice) */
834 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
835                                                          (char*)(k), (l) )
836
837 /* Set initialization vector K of length L for the cipher handle H. */
838 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
839                                                          (char*)(k), (l) )
840
841 /* Reset the handle to the state after open.  */
842 #define gcry_cipher_reset(h)  gcry_cipher_ctl ((h), GCRYCTL_RESET, NULL, 0)
843
844 /* Perform the the OpenPGP sync operation if this is enabled for the
845    cipher handle H. */
846 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
847                                                                    NULL, 0 )
848
849 /* Enable or disable CTS in future calls to gcry_encrypt(). CBC mode only. */
850 #define gcry_cipher_cts(h,on)  gcry_cipher_ctl( (h), GCRYCTL_SET_CBC_CTS, \
851                                                                    NULL, on )
852
853 /* Set counter for CTR mode.  (K,L) must denote a buffer of block size
854    length, or (NULL,0) to set the CTR to the all-zero block. */
855 #define gcry_cipher_setctr(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_CTR, \
856                                                     (char*)(k), (l) )
857
858 /* Retrieved the key length used with algorithm A. */
859 size_t gcry_cipher_get_algo_keylen (int algo);
860
861 /* Retrieve the block length used with algorithm A. */
862 size_t gcry_cipher_get_algo_blklen (int algo);
863
864 /* Return 0 if the algorithm A is available for use. */
865 #define gcry_cipher_test_algo(a) \
866             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
867
868 /* Get a list consisting of the IDs of the loaded cipher modules.  If
869    LIST is zero, write the number of loaded cipher modules to
870    LIST_LENGTH and return.  If LIST is non-zero, the first
871    *LIST_LENGTH algorithm IDs are stored in LIST, which must be of
872    according size.  In case there are less cipher modules than
873    *LIST_LENGTH, *LIST_LENGTH is updated to the correct number.  */
874 gcry_error_t gcry_cipher_list (int *list, int *list_length);
875
876 \f
877 /************************************
878  *                                  *
879  *    asymmetric cipher functions   *
880  *                                  *
881  ************************************/
882
883 /* The algorithms and their IDs we support. */
884 enum gcry_pk_algos 
885   {
886     GCRY_PK_RSA = 1,
887     GCRY_PK_RSA_E = 2,      /* deprecated */
888     GCRY_PK_RSA_S = 3,      /* deprecated */
889     GCRY_PK_ELG_E = 16,     /* use only for OpenPGP */
890     GCRY_PK_DSA   = 17,
891     GCRY_PK_ELG   = 20
892   };
893
894 /* Flags describing usage capabilities of a PK algorithm. */
895 #define GCRY_PK_USAGE_SIGN 1   /* Good for signatures. */            
896 #define GCRY_PK_USAGE_ENCR 2   /* Good for encryption. */            
897 #define GCRY_PK_USAGE_CERT 4   /* Good to certify other keys. */
898 #define GCRY_PK_USAGE_AUTH 8   /* Good for authentication. */        
899 #define GCRY_PK_USAGE_UNKN 128 /* Unknown usage flag. */          
900
901 /* Encrypt the DATA using the public key PKEY and store the result as
902    a newly created S-expression at RESULT. */
903 gcry_error_t gcry_pk_encrypt (gcry_sexp_t *result,
904                               gcry_sexp_t data, gcry_sexp_t pkey);
905
906 /* Decrypt the DATA using the private key SKEY and store the result as
907    a newly created S-expression at RESULT. */
908 gcry_error_t gcry_pk_decrypt (gcry_sexp_t *result,
909                               gcry_sexp_t data, gcry_sexp_t skey);
910
911 /* Sign the DATA using the private key SKEY and store the result as
912    a newly created S-expression at RESULT. */
913 gcry_error_t gcry_pk_sign (gcry_sexp_t *result,
914                            gcry_sexp_t data, gcry_sexp_t skey);
915
916 /* Check the signature SIGVAL on DATA using the public key PKEY. */
917 gcry_error_t gcry_pk_verify (gcry_sexp_t sigval,
918                              gcry_sexp_t data, gcry_sexp_t pkey);
919
920 /* Check that private KEY is sane. */
921 gcry_error_t gcry_pk_testkey (gcry_sexp_t key);
922
923 /* Generate a new key pair according to the parameters given in
924    S_PARMS.  The new key pair is returned in as an S-expression in
925    R_KEY. */
926 gcry_error_t gcry_pk_genkey (gcry_sexp_t *r_key, gcry_sexp_t s_parms);
927
928 /* Catch all function for miscellaneous operations. */
929 gcry_error_t gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
930
931 /* Retrieve information about the public key algorithm ALGO. */
932 gcry_error_t gcry_pk_algo_info (int algo, int what,
933                                 void *buffer, size_t *nbytes);
934
935 /* Map the public key algorithm whose ID is contained in ALGORITHM to
936    a string representation of the algorithm name.  For unknown
937    algorithm IDs this functions returns "?". */
938 const char *gcry_pk_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
939
940 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
941    the algorithm name is not known. */
942 int gcry_pk_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
943
944 /* Return what is commonly referred as the key length for the given
945    public or private KEY.  */
946 unsigned int gcry_pk_get_nbits (gcry_sexp_t key) _GCRY_GCC_ATTR_PURE;
947
948 /* Please note that keygrip is still experimental and should not be
949    used without contacting the author. */
950 unsigned char *gcry_pk_get_keygrip (gcry_sexp_t key, unsigned char *array);
951
952 /* Return 0 if the public key algorithm A is available for use. */
953 #define gcry_pk_test_algo(a) \
954             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
955
956 /* Get a list consisting of the IDs of the loaded pubkey modules.  If
957    LIST is zero, write the number of loaded pubkey modules to
958    LIST_LENGTH and return.  If LIST is non-zero, the first
959    *LIST_LENGTH algorithm IDs are stored in LIST, which must be of
960    according size.  In case there are less pubkey modules than
961    *LIST_LENGTH, *LIST_LENGTH is updated to the correct number.  */
962 gcry_error_t gcry_pk_list (int *list, int *list_length);
963
964 \f
965
966 /************************************
967  *                                  *
968  *   cryptograhic hash functions    *
969  *                                  *
970  ************************************/
971
972 /* Algorithm IDs for the hash functions we know about. Not all of them
973    are implemnted. */
974 enum gcry_md_algos
975   {
976     GCRY_MD_NONE    = 0,  
977     GCRY_MD_MD5     = 1,
978     GCRY_MD_SHA1    = 2,
979     GCRY_MD_RMD160  = 3,
980     GCRY_MD_MD2     = 5,
981     GCRY_MD_TIGER   = 6,   /* TIGER/192. */
982     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
983     GCRY_MD_SHA256  = 8,
984     GCRY_MD_SHA384  = 9,
985     GCRY_MD_SHA512  = 10,
986     GCRY_MD_SHA224  = 11,
987     GCRY_MD_MD4     = 301,
988     GCRY_MD_CRC32               = 302,
989     GCRY_MD_CRC32_RFC1510       = 303,
990     GCRY_MD_CRC24_RFC2440       = 304,
991     GCRY_MD_WHIRLPOOL = 305
992   };
993
994 /* Flags used with the open function.  */
995 enum gcry_md_flags
996   {
997     GCRY_MD_FLAG_SECURE = 1,  /* Allocate all buffers in "secure"
998                                  memory.  */
999     GCRY_MD_FLAG_HMAC   = 2   /* Make an HMAC out of this
1000                                  algorithm.  */
1001   };
1002
1003 /* Forward declaration.  */
1004 struct gcry_md_context;
1005
1006 /* This object is used to hold a handle to a message digest object.
1007    This structure is private - only to be used by the public gcry_md_*
1008    macros.  */
1009 typedef struct gcry_md_handle 
1010 {
1011   /* Actual context.  */
1012   struct gcry_md_context *ctx;
1013   
1014   /* Buffer management.  */
1015   int  bufpos;
1016   int  bufsize;
1017   unsigned char buf[1];
1018 } *gcry_md_hd_t;
1019
1020 /* Compatibility types, do not use them.  */
1021 typedef struct gcry_md_handle *GCRY_MD_HD _GCRY_GCC_ATTR_DEPRECATED;
1022 typedef struct gcry_md_handle *GcryMDHd _GCRY_GCC_ATTR_DEPRECATED;
1023
1024 /* Create a message digest object for algorithm ALGO.  FLAGS may be
1025    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
1026    given as 0 if the algorithms to be used are later set using
1027    gcry_md_enable.  */
1028 gcry_error_t gcry_md_open (gcry_md_hd_t *h, int algo, unsigned int flags);
1029
1030 /* Release the message digest object HD.  */
1031 void gcry_md_close (gcry_md_hd_t hd);
1032
1033 /* Add the message digest algorithm ALGO to the digest object HD.  */
1034 gcry_error_t gcry_md_enable (gcry_md_hd_t hd, int algo);
1035
1036 /* Create a new digest object as an exact copy of the object HD.  */
1037 gcry_error_t gcry_md_copy (gcry_md_hd_t *bhd, gcry_md_hd_t ahd);
1038
1039 /* Reset the digest object HD to its initial state.  */
1040 void gcry_md_reset (gcry_md_hd_t hd);
1041
1042 /* Perform various operations on the digets object HD. */
1043 gcry_error_t gcry_md_ctl (gcry_md_hd_t hd, int cmd, unsigned char *buffer,
1044                          size_t buflen);
1045
1046 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
1047    it can update the digest values.  This is the actual hash
1048    function. */
1049 void gcry_md_write (gcry_md_hd_t hd, const void *buffer, size_t length);
1050
1051 /* Read out the final digest from HD return the digest value for
1052    algorithm ALGO. */
1053 unsigned char *gcry_md_read (gcry_md_hd_t hd, int algo);
1054
1055 /* Convenience function to calculate the hash from the data in BUFFER
1056    of size LENGTH using the algorithm ALGO avoiding the creating of a
1057    hash object.  The hash is returned in the caller provided buffer
1058    DIGEST which must be large enough to hold the digest of the given
1059    algorithm. */
1060 void gcry_md_hash_buffer (int algo, void *digest,
1061                           const void *buffer, size_t length);
1062
1063 /* Retrieve the algorithm used with HD.  This does not work reliable
1064    if more than one algorithm is enabled in HD. */
1065 int gcry_md_get_algo (gcry_md_hd_t hd);
1066
1067 /* Retrieve the length in bytes of the digest yielded by algorithm
1068    ALGO. */
1069 unsigned int gcry_md_get_algo_dlen (int algo);
1070
1071 /* Return true if the the algorithm ALGO is enabled in the digest
1072    object A. */
1073 int gcry_md_is_enabled (gcry_md_hd_t a, int algo);
1074
1075 /* Return true if the digest object A is allocated in "secure" memory. */
1076 int gcry_md_is_secure (gcry_md_hd_t a);
1077
1078 /* Retrieve various information about the object H.  */
1079 gcry_error_t gcry_md_info (gcry_md_hd_t h, int what, void *buffer,
1080                           size_t *nbytes);
1081
1082 /* Retrieve various information about the algorithm ALGO.  */
1083 gcry_error_t gcry_md_algo_info (int algo, int what, void *buffer,
1084                                size_t *nbytes);
1085
1086 /* Map the digest algorithm id ALGO to a string representation of the
1087    algorithm name.  For unknown algorithms this functions returns an
1088    empty string. */
1089 const char *gcry_md_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
1090
1091 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
1092    the algorithm name is not known. */
1093 int gcry_md_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1094
1095 /* For use with the HMAC feature, the set MAC key to the KEY of
1096    KEYLEN. */
1097 gcry_error_t gcry_md_setkey (gcry_md_hd_t hd, const void *key, size_t keylen);
1098
1099 /* Update the hash(s) of H with the character C.  This is a buffered
1100    version of the gcry_md_write function. */
1101 #define gcry_md_putc(h,c)  \
1102             do {                                          \
1103                 gcry_md_hd_t h__ = (h);                   \
1104                 if( (h__)->bufpos == (h__)->bufsize )     \
1105                     gcry_md_write( (h__), NULL, 0 );      \
1106                 (h__)->buf[(h__)->bufpos++] = (c) & 0xff; \
1107             } while(0)
1108
1109 /* Finalize the digest calculation.  This is not really needed because
1110    gcry_md_read() does this implicitly. */
1111 #define gcry_md_final(a) \
1112             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
1113
1114 /* Return 0 if the algorithm A is available for use. */
1115 #define gcry_md_test_algo(a) \
1116             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1117
1118 /* Return an DER encoded ASN.1 OID for the algorithm A in buffer B. N
1119    must point to size_t variable with the available size of buffer B.
1120    After return it will receive the actual size of the returned
1121    OID. */
1122 #define gcry_md_get_asnoid(a,b,n) \
1123             gcry_md_algo_info((a), GCRYCTL_GET_ASNOID, (b), (n))
1124
1125 /* Enable debugging for digets object A; i.e. create files named
1126    dbgmd-<n>.<string> while hashing.  B is a string used as the suffix
1127    for the filename. */
1128 #define gcry_md_start_debug(a,b) \
1129             gcry_md_ctl( (a), GCRYCTL_START_DUMP, (b), 0 )
1130
1131 /* Disable the debugging of A. */
1132 #define gcry_md_stop_debug(a,b) \
1133             gcry_md_ctl( (a), GCRYCTL_STOP_DUMP, (b), 0 )
1134
1135 /* Get a list consisting of the IDs of the loaded message digest
1136    modules.  If LIST is zero, write the number of loaded message
1137    digest modules to LIST_LENGTH and return.  If LIST is non-zero, the
1138    first *LIST_LENGTH algorithm IDs are stored in LIST, which must be
1139    of according size.  In case there are less message digest modules
1140    than *LIST_LENGTH, *LIST_LENGTH is updated to the correct
1141    number.  */
1142 gcry_error_t gcry_md_list (int *list, int *list_length);
1143
1144 \f
1145
1146 /* Alternative interface for asymetric cryptography.  */
1147
1148 /* The algorithm IDs. */
1149 typedef enum gcry_ac_id
1150   {
1151     GCRY_AC_RSA = 1,
1152     GCRY_AC_DSA = 17,
1153     GCRY_AC_ELG = 20,
1154     GCRY_AC_ELG_E = 16
1155   }
1156 gcry_ac_id_t;
1157
1158 /* Key types.  */
1159 typedef enum gcry_ac_key_type
1160   {
1161     GCRY_AC_KEY_SECRET,
1162     GCRY_AC_KEY_PUBLIC
1163   }
1164 gcry_ac_key_type_t;
1165
1166 /* Encoding methods.  */
1167 typedef enum gcry_ac_em
1168   {
1169     GCRY_AC_EME_PKCS_V1_5,
1170     GCRY_AC_EMSA_PKCS_V1_5,
1171   }
1172 gcry_ac_em_t;
1173
1174 /* Encryption and Signature schemes.  */
1175 typedef enum gcry_ac_scheme
1176   {
1177     GCRY_AC_ES_PKCS_V1_5,
1178     GCRY_AC_SSA_PKCS_V1_5,
1179   }
1180 gcry_ac_scheme_t;
1181
1182 /* AC data.  */
1183 #define GCRY_AC_FLAG_DEALLOC     (1 << 0)
1184 #define GCRY_AC_FLAG_COPY        (1 << 1)
1185 #define GCRY_AC_FLAG_NO_BLINDING (1 << 2)
1186
1187 /* This type represents a `data set'.  */
1188 typedef struct gcry_ac_data *gcry_ac_data_t;
1189
1190 /* This type represents a single `key', either a secret one or a
1191    public one.  */
1192 typedef struct gcry_ac_key *gcry_ac_key_t;
1193
1194 /* This type represents a `key pair' containing a secret and a public
1195    key.  */
1196 typedef struct gcry_ac_key_pair *gcry_ac_key_pair_t;
1197
1198 /* This type represents a `handle' that is needed by functions
1199    performing cryptographic operations.  */
1200 typedef struct gcry_ac_handle *gcry_ac_handle_t;
1201
1202 typedef gpg_error_t (*gcry_ac_data_read_cb_t) (void *opaque,
1203                                                unsigned char *buffer,
1204                                                size_t *buffer_n);
1205
1206 typedef gpg_error_t (*gcry_ac_data_write_cb_t) (void *opaque,
1207                                                 unsigned char *buffer,
1208                                                 size_t buffer_n);
1209
1210 typedef enum
1211   {
1212     GCRY_AC_IO_READABLE,
1213     GCRY_AC_IO_WRITABLE
1214   }
1215 gcry_ac_io_mode_t;
1216
1217 typedef enum
1218   {
1219     GCRY_AC_IO_STRING,
1220     GCRY_AC_IO_CALLBACK
1221   }
1222 gcry_ac_io_type_t;
1223
1224 typedef struct gcry_ac_io
1225 {
1226   /* This is an INTERNAL structure, do NOT use manually.  */
1227   gcry_ac_io_mode_t mode;
1228   gcry_ac_io_type_t type;
1229   union
1230   {
1231     union
1232     {
1233       struct
1234       {
1235         gcry_ac_data_read_cb_t cb;
1236         void *opaque;
1237       } callback;
1238       struct
1239       {
1240         unsigned char *data;
1241         size_t data_n;
1242       } string;
1243       void *opaque;
1244     } readable;
1245     union
1246     {
1247       struct
1248       {
1249         gcry_ac_data_write_cb_t cb;
1250         void *opaque;
1251       } callback;
1252       struct
1253       {
1254         unsigned char **data;
1255         size_t *data_n;
1256       } string;
1257       void *opaque;
1258     } writable;
1259   };
1260 }
1261 gcry_ac_io_t;
1262
1263 /* The caller of gcry_ac_key_pair_generate can provide one of these
1264    structures in order to influence the key generation process in an
1265    algorithm-specific way.  */
1266 typedef struct gcry_ac_key_spec_rsa
1267 {
1268   gcry_mpi_t e;                 /* E to use.  */
1269 } gcry_ac_key_spec_rsa_t;
1270
1271 /* Structure used for passing data to the implementation of the
1272    `EME-PKCS-V1_5' encoding method.  */
1273 typedef struct gcry_ac_eme_pkcs_v1_5
1274 {
1275   size_t key_size;
1276 } gcry_ac_eme_pkcs_v1_5_t;
1277
1278 typedef enum gcry_md_algos gcry_md_algo_t;
1279
1280 /* Structure used for passing data to the implementation of the
1281    `EMSA-PKCS-V1_5' encoding method.  */
1282 typedef struct gcry_ac_emsa_pkcs_v1_5
1283 {
1284   gcry_md_algo_t md;
1285   size_t em_n;
1286 } gcry_ac_emsa_pkcs_v1_5_t;
1287
1288 /* Structure used for passing data to the implementation of the
1289    `SSA-PKCS-V1_5' signature scheme.  */
1290 typedef struct gcry_ac_ssa_pkcs_v1_5
1291 {
1292   gcry_md_algo_t md;
1293 } gcry_ac_ssa_pkcs_v1_5_t;
1294
1295 /* Returns a new, empty data set in DATA.  */
1296 gcry_error_t gcry_ac_data_new (gcry_ac_data_t *data);
1297
1298 /* Destroy the data set DATA.  */
1299 void gcry_ac_data_destroy (gcry_ac_data_t data);
1300
1301 /* Create a copy of the data set DATA and store it in DATA_CP.  */
1302 gcry_error_t gcry_ac_data_copy (gcry_ac_data_t *data_cp,
1303                                gcry_ac_data_t data);
1304
1305 /* Return the number of named MPI values inside of the data set
1306    DATA.  */
1307 unsigned int gcry_ac_data_length (gcry_ac_data_t data);
1308
1309 /* Destroy any values contained in the data set DATA.  */
1310 void gcry_ac_data_clear (gcry_ac_data_t data);
1311
1312 /* Add the value MPI to DATA with the label NAME.  If FLAGS contains
1313    GCRY_AC_FLAG_DATA_COPY, the data set will contain copies of NAME
1314    and MPI.  If FLAGS contains GCRY_AC_FLAG_DATA_DEALLOC or
1315    GCRY_AC_FLAG_DATA_COPY, the values contained in the data set will
1316    be deallocated when they are to be removed from the data set.  */
1317 gcry_error_t gcry_ac_data_set (gcry_ac_data_t data, unsigned int flags,
1318                                const char *name, gcry_mpi_t mpi);
1319
1320 /* Store the value labelled with NAME found in DATA in MPI.  If FLAGS
1321    contains GCRY_AC_FLAG_COPY, store a copy of the MPI value contained
1322    in the data set.  MPI may be NULL.  */
1323 gcry_error_t gcry_ac_data_get_name (gcry_ac_data_t data, unsigned int flags,
1324                                     const char *name, gcry_mpi_t *mpi);
1325
1326 /* Stores in NAME and MPI the named MPI value contained in the data
1327    set DATA with the index IDX.  If FLAGS contains GCRY_AC_FLAG_COPY,
1328    store copies of the values contained in the data set. NAME or MPI
1329    may be NULL.  */
1330 gcry_error_t gcry_ac_data_get_index (gcry_ac_data_t data, unsigned int flags,
1331                                      unsigned int idx,
1332                                      const char **name, gcry_mpi_t *mpi);
1333
1334 /* Convert the data set DATA into a new S-Expression, which is to be
1335    stored in SEXP, according to the identifiers contained in
1336    IDENTIFIERS.  */
1337 gcry_error_t gcry_ac_data_to_sexp (gcry_ac_data_t data, gcry_sexp_t *sexp,
1338                                    const char **identifiers);
1339
1340 /* Create a new data set, which is to be stored in DATA_SET, from the
1341    S-Expression SEXP, according to the identifiers contained in
1342    IDENTIFIERS.  */
1343 gcry_error_t gcry_ac_data_from_sexp (gcry_ac_data_t *data, gcry_sexp_t sexp,
1344                                      const char **identifiers);
1345
1346 /* Initialize AC_IO according to MODE, TYPE and the variable list of
1347    arguments.  The list of variable arguments to specify depends on
1348    the given TYPE.  */
1349 void gcry_ac_io_init (gcry_ac_io_t *ac_io, gcry_ac_io_mode_t mode,
1350                       gcry_ac_io_type_t type, ...);
1351
1352 /* Initialize AC_IO according to MODE, TYPE and the variable list of
1353    arguments AP.  The list of variable arguments to specify depends on
1354    the given TYPE.  */
1355 void gcry_ac_io_init_va (gcry_ac_io_t *ac_io, gcry_ac_io_mode_t mode,
1356                          gcry_ac_io_type_t type, va_list ap);
1357
1358 /* Create a new ac handle.  */
1359 gcry_error_t gcry_ac_open (gcry_ac_handle_t *handle,
1360                            gcry_ac_id_t algorithm, unsigned int flags);
1361
1362 /* Destroy an ac handle.  */
1363 void gcry_ac_close (gcry_ac_handle_t handle);
1364
1365 /* Initialize a key from a given data set.  */
1366 gcry_error_t gcry_ac_key_init (gcry_ac_key_t *key, gcry_ac_handle_t handle,
1367                                gcry_ac_key_type_t type, gcry_ac_data_t data);
1368
1369 /* Generates a new key pair via the handle HANDLE of NBITS bits and
1370    stores it in KEY_PAIR.  In case non-standard settings are wanted, a
1371    pointer to a structure of type gcry_ac_key_spec_<algorithm>_t,
1372    matching the selected algorithm, can be given as KEY_SPEC.
1373    MISC_DATA is not used yet.  */
1374 gcry_error_t gcry_ac_key_pair_generate (gcry_ac_handle_t handle,
1375                                         unsigned int nbits, void *spec,
1376                                         gcry_ac_key_pair_t *key_pair,
1377                                         gcry_mpi_t **misc_data);
1378
1379 /* Returns the key of type WHICH out of the key pair KEY_PAIR.  */
1380 gcry_ac_key_t gcry_ac_key_pair_extract (gcry_ac_key_pair_t key_pair,
1381                                         gcry_ac_key_type_t which);
1382
1383 /* Returns the data set contained in the key KEY.  */
1384 gcry_ac_data_t gcry_ac_key_data_get (gcry_ac_key_t key);
1385
1386 /* Verifies that the key KEY is sane via HANDLE.  */
1387 gcry_error_t gcry_ac_key_test (gcry_ac_handle_t handle, gcry_ac_key_t key);
1388
1389 /* Stores the number of bits of the key KEY in NBITS via HANDLE.  */
1390 gcry_error_t gcry_ac_key_get_nbits (gcry_ac_handle_t handle,
1391                                     gcry_ac_key_t key, unsigned int *nbits);
1392
1393 /* Writes the 20 byte long key grip of the key KEY to KEY_GRIP via
1394    HANDLE.  */
1395 gcry_error_t gcry_ac_key_get_grip (gcry_ac_handle_t handle, gcry_ac_key_t key,
1396                                    unsigned char *key_grip);
1397
1398 /* Destroy a key.  */
1399 void gcry_ac_key_destroy (gcry_ac_key_t key);
1400
1401 /* Destroy a key pair.  */
1402 void gcry_ac_key_pair_destroy (gcry_ac_key_pair_t key_pair);
1403
1404 /* Encodes a message according to the encoding method METHOD.  OPTIONS
1405    must be a pointer to a method-specific structure
1406    (gcry_ac_em*_t).  */
1407 gcry_error_t gcry_ac_data_encode (gcry_ac_em_t method,
1408                                   unsigned int flags, void *options,
1409                                   gcry_ac_io_t *io_read,
1410                                   gcry_ac_io_t *io_write);
1411
1412 /* Decodes a message according to the encoding method METHOD.  OPTIONS
1413    must be a pointer to a method-specific structure
1414    (gcry_ac_em*_t).  */
1415 gcry_error_t gcry_ac_data_decode (gcry_ac_em_t method,
1416                                   unsigned int flags, void *options,
1417                                   gcry_ac_io_t *io_read,
1418                                   gcry_ac_io_t *io_write);
1419
1420 /* Encrypt the plain text MPI value DATA_PLAIN with the key KEY under
1421    the control of the flags FLAGS and store the resulting data set
1422    into DATA_ENCRYPTED.  */
1423 gcry_error_t gcry_ac_data_encrypt (gcry_ac_handle_t handle,
1424                                    unsigned int flags,
1425                                    gcry_ac_key_t key,
1426                                    gcry_mpi_t data_plain,
1427                                    gcry_ac_data_t *data_encrypted);
1428
1429 /* Decrypt the decrypted data contained in the data set DATA_ENCRYPTED
1430    with the key KEY under the control of the flags FLAGS and store the
1431    resulting plain text MPI value in DATA_PLAIN.  */
1432 gcry_error_t gcry_ac_data_decrypt (gcry_ac_handle_t handle,
1433                                    unsigned int flags,
1434                                    gcry_ac_key_t key,
1435                                    gcry_mpi_t *data_plain,
1436                                    gcry_ac_data_t data_encrypted);
1437
1438 /* Sign the data contained in DATA with the key KEY and store the
1439    resulting signature in the data set DATA_SIGNATURE.  */
1440 gcry_error_t gcry_ac_data_sign (gcry_ac_handle_t handle,
1441                                 gcry_ac_key_t key,
1442                                 gcry_mpi_t data,
1443                                 gcry_ac_data_t *data_signature);
1444
1445 /* Verify that the signature contained in the data set DATA_SIGNATURE
1446    is indeed the result of signing the data contained in DATA with the
1447    secret key belonging to the public key KEY.  */
1448 gcry_error_t gcry_ac_data_verify (gcry_ac_handle_t handle,
1449                                   gcry_ac_key_t key,
1450                                   gcry_mpi_t data,
1451                                   gcry_ac_data_t data_signature);
1452
1453 /* Encrypts the plain text readable from IO_MESSAGE through HANDLE
1454    with the public key KEY according to SCHEME, FLAGS and OPTS.  If
1455    OPTS is not NULL, it has to be a pointer to a structure specific to
1456    the chosen scheme (gcry_ac_es_*_t).  The encrypted message is
1457    written to IO_CIPHER. */
1458 gcry_error_t gcry_ac_data_encrypt_scheme (gcry_ac_handle_t handle,
1459                                           gcry_ac_scheme_t scheme,
1460                                           unsigned int flags, void *opts,
1461                                           gcry_ac_key_t key,
1462                                           gcry_ac_io_t *io_message,
1463                                           gcry_ac_io_t *io_cipher);
1464
1465 /* Decrypts the cipher text readable from IO_CIPHER through HANDLE
1466    with the secret key KEY according to SCHEME, @var{flags} and OPTS.
1467    If OPTS is not NULL, it has to be a pointer to a structure specific
1468    to the chosen scheme (gcry_ac_es_*_t).  The decrypted message is
1469    written to IO_MESSAGE.  */
1470 gcry_error_t gcry_ac_data_decrypt_scheme (gcry_ac_handle_t handle,
1471                                           gcry_ac_scheme_t scheme,
1472                                           unsigned int flags, void *opts,
1473                                           gcry_ac_key_t key,
1474                                           gcry_ac_io_t *io_cipher,
1475                                           gcry_ac_io_t *io_message);
1476
1477 /* Signs the message readable from IO_MESSAGE through HANDLE with the
1478    secret key KEY according to SCHEME, FLAGS and OPTS.  If OPTS is not
1479    NULL, it has to be a pointer to a structure specific to the chosen
1480    scheme (gcry_ac_ssa_*_t).  The signature is written to
1481    IO_SIGNATURE.  */
1482 gcry_error_t gcry_ac_data_sign_scheme (gcry_ac_handle_t handle,
1483                                        gcry_ac_scheme_t scheme,
1484                                        unsigned int flags, void *opts,
1485                                        gcry_ac_key_t key,
1486                                        gcry_ac_io_t *io_message,
1487                                        gcry_ac_io_t *io_signature);
1488
1489 /* Verifies through HANDLE that the signature readable from
1490    IO_SIGNATURE is indeed the result of signing the message readable
1491    from IO_MESSAGE with the secret key belonging to the public key KEY
1492    according to SCHEME and OPTS.  If OPTS is not NULL, it has to be an
1493    anonymous structure (gcry_ac_ssa_*_t) specific to the chosen
1494    scheme.  */
1495 gcry_error_t gcry_ac_data_verify_scheme (gcry_ac_handle_t handle,
1496                                          gcry_ac_scheme_t scheme,
1497                                          unsigned int flags, void *opts,
1498                                          gcry_ac_key_t key,
1499                                          gcry_ac_io_t *io_message,
1500                                          gcry_ac_io_t *io_signature);
1501
1502 /* Store the textual representation of the algorithm whose id is given
1503    in ALGORITHM in NAME.  */
1504 gcry_error_t gcry_ac_id_to_name (gcry_ac_id_t algorithm,
1505                                 const char **name);
1506
1507 /* Store the numeric ID of the algorithm whose textual representation
1508    is contained in NAME in ALGORITHM.  */
1509 gcry_error_t gcry_ac_name_to_id (const char *name,
1510                                 gcry_ac_id_t *algorithm);
1511
1512
1513 \f
1514 /************************************
1515  *                                  *
1516  *   random generating functions    *
1517  *                                  *
1518  ************************************/
1519
1520 /* The possible values for the random quality.  The rule of thumb is
1521    to use STRONG for session keys and VERY_STRONG for key material.
1522    WEAK is currently an alias for STRONG and should not be used
1523    anymore - use gcry_create_nonce instead. */
1524 typedef enum gcry_random_level
1525   {
1526     GCRY_WEAK_RANDOM = 0,
1527     GCRY_STRONG_RANDOM = 1,
1528     GCRY_VERY_STRONG_RANDOM = 2
1529   }
1530 gcry_random_level_t;
1531
1532 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
1533    quality LEVEL. */
1534 void gcry_randomize (unsigned char *buffer, size_t length,
1535                      enum gcry_random_level level);
1536
1537 /* Add the external random from BUFFER with LENGTH bytes into the
1538    pool. QUALITY should either be -1 for unknown or in the range of 0
1539    to 100 */
1540 gcry_error_t gcry_random_add_bytes (const void *buffer, size_t length,
1541                                    int quality);
1542
1543 /* If random numbers are used in an application, this macro should be
1544    called from time to time so that new stuff gets added to the
1545    internal pool of the RNG.  */
1546 #define gcry_fast_random_poll()  gcry_control (GCRYCTL_FAST_POLL, NULL)
1547
1548
1549 /* Return NBYTES of allocated random using a random numbers of quality
1550    LEVEL. */
1551 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level)
1552                          _GCRY_GCC_ATTR_MALLOC;
1553
1554 /* Return NBYTES of allocated random using a random numbers of quality
1555    LEVEL.  The random numbers are created returned in "secure"
1556    memory. */
1557 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level)
1558                                 _GCRY_GCC_ATTR_MALLOC;
1559
1560
1561 /* Set the big integer W to a random value of NBITS using a random
1562    generator with quality LEVEL. */
1563 void gcry_mpi_randomize (gcry_mpi_t w,
1564                          unsigned int nbits, enum gcry_random_level level);
1565
1566
1567 /* Create an unpredicable nonce of LENGTH bytes in BUFFER. */
1568 void gcry_create_nonce (unsigned char *buffer, size_t length);
1569
1570
1571
1572
1573 /* Prime interface.  */
1574
1575 /* Mode values passed to a gcry_prime_check_func_t. */
1576 #define GCRY_PRIME_CHECK_AT_FINISH      0
1577 #define GCRY_PRIME_CHECK_AT_GOT_PRIME   1
1578 #define GCRY_PRIME_CHECK_AT_MAYBE_PRIME 2
1579
1580 /* The function should return 1 if the operation shall continue, 0 to
1581    reject the prime candidate. */
1582 typedef int (*gcry_prime_check_func_t) (void *arg, int mode,
1583                                         gcry_mpi_t candidate);
1584
1585 /* Flags for gcry_prime_generate():  */
1586
1587 /* Allocate prime numbers and factors in secure memory.  */
1588 #define GCRY_PRIME_FLAG_SECRET         (1 << 0)
1589
1590 /* Make sure that at least one prime factor is of size
1591    `FACTOR_BITS'.  */
1592 #define GCRY_PRIME_FLAG_SPECIAL_FACTOR (1 << 1)
1593
1594 /* Generate a new prime number of PRIME_BITS bits and store it in
1595    PRIME.  If FACTOR_BITS is non-zero, one of the prime factors of
1596    (prime - 1) / 2 must be FACTOR_BITS bits long.  If FACTORS is
1597    non-zero, allocate a new, NULL-terminated array holding the prime
1598    factors and store it in FACTORS.  FLAGS might be used to influence
1599    the prime number generation process.  */
1600 gcry_error_t gcry_prime_generate (gcry_mpi_t *prime,
1601                                   unsigned int prime_bits,
1602                                   unsigned int factor_bits,
1603                                   gcry_mpi_t **factors,
1604                                   gcry_prime_check_func_t cb_func,
1605                                   void *cb_arg,
1606                                   gcry_random_level_t random_level,
1607                                   unsigned int flags);
1608
1609 /* Find a generator for PRIME where the factorization of (prime-1) is
1610    in the NULL terminated array FACTORS. Return the generator as a
1611    newly allocated MPI in R_G.  If START_G is not NULL, use this as
1612    teh start for the search. */
1613 gcry_error_t gcry_prime_group_generator (gcry_mpi_t *r_g,
1614                                          gcry_mpi_t prime, gcry_mpi_t *factors,
1615                                          gcry_mpi_t start_g);
1616
1617
1618 /* Convenience function to release the FACTORS array. */
1619 void gcry_prime_release_factors (gcry_mpi_t *factors);
1620
1621
1622 /* Check wether the number X is prime.  */
1623 gcry_error_t gcry_prime_check (gcry_mpi_t x, unsigned int flags);
1624
1625
1626 \f
1627 /************************************
1628  *                                  *
1629  *     miscellaneous stuff          *
1630  *                                  *
1631  ************************************/
1632
1633 /* Log levels used by the internal logging facility. */
1634 enum gcry_log_levels 
1635   {
1636     GCRY_LOG_CONT   = 0,    /* continue the last log line */
1637     GCRY_LOG_INFO   = 10,
1638     GCRY_LOG_WARN   = 20,
1639     GCRY_LOG_ERROR  = 30,
1640     GCRY_LOG_FATAL  = 40,
1641     GCRY_LOG_BUG    = 50,
1642     GCRY_LOG_DEBUG  = 100
1643   };
1644
1645 /* Type for progress handlers.  */
1646 typedef void (*gcry_handler_progress_t) (void *, const char *, int, int, int);
1647
1648 /* Type for memory allocation handlers.  */
1649 typedef void *(*gcry_handler_alloc_t) (size_t n);
1650
1651 /* Type for secure memory check handlers.  */
1652 typedef int (*gcry_handler_secure_check_t) (const void *);
1653
1654 /* Type for memory reallocation handlers.  */
1655 typedef void *(*gcry_handler_realloc_t) (void *p, size_t n);
1656
1657 /* Type for memory free handlers.  */
1658 typedef void (*gcry_handler_free_t) (void *);
1659
1660 /* Type for out-of-memory handlers.  */
1661 typedef int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int);
1662
1663 /* Type for fatal error handlers.  */
1664 typedef void (*gcry_handler_error_t) (void *, int, const char *);
1665
1666 /* Type for logging handlers.  */
1667 typedef void (*gcry_handler_log_t) (void *, int, const char *, va_list);
1668
1669 /* Certain operations can provide progress information.  This function
1670    is used to register a handler for retrieving these information. */
1671 void gcry_set_progress_handler (gcry_handler_progress_t cb, void *cb_data);
1672
1673
1674 /* Register a custom memory allocation functions. */
1675 void gcry_set_allocation_handler (
1676                              gcry_handler_alloc_t func_alloc,
1677                              gcry_handler_alloc_t func_alloc_secure,
1678                              gcry_handler_secure_check_t func_secure_check,
1679                              gcry_handler_realloc_t func_realloc,
1680                              gcry_handler_free_t func_free);
1681
1682 /* Register a function used instead of the internal out of memory
1683    handler. */
1684 void gcry_set_outofcore_handler (gcry_handler_no_mem_t h, void *opaque);
1685
1686 /* Register a function used instead of the internal fatal error
1687    handler. */
1688 void gcry_set_fatalerror_handler (gcry_handler_error_t fnc, void *opaque);
1689
1690 /* Register a function used instead of the internal logging
1691    facility. */
1692 void gcry_set_log_handler (gcry_handler_log_t f, void *opaque);
1693
1694 /* Reserved for future use. */
1695 void gcry_set_gettext_handler (const char *(*f)(const char*));
1696
1697 /* Libgcrypt uses its own memory allocation.  It is important to use
1698    gcry_free () to release memory allocated by libgcrypt. */
1699 void *gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1700 void *gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1701 void *gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1702 void *gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1703 void *gcry_realloc (void *a, size_t n);
1704 char *gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
1705 void *gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1706 void *gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1707 void *gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1708 void *gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1709 void *gcry_xrealloc (void *a, size_t n);
1710 char *gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
1711 void  gcry_free (void *a);
1712
1713 /* Return true if A is allocated in "secure" memory. */
1714 int gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
1715
1716 /* Include support for Libgcrypt modules.  */
1717 #include <gcrypt-module.h>
1718
1719 #if 0 /* keep Emacsens' auto-indent happy */
1720 {
1721 #endif
1722 #ifdef __cplusplus
1723 }
1724 #endif
1725 #endif /* _GCRYPT_H */