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