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