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