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