See ChangeLog: Fri Apr 9 12:26:25 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_TOO_SHORT = 7,  /* provided buffer too short */
49     GCRYERR_EOF = 8,        /* (-1) is remapped to this value */
50 };
51
52
53 int gcry_errno(void);
54 const char *gcry_strerror( int ec );
55
56 enum gcry_ctl_cmds {
57     GCRYCTL_SET_KEY  = 1,
58     GCRYCTL_SET_IV   = 2,
59     GCRYCTL_CFB_SYNC = 3,
60     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
61     GCRYCTL_FINALIZE = 5,
62 };
63
64 int gcry_control( enum gcry_ctl_cmds, ... );
65
66
67 /*******************************************
68  *                                         *
69  *  multi precision integer functions      *
70  *                                         *
71  *******************************************/
72
73 enum gcry_mpi_opcode {
74     GCRYMPI_NOOP = 0,
75     GCRYMPI_NEW  = 1,       /* use gcry_mpi_new() */
76     GCRYMPI_SNEW = 2,       /* use gcry_mpi_new() */
77     GCRYMPI_RELEASE = 3,
78     GCRYMPI_RESIZE = 4,
79     GCRYMPI_COPY = 5,       /* use gcry_mpi_new() */
80     GCRYMPI_SWAP = 6,
81     GCRYMPI_SET  = 7,
82     GCRYMPI_SET_UI = 8,
83     GCRYMPI_CMP    = 9,
84     GCRYMPI_CMP_UI = 10
85 };
86
87 struct gcry_mpi;
88
89 int gcry_mpi_api( enum gcry_mpi_opcode opcode, int n_args, ... );
90 struct gcry_mpi *gcry_mpi_new( enum gcry_mpi_opcode opcode,
91                                unsigned int size,
92                                struct gcry_mpi *val
93                               );
94
95 #ifndef GCRYPT_NO_MPI_MACROS
96 #define mpi_new( nbits )  gcry_mpi_new( GCRYMPI_NEW, (nbits), NULL )
97 #define mpi_secure_new( nbits )  gcry_mpi_new( GCRYMPI_SNEW, (nbits), NULL )
98 #define mpi_release( a )     do {   gcry_mpi_api( GCRYMPI_RELEASE, 1, (a) ); \
99                                     (a) = NULL; } while(0)
100 #define mpi_resize( a, n )  gcry_mpi_api( GCRYMPI_RESIZE, 2, (a), (n) )
101 #define mpi_copy( a )       gcry_mpi_new( GCRYMPI_COPY, 0, (a) )
102 #define mpi_swap( a, b )    gcyr_mpi_api( GCRYMPI_SWAP, 2, (a), (b) )
103 /* void mpi_set( MPI w, MPI u ); */
104 #define mpi_set( w, u)      gcry_mpi_api( GCRYMPI_SET, 2, (w), (u) )
105 /* void mpi_set_ui( MPI w, unsigned long u ); */
106 #define mpi_set_ui( w, u)   gcry_mpi_api( GCRYMPI_SET_UI, 2, (w), (u) )
107 /* int  mpi_cmp( MPI u, MPI v ); */
108 #define mpi_cmp( u, v )     gcry_mpi_api( GCRYMPI_CMP, 2, (u), (v) )
109 /* int  mpi_cmp_ui( MPI u, unsigned long v ); */
110 #define mpi_cmp_ui( u, v )  gcry_mpi_api( GCRYMPI_CMP_UI, 2, (u), (v) )
111
112 #if 0
113 void g10m_add(MPI w, MPI u, MPI v);
114 void g10m_add_ui(MPI w, MPI u, unsigned long v );
115 void g10m_sub( MPI w, MPI u, MPI v);
116 void g10m_sub_ui(MPI w, MPI u, unsigned long v );
117
118 void g10m_mul_ui(MPI w, MPI u, unsigned long v );
119 void g10m_mul_2exp( MPI w, MPI u, unsigned long cnt);
120 void g10m_mul( MPI w, MPI u, MPI v);
121 void g10m_mulm( MPI w, MPI u, MPI v, MPI m);
122
123 void g10m_fdiv_q( MPI quot, MPI dividend, MPI divisor );
124
125 void g10m_powm( MPI res, MPI base, MPI exp, MPI mod);
126
127 int  g10m_gcd( MPI g, MPI a, MPI b );
128 int  g10m_invm( MPI x, MPI u, MPI v );
129
130 unsigned g10m_get_nbits( MPI a );
131 unsigned g10m_get_size( MPI a );
132
133 void g10m_set_buffer( MPI a, const char *buffer, unsigned nbytes, int sign );
134 #endif
135
136 #endif /* GCRYPT_NO_MPI_MACROS */
137
138 /********************************************
139  *******  symmetric cipher functions  *******
140  ********************************************/
141
142 struct gcry_cipher_context;
143 typedef struct gcry_cipher_context *GCRY_CIPHER_HD;
144
145 enum gcry_cipher_algos {
146     GCRY_CIPHER_NONE        = 0,
147     GCRY_CIPHER_IDEA        = 1,
148     GCRY_CIPHER_3DES        = 2,
149     GCRY_CIPHER_CAST5       = 3,
150     GCRY_CIPHER_BLOWFISH    = 4,
151     GCRY_CIPHER_SAFER_SK128 = 5,
152     GCRY_CIPHER_DES_SK      = 6
153 };
154
155 enum gcry_cipher_modes {
156     GCRY_CIPHER_MODE_NONE   = 0,
157     GCRY_CIPHER_MODE_ECB    = 1,
158     GCRY_CIPHER_MODE_CFB    = 2,
159 };
160
161 enum gcry_cipher_flags {
162     GCRY_CIPHER_SECURE      = 1,  /* allocate in secure memory */
163     GCRY_CIPHER_ENABLE_SYNC = 2,  /* enable CFB sync mode */
164 };
165
166
167 #if 0 /* not yet done */
168 int gcry_string_to_cipher_algo( const char *string );
169 const char * gcry_cipher_algo_to_string( int algo );
170 int gcry_check_cipher_algo( int algo );
171 unsigned gcry_cipher_get_keylen( int algo );
172 unsigned gcry_cipher_get_blocksize( int algo );
173 #endif
174
175 GCRY_CIPHER_HD gcry_cipher_open( int algo, int mode, unsigned flags );
176 void gcry_cipher_close( GCRY_CIPHER_HD h );
177 int  gcry_cipher_ctl( GCRY_CIPHER_HD h, int cmd, byte *buffer, size_t buflen);
178
179 int gcry_cipher_encrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
180                                             byte *in, size_t inlen );
181 int gcry_cipher_decrypt( GCRY_CIPHER_HD h, byte *out, size_t outsize,
182                                             byte *in, size_t inlen );
183
184
185 /* some handy macros */
186 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
187                                                                   (k), (l) )
188 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
189                                                                   (k), (l) )
190 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
191                                                                    NULL, 0 )
192
193
194 /*********************************************
195  *******  asymmetric cipher functions  *******
196  *********************************************/
197
198
199
200
201 /*********************************************
202  *******  cryptograhic hash functions  *******
203  *********************************************/
204
205 struct gcry_md_context;
206 typedef struct gcry_md_context *GCRY_MD_HD;
207
208 enum gcry_md_algos {
209     GCRY_MD_NONE    = 0,
210     GCRY_MD_MD5     = 1,
211     GCRY_MD_SHA1    = 2,
212     GCRY_MD_RMD160  = 3,
213     GCRY_MD_TIGER   = 6
214 };
215
216 enum gcry_md_flags {
217     GCRY_MD_FLAG_SECURE = 1
218 };
219
220
221 GCRY_MD_HD gcry_md_open( int algo, unsigned flags );
222 void gcry_md_close( GCRY_MD_HD hd );
223 void gcry_md_enable( GCRY_MD_HD hd, int algo );
224 GCRY_MD_HD gcry_md_copy( GCRY_MD_HD hd );
225 int gcry_md_ctl( GCRY_MD_HD hd, int cmd, byte *buffer, size_t buflen);
226 void gcry_md_write( GCRY_MD_HD hd, byte *inbuf, size_t inlen);
227 byte *gcry_md_read( GCRY_MD_HD hd, int algo );
228 int gcry_md_get( GCYR_MD_HD hd, int algo, byte *buffer, int buflen );
229
230
231 #define gcry_md_final( a )  gcry_md_ctl( (a), GCRYCTL_FINALIZE, NULL, 0 )
232
233
234 /*****************************************
235  *******  miscellaneous functions  *******
236  *****************************************/
237
238 #if 0
239 const char *g10m_revision_string(int mode);
240 const char *g10c_revision_string(int mode);
241 const char *g10u_revision_string(int mode);
242
243 MPI   g10c_generate_secret_prime( unsigned nbits );
244 char *g10c_get_random_bits( unsigned nbits, int level, int secure );
245
246
247 void *g10_malloc( size_t n );
248 void *g10_calloc( size_t n );
249 void *g10_malloc_secure( size_t n );
250 void *g10_calloc_secure( size_t n );
251 void *g10_realloc( void *a, size_t n );
252 void  g10_free( void *p );
253 char *g10_strdup( const char * a);
254
255 void g10_log_bug( const char *fmt, ... );
256 void g10_log_bug0( const char *, int );
257 void g10_log_fatal( const char *fmt, ... );
258 void g10_log_error( const char *fmt, ... );
259 void g10_log_info( const char *fmt, ... );
260 void g10_log_debug( const char *fmt, ... );
261 void g10_log_hexdump( const char *text, char *buf, size_t len );
262 void g10_log_mpidump( const char *text, MPI a );
263 #endif
264
265 /***************************
266  *******  constants  *******
267  **************************/
268 #if 0
269 #define CIPHER_ALGO_NONE         0
270 #define CIPHER_ALGO_IDEA         1
271 #define CIPHER_ALGO_3DES         2
272 #define CIPHER_ALGO_CAST5        3
273 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
274 #define CIPHER_ALGO_SAFER_SK128  5
275 #define CIPHER_ALGO_DES_SK       6
276 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
277
278 #define PUBKEY_ALGO_RSA        1
279 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
280 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
281 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not for v3)*/
282 #define PUBKEY_ALGO_DSA       17
283 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
284
285 #define DIGEST_ALGO_MD5       1
286 #define DIGEST_ALGO_SHA1      2
287 #define DIGEST_ALGO_RMD160    3
288 #define DIGEST_ALGO_TIGER     6
289
290 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
291                        || (a)==PUBKEY_ALGO_RSA_S )
292 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
293
294 #define G10ERR_GENERAL         1
295 #define G10ERR_PUBKEY_ALGO     4
296 #define G10ERR_DIGEST_ALGO     5
297 #define G10ERR_BAD_PUBKEY      6
298 #define G10ERR_BAD_SECKEY      7
299 #define G10ERR_BAD_SIGN        8
300 #define G10ERR_CIPHER_ALGO    12
301 #define G10ERR_WRONG_SECKEY   18
302 #define G10ERR_UNSUPPORTED    19
303 #define G10ERR_NI_PUBKEY      27
304 #define G10ERR_NI_CIPHER      28
305 #define G10ERR_BAD_MPI        30
306 #define G10ERR_WR_PUBKEY_ALGO 41
307 #endif
308
309 /***********************************************
310  *                                             *
311  *   Some very handy macros                    *
312  *                                             *
313  ***********************************************/
314 #ifndef GCRYPT_NO_MPI_MACROS
315
316 typedef struct gcry_mpi *MPI;
317
318
319 #endif /* GCRYPT_NO_MPI_MACROS */
320
321 #ifdef __cplusplus
322 }
323 #endif
324 #endif /* _GCRYPT_H */