See ChangeLog: Tue Oct 26 14:10:21 CEST 1999 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 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 #ifndef GCRYPT_NO_MPI_MACROS
28 #define GCRYPT_NO_MPI_MACROS
29 #endif
30
31 #ifndef HAVE_BYTE_TYPEDEF
32   #undef byte       /* maybe there is a macro with this name */
33   typedef unsigned char byte;
34   #define HAVE_BYTE_TYPEDEF
35 #endif
36
37 /*******************************************
38  *                                         *
39  *  error handling etc.                    *
40  *                                         *
41  *******************************************/
42
43 enum {
44     GCRYERR_SUCCESS = 0,    /* "no error" */
45     GCRYERR_GENERAL = 1,    /* catch all the other errors code */
46     GCRYERR_INV_OP = 2,     /* invalid operation code or ctl command */
47     GCRYERR_NOMEM = 3,      /* out of core */
48     GCRYERR_INV_ALGO = 4,   /* invalid algorithm */
49     GCRYERR_INV_ARG = 5,    /* invalid argument */
50     GCRYERR_INTERNAL = 6,   /* internal error */
51     GCRYERR_EOF = 7,        /* (-1) is remapped to this value */
52     GCRYERR_TOO_SHORT = 8,  /* provided buffer too short */
53     GCRYERR_TOO_LARGE = 9,  /* object is too large */
54     GCRYERR_INV_OBJ = 10,   /* an object is not valid */
55     GCRYERR_WEAK_KEY = 11,  /* weak encryption key */
56 };
57
58
59 int gcry_errno(void);
60 const char *gcry_strerror( int ec );
61
62 enum gcry_ctl_cmds {
63     GCRYCTL_SET_KEY  = 1,
64     GCRYCTL_SET_IV   = 2,
65     GCRYCTL_CFB_SYNC = 3,
66     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
67     GCRYCTL_FINALIZE = 5,
68     GCRYCTL_GET_KEYLEN = 6,
69     GCRYCTL_GET_BLKLEN = 7,
70     GCRYCTL_TEST_ALGO = 8,
71     GCRYCTL_IS_SECURE = 9,
72     GCRYCTL_GET_ASNOID = 10,
73     GCRYCTL_ENABLE_ALGO = 11,
74     GCRYCTL_DISABLE_ALGO = 12,
75 };
76
77 int gcry_control( enum gcry_ctl_cmds, ... );
78
79 enum gcry_random_level {
80     GCRY_WEAK_RANDOM = 0,
81     GCRY_STRONG_RANDOM = 1,
82     GCRY_VERY_STRONG_RANDOM = 2
83 };
84
85
86 struct gcry_sexp;
87 typedef struct gcry_sexp *GCRY_SEXP;
88
89 enum gcry_sexp_format {
90     GCRYSEXP_FMT_DEFAULT   = 0,
91     GCRYSEXP_FMT_CANON     = 1,
92     GCRYSEXP_FMT_BASE64    = 2,
93     GCRYSEXP_FMT_ADVANCED  = 3,
94 };
95
96
97 GCRY_SEXP gcry_sexp_new( const char *buffer, size_t length );
98 void gcry_sexp_release( GCRY_SEXP sexp );
99 GCRY_SEXP gcry_sexp_cons( GCRY_SEXP a, GCRY_SEXP b );
100 GCRY_SEXP gcry_sexp_vlist( GCRY_SEXP a, ... );
101 int  gcry_sexp_sscan( GCRY_SEXP *retsexp, const char *buffer,
102                                size_t length, size_t *erroff );
103 size_t gcry_sexp_sprint( GCRY_SEXP sexp, int mode, char *buffer,
104                                                 size_t maxlength );
105
106 #ifndef GCRYPT_NO_SEXP_MACROS
107 #define SEXP            GCRY_SEXP
108 #define SEXP_NEW(a,b)   gcry_sexp_new_data( (a), (b) )
109 #define SEXP_RELEASE(a) do { gcry_sexp_release( (a) ); (a)=NULL; } while(0)
110 #define SEXP_CONS(a,b)  gcry_sexp_cons((a),(b))
111 #endif /*GCRYPT_NO_SEXP_MACROS*/
112
113 /*******************************************
114  *                                         *
115  *  multi precision integer functions      *
116  *                                         *
117  *******************************************/
118
119 enum gcry_mpi_format {
120     GCRYMPI_FMT_STD = 0,    /* twos complement stored without length */
121     GCRYMPI_FMT_PGP = 1,    /* As used by OpenPGP */
122     GCRYMPI_FMT_SSH = 2,    /* As used by SSH (same as 0 but with length)*/
123     GCRYMPI_FMT_HEX = 3,    /* hex format */
124     GCRYMPI_FMT_USG = 4,    /* like STD but this is an unsigned one */
125 };
126
127
128 struct gcry_mpi;
129 typedef struct gcry_mpi *GCRY_MPI;
130
131 GCRY_MPI gcry_mpi_new( unsigned int nbits );
132 GCRY_MPI gcry_mpi_snew( unsigned int nbits );
133 void     gcry_mpi_release( GCRY_MPI a );
134 GCRY_MPI gcry_mpi_copy( const GCRY_MPI a );
135 GCRY_MPI gcry_mpi_set( GCRY_MPI w, const GCRY_MPI u );
136 GCRY_MPI gcry_mpi_set_ui( GCRY_MPI w, unsigned long u );
137 int      gcry_mpi_cmp( const GCRY_MPI u, const GCRY_MPI v );
138 int      gcry_mpi_cmp_ui( const GCRY_MPI u, unsigned long v );
139 void     gcry_mpi_randomize( GCRY_MPI w,
140                              unsigned int nbits, enum gcry_random_level level);
141 int      gcry_mpi_scan( GCRY_MPI *ret_mpi, enum gcry_mpi_format format,
142                                        const char *buffer, size_t *nbytes );
143 int      gcry_mpi_print( enum gcry_mpi_format format,
144                          char *buffer, size_t *nbytes, const GCRY_MPI a );
145
146 void gcry_mpi_powm( GCRY_MPI w,
147                     const GCRY_MPI b, const GCRY_MPI e, const GCRY_MPI m );
148
149
150 #ifndef GCRYPT_NO_MPI_MACROS
151 #define mpi_new(n)          gcry_mpi_new( (n) )
152 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
153 #define mpi_release( a )    do { gcry_mpi_release( (a) ); \
154                                  (a) = NULL; } while(0)
155 #define mpi_copy( a )       gcry_mpi_copy( (a) )
156 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
157 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
158 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
159 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
160
161 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
162 #endif /* GCRYPT_NO_MPI_MACROS */
163
164 /********************************************
165  *******  symmetric cipher functions  *******
166  ********************************************/
167
168 struct gcry_cipher_handle;
169 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD;
170
171 enum gcry_cipher_algos {
172     GCRY_CIPHER_NONE        = 0,
173     GCRY_CIPHER_IDEA        = 1,
174     GCRY_CIPHER_3DES        = 2,
175     GCRY_CIPHER_CAST5       = 3,
176     GCRY_CIPHER_BLOWFISH    = 4,
177     GCRY_CIPHER_SAFER_SK128 = 5,
178     GCRY_CIPHER_DES_SK      = 6
179 };
180
181 enum gcry_cipher_modes {
182     GCRY_CIPHER_MODE_NONE   = 0,
183     GCRY_CIPHER_MODE_ECB    = 1,
184     GCRY_CIPHER_MODE_CFB    = 2,
185     GCRY_CIPHER_MODE_CBC    = 3,
186 };
187
188 enum gcry_cipher_flags {
189     GCRY_CIPHER_SECURE      = 1,  /* allocate in secure memory */
190     GCRY_CIPHER_ENABLE_SYNC = 2,  /* enable CFB sync mode */
191 };
192
193
194 GCRY_CIPHER_HD gcry_cipher_open( int algo, int mode, unsigned flags);
195 void gcry_cipher_close( GCRY_CIPHER_HD h );
196 int  gcry_cipher_ctl( GCRY_CIPHER_HD h, int cmd, void *buffer, size_t buflen);
197 int gcry_cipher_info( GCRY_CIPHER_HD h, int what, void *buffer, size_t *nbytes);
198 int gcry_cipher_algo_info( int algo, int what, void *buffer, size_t *nbytes);
199 const char *gcry_cipher_algo_name( int algo );
200 int gcry_cipher_map_name( const char* name );
201
202 int gcry_cipher_encrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
203                                       const byte *in, size_t inlen );
204 int gcry_cipher_decrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
205                                       const byte *in, size_t inlen );
206
207
208 /* some handy macros */
209 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
210                                                                   (k), (l) )
211 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
212                                                                   (k), (l) )
213 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
214                                                                    NULL, 0 )
215
216 #define gcry_cipher_get_algo_keylen(a) \
217             gcry_cipher_algo_info( (a), GCRYCTL_GET_KEYLEN, NULL, NULL )
218 #define gcry_cipher_get_algo_blklen(a) \
219             gcry_cipher_algo_info( (a), GCRYCTL_GET_BLKLEN, NULL, NULL )
220 #define gcry_cipher_test_algo(a) \
221             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
222
223
224 /*********************************************
225  *******  asymmetric cipher functions  *******
226  *********************************************/
227
228 int gcry_pk_encrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP pkey );
229 int gcry_pk_decrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
230 int gcry_pk_sign(    GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
231 int gcry_pk_verify(  GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP pkey );
232
233 int gcry_pk_algo_info( int algo, int what, void *buffer, size_t *nbytes);
234 const char *gcry_pk_algo_name( int algo );
235 int gcry_pk_map_name( const char* name );
236
237
238 #define gcry_pk_test_algo(a) \
239             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
240
241 /*********************************************
242  *******  cryptograhic hash functions  *******
243  *********************************************/
244
245 enum gcry_md_algos {
246     GCRY_MD_NONE    = 0,
247     GCRY_MD_MD5     = 1,
248     GCRY_MD_SHA1    = 2,
249     GCRY_MD_RMD160  = 3,
250     GCRY_MD_TIGER   = 6
251 };
252
253 enum gcry_md_flags {
254     GCRY_MD_FLAG_SECURE = 1
255 };
256
257
258 struct gcry_md_context;
259 struct gcry_md_handle {
260     struct gcry_md_context *ctx;
261     int  bufpos;
262     int  bufsize;
263     byte buf[1];
264 };
265 typedef struct gcry_md_handle *GCRY_MD_HD;
266
267
268 GCRY_MD_HD gcry_md_open( int algo, unsigned flags );
269 void gcry_md_close( GCRY_MD_HD hd );
270 int gcry_md_enable( GCRY_MD_HD hd, int algo );
271 GCRY_MD_HD gcry_md_copy( GCRY_MD_HD hd );
272 void gcry_md_reset( GCRY_MD_HD hd );
273 int gcry_md_ctl( GCRY_MD_HD hd, int cmd, byte *buffer, size_t buflen);
274 void gcry_md_write( GCRY_MD_HD hd, const byte *buffer, size_t length);
275 byte *gcry_md_read( GCRY_MD_HD hd, int algo );
276 int gcry_md_get_algo( GCRY_MD_HD hd );
277 unsigned int gcry_md_get_algo_dlen( int algo );
278 /*??int gcry_md_get( GCRY_MD_HD hd, int algo, byte *buffer, int buflen );*/
279 int gcry_md_info( GCRY_MD_HD h, int what, void *buffer, size_t *nbytes);
280 int gcry_md_algo_info( int algo, int what, void *buffer, size_t *nbytes);
281 const char *gcry_md_algo_name( int algo );
282 int gcry_md_map_name( const char* name );
283
284 #define gcry_md_putc(h,c)  \
285             do {                                        \
286                 if( (h)->bufpos == (h)->bufsize )       \
287                     gcry_md_write( (h), NULL, 0 );      \
288                 (h)->buf[(h)->bufpos++] = (c) & 0xff;   \
289             } while(0)
290
291 #define gcry_md_final(a) \
292             gcry_md_ctl( (a), GCRYCTL_FINALIZE, NULL, 0 )
293
294 #define gcry_md_is_secure(a) \
295             gcry_md_info( (a), GCRYCTL_IS_SECURE, NULL, NULL )
296
297 #define gcry_md_test_algo(a) \
298             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
299
300 /*****************************************
301  *******  miscellaneous functions  *******
302  *****************************************/
303
304 #if 0
305 const char *g10m_revision_string(int mode);
306 const char *g10c_revision_string(int mode);
307 const char *g10u_revision_string(int mode);
308
309 MPI   g10c_generate_secret_prime( unsigned nbits );
310 char *g10c_get_random_bits( unsigned nbits, int level, int secure );
311
312
313 void *g10_malloc( size_t n );
314 void *g10_calloc( size_t n );
315 void *g10_malloc_secure( size_t n );
316 void *g10_calloc_secure( size_t n );
317 void *g10_realloc( void *a, size_t n );
318 void  g10_free( void *p );
319 char *g10_strdup( const char * a);
320
321 void g10_log_bug( const char *fmt, ... );
322 void g10_log_bug0( const char *, int );
323 void g10_log_fatal( const char *fmt, ... );
324 void g10_log_error( const char *fmt, ... );
325 void g10_log_info( const char *fmt, ... );
326 void g10_log_debug( const char *fmt, ... );
327 void g10_log_hexdump( const char *text, char *buf, size_t len );
328 void g10_log_mpidump( const char *text, MPI a );
329 #endif
330
331 /***************************
332  *******  constants  *******
333  **************************/
334 #if 0
335 #define CIPHER_ALGO_NONE         0
336 #define CIPHER_ALGO_IDEA         1
337 #define CIPHER_ALGO_3DES         2
338 #define CIPHER_ALGO_CAST5        3
339 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
340 #define CIPHER_ALGO_SAFER_SK128  5
341 #define CIPHER_ALGO_DES_SK       6
342 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
343
344 #define PUBKEY_ALGO_RSA        1
345 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
346 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
347 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not for v3)*/
348 #define PUBKEY_ALGO_DSA       17
349 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
350
351 #define DIGEST_ALGO_MD5       1
352 #define DIGEST_ALGO_SHA1      2
353 #define DIGEST_ALGO_RMD160    3
354 #define DIGEST_ALGO_TIGER     6
355
356 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
357                        || (a)==PUBKEY_ALGO_RSA_S )
358 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
359
360 #define G10ERR_GENERAL         1
361 #define G10ERR_PUBKEY_ALGO     4
362 #define G10ERR_DIGEST_ALGO     5
363 #define G10ERR_BAD_PUBKEY      6
364 #define G10ERR_BAD_SECKEY      7
365 #define G10ERR_BAD_SIGN        8
366 #define G10ERR_CIPHER_ALGO    12
367 #define G10ERR_WRONG_SECKEY   18
368 #define G10ERR_UNSUPPORTED    19
369 #define G10ERR_NI_PUBKEY      27
370 #define G10ERR_NI_CIPHER      28
371 #define G10ERR_BAD_MPI        30
372 #define G10ERR_WR_PUBKEY_ALGO 41
373 #endif
374
375 /***********************************************
376  *                                             *
377  *   Some very handy macros                    *
378  *                                             *
379  ***********************************************/
380 #ifndef GCRYPT_NO_MPI_MACROS
381
382 typedef struct gcry_mpi *MPI;
383
384 #endif /* GCRYPT_NO_MPI_MACROS */
385
386 #ifdef __cplusplus
387 }
388 #endif
389
390
391 /*****************************************
392  ******** Stuff to be changed ************
393  *****************************************/
394
395 /*-- cipher/pubkey.c --*/
396 #define PUBKEY_MAX_NPKEY  4
397 #define PUBKEY_MAX_NSKEY  6
398 #define PUBKEY_MAX_NSIG   2
399 #define PUBKEY_MAX_NENC   2
400
401 #ifndef DID_MPI_TYPEDEF
402  typedef struct gcry_mpi * MPI;
403  #define DID_MPI_TYPEDEF
404 #endif
405
406 int string_to_pubkey_algo( const char *string );
407 const char * pubkey_algo_to_string( int algo );
408 void disable_pubkey_algo( int algo );
409 int check_pubkey_algo( int algo );
410 int check_pubkey_algo2( int algo, unsigned use );
411 int pubkey_get_npkey( int algo );
412 int pubkey_get_nskey( int algo );
413 int pubkey_get_nsig( int algo );
414 int pubkey_get_nenc( int algo );
415 unsigned pubkey_nbits( int algo, MPI *pkey );
416 int pubkey_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors );
417 int pubkey_check_secret_key( int algo, MPI *skey );
418 int pubkey_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey );
419 int pubkey_decrypt( int algo, MPI *result, MPI *data, MPI *skey );
420 int pubkey_sign( int algo, MPI *resarr, MPI hash, MPI *skey );
421 int pubkey_verify( int algo, MPI hash, MPI *data, MPI *pkey,
422                       int (*cmp)(void *, MPI), void *opaque );
423
424
425
426
427 /*-- primegen.c --*/
428 MPI generate_secret_prime( unsigned nbits );
429 MPI generate_public_prime( unsigned nbits );
430 MPI generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
431                                            MPI g, MPI **factors );
432
433
434
435 #endif /* _GCRYPT_H */