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