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