rsa: Add FIPS 186-4 compliant RSA probable prime key generator.
[libgcrypt.git] / src / gcrypt.h.in
1 /* gcrypt.h -  GNU Cryptographic Library Interface              -*- c -*-
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2006, 2007, 2008, 2009, 2010, 2011,
4  *               2012  Free Software Foundation, Inc.
5  * Copyright (C) 2012, 2013  g10 Code GmbH
6  *
7  * This file is part of Libgcrypt.
8  *
9  * Libgcrypt is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU Lesser General Public License as
11  * published by the Free Software Foundation; either version 2.1 of
12  * the License, or (at your option) any later version.
13  *
14  * Libgcrypt is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
21  *
22  * File: @configure_input@
23  */
24
25 #ifndef _GCRYPT_H
26 #define _GCRYPT_H
27
28 #include <stdlib.h>
29 #include <stdarg.h>
30 #include <string.h>
31
32 #include <gpg-error.h>
33
34 #include <sys/types.h>
35
36 #if defined _WIN32 || defined __WIN32__
37 # include <winsock2.h>
38 # include <ws2tcpip.h>
39 # include <time.h>
40 # ifndef __GNUC__
41   typedef long ssize_t;
42   typedef int  pid_t;
43 # endif /*!__GNUC__*/
44 #else
45 # include <sys/socket.h>
46 # include <sys/time.h>
47 #@INSERT_SYS_SELECT_H@
48 #endif /*!_WIN32*/
49
50 @FALLBACK_SOCKLEN_T@
51
52 /* This is required for error code compatibility. */
53 #define _GCRY_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_GCRYPT
54
55 #ifdef __cplusplus
56 extern "C" {
57 #if 0 /* (Keep Emacsens' auto-indent happy.) */
58 }
59 #endif
60 #endif
61
62 /* The version of this header should match the one of the library. It
63    should not be used by a program because gcry_check_version() should
64    return the same version.  The purpose of this macro is to let
65    autoconf (using the AM_PATH_GCRYPT macro) check that this header
66    matches the installed library.  */
67 #define GCRYPT_VERSION "@VERSION@"
68
69 /* The version number of this header.  It may be used to handle minor
70    API incompatibilities.  */
71 #define GCRYPT_VERSION_NUMBER @VERSION_NUMBER@
72
73
74 /* Internal: We can't use the convenience macros for the multi
75    precision integer functions when building this library. */
76 #ifdef _GCRYPT_IN_LIBGCRYPT
77 #ifndef GCRYPT_NO_MPI_MACROS
78 #define GCRYPT_NO_MPI_MACROS 1
79 #endif
80 #endif
81
82 /* We want to use gcc attributes when possible.  Warning: Don't use
83    these macros in your programs: As indicated by the leading
84    underscore they are subject to change without notice. */
85 #ifdef __GNUC__
86
87 #define _GCRY_GCC_VERSION (__GNUC__ * 10000 \
88                              + __GNUC_MINOR__ * 100 \
89                              + __GNUC_PATCHLEVEL__)
90
91 #if _GCRY_GCC_VERSION >= 30100
92 #define _GCRY_GCC_ATTR_DEPRECATED __attribute__ ((__deprecated__))
93 #endif
94
95 #if _GCRY_GCC_VERSION >= 29600
96 #define _GCRY_GCC_ATTR_PURE  __attribute__ ((__pure__))
97 #endif
98
99 #if _GCRY_GCC_VERSION >= 30200
100 #define _GCRY_GCC_ATTR_MALLOC  __attribute__ ((__malloc__))
101 #endif
102
103 #define _GCRY_GCC_ATTR_PRINTF(f,a)  __attribute__ ((format (printf,f,a)))
104
105 #if _GCRY_GCC_VERSION >= 40000
106 #define _GCRY_GCC_ATTR_SENTINEL(a) __attribute__ ((sentinel(a)))
107 #endif
108
109 #endif /*__GNUC__*/
110
111 #ifndef _GCRY_GCC_ATTR_DEPRECATED
112 #define _GCRY_GCC_ATTR_DEPRECATED
113 #endif
114 #ifndef _GCRY_GCC_ATTR_PURE
115 #define _GCRY_GCC_ATTR_PURE
116 #endif
117 #ifndef _GCRY_GCC_ATTR_MALLOC
118 #define _GCRY_GCC_ATTR_MALLOC
119 #endif
120 #ifndef _GCRY_GCC_ATTR_PRINTF
121 #define _GCRY_GCC_ATTR_PRINTF(f,a)
122 #endif
123 #ifndef _GCRY_GCC_ATTR_SENTINEL
124 #define _GCRY_GCC_ATTR_SENTINEL(a)
125 #endif
126
127 /* Make up an attribute to mark functions and types as deprecated but
128    allow internal use by Libgcrypt.  */
129 #ifdef _GCRYPT_IN_LIBGCRYPT
130 #define _GCRY_ATTR_INTERNAL
131 #else
132 #define _GCRY_ATTR_INTERNAL     _GCRY_GCC_ATTR_DEPRECATED
133 #endif
134
135 /* Wrappers for the libgpg-error library.  */
136
137 typedef gpg_error_t gcry_error_t;
138 typedef gpg_err_code_t gcry_err_code_t;
139 typedef gpg_err_source_t gcry_err_source_t;
140
141 static GPG_ERR_INLINE gcry_error_t
142 gcry_err_make (gcry_err_source_t source, gcry_err_code_t code)
143 {
144   return gpg_err_make (source, code);
145 }
146
147 /* The user can define GPG_ERR_SOURCE_DEFAULT before including this
148    file to specify a default source for gpg_error.  */
149 #ifndef GCRY_ERR_SOURCE_DEFAULT
150 #define GCRY_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
151 #endif
152
153 static GPG_ERR_INLINE gcry_error_t
154 gcry_error (gcry_err_code_t code)
155 {
156   return gcry_err_make (GCRY_ERR_SOURCE_DEFAULT, code);
157 }
158
159 static GPG_ERR_INLINE gcry_err_code_t
160 gcry_err_code (gcry_error_t err)
161 {
162   return gpg_err_code (err);
163 }
164
165
166 static GPG_ERR_INLINE gcry_err_source_t
167 gcry_err_source (gcry_error_t err)
168 {
169   return gpg_err_source (err);
170 }
171
172 /* Return a pointer to a string containing a description of the error
173    code in the error value ERR.  */
174 const char *gcry_strerror (gcry_error_t err);
175
176 /* Return a pointer to a string containing a description of the error
177    source in the error value ERR.  */
178 const char *gcry_strsource (gcry_error_t err);
179
180 /* Retrieve the error code for the system error ERR.  This returns
181    GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
182    this).  */
183 gcry_err_code_t gcry_err_code_from_errno (int err);
184
185 /* Retrieve the system error for the error code CODE.  This returns 0
186    if CODE is not a system error code.  */
187 int gcry_err_code_to_errno (gcry_err_code_t code);
188
189 /* Return an error value with the error source SOURCE and the system
190    error ERR.  */
191 gcry_error_t gcry_err_make_from_errno (gcry_err_source_t source, int err);
192
193 /* Return an error value with the system error ERR.  */
194 gcry_err_code_t gcry_error_from_errno (int err);
195
196 \f
197 /* NOTE: Since Libgcrypt 1.6 the thread callbacks are not anymore
198    used.  However we keep it to allow for some source code
199    compatibility if used in the standard way.  */
200
201 /* Constants defining the thread model to use.  Used with the OPTION
202    field of the struct gcry_thread_cbs.  */
203 #define GCRY_THREAD_OPTION_DEFAULT  0
204 #define GCRY_THREAD_OPTION_USER     1
205 #define GCRY_THREAD_OPTION_PTH      2
206 #define GCRY_THREAD_OPTION_PTHREAD  3
207
208 /* The version number encoded in the OPTION field of the struct
209    gcry_thread_cbs.  */
210 #define GCRY_THREAD_OPTION_VERSION  1
211
212 /* Wrapper for struct ath_ops.  */
213 struct gcry_thread_cbs
214 {
215   /* The OPTION field encodes the thread model and the version number
216      of this structure.
217        Bits  7 - 0  are used for the thread model
218        Bits 15 - 8  are used for the version number.  */
219   unsigned int option;
220 } _GCRY_ATTR_INTERNAL;
221
222 #define GCRY_THREAD_OPTION_PTH_IMPL                                     \
223   static struct gcry_thread_cbs gcry_threads_pth = {                    \
224     (GCRY_THREAD_OPTION_PTH | (GCRY_THREAD_OPTION_VERSION << 8))}
225
226 #define GCRY_THREAD_OPTION_PTHREAD_IMPL                                 \
227   static struct gcry_thread_cbs gcry_threads_pthread = {                \
228     (GCRY_THREAD_OPTION_PTHREAD | (GCRY_THREAD_OPTION_VERSION << 8))}
229
230
231 \f
232 /* A generic context object as used by some functions.  */
233 struct gcry_context;
234 typedef struct gcry_context *gcry_ctx_t;
235
236 /* The data objects used to hold multi precision integers.  */
237 struct gcry_mpi;
238 typedef struct gcry_mpi *gcry_mpi_t;
239 struct gcry_mpi_point;
240 typedef struct gcry_mpi_point *gcry_mpi_point_t;
241
242 #ifndef GCRYPT_NO_DEPRECATED
243 typedef struct gcry_mpi *GCRY_MPI _GCRY_GCC_ATTR_DEPRECATED;
244 typedef struct gcry_mpi *GcryMPI _GCRY_GCC_ATTR_DEPRECATED;
245 #endif
246
247 /* A structure used for scatter gather hashing.  */
248 typedef struct
249 {
250   size_t size;  /* The allocated size of the buffer or 0.  */
251   size_t off;   /* Offset into the buffer.  */
252   size_t len;   /* The used length of the buffer.  */
253   void *data;   /* The buffer.  */
254 } gcry_buffer_t;
255
256
257 \f
258
259 /* Check that the library fulfills the version requirement.  */
260 const char *gcry_check_version (const char *req_version);
261
262 /* Codes for function dispatchers.  */
263
264 /* Codes used with the gcry_control function. */
265 enum gcry_ctl_cmds
266   {
267     /* Note: 1 .. 2 are not anymore used. */
268     GCRYCTL_CFB_SYNC = 3,
269     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
270     GCRYCTL_FINALIZE = 5,
271     GCRYCTL_GET_KEYLEN = 6,
272     GCRYCTL_GET_BLKLEN = 7,
273     GCRYCTL_TEST_ALGO = 8,
274     GCRYCTL_IS_SECURE = 9,
275     GCRYCTL_GET_ASNOID = 10,
276     GCRYCTL_ENABLE_ALGO = 11,
277     GCRYCTL_DISABLE_ALGO = 12,
278     GCRYCTL_DUMP_RANDOM_STATS = 13,
279     GCRYCTL_DUMP_SECMEM_STATS = 14,
280     GCRYCTL_GET_ALGO_NPKEY    = 15,
281     GCRYCTL_GET_ALGO_NSKEY    = 16,
282     GCRYCTL_GET_ALGO_NSIGN    = 17,
283     GCRYCTL_GET_ALGO_NENCR    = 18,
284     GCRYCTL_SET_VERBOSITY     = 19,
285     GCRYCTL_SET_DEBUG_FLAGS   = 20,
286     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
287     GCRYCTL_USE_SECURE_RNDPOOL= 22,
288     GCRYCTL_DUMP_MEMORY_STATS = 23,
289     GCRYCTL_INIT_SECMEM       = 24,
290     GCRYCTL_TERM_SECMEM       = 25,
291     GCRYCTL_DISABLE_SECMEM_WARN = 27,
292     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
293     GCRYCTL_RESUME_SECMEM_WARN  = 29,
294     GCRYCTL_DROP_PRIVS          = 30,
295     GCRYCTL_ENABLE_M_GUARD      = 31,
296     GCRYCTL_START_DUMP          = 32,
297     GCRYCTL_STOP_DUMP           = 33,
298     GCRYCTL_GET_ALGO_USAGE      = 34,
299     GCRYCTL_IS_ALGO_ENABLED     = 35,
300     GCRYCTL_DISABLE_INTERNAL_LOCKING = 36,
301     GCRYCTL_DISABLE_SECMEM      = 37,
302     GCRYCTL_INITIALIZATION_FINISHED = 38,
303     GCRYCTL_INITIALIZATION_FINISHED_P = 39,
304     GCRYCTL_ANY_INITIALIZATION_P = 40,
305     GCRYCTL_SET_CBC_CTS = 41,
306     GCRYCTL_SET_CBC_MAC = 42,
307     /* Note: 43 is not anymore used. */
308     GCRYCTL_ENABLE_QUICK_RANDOM = 44,
309     GCRYCTL_SET_RANDOM_SEED_FILE = 45,
310     GCRYCTL_UPDATE_RANDOM_SEED_FILE = 46,
311     GCRYCTL_SET_THREAD_CBS = 47,
312     GCRYCTL_FAST_POLL = 48,
313     GCRYCTL_SET_RANDOM_DAEMON_SOCKET = 49,
314     GCRYCTL_USE_RANDOM_DAEMON = 50,
315     GCRYCTL_FAKED_RANDOM_P = 51,
316     GCRYCTL_SET_RNDEGD_SOCKET = 52,
317     GCRYCTL_PRINT_CONFIG = 53,
318     GCRYCTL_OPERATIONAL_P = 54,
319     GCRYCTL_FIPS_MODE_P = 55,
320     GCRYCTL_FORCE_FIPS_MODE = 56,
321     GCRYCTL_SELFTEST = 57,
322     /* Note: 58 .. 62 are used internally.  */
323     GCRYCTL_DISABLE_HWF = 63,
324     GCRYCTL_SET_ENFORCED_FIPS_FLAG = 64,
325     GCRYCTL_SET_PREFERRED_RNG_TYPE = 65,
326     GCRYCTL_GET_CURRENT_RNG_TYPE = 66,
327     GCRYCTL_DISABLE_LOCKED_SECMEM = 67,
328     GCRYCTL_DISABLE_PRIV_DROP = 68,
329     GCRYCTL_SET_CCM_LENGTHS = 69,
330     GCRYCTL_CLOSE_RANDOM_DEVICE = 70,
331     GCRYCTL_INACTIVATE_FIPS_FLAG = 71,
332     GCRYCTL_REACTIVATE_FIPS_FLAG = 72,
333     GCRYCTL_SET_SBOX = 73,
334     GCRYCTL_DRBG_REINIT = 74,
335     GCRYCTL_SET_TAGLEN = 75
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-expresion 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 /* Store the projective coordinates from POINT into X, Y, and Z.  */
702 void gcry_mpi_point_get (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
703                          gcry_mpi_point_t point);
704
705 /* Store the projective coordinates from POINT into X, Y, and Z and
706    release POINT.  */
707 void gcry_mpi_point_snatch_get (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
708                                 gcry_mpi_point_t point);
709
710 /* Store the projective coordinates X, Y, and Z into POINT.  */
711 gcry_mpi_point_t gcry_mpi_point_set (gcry_mpi_point_t point,
712                                      gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z);
713
714 /* Store the projective coordinates X, Y, and Z into POINT and release
715    X, Y, and Z.  */
716 gcry_mpi_point_t gcry_mpi_point_snatch_set (gcry_mpi_point_t point,
717                                             gcry_mpi_t x, gcry_mpi_t y,
718                                             gcry_mpi_t z);
719
720 /* Allocate a new context for elliptic curve operations based on the
721    parameters given by KEYPARAM or using CURVENAME.  */
722 gpg_error_t gcry_mpi_ec_new (gcry_ctx_t *r_ctx,
723                              gcry_sexp_t keyparam, const char *curvename);
724
725 /* Get a named MPI from an elliptic curve context.  */
726 gcry_mpi_t gcry_mpi_ec_get_mpi (const char *name, gcry_ctx_t ctx, int copy);
727
728 /* Get a named point from an elliptic curve context.  */
729 gcry_mpi_point_t gcry_mpi_ec_get_point (const char *name,
730                                         gcry_ctx_t ctx, int copy);
731
732 /* Store a named MPI into an elliptic curve context.  */
733 gpg_error_t gcry_mpi_ec_set_mpi (const char *name, gcry_mpi_t newvalue,
734                                  gcry_ctx_t ctx);
735
736 /* Store a named point into an elliptic curve context.  */
737 gpg_error_t gcry_mpi_ec_set_point (const char *name, gcry_mpi_point_t newvalue,
738                                    gcry_ctx_t ctx);
739
740 /* Decode and store VALUE into RESULT.  */
741 gpg_error_t gcry_mpi_ec_decode_point (gcry_mpi_point_t result,
742                                       gcry_mpi_t value, gcry_ctx_t ctx);
743
744 /* Store the affine coordinates of POINT into X and Y.  */
745 int gcry_mpi_ec_get_affine (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_point_t point,
746                             gcry_ctx_t ctx);
747
748 /* W = 2 * U.  */
749 void gcry_mpi_ec_dup (gcry_mpi_point_t w, gcry_mpi_point_t u, gcry_ctx_t ctx);
750
751 /* W = U + V.  */
752 void gcry_mpi_ec_add (gcry_mpi_point_t w,
753                       gcry_mpi_point_t u, gcry_mpi_point_t v, gcry_ctx_t ctx);
754
755 /* W = U - V.  */
756 void gcry_mpi_ec_sub (gcry_mpi_point_t w,
757                       gcry_mpi_point_t u, gcry_mpi_point_t v, gcry_ctx_t ctx);
758
759 /* W = N * U.  */
760 void gcry_mpi_ec_mul (gcry_mpi_point_t w, gcry_mpi_t n, gcry_mpi_point_t u,
761                       gcry_ctx_t ctx);
762
763 /* Return true if POINT is on the curve described by CTX.  */
764 int gcry_mpi_ec_curve_point (gcry_mpi_point_t w, gcry_ctx_t ctx);
765
766 /* Return the number of bits required to represent A. */
767 unsigned int gcry_mpi_get_nbits (gcry_mpi_t a);
768
769 /* Return true when bit number N (counting from 0) is set in A. */
770 int      gcry_mpi_test_bit (gcry_mpi_t a, unsigned int n);
771
772 /* Set bit number N in A. */
773 void     gcry_mpi_set_bit (gcry_mpi_t a, unsigned int n);
774
775 /* Clear bit number N in A. */
776 void     gcry_mpi_clear_bit (gcry_mpi_t a, unsigned int n);
777
778 /* Set bit number N in A and clear all bits greater than N. */
779 void     gcry_mpi_set_highbit (gcry_mpi_t a, unsigned int n);
780
781 /* Clear bit number N in A and all bits greater than N. */
782 void     gcry_mpi_clear_highbit (gcry_mpi_t a, unsigned int n);
783
784 /* Shift the value of A by N bits to the right and store the result in X. */
785 void     gcry_mpi_rshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
786
787 /* Shift the value of A by N bits to the left and store the result in X. */
788 void     gcry_mpi_lshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
789
790 /* Store NBITS of the value P points to in A and mark A as an opaque
791    value.  On success A received the the ownership of the value P.
792    WARNING: Never use an opaque MPI for anything thing else than
793    gcry_mpi_release, gcry_mpi_get_opaque. */
794 gcry_mpi_t gcry_mpi_set_opaque (gcry_mpi_t a, void *p, unsigned int nbits);
795
796 /* Store NBITS of the value P points to in A and mark A as an opaque
797    value.  The function takes a copy of the provided value P.
798    WARNING: Never use an opaque MPI for anything thing else than
799    gcry_mpi_release, gcry_mpi_get_opaque. */
800 gcry_mpi_t gcry_mpi_set_opaque_copy (gcry_mpi_t a,
801                                      const void *p, unsigned int nbits);
802
803 /* Return a pointer to an opaque value stored in A and return its size
804    in NBITS.  Note that the returned pointer is still owned by A and
805    that the function should never be used for an non-opaque MPI. */
806 void *gcry_mpi_get_opaque (gcry_mpi_t a, unsigned int *nbits);
807
808 /* Set the FLAG for the big integer A.  Currently only the flag
809    GCRYMPI_FLAG_SECURE is allowed to convert A into an big intger
810    stored in "secure" memory. */
811 void gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
812
813 /* Clear FLAG for the big integer A.  Note that this function is
814    currently useless as no flags are allowed. */
815 void gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
816
817 /* Return true if the FLAG is set for A. */
818 int gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
819
820 /* Private function - do not use.  */
821 gcry_mpi_t _gcry_mpi_get_const (int no);
822
823 /* Unless the GCRYPT_NO_MPI_MACROS is used, provide a couple of
824    convenience macros for the big integer functions. */
825 #ifndef GCRYPT_NO_MPI_MACROS
826 #define mpi_new(n)          gcry_mpi_new( (n) )
827 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
828 #define mpi_release(a)      \
829   do \
830     { \
831       gcry_mpi_release ((a)); \
832       (a) = NULL; \
833     } \
834   while (0)
835
836 #define mpi_copy( a )          gcry_mpi_copy( (a) )
837 #define mpi_snatch( w, u)      gcry_mpi_snatch( (w), (u) )
838 #define mpi_set( w, u)         gcry_mpi_set( (w), (u) )
839 #define mpi_set_ui( w, u)      gcry_mpi_set_ui( (w), (u) )
840 #define mpi_abs( w )           gcry_mpi_abs( (w) )
841 #define mpi_neg( w, u)         gcry_mpi_neg( (w), (u) )
842 #define mpi_cmp( u, v )        gcry_mpi_cmp( (u), (v) )
843 #define mpi_cmp_ui( u, v )     gcry_mpi_cmp_ui( (u), (v) )
844 #define mpi_is_neg( a )        gcry_mpi_is_neg ((a))
845
846 #define mpi_add_ui(w,u,v)      gcry_mpi_add_ui((w),(u),(v))
847 #define mpi_add(w,u,v)         gcry_mpi_add ((w),(u),(v))
848 #define mpi_addm(w,u,v,m)      gcry_mpi_addm ((w),(u),(v),(m))
849 #define mpi_sub_ui(w,u,v)      gcry_mpi_sub_ui ((w),(u),(v))
850 #define mpi_sub(w,u,v)         gcry_mpi_sub ((w),(u),(v))
851 #define mpi_subm(w,u,v,m)      gcry_mpi_subm ((w),(u),(v),(m))
852 #define mpi_mul_ui(w,u,v)      gcry_mpi_mul_ui ((w),(u),(v))
853 #define mpi_mul_2exp(w,u,v)    gcry_mpi_mul_2exp ((w),(u),(v))
854 #define mpi_mul(w,u,v)         gcry_mpi_mul ((w),(u),(v))
855 #define mpi_mulm(w,u,v,m)      gcry_mpi_mulm ((w),(u),(v),(m))
856 #define mpi_powm(w,b,e,m)      gcry_mpi_powm ( (w), (b), (e), (m) )
857 #define mpi_tdiv(q,r,a,m)      gcry_mpi_div ( (q), (r), (a), (m), 0)
858 #define mpi_fdiv(q,r,a,m)      gcry_mpi_div ( (q), (r), (a), (m), -1)
859 #define mpi_mod(r,a,m)         gcry_mpi_mod ((r), (a), (m))
860 #define mpi_gcd(g,a,b)         gcry_mpi_gcd ( (g), (a), (b) )
861 #define mpi_invm(g,a,b)        gcry_mpi_invm ( (g), (a), (b) )
862
863 #define mpi_point_new(n)              gcry_mpi_point_new((n))
864 #define mpi_point_release(p)                    \
865   do                                            \
866     {                                           \
867       gcry_mpi_point_release ((p));             \
868       (p) = NULL;                               \
869     }                                           \
870   while (0)
871 #define mpi_point_get(x,y,z,p)        gcry_mpi_point_get((x),(y),(z),(p))
872 #define mpi_point_snatch_get(x,y,z,p) gcry_mpi_point_snatch_get((x),(y),(z),(p))
873 #define mpi_point_set(p,x,y,z)        gcry_mpi_point_set((p),(x),(y),(z))
874 #define mpi_point_snatch_set(p,x,y,z) gcry_mpi_point_snatch_set((p),(x),(y),(z))
875
876 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
877 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
878 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
879 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
880 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
881 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
882 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
883 #define mpi_lshift(a,b,c)      gcry_mpi_lshift ((a),(b),(c))
884
885 #define mpi_set_opaque(a,b,c)  gcry_mpi_set_opaque( (a), (b), (c) )
886 #define mpi_get_opaque(a,b)    gcry_mpi_get_opaque( (a), (b) )
887 #endif /* GCRYPT_NO_MPI_MACROS */
888
889
890 \f
891 /************************************
892  *                                  *
893  *   Symmetric Cipher Functions     *
894  *                                  *
895  ************************************/
896
897 /* The data object used to hold a handle to an encryption object.  */
898 struct gcry_cipher_handle;
899 typedef struct gcry_cipher_handle *gcry_cipher_hd_t;
900
901 #ifndef GCRYPT_NO_DEPRECATED
902 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD _GCRY_GCC_ATTR_DEPRECATED;
903 typedef struct gcry_cipher_handle *GcryCipherHd _GCRY_GCC_ATTR_DEPRECATED;
904 #endif
905
906 /* All symmetric encryption algorithms are identified by their IDs.
907    More IDs may be registered at runtime. */
908 enum gcry_cipher_algos
909   {
910     GCRY_CIPHER_NONE        = 0,
911     GCRY_CIPHER_IDEA        = 1,
912     GCRY_CIPHER_3DES        = 2,
913     GCRY_CIPHER_CAST5       = 3,
914     GCRY_CIPHER_BLOWFISH    = 4,
915     GCRY_CIPHER_SAFER_SK128 = 5,
916     GCRY_CIPHER_DES_SK      = 6,
917     GCRY_CIPHER_AES         = 7,
918     GCRY_CIPHER_AES192      = 8,
919     GCRY_CIPHER_AES256      = 9,
920     GCRY_CIPHER_TWOFISH     = 10,
921
922     /* Other cipher numbers are above 300 for OpenPGP reasons. */
923     GCRY_CIPHER_ARCFOUR     = 301,  /* Fully compatible with RSA's RC4 (tm). */
924     GCRY_CIPHER_DES         = 302,  /* Yes, this is single key 56 bit DES. */
925     GCRY_CIPHER_TWOFISH128  = 303,
926     GCRY_CIPHER_SERPENT128  = 304,
927     GCRY_CIPHER_SERPENT192  = 305,
928     GCRY_CIPHER_SERPENT256  = 306,
929     GCRY_CIPHER_RFC2268_40  = 307,  /* Ron's Cipher 2 (40 bit). */
930     GCRY_CIPHER_RFC2268_128 = 308,  /* Ron's Cipher 2 (128 bit). */
931     GCRY_CIPHER_SEED        = 309,  /* 128 bit cipher described in RFC4269. */
932     GCRY_CIPHER_CAMELLIA128 = 310,
933     GCRY_CIPHER_CAMELLIA192 = 311,
934     GCRY_CIPHER_CAMELLIA256 = 312,
935     GCRY_CIPHER_SALSA20     = 313,
936     GCRY_CIPHER_SALSA20R12  = 314,
937     GCRY_CIPHER_GOST28147   = 315,
938     GCRY_CIPHER_CHACHA20    = 316
939   };
940
941 /* The Rijndael algorithm is basically AES, so provide some macros. */
942 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES
943 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES
944 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128
945 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192
946 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256
947
948 /* The supported encryption modes.  Note that not all of them are
949    supported for each algorithm. */
950 enum gcry_cipher_modes
951   {
952     GCRY_CIPHER_MODE_NONE     = 0,   /* Not yet specified. */
953     GCRY_CIPHER_MODE_ECB      = 1,   /* Electronic codebook. */
954     GCRY_CIPHER_MODE_CFB      = 2,   /* Cipher feedback. */
955     GCRY_CIPHER_MODE_CBC      = 3,   /* Cipher block chaining. */
956     GCRY_CIPHER_MODE_STREAM   = 4,   /* Used with stream ciphers. */
957     GCRY_CIPHER_MODE_OFB      = 5,   /* Outer feedback. */
958     GCRY_CIPHER_MODE_CTR      = 6,   /* Counter. */
959     GCRY_CIPHER_MODE_AESWRAP  = 7,   /* AES-WRAP algorithm.  */
960     GCRY_CIPHER_MODE_CCM      = 8,   /* Counter with CBC-MAC.  */
961     GCRY_CIPHER_MODE_GCM      = 9,   /* Galois Counter Mode. */
962     GCRY_CIPHER_MODE_POLY1305 = 10,  /* Poly1305 based AEAD mode. */
963     GCRY_CIPHER_MODE_OCB      = 11   /* OCB3 mode.  */
964   };
965
966 /* Flags used with the open function. */
967 enum gcry_cipher_flags
968   {
969     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
970     GCRY_CIPHER_ENABLE_SYNC = 2,  /* Enable CFB sync mode. */
971     GCRY_CIPHER_CBC_CTS     = 4,  /* Enable CBC cipher text stealing (CTS). */
972     GCRY_CIPHER_CBC_MAC     = 8   /* Enable CBC message auth. code (MAC). */
973   };
974
975 /* GCM works only with blocks of 128 bits */
976 #define GCRY_GCM_BLOCK_LEN  (128 / 8)
977
978 /* CCM works only with blocks of 128 bits.  */
979 #define GCRY_CCM_BLOCK_LEN  (128 / 8)
980
981 /* OCB works only with blocks of 128 bits.  */
982 #define GCRY_OCB_BLOCK_LEN  (128 / 8)
983
984 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
985    be given as an bitwise OR of the gcry_cipher_flags values. */
986 gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *handle,
987                               int algo, int mode, unsigned int flags);
988
989 /* Close the cioher handle H and release all resource. */
990 void gcry_cipher_close (gcry_cipher_hd_t h);
991
992 /* Perform various operations on the cipher object H. */
993 gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer,
994                              size_t buflen);
995
996 /* Retrieve various information about the cipher object H. */
997 gcry_error_t gcry_cipher_info (gcry_cipher_hd_t h, int what, void *buffer,
998                               size_t *nbytes);
999
1000 /* Retrieve various information about the cipher algorithm ALGO. */
1001 gcry_error_t gcry_cipher_algo_info (int algo, int what, void *buffer,
1002                                    size_t *nbytes);
1003
1004 /* Map the cipher algorithm whose ID is contained in ALGORITHM to a
1005    string representation of the algorithm name.  For unknown algorithm
1006    IDs this function returns "?".  */
1007 const char *gcry_cipher_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
1008
1009 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
1010    the algorithm name is not known. */
1011 int gcry_cipher_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
1012
1013 /* Given an ASN.1 object identifier in standard IETF dotted decimal
1014    format in STRING, return the encryption mode associated with that
1015    OID or 0 if not known or applicable. */
1016 int gcry_cipher_mode_from_oid (const char *string) _GCRY_GCC_ATTR_PURE;
1017
1018 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
1019    into the buffer OUT which has an allocated length of OUTSIZE.  For
1020    most algorithms it is possible to pass NULL for in and 0 for INLEN
1021    and do a in-place decryption of the data provided in OUT.  */
1022 gcry_error_t gcry_cipher_encrypt (gcry_cipher_hd_t h,
1023                                   void *out, size_t outsize,
1024                                   const void *in, size_t inlen);
1025
1026 /* The counterpart to gcry_cipher_encrypt.  */
1027 gcry_error_t gcry_cipher_decrypt (gcry_cipher_hd_t h,
1028                                   void *out, size_t outsize,
1029                                   const void *in, size_t inlen);
1030
1031 /* Set KEY of length KEYLEN bytes for the cipher handle HD.  */
1032 gcry_error_t gcry_cipher_setkey (gcry_cipher_hd_t hd,
1033                                  const void *key, size_t keylen);
1034
1035
1036 /* Set initialization vector IV of length IVLEN for the cipher handle HD. */
1037 gcry_error_t gcry_cipher_setiv (gcry_cipher_hd_t hd,
1038                                 const void *iv, size_t ivlen);
1039
1040 /* Provide additional authentication data for AEAD modes/ciphers.  */
1041 gcry_error_t gcry_cipher_authenticate (gcry_cipher_hd_t hd, const void *abuf,
1042                                        size_t abuflen);
1043
1044 /* Get authentication tag for AEAD modes/ciphers.  */
1045 gcry_error_t gcry_cipher_gettag (gcry_cipher_hd_t hd, void *outtag,
1046                                  size_t taglen);
1047
1048 /* Check authentication tag for AEAD modes/ciphers.  */
1049 gcry_error_t gcry_cipher_checktag (gcry_cipher_hd_t hd, const void *intag,
1050                                    size_t taglen);
1051
1052 /* Reset the handle to the state after open.  */
1053 #define gcry_cipher_reset(h)  gcry_cipher_ctl ((h), GCRYCTL_RESET, NULL, 0)
1054
1055 /* Perform the OpenPGP sync operation if this is enabled for the
1056    cipher handle H. */
1057 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, NULL, 0)
1058
1059 /* Enable or disable CTS in future calls to gcry_encrypt(). CBC mode only. */
1060 #define gcry_cipher_cts(h,on)  gcry_cipher_ctl( (h), GCRYCTL_SET_CBC_CTS, \
1061                                                                    NULL, on )
1062
1063 #define gcry_cipher_set_sbox(h,oid) gcry_cipher_ctl( (h), GCRYCTL_SET_SBOX, \
1064                                                      (oid), 0);
1065
1066 /* Indicate to the encrypt and decrypt functions that the next call
1067    provides the final data.  Only used with some modes. e */
1068 #define gcry_cipher_final(a) \
1069             gcry_cipher_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
1070
1071 /* Set counter for CTR mode.  (CTR,CTRLEN) must denote a buffer of
1072    block size length, or (NULL,0) to set the CTR to the all-zero block. */
1073 gpg_error_t gcry_cipher_setctr (gcry_cipher_hd_t hd,
1074                                 const void *ctr, size_t ctrlen);
1075
1076 /* Retrieve the key length in bytes used with algorithm A. */
1077 size_t gcry_cipher_get_algo_keylen (int algo);
1078
1079 /* Retrieve the block length in bytes used with algorithm A. */
1080 size_t gcry_cipher_get_algo_blklen (int algo);
1081
1082 /* Return 0 if the algorithm A is available for use. */
1083 #define gcry_cipher_test_algo(a) \
1084             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1085
1086 \f
1087 /************************************
1088  *                                  *
1089  *    Asymmetric Cipher Functions   *
1090  *                                  *
1091  ************************************/
1092
1093 /* The algorithms and their IDs we support.  */
1094 enum gcry_pk_algos
1095   {
1096     GCRY_PK_RSA   = 1,      /* RSA */
1097     GCRY_PK_RSA_E = 2,      /* (deprecated: use 1).  */
1098     GCRY_PK_RSA_S = 3,      /* (deprecated: use 1).  */
1099     GCRY_PK_ELG_E = 16,     /* (deprecated: use 20). */
1100     GCRY_PK_DSA   = 17,     /* Digital Signature Algorithm.  */
1101     GCRY_PK_ECC   = 18,     /* Generic ECC.  */
1102     GCRY_PK_ELG   = 20,     /* Elgamal       */
1103     GCRY_PK_ECDSA = 301,    /* (only for external use).  */
1104     GCRY_PK_ECDH  = 302,    /* (only for external use).  */
1105     GCRY_PK_EDDSA = 303     /* (only for external use).  */
1106   };
1107
1108 /* Flags describing usage capabilities of a PK algorithm. */
1109 #define GCRY_PK_USAGE_SIGN 1   /* Good for signatures. */
1110 #define GCRY_PK_USAGE_ENCR 2   /* Good for encryption. */
1111 #define GCRY_PK_USAGE_CERT 4   /* Good to certify other keys. */
1112 #define GCRY_PK_USAGE_AUTH 8   /* Good for authentication. */
1113 #define GCRY_PK_USAGE_UNKN 128 /* Unknown usage flag. */
1114
1115 /* Modes used with gcry_pubkey_get_sexp.  */
1116 #define GCRY_PK_GET_PUBKEY 1
1117 #define GCRY_PK_GET_SECKEY 2
1118
1119 /* Encrypt the DATA using the public key PKEY and store the result as
1120    a newly created S-expression at RESULT. */
1121 gcry_error_t gcry_pk_encrypt (gcry_sexp_t *result,
1122                               gcry_sexp_t data, gcry_sexp_t pkey);
1123
1124 /* Decrypt the DATA using the private key SKEY and store the result as
1125    a newly created S-expression at RESULT. */
1126 gcry_error_t gcry_pk_decrypt (gcry_sexp_t *result,
1127                               gcry_sexp_t data, gcry_sexp_t skey);
1128
1129 /* Sign the DATA using the private key SKEY and store the result as
1130    a newly created S-expression at RESULT. */
1131 gcry_error_t gcry_pk_sign (gcry_sexp_t *result,
1132                            gcry_sexp_t data, gcry_sexp_t skey);
1133
1134 /* Check the signature SIGVAL on DATA using the public key PKEY. */
1135 gcry_error_t gcry_pk_verify (gcry_sexp_t sigval,
1136                              gcry_sexp_t data, gcry_sexp_t pkey);
1137
1138 /* Check that private KEY is sane. */
1139 gcry_error_t gcry_pk_testkey (gcry_sexp_t key);
1140
1141 /* Generate a new key pair according to the parameters given in
1142    S_PARMS.  The new key pair is returned in as an S-expression in
1143    R_KEY. */
1144 gcry_error_t gcry_pk_genkey (gcry_sexp_t *r_key, gcry_sexp_t s_parms);
1145
1146 /* Catch all function for miscellaneous operations. */
1147 gcry_error_t gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
1148
1149 /* Retrieve information about the public key algorithm ALGO. */
1150 gcry_error_t gcry_pk_algo_info (int algo, int what,
1151                                 void *buffer, size_t *nbytes);
1152
1153 /* Map the public key algorithm whose ID is contained in ALGORITHM to
1154    a string representation of the algorithm name.  For unknown
1155    algorithm IDs this functions returns "?". */
1156 const char *gcry_pk_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
1157
1158 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
1159    the algorithm name is not known. */
1160 int gcry_pk_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1161
1162 /* Return what is commonly referred as the key length for the given
1163    public or private KEY.  */
1164 unsigned int gcry_pk_get_nbits (gcry_sexp_t key) _GCRY_GCC_ATTR_PURE;
1165
1166 /* Return the so called KEYGRIP which is the SHA-1 hash of the public
1167    key parameters expressed in a way depending on the algorithm.  */
1168 unsigned char *gcry_pk_get_keygrip (gcry_sexp_t key, unsigned char *array);
1169
1170 /* Return the name of the curve matching KEY.  */
1171 const char *gcry_pk_get_curve (gcry_sexp_t key, int iterator,
1172                                unsigned int *r_nbits);
1173
1174 /* Return an S-expression with the parameters of the named ECC curve
1175    NAME.  ALGO must be set to an ECC algorithm.  */
1176 gcry_sexp_t gcry_pk_get_param (int algo, const char *name);
1177
1178 /* Return 0 if the public key algorithm A is available for use. */
1179 #define gcry_pk_test_algo(a) \
1180             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1181
1182 /* Return an S-expression representing the context CTX.  */
1183 gcry_error_t gcry_pubkey_get_sexp (gcry_sexp_t *r_sexp,
1184                                    int mode, gcry_ctx_t ctx);
1185
1186 \f
1187
1188 /************************************
1189  *                                  *
1190  *   Cryptograhic Hash Functions    *
1191  *                                  *
1192  ************************************/
1193
1194 /* Algorithm IDs for the hash functions we know about. Not all of them
1195    are implemented. */
1196 enum gcry_md_algos
1197   {
1198     GCRY_MD_NONE    = 0,
1199     GCRY_MD_MD5     = 1,
1200     GCRY_MD_SHA1    = 2,
1201     GCRY_MD_RMD160  = 3,
1202     GCRY_MD_MD2     = 5,
1203     GCRY_MD_TIGER   = 6,   /* TIGER/192 as used by gpg <= 1.3.2. */
1204     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
1205     GCRY_MD_SHA256  = 8,
1206     GCRY_MD_SHA384  = 9,
1207     GCRY_MD_SHA512  = 10,
1208     GCRY_MD_SHA224  = 11,
1209
1210     GCRY_MD_MD4           = 301,
1211     GCRY_MD_CRC32         = 302,
1212     GCRY_MD_CRC32_RFC1510 = 303,
1213     GCRY_MD_CRC24_RFC2440 = 304,
1214     GCRY_MD_WHIRLPOOL     = 305,
1215     GCRY_MD_TIGER1        = 306, /* TIGER fixed.  */
1216     GCRY_MD_TIGER2        = 307, /* TIGER2 variant.   */
1217     GCRY_MD_GOSTR3411_94  = 308, /* GOST R 34.11-94.  */
1218     GCRY_MD_STRIBOG256    = 309, /* GOST R 34.11-2012, 256 bit.  */
1219     GCRY_MD_STRIBOG512    = 310, /* GOST R 34.11-2012, 512 bit.  */
1220     GCRY_MD_GOSTR3411_CP  = 311, /* GOST R 34.11-94 with CryptoPro-A S-Box.  */
1221     GCRY_MD_SHA3_224      = 312,
1222     GCRY_MD_SHA3_256      = 313,
1223     GCRY_MD_SHA3_384      = 314,
1224     GCRY_MD_SHA3_512      = 315,
1225     GCRY_MD_SHAKE128      = 316,
1226     GCRY_MD_SHAKE256      = 317
1227   };
1228
1229 /* Flags used with the open function.  */
1230 enum gcry_md_flags
1231   {
1232     GCRY_MD_FLAG_SECURE = 1,  /* Allocate all buffers in "secure" memory.  */
1233     GCRY_MD_FLAG_HMAC   = 2,  /* Make an HMAC out of this algorithm.  */
1234     GCRY_MD_FLAG_BUGEMU1 = 0x0100
1235   };
1236
1237 /* (Forward declaration.)  */
1238 struct gcry_md_context;
1239
1240 /* This object is used to hold a handle to a message digest object.
1241    This structure is private - only to be used by the public gcry_md_*
1242    macros.  */
1243 typedef struct gcry_md_handle
1244 {
1245   /* Actual context.  */
1246   struct gcry_md_context *ctx;
1247
1248   /* Buffer management.  */
1249   int  bufpos;
1250   int  bufsize;
1251   unsigned char buf[1];
1252 } *gcry_md_hd_t;
1253
1254 /* Compatibility types, do not use them.  */
1255 #ifndef GCRYPT_NO_DEPRECATED
1256 typedef struct gcry_md_handle *GCRY_MD_HD _GCRY_GCC_ATTR_DEPRECATED;
1257 typedef struct gcry_md_handle *GcryMDHd _GCRY_GCC_ATTR_DEPRECATED;
1258 #endif
1259
1260 /* Create a message digest object for algorithm ALGO.  FLAGS may be
1261    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
1262    given as 0 if the algorithms to be used are later set using
1263    gcry_md_enable.  */
1264 gcry_error_t gcry_md_open (gcry_md_hd_t *h, int algo, unsigned int flags);
1265
1266 /* Release the message digest object HD.  */
1267 void gcry_md_close (gcry_md_hd_t hd);
1268
1269 /* Add the message digest algorithm ALGO to the digest object HD.  */
1270 gcry_error_t gcry_md_enable (gcry_md_hd_t hd, int algo);
1271
1272 /* Create a new digest object as an exact copy of the object HD.  */
1273 gcry_error_t gcry_md_copy (gcry_md_hd_t *bhd, gcry_md_hd_t ahd);
1274
1275 /* Reset the digest object HD to its initial state.  */
1276 void gcry_md_reset (gcry_md_hd_t hd);
1277
1278 /* Perform various operations on the digest object HD. */
1279 gcry_error_t gcry_md_ctl (gcry_md_hd_t hd, int cmd,
1280                           void *buffer, size_t buflen);
1281
1282 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
1283    it can update the digest values.  This is the actual hash
1284    function. */
1285 void gcry_md_write (gcry_md_hd_t hd, const void *buffer, size_t length);
1286
1287 /* Read out the final digest from HD return the digest value for
1288    algorithm ALGO. */
1289 unsigned char *gcry_md_read (gcry_md_hd_t hd, int algo);
1290
1291 /* Read more output from algorithm ALGO to BUFFER of size LENGTH from
1292  * digest object HD. Algorithm needs to be 'expendable-output function'. */
1293 gpg_error_t gcry_md_extract (gcry_md_hd_t hd, int algo, void *buffer,
1294                              size_t length);
1295
1296 /* Convenience function to calculate the hash from the data in BUFFER
1297    of size LENGTH using the algorithm ALGO avoiding the creating of a
1298    hash object.  The hash is returned in the caller provided buffer
1299    DIGEST which must be large enough to hold the digest of the given
1300    algorithm. */
1301 void gcry_md_hash_buffer (int algo, void *digest,
1302                           const void *buffer, size_t length);
1303
1304 /* Convenience function to hash multiple buffers.  */
1305 gpg_error_t gcry_md_hash_buffers (int algo, unsigned int flags, void *digest,
1306                                   const gcry_buffer_t *iov, int iovcnt);
1307
1308 /* Retrieve the algorithm used with HD.  This does not work reliable
1309    if more than one algorithm is enabled in HD. */
1310 int gcry_md_get_algo (gcry_md_hd_t hd);
1311
1312 /* Retrieve the length in bytes of the digest yielded by algorithm
1313    ALGO. */
1314 unsigned int gcry_md_get_algo_dlen (int algo);
1315
1316 /* Return true if the the algorithm ALGO is enabled in the digest
1317    object A. */
1318 int gcry_md_is_enabled (gcry_md_hd_t a, int algo);
1319
1320 /* Return true if the digest object A is allocated in "secure" memory. */
1321 int gcry_md_is_secure (gcry_md_hd_t a);
1322
1323 /* Retrieve various information about the object H.  */
1324 gcry_error_t gcry_md_info (gcry_md_hd_t h, int what, void *buffer,
1325                           size_t *nbytes);
1326
1327 /* Retrieve various information about the algorithm ALGO.  */
1328 gcry_error_t gcry_md_algo_info (int algo, int what, void *buffer,
1329                                size_t *nbytes);
1330
1331 /* Map the digest algorithm id ALGO to a string representation of the
1332    algorithm name.  For unknown algorithms this function returns
1333    "?". */
1334 const char *gcry_md_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
1335
1336 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
1337    the algorithm name is not known. */
1338 int gcry_md_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1339
1340 /* For use with the HMAC feature, the set MAC key to the KEY of
1341    KEYLEN bytes. */
1342 gcry_error_t gcry_md_setkey (gcry_md_hd_t hd, const void *key, size_t keylen);
1343
1344 /* Start or stop debugging for digest handle HD; i.e. create a file
1345    named dbgmd-<n>.<suffix> while hashing.  If SUFFIX is NULL,
1346    debugging stops and the file will be closed. */
1347 void gcry_md_debug (gcry_md_hd_t hd, const char *suffix);
1348
1349
1350 /* Update the hash(s) of H with the character C.  This is a buffered
1351    version of the gcry_md_write function. */
1352 #define gcry_md_putc(h,c)  \
1353             do {                                          \
1354                 gcry_md_hd_t h__ = (h);                   \
1355                 if( (h__)->bufpos == (h__)->bufsize )     \
1356                     gcry_md_write( (h__), NULL, 0 );      \
1357                 (h__)->buf[(h__)->bufpos++] = (c) & 0xff; \
1358             } while(0)
1359
1360 /* Finalize the digest calculation.  This is not really needed because
1361    gcry_md_read() does this implicitly. */
1362 #define gcry_md_final(a) \
1363             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
1364
1365 /* Return 0 if the algorithm A is available for use. */
1366 #define gcry_md_test_algo(a) \
1367             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1368
1369 /* Return an DER encoded ASN.1 OID for the algorithm A in buffer B. N
1370    must point to size_t variable with the available size of buffer B.
1371    After return it will receive the actual size of the returned
1372    OID. */
1373 #define gcry_md_get_asnoid(a,b,n) \
1374             gcry_md_algo_info((a), GCRYCTL_GET_ASNOID, (b), (n))
1375
1376 \f
1377
1378 /**********************************************
1379  *                                            *
1380  *   Message Authentication Code Functions    *
1381  *                                            *
1382  **********************************************/
1383
1384 /* The data object used to hold a handle to an encryption object.  */
1385 struct gcry_mac_handle;
1386 typedef struct gcry_mac_handle *gcry_mac_hd_t;
1387
1388 /* Algorithm IDs for the hash functions we know about. Not all of them
1389    are implemented. */
1390 enum gcry_mac_algos
1391   {
1392     GCRY_MAC_NONE               = 0,
1393
1394     GCRY_MAC_HMAC_SHA256        = 101,
1395     GCRY_MAC_HMAC_SHA224        = 102,
1396     GCRY_MAC_HMAC_SHA512        = 103,
1397     GCRY_MAC_HMAC_SHA384        = 104,
1398     GCRY_MAC_HMAC_SHA1          = 105,
1399     GCRY_MAC_HMAC_MD5           = 106,
1400     GCRY_MAC_HMAC_MD4           = 107,
1401     GCRY_MAC_HMAC_RMD160        = 108,
1402     GCRY_MAC_HMAC_TIGER1        = 109, /* The fixed TIGER variant */
1403     GCRY_MAC_HMAC_WHIRLPOOL     = 110,
1404     GCRY_MAC_HMAC_GOSTR3411_94  = 111,
1405     GCRY_MAC_HMAC_STRIBOG256    = 112,
1406     GCRY_MAC_HMAC_STRIBOG512    = 113,
1407     GCRY_MAC_HMAC_MD2           = 114,
1408     GCRY_MAC_HMAC_SHA3_224      = 115,
1409     GCRY_MAC_HMAC_SHA3_256      = 116,
1410     GCRY_MAC_HMAC_SHA3_384      = 117,
1411     GCRY_MAC_HMAC_SHA3_512      = 118,
1412
1413     GCRY_MAC_CMAC_AES           = 201,
1414     GCRY_MAC_CMAC_3DES          = 202,
1415     GCRY_MAC_CMAC_CAMELLIA      = 203,
1416     GCRY_MAC_CMAC_CAST5         = 204,
1417     GCRY_MAC_CMAC_BLOWFISH      = 205,
1418     GCRY_MAC_CMAC_TWOFISH       = 206,
1419     GCRY_MAC_CMAC_SERPENT       = 207,
1420     GCRY_MAC_CMAC_SEED          = 208,
1421     GCRY_MAC_CMAC_RFC2268       = 209,
1422     GCRY_MAC_CMAC_IDEA          = 210,
1423     GCRY_MAC_CMAC_GOST28147     = 211,
1424
1425     GCRY_MAC_GMAC_AES           = 401,
1426     GCRY_MAC_GMAC_CAMELLIA      = 402,
1427     GCRY_MAC_GMAC_TWOFISH       = 403,
1428     GCRY_MAC_GMAC_SERPENT       = 404,
1429     GCRY_MAC_GMAC_SEED          = 405,
1430
1431     GCRY_MAC_POLY1305           = 501,
1432     GCRY_MAC_POLY1305_AES       = 502,
1433     GCRY_MAC_POLY1305_CAMELLIA  = 503,
1434     GCRY_MAC_POLY1305_TWOFISH   = 504,
1435     GCRY_MAC_POLY1305_SERPENT   = 505,
1436     GCRY_MAC_POLY1305_SEED      = 506
1437   };
1438
1439 /* Flags used with the open function.  */
1440 enum gcry_mac_flags
1441   {
1442     GCRY_MAC_FLAG_SECURE = 1   /* Allocate all buffers in "secure" memory.  */
1443   };
1444
1445 /* Create a MAC handle for algorithm ALGO.  FLAGS may be given as an bitwise OR
1446    of the gcry_mac_flags values.  CTX maybe NULL or gcry_ctx_t object to be
1447    associated with HANDLE.  */
1448 gcry_error_t gcry_mac_open (gcry_mac_hd_t *handle, int algo,
1449                             unsigned int flags, gcry_ctx_t ctx);
1450
1451 /* Close the MAC handle H and release all resource. */
1452 void gcry_mac_close (gcry_mac_hd_t h);
1453
1454 /* Perform various operations on the MAC object H. */
1455 gcry_error_t gcry_mac_ctl (gcry_mac_hd_t h, int cmd, void *buffer,
1456                            size_t buflen);
1457
1458 /* Retrieve various information about the MAC algorithm ALGO. */
1459 gcry_error_t gcry_mac_algo_info (int algo, int what, void *buffer,
1460                                  size_t *nbytes);
1461
1462 /* Set KEY of length KEYLEN bytes for the MAC handle HD.  */
1463 gcry_error_t gcry_mac_setkey (gcry_mac_hd_t hd, const void *key,
1464                               size_t keylen);
1465
1466 /* Set initialization vector IV of length IVLEN for the MAC handle HD. */
1467 gcry_error_t gcry_mac_setiv (gcry_mac_hd_t hd, const void *iv,
1468                              size_t ivlen);
1469
1470 /* Pass LENGTH bytes of data in BUFFER to the MAC object HD so that
1471    it can update the MAC values.  */
1472 gcry_error_t gcry_mac_write (gcry_mac_hd_t hd, const void *buffer,
1473                              size_t length);
1474
1475 /* Read out the final authentication code from the MAC object HD to BUFFER. */
1476 gcry_error_t gcry_mac_read (gcry_mac_hd_t hd, void *buffer, size_t *buflen);
1477
1478 /* Verify the final authentication code from the MAC object HD with BUFFER. */
1479 gcry_error_t gcry_mac_verify (gcry_mac_hd_t hd, const void *buffer,
1480                               size_t buflen);
1481
1482 /* Retrieve the algorithm used with MAC. */
1483 int gcry_mac_get_algo (gcry_mac_hd_t hd);
1484
1485 /* Retrieve the length in bytes of the MAC yielded by algorithm ALGO. */
1486 unsigned int gcry_mac_get_algo_maclen (int algo);
1487
1488 /* Retrieve the default key length in bytes used with algorithm A. */
1489 unsigned int gcry_mac_get_algo_keylen (int algo);
1490
1491 /* Map the MAC algorithm whose ID is contained in ALGORITHM to a
1492    string representation of the algorithm name.  For unknown algorithm
1493    IDs this function returns "?".  */
1494 const char *gcry_mac_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
1495
1496 /* Map the algorithm name NAME to an MAC algorithm ID.  Return 0 if
1497    the algorithm name is not known. */
1498 int gcry_mac_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
1499
1500 /* Reset the handle to the state after open/setkey.  */
1501 #define gcry_mac_reset(h)  gcry_mac_ctl ((h), GCRYCTL_RESET, NULL, 0)
1502
1503 /* Return 0 if the algorithm A is available for use. */
1504 #define gcry_mac_test_algo(a) \
1505             gcry_mac_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1506
1507 \f
1508 /******************************
1509  *                            *
1510  *  Key Derivation Functions  *
1511  *                            *
1512  ******************************/
1513
1514 /* Algorithm IDs for the KDFs.  */
1515 enum gcry_kdf_algos
1516   {
1517     GCRY_KDF_NONE = 0,
1518     GCRY_KDF_SIMPLE_S2K = 16,
1519     GCRY_KDF_SALTED_S2K = 17,
1520     GCRY_KDF_ITERSALTED_S2K = 19,
1521     GCRY_KDF_PBKDF1 = 33,
1522     GCRY_KDF_PBKDF2 = 34,
1523     GCRY_KDF_SCRYPT = 48
1524   };
1525
1526 /* Derive a key from a passphrase.  */
1527 gpg_error_t gcry_kdf_derive (const void *passphrase, size_t passphraselen,
1528                              int algo, int subalgo,
1529                              const void *salt, size_t saltlen,
1530                              unsigned long iterations,
1531                              size_t keysize, void *keybuffer);
1532
1533
1534
1535 \f
1536 /************************************
1537  *                                  *
1538  *   Random Generating Functions    *
1539  *                                  *
1540  ************************************/
1541
1542 /* The type of the random number generator.  */
1543 enum gcry_rng_types
1544   {
1545     GCRY_RNG_TYPE_STANDARD   = 1, /* The default CSPRNG generator.  */
1546     GCRY_RNG_TYPE_FIPS       = 2, /* The FIPS X9.31 AES generator.  */
1547     GCRY_RNG_TYPE_SYSTEM     = 3  /* The system's native generator. */
1548   };
1549
1550 /* The possible values for the random quality.  The rule of thumb is
1551    to use STRONG for session keys and VERY_STRONG for key material.
1552    WEAK is usually an alias for STRONG and should not be used anymore
1553    (except with gcry_mpi_randomize); use gcry_create_nonce instead. */
1554 typedef enum gcry_random_level
1555   {
1556     GCRY_WEAK_RANDOM = 0,
1557     GCRY_STRONG_RANDOM = 1,
1558     GCRY_VERY_STRONG_RANDOM = 2
1559   }
1560 gcry_random_level_t;
1561
1562 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
1563    quality LEVEL. */
1564 void gcry_randomize (void *buffer, size_t length,
1565                      enum gcry_random_level level);
1566
1567 /* Add the external random from BUFFER with LENGTH bytes into the
1568    pool. QUALITY should either be -1 for unknown or in the range of 0
1569    to 100 */
1570 gcry_error_t gcry_random_add_bytes (const void *buffer, size_t length,
1571                                     int quality);
1572
1573 /* If random numbers are used in an application, this macro should be
1574    called from time to time so that new stuff gets added to the
1575    internal pool of the RNG.  */
1576 #define gcry_fast_random_poll()  gcry_control (GCRYCTL_FAST_POLL, NULL)
1577
1578
1579 /* Return NBYTES of allocated random using a random numbers of quality
1580    LEVEL. */
1581 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level)
1582                          _GCRY_GCC_ATTR_MALLOC;
1583
1584 /* Return NBYTES of allocated random using a random numbers of quality
1585    LEVEL.  The random numbers are created returned in "secure"
1586    memory. */
1587 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level)
1588                                 _GCRY_GCC_ATTR_MALLOC;
1589
1590
1591 /* Set the big integer W to a random value of NBITS using a random
1592    generator with quality LEVEL.  Note that by using a level of
1593    GCRY_WEAK_RANDOM gcry_create_nonce is used internally. */
1594 void gcry_mpi_randomize (gcry_mpi_t w,
1595                          unsigned int nbits, enum gcry_random_level level);
1596
1597
1598 /* Create an unpredicable nonce of LENGTH bytes in BUFFER. */
1599 void gcry_create_nonce (void *buffer, size_t length);
1600
1601
1602
1603
1604 \f
1605 /*******************************/
1606 /*                             */
1607 /*    Prime Number Functions   */
1608 /*                             */
1609 /*******************************/
1610
1611 /* Mode values passed to a gcry_prime_check_func_t. */
1612 #define GCRY_PRIME_CHECK_AT_FINISH      0
1613 #define GCRY_PRIME_CHECK_AT_GOT_PRIME   1
1614 #define GCRY_PRIME_CHECK_AT_MAYBE_PRIME 2
1615
1616 /* The function should return 1 if the operation shall continue, 0 to
1617    reject the prime candidate. */
1618 typedef int (*gcry_prime_check_func_t) (void *arg, int mode,
1619                                         gcry_mpi_t candidate);
1620
1621 /* Flags for gcry_prime_generate():  */
1622
1623 /* Allocate prime numbers and factors in secure memory.  */
1624 #define GCRY_PRIME_FLAG_SECRET         (1 << 0)
1625
1626 /* Make sure that at least one prime factor is of size
1627    `FACTOR_BITS'.  */
1628 #define GCRY_PRIME_FLAG_SPECIAL_FACTOR (1 << 1)
1629
1630 /* Generate a new prime number of PRIME_BITS bits and store it in
1631    PRIME.  If FACTOR_BITS is non-zero, one of the prime factors of
1632    (prime - 1) / 2 must be FACTOR_BITS bits long.  If FACTORS is
1633    non-zero, allocate a new, NULL-terminated array holding the prime
1634    factors and store it in FACTORS.  FLAGS might be used to influence
1635    the prime number generation process.  */
1636 gcry_error_t gcry_prime_generate (gcry_mpi_t *prime,
1637                                   unsigned int prime_bits,
1638                                   unsigned int factor_bits,
1639                                   gcry_mpi_t **factors,
1640                                   gcry_prime_check_func_t cb_func,
1641                                   void *cb_arg,
1642                                   gcry_random_level_t random_level,
1643                                   unsigned int flags);
1644
1645 /* Find a generator for PRIME where the factorization of (prime-1) is
1646    in the NULL terminated array FACTORS. Return the generator as a
1647    newly allocated MPI in R_G.  If START_G is not NULL, use this as
1648    the start for the search. */
1649 gcry_error_t gcry_prime_group_generator (gcry_mpi_t *r_g,
1650                                          gcry_mpi_t prime,
1651                                          gcry_mpi_t *factors,
1652                                          gcry_mpi_t start_g);
1653
1654
1655 /* Convenience function to release the FACTORS array. */
1656 void gcry_prime_release_factors (gcry_mpi_t *factors);
1657
1658
1659 /* Check wether the number X is prime.  */
1660 gcry_error_t gcry_prime_check (gcry_mpi_t x, unsigned int flags);
1661
1662
1663 \f
1664 /************************************
1665  *                                  *
1666  *     Miscellaneous Stuff          *
1667  *                                  *
1668  ************************************/
1669
1670 /* Release the context object CTX.  */
1671 void gcry_ctx_release (gcry_ctx_t ctx);
1672
1673 /* Log data using Libgcrypt's own log interface.  */
1674 void gcry_log_debug (const char *fmt, ...) _GCRY_GCC_ATTR_PRINTF(1,2);
1675 void gcry_log_debughex (const char *text, const void *buffer, size_t length);
1676 void gcry_log_debugmpi (const char *text, gcry_mpi_t mpi);
1677 void gcry_log_debugpnt (const char *text,
1678                         gcry_mpi_point_t point, gcry_ctx_t ctx);
1679 void gcry_log_debugsxp (const char *text, gcry_sexp_t sexp);
1680
1681
1682 /* Log levels used by the internal logging facility. */
1683 enum gcry_log_levels
1684   {
1685     GCRY_LOG_CONT   = 0,    /* (Continue the last log line.) */
1686     GCRY_LOG_INFO   = 10,
1687     GCRY_LOG_WARN   = 20,
1688     GCRY_LOG_ERROR  = 30,
1689     GCRY_LOG_FATAL  = 40,
1690     GCRY_LOG_BUG    = 50,
1691     GCRY_LOG_DEBUG  = 100
1692   };
1693
1694 /* Type for progress handlers.  */
1695 typedef void (*gcry_handler_progress_t) (void *, const char *, int, int, int);
1696
1697 /* Type for memory allocation handlers.  */
1698 typedef void *(*gcry_handler_alloc_t) (size_t n);
1699
1700 /* Type for secure memory check handlers.  */
1701 typedef int (*gcry_handler_secure_check_t) (const void *);
1702
1703 /* Type for memory reallocation handlers.  */
1704 typedef void *(*gcry_handler_realloc_t) (void *p, size_t n);
1705
1706 /* Type for memory free handlers.  */
1707 typedef void (*gcry_handler_free_t) (void *);
1708
1709 /* Type for out-of-memory handlers.  */
1710 typedef int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int);
1711
1712 /* Type for fatal error handlers.  */
1713 typedef void (*gcry_handler_error_t) (void *, int, const char *);
1714
1715 /* Type for logging handlers.  */
1716 typedef void (*gcry_handler_log_t) (void *, int, const char *, va_list);
1717
1718 /* Certain operations can provide progress information.  This function
1719    is used to register a handler for retrieving these information. */
1720 void gcry_set_progress_handler (gcry_handler_progress_t cb, void *cb_data);
1721
1722
1723 /* Register a custom memory allocation functions. */
1724 void gcry_set_allocation_handler (
1725                              gcry_handler_alloc_t func_alloc,
1726                              gcry_handler_alloc_t func_alloc_secure,
1727                              gcry_handler_secure_check_t func_secure_check,
1728                              gcry_handler_realloc_t func_realloc,
1729                              gcry_handler_free_t func_free);
1730
1731 /* Register a function used instead of the internal out of memory
1732    handler. */
1733 void gcry_set_outofcore_handler (gcry_handler_no_mem_t h, void *opaque);
1734
1735 /* Register a function used instead of the internal fatal error
1736    handler. */
1737 void gcry_set_fatalerror_handler (gcry_handler_error_t fnc, void *opaque);
1738
1739 /* Register a function used instead of the internal logging
1740    facility. */
1741 void gcry_set_log_handler (gcry_handler_log_t f, void *opaque);
1742
1743 /* Reserved for future use. */
1744 void gcry_set_gettext_handler (const char *(*f)(const char*));
1745
1746 /* Libgcrypt uses its own memory allocation.  It is important to use
1747    gcry_free () to release memory allocated by libgcrypt. */
1748 void *gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1749 void *gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1750 void *gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1751 void *gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1752 void *gcry_realloc (void *a, size_t n);
1753 char *gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
1754 void *gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1755 void *gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1756 void *gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1757 void *gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1758 void *gcry_xrealloc (void *a, size_t n);
1759 char *gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
1760 void  gcry_free (void *a);
1761
1762 /* Return true if A is allocated in "secure" memory. */
1763 int gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
1764
1765 /* Return true if Libgcrypt is in FIPS mode.  */
1766 #define gcry_fips_mode_active()  !!gcry_control (GCRYCTL_FIPS_MODE_P, 0)
1767
1768
1769 #if 0 /* (Keep Emacsens' auto-indent happy.) */
1770 {
1771 #endif
1772 #ifdef __cplusplus
1773 }
1774 #endif
1775 #endif /* _GCRYPT_H */
1776 /*
1777 @emacs_local_vars_begin@
1778 @emacs_local_vars_read_only@
1779 @emacs_local_vars_end@
1780 */