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