bd3d606ffb0deefac46db83c61e1cac1b8121bec
[libgcrypt.git] / src / gcrypt.h
1 /* gcrypt.h -  GNU digital encryption libray 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 /*******************************************
29  *                                         *
30  *  error handling etc.                    *
31  *                                         *
32  *******************************************/
33
34 enum {
35     GCRYERR_SUCCESS = 0,    /* "no error" */
36     GCRYERR_GENERAL = 1
37     GCRYERR_INV_OP = 2,     /* inavlid operation code or ctl command */
38     GCRYERR_NOMEM = 3,
39 };
40
41
42 const char *gcry_strerror( int ec );
43
44 enum gcry_ctl_cmds {
45     GCRYCTL_SET_KEY  = 1,
46     GCRYCTL_SET_IV   = 2,
47     GCRYCTL_CFB_SYNC = 3,
48 };
49
50 int gcry_control( enum gcry_ctl_cmds, ... );
51
52
53 /*******************************************
54  *                                         *
55  *  multi precision integer functions      *
56  *                                         *
57  *******************************************/
58
59 enum gcry_mpi_opcode {
60     GCRYMPI_NOOP = 0,
61     GCRYMPI_NEW  = 1,       /* use gcry_mpi_new() */
62     GCRYMPI_SNEW = 2,       /* use gcry_mpi_new() */
63     GCRYMPI_RELEASE = 3,
64     GCRYMPI_RESIZE = 4,
65     GCRYMPI_COPY = 5,       /* use gcry_mpi_new() */
66     GCRYMPI_SWAP = 6,
67     GCRYMPI_SET  = 7,
68     GCRYMPI_SET_UI = 8,
69     GCRYMPI_CMP    = 9,
70     GCRYMPI_CMP_UI = 10
71 };
72
73 struct gcry_mpi;
74
75 int gcry_mpi_api( enum gcry_mpi_opcode opcode, int n_args, ... );
76 struct gcry_mpi *gcry_mpi_new( enum gcry_mpi_opcode opcode,
77                                unsigned int size,
78                                struct gcry_mpi *val
79                               );
80
81 #ifndef GCRYPT_NO_MPI_MACROS
82 #define mpi_new( nbits )  gcry_mpi_new( GCRYMPI_NEW, (nbits), NULL )
83 #define mpi_secure_new( nbits )  gcry_mpi_new( GCRYMPI_SNEW, (nbits), NULL )
84 #define mpi_release( a )     do {   gcry_mpi_api( GCRYMPI_RELEASE, 1, (a) );
85                                     (a) = NULL; } while(0)
86 #define mpi_resize( a, n )  gcry_mpi_api( GCRYMPI_RESIZE, 2, (a), (n) )
87 #define mpi_copy( a )       gcry_mpi_new( GCRYMPI_COPY, 0, (a) )
88 #define mpi_swap( a, b )    gcyr_mpi_api( GCRYMPI_SWAP, 2, (a), (b) )
89 /* void mpi_set( MPI w, MPI u ); */
90 #define mpi_set( w, u)      gcry_mpi_api( GCRYMPI_SET, 2, (w), (u) )
91 /* void mpi_set_ui( MPI w, unsigned long u ); */
92 #define mpi_set_ui( w, u)   gcry_mpi_api( GCRYMPI_SET_UI, 2, (w), (u) )
93 /* int  mpi_cmp( MPI u, MPI v ); */
94 #define mpi_cmp( u, v )     gcry_mpi_api( GCRYMPI_CMP, 2, (u), (v) )
95 /* int  mpi_cmp_ui( MPI u, unsigned long v ); */
96 #define mpi_cmp_ui( u, v )  gcry_mpi_api( GCRYMPI_CMP_UI, 2, (u), (v) )
97
98
99 void g10m_add(MPI w, MPI u, MPI v);
100 void g10m_add_ui(MPI w, MPI u, unsigned long v );
101 void g10m_sub( MPI w, MPI u, MPI v);
102 void g10m_sub_ui(MPI w, MPI u, unsigned long v );
103
104 void g10m_mul_ui(MPI w, MPI u, unsigned long v );
105 void g10m_mul_2exp( MPI w, MPI u, unsigned long cnt);
106 void g10m_mul( MPI w, MPI u, MPI v);
107 void g10m_mulm( MPI w, MPI u, MPI v, MPI m);
108
109 void g10m_fdiv_q( MPI quot, MPI dividend, MPI divisor );
110
111 void g10m_powm( MPI res, MPI base, MPI exp, MPI mod);
112
113 int  g10m_gcd( MPI g, MPI a, MPI b );
114 int  g10m_invm( MPI x, MPI u, MPI v );
115
116 unsigned g10m_get_nbits( MPI a );
117 unsigned g10m_get_size( MPI a );
118
119 void g10m_set_buffer( MPI a, const char *buffer, unsigned nbytes, int sign );
120
121
122 #endif /* GCRYPT_NO_MPI_MACROS */
123
124 /********************************************
125  *******  symmetric cipher functions  *******
126  ********************************************/
127
128 struct gcry_cipher_context;
129 typedef struct gcry_cipher_context *GCRY_CIPHER_HD;
130
131 enum gcry_cipher_algos {
132     GCRY_CIPHER_NONE        = 0,
133     GCRY_CIPHER_IDEA        = 1,
134     GCRY_CIPHER_3DES        = 2,
135     GCRY_CIPHER_CAST5       = 3,
136     GCRY_CIPHER_BLOWFISH    = 4,
137     GCRY_CIPHER_SAFER_SK128 = 5,
138     GCRY_CIPHER_DES_SK      = 6
139 };
140
141 enum gcry_cipher_modes {
142     GCRY_CIPHER_MODE_NONE   = 0,
143     GCRY_CIPHER_MODE_ECB    = 1,
144     GCRY_CIPHER_MODE_CFB    = 2,
145 };
146
147 enum gcry_cipher_flags {
148     GCRY_CIPHER_SECURE      = 1,  /* allocate in secure memory */
149     GCRY_CIPHER_ENABLE_SYNC = 2,  /* enable CFB sync mode */
150 };
151
152
153 int gcry_string_to_cipher_algo( const char *string );
154 const char * gcry_cipher_algo_to_string( int algo );
155 int gcry_check_cipher_algo( int algo );
156 unsigned gcry_cipher_get_keylen( int algo );
157 unsigned gcry_cipher_get_blocksize( int algo );
158
159 GCRY_CIPHER_HD gcry_cipher_open( algo, int mode, int secure );
160 void gcry_cipher_close( GCRY_CIPHER_HD h );
161 int  gcry_cipher_ctl( GCRY_CIPHER_HD h, int cmd, byte *buffer, size_t buflen);
162
163 int gcry_cipher_encrypt( GCRY_CIPHER_HD h,
164                           byte *out, size_t outsize, byte *in, size_t inlen );
165 void gcry_cipher_decrypt( GCRY_CIPHER_HD h,
166                           byte *out, byte *in, unsigned nbytes );
167
168
169 /* some handy macros */
170 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
171                                                                   (k), (l) )
172 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
173                                                                   (k), (l) )
174 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
175                                                                    NULL, 0 )
176
177
178 /*********************************************
179  *******  asymmetric cipher functions  *******
180  *********************************************/
181
182
183
184
185 /*********************************************
186  *******  cryptograhic hash functions  *******
187  *********************************************/
188
189
190 /*****************************************
191  *******  miscellaneous functions  *******
192  *****************************************/
193
194 #if 0
195 const char *g10m_revision_string(int mode);
196 const char *g10c_revision_string(int mode);
197 const char *g10u_revision_string(int mode);
198
199 MPI   g10c_generate_secret_prime( unsigned nbits );
200 char *g10c_get_random_bits( unsigned nbits, int level, int secure );
201
202
203 void *g10_malloc( size_t n );
204 void *g10_calloc( size_t n );
205 void *g10_malloc_secure( size_t n );
206 void *g10_calloc_secure( size_t n );
207 void *g10_realloc( void *a, size_t n );
208 void  g10_free( void *p );
209 char *g10_strdup( const char * a);
210
211 void g10_log_bug( const char *fmt, ... );
212 void g10_log_bug0( const char *, int );
213 void g10_log_fatal( const char *fmt, ... );
214 void g10_log_error( const char *fmt, ... );
215 void g10_log_info( const char *fmt, ... );
216 void g10_log_debug( const char *fmt, ... );
217 void g10_log_hexdump( const char *text, char *buf, size_t len );
218 void g10_log_mpidump( const char *text, MPI a );
219 #endif
220
221 /***************************
222  *******  constants  *******
223  **************************/
224 #if 0
225 #define CIPHER_ALGO_NONE         0
226 #define CIPHER_ALGO_IDEA         1
227 #define CIPHER_ALGO_3DES         2
228 #define CIPHER_ALGO_CAST5        3
229 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
230 #define CIPHER_ALGO_SAFER_SK128  5
231 #define CIPHER_ALGO_DES_SK       6
232 #define CIPHER_ALGO_BLOWFISH160 42  /* blowfish 160 bit key (not in OpenPGP)*/
233 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
234
235 #define PUBKEY_ALGO_RSA        1
236 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
237 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
238 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not vor v3)*/
239 #define PUBKEY_ALGO_DSA       17
240 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
241
242 #define DIGEST_ALGO_MD5       1
243 #define DIGEST_ALGO_SHA1      2
244 #define DIGEST_ALGO_RMD160    3
245 #define DIGEST_ALGO_TIGER     6
246
247 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
248                        || (a)==PUBKEY_ALGO_RSA_S )
249 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
250
251 #define G10ERR_GENERAL         1
252 #define G10ERR_PUBKEY_ALGO     4
253 #define G10ERR_DIGEST_ALGO     5
254 #define G10ERR_BAD_PUBKEY      6
255 #define G10ERR_BAD_SECKEY      7
256 #define G10ERR_BAD_SIGN        8
257 #define G10ERR_CIPHER_ALGO    12
258 #define G10ERR_WRONG_SECKEY   18
259 #define G10ERR_UNSUPPORTED    19
260 #define G10ERR_NI_PUBKEY      27
261 #define G10ERR_NI_CIPHER      28
262 #define G10ERR_BAD_MPI        30
263 #define G10ERR_WR_PUBKEY_ALGO 41
264 #endif
265
266 /***********************************************
267  *                                             *
268  *   Some very handy macros                    *
269  *                                             *
270  ***********************************************/
271 #ifndef GCRYPT_NO_MPI_MACROS
272
273 typedef struct gcry_mpi *MPI;
274
275
276 #endif /* GCRYPT_NO_MPI_MACROS */
277
278 #ifdef __cplusplus
279 }
280 #endif
281 #endif /* _GCRYPT_H */