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