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