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