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