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