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