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