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