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