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