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