random: Add a RNG selection interface and system RNG wrapper.
[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  *
6  * This file is part of Libgcrypt.
7  *
8  * Libgcrypt is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as
10  * published by the Free Software Foundation; either version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * Libgcrypt is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
20  *
21  * File: @configure_input@
22  */
23
24 #ifndef _GCRYPT_H
25 #define _GCRYPT_H
26
27 #include <stdlib.h>
28 #include <stdarg.h>
29 #include <string.h>
30
31 #include <gpg-error.h>
32
33 #include <sys/types.h>
34
35 #if defined _WIN32 || defined __WIN32__
36 # include <winsock2.h>
37 # include <ws2tcpip.h>
38 # include <time.h>
39 # ifndef __GNUC__
40   typedef long ssize_t;
41   typedef int  pid_t;
42 # endif /*!__GNUC__*/
43 #else
44 # include <sys/socket.h>
45 # include <sys/time.h>
46 #@INSERT_SYS_SELECT_H@
47 #endif /*!_WIN32*/
48
49 @FALLBACK_SOCKLEN_T@
50
51 /* This is required for error code compatibility. */
52 #define _GCRY_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_GCRYPT
53
54 #ifdef __cplusplus
55 extern "C" {
56 #if 0 /* (Keep Emacsens' auto-indent happy.) */
57 }
58 #endif
59 #endif
60
61 /* The version of this header should match the one of the library. It
62    should not be used by a program because gcry_check_version() should
63    return the same version.  The purpose of this macro is to let
64    autoconf (using the AM_PATH_GCRYPT macro) check that this header
65    matches the installed library.  */
66 #define GCRYPT_VERSION "@VERSION@"
67
68 /* Internal: We can't use the convenience macros for the multi
69    precision integer functions when building this library. */
70 #ifdef _GCRYPT_IN_LIBGCRYPT
71 #ifndef GCRYPT_NO_MPI_MACROS
72 #define GCRYPT_NO_MPI_MACROS 1
73 #endif
74 #endif
75
76 /* We want to use gcc attributes when possible.  Warning: Don't use
77    these macros in your programs: As indicated by the leading
78    underscore they are subject to change without notice. */
79 #ifdef __GNUC__
80
81 #define _GCRY_GCC_VERSION (__GNUC__ * 10000 \
82                              + __GNUC_MINOR__ * 100 \
83                              + __GNUC_PATCHLEVEL__)
84
85 #if _GCRY_GCC_VERSION >= 30100
86 #define _GCRY_GCC_ATTR_DEPRECATED __attribute__ ((__deprecated__))
87 #endif
88
89 #if _GCRY_GCC_VERSION >= 29600
90 #define _GCRY_GCC_ATTR_PURE  __attribute__ ((__pure__))
91 #endif
92
93 #if _GCRY_GCC_VERSION >= 30200
94 #define _GCRY_GCC_ATTR_MALLOC  __attribute__ ((__malloc__))
95 #endif
96
97 #endif /*__GNUC__*/
98
99 #ifndef _GCRY_GCC_ATTR_DEPRECATED
100 #define _GCRY_GCC_ATTR_DEPRECATED
101 #endif
102 #ifndef _GCRY_GCC_ATTR_PURE
103 #define _GCRY_GCC_ATTR_PURE
104 #endif
105 #ifndef _GCRY_GCC_ATTR_MALLOC
106 #define _GCRY_GCC_ATTR_MALLOC
107 #endif
108
109 /* Make up an attribute to mark functions and types as deprecated but
110    allow internal use by Libgcrypt.  */
111 #ifdef _GCRYPT_IN_LIBGCRYPT
112 #define _GCRY_ATTR_INTERNAL
113 #else
114 #define _GCRY_ATTR_INTERNAL     _GCRY_GCC_ATTR_DEPRECATED
115 #endif
116
117 /* Wrappers for the libgpg-error library.  */
118
119 typedef gpg_error_t gcry_error_t;
120 typedef gpg_err_code_t gcry_err_code_t;
121 typedef gpg_err_source_t gcry_err_source_t;
122
123 static GPG_ERR_INLINE gcry_error_t
124 gcry_err_make (gcry_err_source_t source, gcry_err_code_t code)
125 {
126   return gpg_err_make (source, code);
127 }
128
129 /* The user can define GPG_ERR_SOURCE_DEFAULT before including this
130    file to specify a default source for gpg_error.  */
131 #ifndef GCRY_ERR_SOURCE_DEFAULT
132 #define GCRY_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
133 #endif
134
135 static GPG_ERR_INLINE gcry_error_t
136 gcry_error (gcry_err_code_t code)
137 {
138   return gcry_err_make (GCRY_ERR_SOURCE_DEFAULT, code);
139 }
140
141 static GPG_ERR_INLINE gcry_err_code_t
142 gcry_err_code (gcry_error_t err)
143 {
144   return gpg_err_code (err);
145 }
146
147
148 static GPG_ERR_INLINE gcry_err_source_t
149 gcry_err_source (gcry_error_t err)
150 {
151   return gpg_err_source (err);
152 }
153
154 /* Return a pointer to a string containing a description of the error
155    code in the error value ERR.  */
156 const char *gcry_strerror (gcry_error_t err);
157
158 /* Return a pointer to a string containing a description of the error
159    source in the error value ERR.  */
160 const char *gcry_strsource (gcry_error_t err);
161
162 /* Retrieve the error code for the system error ERR.  This returns
163    GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
164    this).  */
165 gcry_err_code_t gcry_err_code_from_errno (int err);
166
167 /* Retrieve the system error for the error code CODE.  This returns 0
168    if CODE is not a system error code.  */
169 int gcry_err_code_to_errno (gcry_err_code_t code);
170
171 /* Return an error value with the error source SOURCE and the system
172    error ERR.  */
173 gcry_error_t gcry_err_make_from_errno (gcry_err_source_t source, int err);
174
175 /* Return an error value with the system error ERR.  */
176 gcry_err_code_t gcry_error_from_errno (int err);
177
178 \f
179 /* NOTE: Since Libgcrypt 1.6 the thread callbacks are not anymore
180    used.  However we keep it to allow for some source code
181    compatibility if used in the standard way.  */
182
183 /* Constants defining the thread model to use.  Used with the OPTION
184    field of the struct gcry_thread_cbs.  */
185 #define GCRY_THREAD_OPTION_DEFAULT  0
186 #define GCRY_THREAD_OPTION_USER     1
187 #define GCRY_THREAD_OPTION_PTH      2
188 #define GCRY_THREAD_OPTION_PTHREAD  3
189
190 /* The version number encoded in the OPTION field of the struct
191    gcry_thread_cbs.  */
192 #define GCRY_THREAD_OPTION_VERSION  1
193
194 /* Wrapper for struct ath_ops.  */
195 struct gcry_thread_cbs
196 {
197   /* The OPTION field encodes the thread model and the version number
198      of this structure.
199        Bits  7 - 0  are used for the thread model
200        Bits 15 - 8  are used for the version number.  */
201   unsigned int option;
202 } _GCRY_ATTR_INTERNAL;
203
204 #define GCRY_THREAD_OPTION_PTH_IMPL                                     \
205   static struct gcry_thread_cbs gcry_threads_pth = {                    \
206     (GCRY_THREAD_OPTION_PTH | (GCRY_THREAD_OPTION_VERSION << 8))}
207
208 #define GCRY_THREAD_OPTION_PTHREAD_IMPL                                 \
209   static struct gcry_thread_cbs gcry_threads_pthread = {                \
210     (GCRY_THREAD_OPTION_PTHREAD | (GCRY_THREAD_OPTION_VERSION << 8))}
211
212
213 \f
214 /* The data object used to hold a multi precision integer.  */
215 struct gcry_mpi;
216 typedef struct gcry_mpi *gcry_mpi_t;
217
218 #ifndef GCRYPT_NO_DEPRECATED
219 typedef struct gcry_mpi *GCRY_MPI _GCRY_GCC_ATTR_DEPRECATED;
220 typedef struct gcry_mpi *GcryMPI _GCRY_GCC_ATTR_DEPRECATED;
221 #endif
222
223 \f
224
225 /* Check that the library fulfills the version requirement.  */
226 const char *gcry_check_version (const char *req_version);
227
228 /* Codes for function dispatchers.  */
229
230 /* Codes used with the gcry_control function. */
231 enum gcry_ctl_cmds
232   {
233     GCRYCTL_SET_KEY  = 1,
234     GCRYCTL_SET_IV   = 2,
235     GCRYCTL_CFB_SYNC = 3,
236     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
237     GCRYCTL_FINALIZE = 5,
238     GCRYCTL_GET_KEYLEN = 6,
239     GCRYCTL_GET_BLKLEN = 7,
240     GCRYCTL_TEST_ALGO = 8,
241     GCRYCTL_IS_SECURE = 9,
242     GCRYCTL_GET_ASNOID = 10,
243     GCRYCTL_ENABLE_ALGO = 11,
244     GCRYCTL_DISABLE_ALGO = 12,
245     GCRYCTL_DUMP_RANDOM_STATS = 13,
246     GCRYCTL_DUMP_SECMEM_STATS = 14,
247     GCRYCTL_GET_ALGO_NPKEY    = 15,
248     GCRYCTL_GET_ALGO_NSKEY    = 16,
249     GCRYCTL_GET_ALGO_NSIGN    = 17,
250     GCRYCTL_GET_ALGO_NENCR    = 18,
251     GCRYCTL_SET_VERBOSITY     = 19,
252     GCRYCTL_SET_DEBUG_FLAGS   = 20,
253     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
254     GCRYCTL_USE_SECURE_RNDPOOL= 22,
255     GCRYCTL_DUMP_MEMORY_STATS = 23,
256     GCRYCTL_INIT_SECMEM       = 24,
257     GCRYCTL_TERM_SECMEM       = 25,
258     GCRYCTL_DISABLE_SECMEM_WARN = 27,
259     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
260     GCRYCTL_RESUME_SECMEM_WARN  = 29,
261     GCRYCTL_DROP_PRIVS          = 30,
262     GCRYCTL_ENABLE_M_GUARD      = 31,
263     GCRYCTL_START_DUMP          = 32,
264     GCRYCTL_STOP_DUMP           = 33,
265     GCRYCTL_GET_ALGO_USAGE      = 34,
266     GCRYCTL_IS_ALGO_ENABLED     = 35,
267     GCRYCTL_DISABLE_INTERNAL_LOCKING = 36,
268     GCRYCTL_DISABLE_SECMEM      = 37,
269     GCRYCTL_INITIALIZATION_FINISHED = 38,
270     GCRYCTL_INITIALIZATION_FINISHED_P = 39,
271     GCRYCTL_ANY_INITIALIZATION_P = 40,
272     GCRYCTL_SET_CBC_CTS = 41,
273     GCRYCTL_SET_CBC_MAC = 42,
274     GCRYCTL_SET_CTR = 43,
275     GCRYCTL_ENABLE_QUICK_RANDOM = 44,
276     GCRYCTL_SET_RANDOM_SEED_FILE = 45,
277     GCRYCTL_UPDATE_RANDOM_SEED_FILE = 46,
278     GCRYCTL_SET_THREAD_CBS = 47,
279     GCRYCTL_FAST_POLL = 48,
280     GCRYCTL_SET_RANDOM_DAEMON_SOCKET = 49,
281     GCRYCTL_USE_RANDOM_DAEMON = 50,
282     GCRYCTL_FAKED_RANDOM_P = 51,
283     GCRYCTL_SET_RNDEGD_SOCKET = 52,
284     GCRYCTL_PRINT_CONFIG = 53,
285     GCRYCTL_OPERATIONAL_P = 54,
286     GCRYCTL_FIPS_MODE_P = 55,
287     GCRYCTL_FORCE_FIPS_MODE = 56,
288     GCRYCTL_SELFTEST = 57,
289     /* Note: 58 .. 62 are used internally.  */
290     GCRYCTL_DISABLE_HWF = 63,
291     GCRYCTL_SET_ENFORCED_FIPS_FLAG = 64,
292     GCRYCTL_SET_PREFERRED_RNG_TYPE = 65,
293     GCRYCTL_GET_CURRENT_RNG_TYPE = 66
294   };
295
296 /* Perform various operations defined by CMD. */
297 gcry_error_t gcry_control (enum gcry_ctl_cmds CMD, ...);
298
299 \f
300 /* S-expression management. */
301
302 /* The object to represent an S-expression as used with the public key
303    functions.  */
304 struct gcry_sexp;
305 typedef struct gcry_sexp *gcry_sexp_t;
306
307 #ifndef GCRYPT_NO_DEPRECATED
308 typedef struct gcry_sexp *GCRY_SEXP _GCRY_GCC_ATTR_DEPRECATED;
309 typedef struct gcry_sexp *GcrySexp _GCRY_GCC_ATTR_DEPRECATED;
310 #endif
311
312 /* The possible values for the S-expression format. */
313 enum gcry_sexp_format
314   {
315     GCRYSEXP_FMT_DEFAULT   = 0,
316     GCRYSEXP_FMT_CANON     = 1,
317     GCRYSEXP_FMT_BASE64    = 2,
318     GCRYSEXP_FMT_ADVANCED  = 3
319   };
320
321 /* Create an new S-expression object from BUFFER of size LENGTH and
322    return it in RETSEXP.  With AUTODETECT set to 0 the data in BUFFER
323    is expected to be in canonized format.  */
324 gcry_error_t gcry_sexp_new (gcry_sexp_t *retsexp,
325                             const void *buffer, size_t length,
326                             int autodetect);
327
328  /* Same as gcry_sexp_new but allows to pass a FREEFNC which has the
329     effect to transfer ownership of BUFFER to the created object.  */
330 gcry_error_t gcry_sexp_create (gcry_sexp_t *retsexp,
331                                void *buffer, size_t length,
332                                int autodetect, void (*freefnc) (void *));
333
334 /* Scan BUFFER and return a new S-expression object in RETSEXP.  This
335    function expects a printf like string in BUFFER.  */
336 gcry_error_t gcry_sexp_sscan (gcry_sexp_t *retsexp, size_t *erroff,
337                               const char *buffer, size_t length);
338
339 /* Same as gcry_sexp_sscan but expects a string in FORMAT and can thus
340    only be used for certain encodings.  */
341 gcry_error_t gcry_sexp_build (gcry_sexp_t *retsexp, size_t *erroff,
342                               const char *format, ...);
343
344 /* Like gcry_sexp_build, but uses an array instead of variable
345    function arguments.  */
346 gcry_error_t gcry_sexp_build_array (gcry_sexp_t *retsexp, size_t *erroff,
347                                     const char *format, void **arg_list);
348
349 /* Release the S-expression object SEXP */
350 void gcry_sexp_release (gcry_sexp_t sexp);
351
352 /* Calculate the length of an canonized S-expresion in BUFFER and
353    check for a valid encoding. */
354 size_t gcry_sexp_canon_len (const unsigned char *buffer, size_t length,
355                             size_t *erroff, gcry_error_t *errcode);
356
357 /* Copies the S-expression object SEXP into BUFFER using the format
358    specified in MODE.  */
359 size_t gcry_sexp_sprint (gcry_sexp_t sexp, int mode, void *buffer,
360                          size_t maxlength);
361
362 /* Dumps the S-expression object A in a format suitable for debugging
363    to Libgcrypt's logging stream.  */
364 void gcry_sexp_dump (const gcry_sexp_t a);
365
366 gcry_sexp_t gcry_sexp_cons (const gcry_sexp_t a, const gcry_sexp_t b);
367 gcry_sexp_t gcry_sexp_alist (const gcry_sexp_t *array);
368 gcry_sexp_t gcry_sexp_vlist (const gcry_sexp_t a, ...);
369 gcry_sexp_t gcry_sexp_append (const gcry_sexp_t a, const gcry_sexp_t n);
370 gcry_sexp_t gcry_sexp_prepend (const gcry_sexp_t a, const gcry_sexp_t n);
371
372 /* Scan the S-expression for a sublist with a type (the car of the
373    list) matching the string TOKEN.  If TOKLEN is not 0, the token is
374    assumed to be raw memory of this length.  The function returns a
375    newly allocated S-expression consisting of the found sublist or
376    `NULL' when not found.  */
377 gcry_sexp_t gcry_sexp_find_token (gcry_sexp_t list,
378                                 const char *tok, size_t toklen);
379 /* Return the length of the LIST.  For a valid S-expression this
380    should be at least 1.  */
381 int gcry_sexp_length (const gcry_sexp_t list);
382
383 /* Create and return a new S-expression from the element with index
384    NUMBER in LIST.  Note that the first element has the index 0.  If
385    there is no such element, `NULL' is returned.  */
386 gcry_sexp_t gcry_sexp_nth (const gcry_sexp_t list, int number);
387
388 /* Create and return a new S-expression from the first element in
389    LIST; this called the "type" and should always exist and be a
390    string. `NULL' is returned in case of a problem.  */
391 gcry_sexp_t gcry_sexp_car (const gcry_sexp_t list);
392
393 /* Create and return a new list form all elements except for the first
394    one.  Note, that this function may return an invalid S-expression
395    because it is not guaranteed, that the type exists and is a string.
396    However, for parsing a complex S-expression it might be useful for
397    intermediate lists.  Returns `NULL' on error.  */
398 gcry_sexp_t gcry_sexp_cdr (const gcry_sexp_t list);
399
400 gcry_sexp_t gcry_sexp_cadr (const gcry_sexp_t list);
401
402
403 /* This function is used to get data from a LIST.  A pointer to the
404    actual data with index NUMBER is returned and the length of this
405    data will be stored to DATALEN.  If there is no data at the given
406    index or the index represents another list, `NULL' is returned.
407    *Note:* The returned pointer is valid as long as LIST is not
408    modified or released.  */
409 const char *gcry_sexp_nth_data (const gcry_sexp_t list, int number,
410                                 size_t *datalen);
411
412 /* This function is used to get and convert data from a LIST.  The
413    data is assumed to be a Nul terminated string.  The caller must
414    release the returned value using `gcry_free'.  If there is no data
415    at the given index, the index represents a list or the value can't
416    be converted to a string, `NULL' is returned.  */
417 char *gcry_sexp_nth_string (gcry_sexp_t list, int number);
418
419 /* This function is used to get and convert data from a LIST. This
420    data is assumed to be an MPI stored in the format described by
421    MPIFMT and returned as a standard Libgcrypt MPI.  The caller must
422    release this returned value using `gcry_mpi_release'.  If there is
423    no data at the given index, the index represents a list or the
424    value can't be converted to an MPI, `NULL' is returned.  */
425 gcry_mpi_t gcry_sexp_nth_mpi (gcry_sexp_t list, int number, int mpifmt);
426
427
428 \f
429 /*******************************************
430  *                                         *
431  *  Multi Precision Integer Functions      *
432  *                                         *
433  *******************************************/
434
435 /* Different formats of external big integer representation. */
436 enum gcry_mpi_format
437   {
438     GCRYMPI_FMT_NONE= 0,
439     GCRYMPI_FMT_STD = 1,    /* Twos complement stored without length.  */
440     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP (unsigned only).  */
441     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (like STD but with length).  */
442     GCRYMPI_FMT_HEX = 4,    /* Hex format. */
443     GCRYMPI_FMT_USG = 5     /* Like STD but unsigned. */
444   };
445
446 /* Flags used for creating big integers.  */
447 enum gcry_mpi_flag
448   {
449     GCRYMPI_FLAG_SECURE = 1,  /* Allocate the number in "secure" memory.  */
450     GCRYMPI_FLAG_OPAQUE = 2   /* The number is not a real one but just
451                                  a way to store some bytes.  This is
452                                  useful for encrypted big integers.  */
453   };
454
455
456 /* Allocate a new big integer object, initialize it with 0 and
457    initially allocate memory for a number of at least NBITS. */
458 gcry_mpi_t gcry_mpi_new (unsigned int nbits);
459
460 /* Same as gcry_mpi_new() but allocate in "secure" memory. */
461 gcry_mpi_t gcry_mpi_snew (unsigned int nbits);
462
463 /* Release the number A and free all associated resources. */
464 void gcry_mpi_release (gcry_mpi_t a);
465
466 /* Create a new number with the same value as A. */
467 gcry_mpi_t gcry_mpi_copy (const gcry_mpi_t a);
468
469 /* Store the big integer value U in W. */
470 gcry_mpi_t gcry_mpi_set (gcry_mpi_t w, const gcry_mpi_t u);
471
472 /* Store the unsigned integer value U in W. */
473 gcry_mpi_t gcry_mpi_set_ui (gcry_mpi_t w, unsigned long u);
474
475 /* Swap the values of A and B. */
476 void gcry_mpi_swap (gcry_mpi_t a, gcry_mpi_t b);
477
478 /* Compare the big integer number U and V returning 0 for equality, a
479    positive value for U > V and a negative for U < V. */
480 int gcry_mpi_cmp (const gcry_mpi_t u, const gcry_mpi_t v);
481
482 /* Compare the big integer number U with the unsigned integer V
483    returning 0 for equality, a positive value for U > V and a negative
484    for U < V. */
485 int gcry_mpi_cmp_ui (const gcry_mpi_t u, unsigned long v);
486
487 /* Convert the external representation of an integer stored in BUFFER
488    with a length of BUFLEN into a newly create MPI returned in
489    RET_MPI.  If NSCANNED is not NULL, it will receive the number of
490    bytes actually scanned after a successful operation. */
491 gcry_error_t gcry_mpi_scan (gcry_mpi_t *ret_mpi, enum gcry_mpi_format format,
492                             const void *buffer, size_t buflen,
493                             size_t *nscanned);
494
495 /* Convert the big integer A into the external representation
496    described by FORMAT and store it in the provided BUFFER which has
497    been allocated by the user with a size of BUFLEN bytes.  NWRITTEN
498    receives the actual length of the external representation unless it
499    has been passed as NULL. */
500 gcry_error_t gcry_mpi_print (enum gcry_mpi_format format,
501                              unsigned char *buffer, size_t buflen,
502                              size_t *nwritten,
503                              const gcry_mpi_t a);
504
505 /* Convert the big integer A int the external representation described
506    by FORMAT and store it in a newly allocated buffer which address
507    will be put into BUFFER.  NWRITTEN receives the actual lengths of the
508    external representation. */
509 gcry_error_t gcry_mpi_aprint (enum gcry_mpi_format format,
510                               unsigned char **buffer, size_t *nwritten,
511                               const gcry_mpi_t a);
512
513 /* Dump the value of A in a format suitable for debugging to
514    Libgcrypt's logging stream.  Note that one leading space but no
515    trailing space or linefeed will be printed.  It is okay to pass
516    NULL for A. */
517 void gcry_mpi_dump (const gcry_mpi_t a);
518
519
520 /* W = U + V.  */
521 void gcry_mpi_add (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
522
523 /* W = U + V.  V is an unsigned integer. */
524 void gcry_mpi_add_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v);
525
526 /* W = U + V mod M. */
527 void gcry_mpi_addm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
528
529 /* W = U - V. */
530 void gcry_mpi_sub (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
531
532 /* W = U - V.  V is an unsigned integer. */
533 void gcry_mpi_sub_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
534
535 /* W = U - V mod M */
536 void gcry_mpi_subm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
537
538 /* W = U * V. */
539 void gcry_mpi_mul (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
540
541 /* W = U * V.  V is an unsigned integer. */
542 void gcry_mpi_mul_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
543
544 /* W = U * V mod M. */
545 void gcry_mpi_mulm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
546
547 /* W = U * (2 ^ CNT). */
548 void gcry_mpi_mul_2exp (gcry_mpi_t w, gcry_mpi_t u, unsigned long cnt);
549
550 /* Q = DIVIDEND / DIVISOR, R = DIVIDEND % DIVISOR,
551    Q or R may be passed as NULL.  ROUND should be negative or 0. */
552 void gcry_mpi_div (gcry_mpi_t q, gcry_mpi_t r,
553                    gcry_mpi_t dividend, gcry_mpi_t divisor, int round);
554
555 /* R = DIVIDEND % DIVISOR */
556 void gcry_mpi_mod (gcry_mpi_t r, gcry_mpi_t dividend, gcry_mpi_t divisor);
557
558 /* W = B ^ E mod M. */
559 void gcry_mpi_powm (gcry_mpi_t w,
560                     const gcry_mpi_t b, const gcry_mpi_t e,
561                     const gcry_mpi_t m);
562
563 /* Set G to the greatest common divisor of A and B.
564    Return true if the G is 1. */
565 int gcry_mpi_gcd (gcry_mpi_t g, gcry_mpi_t a, gcry_mpi_t b);
566
567 /* Set X to the multiplicative inverse of A mod M.
568    Return true if the value exists. */
569 int gcry_mpi_invm (gcry_mpi_t x, gcry_mpi_t a, gcry_mpi_t m);
570
571
572 /* Return the number of bits required to represent A. */
573 unsigned int gcry_mpi_get_nbits (gcry_mpi_t a);
574
575 /* Return true when bit number N (counting from 0) is set in A. */
576 int      gcry_mpi_test_bit (gcry_mpi_t a, unsigned int n);
577
578 /* Set bit number N in A. */
579 void     gcry_mpi_set_bit (gcry_mpi_t a, unsigned int n);
580
581 /* Clear bit number N in A. */
582 void     gcry_mpi_clear_bit (gcry_mpi_t a, unsigned int n);
583
584 /* Set bit number N in A and clear all bits greater than N. */
585 void     gcry_mpi_set_highbit (gcry_mpi_t a, unsigned int n);
586
587 /* Clear bit number N in A and all bits greater than N. */
588 void     gcry_mpi_clear_highbit (gcry_mpi_t a, unsigned int n);
589
590 /* Shift the value of A by N bits to the right and store the result in X. */
591 void     gcry_mpi_rshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
592
593 /* Shift the value of A by N bits to the left and store the result in X. */
594 void     gcry_mpi_lshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
595
596 /* Store NBITS of the value P points to in A and mark A as an opaque
597    value.  WARNING: Never use an opaque MPI for anything thing else then
598    gcry_mpi_release, gcry_mpi_get_opaque. */
599 gcry_mpi_t gcry_mpi_set_opaque (gcry_mpi_t a, void *p, unsigned int nbits);
600
601 /* Return a pointer to an opaque value stored in A and return its size
602    in NBITS.  Note that the returned pointer is still owned by A and
603    that the function should never be used for an non-opaque MPI. */
604 void *gcry_mpi_get_opaque (gcry_mpi_t a, unsigned int *nbits);
605
606 /* Set the FLAG for the big integer A.  Currently only the flag
607    GCRYMPI_FLAG_SECURE is allowed to convert A into an big intger
608    stored in "secure" memory. */
609 void gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
610
611 /* Clear FLAG for the big integer A.  Note that this function is
612    currently useless as no flags are allowed. */
613 void gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
614
615 /* Return true when the FLAG is set for A. */
616 int gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
617
618 /* Unless the GCRYPT_NO_MPI_MACROS is used, provide a couple of
619    convenience macros for the big integer functions. */
620 #ifndef GCRYPT_NO_MPI_MACROS
621 #define mpi_new(n)          gcry_mpi_new( (n) )
622 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
623 #define mpi_release(a)      \
624   do \
625     { \
626       gcry_mpi_release ((a)); \
627       (a) = NULL; \
628     } \
629   while (0)
630
631 #define mpi_copy( a )          gcry_mpi_copy( (a) )
632 #define mpi_set( w, u)         gcry_mpi_set( (w), (u) )
633 #define mpi_set_ui( w, u)      gcry_mpi_set_ui( (w), (u) )
634 #define mpi_cmp( u, v )        gcry_mpi_cmp( (u), (v) )
635 #define mpi_cmp_ui( u, v )     gcry_mpi_cmp_ui( (u), (v) )
636
637 #define mpi_add_ui(w,u,v)      gcry_mpi_add_ui((w),(u),(v))
638 #define mpi_add(w,u,v)         gcry_mpi_add ((w),(u),(v))
639 #define mpi_addm(w,u,v,m)      gcry_mpi_addm ((w),(u),(v),(m))
640 #define mpi_sub_ui(w,u,v)      gcry_mpi_sub_ui ((w),(u),(v))
641 #define mpi_sub(w,u,v)         gcry_mpi_sub ((w),(u),(v))
642 #define mpi_subm(w,u,v,m)      gcry_mpi_subm ((w),(u),(v),(m))
643 #define mpi_mul_ui(w,u,v)      gcry_mpi_mul_ui ((w),(u),(v))
644 #define mpi_mul_2exp(w,u,v)    gcry_mpi_mul_2exp ((w),(u),(v))
645 #define mpi_mul(w,u,v)         gcry_mpi_mul ((w),(u),(v))
646 #define mpi_mulm(w,u,v,m)      gcry_mpi_mulm ((w),(u),(v),(m))
647 #define mpi_powm(w,b,e,m)      gcry_mpi_powm ( (w), (b), (e), (m) )
648 #define mpi_tdiv(q,r,a,m)      gcry_mpi_div ( (q), (r), (a), (m), 0)
649 #define mpi_fdiv(q,r,a,m)      gcry_mpi_div ( (q), (r), (a), (m), -1)
650 #define mpi_mod(r,a,m)         gcry_mpi_mod ((r), (a), (m))
651 #define mpi_gcd(g,a,b)         gcry_mpi_gcd ( (g), (a), (b) )
652 #define mpi_invm(g,a,b)        gcry_mpi_invm ( (g), (a), (b) )
653
654 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
655 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
656 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
657 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
658 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
659 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
660 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
661 #define mpi_lshift(a,b,c)      gcry_mpi_lshift ((a),(b),(c))
662
663 #define mpi_set_opaque(a,b,c)  gcry_mpi_set_opaque( (a), (b), (c) )
664 #define mpi_get_opaque(a,b)    gcry_mpi_get_opaque( (a), (b) )
665 #endif /* GCRYPT_NO_MPI_MACROS */
666
667
668 \f
669 /************************************
670  *                                  *
671  *   Symmetric Cipher Functions     *
672  *                                  *
673  ************************************/
674
675 /* The data object used to hold a handle to an encryption object.  */
676 struct gcry_cipher_handle;
677 typedef struct gcry_cipher_handle *gcry_cipher_hd_t;
678
679 #ifndef GCRYPT_NO_DEPRECATED
680 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD _GCRY_GCC_ATTR_DEPRECATED;
681 typedef struct gcry_cipher_handle *GcryCipherHd _GCRY_GCC_ATTR_DEPRECATED;
682 #endif
683
684 /* All symmetric encryption algorithms are identified by their IDs.
685    More IDs may be registered at runtime. */
686 enum gcry_cipher_algos
687   {
688     GCRY_CIPHER_NONE        = 0,
689     GCRY_CIPHER_IDEA        = 1,
690     GCRY_CIPHER_3DES        = 2,
691     GCRY_CIPHER_CAST5       = 3,
692     GCRY_CIPHER_BLOWFISH    = 4,
693     GCRY_CIPHER_SAFER_SK128 = 5,
694     GCRY_CIPHER_DES_SK      = 6,
695     GCRY_CIPHER_AES         = 7,
696     GCRY_CIPHER_AES192      = 8,
697     GCRY_CIPHER_AES256      = 9,
698     GCRY_CIPHER_TWOFISH     = 10,
699
700     /* Other cipher numbers are above 300 for OpenPGP reasons. */
701     GCRY_CIPHER_ARCFOUR     = 301,  /* Fully compatible with RSA's RC4 (tm). */
702     GCRY_CIPHER_DES         = 302,  /* Yes, this is single key 56 bit DES. */
703     GCRY_CIPHER_TWOFISH128  = 303,
704     GCRY_CIPHER_SERPENT128  = 304,
705     GCRY_CIPHER_SERPENT192  = 305,
706     GCRY_CIPHER_SERPENT256  = 306,
707     GCRY_CIPHER_RFC2268_40  = 307,  /* Ron's Cipher 2 (40 bit). */
708     GCRY_CIPHER_RFC2268_128 = 308,  /* Ron's Cipher 2 (128 bit). */
709     GCRY_CIPHER_SEED        = 309,  /* 128 bit cipher described in RFC4269. */
710     GCRY_CIPHER_CAMELLIA128 = 310,
711     GCRY_CIPHER_CAMELLIA192 = 311,
712     GCRY_CIPHER_CAMELLIA256 = 312
713   };
714
715 /* The Rijndael algorithm is basically AES, so provide some macros. */
716 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES
717 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES
718 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128
719 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192
720 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256
721
722 /* The supported encryption modes.  Note that not all of them are
723    supported for each algorithm. */
724 enum gcry_cipher_modes
725   {
726     GCRY_CIPHER_MODE_NONE   = 0,  /* Not yet specified. */
727     GCRY_CIPHER_MODE_ECB    = 1,  /* Electronic codebook. */
728     GCRY_CIPHER_MODE_CFB    = 2,  /* Cipher feedback. */
729     GCRY_CIPHER_MODE_CBC    = 3,  /* Cipher block chaining. */
730     GCRY_CIPHER_MODE_STREAM = 4,  /* Used with stream ciphers. */
731     GCRY_CIPHER_MODE_OFB    = 5,  /* Outer feedback. */
732     GCRY_CIPHER_MODE_CTR    = 6,  /* Counter. */
733     GCRY_CIPHER_MODE_AESWRAP= 7   /* AES-WRAP algorithm.  */
734   };
735
736 /* Flags used with the open function. */
737 enum gcry_cipher_flags
738   {
739     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
740     GCRY_CIPHER_ENABLE_SYNC = 2,  /* Enable CFB sync mode. */
741     GCRY_CIPHER_CBC_CTS     = 4,  /* Enable CBC cipher text stealing (CTS). */
742     GCRY_CIPHER_CBC_MAC     = 8   /* Enable CBC message auth. code (MAC). */
743   };
744
745
746 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
747    be given as an bitwise OR of the gcry_cipher_flags values. */
748 gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *handle,
749                               int algo, int mode, unsigned int flags);
750
751 /* Close the cioher handle H and release all resource. */
752 void gcry_cipher_close (gcry_cipher_hd_t h);
753
754 /* Perform various operations on the cipher object H. */
755 gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer,
756                              size_t buflen);
757
758 /* Retrieve various information about the cipher object H. */
759 gcry_error_t gcry_cipher_info (gcry_cipher_hd_t h, int what, void *buffer,
760                               size_t *nbytes);
761
762 /* Retrieve various information about the cipher algorithm ALGO. */
763 gcry_error_t gcry_cipher_algo_info (int algo, int what, void *buffer,
764                                    size_t *nbytes);
765
766 /* Map the cipher algorithm whose ID is contained in ALGORITHM to a
767    string representation of the algorithm name.  For unknown algorithm
768    IDs this function returns "?".  */
769 const char *gcry_cipher_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
770
771 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
772    the algorithm name is not known. */
773 int gcry_cipher_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
774
775 /* Given an ASN.1 object identifier in standard IETF dotted decimal
776    format in STRING, return the encryption mode associated with that
777    OID or 0 if not known or applicable. */
778 int gcry_cipher_mode_from_oid (const char *string) _GCRY_GCC_ATTR_PURE;
779
780 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
781    into the buffer OUT which has an allocated length of OUTSIZE.  For
782    most algorithms it is possible to pass NULL for in and 0 for INLEN
783    and do a in-place decryption of the data provided in OUT.  */
784 gcry_error_t gcry_cipher_encrypt (gcry_cipher_hd_t h,
785                                   void *out, size_t outsize,
786                                   const void *in, size_t inlen);
787
788 /* The counterpart to gcry_cipher_encrypt.  */
789 gcry_error_t gcry_cipher_decrypt (gcry_cipher_hd_t h,
790                                   void *out, size_t outsize,
791                                   const void *in, size_t inlen);
792
793 /* Set KEY of length KEYLEN bytes for the cipher handle HD.  */
794 gcry_error_t gcry_cipher_setkey (gcry_cipher_hd_t hd,
795                                  const void *key, size_t keylen);
796
797
798 /* Set initialization vector IV of length IVLEN for the cipher handle HD. */
799 gcry_error_t gcry_cipher_setiv (gcry_cipher_hd_t hd,
800                                 const void *iv, size_t ivlen);
801
802
803 /* Reset the handle to the state after open.  */
804 #define gcry_cipher_reset(h)  gcry_cipher_ctl ((h), GCRYCTL_RESET, NULL, 0)
805
806 /* Perform the OpenPGP sync operation if this is enabled for the
807    cipher handle H. */
808 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, NULL, 0)
809
810 /* Enable or disable CTS in future calls to gcry_encrypt(). CBC mode only. */
811 #define gcry_cipher_cts(h,on)  gcry_cipher_ctl( (h), GCRYCTL_SET_CBC_CTS, \
812                                                                    NULL, on )
813
814 /* Set counter for CTR mode.  (CTR,CTRLEN) must denote a buffer of
815    block size length, or (NULL,0) to set the CTR to the all-zero block. */
816 gpg_error_t gcry_cipher_setctr (gcry_cipher_hd_t hd,
817                                 const void *ctr, size_t ctrlen);
818
819 /* Retrieve the key length in bytes used with algorithm A. */
820 size_t gcry_cipher_get_algo_keylen (int algo);
821
822 /* Retrieve the block length in bytes used with algorithm A. */
823 size_t gcry_cipher_get_algo_blklen (int algo);
824
825 /* Return 0 if the algorithm A is available for use. */
826 #define gcry_cipher_test_algo(a) \
827             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
828
829 \f
830 /************************************
831  *                                  *
832  *    Asymmetric Cipher Functions   *
833  *                                  *
834  ************************************/
835
836 /* The algorithms and their IDs we support. */
837 enum gcry_pk_algos
838   {
839     GCRY_PK_RSA   = 1,
840     GCRY_PK_RSA_E = 2,      /* (deprecated) */
841     GCRY_PK_RSA_S = 3,      /* (deprecated) */
842     GCRY_PK_ELG_E = 16,
843     GCRY_PK_DSA   = 17,
844     GCRY_PK_ELG   = 20,
845     GCRY_PK_ECDSA = 301,
846     GCRY_PK_ECDH  = 302
847   };
848
849 /* Flags describing usage capabilities of a PK algorithm. */
850 #define GCRY_PK_USAGE_SIGN 1   /* Good for signatures. */
851 #define GCRY_PK_USAGE_ENCR 2   /* Good for encryption. */
852 #define GCRY_PK_USAGE_CERT 4   /* Good to certify other keys. */
853 #define GCRY_PK_USAGE_AUTH 8   /* Good for authentication. */
854 #define GCRY_PK_USAGE_UNKN 128 /* Unknown usage flag. */
855
856 /* Encrypt the DATA using the public key PKEY and store the result as
857    a newly created S-expression at RESULT. */
858 gcry_error_t gcry_pk_encrypt (gcry_sexp_t *result,
859                               gcry_sexp_t data, gcry_sexp_t pkey);
860
861 /* Decrypt the DATA using the private key SKEY and store the result as
862    a newly created S-expression at RESULT. */
863 gcry_error_t gcry_pk_decrypt (gcry_sexp_t *result,
864                               gcry_sexp_t data, gcry_sexp_t skey);
865
866 /* Sign the DATA using the private key SKEY and store the result as
867    a newly created S-expression at RESULT. */
868 gcry_error_t gcry_pk_sign (gcry_sexp_t *result,
869                            gcry_sexp_t data, gcry_sexp_t skey);
870
871 /* Check the signature SIGVAL on DATA using the public key PKEY. */
872 gcry_error_t gcry_pk_verify (gcry_sexp_t sigval,
873                              gcry_sexp_t data, gcry_sexp_t pkey);
874
875 /* Check that private KEY is sane. */
876 gcry_error_t gcry_pk_testkey (gcry_sexp_t key);
877
878 /* Generate a new key pair according to the parameters given in
879    S_PARMS.  The new key pair is returned in as an S-expression in
880    R_KEY. */
881 gcry_error_t gcry_pk_genkey (gcry_sexp_t *r_key, gcry_sexp_t s_parms);
882
883 /* Catch all function for miscellaneous operations. */
884 gcry_error_t gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
885
886 /* Retrieve information about the public key algorithm ALGO. */
887 gcry_error_t gcry_pk_algo_info (int algo, int what,
888                                 void *buffer, size_t *nbytes);
889
890 /* Map the public key algorithm whose ID is contained in ALGORITHM to
891    a string representation of the algorithm name.  For unknown
892    algorithm IDs this functions returns "?". */
893 const char *gcry_pk_algo_name (int algorithm) _GCRY_GCC_ATTR_PURE;
894
895 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
896    the algorithm name is not known. */
897 int gcry_pk_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
898
899 /* Return what is commonly referred as the key length for the given
900    public or private KEY.  */
901 unsigned int gcry_pk_get_nbits (gcry_sexp_t key) _GCRY_GCC_ATTR_PURE;
902
903 /* Please note that keygrip is still experimental and should not be
904    used without contacting the author. */
905 unsigned char *gcry_pk_get_keygrip (gcry_sexp_t key, unsigned char *array);
906
907 /* Return the name of the curve matching KEY.  */
908 const char *gcry_pk_get_curve (gcry_sexp_t key, int iterator,
909                                unsigned int *r_nbits);
910
911 /* Return an S-expression with the parameters of the named ECC curve
912    NAME.  ALGO must be set to an ECC algorithm.  */
913 gcry_sexp_t gcry_pk_get_param (int algo, const char *name);
914
915 /* Return 0 if the public key algorithm A is available for use. */
916 #define gcry_pk_test_algo(a) \
917             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
918
919
920 \f
921
922 /************************************
923  *                                  *
924  *   Cryptograhic Hash Functions    *
925  *                                  *
926  ************************************/
927
928 /* Algorithm IDs for the hash functions we know about. Not all of them
929    are implemnted. */
930 enum gcry_md_algos
931   {
932     GCRY_MD_NONE    = 0,
933     GCRY_MD_MD5     = 1,
934     GCRY_MD_SHA1    = 2,
935     GCRY_MD_RMD160  = 3,
936     GCRY_MD_MD2     = 5,
937     GCRY_MD_TIGER   = 6,   /* TIGER/192 as used by gpg <= 1.3.2. */
938     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
939     GCRY_MD_SHA256  = 8,
940     GCRY_MD_SHA384  = 9,
941     GCRY_MD_SHA512  = 10,
942     GCRY_MD_SHA224  = 11,
943     GCRY_MD_MD4     = 301,
944     GCRY_MD_CRC32         = 302,
945     GCRY_MD_CRC32_RFC1510 = 303,
946     GCRY_MD_CRC24_RFC2440 = 304,
947     GCRY_MD_WHIRLPOOL = 305,
948     GCRY_MD_TIGER1  = 306, /* TIGER fixed.  */
949     GCRY_MD_TIGER2  = 307  /* TIGER2 variant.   */
950   };
951
952 /* Flags used with the open function.  */
953 enum gcry_md_flags
954   {
955     GCRY_MD_FLAG_SECURE = 1,  /* Allocate all buffers in "secure" memory.  */
956     GCRY_MD_FLAG_HMAC   = 2   /* Make an HMAC out of this algorithm.  */
957   };
958
959 /* (Forward declaration.)  */
960 struct gcry_md_context;
961
962 /* This object is used to hold a handle to a message digest object.
963    This structure is private - only to be used by the public gcry_md_*
964    macros.  */
965 typedef struct gcry_md_handle
966 {
967   /* Actual context.  */
968   struct gcry_md_context *ctx;
969
970   /* Buffer management.  */
971   int  bufpos;
972   int  bufsize;
973   unsigned char buf[1];
974 } *gcry_md_hd_t;
975
976 /* Compatibility types, do not use them.  */
977 #ifndef GCRYPT_NO_DEPRECATED
978 typedef struct gcry_md_handle *GCRY_MD_HD _GCRY_GCC_ATTR_DEPRECATED;
979 typedef struct gcry_md_handle *GcryMDHd _GCRY_GCC_ATTR_DEPRECATED;
980 #endif
981
982 /* Create a message digest object for algorithm ALGO.  FLAGS may be
983    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
984    given as 0 if the algorithms to be used are later set using
985    gcry_md_enable.  */
986 gcry_error_t gcry_md_open (gcry_md_hd_t *h, int algo, unsigned int flags);
987
988 /* Release the message digest object HD.  */
989 void gcry_md_close (gcry_md_hd_t hd);
990
991 /* Add the message digest algorithm ALGO to the digest object HD.  */
992 gcry_error_t gcry_md_enable (gcry_md_hd_t hd, int algo);
993
994 /* Create a new digest object as an exact copy of the object HD.  */
995 gcry_error_t gcry_md_copy (gcry_md_hd_t *bhd, gcry_md_hd_t ahd);
996
997 /* Reset the digest object HD to its initial state.  */
998 void gcry_md_reset (gcry_md_hd_t hd);
999
1000 /* Perform various operations on the digest object HD. */
1001 gcry_error_t gcry_md_ctl (gcry_md_hd_t hd, int cmd,
1002                           void *buffer, size_t buflen);
1003
1004 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
1005    it can update the digest values.  This is the actual hash
1006    function. */
1007 void gcry_md_write (gcry_md_hd_t hd, const void *buffer, size_t length);
1008
1009 /* Read out the final digest from HD return the digest value for
1010    algorithm ALGO. */
1011 unsigned char *gcry_md_read (gcry_md_hd_t hd, int algo);
1012
1013 /* Convenience function to calculate the hash from the data in BUFFER
1014    of size LENGTH using the algorithm ALGO avoiding the creating of a
1015    hash object.  The hash is returned in the caller provided buffer
1016    DIGEST which must be large enough to hold the digest of the given
1017    algorithm. */
1018 void gcry_md_hash_buffer (int algo, void *digest,
1019                           const void *buffer, size_t length);
1020
1021 /* Retrieve the algorithm used with HD.  This does not work reliable
1022    if more than one algorithm is enabled in HD. */
1023 int gcry_md_get_algo (gcry_md_hd_t hd);
1024
1025 /* Retrieve the length in bytes of the digest yielded by algorithm
1026    ALGO. */
1027 unsigned int gcry_md_get_algo_dlen (int algo);
1028
1029 /* Return true if the the algorithm ALGO is enabled in the digest
1030    object A. */
1031 int gcry_md_is_enabled (gcry_md_hd_t a, int algo);
1032
1033 /* Return true if the digest object A is allocated in "secure" memory. */
1034 int gcry_md_is_secure (gcry_md_hd_t a);
1035
1036 /* Retrieve various information about the object H.  */
1037 gcry_error_t gcry_md_info (gcry_md_hd_t h, int what, void *buffer,
1038                           size_t *nbytes);
1039
1040 /* Retrieve various information about the algorithm ALGO.  */
1041 gcry_error_t gcry_md_algo_info (int algo, int what, void *buffer,
1042                                size_t *nbytes);
1043
1044 /* Map the digest algorithm id ALGO to a string representation of the
1045    algorithm name.  For unknown algorithms this function returns
1046    "?". */
1047 const char *gcry_md_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
1048
1049 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
1050    the algorithm name is not known. */
1051 int gcry_md_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
1052
1053 /* For use with the HMAC feature, the set MAC key to the KEY of
1054    KEYLEN bytes. */
1055 gcry_error_t gcry_md_setkey (gcry_md_hd_t hd, const void *key, size_t keylen);
1056
1057 /* Start or stop debugging for digest handle HD; i.e. create a file
1058    named dbgmd-<n>.<suffix> while hashing.  If SUFFIX is NULL,
1059    debugging stops and the file will be closed. */
1060 void gcry_md_debug (gcry_md_hd_t hd, const char *suffix);
1061
1062
1063 /* Update the hash(s) of H with the character C.  This is a buffered
1064    version of the gcry_md_write function. */
1065 #define gcry_md_putc(h,c)  \
1066             do {                                          \
1067                 gcry_md_hd_t h__ = (h);                   \
1068                 if( (h__)->bufpos == (h__)->bufsize )     \
1069                     gcry_md_write( (h__), NULL, 0 );      \
1070                 (h__)->buf[(h__)->bufpos++] = (c) & 0xff; \
1071             } while(0)
1072
1073 /* Finalize the digest calculation.  This is not really needed because
1074    gcry_md_read() does this implicitly. */
1075 #define gcry_md_final(a) \
1076             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
1077
1078 /* Return 0 if the algorithm A is available for use. */
1079 #define gcry_md_test_algo(a) \
1080             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
1081
1082 /* Return an DER encoded ASN.1 OID for the algorithm A in buffer B. N
1083    must point to size_t variable with the available size of buffer B.
1084    After return it will receive the actual size of the returned
1085    OID. */
1086 #define gcry_md_get_asnoid(a,b,n) \
1087             gcry_md_algo_info((a), GCRYCTL_GET_ASNOID, (b), (n))
1088
1089
1090 \f
1091 /******************************
1092  *                            *
1093  *  Key Derivation Functions  *
1094  *                            *
1095  ******************************/
1096
1097 /* Algorithm IDs for the KDFs.  */
1098 enum gcry_kdf_algos
1099   {
1100     GCRY_KDF_NONE = 0,
1101     GCRY_KDF_SIMPLE_S2K = 16,
1102     GCRY_KDF_SALTED_S2K = 17,
1103     GCRY_KDF_ITERSALTED_S2K = 19,
1104     GCRY_KDF_PBKDF1 = 33,
1105     GCRY_KDF_PBKDF2 = 34
1106   };
1107
1108 /* Derive a key from a passphrase.  */
1109 gpg_error_t gcry_kdf_derive (const void *passphrase, size_t passphraselen,
1110                              int algo, int subalgo,
1111                              const void *salt, size_t saltlen,
1112                              unsigned long iterations,
1113                              size_t keysize, void *keybuffer);
1114
1115
1116
1117 \f
1118 /************************************
1119  *                                  *
1120  *   Random Generating Functions    *
1121  *                                  *
1122  ************************************/
1123
1124 /* The type of the random number generator.  */
1125 enum gcry_rng_types
1126   {
1127     GCRY_RNG_TYPE_STANDARD   = 1, /* The default CSPRNG generator.  */
1128     GCRY_RNG_TYPE_FIPS       = 2, /* The FIPS X9.31 AES generator.  */
1129     GCRY_RNG_TYPE_SYSTEM     = 3  /* The system's native generator. */
1130   };
1131
1132 /* The possible values for the random quality.  The rule of thumb is
1133    to use STRONG for session keys and VERY_STRONG for key material.
1134    WEAK is usually an alias for STRONG and should not be used anymore
1135    (except with gcry_mpi_randomize); use gcry_create_nonce instead. */
1136 typedef enum gcry_random_level
1137   {
1138     GCRY_WEAK_RANDOM = 0,
1139     GCRY_STRONG_RANDOM = 1,
1140     GCRY_VERY_STRONG_RANDOM = 2
1141   }
1142 gcry_random_level_t;
1143
1144 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
1145    quality LEVEL. */
1146 void gcry_randomize (void *buffer, size_t length,
1147                      enum gcry_random_level level);
1148
1149 /* Add the external random from BUFFER with LENGTH bytes into the
1150    pool. QUALITY should either be -1 for unknown or in the range of 0
1151    to 100 */
1152 gcry_error_t gcry_random_add_bytes (const void *buffer, size_t length,
1153                                     int quality);
1154
1155 /* If random numbers are used in an application, this macro should be
1156    called from time to time so that new stuff gets added to the
1157    internal pool of the RNG.  */
1158 #define gcry_fast_random_poll()  gcry_control (GCRYCTL_FAST_POLL, NULL)
1159
1160
1161 /* Return NBYTES of allocated random using a random numbers of quality
1162    LEVEL. */
1163 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level)
1164                          _GCRY_GCC_ATTR_MALLOC;
1165
1166 /* Return NBYTES of allocated random using a random numbers of quality
1167    LEVEL.  The random numbers are created returned in "secure"
1168    memory. */
1169 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level)
1170                                 _GCRY_GCC_ATTR_MALLOC;
1171
1172
1173 /* Set the big integer W to a random value of NBITS using a random
1174    generator with quality LEVEL.  Note that by using a level of
1175    GCRY_WEAK_RANDOM gcry_create_nonce is used internally. */
1176 void gcry_mpi_randomize (gcry_mpi_t w,
1177                          unsigned int nbits, enum gcry_random_level level);
1178
1179
1180 /* Create an unpredicable nonce of LENGTH bytes in BUFFER. */
1181 void gcry_create_nonce (void *buffer, size_t length);
1182
1183
1184
1185
1186 \f
1187 /*******************************/
1188 /*                             */
1189 /*    Prime Number Functions   */
1190 /*                             */
1191 /*******************************/
1192
1193 /* Mode values passed to a gcry_prime_check_func_t. */
1194 #define GCRY_PRIME_CHECK_AT_FINISH      0
1195 #define GCRY_PRIME_CHECK_AT_GOT_PRIME   1
1196 #define GCRY_PRIME_CHECK_AT_MAYBE_PRIME 2
1197
1198 /* The function should return 1 if the operation shall continue, 0 to
1199    reject the prime candidate. */
1200 typedef int (*gcry_prime_check_func_t) (void *arg, int mode,
1201                                         gcry_mpi_t candidate);
1202
1203 /* Flags for gcry_prime_generate():  */
1204
1205 /* Allocate prime numbers and factors in secure memory.  */
1206 #define GCRY_PRIME_FLAG_SECRET         (1 << 0)
1207
1208 /* Make sure that at least one prime factor is of size
1209    `FACTOR_BITS'.  */
1210 #define GCRY_PRIME_FLAG_SPECIAL_FACTOR (1 << 1)
1211
1212 /* Generate a new prime number of PRIME_BITS bits and store it in
1213    PRIME.  If FACTOR_BITS is non-zero, one of the prime factors of
1214    (prime - 1) / 2 must be FACTOR_BITS bits long.  If FACTORS is
1215    non-zero, allocate a new, NULL-terminated array holding the prime
1216    factors and store it in FACTORS.  FLAGS might be used to influence
1217    the prime number generation process.  */
1218 gcry_error_t gcry_prime_generate (gcry_mpi_t *prime,
1219                                   unsigned int prime_bits,
1220                                   unsigned int factor_bits,
1221                                   gcry_mpi_t **factors,
1222                                   gcry_prime_check_func_t cb_func,
1223                                   void *cb_arg,
1224                                   gcry_random_level_t random_level,
1225                                   unsigned int flags);
1226
1227 /* Find a generator for PRIME where the factorization of (prime-1) is
1228    in the NULL terminated array FACTORS. Return the generator as a
1229    newly allocated MPI in R_G.  If START_G is not NULL, use this as
1230    teh start for the search. */
1231 gcry_error_t gcry_prime_group_generator (gcry_mpi_t *r_g,
1232                                          gcry_mpi_t prime,
1233                                          gcry_mpi_t *factors,
1234                                          gcry_mpi_t start_g);
1235
1236
1237 /* Convenience function to release the FACTORS array. */
1238 void gcry_prime_release_factors (gcry_mpi_t *factors);
1239
1240
1241 /* Check wether the number X is prime.  */
1242 gcry_error_t gcry_prime_check (gcry_mpi_t x, unsigned int flags);
1243
1244
1245 \f
1246 /************************************
1247  *                                  *
1248  *     Miscellaneous Stuff          *
1249  *                                  *
1250  ************************************/
1251
1252 /* Log levels used by the internal logging facility. */
1253 enum gcry_log_levels
1254   {
1255     GCRY_LOG_CONT   = 0,    /* (Continue the last log line.) */
1256     GCRY_LOG_INFO   = 10,
1257     GCRY_LOG_WARN   = 20,
1258     GCRY_LOG_ERROR  = 30,
1259     GCRY_LOG_FATAL  = 40,
1260     GCRY_LOG_BUG    = 50,
1261     GCRY_LOG_DEBUG  = 100
1262   };
1263
1264 /* Type for progress handlers.  */
1265 typedef void (*gcry_handler_progress_t) (void *, const char *, int, int, int);
1266
1267 /* Type for memory allocation handlers.  */
1268 typedef void *(*gcry_handler_alloc_t) (size_t n);
1269
1270 /* Type for secure memory check handlers.  */
1271 typedef int (*gcry_handler_secure_check_t) (const void *);
1272
1273 /* Type for memory reallocation handlers.  */
1274 typedef void *(*gcry_handler_realloc_t) (void *p, size_t n);
1275
1276 /* Type for memory free handlers.  */
1277 typedef void (*gcry_handler_free_t) (void *);
1278
1279 /* Type for out-of-memory handlers.  */
1280 typedef int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int);
1281
1282 /* Type for fatal error handlers.  */
1283 typedef void (*gcry_handler_error_t) (void *, int, const char *);
1284
1285 /* Type for logging handlers.  */
1286 typedef void (*gcry_handler_log_t) (void *, int, const char *, va_list);
1287
1288 /* Certain operations can provide progress information.  This function
1289    is used to register a handler for retrieving these information. */
1290 void gcry_set_progress_handler (gcry_handler_progress_t cb, void *cb_data);
1291
1292
1293 /* Register a custom memory allocation functions. */
1294 void gcry_set_allocation_handler (
1295                              gcry_handler_alloc_t func_alloc,
1296                              gcry_handler_alloc_t func_alloc_secure,
1297                              gcry_handler_secure_check_t func_secure_check,
1298                              gcry_handler_realloc_t func_realloc,
1299                              gcry_handler_free_t func_free);
1300
1301 /* Register a function used instead of the internal out of memory
1302    handler. */
1303 void gcry_set_outofcore_handler (gcry_handler_no_mem_t h, void *opaque);
1304
1305 /* Register a function used instead of the internal fatal error
1306    handler. */
1307 void gcry_set_fatalerror_handler (gcry_handler_error_t fnc, void *opaque);
1308
1309 /* Register a function used instead of the internal logging
1310    facility. */
1311 void gcry_set_log_handler (gcry_handler_log_t f, void *opaque);
1312
1313 /* Reserved for future use. */
1314 void gcry_set_gettext_handler (const char *(*f)(const char*));
1315
1316 /* Libgcrypt uses its own memory allocation.  It is important to use
1317    gcry_free () to release memory allocated by libgcrypt. */
1318 void *gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1319 void *gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1320 void *gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1321 void *gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1322 void *gcry_realloc (void *a, size_t n);
1323 char *gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
1324 void *gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1325 void *gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1326 void *gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1327 void *gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1328 void *gcry_xrealloc (void *a, size_t n);
1329 char *gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
1330 void  gcry_free (void *a);
1331
1332 /* Return true if A is allocated in "secure" memory. */
1333 int gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
1334
1335 /* Return true if Libgcrypt is in FIPS mode.  */
1336 #define gcry_fips_mode_active()  !!gcry_control (GCRYCTL_FIPS_MODE_P, 0)
1337
1338
1339 #if 0 /* (Keep Emacsens' auto-indent happy.) */
1340 {
1341 #endif
1342 #ifdef __cplusplus
1343 }
1344 #endif
1345 #endif /* _GCRYPT_H */
1346 /*
1347 @emacs_local_vars_begin@
1348 @emacs_local_vars_read_only@
1349 @emacs_local_vars_end@
1350 */