2003-07-28 Moritz Schulte <moritz@g10code.com>
[libgcrypt.git] / doc / gcrypt.texi
1 \input texinfo                  @c -*- Texinfo -*-
2 @c Copyright (C) 2000, 2002, 2003 Free Software Foundation, Inc.
3 @c 
4 @c This file is part of the Libgcrypt.
5 @c
6 @c Permission is granted to copy, distribute and/or modify this document
7 @c under the terms of the GNU Free Documentation License, Version 1.1 or
8 @c any later version published by the Free Software Foundation; with no
9 @c Invariant Sections, with no the Front-Cover texts, and with no
10 @c Back-Cover Texts. 
11 @c A copy of the license is included in the file 'fdl.texi'.
12 @c
13 @setfilename gcrypt.info
14 @settitle The `Libgcrypt' Reference Manual
15
16 @dircategory GNU Libraries
17 @direntry
18 * libgcrypt: (gcrypt) Cryptographic function library.
19 @end direntry
20
21 @include version.texi
22
23 @c Unify some of the indices.
24 @syncodeindex tp fn
25 @syncodeindex pg fn
26
27 @ifinfo
28 This file documents the `Libgcrypt' library.
29
30 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
31 @cite{The `Libgcrypt' Reference Manual}, for Version
32 @value{VERSION}.
33
34 Copyright @copyright{} 2000, 2002, 2003 Free Software Foundation, Inc.
35
36 Permission is granted to copy, distribute and/or modify this document
37 under the terms of the GNU Free Documentation License, Version 1.1 or
38 any later version published by the Free Software Foundation; with no
39 Invariant Sections, with no the Front-Cover texts, and with no
40 Back-Cover Texts.  A copy of the license is included in the section
41 entitled ``GNU Free Documentation License''.
42 @end ifinfo
43
44 @c @iftex
45 @c @shorttitlepage The `Libgcrypt' Reference Manual
46 @c @end iftex
47 @titlepage
48 @center @titlefont{The `Libgcrypt'}
49 @sp 1
50 @center @titlefont{Reference Manual}
51 @sp 6
52 @center Edition @value{EDITION}
53 @sp 1
54 @center last updated @value{UPDATED}
55 @sp 1
56 @center for version @value{VERSION}
57 @page
58 @vskip 0pt plus 1filll
59 Copyright @copyright{} 2000, 2002, 2003 Free Software Foundation, Inc.
60
61 Permission is granted to copy, distribute and/or modify this document
62 under the terms of the GNU Free Documentation License, Version 1.1 or
63 any later version published by the Free Software Foundation; with no
64 Invariant Sections, with no the Front-Cover texts, and with no
65 Back-Cover Texts.  A copy of the license is included in the section
66 entitled ``GNU Free Documentation License''.
67 @end titlepage
68 @page
69
70 @ifnottex
71 @node Top
72 @top Main Menu
73 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
74 @cite{The `Libgcrypt' Reference Manual}, for Version
75 @value{VERSION} of the @acronym{Libgcrypt} library.
76 @end ifnottex
77
78 @menu
79 * Introduction::                 What is @acronym{Libgcrypt}.
80 * Preparation::                  What you should do before using the library.
81 * Generalities::                 General library functions and data types.
82 * Handler Functions::            Working with handler functions.
83 * Symmetric cryptography::       How to use symmetric crytography.
84 * Hashing::                      How to use hashing.
85 * Public Key cryptography (I)::  How to use public key cryptography.
86 * Public Key cryptography (II):: How to use public key cryptography, alternatively.
87 * Random Numbers::               How to work with random numbers.
88 * S-expressions::                How to manage S-expressions.
89 * MPI library::                  How to work with multi-precision-integers.
90 * Utilities::                    Utility functions.
91
92 Appendices
93
94 * Library Copying::             The GNU Lesser General Public License
95                                 says how you can copy and share `@acronym{Libgcrypt}'.
96 * Copying::                     The GNU General Public License says how you
97                                 can copy and share some parts of `@acronym{Libgcrypt}'.
98 * Free Documentation License::  This manual is under the GNU Free
99                                 Documentation License.
100
101 Indices
102
103 * Concept Index::               Index of concepts and programs.
104 * Function and Data Index::     Index of functions, variables and data types.
105
106 @detailmenu
107  --- The Detailed Node Listing ---
108
109 Introduction
110 * Getting Started::             How to use this manual.
111 * Features::                    A glance at @acronym{Libgcrypt}'s features.
112 * Overview::                    Overview about the library.
113
114 Preparation
115 * Header::                              What header file you need to include.
116 * Building sources::                    How to build sources using the library.
117 * Building sources using Automake::     How to build sources with the help auf Automake.
118 * Initializing the library::            How to initialize the library.
119 * Multi Threading::                     How @acronym{Libgcrypt} can be used in a MT environment.
120
121 Generalities
122 * Controlling the library::     Controlling @acronym{Libgcrypt}'s behaviour.
123 * Modules::                     Description of extension modules.
124 * Error Handling::              Error codes and such.
125
126 Handler Functions
127 * Progress handler::            Using a progress handler function.
128 * Allocation handler::          Using special memory allocation functions.
129 * Error handler::               Using error handler functions.
130 * Logging handler::             Using a special logging function.
131
132 Symmetric cryptography
133 * Available ciphers::           List of ciphers supported by the library.
134 * Cipher modules::              How to work with cipher modules.
135 * Available cipher modes::      List of cipher modes supported by the library.
136 * Working with cipher handles:: How to perform operations related to cipher handles.
137 * General cipher functions::    General cipher functions independent of cipher handles.
138
139 Hashing
140 * Available hash algorithms::           List of hash algorithms supported by the library.
141 * Hash algorithm modules::              How to work with hash algorithm modules.
142 * Working with hash algorithms::        List of functions related to hashing.
143
144 Public Key cryptography (I)
145 * Used S-expressions::                    Introduction into the used S-expression.
146 * Available algorithms::                  Algorithms supported by the library.
147 * Public key modules::                    How to work with public key modules.
148 * Cryptographic Functions::               Functions for performing the cryptographic actions.
149 * General public-key related Functions::  General functions, not implementing any cryptography.
150
151 Public Key cryptography (II)
152 * Available asymmetric algorithms:: List of algorithms supported by the library.
153 * Working with sets of data::       How to work with sets of data.
154 * Working with handles::            How to use handles.
155 * Working with keys::               How to work with keys.
156 * Using cryptographic functions::   How to perform cryptographic operations.
157 * Handle-independent functions::    General functions independent of handles.
158
159 Random Numbers
160 * Quality of random numbers::   @acronym{Libgcrypt} uses different quality levels.
161 * Retrieving random numbers::   How to retrieve random numbers.
162
163 S-expressions
164 * Data types for S-expressions::   Data types related with S-expressions.
165 * Working with S-expressions::     How to work with S-expressions.
166
167 MPI library
168 * Data types::                  MPI related data types.
169 * Basic functions::             First steps with MPI numbers.
170 * MPI formats::                 External representation of MPIs.
171 * Calculations::                Performing MPI calculations.
172 * Comparisons::                 How to compare MPI values.
173 * Bit manipulations::           How to access single bits of MPI values.
174 * Misc::                        Misc, fixme.
175
176 Utilities
177 * Memory allocation::           Functions related with memory allocation.
178
179 @end detailmenu
180
181 @end menu
182
183 @c **********************************************************
184 @c *******************  Introduction  ***********************
185 @c **********************************************************
186 @node Introduction
187 @chapter Introduction
188 `@acronym{Libgcrypt}' is a library providing cryptographic building blocks.
189
190 @menu
191 * Getting Started::             How to use this manual.
192 * Features::                    A glance at @acronym{Libgcrypt}'s features.
193 * Overview::                    Overview about the library.
194 @end menu
195
196 @node Getting Started
197 @section Getting Started
198
199 This manual documents the `@acronym{Libgcrypt}' library application programming
200 interface (API).  All functions and data types provided by the library
201 are explained.
202
203 The reader is assumed to possess basic knowledge about applied
204 cryptography.
205
206 This manual can be used in several ways.  If read from the beginning
207 to the end, it gives a good introduction into the library and how it
208 can be used in an application.  Forward references are included where
209 necessary.  Later on, the manual can be used as a reference manual to
210 get just the information needed about any particular interface of the
211 library.  Experienced programmers might want to start looking at the
212 examples at the end of the manual, and then only read up those parts
213 of the interface which are unclear.
214
215
216 @node Features
217 @section Features
218
219 @noindent
220 `Libgcrypt' might have a couple of advantages over other libraries doing
221 a similar job.
222
223 @table @asis
224 @item It's Free Software
225 Anybody can use, modify, and redistribute it under the terms of the GNU
226 Lesser General Public License (@pxref{Library Copying}).  Note, that
227 some parts (which are not needed on a GNU or GNU/Linux system) are
228 subject to the terms of the GNU General Public License
229 (@pxref{Copying}); please see the README file of the distribution for of
230 list of these parts.
231
232 @item It encapsulates the low level cryptography
233 `@acronym{Libgcrypt}' provides a high level interface to cryptographic building
234 blocks using an extendable and flexible API.
235
236 @end table
237
238
239 @node Overview
240 @section Overview
241
242 @noindent
243 The `@acronym{Libgcrypt}' library is fully thread-safe, where it makes
244 sense to be thread-safe.  An exception for thread-safety are some
245 cryptographic functions that modify a certain context stored in
246 handles.  If the user really intents to use such functions from
247 different threads on the same handle, he has to take care of the
248 serialisation of such functions himself.  If not described otherwise,
249 every function is thread-safe.
250
251 The library automagically detects whether an applications uses no
252 threading, pthreads or GNU Pth.
253
254 @acronym{Libgcrypt} depends on the library `libgpg-error', which
255 contains common error handling related code for GnuPG components.
256
257 @c **********************************************************
258 @c *******************  Preparation  ************************
259 @c **********************************************************
260 @node Preparation
261 @chapter Preparation
262
263 To use `@acronym{Libgcrypt}', you have to perform some changes to your sources and
264 the build system.  The necessary changes are small and explained in the
265 following sections.  At the end of this chapter, it is described how the
266 library is initialized, and how the requirements of the library are
267 verified.
268
269 @menu
270 * Header::                              What header file you need to include.
271 * Building sources::                    How to build sources using the library.
272 * Building sources using Automake::     How to build sources with the help auf Automake.
273 * Initializing the library::            How to initialize the library.
274 * Multi Threading::                     How @acronym{Libgcrypt} can be used in a MT environment.
275 @end menu
276
277
278 @node Header
279 @section Header
280
281 All interfaces (data types and functions) of the library are defined
282 in the header file `gcrypt.h'.  You must include this in all source
283 files using the library, either directly or through some other header
284 file, like this:
285
286 @example
287 #include <gcrypt.h>
288 @end example
289
290 The name space of `@acronym{Libgcrypt}' is @code{gcry_*} for function
291 and type names and @code{GCRY*} for other symbols.  In addition the
292 same name prefixes with one prepended underscore are reserved for
293 internal use and should never be used by an application.  Furthermore
294 `libgpg-error' defines functions prefixed with `gpg_' and preprocessor
295 symbols prefixed with `GPG_'.  Note that @acronym{Libgcrypt} uses
296 libgpg-error, which uses @code{gpg_err_*} as name space for function
297 and type names and @code{GPG_ERR_*} for other symbols, including all
298 the error codes.
299
300 @node Building sources
301 @section Building sources
302
303 If you want to compile a source file including the `gcrypt.h' header
304 file, you must make sure that the compiler can find it in the
305 directory hierarchy.  This is accomplished by adding the path to the
306 directory in which the header file is located to the compilers include
307 file search path (via the @option{-I} option).
308
309 However, the path to the include file is determined at the time the
310 source is configured.  To solve this problem, `@acronym{Libgcrypt}' ships with a small
311 helper program @command{libgcrypt-config} that knows the path to the
312 include file and other configuration options.  The options that need
313 to be added to the compiler invocation at compile time are output by
314 the @option{--cflags} option to @command{libgcrypt-config}.  The following
315 example shows how it can be used at the command line:
316
317 @example
318 gcc -c foo.c `libgcrypt-config --cflags`
319 @end example
320
321 Adding the output of @samp{libgcrypt-config --cflags} to the compilers
322 command line will ensure that the compiler can find the `@acronym{Libgcrypt}' header
323 file.
324
325 A similar problem occurs when linking the program with the library.
326 Again, the compiler has to find the library files.  For this to work,
327 the path to the library files has to be added to the library search path
328 (via the @option{-L} option).  For this, the option @option{--libs} to
329 @command{libgcrypt-config} can be used.  For convenience, this option
330 also outputs all other options that are required to link the program
331 with the `@acronym{Libgcrypt}' libraries (in particular, the @samp{-lgcrypt}
332 option).  The example shows how to link @file{foo.o} with the `@acronym{Libgcrypt}'
333 library to a program @command{foo}.
334
335 @example
336 gcc -o foo foo.o `libgcrypt-config --libs`
337 @end example
338
339 Of course you can also combine both examples to a single command by
340 specifying both options to @command{libgcrypt-config}:
341
342 @example
343 gcc -o foo foo.c `libgcrypt-config --cflags --libs`
344 @end example
345
346 @node Building sources using Automake
347 @section Building sources using Automake
348
349 It is much easier if you use GNU Automake instead of writing your own
350 Makefiles.  If you do that you do not have to worry about finding and
351 invoking the @command{libgcrypt-config} script at all.
352 @acronym{Libgcrypt} provides an extension to Automake that does all
353 the work for you.
354
355 @c A simple macro for optional variables.
356 @macro ovar{varname}
357 @r{[}@var{\varname\}@r{]}
358 @end macro
359 @defmac AM_PATH_LIBGCRYPT (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
360 Check whether @acronym{Libgcrypt} (at least version
361 @var{minimum-version}, if given) exists on the host system.  If it is
362 found, execute @var{action-if-found}, otherwise do
363 @var{action-if-not-found}, if given.
364
365 Additionally, the function defines @code{LIBGCRYPT_CFLAGS} to the
366 flags needed for compilation of the program to find the
367 @file{gcrypt.h} header file, and @code{LIBGCRYPT_LIBS} to the linker
368 flags needed to link the program to the @acronym{Libgcrypt} library.
369 @end defmac
370
371 You can use the defined Autoconf variables like this in your
372 @file{Makefile.am}:
373
374 @example
375 AM_CPPFLAGS = $(LIBGCRYPT_CFLAGS)
376 LDADD = $(LIBGCRYPT_LIBS)
377 @end example
378
379 @node Initializing the library
380 @section Initializing the library
381
382 It is often desirable to check that the version of `@acronym{Libgcrypt}' used is
383 indeed one which fits all requirements.  Even with binary compatibility
384 new features may have been introduced but due to problem with the
385 dynamic linker an old version is actually used.  So you may want to
386 check that the version is okay right after program startup.
387
388 @deftypefun const char *gcry_check_version (const char *@var{req_version})
389
390 The function @code{gcry_check_version} has three purposes.  It can be
391 used to retrieve the version number of the library.  In addition it
392 can verify that the version number is higher than a certain required
393 version number.
394
395 In either case, the function initializes some sub-systems, and for
396 this reason alone it must be invoked early in your program, before you
397 make use of the other functions of @acronym{Libgcrypt}.
398 @end deftypefun
399
400 @node Multi Threading
401 @section Multi Threading
402
403 As mentioned earlier, the `@acronym{Libgcrypt}' library is fully thread-safe;
404 the library automagically detects whether an applications uses no
405 threading, pthreads or GNU Pth.
406
407 If you link your program dynamically to @acronym{Libgcrypt} and your
408 supported thread library, @acronym{Libgcrypt} will automatically
409 detect the presence of this library and activate its use.  You must
410 link to the thread library before linking to @acronym{Libgcrypt}.  If
411 you link to both pthread and GNU Pth, @acronym{Libgcrypt} will use the
412 pthread support.  This feature requires weak symbol support.
413
414 If you link your program statically to @acronym{Libgcrypt}, or your
415 system does not support weak symbols, there is currently no easy way
416 to make sure that @acronym{Libgcrypt} detects the presence of the
417 thread library.  This will be solved in a future version.
418
419 The function @code{gcry_check_version} must be called before any other
420 function in the library, because it initializes the thread support
421 subsystem in @acronym{Libgcrypt}.  To achieve this in all generality,
422 it is necessary to synchronize the call to this function with all
423 other calls to functions in the library, using the synchronization
424 mechanisms available in your thread library.  Otherwise, specific
425 compiler or CPU memory cache optimizations could lead to the situation
426 where a thread is started and uses @acronym{Libgcrypt} before the
427 effects of the initialization are visible for this thread.  It doesn't
428 even suffice to call @code{gcry_check_version} before creating this
429 other thread@footnote{In SMP systems the new thread could be started
430 on another CPU before the effects of the initialization are seen by
431 that CPU's memory cache.  Not doing proper synchronization here leads
432 to the same problems the double-checked locking idiom has.  You might
433 find that if you don't do proper synchronization, it still works in
434 most configurations.  Don't let this fool you.  Someday it might lead
435 to subtle bugs when someone tries it on a DEC Alpha or an SMP
436 machine.}.
437
438 For example, if you are using POSIX threads, each thread that wants to
439 call functions in @acronym{Libgcrypt} could call the following
440 function before any function in the library:
441
442 @example
443 #include <pthread.h>
444
445 void
446 initialize_gcrypt (void)
447 @{
448   static int gcrypt_init;
449   static pthread_mutext_t gcrypt_init_lock = PTHREAD_MUTEX_INITIALIZER;
450
451   pthread_mutex_lock (&gcrypt_init_lock);
452   if (! gcrypt_init)
453     @{
454       gcry_check_version ();
455       gcrypt_init = 1;
456     @}
457   pthread_mutex_unlock (&gcrypt_init_lock);
458 @}
459 @end example
460
461 @c **********************************************************
462 @c *******************  General  ****************************
463 @c **********************************************************
464 @node Generalities
465 @chapter Generalities
466
467 @menu
468 * Controlling the library::     Controlling @acronym{Libgcrypt}'s behaviour.
469 * Modules::                     Description of extension modules.
470 * Error Handling::              Error codes and such.
471 @end menu
472
473 @node Controlling the library
474 @section Controlling the library
475
476 @deftypefun gcry_error_t gcry_control (enum gcry_ctl_cmds @var{cmd}, ...)
477
478 This function can be used to influence the general behaviour of
479 @acronym{Libgcrypt} in several ways.  Depending on @var{cmd}, more arguments can
480 or have to be provided.
481
482 @end deftypefun
483
484 @node Modules
485 @section Modules
486
487 @acronym{Libgcrypt} supports the use of `extension modules', which
488 implement algorithms in addition to those already built into the
489 library directly.
490
491 @deftp {Data type} gcry_module_t
492 This data type represents a `module'.
493 @end deftp
494
495 Functions registering modules provided by the user take a `module
496 specification structure' as input and return a value of
497 @code{gcry_module_t} and an ID that is unique in the modules'
498 category.  This ID can be used to reference the newly registered
499 module.  After registering a module successfuly, the new functionality
500 should be able to be used through the normal functions provided by
501 @acronym{Libgcrypt} until it is unregistered again.
502
503 @c **********************************************************
504 @c *******************  Errors  ****************************
505 @c **********************************************************
506 @node Error Handling
507 @section Error Handling
508
509 Many functions in @acronym{Libgcrypt} can return an error if they
510 fail.  For this reason, the application should always catch the error
511 condition and take appropriate measures, for example by releasing the
512 resources and passing the error up to the caller, or by displaying a
513 descriptive message to the user and cancelling the operation.
514
515 Some error values do not indicate a system error or an error in the
516 operation, but the result of an operation that failed properly.  For
517 example, if you try to decrypt a tempered message, the decryption will
518 fail.  Another error value actually means that the end of a data
519 buffer or list has been reached.  The following descriptions explain
520 for many error codes what they mean usually.  Some error values have
521 specific meanings if returned by a certain functions.  Such cases are
522 described in the documentation of those functions.
523
524 @acronym{Libgcrypt} uses the @code{libgpg-error} library.  This allows
525 to share the error codes with other components of the GnuPG system,
526 and thus pass error values transparently from the crypto engine, or
527 some helper application of the crypto engine, to the user.  This way
528 no information is lost.  As a consequence, @acronym{Libgcrypt} does
529 not use its own identifiers for error codes, but uses those provided
530 by @code{libgpg-error}.  They usually start with @code{GPG_ERR_}.
531
532 However, @acronym{Libgcrypt} does provide aliases for the functions
533 defined in libgpg-error, which might be preferred for name space
534 consistency.
535
536
537 Most functions in @acronym{Libgcrypt} return an error code in the case
538 of failure.  For this reason, the application should always catch the
539 error condition and take appropriate measures, for example by
540 releasing the resources and passing the error up to the caller, or by
541 displaying a descriptive message to the user and canceling the
542 operation.
543
544 Some error values do not indicate a system error or an error in the
545 operation, but the result of an operation that failed properly.
546
547 GnuPG components, including libgcrypt, use an extra library named
548 libgpg-error to provide a common error handling scheme.  For more
549 information on libgpg-error, see the according manual.
550
551 @menu
552 * Error Values::                  The error value and what it means.
553 * Error Sources::                 A list of important error sources.
554 * Error Codes::                   A list of important error codes.
555 * Error Strings::                 How to get a descriptive string from a value.
556 @end menu
557
558
559 @node Error Values
560 @subsection Error Values
561 @cindex error values
562 @cindex error codes
563 @cindex error sources
564
565 @deftp {Data type} {gcry_err_code_t}
566 The @code{gcry_err_code_t} type is an alias for the
567 @code{libgpg-error} type @code{gpg_err_code_t}.  The error code
568 indicates the type of an error, or the reason why an operation failed.
569
570 A list of important error codes can be found in the next section.
571 @end deftp
572
573 @deftp {Data type} {gcry_err_source_t}
574 The @code{gcry_err_source_t} type is an alias for the
575 @code{libgpg-error} type @code{gpg_err_source_t}.  The error source
576 has not a precisely defined meaning.  Sometimes it is the place where
577 the error happened, sometimes it is the place where an error was
578 encoded into an error value.  Usually the error source will give an
579 indication to where to look for the problem.  This is not always true,
580 but it is attempted to achieve this goal.
581
582 A list of important error sources can be found in the next section.
583 @end deftp
584
585 @deftp {Data type} {gcry_error_t}
586 The @code{gcry_error_t} type is an alias for the @code{libgpg-error}
587 type @code{gpg_error_t}.  An error value like this has always two
588 components, an error code and an error source.  Both together form the
589 error value.
590
591 Thus, the error value can not be directly compared against an error
592 code, but the accessor functions described below must be used.
593 However, it is guaranteed that only 0 is used to indicate success
594 (@code{GPG_ERR_NO_ERROR}), and that in this case all other parts of
595 the error value are set to 0, too.
596
597 Note that in @acronym{Libgcrypt}, the error source is used purely for
598 diagnostical purposes.  Only the error code should be checked to test
599 for a certain outcome of a function.  The manual only documents the
600 error code part of an error value.  The error source is left
601 unspecified and might be anything.
602 @end deftp
603
604 @deftypefun {static __inline__ gcry_err_code_t} gcry_err_code (@w{gcry_error_t @var{err}})
605 The static inline function @code{gcry_err_code} returns the
606 @code{gcry_err_code_t} component of the error value @var{err}.  This
607 function must be used to extract the error code from an error value in
608 order to compare it with the @code{GPG_ERR_*} error code macros.
609 @end deftypefun
610
611 @deftypefun {static __inline__ gcry_err_source_t} gcry_err_source (@w{gcry_error_t @var{err}})
612 The static inline function @code{gcry_err_source} returns the
613 @code{gcry_err_source_t} component of the error value @var{err}.  This
614 function must be used to extract the error source from an error value in
615 order to compare it with the @code{GPG_ERR_SOURCE_*} error source macros.
616 @end deftypefun
617
618 @deftypefun {static __inline__ gcry_error_t} gcry_err_make (@w{gcry_err_source_t @var{source}}, @w{gcry_err_code_t @var{code}})
619 The static inline function @code{gcry_err_make} returns the error
620 value consisting of the error source @var{source} and the error code
621 @var{code}.
622
623 This function can be used in callback functions to construct an error
624 value to return it to the library.
625 @end deftypefun
626
627 @deftypefun {static __inline__ gcry_error_t} gcry_error (@w{gcry_err_code_t @var{code}})
628 The static inline function @code{gcry_error} returns the error value
629 consisting of the default error source and the error code @var{code}.
630
631 For @acronym{GCRY} applications, the default error source is
632 @code{GPG_ERR_SOURCE_USER_1}.  You can define
633 @code{GCRY_ERR_SOURCE_DEFAULT} before including @file{gcrypt.h} to
634 change this default.
635
636 This function can be used in callback functions to construct an error
637 value to return it to the library.
638 @end deftypefun
639
640 The @code{libgpg-error} library provides error codes for all system
641 error numbers it knows about.  If @var{err} is an unknown error
642 number, the error code @code{GPG_ERR_UNKNOWN_ERRNO} is used.  The
643 following functions can be used to construct error values from system
644 errnor numbers.
645
646 @deftypefun {gcry_error_t} gcry_err_make_from_errno (@w{gcry_err_source_t @var{source}}, @w{int @var{err}})
647 The function @code{gcry_err_make_from_errno} is like
648 @code{gcry_err_make}, but it takes a system error like @code{errno}
649 instead of a @code{gcry_err_code_t} error code.
650 @end deftypefun
651
652 @deftypefun {gcry_error_t} gcry_error_from_errno (@w{int @var{err}})
653 The function @code{gcry_error_from_errno} is like @code{gcry_error},
654 but it takes a system error like @code{errno} instead of a
655 @code{gcry_err_code_t} error code.
656 @end deftypefun
657
658 Sometimes you might want to map system error numbers to error codes
659 directly, or map an error code representing a system error back to the
660 system error number.  The following functions can be used to do that.
661
662 @deftypefun {gcry_err_code_t} gcry_err_code_from_errno (@w{int @var{err}})
663 The function @code{gcry_err_code_from_errno} returns the error code
664 for the system error @var{err}.  If @var{err} is not a known system
665 error, the function returns @code{GPG_ERR_UNKNOWN_ERRNO}.
666 @end deftypefun
667
668 @deftypefun {int} gcry_err_code_to_errno (@w{gcry_err_code_t @var{err}})
669 The function @code{gcry_err_code_to_errno} returns the system error
670 for the error code @var{err}.  If @var{err} is not an error code
671 representing a system error, or if this system error is not defined on
672 this system, the function returns @code{0}.
673 @end deftypefun
674
675
676 @node Error Sources
677 @subsection Error Sources
678 @cindex error codes, list of
679
680 The library @code{libgpg-error} defines an error source for every
681 component of the GnuPG system.  The error source part of an error
682 value is not well defined.  As such it is mainly useful to improve the
683 diagnostic error message for the user.
684
685 If the error code part of an error value is @code{0}, the whole error
686 value will be @code{0}.  In this case the error source part is of
687 course @code{GPG_ERR_SOURCE_UNKNOWN}.
688
689 The list of error sources that might occur in applications using
690 @acronym{Libgctypt} is:
691
692 @table @code
693 @item GPG_ERR_SOURCE_UNKNOWN
694 The error source is not known.  The value of this error source is
695 @code{0}.
696
697 @item GPG_ERR_SOURCE_GPGME
698 The error source is @acronym{GPGME} itself.
699
700 @item GPG_ERR_SOURCE_GPG
701 The error source is GnuPG, which is the crypto engine used for the
702 OpenPGP protocol.
703
704 @item GPG_ERR_SOURCE_GPGSM
705 The error source is GPGSM, which is the crypto engine used for the
706 OpenPGP protocol.
707
708 @item GPG_ERR_SOURCE_GCRYPT
709 The error source is @code{libgcrypt}, which is used by crypto engines
710 to perform cryptographic operations.
711
712 @item GPG_ERR_SOURCE_GPGAGENT
713 The error source is @command{gpg-agent}, which is used by crypto
714 engines to perform operations with the secret key.
715
716 @item GPG_ERR_SOURCE_PINENTRY
717 The error source is @command{pinentry}, which is used by
718 @command{gpg-agent} to query the passphrase to unlock a secret key.
719
720 @item GPG_ERR_SOURCE_SCD
721 The error source is the SmartCard Daemon, which is used by
722 @command{gpg-agent} to delegate operations with the secret key to a
723 SmartCard.
724
725 @item GPG_ERR_SOURCE_KEYBOX
726 The error source is @code{libkbx}, a library used by the crypto
727 engines to manage local keyrings.
728
729 @item GPG_ERR_SOURCE_USER_1
730 @item GPG_ERR_SOURCE_USER_2
731 @item GPG_ERR_SOURCE_USER_3
732 @item GPG_ERR_SOURCE_USER_4
733 These error sources are not used by any GnuPG component and can be
734 used by other software.  For example, applications using
735 @acronym{Libgcrypt} can use them to mark error values coming from callback
736 handlers.  Thus @code{GPG_ERR_SOURCE_USER_1} is the default for errors
737 created with @code{gcry_error} and @code{gcry_error_from_errno},
738 unless you define @code{GCRY_ERR_SOURCE_DEFAULT} before including
739 @file{gcrypt.h}.
740 @end table
741
742
743 @node Error Codes
744 @subsection Error Codes
745 @cindex error codes, list of
746
747 The library @code{libgpg-error} defines many error values.  The
748 following list includes the most important error codes.
749
750 @table @code
751 @item GPG_ERR_EOF
752 This value indicates the end of a list, buffer or file.
753
754 @item GPG_ERR_NO_ERROR
755 This value indicates success.  The value of this error code is
756 @code{0}.  Also, it is guaranteed that an error value made from the
757 error code @code{0} will be @code{0} itself (as a whole).  This means
758 that the error source information is lost for this error code,
759 however, as this error code indicates that no error occured, this is
760 generally not a problem.
761
762 @item GPG_ERR_GENERAL
763 This value means that something went wrong, but either there is not
764 enough information about the problem to return a more useful error
765 value, or there is no separate error value for this type of problem.
766
767 @item GPG_ERR_ENOMEM
768 This value means that an out-of-memory condition occurred.
769
770 @item GPG_ERR_E...
771 System errors are mapped to GPG_ERR_EFOO where FOO is the symbol for
772 the system error.
773
774 @item GPG_ERR_INV_VALUE
775 This value means that some user provided data was out of range.
776
777 @item GPG_ERR_UNUSABLE_PUBKEY
778 This value means that some recipients for a message were invalid.
779
780 @item GPG_ERR_UNUSABLE_SECKEY
781 This value means that some signers were invalid.
782
783 @item GPG_ERR_NO_DATA
784 This value means that data was expected where no data was found.
785
786 @item GPG_ERR_CONFLICT
787 This value means that a conflict of some sort occurred.
788
789 @item GPG_ERR_NOT_IMPLEMENTED
790 This value indicates that the specific function (or operation) is not
791 implemented.  This error should never happen.  It can only occur if
792 you use certain values or configuration options which do not work,
793 but for which we think that they should work at some later time.
794
795 @item GPG_ERR_DECRYPT_FAILED
796 This value indicates that a decryption operation was unsuccessful.
797
798 @item GPG_ERR_WRONG_KEY_USAGE
799 This value indicates that a key is not used appropriately.
800
801 @item GPG_ERR_NO_SECKEY
802 This value indicates that no secret key for the user ID is available.
803
804 @item GPG_ERR_UNSUPPORTED_ALGORITHM
805 This value means a verification failed because the cryptographic
806 algorithm is not supported by the crypto backend.
807
808 @item GPG_ERR_BAD_SIGNATURE
809 This value means a verification failed because the signature is bad.
810
811 @item GPG_ERR_NO_PUBKEY
812 This value means a verification failed because the public key is not
813 available.
814
815 @item GPG_ERR_USER_1
816 @item GPG_ERR_USER_2
817 @item ...
818 @item GPG_ERR_USER_16
819 These error codes are not used by any GnuPG component and can be
820 freely used by other software.  Applications using @acronym{Libgcrypt}
821 might use them to mark specific errors returned by callback handlers
822 if no suitable error codes (including the system errors) for these
823 errors exist already.
824 @end table
825
826
827 @node Error Strings
828 @subsection Error Strings
829 @cindex error values, printing of
830 @cindex error codes, printing of
831 @cindex error sources, printing of
832 @cindex error strings
833
834 @deftypefun {const char *} gcry_strerror (@w{gcry_error_t @var{err}})
835 The function @code{gcry_strerror} returns a pointer to a statically
836 allocated string containing a description of the error code contained
837 in the error value @var{err}.  This string can be used to output a
838 diagnostic message to the user.
839 @end deftypefun
840
841
842 @deftypefun {const char *} gcry_strsource (@w{gcry_error_t @var{err}})
843 The function @code{gcry_strerror} returns a pointer to a statically
844 allocated string containing a description of the error source
845 contained in the error value @var{err}.  This string can be used to
846 output a diagnostic message to the user.
847 @end deftypefun
848
849 The following example illustrates the use of the functions described
850 above:
851
852 @example
853 @{
854   gcry_cipher_hd_t handle;
855   gcry_error_t err = 0;
856
857   err = gcry_cipher_open (&handle, GCRY_CIPHER_AES, GCRY_CIPHER_MODE_CBC, 0);
858   if (err)
859     @{
860       fprintf (stderr, "Failure: %s/%s\n",
861                gcry_strsource (err),
862                gcry_strerror (err));
863     @}
864 @}
865 @end example
866
867 @c **********************************************************
868 @c *******************  General  ****************************
869 @c **********************************************************
870 @node Handler Functions
871 @chapter Handler Functions
872
873 @acronym{Libgcrypt} makes it possible to install so called `handler functions',
874 which get called by @acronym{Libgcrypt} in case of certain events.
875
876 @menu
877 * Progress handler::            Using a progress handler function.
878 * Allocation handler::          Using special memory allocation functions.
879 * Error handler::               Using error handler functions.
880 * Logging handler::             Using a special logging function.
881 @end menu
882
883 @node Progress handler
884 @section Progress handler
885
886 It is often useful to retrieve some feedback while long running
887 operations are performed.
888
889 @deftp {Data type} gcry_handler_progress_t
890 Progress handler functions have to be of the type
891 @code{gcry_handler_progress_t}, which is defined as:
892
893 @code{void (*gcry_handler_progress_t) (void *, const char *, int, int, int)}
894 @end deftp
895
896 The following function may be used to register a handler function for
897 this purpose.
898
899 @deftypefun void gcry_set_progress_handler (gcry_handler_progress_t @var{cb}, void *@var{cb_data})
900
901 This function installs @var{cb} as the `Progress handler' function.
902 @var{cb} must be defined as follows:
903
904 @example
905 void
906 my_progress_handler (void *@var{cb_data}, const char *@var{what},
907                      int @var{printchar}, int @var{current}, int @var{total})
908 @{
909   /* Do something.  */
910 @}
911 @end example
912
913 A description of the arguments of the progress handler function follows.
914
915 @table @var
916 @item cb_data
917 The argument provided in the call to @code{gcry_set_progress_handler}.
918 @item what
919 A string identifying the type of the progress output.  The following
920 values for @var{what} are defined:
921
922 @table @code
923 @item need_entropy
924 Not enough entropy is available.  @var{total} holds the number of
925 required bytes.
926
927 @item primegen
928 Values for @var{printchar}:
929 @table @code
930 @item \n
931 Prime generated.
932 @item !
933 Need to refresh the pool of prime numbers.
934 @item <, >
935 Number of bits adjusted.
936 @item ^
937 Searching for a generator.
938 @item .
939 Fermat test on 10 candidates failed.
940 @item :
941 Restart with a new random value.
942 @item +
943 Rabin Miller test passed.
944 @end table
945
946 @end table
947
948 @end table
949 @end deftypefun
950
951 @node Allocation handler
952 @section Allocation handler
953
954 It is possible to make @acronym{Libgcrypt} use special memory
955 allocation functions instead of the built-in ones.
956
957 Memory allocation functions are of the following types:
958 @deftp {Data type} gcry_handler_alloc_t
959 This type is defined as: @code{void *(*gcry_handler_alloc_t) (size_t n)}.
960 @end deftp
961 @deftp {Data type} gcry_handler_secure_check_t
962 This type is defined as: @code{void *(*gcry_handler_secure_check_t) (void *)}.
963 @end deftp
964 @deftp {Data type} gcry_handler_realloc_t
965 This type is defined as: @code{void *(*gcry_handler_realloc_t) (void *p, size_t n)}.
966 @end deftp
967 @deftp {Data type} gcry_handler_free_t
968 This type is defined as: @code{void *(*gcry_handler_free_t) (void *)}.
969 @end deftp
970
971 Special memory allocation functions can be installed with the
972 following function:
973
974 @deftypefun void gcry_set_allocation_handler (gcry_handler_alloc_t @var{func_alloc}, gcry_handler_alloc_t @var{func_alloc_secure}, gcry_handler_secure_check_t @var{func_secure_check}, gcry_handler_realloc_t @var{func_realloc}, gcry_handler_free_t @var{func_free})
975 Install the provided functions and use them instead of the built-in
976 functions for doing memory allocation.
977 @end deftypefun
978
979 @node Error handler
980 @section Error handler
981
982 The following functions may be used to register handler functions that
983 are called by @acronym{Libgcrypt} in case certain error conditions
984 occur.
985
986 @deftp {Data type} gcry_handler_no_mem_t
987 This type is defined as: @code{void (*gcry_handler_no_mem_t) (void *, size_t, unsigned int)}
988 @end deftp
989 @deftypefun void gcry_set_outofcore_handler (gcry_handler_no_mem_t @var{func_no_mem}, void *@var{cb_data})
990 This function registers @var{func_no_mem} as `out-of-core handler',
991 which means that it will be called in the case of not having enough
992 memory available.
993 @end deftypefun
994
995 @deftp {Data type} gcry_handler_error_t
996 This type is defined as: @code{void (*gcry_handler_error_t) (void *, int, const char *)}
997 @end deftp
998
999 @deftypefun void gcry_set_fatalerror_handler (gcry_handler_error_t @var{func_error}, void *@var{cb_data})
1000 This function registers @var{func_error} as `error handler',
1001 which means that it will be called in error conditions.
1002 @end deftypefun
1003
1004 @node Logging handler
1005 @section Logging handler
1006
1007 @deftp {Data type} gcry_handler_log_t
1008 This type is defined as: @code{void (*gcry_handler_log_t) (void *, int, const char *, va_list)}
1009 @end deftp
1010
1011 @deftypefun void gcry_set_log_handler (gcry_handler_log_t @var{func_log}, void *@var{cb_data})
1012 This function registers @var{func_log} as `logging handler', which
1013 means that it will be called in case @acronym{Libgcrypt} wants to log
1014 a message.
1015 @end deftypefun
1016
1017 @c **********************************************************
1018 @c *******************  Ciphers  ****************************
1019 @c **********************************************************
1020 @c @include cipher-ref.texi
1021 @node Symmetric cryptography
1022 @chapter Symmetric cryptography
1023
1024 The cipher functions are used for symmetrical cryptography,
1025 i.e. cryptography using a shared key.  The programming model follows
1026 an open/process/close paradigm and is in that similar to other
1027 building blocks provided by @acronym{Libgcrypt}.
1028
1029 @menu
1030 * Available ciphers::            List of ciphers supported by the library.
1031 * Cipher modules::               How to work with cipher modules.
1032 * Available cipher modes::       List of cipher modes supported by the library.
1033 * Working with cipher handles::  How to perform operations related to cipher handles.
1034 * General cipher functions::     General cipher functions independent of cipher handles.
1035 @end menu
1036
1037 @node Available ciphers
1038 @section Available ciphers
1039
1040 @table @code
1041 @item GCRY_CIPHER_NONE
1042 This is not a real algorithm but used by some functions as error return.
1043 The value always evaluates to false.
1044
1045 @item GCRY_CIPHER_IDEA
1046 This is the IDEA algorithm.  The constant is provided but there is
1047 currently no implementation for it because the algorithm is patented.
1048
1049 @item GCRY_CIPHER_3DES
1050 Triple-DES with 3 Keys as EDE.  The key size of this algorithm is 168 but
1051 you have to pass 192 bits because the most significant bits of each byte
1052 are ignored.
1053
1054 @item GCRY_CIPHER_CAST5
1055 CAST128-5 block cipher algorithm.  The key size is 128 bits.
1056         
1057 @item GCRY_CIPHER_BLOWFISH
1058 The blowfish algorithm. The current implementation allows only for a key
1059 size of 128 bits.
1060
1061 @item GCRY_CIPHER_SAFER_SK128
1062 Reserved and not currently implemented.
1063
1064 @item GCRY_CIPHER_DES_SK          
1065 Reserved and not currently implemented.
1066  
1067 @item  GCRY_CIPHER_AES        
1068 @itemx GCRY_CIPHER_AES128
1069 @itemx GCRY_CIPHER_RIJNDAEL
1070 @itemx GCRY_CIPHER_RIJNDAEL128
1071 AES (Rijndael) with a 128 bit key.
1072
1073 @item  GCRY_CIPHER_AES192     
1074 @itemx GCRY_CIPHER_RIJNDAEL128
1075 AES (Rijndael) with a 192 bit key.
1076
1077 @item  GCRY_CIPHER_AES256 
1078 @itemx GCRY_CIPHER_RIJNDAEL256
1079 AES (Rijndael) with a 256 bit key.
1080     
1081 @item  GCRY_CIPHER_TWOFISH
1082 The Twofish algorithm with a 256 bit key.
1083     
1084 @item  GCRY_CIPHER_TWOFISH128
1085 The Twofish algorithm with a 128 bit key.
1086     
1087 @item  GCRY_CIPHER_ARCFOUR   
1088 An algorithm which is 100% compatible with RSA Inc.'s RC4 algorithm.
1089 Note that this is a stream cipher and must be used very carefully to
1090 avoid a couple of weaknesses. 
1091
1092 @item  GCRY_CIPHER_DES       
1093 Standard DES with a 56 bit key. You need to pass 64 bit but the high
1094 bits of each byte are ignored.  Note, that this is a weak algorithm
1095 which can be broken in reasonable time using a brute force approach.
1096
1097 @end table
1098
1099 @node Cipher modules
1100 @section Cipher modules
1101
1102 @acronym{Libgcrypt} makes it possible to load additional `cipher
1103 modules'; these cipher can be used just like the cipher algorithms
1104 that are built into the library directly.  For an introduction into
1105 extension modules, see @xref{Modules}.
1106
1107 @deftp {Data type} gcry_cipher_spec_t
1108 This is the `module specification structure' needed for registering
1109 cipher modules, which has to be filled in by the user before it can be
1110 used to register a module.  It contains the following members:
1111
1112 @table @code
1113 @item const char *name
1114 The primary name of the algorithm.
1115 @item const char **aliases
1116 A list of strings that are `aliases' for the algorithm.  The list must
1117 be terminated with a NULL element.
1118 @item gcry_cipher_oid_spec_t *oids
1119 A list of OIDs that are to be associated with the algorithm.  The
1120 list's last element must have it's `oid' member set to NULL.  See
1121 below for an explanation of this type.
1122 @item size_t blocksize
1123 The block size of the algorithm, in bytes.
1124 @item size_t keylen
1125 The length of the key, in bits.
1126 @item size_t contextsize
1127 The size of the algorithm-specific `context', that should be allocated
1128 for each handle.
1129 @item gcry_cipher_setkey_t setkey
1130 The function responsible for initializing a handle with a provided
1131 key.  See below for a description of this type.
1132 @item gcry_cipher_encrypt_t encrypt
1133 The function responsible for encrypting a single block.  See below for
1134 a description of this type.
1135 @item gcry_cipher_decrypt_t decrypt
1136 The function responsible for decrypting a single block.  See below for
1137 a description of this type.
1138 @item gcry_cipher_stencrypt_t stencrypt
1139 Like `encrypt', for stream ciphers.  See below for a description of
1140 this type.
1141 @item gcry_cipher_stdecrypt_t stdecrypt
1142 Like `decrypt', for stream ciphers.  See below for a description of
1143 this type.
1144 @end table
1145 @end deftp
1146
1147 @deftp {Data type} gcry_cipher_oid_spec_t
1148 This type is used for associating a user-provided algorithm
1149 implementation with certain OIDs.  It contains the following members:
1150 @table @code
1151 @item const char *oid
1152 Textual representation of the OID.
1153 @item int mode
1154 Cipher mode for which this OID is valid.
1155 @end table
1156 @end deftp
1157
1158 @deftp {Data type} gcry_cipher_setkey_t
1159 Type for the `setkey' function, defined as: gcry_err_code_t
1160 (*gcry_cipher_setkey_t) (void *c, const unsigned char *key, unsigned
1161 keylen)
1162 @end deftp
1163
1164 @deftp {Data type} gcry_cipher_encrypt_t
1165 Type for the `encrypt' function, defined as: gcry_err_code_t
1166 (*gcry_cipher_encrypt_t) (void *c, const unsigned char *outbuf, const
1167 unsigned char *inbuf)
1168 @end deftp
1169
1170 @deftp {Data type} gcry_cipher_decrypt_t
1171 Type for the `decrypt' function, defined as: gcry_err_code_t
1172 (*gcry_cipher_decrypt_t) (void *c, const unsigned char *outbuf, const
1173 unsigned char *inbuf)
1174 @end deftp
1175
1176 @deftp {Data type} gcry_cipher_stencrypt_t
1177 Type for the `stencrypt' function, defined as: gcry_err_code_t
1178 (*gcry_cipher_stencrypt_t) (void *c, const unsigned char *outbuf, const
1179 unsigned char *, unsigned int n)
1180 @end deftp
1181
1182 @deftp {Data type} gcry_cipher_stdecrypt_t
1183 Type for the `stdecrypt' function, defined as: gcry_err_code_t
1184 (*gcry_cipher_stdecrypt_t) (void *c, const unsigned char *outbuf, const
1185 unsigned char *, unsigned int n)
1186 @end deftp
1187
1188 @deftypefun gcry_error_t gcry_cipher_register (gcry_cipher_spec_t *@var{cipher}, unsigned int *algorithm_id, gcry_module_t *@var{module})
1189
1190 Register a new cipher module whose specification can be found in
1191 @var{cipher}.  On success, a new algorithm ID is stored in
1192 @var{algorithm_id} and a pointer representhing this module is stored
1193 in @var{module}.
1194 @end deftypefun
1195
1196 @deftypefun void gcry_cipher_unregister (gcry_module_t @var{module})
1197 Unregister the cipher identified by @var{module}, which must have been
1198 registered with gcry_cipher_register.
1199 @end deftypefun
1200
1201 @deftypefun gcry_error_t gcry_cipher_list (int *@var{list}, int *@var{list_length})
1202 Get a list consisting of the IDs of the loaded cipher modules.  If
1203 @var{list} is zero, write the number of loaded cipher modules to
1204 @var{list_length} and return.  If @var{list} is non-zero, the first
1205 *@var{list_length} algorithm IDs are stored in @var{list}, which must
1206 be of according size.  In case there are less cipher modules than
1207 *@var{list_length}, *@var{list_length} is updated to the correct
1208 number.
1209 @end deftypefun
1210
1211 @node Available cipher modes
1212 @section Available cipher modes
1213
1214 @table @code
1215 @item GCRY_CIPHER_MODE_NONE
1216 No mode specified, may be set later using other functions.  The value
1217 of this constant is always 0.
1218
1219 @item GCRY_CIPHER_MODE_ECB
1220 Electronic Codebook mode.  
1221
1222 @item GCRY_CIPHER_MODE_CFB
1223 Cipher Feedback mode.
1224
1225 @item  GCRY_CIPHER_MODE_CBC
1226 Cipher Block Chaining mode.
1227
1228 @item GCRY_CIPHER_MODE_STREAM
1229 Stream mode, only to be used with stream cipher algorithms.
1230
1231 @item GCRY_CIPHER_MODE_OFB
1232 Outer Feedback mode.
1233
1234 @item  GCRY_CIPHER_MODE_CTR
1235 Counter mode.
1236
1237 @end table
1238
1239 @node Working with cipher handles
1240 @section Working with cipher handles
1241
1242 To use a cipher algorithm, you must first allocate an according
1243 handle.  This is to be done using the open function:
1244
1245 @deftypefun gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *@var{hd},
1246 int @var{algo}, int @var{mode}, unsigned int @var{flags})
1247
1248 This function creates the context handle required for most of the
1249 other cipher functions and returns a handle to it in `hd'.  In case of
1250 an error, an according error code is returned.
1251
1252 The ID of algorithm to use must be specified via @var{algo}.  See
1253 @xref{Available ciphers}, for a list of supported ciphers and the
1254 according constants.
1255
1256 Besides using the constants directly, the function
1257 @code{gcry_cipher_map_name} may be used to convert the textual name of
1258 an algorithm into the according numeric ID.
1259
1260 The cipher mode to use must be specified via @var{mode}.  See
1261 @xref{Available cipher modes}, for a list of supported cipher modes
1262 and the according constants.  Note, that some modes do not work
1263 together with all algorithms.
1264
1265 The third argument @var{flags} can either be passed as @code{0} or as
1266 the bit-wise OR of the following constants.
1267
1268 @table @code
1269 @item GCRY_CIPHER_SECURE
1270 Make sure that all operations are allocated in secure memory.  This is
1271 useful, when the key material is highly confidential.
1272 @item GCRY_CIPHER_ENABLE_SYNC
1273 This flag enables the CFB sync mode, which is a special feature of
1274 @acronym{Libgcrypt}'s CFB mode implementation to allow for OpenPGP's CFB variant. 
1275 See @code{gcry_cipher_sync}.
1276 @item GCRY_CIPHER_CBC_CTS
1277 Enable cipher text stealing (CTS) for the CBC mode.  Cannot be used
1278 simultaneous as GCRY_CIPHER_CBC_MAC
1279 @item GCRY_CIPHER_CBC_MAC
1280 Compute CBC-MAC keyed checksums.  This is the same as CBC mode, but
1281 only output the last block.  Cannot be used simultaneous as
1282 GCRY_CIPHER_CBC_CTS.
1283 @end table
1284 @end deftypefun 
1285
1286 Use the following function to release an existing handle:
1287
1288 @deftypefun void gcry_cipher_close (gcry_cipher_hd_t @var{h})
1289
1290 This function releases the context created by @code{gcry_cipher_open}.
1291 @end deftypefun
1292
1293 In order to use a handle for performing cryptographic operations, a
1294 `key' has to be set first:
1295
1296 @deftypefun gcry_error_t gcry_cipher_setkey (gcry_cipher_hd_t @var{h}, void *@var{k}, size_t @var{l})
1297
1298 Set the key @var{k} used for encryption or decryption in the context
1299 denoted by the handle @var{h}.  The length @var{l} of the key @var{k}
1300 must match the required length of the algorithm set for this context or
1301 be in the allowed range for algorithms with variable key size.  The
1302 function checks this and returns an error if there is a problem.  A
1303 caller should always check for an error.
1304
1305 Note, this is currently implemented as a macro but may be changed to a
1306 function in the future.
1307 @end deftypefun
1308
1309 Most crypto modes requires an initialization vector (IV), which
1310 usually is a non-secret random string acting as a kind of salt value.
1311 The CTR mode requires a counter, which is also similar to a salt
1312 value.  To set the IV or CTR, use these functions:
1313
1314 @deftypefun gcry_error_t gcry_cipher_setiv (gcry_cipher_hd_t @var{h}, void *@var{k}, size_t @var{l})
1315
1316 Set the initialization vector used for encryption or decryption. The
1317 vector is passed as the buffer @var{K} of length @var{l} and copied to
1318 internal data structures.  The function checks that the IV matches the
1319 requirement of the selected algorithm and mode.  Note, that this is
1320 implemented as a macro.
1321 @end deftypefun
1322
1323 @deftypefun gcry_error_t gcry_cipher_setctr (gcry_cipher_hd_t @var{h}, void *@var{c}, size_t @var{l})
1324
1325 Set the counter vector used for encryption or decryption. The counter
1326 is passed as the buffer @var{c} of length @var{l} and copied to
1327 internal data structures.  The function checks that the counter
1328 matches the requirement of the selected algorithm (i.e., it must be
1329 the same size as the block size).  Note, that this is implemented as a
1330 macro.
1331 @end deftypefun
1332
1333 @deftypefun gcry_error_t gcry_cipher_reset (gcry_cipher_hd_t @var{h})
1334
1335 Set the given handle's context back to the state it had after the last
1336 call to gcry_cipher_setkey and clear the initialization vector.
1337
1338 Note, that gcry_cipher_reset is implemented as a macro.
1339 @end deftypefun
1340
1341 The actual encryption and decryption is done by using one of the
1342 following functions.  They may be used as often as required to process
1343 all the data.
1344
1345 @deftypefun gcry_error_t gcry_cipher_encrypt (gcry_cipher_hd_t @var{h}, unsigned char *{out}, size_t @var{outsize}, const unsigned char *@var{in}, size_t @var{inlen})
1346
1347 @code{gcry_cipher_encrypt} is used to encrypt the data.  This function
1348 can either work in place or with two buffers.  It uses the cipher
1349 context already setup and described by the handle @var{h}.  There are 2
1350 ways to use the function: If @var{in} is passed as @code{NULL} and
1351 @var{inlen} is @code{0}, in-place encryption of the data in @var{out} or
1352 length @var{outsize} takes place.  With @var{in} being not @code{NULL},
1353 @var{inlen} bytes are encrypted to the buffer @var{out} which must have
1354 at least a size of @var{inlen}.  @var{outlen} must be set to the
1355 allocated size of @var{out}, so that the function can check that there
1356 is sufficient space. Note, that overlapping buffers are not allowed.
1357
1358 Depending on the selected algorithms and encryption mode, the length of
1359 the buffers must be a multiple of the block size.
1360
1361 The function returns @code{0} on success or an error code.
1362 @end deftypefun
1363
1364
1365 @deftypefun gcry_error_t gcry_cipher_decrypt (gcry_cipher_hd_t @var{h}, unsigned char *{out}, size_t @var{outsize}, const unsigned char *@var{in}, size_t @var{inlen})
1366
1367 @code{gcry_cipher_decrypt} is used to decrypt the data.  This function
1368 can either work in place or with two buffers.  It uses the cipher
1369 context already setup and described by the handle @var{h}.  There are 2
1370 ways to use the function: If @var{in} is passed as @code{NULL} and
1371 @var{inlen} is @code{0}, in-place decryption of the data in @var{out} or
1372 length @var{outsize} takes place.  With @var{in} being not @code{NULL},
1373 @var{inlen} bytes are decrypted to the buffer @var{out} which must have
1374 at least a size of @var{inlen}.  @var{outlen} must be set to the
1375 allocated size of @var{out}, so that the function can check that there
1376 is sufficient space. Note, that overlapping buffers are not allowed.
1377
1378 Depending on the selected algorithms and encryption mode, the length of
1379 the buffers must be a multiple of the block size.
1380
1381 The function returns @code{0} on success or an error code.
1382 @end deftypefun
1383
1384
1385 OpenPGP (as defined in RFC-2440) requires a special sync operation in
1386 some places, the following function is used for this:
1387
1388 @deftypefun gcry_error_t gcry_cipher_sync (gcry_cipher_hd_t @var{h})
1389
1390 Perform the OpenPGP sync operation on context @var{h}. Note, that this
1391 is a no-op unless the context was created with the flag
1392 @code{GCRY_CIPHER_ENABLE_SYNC}
1393 @end deftypefun
1394
1395 Some of the described functions are implemented as macros utilizing a
1396 catch-all control function.  This control function is rarely used
1397 directly but there is nothing which would inhibit it:
1398
1399 @deftypefun gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t @var{h}, int @var{cmd}, void *@var{buffer}, size_t @var{buflen})
1400
1401 @code{gcry_cipher_ctl} controls various aspects of the cipher module and
1402 specific cipher contexts.  Usually some more specialized functions or
1403 macros are used for this purpose.  The semantics of the function and its
1404 parameters depends on the the command @var{cmd} and the passed context
1405 handle @var{h}.  Please see the comments in the source code
1406 (@code{src/global.c}) for details.
1407 @end deftypefun
1408
1409 @deftypefun gcry_error_t gcry_cipher_info (gcry_cipher_hd_t @var{h}, int @var{what}, void *@var{buffer}, size_t *@var{nbytes})
1410
1411 @code{gcry_cipher_info} is used to retrieve various
1412 information about a cipher context or the cipher module in general.
1413
1414 Currently no information is available.
1415 @end deftypefun
1416
1417 @node General cipher functions
1418 @section General cipher functions
1419
1420 To work with the algorithms, several functions are available to map
1421 algorithm names to the internal identifiers, as well as ways to
1422 retrieve information about an algorithm or the current cipher context.
1423
1424 @deftypefun gcry_error_t gcry_cipher_algo_info (int @var{algo}, int @var{what}, void *@var{buffer}, size_t *@var{nbytes})
1425
1426 This function is used to retrieve information on a specific algorithm.
1427 You pass the cipher algorithm ID as @var{algo} and the type of
1428 information requested as @var{what}. The result is either returned as
1429 the return code of the function or copied to the provided @var{buffer}
1430 whose allocated length must be available in an integer variable with the
1431 address passed in @var{nbytes}.  This variable will also receive the
1432 actual used length of the buffer. 
1433
1434 Here is a list of supported codes for @var{what}:
1435
1436 @c begin constants for gcry_cipher_algo_info
1437 @table @code
1438 @item GCRYCTL_GET_KEYLEN:
1439 Return the length of the key. If the algorithm supports multiple key
1440 length, the maximum supported value is returned.  The length is returned
1441 as number of octets (bytes) and not as number of bits.  @var{buffer} and
1442 @var{nbytes} must be zero.
1443
1444 @item GCRYCTL_GET_BLKLEN:
1445 Return the block length of the algorithm counted in octets.
1446 @var{buffer} and @var{nbytes} must be zero.
1447
1448 @item GCRYCTL_TEST_ALGO:
1449 Returns @code{0} when the specified algorithm is available for use.
1450 @var{buffer} and @var{nbytes} must be zero.
1451  
1452 @end table  
1453 @c end constants for gcry_cipher_algo_info
1454
1455 @end deftypefun
1456 @c end gcry_cipher_algo_info
1457
1458 @deftypefun const char *gcry_cipher_algo_name (int @var{algo})
1459
1460 @code{gcry_cipher_algo_name} returns a string with the name of the
1461 cipher algorithm @var{algo}.  If the algorithm is not known or another
1462 error occurred, an empty string is returned.  This function will never
1463 return @code{NULL}.
1464 @end deftypefun
1465
1466 @deftypefun int gcry_cipher_map_name (const char *@var{name})
1467
1468 @code{gcry_cipher_map_name} returns the algorithm identifier for the
1469 cipher algorithm described by the string @var{name}.  If this algorithm
1470 is not available @code{0} is returned.
1471 @end deftypefun
1472
1473 @deftypefun int gcry_cipher_mode_from_oid (const char *@var{string})
1474
1475 Return the cipher mode associated with an @acronym{ASN.1} object
1476 identifier.  The object identifier is expected to be in the
1477 @acronym{IETF}-style dotted decimal notation.  The function returns
1478 @code{0} for an unknown object identifier or when no mode is associated
1479 with it.
1480 @end deftypefun
1481
1482
1483 @c **********************************************************
1484 @c *******************  Hash Functions  *********************
1485 @c **********************************************************
1486 @node Hashing
1487 @chapter Hashing
1488
1489 @acronym{Libgcrypt} provides an easy and consistent to use interface
1490 for hashing.  Hashing is buffered and several hash algorithms can be
1491 updated at once.  It is possible to calculate a MAC using the same
1492 routines.  The programming model follows an open/process/close
1493 paradigm and is in that similar to other building blocks provided by
1494 @acronym{Libgcrypt}.
1495
1496 For convenience reasons, a few cyclic redudancy check value operations
1497 are also supported.
1498
1499 @menu
1500 * Available hash algorithms::           List of hash algorithms supported by the library.
1501 * Hash algorithm modules::              How to work with hash algorithm modules.
1502 * Working with hash algorithms::        List of functions related to hashing.
1503 @end menu
1504
1505 @node Available hash algorithms
1506 @section Available hash algorithms
1507
1508 @c begin table of hash algorithms
1509 @table @code
1510 @item GCRY_MD_NONE
1511 This is not a real algorithm but used by some functions as an error
1512 return value.  This constant is guaranteed to have the value @code{0}.
1513
1514 @item GCRY_MD_SHA1
1515 This is the SHA-1 algorithm which yields a message digest of 20 bytes.
1516
1517 @item GCRY_MD_RMD160
1518 This is the 160 bit version of the RIPE message digest (RIPE-MD-160).
1519 Like SHA-1 it also yields a digest of 20 bytes.
1520
1521 @item GCRY_MD_MD5
1522 This is the well known MD5 algorithm, which yields a message digest of
1523 16 bytes. 
1524
1525 @item GCRY_MD_MD4
1526 This is the MD4 algorithm, which yields a message digest of 16 bytes.
1527
1528 @item GCRY_MD_MD2
1529 This is an reserved identifier for MD-2; there is no implementation yet.
1530
1531 @item GCRY_MD_TIGER
1532 This is the TIGER/192 algorithm which yields a message digest of 24 bytes.
1533
1534 @item GCRY_MD_HAVAL
1535 This is an reserved for the HAVAL algorithm with 5 passes and 160
1536 bit. It yields a message digest of 20 bytes.  Note that there is no
1537 implementation yet available.
1538
1539 @item GCRY_MD_SHA256
1540 This is the SHA-256 algorithm which yields a message digest of 32 bytes.
1541 See FIPS 180-2 for the specification.
1542
1543 @item GCRY_MD_SHA384
1544 This is reserved for SHA-2 with 384 bits. It yields a message digest of
1545 48 bytes.  Note that there is no implementation yet available.
1546
1547 @item GCRY_MD_SHA512
1548 This is reserved for SHA-2 with 512 bits. It yields a message digest of
1549 64 bytes.  Note that there is no implementation yet available.
1550
1551 @item GCRY_MD_CRC32
1552 This is the ISO 3309 and ITU-T V.42 cyclic redundancy check.  It
1553 yields an output of 4 bytes.
1554
1555 @item GCRY_MD_CRC32_RFC1510
1556 This is the above cyclic redundancy check function, as modified by RFC
1557 1510.  It yields an output of 4 bytes.
1558
1559 @item GCRY_MD_CRC24_RFC2440
1560 This is the OpenPGP cyclic redundancy check function.  It yields an
1561 output of 3 bytes.
1562
1563 @end table
1564 @c end table of hash algorithms
1565
1566 @node Hash algorithm modules
1567 @section Hash algorithm modules
1568
1569 @acronym{Libgcrypt} makes it possible to load additional `message
1570 digest modules'; these cipher can be used just like the message digest
1571 algorithms that are built into the library directly.  For an
1572 introduction into extension modules, see @xref{Modules}.
1573
1574 @deftp {Data type} gcry_md_spec_t
1575 This is the `module specification structure' needed for registering
1576 message digest modules, which has to be filled in by the user before
1577 it can be used to register a module.  It contains the following
1578 members:
1579
1580 @table @code
1581 @item const char *name
1582 The primary name of this algorithm.
1583 @item unsigned char *asnoid
1584 Array of bytes that form the ASN OID.
1585 @item int asnlen
1586 Length of bytes in `asnoid'.
1587 @item gcry_md_oid_spec_t *oids
1588 A list of OIDs that are to be associated with the algorithm.  The
1589 list's last element must have it's `oid' member set to NULL.  See
1590 below for an explanation of this type.  See below for an explanation
1591 of this type.
1592 @item int mdlen
1593 Length of the message digest algorithm.  See below for an explanation
1594 of this type.
1595 @item gcry_md_init_t init
1596 The function responsible for initializing a handle.  See below for an
1597 explanation of this type.
1598 @item gcry_md_write_t write
1599 The function responsible for writing data into a message digest
1600 context.  See below for an explanation of this type.
1601 @item gcry_md_final_t final
1602 The function responsible for `finalizing' a message digest context.
1603 See below for an explanation of this type.
1604 @item gcry_md_read_t read
1605 The function reponsible for reading out a message digest result.  See
1606 below for an explanation of this type.
1607 @item size_t contextsize
1608 The size of the algorithm-specific `context', that should be
1609 allocated for each handle.
1610 @end table
1611 @end deftp
1612
1613 @deftp {Data type} gcry_md_oid_spec_t
1614 This type is used for associating a user-provided algorithm
1615 implementation with certain OIDs.  It contains the following members:
1616
1617 @table @code
1618 @item const char *oidstring
1619 Textual representation of the OID.
1620 @end table
1621 @end deftp
1622
1623 @deftp {Data type} gcry_md_init_t
1624 Type for the `init' function, defined as: void (*gcry_md_init_t) (void
1625 *c)
1626 @end deftp
1627
1628 @deftp {Data type} gcry_md_write_t
1629 Type for the `write' function, defined as: void (*gcry_md_write_t)
1630 (void *c, unsigned char *buf, size_t nbytes)
1631 @end deftp
1632
1633 @deftp {Data type} gcry_md_final_t
1634 Type for the `final' function, defined as: void (*gcry_md_final_t)
1635 (void *c)
1636 @end deftp
1637
1638 @deftp {Data type} gcry_md_read_t
1639 Type for the `read' function, defined as: unsigned char
1640 *(*gcry_md_read_t) (void *c)
1641 @end deftp
1642
1643 @deftypefun gcry_error_t gcry_md_register (gcry_md_spec_t *@var{digest}, unsigned int *algorithm_id, gcry_module_t *@var{module})
1644
1645 Register a new digest module whose specification can be found in
1646 @var{digest}.  On success, a new algorithm ID is stored in
1647 @var{algorithm_id} and a pointer representhing this module is stored
1648 in @var{module}.
1649 @end deftypefun
1650
1651 @deftypefun void gcry_md_unregister (gcry_module_t @var{module})
1652 Unregister the digest identified by @var{module}, which must have been
1653 registered with gcry_md_register.
1654 @end deftypefun
1655
1656 @deftypefun gcry_error_t gcry_md_list (int *@var{list}, int *@var{list_length})
1657 Get a list consisting of the IDs of the loaded message digest modules.
1658 If @var{list} is zero, write the number of loaded message digest
1659 modules to @var{list_length} and return.  If @var{list} is non-zero,
1660 the first *@var{list_length} algorithm IDs are stored in @var{list},
1661 which must be of according size.  In case there are less message
1662 digests modules than *@var{list_length}, *@var{list_length} is updated
1663 to the correct number.
1664 @end deftypefun
1665
1666 @node Working with hash algorithms
1667 @section Working with hash algorithms
1668
1669 To use most of these function it is necessary to create a context;
1670 this is done using:
1671
1672 @deftypefun gcry_error_t gcry_md_open (gcry_md_hd_t *@var{hd}, int @var{algo}, unsigned int @var{flags})
1673
1674 Create a message digest object for algorithm @var{algo}.  @var{flags}
1675 may be given as an bitwise OR of constants described below.  @var{algo}
1676 may be given as @code{0} if the algorithms to use are later set using
1677 @code{gcry_md_enable}. @var{hd} is guaranteed to either receive a valid
1678 handle or NULL.
1679
1680 For a list of supported algorithms, see @xref{Available hash
1681 algorithms}.
1682
1683 The flags allowed for @var{mode} are:
1684
1685 @c begin table of hash flags
1686 @table @code
1687 @item GCRY_MD_FLAG_SECURE
1688 Allocate all buffers and the resulting digest in "secure memory".  Use
1689 this is the hashed data is highly confidential.
1690
1691 @item GCRY_MD_FLAG_HMAC
1692 Turn the algorithm into a HMAC message authentication algorithm.  Note
1693 that the function @code{gcry_md_setkey} must be used set the MAC key.
1694 If you want CBC message authentication codes based on a cipher, see
1695 @xref{Working with cipher handles}.
1696
1697 @end table
1698 @c begin table of hash flags
1699
1700 You may use the function @code{gcry_md_is_enabled} to later check
1701 whether an algorithm has been enabled.
1702
1703 @end deftypefun
1704 @c end function gcry_md_open
1705
1706 If you want to calculate several hash algorithms at the same time, you
1707 have to use the following function right after the @code{gcry_md_open}:
1708
1709 @deftypefun gcry_error_t gcry_md_enable (gcry_md_hd_t @var{h}, int @var{algo})
1710
1711 Add the message digest algorithm @var{algo} to the digest object
1712 described by handle @var{h}.  Duplicated enabling of algorithms is
1713 detected and ignored.
1714 @end deftypefun
1715
1716 If the flag @code{GCRY_MD_FLAG_HMAC} was used, the key for the MAC must
1717 be set using the function:
1718
1719 @deftypefun gcry_error_t gcry_md_setkey (gcry_md_hd_t @var{h}, const void *@var{key},
1720 size_t @var{keylen})
1721
1722 For use with the HMAC feature, set the MAC key to the value of @var{key}
1723 of length @var{keylen}.
1724 @end deftypefun
1725
1726
1727 After you are done with the hash calculation, you should release the
1728 resources by using:
1729
1730 @deftypefun void gcry_md_close (gcry_md_hd_t @var{h})
1731
1732 Release all resources of hash context @var{h}.  @var{h} should not be
1733 used after a call to this function.  A @code{NULL} passed as @var{h} is
1734 ignored.
1735
1736 @end deftypefun
1737
1738 Often you have to do several hash operations using the same algorithm.
1739 To avoid the overhead of creating and releasing context, a reset function
1740 is provided:
1741
1742 @deftypefun void gcry_md_reset (gcry_md_hd_t @var{h})
1743
1744 Reset the current context to its initial state.  This is effectively
1745 identical to a close followed by an open and enabling all currently
1746 active algorithms.
1747 @end deftypefun
1748
1749
1750 Often it is necessary to start hashing some data and than continue to
1751 hash different data.  To avoid hashing the same data several times (which
1752 might not even be possible if the data is received from a pipe), a
1753 snapshot of the current hash context can be taken and turned into a new
1754 context:
1755
1756 @deftypefun gcry_error_t gcry_md_copy (gcry_md_hd_t *@var{handle_dst}, gcry_md_hd_t @var{handle_src})
1757
1758 Create a new digest object as an exact copy of the object described by
1759 handle @var{handle_src} and store it in @var{handle_dst}.  The context
1760 is not reset and you can continue to hash data using this context and
1761 independently using the original context.
1762 @end deftypefun
1763
1764
1765 Now that we have prepared everything to calculate hashes, its time to
1766 see how it is actually done.  There are 2  ways for this, one to
1767 update the hash with a block of memory and one macro to update the hash
1768 by just one character.  Both may be used intermixed.
1769
1770 @deftypefun void gcry_md_write (gcry_md_hd_t @var{h}, const void *@var{buffer}, size_t @var{length})
1771
1772 Pass @var{length} bytes of the data in @var{buffer} to the digest object
1773 with handle @var{h} to update the digest values. This
1774 function should be used for large blocks of data.
1775 @end deftypefun
1776
1777 @deftypefun void gcry_md_putc (gcry_md_hd_t @var{h}, int @var{c})
1778
1779 Pass the byte in @var{c} to the digest object with handle @var{h} to
1780 update the digest value.  This is an efficient function, implemented as
1781 a macro to buffer the data before an actual update. 
1782 @end deftypefun
1783
1784 The semantics of the hash functions don't allow to read out intermediate
1785 message digests because the calculation must be finalized fist.  This
1786 finalization may for example include the number of bytes hashed in the
1787 message digest.  
1788
1789 @deftypefun void gcry_md_final (gcry_md_hd_t @var{h})
1790
1791 Finalize the message digest calculation.  This is not really needed
1792 because @code{gcry_md_read} does this implicitly.  After this has been
1793 done no further updates (by means of @code{gcry_md_write} or
1794 @code{gcry_md_putc} are allowed.  Only the first call to this function
1795 has an effect. It is implemented as a macro.
1796 @end deftypefun
1797
1798 The way to read out the calculated message digest is by using the
1799 function:
1800
1801 @deftypefun unsigned char *gcry_md_read (gcry_md_hd_t @var{h}, int @var{algo})
1802
1803 @code{gcry_md_read} returns the message digest after finalizing the
1804 calculation.  This function may be used as often as required but it will
1805 always return the same value for one handle.  The returned message digest
1806 is allocated within the message context and therefore valid until the
1807 handle is released or reseted (using @code{gcry_md_close} or
1808 @code{gcry_md_reset}.  @var{algo} may be given as 0 to return the only
1809 enabled message digest or it may specify one of the enabled algorithms.
1810 The function does return @code{NULL} if the requested algorithm has not
1811 been enabled.
1812 @end deftypefun
1813
1814 Because it is often necessary to get the message digest of one block of
1815 memory, a fast convenience function is available for this task: 
1816
1817 @deftypefun void gcry_md_hash_buffer (int @var{algo}, void *@var{digest}, const cvoid *@var{buffer}, size_t @var{length});
1818
1819 @code{gcry_md_hash_buffer} is a shortcut function to calculate a message
1820 digest of a buffer.  This function does not require a context and
1821 immediately returns the message digest of the @var{length} bytes at
1822 @var{buffer}.  @var{digest} must be allocated by the caller, large
1823 enough to hold the message digest yielded by the the specified algorithm
1824 @var{algo}.  This required size may be obtained by using the function
1825 @code{gcry_md_get_algo_dlen}.
1826
1827 Note, that this function will abort the process if an unavailable
1828 algorithm is used.
1829 @end deftypefun
1830
1831 @c ***********************************
1832 @c ***** MD info functions ***********
1833 @c ***********************************
1834
1835 Hash algorithms are identified by internal algorithm numbers (see
1836 @code{gcry_md_open} for a list.  However, in most applications they are
1837 used by names, so 2 functions are available to map between string
1838 representations and hash algorithm identifiers.
1839
1840 @deftypefun const char *gcry_md_algo_name (int @var{algo})
1841
1842 Map the digest algorithm id @var{algo} to a string representation of the
1843 algorithm name.  For unknown algorithms this functions returns an
1844 empty string.  This function should not be used to test for the
1845 availability of an algorithm.
1846 @end deftypefun
1847
1848 @deftypefun int gcry_md_map_name (const char *@var{name})
1849
1850 Map the algorithm with @var{name} to a digest algorithm identifier.
1851 Returns 0 if the algorithm name is not known.  Names representing
1852 @acronym{ASN.1} object identifiers are recognized if the @acronym{IETF}
1853 dotted format is used and the OID is prefixed with either "@code{oid.}"
1854 or "@code{OID.}".  For a list of supported OIDs, see the source code at
1855 @file{cipher/md.c}. This function should not be used to test for the
1856 availability of an algorithm.
1857 @end deftypefun
1858
1859 @deftypefun gcry_error_t gcry_md_get_asnoid (int @var{algo}, void *@var{buffer}, size_t *@var{length})
1860
1861 Return an DER encoded ASN.1 OID for the algorithm @var{algo} in the
1862 user allocated @var{buffer}. @var{length} must point to variable with
1863 the available size of @var{buffer} and receives after return the
1864 actual size of the returned OID.  The returned error code may be
1865 @code{GPG_ERR_TOO_SHORT} if the provided buffer is to short to receive
1866 the OID; it is possible to call the function with @code{NULL} for
1867 @var{buffer} to have it only return the required size.  The function
1868 returns 0 on success.
1869
1870 @end deftypefun
1871
1872
1873 To test whether an algorithm is actually available for use, the
1874 following macro should be used:
1875
1876 @deftypefun gcry_error_t gcry_md_test_algo (int @var{algo}) 
1877
1878 The macro returns 0 if the algorithm @var{algo} is available for use.
1879 @end deftypefun
1880
1881 If the length of a message digest is not known, it can be retrieved
1882 using the following function:
1883
1884 @deftypefun unsigned int gcry_md_get_algo_dlen (int @var{algo})
1885
1886 Retrieve the length in bytes of the digest yielded by algorithm
1887 @var{algo}.  This is often used prior to @code{gcry_md_read} to allocate
1888 sufficient memory for the digest.
1889 @end deftypefun
1890
1891
1892 In some situations it might be hard to remember the algorithm used for
1893 the ongoing hashing. The following function might be used to get that
1894 information:
1895
1896 @deftypefun int gcry_md_get_algo (gcry_md_hd_t @var{h})
1897
1898 Retrieve the algorithm used with the handle @var{h}. Note, that this
1899 does not work reliable if more than one algorithm is enabled in @var{h}.
1900 @end deftypefun
1901
1902 The following macro might also be useful:
1903
1904 @deftypefun int gcry_md_is_secure (gcry_md_hd_t @var{h})
1905
1906 This function returns true when the digest object @var{h} is allocated
1907 in "secure memory"; i.e. @var{h} was created with the
1908 @code{GCRY_MD_FLAG_SECURE}.
1909 @end deftypefun
1910
1911 @deftypefun int gcry_md_is_enabled (gcry_md_hd_t @var{h}, int @var{algo})
1912
1913 This function returns true when the algorithm @var{algo} has been
1914 enabled for the digest object @var{h}.
1915 @end deftypefun
1916
1917
1918
1919 Tracking bugs related to hashing is often a cumbersome task which
1920 requires to add a lot of printf statements into the code.  @acronym{Libgcrypt}
1921 provides an easy way to avoid this.  The actual data hashed can be
1922 written to files on request.  The following 2 macros should be used to
1923 implement such a debugging facility:
1924
1925 @deftypefun void gcry_md_start_debug (gcry_md_hd_t @var{h}, const char *@var{suffix})
1926
1927 Enable debugging for the digest object with handle @var{h}.  This
1928 creates create files named @file{dbgmd-<n>.<string>} while doing the
1929 actual hashing.  @var{suffix} is the string part in the filename.  The
1930 number is a counter incremented for each new hashing.  The data in the
1931 file is the raw data as passed to @code{gcry_md_write} or
1932 @code{gcry_md_putc}.
1933 @end deftypefun
1934
1935
1936 @deftypefun void gcry_md_stop_debug (gcry_md_hd_t @var{h}, int @var{reserved})
1937
1938 Stop debugging on handle @var{h}.  @var{reserved} should be specified as
1939 0.  This function is usually not required because @code{gcry_md_close}
1940 does implicitly stop debugging.
1941 @end deftypefun
1942
1943
1944 @c **********************************************************
1945 @c *******************  Public Key  *************************
1946 @c **********************************************************
1947 @node Public Key cryptography (I)
1948 @chapter Public Key cryptography (I)
1949
1950 Public key cryptography, also known as asymmetric cryptography, is an
1951 easy way for key management and to provide digital signatures.
1952 @acronym{Libgcrypt} provides two completely different interfaces to
1953 public key cryptography, this chapter explains the one based on
1954 S-expressions.
1955
1956 @menu
1957 * Used S-expressions::                    Introduction into the used S-expression.
1958 * Available algorithms::                  Algorithms supported by the library.
1959 * Public key modules::                    How to work with public key modules.
1960 * Cryptographic Functions::               Functions for performing the cryptographic actions.
1961 * General public-key related Functions::  General functions, not implementing any cryptography.
1962 @end menu
1963
1964 @node Available algorithms
1965 @section Available algorithms
1966
1967 @acronym{Libgcrypt} supports the RSA (Rivest-Shamir-Adleman) algorithms as well
1968 as DSA (Digital Signature Algorithm) and ElGamal.  The versatile
1969 interface allows to add more algorithms in the future.
1970
1971 @node Used S-expressions
1972 @section Used S-expressions
1973
1974 @acronym{Libgcrypt}'s API for asymmetric cryptography is based on data
1975 structures called S-expressions (see XXXX) and does not work with
1976 contexts as most of the other building blocks of @acronym{Libgcrypt}
1977 do.
1978
1979 The following information are stored in S-expressions:
1980
1981 @table @asis
1982 @item Keys
1983
1984 @item plain text data
1985
1986 @item encrypted data
1987
1988 @item signatures
1989 ...
1990
1991 @end table
1992
1993 @noindent
1994 To describe how @acronym{Libgcrypt} expect keys, we use some examples. Note that
1995 words in
1996 @ifnottex
1997 uppercase
1998 @end ifnottex
1999 @iftex
2000 italics
2001 @end iftex
2002 indicate parameters whereas lowercase words are literals.
2003
2004 @example
2005 (private-key
2006   (dsa
2007     (p @var{p-mpi})
2008     (q @var{q-mpi})
2009     (g @var{g-mpi})
2010     (y @var{y-mpi})
2011     (x @var{x-mpi})))
2012 @end example
2013
2014 @noindent
2015 This specifies a DSA private key with the following parameters:
2016
2017 @table @var
2018 @item p-mpi
2019 DSA prime @math{p}.
2020 @item q-mpi
2021 DSA group order @math{q} (which is a prime divisor of @math{p-1}).
2022 @item g-mpi
2023 DSA group generator @math{g}.
2024 @item y-mpi
2025 DSA public key value @math{y = g^x \bmod p}.
2026 @item x-mpi
2027 DSA secret exponent x.
2028 @end table
2029
2030 All the MPI values are  expected to be in @code{GCRYMPI_FMT_USG} format.
2031 The public key is similar with "private-key" replaced by "public-key"
2032 and no @var{x-mpi}.
2033
2034 An easy way to create such an S-expressions is by using
2035 @code{gcry_sexp_build} which allows to pass a string with printf-like
2036 escapes to insert MPI values.
2037
2038 @noindent
2039 Here is an example for an RSA key:
2040
2041 @example
2042 (private-key
2043   (rsa
2044     (n @var{n-mpi})
2045     (e @var{e-mpi})
2046     (d @var{d-mpi})
2047     (p @var{p-mpi})
2048     (q @var{q-mpi})
2049     (u @var{u-mpi})
2050 @end example
2051
2052 @noindent
2053 with
2054
2055 @table @var
2056 @item n-mpi
2057 RSA public modulus @math{n}.
2058 @item e-mpi
2059 RSA public exponent @math{e}.
2060 @item d-mpi
2061 RSA secret exponent @math{d = e^{-1} \bmod (p-1)(q-1)}.
2062 @item p-mpi
2063 RSA secret prime @math{p}.
2064 @item q-mpi
2065 RSA secret prime @math{q} with @math{q > p}.
2066 @item u-mpi
2067 multiplicative inverse @math{u = p^{-1} \bmod q}.
2068 @end table
2069
2070 @node Public key modules
2071 @section Public key modules
2072
2073 @acronym{Libgcrypt} makes it possible to load additional `public key
2074 modules'; these public key algorithms can be used just like the
2075 algorithms that are built into the library directly.  For an
2076 introduction into extension modules, see @xref{Modules}.
2077
2078 @deftp {Data type} gcry_pk_spec_t
2079 This is the `module specification structure' needed for registering
2080 public key modules, which has to be filled in by the user before it
2081 can be used to register a module.  It contains the following members:
2082
2083 @table @code
2084 @item const char *name
2085 The primary name of this algorithm.
2086 @item char **aliases
2087 A list of strings that are `aliases' for the algorithm.  The list
2088 musdt be terminanted with a NULL element.
2089 @item const char *elements_pkey
2090 String containing the one-letter names of the MPI values contained in
2091 a public key.
2092 @item const char *element_skey
2093 String containing the one-letter names of the MPI values contained in
2094 a secret key.
2095 @item const char *elements_enc
2096 String containing the one-letter names of the MPI values that are the
2097 result of an encryption operation using this algorithm.
2098 @item const char *elements_sig
2099 String containing the one-letter names of the MPI values that are the
2100 result of a sign operation using this algorithm.
2101 @item const char *elements_grip
2102 String containing the one-letter names of the MPI values that are to
2103 be included in the `key grip'.
2104 @item int use
2105 The bitwise-OR of the following flags, depending on the abilities of
2106 the algortihm:
2107 @table @code
2108 @item GCRY_PK_USAGE_SIGN
2109 The algorithm supports signing and verifying of data.
2110 @item GCRY_PK_USAGE_ENCR
2111 The algorithm supports the encryption and decryption of data.
2112 @end table
2113 @item gcry_pk_generate_t generate
2114 The function responsible for generating a new key pair.  See below for
2115 a description of this type.
2116 @item gcry_pk_check_secret_key_t check_secret_key
2117 The function responsible for checking the sanity of a provided secret
2118 key.  See below for a description of this type.
2119 @item gcry_pk_encrypt_t encrypt
2120 The function responsible for encrypting data.  See below for a
2121 description of this type.
2122 @item gcry_pk_decrypt_t decrypt
2123 The function responsible for decrypting data.  See below for a
2124 description of this type.
2125 @item gcry_pk_sign_t sign
2126 The function reponsible for signing data.  See below for a description
2127 of this type.
2128 @item gcry_pk_verify_t verify
2129 The function responsible for verifying that the provided signature
2130 matches the provided data.  See below for a description of this type.
2131 @item gcry_pk_get_nbits_t get_nbits
2132 The function reponsible for returning the number of bits of a provided
2133 key.  See below for a description of this type.
2134 @end table
2135 @end deftp
2136
2137 @deftp {Data type} gcry_pk_generate_t
2138 Type for the `generate' function, defined as: gcry_err_code_t
2139 (*gcry_pk_generate_t) (int algo, unsigned int nbits, unsigned long
2140 use_e, gcry_mpi_t *skey, gcry_mpi_t **retfactors)
2141 @end deftp
2142
2143 @deftp {Data type} gcry_pk_check_secret_key_t
2144 Type for the `check_secret_key' function, defined as: gcry_err_code_t
2145 (*gcry_pk_check_secret_key_t) (int algo, gcry_mpi_t *skey)
2146 @end deftp
2147
2148 @deftp {Data type} gcry_pk_encrypt_t
2149 Type for the `encrypt' function, defined as: gcry_err_code_t
2150 (*gcry_pk_encrypt_t) (int algo, gcry_mpi_t *resarr, gcry_mpi_t data,
2151 gcry_mpi_t *pkey, int flags)
2152 @end deftp
2153
2154 @deftp {Data type} gcry_pk_decrypt_t
2155 Type for the `decrypt' function, defined as: gcry_err_code_t
2156 (*gcry_pk_decrypt_t) (int algo, gcry_mpi_t *result, gcry_mpi_t *data,
2157 gcry_mpi_t *skey, int flags)
2158 @end deftp
2159
2160 @deftp {Data type} gcry_pk_sign_t
2161 Type for the `sign' function, defined as: gcry_err_code_t
2162 (*gcry_pk_sign_t) (int algo, gcry_mpi_t *resarr, gcry_mpi_t data,
2163 gcry_mpi_t *skey)
2164 @end deftp
2165
2166 @deftp {Data type} gcry_pk_verify_t
2167 Type for the `verify' function, defined as: gcry_err_code_t
2168 (*gcry_pk_verify_t) (int algo, gcry_mpi_t hash, gcry_mpi_t *data,
2169 gcry_mpi_t *pkey, int (*cmp) (void *, gcry_mpi_t), void *opaquev)
2170 @end deftp
2171
2172 @deftp {Data type} gcry_pk_get_nbits_t
2173 Type for the `get_nbits' function, defined as: unsigned
2174 (*gcry_pk_get_nbits_t) (int algo, gcry_mpi_t *pkey)
2175 @end deftp
2176
2177 @deftypefun gcry_error_t gcry_pk_register (gcry_pk_spec_t *@var{pubkey}, unsigned int *algorithm_id, gcry_module_t *@var{module})
2178
2179 Register a new public key module whose specification can be found in
2180 @var{pubkey}.  On success, a new algorithm ID is stored in
2181 @var{algorithm_id} and a pointer representhing this module is stored
2182 in @var{module}.
2183 @end deftypefun
2184
2185 @deftypefun void gcry_pk_unregister (gcry_module_t @var{module})
2186 Unregister the public key module identified by @var{module}, which
2187 must have been registered with gcry_pk_register.
2188 @end deftypefun
2189
2190 @deftypefun gcry_error_t gcry_pk_list (int *@var{list}, int *@var{list_length})
2191 Get a list consisting of the IDs of the loaded pubkey modules.  If
2192 @var{list} is zero, write the number of loaded pubkey modules to
2193 @var{list_length} and return.  If @var{list} is non-zero, the first
2194 *@var{list_length} algorithm IDs are stored in @var{list}, which must
2195 be of according size.  In case there are less pubkey modules than
2196 *@var{list_length}, *@var{list_length} is updated to the correct
2197 number.
2198 @end deftypefun
2199
2200 @node Cryptographic Functions
2201 @section Cryptographic Functions
2202
2203 @noindent
2204 Note, that we will in future allow to use keys without p,q and u
2205 specified and may also support other parameters for performance
2206 reasons. 
2207
2208 @noindent
2209
2210 Some functions operating on S-expressions support `flags', that
2211 influence the operation.  These flags have to be listed in a
2212 sub-S-expression named `flags'; the following flags are known:
2213
2214 @table @var
2215 @item pkcs1
2216 Use PKCS#1 block type 2 padding.
2217 @item no-blinding
2218 Do not use a technique called `blinding', which is used by default in
2219 order to prevent leaking of secret information.  Blinding is only
2220 implemented by RSA, but it might be implemented by other algorithms in
2221 the future as well, when necessary.
2222 @end table
2223
2224 @noindent
2225 Now that we know the key basics, we can carry on and explain how to
2226 encrypt and decrypt data.  In almost all cases the data is a random
2227 session key which is in turn used for the actual encryption of the real
2228 data.  There are 2 functions to do this:
2229
2230 @deftypefun gcry_error_t gcry_pk_encrypt (@w{gcry_sexp_t *@var{r_ciph},} @w{gcry_sexp_t @var{data},} @w{gcry_sexp_t @var{pkey}})
2231
2232 Obviously a public key must be provided for encryption.  It is
2233 expected as an appropriate S-expression (see above) in @var{pkey}.
2234 The data to be encrypted can either be in the simple old format, which
2235 is a very simple S-expression consisting only of one MPI, or it may be
2236 a more complex S-expression which also allows to specify flags for
2237 operation, like e.g. padding rules.
2238
2239 @noindent
2240 If you don't want to let @acronym{Libgcrypt} handle the padding, you must pass an
2241 appropriate MPI using this expression for @var{data}:
2242
2243 @example 
2244 (data
2245   (flags raw)
2246   (value @var{mpi}))
2247 @end example
2248
2249 @noindent
2250 This has the same semantics as the old style MPI only way.  @var{MPI} is
2251 the actual data, already padded appropriate for your protocol.  Most
2252 systems however use PKCS#1 padding and so you can use this S-expression
2253 for @var{data}:
2254
2255 @example 
2256 (data
2257   (flags pkcs1)
2258   (value @var{block}))
2259 @end example
2260
2261 @noindent
2262 Here, the "flags" list has the "pkcs1" flag which let the function know
2263 that it should provide PKCS#1 block type 2 padding.  The actual data to
2264 be encrypted is passed as a string of octets in @var{block}.  The
2265 function checks that this data actually can be used with the given key,
2266 does the padding and encrypts it.
2267
2268 If the function could successfully perform the encryption, the return
2269 value will be 0 and a a new S-expression with the encrypted result is
2270 allocated and assign to the variable at the address of @var{r_ciph}.
2271 The caller is responsible to release this value using
2272 @code{gcry_sexp_release}.  In case of an error, an error code is
2273 returned and @var{r_ciph} will be set to @code{NULL}.
2274
2275 @noindent
2276 The returned S-expression has this format when used with RSA:
2277
2278 @example
2279 (enc-val
2280   (rsa
2281     (a @var{a-mpi})))
2282 @end example
2283
2284 @noindent
2285 Where @var{a-mpi} is an MPI with the result of the RSA operation.  When
2286 using the ElGamal algorithm, the return value will have this format:
2287
2288 @example
2289 (enc-val
2290   (elg
2291     (a @var{a-mpi})
2292     (b @var{b-mpi})))
2293 @end example
2294
2295 @noindent
2296 Where @var{a-mpi} and @var{b-mpi} are MPIs with the result of the
2297 ElGamal encryption operation.
2298 @end deftypefun
2299 @c end gcry_pk_encrypt
2300
2301 @deftypefun gcry_error_t gcry_pk_decrypt (@w{gcry_sexp_t *@var{r_plain},} @w{gcry_sexp_t @var{data},} @w{gcry_sexp_t @var{skey}})
2302
2303 Obviously a private key must be provided for decryption.  It is expected
2304 as an appropriate S-expression (see above) in @var{skey}.  The data to
2305 be decrypted must match the format of the result as returned by
2306 @code{gcry_pk_encrypt}, but should be enlarged with a @code{flags}
2307 element:
2308
2309 @example
2310 (enc-val
2311   (flags)
2312   (elg
2313     (a @var{a-mpi})
2314     (b @var{b-mpi})))
2315 @end example
2316
2317 @noindent
2318 Note, that this function currently does not know of any padding
2319 methods and the caller must do any un-padding on his own.
2320
2321 @noindent
2322 The function returns 0 on success or an error code.  The variable at the
2323 address of @var{r_plain} will be set to NULL on error or receive the
2324 decrypted value on success.  The format of @var{r_plain} is a
2325 simple S-expression part (i.e. not a valid one) with just one MPI if
2326 there was no @code{flags} element in @var{data}; if at least an empty
2327 @code{flags} is passed in @var{data}, the format is:
2328
2329 @example
2330 (value @var{plaintext})
2331 @end example
2332 @end deftypefun
2333 @c end gcry_pk_decrypt
2334
2335
2336 Another operation commonly performed using public keys are digital
2337 signature.  In some sense they are even more important than the
2338 encryption because digital signature are an important instrument for key
2339 management.  @acronym{Libgcrypt} support digital signatures using 2 functions,
2340 similar to the encryption functions:
2341
2342 @deftypefun gcry_error_t gcry_pk_sign (@w{gcry_sexp_t *@var{r_sig},} @w{gcry_sexp_t @var{data},} @w{gcry_sexp_t @var{skey}})
2343
2344 This function creates a digital signature for @var{data} using the
2345 private key @var{skey} and place it into the variable at the address of
2346 @var{r_sig}.  @var{data} may either be the simple old style S-expression
2347 with just one MPI or a modern and more versatile S-expression which
2348 allows to let @acronym{Libgcrypt} handle padding:
2349
2350 @example 
2351 (data
2352   (flags pkcs1)
2353   (hash @var{hash-algo} @var{block}))
2354 @end example
2355
2356 @noindent
2357 This example requests to sign the data in @var{block} after applying
2358 PKCS#1 block type 1 style padding.  @var{hash-algo} is a string with the
2359 hash algorithm to be encoded into the signature, this may be any hash
2360 algorithm name as supported by @acronym{Libgcrypt}.  Most likely, this will be
2361 "sha1", "rmd160" or "md5".  It is obvious that the length of @var{block}
2362 must match the size of that message digests; the function checks that
2363 this and other constraints are valid.
2364
2365 @noindent
2366 If PKCS#1 padding is not required (because the caller does already
2367 provide a padded value), either the old format or better the following
2368 format should be used:
2369
2370 @example
2371 (data
2372   (flags raw)
2373   (value @var{mpi}))
2374 @end example
2375
2376 @noindent
2377 Here, the data to be signed is directly given as an @var{MPI}.
2378
2379 @noindent
2380 The signature is returned as a newly allocated S-expression in
2381 @var{r_sig} using this format for RSA:
2382
2383 @example
2384 (sig-val
2385   (rsa
2386     (s @var{s-mpi})))
2387 @end example
2388
2389 Where @var{s-mpi} is the result of the RSA sign operation.  For DSA the
2390 S-expression returned is:
2391
2392 @example
2393 (sig-val
2394   (dsa
2395     (r @var{r-mpi})
2396     (s @var{s-mpi})))
2397 @end example
2398
2399 Where @var{r-mpi} and @var{s-mpi} are the result of the DSA sign
2400 operation.  For ElGamal signing (which is slow, yields large numbers
2401 and probably is not as secure as the other algorithms), the same format is
2402 used with "elg" replacing "dsa".
2403 @end deftypefun
2404 @c end gcry_pk_sign
2405
2406 @noindent
2407 The operation most commonly used is definitely the verification of a
2408 signature.  @acronym{Libgcrypt} provides this function:
2409
2410 @deftypefun gcry_error_t gcry_pk_verify (@w{gcry_sexp_t @var{sig}}, @w{gcry_sexp_t @var{data}}, @w{gcry_sexp_t @var{pkey}})
2411
2412 This is used to check whether the signature @var{sig} matches the
2413 @var{data}.  The public key @var{pkey} must be provided to perform this
2414 verification.  This function is similar in its parameters to
2415 @code{gcry_pk_sign} with the exceptions that the public key is used
2416 instead of the private key and that no signature is created but a
2417 signature, in a format as created by @code{gcry_pk_sign}, is passed to
2418 the function in @var{sig}.
2419
2420 @noindent
2421 The result is 0 for success (i.e. the data matches the signature), or an
2422 error code where the most relevant code is @code{GCRYERR_BAD_SIGNATURE}
2423 to indicate that the signature does not match the provided data.
2424
2425 @end deftypefun
2426 @c end gcry_pk_verify
2427
2428 @node General public-key related Functions
2429 @section General public-key related Functions
2430
2431 @noindent
2432 A couple of utility functions are available to retrieve the length of
2433 the key, map algorithm identifiers and perform sanity checks:
2434
2435 @deftypefun {const char *} gcry_pk_algo_name (int @var{algo})
2436
2437 Map the public key algorithm id @var{algo} to a string representation of
2438 the algorithm name.  For unknown algorithms this functions returns an
2439 empty string.
2440 @end deftypefun
2441
2442 @deftypefun int gcry_pk_map_name (const char *@var{name})
2443
2444 Map the algorithm @var{name} to a public key algorithm Id.  Returns 0 if
2445 the algorithm name is not known.
2446 @end deftypefun
2447
2448 @deftypefun int gcry_pk_test_algo (int @var{algo})
2449
2450 Return 0 if the public key algorithm @var{algo} is available for use.
2451 Note, that this is implemented as a macro.
2452 @end deftypefun
2453
2454
2455 @deftypefun {unsigned int} gcry_pk_get_nbits (gcry_sexp_t @var{key})
2456
2457 Return what is commonly referred as the key length for the given
2458 public or private in @var{key}.
2459 @end deftypefun
2460
2461 @deftypefun {unsigned char *} gcry_pk_get_keygrip (@w{gcry_sexp_t @var{key}}, @w{unsigned char *@var{array}})
2462
2463 Return the so called "keygrip" which is the SHA-1 hash of the public key
2464 parameters expressed in a way depended on the algorithm.  @var{array}
2465 must either provide space for 20 bytes or @code{NULL;}. In the latter
2466 case a newly allocated array of that size is returned.  On success a
2467 pointer to the newly allocated space or to @var{array} is returned.
2468 @code{NULL} is returned to indicate an error which is most likely an unknown
2469 algorithm or one where a "keygrip" has not yet been defined.
2470 The function accepts public or secret keys in @var{key}.
2471 @end deftypefun
2472
2473 @deftypefun gcry_error_t gcry_pk_testkey (gcry_sexp_t @var{key})
2474
2475 Return zero if the private key @var{key} is `sane', an error code otherwise.
2476
2477 @end deftypefun
2478
2479
2480 @deftypefun int gcry_pk_algo_info (@w{int @var{algo}}, @w{int @var{what}}, @w{void *@var{buffer}}, @w{size_t *@var{nbytes}})
2481
2482 Depending on the value of @var{what} return various information about
2483 the public key algorithm with the id @var{algo}.  Note, that the
2484 function returns @code{-1} on error and the actual error code must be
2485 retrieved using the function @code{gcry_errno}.  The currently defined
2486 values for @var{what} are:
2487
2488 @table @code
2489 @item GCRYCTL_TEST_ALGO:
2490 Return 0 when the specified algorithm is available for use.
2491 @var{buffer} must be @code{NULL}, @var{nbytes} may be passed as
2492 @code{NULL} or point to a variable with the required usage of the
2493 algorithm. This may be 0 for "don't care" or the bit-wise OR of these
2494 flags:
2495
2496 @table @code
2497 @item GCRY_PK_USAGE_SIGN 
2498 Algorithm is usable for signing.
2499 @item GCRY_PK_USAGE_ENCR 
2500 Algorithm is usable for encryption.
2501 @end table
2502
2503 @item GCRYCTL_GET_ALGO_USAGE:
2504 Return the usage flags for the given algorithm.  An invalid algorithm
2505 return 0.  Disabled algorithms are ignored here because we
2506 want to know whether the algorithm is at all capable of a certain usage.
2507
2508 @item GCRYCTL_GET_ALGO_NPKEY
2509 Return the number of elements the public key for algorithm @var{algo}
2510 consist of.  Return 0 for an unknown algorithm.
2511
2512 @item GCRYCTL_GET_ALGO_NSKEY
2513 Return the number of elements the private key for algorithm @var{algo}
2514 consist of.  Note that this value is always larger than that of the
2515 public key.  Return 0 for an unknown algorithm.
2516
2517 @item GCRYCTL_GET_ALGO_NSIGN
2518 Return the number of elements a signature created with the algorithm
2519 @var{algo} consists of.  Return 0 for an unknown algorithm or for an
2520 algorithm not capable of creating signatures.
2521
2522 @item GCRYCTL_GET_ALGO_NENC
2523 Return the number of elements a encrypted message created with the algorithm
2524 @var{algo} consists of.  Return 0 for an unknown algorithm or for an
2525 algorithm not capable of encryption.
2526 @end table
2527
2528 @noindent
2529 Please note that parameters not required should be passed as @code{NULL}.
2530 @end deftypefun
2531 @c end gcry_pk_algo_info
2532
2533
2534 @deftypefun gcry_error_t gcry_pk_ctl (@w{int @var{cmd}}, @w{void *@var{buffer}}, @w{size_t @var{buflen}})
2535
2536 This is a general purpose function to perform certain control
2537 operations.  @var{cmd} controls what is to be done. The return value is
2538 0 for success or an error code.  Currently supported values for
2539 @var{cmd} are:
2540
2541 @table @code
2542 @item GCRYCTL_DISABLE_ALGO
2543 Disable the algorithm given as an algorithm id in @var{buffer}.
2544 @var{buffer} must point to an @code{int} variable with the algorithm id
2545 and @var{buflen} must have the value @code{sizeof (int)}.
2546
2547 @end table
2548 @end deftypefun
2549 @c end gcry_pk_ctl
2550
2551 @noindent
2552 @acronym{Libgcrypt} also provides a function for generating public key
2553 pairs:
2554
2555 @deftypefun gcry_error_t gcry_pk_genkey (@w{gcry_sexp_t *@var{r_key}}, @w{gcry_sexp_t @var{parms}})
2556
2557 This function create a new public key pair using information given in
2558 the S-expression @var{parms} and stores the private and the public key
2559 in one new S-expression at the address given by @var{r_key}.  In case of
2560 an error, @var{r_key} is set to @code{NULL}.  The return code is 0 for
2561 success or an error code otherwise.
2562
2563 @noindent
2564 Here is an example for @var{parms} for creating a 1024 bit RSA key:
2565
2566 @example
2567 (genkey
2568   (rsa
2569     (nbits 4:1024)))
2570 @end example
2571
2572 @noindent
2573 To create an ElGamal key, substitute "elg" for "rsa" and to create a DSA
2574 key use "dsa".  Valid ranges for the key length depend on the
2575 algorithms; all commonly used key lengths are supported.  Currently
2576 supported parameters are:
2577
2578 @table @code
2579 @item nbits
2580 This is always required to specify the length of the key.  The argument
2581 is a string with a number in C-notation.
2582
2583 @item rsa-use-e
2584 This is only used with RSA to give a hint for the public exponent. The
2585 value will be used as a base to test for a usable exponent. Some values
2586 are special:
2587
2588 @table @samp
2589 @item 0
2590 Use a secure and fast value.  This is currently the number 41.
2591 @item 1
2592 Use a secure value as required by some specification.  This is currently
2593 the number 65537.
2594 @item 2
2595 Reserved
2596 @end table
2597
2598 @noindent
2599 If this parameter is not used, @acronym{Libgcrypt} uses for historic reasons
2600 65537.
2601
2602 @end table
2603 @c end table of parameters
2604
2605 @noindent
2606 The key pair is returned in a format depending on the
2607 algorithm. Both, private and secret, keys are returned and my be accompanied
2608 by some miscellaneous information.  The format resembles closely the one
2609 of the public respectively the private key.  Frankly, they are put into
2610 one container, so that they can easily be extracted.
2611
2612 @noindent
2613 As an example, here is what the ElGamal key generation returns:
2614
2615 @example
2616 (key-data
2617   (public-key
2618     (elg
2619       (p @var{p-mpi})
2620       (g @var{g-mpi})
2621       (y @var{y-mpi})))
2622   (private-key
2623     (elg
2624       (p @var{p-mpi})
2625       (g @var{g-mpi})
2626       (y @var{y-mpi})
2627       (x @var{x-mpi})))
2628   (misc-key-info
2629     (pm1-factors @var{n1 n2 ... nn})))
2630 @end example
2631
2632 @noindent
2633 As you can see, some of the information is duplicated, but this provides
2634 an easy way to extract either the public or the private key.  Note that
2635 the order of the elements is not defined, e.g. the private key may be
2636 stored before the public key. @var{n1 n2 ... nn} is a list of prime
2637 numbers used to composite @var{p-mpi}; this is in general not a very
2638 useful information.
2639 @end deftypefun
2640 @c end gcry_pk_genkey
2641
2642 @node Public Key cryptography (II)
2643 @chapter Public Key cryptography (II)
2644
2645 This chapter documents the alternative interface to asymmetric
2646 cryptography (ac) that is not based on S-expressions, but on native C
2647 data structures.  As opposed to the pk interface described in the
2648 former chapter, this one follows an open/use/close paradigm like other
2649 building blocks of the library.
2650
2651 @menu
2652 * Available asymmetric algorithms:: List of algorithms supported by the library.
2653 * Working with sets of data::       How to work with sets of data.
2654 * Working with handles::            How to use handles.
2655 * Working with keys::               How to work with keys.
2656 * Using cryptographic functions::   How to perform cryptographic operations.
2657 * Handle-independent functions::    General functions independent of handles.
2658 @end menu
2659
2660 @node Available asymmetric algorithms
2661 @section Available asymmetric algorithms
2662
2663 @acronym{Libgcrypt} supports the RSA (Rivest-Shamir-Adleman)
2664 algorithms as well as DSA (Digital Signature Algorithm) and ElGamal.
2665 The versatile interface allows to add more algorithms in the future.
2666
2667 @deftp {Data type} gcry_ac_id_t
2668
2669 The following constants are defined for this type:
2670
2671 @table @code
2672 @item GCRY_AC_RSA
2673 Riven-Shamir-Adleman
2674 @item GCRY_AC_DSA
2675 Digital Signature Algorithm
2676 @item GCRY_AC_ELG
2677 ElGamal
2678 @end table
2679 @end deftp
2680
2681 @node Working with sets of data
2682 @section Working with sets of data
2683
2684 In the context of this interface the term `data set' refers to a list
2685 of `named MPI values' that is used by functions performing
2686 cryptographic operations.
2687
2688 Such data sets are used for representing keys, since keys simply
2689 consist of a variable amount of numbers.  Furthermore some functions
2690 return data sets to the caller that are to be provided to other
2691 functions.
2692
2693 This section documents the data types and functions that are relevant
2694 for working with such data sets.
2695
2696 @deftp {Data type} gcry_ac_data_t
2697 A data set, that is simply a list of named MPI values.
2698 @end deftp
2699
2700 @deftypefun gcry_error_t gcry_ac_data_new (gcry_ac_data_t *@var{data})
2701 Creates a new, empty data set and stores it in @var{data}.
2702 @end deftypefun
2703
2704 @deftypefun void gcry_ac_data_destroy (gcry_ac_data_t @var{data})
2705 Destroys the data set @var{data}.
2706 @end deftypefun
2707
2708 @deftypefun gcry_error_t gcry_ac_data_set (gcry_ac_data_t @var{data},
2709 char *@var{name}, gcry_mpi_t @var{mpi})
2710 Adds the value @var{mpi} to the data set @var{data} with the label
2711 @var{name}.  If there is already a value with that label, it is replaced,
2712 otherwise a new value is added.
2713 @end deftypefun
2714
2715 @deftypefun gcry_error_t gcry_ac_data_copy (gcry_ac_data_t *@var{data_cp}, gcry_ac_data_t @var{data})
2716 Create a copy of the data set @var{data} and store it in @var{data_cp}.
2717 @end deftypefun
2718
2719 @deftypefun unsigned int gcry_ac_data_length (gcry_ac_data_t @var{data})
2720 Returns the number of named MPI values inside of the data set
2721 @var{data}.
2722 @end deftypefun
2723
2724 @deftypefun gcry_error_t gcry_ac_data_get_name (gcry_ac_data_t @var{data},
2725 char *@var{name}, gcry_mpi_t *@var{mpi})
2726
2727 Stores the value labelled with @var{name} found in data set @var{data}
2728 in @var{mpi}.  The returned MPI value will be released in case
2729 gcry_ac_data_set is used to associate the label @var{name} with a
2730 different MPI value.
2731 @end deftypefun
2732
2733 @deftypefun gcry_error_t gcry_ac_data_get_index (gcry_ac_data_t @var{data}, unsigned int @var{index}, const char **@var{name}, gcry_mpi_t *@var{mpi})
2734
2735 Stores in @var{name} and @var{mpi} the named MPI value contained in
2736 the data set @var{data} with the index @var{index}.  @var{name} or
2737 @var{mpi} may be @code{NULL}.  The returned MPI value will be released
2738 in case gcry_ac_data_set is used to associate the label @var{name}
2739 with a different MPI value.
2740 @end deftypefun
2741
2742 @deftypefun void gcry_ac_data_clear (gcry_ac_data_t @var{data})
2743 Destroys any values contained in the data set @var{data}.
2744 @end deftypefun
2745
2746 @node Working with handles
2747 @section Working with handles
2748
2749 In order to use an algorithm, an according handle must be created.
2750 This is done using the following function:
2751
2752 @deftypefun gcry_error_t gcry_ac_open (gcry_ac_handle_t *@var{handle},
2753 int @var{algorithm}, int @var{flags})
2754
2755 Creates a new handle for the algorithm @var{algorithm} and stores it
2756 in @var{handle}.  @var{flags} is not used yet.
2757
2758 @var{algorithm} must be a valid algorithm ID, see @xref{Available
2759 algorithms}, for a list of supported algorithms and the according
2760 constants.  Besides using the listed constants directly, the functions
2761 @code{gcry_ac_name_to_id} may be used to convert the textual name of
2762 an algorithm into the according numeric ID.
2763 @end deftypefun
2764
2765 @deftypefun void gcry_ac_close (gcry_ac_handle_t @var{handle})
2766 Destroys the handle @var{handle}.
2767 @end deftypefun
2768
2769 @node Working with keys
2770 @section Working with keys
2771
2772 @deftp {Data type} gcry_ac_key_id_t
2773 Defined constants:
2774
2775 @table @code
2776 @item GCRY_AC_KEY_TYPE_SECRET
2777 Specifies a secret key.
2778 @item GCRY_AC_KEY_TYPE_PUBLIC
2779 Specifies a public key.
2780 @end table
2781 @end deftp
2782
2783 @deftp {Data type} gcry_ac_key_t
2784 This type represents a single `key', either a secret one or a public
2785 one.
2786 @end deftp
2787
2788 @deftp {Data type} gcry_ac_key_pair_t
2789 This type represents a `key pair' containing a secret and a public key.
2790 @end deftp
2791
2792 Key data structures can be created in two different ways; a new key
2793 pair can be generated, resulting in ready-to-use key.  Alternatively a
2794 key can be initialized from a given data set.
2795
2796 @deftypefun gcry_error_t gcry_ac_key_init (gcry_ac_key_t *@var{key}, gcry_ac_handle_t @var{handle}, gcry_ac_key_type_t @var{type}, gcry_ac_data_t @var{data})
2797 Creates a new key of type @var{type}, consisting of the MPI values
2798 contained in the data set @var{data} and stores it in @var{key}.
2799 @end deftypefun
2800
2801 @deftypefun gcry_error_t gcry_ac_key_pair_generate (gcry_ac_handle_t @var{handle}, gcry_ac_key_pair_t *@var{key_pair}, unsigned int @var{nbits}, void *@var{key_spec})
2802
2803 Generates a new key pair via the handle @var{handle} of @var{NBITS}
2804 bits and stores it in @var{key_pair}.
2805
2806 In case non-standard settings are wanted, a pointer to a structure of
2807 type @code{gcry_ac_key_spec_<algorithm>_t}, matching the selected
2808 algorithm, can be given as KEY_SPEC.  Such a structure does only exist
2809 for RSA.  A descriptions of the members of the supported structures
2810 follows.
2811
2812 @table @code
2813 @item gcry_ac_key_spec_rsa_t
2814 @table @code
2815 @item gcry_mpi_t e
2816 Generate the key pair using a special @code{e}.  The value of @code{e}
2817 has the following meanings:
2818 @table @code
2819 @item = 0
2820 Let @acronym{Libgcrypt} device what exponent should be used.
2821 @item = 1
2822 Request the use of a ``secure'' exponent; this is required by sosme
2823 specification to be 65537.
2824 @item > 2
2825 Try starting at this value until a working exponent is found.
2826 @end table
2827 @end table
2828 @end table
2829
2830 Example code:
2831 @example
2832 @{
2833   gcry_ac_key_pair_t key_pair;
2834   gcry_ac_key_spec_rsa  rsa_spec;
2835
2836   rsa_spec.e = gcry_mpi_new (0);
2837   gcry_mpi_set_ui (rsa_spec.e, 1)
2838
2839   err = gcry_ac_open  (&handle, GCRY_AC_RSA, 0);
2840   assert (! err);
2841
2842   err = gcry_ac_key_pair_generate (handle, &key_pair, 1024, (void *) &rsa_spec);
2843   assert (! err);
2844 @}
2845 @end example
2846 @end deftypefun
2847
2848
2849 @deftypefun gcry_ac_key_t gcry_ac_key_pair_extract (gcry_ac_key_pair_t @var{key_pair}, gcry_ac_key_type_t @var{which})
2850 Returns the key of type @var{which} out of the key pair
2851 @var{key_pair}.
2852 @end deftypefun
2853
2854 @deftypefun void gcry_ac_key_destroy (gcry_ac_key_t @var{key})
2855 Destroys the key @var{key}.
2856 @end deftypefun
2857
2858 @deftypefun void gcry_ac_key_pair_destroy (gcry_ac_key_pair_t @var{key_pair})
2859 Destroys the key pair @var{key_pair}.
2860 @end deftypefun
2861
2862 @deftypefun gcry_ac_data_t gcry_ac_key_data_get (gcry_ac_key_t @var{key})
2863 Returns the data set contained in the key @var{key}.
2864 @end deftypefun
2865
2866 @deftypefun gcry_error_t gcry_ac_key_test (gcry_ac_key_t @var{key})
2867 Verifies that the private key @var{key} is sane.
2868 @end deftypefun
2869
2870 @deftypefun gcry_error_t gcry_ac_key_get_nbits (gcry_ac_key_t @var{key}, unsigned int *@var{nbits})
2871 Stores the number of bits of the key @var{key} in @var{nbits}.
2872 @end deftypefun
2873
2874 @deftypefun gcry_error_t gcry_ac_key_get_grip (gcry_ac_key_t @var{key}, unsigned char *@var{key_grip})
2875 Writes the 20 byte long key grip of the key @var{key} to
2876 @var{key_grip}.
2877 @end deftypefun
2878
2879 @node Using cryptographic functions
2880 @section Using cryptographic functions
2881
2882 @deftypefun gcry_error_t gcry_ac_data_encrypt (gcry_ac_handle_t @var{handle}, unsigned int @var{flags}, gcry_ac_key_t @var{key}, gcry_mpi_t @var{data_plain}, gcry_ac_data_t **@var{data_encrypted})
2883 Encrypts the plain text MPI value @var{data_plain} with the key public
2884 @var{key} under the control of the flags @var{flags} and stores the
2885 resulting data set into @var{data_encrypted}.
2886 @end deftypefun
2887
2888 @deftypefun gcry_error_t gcry_ac_data_decrypt (gcry_ac_handle_t @var{handle}, unsigned int @var{flags}, gcry_ac_key_t @var{key}, gcry_mpi_t *@var{data_plain}, gcry_ac_data_t @var{data_encrypted})
2889 Decrypts the encrypted data contained in the data set
2890 @var{data_encrypted} with the secret key KEY under the control of the
2891 flags @var{flags} and stores the resulting plain text MPI value in
2892 @var{DATA_PLAIN}.
2893 @end deftypefun
2894
2895 @deftypefun gcry_error_t gcry_ac_data_sign (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key}, gcry_mpi_t @var{data}, gcry_ac_data_t *@var{data_signature})
2896 Signs the data contained in @var{data} with the secret key @var{key}
2897 and stores the resulting signature in the data set
2898 @var{data_signature}.
2899 @end deftypefun
2900
2901 @deftypefun gcry_error_t gcry_ac_data_verify (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key}, gcry_mpi_t @var{data}, gcry_ac_data_t @var{data_signature})
2902 Verifies that the signature contained in the data set
2903 @var{data_signature} is indeed the result of signing the data
2904 contained in @var{data} with the secret key belonging to the public
2905 key @var{key}.
2906 @end deftypefun
2907
2908 @node Handle-independent functions
2909 @section Handle-independent functions
2910
2911 @deftypefun gcry_error_t gcry_ac_id_to_name (gcry_ac_id_t @var{algorithm}, const char **@var{name})
2912 Stores the textual representation of the algorithm whose id is given
2913 in @var{algorithm} in @var{name}.
2914 @end deftypefun
2915
2916 @deftypefun gcry_error_t gcry_ac_name_to_id (const char *@var{name}, gcry_ac_id_t *@var{algorithm})
2917 Stores the numeric ID of the algorithm whose textual representation is
2918 contained in @var{name} in @var{algorithm}.
2919 @end deftypefun
2920
2921 @c **********************************************************
2922 @c *******************  Random  *****************************
2923 @c **********************************************************
2924 @node Random Numbers
2925 @chapter Random Numbers
2926
2927 @menu
2928 * Quality of random numbers::   @acronym{Libgcrypt} uses different quality levels.
2929 * Retrieving random numbers::   How to retrieve random numbers.
2930 @end menu
2931
2932 @node Quality of random numbers
2933 @section Quality of random numbers
2934
2935 @acronym{Libgcypt} offers random numbers of different quality levels:
2936
2937 @deftp {Data type} enum gcry_random_level
2938 The constants for the random quality levels are of this type.
2939 @end deftp
2940
2941 @table @code
2942 @item GCRY_WEAK_RANDOM
2943 Use this level for random numbers that do not need to be
2944 `cryptographically strong'.
2945 @item GCRY_STRONG_RANDOM
2946 Use this level for e.g. session keys and similar purposes.
2947 @item GCRY_VERY_STRONG_RANDOM
2948 Use this level for e.g. key material.
2949 @end table
2950
2951 @node Retrieving random numbers
2952 @section Retrieving random numbers
2953
2954 @deftypefun void gcry_randomize (unsigned char *@var{buffer}, size_t @var{length}, enum gcry_random_level @var{level})
2955
2956 Fill @var{buffer} with @var{length} random bytes using a random quality
2957 as defined by @var{level}.
2958 @end deftypefun
2959
2960 @deftypefun void * gcry_random_bytes (size_t @var{nbytes}, enum gcry_random_level @var{level})
2961
2962 Allocate a memory block consisting of @var{nbytes} fresh random bytes
2963 using a random quality as defined by @var{level}.
2964 @end deftypefun
2965
2966 @deftypefun void * gcry_random_bytes_secure (size_t @var{nbytes}, enum gcry_random_level @var{level})
2967
2968 Allocate a memory block consisting of @var{nbytes} fresh random bytes
2969 using a random quality as defined by @var{level}.  This function
2970 differs from @code{gcry_random_bytes} in that the returned buffer is
2971 allocated in a ``secure'' area of the memory.
2972 @end deftypefun
2973
2974
2975 @c **********************************************************
2976 @c *******************  S-Expressions ***********************
2977 @c **********************************************************
2978 @node S-expressions
2979 @chapter S-expressions
2980
2981 S-expressions are used by the public key functions to pass complex data
2982 structures around.  These LISP like objects are used by some
2983 cryptographic protocols (cf. RFC-2692) and @acronym{Libgcrypt} provides functions
2984 to parse and construct them.  For detailed information, see
2985 @cite{Ron Rivest, code and description of S-expressions,
2986 @uref{http://theory.lcs.mit.edu/~rivest/sexp.html}}.
2987
2988 @menu
2989 * Data types for S-expressions::   Data types related with S-expressions.
2990 * Working with S-expressions::     How to work with S-expressions.
2991 @end menu
2992
2993 @node Data types for S-expressions
2994 @section Data types for S-expressions
2995
2996 @deftp {Data type} gcry_sexp_t
2997 The @code{gcry_sexp_t} type describes an object with the @acronym{Libgcrypt} internal
2998 representation of an S-expression.
2999 @end deftp
3000
3001 @node Working with S-expressions
3002 @section Working with S-expressions
3003
3004 @noindent
3005 There are several functions to create an @acronym{Libgcrypt} S-expression object
3006 from its external representation or from a string template.  There is
3007 also a function to convert the internal representation back into one of
3008 the external formats:
3009
3010
3011 @deftypefun gcry_error_t gcry_sexp_new (@w{gcry_sexp_t *@var{r_sexp}}, @w{const void *@var{buffer}}, @w{size_t @var{length}}, @w{int @var{autodetect}})
3012
3013 This is the generic function to create an new S-expression object from
3014 its external representation in @var{buffer} of @var{length} bytes.  On
3015 success the result is stored at the address given by @var{r_sexp}. 
3016 With @var{autodetect} set to 0, the data in @var{buffer} is expected to
3017 be in canonized format, with @var{autodetect} set to 1 the parses any of
3018 the defined external formats.  If @var{buffer} does not hold a valid
3019 S-expression an error code is returned and @var{r_sexp} set to
3020 @code{NULL}.
3021 Note, that the caller is responsible for releasing the newly allocated
3022 S-expression using @code{gcry_sexp_release}.
3023 @end deftypefun
3024
3025 @deftypefun gcry_error_t gcry_sexp_create (@w{gcry_sexp_t *@var{r_sexp}}, @w{void *@var{buffer}}, @w{size_t @var{length}}, @w{int @var{autodetect}}, @w{void (*@var{freefnc})(void*)})
3026
3027 This function is identical to @code{gcry_sexp_new} but has an extra
3028 argument @var{freefnc}, which, when not set to @code{NULL}, is expected
3029 to be a function to release the @var{buffer}; most likely the standard
3030 @code{free} function is used for this argument.  This has the effect of
3031 transferring the ownership of @var{buffer} to the created object in
3032 @var{r_sexp}.  The advantage of using this function is that @acronym{Libgcrypt}
3033 might decide to directly use the provided buffer and thus avoid extra
3034 copying.
3035 @end deftypefun
3036
3037 @deftypefun gcry_error_t gcry_sexp_sscan (@w{gcry_sexp_t *@var{r_sexp}}, @w{size_t *@var{erroff}}, @w{const char *@var{buffer}}, @w{size_t @var{length}})
3038
3039 This is another variant of the above functions.  It behaves nearly
3040 identical but provides an @var{erroff} argument which will receive the
3041 offset into the buffer where the parsing stopped on error.
3042 @end deftypefun
3043
3044 @deftypefun gcry_error_t gcry_sexp_build (@w{gcry_sexp_t *@var{r_sexp}}, @w{size_t *@var{erroff}}, @w{const char *@var{format}, ...})
3045
3046 This function creates an internal S-expression from the string template
3047 @var{format} and stores it at the address of @var{r_sexp}. If there is a
3048 parsing error, the function returns an appropriate error code and stores
3049 the offset into @var{format} where the parsing stopped in @var{erroff}.
3050 The function supports a couple of printf-like formatting characters and
3051 expects arguments for some of these escape sequences right after
3052 @var{format}.  The following format characters are defined:
3053
3054 @table @samp
3055 @item %m
3056 The next argument is expected to be of type @code{gcry_mpi_t} and a copy of
3057 its value is inserted into the resulting S-expression.
3058 @item %s
3059 The next argument is expected to be of type @code{char *} and that
3060 string is inserted into the resulting S-expression.
3061 @item %d
3062 The next argument is expected to be of type @code{int} and its 
3063 value ist inserted into the resulting S-expression.
3064 @end table
3065
3066 @noindent
3067 No other format characters are defined and would return an error.  Note,
3068 that the format character @samp{%%} does not exists, because a percent
3069 sign is not a valid character in an S-expression.
3070 @end deftypefun
3071
3072 @deftypefun void gcry_sexp_release (@w{gcry_sexp_t @var{sexp}})
3073
3074 Release the S-expression object @var{sexp}.
3075 @end deftypefun
3076
3077
3078 @noindent
3079 The next 2 functions are used to convert the internal representation
3080 back into a regular external S-expression format and to show the
3081 structure for debugging.
3082
3083 @deftypefun size_t gcry_sexp_sprint (@w{gcry_sexp_t @var{sexp}}, @w{int @var{mode}}, @w{char *@var{buffer}}, @w{size_t @var{maxlength}})
3084
3085 Copies the S-expression object @var{sexp} into @var{buffer} using the
3086 format specified in @var{mode}.  @var{maxlength} must be set to the
3087 allocated length of @var{buffer}.  The function returns the actual
3088 length of valid bytes put into @var{buffer} or 0 if the provided buffer
3089 is too short.  Passing @code{NULL} for @var{buffer} returns the required
3090 length for @var{buffer}.  For convenience reasons an extra byte with
3091 value 0 is appended to the buffer.
3092
3093 @noindent
3094 The following formats are supported:
3095
3096 @table @code
3097 @item GCRYSEXP_FMT_DEFAULT
3098 Returns a convenient external S-expression representation.
3099
3100 @item GCRYSEXP_FMT_CANON
3101 Return the S-expression in canonical format.
3102
3103 @item GCRYSEXP_FMT_BASE64
3104 Not currently supported.
3105
3106 @item GCRYSEXP_FMT_ADVANCED
3107 Returns the S-expression in advanced format.
3108 @end table
3109 @end deftypefun
3110
3111 @deftypefun void gcry_sexp_dump (@w{gcry_sexp_t @var{sexp}})
3112
3113 Dumps @var{sexp} in a format suitable for debugging to @acronym{Libgcrypt}'s
3114 logging stream.
3115 @end deftypefun
3116
3117 @noindent
3118 Often canonical encoding is used in the external representation.  The
3119 following function can be used to check for valid encoding and to learn
3120 the length of the S-expression"
3121
3122 @deftypefun size_t gcry_sexp_canon_len (@w{const unsigned char *@var{buffer}}, @w{size_t @var{length}}, @w{size_t *@var{erroff}}, @w{int *@var{errcode}})
3123
3124 Scan the canonical encoded @var{buffer} with implicit length values and
3125 return the actual length this S-expression uses.  For a valid S-expression
3126 it should never return 0.  If @var{length} is not 0, the maximum
3127 length to scan is given; this can be used for syntax checks of
3128 data passed from outside.  @var{errcode} and @var{erroff} may both be
3129 passed as @code{NULL}.
3130
3131 @end deftypefun
3132
3133
3134 @noindent
3135 There are a couple of functions to parse S-expressions and retrieve
3136 elements:
3137
3138 @deftypefun gcry_sexp_t gcry_sexp_find_token (@w{const gcry_sexp_t @var{list}}, @w{const char *@var{token}}, @w{size_t @var{toklen}})
3139
3140 Scan the S-expression for a sublist with a type (the car of the list)
3141 matching the string @var{token}.  If @var{toklen} is not 0, the token is
3142 assumed to be raw memory of this length.  The function returns a newly
3143 allocated S-expression consisting of the found sublist or @code{NULL}
3144 when not found.
3145 @end deftypefun
3146
3147
3148 @deftypefun int gcry_sexp_length (@w{const gcry_sexp_t @var{list}})
3149
3150 Return the length of the @var{list}.  For a valid S-expression this
3151 should be at least 1.
3152 @end deftypefun
3153
3154
3155 @deftypefun gcry_sexp_t gcry_sexp_nth (@w{const gcry_sexp_t @var{list}}, @w{int @var{number}})
3156
3157 Create and return a new S-expression from the element with index @var{number} in
3158 @var{list}.  Note that the first element has the index 0.  If there is
3159 no such element, @code{NULL} is returned.
3160 @end deftypefun
3161
3162 @deftypefun gcry_sexp_t gcry_sexp_car (@w{const gcry_sexp_t @var{list}})
3163
3164 Create and return a new S-expression from the first element in
3165 @var{list}; this called the "type" and should always exist and be a
3166 string. @code{NULL} is returned in case of a problem.
3167 @end deftypefun
3168
3169 @deftypefun gcry_sexp_t gcry_sexp_cdr (@w{const gcry_sexp_t @var{list}})
3170
3171 Create and return a new list form all elements except for the first one.
3172 Note, that this function may return an invalid S-expression because it
3173 is not guaranteed, that the type exists and is a string.  However, for
3174 parsing a complex S-expression it might be useful for intermediate
3175 lists.  Returns @code{NULL} on error.
3176 @end deftypefun
3177
3178
3179 @deftypefun {const char *} gcry_sexp_nth_data (@w{const gcry_sexp_t @var{list}}, @w{int @var{number}}, @w{size_t *@var{datalen}})
3180
3181 This function is used to get data from a @var{list}.  A pointer to the
3182 actual data with index @var{number} is returned and the length of this
3183 data will be stored to @var{datalen}.  If there is no data at the given
3184 index or the index represents another list, @code{NULL} is returned.
3185 @strong{Note:} The returned pointer is valid as long as @var{list} is
3186 not modified or released.
3187
3188 @noindent
3189 Here is an example on how to extract and print the surname (Meier) from
3190 the S-expression @samp{(Name Otto Meier (address Burgplatz 3))}:
3191
3192 @example
3193 size_t len;
3194 const char *name;
3195
3196 name = gcry_sexp_nth_data (list, 2, &len);
3197 printf ("my name is %.*s\n", (int)len, name);
3198 @end example
3199 @end deftypefun
3200
3201 @deftypefun gcry_mpi_t gcry_sexp_nth_mpi (@w{gcry_sexp_t @var{list}}, @w{int @var{number}}, @w{int @var{mpifmt}})
3202
3203 This function is used to get and convert data from a @var{list}. This
3204 data is assumed to be an MPI stored in the format described by
3205 @var{mpifmt} and returned as a standard @acronym{Libgcrypt} MPI.  The caller must
3206 release this returned value using @code{gcry_mpi_release}.  If there is
3207 no data at the given index, the index represents a list or the value
3208 can't be converted to an MPI, @code{NULL} is returned.
3209 @end deftypefun
3210
3211
3212 @c **********************************************************
3213 @c *******************  MPIs ******** ***********************
3214 @c **********************************************************
3215 @node MPI library
3216 @chapter MPI library
3217
3218 @menu
3219 * Data types::                  MPI related data types.
3220 * Basic functions::             First steps with MPI numbers.
3221 * MPI formats::                 External representation of MPIs.
3222 * Calculations::                Performing MPI calculations.
3223 * Comparisons::                 How to compare MPI values.
3224 * Bit manipulations::           How to access single bits of MPI values.
3225 * Misc::                        Misc, fixme.
3226 @end menu
3227
3228 Public key cryptography is based on mathematics with large numbers.  To
3229 implement the public key functions, a library for handling these large
3230 numbers is required.  Because of the general usefulness of such a
3231 library, its interface is exposed by @acronym{Libgcrypt}.  The implementation is
3232 based on an old release of GNU Multi-Precision Library (GMP) but in the
3233 meantime heavily modified and stripped down to what is required for
3234 cryptography. For a lot of CPUs, high performance assembler
3235 implementations of some very low level functions are used to gain much
3236 better performance than with the standard C implementation.
3237
3238 @noindent
3239 In the context of @acronym{Libgcrypt} and in most other applications, these large
3240 numbers are called MPIs (multi-precision-integers).
3241
3242 @node Data types
3243 @section Data types
3244
3245 @deftp {Data type} gcry_mpi_t
3246 The @code{gcry_mpi_t} type represents an object to hold an MPI.
3247 @end deftp
3248
3249 @node Basic functions
3250 @section Basic functions
3251
3252 @noindent
3253 To work with MPIs, storage must be allocated and released for the
3254 numbers.  This can be done with one of these functions:
3255
3256 @deftypefun gcry_mpi_t gcry_mpi_new (@w{unsigned int @var{nbits}})
3257
3258 Allocate a new MPI object, initialize it to 0 and initially allocate
3259 enough memory for a number of at least @var{nbits}.  This pre-allocation is
3260 only a small performance issue and not actually necessary because
3261 @acronym{Libgcrypt} automatically re-allocates the required memory.
3262 @end deftypefun
3263
3264 @deftypefun gcry_mpi_t gcry_mpi_snew (@w{unsigned int @var{nbits}})
3265
3266 This is identical to @code{gcry_mpi_new} but allocates the MPI in the so
3267 called "secure memory" which in turn will take care that all derived
3268 values will also be stored in this "secure memory".  Use this for highly
3269 confidential data like private key parameters.
3270 @end deftypefun
3271
3272 @deftypefun gcry_mpi_t gcry_mpi_copy (@w{const gcry_mpi_t @var{a}})
3273
3274 Create a new MPI as the exact copy of @var{a}.
3275 @end deftypefun
3276
3277
3278 @deftypefun void gcry_mpi_release (@w{gcry_mpi_t @var{a}})
3279
3280 Release the MPI @var{a} and free all associated resources.  Passing
3281 @code{NULL} is allowed and ignored.  When a MPI stored in the "secure
3282 memory" is released, that memory gets wiped out immediately.
3283 @end deftypefun
3284
3285 @noindent
3286 The simplest operations are used to assign a new value to an MPI:
3287
3288 @deftypefun gcry_mpi_t gcry_mpi_set (@w{gcry_mpi_t @var{w}}, @w{const gcry_mpi_t @var{u}})
3289
3290 Assign the value of @var{u} to @var{w} and return @var{w}.  If
3291 @code{NULL} is passed for @var{w}, a new MPI is allocated, set to the
3292 value of @var{u} and returned.
3293 @end deftypefun
3294
3295 @deftypefun gcry_mpi_t gcry_mpi_set_ui (@w{gcry_mpi_t @var{w}}, @w{unsigned long @var{u}})
3296
3297 Assign the value of @var{u} to @var{w} and return @var{w}.  If
3298 @code{NULL} is passed for @var{w}, a new MPI is allocated, set to the
3299 value of @var{u} and returned.  This function takes an @code{unsigned
3300 int} as type for @var{u} and thus it is only possible to set @var{w} to
3301 small values (usually up to the word size of the CPU).
3302 @end deftypefun
3303
3304 @deftypefun void gcry_mpi_swap (@w{gcry_mpi_t @var{a}}, @w{gcry_mpi_t @var{b}})
3305
3306 Swap the values of @var{a} and @var{b}.
3307 @end deftypefun
3308
3309 @node MPI formats
3310 @section MPI formats
3311
3312 @noindent
3313 The following functions are used to convert between an external
3314 representation of an MPI and the internal one of @acronym{Libgcrypt}.
3315
3316 @deftypefun int gcry_mpi_scan (@w{gcry_mpi_t *@var{r_mpi}}, @w{enum gcry_mpi_format @var{format}}, @w{const char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nscanned}})
3317
3318 Convert the external representation of an integer stored in @var{buffer}
3319 with a length of @var{buflen} into a newly created MPI returned which
3320 will be stored at the address of @var{r_mpi}.  For certain formats the
3321 length argument is not required and may be passed as @code{0}.  After a
3322 successful operation the variable @var{nscanned} receives the number of
3323 bytes actually scanned unless @var{nscanned} was given as
3324 @code{NULL}. @var{format} describes the format of the MPI as stored in
3325 @var{buffer}:
3326
3327 @table @code
3328 @item GCRYMPI_FMT_STD
3329 2-complement stored without a length header.
3330
3331 @item GCRYMPI_FMT_PGP
3332 As used by OpenPGP (only defined as unsigned). This is basically
3333 @code{GCRYMPI_FMT_STD} with a 2 byte big endian length header.
3334
3335 @item GCRYMPI_FMT_SSH
3336 As used in the Secure Shell protocol.  This is @code{GCRYMPI_FMT_STD}
3337 with a 4 byte big endian header.
3338
3339 @item GCRYMPI_FMT_HEX
3340 Stored as a C style string with each byte of the MPI encoded as 2 hex
3341 digits.
3342
3343 @item GCRYMPI_FMT_USG
3344 Simple unsigned integer.
3345 @end table
3346
3347 @noindent
3348 Note, that all of the above formats store the integer in big-endian
3349 format (MSB first).
3350 @end deftypefun
3351
3352
3353 @deftypefun int gcry_mpi_print (@w{enum gcry_mpi_format @var{format}}, @w{char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nwritten}}, @w{const gcry_mpi_t @var{a}})
3354
3355 Convert the MPI @var{a} into an external representation described by
3356 @var{format} (see above) and store it in the provided @var{buffer} which
3357 which has a usable length of at least the @var{buflen} bytes. If
3358 @var{nwritten} is not NULL, it wilol receive the number of bytes
3359 actually stored in @var{buffer} after a successful operation.
3360 @end deftypefun
3361
3362 @deftypefun int gcry_mpi_aprint (@w{enum gcry_mpi_format @var{format}}, @w{void **@var{buffer}}, @w{size_t *@var{nbytes}}, @w{const gcry_mpi_t @var{a}})
3363
3364 Convert the MPI @var{a} into an external representation described by
3365 @var{format} (see above) and store it in a newly allocated buffer which
3366 address will be stored in the variable @var{buffer} points to.  The
3367 number of bytes stored in this buffer will be stored in the variable
3368 @var{nbytes} points to, unless @var{nbytes} is @code{NULL}.
3369 @end deftypefun
3370
3371 @deftypefun void gcry_mpi_dump (@w{const gcry_mpi_t @var{a}})
3372
3373 Dump the value of @var{a} in a format suitable for debugging to
3374 Libgcrypt's logging stream.  Note that one leading space but no trailing
3375 space or linefeed will be printed.  It is okay to pass @code{NULL} for
3376 @var{a}.
3377 @end deftypefun
3378
3379
3380 @node Calculations
3381 @section Calculations
3382
3383 @noindent
3384 Basic arithmetic operations:
3385
3386 @deftypefun void gcry_mpi_add (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}})
3387
3388 @math{@var{w} = @var{u} + @var{v}}.
3389 @end deftypefun
3390
3391
3392 @deftypefun void gcry_mpi_add_ui (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3393
3394 @math{@var{w} = @var{u} + @var{v}}.  Note, that @var{v} is an unsigned integer.
3395 @end deftypefun
3396
3397
3398 @deftypefun void gcry_mpi_addm (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}}, @w{gcry_mpi_t @var{m}})
3399
3400 @math{var{w} = @var{u} + @var{v} \bmod @var{m}}.
3401 @end deftypefun
3402
3403 @deftypefun void gcry_mpi_sub (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}})
3404
3405 @math{@var{w} = @var{u} - @var{v}}.
3406 @end deftypefun
3407
3408 @deftypefun void gcry_mpi_sub_ui (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3409
3410 @math{@var{w} = @var{u} - @var{v}}.  @var{v} is an unsigned integer.
3411 @end deftypefun
3412
3413 @deftypefun void gcry_mpi_subm (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}}, @w{gcry_mpi_t @var{m}})
3414
3415 @math{@var{w} = @var{u} - @var{v} \bmod @var{m}}.
3416 @end deftypefun
3417
3418 @deftypefun void gcry_mpi_mul (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}})
3419
3420 @math{@var{w} = @var{u} * @var{v}}.
3421 @end deftypefun
3422
3423 @deftypefun void gcry_mpi_mul_ui (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3424
3425 @math{@var{w} = @var{u} * @var{v}}.  @var{v} is an unsigned integer.
3426 @end deftypefun
3427
3428 @deftypefun void gcry_mpi_mulm (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}}, @w{gcry_mpi_t @var{m}})
3429
3430 @math{@var{w} = @var{u} * @var{v} \bmod @var{m}}.
3431 @end deftypefun
3432
3433 @deftypefun void gcry_mpi_mul_2exp (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{e}})
3434
3435 @c FIXME: I am in need for a real TeX{info} guru:
3436 @c I don't know why TeX can grok @var{e} here.
3437 @math{@var{w} = @var{u} * 2^e}.
3438 @end deftypefun
3439
3440 @deftypefun void gcry_mpi_div (@w{gcry_mpi_t @var{q}}, @w{gcry_mpi_t @var{r}}, @w{gcry_mpi_t @var{dividend}}, @w{gcry_mpi_t @var{divisor}}, @w{int @var{round}})
3441
3442 @math{@var{q} = @var{dividend} / @var{divisor}}, @math{@var{r} =
3443 @var{dividend} \bmod @var{divisor}}.  @var{q} and @var{r} may be passed
3444 as @code{NULL}.  @var{round} should be negative or 0.
3445 @end deftypefun
3446
3447 @deftypefun void gcry_mpi_mod (@w{gcry_mpi_t @var{r}}, @w{gcry_mpi_t @var{dividend}}, @w{gcry_mpi_t @var{divisor}})
3448
3449 @math{@var{r} = @var{dividend} \bmod @var{divisor}}.
3450 @end deftypefun
3451
3452 @deftypefun void gcry_mpi_powm (@w{gcry_mpi_t @var{w}}, @w{const gcry_mpi_t @var{b}}, @w{const gcry_mpi_t @var{e}}, @w{const gcry_mpi_t @var{m}})
3453
3454 @c I don't know why TeX can grok @var{e} here.
3455 @math{@var{w} = @var{b}^e \bmod @var{m}}.
3456 @end deftypefun
3457
3458 @deftypefun int gcry_mpi_gcd (@w{gcry_mpi_t @var{g}}, @w{gcry_mpi_t @var{a}}, @w{gcry_mpi_t @var{b}})
3459
3460 Set @var{g} to the greatest common divisor of @var{a} and @var{b}.  
3461 Return true if the @var{g} is 1.
3462 @end deftypefun
3463
3464 @deftypefun int gcry_mpi_invm (@w{gcry_mpi_t @var{x}}, @w{gcry_mpi_t @var{a}}, @w{gcry_mpi_t @var{m}})
3465
3466 Set @var{x} to the multiplicative inverse of @math{@var{a} \bmod @var{m}}.
3467 Return true if the inverse exists.
3468 @end deftypefun
3469
3470
3471 @node Comparisons
3472 @section Comparisons
3473
3474 @noindent
3475 The next 2 functions are used to compare MPIs:
3476
3477
3478 @deftypefun int gcry_mpi_cmp (@w{const gcry_mpi_t @var{u}}, @w{const gcry_mpi_t @var{v}})
3479
3480 Compare the big integer number @var{u} and @var{v} returning 0 for
3481 equality, a positive value for @var{u} > @var{v} and a negative for
3482 @var{u} < @var{v}.
3483 @end deftypefun
3484
3485 @deftypefun int gcry_mpi_cmp_ui (@w{const gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3486
3487 Compare the big integer number @var{u} with the unsigned integer @var{v}
3488 returning 0 for equality, a positive value for @var{u} > @var{v} and a
3489 negative for @var{u} < @var{v}.
3490 @end deftypefun
3491
3492
3493 @node Bit manipulations
3494 @section Bit manipulations
3495
3496 @noindent
3497 There are a couple of functions to get information on arbitrary bits
3498 in an MPI and to set or clear them:
3499
3500 @deftypefun {unsigned int} gcry_mpi_get_nbits (@w{gcry_mpi_t @var{a}})
3501
3502 Return the number of bits required to represent @var{a}.
3503 @end deftypefun
3504
3505 @deftypefun int gcry_mpi_test_bit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3506
3507 Return true if bit number @var{n} (counting from 0) is set in @var{a}.
3508 @end deftypefun
3509
3510 @deftypefun void gcry_mpi_set_bit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3511
3512 Set bit number @var{n} in @var{a}.
3513 @end deftypefun
3514
3515 @deftypefun void gcry_mpi_clear_bit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3516
3517 Clear bit number @var{n} in @var{a}.
3518 @end deftypefun
3519
3520 @deftypefun void gcry_mpi_set_highbit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3521
3522 Set bit number @var{n} in @var{a} and clear all bits greater than @var{n}.
3523 @end deftypefun
3524
3525 @deftypefun void gcry_mpi_clear_highbit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3526
3527 Clear bit number @var{n} in @var{a} and all bits greater than @var{n}.
3528 @end deftypefun
3529
3530 @deftypefun void gcry_mpi_rshift (@w{gcry_mpi_t @var{x}}, @w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3531
3532 Shift the value of @var{a} by @var{n} bits to the right and store the
3533 result in @var{x}.
3534 @end deftypefun
3535
3536 @node Misc
3537 @section Misc
3538
3539 @noindent
3540 The remaining MPI functions take care of very special properties of the
3541 implementation:
3542
3543 @deftypefun gcry_mpi_t gcry_mpi_set_opaque (@w{gcry_mpi_t @var{a}}, @w{void *@var{p}}, @w{unsigned int @var{nbits}})
3544
3545 Store @var{nbits} of the value @var{p} points to in @var{a} and mark
3546 @var{a} as an opaque value (i.e. an value that can't be used for any
3547 math calculation and is only used to store an arbitrary bit pattern in
3548 @var{a}.
3549
3550 WARNING: Never use an opaque MPI for actual math operations.  The only
3551 valid functions are gcry_mpi_get_opaque and gcry_mpi_release.  Use
3552 gcry_mpi_scan to convert a string of arbitrary bytes into an MPI.
3553
3554 @end deftypefun
3555
3556 @deftypefun {void *} gcry_mpi_get_opaque (@w{gcry_mpi_t @var{a}}, @w{unsigned int *@var{nbits}})
3557
3558 Return a pointer to an opaque value stored in @var{a} and return its
3559 size in @var{nbits}.  Note, that the returned pointer is still owned by
3560 @var{a} and that the function should never be used for an non-opaque
3561 MPI.
3562 @end deftypefun
3563
3564 @deftypefun void gcry_mpi_set_flag (@w{gcry_mpi_t @var{a}}, @w{enum gcry_mpi_flag @var{flag}})
3565
3566 Set the @var{flag} for the MPI @var{a}.  Currently only the flag
3567 @code{GCRYMPI_FLAG_SECURE} is allowed to convert @var{a} into an MPI
3568 stored in "secure memory".
3569 @end deftypefun
3570
3571 @deftypefun void gcry_mpi_clear_flag (@w{gcry_mpi_t @var{a}}, @w{enum gcry_mpi_flag @var{flag}})
3572
3573 Clear @var{flag} for the big integer @var{a}.  Note, that this function is
3574 currently useless as no flags are allowed.
3575 @end deftypefun
3576
3577 @deftypefun int gcry_mpi_get_flag (@w{gcry_mpi_t @var{a}}, @w{enum gcry_mpi_flag @var{flag}})
3578
3579 Return true when the @var{flag} is set for @var{a}.
3580 @end deftypefun
3581
3582 @node Utilities
3583 @chapter Utilities
3584
3585 @menu
3586 * Memory allocation::           Functions related with memory allocation.
3587 @end menu
3588
3589 @node Memory allocation
3590 @section Memory allocation
3591
3592 @deftypefun void *gcry_malloc (size_t @var{n})
3593
3594 This function tries to allocate @var{n} bytes of memory.  On success
3595 it returns a pointer to the memory area, in an out-of-core condition,
3596 it returns NULL.
3597 @end deftypefun
3598
3599 @deftypefun void *gcry_malloc_secure (size_t @var{n})
3600 Like @code{gcry_malloc}, but uses secure memory.
3601 @end deftypefun
3602
3603 @deftypefun void *gcry_calloc (size_t @var{n})
3604
3605 This function tries to allocate @var{n} bytes of cleared memory
3606 (i.e. memory that is initialized with zero bytes).  On success it
3607 returns a pointer to the memory area, in an out-of-core condition, it
3608 returns NULL.
3609 @end deftypefun
3610
3611 @deftypefun void *gcry_calloc_secure (size_t @var{n})
3612 Like @code{gcry_calloc}, but uses secure memory.
3613 @end deftypefun
3614
3615 @deftypefun void *gcry_realloc (void *@var{p}, size_t @var{n})
3616
3617 This function tries to resize the memory area pointed to by @var{p} to
3618 @var{n} bytes.  On success it returns a pointer to the new memory
3619 area, in an out-of-core condition, it returns NULL.  Depending on
3620 wether the memory pointed to by @var{p} is secure memory or not,
3621 gcry_realloc tries to use secure memory as well.
3622 @end deftypefun
3623
3624 @deftypefun void gcry_free (void *@var{p})
3625 Release the memory area pointed to by @var{p}.
3626 @end deftypefun
3627
3628 @c **********************************************************
3629 @c *******************  Appendices  *************************
3630 @c **********************************************************
3631
3632 @include lgpl.texi
3633
3634 @include gpl.texi
3635
3636 @include fdl.texi
3637
3638 @node Concept Index
3639 @unnumbered Concept Index
3640
3641 @printindex cp
3642
3643 @node Function and Data Index
3644 @unnumbered Function and Data Index
3645
3646 @printindex fn
3647
3648 @summarycontents
3649 @contents
3650 @bye
3651
3652   /* Version check should be the very first gcry call because it
3653      makes sure that constructor functrions are run. */
3654   if (!gcry_check_version (GCRYPT_VERSION))
3655     die ("version mismatch\n");
3656   /* Many applications don't require secure memory, so they should
3657      disable it right away.  There won't be a problem unless one makes
3658      use of a feature which requires secure memoery - in that case the
3659      process would abort becuase the secmem is not initialized. */
3660   gcry_control (GCRYCTL_DISABLE_SECMEM, 0);
3661
3662   /* .. add whatever initialization you want, but better don't make calls
3663         to libgcrypt from more than one thread ... */
3664
3665   /* Tell Libgcrypt that initialization has completed. */
3666   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
3667
3668
3669 If you require secure memory, this code should be used: 
3670
3671   if (!gcry_check_version (GCRYPT_VERSION))
3672     die ("version mismatch\n");
3673   /* We don't want to see any warnings, e.g. because we have not yet
3674     parsed options which might be used to suppress such warnings */
3675   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
3676
3677   /* ... */
3678
3679   /* Allocate a pool of 16k secure memory.  This also drops priviliges
3680      on some systems. */
3681   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
3682
3683   /* It is now okay to let Libgcrypt complain when there was/is a problem
3684      with the secure memory. */
3685   gcry_control (GCRYCTL_RESUME_SECMEM_WARN);
3686
3687   /* Tell Libgcrypt that initialization has completed. */
3688   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
3689
3690
3691 This sounds a bit complicated but has the advantage that the caller
3692 must decide whether he wants secure memory or not - there is no
3693 default.
3694
3695 It is important that this initialization is not done by a library but
3696 in the application.  The library might want to check for finished
3697 initialization using:
3698
3699   if (!gcry_control (GCRYCTL_INITIALIZATION_FINISHED_P))
3700     return MYLIB_ERROR_LIBGCRYPT_NOT_INITIALIZED;
3701
3702
3703 @c  LocalWords:  int HD
3704