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