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