2003-06-18 Moritz Schulte <moritz@g10code.com>
[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.13-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 /* The data object used to hold a multi precision integer.  */
89 struct gcry_mpi;
90 typedef struct gcry_mpi *gcry_mpi_t;
91
92 typedef struct gcry_mpi *GCRY_MPI _GCRY_GCC_ATTR_DEPRECATED;
93 typedef struct gcry_mpi *GcryMPI _GCRY_GCC_ATTR_DEPRECATED;
94
95 \f
96
97 /* Check that the library fulfills the version requirement.  */
98 const char *gcry_check_version (const char *req_version);
99
100 #if 0
101 /* FIXME.  */
102 /* Map an error number to a string. */
103 const char *gcry_strerror (gpg_error_t ec);
104 #endif
105
106 /* Codes for function dispatchers.  */
107
108 /* Codes used with the gcry_control function. */
109 enum gcry_ctl_cmds 
110   {
111     GCRYCTL_SET_KEY  = 1,
112     GCRYCTL_SET_IV   = 2,
113     GCRYCTL_CFB_SYNC = 3,
114     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
115     GCRYCTL_FINALIZE = 5,
116     GCRYCTL_GET_KEYLEN = 6,
117     GCRYCTL_GET_BLKLEN = 7,
118     GCRYCTL_TEST_ALGO = 8,
119     GCRYCTL_IS_SECURE = 9,
120     GCRYCTL_GET_ASNOID = 10,
121     GCRYCTL_ENABLE_ALGO = 11,
122     GCRYCTL_DISABLE_ALGO = 12,
123     GCRYCTL_DUMP_RANDOM_STATS = 13,
124     GCRYCTL_DUMP_SECMEM_STATS = 14,
125     GCRYCTL_GET_ALGO_NPKEY    = 15,
126     GCRYCTL_GET_ALGO_NSKEY    = 16,
127     GCRYCTL_GET_ALGO_NSIGN    = 17,
128     GCRYCTL_GET_ALGO_NENCR    = 18,
129     GCRYCTL_SET_VERBOSITY     = 19,
130     GCRYCTL_SET_DEBUG_FLAGS   = 20,
131     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
132     GCRYCTL_USE_SECURE_RNDPOOL= 22,
133     GCRYCTL_DUMP_MEMORY_STATS = 23,
134     GCRYCTL_INIT_SECMEM       = 24,
135     GCRYCTL_TERM_SECMEM       = 25,
136     GCRYCTL_DISABLE_SECMEM_WARN = 27,
137     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
138     GCRYCTL_RESUME_SECMEM_WARN  = 29,
139     GCRYCTL_DROP_PRIVS          = 30,
140     GCRYCTL_ENABLE_M_GUARD      = 31,
141     GCRYCTL_START_DUMP          = 32,
142     GCRYCTL_STOP_DUMP           = 33,
143     GCRYCTL_GET_ALGO_USAGE      = 34,
144     GCRYCTL_IS_ALGO_ENABLED     = 35,
145     GCRYCTL_DISABLE_INTERNAL_LOCKING = 36,
146     GCRYCTL_DISABLE_SECMEM      = 37,
147     GCRYCTL_INITIALIZATION_FINISHED = 38,
148     GCRYCTL_INITIALIZATION_FINISHED_P = 39,
149     GCRYCTL_ANY_INITIALIZATION_P = 40,
150     GCRYCTL_SET_CBC_CTS = 41,
151     GCRYCTL_SET_CBC_MAC = 42,
152     GCRYCTL_SET_CTR = 43,
153     GCRYCTL_ENABLE_QUICK_RANDOM = 44,
154   };
155
156 /* Perform various operations defined by CMD. */
157 gpg_error_t gcry_control (enum gcry_ctl_cmds CMD, ...);
158
159
160 \f
161 /* S-expression management. */ 
162
163 /* The object to represent an S-expression as used with the public key
164    functions.  */
165 struct gcry_sexp;
166 typedef struct gcry_sexp *gcry_sexp_t;
167
168 typedef struct gcry_sexp *GCRY_SEXP _GCRY_GCC_ATTR_DEPRECATED;
169 typedef struct gcry_sexp *GcrySexp _GCRY_GCC_ATTR_DEPRECATED;
170
171 /* The possible values for the S-expression format. */
172 enum gcry_sexp_format
173   {
174     GCRYSEXP_FMT_DEFAULT   = 0,
175     GCRYSEXP_FMT_CANON     = 1,
176     GCRYSEXP_FMT_BASE64    = 2,
177     GCRYSEXP_FMT_ADVANCED  = 3
178   };
179
180 /* Create an new S-expression object from BUFFER of size LENGTH and
181    return it in RETSEXP.  With AUTODETECT set to 0 the data in BUFFER
182    is expected to be in canonized format.  */
183 gpg_error_t gcry_sexp_new (gcry_sexp_t *retsexp, const void *buffer, size_t length,
184                            int autodetect);
185
186  /* Same as gcry_sexp_new but allows to pass a FREEFNC which has the
187    effect to transfer ownership of BUFFER to the created object.  */
188 gpg_error_t gcry_sexp_create (gcry_sexp_t *retsexp, void *buffer, size_t length,
189                               int autodetect, void (*freefnc) (void *));
190
191 /* Scan BUFFER and return a new S-expression object in RETSEXP.  This
192    function expects a printf like string in BUFFER.  */
193 gpg_error_t gcry_sexp_sscan (gcry_sexp_t *retsexp, size_t *erroff,
194                              const char *buffer, size_t length);
195
196 /* Same as gcry_sexp_sscan but expects a string in FORMAT and can thus
197    only be used for certain encodings.  */
198 gpg_error_t gcry_sexp_build (gcry_sexp_t *retsexp, size_t *erroff,
199                              const char *format, ...);
200
201 /* Like gcry_sexp_build, but uses an array instead of variable
202    function arguments.  */
203 gpg_error_t gcry_sexp_build_array (gcry_sexp_t *retsexp, size_t *erroff,
204                                    const char *format, void **arg_list);
205
206 /* Release the S-expression object SEXP */
207 void gcry_sexp_release (gcry_sexp_t sexp);
208
209 /* Calculate the length of an canonized S-expresion in BUFFER and
210    check for a valid encoding. */
211 size_t gcry_sexp_canon_len (const unsigned char *buffer, size_t length, 
212                             size_t *erroff, gpg_error_t *errcode);
213
214 /* Copies the S-expression object SEXP into BUFFER using the format
215    specified in MODE.  */
216 size_t gcry_sexp_sprint (gcry_sexp_t sexp, int mode, char *buffer,
217                          size_t maxlength);
218
219 /* Dumps the S-expression object A in a aformat suitable for debugging
220    to Libgcrypt's logging stream.  */
221 void gcry_sexp_dump (const gcry_sexp_t a);
222
223 gcry_sexp_t gcry_sexp_cons (const gcry_sexp_t a, const gcry_sexp_t b);
224 gcry_sexp_t gcry_sexp_alist (const gcry_sexp_t *array);
225 gcry_sexp_t gcry_sexp_vlist (const gcry_sexp_t a, ...);
226 gcry_sexp_t gcry_sexp_append (const gcry_sexp_t a, const gcry_sexp_t n);
227 gcry_sexp_t gcry_sexp_prepend (const gcry_sexp_t a, const gcry_sexp_t n);
228
229 /* Scan the S-expression for a sublist with a type (the car of the
230    list) matching the string TOKEN.  If TOKLEN is not 0, the token is
231    assumed to be raw memory of this length.  The function returns a
232    newly allocated S-expression consisting of the found sublist or
233    `NULL' when not found.  */
234 gcry_sexp_t gcry_sexp_find_token (gcry_sexp_t list,
235                                 const char *tok, size_t toklen);
236 /* Return the length of the LIST.  For a valid S-expression this
237    should be at least 1.  */
238 int gcry_sexp_length (const gcry_sexp_t list);
239
240 /* Create and return a new S-expression from the element with index
241    NUMBER in LIST.  Note that the first element has the index 0.  If
242    there is no such element, `NULL' is returned.  */
243 gcry_sexp_t gcry_sexp_nth (const gcry_sexp_t list, int number);
244
245 /* Create and return a new S-expression from the first element in
246    LIST; this called the "type" and should always exist and be a
247    string. `NULL' is returned in case of a problem.  */
248 gcry_sexp_t gcry_sexp_car (const gcry_sexp_t list);
249
250 /* Create and return a new list form all elements except for the first
251    one.  Note, that this function may return an invalid S-expression
252    because it is not guaranteed, that the type exists and is a string.
253    However, for parsing a complex S-expression it might be useful for
254    intermediate lists.  Returns `NULL' on error.  */
255 gcry_sexp_t gcry_sexp_cdr (const gcry_sexp_t list);
256
257 gcry_sexp_t gcry_sexp_cadr (const gcry_sexp_t list);
258
259
260 /* This function is used to get data from a LIST.  A pointer to the
261    actual data with index NUMBER is returned and the length of this
262    data will be stored to DATALEN.  If there is no data at the given
263    index or the index represents another list, `NULL' is returned.
264    *Note:* The returned pointer is valid as long as LIST is not
265    modified or released.  */
266 const char *gcry_sexp_nth_data (const gcry_sexp_t list, int number,
267                                 size_t *datalen);
268
269 /* This function is used to get and convert data from a LIST. This
270    data is assumed to be an MPI stored in the format described by
271    MPIFMT and returned as a standard Libgcrypt MPI.  The caller must
272    release this returned value using `gcry_mpi_release'.  If there is
273    no data at the given index, the index represents a list or the
274    value can't be converted to an MPI, `NULL' is returned.  */
275 gcry_mpi_t gcry_sexp_nth_mpi (gcry_sexp_t list, int number, int mpifmt);
276
277
278 \f
279 /*******************************************
280  *                                         *
281  *  multi precision integer functions      *
282  *                                         *
283  *******************************************/
284
285 /* Different formats of external big integer representation. */
286 enum gcry_mpi_format 
287   {
288     GCRYMPI_FMT_NONE= 0,
289     GCRYMPI_FMT_STD = 1,    /* twos complement stored without length */
290     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP (only defined as unsigned)*/
291     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (same as 1 but with length)*/
292     GCRYMPI_FMT_HEX = 4,    /* hex format */
293     GCRYMPI_FMT_USG = 5     /* like STD but this is an unsigned one */
294   };
295
296 /* Flags used for creating big integers.  */
297 enum gcry_mpi_flag 
298   {
299     GCRYMPI_FLAG_SECURE = 1,  /* Allocate the number in "secure" memory. */
300     GCRYMPI_FLAG_OPAQUE = 2   /* The number is not a real one but just a
301                                way to store some bytes.  This is
302                                useful for encrypted big integers. */
303   };
304
305
306 /* Allocate a new big integer object, initialize it with 0 and
307    initially allocate memory for a number of at least NBITS. */
308 gcry_mpi_t gcry_mpi_new (unsigned int nbits);
309
310 /* Same as gcry_mpi_new() but allocate in "secure" memory. */
311 gcry_mpi_t gcry_mpi_snew (unsigned int nbits);
312
313 /* Release the number A and free all associated resources. */
314 void gcry_mpi_release (gcry_mpi_t a);
315
316 /* Create a new number with the same value as A. */
317 gcry_mpi_t gcry_mpi_copy (const gcry_mpi_t a);
318
319 /* Store the big integer value U in W. */
320 gcry_mpi_t gcry_mpi_set (gcry_mpi_t w, const gcry_mpi_t u);
321
322 /* Store the unsigned integer value U in W. */
323 gcry_mpi_t gcry_mpi_set_ui (gcry_mpi_t w, unsigned long u);
324
325 /* Swap the values of A and B. */
326 void gcry_mpi_swap (gcry_mpi_t a, gcry_mpi_t b);
327
328 /* Compare the big integer number U and V returning 0 for equality, a
329    positive value for U > V and a negative for U < V. */
330 int gcry_mpi_cmp (const gcry_mpi_t u, const gcry_mpi_t v);
331
332 /* Compare the big integer number U with the unsigned integer V
333    returning 0 for equality, a positive value for U > V and a negative
334    for U < V. */
335 int gcry_mpi_cmp_ui (const gcry_mpi_t u, unsigned long v);
336
337 /* Convert the external representation of an integer stored in BUFFER
338    with a size of (*NBYTES) in a newly create MPI returned in RET_MPI.
339    For certain formats a length is not required and may be passed as
340    NULL.  After a successful operation NBYTES received the number of
341    bytes actually scanned. */
342 gpg_error_t gcry_mpi_scan (gcry_mpi_t *ret_mpi, enum gcry_mpi_format format,
343                    const char *buffer, size_t *nbytes);
344
345 /* Convert the big integer A into the external representation
346    described by FORMAT and store it in the provided BUFFER which has
347    the size (*NBYTES).  NBYTES receives the actual length of the
348    external representation. */
349 gpg_error_t gcry_mpi_print (enum gcry_mpi_format format,
350                             char *buffer, size_t *nbytes, const gcry_mpi_t a);
351
352 /* Convert the big integer A int the external representation desribed
353    by FORMAT and store it in a newly allocated buffer which address
354    will be put into BUFFER.  NBYTES receives the actual lengths of the
355    external representation. */
356 gpg_error_t gcry_mpi_aprint (enum gcry_mpi_format format,
357                              void **buffer, size_t *nbytes, const gcry_mpi_t a);
358
359 /* W = U + V.  */
360 void gcry_mpi_add (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
361
362 /* W = U + V.  V is an unsigned integer. */
363 void gcry_mpi_add_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v);
364
365 /* W = U + V mod M. */
366 void gcry_mpi_addm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
367
368 /* W = U - V. */
369 void gcry_mpi_sub (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
370
371 /* W = U - V.  V is an unsigned integer. */
372 void gcry_mpi_sub_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
373
374 /* W = U - V mod M */
375 void gcry_mpi_subm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
376
377 /* W = U * V. */
378 void gcry_mpi_mul (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v);
379
380 /* W = U * V.  V is an unsigned integer. */
381 void gcry_mpi_mul_ui (gcry_mpi_t w, gcry_mpi_t u, unsigned long v );
382
383 /* W = U * V mod M. */
384 void gcry_mpi_mulm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, gcry_mpi_t m);
385
386 /* W = U * (2 ^ CNT). */
387 void gcry_mpi_mul_2exp (gcry_mpi_t w, gcry_mpi_t u, unsigned long cnt);
388
389 /* Q = DIVIDEND / DIVISOR, R = DIVIDEND % DIVISOR,
390    Q or R may be passed as NULL.  ROUND should be negative or 0. */
391 void gcry_mpi_div (gcry_mpi_t q, gcry_mpi_t r,
392                    gcry_mpi_t dividend, gcry_mpi_t divisor, int round);
393
394 /* R = DIVIDEND % DIVISOR */
395 void gcry_mpi_mod (gcry_mpi_t r, gcry_mpi_t dividend, gcry_mpi_t divisor);
396
397 /* W = B ^ E mod M. */
398 void gcry_mpi_powm (gcry_mpi_t w,
399                     const gcry_mpi_t b, const gcry_mpi_t e, const gcry_mpi_t m);
400
401 /* Set G to the greatest common divisor of A and B.  
402    Return true if the G is 1. */
403 int gcry_mpi_gcd (gcry_mpi_t g, gcry_mpi_t a, gcry_mpi_t b);
404
405 /* Set X to the multiplicative inverse of A mod M.
406    Return true if the value exists. */
407 int gcry_mpi_invm (gcry_mpi_t x, gcry_mpi_t a, gcry_mpi_t m);
408
409
410 /* Return the number of bits required to represent A. */
411 unsigned int gcry_mpi_get_nbits (gcry_mpi_t a);
412
413 /* Return true when bit number N (counting from 0) is set in A. */
414 int      gcry_mpi_test_bit (gcry_mpi_t a, unsigned int n);
415
416 /* Set bit number N in A. */
417 void     gcry_mpi_set_bit (gcry_mpi_t a, unsigned int n);
418
419 /* Clear bit number N in A. */
420 void     gcry_mpi_clear_bit (gcry_mpi_t a, unsigned int n);
421
422 /* Set bit number N in A and clear all bits greater than N. */
423 void     gcry_mpi_set_highbit (gcry_mpi_t a, unsigned int n);
424
425 /* Clear bit number N in A and all bits greater than N. */
426 void     gcry_mpi_clear_highbit (gcry_mpi_t a, unsigned int n);
427
428 /* Shift the value of A by N bits to the right and store the result in X. */
429 void     gcry_mpi_rshift (gcry_mpi_t x, gcry_mpi_t a, unsigned int n);
430
431 /* Store NBITS of the value P points to in A and mark A as an opaque
432    value. */
433 gcry_mpi_t gcry_mpi_set_opaque (gcry_mpi_t a, void *p, unsigned int nbits);
434
435 /* Return a pointer to an opaque value stored in A and return its size
436    in NBITS.  Note that the returned pointer is still owned by A and
437    that the function should never be used for an non-opaque MPI. */
438 void *gcry_mpi_get_opaque (gcry_mpi_t a, unsigned int *nbits);
439
440 /* Set the FLAG for the big integer A.  Currently only the flag
441    GCRYMPI_FLAG_SECURE is allowed to convert A into an big intger
442    stored in "secure" memory. */
443 void gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
444
445 /* Clear FLAG for the big integer A.  Note that this function is
446    currently useless as no flags are allowed. */
447 void gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
448
449 /* Return true when the FLAG is set for A. */
450 int gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag);
451
452 /* Unless the GCRYPT_NO_MPI_MACROS is used, provide a couple of
453    convenience macors for the big integer functions. */
454 #ifndef GCRYPT_NO_MPI_MACROS
455 #define mpi_new(n)          gcry_mpi_new( (n) )
456 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
457 #define mpi_release(a)      \
458   do \
459     { \
460       gcry_mpi_release ((a)); \
461       (a) = NULL; \
462     } \
463   while (0)
464
465 #define mpi_copy( a )       gcry_mpi_copy( (a) )
466 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
467 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
468 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
469 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
470
471 #define mpi_add_ui(w,u,v)   gcry_mpi_add_ui((w),(u),(v))
472 #define mpi_add(w,u,v)      gcry_mpi_add ((w),(u),(v))
473 #define mpi_addm(w,u,v,m)   gcry_mpi_addm ((w),(u),(v),(m))
474 #define mpi_sub_ui(w,u,v)   gcry_mpi_sub_ui ((w),(u),(v))
475 #define mpi_sub(w,u,v)      gcry_mpi_sub ((w),(u),(v))
476 #define mpi_subm(w,u,v,m)   gcry_mpi_subm ((w),(u),(v),(m))
477 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
478 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
479 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
480 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
481 #define mpi_powm(w,b,e,m)   gcry_mpi_powm ( (w), (b), (e), (m) )
482 #define mpi_tdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), 0)
483 #define mpi_fdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), -1)
484 #define mpi_mod(r,a,m)      gcry_mpi_mod ((r), (a), (m))
485 #define mpi_gcd(g,a,b)      gcry_mpi_gcd ( (g), (a), (b) )
486 #define mpi_invm(g,a,b)     gcry_mpi_invm ( (g), (a), (b) )
487
488 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
489 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
490 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
491 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
492 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
493 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
494 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
495
496 #define mpi_set_opaque(a,b,c) gcry_mpi_set_opaque( (a), (b), (c) )
497 #define mpi_get_opaque(a,b)   gcry_mpi_get_opaque( (a), (b) )
498 #endif /* GCRYPT_NO_MPI_MACROS */
499
500
501 \f
502 /************************************
503  *                                  *
504  *   symmetric cipher functions     *
505  *                                  *
506  ************************************/
507
508 /* The data object used to hold a handle to an encryption object.  */
509 struct gcry_cipher_handle;
510 typedef struct gcry_cipher_handle *gcry_cipher_hd_t;
511
512 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD _GCRY_GCC_ATTR_DEPRECATED;
513 typedef struct gcry_cipher_handle *GcryCipherHd _GCRY_GCC_ATTR_DEPRECATED;
514
515 /* All symmetric encryption algorithms are identified by their IDs.
516    More IDs may be registered at runtime. */
517 enum gcry_cipher_algos
518   {
519     GCRY_CIPHER_NONE        = 0,
520     GCRY_CIPHER_IDEA        = 1,
521     GCRY_CIPHER_3DES        = 2,
522     GCRY_CIPHER_CAST5       = 3,
523     GCRY_CIPHER_BLOWFISH    = 4,
524     GCRY_CIPHER_SAFER_SK128 = 5,
525     GCRY_CIPHER_DES_SK      = 6,
526     GCRY_CIPHER_AES         = 7,
527     GCRY_CIPHER_AES192      = 8,
528     GCRY_CIPHER_AES256      = 9,
529     GCRY_CIPHER_TWOFISH     = 10,
530
531     /* other cipher numbers are above 300 for OpenPGP reasons. */
532     GCRY_CIPHER_ARCFOUR     = 301,  /* fully compatible with RSA's RC4 (tm). */
533     GCRY_CIPHER_DES         = 302,  /* Yes, this is single key 56 bit DES. */
534     GCRY_CIPHER_SERPENT128  = 303,
535     GCRY_CIPHER_SERPENT192  = 304,
536     GCRY_CIPHER_SERPENT256  = 305,
537   };
538
539 /* The Rijndael algorithm is basically AES, so provide some macros. */
540 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES    
541 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES    
542 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128 
543 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192 
544 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256 
545
546 /* The supported encryption modes.  Note that not all of them are
547    supported for each algorithm. */
548 enum gcry_cipher_modes 
549   {
550     GCRY_CIPHER_MODE_NONE   = 0,  /* Not yet specified. */
551     GCRY_CIPHER_MODE_ECB    = 1,  /* Electronic codebook. */
552     GCRY_CIPHER_MODE_CFB    = 2,  /* Cipher feedback. */
553     GCRY_CIPHER_MODE_CBC    = 3,  /* Cipher block chaining. */
554     GCRY_CIPHER_MODE_STREAM = 4,  /* Used with stream ciphers. */
555     GCRY_CIPHER_MODE_OFB    = 5,  /* Outer feedback. */
556     GCRY_CIPHER_MODE_CTR    = 6   /* Counter. */
557   };
558
559 /* Flags used with the open function. */ 
560 enum gcry_cipher_flags
561   {
562     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
563     GCRY_CIPHER_ENABLE_SYNC = 2,  /* Enable CFB sync mode. */
564     GCRY_CIPHER_CBC_CTS     = 4,  /* Enable CBC cipher text stealing (CTS). */
565     GCRY_CIPHER_CBC_MAC     = 8   /* Enable CBC message auth. code (MAC). */
566   };
567
568
569 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
570    be given as an bitwise OR of the gcry_cipher_flags values. */
571 gpg_error_t gcry_cipher_open (gcry_cipher_hd_t *handle,
572                               int algo, int mode, unsigned int flags);
573
574 /* Close the cioher handle H and release all resource. */
575 void gcry_cipher_close (gcry_cipher_hd_t h);
576
577 /* Perform various operations on the cipher object H. */
578 gpg_error_t gcry_cipher_ctl (gcry_cipher_hd_t h, int cmd, void *buffer,
579                              size_t buflen);
580
581 /* Retrieve various information about the cipher object H. */
582 gpg_error_t gcry_cipher_info (gcry_cipher_hd_t h, int what, void *buffer,
583                               size_t *nbytes);
584
585 /* Retrieve various information about the cipher algorithm ALGO. */
586 gpg_error_t gcry_cipher_algo_info (int algo, int what, void *buffer,
587                                    size_t *nbytes);
588
589 /* Map the cipher algorithm id ALGO to a string representation of that
590    algorithm name.  For unknown algorithms this functions returns an
591    empty string. */
592 const char *gcry_cipher_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
593
594 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
595    the algorithm name is not known. */
596 int gcry_cipher_map_name (const char *name) _GCRY_GCC_ATTR_PURE;
597
598 /* Given an ASN.1 object identifier in standard IETF dotted decimal
599    format in STING, return the encryption mode associated with that
600    OID or 0 if not known or applicable. */
601 int gcry_cipher_mode_from_oid (const char *string) _GCRY_GCC_ATTR_PURE;
602
603 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
604    into the buffer OUT which has an allocated length of OUTSIZE.  For
605    most algorithms it is possible to pass NULL for in and 0 for INLEN
606    and do a in-place decryption of the data provided in OUT.  */
607 gpg_error_t gcry_cipher_encrypt (gcry_cipher_hd_t h,
608                                  unsigned char *out, size_t outsize,
609                                  const unsigned char *in, size_t inlen);
610
611 /* The counterpart to gcry_cipher_encrypt.  */
612 gpg_error_t gcry_cipher_decrypt (gcry_cipher_hd_t h,
613                                  unsigned char *out, size_t outsize,
614                                  const unsigned char *in, size_t inlen);
615
616 /* Set key K of length L for the cipher handle H.  (We have to cast
617    away a const char* here - this catch-all ctl function was probably
618    not the best choice) */
619 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
620                                                          (char*)(k), (l) )
621
622 /* Set initialization vector K of length L for the cipher handle H. */
623 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
624                                                          (char*)(k), (l) )
625
626 /* Reset the handle to the state after open.  */
627 #define gcry_cipher_reset(h)  gcry_cipher_ctl ((h), GCRYCTL_RESET, NULL, 0)
628
629 /* Perform the the OpenPGP sync operation if this is enabled for the
630    cipher handle H. */
631 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
632                                                                    NULL, 0 )
633
634 /* Enable or disable CTS in future calls to gcry_encrypt(). CBC mode only. */
635 #define gcry_cipher_cts(h,on)  gcry_cipher_ctl( (h), GCRYCTL_SET_CBC_CTS, \
636                                                                    NULL, on )
637
638 /* Set counter for CTR mode.  (K,L) must denote a buffer of block size
639    length, or (NULL,0) to set the CTR to the all-zero block. */
640 #define gcry_cipher_setctr(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_CTR, \
641                                                     (char*)(k), (l) )
642
643 /* Retrieved the key length used with algorithm A. */
644 #define gcry_cipher_get_algo_keylen(a, b) \
645             gcry_cipher_algo_info( (a), GCRYCTL_GET_KEYLEN, NULL, b)
646
647 /* Retrieve the block length used with algorithm A. */
648 #define gcry_cipher_get_algo_blklen(a, b) \
649             gcry_cipher_algo_info( (a), GCRYCTL_GET_BLKLEN, NULL, b)
650
651 /* Return 0 if the algorithm A is available for use. */
652 #define gcry_cipher_test_algo(a) \
653             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
654
655
656 \f
657 /************************************
658  *                                  *
659  *    asymmetric cipher functions   *
660  *                                  *
661  ************************************/
662
663 /* The algorithms and their IDs we support. */
664 enum gcry_pk_algos 
665   {
666     GCRY_PK_RSA = 1,
667     GCRY_PK_RSA_E = 2,      /* deprecated */
668     GCRY_PK_RSA_S = 3,      /* deprecated */
669     GCRY_PK_ELG_E = 16,     /* use only for OpenPGP */
670     GCRY_PK_DSA   = 17,
671     GCRY_PK_ELG   = 20
672   };
673
674 /* Flags describing usage capabilities of a PK algorithm. */
675 #define GCRY_PK_USAGE_SIGN 1
676 #define GCRY_PK_USAGE_ENCR 2
677
678 /* Encrypt the DATA using the public key PKEY and store the result as
679    a newly created S-expression at RESULT. */
680 gpg_error_t gcry_pk_encrypt (gcry_sexp_t *result, gcry_sexp_t data, gcry_sexp_t pkey);
681
682 /* Decrypt the DATA using the private key SKEY and store the result as
683    a newly created S-expression at RESULT. */
684 gpg_error_t gcry_pk_decrypt (gcry_sexp_t *result, gcry_sexp_t data, gcry_sexp_t skey);
685
686 /* Sign the DATA using the private key SKEY and store the result as
687    a newly created S-expression at RESULT. */
688 gpg_error_t gcry_pk_sign (gcry_sexp_t *result, gcry_sexp_t data, gcry_sexp_t skey);
689
690 /* Check the signature SIGVAL on DATA using the public key PKEY. */
691 gpg_error_t gcry_pk_verify (gcry_sexp_t sigval, gcry_sexp_t data, gcry_sexp_t pkey);
692
693 /* Check that KEY (either private or public) is sane. */
694 gpg_error_t gcry_pk_testkey (gcry_sexp_t key);
695
696 /* Generate a new key pair according to the parameters given in
697    S_PARMS.  The new key pair is returned in as an S-expression in
698    R_KEY. */
699 gpg_error_t gcry_pk_genkey (gcry_sexp_t *r_key, gcry_sexp_t s_parms);
700
701 /* Catch all function for miscellaneous operations. */
702 gpg_error_t gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
703
704 /* Retrieve information about the public key algorithm ALGO. */
705 gpg_error_t gcry_pk_algo_info (int algo, int what, void *buffer, size_t *nbytes);
706
707 /* Map the public key algorithm id ALGO to a string representation of the
708    algorithm name.  For unknown algorithms this functions returns an
709    empty string. */
710 const char *gcry_pk_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
711
712 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
713    the algorithm name is not known. */
714 int gcry_pk_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
715
716 /* Return what is commonly referred as the key length for the given
717    public or private KEY.  */
718 unsigned int gcry_pk_get_nbits (gcry_sexp_t key) _GCRY_GCC_ATTR_PURE;
719
720 /* Please note that keygrip is still experimental and should not be
721    used without contacting the author. */
722 unsigned char *gcry_pk_get_keygrip (gcry_sexp_t key, unsigned char *array);
723
724 /* Return 0 if the public key algorithm A is available for use. */
725 #define gcry_pk_test_algo(a) \
726             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
727
728
729 \f
730 /************************************
731  *                                  *
732  *   cryptograhic hash functions    *
733  *                                  *
734  ************************************/
735
736 /* Algorithm IDs for the hash functions we know about. Not all of them
737    are implemnted. */
738 enum gcry_md_algos
739   {
740     GCRY_MD_NONE    = 0,  
741     GCRY_MD_MD5     = 1,
742     GCRY_MD_SHA1    = 2,
743     GCRY_MD_RMD160  = 3,
744     GCRY_MD_MD2     = 5,
745     GCRY_MD_TIGER   = 6,   /* TIGER/192. */
746     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
747     GCRY_MD_SHA256  = 8,
748     GCRY_MD_SHA384  = 9,
749     GCRY_MD_SHA512  = 10,
750     GCRY_MD_MD4     = 301,
751     GCRY_MD_CRC32               = 302,
752     GCRY_MD_CRC32_RFC1510       = 303,
753     GCRY_MD_CRC24_RFC2440       = 304
754   };
755
756 /* Flags used with the open function. */
757 enum gcry_md_flags
758   {
759     GCRY_MD_FLAG_SECURE = 1,  /* Allocate all buffers in "secure" memory */
760     GCRY_MD_FLAG_HMAC   = 2   /* Make an HMAC out of this algorithm. */
761   };
762
763
764 /* This object is used to hold a handle to an message digest object.  */
765 struct gcry_md_context;
766 struct gcry_md_handle 
767   { /* This structure is private - only to be used by the gcry_md_  macros. */
768     struct gcry_md_context *ctx;
769     int  bufpos;
770     int  bufsize;
771     unsigned char buf[1];
772   };
773 typedef struct gcry_md_handle *gcry_md_hd_t;
774
775 typedef struct gcry_md_handle *GCRY_MD_HD _GCRY_GCC_ATTR_DEPRECATED;
776 typedef struct gcry_md_handle *GcryMDHd _GCRY_GCC_ATTR_DEPRECATED;
777
778
779 /* Create a message digest object for algorithm ALGO.  FLAGS may be
780    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
781    given as 0 if the algorithms to be used are later set using
782    gcry_md_enable. */
783 gpg_error_t gcry_md_open (gcry_md_hd_t *h, int algo, unsigned int flags);
784
785 /* Release the message digest object HD. */
786 void gcry_md_close (gcry_md_hd_t hd);
787
788 /* Add the message digest algorithm ALGO to the digest object HD. */
789 gpg_error_t gcry_md_enable( gcry_md_hd_t hd, int algo );
790
791 /* Create a new digest object as an exact copy of the object HD. */
792 gpg_error_t gcry_md_copy (gcry_md_hd_t *bhd, gcry_md_hd_t ahd);
793
794 /* Reset the digest object HD to its initial state. */
795 void gcry_md_reset (gcry_md_hd_t hd);
796
797 /* Perform various operations on the digets object HD. */
798 gpg_error_t gcry_md_ctl (gcry_md_hd_t hd, int cmd, unsigned char *buffer,
799                          size_t buflen);
800
801 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
802    it can update the digest values.  This is the actual hash
803    function. */
804 void gcry_md_write (gcry_md_hd_t hd, const void *buffer, size_t length);
805
806 /* Read out the final digest from HD return the digest value for
807    algorithm ALGO. */
808 unsigned char *gcry_md_read (gcry_md_hd_t hd, int algo);
809
810 /* Convenience function to calculate the hash from the data in BUFFER
811    of size LENGTH using the algorithm ALGO avoiding the creating of a
812    hash object.  The hash is returned in the caller provided buffer
813    DIGEST which must be large enough to hold the digest of the given
814    algorithm. */
815 void gcry_md_hash_buffer (int algo, void *digest,
816                           const void *buffer, size_t length);
817
818 /* Retrieve the algorithm used with HD.  This does not work reliable
819    if more than one algorithm is enabled in HD. */
820 int gcry_md_get_algo (gcry_md_hd_t hd);
821
822 /* Retrieve the length in bytes of the digest yielded by algorithm
823    ALGO. */
824 unsigned int gcry_md_get_algo_dlen (int algo);
825
826 /* Return true if the the algorithm ALGO is enabled in the digest
827    object A. */
828 int gcry_md_is_enabled (gcry_md_hd_t a, int algo);
829
830 /* Return true if the digest object A is allocated in "secure" memory. */
831 int gcry_md_is_secure (gcry_md_hd_t a);
832
833 /* Retrieve various information about the object H.  */
834 gpg_error_t gcry_md_info (gcry_md_hd_t h, int what, void *buffer,
835                           size_t *nbytes);
836
837 /* Retrieve various information about the algorithm ALGO.  */
838 gpg_error_t gcry_md_algo_info (int algo, int what, void *buffer,
839                                size_t *nbytes);
840
841 /* Map the digest algorithm id ALGO to a string representation of the
842    algorithm name.  For unknown algorithms this functions returns an
843    empty string. */
844 const char *gcry_md_algo_name (int algo) _GCRY_GCC_ATTR_PURE;
845
846 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
847    the algorithm name is not known. */
848 int gcry_md_map_name (const char* name) _GCRY_GCC_ATTR_PURE;
849
850 /* For use with the HMAC feature, the set MAC key to the KEY of
851    KEYLEN. */
852 gpg_error_t gcry_md_setkey (gcry_md_hd_t hd, const void *key, size_t keylen);
853
854 /* Update the hash(s) of H with the character C.  This is a buffered
855    version of the gcry_md_write function. */
856 #define gcry_md_putc(h,c)  \
857             do {                                          \
858                 gcry_md_hd_t h__ = (h);                       \
859                 if( (h__)->bufpos == (h__)->bufsize )     \
860                     gcry_md_write( (h__), NULL, 0 );      \
861                 (h__)->buf[(h__)->bufpos++] = (c) & 0xff; \
862             } while(0)
863
864 /* Finalize the digest calculation.  This is not really needed because
865    gcry_md_read() does this implicitly. */
866 #define gcry_md_final(a) \
867             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
868
869 /* Return 0 if the algorithm A is available for use. */
870 #define gcry_md_test_algo(a) \
871             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
872
873 /* Return an DER encoded ASN.1 OID for the algorithm A in buffer B. N
874    must point to size_t variable with the available size of buffer B.
875    After return it will receive the actual size of the returned
876    OID. */
877 #define gcry_md_get_asnoid(a,b,n) \
878             gcry_md_algo_info((a), GCRYCTL_GET_ASNOID, (b), (n))
879
880 /* Enable debugging for digets object A; i.e. create files named
881    dbgmd-<n>.<string> while hashing.  B is a string used as the suffix
882    for the filename. */
883 #define gcry_md_start_debug(a,b) \
884             gcry_md_ctl( (a), GCRYCTL_START_DUMP, (b), 0 )
885
886 /* Disable the debugging of A. */
887 #define gcry_md_stop_debug(a,b) \
888             gcry_md_ctl( (a), GCRYCTL_STOP_DUMP, (b), 0 )
889
890
891 \f
892 /************************************
893  *                                  *
894  *   random generating functions    *
895  *                                  *
896  ************************************/
897
898 /* The possible values for the random quality.  The rule of thumb is
899    to use WEAK for random number which don't need to be
900    cryptographically strong, STRONG for session keys and VERY_STRONG
901    for key material. */
902 enum gcry_random_level
903   {
904     GCRY_WEAK_RANDOM = 0,
905     GCRY_STRONG_RANDOM = 1,
906     GCRY_VERY_STRONG_RANDOM = 2
907   };
908
909
910 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
911    quality LEVEL. */
912 void gcry_randomize (unsigned char *buffer, size_t length,
913                      enum gcry_random_level level);
914
915 /* Add the external random from BUFFER with LENGTH bytes into the
916    pool. QUALITY should either be -1 for unknown or in the range of 0
917    to 100 */
918 gpg_error_t gcry_random_add_bytes (const void *buffer, size_t length,
919                                    int quality);
920
921 /* Return NBYTES of allocated random using a random numbers of quality
922    LEVEL. */
923 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level)
924                          _GCRY_GCC_ATTR_MALLOC;
925
926 /* Return NBYTES of allocated random using a random numbers of quality
927    LEVEL.  The random numbers are created returned in "secure"
928    memory. */
929 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level)
930                                 _GCRY_GCC_ATTR_MALLOC;
931
932
933 /* Set the big inetger W to a random value of NBITS using a random
934    generator with quality LEVEL. */
935 void gcry_mpi_randomize (gcry_mpi_t w,
936                          unsigned int nbits, enum gcry_random_level level);
937
938
939 \f
940 /************************************
941  *                                  *
942  *     miscellaneous stuff          *
943  *                                  *
944  ************************************/
945
946 /* Log levels used by the internal logging facility. */
947 enum gcry_log_levels 
948   {
949     GCRY_LOG_CONT   = 0,    /* continue the last log line */
950     GCRY_LOG_INFO   = 10,
951     GCRY_LOG_WARN   = 20,
952     GCRY_LOG_ERROR  = 30,
953     GCRY_LOG_FATAL  = 40,
954     GCRY_LOG_BUG    = 50,
955     GCRY_LOG_DEBUG  = 100
956   };
957
958
959 typedef void (*gcry_handler_progress_t) (void *, const char *, int, int, int);
960 typedef void *(*gcry_handler_alloc_t) (size_t n);
961 typedef void *(*gcry_handler_secure_check_t) (void *);
962 typedef void *(*gcry_handler_realloc_t) (void *p, size_t n);
963 typedef void *(*gcry_handler_free_t) (void *);
964 typedef void (*gcry_handler_no_mem_t) (void *, size_t, unsigned int);
965 typedef void (*gcry_handler_error_t) (void *, int, const char *);
966 typedef void (*gcry_handler_log_t) (void *, int, const char *, va_list);
967
968 /* Certain operations can provide progress information.  This function
969    is used to register a handler for retrieving these information. */
970 void gcry_set_progress_handler (void (*cb)(void *,const char*,int, int, int),
971                                 void *cb_data);
972
973
974 /* Register a custom memory allocation functions. */
975 void gcry_set_allocation_handler (void *(*new_alloc_func)(size_t n),
976                                   void *(*new_alloc_secure_func)(size_t n),
977                                   int (*new_is_secure_func)(const void*),
978                                   void *(*new_realloc_func)(void *p, size_t n),
979                                   void (*new_free_func)(void*));
980
981 /* Register a function used instead of the internal out of memory
982    handler. */
983 void gcry_set_outofcore_handler (int (*h)(void*, size_t, unsigned int),
984                                  void *opaque );
985
986 /* Register a function used instead of the internal fatal error
987    handler. */
988 void gcry_set_fatalerror_handler (void (*fnc)(void*,int, const char*),
989                                   void *opaque);
990
991 /* Reserved for future use. */
992 void gcry_set_gettext_handler (const char *(*f)(const char*));
993
994 /* Register a function used instead of the internal logging
995    facility. */
996 void gcry_set_log_handler (void (*f)(void*,int, const char*, va_list),
997                            void *opaque);
998
999
1000 /* Libgcrypt uses its own memory allocation.  It is important to use
1001    gcry_free () to release memory allocated by libgcrypt. */
1002 void *gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1003 void *gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1004 void *gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1005 void *gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1006 void *gcry_realloc (void *a, size_t n);
1007 char *gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
1008 void *gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
1009 void *gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1010 void *gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
1011 void *gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
1012 void *gcry_xrealloc (void *a, size_t n);
1013 char *gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
1014 void  gcry_free (void *a);
1015
1016 /* Return true if A is allocated in "secure" memory. */
1017 int gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
1018
1019 #if 0 /* keep Emacsens's auto-indent happy */
1020 {
1021 #endif
1022 #ifdef __cplusplus
1023 }
1024 #endif
1025 #endif /* _GCRYPT_H */