See ChangeLog: Wed Oct 4 13:16:18 CEST 2000 Werner Koch
[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 GnuPG.
5  *
6  * GnuPG 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  * GnuPG 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.1a"
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 };
94
95 const char *gcry_check_version( const char *req_version );
96
97 int gcry_errno(void);
98 const char *gcry_strerror( int ec );
99
100 enum gcry_ctl_cmds {
101     GCRYCTL_SET_KEY  = 1,
102     GCRYCTL_SET_IV   = 2,
103     GCRYCTL_CFB_SYNC = 3,
104     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
105     GCRYCTL_FINALIZE = 5,
106     GCRYCTL_GET_KEYLEN = 6,
107     GCRYCTL_GET_BLKLEN = 7,
108     GCRYCTL_TEST_ALGO = 8,
109     GCRYCTL_IS_SECURE = 9,
110     GCRYCTL_GET_ASNOID = 10,
111     GCRYCTL_ENABLE_ALGO = 11,
112     GCRYCTL_DISABLE_ALGO = 12,
113     GCRYCTL_DUMP_RANDOM_STATS = 13,
114     GCRYCTL_DUMP_SECMEM_STATS = 14,
115     GCRYCTL_GET_ALGO_NPKEY    = 15,
116     GCRYCTL_GET_ALGO_NSKEY    = 16,
117     GCRYCTL_GET_ALGO_NSIGN    = 17,
118     GCRYCTL_GET_ALGO_NENCR    = 18,
119     GCRYCTL_SET_VERBOSITY     = 19,
120     GCRYCTL_SET_DEBUG_FLAGS   = 20,
121     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
122     GCRYCTL_USE_SECURE_RNDPOOL= 22,
123     GCRYCTL_DUMP_MEMORY_STATS = 23,
124     GCRYCTL_INIT_SECMEM       = 24,
125     GCRYCTL_TERM_SECMEM       = 25,
126     GCRYCTL_DISABLE_SECMEM_WARN = 27,
127     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
128     GCRYCTL_RESUME_SECMEM_WARN  = 29,
129     GCRYCTL_DROP_PRIVS          = 30,
130     GCRYCTL_ENABLE_M_GUARD      = 31,
131     GCRYCTL_START_DUMP          = 32,
132     GCRYCTL_STOP_DUMP           = 33,
133     GCRYCTL_GET_ALGO_USAGE      = 34
134 };
135
136 int gcry_control( enum gcry_ctl_cmds, ... );
137
138 enum gcry_random_level {
139     GCRY_WEAK_RANDOM = 0,
140     GCRY_STRONG_RANDOM = 1,
141     GCRY_VERY_STRONG_RANDOM = 2
142 };
143
144
145 struct gcry_sexp;
146 typedef struct gcry_sexp *GCRY_SEXP;
147
148 enum gcry_sexp_format {
149     GCRYSEXP_FMT_DEFAULT   = 0,
150     GCRYSEXP_FMT_CANON     = 1,
151     GCRYSEXP_FMT_BASE64    = 2,
152     GCRYSEXP_FMT_ADVANCED  = 3,
153 };
154
155
156 void      gcry_sexp_release( GCRY_SEXP sexp );
157 void      gcry_sexp_dump( const GCRY_SEXP a );
158 GCRY_SEXP gcry_sexp_cons( const GCRY_SEXP a, const GCRY_SEXP b );
159 GCRY_SEXP gcry_sexp_alist( const GCRY_SEXP *array );
160 GCRY_SEXP gcry_sexp_vlist( const GCRY_SEXP a, ... );
161 GCRY_SEXP gcry_sexp_append( const GCRY_SEXP a, const GCRY_SEXP n );
162 GCRY_SEXP gcry_sexp_prepend( const GCRY_SEXP a, const GCRY_SEXP n );
163 int       gcry_sexp_sscan( GCRY_SEXP *retsexp, size_t *erroff,
164                            const char *buffer, size_t length );
165 int       gcry_sexp_build( GCRY_SEXP *retsexp, size_t *erroff,
166                            const char *format, ... );
167 size_t    gcry_sexp_sprint( GCRY_SEXP sexp, int mode, char *buffer,
168                                                 size_t maxlength );
169 GCRY_SEXP   gcry_sexp_find_token( GCRY_SEXP list,
170                                   const char *tok, size_t toklen );
171 int         gcry_sexp_length( const GCRY_SEXP list );
172 GCRY_SEXP   gcry_sexp_nth( const GCRY_SEXP list, int number );
173 GCRY_SEXP   gcry_sexp_car( const GCRY_SEXP list );
174 GCRY_SEXP   gcry_sexp_cdr( const GCRY_SEXP list );
175 GCRY_SEXP   gcry_sexp_cadr( const GCRY_SEXP list );
176 const char *gcry_sexp_nth_data( const GCRY_SEXP list, int number,
177                                                       size_t *datalen );
178 GCRY_MPI    gcry_sexp_nth_mpi( GCRY_SEXP list, int number, int mpifmt );
179
180
181 /*******************************************
182  *                                         *
183  *  multi precision integer functions      *
184  *                                         *
185  *******************************************/
186
187 enum gcry_mpi_format {
188     GCRYMPI_FMT_NONE= 0,
189     GCRYMPI_FMT_STD = 1,    /* twos complement stored without length */
190     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP */
191     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (same as 1 but with length)*/
192     GCRYMPI_FMT_HEX = 4,    /* hex format */
193     GCRYMPI_FMT_USG = 5,    /* like STD but this is an unsigned one */
194 };
195
196
197 enum gcry_mpi_flag {
198     GCRYMPI_FLAG_SECURE = 1,
199     GCRYMPI_FLAG_OPAQUE = 2,
200 };
201
202
203
204 GCRY_MPI gcry_mpi_new( unsigned int nbits );
205 GCRY_MPI gcry_mpi_snew( unsigned int nbits );
206 void     gcry_mpi_release( GCRY_MPI a );
207 GCRY_MPI gcry_mpi_copy( const GCRY_MPI a );
208 GCRY_MPI gcry_mpi_set( GCRY_MPI w, const GCRY_MPI u );
209 GCRY_MPI gcry_mpi_set_ui( GCRY_MPI w, unsigned long u );
210 int      gcry_mpi_cmp( const GCRY_MPI u, const GCRY_MPI v );
211 int      gcry_mpi_cmp_ui( const GCRY_MPI u, unsigned long v );
212 void     gcry_mpi_randomize( GCRY_MPI w,
213                              unsigned int nbits, enum gcry_random_level level);
214 int      gcry_mpi_scan( GCRY_MPI *ret_mpi, enum gcry_mpi_format format,
215                                        const char *buffer, size_t *nbytes );
216 int      gcry_mpi_print( enum gcry_mpi_format format,
217                          char *buffer, size_t *nbytes, const GCRY_MPI a );
218 int      gcry_mpi_aprint( enum gcry_mpi_format format,
219                           void **buffer, size_t *nbytes, const GCRY_MPI a );
220
221 void gcry_mpi_powm( GCRY_MPI w,
222                     const GCRY_MPI b, const GCRY_MPI e, const GCRY_MPI m );
223 GCRY_MPI gcry_mpi_set_opaque( GCRY_MPI a, void *p, unsigned int nbits );
224 void    *gcry_mpi_get_opaque( GCRY_MPI a, unsigned int *nbits );
225 void gcry_mpi_set_flag( GCRY_MPI a, enum gcry_mpi_flag flag );
226 void gcry_mpi_clear_flag( GCRY_MPI a, enum gcry_mpi_flag flag );
227 int  gcry_mpi_get_flag( GCRY_MPI a, enum gcry_mpi_flag flag );
228 unsigned int gcry_mpi_get_nbits( GCRY_MPI a );
229
230
231 #ifndef GCRYPT_NO_MPI_MACROS
232 #define mpi_new(n)          gcry_mpi_new( (n) )
233 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
234 #define mpi_release( a )    do { gcry_mpi_release( (a) ); \
235                                  (a) = NULL; } while(0)
236 #define mpi_copy( a )       gcry_mpi_copy( (a) )
237 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
238 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
239 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
240 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
241
242 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
243 #define mpi_set_opaque(a,b,c) gcry_mpi_set_opaque( (a), (b), (c) )
244 #define mpi_get_opaque(a,b)   gcry_mpi_get_opaque( (a), (b) )
245 #endif /* GCRYPT_NO_MPI_MACROS */
246
247 /********************************************
248  *******  symmetric cipher functions  *******
249  ********************************************/
250
251 struct gcry_cipher_handle;
252 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD;
253
254 enum gcry_cipher_algos {
255     GCRY_CIPHER_NONE        = 0,
256     GCRY_CIPHER_IDEA        = 1,
257     GCRY_CIPHER_3DES        = 2,
258     GCRY_CIPHER_CAST5       = 3,
259     GCRY_CIPHER_BLOWFISH    = 4,
260     GCRY_CIPHER_SAFER_SK128 = 5,
261     GCRY_CIPHER_DES_SK      = 6,
262     GCRY_CIPHER_RIJNDAEL    = 7,
263     GCRY_CIPHER_RIJNDAEL192 = 8,
264     GCRY_CIPHER_RIJNDAEL256 = 9,
265     GCRY_CIPHER_TWOFISH     = 10,
266 };
267
268 enum gcry_cipher_modes {
269     GCRY_CIPHER_MODE_NONE   = 0,
270     GCRY_CIPHER_MODE_ECB    = 1,
271     GCRY_CIPHER_MODE_CFB    = 2,
272     GCRY_CIPHER_MODE_CBC    = 3,
273 };
274
275 enum gcry_cipher_flags {
276     GCRY_CIPHER_SECURE      = 1,  /* allocate in secure memory */
277     GCRY_CIPHER_ENABLE_SYNC = 2,  /* enable CFB sync mode */
278 };
279
280
281 GCRY_CIPHER_HD gcry_cipher_open( int algo, int mode, unsigned flags);
282 void gcry_cipher_close( GCRY_CIPHER_HD h );
283 int  gcry_cipher_ctl( GCRY_CIPHER_HD h, int cmd, void *buffer, size_t buflen);
284 int gcry_cipher_info( GCRY_CIPHER_HD h, int what, void *buffer, size_t *nbytes);
285 int gcry_cipher_algo_info( int algo, int what, void *buffer, size_t *nbytes);
286 const char *gcry_cipher_algo_name( int algo );
287 int gcry_cipher_map_name( const char* name );
288
289 int gcry_cipher_encrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
290                                       const byte *in, size_t inlen );
291 int gcry_cipher_decrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
292                                       const byte *in, size_t inlen );
293
294
295 /* some handy macros */
296 /* We have to cast a way a const char* here - this catch-all ctl function
297  * was probably not the best choice */
298 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
299                                                          (char*)(k), (l) )
300 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
301                                                          (char*)(k), (l) )
302 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
303                                                                    NULL, 0 )
304
305 #define gcry_cipher_get_algo_keylen(a) \
306             gcry_cipher_algo_info( (a), GCRYCTL_GET_KEYLEN, NULL, NULL )
307 #define gcry_cipher_get_algo_blklen(a) \
308             gcry_cipher_algo_info( (a), GCRYCTL_GET_BLKLEN, NULL, NULL )
309 #define gcry_cipher_test_algo(a) \
310             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
311
312
313 /*********************************************
314  *******  asymmetric cipher functions  *******
315  *********************************************/
316
317 enum gcry_pk_algos {
318     GCRY_PK_RSA = 1,
319     GCRY_PK_RSA_E = 2,      /* use only for OpenPGP */
320     GCRY_PK_RSA_S = 3,      /* use only for OpenPGP */
321     GCRY_PK_ELG_E = 16,     /* use only for OpenPGP */
322     GCRY_PK_DSA   = 17,
323     GCRY_PK_ELG   = 20,
324 };
325
326 /* Flags describing usage capabilites/request of a PK algorithm */
327 #define GCRY_PK_USAGE_SIGN 1
328 #define GCRY_PK_USAGE_ENCR 2
329
330 int gcry_pk_encrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP pkey );
331 int gcry_pk_decrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
332 int gcry_pk_sign(    GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
333 int gcry_pk_verify(  GCRY_SEXP sigval, GCRY_SEXP data, GCRY_SEXP pkey );
334 int gcry_pk_testkey( GCRY_SEXP key );
335 int gcry_pk_genkey(  GCRY_SEXP *r_key, GCRY_SEXP s_parms );
336
337 int gcry_pk_ctl( int cmd, void *buffer, size_t buflen);
338 int gcry_pk_algo_info( int algo, int what, void *buffer, size_t *nbytes);
339 const char *gcry_pk_algo_name( int algo );
340 int gcry_pk_map_name( const char* name );
341 unsigned int gcry_pk_get_nbits( GCRY_SEXP key );
342
343
344 #define gcry_pk_test_algo(a) \
345             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
346
347 /*********************************************
348  *******  cryptograhic hash functions  *******
349  *********************************************/
350
351 enum gcry_md_algos {
352     GCRY_MD_NONE    = 0,
353     GCRY_MD_MD5     = 1,
354     GCRY_MD_SHA1    = 2,
355     GCRY_MD_RMD160  = 3,
356     GCRY_MD_TIGER   = 6
357 };
358
359 enum gcry_md_flags {
360     GCRY_MD_FLAG_SECURE = 1,
361     GCRY_MD_FLAG_HMAC   = 2
362 };
363
364
365 struct gcry_md_context;
366 struct gcry_md_handle {
367     struct gcry_md_context *ctx;
368     int  bufpos;
369     int  bufsize;
370     byte buf[1];
371 };
372 typedef struct gcry_md_handle *GCRY_MD_HD;
373
374
375 GCRY_MD_HD gcry_md_open( int algo, unsigned flags );
376 void gcry_md_close( GCRY_MD_HD hd );
377 int gcry_md_enable( GCRY_MD_HD hd, int algo );
378 GCRY_MD_HD gcry_md_copy( GCRY_MD_HD hd );
379 void gcry_md_reset( GCRY_MD_HD hd );
380 int gcry_md_ctl( GCRY_MD_HD hd, int cmd, byte *buffer, size_t buflen);
381 void gcry_md_write( GCRY_MD_HD hd, const byte *buffer, size_t length);
382 byte *gcry_md_read( GCRY_MD_HD hd, int algo );
383 void gcry_md_hash_buffer( int algo, char *digest,
384                           const char *buffer, size_t length);
385 int gcry_md_get_algo( GCRY_MD_HD hd );
386 unsigned int gcry_md_get_algo_dlen( int algo );
387 /*??int gcry_md_get( GCRY_MD_HD hd, int algo, byte *buffer, int buflen );*/
388 int gcry_md_info( GCRY_MD_HD h, int what, void *buffer, size_t *nbytes);
389 int gcry_md_algo_info( int algo, int what, void *buffer, size_t *nbytes);
390 const char *gcry_md_algo_name( int algo );
391 int gcry_md_map_name( const char* name );
392 int gcry_md_setkey( GCRY_MD_HD hd, const char *key, size_t keylen );
393
394 #define gcry_md_putc(h,c)  \
395             do {                                        \
396                 if( (h)->bufpos == (h)->bufsize )       \
397                     gcry_md_write( (h), NULL, 0 );      \
398                 (h)->buf[(h)->bufpos++] = (c) & 0xff;   \
399             } while(0)
400
401 #define gcry_md_final(a) \
402             gcry_md_ctl( (a), GCRYCTL_FINALIZE, NULL, 0 )
403
404 #define gcry_md_is_secure(a) \
405             gcry_md_info( (a), GCRYCTL_IS_SECURE, NULL, NULL )
406
407 #define gcry_md_test_algo(a) \
408             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
409
410 #define gcry_md_start_debug(a,b) \
411             gcry_md_ctl( (a), GCRYCTL_START_DUMP, (b), 0 )
412 #define gcry_md_stop_debug(a,b) \
413             gcry_md_ctl( (a), GCRYCTL_STOP_DUMP, (b), 0 )
414
415
416 /*********************************************
417  *******  random generating functions  *******
418  *********************************************/
419 void gcry_randomize( byte *buffer, size_t length,
420                      enum gcry_random_level level );
421 void *gcry_random_bytes( size_t nbytes, enum gcry_random_level level );
422 void *gcry_random_bytes_secure( size_t nbytes, enum gcry_random_level level );
423
424 /*****************************************
425  *******  miscellaneous stuff   **********
426  *****************************************/
427
428 enum gcry_log_levels {
429     GCRY_LOG_CONT   = 0,    /* continue the last log line */
430     GCRY_LOG_INFO   = 10,
431     GCRY_LOG_WARN   = 20,
432     GCRY_LOG_ERROR  = 30,
433     GCRY_LOG_FATAL  = 40,
434     GCRY_LOG_BUG    = 50,
435     GCRY_LOG_DEBUG  = 100,
436 };
437
438
439 /* Provide custom functions for special tasks of libgcrypt.
440  */
441 void gcry_set_allocation_handler( void *(*new_alloc_func)(size_t n),
442                                   void *(*new_alloc_secure_func)(size_t n),
443                                   int (*new_is_secure_func)(const void*),
444                                   void *(*new_realloc_func)(void *p, size_t n),
445                                   void (*new_free_func)(void*) );
446 void gcry_set_outofcore_handler( int (*h)( void*, size_t, unsigned int ),
447                                                                 void *opaque );
448 void gcry_set_fatalerror_handler( void (*fnc)(void*,int, const char*),
449                                                                 void *opaque );
450 void gcry_set_gettext_handler( const char *(*f)(const char*) );
451 void gcry_set_log_handler( void (*f)(void*,int, const char*, va_list ),
452                                                              void *opaque );
453
454
455 /* Access to the memory function of libgcrypt.
456  * Especially the gcry_free() should be used for memory
457  * allocated by gcry_ functions.
458  */
459 void *gcry_malloc( size_t n );
460 void *gcry_calloc( size_t n, size_t m );
461 void *gcry_malloc_secure( size_t n );
462 void *gcry_calloc_secure( size_t n, size_t m );
463 void *gcry_realloc( void *a, size_t n );
464 void *gcry_xmalloc( size_t n );
465 void *gcry_xcalloc( size_t n, size_t m );
466 void *gcry_xmalloc_secure( size_t n );
467 void *gcry_xcalloc_secure( size_t n, size_t m );
468 void *gcry_xrealloc( void *a, size_t n );
469 char *gcry_xstrdup( const char * a);
470 void  gcry_free( void *a );
471 int   gcry_is_secure( const void *a );
472
473
474 #ifndef GCRYPT_NO_MPI_MACROS
475 # ifndef DID_MPI_TYPEDEF
476     typedef struct gcry_mpi *MPI;
477 #   define DID_MPI_TYPEDEF
478 # endif
479 #endif /* GCRYPT_NO_MPI_MACROS */
480
481 #ifdef __cplusplus
482 }
483 #endif
484 #endif /* _GCRYPT_H */