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