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