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