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