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