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