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