23cd36f6605d03fdc647889069fd2723cf37a6aa
[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_SET_RNDEGD_SOCKET = 52,
360     GCRYCTL_PRINT_CONFIG = 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     GCRY_CIPHER_CAMELLIA128 = 310,
770     GCRY_CIPHER_CAMELLIA192 = 311,
771     GCRY_CIPHER_CAMELLIA256 = 312
772   };
773
774 /* The Rijndael algorithm is basically AES, so provide some macros. */
775 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES    
776 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES    
777 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128 
778 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192 
779 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256 
780
781 /* The supported encryption modes.  Note that not all of them are
782    supported for each algorithm. */
783 enum gcry_cipher_modes 
784   {
785     GCRY_CIPHER_MODE_NONE   = 0,  /* Not yet specified. */
786     GCRY_CIPHER_MODE_ECB    = 1,  /* Electronic codebook. */
787     GCRY_CIPHER_MODE_CFB    = 2,  /* Cipher feedback. */
788     GCRY_CIPHER_MODE_CBC    = 3,  /* Cipher block chaining. */
789     GCRY_CIPHER_MODE_STREAM = 4,  /* Used with stream ciphers. */
790     GCRY_CIPHER_MODE_OFB    = 5,  /* Outer feedback. */
791     GCRY_CIPHER_MODE_CTR    = 6   /* Counter. */
792   };
793
794 /* Flags used with the open function. */ 
795 enum gcry_cipher_flags
796   {
797     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
798     GCRY_CIPHER_ENABLE_SYNC = 2,  /* Enable CFB sync mode. */
799     GCRY_CIPHER_CBC_CTS     = 4,  /* Enable CBC cipher text stealing (CTS). */
800     GCRY_CIPHER_CBC_MAC     = 8   /* Enable CBC message auth. code (MAC). */
801   };
802
803
804 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
805    be given as an bitwise OR of the gcry_cipher_flags values. */
806 gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *handle,
807                               int algo, int mode, unsigned int flags);
808
809 /* Close the cioher handle H and release all resource. */
810 void gcry_cipher_close (gcry_cipher_hd_t h);
811
812 /* Perform various operations on the cipher object H. */
813 gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer,
814                              size_t buflen);
815
816 /* Retrieve various information about the cipher object H. */
817 gcry_error_t gcry_cipher_info (gcry_cipher_hd_t h, int what, void *buffer,
818                               size_t *nbytes);
819
820 /* Retrieve various information about the cipher algorithm ALGO. */
821 gcry_error_t gcry_cipher_algo_info (int algo, int what, void *buffer,
822                                    size_t *nbytes);
823
824 /* Map the cipher algorithm whose ID is contained in ALGORITHM to a
825    string representation of the algorithm name.  For unknown algorithm
826    IDs this function returns "?".  */
827 const char *gcry_cipher_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
828
829 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
830    the algorithm name is not known. */
831 int gcry_cipher_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
832
833 /* Given an ASN.1 object identifier in standard IETF dotted decimal
834    format in STRING, return the encryption mode associated with that
835    OID or 0 if not known or applicable. */
836 int gcry_cipher_mode_from_oid (const char *string) _GCRY_GCC_ATTR_PURE;
837
838 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
839    into the buffer OUT which has an allocated length of OUTSIZE.  For
840    most algorithms it is possible to pass NULL for in and 0 for INLEN
841    and do a in-place decryption of the data provided in OUT.  */
842 gcry_error_t gcry_cipher_encrypt (gcry_cipher_hd_t h,
843                                   void *out, size_t outsize,
844                                   const void *in, size_t inlen);
845
846 /* The counterpart to gcry_cipher_encrypt.  */
847 gcry_error_t gcry_cipher_decrypt (gcry_cipher_hd_t h,
848                                   void *out, size_t outsize,
849                                   const void *in, size_t inlen);
850
851 /* Set key K of length L for the cipher handle H.  (We have to cast
852    away a const char* here - this catch-all ctl function was probably
853    not the best choice) */
854 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
855                                                          (char*)(k), (l) )
856
857 /* Set initialization vector K of length L for the cipher handle H. */
858 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
859                                                          (char*)(k), (l) )
860
861 /* Reset the handle to the state after open.  */
862 #define gcry_cipher_reset(h)  gcry_cipher_ctl ((h), GCRYCTL_RESET, NULL, 0)
863
864 /* Perform the the OpenPGP sync operation if this is enabled for the
865    cipher handle H. */
866 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
867                                                                    NULL, 0 )
868
869 /* Enable or disable CTS in future calls to gcry_encrypt(). CBC mode only. */
870 #define gcry_cipher_cts(h,on)  gcry_cipher_ctl( (h), GCRYCTL_SET_CBC_CTS, \
871                                                                    NULL, on )
872
873 /* Set counter for CTR mode.  (K,L) must denote a buffer of block size
874    length, or (NULL,0) to set the CTR to the all-zero block. */
875 #define gcry_cipher_setctr(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_CTR, \
876                                                     (char*)(k), (l) )
877
878 /* Retrieved the key length used with algorithm A. */
879 size_t gcry_cipher_get_algo_keylen (int algo);
880
881 /* Retrieve the block length used with algorithm A. */
882 size_t gcry_cipher_get_algo_blklen (int algo);
883
884 /* Return 0 if the algorithm A is available for use. */
885 #define gcry_cipher_test_algo(a) \
886             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
887
888 /* Get a list consisting of the IDs of the loaded cipher modules.  If
889    LIST is zero, write the number of loaded cipher modules to
890    LIST_LENGTH and return.  If LIST is non-zero, the first
891    *LIST_LENGTH algorithm IDs are stored in LIST, which must be of
892    according size.  In case there are less cipher modules than
893    *LIST_LENGTH, *LIST_LENGTH is updated to the correct number.  */
894 gcry_error_t gcry_cipher_list (int *list, int *list_length);
895
896 \f
897 /************************************
898  *                                  *
899  *    asymmetric cipher functions   *
900  *                                  *
901  ************************************/
902
903 /* The algorithms and their IDs we support. */
904 enum gcry_pk_algos 
905   {
906     GCRY_PK_RSA = 1,
907     GCRY_PK_RSA_E = 2,      /* deprecated */
908     GCRY_PK_RSA_S = 3,      /* deprecated */
909     GCRY_PK_ELG_E = 16,     /* use only for OpenPGP */
910     GCRY_PK_DSA   = 17,
911     GCRY_PK_ELG   = 20,
912     GCRY_PK_ECDSA = 301     /* Experimental implementaion; not for
913                                production. */
914   };
915
916 /* Flags describing usage capabilities of a PK algorithm. */
917 #define GCRY_PK_USAGE_SIGN 1   /* Good for signatures. */            
918 #define GCRY_PK_USAGE_ENCR 2   /* Good for encryption. */            
919 #define GCRY_PK_USAGE_CERT 4   /* Good to certify other keys. */
920 #define GCRY_PK_USAGE_AUTH 8   /* Good for authentication. */        
921 #define GCRY_PK_USAGE_UNKN 128 /* Unknown usage flag. */          
922
923 /* Encrypt the DATA using the public key PKEY and store the result as
924    a newly created S-expression at RESULT. */
925 gcry_error_t gcry_pk_encrypt (gcry_sexp_t *result,
926                               gcry_sexp_t data, gcry_sexp_t pkey);
927
928 /* Decrypt the DATA using the private key SKEY and store the result as
929    a newly created S-expression at RESULT. */
930 gcry_error_t gcry_pk_decrypt (gcry_sexp_t *result,
931                               gcry_sexp_t data, gcry_sexp_t skey);
932
933 /* Sign the DATA using the private key SKEY and store the result as
934    a newly created S-expression at RESULT. */
935 gcry_error_t gcry_pk_sign (gcry_sexp_t *result,
936                            gcry_sexp_t data, gcry_sexp_t skey);
937
938 /* Check the signature SIGVAL on DATA using the public key PKEY. */
939 gcry_error_t gcry_pk_verify (gcry_sexp_t sigval,
940                              gcry_sexp_t data, gcry_sexp_t pkey);
941
942 /* Check that private KEY is sane. */
943 gcry_error_t gcry_pk_testkey (gcry_sexp_t key);
944
945 /* Generate a new key pair according to the parameters given in
946    S_PARMS.  The new key pair is returned in as an S-expression in
947    R_KEY. */
948 gcry_error_t gcry_pk_genkey (gcry_sexp_t *r_key, gcry_sexp_t s_parms);
949
950 /* Catch all function for miscellaneous operations. */
951 gcry_error_t gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
952
953 /* Retrieve information about the public key algorithm ALGO. */
954 gcry_error_t gcry_pk_algo_info (int algo, int what,
955                                 void *buffer, size_t *nbytes);
956
957 /* Map the public key algorithm whose ID is contained in ALGORITHM to
958    a string representation of the algorithm name.  For unknown
959    algorithm IDs this functions returns "?". */
960 const char *gcry_pk_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
961
962 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
963    the algorithm name is not known. */
964 int gcry_pk_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
965
966 /* Return what is commonly referred as the key length for the given
967    public or private KEY.  */
968 unsigned int gcry_pk_get_nbits (gcry_sexp_t key) _GCRY_GCC_ATTR_PURE;
969
970 /* Please note that keygrip is still experimental and should not be
971    used without contacting the author. */
972 unsigned char *gcry_pk_get_keygrip (gcry_sexp_t key, unsigned char *array);
973
974 /* Return 0 if the public key algorithm A is available for use. */
975 #define gcry_pk_test_algo(a) \
976             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
977
978 /* Get a list consisting of the IDs of the loaded pubkey modules.  If
979    LIST is zero, write the number of loaded pubkey modules to
980    LIST_LENGTH and return.  If LIST is non-zero, the first
981    *LIST_LENGTH algorithm IDs are stored in LIST, which must be of
982    according size.  In case there are less pubkey modules than
983    *LIST_LENGTH, *LIST_LENGTH is updated to the correct number.  */
984 gcry_error_t gcry_pk_list (int *list, int *list_length);
985
986 \f
987
988 /************************************
989  *                                  *
990  *   cryptograhic hash functions    *
991  *                                  *
992  ************************************/
993
994 /* Algorithm IDs for the hash functions we know about. Not all of them
995    are implemnted. */
996 enum gcry_md_algos
997   {
998     GCRY_MD_NONE    = 0,  
999     GCRY_MD_MD5     = 1,
1000     GCRY_MD_SHA1    = 2,
1001     GCRY_MD_RMD160  = 3,
1002     GCRY_MD_MD2     = 5,
1003     GCRY_MD_TIGER   = 6,   /* TIGER/192. */
1004     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
1005     GCRY_MD_SHA256  = 8,
1006     GCRY_MD_SHA384  = 9,
1007     GCRY_MD_SHA512  = 10,
1008     GCRY_MD_SHA224  = 11,
1009     GCRY_MD_MD4     = 301,
1010     GCRY_MD_CRC32               = 302,
1011     GCRY_MD_CRC32_RFC1510       = 303,
1012     GCRY_MD_CRC24_RFC2440       = 304,
1013     GCRY_MD_WHIRLPOOL = 305
1014   };
1015
1016 /* Flags used with the open function.  */
1017 enum gcry_md_flags
1018   {
1019     GCRY_MD_FLAG_SECURE = 1,  /* Allocate all buffers in "secure"
1020                                  memory.  */
1021     GCRY_MD_FLAG_HMAC   = 2   /* Make an HMAC out of this
1022                                  algorithm.  */
1023   };
1024
1025 /* Forward declaration.  */
1026 struct gcry_md_context;
1027
1028 /* This object is used to hold a handle to a message digest object.
1029    This structure is private - only to be used by the public gcry_md_*
1030    macros.  */
1031 typedef struct gcry_md_handle 
1032 {
1033   /* Actual context.  */
1034   struct gcry_md_context *ctx;
1035   
1036   /* Buffer management.  */
1037   int  bufpos;
1038   int  bufsize;
1039   unsigned char buf[1];
1040 } *gcry_md_hd_t;
1041
1042 /* Compatibility types, do not use them.  */
1043 typedef struct gcry_md_handle *GCRY_MD_HD _GCRY_GCC_ATTR_DEPRECATED;
1044 typedef struct gcry_md_handle *GcryMDHd _GCRY_GCC_ATTR_DEPRECATED;
1045
1046 /* Create a message digest object for algorithm ALGO.  FLAGS may be
1047    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
1048    given as 0 if the algorithms to be used are later set using
1049    gcry_md_enable.  */
1050 gcry_error_t gcry_md_open (gcry_md_hd_t *h, int algo, unsigned int flags);
1051
1052 /* Release the message digest object HD.  */
1053 void gcry_md_close (gcry_md_hd_t hd);
1054
1055 /* Add the message digest algorithm ALGO to the digest object HD.  */
1056 gcry_error_t gcry_md_enable (gcry_md_hd_t hd, int algo);
1057
1058 /* Create a new digest object as an exact copy of the object HD.  */
1059 gcry_error_t gcry_md_copy (gcry_md_hd_t *bhd, gcry_md_hd_t ahd);
1060
1061 /* Reset the digest object HD to its initial state.  */
1062 void gcry_md_reset (gcry_md_hd_t hd);
1063
1064 /* Perform various operations on the digest object HD. */
1065 gcry_error_t gcry_md_ctl (gcry_md_hd_t hd, int cmd,
1066                           void *buffer, size_t buflen);
1067
1068 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
1069    it can update the digest values.  This is the actual hash
1070    function. */
1071 void gcry_md_write (gcry_md_hd_t hd, const void *buffer, size_t length);
1072
1073 /* Read out the final digest from HD return the digest value for
1074    algorithm ALGO. */
1075 unsigned char *gcry_md_read (gcry_md_hd_t hd, int algo);
1076
1077 /* Convenience function to calculate the hash from the data in BUFFER
1078    of size LENGTH using the algorithm ALGO avoiding the creating of a
1079    hash object.  The hash is returned in the caller provided buffer
1080    DIGEST which must be large enough to hold the digest of the given
1081    algorithm. */
1082 void gcry_md_hash_buffer (int algo, void *digest,
1083                           const void *buffer, size_t length);
1084
1085 /* Retrieve the algorithm used with HD.  This does not work reliable
1086    if more than one algorithm is enabled in HD. */
1087 int gcry_md_get_algo (gcry_md_hd_t hd);
1088
1089 /* Retrieve the length in bytes of the digest yielded by algorithm
1090    ALGO. */
1091 unsigned int gcry_md_get_algo_dlen (int algo);
1092
1093 /* Return true if the the algorithm ALGO is enabled in the digest
1094    object A. */
1095 int gcry_md_is_enabled (gcry_md_hd_t a, int algo);
1096
1097 /* Return true if the digest object A is allocated in "secure" memory. */
1098 int gcry_md_is_secure (gcry_md_hd_t a);
1099
1100 /* Retrieve various information about the object H.  */
1101 gcry_error_t gcry_md_info (gcry_md_hd_t h, int what, void *buffer,
1102                           size_t *nbytes);
1103
1104 /* Retrieve various information about the algorithm ALGO.  */
1105 gcry_error_t gcry_md_algo_info (int algo, int what, void *buffer,
1106                                size_t *nbytes);
1107
1108 /* Map the digest algorithm id ALGO to a string representation of the
1109    algorithm name.  For unknown algorithms this functions returns
1110    "?". */
1111 const char *gcry_md_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
1112
1113 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
1114    the algorithm name is not known. */
1115 int gcry_md_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1116
1117 /* For use with the HMAC feature, the set MAC key to the KEY of
1118    KEYLEN. */
1119 gcry_error_t gcry_md_setkey (gcry_md_hd_t hd, const void *key, size_t keylen);
1120
1121 /* Start or stop debugging for digest handle HD; i.e. create a file
1122    named dbgmd-<n>.<suffix> while hashing.  If SUFFIX is NULL,
1123    debugging stops and the file will be closed. */
1124 void gcry_md_debug (gcry_md_hd_t hd, const char *suffix);
1125
1126
1127 /* Update the hash(s) of H with the character C.  This is a buffered
1128    version of the gcry_md_write function. */
1129 #define gcry_md_putc(h,c)  \
1130             do {                                          \
1131                 gcry_md_hd_t h__ = (h);                   \
1132                 if( (h__)->bufpos == (h__)->bufsize )     \
1133                     gcry_md_write( (h__), NULL, 0 );      \
1134                 (h__)->buf[(h__)->bufpos++] = (c) & 0xff; \
1135             } while(0)
1136
1137 /* Finalize the digest calculation.  This is not really needed because
1138    gcry_md_read() does this implicitly. */
1139 #define gcry_md_final(a) \
1140             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
1141
1142 /* Return 0 if the algorithm A is available for use. */
1143 #define gcry_md_test_algo(a) \
1144             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1145
1146 /* Return an DER encoded ASN.1 OID for the algorithm A in buffer B. N
1147    must point to size_t variable with the available size of buffer B.
1148    After return it will receive the actual size of the returned
1149    OID. */
1150 #define gcry_md_get_asnoid(a,b,n) \
1151             gcry_md_algo_info((a), GCRYCTL_GET_ASNOID, (b), (n))
1152
1153 /* Enable debugging for digest object A; i.e. create files named
1154    dbgmd-<n>.<string> while hashing.  B is a string used as the suffix
1155    for the filename.  This macro is deprecated, use gcry_md_debug. */
1156 #define gcry_md_start_debug(a,b) \
1157             gcry_md_ctl( (a), GCRYCTL_START_DUMP, (b), 0 )
1158
1159 /* Disable the debugging of A.  This macro is deprecated, use
1160    gcry_md_debug.  */
1161 #define gcry_md_stop_debug(a,b) \
1162             gcry_md_ctl( (a), GCRYCTL_STOP_DUMP, (b), 0 )
1163
1164 /* Get a list consisting of the IDs of the loaded message digest
1165    modules.  If LIST is zero, write the number of loaded message
1166    digest modules to LIST_LENGTH and return.  If LIST is non-zero, the
1167    first *LIST_LENGTH algorithm IDs are stored in LIST, which must be
1168    of according size.  In case there are less message digest modules
1169    than *LIST_LENGTH, *LIST_LENGTH is updated to the correct
1170    number.  */
1171 gcry_error_t gcry_md_list (int *list, int *list_length);
1172
1173 \f
1174
1175 /* Alternative interface for asymetric cryptography.  */
1176
1177 /* The algorithm IDs. */
1178 typedef enum gcry_ac_id
1179   {
1180     GCRY_AC_RSA = 1,
1181     GCRY_AC_DSA = 17,
1182     GCRY_AC_ELG = 20,
1183     GCRY_AC_ELG_E = 16
1184   }
1185 gcry_ac_id_t;
1186
1187 /* Key types.  */
1188 typedef enum gcry_ac_key_type
1189   {
1190     GCRY_AC_KEY_SECRET,
1191     GCRY_AC_KEY_PUBLIC
1192   }
1193 gcry_ac_key_type_t;
1194
1195 /* Encoding methods.  */
1196 typedef enum gcry_ac_em
1197   {
1198     GCRY_AC_EME_PKCS_V1_5,
1199     GCRY_AC_EMSA_PKCS_V1_5,
1200   }
1201 gcry_ac_em_t;
1202
1203 /* Encryption and Signature schemes.  */
1204 typedef enum gcry_ac_scheme
1205   {
1206     GCRY_AC_ES_PKCS_V1_5,
1207     GCRY_AC_SSA_PKCS_V1_5,
1208   }
1209 gcry_ac_scheme_t;
1210
1211 /* AC data.  */
1212 #define GCRY_AC_FLAG_DEALLOC     (1 << 0)
1213 #define GCRY_AC_FLAG_COPY        (1 << 1)
1214 #define GCRY_AC_FLAG_NO_BLINDING (1 << 2)
1215
1216 /* This type represents a `data set'.  */
1217 typedef struct gcry_ac_data *gcry_ac_data_t;
1218
1219 /* This type represents a single `key', either a secret one or a
1220    public one.  */
1221 typedef struct gcry_ac_key *gcry_ac_key_t;
1222
1223 /* This type represents a `key pair' containing a secret and a public
1224    key.  */
1225 typedef struct gcry_ac_key_pair *gcry_ac_key_pair_t;
1226
1227 /* This type represents a `handle' that is needed by functions
1228    performing cryptographic operations.  */
1229 typedef struct gcry_ac_handle *gcry_ac_handle_t;
1230
1231 typedef gpg_error_t (*gcry_ac_data_read_cb_t) (void *opaque,
1232                                                unsigned char *buffer,
1233                                                size_t *buffer_n);
1234
1235 typedef gpg_error_t (*gcry_ac_data_write_cb_t) (void *opaque,
1236                                                 unsigned char *buffer,
1237                                                 size_t buffer_n);
1238
1239 typedef enum
1240   {
1241     GCRY_AC_IO_READABLE,
1242     GCRY_AC_IO_WRITABLE
1243   }
1244 gcry_ac_io_mode_t;
1245
1246 typedef enum
1247   {
1248     GCRY_AC_IO_STRING,
1249     GCRY_AC_IO_CALLBACK
1250   }
1251 gcry_ac_io_type_t;
1252
1253 typedef struct gcry_ac_io
1254 {
1255   /* This is an INTERNAL structure, do NOT use manually.  */
1256   gcry_ac_io_mode_t mode;
1257   gcry_ac_io_type_t type;
1258   union
1259   {
1260     union
1261     {
1262       struct
1263       {
1264         gcry_ac_data_read_cb_t cb;
1265         void *opaque;
1266       } callback;
1267       struct
1268       {
1269         unsigned char *data;
1270         size_t data_n;
1271       } string;
1272       void *opaque;
1273     } readable;
1274     union
1275     {
1276       struct
1277       {
1278         gcry_ac_data_write_cb_t cb;
1279         void *opaque;
1280       } callback;
1281       struct
1282       {
1283         unsigned char **data;
1284         size_t *data_n;
1285       } string;
1286       void *opaque;
1287     } writable;
1288   };
1289 }
1290 gcry_ac_io_t;
1291
1292 /* The caller of gcry_ac_key_pair_generate can provide one of these
1293    structures in order to influence the key generation process in an
1294    algorithm-specific way.  */
1295 typedef struct gcry_ac_key_spec_rsa
1296 {
1297   gcry_mpi_t e;                 /* E to use.  */
1298 } gcry_ac_key_spec_rsa_t;
1299
1300 /* Structure used for passing data to the implementation of the
1301    `EME-PKCS-V1_5' encoding method.  */
1302 typedef struct gcry_ac_eme_pkcs_v1_5
1303 {
1304   size_t key_size;
1305 } gcry_ac_eme_pkcs_v1_5_t;
1306
1307 typedef enum gcry_md_algos gcry_md_algo_t;
1308
1309 /* Structure used for passing data to the implementation of the
1310    `EMSA-PKCS-V1_5' encoding method.  */
1311 typedef struct gcry_ac_emsa_pkcs_v1_5
1312 {
1313   gcry_md_algo_t md;
1314   size_t em_n;
1315 } gcry_ac_emsa_pkcs_v1_5_t;
1316
1317 /* Structure used for passing data to the implementation of the
1318    `SSA-PKCS-V1_5' signature scheme.  */
1319 typedef struct gcry_ac_ssa_pkcs_v1_5
1320 {
1321   gcry_md_algo_t md;
1322 } gcry_ac_ssa_pkcs_v1_5_t;
1323
1324 /* Returns a new, empty data set in DATA.  */
1325 gcry_error_t gcry_ac_data_new (gcry_ac_data_t *data);
1326
1327 /* Destroy the data set DATA.  */
1328 void gcry_ac_data_destroy (gcry_ac_data_t data);
1329
1330 /* Create a copy of the data set DATA and store it in DATA_CP.  */
1331 gcry_error_t gcry_ac_data_copy (gcry_ac_data_t *data_cp,
1332                                gcry_ac_data_t data);
1333
1334 /* Return the number of named MPI values inside of the data set
1335    DATA.  */
1336 unsigned int gcry_ac_data_length (gcry_ac_data_t data);
1337
1338 /* Destroy any values contained in the data set DATA.  */
1339 void gcry_ac_data_clear (gcry_ac_data_t data);
1340
1341 /* Add the value MPI to DATA with the label NAME.  If FLAGS contains
1342    GCRY_AC_FLAG_DATA_COPY, the data set will contain copies of NAME
1343    and MPI.  If FLAGS contains GCRY_AC_FLAG_DATA_DEALLOC or
1344    GCRY_AC_FLAG_DATA_COPY, the values contained in the data set will
1345    be deallocated when they are to be removed from the data set.  */
1346 gcry_error_t gcry_ac_data_set (gcry_ac_data_t data, unsigned int flags,
1347                                const char *name, gcry_mpi_t mpi);
1348
1349 /* Store the value labelled with NAME found in DATA in MPI.  If FLAGS
1350    contains GCRY_AC_FLAG_COPY, store a copy of the MPI value contained
1351    in the data set.  MPI may be NULL.  */
1352 gcry_error_t gcry_ac_data_get_name (gcry_ac_data_t data, unsigned int flags,
1353                                     const char *name, gcry_mpi_t *mpi);
1354
1355 /* Stores in NAME and MPI the named MPI value contained in the data
1356    set DATA with the index IDX.  If FLAGS contains GCRY_AC_FLAG_COPY,
1357    store copies of the values contained in the data set. NAME or MPI
1358    may be NULL.  */
1359 gcry_error_t gcry_ac_data_get_index (gcry_ac_data_t data, unsigned int flags,
1360                                      unsigned int idx,
1361                                      const char **name, gcry_mpi_t *mpi);
1362
1363 /* Convert the data set DATA into a new S-Expression, which is to be
1364    stored in SEXP, according to the identifiers contained in
1365    IDENTIFIERS.  */
1366 gcry_error_t gcry_ac_data_to_sexp (gcry_ac_data_t data, gcry_sexp_t *sexp,
1367                                    const char **identifiers);
1368
1369 /* Create a new data set, which is to be stored in DATA_SET, from the
1370    S-Expression SEXP, according to the identifiers contained in
1371    IDENTIFIERS.  */
1372 gcry_error_t gcry_ac_data_from_sexp (gcry_ac_data_t *data, gcry_sexp_t sexp,
1373                                      const char **identifiers);
1374
1375 /* Initialize AC_IO according to MODE, TYPE and the variable list of
1376    arguments.  The list of variable arguments to specify depends on
1377    the given TYPE.  */
1378 void gcry_ac_io_init (gcry_ac_io_t *ac_io, gcry_ac_io_mode_t mode,
1379                       gcry_ac_io_type_t type, ...);
1380
1381 /* Initialize AC_IO according to MODE, TYPE and the variable list of
1382    arguments AP.  The list of variable arguments to specify depends on
1383    the given TYPE.  */
1384 void gcry_ac_io_init_va (gcry_ac_io_t *ac_io, gcry_ac_io_mode_t mode,
1385                          gcry_ac_io_type_t type, va_list ap);
1386
1387 /* Create a new ac handle.  */
1388 gcry_error_t gcry_ac_open (gcry_ac_handle_t *handle,
1389                            gcry_ac_id_t algorithm, unsigned int flags);
1390
1391 /* Destroy an ac handle.  */
1392 void gcry_ac_close (gcry_ac_handle_t handle);
1393
1394 /* Initialize a key from a given data set.  */
1395 gcry_error_t gcry_ac_key_init (gcry_ac_key_t *key, gcry_ac_handle_t handle,
1396                                gcry_ac_key_type_t type, gcry_ac_data_t data);
1397
1398 /* Generates a new key pair via the handle HANDLE of NBITS bits and
1399    stores it in KEY_PAIR.  In case non-standard settings are wanted, a
1400    pointer to a structure of type gcry_ac_key_spec_<algorithm>_t,
1401    matching the selected algorithm, can be given as KEY_SPEC.
1402    MISC_DATA is not used yet.  */
1403 gcry_error_t gcry_ac_key_pair_generate (gcry_ac_handle_t handle,
1404                                         unsigned int nbits, void *spec,
1405                                         gcry_ac_key_pair_t *key_pair,
1406                                         gcry_mpi_t **misc_data);
1407
1408 /* Returns the key of type WHICH out of the key pair KEY_PAIR.  */
1409 gcry_ac_key_t gcry_ac_key_pair_extract (gcry_ac_key_pair_t key_pair,
1410                                         gcry_ac_key_type_t which);
1411
1412 /* Returns the data set contained in the key KEY.  */
1413 gcry_ac_data_t gcry_ac_key_data_get (gcry_ac_key_t key);
1414
1415 /* Verifies that the key KEY is sane via HANDLE.  */
1416 gcry_error_t gcry_ac_key_test (gcry_ac_handle_t handle, gcry_ac_key_t key);
1417
1418 /* Stores the number of bits of the key KEY in NBITS via HANDLE.  */
1419 gcry_error_t gcry_ac_key_get_nbits (gcry_ac_handle_t handle,
1420                                     gcry_ac_key_t key, unsigned int *nbits);
1421
1422 /* Writes the 20 byte long key grip of the key KEY to KEY_GRIP via
1423    HANDLE.  */
1424 gcry_error_t gcry_ac_key_get_grip (gcry_ac_handle_t handle, gcry_ac_key_t key,
1425                                    unsigned char *key_grip);
1426
1427 /* Destroy a key.  */
1428 void gcry_ac_key_destroy (gcry_ac_key_t key);
1429
1430 /* Destroy a key pair.  */
1431 void gcry_ac_key_pair_destroy (gcry_ac_key_pair_t key_pair);
1432
1433 /* Encodes a message according to the encoding method METHOD.  OPTIONS
1434    must be a pointer to a method-specific structure
1435    (gcry_ac_em*_t).  */
1436 gcry_error_t gcry_ac_data_encode (gcry_ac_em_t method,
1437                                   unsigned int flags, void *options,
1438                                   gcry_ac_io_t *io_read,
1439                                   gcry_ac_io_t *io_write);
1440
1441 /* Decodes a message according to the encoding method METHOD.  OPTIONS
1442    must be a pointer to a method-specific structure
1443    (gcry_ac_em*_t).  */
1444 gcry_error_t gcry_ac_data_decode (gcry_ac_em_t method,
1445                                   unsigned int flags, void *options,
1446                                   gcry_ac_io_t *io_read,
1447                                   gcry_ac_io_t *io_write);
1448
1449 /* Encrypt the plain text MPI value DATA_PLAIN with the key KEY under
1450    the control of the flags FLAGS and store the resulting data set
1451    into DATA_ENCRYPTED.  */
1452 gcry_error_t gcry_ac_data_encrypt (gcry_ac_handle_t handle,
1453                                    unsigned int flags,
1454                                    gcry_ac_key_t key,
1455                                    gcry_mpi_t data_plain,
1456                                    gcry_ac_data_t *data_encrypted);
1457
1458 /* Decrypt the decrypted data contained in the data set DATA_ENCRYPTED
1459    with the key KEY under the control of the flags FLAGS and store the
1460    resulting plain text MPI value in DATA_PLAIN.  */
1461 gcry_error_t gcry_ac_data_decrypt (gcry_ac_handle_t handle,
1462                                    unsigned int flags,
1463                                    gcry_ac_key_t key,
1464                                    gcry_mpi_t *data_plain,
1465                                    gcry_ac_data_t data_encrypted);
1466
1467 /* Sign the data contained in DATA with the key KEY and store the
1468    resulting signature in the data set DATA_SIGNATURE.  */
1469 gcry_error_t gcry_ac_data_sign (gcry_ac_handle_t handle,
1470                                 gcry_ac_key_t key,
1471                                 gcry_mpi_t data,
1472                                 gcry_ac_data_t *data_signature);
1473
1474 /* Verify that the signature contained in the data set DATA_SIGNATURE
1475    is indeed the result of signing the data contained in DATA with the
1476    secret key belonging to the public key KEY.  */
1477 gcry_error_t gcry_ac_data_verify (gcry_ac_handle_t handle,
1478                                   gcry_ac_key_t key,
1479                                   gcry_mpi_t data,
1480                                   gcry_ac_data_t data_signature);
1481
1482 /* Encrypts the plain text readable from IO_MESSAGE through HANDLE
1483    with the public key KEY according to SCHEME, FLAGS and OPTS.  If
1484    OPTS is not NULL, it has to be a pointer to a structure specific to
1485    the chosen scheme (gcry_ac_es_*_t).  The encrypted message is
1486    written to IO_CIPHER. */
1487 gcry_error_t gcry_ac_data_encrypt_scheme (gcry_ac_handle_t handle,
1488                                           gcry_ac_scheme_t scheme,
1489                                           unsigned int flags, void *opts,
1490                                           gcry_ac_key_t key,
1491                                           gcry_ac_io_t *io_message,
1492                                           gcry_ac_io_t *io_cipher);
1493
1494 /* Decrypts the cipher text readable from IO_CIPHER through HANDLE
1495    with the secret key KEY according to SCHEME, @var{flags} and OPTS.
1496    If OPTS is not NULL, it has to be a pointer to a structure specific
1497    to the chosen scheme (gcry_ac_es_*_t).  The decrypted message is
1498    written to IO_MESSAGE.  */
1499 gcry_error_t gcry_ac_data_decrypt_scheme (gcry_ac_handle_t handle,
1500                                           gcry_ac_scheme_t scheme,
1501                                           unsigned int flags, void *opts,
1502                                           gcry_ac_key_t key,
1503                                           gcry_ac_io_t *io_cipher,
1504                                           gcry_ac_io_t *io_message);
1505
1506 /* Signs the message readable from IO_MESSAGE through HANDLE with the
1507    secret key KEY according to SCHEME, FLAGS and OPTS.  If OPTS is not
1508    NULL, it has to be a pointer to a structure specific to the chosen
1509    scheme (gcry_ac_ssa_*_t).  The signature is written to
1510    IO_SIGNATURE.  */
1511 gcry_error_t gcry_ac_data_sign_scheme (gcry_ac_handle_t handle,
1512                                        gcry_ac_scheme_t scheme,
1513                                        unsigned int flags, void *opts,
1514                                        gcry_ac_key_t key,
1515                                        gcry_ac_io_t *io_message,
1516                                        gcry_ac_io_t *io_signature);
1517
1518 /* Verifies through HANDLE that the signature readable from
1519    IO_SIGNATURE is indeed the result of signing the message readable
1520    from IO_MESSAGE with the secret key belonging to the public key KEY
1521    according to SCHEME and OPTS.  If OPTS is not NULL, it has to be an
1522    anonymous structure (gcry_ac_ssa_*_t) specific to the chosen
1523    scheme.  */
1524 gcry_error_t gcry_ac_data_verify_scheme (gcry_ac_handle_t handle,
1525                                          gcry_ac_scheme_t scheme,
1526                                          unsigned int flags, void *opts,
1527                                          gcry_ac_key_t key,
1528                                          gcry_ac_io_t *io_message,
1529                                          gcry_ac_io_t *io_signature);
1530
1531 /* Store the textual representation of the algorithm whose id is given
1532    in ALGORITHM in NAME.  This function is deprecated; use
1533    gcry_pk_algo_name. */
1534 gcry_error_t gcry_ac_id_to_name (gcry_ac_id_t algorithm,
1535                                  const char **name) _GCRY_GCC_ATTR_DEPRECATED;
1536 /* Store the numeric ID of the algorithm whose textual representation
1537    is contained in NAME in ALGORITHM.  This function is deprecated;
1538    use gcry_pk_map_name. */
1539 gcry_error_t gcry_ac_name_to_id (const char *name,
1540                                  gcry_ac_id_t *algorithm
1541                                  ) _GCRY_GCC_ATTR_DEPRECATED;;
1542
1543
1544 \f
1545 /************************************
1546  *                                  *
1547  *   random generating functions    *
1548  *                                  *
1549  ************************************/
1550
1551 /* The possible values for the random quality.  The rule of thumb is
1552    to use STRONG for session keys and VERY_STRONG for key material.
1553    WEAK is currently an alias for STRONG and should not be used
1554    anymore - use gcry_create_nonce instead. */
1555 typedef enum gcry_random_level
1556   {
1557     GCRY_WEAK_RANDOM = 0,
1558     GCRY_STRONG_RANDOM = 1,
1559     GCRY_VERY_STRONG_RANDOM = 2
1560   }
1561 gcry_random_level_t;
1562
1563 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
1564    quality LEVEL. */
1565 void gcry_randomize (void *buffer, size_t length,
1566                      enum gcry_random_level level);
1567
1568 /* Add the external random from BUFFER with LENGTH bytes into the
1569    pool. QUALITY should either be -1 for unknown or in the range of 0
1570    to 100 */
1571 gcry_error_t gcry_random_add_bytes (const void *buffer, size_t length,
1572                                    int quality);
1573
1574 /* If random numbers are used in an application, this macro should be
1575    called from time to time so that new stuff gets added to the
1576    internal pool of the RNG.  */
1577 #define gcry_fast_random_poll()  gcry_control (GCRYCTL_FAST_POLL, NULL)
1578
1579
1580 /* Return NBYTES of allocated random using a random numbers of quality
1581    LEVEL. */
1582 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level)
1583                          _GCRY_GCC_ATTR_MALLOC;
1584
1585 /* Return NBYTES of allocated random using a random numbers of quality
1586    LEVEL.  The random numbers are created returned in "secure"
1587    memory. */
1588 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level)
1589                                 _GCRY_GCC_ATTR_MALLOC;
1590
1591
1592 /* Set the big integer W to a random value of NBITS using a random
1593    generator with quality LEVEL. */
1594 void gcry_mpi_randomize (gcry_mpi_t w,
1595                          unsigned int nbits, enum gcry_random_level level);
1596
1597
1598 /* Create an unpredicable nonce of LENGTH bytes in BUFFER. */
1599 void gcry_create_nonce (void *buffer, size_t length);
1600
1601
1602
1603
1604 /* Prime interface.  */
1605
1606 /* Mode values passed to a gcry_prime_check_func_t. */
1607 #define GCRY_PRIME_CHECK_AT_FINISH      0
1608 #define GCRY_PRIME_CHECK_AT_GOT_PRIME   1
1609 #define GCRY_PRIME_CHECK_AT_MAYBE_PRIME 2
1610
1611 /* The function should return 1 if the operation shall continue, 0 to
1612    reject the prime candidate. */
1613 typedef int (*gcry_prime_check_func_t) (void *arg, int mode,
1614                                         gcry_mpi_t candidate);
1615
1616 /* Flags for gcry_prime_generate():  */
1617
1618 /* Allocate prime numbers and factors in secure memory.  */
1619 #define GCRY_PRIME_FLAG_SECRET         (1 << 0)
1620
1621 /* Make sure that at least one prime factor is of size
1622    `FACTOR_BITS'.  */
1623 #define GCRY_PRIME_FLAG_SPECIAL_FACTOR (1 << 1)
1624
1625 /* Generate a new prime number of PRIME_BITS bits and store it in
1626    PRIME.  If FACTOR_BITS is non-zero, one of the prime factors of
1627    (prime - 1) / 2 must be FACTOR_BITS bits long.  If FACTORS is
1628    non-zero, allocate a new, NULL-terminated array holding the prime
1629    factors and store it in FACTORS.  FLAGS might be used to influence
1630    the prime number generation process.  */
1631 gcry_error_t gcry_prime_generate (gcry_mpi_t *prime,
1632                                   unsigned int prime_bits,
1633                                   unsigned int factor_bits,
1634                                   gcry_mpi_t **factors,
1635                                   gcry_prime_check_func_t cb_func,
1636                                   void *cb_arg,
1637                                   gcry_random_level_t random_level,
1638                                   unsigned int flags);
1639
1640 /* Find a generator for PRIME where the factorization of (prime-1) is
1641    in the NULL terminated array FACTORS. Return the generator as a
1642    newly allocated MPI in R_G.  If START_G is not NULL, use this as
1643    teh start for the search. */
1644 gcry_error_t gcry_prime_group_generator (gcry_mpi_t *r_g,
1645                                          gcry_mpi_t prime, gcry_mpi_t *factors,
1646                                          gcry_mpi_t start_g);
1647
1648
1649 /* Convenience function to release the FACTORS array. */
1650 void gcry_prime_release_factors (gcry_mpi_t *factors);
1651
1652
1653 /* Check wether the number X is prime.  */
1654 gcry_error_t gcry_prime_check (gcry_mpi_t x, unsigned int flags);
1655
1656
1657 \f
1658 /************************************
1659  *                                  *
1660  *     miscellaneous stuff          *
1661  *                                  *
1662  ************************************/
1663
1664 /* Log levels used by the internal logging facility. */
1665 enum gcry_log_levels 
1666   {
1667     GCRY_LOG_CONT   = 0,    /* continue the last log line */
1668     GCRY_LOG_INFO   = 10,
1669     GCRY_LOG_WARN   = 20,
1670     GCRY_LOG_ERROR  = 30,
1671     GCRY_LOG_FATAL  = 40,
1672     GCRY_LOG_BUG    = 50,
1673     GCRY_LOG_DEBUG  = 100
1674   };
1675
1676 /* Type for progress handlers.  */
1677 typedef void (*gcry_handler_progress_t) (void *, const char *, int, int, int);
1678
1679 /* Type for memory allocation handlers.  */
1680 typedef void *(*gcry_handler_alloc_t) (size_t n);
1681
1682 /* Type for secure memory check handlers.  */
1683 typedef int (*gcry_handler_secure_check_t) (const void *);
1684
1685 /* Type for memory reallocation handlers.  */
1686 typedef void *(*gcry_handler_realloc_t) (void *p, size_t n);
1687
1688 /* Type for memory free handlers.  */
1689 typedef void (*gcry_handler_free_t) (void *);
1690
1691 /* Type for out-of-memory handlers.  */
1692 typedef int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int);
1693
1694 /* Type for fatal error handlers.  */
1695 typedef void (*gcry_handler_error_t) (void *, int, const char *);
1696
1697 /* Type for logging handlers.  */
1698 typedef void (*gcry_handler_log_t) (void *, int, const char *, va_list);
1699
1700 /* Certain operations can provide progress information.  This function
1701    is used to register a handler for retrieving these information. */
1702 void gcry_set_progress_handler (gcry_handler_progress_t cb, void *cb_data);
1703
1704
1705 /* Register a custom memory allocation functions. */
1706 void gcry_set_allocation_handler (
1707                              gcry_handler_alloc_t func_alloc,
1708                              gcry_handler_alloc_t func_alloc_secure,
1709                              gcry_handler_secure_check_t func_secure_check,
1710                              gcry_handler_realloc_t func_realloc,
1711                              gcry_handler_free_t func_free);
1712
1713 /* Register a function used instead of the internal out of memory
1714    handler. */
1715 void gcry_set_outofcore_handler (gcry_handler_no_mem_t h, void *opaque);
1716
1717 /* Register a function used instead of the internal fatal error
1718    handler. */
1719 void gcry_set_fatalerror_handler (gcry_handler_error_t fnc, void *opaque);
1720
1721 /* Register a function used instead of the internal logging
1722    facility. */
1723 void gcry_set_log_handler (gcry_handler_log_t f, void *opaque);
1724
1725 /* Reserved for future use. */
1726 void gcry_set_gettext_handler (const char *(*f)(const char*));
1727
1728 /* Libgcrypt uses its own memory allocation.  It is important to use
1729    gcry_free () to release memory allocated by libgcrypt. */
1730 void *gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1731 void *gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1732 void *gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1733 void *gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1734 void *gcry_realloc (void *a, size_t n);
1735 char *gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
1736 void *gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1737 void *gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1738 void *gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1739 void *gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1740 void *gcry_xrealloc (void *a, size_t n);
1741 char *gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
1742 void  gcry_free (void *a);
1743
1744 /* Return true if A is allocated in "secure" memory. */
1745 int gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
1746
1747 /* Include support for Libgcrypt modules.  */
1748 #include <gcrypt-module.h>
1749
1750 #if 0 /* keep Emacsens' auto-indent happy */
1751 {
1752 #endif
1753 #ifdef __cplusplus
1754 }
1755 #endif
1756 #endif /* _GCRYPT_H */