See ChangeLog: Thu Jul 8 16:21:27 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
28 #ifndef HAVE_BYTE_TYPEDEF
29   #undef byte       /* maybe there is a macro with this name */
30   typedef unsigned char byte;
31   #define HAVE_BYTE_TYPEDEF
32 #endif
33
34 /*******************************************
35  *                                         *
36  *  error handling etc.                    *
37  *                                         *
38  *******************************************/
39
40 enum {
41     GCRYERR_SUCCESS = 0,    /* "no error" */
42     GCRYERR_GENERAL = 1,    /* catch all the other errors code */
43     GCRYERR_INV_OP = 2,     /* invalid operation code or ctl command */
44     GCRYERR_NOMEM = 3,      /* out of core */
45     GCRYERR_INV_ALGO = 4,   /* invalid algorithm */
46     GCRYERR_INV_ARG = 5,    /* invalid argument */
47     GCRYERR_INTERNAL = 6,   /* internal error */
48     GCRYERR_EOF = 7,        /* (-1) is remapped to this value */
49     GCRYERR_TOO_SHORT = 8,  /* provided buffer too short */
50     GCRYERR_TOO_LARGE = 9,  /* object is too large */
51     GCRYERR_INV_OBJ = 10,   /* an object is not valid */
52 };
53
54
55 int gcry_errno(void);
56 const char *gcry_strerror( int ec );
57
58 enum gcry_ctl_cmds {
59     GCRYCTL_SET_KEY  = 1,
60     GCRYCTL_SET_IV   = 2,
61     GCRYCTL_CFB_SYNC = 3,
62     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
63     GCRYCTL_FINALIZE = 5,
64 };
65
66 int gcry_control( enum gcry_ctl_cmds, ... );
67
68 enum gcry_random_level {
69     GCRY_WEAK_RANDOM = 0,
70     GCRY_STRONG_RANDOM = 1,
71     GCRY_VERY_STRONG_RANDOM = 2
72 };
73
74
75 struct gcry_sexp;
76 typedef struct gcry_sexp *GCRY_SEXP;
77
78 enum gcry_sexp_format {
79     GCRY_SEXP_FMT_DEFAULT   = 0,
80     GCRY_SEXP_FMT_CANON     = 1,
81     GCRY_SEXP_FMT_BASE64    = 2,
82     GCRY_SEXP_FMT_ADVANCED  = 3,
83 };
84
85
86 GCRY_SEXP gcry_sexp_new( const char *buffer, size_t length );
87 void gcry_sexp_release( GCRY_SEXP sexp );
88 GCRY_SEXP gcry_sexp_cons( GCRY_SEXP a, GCRY_SEXP b );
89 GCRY_SEXP gcry_sexp_vlist( GCRY_SEXP a, ... );
90 int  gcry_sexp_sscan( GCRY_SEXP *retsexp, const char *buffer,
91                                size_t length, size_t *erroff );
92 size_t gcry_sexp_sprint( GCRY_SEXP sexp, int mode, char *buffer,
93                                                 size_t maxlength );
94
95 #ifndef GCRYPT_NO_SEXP_MACROS
96 #define SEXP            GCRY_SEXP
97 #define SEXP_NEW(a,b)   gcry_sexp_new( (a), (b) )
98 #define SEXP_RELEASE(a) do { gcry_sexp_release( (a) ); (a)=NULL; } while(0)
99 #define SEXP_CONS(a,b)  gcry_sexp_cons((a),(b))
100 #endif /*GCRYPT_NO_SEXP_MACROS*/
101
102 /*******************************************
103  *                                         *
104  *  multi precision integer functions      *
105  *                                         *
106  *******************************************/
107
108 enum gcry_mpi_format {
109     GCRYMPI_FMT_STD = 0,    /* As used by OpenPGP */
110     GCRYMPI_FMT_SSH = 1,    /* As used by SSH */
111     GCRYMPI_FMT_HEX = 2,    /* hex format */
112 };
113
114 struct gcry_mpi;
115 typedef struct gcry_mpi *GCRY_MPI;
116
117 GCRY_MPI gcry_mpi_new( unsigned int nbits );
118 GCRY_MPI gcry_mpi_snew( unsigned int nbits );
119 void     gcry_mpi_release( GCRY_MPI a );
120 GCRY_MPI gcry_mpi_copy( const GCRY_MPI a );
121 GCRY_MPI gcry_mpi_set( GCRY_MPI w, const GCRY_MPI u );
122 GCRY_MPI gcry_mpi_set_ui( GCRY_MPI w, unsigned long u );
123 int      gcry_mpi_cmp( const GCRY_MPI u, const GCRY_MPI v );
124 int      gcry_mpi_cmp_ui( const GCRY_MPI u, unsigned long v );
125 void     gcry_mpi_randomize( GCRY_MPI w,
126                              unsigned int nbits, enum gcry_random_level level);
127 int      gcry_mpi_scan( GCRY_MPI *ret_mpi, enum gcry_mpi_format format,
128                                        const char *buffer, size_t *nbytes );
129 int      gcry_mpi_print( enum gcry_mpi_format format,
130                          char *buffer, size_t *nbytes, const GCRY_MPI a );
131
132 void gcry_mpi_powm( GCRY_MPI w,
133                     const GCRY_MPI b, const GCRY_MPI e, const GCRY_MPI m );
134
135
136 #ifndef GCRYPT_NO_MPI_MACROS
137 #define mpi_new(n)          gcry_mpi_new( (n) )
138 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
139 #define mpi_release( a )    do { gcry_mpi_release( (a) ); \
140                                  (a) = NULL; } while(0)
141 #define mpi_copy( a )       gcry_mpi_copy( (a) )
142 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
143 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
144 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
145 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
146
147 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
148 #endif /* GCRYPT_NO_MPI_MACROS */
149
150 /********************************************
151  *******  symmetric cipher functions  *******
152  ********************************************/
153
154 struct gcry_cipher_context;
155 typedef struct gcry_cipher_context *GCRY_CIPHER_HD;
156
157 enum gcry_cipher_algos {
158     GCRY_CIPHER_NONE        = 0,
159     GCRY_CIPHER_IDEA        = 1,
160     GCRY_CIPHER_3DES        = 2,
161     GCRY_CIPHER_CAST5       = 3,
162     GCRY_CIPHER_BLOWFISH    = 4,
163     GCRY_CIPHER_SAFER_SK128 = 5,
164     GCRY_CIPHER_DES_SK      = 6
165 };
166
167 enum gcry_cipher_modes {
168     GCRY_CIPHER_MODE_NONE   = 0,
169     GCRY_CIPHER_MODE_ECB    = 1,
170     GCRY_CIPHER_MODE_CFB    = 2,
171     GCRY_CIPHER_MODE_CBC    = 3,
172 };
173
174 enum gcry_cipher_flags {
175     GCRY_CIPHER_SECURE      = 1,  /* allocate in secure memory */
176     GCRY_CIPHER_ENABLE_SYNC = 2,  /* enable CFB sync mode */
177 };
178
179
180 #if 0 /* not yet done */
181 int gcry_string_to_cipher_algo( const char *string );
182 const char * gcry_cipher_algo_to_string( int algo );
183 int gcry_check_cipher_algo( int algo );
184 unsigned gcry_cipher_get_keylen( int algo );
185 unsigned gcry_cipher_get_blocksize( int algo );
186 #endif
187
188 int gcry_cipher_open( GCRY_CIPHER_HD *rhd, int algo, int mode, unsigned flags);
189 void gcry_cipher_close( GCRY_CIPHER_HD h );
190 int  gcry_cipher_ctl( GCRY_CIPHER_HD h, int cmd, byte *buffer, size_t buflen);
191
192 int gcry_cipher_encrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
193                                             byte *in, size_t inlen );
194 int gcry_cipher_decrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
195                                             byte *in, size_t inlen );
196
197
198 /* some handy macros */
199 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
200                                                                   (k), (l) )
201 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
202                                                                   (k), (l) )
203 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
204                                                                    NULL, 0 )
205
206
207 /*********************************************
208  *******  asymmetric cipher functions  *******
209  *********************************************/
210
211 int gcry_pk_encrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP pkey );
212 int gcry_pk_decrypt( GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
213 int gcry_pk_sign(    GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP skey );
214 int gcry_pk_verify(  GCRY_SEXP *result, GCRY_SEXP data, GCRY_SEXP pkey );
215
216
217 /*********************************************
218  *******  cryptograhic hash functions  *******
219  *********************************************/
220
221 struct gcry_md_context;
222 typedef struct gcry_md_context *GCRY_MD_HD; /* same as the old MD_HANDLE */
223
224 enum gcry_md_algos {
225     GCRY_MD_NONE    = 0,
226     GCRY_MD_MD5     = 1,
227     GCRY_MD_SHA1    = 2,
228     GCRY_MD_RMD160  = 3,
229     GCRY_MD_TIGER   = 6
230 };
231
232 enum gcry_md_flags {
233     GCRY_MD_FLAG_SECURE = 1
234 };
235
236
237 int gcry_md_open( GCRY_MD_HD *ret_hd, int algo, unsigned flags );
238 void gcry_md_close( GCRY_MD_HD hd );
239 int gcry_md_enable( GCRY_MD_HD hd, int algo );
240 GCRY_MD_HD gcry_md_copy( GCRY_MD_HD hd );
241 int gcry_md_ctl( GCRY_MD_HD hd, int cmd, byte *buffer, size_t buflen);
242 void gcry_md_write( GCRY_MD_HD hd, const byte *buffer, size_t length);
243 byte *gcry_md_read( GCRY_MD_HD hd, int algo );
244 int gcry_md_algo( GCRY_MD_HD hd );
245 size_t gcry_md_dlen( int algo );
246 int gcry_md_get( GCRY_MD_HD hd, int algo, byte *buffer, int buflen );
247
248
249 /*****************************************
250  *******  miscellaneous functions  *******
251  *****************************************/
252
253 #if 0
254 const char *g10m_revision_string(int mode);
255 const char *g10c_revision_string(int mode);
256 const char *g10u_revision_string(int mode);
257
258 MPI   g10c_generate_secret_prime( unsigned nbits );
259 char *g10c_get_random_bits( unsigned nbits, int level, int secure );
260
261
262 void *g10_malloc( size_t n );
263 void *g10_calloc( size_t n );
264 void *g10_malloc_secure( size_t n );
265 void *g10_calloc_secure( size_t n );
266 void *g10_realloc( void *a, size_t n );
267 void  g10_free( void *p );
268 char *g10_strdup( const char * a);
269
270 void g10_log_bug( const char *fmt, ... );
271 void g10_log_bug0( const char *, int );
272 void g10_log_fatal( const char *fmt, ... );
273 void g10_log_error( const char *fmt, ... );
274 void g10_log_info( const char *fmt, ... );
275 void g10_log_debug( const char *fmt, ... );
276 void g10_log_hexdump( const char *text, char *buf, size_t len );
277 void g10_log_mpidump( const char *text, MPI a );
278 #endif
279
280 /***************************
281  *******  constants  *******
282  **************************/
283 #if 0
284 #define CIPHER_ALGO_NONE         0
285 #define CIPHER_ALGO_IDEA         1
286 #define CIPHER_ALGO_3DES         2
287 #define CIPHER_ALGO_CAST5        3
288 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
289 #define CIPHER_ALGO_SAFER_SK128  5
290 #define CIPHER_ALGO_DES_SK       6
291 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
292
293 #define PUBKEY_ALGO_RSA        1
294 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
295 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
296 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not for v3)*/
297 #define PUBKEY_ALGO_DSA       17
298 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
299
300 #define DIGEST_ALGO_MD5       1
301 #define DIGEST_ALGO_SHA1      2
302 #define DIGEST_ALGO_RMD160    3
303 #define DIGEST_ALGO_TIGER     6
304
305 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
306                        || (a)==PUBKEY_ALGO_RSA_S )
307 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
308
309 #define G10ERR_GENERAL         1
310 #define G10ERR_PUBKEY_ALGO     4
311 #define G10ERR_DIGEST_ALGO     5
312 #define G10ERR_BAD_PUBKEY      6
313 #define G10ERR_BAD_SECKEY      7
314 #define G10ERR_BAD_SIGN        8
315 #define G10ERR_CIPHER_ALGO    12
316 #define G10ERR_WRONG_SECKEY   18
317 #define G10ERR_UNSUPPORTED    19
318 #define G10ERR_NI_PUBKEY      27
319 #define G10ERR_NI_CIPHER      28
320 #define G10ERR_BAD_MPI        30
321 #define G10ERR_WR_PUBKEY_ALGO 41
322 #endif
323
324 /***********************************************
325  *                                             *
326  *   Some very handy macros                    *
327  *                                             *
328  ***********************************************/
329 #ifndef GCRYPT_NO_MPI_MACROS
330
331 typedef struct gcry_mpi *MPI;
332
333
334 #endif /* GCRYPT_NO_MPI_MACROS */
335
336 #ifdef __cplusplus
337 }
338 #endif
339 #endif /* _GCRYPT_H */