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