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