doc updates
[libgcrypt.git] / doc / gcrypt.texi
1 \input texinfo                  @c -*- Texinfo -*-
2 @c %**start of header
3 @setfilename gcrypt.info
4 @include version.texi
5 @settitle The Libgcrypt Reference Manual
6 @c Unify some of the indices.
7 @syncodeindex tp fn
8 @syncodeindex pg fn
9 @c %**end of header
10 @copying
11 This manual is for Libgcrypt
12 (version @value{VERSION}, @value{UPDATED}),
13 which is GNU's library of cryptographic building blocks.
14
15 Copyright @copyright{} 2000, 2002, 2003, 2004, 2006, 2007, 2008 Free Software Foundation, Inc.
16
17 @quotation
18 Permission is granted to copy, distribute and/or modify this document
19 under the terms of the GNU General Public License as published by the
20 Free Software Foundation; either version 2 of the License, or (at your
21 option) any later version. The text of the license can be found in the
22 section entitled ``GNU General Public License''.
23 @end quotation
24 @end copying
25
26 @dircategory GNU Libraries
27 @direntry
28 * libgcrypt: (gcrypt).  Cryptographic function library.
29 @end direntry
30
31
32
33 @c
34 @c Titlepage
35 @c
36 @setchapternewpage odd
37 @titlepage
38 @title The Libgcrypt Reference Manual
39 @subtitle Version @value{VERSION}
40 @subtitle @value{UPDATED}
41 @author Werner Koch (@email{wk@@gnupg.org})
42 @author Moritz Schulte (@email{mo@@g10code.com})
43
44 @page
45 @vskip 0pt plus 1filll
46 @insertcopying
47 @end titlepage
48
49 @ifnothtml
50 @summarycontents
51 @contents
52 @page
53 @end ifnothtml
54
55
56 @ifnottex
57 @node Top
58 @top The Libgcrypt Library
59 @insertcopying
60 @end ifnottex
61
62
63 @menu
64 * Introduction::                 What is Libgcrypt.
65 * Preparation::                  What you should do before using the library.
66 * Generalities::                 General library functions and data types.
67 * Handler Functions::            Working with handler functions.
68 * Symmetric cryptography::       How to use symmetric cryptography.
69 * Public Key cryptography::      How to use public key cryptography.
70 * Hashing::                      How to use hash and MAC algorithms.
71 * Random Numbers::               How to work with random numbers.
72 * S-expressions::                How to manage S-expressions.
73 * MPI library::                  How to work with multi-precision-integers.
74 * Prime numbers::                How to use the Prime number related functions.
75 * Utilities::                    Utility functions.
76 * Architecture::                 How Libgcrypt works internally.
77
78 Appendices
79
80 * Self-Tests::                  Description of the self-tests.
81 * FIPS Mode::                   Description of the FIPS mode.
82 * Library Copying::             The GNU Lesser General Public License
83                                 says how you can copy and share Libgcrypt.
84 * Copying::                     The GNU General Public License says how you
85                                 can copy and share some parts of Libgcrypt.
86
87 Indices
88
89 * Figures and Tables::          Index of figures and tables.
90 * Concept Index::               Index of concepts and programs.
91 * Function and Data Index::     Index of functions, variables and data types.
92
93 @end menu
94
95 @ifhtml
96 @page
97 @summarycontents
98 @contents
99 @end ifhtml
100
101
102 @c **********************************************************
103 @c *******************  Introduction  ***********************
104 @c **********************************************************
105 @node Introduction
106 @chapter Introduction
107
108 Libgcrypt is a library providing cryptographic building blocks.
109
110 @menu
111 * Getting Started::             How to use this manual.
112 * Features::                    A glance at Libgcrypt's features.
113 * Overview::                    Overview about the library.
114 @end menu
115
116 @node Getting Started
117 @section Getting Started
118
119 This manual documents the Libgcrypt library application programming
120 interface (API).  All functions and data types provided by the library
121 are explained.
122
123 @noindent
124 The reader is assumed to possess basic knowledge about applied
125 cryptography.
126
127 This manual can be used in several ways.  If read from the beginning
128 to the end, it gives a good introduction into the library and how it
129 can be used in an application.  Forward references are included where
130 necessary.  Later on, the manual can be used as a reference manual to
131 get just the information needed about any particular interface of the
132 library.  Experienced programmers might want to start looking at the
133 examples at the end of the manual, and then only read up those parts
134 of the interface which are unclear.
135
136
137 @node Features
138 @section Features
139
140 Libgcrypt might have a couple of advantages over other libraries doing
141 a similar job.
142
143 @table @asis
144 @item It's Free Software
145 Anybody can use, modify, and redistribute it under the terms of the GNU
146 Lesser General Public License (@pxref{Library Copying}).  Note, that
147 some parts (which are in general not needed by applications) are subject
148 to the terms of the GNU General Public License (@pxref{Copying}); please
149 see the README file of the distribution for of list of these parts.
150
151 @item It encapsulates the low level cryptography
152 Libgcrypt provides a high level interface to cryptographic
153 building blocks using an extensible and flexible API.
154
155 @end table
156
157 @node Overview
158 @section Overview
159
160 @noindent
161 The Libgcrypt library is fully thread-safe, where it makes
162 sense to be thread-safe.  Not thread-safe are some cryptographic
163 functions that modify a certain context stored in handles.  If the
164 user really intents to use such functions from different threads on
165 the same handle, he has to take care of the serialization of such
166 functions himself.  If not described otherwise, every function is
167 thread-safe.
168
169 Libgcrypt depends on the library `libgpg-error', which
170 contains common error handling related code for GnuPG components.
171
172 @c **********************************************************
173 @c *******************  Preparation  ************************
174 @c **********************************************************
175 @node Preparation
176 @chapter Preparation
177
178 To use Libgcrypt, you have to perform some changes to your
179 sources and the build system.  The necessary changes are small and
180 explained in the following sections.  At the end of this chapter, it
181 is described how the library is initialized, and how the requirements
182 of the library are verified.
183
184 @menu
185 * Header::                      What header file you need to include.
186 * Building sources::            How to build sources using the library.
187 * Building sources using Automake::  How to build sources with the help of Automake.
188 * Initializing the library::    How to initialize the library.
189 * Multi-Threading::             How Libgcrypt can be used in a MT environment.
190 * Enabling FIPS mode::          How to enable the FIPS mode.
191 @end menu
192
193
194 @node Header
195 @section Header
196
197 All interfaces (data types and functions) of the library are defined
198 in the header file @file{gcrypt.h}.  You must include this in all source
199 files using the library, either directly or through some other header
200 file, like this:
201
202 @example
203 #include <gcrypt.h>
204 @end example
205
206 The name space of Libgcrypt is @code{gcry_*} for function
207 and type names and @code{GCRY*} for other symbols.  In addition the
208 same name prefixes with one prepended underscore are reserved for
209 internal use and should never be used by an application.  Note that
210 Libgcrypt uses libgpg-error, which uses @code{gpg_*} as
211 name space for function and type names and @code{GPG_*} for other
212 symbols, including all the error codes.
213
214 @noindent
215 Certain parts of gcrypt.h may be excluded by defining these macros:
216
217 @table @code
218 @item GCRYPT_NO_MPI_MACROS
219 Do not define the shorthand macros @code{mpi_*} for @code{gcry_mpi_*}.
220
221 @item GCRYPT_NO_DEPRECATED
222 Do not include defintions for deprecated features.  This is useful to
223 make sure that no deprecated features are used.
224 @end table
225
226 @node Building sources
227 @section Building sources
228
229 If you want to compile a source file including the `gcrypt.h' header
230 file, you must make sure that the compiler can find it in the
231 directory hierarchy.  This is accomplished by adding the path to the
232 directory in which the header file is located to the compilers include
233 file search path (via the @option{-I} option).
234
235 However, the path to the include file is determined at the time the
236 source is configured.  To solve this problem, Libgcrypt ships with a small
237 helper program @command{libgcrypt-config} that knows the path to the
238 include file and other configuration options.  The options that need
239 to be added to the compiler invocation at compile time are output by
240 the @option{--cflags} option to @command{libgcrypt-config}.  The following
241 example shows how it can be used at the command line:
242
243 @example
244 gcc -c foo.c `libgcrypt-config --cflags`
245 @end example
246
247 Adding the output of @samp{libgcrypt-config --cflags} to the compilers
248 command line will ensure that the compiler can find the Libgcrypt header
249 file.
250
251 A similar problem occurs when linking the program with the library.
252 Again, the compiler has to find the library files.  For this to work,
253 the path to the library files has to be added to the library search path
254 (via the @option{-L} option).  For this, the option @option{--libs} to
255 @command{libgcrypt-config} can be used.  For convenience, this option
256 also outputs all other options that are required to link the program
257 with the Libgcrypt libraries (in particular, the @samp{-lgcrypt}
258 option).  The example shows how to link @file{foo.o} with the Libgcrypt
259 library to a program @command{foo}.
260
261 @example
262 gcc -o foo foo.o `libgcrypt-config --libs`
263 @end example
264
265 Of course you can also combine both examples to a single command by
266 specifying both options to @command{libgcrypt-config}:
267
268 @example
269 gcc -o foo foo.c `libgcrypt-config --cflags --libs`
270 @end example
271
272 @node Building sources using Automake
273 @section Building sources using Automake
274
275 It is much easier if you use GNU Automake instead of writing your own
276 Makefiles.  If you do that, you do not have to worry about finding and
277 invoking the @command{libgcrypt-config} script at all.
278 Libgcrypt provides an extension to Automake that does all
279 the work for you.
280
281 @c A simple macro for optional variables.
282 @macro ovar{varname}
283 @r{[}@var{\varname\}@r{]}
284 @end macro
285 @defmac AM_PATH_LIBGCRYPT (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
286 Check whether Libgcrypt (at least version
287 @var{minimum-version}, if given) exists on the host system.  If it is
288 found, execute @var{action-if-found}, otherwise do
289 @var{action-if-not-found}, if given.
290
291 Additionally, the function defines @code{LIBGCRYPT_CFLAGS} to the
292 flags needed for compilation of the program to find the
293 @file{gcrypt.h} header file, and @code{LIBGCRYPT_LIBS} to the linker
294 flags needed to link the program to the Libgcrypt library.
295 @end defmac
296
297 You can use the defined Autoconf variables like this in your
298 @file{Makefile.am}:
299
300 @example
301 AM_CPPFLAGS = $(LIBGCRYPT_CFLAGS)
302 LDADD = $(LIBGCRYPT_LIBS)
303 @end example
304
305 @node Initializing the library
306 @section Initializing the library
307
308 Before the library can be used, it must initialize itself.  This is
309 achieved by invoking the function @code{gcry_check_version} described
310 below.
311
312 Also, it is often desirable to check that the version of
313 Libgcrypt used is indeed one which fits all requirements.
314 Even with binary compatibility, new features may have been introduced,
315 but due to problem with the dynamic linker an old version may actually
316 be used.  So you may want to check that the version is okay right
317 after program startup.
318
319 @deftypefun {const char *} gcry_check_version (const char *@var{req_version})
320
321 The function @code{gcry_check_version} initializes some subsystems used
322 by Libgcrypt and must be invoked before any other function in the
323 library, with the exception of the @code{GCRYCTL_SET_THREAD_CBS} command
324 (called via the @code{gcry_control} function).
325 @xref{Multi-Threading}.
326
327 Furthermore, this function returns the version number of the library.
328 It can also verify that the version number is higher than a certain
329 required version number @var{req_version}, if this value is not a null
330 pointer.
331 @end deftypefun
332
333 Libgcrypt uses a concept known as secure memory, which is a region of
334 memory set aside for storing sensitive data.  Because such memory is a
335 scarce resource, it needs to be setup in advanced to a fixed size.
336 Further, most operating systems have special requirements on how that
337 secure memory can be used.  For example, it might be required to install
338 an application as ``setuid(root)'' to allow allocating such memory.
339 Libgcrypt requires a sequence of initialization steps to make sure that
340 this works correctly.  The following examples show the necessary steps.
341
342 If you don't have a need for secure memory, for example if your
343 application does not use secret keys or other confidential data or it
344 runs in a controlled environment where key material floating around in
345 memory is not a problem, you should initialize Libgcrypt this way:
346
347 @example
348   /* Version check should be the very first call because it
349      makes sure that important subsystems are intialized. */
350   if (!gcry_check_version (GCRYPT_VERSION))
351     @{
352       fputs ("libgcrypt version mismatch\n", stderr);
353       exit (2);
354     @}
355         
356   /* Disable secure memory.  */
357   gcry_control (GCRYCTL_DISABLE_SECMEM, 0);
358
359   /* ... If required, other initialization goes here.  */
360
361   /* Tell Libgcrypt that initialization has completed. */
362   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
363 @end example
364
365
366 If you have to protect your keys or other information in memory against
367 being swapped out to disk and to enable an automatic overwrite of used
368 and freed memory, you need to initialize Libgcrypt this way:
369
370 @example
371   /* Version check should be the very first call because it
372      makes sure that important subsystems are intialized. */
373   if (!gcry_check_version (GCRYPT_VERSION))
374     @{
375       fputs ("libgcrypt version mismatch\n", stderr);
376       exit (2);
377     @}
378
379 @anchor{sample-use-suspend-secmem}
380   /* We don't want to see any warnings, e.g. because we have not yet
381      parsed program options which might be used to suppress such
382      warnings. */
383   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
384
385   /* ... If required, other initialization goes here.  Note that the
386      process might still be running with increased privileges and that 
387      the secure memory has not been intialized.  */
388
389   /* Allocate a pool of 16k secure memory.  This make the secure memory
390      available and also drops privileges where needed.  */
391   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
392
393 @anchor{sample-use-resume-secmem}
394   /* It is now okay to let Libgcrypt complain when there was/is
395      a problem with the secure memory. */
396   gcry_control (GCRYCTL_RESUME_SECMEM_WARN);
397
398   /* ... If required, other initialization goes here.  */
399
400   /* Tell Libgcrypt that initialization has completed. */
401   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
402 @end example
403
404 It is important that these initialization steps are not done by a
405 library but by the actual application.  A library using Libgcrypt might
406 want to check for finished initialization using:
407
408 @example
409   if (!gcry_control (GCRYCTL_INITIALIZATION_FINISHED_P))
410     @{
411       fputs ("libgcrypt has not been initialized\n", stderr);
412       abort ();
413     @}       
414 @end example
415
416 Instead of terminating the process, the library may instead print a
417 warning and try to initialize Libgcrypt itself.  See also the section on
418 multi-threading below for more pitfalls.
419
420
421
422 @node Multi-Threading
423 @section Multi-Threading
424
425 As mentioned earlier, the Libgcrypt library is 
426 thread-safe if you adhere to the following requirements:
427
428 @itemize @bullet
429 @item
430 If your application is multi-threaded, you must set the thread support
431 callbacks with the @code{GCRYCTL_SET_THREAD_CBS} command
432 @strong{before} any other function in the library.
433
434 This is easy enough if you are indeed writing an application using
435 Libgcrypt.  It is rather problematic if you are writing a library
436 instead.  Here are some tips what to do if you are writing a library:
437
438 If your library requires a certain thread package, just initialize
439 Libgcrypt to use this thread package.  If your library supports multiple
440 thread packages, but needs to be configured, you will have to
441 implement a way to determine which thread package the application
442 wants to use with your library anyway.  Then configure Libgcrypt to use
443 this thread package.
444
445 If your library is fully reentrant without any special support by a
446 thread package, then you are lucky indeed.  Unfortunately, this does
447 not relieve you from doing either of the two above, or use a third
448 option.  The third option is to let the application initialize Libgcrypt
449 for you.  Then you are not using Libgcrypt transparently, though.
450
451 As if this was not difficult enough, a conflict may arise if two
452 libraries try to initialize Libgcrypt independently of each others, and
453 both such libraries are then linked into the same application.  To
454 make it a bit simpler for you, this will probably work, but only if
455 both libraries have the same requirement for the thread package.  This
456 is currently only supported for the non-threaded case, GNU Pth and
457 pthread.  Support for more thread packages is easy to add, so contact
458 us if you require it.
459
460 @item
461 The function @code{gcry_check_version} must be called before any other
462 function in the library, except the @code{GCRYCTL_SET_THREAD_CBS}
463 command (called via the @code{gcry_control} function), because it
464 initializes the thread support subsystem in Libgcrypt.  To
465 achieve this in multi-threaded programs, you must synchronize the
466 memory with respect to other threads that also want to use
467 Libgcrypt.  For this, it is sufficient to call
468 @code{gcry_check_version} before creating the other threads using
469 Libgcrypt@footnote{At least this is true for POSIX threads,
470 as @code{pthread_create} is a function that synchronizes memory with
471 respects to other threads.  There are many functions which have this
472 property, a complete list can be found in POSIX, IEEE Std 1003.1-2003,
473 Base Definitions, Issue 6, in the definition of the term ``Memory
474 Synchronization''.  For other thread packages, more relaxed or more
475 strict rules may apply.}.
476
477 @item
478 Just like the function @code{gpg_strerror}, the function
479 @code{gcry_strerror} is not thread safe.  You have to use
480 @code{gpg_strerror_r} instead.
481
482 @end itemize
483
484
485 Libgcrypt contains convenient macros, which define the
486 necessary thread callbacks for PThread and for GNU Pth:
487
488 @table @code
489 @item GCRY_THREAD_OPTION_PTH_IMPL
490
491 This macro defines the following (static) symbols:
492 @code{gcry_pth_init}, @code{gcry_pth_mutex_init},
493 @code{gcry_pth_mutex_destroy}, @code{gcry_pth_mutex_lock},
494 @code{gcry_pth_mutex_unlock}, @code{gcry_pth_read},
495 @code{gcry_pth_write}, @code{gcry_pth_select},
496 @code{gcry_pth_waitpid}, @code{gcry_pth_accept},
497 @code{gcry_pth_connect}, @code{gcry_threads_pth}.
498
499 After including this macro, @code{gcry_control()} shall be used with a
500 command of @code{GCRYCTL_SET_THREAD_CBS} in order to register the
501 thread callback structure named ``gcry_threads_pth''.
502
503 @item GCRY_THREAD_OPTION_PTHREAD_IMPL
504
505 This macro defines the following (static) symbols:
506 @code{gcry_pthread_mutex_init}, @code{gcry_pthread_mutex_destroy},
507 @code{gcry_pthread_mutex_lock}, @code{gcry_pthread_mutex_unlock},
508 @code{gcry_threads_pthread}.
509
510 After including this macro, @code{gcry_control()} shall be used with a
511 command of @code{GCRYCTL_SET_THREAD_CBS} in order to register the
512 thread callback structure named ``gcry_threads_pthread''.
513 @end table
514
515 Note that these macros need to be terminated with a semicolon.  Keep
516 in mind that these are convenient macros for C programmers; C++
517 programmers might have to wrap these macros in an ``extern C'' body.
518
519
520 @node Enabling FIPS mode
521 @section How to enable the FIPS mode
522 @cindex FIPS mode
523 @cindex FIPS 140
524
525 Libgcrypt may be used in a FIPS 140-2 mode.  Note, that this does not
526 necessary mean that Libcgrypt is an appoved FIPS 140-2 module.  Check the
527 NIST database at @url{http://csrc.nist.gov/groups/STM/cmvp/} to see what
528 versions of Libgcrypt are approved.
529
530 Because FIPS 140 has certain restrictions on the use of cryptography
531 which are not always wanted, Libgcrypt needs to be put into FIPS mode
532 explicitly.  Three alternative mechanisms are provided to switch
533 Libgcrypt into this mode:
534
535 @itemize
536 @item 
537 If the file @file{/proc/sys/crypto/fips_enabled} exists and contains a
538 numeric value other than @code{0}, Libgcrypt is put into FIPS mode at
539 initialization time.  Obviously this works only on systems with a
540 @code{proc} file system (i.e. GNU/Linux).
541
542 @item 
543 If the file @file{/etc/gcrypt/fips_enabled} exists, Libgcrypt is put
544 into FIPS mode at initialization time.  Note that this filename is
545 hardwired and does not depend on any configuration options.
546
547 @item 
548 If the application requests FIPS mode using the control command
549 @code{GCRYCTL_FORCE_FIPS_MODE}.  This must be done prior to any
550 initialization (i.e. before @code{gcry_check_version}).
551
552 @end itemize
553
554 @cindex Enforced FIPS mode
555
556 In addition to the standard FIPS mode, Libgcrypt may also be put into
557 an Enforced FIPS mode by writing a non-zero value into the file
558 @file{/etc/gcrypt/fips_enabled}.  The Enforced FIPS mode helps to
559 detect applications which don't fulfill all requirements for using
560 Libgcrypt in FIPS mode (@pxref{FIPS Mode}).
561
562 Once Libgcrypt has been put into FIPS mode, it is not possible to
563 switch back to standard mode without terminating the process first.
564 If the logging verbosity level of Libgcrypt has been set to at least
565 2, the state transitions and the self-tests are logged.
566
567
568
569 @c **********************************************************
570 @c *******************  General  ****************************
571 @c **********************************************************
572 @node Generalities
573 @chapter Generalities
574
575 @menu
576 * Controlling the library::     Controlling Libgcrypt's behavior.
577 * Modules::                     Description of extension modules.
578 * Error Handling::              Error codes and such.
579 @end menu
580
581 @node Controlling the library
582 @section Controlling the library
583
584 @deftypefun gcry_error_t gcry_control (enum gcry_ctl_cmds @var{cmd}, ...)
585
586 This function can be used to influence the general behavior of
587 Libgcrypt in several ways.  Depending on @var{cmd}, more
588 arguments can or have to be provided.
589
590 @table @code
591 @item GCRYCTL_ENABLE_M_GUARD; Arguments: none
592 This command enables the built-in memory guard.  It must not be used to
593 activate the memory guard after the memory management has already been
594 used; therefore it can ONLY be used at initialization time.  Note that
595 the memory guard is NOT used when the user of the library has set his
596 own memory management callbacks.
597
598 @item GCRYCTL_ENABLE_QUICK_RANDOM; Arguments: none
599 This command inhibits the use the very secure random quality level
600 (@code{GCRY_VERY_STRONG_RANDOM}) and degrades all request down to
601 @code{GCRY_STRONG_RANDOM}.  In general this is not recommened.  However,
602 for some applications the extra quality random Libgcrypt tries to create
603 is not justified and this option may help to get better performace.
604 Please check with a crypto expert whether this option can be used for
605 your application.
606
607 This option can only be used at initialization time.
608
609
610 @item GCRYCTL_DUMP_RANDOM_STATS; Arguments: none
611 This command dumps randum number generator related statistics to the
612 library's logging stream.
613
614 @item GCRYCTL_DUMP_MEMORY_STATS; Arguments: none
615 This command dumps memory managment related statistics to the library's
616 logging stream.
617
618 @item GCRYCTL_DUMP_SECMEM_STATS; Arguments: none
619 This command dumps secure memory manamgent related statistics to the
620 library's logging stream.
621
622 @item GCRYCTL_DROP_PRIVS; Arguments: none
623 This command disables the use of secure memory and drops the priviliges
624 of the current process.  This command has not much use; the suggested way
625 to disable secure memory is to use @code{GCRYCTL_DISABLE_SECMEM} right
626 after initialization.
627
628 @item GCRYCTL_DISABLE_SECMEM; Arguments: none
629 This command disables the use of secure memory.  If this command is
630 used in FIPS mode, FIPS mode will be disabled and the function
631 @code{gcry_fips_mode_active} returns false.  However, in Enforced FIPS
632 mode this command has no effect at all.
633
634 Many applications do not require secure memory, so they should disable
635 it right away.  This command should be executed right after
636 @code{gcry_check_version}. 
637
638 @item GCRYCTL_INIT_SECMEM; Arguments: int nbytes
639 This command is used to allocate a pool of secure memory and thus
640 enabling the use of secure memory.  It also drops all extra privileges
641 the process has (i.e. if it is run as setuid (root)).  If the argument
642 @var{nbytes} is 0, secure memory will be disabled.  The minimum amount
643 of secure memory allocated is currently 16384 bytes; you may thus use a
644 value of 1 to request that default size.
645
646 @item GCRYCTL_TERM_SECMEM; Arguments: none
647 This command zeroises the secure memory and destroys the handler.  The
648 secure memory pool may not be used anymore after running this command.
649 If the secure memory pool as already been destroyed, this command has
650 no effect.  Applications might want to run this command from their
651 exit handler to make sure that the secure memory gets properly
652 destroyed.  This command is not necessarily thread-safe but that
653 should not be needed in cleanup code.  It may be called from a signal
654 handler.
655
656 @item GCRYCTL_DISABLE_SECMEM_WARN; Arguments: none
657 Disable warning messages about problems with the secure memory
658 subsystem. This command should be run right after
659 @code{gcry_check_version}.
660
661 @item GCRYCTL_SUSPEND_SECMEM_WARN; Arguments: none
662 Postpone warning messages from the secure memory subsystem. 
663 @xref{sample-use-suspend-secmem,,the initialization example}, on how to
664 use it. 
665
666 @item GCRYCTL_RESUME_SECMEM_WARN; Arguments: none
667 Resume warning messages from the secure memory subsystem.
668 @xref{sample-use-resume-secmem,,the initialization example}, on how to
669 use it.
670
671 @item GCRYCTL_USE_SECURE_RNDPOOL; Arguments: none
672 This command tells the PRNG to store random numbers in secure memory.
673 This command should be run right after @code{gcry_check_version} and not
674 later than the command GCRYCTL_INIT_SECMEM.  Note that in FIPS mode the
675 secure memory is always used.
676
677 @item GCRYCTL_SET_RANDOM_SEED_FILE; Arguments: const char *filename
678 This command specifies the file, which is to be used as seed file for
679 the PRNG.  If the seed file is registered prior to initialization of the
680 PRNG, the seed file's content (if it exists and seems to be valid) is
681 fed into the PRNG pool.  After the seed file has been registered, the
682 PRNG can be signalled to write out the PRNG pool's content into the seed
683 file with the following command.
684
685
686 @item GCRYCTL_UPDATE_RANDOM_SEED_FILE; Arguments: none
687 Write out the PRNG pool's content into the registered seed file.
688
689 Multiple instances of the applications sharing the same random seed file
690 can be started in parallel, in which case they will read out the same
691 pool and then race for updating it (the last update overwrites earlier
692 updates).  They will differentiate only by the weak entropy that is
693 added in read_seed_file based on the PID and clock, and up to 16 bytes
694 of weak random non-blockingly.  The consequence is that the output of
695 these different instances is correlated to some extent.  In a perfect
696 attack scenario, the attacker can control (or at least guess) the PID
697 and clock of the application, and drain the system's entropy pool to
698 reduce the "up to 16 bytes" above to 0.  Then the dependencies of the
699 inital states of the pools are completely known.  Note that this is not
700 an issue if random of @code{GCRY_VERY_STRONG_RANDOM} quality is
701 requested as in this case enough extra entropy gets mixed.  It is also
702 not an issue when using Linux (rndlinux driver), because this one
703 guarantees to read full 16 bytes from /dev/urandom and thus there is no
704 way for an attacker without kernel access to control these 16 bytes.
705
706 @item GCRYCTL_SET_VERBOSITY; Arguments: int level
707 This command sets the verbosity of the logging.  A level of 0 disables
708 all extra logging whereas positive numbers enable more verbose logging.
709 The level may be changed at any time but be aware that no memory
710 synchronization is done so the effect of this command might not
711 immediately show up in other threads.  This command may even be used
712 prior to @code{gcry_check_version}.
713
714 @item GCRYCTL_SET_DEBUG_FLAGS; Arguments: unsigned int flags
715 Set the debug flag bits as given by the argument.  Be aware that that no
716 memory synchronization is done so the effect of this command might not
717 immediately show up in other threads.  The debug flags are not
718 considered part of the API and thus may change without notice.  As of
719 now bit 0 enables debugging of cipher functions and bit 1 debugging of
720 multi-precision-integers.  This command may even be used prior to
721 @code{gcry_check_version}.
722
723 @item GCRYCTL_CLEAR_DEBUG_FLAGS; Arguments: unsigned int flags
724 Set the debug flag bits as given by the argument.  Be aware that that no
725 memory synchronization is done so the effect of this command might not
726 immediately show up in other threads.  This command may even be used
727 prior to @code{gcry_check_version}.
728
729 @item GCRYCTL_DISABLE_INTERNAL_LOCKING; Arguments: none
730 This command does nothing.  It exists only for backward compatibility.
731
732 @item GCRYCTL_ANY_INITIALIZATION_P; Arguments: none
733 This command returns true if the library has been basically initialized.
734 Such a basic initialization happens implicitly with many commands to get
735 certain internal subsystems running.  The common and suggested way to
736 do this basic intialization is by calling gcry_check_version.
737
738 @item GCRYCTL_INITIALIZATION_FINISHED; Arguments: none
739 This command tells the libray that the application has finished the
740 intialization.
741
742 @item GCRYCTL_INITIALIZATION_FINISHED_P; Arguments: none
743 This command returns true if the command@*
744 GCRYCTL_INITIALIZATION_FINISHED has already been run.
745
746 @item GCRYCTL_SET_THREAD_CBS; Arguments: struct ath_ops *ath_ops
747 This command registers a thread-callback structure.
748 @xref{Multi-Threading}.
749
750 @item GCRYCTL_FAST_POLL; Arguments: none
751 Run a fast random poll.
752
753 @item GCRYCTL_SET_RNDEGD_SOCKET; Arguments: const char *filename
754 This command may be used to override the default name of the EGD socket
755 to connect to.  It may be used only during initialization as it is not
756 thread safe.  Changing the socket name again is not supported.  The
757 function may return an error if the given filename is too long for a
758 local socket name.
759
760 EGD is an alternative random gatherer, used only on systems lacking a
761 proper random device.
762
763 @item GCRYCTL_PRINT_CONFIG; Arguments: FILE *stream
764 This command dumps information pertaining to the configuration of the
765 library to the given stream.  If NULL is given for @var{stream}, the log
766 system is used.  This command may be used before the intialization has
767 been finished but not before a gcry_version_check.
768
769 @item GCRYCTL_OPERATIONAL_P; Arguments: none
770 This command returns true if the library is in an operational state.
771 This information makes only sense in FIPS mode.  In contrast to other
772 functions, this is a pure test function and won't put the library into
773 FIPS mode or change the internal state.  This command may be used before
774 the intialization has been finished but not before a gcry_version_check.
775
776 @item GCRYCTL_FIPS_MODE_P; Arguments: none
777 This command returns true if the library is in FIPS mode.  Note, that
778 this is no indication about the current state of the library.  This
779 command may be used before the intialization has been finished but not
780 before a gcry_version_check.  An application may use this command or
781 the convenience macro below to check whether FIPS mode is actually
782 active.
783
784 @deftypefun int gcry_fips_mode_active (void)
785
786 Returns true if the FIPS mode is active.  Note that this is
787 implemented as a macro.
788 @end deftypefun
789
790
791
792 @item GCRYCTL_FORCE_FIPS_MODE; Arguments: none
793 Running this command puts the library into FIPS mode.  If the library is
794 already in FIPS mode, a self-test is triggered and thus the library will
795 be put into operational state.  This command may be used before a call
796 to gcry_check_version and that is actually the recommended way to let an
797 application switch the library into FIPS mode.  Note that Libgcrypt will
798 reject an attempt to switch to fips mode during or after the intialization.
799
800 @item GCRYCTL_SELFTEST; Arguments: none
801 This may be used at anytime to have the library run all implemented
802 self-tests.  It works in standard and in FIPS mode.  Returns 0 on
803 success or an error code on failure.
804
805
806 @end table
807
808 @end deftypefun
809
810 @node Modules
811 @section Modules
812
813 Libgcrypt supports the use of `extension modules', which
814 implement algorithms in addition to those already built into the library
815 directly.
816
817 @deftp {Data type} gcry_module_t
818 This data type represents a `module'.
819 @end deftp
820
821 Functions registering modules provided by the user take a `module
822 specification structure' as input and return a value of
823 @code{gcry_module_t} and an ID that is unique in the modules'
824 category.  This ID can be used to reference the newly registered
825 module.  After registering a module successfully, the new functionality
826 should be able to be used through the normal functions provided by
827 Libgcrypt until it is unregistered again.
828
829 @c **********************************************************
830 @c *******************  Errors  ****************************
831 @c **********************************************************
832 @node Error Handling
833 @section Error Handling
834
835 Many functions in Libgcrypt can return an error if they
836 fail.  For this reason, the application should always catch the error
837 condition and take appropriate measures, for example by releasing the
838 resources and passing the error up to the caller, or by displaying a
839 descriptive message to the user and cancelling the operation.
840
841 Some error values do not indicate a system error or an error in the
842 operation, but the result of an operation that failed properly.  For
843 example, if you try to decrypt a tempered message, the decryption will
844 fail.  Another error value actually means that the end of a data
845 buffer or list has been reached.  The following descriptions explain
846 for many error codes what they mean usually.  Some error values have
847 specific meanings if returned by a certain functions.  Such cases are
848 described in the documentation of those functions.
849
850 Libgcrypt uses the @code{libgpg-error} library.  This allows to share
851 the error codes with other components of the GnuPG system, and to pass
852 error values transparently from the crypto engine, or some helper
853 application of the crypto engine, to the user.  This way no
854 information is lost.  As a consequence, Libgcrypt does not use its own
855 identifiers for error codes, but uses those provided by
856 @code{libgpg-error}.  They usually start with @code{GPG_ERR_}.
857
858 However, Libgcrypt does provide aliases for the functions
859 defined in libgpg-error, which might be preferred for name space
860 consistency.
861
862
863 Most functions in Libgcrypt return an error code in the case
864 of failure.  For this reason, the application should always catch the
865 error condition and take appropriate measures, for example by
866 releasing the resources and passing the error up to the caller, or by
867 displaying a descriptive message to the user and canceling the
868 operation.
869
870 Some error values do not indicate a system error or an error in the
871 operation, but the result of an operation that failed properly.
872
873 GnuPG components, including Libgcrypt, use an extra library named
874 libgpg-error to provide a common error handling scheme.  For more
875 information on libgpg-error, see the according manual.
876
877 @menu
878 * Error Values::                The error value and what it means.
879 * Error Sources::               A list of important error sources.
880 * Error Codes::                 A list of important error codes.
881 * Error Strings::               How to get a descriptive string from a value.
882 @end menu
883
884
885 @node Error Values
886 @subsection Error Values
887 @cindex error values
888 @cindex error codes
889 @cindex error sources
890
891 @deftp {Data type} {gcry_err_code_t}
892 The @code{gcry_err_code_t} type is an alias for the
893 @code{libgpg-error} type @code{gpg_err_code_t}.  The error code
894 indicates the type of an error, or the reason why an operation failed.
895
896 A list of important error codes can be found in the next section.
897 @end deftp
898
899 @deftp {Data type} {gcry_err_source_t}
900 The @code{gcry_err_source_t} type is an alias for the
901 @code{libgpg-error} type @code{gpg_err_source_t}.  The error source
902 has not a precisely defined meaning.  Sometimes it is the place where
903 the error happened, sometimes it is the place where an error was
904 encoded into an error value.  Usually the error source will give an
905 indication to where to look for the problem.  This is not always true,
906 but it is attempted to achieve this goal.
907
908 A list of important error sources can be found in the next section.
909 @end deftp
910
911 @deftp {Data type} {gcry_error_t}
912 The @code{gcry_error_t} type is an alias for the @code{libgpg-error}
913 type @code{gpg_error_t}.  An error value like this has always two
914 components, an error code and an error source.  Both together form the
915 error value.
916
917 Thus, the error value can not be directly compared against an error
918 code, but the accessor functions described below must be used.
919 However, it is guaranteed that only 0 is used to indicate success
920 (@code{GPG_ERR_NO_ERROR}), and that in this case all other parts of
921 the error value are set to 0, too.
922
923 Note that in Libgcrypt, the error source is used purely for
924 diagnostic purposes.  Only the error code should be checked to test
925 for a certain outcome of a function.  The manual only documents the
926 error code part of an error value.  The error source is left
927 unspecified and might be anything.
928 @end deftp
929
930 @deftypefun {gcry_err_code_t} gcry_err_code (@w{gcry_error_t @var{err}})
931 The static inline function @code{gcry_err_code} returns the
932 @code{gcry_err_code_t} component of the error value @var{err}.  This
933 function must be used to extract the error code from an error value in
934 order to compare it with the @code{GPG_ERR_*} error code macros.
935 @end deftypefun
936
937 @deftypefun {gcry_err_source_t} gcry_err_source (@w{gcry_error_t @var{err}})
938 The static inline function @code{gcry_err_source} returns the
939 @code{gcry_err_source_t} component of the error value @var{err}.  This
940 function must be used to extract the error source from an error value in
941 order to compare it with the @code{GPG_ERR_SOURCE_*} error source macros.
942 @end deftypefun
943
944 @deftypefun {gcry_error_t} gcry_err_make (@w{gcry_err_source_t @var{source}}, @w{gcry_err_code_t @var{code}})
945 The static inline function @code{gcry_err_make} returns the error
946 value consisting of the error source @var{source} and the error code
947 @var{code}.
948
949 This function can be used in callback functions to construct an error
950 value to return it to the library.
951 @end deftypefun
952
953 @deftypefun {gcry_error_t} gcry_error (@w{gcry_err_code_t @var{code}})
954 The static inline function @code{gcry_error} returns the error value
955 consisting of the default error source and the error code @var{code}.
956
957 For @acronym{GCRY} applications, the default error source is
958 @code{GPG_ERR_SOURCE_USER_1}.  You can define
959 @code{GCRY_ERR_SOURCE_DEFAULT} before including @file{gcrypt.h} to
960 change this default.
961
962 This function can be used in callback functions to construct an error
963 value to return it to the library.
964 @end deftypefun
965
966 The @code{libgpg-error} library provides error codes for all system
967 error numbers it knows about.  If @var{err} is an unknown error
968 number, the error code @code{GPG_ERR_UNKNOWN_ERRNO} is used.  The
969 following functions can be used to construct error values from system
970 errno numbers.
971
972 @deftypefun {gcry_error_t} gcry_err_make_from_errno (@w{gcry_err_source_t @var{source}}, @w{int @var{err}})
973 The function @code{gcry_err_make_from_errno} is like
974 @code{gcry_err_make}, but it takes a system error like @code{errno}
975 instead of a @code{gcry_err_code_t} error code.
976 @end deftypefun
977
978 @deftypefun {gcry_error_t} gcry_error_from_errno (@w{int @var{err}})
979 The function @code{gcry_error_from_errno} is like @code{gcry_error},
980 but it takes a system error like @code{errno} instead of a
981 @code{gcry_err_code_t} error code.
982 @end deftypefun
983
984 Sometimes you might want to map system error numbers to error codes
985 directly, or map an error code representing a system error back to the
986 system error number.  The following functions can be used to do that.
987
988 @deftypefun {gcry_err_code_t} gcry_err_code_from_errno (@w{int @var{err}})
989 The function @code{gcry_err_code_from_errno} returns the error code
990 for the system error @var{err}.  If @var{err} is not a known system
991 error, the function returns @code{GPG_ERR_UNKNOWN_ERRNO}.
992 @end deftypefun
993
994 @deftypefun {int} gcry_err_code_to_errno (@w{gcry_err_code_t @var{err}})
995 The function @code{gcry_err_code_to_errno} returns the system error
996 for the error code @var{err}.  If @var{err} is not an error code
997 representing a system error, or if this system error is not defined on
998 this system, the function returns @code{0}.
999 @end deftypefun
1000
1001
1002 @node Error Sources
1003 @subsection Error Sources
1004 @cindex error codes, list of
1005
1006 The library @code{libgpg-error} defines an error source for every
1007 component of the GnuPG system.  The error source part of an error
1008 value is not well defined.  As such it is mainly useful to improve the
1009 diagnostic error message for the user.
1010
1011 If the error code part of an error value is @code{0}, the whole error
1012 value will be @code{0}.  In this case the error source part is of
1013 course @code{GPG_ERR_SOURCE_UNKNOWN}.
1014
1015 The list of error sources that might occur in applications using
1016 @acronym{Libgcrypt} is:
1017
1018 @table @code
1019 @item GPG_ERR_SOURCE_UNKNOWN
1020 The error source is not known.  The value of this error source is
1021 @code{0}.
1022
1023 @item GPG_ERR_SOURCE_GPGME
1024 The error source is @acronym{GPGME} itself.
1025
1026 @item GPG_ERR_SOURCE_GPG
1027 The error source is GnuPG, which is the crypto engine used for the
1028 OpenPGP protocol.
1029
1030 @item GPG_ERR_SOURCE_GPGSM
1031 The error source is GPGSM, which is the crypto engine used for the
1032 OpenPGP protocol.
1033
1034 @item GPG_ERR_SOURCE_GCRYPT
1035 The error source is @code{libgcrypt}, which is used by crypto engines
1036 to perform cryptographic operations.
1037
1038 @item GPG_ERR_SOURCE_GPGAGENT
1039 The error source is @command{gpg-agent}, which is used by crypto
1040 engines to perform operations with the secret key.
1041
1042 @item GPG_ERR_SOURCE_PINENTRY
1043 The error source is @command{pinentry}, which is used by
1044 @command{gpg-agent} to query the passphrase to unlock a secret key.
1045
1046 @item GPG_ERR_SOURCE_SCD
1047 The error source is the SmartCard Daemon, which is used by
1048 @command{gpg-agent} to delegate operations with the secret key to a
1049 SmartCard.
1050
1051 @item GPG_ERR_SOURCE_KEYBOX
1052 The error source is @code{libkbx}, a library used by the crypto
1053 engines to manage local keyrings.
1054
1055 @item GPG_ERR_SOURCE_USER_1
1056 @item GPG_ERR_SOURCE_USER_2
1057 @item GPG_ERR_SOURCE_USER_3
1058 @item GPG_ERR_SOURCE_USER_4
1059 These error sources are not used by any GnuPG component and can be
1060 used by other software.  For example, applications using
1061 Libgcrypt can use them to mark error values coming from callback
1062 handlers.  Thus @code{GPG_ERR_SOURCE_USER_1} is the default for errors
1063 created with @code{gcry_error} and @code{gcry_error_from_errno},
1064 unless you define @code{GCRY_ERR_SOURCE_DEFAULT} before including
1065 @file{gcrypt.h}.
1066 @end table
1067
1068
1069 @node Error Codes
1070 @subsection Error Codes
1071 @cindex error codes, list of
1072
1073 The library @code{libgpg-error} defines many error values.  The
1074 following list includes the most important error codes.
1075
1076 @table @code
1077 @item GPG_ERR_EOF
1078 This value indicates the end of a list, buffer or file.
1079
1080 @item GPG_ERR_NO_ERROR
1081 This value indicates success.  The value of this error code is
1082 @code{0}.  Also, it is guaranteed that an error value made from the
1083 error code @code{0} will be @code{0} itself (as a whole).  This means
1084 that the error source information is lost for this error code,
1085 however, as this error code indicates that no error occurred, this is
1086 generally not a problem.
1087
1088 @item GPG_ERR_GENERAL
1089 This value means that something went wrong, but either there is not
1090 enough information about the problem to return a more useful error
1091 value, or there is no separate error value for this type of problem.
1092
1093 @item GPG_ERR_ENOMEM
1094 This value means that an out-of-memory condition occurred.
1095
1096 @item GPG_ERR_E...
1097 System errors are mapped to GPG_ERR_EFOO where FOO is the symbol for
1098 the system error.
1099
1100 @item GPG_ERR_INV_VALUE
1101 This value means that some user provided data was out of range.
1102
1103 @item GPG_ERR_UNUSABLE_PUBKEY
1104 This value means that some recipients for a message were invalid.
1105
1106 @item GPG_ERR_UNUSABLE_SECKEY
1107 This value means that some signers were invalid.
1108
1109 @item GPG_ERR_NO_DATA
1110 This value means that data was expected where no data was found.
1111
1112 @item GPG_ERR_CONFLICT
1113 This value means that a conflict of some sort occurred.
1114
1115 @item GPG_ERR_NOT_IMPLEMENTED
1116 This value indicates that the specific function (or operation) is not
1117 implemented.  This error should never happen.  It can only occur if
1118 you use certain values or configuration options which do not work,
1119 but for which we think that they should work at some later time.
1120
1121 @item GPG_ERR_DECRYPT_FAILED
1122 This value indicates that a decryption operation was unsuccessful.
1123
1124 @item GPG_ERR_WRONG_KEY_USAGE
1125 This value indicates that a key is not used appropriately.
1126
1127 @item GPG_ERR_NO_SECKEY
1128 This value indicates that no secret key for the user ID is available.
1129
1130 @item GPG_ERR_UNSUPPORTED_ALGORITHM
1131 This value means a verification failed because the cryptographic
1132 algorithm is not supported by the crypto backend.
1133
1134 @item GPG_ERR_BAD_SIGNATURE
1135 This value means a verification failed because the signature is bad.
1136
1137 @item GPG_ERR_NO_PUBKEY
1138 This value means a verification failed because the public key is not
1139 available.
1140
1141 @item GPG_ERR_NOT_OPERATIONAL
1142 This value means that the library is not yet in state which allows to
1143 use this function.  This error code is in particular returned if
1144 Libgcrypt is operated in FIPS mode and the internal state of the
1145 library does not yet or not anymore allow the use of a service.
1146
1147 This error code is only available with newer libgpg-error versions, thus
1148 you might see ``invalid error code'' when passing this to
1149 @code{gpg_strerror}.  The numeric value of this error code is 176.
1150
1151 @item GPG_ERR_USER_1
1152 @item GPG_ERR_USER_2
1153 @item ...
1154 @item GPG_ERR_USER_16
1155 These error codes are not used by any GnuPG component and can be
1156 freely used by other software.  Applications using Libgcrypt
1157 might use them to mark specific errors returned by callback handlers
1158 if no suitable error codes (including the system errors) for these
1159 errors exist already.
1160 @end table
1161
1162
1163 @node Error Strings
1164 @subsection Error Strings
1165 @cindex error values, printing of
1166 @cindex error codes, printing of
1167 @cindex error sources, printing of
1168 @cindex error strings
1169
1170 @deftypefun {const char *} gcry_strerror (@w{gcry_error_t @var{err}})
1171 The function @code{gcry_strerror} returns a pointer to a statically
1172 allocated string containing a description of the error code contained
1173 in the error value @var{err}.  This string can be used to output a
1174 diagnostic message to the user.
1175 @end deftypefun
1176
1177
1178 @deftypefun {const char *} gcry_strsource (@w{gcry_error_t @var{err}})
1179 The function @code{gcry_strerror} returns a pointer to a statically
1180 allocated string containing a description of the error source
1181 contained in the error value @var{err}.  This string can be used to
1182 output a diagnostic message to the user.
1183 @end deftypefun
1184
1185 The following example illustrates the use of the functions described
1186 above:
1187
1188 @example
1189 @{
1190   gcry_cipher_hd_t handle;
1191   gcry_error_t err = 0;
1192
1193   err = gcry_cipher_open (&handle, GCRY_CIPHER_AES, 
1194                           GCRY_CIPHER_MODE_CBC, 0);
1195   if (err)
1196     @{
1197       fprintf (stderr, "Failure: %s/%s\n",
1198                gcry_strsource (err),
1199                gcry_strerror (err));
1200     @}
1201 @}
1202 @end example
1203
1204 @c **********************************************************
1205 @c *******************  General  ****************************
1206 @c **********************************************************
1207 @node Handler Functions
1208 @chapter Handler Functions
1209
1210 Libgcrypt makes it possible to install so called `handler functions',
1211 which get called by Libgcrypt in case of certain events. 
1212
1213 @menu
1214 * Progress handler::            Using a progress handler function.
1215 * Allocation handler::          Using special memory allocation functions.
1216 * Error handler::               Using error handler functions.
1217 * Logging handler::             Using a special logging function.
1218 @end menu
1219
1220 @node Progress handler
1221 @section Progress handler
1222
1223 It is often useful to retrieve some feedback while long running
1224 operations are performed.
1225
1226 @deftp {Data type} gcry_handler_progress_t
1227 Progress handler functions have to be of the type
1228 @code{gcry_handler_progress_t}, which is defined as:
1229
1230 @code{void (*gcry_handler_progress_t) (void *, const char *, int, int, int)}
1231 @end deftp
1232
1233 The following function may be used to register a handler function for
1234 this purpose.
1235
1236 @deftypefun void gcry_set_progress_handler (gcry_handler_progress_t @var{cb}, void *@var{cb_data})
1237
1238 This function installs @var{cb} as the `Progress handler' function.
1239 It may be used only during initialization.  @var{cb} must be defined
1240 as follows:
1241
1242 @example
1243 void
1244 my_progress_handler (void *@var{cb_data}, const char *@var{what},
1245                      int @var{printchar}, int @var{current}, int @var{total})
1246 @{
1247   /* Do something.  */
1248 @}
1249 @end example
1250
1251 A description of the arguments of the progress handler function follows.
1252
1253 @table @var
1254 @item cb_data
1255 The argument provided in the call to @code{gcry_set_progress_handler}.
1256 @item what
1257 A string identifying the type of the progress output.  The following
1258 values for @var{what} are defined:
1259
1260 @table @code
1261 @item need_entropy
1262 Not enough entropy is available.  @var{total} holds the number of
1263 required bytes.
1264
1265 @item primegen
1266 Values for @var{printchar}:
1267 @table @code
1268 @item \n
1269 Prime generated.
1270 @item !
1271 Need to refresh the pool of prime numbers.
1272 @item <, >
1273 Number of bits adjusted.
1274 @item ^
1275 Searching for a generator.
1276 @item .
1277 Fermat test on 10 candidates failed.
1278 @item :
1279 Restart with a new random value.
1280 @item +
1281 Rabin Miller test passed.
1282 @end table
1283
1284 @end table
1285
1286 @end table
1287 @end deftypefun
1288
1289 @node Allocation handler
1290 @section Allocation handler
1291
1292 It is possible to make Libgcrypt use special memory
1293 allocation functions instead of the built-in ones.
1294
1295 Memory allocation functions are of the following types:
1296 @deftp {Data type} gcry_handler_alloc_t
1297 This type is defined as: @code{void *(*gcry_handler_alloc_t) (size_t n)}.
1298 @end deftp
1299 @deftp {Data type} gcry_handler_secure_check_t
1300 This type is defined as: @code{int *(*gcry_handler_secure_check_t) (const void *)}.
1301 @end deftp
1302 @deftp {Data type} gcry_handler_realloc_t
1303 This type is defined as: @code{void *(*gcry_handler_realloc_t) (void *p, size_t n)}.
1304 @end deftp
1305 @deftp {Data type} gcry_handler_free_t
1306 This type is defined as: @code{void *(*gcry_handler_free_t) (void *)}.
1307 @end deftp
1308
1309 Special memory allocation functions can be installed with the
1310 following function:
1311
1312 @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})
1313 Install the provided functions and use them instead of the built-in
1314 functions for doing memory allocation.  Using this function is in
1315 general not recommended because the standard Libgcrypt allocation
1316 functions are guaranteed to zeroize memory if needed.
1317
1318 This function may be used only during initialization and may not be
1319 used in fips mode.
1320
1321
1322 @end deftypefun
1323
1324 @node Error handler
1325 @section Error handler
1326
1327 The following functions may be used to register handler functions that
1328 are called by Libgcrypt in case certain error conditions occur.  They
1329 may and should be registered prior to calling @code{gcry_check_version}.
1330
1331 @deftp {Data type} gcry_handler_no_mem_t
1332 This type is defined as: @code{int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int)}
1333 @end deftp
1334 @deftypefun void gcry_set_outofcore_handler (gcry_handler_no_mem_t @var{func_no_mem}, void *@var{cb_data})
1335 This function registers @var{func_no_mem} as `out-of-core handler',
1336 which means that it will be called in the case of not having enough
1337 memory available.  The handler is called with 3 arguments: The first
1338 one is the pointer @var{cb_data} as set with this function, the second
1339 is the requested memory size and the last being a flag.  If bit 0 of
1340 the flag is set, secure memory has been requested.  The handler should
1341 either return true to indicate that Libgcrypt should try again
1342 allocating memory or return false to let Libgcrypt use its default
1343 fatal error handler.
1344 @end deftypefun
1345
1346 @deftp {Data type} gcry_handler_error_t
1347 This type is defined as: @code{void (*gcry_handler_error_t) (void *, int, const char *)}
1348 @end deftp
1349
1350 @deftypefun void gcry_set_fatalerror_handler (gcry_handler_error_t @var{func_error}, void *@var{cb_data})
1351 This function registers @var{func_error} as `error handler',
1352 which means that it will be called in error conditions.
1353 @end deftypefun
1354
1355 @node Logging handler
1356 @section Logging handler
1357
1358 @deftp {Data type} gcry_handler_log_t
1359 This type is defined as: @code{void (*gcry_handler_log_t) (void *, int, const char *, va_list)}
1360 @end deftp
1361
1362 @deftypefun void gcry_set_log_handler (gcry_handler_log_t @var{func_log}, void *@var{cb_data})
1363 This function registers @var{func_log} as `logging handler', which means
1364 that it will be called in case Libgcrypt wants to log a message.  This
1365 function may and should be used prior to calling
1366 @code{gcry_check_version}.
1367 @end deftypefun
1368
1369 @c **********************************************************
1370 @c *******************  Ciphers  ****************************
1371 @c **********************************************************
1372 @c @include cipher-ref.texi
1373 @node Symmetric cryptography
1374 @chapter Symmetric cryptography
1375
1376 The cipher functions are used for symmetrical cryptography,
1377 i.e. cryptography using a shared key.  The programming model follows
1378 an open/process/close paradigm and is in that similar to other
1379 building blocks provided by Libgcrypt.
1380
1381 @menu
1382 * Available ciphers::           List of ciphers supported by the library.
1383 * Cipher modules::              How to work with cipher modules.
1384 * Available cipher modes::      List of cipher modes supported by the library.
1385 * Working with cipher handles::  How to perform operations related to cipher handles.
1386 * General cipher functions::    General cipher functions independent of cipher handles.
1387 @end menu
1388
1389 @node Available ciphers
1390 @section Available ciphers
1391
1392 @table @code
1393 @item GCRY_CIPHER_NONE
1394 This is not a real algorithm but used by some functions as error return.
1395 The value always evaluates to false.
1396
1397 @item GCRY_CIPHER_IDEA
1398 @cindex IDEA
1399 This is the IDEA algorithm.  The constant is provided but there is
1400 currently no implementation for it because the algorithm is patented.
1401
1402 @item GCRY_CIPHER_3DES
1403 @cindex 3DES
1404 @cindex Triple-DES
1405 @cindex DES-EDE
1406 @cindex Digital Encryption Standard
1407 Triple-DES with 3 Keys as EDE.  The key size of this algorithm is 168 but
1408 you have to pass 192 bits because the most significant bits of each byte
1409 are ignored.
1410
1411 @item GCRY_CIPHER_CAST5
1412 @cindex CAST5
1413 CAST128-5 block cipher algorithm.  The key size is 128 bits.
1414         
1415 @item GCRY_CIPHER_BLOWFISH
1416 @cindex Blowfish
1417 The blowfish algorithm. The current implementation allows only for a key
1418 size of 128 bits.
1419
1420 @item GCRY_CIPHER_SAFER_SK128
1421 Reserved and not currently implemented.
1422
1423 @item GCRY_CIPHER_DES_SK          
1424 Reserved and not currently implemented.
1425  
1426 @item  GCRY_CIPHER_AES        
1427 @itemx GCRY_CIPHER_AES128
1428 @itemx GCRY_CIPHER_RIJNDAEL
1429 @itemx GCRY_CIPHER_RIJNDAEL128
1430 @cindex Rijndael
1431 @cindex AES
1432 @cindex Advanced Encryption Standard
1433 AES (Rijndael) with a 128 bit key.
1434
1435 @item  GCRY_CIPHER_AES192     
1436 @itemx GCRY_CIPHER_RIJNDAEL192
1437 AES (Rijndael) with a 192 bit key.
1438
1439 @item  GCRY_CIPHER_AES256 
1440 @itemx GCRY_CIPHER_RIJNDAEL256
1441 AES (Rijndael) with a 256 bit key.
1442     
1443 @item  GCRY_CIPHER_TWOFISH
1444 @cindex Twofish
1445 The Twofish algorithm with a 256 bit key.
1446     
1447 @item  GCRY_CIPHER_TWOFISH128
1448 The Twofish algorithm with a 128 bit key.
1449     
1450 @item  GCRY_CIPHER_ARCFOUR   
1451 @cindex Arcfour
1452 @cindex RC4
1453 An algorithm which is 100% compatible with RSA Inc.'s RC4 algorithm.
1454 Note that this is a stream cipher and must be used very carefully to
1455 avoid a couple of weaknesses. 
1456
1457 @item  GCRY_CIPHER_DES
1458 @cindex DES
1459 Standard DES with a 56 bit key. You need to pass 64 bit but the high
1460 bits of each byte are ignored.  Note, that this is a weak algorithm
1461 which can be broken in reasonable time using a brute force approach.
1462
1463 @item  GCRY_CIPHER_SERPENT128
1464 @itemx GCRY_CIPHER_SERPENT192
1465 @itemx GCRY_CIPHER_SERPENT256
1466 @cindex Serpent
1467 The Serpent cipher from the AES contest.
1468
1469 @item  GCRY_CIPHER_RFC2268_40
1470 @itemx GCRY_CIPHER_RFC2268_128
1471 @cindex rfc-2268
1472 @cindex RC2
1473 Ron's Cipher 2 in the 40 and 128 bit variants.  Note, that we currently
1474 only support the 40 bit variant.  The identifier for 128 is reserved for
1475 future use.
1476
1477 @item GCRY_CIPHER_SEED
1478 @cindex Seed (cipher)
1479 A 128 bit cipher as described by RFC4269.
1480
1481 @item  GCRY_CIPHER_CAMELLIA128
1482 @itemx GCRY_CIPHER_CAMELLIA192
1483 @itemx GCRY_CIPHER_CAMELLIA256
1484 @cindex Camellia
1485 The Camellia cipher by NTT.  See
1486 @uref{http://info.isl.ntt.co.jp/@/crypt/@/eng/@/camellia/@/specifications.html}.
1487
1488 @end table
1489
1490 @node Cipher modules
1491 @section Cipher modules
1492
1493 Libgcrypt makes it possible to load additional `cipher modules'; these
1494 ciphers can be used just like the cipher algorithms that are built
1495 into the library directly.  For an introduction into extension
1496 modules, see @xref{Modules}.
1497
1498 @deftp {Data type} gcry_cipher_spec_t
1499 This is the `module specification structure' needed for registering
1500 cipher modules, which has to be filled in by the user before it can be
1501 used to register a module.  It contains the following members:
1502
1503 @table @code
1504 @item const char *name
1505 The primary name of the algorithm.
1506 @item const char **aliases
1507 A list of strings that are `aliases' for the algorithm.  The list must
1508 be terminated with a NULL element.
1509 @item gcry_cipher_oid_spec_t *oids
1510 A list of OIDs that are to be associated with the algorithm.  The
1511 list's last element must have it's `oid' member set to NULL.  See
1512 below for an explanation of this type.
1513 @item size_t blocksize
1514 The block size of the algorithm, in bytes.
1515 @item size_t keylen
1516 The length of the key, in bits.
1517 @item size_t contextsize
1518 The size of the algorithm-specific `context', that should be allocated
1519 for each handle.
1520 @item gcry_cipher_setkey_t setkey
1521 The function responsible for initializing a handle with a provided
1522 key.  See below for a description of this type.
1523 @item gcry_cipher_encrypt_t encrypt
1524 The function responsible for encrypting a single block.  See below for
1525 a description of this type.
1526 @item gcry_cipher_decrypt_t decrypt
1527 The function responsible for decrypting a single block.  See below for
1528 a description of this type.
1529 @item gcry_cipher_stencrypt_t stencrypt
1530 Like `encrypt', for stream ciphers.  See below for a description of
1531 this type.
1532 @item gcry_cipher_stdecrypt_t stdecrypt
1533 Like `decrypt', for stream ciphers.  See below for a description of
1534 this type.
1535 @end table
1536 @end deftp
1537
1538 @deftp {Data type} gcry_cipher_oid_spec_t
1539 This type is used for associating a user-provided algorithm
1540 implementation with certain OIDs.  It contains the following members:
1541 @table @code
1542 @item const char *oid
1543 Textual representation of the OID.
1544 @item int mode
1545 Cipher mode for which this OID is valid.
1546 @end table
1547 @end deftp
1548
1549 @deftp {Data type} gcry_cipher_setkey_t
1550 Type for the `setkey' function, defined as: gcry_err_code_t
1551 (*gcry_cipher_setkey_t) (void *c, const unsigned char *key, unsigned
1552 keylen)
1553 @end deftp
1554
1555 @deftp {Data type} gcry_cipher_encrypt_t
1556 Type for the `encrypt' function, defined as: gcry_err_code_t
1557 (*gcry_cipher_encrypt_t) (void *c, const unsigned char *outbuf, const
1558 unsigned char *inbuf)
1559 @end deftp
1560
1561 @deftp {Data type} gcry_cipher_decrypt_t
1562 Type for the `decrypt' function, defined as: gcry_err_code_t
1563 (*gcry_cipher_decrypt_t) (void *c, const unsigned char *outbuf, const
1564 unsigned char *inbuf)
1565 @end deftp
1566
1567 @deftp {Data type} gcry_cipher_stencrypt_t
1568 Type for the `stencrypt' function, defined as: gcry_err_code_t
1569 (*gcry_@/cipher_@/stencrypt_@/t) (void *c, const unsigned char *outbuf, const
1570 unsigned char *, unsigned int n)
1571 @end deftp
1572
1573 @deftp {Data type} gcry_cipher_stdecrypt_t
1574 Type for the `stdecrypt' function, defined as: gcry_err_code_t
1575 (*gcry_@/cipher_@/stdecrypt_@/t) (void *c, const unsigned char *outbuf, const
1576 unsigned char *, unsigned int n)
1577 @end deftp
1578
1579 @deftypefun gcry_error_t gcry_cipher_register (gcry_cipher_spec_t *@var{cipher}, unsigned int *algorithm_id, gcry_module_t *@var{module})
1580
1581 Register a new cipher module whose specification can be found in
1582 @var{cipher}.  On success, a new algorithm ID is stored in
1583 @var{algorithm_id} and a pointer representing this module is stored
1584 in @var{module}.
1585 @end deftypefun
1586
1587 @deftypefun void gcry_cipher_unregister (gcry_module_t @var{module})
1588 Unregister the cipher identified by @var{module}, which must have been
1589 registered with gcry_cipher_register.
1590 @end deftypefun
1591
1592 @deftypefun gcry_error_t gcry_cipher_list (int *@var{list}, int *@var{list_length})
1593 Get a list consisting of the IDs of the loaded cipher modules.  If
1594 @var{list} is zero, write the number of loaded cipher modules to
1595 @var{list_length} and return.  If @var{list} is non-zero, the first
1596 *@var{list_length} algorithm IDs are stored in @var{list}, which must
1597 be of according size.  In case there are less cipher modules than
1598 *@var{list_length}, *@var{list_length} is updated to the correct
1599 number.
1600 @end deftypefun
1601
1602 @node Available cipher modes
1603 @section Available cipher modes
1604
1605 @table @code
1606 @item GCRY_CIPHER_MODE_NONE
1607 No mode specified.  This should not be used.  The only exception is that
1608 if Libgcrypt is not used in FIPS mode and if any debug flag has been
1609 set, this mode may be used to bypass the actual encryption.
1610
1611 @item GCRY_CIPHER_MODE_ECB
1612 @cindex ECB, Electronic Codebook mode
1613 Electronic Codebook mode.  
1614
1615 @item GCRY_CIPHER_MODE_CFB
1616 @cindex CFB, Cipher Feedback mode
1617 Cipher Feedback mode.  The shift size equals the block size of the
1618 cipher (e.g. for AES it is CFB-128).
1619
1620 @item  GCRY_CIPHER_MODE_CBC
1621 @cindex CBC, Cipher Block Chaining mode
1622 Cipher Block Chaining mode.
1623
1624 @item GCRY_CIPHER_MODE_STREAM
1625 Stream mode, only to be used with stream cipher algorithms.
1626
1627 @item GCRY_CIPHER_MODE_OFB
1628 @cindex OFB, Output Feedback mode
1629 Output Feedback mode.
1630
1631 @item  GCRY_CIPHER_MODE_CTR
1632 @cindex CTR, Counter mode
1633 Counter mode.
1634
1635 @end table
1636
1637 @node Working with cipher handles
1638 @section Working with cipher handles
1639
1640 To use a cipher algorithm, you must first allocate an according
1641 handle.  This is to be done using the open function:
1642
1643 @deftypefun gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *@var{hd}, int @var{algo}, int @var{mode}, unsigned int @var{flags})
1644
1645 This function creates the context handle required for most of the
1646 other cipher functions and returns a handle to it in `hd'.  In case of
1647 an error, an according error code is returned.
1648
1649 The ID of algorithm to use must be specified via @var{algo}.  See
1650 @xref{Available ciphers}, for a list of supported ciphers and the
1651 according constants.
1652
1653 Besides using the constants directly, the function
1654 @code{gcry_cipher_map_name} may be used to convert the textual name of
1655 an algorithm into the according numeric ID.
1656
1657 The cipher mode to use must be specified via @var{mode}.  See
1658 @xref{Available cipher modes}, for a list of supported cipher modes
1659 and the according constants.  Note that some modes are incompatible
1660 with some algorithms - in particular, stream mode
1661 (@code{GCRY_CIPHER_MODE_STREAM}) only works with stream ciphers. Any
1662 block cipher mode (@code{GCRY_CIPHER_MODE_ECB},
1663 @code{GCRY_CIPHER_MODE_CBC}, @code{GCRY_CIPHER_MODE_CFB},
1664 @code{GCRY_CIPHER_MODE_OFB} or @code{GCRY_CIPHER_MODE_CTR}) will work
1665 with any block cipher algorithm.
1666
1667 The third argument @var{flags} can either be passed as @code{0} or as
1668 the bit-wise OR of the following constants.
1669
1670 @table @code
1671 @item GCRY_CIPHER_SECURE
1672 Make sure that all operations are allocated in secure memory.  This is
1673 useful when the key material is highly confidential.
1674 @item GCRY_CIPHER_ENABLE_SYNC
1675 @cindex sync mode (OpenPGP)
1676 This flag enables the CFB sync mode, which is a special feature of
1677 Libgcrypt's CFB mode implementation to allow for OpenPGP's CFB variant. 
1678 See @code{gcry_cipher_sync}.
1679 @item GCRY_CIPHER_CBC_CTS
1680 @cindex cipher text stealing
1681 Enable cipher text stealing (CTS) for the CBC mode.  Cannot be used
1682 simultaneous as GCRY_CIPHER_CBC_MAC.  CTS mode makes it possible to
1683 transform data of almost arbitrary size (only limitation is that it
1684 must be greater than the algorithm's block size).
1685 @item GCRY_CIPHER_CBC_MAC
1686 @cindex CBC-MAC
1687 Compute CBC-MAC keyed checksums.  This is the same as CBC mode, but
1688 only output the last block.  Cannot be used simultaneous as
1689 GCRY_CIPHER_CBC_CTS.
1690 @end table
1691 @end deftypefun 
1692
1693 Use the following function to release an existing handle:
1694
1695 @deftypefun void gcry_cipher_close (gcry_cipher_hd_t @var{h})
1696
1697 This function releases the context created by @code{gcry_cipher_open}.
1698 @end deftypefun
1699
1700 In order to use a handle for performing cryptographic operations, a
1701 `key' has to be set first:
1702
1703 @deftypefun gcry_error_t gcry_cipher_setkey (gcry_cipher_hd_t @var{h}, const void *@var{k}, size_t @var{l})
1704
1705 Set the key @var{k} used for encryption or decryption in the context
1706 denoted by the handle @var{h}.  The length @var{l} of the key @var{k}
1707 must match the required length of the algorithm set for this context or
1708 be in the allowed range for algorithms with variable key size.  The
1709 function checks this and returns an error if there is a problem.  A
1710 caller should always check for an error.
1711
1712 @end deftypefun
1713
1714 Most crypto modes requires an initialization vector (IV), which
1715 usually is a non-secret random string acting as a kind of salt value.
1716 The CTR mode requires a counter, which is also similar to a salt
1717 value.  To set the IV or CTR, use these functions:
1718
1719 @deftypefun gcry_error_t gcry_cipher_setiv (gcry_cipher_hd_t @var{h}, const void *@var{k}, size_t @var{l})
1720
1721 Set the initialization vector used for encryption or decryption. The
1722 vector is passed as the buffer @var{K} of length @var{l} and copied to
1723 internal data structures.  The function checks that the IV matches the
1724 requirement of the selected algorithm and mode. 
1725 @end deftypefun
1726
1727 @deftypefun gcry_error_t gcry_cipher_setctr (gcry_cipher_hd_t @var{h}, const void *@var{c}, size_t @var{l})
1728
1729 Set the counter vector used for encryption or decryption. The counter
1730 is passed as the buffer @var{c} of length @var{l} and copied to
1731 internal data structures.  The function checks that the counter
1732 matches the requirement of the selected algorithm (i.e., it must be
1733 the same size as the block size).  
1734 @end deftypefun
1735
1736 @deftypefun gcry_error_t gcry_cipher_reset (gcry_cipher_hd_t @var{h})
1737
1738 Set the given handle's context back to the state it had after the last
1739 call to gcry_cipher_setkey and clear the initialization vector.
1740
1741 Note that gcry_cipher_reset is implemented as a macro.
1742 @end deftypefun
1743
1744 The actual encryption and decryption is done by using one of the
1745 following functions.  They may be used as often as required to process
1746 all the data.
1747
1748 @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})
1749
1750 @code{gcry_cipher_encrypt} is used to encrypt the data.  This function
1751 can either work in place or with two buffers.  It uses the cipher
1752 context already setup and described by the handle @var{h}.  There are 2
1753 ways to use the function: If @var{in} is passed as @code{NULL} and
1754 @var{inlen} is @code{0}, in-place encryption of the data in @var{out} or
1755 length @var{outsize} takes place.  With @var{in} being not @code{NULL},
1756 @var{inlen} bytes are encrypted to the buffer @var{out} which must have
1757 at least a size of @var{inlen}.  @var{outsize} must be set to the
1758 allocated size of @var{out}, so that the function can check that there
1759 is sufficient space. Note that overlapping buffers are not allowed.
1760
1761 Depending on the selected algorithms and encryption mode, the length of
1762 the buffers must be a multiple of the block size.
1763
1764 The function returns @code{0} on success or an error code.
1765 @end deftypefun
1766
1767
1768 @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})
1769
1770 @code{gcry_cipher_decrypt} is used to decrypt the data.  This function
1771 can either work in place or with two buffers.  It uses the cipher
1772 context already setup and described by the handle @var{h}.  There are 2
1773 ways to use the function: If @var{in} is passed as @code{NULL} and
1774 @var{inlen} is @code{0}, in-place decryption of the data in @var{out} or
1775 length @var{outsize} takes place.  With @var{in} being not @code{NULL},
1776 @var{inlen} bytes are decrypted to the buffer @var{out} which must have
1777 at least a size of @var{inlen}.  @var{outsize} must be set to the
1778 allocated size of @var{out}, so that the function can check that there
1779 is sufficient space.  Note that overlapping buffers are not allowed.
1780
1781 Depending on the selected algorithms and encryption mode, the length of
1782 the buffers must be a multiple of the block size.
1783
1784 The function returns @code{0} on success or an error code.
1785 @end deftypefun
1786
1787
1788 OpenPGP (as defined in RFC-2440) requires a special sync operation in
1789 some places.  The following function is used for this:
1790
1791 @deftypefun gcry_error_t gcry_cipher_sync (gcry_cipher_hd_t @var{h})
1792
1793 Perform the OpenPGP sync operation on context @var{h}.  Note that this
1794 is a no-op unless the context was created with the flag
1795 @code{GCRY_CIPHER_ENABLE_SYNC}
1796 @end deftypefun
1797
1798 Some of the described functions are implemented as macros utilizing a
1799 catch-all control function.  This control function is rarely used
1800 directly but there is nothing which would inhibit it:
1801
1802 @deftypefun gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t @var{h}, int @var{cmd}, void *@var{buffer}, size_t @var{buflen})
1803
1804 @code{gcry_cipher_ctl} controls various aspects of the cipher module and
1805 specific cipher contexts.  Usually some more specialized functions or
1806 macros are used for this purpose.  The semantics of the function and its
1807 parameters depends on the the command @var{cmd} and the passed context
1808 handle @var{h}.  Please see the comments in the source code
1809 (@code{src/global.c}) for details.
1810 @end deftypefun
1811
1812 @deftypefun gcry_error_t gcry_cipher_info (gcry_cipher_hd_t @var{h}, int @var{what}, void *@var{buffer}, size_t *@var{nbytes})
1813
1814 @code{gcry_cipher_info} is used to retrieve various
1815 information about a cipher context or the cipher module in general.
1816
1817 Currently no information is available.
1818 @end deftypefun
1819
1820 @node General cipher functions
1821 @section General cipher functions
1822
1823 To work with the algorithms, several functions are available to map
1824 algorithm names to the internal identifiers, as well as ways to
1825 retrieve information about an algorithm or the current cipher context.
1826
1827 @deftypefun gcry_error_t gcry_cipher_algo_info (int @var{algo}, int @var{what}, void *@var{buffer}, size_t *@var{nbytes})
1828
1829 This function is used to retrieve information on a specific algorithm.
1830 You pass the cipher algorithm ID as @var{algo} and the type of
1831 information requested as @var{what}. The result is either returned as
1832 the return code of the function or copied to the provided @var{buffer}
1833 whose allocated length must be available in an integer variable with the
1834 address passed in @var{nbytes}.  This variable will also receive the
1835 actual used length of the buffer. 
1836
1837 Here is a list of supported codes for @var{what}:
1838
1839 @c begin constants for gcry_cipher_algo_info
1840 @table @code
1841 @item GCRYCTL_GET_KEYLEN:
1842 Return the length of the key. If the algorithm supports multiple key
1843 lengths, the maximum supported value is returned.  The length is
1844 returned as number of octets (bytes) and not as number of bits in
1845 @var{nbytes}; @var{buffer} must be zero.
1846
1847 @item GCRYCTL_GET_BLKLEN:
1848 Return the block length of the algorithm.  The length is returned as a
1849 number of octets in @var{nbytes}; @var{buffer} must be zero.
1850
1851 @item GCRYCTL_TEST_ALGO:
1852 Returns @code{0} when the specified algorithm is available for use.
1853 @var{buffer} and @var{nbytes} must be zero.
1854  
1855 @end table  
1856 @c end constants for gcry_cipher_algo_info
1857
1858 @end deftypefun
1859 @c end gcry_cipher_algo_info
1860
1861 @deftypefun {const char *} gcry_cipher_algo_name (int @var{algo})
1862
1863 @code{gcry_cipher_algo_name} returns a string with the name of the
1864 cipher algorithm @var{algo}.  If the algorithm is not known or another
1865 error occurred, the string @code{"?"} is returned.  This function should
1866 not be used to test for the availability of an algorithm.
1867 @end deftypefun
1868
1869 @deftypefun int gcry_cipher_map_name (const char *@var{name})
1870
1871 @code{gcry_cipher_map_name} returns the algorithm identifier for the
1872 cipher algorithm described by the string @var{name}.  If this algorithm
1873 is not available @code{0} is returned.
1874 @end deftypefun
1875
1876 @deftypefun int gcry_cipher_mode_from_oid (const char *@var{string})
1877
1878 Return the cipher mode associated with an @acronym{ASN.1} object
1879 identifier.  The object identifier is expected to be in the
1880 @acronym{IETF}-style dotted decimal notation.  The function returns
1881 @code{0} for an unknown object identifier or when no mode is associated
1882 with it.
1883 @end deftypefun
1884
1885
1886 @c **********************************************************
1887 @c *******************  Public Key  *************************
1888 @c **********************************************************
1889 @node Public Key cryptography
1890 @chapter Public Key cryptography
1891
1892 Public key cryptography, also known as asymmetric cryptography, is an
1893 easy way for key management and to provide digital signatures.
1894 Libgcrypt provides two completely different interfaces to
1895 public key cryptography, this chapter explains the one based on
1896 S-expressions.
1897
1898 @menu
1899 * Available algorithms::        Algorithms supported by the library.
1900 * Used S-expressions::          Introduction into the used S-expression.
1901 * Public key modules::          How to work with public key modules.
1902 * Cryptographic Functions::     Functions for performing the cryptographic actions.
1903 * General public-key related Functions::  General functions, not implementing any cryptography.
1904
1905 * AC Interface::                Alternative interface to public key functions.
1906 @end menu
1907
1908 @node Available algorithms
1909 @section Available algorithms
1910
1911 Libgcrypt supports the RSA (Rivest-Shamir-Adleman) algorithms as well
1912 as DSA (Digital Signature Algorithm) and Elgamal.  The versatile
1913 interface allows to add more algorithms in the future.
1914
1915 @node Used S-expressions
1916 @section Used S-expressions
1917
1918 Libgcrypt's API for asymmetric cryptography is based on data structures
1919 called S-expressions (see
1920 @uref{http://people.csail.mit.edu/@/rivest/@/sexp.html}) and does not work
1921 with contexts as most of the other building blocks of Libgcrypt do.
1922
1923 @noindent
1924 The following information are stored in S-expressions:
1925
1926 @itemize @asis
1927 @item keys
1928
1929 @item plain text data
1930
1931 @item encrypted data
1932
1933 @item signatures
1934
1935 @end itemize
1936
1937 @noindent
1938 To describe how Libgcrypt expect keys, we use examples. Note that
1939 words in
1940 @ifnottex
1941 uppercase
1942 @end ifnottex
1943 @iftex
1944 italics
1945 @end iftex
1946 indicate parameters whereas lowercase words are literals.
1947
1948 Note that all MPI (multi-precision-integers) values are expected to be in
1949 @code{GCRYMPI_FMT_USG} format.  An easy way to create S-expressions is
1950 by using @code{gcry_sexp_build} which allows to pass a string with
1951 printf-like escapes to insert MPI values.
1952
1953 @menu
1954 * RSA key parameters::  Parameters used with an RSA key.
1955 * DSA key parameters::  Parameters used with a DSA key.
1956 * ECC key parameters::  Parameters used with ECC keys.
1957 @end menu
1958
1959 @node RSA key parameters
1960 @subsection RSA key parameters
1961
1962 @noindent
1963 An RSA private key is described by this S-expression:
1964
1965 @example
1966 (private-key
1967   (rsa
1968     (n @var{n-mpi})
1969     (e @var{e-mpi})
1970     (d @var{d-mpi})
1971     (p @var{p-mpi})
1972     (q @var{q-mpi})
1973     (u @var{u-mpi})))
1974 @end example
1975
1976 @noindent
1977 An RSA public key is described by this S-expression:
1978
1979 @example
1980 (public-key
1981   (rsa
1982     (n @var{n-mpi})
1983     (e @var{e-mpi})))
1984 @end example
1985
1986
1987 @table @var
1988 @item n-mpi
1989 RSA public modulus @math{n}.
1990 @item e-mpi
1991 RSA public exponent @math{e}.
1992 @item d-mpi
1993 RSA secret exponent @math{d = e^{-1} \bmod (p-1)(q-1)}.
1994 @item p-mpi
1995 RSA secret prime @math{p}.
1996 @item q-mpi
1997 RSA secret prime @math{q} with @math{p < q}.
1998 @item u-mpi
1999 Multiplicative inverse @math{u = p^{-1} \bmod q}.
2000 @end table
2001
2002 For signing and decryption the parameters @math{(p, q, u)} are optional
2003 but greatly improve the performance.  Either all of these optional
2004 parameters must be given or none of them.  They are mandatory for
2005 gcry_pk_testkey.
2006
2007 Note that OpenSSL uses slighly different parameters: @math{q < p} and 
2008  @math{u = q^{-1} \bmod p}.  To use these parameters you will need to
2009 swap the values and recompute @math{u}.  Here is example code to do this:
2010
2011 @example
2012   if (gcry_mpi_cmp (p, q) > 0)
2013     @{
2014       gcry_mpi_swap (p, q);
2015       gcry_mpi_invm (u, p, q);
2016     @}
2017 @end example
2018
2019
2020
2021
2022 @node DSA key parameters
2023 @subsection DSA key parameters
2024
2025 @noindent
2026 A DSA private key is described by this S-expression:
2027
2028 @example
2029 (private-key
2030   (dsa
2031     (p @var{p-mpi})
2032     (q @var{q-mpi})
2033     (g @var{g-mpi})
2034     (y @var{y-mpi})
2035     (x @var{x-mpi})))
2036 @end example
2037
2038 @table @var
2039 @item p-mpi
2040 DSA prime @math{p}.
2041 @item q-mpi
2042 DSA group order @math{q} (which is a prime divisor of @math{p-1}).
2043 @item g-mpi
2044 DSA group generator @math{g}.
2045 @item y-mpi
2046 DSA public key value @math{y = g^x \bmod p}.
2047 @item x-mpi
2048 DSA secret exponent x.
2049 @end table
2050
2051 The public key is similar with "private-key" replaced by "public-key"
2052 and no @var{x-mpi}.
2053
2054
2055 @node ECC key parameters
2056 @subsection ECC key parameters
2057
2058 @noindent
2059 An ECC private key is described by this S-expression:
2060
2061 @example
2062 (private-key
2063   (ecc
2064     (p @var{p-mpi})
2065     (a @var{a-mpi})
2066     (b @var{b-mpi})
2067     (g @var{g-point})
2068     (n @var{n-mpi})
2069     (q @var{q-point})
2070     (d @var{d-mpi})))
2071 @end example
2072
2073 @table @var
2074 @item p-mpi
2075 Prime specifying the field @math{GF(p)}.
2076 @item a-mpi
2077 @itemx b-mpi
2078 The two coefficients of the Weierstrass equation @math{y^2 = x^3 + ax + b}
2079 @item g-point
2080 Base point @math{g}.
2081 @item n-mpi
2082 Order of @math{g}
2083 @item q-point
2084 The point representing the public key @math{Q = dP}.
2085 @item d-mpi
2086 The private key @math{d}
2087 @end table
2088
2089 All point values are encoded in standard format; Libgcrypt does
2090 currently only support uncompressed points, thus the first byte needs to
2091 be @code{0x04}.
2092
2093 The public key is similar with "private-key" replaced by "public-key"
2094 and no @var{d-mpi}.
2095
2096 If the domain parameters are well-known, the name of this curve may be
2097 used.  For example
2098
2099 @example
2100 (private-key
2101   (ecc
2102     (curve "NIST P-192")
2103     (q @var{q-point})
2104     (d @var{d-mpi})))
2105 @end example
2106
2107 The @code{curve} parameter may be given in any case and is used to replace
2108 missing parameters.
2109
2110 @noindent
2111 Currently implemented curves are:
2112 @table @code
2113 @item NIST P-192
2114 @itemx 1.2.840.10045.3.1.1
2115 @itemx prime192v1
2116 @itemx secp192r1
2117 The NIST 192 bit curve, its OID, X9.62 and SECP aliases.
2118
2119 @item NIST P-224
2120 @itemx secp224r1
2121 The NIST 224 bit curve and its SECP alias.
2122
2123 @item NIST P-256
2124 @itemx 1.2.840.10045.3.1.7
2125 @itemx prime256v1
2126 @itemx secp256r1
2127 The NIST 256 bit curve, its OID, X9.62 and SECP aliases.
2128
2129 @item NIST P-384
2130 @itemx secp384r1
2131 The NIST 384 bit curve and its SECP alias.
2132
2133 @item NIST P-521
2134 @itemx secp521r1
2135 The NIST 521 bit curve and its SECP alias.
2136
2137 @end table
2138 As usual the OIDs may optionally be prefixed with the string @code{OID.}
2139 or @code{oid.}.
2140
2141
2142
2143 @node Public key modules
2144 @section Public key modules
2145
2146 Libgcrypt makes it possible to load additional `public key
2147 modules'; these public key algorithms can be used just like the
2148 algorithms that are built into the library directly.  For an
2149 introduction into extension modules, see @xref{Modules}.
2150
2151 @deftp {Data type} gcry_pk_spec_t
2152 This is the `module specification structure' needed for registering
2153 public key modules, which has to be filled in by the user before it
2154 can be used to register a module.  It contains the following members:
2155
2156 @table @code
2157 @item const char *name
2158 The primary name of this algorithm.
2159 @item char **aliases
2160 A list of strings that are `aliases' for the algorithm.  The list
2161 must be terminated with a NULL element.
2162 @item const char *elements_pkey
2163 String containing the one-letter names of the MPI values contained in
2164 a public key.
2165 @item const char *element_skey
2166 String containing the one-letter names of the MPI values contained in
2167 a secret key.
2168 @item const char *elements_enc
2169 String containing the one-letter names of the MPI values that are the
2170 result of an encryption operation using this algorithm.
2171 @item const char *elements_sig
2172 String containing the one-letter names of the MPI values that are the
2173 result of a sign operation using this algorithm.
2174 @item const char *elements_grip
2175 String containing the one-letter names of the MPI values that are to
2176 be included in the `key grip'.
2177 @item int use
2178 The bitwise-OR of the following flags, depending on the abilities of
2179 the algorithm:
2180 @table @code
2181 @item GCRY_PK_USAGE_SIGN
2182 The algorithm supports signing and verifying of data.
2183 @item GCRY_PK_USAGE_ENCR
2184 The algorithm supports the encryption and decryption of data.
2185 @end table
2186 @item gcry_pk_generate_t generate
2187 The function responsible for generating a new key pair.  See below for
2188 a description of this type.
2189 @item gcry_pk_check_secret_key_t check_secret_key
2190 The function responsible for checking the sanity of a provided secret
2191 key.  See below for a description of this type.
2192 @item gcry_pk_encrypt_t encrypt
2193 The function responsible for encrypting data.  See below for a
2194 description of this type.
2195 @item gcry_pk_decrypt_t decrypt
2196 The function responsible for decrypting data.  See below for a
2197 description of this type.
2198 @item gcry_pk_sign_t sign
2199 The function responsible for signing data.  See below for a description
2200 of this type.
2201 @item gcry_pk_verify_t verify
2202 The function responsible for verifying that the provided signature
2203 matches the provided data.  See below for a description of this type.
2204 @item gcry_pk_get_nbits_t get_nbits
2205 The function responsible for returning the number of bits of a provided
2206 key.  See below for a description of this type.
2207 @end table
2208 @end deftp
2209
2210 @deftp {Data type} gcry_pk_generate_t
2211 Type for the `generate' function, defined as: gcry_err_code_t
2212 (*gcry_pk_generate_t) (int algo, unsigned int nbits, unsigned long
2213 use_e, gcry_mpi_t *skey, gcry_mpi_t **retfactors)
2214 @end deftp
2215
2216 @deftp {Data type} gcry_pk_check_secret_key_t
2217 Type for the `check_secret_key' function, defined as: gcry_err_code_t
2218 (*gcry_pk_check_secret_key_t) (int algo, gcry_mpi_t *skey)
2219 @end deftp
2220
2221 @deftp {Data type} gcry_pk_encrypt_t
2222 Type for the `encrypt' function, defined as: gcry_err_code_t
2223 (*gcry_pk_encrypt_t) (int algo, gcry_mpi_t *resarr, gcry_mpi_t data,
2224 gcry_mpi_t *pkey, int flags)
2225 @end deftp
2226
2227 @deftp {Data type} gcry_pk_decrypt_t
2228 Type for the `decrypt' function, defined as: gcry_err_code_t
2229 (*gcry_pk_decrypt_t) (int algo, gcry_mpi_t *result, gcry_mpi_t *data,
2230 gcry_mpi_t *skey, int flags)
2231 @end deftp
2232
2233 @deftp {Data type} gcry_pk_sign_t
2234 Type for the `sign' function, defined as: gcry_err_code_t
2235 (*gcry_pk_sign_t) (int algo, gcry_mpi_t *resarr, gcry_mpi_t data,
2236 gcry_mpi_t *skey)
2237 @end deftp
2238
2239 @deftp {Data type} gcry_pk_verify_t
2240 Type for the `verify' function, defined as: gcry_err_code_t
2241 (*gcry_pk_verify_t) (int algo, gcry_mpi_t hash, gcry_mpi_t *data,
2242 gcry_mpi_t *pkey, int (*cmp) (void *, gcry_mpi_t), void *opaquev)
2243 @end deftp
2244
2245 @deftp {Data type} gcry_pk_get_nbits_t
2246 Type for the `get_nbits' function, defined as: unsigned
2247 (*gcry_pk_get_nbits_t) (int algo, gcry_mpi_t *pkey)
2248 @end deftp
2249
2250 @deftypefun gcry_error_t gcry_pk_register (gcry_pk_spec_t *@var{pubkey}, unsigned int *algorithm_id, gcry_module_t *@var{module})
2251
2252 Register a new public key module whose specification can be found in
2253 @var{pubkey}.  On success, a new algorithm ID is stored in
2254 @var{algorithm_id} and a pointer representing this module is stored
2255 in @var{module}.
2256 @end deftypefun
2257
2258 @deftypefun void gcry_pk_unregister (gcry_module_t @var{module})
2259 Unregister the public key module identified by @var{module}, which
2260 must have been registered with gcry_pk_register.
2261 @end deftypefun
2262
2263 @deftypefun gcry_error_t gcry_pk_list (int *@var{list}, int *@var{list_length})
2264 Get a list consisting of the IDs of the loaded pubkey modules.  If
2265 @var{list} is zero, write the number of loaded pubkey modules to
2266 @var{list_length} and return.  If @var{list} is non-zero, the first
2267 *@var{list_length} algorithm IDs are stored in @var{list}, which must
2268 be of according size.  In case there are less pubkey modules than
2269 *@var{list_length}, *@var{list_length} is updated to the correct
2270 number.
2271 @end deftypefun
2272
2273 @node Cryptographic Functions
2274 @section Cryptographic Functions
2275
2276 @noindent
2277 Note that we will in future allow to use keys without p,q and u
2278 specified and may also support other parameters for performance
2279 reasons. 
2280
2281 @noindent
2282
2283 Some functions operating on S-expressions support `flags', that
2284 influence the operation.  These flags have to be listed in a
2285 sub-S-expression named `flags'; the following flags are known:
2286
2287 @table @code
2288 @item pkcs1
2289 Use PKCS#1 block type 2 padding.
2290 @item no-blinding
2291 Do not use a technique called `blinding', which is used by default in
2292 order to prevent leaking of secret information.  Blinding is only
2293 implemented by RSA, but it might be implemented by other algorithms in
2294 the future as well, when necessary.
2295 @end table
2296
2297 @noindent
2298 Now that we know the key basics, we can carry on and explain how to
2299 encrypt and decrypt data.  In almost all cases the data is a random
2300 session key which is in turn used for the actual encryption of the real
2301 data.  There are 2 functions to do this:
2302
2303 @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}})
2304
2305 Obviously a public key must be provided for encryption.  It is
2306 expected as an appropriate S-expression (see above) in @var{pkey}.
2307 The data to be encrypted can either be in the simple old format, which
2308 is a very simple S-expression consisting only of one MPI, or it may be
2309 a more complex S-expression which also allows to specify flags for
2310 operation, like e.g. padding rules.
2311
2312 @noindent
2313 If you don't want to let Libgcrypt handle the padding, you must pass an
2314 appropriate MPI using this expression for @var{data}:
2315
2316 @example 
2317 (data
2318   (flags raw)
2319   (value @var{mpi}))
2320 @end example
2321
2322 @noindent
2323 This has the same semantics as the old style MPI only way.  @var{MPI} is
2324 the actual data, already padded appropriate for your protocol.  Most
2325 systems however use PKCS#1 padding and so you can use this S-expression
2326 for @var{data}:
2327
2328 @example 
2329 (data
2330   (flags pkcs1)
2331   (value @var{block}))
2332 @end example
2333
2334 @noindent
2335 Here, the "flags" list has the "pkcs1" flag which let the function know
2336 that it should provide PKCS#1 block type 2 padding.  The actual data to
2337 be encrypted is passed as a string of octets in @var{block}.  The
2338 function checks that this data actually can be used with the given key,
2339 does the padding and encrypts it.
2340
2341 If the function could successfully perform the encryption, the return
2342 value will be 0 and a new S-expression with the encrypted result is
2343 allocated and assigned to the variable at the address of @var{r_ciph}.
2344 The caller is responsible to release this value using
2345 @code{gcry_sexp_release}.  In case of an error, an error code is
2346 returned and @var{r_ciph} will be set to @code{NULL}.
2347
2348 @noindent
2349 The returned S-expression has this format when used with RSA:
2350
2351 @example
2352 (enc-val
2353   (rsa
2354     (a @var{a-mpi})))
2355 @end example
2356
2357 @noindent
2358 Where @var{a-mpi} is an MPI with the result of the RSA operation.  When
2359 using the Elgamal algorithm, the return value will have this format:
2360
2361 @example
2362 (enc-val
2363   (elg
2364     (a @var{a-mpi})
2365     (b @var{b-mpi})))
2366 @end example
2367
2368 @noindent
2369 Where @var{a-mpi} and @var{b-mpi} are MPIs with the result of the
2370 Elgamal encryption operation.
2371 @end deftypefun
2372 @c end gcry_pk_encrypt
2373
2374 @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}})
2375
2376 Obviously a private key must be provided for decryption.  It is expected
2377 as an appropriate S-expression (see above) in @var{skey}.  The data to
2378 be decrypted must match the format of the result as returned by
2379 @code{gcry_pk_encrypt}, but should be enlarged with a @code{flags}
2380 element:
2381
2382 @example
2383 (enc-val
2384   (flags)
2385   (elg
2386     (a @var{a-mpi})
2387     (b @var{b-mpi})))
2388 @end example
2389
2390 @noindent
2391 Note that this function currently does not know of any padding
2392 methods and the caller must do any un-padding on his own.
2393
2394 @noindent
2395 The function returns 0 on success or an error code.  The variable at the
2396 address of @var{r_plain} will be set to NULL on error or receive the
2397 decrypted value on success.  The format of @var{r_plain} is a
2398 simple S-expression part (i.e. not a valid one) with just one MPI if
2399 there was no @code{flags} element in @var{data}; if at least an empty
2400 @code{flags} is passed in @var{data}, the format is:
2401
2402 @example
2403 (value @var{plaintext})
2404 @end example
2405 @end deftypefun
2406 @c end gcry_pk_decrypt
2407
2408
2409 Another operation commonly performed using public key cryptography is
2410 signing data.  In some sense this is even more important than
2411 encryption because digital signatures are an important instrument for
2412 key management.  Libgcrypt supports digital signatures using
2413 2 functions, similar to the encryption functions:
2414
2415 @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}})
2416
2417 This function creates a digital signature for @var{data} using the
2418 private key @var{skey} and place it into the variable at the address of
2419 @var{r_sig}.  @var{data} may either be the simple old style S-expression
2420 with just one MPI or a modern and more versatile S-expression which
2421 allows to let Libgcrypt handle padding:
2422
2423 @example 
2424  (data
2425   (flags pkcs1)
2426   (hash @var{hash-algo} @var{block}))
2427 @end example
2428
2429 @noindent
2430 This example requests to sign the data in @var{block} after applying
2431 PKCS#1 block type 1 style padding.  @var{hash-algo} is a string with the
2432 hash algorithm to be encoded into the signature, this may be any hash
2433 algorithm name as supported by Libgcrypt.  Most likely, this will be
2434 "sha1", "rmd160" or "md5".  It is obvious that the length of @var{block}
2435 must match the size of that message digests; the function checks that
2436 this and other constraints are valid.
2437
2438 @noindent
2439 If PKCS#1 padding is not required (because the caller does already
2440 provide a padded value), either the old format or better the following
2441 format should be used:
2442
2443 @example
2444 (data
2445   (flags raw)
2446   (value @var{mpi}))
2447 @end example
2448
2449 @noindent
2450 Here, the data to be signed is directly given as an @var{MPI}.
2451
2452 @noindent
2453 The signature is returned as a newly allocated S-expression in
2454 @var{r_sig} using this format for RSA:
2455
2456 @example
2457 (sig-val
2458   (rsa
2459     (s @var{s-mpi})))
2460 @end example
2461
2462 Where @var{s-mpi} is the result of the RSA sign operation.  For DSA the
2463 S-expression returned is:
2464
2465 @example
2466 (sig-val
2467   (dsa
2468     (r @var{r-mpi})
2469     (s @var{s-mpi})))
2470 @end example
2471
2472 Where @var{r-mpi} and @var{s-mpi} are the result of the DSA sign
2473 operation.  For Elgamal signing (which is slow, yields large numbers
2474 and probably is not as secure as the other algorithms), the same format is
2475 used with "elg" replacing "dsa".
2476 @end deftypefun
2477 @c end gcry_pk_sign
2478
2479 @noindent
2480 The operation most commonly used is definitely the verification of a
2481 signature.  Libgcrypt provides this function:
2482
2483 @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}})
2484
2485 This is used to check whether the signature @var{sig} matches the
2486 @var{data}.  The public key @var{pkey} must be provided to perform this
2487 verification.  This function is similar in its parameters to
2488 @code{gcry_pk_sign} with the exceptions that the public key is used
2489 instead of the private key and that no signature is created but a
2490 signature, in a format as created by @code{gcry_pk_sign}, is passed to
2491 the function in @var{sig}.
2492
2493 @noindent
2494 The result is 0 for success (i.e. the data matches the signature), or an
2495 error code where the most relevant code is @code{GCRYERR_BAD_SIGNATURE}
2496 to indicate that the signature does not match the provided data.
2497
2498 @end deftypefun
2499 @c end gcry_pk_verify
2500
2501 @node General public-key related Functions
2502 @section General public-key related Functions
2503
2504 @noindent
2505 A couple of utility functions are available to retrieve the length of
2506 the key, map algorithm identifiers and perform sanity checks:
2507
2508 @deftypefun {const char *} gcry_pk_algo_name (int @var{algo})
2509
2510 Map the public key algorithm id @var{algo} to a string representation of
2511 the algorithm name.  For unknown algorithms this functions returns the
2512 string @code{"?"}.  This function should not be used to test for the
2513 availability of an algorithm.
2514 @end deftypefun
2515
2516 @deftypefun int gcry_pk_map_name (const char *@var{name})
2517
2518 Map the algorithm @var{name} to a public key algorithm Id.  Returns 0 if
2519 the algorithm name is not known.
2520 @end deftypefun
2521
2522 @deftypefun int gcry_pk_test_algo (int @var{algo})
2523
2524 Return 0 if the public key algorithm @var{algo} is available for use.
2525 Note that this is implemented as a macro.
2526 @end deftypefun
2527
2528
2529 @deftypefun {unsigned int} gcry_pk_get_nbits (gcry_sexp_t @var{key})
2530
2531 Return what is commonly referred as the key length for the given
2532 public or private in @var{key}.
2533 @end deftypefun
2534
2535 @deftypefun {unsigned char *} gcry_pk_get_keygrip (@w{gcry_sexp_t @var{key}}, @w{unsigned char *@var{array}})
2536
2537 Return the so called "keygrip" which is the SHA-1 hash of the public key
2538 parameters expressed in a way depended on the algorithm.  @var{array}
2539 must either provide space for 20 bytes or be @code{NULL}. In the latter
2540 case a newly allocated array of that size is returned.  On success a
2541 pointer to the newly allocated space or to @var{array} is returned.
2542 @code{NULL} is returned to indicate an error which is most likely an
2543 unknown algorithm or one where a "keygrip" has not yet been defined.
2544 The function accepts public or secret keys in @var{key}.
2545 @end deftypefun
2546
2547 @deftypefun gcry_error_t gcry_pk_testkey (gcry_sexp_t @var{key})
2548
2549 Return zero if the private key @var{key} is `sane', an error code otherwise.
2550 Note that it is not possible to check the `saneness' of a public key.
2551
2552 @end deftypefun
2553
2554
2555 @deftypefun gcry_error_t gcry_pk_algo_info (@w{int @var{algo}}, @w{int @var{what}}, @w{void *@var{buffer}}, @w{size_t *@var{nbytes}})
2556
2557 Depending on the value of @var{what} return various information about
2558 the public key algorithm with the id @var{algo}.  Note that the
2559 function returns @code{-1} on error and the actual error code must be
2560 retrieved using the function @code{gcry_errno}.  The currently defined
2561 values for @var{what} are:
2562
2563 @table @code
2564 @item GCRYCTL_TEST_ALGO:
2565 Return 0 if the specified algorithm is available for use.
2566 @var{buffer} must be @code{NULL}, @var{nbytes} may be passed as
2567 @code{NULL} or point to a variable with the required usage of the
2568 algorithm. This may be 0 for "don't care" or the bit-wise OR of these
2569 flags:
2570
2571 @table @code
2572 @item GCRY_PK_USAGE_SIGN 
2573 Algorithm is usable for signing.
2574 @item GCRY_PK_USAGE_ENCR 
2575 Algorithm is usable for encryption.
2576 @end table
2577
2578 Unless you need to test for the allowed usage, it is in general better
2579 to use the macro gcry_pk_test_algo instead.
2580
2581 @item GCRYCTL_GET_ALGO_USAGE:
2582 Return the usage flags for the given algorithm.  An invalid algorithm
2583 return 0.  Disabled algorithms are ignored here because we
2584 want to know whether the algorithm is at all capable of a certain usage.
2585
2586 @item GCRYCTL_GET_ALGO_NPKEY
2587 Return the number of elements the public key for algorithm @var{algo}
2588 consist of.  Return 0 for an unknown algorithm.
2589
2590 @item GCRYCTL_GET_ALGO_NSKEY
2591 Return the number of elements the private key for algorithm @var{algo}
2592 consist of.  Note that this value is always larger than that of the
2593 public key.  Return 0 for an unknown algorithm.
2594
2595 @item GCRYCTL_GET_ALGO_NSIGN
2596 Return the number of elements a signature created with the algorithm
2597 @var{algo} consists of.  Return 0 for an unknown algorithm or for an
2598 algorithm not capable of creating signatures.
2599
2600 @item GCRYCTL_GET_ALGO_NENC
2601 Return the number of elements a encrypted message created with the algorithm
2602 @var{algo} consists of.  Return 0 for an unknown algorithm or for an
2603 algorithm not capable of encryption.
2604 @end table
2605
2606 @noindent
2607 Please note that parameters not required should be passed as @code{NULL}.
2608 @end deftypefun
2609 @c end gcry_pk_algo_info
2610
2611
2612 @deftypefun gcry_error_t gcry_pk_ctl (@w{int @var{cmd}}, @w{void *@var{buffer}}, @w{size_t @var{buflen}})
2613
2614 This is a general purpose function to perform certain control
2615 operations.  @var{cmd} controls what is to be done. The return value is
2616 0 for success or an error code.  Currently supported values for
2617 @var{cmd} are:
2618
2619 @table @code
2620 @item GCRYCTL_DISABLE_ALGO
2621 Disable the algorithm given as an algorithm id in @var{buffer}.
2622 @var{buffer} must point to an @code{int} variable with the algorithm id
2623 and @var{buflen} must have the value @code{sizeof (int)}.
2624
2625 @end table
2626 @end deftypefun
2627 @c end gcry_pk_ctl
2628
2629 @noindent
2630 Libgcrypt also provides a function to generate public key
2631 pairs:
2632
2633 @deftypefun gcry_error_t gcry_pk_genkey (@w{gcry_sexp_t *@var{r_key}}, @w{gcry_sexp_t @var{parms}})
2634
2635 This function create a new public key pair using information given in
2636 the S-expression @var{parms} and stores the private and the public key
2637 in one new S-expression at the address given by @var{r_key}.  In case of
2638 an error, @var{r_key} is set to @code{NULL}.  The return code is 0 for
2639 success or an error code otherwise.
2640
2641 @noindent
2642 Here is an example for @var{parms} to create an 2048 bit RSA key:
2643
2644 @example
2645 (genkey
2646   (rsa
2647     (nbits 4:2048)))
2648 @end example
2649
2650 @noindent
2651 To create an Elgamal key, substitute "elg" for "rsa" and to create a DSA
2652 key use "dsa".  Valid ranges for the key length depend on the
2653 algorithms; all commonly used key lengths are supported.  Currently
2654 supported parameters are:
2655
2656 @table @code
2657 @item nbits
2658 This is always required to specify the length of the key.  The argument
2659 is a string with a number in C-notation.  The value should be a multiple
2660 of 8.
2661
2662 @item curve @var{name}
2663 For ECC a named curve may be used instead of giving the number of
2664 requested bits.  This allows to request a specific curve to override a
2665 default selection Libgcrypt would have taken if @code{nbits} has been
2666 given.  The available names are listed with the description of the ECC
2667 public key parameters.
2668
2669 @item rsa-use-e
2670 This is only used with RSA to give a hint for the public exponent. The
2671 value will be used as a base to test for a usable exponent. Some values
2672 are special:
2673
2674 @table @samp
2675 @item 0
2676 Use a secure and fast value.  This is currently the number 41.
2677 @item 1
2678 Use a value as required by some crypto policies.  This is currently
2679 the number 65537.
2680 @item 2
2681 Reserved
2682 @item > 2
2683 Use the given value.
2684 @end table
2685
2686 @noindent
2687 If this parameter is not used, Libgcrypt uses for historic reasons
2688 65537.
2689
2690 @item qbits
2691 This is only meanigful for DSA keys.  If it is given the DSA key is
2692 generated with a Q parameyer of this size.  If it is not given or zero 
2693 Q is deduced from NBITS in this way:
2694 @table @samp
2695 @item 512 <= N <= 1024
2696 Q = 160
2697 @item N = 2048
2698 Q = 224
2699 @item N = 3072
2700 Q = 256
2701 @item N = 7680
2702 Q = 384
2703 @item N = 15360
2704 Q = 512
2705 @end table
2706 Note that in this case only the values for N, as given in the table,
2707 are allowed.  When specifying Q all values of N in the range 512 to
2708 15680 are valid as long as they are multiples of 8.
2709
2710 @item transient-key
2711 This is only meaningful for RSA keys.  This is a flag with no value.  If
2712 given the RSA key is created using a faster and a somewhat less secure
2713 random number generator.  This flag may be used for keys which are only
2714 used for a short time and do not require full cryptographic strength.
2715
2716 @item domain
2717 This is only meaningful for DLP algorithms.  If specified keys are
2718 generated with domain parameters taken from this list.  The exact
2719 format of this parameter depends on the actual algorithm.  It is
2720 currently only implemented for DSA using this format:
2721
2722 @example
2723 (genkey
2724   (dsa
2725     (domain
2726       (p @var{p-mpi})
2727       (q @var{q-mpi})
2728       (g @var{q-mpi})
2729       (seed @var{seed-mpi})
2730       (counter @var{counter-mpi})
2731       (h @var{h-mpi}))))
2732 @end example
2733
2734 The @code{seed}, @code{counter} and @code{h} domain parameters are
2735 optional and currently not used.
2736
2737 @item derive-parms
2738 This is currently only meaningful for RSA keys.  If given, it is used
2739 to derive the RSA keys using the given parameters.  This is in general
2740 only useful for key generation tests.  If given for an RSA key the
2741 X9.31 key generation algorithm is used even if libgcrypt is not in
2742 FIPS mode.
2743
2744 @example
2745 (genkey
2746   (rsa
2747     (nbits 4:1024)
2748     (rsa-use-e 1:3)
2749     (derive-parms
2750       (Xp1 #1A1916DDB29B4EB7EB6732E128#)
2751       (Xp2 #192E8AAC41C576C822D93EA433#)
2752       (Xp  #D8CD81F035EC57EFE822955149D3BFF70C53520D
2753             769D6D76646C7A792E16EBD89FE6FC5B605A6493
2754             39DFC925A86A4C6D150B71B9EEA02D68885F5009
2755             B98BD984#)
2756       (Xq1 #1A5CF72EE770DE50CB09ACCEA9#)
2757       (Xq2 #134E4CAA16D2350A21D775C404#)
2758       (Xq  #CC1092495D867E64065DEE3E7955F2EBC7D47A2D
2759             7C9953388F97DDDC3E1CA19C35CA659EDC2FC325
2760             6D29C2627479C086A699A49C4C9CEE7EF7BD1B34
2761             321DE34A#))))
2762 @end example
2763
2764 @item use-x931
2765 @cindex X9.31
2766 Force the use of the ANSI X9.31 key generation algorithm instead of
2767 the default algorithm. This flag is only meaningful for RSA and
2768 usually not required.  Note that this algorithm is implicitly used if
2769 either @code{derive-parms} is given or Libgcrypt is in FIPS mode.
2770
2771 @item use-fips186
2772 @cindex FIPS 186
2773 Force the use of the FIPS 186 key generation algorithm instead of the
2774 default algorithm.  This flag is only meaningful for DSA and usually
2775 not required.  Note that this algorithm is implicitly used if either
2776 @code{derive-parms} is given or Libgcrypt is in FIPS mode.  As of now
2777 FIPS 186-2 is implemented; after the approval of FIPS 186-3 the code
2778 will be changed to implement 186-3.
2779
2780
2781 @item use-fips186-2
2782 Force the use of the FIPS 186-2 key generation algorithm instead of
2783 the default algorithm.  This algorithm has a slighlty different from
2784 FIPS 186-3 and allws only 1024 bit keys.  This flag is only meaningful
2785 for DSA and only required for FIPS testing backward compatibility.
2786
2787
2788 @end table
2789 @c end table of parameters
2790
2791 @noindent
2792 The key pair is returned in a format depending on the algorithm.  Both
2793 private and public keys are returned in one container and may be
2794 accompanied by some miscellaneous information.
2795
2796 @noindent
2797 As an example, here is what the Elgamal key generation returns:
2798
2799 @example
2800 (key-data
2801   (public-key
2802     (elg
2803       (p @var{p-mpi})
2804       (g @var{g-mpi})
2805       (y @var{y-mpi})))
2806   (private-key
2807     (elg
2808       (p @var{p-mpi})
2809       (g @var{g-mpi})
2810       (y @var{y-mpi})
2811       (x @var{x-mpi})))
2812   (misc-key-info
2813     (pm1-factors @var{n1 n2 ... nn}))
2814 @end example
2815
2816 @noindent
2817 As you can see, some of the information is duplicated, but this
2818 provides an easy way to extract either the public or the private key.
2819 Note that the order of the elements is not defined, e.g. the private
2820 key may be stored before the public key. @var{n1 n2 ... nn} is a list
2821 of prime numbers used to composite @var{p-mpi}; this is in general not
2822 a very useful information and only available if the key generation
2823 algorithm provides them.  
2824 @end deftypefun
2825 @c end gcry_pk_genkey
2826
2827 @node AC Interface
2828 @section Alternative Public Key Interface
2829
2830 This section documents the alternative interface to asymmetric
2831 cryptography (ac) that is not based on S-expressions, but on native C
2832 data structures.  As opposed to the pk interface described in the
2833 former chapter, this one follows an open/use/close paradigm like other
2834 building blocks of the library.
2835
2836 @strong{This interface has a few known problems; most noteworthy an
2837 inherent tendency to leak memory.  It might not be available in
2838 forthcoming versions Libgcrypt.}
2839
2840
2841 @menu
2842 * Available asymmetric algorithms::  List of algorithms supported by the library.
2843 * Working with sets of data::   How to work with sets of data.
2844 * Working with IO objects::     How to work with IO objects.
2845 * Working with handles::        How to use handles.
2846 * Working with keys::           How to work with keys.
2847 * Using cryptographic functions::  How to perform cryptographic operations.
2848 * Handle-independent functions::  General functions independent of handles.
2849 @end menu
2850
2851 @node Available asymmetric algorithms
2852 @subsection Available asymmetric algorithms
2853
2854 Libgcrypt supports the RSA (Rivest-Shamir-Adleman)
2855 algorithms as well as DSA (Digital Signature Algorithm) and Elgamal.
2856 The versatile interface allows to add more algorithms in the future.
2857
2858 @deftp {Data type} gcry_ac_id_t
2859
2860 The following constants are defined for this type:
2861
2862 @table @code
2863 @item GCRY_AC_RSA
2864 Rivest-Shamir-Adleman
2865 @item GCRY_AC_DSA
2866 Digital Signature Algorithm
2867 @item GCRY_AC_ELG
2868 Elgamal
2869 @item GCRY_AC_ELG_E
2870 Elgamal, encryption only.
2871 @end table
2872 @end deftp
2873
2874 @node Working with sets of data
2875 @subsection Working with sets of data
2876
2877 In the context of this interface the term `data set' refers to a list
2878 of `named MPI values' that is used by functions performing
2879 cryptographic operations; a named MPI value is a an MPI value,
2880 associated with a label.
2881
2882 Such data sets are used for representing keys, since keys simply
2883 consist of a variable amount of numbers.  Furthermore some functions
2884 return data sets to the caller that are to be provided to other
2885 functions.
2886
2887 This section documents the data types, symbols and functions that are
2888 relevant for working with data sets.
2889
2890 @deftp {Data type} gcry_ac_data_t
2891 A single data set.
2892 @end deftp
2893
2894 The following flags are supported:
2895
2896 @table @code
2897 @item GCRY_AC_FLAG_DEALLOC
2898 Used for storing data in a data set.  If given, the data will be
2899 released by the library.  Note that whenever one of the ac functions
2900 is about to release objects because of this flag, the objects are
2901 expected to be stored in memory allocated through the Libgcrypt memory
2902 management.  In other words: gcry_free() is used instead of free().
2903
2904 @item GCRY_AC_FLAG_COPY
2905 Used for storing/retrieving data in/from a data set.  If given, the
2906 library will create copies of the provided/contained data, which will
2907 then be given to the user/associated with the data set.
2908 @end table
2909
2910 @deftypefun gcry_error_t gcry_ac_data_new (gcry_ac_data_t *@var{data})
2911 Creates a new, empty data set and stores it in @var{data}.
2912 @end deftypefun
2913
2914 @deftypefun void gcry_ac_data_destroy (gcry_ac_data_t @var{data})
2915 Destroys the data set @var{data}.
2916 @end deftypefun
2917
2918 @deftypefun gcry_error_t gcry_ac_data_set (gcry_ac_data_t @var{data}, unsigned int @var{flags}, char *@var{name}, gcry_mpi_t @var{mpi})
2919 Add the value @var{mpi} to @var{data} with the label @var{name}.  If
2920 @var{flags} contains GCRY_AC_FLAG_COPY, the data set will contain
2921 copies of @var{name} and @var{mpi}.  If @var{flags} contains
2922 GCRY_AC_FLAG_DEALLOC or GCRY_AC_FLAG_COPY, the values
2923 contained in the data set will be deallocated when they are to be
2924 removed from the data set.
2925 @end deftypefun
2926
2927 @deftypefun gcry_error_t gcry_ac_data_copy (gcry_ac_data_t *@var{data_cp}, gcry_ac_data_t @var{data})
2928 Create a copy of the data set @var{data} and store it in
2929 @var{data_cp}.  FIXME: exact semantics undefined.
2930 @end deftypefun
2931
2932 @deftypefun {unsigned int} gcry_ac_data_length (gcry_ac_data_t @var{data})
2933 Returns the number of named MPI values inside of the data set
2934 @var{data}.
2935 @end deftypefun
2936
2937 @deftypefun gcry_error_t gcry_ac_data_get_name (gcry_ac_data_t @var{data}, unsigned int @var{flags}, char *@var{name}, gcry_mpi_t *@var{mpi})
2938 Store the value labelled with @var{name} found in @var{data} in
2939 @var{mpi}.  If @var{flags} contains GCRY_AC_FLAG_COPY, store a copy of
2940 the @var{mpi} value contained in the data set.  @var{mpi} may be NULL
2941 (this might be useful for checking the existence of an MPI with
2942 extracting it).
2943 @end deftypefun
2944
2945 @deftypefun gcry_error_t gcry_ac_data_get_index (gcry_ac_data_t @var{data}, unsigned int flags, unsigned int @var{index}, const char **@var{name}, gcry_mpi_t *@var{mpi})
2946 Stores in @var{name} and @var{mpi} the named @var{mpi} value contained
2947 in the data set @var{data} with the index @var{idx}.  If @var{flags}
2948 contains GCRY_AC_FLAG_COPY, store copies of the values contained in
2949 the data set. @var{name} or @var{mpi} may be NULL.
2950 @end deftypefun
2951
2952 @deftypefun void gcry_ac_data_clear (gcry_ac_data_t @var{data})
2953 Destroys any values contained in the data set @var{data}.
2954 @end deftypefun
2955
2956 @deftypefun gcry_error_t gcry_ac_data_to_sexp (gcry_ac_data_t @var{data}, gcry_sexp_t *@var{sexp}, const char **@var{identifiers})
2957 This function converts the data set @var{data} into a newly created
2958 S-Expression, which is to be stored in @var{sexp}; @var{identifiers}
2959 is a NULL terminated list of C strings, which specifies the structure
2960 of the S-Expression.
2961
2962 Example:
2963
2964 If @var{identifiers} is a list of pointers to the strings ``foo'' and
2965 ``bar'' and if @var{data} is a data set containing the values ``val1 =
2966 0x01'' and ``val2 = 0x02'', then the resulting S-Expression will look
2967 like this: (foo (bar ((val1 0x01) (val2 0x02))).
2968 @end deftypefun
2969
2970 @deftypefun gcry_error gcry_ac_data_from_sexp (gcry_ac_data_t *@var{data}, gcry_sexp_t @var{sexp}, const char **@var{identifiers})
2971 This function converts the S-Expression @var{sexp} into a newly
2972 created data set, which is to be stored in @var{data};
2973 @var{identifiers} is a NULL terminated list of C strings, which
2974 specifies the structure of the S-Expression.  If the list of
2975 identifiers does not match the structure of the S-Expression, the
2976 function fails.
2977 @end deftypefun
2978
2979 @node Working with IO objects
2980 @subsection Working with IO objects
2981
2982 Note: IO objects are currently only used in the context of message
2983 encoding/decoding and encryption/signature schemes.
2984
2985 @deftp {Data type} {gcry_ac_io_t}
2986 @code{gcry_ac_io_t} is the type to be used for IO objects.
2987 @end deftp
2988
2989 IO objects provide an uniform IO layer on top of different underlying
2990 IO mechanisms; either they can be used for providing data to the
2991 library (mode is GCRY_AC_IO_READABLE) or they can be used for
2992 retrieving data from the library (mode is GCRY_AC_IO_WRITABLE).
2993
2994 IO object need to be initialized by calling on of the following
2995 functions:
2996
2997 @deftypefun void gcry_ac_io_init (gcry_ac_io_t *@var{ac_io}, gcry_ac_io_mode_t @var{mode}, gcry_ac_io_type_t @var{type}, ...);
2998 Initialize @var{ac_io} according to @var{mode}, @var{type} and the
2999 variable list of arguments.  The list of variable arguments to specify
3000 depends on the given @var{type}.
3001 @end deftypefun
3002
3003 @deftypefun void gcry_ac_io_init_va (gcry_ac_io_t *@var{ac_io}, gcry_ac_io_mode_t @var{mode}, gcry_ac_io_type_t @var{type}, va_list @var{ap});
3004 Initialize @var{ac_io} according to @var{mode}, @var{type} and the
3005 variable list of arguments @var{ap}.  The list of variable arguments
3006 to specify depends on the given @var{type}.
3007 @end deftypefun
3008
3009 The following types of IO objects exist:
3010
3011 @table @code
3012 @item GCRY_AC_IO_STRING
3013 In case of GCRY_AC_IO_READABLE the IO object will provide data from a
3014 memory string.  Arguments to specify at initialization time:
3015 @table @code
3016 @item unsigned char *
3017 Pointer to the beginning of the memory string
3018 @item size_t
3019 Size of the memory string
3020 @end table
3021 In case of GCRY_AC_IO_WRITABLE the object will store retrieved data in
3022 a newly allocated memory string.  Arguments to specify at
3023 initialization time:
3024 @table @code
3025 @item unsigned char **
3026 Pointer to address, at which the pointer to the newly created memory
3027 string is to be stored
3028 @item size_t *
3029 Pointer to address, at which the size of the newly created memory
3030 string is to be stored
3031 @end table
3032
3033 @item GCRY_AC_IO_CALLBACK
3034 In case of GCRY_AC_IO_READABLE the object will forward read requests
3035 to a provided callback function.  Arguments to specify at
3036 initialization time:
3037 @table @code
3038 @item gcry_ac_data_read_cb_t
3039 Callback function to use
3040 @item void *
3041 Opaque argument to provide to the callback function
3042 @end table
3043 In case of GCRY_AC_IO_WRITABLE the object will forward write requests
3044 to a provided callback function.  Arguments to specify at
3045 initialization time:
3046 @table @code
3047 @item gcry_ac_data_write_cb_t
3048 Callback function to use
3049 @item void *
3050 Opaque argument to provide to the callback function
3051 @end table
3052 @end table
3053
3054 @node Working with handles
3055 @subsection Working with handles
3056
3057 In order to use an algorithm, an according handle must be created.
3058 This is done using the following function:
3059
3060 @deftypefun gcry_error_t gcry_ac_open (gcry_ac_handle_t *@var{handle}, int @var{algorithm}, int @var{flags})
3061
3062 Creates a new handle for the algorithm @var{algorithm} and stores it
3063 in @var{handle}.  @var{flags} is not used currently.
3064
3065 @var{algorithm} must be a valid algorithm ID, see @xref{Available
3066 asymmetric algorithms}, for a list of supported algorithms and the
3067 according constants.  Besides using the listed constants directly, the
3068 functions @code{gcry_pk_name_to_id} may be used to convert the textual
3069 name of an algorithm into the according numeric ID.
3070 @end deftypefun
3071
3072 @deftypefun void gcry_ac_close (gcry_ac_handle_t @var{handle})
3073 Destroys the handle @var{handle}.
3074 @end deftypefun
3075
3076 @node Working with keys
3077 @subsection Working with keys
3078
3079 @deftp {Data type} gcry_ac_key_type_t
3080 Defined constants:
3081
3082 @table @code
3083 @item GCRY_AC_KEY_SECRET
3084 Specifies a secret key.
3085 @item GCRY_AC_KEY_PUBLIC
3086 Specifies a public key.
3087 @end table
3088 @end deftp
3089
3090 @deftp {Data type} gcry_ac_key_t
3091 This type represents a single `key', either a secret one or a public
3092 one.
3093 @end deftp
3094
3095 @deftp {Data type} gcry_ac_key_pair_t
3096 This type represents a `key pair' containing a secret and a public key.
3097 @end deftp
3098
3099 Key data structures can be created in two different ways; a new key
3100 pair can be generated, resulting in ready-to-use key.  Alternatively a
3101 key can be initialized from a given data set.
3102
3103 @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})
3104 Creates a new key of type @var{type}, consisting of the MPI values
3105 contained in the data set @var{data} and stores it in @var{key}.
3106 @end deftypefun
3107
3108 @deftypefun gcry_error_t gcry_ac_key_pair_generate (gcry_ac_handle_t @var{handle}, unsigned int @var{nbits}, void *@var{key_spec}, gcry_ac_key_pair_t *@var{key_pair}, gcry_mpi_t **@var{misc_data})
3109
3110 Generates a new key pair via the handle @var{handle} of @var{NBITS}
3111 bits and stores it in @var{key_pair}.
3112
3113 In case non-standard settings are wanted, a pointer to a structure of
3114 type @code{gcry_ac_key_spec_<algorithm>_t}, matching the selected
3115 algorithm, can be given as @var{key_spec}.  @var{misc_data} is not
3116 used yet.  Such a structure does only exist for RSA.  A description
3117 of the members of the supported structures follows.
3118
3119 @table @code
3120 @item gcry_ac_key_spec_rsa_t
3121 @table @code
3122 @item gcry_mpi_t e
3123 Generate the key pair using a special @code{e}.  The value of @code{e}
3124 has the following meanings:
3125 @table @code
3126 @item = 0
3127 Let Libgcrypt decide what exponent should be used.
3128 @item = 1
3129 Request the use of a ``secure'' exponent; this is required by some
3130 specification to be 65537.
3131 @item > 2
3132 Try starting at this value until a working exponent is found.  Note
3133 that the current implementation leaks some information about the
3134 private key because the incrementation used is not randomized.  Thus,
3135 this function will be changed in the future to return a random
3136 exponent of the given size.
3137 @end table
3138 @end table
3139 @end table
3140
3141 Example code:
3142 @example
3143 @{
3144   gcry_ac_key_pair_t key_pair;
3145   gcry_ac_key_spec_rsa_t rsa_spec;
3146
3147   rsa_spec.e = gcry_mpi_new (0);
3148   gcry_mpi_set_ui (rsa_spec.e, 1);
3149
3150   err = gcry_ac_open  (&handle, GCRY_AC_RSA, 0);
3151   assert (! err);
3152
3153   err = gcry_ac_key_pair_generate (handle, 1024, &rsa_spec,
3154                                    &key_pair, NULL);
3155   assert (! err);
3156 @}
3157 @end example
3158 @end deftypefun
3159
3160
3161 @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})
3162 Returns the key of type @var{which} out of the key pair
3163 @var{key_pair}.
3164 @end deftypefun
3165
3166 @deftypefun void gcry_ac_key_destroy (gcry_ac_key_t @var{key})
3167 Destroys the key @var{key}.
3168 @end deftypefun
3169
3170 @deftypefun void gcry_ac_key_pair_destroy (gcry_ac_key_pair_t @var{key_pair})
3171 Destroys the key pair @var{key_pair}.
3172 @end deftypefun
3173
3174 @deftypefun gcry_ac_data_t gcry_ac_key_data_get (gcry_ac_key_t @var{key})
3175 Returns the data set contained in the key @var{key}.
3176 @end deftypefun
3177
3178 @deftypefun gcry_error_t gcry_ac_key_test (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key})
3179 Verifies that the private key @var{key} is sane via @var{handle}.
3180 @end deftypefun
3181
3182 @deftypefun gcry_error_t gcry_ac_key_get_nbits (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key}, unsigned int *@var{nbits})
3183 Stores the number of bits of the key @var{key} in @var{nbits} via @var{handle}.
3184 @end deftypefun
3185
3186 @deftypefun gcry_error_t gcry_ac_key_get_grip (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key}, unsigned char *@var{key_grip})
3187 Writes the 20 byte long key grip of the key @var{key} to
3188 @var{key_grip} via @var{handle}.
3189 @end deftypefun
3190
3191 @node Using cryptographic functions
3192 @subsection Using cryptographic functions
3193
3194 The following flags might be relevant:
3195
3196 @table @code
3197 @item GCRY_AC_FLAG_NO_BLINDING
3198 Disable any blinding, which might be supported by the chosen
3199 algorithm; blinding is the default.
3200 @end table
3201
3202 There exist two kinds of cryptographic functions available through the
3203 ac interface: primitives, and high-level functions.
3204
3205 Primitives deal with MPIs (data sets) directly; what they provide is
3206 direct access to the cryptographic operations provided by an algorithm
3207 implementation.
3208
3209 High-level functions deal with octet strings, according to a specified
3210 ``scheme''.  Schemes make use of ``encoding methods'', which are
3211 responsible for converting the provided octet strings into MPIs, which
3212 are then forwared to the cryptographic primitives.  Since schemes are
3213 to be used for a special purpose in order to achieve a particular
3214 security goal, there exist ``encryption schemes'' and ``signature
3215 schemes''.  Encoding methods can be used seperately or implicitly
3216 through schemes.
3217
3218 What follows is a description of the cryptographic primitives.
3219
3220 @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})
3221 Encrypts the plain text MPI value @var{data_plain} with the key public
3222 @var{key} under the control of the flags @var{flags} and stores the
3223 resulting data set into @var{data_encrypted}.
3224 @end deftypefun
3225
3226 @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})
3227 Decrypts the encrypted data contained in the data set
3228 @var{data_encrypted} with the secret key KEY under the control of the
3229 flags @var{flags} and stores the resulting plain text MPI value in
3230 @var{DATA_PLAIN}.
3231 @end deftypefun
3232
3233 @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})
3234 Signs the data contained in @var{data} with the secret key @var{key}
3235 and stores the resulting signature in the data set
3236 @var{data_signature}.
3237 @end deftypefun
3238
3239 @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})
3240 Verifies that the signature contained in the data set
3241 @var{data_signature} is indeed the result of signing the data
3242 contained in @var{data} with the secret key belonging to the public
3243 key @var{key}.
3244 @end deftypefun
3245
3246 What follows is a description of the high-level functions.
3247
3248 The type ``gcry_ac_em_t'' is used for specifying encoding methods; the
3249 following methods are supported:
3250
3251 @table @code
3252 @item GCRY_AC_EME_PKCS_V1_5
3253 PKCS-V1_5 Encoding Method for Encryption.  Options must be provided
3254 through a pointer to a correctly initialized object of type
3255 gcry_ac_eme_pkcs_v1_5_t.
3256
3257 @item GCRY_AC_EMSA_PKCS_V1_5
3258 PKCS-V1_5 Encoding Method for Signatures with Appendix.  Options must
3259 be provided through a pointer to a correctly initialized object of
3260 type gcry_ac_emsa_pkcs_v1_5_t.
3261 @end table
3262
3263 Option structure types:
3264
3265 @table @code
3266 @item gcry_ac_eme_pkcs_v1_5_t
3267 @table @code
3268 @item gcry_ac_key_t key
3269 @item gcry_ac_handle_t handle
3270 @end table
3271 @item gcry_ac_emsa_pkcs_v1_5_t
3272 @table @code
3273 @item gcry_md_algo_t md
3274 @item size_t em_n
3275 @end table
3276 @end table
3277
3278 Encoding methods can be used directly through the following functions:
3279
3280 @deftypefun gcry_error_t gcry_ac_data_encode (gcry_ac_em_t @var{method}, unsigned int @var{flags}, void *@var{options}, unsigned char *@var{m}, size_t @var{m_n}, unsigned char **@var{em}, size_t *@var{em_n})
3281 Encodes the message contained in @var{m} of size @var{m_n} according
3282 to @var{method}, @var{flags} and @var{options}.  The newly created
3283 encoded message is stored in @var{em} and @var{em_n}.
3284 @end deftypefun
3285
3286 @deftypefun gcry_error_t gcry_ac_data_decode (gcry_ac_em_t @var{method}, unsigned int @var{flags}, void *@var{options}, unsigned char *@var{em}, size_t @var{em_n}, unsigned char **@var{m}, size_t *@var{m_n})
3287 Decodes the message contained in @var{em} of size @var{em_n} according
3288 to @var{method}, @var{flags} and @var{options}.  The newly created
3289 decoded message is stored in @var{m} and @var{m_n}.
3290 @end deftypefun
3291
3292 The type ``gcry_ac_scheme_t'' is used for specifying schemes; the
3293 following schemes are supported:
3294
3295 @table @code
3296 @item GCRY_AC_ES_PKCS_V1_5
3297 PKCS-V1_5 Encryption Scheme.  No options can be provided.
3298 @item GCRY_AC_SSA_PKCS_V1_5
3299 PKCS-V1_5 Signature Scheme (with Appendix).  Options can be provided
3300 through a pointer to a correctly initialized object of type
3301 gcry_ac_ssa_pkcs_v1_5_t.
3302 @end table
3303
3304 Option structure types:
3305
3306 @table @code
3307 @item gcry_ac_ssa_pkcs_v1_5_t
3308 @table @code
3309 @item gcry_md_algo_t md
3310 @end table
3311 @end table
3312
3313 The functions implementing schemes:
3314
3315 @deftypefun gcry_error_t gcry_ac_data_encrypt_scheme (gcry_ac_handle_t @var{handle}, gcry_ac_scheme_t @var{scheme}, unsigned int @var{flags}, void *@var{opts}, gcry_ac_key_t @var{key}, gcry_ac_io_t *@var{io_message}, gcry_ac_io_t *@var{io_cipher})
3316 Encrypts the plain text readable from @var{io_message} through
3317 @var{handle} with the public key @var{key} according to @var{scheme},
3318 @var{flags} and @var{opts}.  If @var{opts} is not NULL, it has to be a
3319 pointer to a structure specific to the chosen scheme (gcry_ac_es_*_t).
3320 The encrypted message is written to @var{io_cipher}.
3321 @end deftypefun
3322
3323 @deftypefun gcry_error_t gcry_ac_data_decrypt_scheme (gcry_ac_handle_t @var{handle}, gcry_ac_scheme_t @var{scheme}, unsigned int @var{flags}, void *@var{opts}, gcry_ac_key_t @var{key}, gcry_ac_io_t *@var{io_cipher}, gcry_ac_io_t *@var{io_message})
3324 Decrypts the cipher text readable from @var{io_cipher} through
3325 @var{handle} with the secret key @var{key} according to @var{scheme},
3326 @var{flags} and @var{opts}.  If @var{opts} is not NULL, it has to be a
3327 pointer to a structure specific to the chosen scheme (gcry_ac_es_*_t).
3328 The decrypted message is written to @var{io_message}.
3329 @end deftypefun
3330
3331 @deftypefun gcry_error_t gcry_ac_data_sign_scheme (gcry_ac_handle_t @var{handle}, gcry_ac_scheme_t @var{scheme}, unsigned int @var{flags}, void *@var{opts}, gcry_ac_key_t @var{key}, gcry_ac_io_t *@var{io_message}, gcry_ac_io_t *@var{io_signature})
3332 Signs the message readable from @var{io_message} through @var{handle}
3333 with the secret key @var{key} according to @var{scheme}, @var{flags}
3334 and @var{opts}.  If @var{opts} is not NULL, it has to be a pointer to
3335 a structure specific to the chosen scheme (gcry_ac_ssa_*_t).  The
3336 signature is written to @var{io_signature}.
3337 @end deftypefun
3338
3339 @deftypefun gcry_error_t gcry_ac_data_verify_scheme (gcry_ac_handle_t @var{handle}, gcry_ac_scheme_t @var{scheme}, unsigned int @var{flags}, void *@var{opts}, gcry_ac_key_t @var{key}, gcry_ac_io_t *@var{io_message}, gcry_ac_io_t *@var{io_signature})
3340 Verifies through @var{handle} that the signature readable from
3341 @var{io_signature} is indeed the result of signing the message
3342 readable from @var{io_message} with the secret key belonging to the
3343 public key @var{key} according to @var{scheme} and @var{opts}.  If
3344 @var{opts} is not NULL, it has to be an anonymous structure
3345 (gcry_ac_ssa_*_t) specific to the chosen scheme.
3346 @end deftypefun
3347
3348 @node Handle-independent functions
3349 @subsection Handle-independent functions
3350
3351 These two functions are deprecated; do not use them for new code.
3352
3353 @deftypefun gcry_error_t gcry_ac_id_to_name (gcry_ac_id_t @var{algorithm}, const char **@var{name})
3354 Stores the textual representation of the algorithm whose id is given
3355 in @var{algorithm} in @var{name}.  Deprecated; use @code{gcry_pk_algo_name}.
3356 @end deftypefun
3357
3358 @deftypefun gcry_error_t gcry_ac_name_to_id (const char *@var{name}, gcry_ac_id_t *@var{algorithm})
3359 Stores the numeric ID of the algorithm whose textual representation is
3360 contained in @var{name} in @var{algorithm}. Deprecated; use
3361 @code{gcry_pk_map_name}.
3362 @end deftypefun
3363
3364 @c **********************************************************
3365 @c *******************  Hash Functions  *********************
3366 @c **********************************************************
3367 @node Hashing
3368 @chapter Hashing
3369
3370 Libgcrypt provides an easy and consistent to use interface for hashing.
3371 Hashing is buffered and several hash algorithms can be updated at once.
3372 It is possible to compute a MAC using the same routines.  The
3373 programming model follows an open/process/close paradigm and is in that
3374 similar to other building blocks provided by Libgcrypt.
3375
3376 For convenience reasons, a few cyclic redundancy check value operations
3377 are also supported.
3378
3379 @menu
3380 * Available hash algorithms::   List of hash algorithms supported by the library.
3381 * Hash algorithm modules::      How to work with hash algorithm modules.
3382 * Working with hash algorithms::  List of functions related to hashing.
3383 @end menu
3384
3385 @node Available hash algorithms
3386 @section Available hash algorithms
3387
3388 @c begin table of hash algorithms
3389 @cindex SHA-1
3390 @cindex SHA-224, SHA-256, SHA-384, SHA-512
3391 @cindex RIPE-MD-160
3392 @cindex MD2, MD4, MD5
3393 @cindex TIGER
3394 @cindex HAVAL
3395 @cindex Whirlpool
3396 @cindex CRC32
3397 @table @code
3398 @item GCRY_MD_NONE
3399 This is not a real algorithm but used by some functions as an error
3400 return value.  This constant is guaranteed to have the value @code{0}.
3401
3402 @item GCRY_MD_SHA1
3403 This is the SHA-1 algorithm which yields a message digest of 20 bytes.
3404
3405 @item GCRY_MD_RMD160
3406 This is the 160 bit version of the RIPE message digest (RIPE-MD-160).
3407 Like SHA-1 it also yields a digest of 20 bytes.
3408
3409 @item GCRY_MD_MD5
3410 This is the well known MD5 algorithm, which yields a message digest of
3411 16 bytes. 
3412
3413 @item GCRY_MD_MD4
3414 This is the MD4 algorithm, which yields a message digest of 16 bytes.
3415
3416 @item GCRY_MD_MD2
3417 This is an reserved identifier for MD-2; there is no implementation yet.
3418
3419 @item GCRY_MD_TIGER
3420 This is the TIGER/192 algorithm which yields a message digest of 24 bytes.
3421
3422 @item GCRY_MD_HAVAL
3423 This is an reserved for the HAVAL algorithm with 5 passes and 160
3424 bit. It yields a message digest of 20 bytes.  Note that there is no
3425 implementation yet available.
3426
3427 @item GCRY_MD_SHA224
3428 This is the SHA-224 algorithm which yields a message digest of 28 bytes.
3429 See Change Notice 1 for FIPS 180-2 for the specification.
3430
3431 @item GCRY_MD_SHA256
3432 This is the SHA-256 algorithm which yields a message digest of 32 bytes.
3433 See FIPS 180-2 for the specification.
3434
3435 @item GCRY_MD_SHA384
3436 This is the SHA-384 algorithm which yields a message digest of 48 bytes.
3437 See FIPS 180-2 for the specification.
3438
3439 @item GCRY_MD_SHA512
3440 This is the SHA-384 algorithm which yields a message digest of 64 bytes.
3441 See FIPS 180-2 for the specification.
3442
3443 @item GCRY_MD_CRC32
3444 This is the ISO 3309 and ITU-T V.42 cyclic redundancy check.  It
3445 yields an output of 4 bytes.
3446
3447 @item GCRY_MD_CRC32_RFC1510
3448 This is the above cyclic redundancy check function, as modified by RFC
3449 1510.  It yields an output of 4 bytes.
3450
3451 @item GCRY_MD_CRC24_RFC2440
3452 This is the OpenPGP cyclic redundancy check function.  It yields an
3453 output of 3 bytes.
3454
3455 @item GCRY_MD_WHIRLPOOL
3456 This is the Whirlpool algorithm which yields a message digest of 64
3457 bytes.
3458
3459 @end table
3460 @c end table of hash algorithms
3461
3462 @node Hash algorithm modules
3463 @section Hash algorithm modules
3464
3465 Libgcrypt makes it possible to load additional `message
3466 digest modules'; these digests can be used just like the message digest
3467 algorithms that are built into the library directly.  For an
3468 introduction into extension modules, see @xref{Modules}.
3469
3470 @deftp {Data type} gcry_md_spec_t
3471 This is the `module specification structure' needed for registering
3472 message digest modules, which has to be filled in by the user before
3473 it can be used to register a module.  It contains the following
3474 members:
3475
3476 @table @code
3477 @item const char *name
3478 The primary name of this algorithm.
3479 @item unsigned char *asnoid
3480 Array of bytes that form the ASN OID.
3481 @item int asnlen
3482 Length of bytes in `asnoid'.
3483 @item gcry_md_oid_spec_t *oids
3484 A list of OIDs that are to be associated with the algorithm.  The
3485 list's last element must have it's `oid' member set to NULL.  See
3486 below for an explanation of this type.  See below for an explanation
3487 of this type.
3488 @item int mdlen
3489 Length of the message digest algorithm.  See below for an explanation
3490 of this type.
3491 @item gcry_md_init_t init
3492 The function responsible for initializing a handle.  See below for an
3493 explanation of this type.
3494 @item gcry_md_write_t write
3495 The function responsible for writing data into a message digest
3496 context.  See below for an explanation of this type.
3497 @item gcry_md_final_t final
3498 The function responsible for `finalizing' a message digest context.
3499 See below for an explanation of this type.
3500 @item gcry_md_read_t read
3501 The function responsible for reading out a message digest result.  See
3502 below for an explanation of this type.
3503 @item size_t contextsize
3504 The size of the algorithm-specific `context', that should be
3505 allocated for each handle.
3506 @end table
3507 @end deftp
3508
3509 @deftp {Data type} gcry_md_oid_spec_t
3510 This type is used for associating a user-provided algorithm
3511 implementation with certain OIDs.  It contains the following members:
3512
3513 @table @code
3514 @item const char *oidstring
3515 Textual representation of the OID.
3516 @end table
3517 @end deftp
3518
3519 @deftp {Data type} gcry_md_init_t
3520 Type for the `init' function, defined as: void (*gcry_md_init_t) (void
3521 *c)
3522 @end deftp
3523
3524 @deftp {Data type} gcry_md_write_t
3525 Type for the `write' function, defined as: void (*gcry_md_write_t)
3526 (void *c, unsigned char *buf, size_t nbytes)
3527 @end deftp
3528
3529 @deftp {Data type} gcry_md_final_t
3530 Type for the `final' function, defined as: void (*gcry_md_final_t)
3531 (void *c)
3532 @end deftp
3533
3534 @deftp {Data type} gcry_md_read_t
3535 Type for the `read' function, defined as: unsigned char
3536 *(*gcry_md_read_t) (void *c)
3537 @end deftp
3538
3539 @deftypefun gcry_error_t gcry_md_register (gcry_md_spec_t *@var{digest}, unsigned int *algorithm_id, gcry_module_t *@var{module})
3540
3541 Register a new digest module whose specification can be found in
3542 @var{digest}.  On success, a new algorithm ID is stored in
3543 @var{algorithm_id} and a pointer representing this module is stored
3544 in @var{module}.
3545 @end deftypefun
3546
3547 @deftypefun void gcry_md_unregister (gcry_module_t @var{module})
3548 Unregister the digest identified by @var{module}, which must have been
3549 registered with gcry_md_register.
3550 @end deftypefun
3551
3552 @deftypefun gcry_error_t gcry_md_list (int *@var{list}, int *@var{list_length})
3553 Get a list consisting of the IDs of the loaded message digest modules.
3554 If @var{list} is zero, write the number of loaded message digest
3555 modules to @var{list_length} and return.  If @var{list} is non-zero,
3556 the first *@var{list_length} algorithm IDs are stored in @var{list},
3557 which must be of according size.  In case there are less message
3558 digests modules than *@var{list_length}, *@var{list_length} is updated
3559 to the correct number.
3560 @end deftypefun
3561
3562 @node Working with hash algorithms
3563 @section Working with hash algorithms
3564
3565 To use most of these function it is necessary to create a context;
3566 this is done using:
3567
3568 @deftypefun gcry_error_t gcry_md_open (gcry_md_hd_t *@var{hd}, int @var{algo}, unsigned int @var{flags})
3569
3570 Create a message digest object for algorithm @var{algo}.  @var{flags}
3571 may be given as an bitwise OR of constants described below.  @var{algo}
3572 may be given as @code{0} if the algorithms to use are later set using
3573 @code{gcry_md_enable}. @var{hd} is guaranteed to either receive a valid
3574 handle or NULL.
3575
3576 For a list of supported algorithms, see @xref{Available hash
3577 algorithms}.
3578
3579 The flags allowed for @var{mode} are:
3580
3581 @c begin table of hash flags
3582 @table @code
3583 @item GCRY_MD_FLAG_SECURE
3584 Allocate all buffers and the resulting digest in "secure memory".  Use
3585 this is the hashed data is highly confidential.
3586
3587 @item GCRY_MD_FLAG_HMAC
3588 @cindex HMAC
3589 Turn the algorithm into a HMAC message authentication algorithm.  This
3590 only works if just one algorithm is enabled for the handle.  Note that
3591 the function @code{gcry_md_setkey} must be used to set the MAC key.
3592 The size of the MAC is equal to the message digest of the underlying
3593 hash algorithm.  If you want CBC message authentication codes based on
3594 a cipher, see @xref{Working with cipher handles}.
3595
3596 @end table
3597 @c begin table of hash flags
3598
3599 You may use the function @code{gcry_md_is_enabled} to later check
3600 whether an algorithm has been enabled.
3601
3602 @end deftypefun
3603 @c end function gcry_md_open
3604
3605 If you want to calculate several hash algorithms at the same time, you
3606 have to use the following function right after the @code{gcry_md_open}:
3607
3608 @deftypefun gcry_error_t gcry_md_enable (gcry_md_hd_t @var{h}, int @var{algo})
3609
3610 Add the message digest algorithm @var{algo} to the digest object
3611 described by handle @var{h}.  Duplicated enabling of algorithms is
3612 detected and ignored.
3613 @end deftypefun
3614
3615 If the flag @code{GCRY_MD_FLAG_HMAC} was used, the key for the MAC must
3616 be set using the function:
3617
3618 @deftypefun gcry_error_t gcry_md_setkey (gcry_md_hd_t @var{h}, const void *@var{key}, size_t @var{keylen})
3619
3620 For use with the HMAC feature, set the MAC key to the value of @var{key}
3621 of length @var{keylen}.  There is no restriction on the length of the key.
3622 @end deftypefun
3623
3624
3625 After you are done with the hash calculation, you should release the
3626 resources by using:
3627
3628 @deftypefun void gcry_md_close (gcry_md_hd_t @var{h})
3629
3630 Release all resources of hash context @var{h}.  @var{h} should not be
3631 used after a call to this function.  A @code{NULL} passed as @var{h} is
3632 ignored.
3633
3634 @end deftypefun
3635
3636 Often you have to do several hash operations using the same algorithm.
3637 To avoid the overhead of creating and releasing context, a reset function
3638 is provided:
3639
3640 @deftypefun void gcry_md_reset (gcry_md_hd_t @var{h})
3641
3642 Reset the current context to its initial state.  This is effectively
3643 identical to a close followed by an open and enabling all currently
3644 active algorithms.
3645 @end deftypefun
3646
3647
3648 Often it is necessary to start hashing some data and then continue to
3649 hash different data.  To avoid hashing the same data several times (which
3650 might not even be possible if the data is received from a pipe), a
3651 snapshot of the current hash context can be taken and turned into a new
3652 context:
3653
3654 @deftypefun gcry_error_t gcry_md_copy (gcry_md_hd_t *@var{handle_dst}, gcry_md_hd_t @var{handle_src})
3655
3656 Create a new digest object as an exact copy of the object described by
3657 handle @var{handle_src} and store it in @var{handle_dst}.  The context
3658 is not reset and you can continue to hash data using this context and
3659 independently using the original context.
3660 @end deftypefun
3661
3662
3663 Now that we have prepared everything to calculate hashes, it is time to
3664 see how it is actually done.  There are two ways for this, one to
3665 update the hash with a block of memory and one macro to update the hash
3666 by just one character.  Both methods can be used on the same hash context.
3667
3668 @deftypefun void gcry_md_write (gcry_md_hd_t @var{h}, const void *@var{buffer}, size_t @var{length})
3669
3670 Pass @var{length} bytes of the data in @var{buffer} to the digest object
3671 with handle @var{h} to update the digest values. This
3672 function should be used for large blocks of data.
3673 @end deftypefun
3674
3675 @deftypefun void gcry_md_putc (gcry_md_hd_t @var{h}, int @var{c})
3676
3677 Pass the byte in @var{c} to the digest object with handle @var{h} to
3678 update the digest value.  This is an efficient function, implemented as
3679 a macro to buffer the data before an actual update. 
3680 @end deftypefun
3681
3682 The semantics of the hash functions do not provide for reading out intermediate
3683 message digests because the calculation must be finalized first.  This
3684 finalization may for example include the number of bytes hashed in the
3685 message digest or some padding.
3686
3687 @deftypefun void gcry_md_final (gcry_md_hd_t @var{h})
3688
3689 Finalize the message digest calculation.  This is not really needed
3690 because @code{gcry_md_read} does this implicitly.  After this has been
3691 done no further updates (by means of @code{gcry_md_write} or
3692 @code{gcry_md_putc} are allowed.  Only the first call to this function
3693 has an effect. It is implemented as a macro.
3694 @end deftypefun
3695
3696 The way to read out the calculated message digest is by using the
3697 function:
3698
3699 @deftypefun {unsigned char *} gcry_md_read (gcry_md_hd_t @var{h}, int @var{algo})
3700
3701 @code{gcry_md_read} returns the message digest after finalizing the
3702 calculation.  This function may be used as often as required but it will
3703 always return the same value for one handle.  The returned message digest
3704 is allocated within the message context and therefore valid until the
3705 handle is released or reseted (using @code{gcry_md_close} or
3706 @code{gcry_md_reset}.  @var{algo} may be given as 0 to return the only
3707 enabled message digest or it may specify one of the enabled algorithms.
3708 The function does return @code{NULL} if the requested algorithm has not
3709 been enabled.
3710 @end deftypefun
3711
3712 Because it is often necessary to get the message digest of one block of
3713 memory, a fast convenience function is available for this task: 
3714
3715 @deftypefun void gcry_md_hash_buffer (int @var{algo}, void *@var{digest}, const void *@var{buffer}, size_t @var{length});
3716
3717 @code{gcry_md_hash_buffer} is a shortcut function to calculate a message
3718 digest of a buffer.  This function does not require a context and
3719 immediately returns the message digest of the @var{length} bytes at
3720 @var{buffer}.  @var{digest} must be allocated by the caller, large
3721 enough to hold the message digest yielded by the the specified algorithm
3722 @var{algo}.  This required size may be obtained by using the function
3723 @code{gcry_md_get_algo_dlen}.
3724
3725 Note that this function will abort the process if an unavailable
3726 algorithm is used.
3727 @end deftypefun
3728
3729 @c ***********************************
3730 @c ***** MD info functions ***********
3731 @c ***********************************
3732
3733 Hash algorithms are identified by internal algorithm numbers (see
3734 @code{gcry_md_open} for a list).  However, in most applications they are
3735 used by names, so two functions are available to map between string
3736 representations and hash algorithm identifiers.
3737
3738 @deftypefun {const char *} gcry_md_algo_name (int @var{algo})
3739
3740 Map the digest algorithm id @var{algo} to a string representation of the
3741 algorithm name.  For unknown algorithms this function returns the
3742 string @code{"?"}.  This function should not be used to test for the
3743 availability of an algorithm.
3744 @end deftypefun
3745
3746 @deftypefun int gcry_md_map_name (const char *@var{name})
3747
3748 Map the algorithm with @var{name} to a digest algorithm identifier.
3749 Returns 0 if the algorithm name is not known.  Names representing
3750 @acronym{ASN.1} object identifiers are recognized if the @acronym{IETF}
3751 dotted format is used and the OID is prefixed with either "@code{oid.}"
3752 or "@code{OID.}".  For a list of supported OIDs, see the source code at
3753 @file{cipher/md.c}. This function should not be used to test for the
3754 availability of an algorithm.
3755 @end deftypefun
3756
3757 @deftypefun gcry_error_t gcry_md_get_asnoid (int @var{algo}, void *@var{buffer}, size_t *@var{length})
3758
3759 Return an DER encoded ASN.1 OID for the algorithm @var{algo} in the
3760 user allocated @var{buffer}. @var{length} must point to variable with
3761 the available size of @var{buffer} and receives after return the
3762 actual size of the returned OID.  The returned error code may be
3763 @code{GPG_ERR_TOO_SHORT} if the provided buffer is to short to receive
3764 the OID; it is possible to call the function with @code{NULL} for
3765 @var{buffer} to have it only return the required size.  The function
3766 returns 0 on success.
3767
3768 @end deftypefun
3769
3770
3771 To test whether an algorithm is actually available for use, the
3772 following macro should be used:
3773
3774 @deftypefun gcry_error_t gcry_md_test_algo (int @var{algo}) 
3775
3776 The macro returns 0 if the algorithm @var{algo} is available for use.
3777 @end deftypefun
3778
3779 If the length of a message digest is not known, it can be retrieved
3780 using the following function:
3781
3782 @deftypefun {unsigned int} gcry_md_get_algo_dlen (int @var{algo})
3783
3784 Retrieve the length in bytes of the digest yielded by algorithm
3785 @var{algo}.  This is often used prior to @code{gcry_md_read} to allocate
3786 sufficient memory for the digest.
3787 @end deftypefun
3788
3789
3790 In some situations it might be hard to remember the algorithm used for
3791 the ongoing hashing. The following function might be used to get that
3792 information:
3793
3794 @deftypefun int gcry_md_get_algo (gcry_md_hd_t @var{h})
3795
3796 Retrieve the algorithm used with the handle @var{h}.  Note that this
3797 does not work reliable if more than one algorithm is enabled in @var{h}.
3798 @end deftypefun
3799
3800 The following macro might also be useful:
3801
3802 @deftypefun int gcry_md_is_secure (gcry_md_hd_t @var{h})
3803
3804 This function returns true when the digest object @var{h} is allocated
3805 in "secure memory"; i.e. @var{h} was created with the
3806 @code{GCRY_MD_FLAG_SECURE}.
3807 @end deftypefun
3808
3809 @deftypefun int gcry_md_is_enabled (gcry_md_hd_t @var{h}, int @var{algo})
3810
3811 This function returns true when the algorithm @var{algo} has been
3812 enabled for the digest object @var{h}.
3813 @end deftypefun
3814
3815
3816
3817 Tracking bugs related to hashing is often a cumbersome task which
3818 requires to add a lot of printf statements into the code.
3819 Libgcrypt provides an easy way to avoid this.  The actual data
3820 hashed can be written to files on request.
3821
3822 @deftypefun void gcry_md_debug (gcry_md_hd_t @var{h}, const char *@var{suffix})
3823
3824 Enable debugging for the digest object with handle @var{h}.  This
3825 creates create files named @file{dbgmd-<n>.<string>} while doing the
3826 actual hashing.  @var{suffix} is the string part in the filename.  The
3827 number is a counter incremented for each new hashing.  The data in the
3828 file is the raw data as passed to @code{gcry_md_write} or
3829 @code{gcry_md_putc}.  If @code{NULL} is used for @var{suffix}, the
3830 debugging is stopped and the file closed.  This is only rarely required
3831 because @code{gcry_md_close} implicitly stops debugging.
3832 @end deftypefun
3833
3834
3835 The following two deprecated macros are used for debugging by old code.
3836 They shopuld be replaced by @code{gcry_md_debug}.
3837
3838 @deftypefun void gcry_md_start_debug (gcry_md_hd_t @var{h}, const char *@var{suffix})
3839
3840 Enable debugging for the digest object with handle @var{h}.  This
3841 creates create files named @file{dbgmd-<n>.<string>} while doing the
3842 actual hashing.  @var{suffix} is the string part in the filename.  The
3843 number is a counter incremented for each new hashing.  The data in the
3844 file is the raw data as passed to @code{gcry_md_write} or
3845 @code{gcry_md_putc}.
3846 @end deftypefun
3847
3848
3849 @deftypefun void gcry_md_stop_debug (gcry_md_hd_t @var{h}, int @var{reserved})
3850
3851 Stop debugging on handle @var{h}.  @var{reserved} should be specified as
3852 0.  This function is usually not required because @code{gcry_md_close}
3853 does implicitly stop debugging.
3854 @end deftypefun
3855
3856
3857 @c **********************************************************
3858 @c *******************  Random  *****************************
3859 @c **********************************************************
3860 @node Random Numbers
3861 @chapter Random Numbers
3862
3863 @menu
3864 * Quality of random numbers::   Libgcrypt uses different quality levels.
3865 * Retrieving random numbers::   How to retrieve random numbers.
3866 @end menu
3867
3868 @node Quality of random numbers
3869 @section Quality of random numbers
3870
3871 @acronym{Libgcypt} offers random numbers of different quality levels:
3872
3873 @deftp {Data type} gcry_random_level_t
3874 The constants for the random quality levels are of this enum type.
3875 @end deftp
3876
3877 @table @code
3878 @item GCRY_WEAK_RANDOM
3879 For all functions, except for @code{gcry_mpi_randomize}, this level maps
3880 to GCRY_STRONG_RANDOM.  If you do not want this, consider using
3881 @code{gcry_create_nonce}.
3882 @item GCRY_STRONG_RANDOM
3883 Use this level for session keys and similar purposes.
3884 @item GCRY_VERY_STRONG_RANDOM
3885 Use this level for long term key material.
3886 @end table
3887
3888 @node Retrieving random numbers
3889 @section Retrieving random numbers
3890
3891 @deftypefun void gcry_randomize (unsigned char *@var{buffer}, size_t @var{length}, enum gcry_random_level @var{level})
3892
3893 Fill @var{buffer} with @var{length} random bytes using a random quality
3894 as defined by @var{level}.
3895 @end deftypefun
3896
3897 @deftypefun {void *} gcry_random_bytes (size_t @var{nbytes}, enum gcry_random_level @var{level})
3898
3899 Convenience function to allocate a memory block consisting of
3900 @var{nbytes} fresh random bytes using a random quality as defined by
3901 @var{level}.
3902 @end deftypefun
3903
3904 @deftypefun {void *} gcry_random_bytes_secure (size_t @var{nbytes}, enum gcry_random_level @var{level})
3905
3906 Convenience function to allocate a memory block consisting of
3907 @var{nbytes} fresh random bytes using a random quality as defined by
3908 @var{level}.  This function differs from @code{gcry_random_bytes} in
3909 that the returned buffer is allocated in a ``secure'' area of the
3910 memory.
3911 @end deftypefun
3912
3913 @deftypefun void gcry_create_nonce (unsigned char *@var{buffer}, size_t @var{length})
3914
3915 Fill @var{buffer} with @var{length} unpredictable bytes.  This is
3916 commonly called a nonce and may also be used for initialization
3917 vectors and padding.  This is an extra function nearly independent of
3918 the other random function for 3 reasons: It better protects the
3919 regular random generator's internal state, provides better performance
3920 and does not drain the precious entropy pool.
3921
3922 @end deftypefun
3923
3924
3925
3926 @c **********************************************************
3927 @c *******************  S-Expressions ***********************
3928 @c **********************************************************
3929 @node S-expressions
3930 @chapter S-expressions
3931
3932 S-expressions are used by the public key functions to pass complex data
3933 structures around.  These LISP like objects are used by some
3934 cryptographic protocols (cf. RFC-2692) and Libgcrypt provides functions
3935 to parse and construct them.  For detailed information, see
3936 @cite{Ron Rivest, code and description of S-expressions,
3937 @uref{http://theory.lcs.mit.edu/~rivest/sexp.html}}.
3938
3939 @menu
3940 * Data types for S-expressions::  Data types related with S-expressions.
3941 * Working with S-expressions::  How to work with S-expressions.
3942 @end menu
3943
3944 @node Data types for S-expressions
3945 @section Data types for S-expressions
3946
3947 @deftp {Data type} gcry_sexp_t
3948 The @code{gcry_sexp_t} type describes an object with the Libgcrypt internal
3949 representation of an S-expression.
3950 @end deftp
3951
3952 @node Working with S-expressions
3953 @section Working with S-expressions
3954
3955 @noindent
3956 There are several functions to create an Libgcrypt S-expression object
3957 from its external representation or from a string template.  There is
3958 also a function to convert the internal representation back into one of
3959 the external formats:
3960
3961
3962 @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}})
3963
3964 This is the generic function to create an new S-expression object from
3965 its external representation in @var{buffer} of @var{length} bytes.  On
3966 success the result is stored at the address given by @var{r_sexp}. 
3967 With @var{autodetect} set to 0, the data in @var{buffer} is expected to
3968 be in canonized format, with @var{autodetect} set to 1 the parses any of
3969 the defined external formats.  If @var{buffer} does not hold a valid
3970 S-expression an error code is returned and @var{r_sexp} set to
3971 @code{NULL}.
3972 Note that the caller is responsible for releasing the newly allocated
3973 S-expression using @code{gcry_sexp_release}.
3974 @end deftypefun
3975
3976 @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*)})
3977
3978 This function is identical to @code{gcry_sexp_new} but has an extra
3979 argument @var{freefnc}, which, when not set to @code{NULL}, is expected
3980 to be a function to release the @var{buffer}; most likely the standard
3981 @code{free} function is used for this argument.  This has the effect of
3982 transferring the ownership of @var{buffer} to the created object in
3983 @var{r_sexp}.  The advantage of using this function is that Libgcrypt
3984 might decide to directly use the provided buffer and thus avoid extra
3985 copying.
3986 @end deftypefun
3987
3988 @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}})
3989
3990 This is another variant of the above functions.  It behaves nearly
3991 identical but provides an @var{erroff} argument which will receive the
3992 offset into the buffer where the parsing stopped on error.
3993 @end deftypefun
3994
3995 @deftypefun gcry_error_t gcry_sexp_build (@w{gcry_sexp_t *@var{r_sexp}}, @w{size_t *@var{erroff}}, @w{const char *@var{format}, ...})
3996
3997 This function creates an internal S-expression from the string template
3998 @var{format} and stores it at the address of @var{r_sexp}. If there is a
3999 parsing error, the function returns an appropriate error code and stores
4000 the offset into @var{format} where the parsing stopped in @var{erroff}.
4001 The function supports a couple of printf-like formatting characters and
4002 expects arguments for some of these escape sequences right after
4003 @var{format}.  The following format characters are defined:
4004
4005 @table @samp
4006 @item %m
4007 The next argument is expected to be of type @code{gcry_mpi_t} and a copy of
4008 its value is inserted into the resulting S-expression.
4009 @item %s
4010 The next argument is expected to be of type @code{char *} and that
4011 string is inserted into the resulting S-expression.
4012 @item %d
4013 The next argument is expected to be of type @code{int} and its value is
4014 inserted into the resulting S-expression.
4015 @item %b
4016 The next argument is expected to be of type @code{int} directly
4017 followed by an argument of type @code{char *}.  This represents a
4018 buffer of given length to be inserted into the resulting regular
4019 expression.
4020 @end table
4021
4022 @noindent
4023 No other format characters are defined and would return an error.  Note
4024 that the format character @samp{%%} does not exists, because a percent
4025 sign is not a valid character in an S-expression.
4026 @end deftypefun
4027
4028 @deftypefun void gcry_sexp_release (@w{gcry_sexp_t @var{sexp}})
4029
4030 Release the S-expression object @var{sexp}.
4031 @end deftypefun
4032
4033
4034 @noindent
4035 The next 2 functions are used to convert the internal representation
4036 back into a regular external S-expression format and to show the
4037 structure for debugging.
4038
4039 @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}})
4040
4041 Copies the S-expression object @var{sexp} into @var{buffer} using the
4042 format specified in @var{mode}.  @var{maxlength} must be set to the
4043 allocated length of @var{buffer}.  The function returns the actual
4044 length of valid bytes put into @var{buffer} or 0 if the provided buffer
4045 is too short.  Passing @code{NULL} for @var{buffer} returns the required
4046 length for @var{buffer}.  For convenience reasons an extra byte with
4047 value 0 is appended to the buffer.
4048
4049 @noindent
4050 The following formats are supported:
4051
4052 @table @code
4053 @item GCRYSEXP_FMT_DEFAULT
4054 Returns a convenient external S-expression representation.
4055
4056 @item GCRYSEXP_FMT_CANON
4057 Return the S-expression in canonical format.
4058
4059 @item GCRYSEXP_FMT_BASE64
4060 Not currently supported.
4061
4062 @item GCRYSEXP_FMT_ADVANCED
4063 Returns the S-expression in advanced format.
4064 @end table
4065 @end deftypefun
4066
4067 @deftypefun void gcry_sexp_dump (@w{gcry_sexp_t @var{sexp}})
4068
4069 Dumps @var{sexp} in a format suitable for debugging to Libgcrypt's
4070 logging stream.
4071 @end deftypefun
4072
4073 @noindent
4074 Often canonical encoding is used in the external representation.  The
4075 following function can be used to check for valid encoding and to learn
4076 the length of the S-expression"
4077
4078 @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}})
4079
4080 Scan the canonical encoded @var{buffer} with implicit length values and
4081 return the actual length this S-expression uses.  For a valid S-expression
4082 it should never return 0.  If @var{length} is not 0, the maximum
4083 length to scan is given; this can be used for syntax checks of
4084 data passed from outside.  @var{errcode} and @var{erroff} may both be
4085 passed as @code{NULL}.
4086
4087 @end deftypefun
4088
4089
4090 @noindent
4091 There are a couple of functions to parse S-expressions and retrieve
4092 elements:
4093
4094 @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}})
4095
4096 Scan the S-expression for a sublist with a type (the car of the list)
4097 matching the string @var{token}.  If @var{toklen} is not 0, the token is
4098 assumed to be raw memory of this length.  The function returns a newly
4099 allocated S-expression consisting of the found sublist or @code{NULL}
4100 when not found.
4101 @end deftypefun
4102
4103
4104 @deftypefun int gcry_sexp_length (@w{const gcry_sexp_t @var{list}})
4105
4106 Return the length of the @var{list}.  For a valid S-expression this
4107 should be at least 1.
4108 @end deftypefun
4109
4110
4111 @deftypefun gcry_sexp_t gcry_sexp_nth (@w{const gcry_sexp_t @var{list}}, @w{int @var{number}})
4112
4113 Create and return a new S-expression from the element with index @var{number} in
4114 @var{list}.  Note that the first element has the index 0.  If there is
4115 no such element, @code{NULL} is returned.
4116 @end deftypefun
4117
4118 @deftypefun gcry_sexp_t gcry_sexp_car (@w{const gcry_sexp_t @var{list}})
4119
4120 Create and return a new S-expression from the first element in
4121 @var{list}; this called the "type" and should always exist and be a
4122 string. @code{NULL} is returned in case of a problem.
4123 @end deftypefun
4124
4125 @deftypefun gcry_sexp_t gcry_sexp_cdr (@w{const gcry_sexp_t @var{list}})
4126
4127 Create and return a new list form all elements except for the first one.
4128 Note that this function may return an invalid S-expression because it
4129 is not guaranteed, that the type exists and is a string.  However, for
4130 parsing a complex S-expression it might be useful for intermediate
4131 lists.  Returns @code{NULL} on error.
4132 @end deftypefun
4133
4134
4135 @deftypefun {const char *} gcry_sexp_nth_data (@w{const gcry_sexp_t @var{list}}, @w{int @var{number}}, @w{size_t *@var{datalen}})
4136
4137 This function is used to get data from a @var{list}.  A pointer to the
4138 actual data with index @var{number} is returned and the length of this
4139 data will be stored to @var{datalen}.  If there is no data at the given
4140 index or the index represents another list, @code{NULL} is returned.
4141 @strong{Caution:} The returned pointer is valid as long as @var{list} is
4142 not modified or released.
4143
4144 @noindent
4145 Here is an example on how to extract and print the surname (Meier) from
4146 the S-expression @samp{(Name Otto Meier (address Burgplatz 3))}:
4147
4148 @example
4149 size_t len;
4150 const char *name;
4151
4152 name = gcry_sexp_nth_data (list, 2, &len);
4153 printf ("my name is %.*s\n", (int)len, name);
4154 @end example
4155 @end deftypefun
4156
4157 @deftypefun {char *} gcry_sexp_nth_string (@w{gcry_sexp_t @var{list}}, @w{int @var{number}})
4158
4159 This function is used to get and convert data from a @var{list}. The
4160 data is assumed to be a Nul terminated string.  The caller must
4161 release this returned value using @code{gcry_free}.  If there is
4162 no data at the given index, the index represents a list or the value
4163 can't be converted to a string, @code{NULL} is returned.
4164 @end deftypefun
4165
4166 @deftypefun gcry_mpi_t gcry_sexp_nth_mpi (@w{gcry_sexp_t @var{list}}, @w{int @var{number}}, @w{int @var{mpifmt}})
4167
4168 This function is used to get and convert data from a @var{list}. This
4169 data is assumed to be an MPI stored in the format described by
4170 @var{mpifmt} and returned as a standard Libgcrypt MPI.  The caller must
4171 release this returned value using @code{gcry_mpi_release}.  If there is
4172 no data at the given index, the index represents a list or the value
4173 can't be converted to an MPI, @code{NULL} is returned.
4174 @end deftypefun
4175
4176
4177 @c **********************************************************
4178 @c *******************  MPIs ******** ***********************
4179 @c **********************************************************
4180 @node MPI library
4181 @chapter MPI library
4182
4183 @menu
4184 * Data types::                  MPI related data types.
4185 * Basic functions::             First steps with MPI numbers.
4186 * MPI formats::                 External representation of MPIs.
4187 * Calculations::                Performing MPI calculations.
4188 * Comparisons::                 How to compare MPI values.
4189 * Bit manipulations::           How to access single bits of MPI values.
4190 * Miscellaneous::               Miscellaneous MPI functions.
4191 @end menu
4192
4193 Public key cryptography is based on mathematics with large numbers.  To
4194 implement the public key functions, a library for handling these large
4195 numbers is required.  Because of the general usefulness of such a
4196 library, its interface is exposed by Libgcrypt. 
4197 In the context of Libgcrypt and in most other applications, these large
4198 numbers are called MPIs (multi-precision-integers).
4199
4200 @node Data types
4201 @section Data types
4202
4203 @deftp {Data type} {gcry_mpi_t}
4204 This type represents an object to hold an MPI.
4205 @end deftp
4206
4207 @node Basic functions
4208 @section Basic functions
4209
4210 @noindent
4211 To work with MPIs, storage must be allocated and released for the
4212 numbers.  This can be done with one of these functions:
4213
4214 @deftypefun gcry_mpi_t gcry_mpi_new (@w{unsigned int @var{nbits}})
4215
4216 Allocate a new MPI object, initialize it to 0 and initially allocate
4217 enough memory for a number of at least @var{nbits}.  This pre-allocation is
4218 only a small performance issue and not actually necessary because
4219 Libgcrypt automatically re-allocates the required memory.
4220 @end deftypefun
4221
4222 @deftypefun gcry_mpi_t gcry_mpi_snew (@w{unsigned int @var{nbits}})
4223
4224 This is identical to @code{gcry_mpi_new} but allocates the MPI in the so
4225 called "secure memory" which in turn will take care that all derived
4226 values will also be stored in this "secure memory".  Use this for highly
4227 confidential data like private key parameters.
4228 @end deftypefun
4229
4230 @deftypefun gcry_mpi_t gcry_mpi_copy (@w{const gcry_mpi_t @var{a}})
4231
4232 Create a new MPI as the exact copy of @var{a}.
4233 @end deftypefun
4234
4235
4236 @deftypefun void gcry_mpi_release (@w{gcry_mpi_t @var{a}})
4237
4238 Release the MPI @var{a} and free all associated resources.  Passing
4239 @code{NULL} is allowed and ignored.  When a MPI stored in the "secure
4240 memory" is released, that memory gets wiped out immediately.
4241 @end deftypefun
4242
4243 @noindent
4244 The simplest operations are used to assign a new value to an MPI:
4245
4246 @deftypefun gcry_mpi_t gcry_mpi_set (@w{gcry_mpi_t @var{w}}, @w{const gcry_mpi_t @var{u}})
4247
4248 Assign the value of @var{u} to @var{w} and return @var{w}.  If
4249 @code{NULL} is passed for @var{w}, a new MPI is allocated, set to the
4250 value of @var{u} and returned.
4251 @end deftypefun
4252
4253 @deftypefun gcry_mpi_t gcry_mpi_set_ui (@w{gcry_mpi_t @var{w}}, @w{unsigned long @var{u}})
4254
4255 Assign the value of @var{u} to @var{w} and return @var{w}.  If
4256 @code{NULL} is passed for @var{w}, a new MPI is allocated, set to the
4257 value of @var{u} and returned.  This function takes an @code{unsigned
4258 int} as type for @var{u} and thus it is only possible to set @var{w} to
4259 small values (usually up to the word size of the CPU).
4260 @end deftypefun
4261
4262 @deftypefun void gcry_mpi_swap (@w{gcry_mpi_t @var{a}}, @w{gcry_mpi_t @var{b}})
4263
4264 Swap the values of @var{a} and @var{b}.
4265 @end deftypefun
4266
4267 @node MPI formats
4268 @section MPI formats
4269
4270 @noindent
4271 The following functions are used to convert between an external
4272 representation of an MPI and the internal one of Libgcrypt.
4273
4274 @deftypefun gcry_error_t gcry_mpi_scan (@w{gcry_mpi_t *@var{r_mpi}}, @w{enum gcry_mpi_format @var{format}}, @w{const unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nscanned}})
4275
4276 Convert the external representation of an integer stored in @var{buffer}
4277 with a length of @var{buflen} into a newly created MPI returned which
4278 will be stored at the address of @var{r_mpi}.  For certain formats the
4279 length argument is not required and should be passed as @code{0}.  After a
4280 successful operation the variable @var{nscanned} receives the number of
4281 bytes actually scanned unless @var{nscanned} was given as
4282 @code{NULL}. @var{format} describes the format of the MPI as stored in
4283 @var{buffer}:
4284
4285 @table @code
4286 @item GCRYMPI_FMT_STD
4287 2-complement stored without a length header.
4288
4289 @item GCRYMPI_FMT_PGP
4290 As used by OpenPGP (only defined as unsigned). This is basically
4291 @code{GCRYMPI_FMT_STD} with a 2 byte big endian length header.
4292
4293 @item GCRYMPI_FMT_SSH
4294 As used in the Secure Shell protocol.  This is @code{GCRYMPI_FMT_STD}
4295 with a 4 byte big endian header.
4296
4297 @item GCRYMPI_FMT_HEX
4298 Stored as a C style string with each byte of the MPI encoded as 2 hex
4299 digits.  When using this format, @var{buflen} must be zero.
4300
4301 @item GCRYMPI_FMT_USG
4302 Simple unsigned integer.
4303 @end table
4304
4305 @noindent
4306 Note that all of the above formats store the integer in big-endian
4307 format (MSB first).
4308 @end deftypefun
4309
4310
4311 @deftypefun gcry_error_t gcry_mpi_print (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nwritten}}, @w{const gcry_mpi_t @var{a}})
4312
4313 Convert the MPI @var{a} into an external representation described by
4314 @var{format} (see above) and store it in the provided @var{buffer}
4315 which has a usable length of at least the @var{buflen} bytes. If
4316 @var{nwritten} is not NULL, it will receive the number of bytes
4317 actually stored in @var{buffer} after a successful operation.
4318 @end deftypefun
4319
4320 @deftypefun gcry_error_t gcry_mpi_aprint (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char **@var{buffer}}, @w{size_t *@var{nbytes}}, @w{const gcry_mpi_t @var{a}})
4321
4322 Convert the MPI @var{a} into an external representation described by
4323 @var{format} (see above) and store it in a newly allocated buffer which
4324 address will be stored in the variable @var{buffer} points to.  The
4325 number of bytes stored in this buffer will be stored in the variable
4326 @var{nbytes} points to, unless @var{nbytes} is @code{NULL}.
4327 @end deftypefun
4328
4329 @deftypefun void gcry_mpi_dump (@w{const gcry_mpi_t @var{a}})
4330
4331 Dump the value of @var{a} in a format suitable for debugging to
4332 Libgcrypt's logging stream.  Note that one leading space but no trailing
4333 sp