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