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