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