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