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