* mpiutil.c (gcry_mpi_swap): New.
[libgcrypt.git] / src / gcrypt.h
1 /* gcrypt.h -  GNU cryptographic library interface
2  * Copyright (C) 1998,1999,2000,2001,2002 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt 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 Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License 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 #if 0 /* keep Emacsens's auto-indent happy */
29 }
30 #endif
31 #endif
32
33 /* The version of this header should match the one of the library It
34    should not be used by a program because gcry_check_version() should
35    reurn the same version.  The purpose of this macro is to let
36    autoconf (using the AM_PATH_GCRYPT macro) check that this header
37    matches the installed library.  Note: Do not edit the next line as
38    configure may fix the string here.  */
39 #define GCRYPT_VERSION "1.1.8"
40
41 /* Internal: We can't to use the convenience macros for the multi
42    precision integer functions when building this library. */
43 #ifdef _GCRYPT_IN_LIBGCRYPT
44 # ifndef GCRYPT_NO_MPI_MACROS
45 #   define GCRYPT_NO_MPI_MACROS 1
46 # endif
47 #endif
48
49 /* The data object used to hold a multi precision integer.  GcryMPI is
50    the preferred one. */
51 struct gcry_mpi;
52 typedef struct gcry_mpi *GCRY_MPI;
53 typedef struct gcry_mpi *GcryMPI;
54
55 \f
56 /* Error handling etc. */
57
58 /* The error numbers used by Libgcrypt. */
59 /* FIXME: We should use the same values as they were used in GnuPG
60    1.0.  gpg --status-fd may print some of these values. */
61 enum
62   {
63     GCRYERR_SUCCESS = 0,    /* "no error" */
64     GCRYERR_GENERAL = 1,    /* catch all the other errors code */
65     
66     GCRYERR_INV_PK_ALGO = 4, /* invalid public key algorithm */
67     GCRYERR_INV_MD_ALGO = 5, /* invalid message digest algorithm */
68     GCRYERR_BAD_PUBLIC_KEY = 6, /* Bad public key */
69     GCRYERR_BAD_SECRET_KEY = 7, /* Bad secret key */
70     GCRYERR_BAD_SIGNATURE = 8,  /* Bad signature */
71     
72     GCRYERR_INV_CIPHER_ALGO = 12, /* invalid cipher algorithm */
73     GCRYERR_BAD_MPI = 30,
74     GCRYERR_WRONG_PK_ALGO = 41, /* wrong public key algorithm */
75     GCRYERR_WEAK_KEY = 43,  /* weak encryption key */
76     GCRYERR_INV_KEYLEN = 44,  /* invalid length of a key*/
77     GCRYERR_INV_ARG = 45,    /* invalid argument */
78     GCRYERR_SELFTEST = 50,      /* selftest failed */
79
80     /* error codes not used in GnuPG 1.0 */
81     GCRYERR_INV_OP = 61,     /* invalid operation code or ctl command */
82     GCRYERR_NO_MEM = 62,     /* out of core */
83     GCRYERR_INTERNAL = 63,   /* internal error */
84     GCRYERR_EOF = 64,        /* (-1) is remapped to this value */
85     GCRYERR_INV_OBJ = 65,    /* an object is not valid */
86     GCRYERR_TOO_SHORT = 66,  /* provided buffer too short */
87     GCRYERR_TOO_LARGE = 67,  /* object is too large */
88     GCRYERR_NO_OBJ = 68,     /* Missing item in an object */
89     GCRYERR_NOT_IMPL = 69,   /* Not implemented */
90     GCRYERR_CONFLICT = 70,
91     GCRYERR_INV_CIPHER_MODE = 71,
92
93     /* error codes pertaining to S-expressions */
94     GCRYERR_SEXP_INV_LEN_SPEC    = 201,
95     GCRYERR_SEXP_STRING_TOO_LONG = 202,
96     GCRYERR_SEXP_UNMATCHED_PAREN = 203, 
97     GCRYERR_SEXP_NOT_CANONICAL   = 204, 
98     GCRYERR_SEXP_BAD_CHARACTER   = 205, 
99     GCRYERR_SEXP_BAD_QUOTATION   = 206,/* or invalid hex or octal value */
100     GCRYERR_SEXP_ZERO_PREFIX     = 207,/* first character of a length is 0 */
101     GCRYERR_SEXP_NESTED_DH       = 208,/* nested display hints */
102     GCRYERR_SEXP_UNMATCHED_DH    = 209,/* unmatched display hint */
103     GCRYERR_SEXP_UNEXPECTED_PUNC = 210,/* unexpected reserved punctuation */
104     GCRYERR_SEXP_BAD_HEX_CHAR    = 211,
105     GCRYERR_SEXP_ODD_HEX_NUMBERS = 212,
106     GCRYERR_SEXP_BAD_OCT_CHAR    = 213
107   };
108
109 /* Check that the library fulfills the version requirement.  */
110 const char *gcry_check_version (const char *req_version);
111
112 /* Return the error number for the last failed function call. */
113 int gcry_errno(void);
114
115 /* Map an error number to a string. */
116 const char *gcry_strerror (int ec);
117
118 /* Codes used with the gcry_control function. */
119 enum gcry_ctl_cmds 
120   {
121     GCRYCTL_SET_KEY  = 1,
122     GCRYCTL_SET_IV   = 2,
123     GCRYCTL_CFB_SYNC = 3,
124     GCRYCTL_RESET    = 4,   /* e.g. for MDs */
125     GCRYCTL_FINALIZE = 5,
126     GCRYCTL_GET_KEYLEN = 6,
127     GCRYCTL_GET_BLKLEN = 7,
128     GCRYCTL_TEST_ALGO = 8,
129     GCRYCTL_IS_SECURE = 9,
130     GCRYCTL_GET_ASNOID = 10,
131     GCRYCTL_ENABLE_ALGO = 11,
132     GCRYCTL_DISABLE_ALGO = 12,
133     GCRYCTL_DUMP_RANDOM_STATS = 13,
134     GCRYCTL_DUMP_SECMEM_STATS = 14,
135     GCRYCTL_GET_ALGO_NPKEY    = 15,
136     GCRYCTL_GET_ALGO_NSKEY    = 16,
137     GCRYCTL_GET_ALGO_NSIGN    = 17,
138     GCRYCTL_GET_ALGO_NENCR    = 18,
139     GCRYCTL_SET_VERBOSITY     = 19,
140     GCRYCTL_SET_DEBUG_FLAGS   = 20,
141     GCRYCTL_CLEAR_DEBUG_FLAGS = 21,
142     GCRYCTL_USE_SECURE_RNDPOOL= 22,
143     GCRYCTL_DUMP_MEMORY_STATS = 23,
144     GCRYCTL_INIT_SECMEM       = 24,
145     GCRYCTL_TERM_SECMEM       = 25,
146     GCRYCTL_DISABLE_SECMEM_WARN = 27,
147     GCRYCTL_SUSPEND_SECMEM_WARN = 28,
148     GCRYCTL_RESUME_SECMEM_WARN  = 29,
149     GCRYCTL_DROP_PRIVS          = 30,
150     GCRYCTL_ENABLE_M_GUARD      = 31,
151     GCRYCTL_START_DUMP          = 32,
152     GCRYCTL_STOP_DUMP           = 33,
153     GCRYCTL_GET_ALGO_USAGE      = 34,
154     GCRYCTL_IS_ALGO_ENABLED     = 35,
155     GCRYCTL_DISABLE_INTERNAL_LOCKING = 36,
156     GCRYCTL_DISABLE_SECMEM      = 37,
157     GCRYCTL_INITIALIZATION_FINISHED = 38,
158     GCRYCTL_INITIALIZATION_FINISHED_P = 39,
159     GCRYCTL_ANY_INITIALIZATION_P = 40
160   };
161
162 /* Perform various operations defined by CMD. */
163 int gcry_control (enum gcry_ctl_cmds CMD, ...);
164
165
166 \f
167 /* S-expression management. */ 
168
169 /* The object to represent an S-expression as used with the
170    public key functions.  GcrySexp is the preferrred form. */
171 struct gcry_sexp;
172 typedef struct gcry_sexp *GCRY_SEXP;
173 typedef struct gcry_sexp *GcrySexp;  
174
175 /* The possible values for the S-expression format. */
176 enum gcry_sexp_format {
177     GCRYSEXP_FMT_DEFAULT   = 0,
178     GCRYSEXP_FMT_CANON     = 1,
179     GCRYSEXP_FMT_BASE64    = 2,
180     GCRYSEXP_FMT_ADVANCED  = 3
181 };
182
183 /* Create an new S-expression object from BUFFER of size LENGTH aand
184    return it in RETSEXP.  With AUTODETECT set to 0 the data in BUFFER
185    is expected to be in canonized format */
186 int gcry_sexp_new (GcrySexp *retsexp, const void *buffer, size_t length,
187                    int autodetect);
188
189 /* Same as gcry_sexp_new but allows to pass a FREEFNC which has the
190    effect to transfer ownership of BUFFER to the created object. */
191 int gcry_sexp_create (GcrySexp *retsexp, void *buffer, size_t length,
192                       int autodetect, void (*freefnc)(void*) );
193
194 /* Scan BUFFER and return a new S-expression object in RETSEXP.  This
195    function expects a printf like string in BUFFER. */
196 int gcry_sexp_sscan (GcrySexp *retsexp, size_t *erroff,
197                      const char *buffer, size_t length );
198
199 /* Same as gcry_sexp_sscan but expects a string in FORMAT and can thus
200    only be used for certain encodings. */
201 int gcry_sexp_build (GcrySexp *retsexp, size_t *erroff,
202                      const char *format, ... );
203
204 /* Release the S-expression object SEXP */
205 void gcry_sexp_release (GcrySexp sexp);
206
207 /* Calculate the length of an canonized S-expresion in BUFFER and
208    check for a valid encoding. */
209 size_t gcry_sexp_canon_len (const unsigned char *buffer, size_t length, 
210                             size_t *erroff, int *errcode);
211
212 /* Copies the S-expression object SEXP into BUFFER using the format
213    specified in MODE. */
214 size_t gcry_sexp_sprint (GCRY_SEXP sexp, int mode, char *buffer,
215                          size_t maxlength );
216
217 void      gcry_sexp_dump( const GCRY_SEXP a );
218 GCRY_SEXP gcry_sexp_cons( const GCRY_SEXP a, const GCRY_SEXP b );
219 GCRY_SEXP gcry_sexp_alist( const GCRY_SEXP *array );
220 GCRY_SEXP gcry_sexp_vlist( const GCRY_SEXP a, ... );
221 GCRY_SEXP gcry_sexp_append( const GCRY_SEXP a, const GCRY_SEXP n );
222 GCRY_SEXP gcry_sexp_prepend( const GCRY_SEXP a, const GCRY_SEXP n );
223 GCRY_SEXP gcry_sexp_find_token( GCRY_SEXP list,
224                                   const char *tok, size_t toklen );
225 int         gcry_sexp_length( const GCRY_SEXP list );
226 GCRY_SEXP   gcry_sexp_nth( const GCRY_SEXP list, int number );
227 GCRY_SEXP   gcry_sexp_car( const GCRY_SEXP list );
228 GCRY_SEXP   gcry_sexp_cdr( const GCRY_SEXP list );
229 GCRY_SEXP   gcry_sexp_cadr( const GCRY_SEXP list );
230 const char *gcry_sexp_nth_data( const GCRY_SEXP list, int number,
231                                                       size_t *datalen );
232 GCRY_MPI    gcry_sexp_nth_mpi( GCRY_SEXP list, int number, int mpifmt );
233
234
235 \f
236 /*******************************************
237  *                                         *
238  *  multi precision integer functions      *
239  *                                         *
240  *******************************************/
241
242 /* Different formats of external big integer representation. */
243 enum gcry_mpi_format 
244   {
245     GCRYMPI_FMT_NONE= 0,
246     GCRYMPI_FMT_STD = 1,    /* twos complement stored without length */
247     GCRYMPI_FMT_PGP = 2,    /* As used by OpenPGP (only defined as unsigned)*/
248     GCRYMPI_FMT_SSH = 3,    /* As used by SSH (same as 1 but with length)*/
249     GCRYMPI_FMT_HEX = 4,    /* hex format */
250     GCRYMPI_FMT_USG = 5     /* like STD but this is an unsigned one */
251   };
252
253 /* Flags used for creating big integers.  */
254 enum gcry_mpi_flag 
255   {
256     GCRYMPI_FLAG_SECURE = 1,  /* Allocate the number in "secure" memory. */
257     GCRYMPI_FLAG_OPAQUE = 2   /* The number is not a real one but just a
258                                way to store some bytes.  This is
259                                useful for encrypted big integers. */
260   };
261
262
263 /* Allocate a new big integer object, initialize it with 0 and
264    initially allocate memory for a number of at least NBITS. */
265 GcryMPI gcry_mpi_new (unsigned int nbits);
266
267 /* Same as gcry_mpi_new() but allocate in "secure" memory. */
268 GcryMPI gcry_mpi_snew (unsigned int nbits);
269
270 /* Release the number A and free all associated resources. */
271 void gcry_mpi_release (GcryMPI a);
272
273 /* Create a new number with the same value as A. */
274 GcryMPI gcry_mpi_copy (const GcryMPI a);
275
276 /* Store the big integer value U in W. */
277 GcryMPI gcry_mpi_set (GcryMPI w, const GcryMPI u);
278
279 /* Store the unsigned integer value U in W. */
280 GcryMPI gcry_mpi_set_ui (GcryMPI w, unsigned long u);
281
282 /* Swap the values of A and B. */
283 void gcry_mpi_swap (GcryMPI a, GcryMPI b);
284
285 /* Compare the big integer number U and V returning 0 for equality, a
286    positive value for U > V and a negative for U < V. */
287 int gcry_mpi_cmp (const GcryMPI u, const GcryMPI v);
288
289 /* Compare the big integer number U with the unsigned integer V
290    returning 0 for equality, a positive value for U > V and a negative
291    for U < V. */
292 int gcry_mpi_cmp_ui (const GcryMPI u, unsigned long v);
293
294 /* Convert the external representation of an integer stored in BUFFER
295    with a size of (*NBYTES) in a newly create MPI returned in RET_MPI.
296    For certain formats a length is not required and may be passed as
297    NULL.  After a successful operation NBYTES received the number of
298    bytes actually scanned. */
299 int gcry_mpi_scan (GcryMPI *ret_mpi, enum gcry_mpi_format format,
300                    const char *buffer, size_t *nbytes);
301
302 /* Convert the big integer A into the external representation
303    described by FORMAT and store it in the provided BUFFER which has
304    the size (*NBYTES).  NBYTES receives the actual length of the
305    external representation. */
306 int gcry_mpi_print (enum gcry_mpi_format format,
307                     char *buffer, size_t *nbytes, const GcryMPI a);
308
309 /* Convert the big integer A int the external representation desribed
310    by FORMAT and store it in a newly allocated buffer which address
311    will be put into BUFFER.  NBYTES receives the actual lengths of the
312    external representation. */
313 int gcry_mpi_aprint (enum gcry_mpi_format format,
314                      void **buffer, size_t *nbytes, const GcryMPI a);
315
316 /* W = U + V.  */
317 void gcry_mpi_add (GcryMPI w, GcryMPI u, GcryMPI v);
318
319 /* W = U + V.  V is an unsigned integer. */
320 void gcry_mpi_add_ui (GcryMPI w, GcryMPI u, unsigned long v);
321
322 /* W = U + V mod M. */
323 void gcry_mpi_addm (GcryMPI w, GcryMPI u, GcryMPI v, GcryMPI m);
324
325 /* W = U - V. */
326 void gcry_mpi_sub (GcryMPI w, GcryMPI u, GcryMPI v);
327
328 /* W = U - V.  V is an unsigned integer. */
329 void gcry_mpi_sub_ui (GcryMPI w, GcryMPI u, unsigned long v );
330
331 /* W = U - V mod M */
332 void gcry_mpi_subm (GcryMPI w, GcryMPI u, GcryMPI v, GcryMPI m);
333
334 /* W = U * V. */
335 void gcry_mpi_mul (GcryMPI w, GcryMPI u, GcryMPI v);
336
337 /* W = U * V.  V is an unsigned integer. */
338 void gcry_mpi_mul_ui (GcryMPI w, GcryMPI u, unsigned long v );
339
340 /* W = U * V mod M. */
341 void gcry_mpi_mulm (GcryMPI w, GcryMPI u, GcryMPI v, GcryMPI m);
342
343 /* W = U * (2 ^ CNT). */
344 void gcry_mpi_mul_2exp (GcryMPI w, GcryMPI u, unsigned long cnt);
345
346 /* Q = DIVIDEND / DIVISOR, R = DIVIDEND % DIVISOR,
347    Q or R may be passed as NULL.  ROUND should be negative or 0. */
348 void gcry_mpi_div (GcryMPI q, GcryMPI r,
349                    GcryMPI dividend, GcryMPI divisor, int round);
350
351 /* R = DIVIDEND % DIVISOR */
352 void gcry_mpi_mod (GcryMPI r, GcryMPI dividend, GcryMPI divisor);
353
354 /* W = B ^ E mod M. */
355 void gcry_mpi_powm (GcryMPI w,
356                     const GcryMPI b, const GcryMPI e, const GcryMPI m);
357
358 /* Set G to the greatest common divisor of A and B.  
359    Return true if the G is 1. */
360 int gcry_mpi_gcd (GcryMPI g, GcryMPI a, GcryMPI b);
361
362 /* Set X to the multiplicative inverse of A mod M.
363    Return true if the value exists. */
364 int gcry_mpi_invm (GcryMPI x, GcryMPI a, GcryMPI m);
365
366
367 /* Return the number of bits required to represent A. */
368 unsigned int gcry_mpi_get_nbits (GcryMPI a);
369
370 /* Return true when bit number N (counting from 0) is set in A. */
371 int      gcry_mpi_test_bit (GcryMPI a, unsigned int n);
372
373 /* Set bit number N in A. */
374 void     gcry_mpi_set_bit (GcryMPI a, unsigned int n);
375
376 /* Clear bit number N in A. */
377 void     gcry_mpi_clear_bit (GcryMPI a, unsigned int n);
378
379 /* Set bit number N in A and clear all bits greater than N. */
380 void     gcry_mpi_set_highbit (GcryMPI a, unsigned int n);
381
382 /* Clear bit number N in A and all bits greater than N. */
383 void     gcry_mpi_clear_highbit (GcryMPI a, unsigned int n);
384
385 /* Shift the value of A by N bits to the right and store the result in X. */
386 void     gcry_mpi_rshift (GcryMPI x, GcryMPI a, unsigned int n);
387
388 /* Store NBITS of the value P points to in A and mark A as an opaque
389    value. */
390 GcryMPI gcry_mpi_set_opaque (GcryMPI a, void *p, unsigned int nbits);
391
392 /* creturn a pointer to an opaque value stored in A and return its
393    size in NBITS.  Note that the returned pointer is still owned by A
394    and that the function should never be used for an non-opaque
395    MPI. */
396 void *gcry_mpi_get_opaque (GcryMPI a, unsigned int *nbits);
397
398 /* Set the FLAG for the big integer A.  Currently only the flag
399    GCRYMPI_FLAG_SECURE is allowed to convert A into an big intger
400    stored in "secure" memory. */
401 void gcry_mpi_set_flag (GcryMPI a, enum gcry_mpi_flag flag);
402
403 /* Clear FLAG for the big integer A.  Note that this function is
404    currently useless as no flags are allowed. */
405 void gcry_mpi_clear_flag (GcryMPI a, enum gcry_mpi_flag flag);
406
407 /* Return true when the FLAG is set for A. */
408 int gcry_mpi_get_flag (GcryMPI a, enum gcry_mpi_flag flag);
409
410 /* Unless the GCRYPT_NO_MPI_MACROS is used, provide a couple of
411    convenience macors for the big integer functions. */
412 #ifndef GCRYPT_NO_MPI_MACROS
413 #define mpi_new(n)          gcry_mpi_new( (n) )
414 #define mpi_secure_new( n ) gcry_mpi_snew( (n) )
415 #define mpi_release( a )    do { gcry_mpi_release( (a) ); \
416                                  (a) = NULL; } while(0)
417 #define mpi_copy( a )       gcry_mpi_copy( (a) )
418 #define mpi_set( w, u)      gcry_mpi_set( (w), (u) )
419 #define mpi_set_ui( w, u)   gcry_mpi_set_ui( (w), (u) )
420 #define mpi_cmp( u, v )     gcry_mpi_cmp( (u), (v) )
421 #define mpi_cmp_ui( u, v )  gcry_mpi_cmp_ui( (u), (v) )
422
423 #define mpi_add_ui(w,u,v)   gcry_mpi_add_ui((w),(u),(v))
424 #define mpi_add(w,u,v)      gcry_mpi_add ((w),(u),(v))
425 #define mpi_addm(w,u,v,m)   gcry_mpi_addm ((w),(u),(v),(m))
426 #define mpi_sub_ui(w,u,v)   gcry_mpi_sub_ui ((w),(u),(v))
427 #define mpi_sub(w,u,v)      gcry_mpi_sub ((w),(u),(v))
428 #define mpi_subm(w,u,v,m)   gcry_mpi_subm ((w),(u),(v),(m))
429 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
430 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
431 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
432 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
433 #define mpi_powm(w,b,e,m)   gcry_mpi_powm ( (w), (b), (e), (m) )
434 #define mpi_tdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), 0)
435 #define mpi_fdiv(q,r,a,m)   gcry_mpi_div ( (q), (r), (a), (m), -1)
436 #define mpi_mod(r,a,m)      gcry_mpi_mod ((r), (a), (m))
437 #define mpi_gcd(g,a,b)      gcry_mpi_gcd ( (g), (a), (b) )
438 #define mpi_invm(g,a,b)     gcry_mpi_invm ( (g), (a), (b) )
439
440 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
441 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
442 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
443 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
444 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
445 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
446 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
447
448 #define mpi_set_opaque(a,b,c) gcry_mpi_set_opaque( (a), (b), (c) )
449 #define mpi_get_opaque(a,b)   gcry_mpi_get_opaque( (a), (b) )
450 #endif /* GCRYPT_NO_MPI_MACROS */
451
452
453 \f
454 /************************************
455  *                                  *
456  *   symmetric cipher functions     *
457  *                                  *
458  ************************************/
459
460 /* The data object used to hold a handle to an encryption opject.
461    GcryCipherHd is the preferred one. */
462 struct gcry_cipher_handle;
463 typedef struct gcry_cipher_handle *GCRY_CIPHER_HD;
464 typedef struct gcry_cipher_handle *GcryCipherHd;
465
466 /* All symmetric encryption algorithms are identified by their IDs.
467    More IDs may be registered at runtime. */
468 enum gcry_cipher_algos
469   {
470     GCRY_CIPHER_NONE        = 0,
471     GCRY_CIPHER_IDEA        = 1,
472     GCRY_CIPHER_3DES        = 2,
473     GCRY_CIPHER_CAST5       = 3,
474     GCRY_CIPHER_BLOWFISH    = 4,
475     GCRY_CIPHER_SAFER_SK128 = 5,
476     GCRY_CIPHER_DES_SK      = 6,
477     GCRY_CIPHER_AES         = 7,
478     GCRY_CIPHER_AES192      = 8,
479     GCRY_CIPHER_AES256      = 9,
480     GCRY_CIPHER_TWOFISH     = 10,
481     /* other cipher numbers are above 300 for OpenPGP reasons. */
482     GCRY_CIPHER_ARCFOUR     = 301
483   };
484
485 /* The Rijndael algorithm is basically AES, so provide some macros. */
486 #define GCRY_CIPHER_AES128      GCRY_CIPHER_AES    
487 #define GCRY_CIPHER_RIJNDAEL    GCRY_CIPHER_AES    
488 #define GCRY_CIPHER_RIJNDAEL128 GCRY_CIPHER_AES128 
489 #define GCRY_CIPHER_RIJNDAEL192 GCRY_CIPHER_AES192 
490 #define GCRY_CIPHER_RIJNDAEL256 GCRY_CIPHER_AES256 
491
492 /* The supported encryption modes.  NOte that not all of them are
493    supported for each algorithm. */
494 enum gcry_cipher_modes 
495   {
496     GCRY_CIPHER_MODE_NONE   = 0,  /* Not yet specified. */
497     GCRY_CIPHER_MODE_ECB    = 1,  /* Electronic codebook. */
498     GCRY_CIPHER_MODE_CFB    = 2,  /* Cipher feedback. */
499     GCRY_CIPHER_MODE_CBC    = 3,  /* Cipher block chaining. */
500     GCRY_CIPHER_MODE_STREAM = 4,  /* Used with stream ciphers. */
501     GCRY_CIPHER_MODE_OFB    = 5   /* Outer feedback. */
502   };
503
504 /* Flags used with the open function. */ 
505 enum gcry_cipher_flags
506   {
507     GCRY_CIPHER_SECURE      = 1,  /* Allocate in secure memory. */
508     GCRY_CIPHER_ENABLE_SYNC = 2   /* Enable CFB sync mode. */
509   };
510
511
512 /* Create a handle for algorithm ALGO to be used in MODE.  FLAGS may
513    be given as an bitwise OR of the gcry_cipher_flags values. */
514 GcryCipherHd gcry_cipher_open (int algo, int mode, unsigned int flags);
515
516 /* Close the cioher handle H and release all resource. */
517 void gcry_cipher_close (GcryCipherHd h);
518
519 /* Perform various operations on the cipher object H. */
520 int gcry_cipher_ctl( GcryCipherHd h, int cmd, void *buffer, size_t buflen);
521
522 /* Retrieve various information about the cipher object H. */
523 int gcry_cipher_info( GcryCipherHd h, int what, void *buffer, size_t *nbytes);
524
525 /* Retrieve various information about the cipher algorithm ALGO. */
526 int gcry_cipher_algo_info (int algo, int what, void *buffer, size_t *nbytes);
527
528 /* Map the cipher algorithm id ALGO to a string representation of that
529    algorithm name.  For unknown algorithms this functions returns an
530    empty string. */
531 const char *gcry_cipher_algo_name (int algo);
532
533 /* Map the algorithm name NAME to an cipher algorithm ID.  Return 0 if
534    the algorithm name is not known. */
535 int gcry_cipher_map_name (const char *name);
536
537 /* Given an ASN.1 object identifier in standard IETF dotted decimal
538    format in STING, return the encryption mode associated with that
539    OID or 0 if not known or applicable. */
540 int gcry_cipher_mode_from_oid (const char *string);
541
542 /* Encrypt the plaintext of size INLEN in IN using the cipher handle H
543    into the buffer OUT which has an allocated length of OUTSIZE.  For
544    most algorithms it is possible to pass NULL for in and 0 for INLEN
545    and do a in-place decryption of the data provided in OUT. */
546 int gcry_cipher_encrypt (GcryCipherHd h,
547                          unsigned char *out, size_t outsize,
548                          const unsigned char *in, size_t inlen);
549
550 /* The counterpart to gcry_cipher_encrypt. */
551 int gcry_cipher_decrypt (GcryCipherHd h,
552                          unsigned char *out, size_t outsize,
553                          const unsigned char *in, size_t inlen);
554
555 /* Set key K of length L for the cipher handle H. 
556   (We have to cast away a const char* here - this catch-all ctl
557   function was probably not the best choice) */
558 #define gcry_cipher_setkey(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_KEY, \
559                                                          (char*)(k), (l) )
560
561 /* Set initialization vector K of length L for the cipher handle H. */
562 #define gcry_cipher_setiv(h,k,l)  gcry_cipher_ctl( (h), GCRYCTL_SET_IV, \
563                                                          (char*)(k), (l) )
564
565 /* Perform the the OppenPGP sync operation if this is enabled for the
566    cipher handle H. */
567 #define gcry_cipher_sync(h)  gcry_cipher_ctl( (h), GCRYCTL_CFB_SYNC, \
568                                                                    NULL, 0 )
569
570 /* Retrieved the key length used with algorithm A. */
571 #define gcry_cipher_get_algo_keylen(a) \
572             gcry_cipher_algo_info( (a), GCRYCTL_GET_KEYLEN, NULL, NULL )
573
574 /* Retrieve the block length used with algorithm A. */
575 #define gcry_cipher_get_algo_blklen(a) \
576             gcry_cipher_algo_info( (a), GCRYCTL_GET_BLKLEN, NULL, NULL )
577
578 /* Return 0 if the algorithm A is available for use. */
579 #define gcry_cipher_test_algo(a) \
580             gcry_cipher_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
581
582
583 \f
584 /************************************
585  *                                  *
586  *    asymmetric cipher functions   *
587  *                                  *
588  ************************************/
589
590 /* The algorithms and their IDs we support. */
591 enum gcry_pk_algos 
592   {
593     GCRY_PK_RSA = 1,
594     GCRY_PK_RSA_E = 2,      /* deprecated */
595     GCRY_PK_RSA_S = 3,      /* deprecated */
596     GCRY_PK_ELG_E = 16,     /* use only for OpenPGP */
597     GCRY_PK_DSA   = 17,
598     GCRY_PK_ELG   = 20
599   };
600
601 /* Flags describing usage capabilities of a PK algorithm. */
602 #define GCRY_PK_USAGE_SIGN 1
603 #define GCRY_PK_USAGE_ENCR 2
604
605 /* Encrypt the DATA using the public key PKEY and store the result as
606    a newly created S-expression at RESULT. */
607 int gcry_pk_encrypt (GcrySexp *result, GcrySexp data, GcrySexp pkey);
608
609 /* Decrypt the DATA using the private key SKEY and store the result as
610    a newly created S-expression at RESULT. */
611 int gcry_pk_decrypt (GcrySexp *result, GcrySexp data, GcrySexp skey);
612
613 /* Sign the DATA using the private key SKEY and store the result as
614    a newly created S-expression at RESULT. */
615 int gcry_pk_sign (GcrySexp *result, GcrySexp data, GcrySexp skey);
616
617 /* Check the signature SIGVAL on DATA using the public key PKEY. */
618 int gcry_pk_verify (GcrySexp sigval, GcrySexp data, GcrySexp pkey);
619
620 /* Check that KEY (either private or public) is sane. */
621 int gcry_pk_testkey (GcrySexp key);
622
623 /* Generate a new key pair according to the parameters given in
624    S_PARMS.  The new key pair is returned in as an S-expression in
625    R_KEY. */
626 int gcry_pk_genkey (GcrySexp *r_key, GcrySexp s_parms);
627
628 /* Catch all function for miscellaneous operations. */
629 int gcry_pk_ctl (int cmd, void *buffer, size_t buflen);
630
631 /* Retrieve information about the public key algorithm ALGO. */
632 int gcry_pk_algo_info (int algo, int what, void *buffer, size_t *nbytes);
633
634 /* Map the public key algorithm id ALGO to a string representation of the
635    algorithm name.  For unknown algorithms this functions returns an
636    empty string. */
637 const char *gcry_pk_algo_name (int algo);
638
639 /* Map the algorithm NAME to a public key algorithm Id.  Return 0 if
640    the algorithm name is not known. */
641 int gcry_pk_map_name (const char* name);
642
643 /* Return what is commonly referred as the key length for the given
644    public or private KEY.  */
645 unsigned int gcry_pk_get_nbits (GcrySexp key);
646
647 /* Please note that keygrip is still experimental and should not be
648    used without contacting the author. */
649 unsigned char *gcry_pk_get_keygrip (GcrySexp key, unsigned char *array);
650
651 /* Return 0 if the public key algorithm A is available for use. */
652 #define gcry_pk_test_algo(a) \
653             gcry_pk_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
654
655
656 \f
657 /************************************
658  *                                  *
659  *   cryptograhic hash functions    *
660  *                                  *
661  ************************************/
662
663 /* Algorithm IDs for the hash functions we know about. Not all of them
664    are implemnted. */
665 enum gcry_md_algos
666   {
667     GCRY_MD_NONE    = 0,  
668     GCRY_MD_MD5     = 1,
669     GCRY_MD_SHA1    = 2,
670     GCRY_MD_RMD160  = 3,
671     GCRY_MD_MD2     = 5,
672     GCRY_MD_TIGER   = 6,   /* TIGER/192. */
673     GCRY_MD_HAVAL   = 7,   /* HAVAL, 5 pass, 160 bit. */
674     GCRY_MD_SHA256  = 8,
675     GCRY_MD_SHA384  = 9,
676     GCRY_MD_SHA512  = 10
677   };
678
679 /* Flags used with the open function. */
680 enum gcry_md_flags
681   {
682     GCRY_MD_FLAG_SECURE = 1,  /* Allocate all buffers in "secure" memory */
683     GCRY_MD_FLAG_HMAC   = 2   /* Make an HMAC out of this algorithm. */
684   };
685
686
687 /* This object is used to hold a handle to an message digest object.
688    GcryCipherHd is the preferred type. */
689 struct gcry_md_context;
690 struct gcry_md_handle 
691   { /* This structure is private - only to be used by the gcry_md_  macros. */
692     struct gcry_md_context *ctx;
693     int  bufpos;
694     int  bufsize;
695     unsigned char buf[1];
696   };
697 typedef struct gcry_md_handle *GCRY_MD_HD;
698 typedef struct gcry_md_handle *GcryMDHd;
699
700
701 /* Create a message digest object for algorithm ALGO.  FLAGS may be
702    given as an bitwise OR of the gcry_md_flags values.  ALGO may be
703    given as 0 if the algorithms to used are later set using
704    gcry_md_enable. */
705 GcryMDHd gcry_md_open (int algo, unsigned int flags);
706
707 /* Release the message digest object HD. */
708 void gcry_md_close (GcryMDHd hd);
709
710 /* Add the message digest algorithm ALGO to the digest object HD. */
711 int gcry_md_enable( GcryMDHd hd, int algo );
712
713 /* Create a new digest object as an exact copy of the object HD. */
714 GcryMDHd gcry_md_copy (GcryMDHd hd);
715
716 /* Reset the digest object HD to its initail state. */
717 void gcry_md_reset (GcryMDHd hd);
718
719 /* Perform various operations on the digets object HD. */
720 int gcry_md_ctl (GcryMDHd hd, int cmd, unsigned char *buffer, size_t buflen);
721
722 /* Pass LENGTH bytes of data in BUFFER to the digest object HD so that
723    it can update the digest values.  This is the actual hash
724    function. */
725 void gcry_md_write (GcryMDHd hd, const unsigned char *buffer, size_t length);
726
727 /* Read out the final digest from HD return the digest value for
728    algorithm ALGO. */
729 unsigned char *gcry_md_read (GcryMDHd hd, int algo);
730
731 /* Convenience function to calculate the hash from the data in BUFFER
732    of size LENGTH using the algorithm ALGO avoiding the creating of a
733    hash object.  The hash is returned in the caller provied buffer
734    DIGEST which must be large enough to hold the digest of the given
735    algorithm. */
736 void gcry_md_hash_buffer (int algo, char *digest,
737                           const char *buffer, size_t length);
738
739 /* Retrieve the algorithm used with HD.  This does not work relaibale
740    if more than one algorithm is enabled in HD. */
741 int gcry_md_get_algo (GcryMDHd hd);
742
743 /* Retrieved the length in bytes of the digest yielded by algorithm
744    ALGO. */
745 unsigned int gcry_md_get_algo_dlen (int algo);
746
747 /* Retrieve various information about the obhject H. */
748 int gcry_md_info (GcryMDHd h, int what, void *buffer, size_t *nbytes);
749
750 /* Retrieve valrious information about the algorithm ALGO. */
751 int gcry_md_algo_info( int algo, int what, void *buffer, size_t *nbytes);
752
753 /* Map the digest algorithm id ALGO to a string representation of the
754    algorithm name.  For unknown algorithms this functions returns an
755    empty string. */
756 const char *gcry_md_algo_name (int algo);
757
758 /* Map the algorithm NAME to a digest algorithm Id.  Return 0 if
759    the algorithm name is not known. */
760 int gcry_md_map_name (const char* name);
761
762 /* For use with the HMAC feature, the set MAC key to the KEY of
763    KEYLEN. */
764 int gcry_md_setkey (GcryMDHd hd, const char *key, size_t keylen);
765
766 /* Update the hash(s) of H with the character C.  This is a buffered
767    version of the gcry_md_write function. */
768 #define gcry_md_putc(h,c)  \
769             do {                                        \
770                 if( (h)->bufpos == (h)->bufsize )       \
771                     gcry_md_write( (h), NULL, 0 );      \
772                 (h)->buf[(h)->bufpos++] = (c) & 0xff;   \
773             } while(0)
774
775 /* Finalize the digest calculation.  This is not really needed because
776    gcry_md_read() does this implicitly. */
777 #define gcry_md_final(a) \
778             gcry_md_ctl ((a), GCRYCTL_FINALIZE, NULL, 0)
779
780 /* Return true when the digest object is allocated in "secure" memory. */
781 #define gcry_md_is_secure(a) \
782             gcry_md_info( (a), GCRYCTL_IS_SECURE, NULL, NULL )
783
784 /* Return 0 if the algorithm A is available for use. */
785 #define gcry_md_test_algo(a) \
786             gcry_md_algo_info( (a), GCRYCTL_TEST_ALGO, NULL, NULL )
787
788 /* Enable debugging for digets object A; i.e. create files named
789    dbgmd-<n>.<string> while hashing.  B is a string used as the suffix
790    for the filename. */
791 #define gcry_md_start_debug(a,b) \
792             gcry_md_ctl( (a), GCRYCTL_START_DUMP, (b), 0 )
793
794 /* Disable the debugging of A. */
795 #define gcry_md_stop_debug(a,b) \
796             gcry_md_ctl( (a), GCRYCTL_STOP_DUMP, (b), 0 )
797
798
799 \f
800 /************************************
801  *                                  *
802  *   random generating functions    *
803  *                                  *
804  ************************************/
805
806 /* The possible values for the random quality.  The rule of thumb is
807    to use WEAK for random number which don't need to be
808    cryptographically strong, STRONG for session keys and VERY_STRONG
809    for key material. */
810 enum gcry_random_level
811   {
812     GCRY_WEAK_RANDOM = 0,
813     GCRY_STRONG_RANDOM = 1,
814     GCRY_VERY_STRONG_RANDOM = 2
815   };
816
817 /* Fill BUFFER with LENGTH bytes of random, using random numbers of
818    quality LEVEL. */
819 void gcry_randomize (unsigned char *buffer, size_t length,
820                      enum gcry_random_level level);
821
822 /* Return NBYTES of allocated random suing a radnom numbers of quality
823    LEVEL. */
824 void *gcry_random_bytes (size_t nbytes, enum gcry_random_level level);
825
826 /* Return NBYTES of allocated random suing a random numbers of quality
827    LEVEL.  The random numbers are created returned in "secure"
828    memory. */
829 void *gcry_random_bytes_secure (size_t nbytes, enum gcry_random_level level);
830
831
832 /* Set the big inetger W to a random value of NBITS using a random
833    generator with quality LEVEL. */
834 void gcry_mpi_randomize (GcryMPI w,
835                          unsigned int nbits, enum gcry_random_level level);
836
837
838 \f
839 /************************************
840  *                                  *
841  *     miscellaneous stuff          *
842  *                                  *
843  ************************************/
844
845 /* Log leveles used by the internal logging facility. */
846 enum gcry_log_levels 
847   {
848     GCRY_LOG_CONT   = 0,    /* continue the last log line */
849     GCRY_LOG_INFO   = 10,
850     GCRY_LOG_WARN   = 20,
851     GCRY_LOG_ERROR  = 30,
852     GCRY_LOG_FATAL  = 40,
853     GCRY_LOG_BUG    = 50,
854     GCRY_LOG_DEBUG  = 100
855   };
856
857
858 /* Certain operations can provide progress information.  This function
859    is used to register a handler for retrieving these information. */
860 void gcry_set_progress_handler (void (*cb)(void *,const char*,int, int, int),
861                                 void *cb_data);
862
863
864
865 /* Register a custom memory allocation functions. */
866 void gcry_set_allocation_handler (void *(*new_alloc_func)(size_t n),
867                                   void *(*new_alloc_secure_func)(size_t n),
868                                   int (*new_is_secure_func)(const void*),
869                                   void *(*new_realloc_func)(void *p, size_t n),
870                                   void (*new_free_func)(void*));
871
872 /* Register a function used instead of the internal out of memory
873    handler. */
874 void gcry_set_outofcore_handler (int (*h)(void*, size_t, unsigned int),
875                                  void *opaque );
876
877 /* Register a function used instead of the internal fatal error
878    handler. */
879 void gcry_set_fatalerror_handler (void (*fnc)(void*,int, const char*),
880                                   void *opaque);
881
882 /* Reserved for future use. */
883 void gcry_set_gettext_handler (const char *(*f)(const char*));
884
885 /* Regstier a function used instead of the internal logging
886    facility. */
887 void gcry_set_log_handler (void (*f)(void*,int, const char*, va_list),
888                            void *opaque);
889
890
891 /* Libgcrypt uses its own memory allocation.  It is important to use
892    gcry_free () to release memory allocated by libgcrypt. */
893 void *gcry_malloc (size_t n);
894 void *gcry_calloc (size_t n, size_t m);
895 void *gcry_malloc_secure (size_t n);
896 void *gcry_calloc_secure (size_t n, size_t m);
897 void *gcry_realloc (void *a, size_t n);
898 char *gcry_strdup (const char *string);
899 void *gcry_xmalloc (size_t n);
900 void *gcry_xcalloc (size_t n, size_t m);
901 void *gcry_xmalloc_secure (size_t n);
902 void *gcry_xcalloc_secure (size_t n, size_t m);
903 void *gcry_xrealloc (void *a, size_t n);
904 char *gcry_xstrdup (const char * a);
905 void  gcry_free (void *a);
906
907 /* Return true if A is allocated in "secure" memory. */
908 int gcry_is_secure (const void *a);
909
910
911 #ifndef GCRYPT_NO_MPI_MACROS
912 # ifndef DID_MPI_TYPEDEF
913     typedef struct gcry_mpi *MPI;
914 #   define DID_MPI_TYPEDEF
915 # endif
916 #endif /* GCRYPT_NO_MPI_MACROS */
917
918 #ifdef __cplusplus
919 }
920 #endif
921 #endif /* _GCRYPT_H */