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