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