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