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