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