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