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