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