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