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