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