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