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