The first libgcrypt only release.
[libgcrypt.git] / src / gcrypt.h
1 /* gcrypt.h -  GNU digital encryption library interface
2  *      Copyright (C) 1998 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 General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (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 General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * 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
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 /*
31  * The version of this header should match the one of the library
32  * It should not be used by a program because gcry_check_version()
33  * should reurn the same version.  The purpose of this macro is to
34  * let autoconf (using the AM_PATH_GCRYPT macro) check that this
35  * header matches the installed library.
36  * Note: Do not edit the next line as configure may fix the string here.
37  */
38 #define GCRYPT_VERSION "1.1.3"
39
40
41 #ifndef HAVE_BYTE_TYPEDEF
42 # undef byte       /* maybe there is a macro with this name */
43   typedef unsigned char byte;
44 # define HAVE_BYTE_TYPEDEF
45 #endif
46
47 #ifdef _GCRYPT_IN_LIBGCRYPT
48 # ifndef GCRYPT_NO_MPI_MACROS
49 #   define GCRYPT_NO_MPI_MACROS 1
50 # endif
51 #endif
52
53 struct gcry_mpi;
54 typedef struct gcry_mpi *GCRY_MPI;
55
56 /*******************************************
57  *                                         *
58  *  error handling etc.                    *
59  *                                         *
60  *******************************************/
61
62 /* FIXME: We should use the same values as they were used in GnuPG 1.0.
63  *        gpg --status-fd may print some of these values */
64 enum {
65     GCRYERR_SUCCESS = 0,    /* "no error" */
66     GCRYERR_GENERAL = 1,    /* catch all the other errors code */
67
68     GCRYERR_INV_PK_ALGO = 4, /* invalid public key algorithm */
69     GCRYERR_INV_MD_ALGO = 5, /* invalid message digest algorithm */
70     GCRYERR_BAD_PUBLIC_KEY = 6, /* Bad public key */
71     GCRYERR_BAD_SECRET_KEY = 7, /* Bad secret key */
72     GCRYERR_BAD_SIGNATURE = 8,  /* Bad signature */
73
74     GCRYERR_INV_CIPHER_ALGO = 12, /* invalid cipher algorithm */
75     GCRYERR_BAD_MPI = 30,
76     GCRYERR_WRONG_PK_ALGO = 41, /* wrong public key algorithm */
77     GCRYERR_WEAK_KEY = 43,  /* weak encryption key */
78     GCRYERR_INV_KEYLEN = 44,  /* invalid length of a key*/
79     GCRYERR_INV_ARG = 45,    /* invalid argument */
80     GCRYERR_SELFTEST = 50,      /* selftest failed */
81
82     /* error codes not used in GnuPG 1.0 */
83     GCRYERR_INV_OP = 61,     /* invalid operation code or ctl command */
84     GCRYERR_NO_MEM = 62,     /* out of core */
85     GCRYERR_INTERNAL = 63,   /* internal error */
86     GCRYERR_EOF = 64,        /* (-1) is remapped to this value */
87     GCRYERR_INV_OBJ = 65,    /* an object is not valid */
88     GCRYERR_TOO_SHORT = 66,  /* provided buffer too short */
89     GCRYERR_TOO_LARGE = 67,  /* object is too large */
90     GCRYERR_NO_OBJ = 68,     /* Missing item in an object */
91     GCRYERR_NOT_IMPL = 69,   /* Not implemented */
92     GCRYERR_CONFLICT = 70,
93     GCRYERR_INV_CIPHER_MODE = 71, 
94 };
95
96 const char *gcry_check_version( const char *req_version );
97
98 int gcry_errno(void);
99 const char *gcry_strerror( int ec );
100
101 enum gcry_ctl_cmds {
102     GCRYCTL_SET_KEY  = 1,
103     GCRYCTL_SET_IV   = 2,
104     GCRYCTL_CFB_SYNC = 3,
105     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
106     GCRYCTL_FINALIZE = 5,
107     GCRYCTL_GET_KEYLEN = 6,
108     GCRYCTL_GET_BLKLEN = 7,
109     GCRYCTL_TEST_ALGO = 8,
110     GCRYCTL_IS_SECURE = 9,
111     GCRYCTL_GET_ASNOID = 10,
112     GCRYCTL_ENABLE_ALGO = 11,
113     GCRYCTL_DISABLE_ALGO = 12,
114     GCRYCTL_DUMP_RANDOM_STATS = 13,
115     GCRYCTL_DUMP_SECMEM_STATS = 14,
116     GCRYCTL_GET_ALGO_NPKEY    = 15,
117     GCRYCTL_GET_ALGO_NSKEY    = 16,
118     GCRYCTL_GET_ALGO_NSIGN    = 17,
119     GCRYCTL_GET_ALGO_NENCR    = 18,
120     GCRYCTL_SET_VERBOSITY     = 19,
121     GCRYCTL_SET_DEBUG_FLAGS   = 20,
122     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
123     GCRYCTL_USE_SECURE_RNDPOOL= 22,
124     GCRYCTL_DUMP_MEMORY_STATS = 23,
125     GCRYCTL_INIT_SECMEM       = 24,
126     GCRYCTL_TERM_SECMEM       = 25,
127     GCRYCTL_DISABLE_SECMEM_WARN = 27,
128     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
129     GCRYCTL_RESUME_SECMEM_WARN  = 29,
130     GCRYCTL_DROP_PRIVS          = 30,
131     GCRYCTL_ENABLE_M_GUARD      = 31,
132     GCRYCTL_START_DUMP          = 32,
133     GCRYCTL_STOP_DUMP           = 33,
134     GCRYCTL_GET_ALGO_USAGE      = 34
135 };
136
137 int gcry_control( enum gcry_ctl_cmds, ... );
138
139 enum gcry_random_level {
140     GCRY_WEAK_RANDOM = 0,
141     GCRY_STRONG_RANDOM = 1,
142     GCRY_VERY_STRONG_RANDOM = 2
143 };
144
145
146 struct gcry_sexp;
147 typedef struct gcry_sexp *GCRY_SEXP;
148
149 enum gcry_sexp_format {
150     GCRYSEXP_FMT_DEFAULT   = 0,
151     GCRYSEXP_FMT_CANON     = 1,
152     GCRYSEXP_FMT_BASE64    = 2,
153     GCRYSEXP_FMT_ADVANCED  = 3,
154 };
155
156
157 void      gcry_sexp_release( GCRY_SEXP sexp );
158 void      gcry_sexp_dump( const GCRY_SEXP a );
159 GCRY_SEXP gcry_sexp_cons( const GCRY_SEXP a, const GCRY_SEXP b );
160 GCRY_SEXP gcry_sexp_alist( const GCRY_SEXP *array );
161 GCRY_SEXP gcry_sexp_vlist( const GCRY_SEXP a, ... );
162 GCRY_SEXP gcry_sexp_append( const GCRY_SEXP a, const GCRY_SEXP n );
163 GCRY_SEXP gcry_sexp_prepend( const GCRY_SEXP a, const GCRY_SEXP n );
164 int       gcry_sexp_sscan( GCRY_SEXP *retsexp, size_t *erroff,
165                            const char *buffer, size_t length );
166 int       gcry_sexp_build( GCRY_SEXP *retsexp, size_t *erroff,
167                            const char *format, ... );
168 size_t    gcry_sexp_sprint( GCRY_SEXP sexp, int mode, char *buffer,
169                                                 size_t maxlength );
170 GCRY_SEXP   gcry_sexp_find_token( GCRY_SEXP list,
171                                   const char *tok, size_t toklen );
172 int         gcry_sexp_length( const GCRY_SEXP list );
173 GCRY_SEXP   gcry_sexp_nth( const GCRY_SEXP list, int number );
174 GCRY_SEXP   gcry_sexp_car( const GCRY_SEXP list );
175 GCRY_SEXP   gcry_sexp_cdr( const GCRY_SEXP list );
176 GCRY_SEXP   gcry_sexp_cadr( const GCRY_SEXP list );
177 const char *gcry_sexp_nth_data( const GCRY_SEXP list, int number,
178                                                       size_t *datalen );
179 GCRY_MPI    gcry_sexp_nth_mpi( GCRY_SEXP list, int number, int mpifmt );
180
181
182 /*******************************************
183  *                                         *
184  *  multi precision integer functions      *
185  *                                         *
186  *******************************************/
187
188 enum gcry_mpi_format {
189     GCRYMPI_FMT_NONE= 0,
190     GCRYMPI_FMT_STD = 1,    /* twos complement stored without length */
191     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP */
192     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (same as 1 but with length)*/
193     GCRYMPI_FMT_HEX = 4,    /* hex format */
194     GCRYMPI_FMT_USG = 5,    /* like STD but this is an unsigned one */
195 };
196
197
198 enum gcry_mpi_flag {
199     GCRYMPI_FLAG_SECURE = 1,
200     GCRYMPI_FLAG_OPAQUE = 2,
201 };
202
203
204
205 GCRY_MPI gcry_mpi_new( unsigned int nbits );
206 GCRY_MPI gcry_mpi_snew( unsigned int nbits );
207 void     gcry_mpi_release( GCRY_MPI a );
208 GCRY_MPI gcry_mpi_copy( const GCRY_MPI a );
209 GCRY_MPI gcry_mpi_set( GCRY_MPI w, const GCRY_MPI u );
210 GCRY_MPI gcry_mpi_set_ui( GCRY_MPI w, unsigned long u );
211 int      gcry_mpi_cmp( const GCRY_MPI u, const GCRY_MPI v );
212 int      gcry_mpi_cmp_ui( const GCRY_MPI u, unsigned long v );
213 void     gcry_mpi_randomize( GCRY_MPI w,
214                              unsigned int nbits, enum gcry_random_level level);
215 int      gcry_mpi_scan( GCRY_MPI *ret_mpi, enum gcry_mpi_format format,
216                                        const char *buffer, size_t *nbytes );
217 int      gcry_mpi_print( enum gcry_mpi_format format,
218                          char *buffer, size_t *nbytes, const GCRY_MPI a );
219 int      gcry_mpi_aprint( enum gcry_mpi_format format,
220                           void **buffer, size_t *nbytes, const GCRY_MPI a );
221
222
223 void     gcry_mpi_add(GCRY_MPI w, GCRY_MPI u, GCRY_MPI v);
224 void     gcry_mpi_add_ui(GCRY_MPI w, GCRY_MPI u, unsigned long v );
225 void     gcry_mpi_addm(GCRY_MPI w, GCRY_MPI u, GCRY_MPI v, GCRY_MPI m);
226 void     gcry_mpi_sub( GCRY_MPI w, GCRY_MPI u, GCRY_MPI v);
227 void     gcry_mpi_sub_ui(GCRY_MPI w, GCRY_MPI u, ulong v );
228 void     gcry_mpi_subm( GCRY_MPI w, GCRY_MPI u, GCRY_MPI v, GCRY_MPI m);
229 void     gcry_mpi_mul_ui(GCRY_MPI w, GCRY_MPI u, unsigned long v );
230 void     gcry_mpi_mul_2exp( GCRY_MPI w, GCRY_MPI u, unsigned long cnt);
231 void     gcry_mpi_mul( GCRY_MPI w, GCRY_MPI u, GCRY_MPI v);
232 void     gcry_mpi_mulm( GCRY_MPI w, GCRY_MPI u, GCRY_MPI v, GCRY_MPI m);
233
234 void     gcry_mpi_powm( GCRY_MPI w,
235                         const GCRY_MPI b, const GCRY_MPI e, const GCRY_MPI m );
236 int      gcry_mpi_gcd( GCRY_MPI g, GCRY_MPI a, GCRY_MPI b );
237
238 unsigned int gcry_mpi_get_nbits( GCRY_MPI a );
239 int      gcry_mpi_test_bit( GCRY_MPI a, unsigned int n );
240 void     gcry_mpi_set_bit( GCRY_MPI a, unsigned int n );
241 void     gcry_mpi_clear_bit( GCRY_MPI a, unsigned int n );
242 void     gcry_mpi_set_highbit( GCRY_MPI a, unsigned int n );
243 void     gcry_mpi_clear_highbit( GCRY_MPI a, unsigned int n );
244 void     gcry_mpi_rshift( GCRY_MPI x, GCRY_MPI a, unsigned int n );
245
246 GCRY_MPI gcry_mpi_set_opaque( GCRY_MPI a, void *p, unsigned int nbits );
247 void *   gcry_mpi_get_opaque( GCRY_MPI a, unsigned int *nbits );
248 void     gcry_mpi_set_flag( GCRY_MPI a, enum gcry_mpi_flag flag );
249 void     gcry_mpi_clear_flag( GCRY_MPI a, enum gcry_mpi_flag flag );
250 int      gcry_mpi_get_flag( GCRY_MPI a, enum gcry_mpi_flag flag );
251
252
253 #ifndef GCRYPT_NO_MPI_MACROS
254 #define mpi_new(n)          gcry_mpi_new( (n) )
255 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
256 #define mpi_release( a )    do { gcry_mpi_release( (a) ); \
257                                  (a) = NULL; } while(0)
258 #define mpi_copy( a )       gcry_mpi_copy( (a) )
259 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
260 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
261 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
262 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
263
264 #define mpi_add_ui(w,u,v)   gcry_mpi_add_ui((w),(u),(v))
265 #define mpi_add(w,u,v)      gcry_mpi_add ((w),(u),(v))
266 #define mpi_addm(w,u,v,m)   gcry_mpi_addm ((w),(u),(v),(m))
267 #define mpi_sub_ui(w,u,v)   gcry_mpi_sub_ui ((w),(u),(v))
268 #define mpi_sub(w,u,v)      gcry_mpi_sub ((w),(u),(v))
269 #define mpi_subm(w,u,v,m)   gcry_mpi_subm ((w),(u),(v),(m))
270 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
271 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
272 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
273 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
274 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
275 #define mpi_gcd(g,a,b)      gcry_mpi_gcd( (g), (a), (b) )
276
277 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
278 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
279 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
280 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
281 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
282 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
283 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
284
285 #define mpi_set_opaque(a,b,c) gcry_mpi_set_opaque( (a), (b), (c) )
286 #define mpi_get_opaque(a,b)   gcry_mpi_get_opaque( (a), (b) )
287 #endif /* GCRYPT_NO_MPI_MACROS */
288
289 /********************************************
290  *******  symmetric cipher functions  *******
291  ********************************************/
292
293 struct gcry_cipher_handle;
294 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD;
295
296 enum gcry_cipher_algos {
297     GCRY_CIPHER_NONE        = 0,
298     GCRY_CIPHER_IDEA        = 1,
299     GCRY_CIPHER_3DES        = 2,
300     GCRY_CIPHER_CAST5       = 3,
301     GCRY_CIPHER_BLOWFISH    = 4,
302     GCRY_CIPHER_SAFER_SK128 = 5,
303     GCRY_CIPHER_DES_SK      = 6,
304     GCRY_CIPHER_RIJNDAEL    = 7,
305     GCRY_CIPHER_RIJNDAEL192 = 8,
306     GCRY_CIPHER_RIJNDAEL256 = 9,
307     GCRY_CIPHER_TWOFISH     = 10,
308     /* other cipher numbers are above 300 for OpenPGP reasons. */
309     GCRY_CIPHER_ARCFOUR     = 301
310 };
311
312 #define GCRY_CIPHER_AES    GCRY_CIPHER_RIJNDAEL
313 #define GCRY_CIPHER_AES128 GCRY_CIPHER_RIJNDAEL128
314 #define GCRY_CIPHER_AES192 GCRY_CIPHER_RIJNDAEL192
315 #define GCRY_CIPHER_AES256 GCRY_CIPHER_RIJNDAEL256
316
317 enum gcry_cipher_modes {
318     GCRY_CIPHER_MODE_NONE   = 0,
319     GCRY_CIPHER_MODE_ECB    = 1,
320     GCRY_CIPHER_MODE_CFB    = 2,
321     GCRY_CIPHER_MODE_CBC    = 3,
322     GCRY_CIPHER_MODE_STREAM = 4 /* native stream mode of some the algorithms */
323 };
324
325 enum gcry_cipher_flags {
326     GCRY_CIPHER_SECURE      = 1,  /* allocate in secure memory */
327     GCRY_CIPHER_ENABLE_SYNC = 2,  /* enable CFB sync mode */
328 };
329
330
331 GCRY_CIPHER_HD gcry_cipher_open( int algo, int mode, unsigned flags);
332 void gcry_cipher_close( GCRY_CIPHER_HD h );
333 int  gcry_cipher_ctl( GCRY_CIPHER_HD h, int cmd, void *buffer, size_t buflen);
334 int gcry_cipher_info( GCRY_CIPHER_HD h, int what, void *buffer, size_t *nbytes);
335 int gcry_cipher_algo_info( int algo, int what, void *buffer, size_t *nbytes);
336 const char *gcry_cipher_algo_name( int algo );
337 int gcry_cipher_map_name( const char* name );
338
339 int gcry_cipher_encrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
340                                       const byte *in, size_t inlen );
341 int gcry_cipher_decrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
342                                       const byte *in, size_t inlen );
343
344
345 /* some handy macros */
346 /* We have to cast a way a const char* here - this catch-all ctl function
347  * was probably not the best choice */
348 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
349                                                          (char*)(k), (l) )
350 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
351                                                          (char*)(k), (l) )
352 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
353                                                                    NULL, 0 )
354
355 #define gcry_cipher_get_algo_keylen(a) \
356             gcry_cipher_algo_info( (a), GCRYCTL_GET_KEYLEN, NULL, NULL )
357 #define gcry_cipher_get_algo_blklen(a) \
358             gcry_cipher_algo_info( (a), GCRYCTL_GET_BLKLEN, NULL, NULL )
359 #define gcry_cipher_test_algo(a) \
360             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
361
362
363 /*********************************************
364  *******  asymmetric cipher functions  *******
365  *********************************************/
366
367 enum gcry_pk_algos {
368     GCRY_PK_RSA = 1,
369     GCRY_PK_RSA_E = 2,      /* use only for OpenPGP */
370     GCRY_PK_RSA_S = 3,      /* use only for OpenPGP */
371     GCRY_PK_ELG_E = 16,     /* use only for OpenPGP */
372     GCRY_PK_DSA   = 17,
373     GCRY_PK_ELG   = 20,
374 };
375
376 /* Flags describing usage capabilites/request of a PK algorithm */
377 #define GCRY_PK_USAGE_SIGN 1
378 #define GCRY_PK_USAGE_ENCR 2
379
380 int gcry_pk_encrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP pkey );
381 int gcry_pk_decrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
382 int gcry_pk_sign(    GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
383 int gcry_pk_verify(  GCRY_SEXP sigval, GCRY_SEXP data, GCRY_SEXP pkey );
384 int gcry_pk_testkey( GCRY_SEXP key );
385 int gcry_pk_genkey(  GCRY_SEXP *r_key, GCRY_SEXP s_parms );
386
387 int gcry_pk_ctl( int cmd, void *buffer, size_t buflen);
388 int gcry_pk_algo_info( int algo, int what, void *buffer, size_t *nbytes);
389 const char *gcry_pk_algo_name( int algo );
390 int gcry_pk_map_name( const char* name );
391 unsigned int gcry_pk_get_nbits( GCRY_SEXP key );
392
393
394 #define gcry_pk_test_algo(a) \
395             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
396
397 /*********************************************
398  *******  cryptograhic hash functions  *******
399  *********************************************/
400
401 enum gcry_md_algos {
402     GCRY_MD_NONE    = 0,
403     GCRY_MD_MD5     = 1,
404     GCRY_MD_SHA1    = 2,
405     GCRY_MD_RMD160  = 3,
406     GCRY_MD_TIGER   = 6
407 };
408
409 enum gcry_md_flags {
410     GCRY_MD_FLAG_SECURE = 1,
411     GCRY_MD_FLAG_HMAC   = 2
412 };
413
414
415 struct gcry_md_context;
416 struct gcry_md_handle {
417     struct gcry_md_context *ctx;
418     int  bufpos;
419     int  bufsize;
420     byte buf[1];
421 };
422 typedef struct gcry_md_handle *GCRY_MD_HD;
423
424
425 GCRY_MD_HD gcry_md_open( int algo, unsigned flags );
426 void gcry_md_close( GCRY_MD_HD hd );
427 int gcry_md_enable( GCRY_MD_HD hd, int algo );
428 GCRY_MD_HD gcry_md_copy( GCRY_MD_HD hd );
429 void gcry_md_reset( GCRY_MD_HD hd );
430 int gcry_md_ctl( GCRY_MD_HD hd, int cmd, byte *buffer, size_t buflen);
431 void gcry_md_write( GCRY_MD_HD hd, const byte *buffer, size_t length);
432 byte *gcry_md_read( GCRY_MD_HD hd, int algo );
433 void gcry_md_hash_buffer( int algo, char *digest,
434                           const char *buffer, size_t length);
435 int gcry_md_get_algo( GCRY_MD_HD hd );
436 unsigned int gcry_md_get_algo_dlen( int algo );
437 /*??int gcry_md_get( GCRY_MD_HD hd, int algo, byte *buffer, int buflen );*/
438 int gcry_md_info( GCRY_MD_HD h, int what, void *buffer, size_t *nbytes);
439 int gcry_md_algo_info( int algo, int what, void *buffer, size_t *nbytes);
440 const char *gcry_md_algo_name( int algo );
441 int gcry_md_map_name( const char* name );
442 int gcry_md_setkey( GCRY_MD_HD hd, const char *key, size_t keylen );
443
444 #define gcry_md_putc(h,c)  \
445             do {                                        \
446                 if( (h)->bufpos == (h)->bufsize )       \
447                     gcry_md_write( (h), NULL, 0 );      \
448                 (h)->buf[(h)->bufpos++] = (c) & 0xff;   \
449             } while(0)
450
451 #define gcry_md_final(a) \
452             gcry_md_ctl( (a), GCRYCTL_FINALIZE, NULL, 0 )
453
454 #define gcry_md_is_secure(a) \
455             gcry_md_info( (a), GCRYCTL_IS_SECURE, NULL, NULL )
456
457 #define gcry_md_test_algo(a) \
458             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
459
460 #define gcry_md_start_debug(a,b) \
461             gcry_md_ctl( (a), GCRYCTL_START_DUMP, (b), 0 )
462 #define gcry_md_stop_debug(a,b) \
463             gcry_md_ctl( (a), GCRYCTL_STOP_DUMP, (b), 0 )
464
465
466 /*********************************************
467  *******  random generating functions  *******
468  *********************************************/
469 void gcry_randomize( byte *buffer, size_t length,
470                      enum gcry_random_level level );
471 void *gcry_random_bytes( size_t nbytes, enum gcry_random_level level );
472 void *gcry_random_bytes_secure( size_t nbytes, enum gcry_random_level level );
473
474 /*****************************************
475  *******  miscellaneous stuff   **********
476  *****************************************/
477
478 enum gcry_log_levels {
479     GCRY_LOG_CONT   = 0,    /* continue the last log line */
480     GCRY_LOG_INFO   = 10,
481     GCRY_LOG_WARN   = 20,
482     GCRY_LOG_ERROR  = 30,
483     GCRY_LOG_FATAL  = 40,
484     GCRY_LOG_BUG    = 50,
485     GCRY_LOG_DEBUG  = 100,
486 };
487
488
489 /* Provide custom functions for special tasks of libgcrypt.
490  */
491 void gcry_set_allocation_handler( void *(*new_alloc_func)(size_t n),
492                                   void *(*new_alloc_secure_func)(size_t n),
493                                   int (*new_is_secure_func)(const void*),
494                                   void *(*new_realloc_func)(void *p, size_t n),
495                                   void (*new_free_func)(void*) );
496 void gcry_set_outofcore_handler( int (*h)( void*, size_t, unsigned int ),
497                                                                 void *opaque );
498 void gcry_set_fatalerror_handler( void (*fnc)(void*,int, const char*),
499                                                                 void *opaque );
500 void gcry_set_gettext_handler( const char *(*f)(const char*) );
501 void gcry_set_log_handler( void (*f)(void*,int, const char*, va_list ),
502                                                              void *opaque );
503
504
505 /* Access to the memory function of libgcrypt.
506  * Especially the gcry_free() should be used for memory
507  * allocated by gcry_ functions.
508  */
509 void *gcry_malloc( size_t n );
510 void *gcry_calloc( size_t n, size_t m );
511 void *gcry_malloc_secure( size_t n );
512 void *gcry_calloc_secure( size_t n, size_t m );
513 void *gcry_realloc( void *a, size_t n );
514 void *gcry_xmalloc( size_t n );
515 void *gcry_xcalloc( size_t n, size_t m );
516 void *gcry_xmalloc_secure( size_t n );
517 void *gcry_xcalloc_secure( size_t n, size_t m );
518 void *gcry_xrealloc( void *a, size_t n );
519 char *gcry_xstrdup( const char * a);
520 void  gcry_free( void *a );
521 int   gcry_is_secure( const void *a );
522
523
524 #ifndef GCRYPT_NO_MPI_MACROS
525 # ifndef DID_MPI_TYPEDEF
526     typedef struct gcry_mpi *MPI;
527 #   define DID_MPI_TYPEDEF
528 # endif
529 #endif /* GCRYPT_NO_MPI_MACROS */
530
531 #ifdef __cplusplus
532 }
533 #endif
534 #endif /* _GCRYPT_H */