b34ff08c7ce39091b0d3898a6e819159468da14f
[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 /* Make up an attribute to mark functions and types as deprecated but
108    allow internal use by Libgcrypt.  */
109 #ifdef _GCRYPT_IN_LIBGCRYPT
110 #define _GCRY_ATTR_INTERNAL
111 #else
112 #define _GCRY_ATTR_INTERNAL     _GCRY_GCC_ATTR_DEPRECATED
113 #endif
114
115 /* Wrappers for the libgpg-error library.  */
116
117 typedef gpg_error_t gcry_error_t;
118 typedef gpg_err_code_t gcry_err_code_t;
119 typedef gpg_err_source_t gcry_err_source_t;
120
121 static GPG_ERR_INLINE gcry_error_t
122 gcry_err_make (gcry_err_source_t source, gcry_err_code_t code)
123 {
124   return gpg_err_make (source, code);
125 }
126
127 /* The user can define GPG_ERR_SOURCE_DEFAULT before including this
128    file to specify a default source for gpg_error.  */
129 #ifndef GCRY_ERR_SOURCE_DEFAULT
130 #define GCRY_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
131 #endif
132
133 static GPG_ERR_INLINE gcry_error_t
134 gcry_error (gcry_err_code_t code)
135 {
136   return gcry_err_make (GCRY_ERR_SOURCE_DEFAULT, code);
137 }
138
139 static GPG_ERR_INLINE gcry_err_code_t
140 gcry_err_code (gcry_error_t err)
141 {
142   return gpg_err_code (err);
143 }
144
145
146 static GPG_ERR_INLINE gcry_err_source_t
147 gcry_err_source (gcry_error_t err)
148 {
149   return gpg_err_source (err);
150 }
151
152 /* Return a pointer to a string containing a description of the error
153    code in the error value ERR.  */
154 const char *gcry_strerror (gcry_error_t err);
155
156 /* Return a pointer to a string containing a description of the error
157    source in the error value ERR.  */
158 const char *gcry_strsource (gcry_error_t err);
159
160 /* Retrieve the error code for the system error ERR.  This returns
161    GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
162    this).  */
163 gcry_err_code_t gcry_err_code_from_errno (int err);
164
165 /* Retrieve the system error for the error code CODE.  This returns 0
166    if CODE is not a system error code.  */
167 int gcry_err_code_to_errno (gcry_err_code_t code);
168
169 /* Return an error value with the error source SOURCE and the system
170    error ERR.  */
171 gcry_error_t gcry_err_make_from_errno (gcry_err_source_t source, int err);
172
173 /* Return an error value with the system error ERR.  */
174 gcry_err_code_t gcry_error_from_errno (int err);
175
176 \f
177 /* Constants defining the thread model to use.  Used with the OPTION
178    field of the struct gcry_thread_cbs.  */
179 #define GCRY_THREAD_OPTION_DEFAULT  0
180 #define GCRY_THREAD_OPTION_USER     1
181 #define GCRY_THREAD_OPTION_PTH      2
182 #define GCRY_THREAD_OPTION_PTHREAD  3
183
184 /* The version number encoded in the OPTION field of the struct
185    gcry_thread_cbs.  */
186 #define GCRY_THREAD_OPTION_VERSION  0
187
188 /* Wrapper for struct ath_ops.  */
189 struct gcry_thread_cbs
190 {
191   /* The OPTION field encodes the thread model and the version number
192      of this structure.
193        Bits  7 - 0  are used for the thread model
194        Bits 15 - 8  are used for the version number.
195   */
196   unsigned int option;
197
198   int (*init) (void);
199   int (*mutex_init) (void **priv);
200   int (*mutex_destroy) (void **priv);
201   int (*mutex_lock) (void **priv);
202   int (*mutex_unlock) (void **priv);
203   ssize_t (*read) (int fd, void *buf, size_t nbytes);
204   ssize_t (*write) (int fd, const void *buf, size_t nbytes);
205 #ifdef _WIN32
206   ssize_t (*select) (int nfd, void *rset, void *wset, void *eset,
207                      struct timeval *timeout);
208   ssize_t (*waitpid) (pid_t pid, int *status, int options);
209   int (*accept) (int s, void  *addr, int *length_ptr);
210   int (*connect) (int s, void *addr, gcry_socklen_t length);
211   int (*sendmsg) (int s, const void *msg, int flags);
212   int (*recvmsg) (int s, void *msg, int flags);
213 #else
214   ssize_t (*select) (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
215                      struct timeval *timeout);
216   ssize_t (*waitpid) (pid_t pid, int *status, int options);
217   int (*accept) (int s, struct sockaddr *addr, gcry_socklen_t *length_ptr);
218   int (*connect) (int s, struct sockaddr *addr, gcry_socklen_t length);
219   int (*sendmsg) (int s, const struct msghdr *msg, int flags);
220   int (*recvmsg) (int s, struct msghdr *msg, int flags);
221 #endif
222 };
223
224 #ifdef _WIN32
225 # define _GCRY_THREAD_OPTION_PTH_IMPL_NET                                     \
226 static ssize_t gcry_pth_select (int nfd, void *rset, void *wset,              \
227                                 void *eset, struct timeval *timeout)          \
228   { return pth_select (nfd, rset, wset, eset, timeout); }                     \
229 static ssize_t gcry_pth_waitpid (pid_t pid, int *status, int options)         \
230   { return pth_waitpid (pid, status, options); }                              \
231 static int gcry_pth_accept (int s, void *addr,                                \
232                             gcry_socklen_t *length_ptr)                       \
233   { return pth_accept (s, addr, length_ptr); }                                \
234 static int gcry_pth_connect (int s, void *addr,                               \
235                              gcry_socklen_t length)                           \
236   { return pth_connect (s, addr, length); }
237 #else /*!_WIN32*/
238 # define _GCRY_THREAD_OPTION_PTH_IMPL_NET                                     \
239 static ssize_t gcry_pth_select (int nfd, fd_set *rset, fd_set *wset,          \
240                                 fd_set *eset, struct timeval *timeout)        \
241   { return pth_select (nfd, rset, wset, eset, timeout); }                     \
242 static ssize_t gcry_pth_waitpid (pid_t pid, int *status, int options)         \
243   { return pth_waitpid (pid, status, options); }                              \
244 static int gcry_pth_accept (int s, struct sockaddr *addr,                     \
245                             gcry_socklen_t *length_ptr)                       \
246   { return pth_accept (s, addr, length_ptr); }                                \
247 static int gcry_pth_connect (int s, struct sockaddr *addr,                    \
248                              gcry_socklen_t length)                           \
249   { return pth_connect (s, addr, length); }
250 #endif /*!_WIN32*/
251
252
253
254 #define GCRY_THREAD_OPTION_PTH_IMPL                                           \
255 static int gcry_pth_init (void)                                               \
256 { return (pth_init () == FALSE) ? errno : 0; }                                \
257 static int gcry_pth_mutex_init (void **priv)                                  \
258 {                                                                             \
259   int err = 0;                                                                \
260   pth_mutex_t *lock = malloc (sizeof (pth_mutex_t));                          \
261                                                                               \
262   if (!lock)                                                                  \
263     err = ENOMEM;                                                             \
264   if (!err)                                                                   \
265     {                                                                         \
266       err = pth_mutex_init (lock);                                            \
267       if (err == FALSE)                                                       \
268         err = errno;                                                          \
269       else                                                                    \
270         err = 0;                                                              \
271       if (err)                                                                \
272         free (lock);                                                          \
273       else                                                                    \
274         *priv = lock;                                                         \
275     }                                                                         \
276   return err;                                                                 \
277 }                                                                             \
278 static int gcry_pth_mutex_destroy (void **lock)                               \
279   { /* GNU Pth has no destructor function.  */ free (*lock); return 0; }      \
280 static int gcry_pth_mutex_lock (void **lock)                                  \
281   { return ((pth_mutex_acquire (*lock, 0, NULL)) == FALSE)                    \
282       ? errno : 0; }                                                          \
283 static int gcry_pth_mutex_unlock (void **lock)                                \
284   { return ((pth_mutex_release (*lock)) == FALSE)                             \
285       ? errno : 0; }                                                          \
286 static ssize_t gcry_pth_read (int fd, void *buf, size_t nbytes)               \
287   { return pth_read (fd, buf, nbytes); }                                      \
288 static ssize_t gcry_pth_write (int fd, const void *buf, size_t nbytes)        \
289   { return pth_write (fd, buf, nbytes); }                                     \
290 _GCRY_THREAD_OPTION_PTH_IMPL_NET                                              \
291                                                                               \
292 /* Note: GNU Pth is missing pth_sendmsg and pth_recvmsg.  */                  \
293 static struct gcry_thread_cbs gcry_threads_pth = {                            \
294   (GCRY_THREAD_OPTION_PTH | (GCRY_THREAD_OPTION_VERSION << 8)),               \
295   gcry_pth_init, gcry_pth_mutex_init, gcry_pth_mutex_destroy,                 \
296   gcry_pth_mutex_lock, gcry_pth_mutex_unlock, gcry_pth_read, gcry_pth_write,  \
297   gcry_pth_select, gcry_pth_waitpid, gcry_pth_accept, gcry_pth_connect,       \
298   NULL, NULL }
299
300
301 #define GCRY_THREAD_OPTION_PTHREAD_IMPL                                       \
302 static int gcry_pthread_mutex_init (void **priv)                              \
303 {                                                                             \
304   int err = 0;                                                                \
305   pthread_mutex_t *lock = (pthread_mutex_t*)malloc (sizeof (pthread_mutex_t));\
306                                                                               \
307   if (!lock)                                                                  \
308     err = ENOMEM;                                                             \
309   if (!err)                                                                   \
310     {                                                                         \
311       err = pthread_mutex_init (lock, NULL);                                  \
312       if (err)                                                                \
313         free (lock);                                                          \
314       else                                                                    \
315         *priv = lock;                                                         \
316     }                                                                         \
317   return err;                                                                 \
318 }                                                                             \
319 static int gcry_pthread_mutex_destroy (void **lock)                           \
320   { int err = pthread_mutex_destroy ((pthread_mutex_t*)*lock);                \
321     free (*lock); return err; }                                               \
322 static int gcry_pthread_mutex_lock (void **lock)                              \
323   { return pthread_mutex_lock ((pthread_mutex_t*)*lock); }                    \
324 static int gcry_pthread_mutex_unlock (void **lock)                            \
325   { return pthread_mutex_unlock ((pthread_mutex_t*)*lock); }                  \
326                                                                               \
327 static struct gcry_thread_cbs gcry_threads_pthread = {                        \
328   (GCRY_THREAD_OPTION_PTHREAD | (GCRY_THREAD_OPTION_VERSION << 8)),           \
329   NULL, gcry_pthread_mutex_init, gcry_pthread_mutex_destroy,                  \
330   gcry_pthread_mutex_lock, gcry_pthread_mutex_unlock,                         \
331   NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL }
332
333 \f
334 /* The data object used to hold a multi precision integer.  */
335 struct gcry_mpi;
336 typedef struct gcry_mpi *gcry_mpi_t;
337
338 #ifndef GCRYPT_NO_DEPRECATED
339 typedef struct gcry_mpi *GCRY_MPI _GCRY_GCC_ATTR_DEPRECATED;
340 typedef struct gcry_mpi *GcryMPI _GCRY_GCC_ATTR_DEPRECATED;
341 #endif
342
343 \f
344
345 /* Check that the library fulfills the version requirement.  */
346 const char *gcry_check_version (const char *req_version);
347
348 /* Codes for function dispatchers.  */
349
350 /* Codes used with the gcry_control function. */
351 enum gcry_ctl_cmds
352   {
353     GCRYCTL_SET_KEY  = 1,
354     GCRYCTL_SET_IV   = 2,
355     GCRYCTL_CFB_SYNC = 3,
356     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
357     GCRYCTL_FINALIZE = 5,
358     GCRYCTL_GET_KEYLEN = 6,
359     GCRYCTL_GET_BLKLEN = 7,
360     GCRYCTL_TEST_ALGO = 8,
361     GCRYCTL_IS_SECURE = 9,
362     GCRYCTL_GET_ASNOID = 10,
363     GCRYCTL_ENABLE_ALGO = 11,
364     GCRYCTL_DISABLE_ALGO = 12,
365     GCRYCTL_DUMP_RANDOM_STATS = 13,
366     GCRYCTL_DUMP_SECMEM_STATS = 14,
367     GCRYCTL_GET_ALGO_NPKEY    = 15,
368     GCRYCTL_GET_ALGO_NSKEY    = 16,
369     GCRYCTL_GET_ALGO_NSIGN    = 17,
370     GCRYCTL_GET_ALGO_NENCR    = 18,
371     GCRYCTL_SET_VERBOSITY     = 19,
372     GCRYCTL_SET_DEBUG_FLAGS   = 20,
373     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
374     GCRYCTL_USE_SECURE_RNDPOOL= 22,
375     GCRYCTL_DUMP_MEMORY_STATS = 23,
376     GCRYCTL_INIT_SECMEM       = 24,
377     GCRYCTL_TERM_SECMEM       = 25,
378     GCRYCTL_DISABLE_SECMEM_WARN = 27,
379     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
380     GCRYCTL_RESUME_SECMEM_WARN  = 29,
381     GCRYCTL_DROP_PRIVS          = 30,
382     GCRYCTL_ENABLE_M_GUARD      = 31,
383     GCRYCTL_START_DUMP          = 32,
384     GCRYCTL_STOP_DUMP           = 33,
385     GCRYCTL_GET_ALGO_USAGE      = 34,
386     GCRYCTL_IS_ALGO_ENABLED     = 35,
387     GCRYCTL_DISABLE_INTERNAL_LOCKING = 36,
388     GCRYCTL_DISABLE_SECMEM      = 37,
389     GCRYCTL_INITIALIZATION_FINISHED = 38,
390     GCRYCTL_INITIALIZATION_FINISHED_P = 39,
391     GCRYCTL_ANY_INITIALIZATION_P = 40,
392     GCRYCTL_SET_CBC_CTS = 41,
393     GCRYCTL_SET_CBC_MAC = 42,
394     GCRYCTL_SET_CTR = 43,
395     GCRYCTL_ENABLE_QUICK_RANDOM = 44,
396     GCRYCTL_SET_RANDOM_SEED_FILE = 45,
397     GCRYCTL_UPDATE_RANDOM_SEED_FILE = 46,
398     GCRYCTL_SET_THREAD_CBS = 47,
399     GCRYCTL_FAST_POLL = 48,
400     GCRYCTL_SET_RANDOM_DAEMON_SOCKET = 49,
401     GCRYCTL_USE_RANDOM_DAEMON = 50,
402     GCRYCTL_FAKED_RANDOM_P = 51,
403     GCRYCTL_SET_RNDEGD_SOCKET = 52,
404     GCRYCTL_PRINT_CONFIG = 53,
405     GCRYCTL_OPERATIONAL_P = 54,
406     GCRYCTL_FIPS_MODE_P = 55,
407     GCRYCTL_FORCE_FIPS_MODE = 56,
408     GCRYCTL_SELFTEST = 57,
409     /* Note: 58 .. 62 are used internally.  */
410     GCRYCTL_DISABLE_HWF = 63
411   };
412
413 /* Perform various operations defined by CMD. */
414 gcry_error_t gcry_control (enum gcry_ctl_cmds CMD, ...);
415
416 \f
417 /* S-expression management. */
418
419 /* The object to represent an S-expression as used with the public key
420    functions.  */
421 struct gcry_sexp;
422 typedef struct gcry_sexp *gcry_sexp_t;
423
424 #ifndef GCRYPT_NO_DEPRECATED
425 typedef struct gcry_sexp *GCRY_SEXP _GCRY_GCC_ATTR_DEPRECATED;
426 typedef struct gcry_sexp *GcrySexp _GCRY_GCC_ATTR_DEPRECATED;
427 #endif
428
429 /* The possible values for the S-expression format. */
430 enum gcry_sexp_format
431   {
432     GCRYSEXP_FMT_DEFAULT   = 0,
433     GCRYSEXP_FMT_CANON     = 1,
434     GCRYSEXP_FMT_BASE64    = 2,
435     GCRYSEXP_FMT_ADVANCED  = 3
436   };
437
438 /* Create an new S-expression object from BUFFER of size LENGTH and
439    return it in RETSEXP.  With AUTODETECT set to 0 the data in BUFFER
440    is expected to be in canonized format.  */
441 gcry_error_t gcry_sexp_new (gcry_sexp_t *retsexp,
442                             const void *buffer, size_t length,
443                             int autodetect);
444
445  /* Same as gcry_sexp_new but allows to pass a FREEFNC which has the
446     effect to transfer ownership of BUFFER to the created object.  */
447 gcry_error_t gcry_sexp_create (gcry_sexp_t *retsexp,
448                                void *buffer, size_t length,
449                                int autodetect, void (*freefnc) (void *));
450
451 /* Scan BUFFER and return a new S-expression object in RETSEXP.  This
452    function expects a printf like string in BUFFER.  */
453 gcry_error_t gcry_sexp_sscan (gcry_sexp_t *retsexp, size_t *erroff,
454                               const char *buffer, size_t length);
455
456 /* Same as gcry_sexp_sscan but expects a string in FORMAT and can thus
457    only be used for certain encodings.  */
458 gcry_error_t gcry_sexp_build (gcry_sexp_t *retsexp, size_t *erroff,
459                               const char *format, ...);
460
461 /* Like gcry_sexp_build, but uses an array instead of variable
462    function arguments.  */
463 gcry_error_t gcry_sexp_build_array (gcry_sexp_t *retsexp, size_t *erroff,
464                                     const char *format, void **arg_list);
465
466 /* Release the S-expression object SEXP */
467 void gcry_sexp_release (gcry_sexp_t sexp);
468
469 /* Calculate the length of an canonized S-expresion in BUFFER and
470    check for a valid encoding. */
471 size_t gcry_sexp_canon_len (const unsigned char *buffer, size_t length,
472                             size_t *erroff, gcry_error_t *errcode);
473
474 /* Copies the S-expression object SEXP into BUFFER using the format
475    specified in MODE.  */
476 size_t gcry_sexp_sprint (gcry_sexp_t sexp, int mode, void *buffer,
477                          size_t maxlength);
478
479 /* Dumps the S-expression object A in a format suitable for debugging
480    to Libgcrypt's logging stream.  */
481 void gcry_sexp_dump (const gcry_sexp_t a);
482
483 gcry_sexp_t gcry_sexp_cons (const gcry_sexp_t a, const gcry_sexp_t b);
484 gcry_sexp_t gcry_sexp_alist (const gcry_sexp_t *array);
485 gcry_sexp_t gcry_sexp_vlist (const gcry_sexp_t a, ...);
486 gcry_sexp_t gcry_sexp_append (const gcry_sexp_t a, const gcry_sexp_t n);
487 gcry_sexp_t gcry_sexp_prepend (const gcry_sexp_t a, const gcry_sexp_t n);
488
489 /* Scan the S-expression for a sublist with a type (the car of the
490    list) matching the string TOKEN.  If TOKLEN is not 0, the token is
491    assumed to be raw memory of this length.  The function returns a
492    newly allocated S-expression consisting of the found sublist or
493    `NULL' when not found.  */
494 gcry_sexp_t gcry_sexp_find_token (gcry_sexp_t list,
495                                 const char *tok, size_t toklen);
496 /* Return the length of the LIST.  For a valid S-expression this
497    should be at least 1.  */
498 int gcry_sexp_length (const gcry_sexp_t list);
499
500 /* Create and return a new S-expression from the element with index
501    NUMBER in LIST.  Note that the first element has the index 0.  If
502    there is no such element, `NULL' is returned.  */
503 gcry_sexp_t gcry_sexp_nth (const gcry_sexp_t list, int number);
504
505 /* Create and return a new S-expression from the first element in
506    LIST; this called the "type" and should always exist and be a
507    string. `NULL' is returned in case of a problem.  */
508 gcry_sexp_t gcry_sexp_car (const gcry_sexp_t list);
509
510 /* Create and return a new list form all elements except for the first
511    one.  Note, that this function may return an invalid S-expression
512    because it is not guaranteed, that the type exists and is a string.
513    However, for parsing a complex S-expression it might be useful for
514    intermediate lists.  Returns `NULL' on error.  */
515 gcry_sexp_t gcry_sexp_cdr (const gcry_sexp_t list);
516
517 gcry_sexp_t gcry_sexp_cadr (const gcry_sexp_t list);
518
519
520 /* This function is used to get data from a LIST.  A pointer to the
521    actual data with index NUMBER is returned and the length of this
522    data will be stored to DATALEN.  If there is no data at the given
523    index or the index represents another list, `NULL' is returned.
524    *Note:* The returned pointer is valid as long as LIST is not
525    modified or released.  */
526 const char *gcry_sexp_nth_data (const gcry_sexp_t list, int number,
527                                 size_t *datalen);
528
529 /* This function is used to get and convert data from a LIST.  The
530    data is assumed to be a Nul terminated string.  The caller must
531    release the returned value using `gcry_free'.  If there is no data
532    at the given index, the index represents a list or the value can't
533    be converted to a string, `NULL' is returned.  */
534 char *gcry_sexp_nth_string (gcry_sexp_t list, int number);
535
536 /* This function is used to get and convert data from a LIST. This
537    data is assumed to be an MPI stored in the format described by
538    MPIFMT and returned as a standard Libgcrypt MPI.  The caller must
539    release this returned value using `gcry_mpi_release'.  If there is
540    no data at the given index, the index represents a list or the
541    value can't be converted to an MPI, `NULL' is returned.  */
542 gcry_mpi_t gcry_sexp_nth_mpi (gcry_sexp_t list, int number, int mpifmt);
543
544
545 \f
546 /*******************************************
547  *                                         *
548  *  Multi Precision Integer Functions      *
549  *                                         *
550  *******************************************/
551
552 /* Different formats of external big integer representation. */
553 enum gcry_mpi_format
554   {
555     GCRYMPI_FMT_NONE= 0,
556     GCRYMPI_FMT_STD = 1,    /* Twos complement stored without length.  */
557     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP (unsigned only).  */
558     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (like STD but with length).  */
559     GCRYMPI_FMT_HEX = 4,    /* Hex format. */
560     GCRYMPI_FMT_USG = 5     /* Like STD but unsigned. */
561   };
562
563 /* Flags used for creating big integers.  */
564 enum gcry_mpi_flag
565   {
566     GCRYMPI_FLAG_SECURE = 1,  /* Allocate the number in "secure" memory.  */
567     GCRYMPI_FLAG_OPAQUE = 2   /* The number is not a real one but just
568                                  a way to store some bytes.  This is
569                                  useful for encrypted big integers.  */
570   };
571
572
573 /* Allocate a new big integer object, initialize it with 0 and
574    initially allocate memory for a number of at least NBITS. */
575 gcry_mpi_t gcry_mpi_new (unsigned int nbits);
576
577 /* Same as gcry_mpi_new() but allocate in "secure" memory. */
578 gcry_mpi_t gcry_mpi_snew (unsigned int nbits);
579
580 /* Release the number A and free all associated resources. */
581 void gcry_mpi_release (gcry_mpi_t a);
582
583 /* Create a new number with the same value as A. */
584 gcry_mpi_t gcry_mpi_copy (const gcry_mpi_t a);
585
586 /* Store the big integer value U in W. */
587 gcry_mpi_t gcry_mpi_set (gcry_mpi_t w, const gcry_mpi_t u);
588
589 /* Store the unsigned integer value U in W. */
590 gcry_mpi_t gcry_mpi_set_ui (gcry_mpi_t w, unsigned long u);
591
592 /* Swap the values of A and B. */
593 void gcry_mpi_swap (gcry_mpi_t a, gcry_mpi_t b);
594
595 /* Compare the big integer number U and V returning 0 for equality, a
596    positive value for U > V and a negative for U < V. */
597 int gcry_mpi_cmp (const gcry_mpi_t u, const gcry_mpi_t v);
598
599 /* Compare the big integer number U with the unsigned integer V
600    returning 0 for equality, a positive value for U > V and a negative
601    for U < V. */
602 int gcry_mpi_cmp_ui (const gcry_mpi_t u, unsigned long v);
603
604 /* Convert the external representation of an integer stored in BUFFER
605    with a length of BUFLEN into a newly create MPI returned in
606    RET_MPI.  If NSCANNED is not NULL, it will receive the number of
607    bytes actually scanned after a successful operation. */
608 gcry_error_t gcry_mpi_scan (gcry_mpi_t *ret_mpi, enum gcry_mpi_format format,
609                             const void *buffer, size_t buflen,
610                             size_t *nscanned);
611
612 /* Convert the big integer A into the external representation
613    described by FORMAT and store it in the provided BUFFER which has
614    been allocated by the user with a size of BUFLEN bytes.  NWRITTEN
615    receives the actual length of the external representation unless it
616    has been passed as NULL. */
617 gcry_error_t gcry_mpi_print (enum gcry_mpi_format format,
618                              unsigned char *buffer, size_t buflen,
619                              size_t *nwritten,
620                              const gcry_mpi_t a);
621
622 /* Convert the big integer A int the external representation described
623    by FORMAT and store it in a newly allocated buffer which address
624    will be put into BUFFER.  NWRITTEN receives the actual lengths of the
625    external representation. */
626 gcry_error_t gcry_mpi_aprint (enum gcry_mpi_format format,
627                               unsigned char **buffer, size_t *nwritten,
628                               const gcry_mpi_t a);
629
630 /* Dump the value of A in a format suitable for debugging to
631    Libgcrypt's logging stream.  Note that one leading space but no
632    trailing space or linefeed will be printed.  It is okay to pass
633    NULL for A. */
634 void gcry_mpi_dump (const gcry_mpi_t a);
635
636
637 /* W = U + V.  */
638 void gcry_mpi_add (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
639
640 /* W = U + V.  V is an unsigned integer. */
641 void gcry_mpi_add_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v);
642
643 /* W = U + V mod M. */
644 void gcry_mpi_addm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
645
646 /* W = U - V. */
647 void gcry_mpi_sub (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_sub_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
651
652 /* W = U - V mod M */
653 void gcry_mpi_subm (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_mul (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_mul_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
660
661 /* W = U * V mod M. */
662 void gcry_mpi_mulm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
663
664 /* W = U * (2 ^ CNT). */
665 void gcry_mpi_mul_2exp (gcry_mpi_t w, gcry_mpi_t u, unsigned long cnt);
666
667 /* Q = DIVIDEND / DIVISOR, R = DIVIDEND % DIVISOR,
668    Q or R may be passed as NULL.  ROUND should be negative or 0. */
669 void gcry_mpi_div (gcry_mpi_t q, gcry_mpi_t r,
670                    gcry_mpi_t dividend, gcry_mpi_t divisor, int round);
671
672 /* R = DIVIDEND % DIVISOR */
673 void gcry_mpi_mod (gcry_mpi_t r, gcry_mpi_t dividend, gcry_mpi_t divisor);
674
675 /* W = B ^ E mod M. */
676 void gcry_mpi_powm (gcry_mpi_t w,
677                     const gcry_mpi_t b, const gcry_mpi_t e,
678                     const gcry_mpi_t m);
679
680 /* Set G to the greatest common divisor of A and B.
681    Return true if the G is 1. */
682 int gcry_mpi_gcd (gcry_mpi_t g, gcry_mpi_t a, gcry_mpi_t b);
683
684 /* Set X to the multiplicative inverse of A mod M.
685    Return true if the value exists. */
686 int gcry_mpi_invm (gcry_mpi_t x, gcry_mpi_t a, gcry_mpi_t m);
687
688
689 /* Return the number of bits required to represent A. */
690 unsigned int gcry_mpi_get_nbits (gcry_mpi_t a);
691
692 /* Return true when bit number N (counting from 0) is set in A. */
693 int      gcry_mpi_test_bit (gcry_mpi_t a, unsigned int n);
694
695 /* Set bit number N in A. */
696 void     gcry_mpi_set_bit (gcry_mpi_t a, unsigned int n);
697
698 /* Clear bit number N in A. */
699 void     gcry_mpi_clear_bit (gcry_mpi_t a, unsigned int n);
700
701 /* Set bit number N in A and clear all bits greater than N. */
702 void     gcry_mpi_set_highbit (gcry_mpi_t a, unsigned int n);
703
704 /* Clear bit number N in A and all bits greater than N. */
705 void     gcry_mpi_clear_highbit (gcry_mpi_t a, unsigned int n);
706
707 /* Shift the value of A by N bits to the right and store the result in X. */
708 void     gcry_mpi_rshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
709
710 /* Shift the value of A by N bits to the left and store the result in X. */
711 void     gcry_mpi_lshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
712
713 /* Store NBITS of the value P points to in A and mark A as an opaque
714    value.  WARNING: Never use an opaque MPI for anything thing else then
715    gcry_mpi_release, gcry_mpi_get_opaque. */
716 gcry_mpi_t gcry_mpi_set_opaque (gcry_mpi_t a, void *p, unsigned int nbits);
717
718 /* Return a pointer to an opaque value stored in A and return its size
719    in NBITS.  Note that the returned pointer is still owned by A and
720    that the function should never be used for an non-opaque MPI. */
721 void *gcry_mpi_get_opaque (gcry_mpi_t a, unsigned int *nbits);
722
723 /* Set the FLAG for the big integer A.  Currently only the flag
724    GCRYMPI_FLAG_SECURE is allowed to convert A into an big intger
725    stored in "secure" memory. */
726 void gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
727
728 /* Clear FLAG for the big integer A.  Note that this function is
729    currently useless as no flags are allowed. */
730 void gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
731
732 /* Return true when the FLAG is set for A. */
733 int gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
734
735 /* Unless the GCRYPT_NO_MPI_MACROS is used, provide a couple of
736    convenience macros for the big integer functions. */
737 #ifndef GCRYPT_NO_MPI_MACROS
738 #define mpi_new(n)          gcry_mpi_new( (n) )
739 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
740 #define mpi_release(a)      \
741   do \
742     { \
743       gcry_mpi_release ((a)); \
744       (a) = NULL; \
745     } \
746   while (0)
747
748 #define mpi_copy( a )          gcry_mpi_copy( (a) )
749 #define mpi_set( w, u)         gcry_mpi_set( (w), (u) )
750 #define mpi_set_ui( w, u)      gcry_mpi_set_ui( (w), (u) )
751 #define mpi_cmp( u, v )        gcry_mpi_cmp( (u), (v) )
752 #define mpi_cmp_ui( u, v )     gcry_mpi_cmp_ui( (u), (v) )
753
754 #define mpi_add_ui(w,u,v)      gcry_mpi_add_ui((w),(u),(v))
755 #define mpi_add(w,u,v)         gcry_mpi_add ((w),(u),(v))
756 #define mpi_addm(w,u,v,m)      gcry_mpi_addm ((w),(u),(v),(m))
757 #define mpi_sub_ui(w,u,v)      gcry_mpi_sub_ui ((w),(u),(v))
758 #define mpi_sub(w,u,v)         gcry_mpi_sub ((w),(u),(v))
759 #define mpi_subm(w,u,v,m)      gcry_mpi_subm ((w),(u),(v),(m))
760 #define mpi_mul_ui(w,u,v)      gcry_mpi_mul_ui ((w),(u),(v))
761 #define mpi_mul_2exp(w,u,v)    gcry_mpi_mul_2exp ((w),(u),(v))
762 #define mpi_mul(w,u,v)         gcry_mpi_mul ((w),(u),(v))
763 #define mpi_mulm(w,u,v,m)      gcry_mpi_mulm ((w),(u),(v),(m))
764 #define mpi_powm(w,b,e,m)      gcry_mpi_powm ( (w), (b), (e), (m) )
765 #define mpi_tdiv(q,r,a,m)      gcry_mpi_div ( (q), (r), (a), (m), 0)
766 #define mpi_fdiv(q,r,a,m)      gcry_mpi_div ( (q), (r), (a), (m), -1)
767 #define mpi_mod(r,a,m)         gcry_mpi_mod ((r), (a), (m))
768 #define mpi_gcd(g,a,b)         gcry_mpi_gcd ( (g), (a), (b) )
769 #define mpi_invm(g,a,b)        gcry_mpi_invm ( (g), (a), (b) )
770
771 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
772 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
773 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
774 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
775 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
776 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
777 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
778 #define mpi_lshift(a,b,c)      gcry_mpi_lshift ((a),(b),(c))
779
780 #define mpi_set_opaque(a,b,c)  gcry_mpi_set_opaque( (a), (b), (c) )
781 #define mpi_get_opaque(a,b)    gcry_mpi_get_opaque( (a), (b) )
782 #endif /* GCRYPT_NO_MPI_MACROS */
783
784
785 \f
786 /************************************
787  *                                  *
788  *   Symmetric Cipher Functions     *
789  *                                  *
790  ************************************/
791
792 /* The data object used to hold a handle to an encryption object.  */
793 struct gcry_cipher_handle;
794 typedef struct gcry_cipher_handle *gcry_cipher_hd_t;
795
796 #ifndef GCRYPT_NO_DEPRECATED
797 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD _GCRY_GCC_ATTR_DEPRECATED;
798 typedef struct gcry_cipher_handle *GcryCipherHd _GCRY_GCC_ATTR_DEPRECATED;
799 #endif
800
801 /* All symmetric encryption algorithms are identified by their IDs.
802    More IDs may be registered at runtime. */
803 enum gcry_cipher_algos
804   {
805     GCRY_CIPHER_NONE        = 0,
806     GCRY_CIPHER_IDEA        = 1,
807     GCRY_CIPHER_3DES        = 2,
808     GCRY_CIPHER_CAST5       = 3,
809     GCRY_CIPHER_BLOWFISH    = 4,
810     GCRY_CIPHER_SAFER_SK128 = 5,
811     GCRY_CIPHER_DES_SK      = 6,
812     GCRY_CIPHER_AES         = 7,
813     GCRY_CIPHER_AES192      = 8,
814     GCRY_CIPHER_AES256      = 9,
815     GCRY_CIPHER_TWOFISH     = 10,
816
817     /* Other cipher numbers are above 300 for OpenPGP reasons. */
818     GCRY_CIPHER_ARCFOUR     = 301,  /* Fully compatible with RSA's RC4 (tm). */
819     GCRY_CIPHER_DES         = 302,  /* Yes, this is single key 56 bit DES. */
820     GCRY_CIPHER_TWOFISH128  = 303,
821     GCRY_CIPHER_SERPENT128  = 304,
822     GCRY_CIPHER_SERPENT192  = 305,
823     GCRY_CIPHER_SERPENT256  = 306,
824     GCRY_CIPHER_RFC2268_40  = 307,  /* Ron's Cipher 2 (40 bit). */
825     GCRY_CIPHER_RFC2268_128 = 308,  /* Ron's Cipher 2 (128 bit). */
826     GCRY_CIPHER_SEED        = 309,  /* 128 bit cipher described in RFC4269. */
827     GCRY_CIPHER_CAMELLIA128 = 310,
828     GCRY_CIPHER_CAMELLIA192 = 311,
829     GCRY_CIPHER_CAMELLIA256 = 312
830   };
831
832 /* The Rijndael algorithm is basically AES, so provide some macros. */
833 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES
834 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES
835 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128
836 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192
837 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256
838
839 /* The supported encryption modes.  Note that not all of them are
840    supported for each algorithm. */
841 enum gcry_cipher_modes
842   {
843     GCRY_CIPHER_MODE_NONE   = 0,  /* Not yet specified. */
844     GCRY_CIPHER_MODE_ECB    = 1,  /* Electronic codebook. */
845     GCRY_CIPHER_MODE_CFB    = 2,  /* Cipher feedback. */
846     GCRY_CIPHER_MODE_CBC    = 3,  /* Cipher block chaining. */
847     GCRY_CIPHER_MODE_STREAM = 4,  /* Used with stream ciphers. */
848     GCRY_CIPHER_MODE_OFB    = 5,  /* Outer feedback. */
849     GCRY_CIPHER_MODE_CTR    = 6,  /* Counter. */
850     GCRY_CIPHER_MODE_AESWRAP= 7   /* AES-WRAP algorithm.  */
851   };
852
853 /* Flags used with the open function. */
854 enum gcry_cipher_flags
855   {
856     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
857     GCRY_CIPHER_ENABLE_SYNC = 2,  /* Enable CFB sync mode. */
858     GCRY_CIPHER_CBC_CTS     = 4,  /* Enable CBC cipher text stealing (CTS). */
859     GCRY_CIPHER_CBC_MAC     = 8   /* Enable CBC message auth. code (MAC). */
860   };
861
862
863 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
864    be given as an bitwise OR of the gcry_cipher_flags values. */
865 gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *handle,
866                               int algo, int mode, unsigned int flags);
867
868 /* Close the cioher handle H and release all resource. */
869 void gcry_cipher_close (gcry_cipher_hd_t h);
870
871 /* Perform various operations on the cipher object H. */
872 gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer,
873                              size_t buflen);
874
875 /* Retrieve various information about the cipher object H. */
876 gcry_error_t gcry_cipher_info (gcry_cipher_hd_t h, int what, void *buffer,
877                               size_t *nbytes);
878
879 /* Retrieve various information about the cipher algorithm ALGO. */
880 gcry_error_t gcry_cipher_algo_info (int algo, int what, void *buffer,
881                                    size_t *nbytes);
882
883 /* Map the cipher algorithm whose ID is contained in ALGORITHM to a
884    string representation of the algorithm name.  For unknown algorithm
885    IDs this function returns "?".  */
886 const char *gcry_cipher_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
887
888 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
889    the algorithm name is not known. */
890 int gcry_cipher_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
891
892 /* Given an ASN.1 object identifier in standard IETF dotted decimal
893    format in STRING, return the encryption mode associated with that
894    OID or 0 if not known or applicable. */
895 int gcry_cipher_mode_from_oid (const char *string) _GCRY_GCC_ATTR_PURE;
896
897 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
898    into the buffer OUT which has an allocated length of OUTSIZE.  For
899    most algorithms it is possible to pass NULL for in and 0 for INLEN
900    and do a in-place decryption of the data provided in OUT.  */
901 gcry_error_t gcry_cipher_encrypt (gcry_cipher_hd_t h,
902                                   void *out, size_t outsize,
903                                   const void *in, size_t inlen);
904
905 /* The counterpart to gcry_cipher_encrypt.  */
906 gcry_error_t gcry_cipher_decrypt (gcry_cipher_hd_t h,
907                                   void *out, size_t outsize,
908                                   const void *in, size_t inlen);
909
910 /* Set KEY of length KEYLEN bytes for the cipher handle HD.  */
911 gcry_error_t gcry_cipher_setkey (gcry_cipher_hd_t hd,
912                                  const void *key, size_t keylen);
913
914
915 /* Set initialization vector IV of length IVLEN for the cipher handle HD. */
916 gcry_error_t gcry_cipher_setiv (gcry_cipher_hd_t hd,
917                                 const void *iv, size_t ivlen);
918
919
920 /* Reset the handle to the state after open.  */
921 #define gcry_cipher_reset(h)  gcry_cipher_ctl ((h), GCRYCTL_RESET, NULL, 0)
922
923 /* Perform the OpenPGP sync operation if this is enabled for the
924    cipher handle H. */
925 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, NULL, 0)
926
927 /* Enable or disable CTS in future calls to gcry_encrypt(). CBC mode only. */
928 #define gcry_cipher_cts(h,on)  gcry_cipher_ctl( (h), GCRYCTL_SET_CBC_CTS, \
929                                                                    NULL, on )
930
931 /* Set counter for CTR mode.  (CTR,CTRLEN) must denote a buffer of
932    block size length, or (NULL,0) to set the CTR to the all-zero block. */
933 gpg_error_t gcry_cipher_setctr (gcry_cipher_hd_t hd,
934                                 const void *ctr, size_t ctrlen);
935
936 /* Retrieve the key length in bytes used with algorithm A. */
937 size_t gcry_cipher_get_algo_keylen (int algo);
938
939 /* Retrieve the block length in bytes used with algorithm A. */
940 size_t gcry_cipher_get_algo_blklen (int algo);
941
942 /* Return 0 if the algorithm A is available for use. */
943 #define gcry_cipher_test_algo(a) \
944             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
945
946 \f
947 /************************************
948  *                                  *
949  *    Asymmetric Cipher Functions   *
950  *                                  *
951  ************************************/
952
953 /* The algorithms and their IDs we support. */
954 enum gcry_pk_algos
955   {
956     GCRY_PK_RSA   = 1,
957     GCRY_PK_RSA_E = 2,      /* (deprecated) */
958     GCRY_PK_RSA_S = 3,      /* (deprecated) */
959     GCRY_PK_ELG_E = 16,
960     GCRY_PK_DSA   = 17,
961     GCRY_PK_ELG   = 20,
962     GCRY_PK_ECDSA = 301,
963     GCRY_PK_ECDH  = 302
964   };
965
966 /* Flags describing usage capabilities of a PK algorithm. */
967 #define GCRY_PK_USAGE_SIGN 1   /* Good for signatures. */
968 #define GCRY_PK_USAGE_ENCR 2   /* Good for encryption. */
969 #define GCRY_PK_USAGE_CERT 4   /* Good to certify other keys. */
970 #define GCRY_PK_USAGE_AUTH 8   /* Good for authentication. */
971 #define GCRY_PK_USAGE_UNKN 128 /* Unknown usage flag. */
972
973 /* Encrypt the DATA using the public key PKEY and store the result as
974    a newly created S-expression at RESULT. */
975 gcry_error_t gcry_pk_encrypt (gcry_sexp_t *result,
976                               gcry_sexp_t data, gcry_sexp_t pkey);
977
978 /* Decrypt the DATA using the private key SKEY and store the result as
979    a newly created S-expression at RESULT. */
980 gcry_error_t gcry_pk_decrypt (gcry_sexp_t *result,
981                               gcry_sexp_t data, gcry_sexp_t skey);
982
983 /* Sign the DATA using the private key SKEY and store the result as
984    a newly created S-expression at RESULT. */
985 gcry_error_t gcry_pk_sign (gcry_sexp_t *result,
986                            gcry_sexp_t data, gcry_sexp_t skey);
987
988 /* Check the signature SIGVAL on DATA using the public key PKEY. */
989 gcry_error_t gcry_pk_verify (gcry_sexp_t sigval,
990                              gcry_sexp_t data, gcry_sexp_t pkey);
991
992 /* Check that private KEY is sane. */
993 gcry_error_t gcry_pk_testkey (gcry_sexp_t key);
994
995 /* Generate a new key pair according to the parameters given in
996    S_PARMS.  The new key pair is returned in as an S-expression in
997    R_KEY. */
998 gcry_error_t gcry_pk_genkey (gcry_sexp_t *r_key, gcry_sexp_t s_parms);
999
1000 /* Catch all function for miscellaneous operations. */
1001 gcry_error_t gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
1002
1003 /* Retrieve information about the public key algorithm ALGO. */
1004 gcry_error_t gcry_pk_algo_info (int algo, int what,
1005                                 void *buffer, size_t *nbytes);
1006
1007 /* Map the public key algorithm whose ID is contained in ALGORITHM to
1008    a string representation of the algorithm name.  For unknown
1009    algorithm IDs this functions returns "?". */
1010 const char *gcry_pk_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
1011
1012 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
1013    the algorithm name is not known. */
1014 int gcry_pk_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1015
1016 /* Return what is commonly referred as the key length for the given
1017    public or private KEY.  */
1018 unsigned int gcry_pk_get_nbits (gcry_sexp_t key) _GCRY_GCC_ATTR_PURE;
1019
1020 /* Please note that keygrip is still experimental and should not be
1021    used without contacting the author. */
1022 unsigned char *gcry_pk_get_keygrip (gcry_sexp_t key, unsigned char *array);
1023
1024 /* Return the name of the curve matching KEY.  */
1025 const char *gcry_pk_get_curve (gcry_sexp_t key, int iterator,
1026                                unsigned int *r_nbits);
1027
1028 /* Return an S-expression with the parameters of the named ECC curve
1029    NAME.  ALGO must be set to an ECC algorithm.  */
1030 gcry_sexp_t gcry_pk_get_param (int algo, const char *name);
1031
1032 /* Return 0 if the public key algorithm A is available for use. */
1033 #define gcry_pk_test_algo(a) \
1034             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1035
1036
1037 \f
1038
1039 /************************************
1040  *                                  *
1041  *   Cryptograhic Hash Functions    *
1042  *                                  *
1043  ************************************/
1044
1045 /* Algorithm IDs for the hash functions we know about. Not all of them
1046    are implemnted. */
1047 enum gcry_md_algos
1048   {
1049     GCRY_MD_NONE    = 0,
1050     GCRY_MD_MD5     = 1,
1051     GCRY_MD_SHA1    = 2,
1052     GCRY_MD_RMD160  = 3,
1053     GCRY_MD_MD2     = 5,
1054     GCRY_MD_TIGER   = 6,   /* TIGER/192 as used by gpg <= 1.3.2. */
1055     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
1056     GCRY_MD_SHA256  = 8,
1057     GCRY_MD_SHA384  = 9,
1058     GCRY_MD_SHA512  = 10,
1059     GCRY_MD_SHA224  = 11,
1060     GCRY_MD_MD4     = 301,
1061     GCRY_MD_CRC32         = 302,
1062     GCRY_MD_CRC32_RFC1510 = 303,
1063     GCRY_MD_CRC24_RFC2440 = 304,
1064     GCRY_MD_WHIRLPOOL = 305,
1065     GCRY_MD_TIGER1  = 306, /* TIGER fixed.  */
1066     GCRY_MD_TIGER2  = 307  /* TIGER2 variant.   */
1067   };
1068
1069 /* Flags used with the open function.  */
1070 enum gcry_md_flags
1071   {
1072     GCRY_MD_FLAG_SECURE = 1,  /* Allocate all buffers in "secure" memory.  */
1073     GCRY_MD_FLAG_HMAC   = 2   /* Make an HMAC out of this algorithm.  */
1074   };
1075
1076 /* (Forward declaration.)  */
1077 struct gcry_md_context;
1078
1079 /* This object is used to hold a handle to a message digest object.
1080    This structure is private - only to be used by the public gcry_md_*
1081    macros.  */
1082 typedef struct gcry_md_handle
1083 {
1084   /* Actual context.  */
1085   struct gcry_md_context *ctx;
1086
1087   /* Buffer management.  */
1088   int  bufpos;
1089   int  bufsize;
1090   unsigned char buf[1];
1091 } *gcry_md_hd_t;
1092
1093 /* Compatibility types, do not use them.  */
1094 #ifndef GCRYPT_NO_DEPRECATED
1095 typedef struct gcry_md_handle *GCRY_MD_HD _GCRY_GCC_ATTR_DEPRECATED;
1096 typedef struct gcry_md_handle *GcryMDHd _GCRY_GCC_ATTR_DEPRECATED;
1097 #endif
1098
1099 /* Create a message digest object for algorithm ALGO.  FLAGS may be
1100    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
1101    given as 0 if the algorithms to be used are later set using
1102    gcry_md_enable.  */
1103 gcry_error_t gcry_md_open (gcry_md_hd_t *h, int algo, unsigned int flags);
1104
1105 /* Release the message digest object HD.  */
1106 void gcry_md_close (gcry_md_hd_t hd);
1107
1108 /* Add the message digest algorithm ALGO to the digest object HD.  */
1109 gcry_error_t gcry_md_enable (gcry_md_hd_t hd, int algo);
1110
1111 /* Create a new digest object as an exact copy of the object HD.  */
1112 gcry_error_t gcry_md_copy (gcry_md_hd_t *bhd, gcry_md_hd_t ahd);
1113
1114 /* Reset the digest object HD to its initial state.  */
1115 void gcry_md_reset (gcry_md_hd_t hd);
1116
1117 /* Perform various operations on the digest object HD. */
1118 gcry_error_t gcry_md_ctl (gcry_md_hd_t hd, int cmd,
1119                           void *buffer, size_t buflen);
1120
1121 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
1122    it can update the digest values.  This is the actual hash
1123    function. */
1124 void gcry_md_write (gcry_md_hd_t hd, const void *buffer, size_t length);
1125
1126 /* Read out the final digest from HD return the digest value for
1127    algorithm ALGO. */
1128 unsigned char *gcry_md_read (gcry_md_hd_t hd, int algo);
1129
1130 /* Convenience function to calculate the hash from the data in BUFFER
1131    of size LENGTH using the algorithm ALGO avoiding the creating of a
1132    hash object.  The hash is returned in the caller provided buffer
1133    DIGEST which must be large enough to hold the digest of the given
1134    algorithm. */
1135 void gcry_md_hash_buffer (int algo, void *digest,
1136                           const void *buffer, size_t length);
1137
1138 /* Retrieve the algorithm used with HD.  This does not work reliable
1139    if more than one algorithm is enabled in HD. */
1140 int gcry_md_get_algo (gcry_md_hd_t hd);
1141
1142 /* Retrieve the length in bytes of the digest yielded by algorithm
1143    ALGO. */
1144 unsigned int gcry_md_get_algo_dlen (int algo);
1145
1146 /* Return true if the the algorithm ALGO is enabled in the digest
1147    object A. */
1148 int gcry_md_is_enabled (gcry_md_hd_t a, int algo);
1149
1150 /* Return true if the digest object A is allocated in "secure" memory. */
1151 int gcry_md_is_secure (gcry_md_hd_t a);
1152
1153 /* Retrieve various information about the object H.  */
1154 gcry_error_t gcry_md_info (gcry_md_hd_t h, int what, void *buffer,
1155                           size_t *nbytes);
1156
1157 /* Retrieve various information about the algorithm ALGO.  */
1158 gcry_error_t gcry_md_algo_info (int algo, int what, void *buffer,
1159                                size_t *nbytes);
1160
1161 /* Map the digest algorithm id ALGO to a string representation of the
1162    algorithm name.  For unknown algorithms this function returns
1163    "?". */
1164 const char *gcry_md_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
1165
1166 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
1167    the algorithm name is not known. */
1168 int gcry_md_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1169
1170 /* For use with the HMAC feature, the set MAC key to the KEY of
1171    KEYLEN bytes. */
1172 gcry_error_t gcry_md_setkey (gcry_md_hd_t hd, const void *key, size_t keylen);
1173
1174 /* Start or stop debugging for digest handle HD; i.e. create a file
1175    named dbgmd-<n>.<suffix> while hashing.  If SUFFIX is NULL,
1176    debugging stops and the file will be closed. */
1177 void gcry_md_debug (gcry_md_hd_t hd, const char *suffix);
1178
1179
1180 /* Update the hash(s) of H with the character C.  This is a buffered
1181    version of the gcry_md_write function. */
1182 #define gcry_md_putc(h,c)  \
1183             do {                                          \
1184                 gcry_md_hd_t h__ = (h);                   \
1185                 if( (h__)->bufpos == (h__)->bufsize )     \
1186                     gcry_md_write( (h__), NULL, 0 );      \
1187                 (h__)->buf[(h__)->bufpos++] = (c) & 0xff; \
1188             } while(0)
1189
1190 /* Finalize the digest calculation.  This is not really needed because
1191    gcry_md_read() does this implicitly. */
1192 #define gcry_md_final(a) \
1193             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
1194
1195 /* Return 0 if the algorithm A is available for use. */
1196 #define gcry_md_test_algo(a) \
1197             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1198
1199 /* Return an DER encoded ASN.1 OID for the algorithm A in buffer B. N
1200    must point to size_t variable with the available size of buffer B.
1201    After return it will receive the actual size of the returned
1202    OID. */
1203 #define gcry_md_get_asnoid(a,b,n) \
1204             gcry_md_algo_info((a), GCRYCTL_GET_ASNOID, (b), (n))
1205
1206
1207 \f
1208 /******************************
1209  *                            *
1210  *  Key Derivation Functions  *
1211  *                            *
1212  ******************************/
1213
1214 /* Algorithm IDs for the KDFs.  */
1215 enum gcry_kdf_algos
1216   {
1217     GCRY_KDF_NONE = 0,
1218     GCRY_KDF_SIMPLE_S2K = 16,
1219     GCRY_KDF_SALTED_S2K = 17,
1220     GCRY_KDF_ITERSALTED_S2K = 19,
1221     GCRY_KDF_PBKDF1 = 33,
1222     GCRY_KDF_PBKDF2 = 34
1223   };
1224
1225 /* Derive a key from a passphrase.  */
1226 gpg_error_t gcry_kdf_derive (const void *passphrase, size_t passphraselen,
1227                              int algo, int subalgo,
1228                              const void *salt, size_t saltlen,
1229                              unsigned long iterations,
1230                              size_t keysize, void *keybuffer);
1231
1232
1233
1234 \f
1235 /************************************
1236  *                                  *
1237  *   Random Generating Functions    *
1238  *                                  *
1239  ************************************/
1240
1241 /* The possible values for the random quality.  The rule of thumb is
1242    to use STRONG for session keys and VERY_STRONG for key material.
1243    WEAK is usually an alias for STRONG and should not be used anymore
1244    (except with gcry_mpi_randomize); use gcry_create_nonce instead. */
1245 typedef enum gcry_random_level
1246   {
1247     GCRY_WEAK_RANDOM = 0,
1248     GCRY_STRONG_RANDOM = 1,
1249     GCRY_VERY_STRONG_RANDOM = 2
1250   }
1251 gcry_random_level_t;
1252
1253 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
1254    quality LEVEL. */
1255 void gcry_randomize (void *buffer, size_t length,
1256                      enum gcry_random_level level);
1257
1258 /* Add the external random from BUFFER with LENGTH bytes into the
1259    pool. QUALITY should either be -1 for unknown or in the range of 0
1260    to 100 */
1261 gcry_error_t gcry_random_add_bytes (const void *buffer, size_t length,
1262                                     int quality);
1263
1264 /* If random numbers are used in an application, this macro should be
1265    called from time to time so that new stuff gets added to the
1266    internal pool of the RNG.  */
1267 #define gcry_fast_random_poll()  gcry_control (GCRYCTL_FAST_POLL, NULL)
1268
1269
1270 /* Return NBYTES of allocated random using a random numbers of quality
1271    LEVEL. */
1272 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level)
1273                          _GCRY_GCC_ATTR_MALLOC;
1274
1275 /* Return NBYTES of allocated random using a random numbers of quality
1276    LEVEL.  The random numbers are created returned in "secure"
1277    memory. */
1278 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level)
1279                                 _GCRY_GCC_ATTR_MALLOC;
1280
1281
1282 /* Set the big integer W to a random value of NBITS using a random
1283    generator with quality LEVEL.  Note that by using a level of
1284    GCRY_WEAK_RANDOM gcry_create_nonce is used internally. */
1285 void gcry_mpi_randomize (gcry_mpi_t w,
1286                          unsigned int nbits, enum gcry_random_level level);
1287
1288
1289 /* Create an unpredicable nonce of LENGTH bytes in BUFFER. */
1290 void gcry_create_nonce (void *buffer, size_t length);
1291
1292
1293
1294
1295 \f
1296 /*******************************/
1297 /*                             */
1298 /*    Prime Number Functions   */
1299 /*                             */
1300 /*******************************/
1301
1302 /* Mode values passed to a gcry_prime_check_func_t. */
1303 #define GCRY_PRIME_CHECK_AT_FINISH      0
1304 #define GCRY_PRIME_CHECK_AT_GOT_PRIME   1
1305 #define GCRY_PRIME_CHECK_AT_MAYBE_PRIME 2
1306
1307 /* The function should return 1 if the operation shall continue, 0 to
1308    reject the prime candidate. */
1309 typedef int (*gcry_prime_check_func_t) (void *arg, int mode,
1310                                         gcry_mpi_t candidate);
1311
1312 /* Flags for gcry_prime_generate():  */
1313
1314 /* Allocate prime numbers and factors in secure memory.  */
1315 #define GCRY_PRIME_FLAG_SECRET         (1 << 0)
1316
1317 /* Make sure that at least one prime factor is of size
1318    `FACTOR_BITS'.  */
1319 #define GCRY_PRIME_FLAG_SPECIAL_FACTOR (1 << 1)
1320
1321 /* Generate a new prime number of PRIME_BITS bits and store it in
1322    PRIME.  If FACTOR_BITS is non-zero, one of the prime factors of
1323    (prime - 1) / 2 must be FACTOR_BITS bits long.  If FACTORS is
1324    non-zero, allocate a new, NULL-terminated array holding the prime
1325    factors and store it in FACTORS.  FLAGS might be used to influence
1326    the prime number generation process.  */
1327 gcry_error_t gcry_prime_generate (gcry_mpi_t *prime,
1328                                   unsigned int prime_bits,
1329                                   unsigned int factor_bits,
1330                                   gcry_mpi_t **factors,
1331                                   gcry_prime_check_func_t cb_func,
1332                                   void *cb_arg,
1333                                   gcry_random_level_t random_level,
1334                                   unsigned int flags);
1335
1336 /* Find a generator for PRIME where the factorization of (prime-1) is
1337    in the NULL terminated array FACTORS. Return the generator as a
1338    newly allocated MPI in R_G.  If START_G is not NULL, use this as
1339    teh start for the search. */
1340 gcry_error_t gcry_prime_group_generator (gcry_mpi_t *r_g,
1341                                          gcry_mpi_t prime,
1342                                          gcry_mpi_t *factors,
1343                                          gcry_mpi_t start_g);
1344
1345
1346 /* Convenience function to release the FACTORS array. */
1347 void gcry_prime_release_factors (gcry_mpi_t *factors);
1348
1349
1350 /* Check wether the number X is prime.  */
1351 gcry_error_t gcry_prime_check (gcry_mpi_t x, unsigned int flags);
1352
1353
1354 \f
1355 /************************************
1356  *                                  *
1357  *     Miscellaneous Stuff          *
1358  *                                  *
1359  ************************************/
1360
1361 /* Log levels used by the internal logging facility. */
1362 enum gcry_log_levels
1363   {
1364     GCRY_LOG_CONT   = 0,    /* (Continue the last log line.) */
1365     GCRY_LOG_INFO   = 10,
1366     GCRY_LOG_WARN   = 20,
1367     GCRY_LOG_ERROR  = 30,
1368     GCRY_LOG_FATAL  = 40,
1369     GCRY_LOG_BUG    = 50,
1370     GCRY_LOG_DEBUG  = 100
1371   };
1372
1373 /* Type for progress handlers.  */
1374 typedef void (*gcry_handler_progress_t) (void *, const char *, int, int, int);
1375
1376 /* Type for memory allocation handlers.  */
1377 typedef void *(*gcry_handler_alloc_t) (size_t n);
1378
1379 /* Type for secure memory check handlers.  */
1380 typedef int (*gcry_handler_secure_check_t) (const void *);
1381
1382 /* Type for memory reallocation handlers.  */
1383 typedef void *(*gcry_handler_realloc_t) (void *p, size_t n);
1384
1385 /* Type for memory free handlers.  */
1386 typedef void (*gcry_handler_free_t) (void *);
1387
1388 /* Type for out-of-memory handlers.  */
1389 typedef int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int);
1390
1391 /* Type for fatal error handlers.  */
1392 typedef void (*gcry_handler_error_t) (void *, int, const char *);
1393
1394 /* Type for logging handlers.  */
1395 typedef void (*gcry_handler_log_t) (void *, int, const char *, va_list);
1396
1397 /* Certain operations can provide progress information.  This function
1398    is used to register a handler for retrieving these information. */
1399 void gcry_set_progress_handler (gcry_handler_progress_t cb, void *cb_data);
1400
1401
1402 /* Register a custom memory allocation functions. */
1403 void gcry_set_allocation_handler (
1404                              gcry_handler_alloc_t func_alloc,
1405                              gcry_handler_alloc_t func_alloc_secure,
1406                              gcry_handler_secure_check_t func_secure_check,
1407                              gcry_handler_realloc_t func_realloc,
1408                              gcry_handler_free_t func_free);
1409
1410 /* Register a function used instead of the internal out of memory
1411    handler. */
1412 void gcry_set_outofcore_handler (gcry_handler_no_mem_t h, void *opaque);
1413
1414 /* Register a function used instead of the internal fatal error
1415    handler. */
1416 void gcry_set_fatalerror_handler (gcry_handler_error_t fnc, void *opaque);
1417
1418 /* Register a function used instead of the internal logging
1419    facility. */
1420 void gcry_set_log_handler (gcry_handler_log_t f, void *opaque);
1421
1422 /* Reserved for future use. */
1423 void gcry_set_gettext_handler (const char *(*f)(const char*));
1424
1425 /* Libgcrypt uses its own memory allocation.  It is important to use
1426    gcry_free () to release memory allocated by libgcrypt. */
1427 void *gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1428 void *gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1429 void *gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1430 void *gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1431 void *gcry_realloc (void *a, size_t n);
1432 char *gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
1433 void *gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1434 void *gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1435 void *gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1436 void *gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1437 void *gcry_xrealloc (void *a, size_t n);
1438 char *gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
1439 void  gcry_free (void *a);
1440
1441 /* Return true if A is allocated in "secure" memory. */
1442 int gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
1443
1444 /* Return true if Libgcrypt is in FIPS mode.  */
1445 #define gcry_fips_mode_active()  !!gcry_control (GCRYCTL_FIPS_MODE_P, 0)
1446
1447
1448 #if 0 /* (Keep Emacsens' auto-indent happy.) */
1449 {
1450 #endif
1451 #ifdef __cplusplus
1452 }
1453 #endif
1454 #endif /* _GCRYPT_H */
1455 /*
1456 @emacs_local_vars_begin@
1457 @emacs_local_vars_read_only@
1458 @emacs_local_vars_end@
1459 */