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