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