2006-01-08 Moritz Schulte <moritz@g10code.com>
[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 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 @end menu
169
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 occured, 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 @end table
1187
1188 @node Cipher modules
1189 @section Cipher modules
1190
1191 @acronym{Libgcrypt} makes it possible to load additional `cipher
1192 modules'; these cipher can be used just like the cipher algorithms
1193 that are built into the library directly.  For an introduction into
1194 extension modules, see @xref{Modules}.
1195
1196 @deftp {Data type} gcry_cipher_spec_t
1197 This is the `module specification structure' needed for registering
1198 cipher modules, which has to be filled in by the user before it can be
1199 used to register a module.  It contains the following members:
1200
1201 @table @code
1202 @item const char *name
1203 The primary name of the algorithm.
1204 @item const char **aliases
1205 A list of strings that are `aliases' for the algorithm.  The list must
1206 be terminated with a NULL element.
1207 @item gcry_cipher_oid_spec_t *oids
1208 A list of OIDs that are to be associated with the algorithm.  The
1209 list's last element must have it's `oid' member set to NULL.  See
1210 below for an explanation of this type.
1211 @item size_t blocksize
1212 The block size of the algorithm, in bytes.
1213 @item size_t keylen
1214 The length of the key, in bits.
1215 @item size_t contextsize
1216 The size of the algorithm-specific `context', that should be allocated
1217 for each handle.
1218 @item gcry_cipher_setkey_t setkey
1219 The function responsible for initializing a handle with a provided
1220 key.  See below for a description of this type.
1221 @item gcry_cipher_encrypt_t encrypt
1222 The function responsible for encrypting a single block.  See below for
1223 a description of this type.
1224 @item gcry_cipher_decrypt_t decrypt
1225 The function responsible for decrypting a single block.  See below for
1226 a description of this type.
1227 @item gcry_cipher_stencrypt_t stencrypt
1228 Like `encrypt', for stream ciphers.  See below for a description of
1229 this type.
1230 @item gcry_cipher_stdecrypt_t stdecrypt
1231 Like `decrypt', for stream ciphers.  See below for a description of
1232 this type.
1233 @end table
1234 @end deftp
1235
1236 @deftp {Data type} gcry_cipher_oid_spec_t
1237 This type is used for associating a user-provided algorithm
1238 implementation with certain OIDs.  It contains the following members:
1239 @table @code
1240 @item const char *oid
1241 Textual representation of the OID.
1242 @item int mode
1243 Cipher mode for which this OID is valid.
1244 @end table
1245 @end deftp
1246
1247 @deftp {Data type} gcry_cipher_setkey_t
1248 Type for the `setkey' function, defined as: gcry_err_code_t
1249 (*gcry_cipher_setkey_t) (void *c, const unsigned char *key, unsigned
1250 keylen)
1251 @end deftp
1252
1253 @deftp {Data type} gcry_cipher_encrypt_t
1254 Type for the `encrypt' function, defined as: gcry_err_code_t
1255 (*gcry_cipher_encrypt_t) (void *c, const unsigned char *outbuf, const
1256 unsigned char *inbuf)
1257 @end deftp
1258
1259 @deftp {Data type} gcry_cipher_decrypt_t
1260 Type for the `decrypt' function, defined as: gcry_err_code_t
1261 (*gcry_cipher_decrypt_t) (void *c, const unsigned char *outbuf, const
1262 unsigned char *inbuf)
1263 @end deftp
1264
1265 @deftp {Data type} gcry_cipher_stencrypt_t
1266 Type for the `stencrypt' function, defined as: gcry_err_code_t
1267 (*gcry_cipher_stencrypt_t) (void *c, const unsigned char *outbuf, const
1268 unsigned char *, unsigned int n)
1269 @end deftp
1270
1271 @deftp {Data type} gcry_cipher_stdecrypt_t
1272 Type for the `stdecrypt' function, defined as: gcry_err_code_t
1273 (*gcry_cipher_stdecrypt_t) (void *c, const unsigned char *outbuf, const
1274 unsigned char *, unsigned int n)
1275 @end deftp
1276
1277 @deftypefun gcry_error_t gcry_cipher_register (gcry_cipher_spec_t *@var{cipher}, unsigned int *algorithm_id, gcry_module_t *@var{module})
1278
1279 Register a new cipher module whose specification can be found in
1280 @var{cipher}.  On success, a new algorithm ID is stored in
1281 @var{algorithm_id} and a pointer representing this module is stored
1282 in @var{module}.
1283 @end deftypefun
1284
1285 @deftypefun void gcry_cipher_unregister (gcry_module_t @var{module})
1286 Unregister the cipher identified by @var{module}, which must have been
1287 registered with gcry_cipher_register.
1288 @end deftypefun
1289
1290 @deftypefun gcry_error_t gcry_cipher_list (int *@var{list}, int *@var{list_length})
1291 Get a list consisting of the IDs of the loaded cipher modules.  If
1292 @var{list} is zero, write the number of loaded cipher modules to
1293 @var{list_length} and return.  If @var{list} is non-zero, the first
1294 *@var{list_length} algorithm IDs are stored in @var{list}, which must
1295 be of according size.  In case there are less cipher modules than
1296 *@var{list_length}, *@var{list_length} is updated to the correct
1297 number.
1298 @end deftypefun
1299
1300 @node Available cipher modes
1301 @section Available cipher modes
1302
1303 @table @code
1304 @item GCRY_CIPHER_MODE_NONE
1305 No mode specified, may be set later using other functions.  The value
1306 of this constant is always 0.
1307
1308 @item GCRY_CIPHER_MODE_ECB
1309 Electronic Codebook mode.  
1310
1311 @item GCRY_CIPHER_MODE_CFB
1312 Cipher Feedback mode.
1313
1314 @item  GCRY_CIPHER_MODE_CBC
1315 Cipher Block Chaining mode.
1316
1317 @item GCRY_CIPHER_MODE_STREAM
1318 Stream mode, only to be used with stream cipher algorithms.
1319
1320 @item GCRY_CIPHER_MODE_OFB
1321 Outer Feedback mode.
1322
1323 @item  GCRY_CIPHER_MODE_CTR
1324 Counter mode.
1325
1326 @end table
1327
1328 @node Working with cipher handles
1329 @section Working with cipher handles
1330
1331 To use a cipher algorithm, you must first allocate an according
1332 handle.  This is to be done using the open function:
1333
1334 @deftypefun gcry_error_t gcry_cipher_open (gcry_cipher_hd_t *@var{hd}, int @var{algo}, int @var{mode}, unsigned int @var{flags})
1335
1336 This function creates the context handle required for most of the
1337 other cipher functions and returns a handle to it in `hd'.  In case of
1338 an error, an according error code is returned.
1339
1340 The ID of algorithm to use must be specified via @var{algo}.  See
1341 @xref{Available ciphers}, for a list of supported ciphers and the
1342 according constants.
1343
1344 Besides using the constants directly, the function
1345 @code{gcry_cipher_map_name} may be used to convert the textual name of
1346 an algorithm into the according numeric ID.
1347
1348 The cipher mode to use must be specified via @var{mode}.  See
1349 @xref{Available cipher modes}, for a list of supported cipher modes
1350 and the according constants.  Note, that some modes do not work
1351 together with all algorithms.
1352
1353 The third argument @var{flags} can either be passed as @code{0} or as
1354 the bit-wise OR of the following constants.
1355
1356 @table @code
1357 @item GCRY_CIPHER_SECURE
1358 Make sure that all operations are allocated in secure memory.  This is
1359 useful, when the key material is highly confidential.
1360 @item GCRY_CIPHER_ENABLE_SYNC
1361 This flag enables the CFB sync mode, which is a special feature of
1362 @acronym{Libgcrypt}'s CFB mode implementation to allow for OpenPGP's CFB variant. 
1363 See @code{gcry_cipher_sync}.
1364 @item GCRY_CIPHER_CBC_CTS
1365 Enable cipher text stealing (CTS) for the CBC mode.  Cannot be used
1366 simultaneous as GCRY_CIPHER_CBC_MAC.  CTS mode makes it possible to
1367 transform data of almost arbitrary size (only limitation is that it
1368 must be greater than the algorithm's block size).
1369 @item GCRY_CIPHER_CBC_MAC
1370 Compute CBC-MAC keyed checksums.  This is the same as CBC mode, but
1371 only output the last block.  Cannot be used simultaneous as
1372 GCRY_CIPHER_CBC_CTS.
1373 @end table
1374 @end deftypefun 
1375
1376 Use the following function to release an existing handle:
1377
1378 @deftypefun void gcry_cipher_close (gcry_cipher_hd_t @var{h})
1379
1380 This function releases the context created by @code{gcry_cipher_open}.
1381 @end deftypefun
1382
1383 In order to use a handle for performing cryptographic operations, a
1384 `key' has to be set first:
1385
1386 @deftypefun gcry_error_t gcry_cipher_setkey (gcry_cipher_hd_t @var{h}, void *@var{k}, size_t @var{l})
1387
1388 Set the key @var{k} used for encryption or decryption in the context
1389 denoted by the handle @var{h}.  The length @var{l} of the key @var{k}
1390 must match the required length of the algorithm set for this context or
1391 be in the allowed range for algorithms with variable key size.  The
1392 function checks this and returns an error if there is a problem.  A
1393 caller should always check for an error.
1394
1395 Note, this is currently implemented as a macro but may be changed to a
1396 function in the future.
1397 @end deftypefun
1398
1399 Most crypto modes requires an initialization vector (IV), which
1400 usually is a non-secret random string acting as a kind of salt value.
1401 The CTR mode requires a counter, which is also similar to a salt
1402 value.  To set the IV or CTR, use these functions:
1403
1404 @deftypefun gcry_error_t gcry_cipher_setiv (gcry_cipher_hd_t @var{h}, void *@var{k}, size_t @var{l})
1405
1406 Set the initialization vector used for encryption or decryption. The
1407 vector is passed as the buffer @var{K} of length @var{l} and copied to
1408 internal data structures.  The function checks that the IV matches the
1409 requirement of the selected algorithm and mode.  Note, that this is
1410 implemented as a macro.
1411 @end deftypefun
1412
1413 @deftypefun gcry_error_t gcry_cipher_setctr (gcry_cipher_hd_t @var{h}, void *@var{c}, size_t @var{l})
1414
1415 Set the counter vector used for encryption or decryption. The counter
1416 is passed as the buffer @var{c} of length @var{l} and copied to
1417 internal data structures.  The function checks that the counter
1418 matches the requirement of the selected algorithm (i.e., it must be
1419 the same size as the block size).  Note, that this is implemented as a
1420 macro.
1421 @end deftypefun
1422
1423 @deftypefun gcry_error_t gcry_cipher_reset (gcry_cipher_hd_t @var{h})
1424
1425 Set the given handle's context back to the state it had after the last
1426 call to gcry_cipher_setkey and clear the initialization vector.
1427
1428 Note, that gcry_cipher_reset is implemented as a macro.
1429 @end deftypefun
1430
1431 The actual encryption and decryption is done by using one of the
1432 following functions.  They may be used as often as required to process
1433 all the data.
1434
1435 @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})
1436
1437 @code{gcry_cipher_encrypt} is used to encrypt the data.  This function
1438 can either work in place or with two buffers.  It uses the cipher
1439 context already setup and described by the handle @var{h}.  There are 2
1440 ways to use the function: If @var{in} is passed as @code{NULL} and
1441 @var{inlen} is @code{0}, in-place encryption of the data in @var{out} or
1442 length @var{outsize} takes place.  With @var{in} being not @code{NULL},
1443 @var{inlen} bytes are encrypted to the buffer @var{out} which must have
1444 at least a size of @var{inlen}.  @var{outsize} must be set to the
1445 allocated size of @var{out}, so that the function can check that there
1446 is sufficient space. Note, that overlapping buffers are not allowed.
1447
1448 Depending on the selected algorithms and encryption mode, the length of
1449 the buffers must be a multiple of the block size.
1450
1451 The function returns @code{0} on success or an error code.
1452 @end deftypefun
1453
1454
1455 @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})
1456
1457 @code{gcry_cipher_decrypt} is used to decrypt the data.  This function
1458 can either work in place or with two buffers.  It uses the cipher
1459 context already setup and described by the handle @var{h}.  There are 2
1460 ways to use the function: If @var{in} is passed as @code{NULL} and
1461 @var{inlen} is @code{0}, in-place decryption of the data in @var{out} or
1462 length @var{outsize} takes place.  With @var{in} being not @code{NULL},
1463 @var{inlen} bytes are decrypted to the buffer @var{out} which must have
1464 at least a size of @var{inlen}.  @var{outsize} must be set to the
1465 allocated size of @var{out}, so that the function can check that there
1466 is sufficient space. Note, that overlapping buffers are not allowed.
1467
1468 Depending on the selected algorithms and encryption mode, the length of
1469 the buffers must be a multiple of the block size.
1470
1471 The function returns @code{0} on success or an error code.
1472 @end deftypefun
1473
1474
1475 OpenPGP (as defined in RFC-2440) requires a special sync operation in
1476 some places, the following function is used for this:
1477
1478 @deftypefun gcry_error_t gcry_cipher_sync (gcry_cipher_hd_t @var{h})
1479
1480 Perform the OpenPGP sync operation on context @var{h}. Note, that this
1481 is a no-op unless the context was created with the flag
1482 @code{GCRY_CIPHER_ENABLE_SYNC}
1483 @end deftypefun
1484
1485 Some of the described functions are implemented as macros utilizing a
1486 catch-all control function.  This control function is rarely used
1487 directly but there is nothing which would inhibit it:
1488
1489 @deftypefun gcry_error_t gcry_cipher_ctl (gcry_cipher_hd_t @var{h}, int @var{cmd}, void *@var{buffer}, size_t @var{buflen})
1490
1491 @code{gcry_cipher_ctl} controls various aspects of the cipher module and
1492 specific cipher contexts.  Usually some more specialized functions or
1493 macros are used for this purpose.  The semantics of the function and its
1494 parameters depends on the the command @var{cmd} and the passed context
1495 handle @var{h}.  Please see the comments in the source code
1496 (@code{src/global.c}) for details.
1497 @end deftypefun
1498
1499 @deftypefun gcry_error_t gcry_cipher_info (gcry_cipher_hd_t @var{h}, int @var{what}, void *@var{buffer}, size_t *@var{nbytes})
1500
1501 @code{gcry_cipher_info} is used to retrieve various
1502 information about a cipher context or the cipher module in general.
1503
1504 Currently no information is available.
1505 @end deftypefun
1506
1507 @node General cipher functions
1508 @section General cipher functions
1509
1510 To work with the algorithms, several functions are available to map
1511 algorithm names to the internal identifiers, as well as ways to
1512 retrieve information about an algorithm or the current cipher context.
1513
1514 @deftypefun gcry_error_t gcry_cipher_algo_info (int @var{algo}, int @var{what}, void *@var{buffer}, size_t *@var{nbytes})
1515
1516 This function is used to retrieve information on a specific algorithm.
1517 You pass the cipher algorithm ID as @var{algo} and the type of
1518 information requested as @var{what}. The result is either returned as
1519 the return code of the function or copied to the provided @var{buffer}
1520 whose allocated length must be available in an integer variable with the
1521 address passed in @var{nbytes}.  This variable will also receive the
1522 actual used length of the buffer. 
1523
1524 Here is a list of supported codes for @var{what}:
1525
1526 @c begin constants for gcry_cipher_algo_info
1527 @table @code
1528 @item GCRYCTL_GET_KEYLEN:
1529 Return the length of the key. If the algorithm supports multiple key
1530 lengths, the maximum supported value is returned.  The length is
1531 returned as number of octets (bytes) and not as number of bits in
1532 @var{nbytes}; @var{buffer} must be zero.
1533
1534 @item GCRYCTL_GET_BLKLEN:
1535 Return the block length of the algorithm.  The length is returned as a
1536 number of octets in @var{nbytes}; @var{buffer} must be zero.
1537
1538 @item GCRYCTL_TEST_ALGO:
1539 Returns @code{0} when the specified algorithm is available for use.
1540 @var{buffer} and @var{nbytes} must be zero.
1541  
1542 @end table  
1543 @c end constants for gcry_cipher_algo_info
1544
1545 @end deftypefun
1546 @c end gcry_cipher_algo_info
1547
1548 @deftypefun const char *gcry_cipher_algo_name (int @var{algo})
1549
1550 @code{gcry_cipher_algo_name} returns a string with the name of the
1551 cipher algorithm @var{algo}.  If the algorithm is not known or another
1552 error occurred, an empty string is returned.  This function will never
1553 return @code{NULL}.
1554 @end deftypefun
1555
1556 @deftypefun int gcry_cipher_map_name (const char *@var{name})
1557
1558 @code{gcry_cipher_map_name} returns the algorithm identifier for the
1559 cipher algorithm described by the string @var{name}.  If this algorithm
1560 is not available @code{0} is returned.
1561 @end deftypefun
1562
1563 @deftypefun int gcry_cipher_mode_from_oid (const char *@var{string})
1564
1565 Return the cipher mode associated with an @acronym{ASN.1} object
1566 identifier.  The object identifier is expected to be in the
1567 @acronym{IETF}-style dotted decimal notation.  The function returns
1568 @code{0} for an unknown object identifier or when no mode is associated
1569 with it.
1570 @end deftypefun
1571
1572
1573 @c **********************************************************
1574 @c *******************  Hash Functions  *********************
1575 @c **********************************************************
1576 @node Hashing
1577 @chapter Hashing
1578
1579 @acronym{Libgcrypt} provides an easy and consistent to use interface
1580 for hashing.  Hashing is buffered and several hash algorithms can be
1581 updated at once.  It is possible to calculate a MAC using the same
1582 routines.  The programming model follows an open/process/close
1583 paradigm and is in that similar to other building blocks provided by
1584 @acronym{Libgcrypt}.
1585
1586 For convenience reasons, a few cyclic redundancy check value operations
1587 are also supported.
1588
1589 @menu
1590 * Available hash algorithms::   List of hash algorithms supported by the library.
1591 * Hash algorithm modules::      How to work with hash algorithm modules.
1592 * Working with hash algorithms::  List of functions related to hashing.
1593 @end menu
1594
1595 @node Available hash algorithms
1596 @section Available hash algorithms
1597
1598 @c begin table of hash algorithms
1599 @table @code
1600 @item GCRY_MD_NONE
1601 This is not a real algorithm but used by some functions as an error
1602 return value.  This constant is guaranteed to have the value @code{0}.
1603
1604 @item GCRY_MD_SHA1
1605 This is the SHA-1 algorithm which yields a message digest of 20 bytes.
1606
1607 @item GCRY_MD_RMD160
1608 This is the 160 bit version of the RIPE message digest (RIPE-MD-160).
1609 Like SHA-1 it also yields a digest of 20 bytes.
1610
1611 @item GCRY_MD_MD5
1612 This is the well known MD5 algorithm, which yields a message digest of
1613 16 bytes. 
1614
1615 @item GCRY_MD_MD4
1616 This is the MD4 algorithm, which yields a message digest of 16 bytes.
1617
1618 @item GCRY_MD_MD2
1619 This is an reserved identifier for MD-2; there is no implementation yet.
1620
1621 @item GCRY_MD_TIGER
1622 This is the TIGER/192 algorithm which yields a message digest of 24 bytes.
1623
1624 @item GCRY_MD_HAVAL
1625 This is an reserved for the HAVAL algorithm with 5 passes and 160
1626 bit. It yields a message digest of 20 bytes.  Note that there is no
1627 implementation yet available.
1628
1629 @item GCRY_MD_SHA256
1630 This is the SHA-256 algorithm which yields a message digest of 32 bytes.
1631 See FIPS 180-2 for the specification.
1632
1633 @item GCRY_MD_SHA384
1634 This is reserved for SHA-2 with 384 bits. It yields a message digest of
1635 48 bytes.  Note that there is no implementation yet available.
1636
1637 @item GCRY_MD_SHA512
1638 This is reserved for SHA-2 with 512 bits. It yields a message digest of
1639 64 bytes.  Note that there is no implementation yet available.
1640
1641 @item GCRY_MD_CRC32
1642 This is the ISO 3309 and ITU-T V.42 cyclic redundancy check.  It
1643 yields an output of 4 bytes.
1644
1645 @item GCRY_MD_CRC32_RFC1510
1646 This is the above cyclic redundancy check function, as modified by RFC
1647 1510.  It yields an output of 4 bytes.
1648
1649 @item GCRY_MD_CRC24_RFC2440
1650 This is the OpenPGP cyclic redundancy check function.  It yields an
1651 output of 3 bytes.
1652
1653 @item GCRY_MD_WHIRLPOOL
1654 This is the Whirlpool algorithm which yields a message digest of 64
1655 bytes.
1656
1657 @end table
1658 @c end table of hash algorithms
1659
1660 @node Hash algorithm modules
1661 @section Hash algorithm modules
1662
1663 @acronym{Libgcrypt} makes it possible to load additional `message
1664 digest modules'; these cipher can be used just like the message digest
1665 algorithms that are built into the library directly.  For an
1666 introduction into extension modules, see @xref{Modules}.
1667
1668 @deftp {Data type} gcry_md_spec_t
1669 This is the `module specification structure' needed for registering
1670 message digest modules, which has to be filled in by the user before
1671 it can be used to register a module.  It contains the following
1672 members:
1673
1674 @table @code
1675 @item const char *name
1676 The primary name of this algorithm.
1677 @item unsigned char *asnoid
1678 Array of bytes that form the ASN OID.
1679 @item int asnlen
1680 Length of bytes in `asnoid'.
1681 @item gcry_md_oid_spec_t *oids
1682 A list of OIDs that are to be associated with the algorithm.  The
1683 list's last element must have it's `oid' member set to NULL.  See
1684 below for an explanation of this type.  See below for an explanation
1685 of this type.
1686 @item int mdlen
1687 Length of the message digest algorithm.  See below for an explanation
1688 of this type.
1689 @item gcry_md_init_t init
1690 The function responsible for initializing a handle.  See below for an
1691 explanation of this type.
1692 @item gcry_md_write_t write
1693 The function responsible for writing data into a message digest
1694 context.  See below for an explanation of this type.
1695 @item gcry_md_final_t final
1696 The function responsible for `finalizing' a message digest context.
1697 See below for an explanation of this type.
1698 @item gcry_md_read_t read
1699 The function responsible for reading out a message digest result.  See
1700 below for an explanation of this type.
1701 @item size_t contextsize
1702 The size of the algorithm-specific `context', that should be
1703 allocated for each handle.
1704 @end table
1705 @end deftp
1706
1707 @deftp {Data type} gcry_md_oid_spec_t
1708 This type is used for associating a user-provided algorithm
1709 implementation with certain OIDs.  It contains the following members:
1710
1711 @table @code
1712 @item const char *oidstring
1713 Textual representation of the OID.
1714 @end table
1715 @end deftp
1716
1717 @deftp {Data type} gcry_md_init_t
1718 Type for the `init' function, defined as: void (*gcry_md_init_t) (void
1719 *c)
1720 @end deftp
1721
1722 @deftp {Data type} gcry_md_write_t
1723 Type for the `write' function, defined as: void (*gcry_md_write_t)
1724 (void *c, unsigned char *buf, size_t nbytes)
1725 @end deftp
1726
1727 @deftp {Data type} gcry_md_final_t
1728 Type for the `final' function, defined as: void (*gcry_md_final_t)
1729 (void *c)
1730 @end deftp
1731
1732 @deftp {Data type} gcry_md_read_t
1733 Type for the `read' function, defined as: unsigned char
1734 *(*gcry_md_read_t) (void *c)
1735 @end deftp
1736
1737 @deftypefun gcry_error_t gcry_md_register (gcry_md_spec_t *@var{digest}, unsigned int *algorithm_id, gcry_module_t *@var{module})
1738
1739 Register a new digest module whose specification can be found in
1740 @var{digest}.  On success, a new algorithm ID is stored in
1741 @var{algorithm_id} and a pointer representing this module is stored
1742 in @var{module}.
1743 @end deftypefun
1744
1745 @deftypefun void gcry_md_unregister (gcry_module_t @var{module})
1746 Unregister the digest identified by @var{module}, which must have been
1747 registered with gcry_md_register.
1748 @end deftypefun
1749
1750 @deftypefun gcry_error_t gcry_md_list (int *@var{list}, int *@var{list_length})
1751 Get a list consisting of the IDs of the loaded message digest modules.
1752 If @var{list} is zero, write the number of loaded message digest
1753 modules to @var{list_length} and return.  If @var{list} is non-zero,
1754 the first *@var{list_length} algorithm IDs are stored in @var{list},
1755 which must be of according size.  In case there are less message
1756 digests modules than *@var{list_length}, *@var{list_length} is updated
1757 to the correct number.
1758 @end deftypefun
1759
1760 @node Working with hash algorithms
1761 @section Working with hash algorithms
1762
1763 To use most of these function it is necessary to create a context;
1764 this is done using:
1765
1766 @deftypefun gcry_error_t gcry_md_open (gcry_md_hd_t *@var{hd}, int @var{algo}, unsigned int @var{flags})
1767
1768 Create a message digest object for algorithm @var{algo}.  @var{flags}
1769 may be given as an bitwise OR of constants described below.  @var{algo}
1770 may be given as @code{0} if the algorithms to use are later set using
1771 @code{gcry_md_enable}. @var{hd} is guaranteed to either receive a valid
1772 handle or NULL.
1773
1774 For a list of supported algorithms, see @xref{Available hash
1775 algorithms}.
1776
1777 The flags allowed for @var{mode} are:
1778
1779 @c begin table of hash flags
1780 @table @code
1781 @item GCRY_MD_FLAG_SECURE
1782 Allocate all buffers and the resulting digest in "secure memory".  Use
1783 this is the hashed data is highly confidential.
1784
1785 @item GCRY_MD_FLAG_HMAC
1786 Turn the algorithm into a HMAC message authentication algorithm.  This
1787 does only work if just one algorithm is enabled for the handle and
1788 SHA-384 and SHA512 is not used.  Note that the function
1789 @code{gcry_md_setkey} must be used to set the MAC key.  If you want CBC
1790 message authentication codes based on a cipher, see @xref{Working with
1791 cipher handles}.
1792
1793 @end table
1794 @c begin table of hash flags
1795
1796 You may use the function @code{gcry_md_is_enabled} to later check
1797 whether an algorithm has been enabled.
1798
1799 @end deftypefun
1800 @c end function gcry_md_open
1801
1802 If you want to calculate several hash algorithms at the same time, you
1803 have to use the following function right after the @code{gcry_md_open}:
1804
1805 @deftypefun gcry_error_t gcry_md_enable (gcry_md_hd_t @var{h}, int @var{algo})
1806
1807 Add the message digest algorithm @var{algo} to the digest object
1808 described by handle @var{h}.  Duplicated enabling of algorithms is
1809 detected and ignored.
1810 @end deftypefun
1811
1812 If the flag @code{GCRY_MD_FLAG_HMAC} was used, the key for the MAC must
1813 be set using the function:
1814
1815 @deftypefun gcry_error_t gcry_md_setkey (gcry_md_hd_t @var{h}, const void *@var{key}, size_t @var{keylen})
1816
1817 For use with the HMAC feature, set the MAC key to the value of @var{key}
1818 of length @var{keylen}.
1819 @end deftypefun
1820
1821
1822 After you are done with the hash calculation, you should release the
1823 resources by using:
1824
1825 @deftypefun void gcry_md_close (gcry_md_hd_t @var{h})
1826
1827 Release all resources of hash context @var{h}.  @var{h} should not be
1828 used after a call to this function.  A @code{NULL} passed as @var{h} is
1829 ignored.
1830
1831 @end deftypefun
1832
1833 Often you have to do several hash operations using the same algorithm.
1834 To avoid the overhead of creating and releasing context, a reset function
1835 is provided:
1836
1837 @deftypefun void gcry_md_reset (gcry_md_hd_t @var{h})
1838
1839 Reset the current context to its initial state.  This is effectively
1840 identical to a close followed by an open and enabling all currently
1841 active algorithms.
1842 @end deftypefun
1843
1844
1845 Often it is necessary to start hashing some data and than continue to
1846 hash different data.  To avoid hashing the same data several times (which
1847 might not even be possible if the data is received from a pipe), a
1848 snapshot of the current hash context can be taken and turned into a new
1849 context:
1850
1851 @deftypefun gcry_error_t gcry_md_copy (gcry_md_hd_t *@var{handle_dst}, gcry_md_hd_t @var{handle_src})
1852
1853 Create a new digest object as an exact copy of the object described by
1854 handle @var{handle_src} and store it in @var{handle_dst}.  The context
1855 is not reset and you can continue to hash data using this context and
1856 independently using the original context.
1857 @end deftypefun
1858
1859
1860 Now that we have prepared everything to calculate hashes, its time to
1861 see how it is actually done.  There are 2  ways for this, one to
1862 update the hash with a block of memory and one macro to update the hash
1863 by just one character.  Both may be used intermixed.
1864
1865 @deftypefun void gcry_md_write (gcry_md_hd_t @var{h}, const void *@var{buffer}, size_t @var{length})
1866
1867 Pass @var{length} bytes of the data in @var{buffer} to the digest object
1868 with handle @var{h} to update the digest values. This
1869 function should be used for large blocks of data.
1870 @end deftypefun
1871
1872 @deftypefun void gcry_md_putc (gcry_md_hd_t @var{h}, int @var{c})
1873
1874 Pass the byte in @var{c} to the digest object with handle @var{h} to
1875 update the digest value.  This is an efficient function, implemented as
1876 a macro to buffer the data before an actual update. 
1877 @end deftypefun
1878
1879 The semantics of the hash functions don't allow to read out intermediate
1880 message digests because the calculation must be finalized fist.  This
1881 finalization may for example include the number of bytes hashed in the
1882 message digest.  
1883
1884 @deftypefun void gcry_md_final (gcry_md_hd_t @var{h})
1885
1886 Finalize the message digest calculation.  This is not really needed
1887 because @code{gcry_md_read} does this implicitly.  After this has been
1888 done no further updates (by means of @code{gcry_md_write} or
1889 @code{gcry_md_putc} are allowed.  Only the first call to this function
1890 has an effect. It is implemented as a macro.
1891 @end deftypefun
1892
1893 The way to read out the calculated message digest is by using the
1894 function:
1895
1896 @deftypefun unsigned char *gcry_md_read (gcry_md_hd_t @var{h}, int @var{algo})
1897
1898 @code{gcry_md_read} returns the message digest after finalizing the
1899 calculation.  This function may be used as often as required but it will
1900 always return the same value for one handle.  The returned message digest
1901 is allocated within the message context and therefore valid until the
1902 handle is released or reseted (using @code{gcry_md_close} or
1903 @code{gcry_md_reset}.  @var{algo} may be given as 0 to return the only
1904 enabled message digest or it may specify one of the enabled algorithms.
1905 The function does return @code{NULL} if the requested algorithm has not
1906 been enabled.
1907 @end deftypefun
1908
1909 Because it is often necessary to get the message digest of one block of
1910 memory, a fast convenience function is available for this task: 
1911
1912 @deftypefun void gcry_md_hash_buffer (int @var{algo}, void *@var{digest}, const cvoid *@var{buffer}, size_t @var{length});
1913
1914 @code{gcry_md_hash_buffer} is a shortcut function to calculate a message
1915 digest of a buffer.  This function does not require a context and
1916 immediately returns the message digest of the @var{length} bytes at
1917 @var{buffer}.  @var{digest} must be allocated by the caller, large
1918 enough to hold the message digest yielded by the the specified algorithm
1919 @var{algo}.  This required size may be obtained by using the function
1920 @code{gcry_md_get_algo_dlen}.
1921
1922 Note, that this function will abort the process if an unavailable
1923 algorithm is used.
1924 @end deftypefun
1925
1926 @c ***********************************
1927 @c ***** MD info functions ***********
1928 @c ***********************************
1929
1930 Hash algorithms are identified by internal algorithm numbers (see
1931 @code{gcry_md_open} for a list.  However, in most applications they are
1932 used by names, so 2 functions are available to map between string
1933 representations and hash algorithm identifiers.
1934
1935 @deftypefun const char *gcry_md_algo_name (int @var{algo})
1936
1937 Map the digest algorithm id @var{algo} to a string representation of the
1938 algorithm name.  For unknown algorithms this functions returns an
1939 empty string.  This function should not be used to test for the
1940 availability of an algorithm.
1941 @end deftypefun
1942
1943 @deftypefun int gcry_md_map_name (const char *@var{name})
1944
1945 Map the algorithm with @var{name} to a digest algorithm identifier.
1946 Returns 0 if the algorithm name is not known.  Names representing
1947 @acronym{ASN.1} object identifiers are recognized if the @acronym{IETF}
1948 dotted format is used and the OID is prefixed with either "@code{oid.}"
1949 or "@code{OID.}".  For a list of supported OIDs, see the source code at
1950 @file{cipher/md.c}. This function should not be used to test for the
1951 availability of an algorithm.
1952 @end deftypefun
1953
1954 @deftypefun gcry_error_t gcry_md_get_asnoid (int @var{algo}, void *@var{buffer}, size_t *@var{length})
1955
1956 Return an DER encoded ASN.1 OID for the algorithm @var{algo} in the
1957 user allocated @var{buffer}. @var{length} must point to variable with
1958 the available size of @var{buffer} and receives after return the
1959 actual size of the returned OID.  The returned error code may be
1960 @code{GPG_ERR_TOO_SHORT} if the provided buffer is to short to receive
1961 the OID; it is possible to call the function with @code{NULL} for
1962 @var{buffer} to have it only return the required size.  The function
1963 returns 0 on success.
1964
1965 @end deftypefun
1966
1967
1968 To test whether an algorithm is actually available for use, the
1969 following macro should be used:
1970
1971 @deftypefun gcry_error_t gcry_md_test_algo (int @var{algo}) 
1972
1973 The macro returns 0 if the algorithm @var{algo} is available for use.
1974 @end deftypefun
1975
1976 If the length of a message digest is not known, it can be retrieved
1977 using the following function:
1978
1979 @deftypefun unsigned int gcry_md_get_algo_dlen (int @var{algo})
1980
1981 Retrieve the length in bytes of the digest yielded by algorithm
1982 @var{algo}.  This is often used prior to @code{gcry_md_read} to allocate
1983 sufficient memory for the digest.
1984 @end deftypefun
1985
1986
1987 In some situations it might be hard to remember the algorithm used for
1988 the ongoing hashing. The following function might be used to get that
1989 information:
1990
1991 @deftypefun int gcry_md_get_algo (gcry_md_hd_t @var{h})
1992
1993 Retrieve the algorithm used with the handle @var{h}. Note, that this
1994 does not work reliable if more than one algorithm is enabled in @var{h}.
1995 @end deftypefun
1996
1997 The following macro might also be useful:
1998
1999 @deftypefun int gcry_md_is_secure (gcry_md_hd_t @var{h})
2000
2001 This function returns true when the digest object @var{h} is allocated
2002 in "secure memory"; i.e. @var{h} was created with the
2003 @code{GCRY_MD_FLAG_SECURE}.
2004 @end deftypefun
2005
2006 @deftypefun int gcry_md_is_enabled (gcry_md_hd_t @var{h}, int @var{algo})
2007
2008 This function returns true when the algorithm @var{algo} has been
2009 enabled for the digest object @var{h}.
2010 @end deftypefun
2011
2012
2013
2014 Tracking bugs related to hashing is often a cumbersome task which
2015 requires to add a lot of printf statements into the code.  @acronym{Libgcrypt}
2016 provides an easy way to avoid this.  The actual data hashed can be
2017 written to files on request.  The following 2 macros should be used to
2018 implement such a debugging facility:
2019
2020 @deftypefun void gcry_md_start_debug (gcry_md_hd_t @var{h}, const char *@var{suffix})
2021
2022 Enable debugging for the digest object with handle @var{h}.  This
2023 creates create files named @file{dbgmd-<n>.<string>} while doing the
2024 actual hashing.  @var{suffix} is the string part in the filename.  The
2025 number is a counter incremented for each new hashing.  The data in the
2026 file is the raw data as passed to @code{gcry_md_write} or
2027 @code{gcry_md_putc}.
2028 @end deftypefun
2029
2030
2031 @deftypefun void gcry_md_stop_debug (gcry_md_hd_t @var{h}, int @var{reserved})
2032
2033 Stop debugging on handle @var{h}.  @var{reserved} should be specified as
2034 0.  This function is usually not required because @code{gcry_md_close}
2035 does implicitly stop debugging.
2036 @end deftypefun
2037
2038
2039 @c **********************************************************
2040 @c *******************  Public Key  *************************
2041 @c **********************************************************
2042 @node Public Key cryptography (I)
2043 @chapter Public Key cryptography (I)
2044
2045 Public key cryptography, also known as asymmetric cryptography, is an
2046 easy way for key management and to provide digital signatures.
2047 @acronym{Libgcrypt} provides two completely different interfaces to
2048 public key cryptography, this chapter explains the one based on
2049 S-expressions.
2050
2051 @menu
2052 * Available algorithms::        Algorithms supported by the library.
2053 * Used S-expressions::          Introduction into the used S-expression.
2054 * Public key modules::          How to work with public key modules.
2055 * Cryptographic Functions::     Functions for performing the cryptographic actions.
2056 * General public-key related Functions::  General functions, not implementing any cryptography.
2057 @end menu
2058
2059 @node Available algorithms
2060 @section Available algorithms
2061
2062 @acronym{Libgcrypt} supports the RSA (Rivest-Shamir-Adleman) algorithms as well
2063 as DSA (Digital Signature Algorithm) and ElGamal.  The versatile
2064 interface allows to add more algorithms in the future.
2065
2066 @node Used S-expressions
2067 @section Used S-expressions
2068
2069 @acronym{Libgcrypt}'s API for asymmetric cryptography is based on data
2070 structures called S-expressions (see XXXX) and does not work with
2071 contexts as most of the other building blocks of @acronym{Libgcrypt}
2072 do.
2073
2074 The following information are stored in S-expressions:
2075
2076 @table @asis
2077 @item keys
2078
2079 @item plain text data
2080
2081 @item encrypted data
2082
2083 @item signatures
2084
2085 @end table
2086
2087 @noindent
2088 To describe how @acronym{Libgcrypt} expect keys, we use some examples. Note that
2089 words in
2090 @ifnottex
2091 uppercase
2092 @end ifnottex
2093 @iftex
2094 italics
2095 @end iftex
2096 indicate parameters whereas lowercase words are literals.
2097
2098 @example
2099 (private-key
2100   (dsa
2101     (p @var{p-mpi})
2102     (q @var{q-mpi})
2103     (g @var{g-mpi})
2104     (y @var{y-mpi})
2105     (x @var{x-mpi})))
2106 @end example
2107
2108 @noindent
2109 This specifies a DSA private key with the following parameters:
2110
2111 @table @var
2112 @item p-mpi
2113 DSA prime @math{p}.
2114 @item q-mpi
2115 DSA group order @math{q} (which is a prime divisor of @math{p-1}).
2116 @item g-mpi
2117 DSA group generator @math{g}.
2118 @item y-mpi
2119 DSA public key value @math{y = g^x \bmod p}.
2120 @item x-mpi
2121 DSA secret exponent x.
2122 @end table
2123
2124 All the MPI values are  expected to be in @code{GCRYMPI_FMT_USG} format.
2125 The public key is similar with "private-key" replaced by "public-key"
2126 and no @var{x-mpi}.
2127
2128 An easy way to create such an S-expressions is by using
2129 @code{gcry_sexp_build} which allows to pass a string with printf-like
2130 escapes to insert MPI values.
2131
2132 @noindent
2133 Here is an example for an RSA key:
2134
2135 @example
2136 (private-key
2137   (rsa
2138     (n @var{n-mpi})
2139     (e @var{e-mpi})
2140     (d @var{d-mpi})
2141     (p @var{p-mpi})
2142     (q @var{q-mpi})
2143     (u @var{u-mpi})
2144 @end example
2145
2146 @noindent
2147 with
2148
2149 @table @var
2150 @item n-mpi
2151 RSA public modulus @math{n}.
2152 @item e-mpi
2153 RSA public exponent @math{e}.
2154 @item d-mpi
2155 RSA secret exponent @math{d = e^{-1} \bmod (p-1)(q-1)}.
2156 @item p-mpi
2157 RSA secret prime @math{p}.
2158 @item q-mpi
2159 RSA secret prime @math{q} with @math{q > p}.
2160 @item u-mpi
2161 multiplicative inverse @math{u = p^{-1} \bmod q}.
2162 @end table
2163
2164 @node Public key modules
2165 @section Public key modules
2166
2167 @acronym{Libgcrypt} makes it possible to load additional `public key
2168 modules'; these public key algorithms can be used just like the
2169 algorithms that are built into the library directly.  For an
2170 introduction into extension modules, see @xref{Modules}.
2171
2172 @deftp {Data type} gcry_pk_spec_t
2173 This is the `module specification structure' needed for registering
2174 public key modules, which has to be filled in by the user before it
2175 can be used to register a module.  It contains the following members:
2176
2177 @table @code
2178 @item const char *name
2179 The primary name of this algorithm.
2180 @item char **aliases
2181 A list of strings that are `aliases' for the algorithm.  The list
2182 must be terminated with a NULL element.
2183 @item const char *elements_pkey
2184 String containing the one-letter names of the MPI values contained in
2185 a public key.
2186 @item const char *element_skey
2187 String containing the one-letter names of the MPI values contained in
2188 a secret key.
2189 @item const char *elements_enc
2190 String containing the one-letter names of the MPI values that are the
2191 result of an encryption operation using this algorithm.
2192 @item const char *elements_sig
2193 String containing the one-letter names of the MPI values that are the
2194 result of a sign operation using this algorithm.
2195 @item const char *elements_grip
2196 String containing the one-letter names of the MPI values that are to
2197 be included in the `key grip'.
2198 @item int use
2199 The bitwise-OR of the following flags, depending on the abilities of
2200 the algorithm:
2201 @table @code
2202 @item GCRY_PK_USAGE_SIGN
2203 The algorithm supports signing and verifying of data.
2204 @item GCRY_PK_USAGE_ENCR
2205 The algorithm supports the encryption and decryption of data.
2206 @end table
2207 @item gcry_pk_generate_t generate
2208 The function responsible for generating a new key pair.  See below for
2209 a description of this type.
2210 @item gcry_pk_check_secret_key_t check_secret_key
2211 The function responsible for checking the sanity of a provided secret
2212 key.  See below for a description of this type.
2213 @item gcry_pk_encrypt_t encrypt
2214 The function responsible for encrypting data.  See below for a
2215 description of this type.
2216 @item gcry_pk_decrypt_t decrypt
2217 The function responsible for decrypting data.  See below for a
2218 description of this type.
2219 @item gcry_pk_sign_t sign
2220 The function responsible for signing data.  See below for a description
2221 of this type.
2222 @item gcry_pk_verify_t verify
2223 The function responsible for verifying that the provided signature
2224 matches the provided data.  See below for a description of this type.
2225 @item gcry_pk_get_nbits_t get_nbits
2226 The function responsible for returning the number of bits of a provided
2227 key.  See below for a description of this type.
2228 @end table
2229 @end deftp
2230
2231 @deftp {Data type} gcry_pk_generate_t
2232 Type for the `generate' function, defined as: gcry_err_code_t
2233 (*gcry_pk_generate_t) (int algo, unsigned int nbits, unsigned long
2234 use_e, gcry_mpi_t *skey, gcry_mpi_t **retfactors)
2235 @end deftp
2236
2237 @deftp {Data type} gcry_pk_check_secret_key_t
2238 Type for the `check_secret_key' function, defined as: gcry_err_code_t
2239 (*gcry_pk_check_secret_key_t) (int algo, gcry_mpi_t *skey)
2240 @end deftp
2241
2242 @deftp {Data type} gcry_pk_encrypt_t
2243 Type for the `encrypt' function, defined as: gcry_err_code_t
2244 (*gcry_pk_encrypt_t) (int algo, gcry_mpi_t *resarr, gcry_mpi_t data,
2245 gcry_mpi_t *pkey, int flags)
2246 @end deftp
2247
2248 @deftp {Data type} gcry_pk_decrypt_t
2249 Type for the `decrypt' function, defined as: gcry_err_code_t
2250 (*gcry_pk_decrypt_t) (int algo, gcry_mpi_t *result, gcry_mpi_t *data,
2251 gcry_mpi_t *skey, int flags)
2252 @end deftp
2253
2254 @deftp {Data type} gcry_pk_sign_t
2255 Type for the `sign' function, defined as: gcry_err_code_t
2256 (*gcry_pk_sign_t) (int algo, gcry_mpi_t *resarr, gcry_mpi_t data,
2257 gcry_mpi_t *skey)
2258 @end deftp
2259
2260 @deftp {Data type} gcry_pk_verify_t
2261 Type for the `verify' function, defined as: gcry_err_code_t
2262 (*gcry_pk_verify_t) (int algo, gcry_mpi_t hash, gcry_mpi_t *data,
2263 gcry_mpi_t *pkey, int (*cmp) (void *, gcry_mpi_t), void *opaquev)
2264 @end deftp
2265
2266 @deftp {Data type} gcry_pk_get_nbits_t
2267 Type for the `get_nbits' function, defined as: unsigned
2268 (*gcry_pk_get_nbits_t) (int algo, gcry_mpi_t *pkey)
2269 @end deftp
2270
2271 @deftypefun gcry_error_t gcry_pk_register (gcry_pk_spec_t *@var{pubkey}, unsigned int *algorithm_id, gcry_module_t *@var{module})
2272
2273 Register a new public key module whose specification can be found in
2274 @var{pubkey}.  On success, a new algorithm ID is stored in
2275 @var{algorithm_id} and a pointer representing this module is stored
2276 in @var{module}.
2277 @end deftypefun
2278
2279 @deftypefun void gcry_pk_unregister (gcry_module_t @var{module})
2280 Unregister the public key module identified by @var{module}, which
2281 must have been registered with gcry_pk_register.
2282 @end deftypefun
2283
2284 @deftypefun gcry_error_t gcry_pk_list (int *@var{list}, int *@var{list_length})
2285 Get a list consisting of the IDs of the loaded pubkey modules.  If
2286 @var{list} is zero, write the number of loaded pubkey modules to
2287 @var{list_length} and return.  If @var{list} is non-zero, the first
2288 *@var{list_length} algorithm IDs are stored in @var{list}, which must
2289 be of according size.  In case there are less pubkey modules than
2290 *@var{list_length}, *@var{list_length} is updated to the correct
2291 number.
2292 @end deftypefun
2293
2294 @node Cryptographic Functions
2295 @section Cryptographic Functions
2296
2297 @noindent
2298 Note, that we will in future allow to use keys without p,q and u
2299 specified and may also support other parameters for performance
2300 reasons. 
2301
2302 @noindent
2303
2304 Some functions operating on S-expressions support `flags', that
2305 influence the operation.  These flags have to be listed in a
2306 sub-S-expression named `flags'; the following flags are known:
2307
2308 @table @var
2309 @item pkcs1
2310 Use PKCS#1 block type 2 padding.
2311 @item no-blinding
2312 Do not use a technique called `blinding', which is used by default in
2313 order to prevent leaking of secret information.  Blinding is only
2314 implemented by RSA, but it might be implemented by other algorithms in
2315 the future as well, when necessary.
2316 @end table
2317
2318 @noindent
2319 Now that we know the key basics, we can carry on and explain how to
2320 encrypt and decrypt data.  In almost all cases the data is a random
2321 session key which is in turn used for the actual encryption of the real
2322 data.  There are 2 functions to do this:
2323
2324 @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}})
2325
2326 Obviously a public key must be provided for encryption.  It is
2327 expected as an appropriate S-expression (see above) in @var{pkey}.
2328 The data to be encrypted can either be in the simple old format, which
2329 is a very simple S-expression consisting only of one MPI, or it may be
2330 a more complex S-expression which also allows to specify flags for
2331 operation, like e.g. padding rules.
2332
2333 @noindent
2334 If you don't want to let @acronym{Libgcrypt} handle the padding, you must pass an
2335 appropriate MPI using this expression for @var{data}:
2336
2337 @example 
2338 (data
2339   (flags raw)
2340   (value @var{mpi}))
2341 @end example
2342
2343 @noindent
2344 This has the same semantics as the old style MPI only way.  @var{MPI} is
2345 the actual data, already padded appropriate for your protocol.  Most
2346 systems however use PKCS#1 padding and so you can use this S-expression
2347 for @var{data}:
2348
2349 @example 
2350 (data
2351   (flags pkcs1)
2352   (value @var{block}))
2353 @end example
2354
2355 @noindent
2356 Here, the "flags" list has the "pkcs1" flag which let the function know
2357 that it should provide PKCS#1 block type 2 padding.  The actual data to
2358 be encrypted is passed as a string of octets in @var{block}.  The
2359 function checks that this data actually can be used with the given key,
2360 does the padding and encrypts it.
2361
2362 If the function could successfully perform the encryption, the return
2363 value will be 0 and a a new S-expression with the encrypted result is
2364 allocated and assign to the variable at the address of @var{r_ciph}.
2365 The caller is responsible to release this value using
2366 @code{gcry_sexp_release}.  In case of an error, an error code is
2367 returned and @var{r_ciph} will be set to @code{NULL}.
2368
2369 @noindent
2370 The returned S-expression has this format when used with RSA:
2371
2372 @example
2373 (enc-val
2374   (rsa
2375     (a @var{a-mpi})))
2376 @end example
2377
2378 @noindent
2379 Where @var{a-mpi} is an MPI with the result of the RSA operation.  When
2380 using the ElGamal algorithm, the return value will have this format:
2381
2382 @example
2383 (enc-val
2384   (elg
2385     (a @var{a-mpi})
2386     (b @var{b-mpi})))
2387 @end example
2388
2389 @noindent
2390 Where @var{a-mpi} and @var{b-mpi} are MPIs with the result of the
2391 ElGamal encryption operation.
2392 @end deftypefun
2393 @c end gcry_pk_encrypt
2394
2395 @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}})
2396
2397 Obviously a private key must be provided for decryption.  It is expected
2398 as an appropriate S-expression (see above) in @var{skey}.  The data to
2399 be decrypted must match the format of the result as returned by
2400 @code{gcry_pk_encrypt}, but should be enlarged with a @code{flags}
2401 element:
2402
2403 @example
2404 (enc-val
2405   (flags)
2406   (elg
2407     (a @var{a-mpi})
2408     (b @var{b-mpi})))
2409 @end example
2410
2411 @noindent
2412 Note, that this function currently does not know of any padding
2413 methods and the caller must do any un-padding on his own.
2414
2415 @noindent
2416 The function returns 0 on success or an error code.  The variable at the
2417 address of @var{r_plain} will be set to NULL on error or receive the
2418 decrypted value on success.  The format of @var{r_plain} is a
2419 simple S-expression part (i.e. not a valid one) with just one MPI if
2420 there was no @code{flags} element in @var{data}; if at least an empty
2421 @code{flags} is passed in @var{data}, the format is:
2422
2423 @example
2424 (value @var{plaintext})
2425 @end example
2426 @end deftypefun
2427 @c end gcry_pk_decrypt
2428
2429
2430 Another operation commonly performed using public key cryptography is
2431 signing data.  In some sense this is even more important than
2432 encryption because digital signatures are an important instrument for
2433 key management.  @acronym{Libgcrypt} supports digital signatures using
2434 2 functions, similar to the encryption functions:
2435
2436 @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}})
2437
2438 This function creates a digital signature for @var{data} using the
2439 private key @var{skey} and place it into the variable at the address of
2440 @var{r_sig}.  @var{data} may either be the simple old style S-expression
2441 with just one MPI or a modern and more versatile S-expression which
2442 allows to let @acronym{Libgcrypt} handle padding:
2443
2444 @example 
2445  (data
2446   (flags pkcs1)
2447   (hash @var{hash-algo} @var{block}))
2448 @end example
2449
2450 @noindent
2451 This example requests to sign the data in @var{block} after applying
2452 PKCS#1 block type 1 style padding.  @var{hash-algo} is a string with the
2453 hash algorithm to be encoded into the signature, this may be any hash
2454 algorithm name as supported by @acronym{Libgcrypt}.  Most likely, this will be
2455 "sha1", "rmd160" or "md5".  It is obvious that the length of @var{block}
2456 must match the size of that message digests; the function checks that
2457 this and other constraints are valid.
2458
2459 @noindent
2460 If PKCS#1 padding is not required (because the caller does already
2461 provide a padded value), either the old format or better the following
2462 format should be used:
2463
2464 @example
2465 (data
2466   (flags raw)
2467   (value @var{mpi}))
2468 @end example
2469
2470 @noindent
2471 Here, the data to be signed is directly given as an @var{MPI}.
2472
2473 @noindent
2474 The signature is returned as a newly allocated S-expression in
2475 @var{r_sig} using this format for RSA:
2476
2477 @example
2478 (sig-val
2479   (rsa
2480     (s @var{s-mpi})))
2481 @end example
2482
2483 Where @var{s-mpi} is the result of the RSA sign operation.  For DSA the
2484 S-expression returned is:
2485
2486 @example
2487 (sig-val
2488   (dsa
2489     (r @var{r-mpi})
2490     (s @var{s-mpi})))
2491 @end example
2492
2493 Where @var{r-mpi} and @var{s-mpi} are the result of the DSA sign
2494 operation.  For ElGamal signing (which is slow, yields large numbers
2495 and probably is not as secure as the other algorithms), the same format is
2496 used with "elg" replacing "dsa".
2497 @end deftypefun
2498 @c end gcry_pk_sign
2499
2500 @noindent
2501 The operation most commonly used is definitely the verification of a
2502 signature.  @acronym{Libgcrypt} provides this function:
2503
2504 @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}})
2505
2506 This is used to check whether the signature @var{sig} matches the
2507 @var{data}.  The public key @var{pkey} must be provided to perform this
2508 verification.  This function is similar in its parameters to
2509 @code{gcry_pk_sign} with the exceptions that the public key is used
2510 instead of the private key and that no signature is created but a
2511 signature, in a format as created by @code{gcry_pk_sign}, is passed to
2512 the function in @var{sig}.
2513
2514 @noindent
2515 The result is 0 for success (i.e. the data matches the signature), or an
2516 error code where the most relevant code is @code{GCRYERR_BAD_SIGNATURE}
2517 to indicate that the signature does not match the provided data.
2518
2519 @end deftypefun
2520 @c end gcry_pk_verify
2521
2522 @node General public-key related Functions
2523 @section General public-key related Functions
2524
2525 @noindent
2526 A couple of utility functions are available to retrieve the length of
2527 the key, map algorithm identifiers and perform sanity checks:
2528
2529 @deftypefun {const char *} gcry_pk_algo_name (int @var{algo})
2530
2531 Map the public key algorithm id @var{algo} to a string representation of
2532 the algorithm name.  For unknown algorithms this functions returns an
2533 empty string.
2534 @end deftypefun
2535
2536 @deftypefun int gcry_pk_map_name (const char *@var{name})
2537
2538 Map the algorithm @var{name} to a public key algorithm Id.  Returns 0 if
2539 the algorithm name is not known.
2540 @end deftypefun
2541
2542 @deftypefun int gcry_pk_test_algo (int @var{algo})
2543
2544 Return 0 if the public key algorithm @var{algo} is available for use.
2545 Note, that this is implemented as a macro.
2546 @end deftypefun
2547
2548
2549 @deftypefun {unsigned int} gcry_pk_get_nbits (gcry_sexp_t @var{key})
2550
2551 Return what is commonly referred as the key length for the given
2552 public or private in @var{key}.
2553 @end deftypefun
2554
2555 @deftypefun {unsigned char *} gcry_pk_get_keygrip (@w{gcry_sexp_t @var{key}}, @w{unsigned char *@var{array}})
2556
2557 Return the so called "keygrip" which is the SHA-1 hash of the public key
2558 parameters expressed in a way depended on the algorithm.  @var{array}
2559 must either provide space for 20 bytes or @code{NULL;}. In the latter
2560 case a newly allocated array of that size is returned.  On success a
2561 pointer to the newly allocated space or to @var{array} is returned.
2562 @code{NULL} is returned to indicate an error which is most likely an unknown
2563 algorithm or one where a "keygrip" has not yet been defined.
2564 The function accepts public or secret keys in @var{key}.
2565 @end deftypefun
2566
2567 @deftypefun gcry_error_t gcry_pk_testkey (gcry_sexp_t @var{key})
2568
2569 Return zero if the private key @var{key} is `sane', an error code otherwise.
2570 Note, that it is not possible to chek the `saneness' of a public key.
2571
2572 @end deftypefun
2573
2574
2575 @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}})
2576
2577 Depending on the value of @var{what} return various information about
2578 the public key algorithm with the id @var{algo}.  Note, that the
2579 function returns @code{-1} on error and the actual error code must be
2580 retrieved using the function @code{gcry_errno}.  The currently defined
2581 values for @var{what} are:
2582
2583 @table @code
2584 @item GCRYCTL_TEST_ALGO:
2585 Return 0 when the specified algorithm is available for use.
2586 @var{buffer} must be @code{NULL}, @var{nbytes} may be passed as
2587 @code{NULL} or point to a variable with the required usage of the
2588 algorithm. This may be 0 for "don't care" or the bit-wise OR of these
2589 flags:
2590
2591 @table @code
2592 @item GCRY_PK_USAGE_SIGN 
2593 Algorithm is usable for signing.
2594 @item GCRY_PK_USAGE_ENCR 
2595 Algorithm is usable for encryption.
2596 @end table
2597
2598 @item GCRYCTL_GET_ALGO_USAGE:
2599 Return the usage flags for the given algorithm.  An invalid algorithm
2600 return 0.  Disabled algorithms are ignored here because we
2601 want to know whether the algorithm is at all capable of a certain usage.
2602
2603 @item GCRYCTL_GET_ALGO_NPKEY
2604 Return the number of elements the public key for algorithm @var{algo}
2605 consist of.  Return 0 for an unknown algorithm.
2606
2607 @item GCRYCTL_GET_ALGO_NSKEY
2608 Return the number of elements the private key for algorithm @var{algo}
2609 consist of.  Note that this value is always larger than that of the
2610 public key.  Return 0 for an unknown algorithm.
2611
2612 @item GCRYCTL_GET_ALGO_NSIGN
2613 Return the number of elements a signature created with the algorithm
2614 @var{algo} consists of.  Return 0 for an unknown algorithm or for an
2615 algorithm not capable of creating signatures.
2616
2617 @item GCRYCTL_GET_ALGO_NENC
2618 Return the number of elements a encrypted message created with the algorithm
2619 @var{algo} consists of.  Return 0 for an unknown algorithm or for an
2620 algorithm not capable of encryption.
2621 @end table
2622
2623 @noindent
2624 Please note that parameters not required should be passed as @code{NULL}.
2625 @end deftypefun
2626 @c end gcry_pk_algo_info
2627
2628
2629 @deftypefun gcry_error_t gcry_pk_ctl (@w{int @var{cmd}}, @w{void *@var{buffer}}, @w{size_t @var{buflen}})
2630
2631 This is a general purpose function to perform certain control
2632 operations.  @var{cmd} controls what is to be done. The return value is
2633 0 for success or an error code.  Currently supported values for
2634 @var{cmd} are:
2635
2636 @table @code
2637 @item GCRYCTL_DISABLE_ALGO
2638 Disable the algorithm given as an algorithm id in @var{buffer}.
2639 @var{buffer} must point to an @code{int} variable with the algorithm id
2640 and @var{buflen} must have the value @code{sizeof (int)}.
2641
2642 @end table
2643 @end deftypefun
2644 @c end gcry_pk_ctl
2645
2646 @noindent
2647 @acronym{Libgcrypt} also provides a function for generating public key
2648 pairs:
2649
2650 @deftypefun gcry_error_t gcry_pk_genkey (@w{gcry_sexp_t *@var{r_key}}, @w{gcry_sexp_t @var{parms}})
2651
2652 This function create a new public key pair using information given in
2653 the S-expression @var{parms} and stores the private and the public key
2654 in one new S-expression at the address given by @var{r_key}.  In case of
2655 an error, @var{r_key} is set to @code{NULL}.  The return code is 0 for
2656 success or an error code otherwise.
2657
2658 @noindent
2659 Here is an example for @var{parms} for creating a 1024 bit RSA key:
2660
2661 @example
2662 (genkey
2663   (rsa
2664     (nbits 4:1024)))
2665 @end example
2666
2667 @noindent
2668 To create an ElGamal key, substitute "elg" for "rsa" and to create a DSA
2669 key use "dsa".  Valid ranges for the key length depend on the
2670 algorithms; all commonly used key lengths are supported.  Currently
2671 supported parameters are:
2672
2673 @table @code
2674 @item nbits
2675 This is always required to specify the length of the key.  The argument
2676 is a string with a number in C-notation.
2677
2678 @item rsa-use-e
2679 This is only used with RSA to give a hint for the public exponent. The
2680 value will be used as a base to test for a usable exponent. Some values
2681 are special:
2682
2683 @table @samp
2684 @item 0
2685 Use a secure and fast value.  This is currently the number 41.
2686 @item 1
2687 Use a secure value as required by some specification.  This is currently
2688 the number 65537.
2689 @item 2
2690 Reserved
2691 @end table
2692
2693 @noindent
2694 If this parameter is not used, @acronym{Libgcrypt} uses for historic reasons
2695 65537.
2696
2697 @end table
2698 @c end table of parameters
2699
2700 @noindent
2701 The key pair is returned in a format depending on the algorithm.  Both
2702 private and public keys are returned in one container and may be
2703 accompanied by some miscellaneous information.
2704
2705 @noindent
2706 As an example, here is what the ElGamal key generation returns:
2707
2708 @example
2709 (key-data
2710   (public-key
2711     (elg
2712       (p @var{p-mpi})
2713       (g @var{g-mpi})
2714       (y @var{y-mpi})))
2715   (private-key
2716     (elg
2717       (p @var{p-mpi})
2718       (g @var{g-mpi})
2719       (y @var{y-mpi})
2720       (x @var{x-mpi})))
2721   (misc-key-info
2722     (pm1-factors @var{n1 n2 ... nn})))
2723 @end example
2724
2725 @noindent
2726 As you can see, some of the information is duplicated, but this provides
2727 an easy way to extract either the public or the private key.  Note that
2728 the order of the elements is not defined, e.g. the private key may be
2729 stored before the public key. @var{n1 n2 ... nn} is a list of prime
2730 numbers used to composite @var{p-mpi}; this is in general not a very
2731 useful information.
2732 @end deftypefun
2733 @c end gcry_pk_genkey
2734
2735 @node Public Key cryptography (II)
2736 @chapter Public Key cryptography (II)
2737
2738 This chapter documents the alternative interface to asymmetric
2739 cryptography (ac) that is not based on S-expressions, but on native C
2740 data structures.  As opposed to the pk interface described in the
2741 former chapter, this one follows an open/use/close paradigm like other
2742 building blocks of the library.
2743
2744 @menu
2745 * Available asymmetric algorithms::  List of algorithms supported by the library.
2746 * Working with sets of data::   How to work with sets of data.
2747 * Working with IO objects::     How to work with IO objects.
2748 * Working with handles::        How to use handles.
2749 * Working with keys::           How to work with keys.
2750 * Using cryptographic functions::  How to perform cryptographic operations.
2751 * Handle-independent functions::  General functions independent of handles.
2752 @end menu
2753
2754 @node Available asymmetric algorithms
2755 @section Available asymmetric algorithms
2756
2757 @acronym{Libgcrypt} supports the RSA (Rivest-Shamir-Adleman)
2758 algorithms as well as DSA (Digital Signature Algorithm) and ElGamal.
2759 The versatile interface allows to add more algorithms in the future.
2760
2761 @deftp {Data type} gcry_ac_id_t
2762
2763 The following constants are defined for this type:
2764
2765 @table @code
2766 @item GCRY_AC_RSA
2767 Riven-Shamir-Adleman
2768 @item GCRY_AC_DSA
2769 Digital Signature Algorithm
2770 @item GCRY_AC_ELG
2771 ElGamal
2772 @item GCRY_AC_ELG_E
2773 ElGamal, encryption only.
2774 @end table
2775 @end deftp
2776
2777 @node Working with sets of data
2778 @section Working with sets of data
2779
2780 In the context of this interface the term `data set' refers to a list
2781 of `named MPI values' that is used by functions performing
2782 cryptographic operations; a named MPI value is a an MPI value,
2783 associated with a label.
2784
2785 Such data sets are used for representing keys, since keys simply
2786 consist of a variable amount of numbers.  Furthermore some functions
2787 return data sets to the caller that are to be provided to other
2788 functions.
2789
2790 This section documents the data types, symbols and functions that are
2791 relevant for working with data sets.
2792
2793 @deftp {Data type} gcry_ac_data_t
2794 A single data set.
2795 @end deftp
2796
2797 The following flags are supported:
2798
2799 @table @code
2800 @item GCRY_AC_FLAG_DEALLOC
2801 Used for storing data in a data set.  If given, the data will be
2802 released by the library.  Note that whenever one of the ac functions
2803 is about to release objects because of this flag, the objects are
2804 expected to be stored in memory allocated through the Libgcrypt memory
2805 management.  In other words: gcry_free() is used instead of free().
2806
2807 @item GCRY_AC_FLAG_COPY
2808 Used for storing/retrieving data in/from a data set.  If given, the
2809 library will create copies of the provided/contained data, which will
2810 then be given to the user/associated with the data set.
2811 @end table
2812
2813 @deftypefun gcry_error_t gcry_ac_data_new (gcry_ac_data_t *@var{data})
2814 Creates a new, empty data set and stores it in @var{data}.
2815 @end deftypefun
2816
2817 @deftypefun void gcry_ac_data_destroy (gcry_ac_data_t @var{data})
2818 Destroys the data set @var{data}.
2819 @end deftypefun
2820
2821 @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})
2822 Add the value @var{mpi} to @var{data} with the label @var{name}.  If
2823 @var{flags} contains GCRY_AC_FLAG_DATA_COPY, the data set will contain
2824 copies of @var{name} and @var{mpi}.  If @var{flags} contains
2825 GCRY_AC_FLAG_DATA_DEALLOC or GCRY_AC_FLAG_DATA_COPY, the values
2826 contained in the data set will be deallocated when they are to be
2827 removed from the data set.
2828 @end deftypefun
2829
2830 @deftypefun gcry_error_t gcry_ac_data_copy (gcry_ac_data_t *@var{data_cp}, gcry_ac_data_t @var{data})
2831 Create a copy of the data set @var{data} and store it in
2832 @var{data_cp}.  FIXME: exact semantics undefined.
2833 @end deftypefun
2834
2835 @deftypefun unsigned int gcry_ac_data_length (gcry_ac_data_t @var{data})
2836 Returns the number of named MPI values inside of the data set
2837 @var{data}.
2838 @end deftypefun
2839
2840 @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})
2841 Store the value labelled with @var{name} found in @var{data} in
2842 @var{mpi}.  If @var{flags} contains GCRY_AC_FLAG_COPY, store a copy of
2843 the @var{mpi} value contained in the data set.  @var{mpi} may be NULL
2844 (this might be useful for checking the existence of an MPI with
2845 extracting it).
2846 @end deftypefun
2847
2848 @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})
2849 Stores in @var{name} and @var{mpi} the named @var{mpi} value contained
2850 in the data set @var{data} with the index @var{idx}.  If @var{flags}
2851 contains GCRY_AC_FLAG_COPY, store copies of the values contained in
2852 the data set. @var{name} or @var{mpi} may be NULL.
2853 @end deftypefun
2854
2855 @deftypefun void gcry_ac_data_clear (gcry_ac_data_t @var{data})
2856 Destroys any values contained in the data set @var{data}.
2857 @end deftypefun
2858
2859 @deftypefun gcry_error_t gcry_ac_data_to_sexp (gcry_ac_data_t @var{data}, gcry_sexp_t *@var{sexp}, const char **@var{identifiers})
2860 This function converts the data set @var{data} into a newly created
2861 S-Expression, which is to be stored in @var{sexp}; @var{identifiers}
2862 is a NULL terminated list of C strings, which specifies the structure
2863 of the S-Expression.
2864
2865 Example:
2866
2867 If @var{identifiers} is a list of pointers to the strings ``foo'' and
2868 ``bar'' and if @var{data} is a data set containing the values ``val1 =
2869 0x01'' and ``val2 = 0x02'', then the resulting S-Expression will look
2870 like this: (foo (bar ((val1 0x01) (val2 0x02))).
2871 @end deftypefun
2872
2873 @deftypefun gcry_error gcry_ac_data_from_sexp (gcry_ac_data_t *@var{data}, gcry_sexp_t @var{sexp}, const char **@var{identifiers})
2874 This function converts the S-Expression @var{sexp} into a newly
2875 created data set, which is to be stored in @var{data};
2876 @var{identifiers} is a NULL terminated list of C strings, which
2877 specifies the structure of the S-Expression.  If the list of
2878 identifiers does not match the structure of the S-Expression, the
2879 function fails.
2880 @end deftypefun
2881
2882 @node Working with IO objects
2883 @section Working with IO objects
2884
2885 Note: IO objects are currently only used in the context of message
2886 encoding/decoding and encryption/signature schemes.
2887
2888 @deftp {Data type} {gcry_ac_io_t}
2889 @code{gcry_ac_io_t} is the type to be used for IO objects.
2890 @end deftp
2891
2892 IO objects provide an uniform IO layer on top of different underlying
2893 IO mechanisms; either they can be used for providing data to the
2894 library (mode is GCRY_AC_IO_READABLE) or they can be used for
2895 retrieving data from the library (mode is GCRY_AC_IO_WRITABLE).
2896
2897 IO object need to be initialized by calling on of the following
2898 functions:
2899
2900 @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}, ...);
2901 Initialize @var{ac_io} according to @var{mode}, @var{type} and the
2902 variable list of arguments.  The list of variable arguments to specify
2903 depends on the given @var{type}.
2904 @end deftypefun
2905
2906 @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});
2907 Initialize @var{ac_io} according to @var{mode}, @var{type} and the
2908 variable list of arguments @var{ap}.  The list of variable arguments
2909 to specify depends on the given @var{type}.
2910 @end deftypefun
2911
2912 The following types of IO objects exist:
2913
2914 @table @code
2915 @item GCRY_AC_IO_STRING
2916 In case of GCRY_AC_IO_READABLE the IO object will provide data from a
2917 memory string.  Arguments to specify at initialization time:
2918 @table @code
2919 @item unsigned char *
2920 Pointer to the beginning of the memory string
2921 @item size_t
2922 Size of the memory string
2923 @end table
2924 In case of GCRY_AC_IO_WRITABLE the object will store retrieved data in
2925 a newly allocated memory string.  Arguments to specify at
2926 initialization time:
2927 @table @code
2928 @item unsigned char **
2929 Pointer to address, at which the pointer to the newly created memory
2930 string is to be stored
2931 @item size_t *
2932 Pointer to address, at which the size of the newly created memory
2933 string is to be stored
2934 @end table
2935
2936 @item GCRY_AC_IO_CALLBACK
2937 In case of GCRY_AC_IO_READABLE the object will forward read requests
2938 to a provided callback function.  Arguments to specify at
2939 initialization time:
2940 @table @code
2941 @item gcry_ac_data_read_cb_t
2942 Callback function to use
2943 @item void *
2944 Opaque argument to provide to the callback function
2945 @end table
2946 In case of GCRY_AC_IO_WRITABLE the object will forward write requests
2947 to a provided callback function.  Arguments to specify at
2948 initialization time:
2949 @table @code
2950 @item gcry_ac_data_write_cb_t
2951 Callback function to use
2952 @item void *
2953 Opaque argument to provide to the callback function
2954 @end table
2955 @end table
2956
2957 @node Working with handles
2958 @section Working with handles
2959
2960 In order to use an algorithm, an according handle must be created.
2961 This is done using the following function:
2962
2963 @deftypefun gcry_error_t gcry_ac_open (gcry_ac_handle_t *@var{handle}, int @var{algorithm}, int @var{flags})
2964
2965 Creates a new handle for the algorithm @var{algorithm} and stores it
2966 in @var{handle}.  @var{flags} is not used currently.
2967
2968 @var{algorithm} must be a valid algorithm ID, see @xref{Available
2969 algorithms}, for a list of supported algorithms and the according
2970 constants.  Besides using the listed constants directly, the functions
2971 @code{gcry_ac_name_to_id} may be used to convert the textual name of
2972 an algorithm into the according numeric ID.
2973 @end deftypefun
2974
2975 @deftypefun void gcry_ac_close (gcry_ac_handle_t @var{handle})
2976 Destroys the handle @var{handle}.
2977 @end deftypefun
2978
2979 @node Working with keys
2980 @section Working with keys
2981
2982 @deftp {Data type} gcry_ac_key_type_t
2983 Defined constants:
2984
2985 @table @code
2986 @item GCRY_AC_KEY_TYPE_SECRET
2987 Specifies a secret key.
2988 @item GCRY_AC_KEY_TYPE_PUBLIC
2989 Specifies a public key.
2990 @end table
2991 @end deftp
2992
2993 @deftp {Data type} gcry_ac_key_t
2994 This type represents a single `key', either a secret one or a public
2995 one.
2996 @end deftp
2997
2998 @deftp {Data type} gcry_ac_key_pair_t
2999 This type represents a `key pair' containing a secret and a public key.
3000 @end deftp
3001
3002 Key data structures can be created in two different ways; a new key
3003 pair can be generated, resulting in ready-to-use key.  Alternatively a
3004 key can be initialized from a given data set.
3005
3006 @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})
3007 Creates a new key of type @var{type}, consisting of the MPI values
3008 contained in the data set @var{data} and stores it in @var{key}.
3009 @end deftypefun
3010
3011 @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})
3012
3013 Generates a new key pair via the handle @var{handle} of @var{NBITS}
3014 bits and stores it in @var{key_pair}.
3015
3016 In case non-standard settings are wanted, a pointer to a structure of
3017 type @code{gcry_ac_key_spec_<algorithm>_t}, matching the selected
3018 algorithm, can be given as @var{key_spec}.  @var{misc_data} is not
3019 used yet.  Such a structure does only exist for RSA.  A descriptions
3020 of the members of the supported structures follows.
3021
3022 @table @code
3023 @item gcry_ac_key_spec_rsa_t
3024 @table @code
3025 @item gcry_mpi_t e
3026 Generate the key pair using a special @code{e}.  The value of @code{e}
3027 has the following meanings:
3028 @table @code
3029 @item = 0
3030 Let @acronym{Libgcrypt} decide what exponent should be used.
3031 @item = 1
3032 Request the use of a ``secure'' exponent; this is required by some
3033 specification to be 65537.
3034 @item > 2
3035 Try starting at this value until a working exponent is found.  Note,
3036 that the current implementation leaks some information about the
3037 private key because the incrementation used is not randomized.  Thus,
3038 this function will be changed in the future to return a random
3039 exponent of the given size.
3040 @end table
3041 @end table
3042 @end table
3043
3044 Example code:
3045 @example
3046 @{
3047   gcry_ac_key_pair_t key_pair;
3048   gcry_ac_key_spec_rsa_t  rsa_spec;
3049
3050   rsa_spec.e = gcry_mpi_new (0);
3051   gcry_mpi_set_ui (rsa_spec.e, 1)
3052
3053   err = gcry_ac_open  (&handle, GCRY_AC_RSA, 0);
3054   assert (! err);
3055
3056   err = gcry_ac_key_pair_generate (handle, &key_pair, 1024, (void *) &rsa_spec);
3057   assert (! err);
3058 @}
3059 @end example
3060 @end deftypefun
3061
3062
3063 @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})
3064 Returns the key of type @var{which} out of the key pair
3065 @var{key_pair}.
3066 @end deftypefun
3067
3068 @deftypefun void gcry_ac_key_destroy (gcry_ac_key_t @var{key})
3069 Destroys the key @var{key}.
3070 @end deftypefun
3071
3072 @deftypefun void gcry_ac_key_pair_destroy (gcry_ac_key_pair_t @var{key_pair})
3073 Destroys the key pair @var{key_pair}.
3074 @end deftypefun
3075
3076 @deftypefun gcry_ac_data_t gcry_ac_key_data_get (gcry_ac_key_t @var{key})
3077 Returns the data set contained in the key @var{key}.
3078 @end deftypefun
3079
3080 @deftypefun gcry_error_t gcry_ac_key_test (gcry_ac_handle_t @var{handle}, gcry_ac_key_t @var{key})
3081 Verifies that the private key @var{key} is sane via @var{handle}.
3082 @end deftypefun
3083
3084 @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})
3085 Stores the number of bits of the key @var{key} in @var{nbits} via @var{handle}.
3086 @end deftypefun
3087
3088 @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})
3089 Writes the 20 byte long key grip of the key @var{key} to
3090 @var{key_grip} via @var{handle}.
3091 @end deftypefun
3092
3093 @node Using cryptographic functions
3094 @section Using cryptographic functions
3095
3096 The following flags might be relevant:
3097
3098 @table @code
3099 @item GCRY_AC_FLAG_NO_BLINDING
3100 Disable any blinding, which might be supported by the chosen
3101 algorithm; blinding is the default.
3102 @end table
3103
3104 There exist two kinds of cryptographic functions available through the
3105 ac interface: primitives, and high-level functions.
3106
3107 Primitives deal with MPIs (data sets) directly; what they provide is
3108 direct access to the cryptographic operations provided by an algorithm
3109 implementation.
3110
3111 High-level functions deal with octet strings, according to a specified
3112 ``scheme''.  Schemes make use of ``encoding methods'', which are
3113 responsible for converting the provided octet strings into MPIs, which
3114 are then forwared to the cryptographic primitives.  Since schemes are
3115 to be used for a special purpose in order to achieve a particular
3116 security goal, there exist ``encryption schemes'' and ``signature
3117 schemes''.  Encoding methods can be used seperately or implicitly
3118 through schemes.
3119
3120 What follows is a description of the cryptographic primitives.
3121
3122 @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})
3123 Encrypts the plain text MPI value @var{data_plain} with the key public
3124 @var{key} under the control of the flags @var{flags} and stores the
3125 resulting data set into @var{data_encrypted}.
3126 @end deftypefun
3127
3128 @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})
3129 Decrypts the encrypted data contained in the data set
3130 @var{data_encrypted} with the secret key KEY under the control of the
3131 flags @var{flags} and stores the resulting plain text MPI value in
3132 @var{DATA_PLAIN}.
3133 @end deftypefun
3134
3135 @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})
3136 Signs the data contained in @var{data} with the secret key @var{key}
3137 and stores the resulting signature in the data set
3138 @var{data_signature}.
3139 @end deftypefun
3140
3141 @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})
3142 Verifies that the signature contained in the data set
3143 @var{data_signature} is indeed the result of signing the data
3144 contained in @var{data} with the secret key belonging to the public
3145 key @var{key}.
3146 @end deftypefun
3147
3148 What follows is a description of the high-level functions.
3149
3150 The type ``gcry_ac_em_t'' is used for specifying encoding methods; the
3151 following methods are supported:
3152
3153 @table @code
3154 @item GCRY_AC_EME_PKCS_V1_5
3155 PKCS-V1_5 Encoding Method for Encryption.  Options must be provided
3156 through a pointer to a correctly initialized object of type
3157 gcry_ac_eme_pkcs_v1_5_t.
3158
3159 @item GCRY_AC_EMSA_PKCS_V1_5
3160 PKCS-V1_5 Encoding Method for Signatures with Appendix.  Options must
3161 be provided through a pointer to a correctly initialized object of
3162 type gcry_ac_emsa_pkcs_v1_5_t.
3163 @end table
3164
3165 Option structure types:
3166
3167 @table @code
3168 @item gcry_ac_eme_pkcs_v1_5_t
3169 @table @code
3170 @item gcry_ac_key_t key
3171 @item gcry_ac_handle_t handle
3172 @end table
3173 @item gcry_ac_emsa_pkcs_v1_5_t
3174 @table @code
3175 @item gcry_md_algo_t md
3176 @item size_t em_n
3177 @end table
3178 @end table
3179
3180 Encoding methods can be used directly through the following functions:
3181
3182 @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})
3183 Encodes the message contained in @var{m} of size @var{m_n} according
3184 to @var{method}, @var{flags} and @var{options}.  The newly created
3185 encoded message is stored in @var{em} and @var{em_n}.
3186 @end deftypefun
3187
3188 @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})
3189 Decodes the message contained in @var{em} of size @var{em_n} according
3190 to @var{method}, @var{flags} and @var{options}.  The newly created
3191 decoded message is stored in @var{m} and @var{m_n}.
3192 @end deftypefun
3193
3194 The type ``gcry_ac_scheme_t'' is used for specifying schemes; the
3195 following schemes are supported:
3196
3197 @table @code
3198 @item GCRY_AC_ES_PKCS_V1_5
3199 PKCS-V1_5 Encryption Scheme.  No options can be provided.
3200 @item GCRY_AC_SSA_PKCS_V1_5
3201 PKCS-V1_5 Signature Scheme (with Appendix).  Options can be provided
3202 through a pointer to a correctly initialized object of type
3203 gcry_ac_ssa_pkcs_v1_5_t.
3204 @end table
3205
3206 Option structure types:
3207
3208 @table @code
3209 @item gcry_ac_ssa_pkcs_v1_5_t
3210 @table @code
3211 @item gcry_md_algo_t md
3212 @end table
3213 @end table
3214
3215 The functions implementing schemes:
3216
3217 @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})
3218 Encrypts the plain text readable from @var{io_message} through
3219 @var{handle} with the public key @var{key} according to @var{scheme},
3220 @var{flags} and @var{opts}.  If @var{opts} is not NULL, it has to be a
3221 pointer to a structure specific to the chosen scheme (gcry_ac_es_*_t).
3222 The encrypted message is written to @var{io_cipher}.
3223 @end deftypefun
3224
3225 @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})
3226 Decrypts the cipher text readable from @var{io_cipher} through
3227 @var{handle} with the secret key @var{key} according to @var{scheme},
3228 @var{flags} and @var{opts}.  If @var{opts} is not NULL, it has to be a
3229 pointer to a structure specific to the chosen scheme (gcry_ac_es_*_t).
3230 The decrypted message is written to @var{io_message}.
3231 @end deftypefun
3232
3233 @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})
3234 Signs the message readable from @var{io_message} through @var{handle}
3235 with the secret key @var{key} according to @var{scheme}, @var{flags}
3236 and @var{opts}.  If @var{opts} is not NULL, it has to be a pointer to
3237 a structure specific to the chosen scheme (gcry_ac_ssa_*_t).  The
3238 signature is written to @var{io_signature}.
3239 @end deftypefun
3240
3241 @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})
3242 Verifies through @var{handle} that the signature readable from
3243 @var{io_signature} is indeed the result of signing the message
3244 readable from @var{io_message} with the secret key belonging to the
3245 public key @var{key} according to @var{scheme} and @var{opts}.  If
3246 @var{opts} is not NULL, it has to be an anonymous structure
3247 (gcry_ac_ssa_*_t) specific to the chosen scheme.
3248 @end deftypefun
3249
3250 @node Handle-independent functions
3251 @section Handle-independent functions
3252
3253 @deftypefun gcry_error_t gcry_ac_id_to_name (gcry_ac_id_t @var{algorithm}, const char **@var{name})
3254 Stores the textual representation of the algorithm whose id is given
3255 in @var{algorithm} in @var{name}.
3256 @end deftypefun
3257
3258 @deftypefun gcry_error_t gcry_ac_name_to_id (const char *@var{name}, gcry_ac_id_t *@var{algorithm})
3259 Stores the numeric ID of the algorithm whose textual representation is
3260 contained in @var{name} in @var{algorithm}.
3261 @end deftypefun
3262
3263 @c **********************************************************
3264 @c *******************  Random  *****************************
3265 @c **********************************************************
3266 @node Random Numbers
3267 @chapter Random Numbers
3268
3269 @menu
3270 * Quality of random numbers::   @acronym{Libgcrypt} uses different quality levels.
3271 * Retrieving random numbers::   How to retrieve random numbers.
3272 @end menu
3273
3274 @node Quality of random numbers
3275 @section Quality of random numbers
3276
3277 @acronym{Libgcypt} offers random numbers of different quality levels:
3278
3279 @deftp {Data type} enum gcry_random_level
3280 The constants for the random quality levels are of this type.
3281 @end deftp
3282
3283 @table @code
3284 @item GCRY_WEAK_RANDOM
3285 This should not anymore be used.  It has recently been changed to an
3286 alias of GCRY_STRONG_RANDOM.  Use @code{gcry_create_nonce} instead.
3287 @item GCRY_STRONG_RANDOM
3288 Use this level for e.g. session keys and similar purposes.
3289 @item GCRY_VERY_STRONG_RANDOM
3290 Use this level for e.g. key material.
3291 @end table
3292
3293 @node Retrieving random numbers
3294 @section Retrieving random numbers
3295
3296 @deftypefun void gcry_randomize (unsigned char *@var{buffer}, size_t @var{length}, enum gcry_random_level @var{level})
3297
3298 Fill @var{buffer} with @var{length} random bytes using a random quality
3299 as defined by @var{level}.
3300 @end deftypefun
3301
3302 @deftypefun void * gcry_random_bytes (size_t @var{nbytes}, enum gcry_random_level @var{level})
3303
3304 Allocate a memory block consisting of @var{nbytes} fresh random bytes
3305 using a random quality as defined by @var{level}.
3306 @end deftypefun
3307
3308 @deftypefun void * gcry_random_bytes_secure (size_t @var{nbytes}, enum gcry_random_level @var{level})
3309
3310 Allocate a memory block consisting of @var{nbytes} fresh random bytes
3311 using a random quality as defined by @var{level}.  This function
3312 differs from @code{gcry_random_bytes} in that the returned buffer is
3313 allocated in a ``secure'' area of the memory.
3314 @end deftypefun
3315
3316 @deftypefun void gcry_create_nonce (unsigned char *@var{buffer}, size_t @var{length})
3317
3318 Fill @var{buffer} with @var{length} unpredictable bytes.  This is
3319 commonly called a nonce and may also be used for initialization
3320 vectors and padding.  This is an extra function nearly independent of
3321 the other random function for 3 reasons: It better protects the
3322 regular random generator's internal state, provides better performance
3323 and does not drain the precious entropy pool.
3324
3325 @end deftypefun
3326
3327
3328
3329 @c **********************************************************
3330 @c *******************  S-Expressions ***********************
3331 @c **********************************************************
3332 @node S-expressions
3333 @chapter S-expressions
3334
3335 S-expressions are used by the public key functions to pass complex data
3336 structures around.  These LISP like objects are used by some
3337 cryptographic protocols (cf. RFC-2692) and @acronym{Libgcrypt} provides functions
3338 to parse and construct them.  For detailed information, see
3339 @cite{Ron Rivest, code and description of S-expressions,
3340 @uref{http://theory.lcs.mit.edu/~rivest/sexp.html}}.
3341
3342 @menu
3343 * Data types for S-expressions::  Data types related with S-expressions.
3344 * Working with S-expressions::  How to work with S-expressions.
3345 @end menu
3346
3347 @node Data types for S-expressions
3348 @section Data types for S-expressions
3349
3350 @deftp {Data type} gcry_sexp_t
3351 The @code{gcry_sexp_t} type describes an object with the @acronym{Libgcrypt} internal
3352 representation of an S-expression.
3353 @end deftp
3354
3355 @node Working with S-expressions
3356 @section Working with S-expressions
3357
3358 @noindent
3359 There are several functions to create an @acronym{Libgcrypt} S-expression object
3360 from its external representation or from a string template.  There is
3361 also a function to convert the internal representation back into one of
3362 the external formats:
3363
3364
3365 @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}})
3366
3367 This is the generic function to create an new S-expression object from
3368 its external representation in @var{buffer} of @var{length} bytes.  On
3369 success the result is stored at the address given by @var{r_sexp}. 
3370 With @var{autodetect} set to 0, the data in @var{buffer} is expected to
3371 be in canonized format, with @var{autodetect} set to 1 the parses any of
3372 the defined external formats.  If @var{buffer} does not hold a valid
3373 S-expression an error code is returned and @var{r_sexp} set to
3374 @code{NULL}.
3375 Note, that the caller is responsible for releasing the newly allocated
3376 S-expression using @code{gcry_sexp_release}.
3377 @end deftypefun
3378
3379 @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*)})
3380
3381 This function is identical to @code{gcry_sexp_new} but has an extra
3382 argument @var{freefnc}, which, when not set to @code{NULL}, is expected
3383 to be a function to release the @var{buffer}; most likely the standard
3384 @code{free} function is used for this argument.  This has the effect of
3385 transferring the ownership of @var{buffer} to the created object in
3386 @var{r_sexp}.  The advantage of using this function is that @acronym{Libgcrypt}
3387 might decide to directly use the provided buffer and thus avoid extra
3388 copying.
3389 @end deftypefun
3390
3391 @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}})
3392
3393 This is another variant of the above functions.  It behaves nearly
3394 identical but provides an @var{erroff} argument which will receive the
3395 offset into the buffer where the parsing stopped on error.
3396 @end deftypefun
3397
3398 @deftypefun gcry_error_t gcry_sexp_build (@w{gcry_sexp_t *@var{r_sexp}}, @w{size_t *@var{erroff}}, @w{const char *@var{format}, ...})
3399
3400 This function creates an internal S-expression from the string template
3401 @var{format} and stores it at the address of @var{r_sexp}. If there is a
3402 parsing error, the function returns an appropriate error code and stores
3403 the offset into @var{format} where the parsing stopped in @var{erroff}.
3404 The function supports a couple of printf-like formatting characters and
3405 expects arguments for some of these escape sequences right after
3406 @var{format}.  The following format characters are defined:
3407
3408 @table @samp
3409 @item %m
3410 The next argument is expected to be of type @code{gcry_mpi_t} and a copy of
3411 its value is inserted into the resulting S-expression.
3412 @item %s
3413 The next argument is expected to be of type @code{char *} and that
3414 string is inserted into the resulting S-expression.
3415 @item %d
3416 The next argument is expected to be of type @code{int} and its value is
3417 inserted into the resulting S-expression.
3418 @item %b
3419 The next argument is expected to be of type @code{int} directly
3420 followed by an argument of type @code{char *}.  This represents a
3421 buffer of given length to be inserted into the resulting regular
3422 expression.
3423 @end table
3424
3425 @noindent
3426 No other format characters are defined and would return an error.  Note,
3427 that the format character @samp{%%} does not exists, because a percent
3428 sign is not a valid character in an S-expression.
3429 @end deftypefun
3430
3431 @deftypefun void gcry_sexp_release (@w{gcry_sexp_t @var{sexp}})
3432
3433 Release the S-expression object @var{sexp}.
3434 @end deftypefun
3435
3436
3437 @noindent
3438 The next 2 functions are used to convert the internal representation
3439 back into a regular external S-expression format and to show the
3440 structure for debugging.
3441
3442 @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}})
3443
3444 Copies the S-expression object @var{sexp} into @var{buffer} using the
3445 format specified in @var{mode}.  @var{maxlength} must be set to the
3446 allocated length of @var{buffer}.  The function returns the actual
3447 length of valid bytes put into @var{buffer} or 0 if the provided buffer
3448 is too short.  Passing @code{NULL} for @var{buffer} returns the required
3449 length for @var{buffer}.  For convenience reasons an extra byte with
3450 value 0 is appended to the buffer.
3451
3452 @noindent
3453 The following formats are supported:
3454
3455 @table @code
3456 @item GCRYSEXP_FMT_DEFAULT
3457 Returns a convenient external S-expression representation.
3458
3459 @item GCRYSEXP_FMT_CANON
3460 Return the S-expression in canonical format.
3461
3462 @item GCRYSEXP_FMT_BASE64
3463 Not currently supported.
3464
3465 @item GCRYSEXP_FMT_ADVANCED
3466 Returns the S-expression in advanced format.
3467 @end table
3468 @end deftypefun
3469
3470 @deftypefun void gcry_sexp_dump (@w{gcry_sexp_t @var{sexp}})
3471
3472 Dumps @var{sexp} in a format suitable for debugging to @acronym{Libgcrypt}'s
3473 logging stream.
3474 @end deftypefun
3475
3476 @noindent
3477 Often canonical encoding is used in the external representation.  The
3478 following function can be used to check for valid encoding and to learn
3479 the length of the S-expression"
3480
3481 @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}})
3482
3483 Scan the canonical encoded @var{buffer} with implicit length values and
3484 return the actual length this S-expression uses.  For a valid S-expression
3485 it should never return 0.  If @var{length} is not 0, the maximum
3486 length to scan is given; this can be used for syntax checks of
3487 data passed from outside.  @var{errcode} and @var{erroff} may both be
3488 passed as @code{NULL}.
3489
3490 @end deftypefun
3491
3492
3493 @noindent
3494 There are a couple of functions to parse S-expressions and retrieve
3495 elements:
3496
3497 @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}})
3498
3499 Scan the S-expression for a sublist with a type (the car of the list)
3500 matching the string @var{token}.  If @var{toklen} is not 0, the token is
3501 assumed to be raw memory of this length.  The function returns a newly
3502 allocated S-expression consisting of the found sublist or @code{NULL}
3503 when not found.
3504 @end deftypefun
3505
3506
3507 @deftypefun int gcry_sexp_length (@w{const gcry_sexp_t @var{list}})
3508
3509 Return the length of the @var{list}.  For a valid S-expression this
3510 should be at least 1.
3511 @end deftypefun
3512
3513
3514 @deftypefun gcry_sexp_t gcry_sexp_nth (@w{const gcry_sexp_t @var{list}}, @w{int @var{number}})
3515
3516 Create and return a new S-expression from the element with index @var{number} in
3517 @var{list}.  Note that the first element has the index 0.  If there is
3518 no such element, @code{NULL} is returned.
3519 @end deftypefun
3520
3521 @deftypefun gcry_sexp_t gcry_sexp_car (@w{const gcry_sexp_t @var{list}})
3522
3523 Create and return a new S-expression from the first element in
3524 @var{list}; this called the "type" and should always exist and be a
3525 string. @code{NULL} is returned in case of a problem.
3526 @end deftypefun
3527
3528 @deftypefun gcry_sexp_t gcry_sexp_cdr (@w{const gcry_sexp_t @var{list}})
3529
3530 Create and return a new list form all elements except for the first one.
3531 Note, that this function may return an invalid S-expression because it
3532 is not guaranteed, that the type exists and is a string.  However, for
3533 parsing a complex S-expression it might be useful for intermediate
3534 lists.  Returns @code{NULL} on error.
3535 @end deftypefun
3536
3537
3538 @deftypefun {const char *} gcry_sexp_nth_data (@w{const gcry_sexp_t @var{list}}, @w{int @var{number}}, @w{size_t *@var{datalen}})
3539
3540 This function is used to get data from a @var{list}.  A pointer to the
3541 actual data with index @var{number} is returned and the length of this
3542 data will be stored to @var{datalen}.  If there is no data at the given
3543 index or the index represents another list, @code{NULL} is returned.
3544 @strong{Note:} The returned pointer is valid as long as @var{list} is
3545 not modified or released.
3546
3547 @noindent
3548 Here is an example on how to extract and print the surname (Meier) from
3549 the S-expression @samp{(Name Otto Meier (address Burgplatz 3))}:
3550
3551 @example
3552 size_t len;
3553 const char *name;
3554
3555 name = gcry_sexp_nth_data (list, 2, &len);
3556 printf ("my name is %.*s\n", (int)len, name);
3557 @end example
3558 @end deftypefun
3559
3560 @deftypefun gcry_mpi_t gcry_sexp_nth_mpi (@w{gcry_sexp_t @var{list}}, @w{int @var{number}}, @w{int @var{mpifmt}})
3561
3562 This function is used to get and convert data from a @var{list}. This
3563 data is assumed to be an MPI stored in the format described by
3564 @var{mpifmt} and returned as a standard @acronym{Libgcrypt} MPI.  The caller must
3565 release this returned value using @code{gcry_mpi_release}.  If there is
3566 no data at the given index, the index represents a list or the value
3567 can't be converted to an MPI, @code{NULL} is returned.
3568 @end deftypefun
3569
3570
3571 @c **********************************************************
3572 @c *******************  MPIs ******** ***********************
3573 @c **********************************************************
3574 @node MPI library
3575 @chapter MPI library
3576
3577 @menu
3578 * Data types::                  MPI related data types.
3579 * Basic functions::             First steps with MPI numbers.
3580 * MPI formats::                 External representation of MPIs.
3581 * Calculations::                Performing MPI calculations.
3582 * Comparisons::                 How to compare MPI values.
3583 * Bit manipulations::           How to access single bits of MPI values.
3584 * Miscellaneous::               Miscellaneous MPI functions.
3585 @end menu
3586
3587 Public key cryptography is based on mathematics with large numbers.  To
3588 implement the public key functions, a library for handling these large
3589 numbers is required.  Because of the general usefulness of such a
3590 library, its interface is exposed by @acronym{Libgcrypt}.  The implementation is
3591 based on an old release of GNU Multi-Precision Library (GMP) but in the
3592 meantime heavily modified and stripped down to what is required for
3593 cryptography. For a lot of CPUs, high performance assembler
3594 implementations of some very low level functions are used to gain much
3595 better performance than with the standard C implementation.
3596
3597 @noindent
3598 In the context of @acronym{Libgcrypt} and in most other applications, these large
3599 numbers are called MPIs (multi-precision-integers).
3600
3601 @node Data types
3602 @section Data types
3603
3604 @deftp {Data type} gcry_mpi_t
3605 The @code{gcry_mpi_t} type represents an object to hold an MPI.
3606 @end deftp
3607
3608 @node Basic functions
3609 @section Basic functions
3610
3611 @noindent
3612 To work with MPIs, storage must be allocated and released for the
3613 numbers.  This can be done with one of these functions:
3614
3615 @deftypefun gcry_mpi_t gcry_mpi_new (@w{unsigned int @var{nbits}})
3616
3617 Allocate a new MPI object, initialize it to 0 and initially allocate
3618 enough memory for a number of at least @var{nbits}.  This pre-allocation is
3619 only a small performance issue and not actually necessary because
3620 @acronym{Libgcrypt} automatically re-allocates the required memory.
3621 @end deftypefun
3622
3623 @deftypefun gcry_mpi_t gcry_mpi_snew (@w{unsigned int @var{nbits}})
3624
3625 This is identical to @code{gcry_mpi_new} but allocates the MPI in the so
3626 called "secure memory" which in turn will take care that all derived
3627 values will also be stored in this "secure memory".  Use this for highly
3628 confidential data like private key parameters.
3629 @end deftypefun
3630
3631 @deftypefun gcry_mpi_t gcry_mpi_copy (@w{const gcry_mpi_t @var{a}})
3632
3633 Create a new MPI as the exact copy of @var{a}.
3634 @end deftypefun
3635
3636
3637 @deftypefun void gcry_mpi_release (@w{gcry_mpi_t @var{a}})
3638
3639 Release the MPI @var{a} and free all associated resources.  Passing
3640 @code{NULL} is allowed and ignored.  When a MPI stored in the "secure
3641 memory" is released, that memory gets wiped out immediately.
3642 @end deftypefun
3643
3644 @noindent
3645 The simplest operations are used to assign a new value to an MPI:
3646
3647 @deftypefun gcry_mpi_t gcry_mpi_set (@w{gcry_mpi_t @var{w}}, @w{const gcry_mpi_t @var{u}})
3648
3649 Assign the value of @var{u} to @var{w} and return @var{w}.  If
3650 @code{NULL} is passed for @var{w}, a new MPI is allocated, set to the
3651 value of @var{u} and returned.
3652 @end deftypefun
3653
3654 @deftypefun gcry_mpi_t gcry_mpi_set_ui (@w{gcry_mpi_t @var{w}}, @w{unsigned long @var{u}})
3655
3656 Assign the value of @var{u} to @var{w} and return @var{w}.  If
3657 @code{NULL} is passed for @var{w}, a new MPI is allocated, set to the
3658 value of @var{u} and returned.  This function takes an @code{unsigned
3659 int} as type for @var{u} and thus it is only possible to set @var{w} to
3660 small values (usually up to the word size of the CPU).
3661 @end deftypefun
3662
3663 @deftypefun void gcry_mpi_swap (@w{gcry_mpi_t @var{a}}, @w{gcry_mpi_t @var{b}})
3664
3665 Swap the values of @var{a} and @var{b}.
3666 @end deftypefun
3667
3668 @node MPI formats
3669 @section MPI formats
3670
3671 @noindent
3672 The following functions are used to convert between an external
3673 representation of an MPI and the internal one of @acronym{Libgcrypt}.
3674
3675 @deftypefun gcry_error_t gcry_mpi_scan (@w{gcry_mpi_t *@var{r_mpi}}, @w{enum gcry_mpi_format @var{format}}, @w{const unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nscanned}})
3676
3677 Convert the external representation of an integer stored in @var{buffer}
3678 with a length of @var{buflen} into a newly created MPI returned which
3679 will be stored at the address of @var{r_mpi}.  For certain formats the
3680 length argument is not required and may be passed as @code{0}.  After a
3681 successful operation the variable @var{nscanned} receives the number of
3682 bytes actually scanned unless @var{nscanned} was given as
3683 @code{NULL}. @var{format} describes the format of the MPI as stored in
3684 @var{buffer}:
3685
3686 @table @code
3687 @item GCRYMPI_FMT_STD
3688 2-complement stored without a length header.
3689
3690 @item GCRYMPI_FMT_PGP
3691 As used by OpenPGP (only defined as unsigned). This is basically
3692 @code{GCRYMPI_FMT_STD} with a 2 byte big endian length header.
3693
3694 @item GCRYMPI_FMT_SSH
3695 As used in the Secure Shell protocol.  This is @code{GCRYMPI_FMT_STD}
3696 with a 4 byte big endian header.
3697
3698 @item GCRYMPI_FMT_HEX
3699 Stored as a C style string with each byte of the MPI encoded as 2 hex
3700 digits.  When using this format, @var{buflen} must be zero.
3701
3702 @item GCRYMPI_FMT_USG
3703 Simple unsigned integer.
3704 @end table
3705
3706 @noindent
3707 Note, that all of the above formats store the integer in big-endian
3708 format (MSB first).
3709 @end deftypefun
3710
3711
3712 @deftypefun gcry_error_t gcry_mpi_print (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nwritten}}, @w{const gcry_mpi_t @var{a}})
3713
3714 Convert the MPI @var{a} into an external representation described by
3715 @var{format} (see above) and store it in the provided @var{buffer}
3716 which has a usable length of at least the @var{buflen} bytes. If
3717 @var{nwritten} is not NULL, it will receive the number of bytes
3718 actually stored in @var{buffer} after a successful operation.
3719 @end deftypefun
3720
3721 @deftypefun gcry_error_t gcry_mpi_aprint (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char **@var{buffer}}, @w{size_t *@var{nbytes}}, @w{const gcry_mpi_t @var{a}})
3722
3723 Convert the MPI @var{a} into an external representation described by
3724 @var{format} (see above) and store it in a newly allocated buffer which
3725 address will be stored in the variable @var{buffer} points to.  The
3726 number of bytes stored in this buffer will be stored in the variable
3727 @var{nbytes} points to, unless @var{nbytes} is @code{NULL}.
3728 @end deftypefun
3729
3730 @deftypefun void gcry_mpi_dump (@w{const gcry_mpi_t @var{a}})
3731
3732 Dump the value of @var{a} in a format suitable for debugging to
3733 Libgcrypt's logging stream.  Note that one leading space but no trailing
3734 space or linefeed will be printed.  It is okay to pass @code{NULL} for
3735 @var{a}.
3736 @end deftypefun
3737
3738
3739 @node Calculations
3740 @section Calculations
3741
3742 @noindent
3743 Basic arithmetic operations:
3744
3745 @deftypefun void gcry_mpi_add (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}})
3746
3747 @math{@var{w} = @var{u} + @var{v}}.
3748 @end deftypefun
3749
3750
3751 @deftypefun void gcry_mpi_add_ui (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3752
3753 @math{@var{w} = @var{u} + @var{v}}.  Note, that @var{v} is an unsigned integer.
3754 @end deftypefun
3755
3756
3757 @deftypefun void gcry_mpi_addm (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}}, @w{gcry_mpi_t @var{m}})
3758
3759 @math{@var{w} = @var{u} + @var{v} \bmod @var{m}}.
3760 @end deftypefun
3761
3762 @deftypefun void gcry_mpi_sub (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}})
3763
3764 @math{@var{w} = @var{u} - @var{v}}.
3765 @end deftypefun
3766
3767 @deftypefun void gcry_mpi_sub_ui (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3768
3769 @math{@var{w} = @var{u} - @var{v}}.  @var{v} is an unsigned integer.
3770 @end deftypefun
3771
3772 @deftypefun void gcry_mpi_subm (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}}, @w{gcry_mpi_t @var{m}})
3773
3774 @math{@var{w} = @var{u} - @var{v} \bmod @var{m}}.
3775 @end deftypefun
3776
3777 @deftypefun void gcry_mpi_mul (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}})
3778
3779 @math{@var{w} = @var{u} * @var{v}}.
3780 @end deftypefun
3781
3782 @deftypefun void gcry_mpi_mul_ui (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3783
3784 @math{@var{w} = @var{u} * @var{v}}.  @var{v} is an unsigned integer.
3785 @end deftypefun
3786
3787 @deftypefun void gcry_mpi_mulm (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{gcry_mpi_t @var{v}}, @w{gcry_mpi_t @var{m}})
3788
3789 @math{@var{w} = @var{u} * @var{v} \bmod @var{m}}.
3790 @end deftypefun
3791
3792 @deftypefun void gcry_mpi_mul_2exp (@w{gcry_mpi_t @var{w}}, @w{gcry_mpi_t @var{u}}, @w{unsigned long @var{e}})
3793
3794 @c FIXME: I am in need for a real TeX{info} guru:
3795 @c I don't know why TeX can grok @var{e} here.
3796 @math{@var{w} = @var{u} * 2^e}.
3797 @end deftypefun
3798
3799 @deftypefun void gcry_mpi_div (@w{gcry_mpi_t @var{q}}, @w{gcry_mpi_t @var{r}}, @w{gcry_mpi_t @var{dividend}}, @w{gcry_mpi_t @var{divisor}}, @w{int @var{round}})
3800
3801 @math{@var{q} = @var{dividend} / @var{divisor}}, @math{@var{r} =
3802 @var{dividend} \bmod @var{divisor}}.  @var{q} and @var{r} may be passed
3803 as @code{NULL}.  @var{round} should be negative or 0.
3804 @end deftypefun
3805
3806 @deftypefun void gcry_mpi_mod (@w{gcry_mpi_t @var{r}}, @w{gcry_mpi_t @var{dividend}}, @w{gcry_mpi_t @var{divisor}})
3807
3808 @math{@var{r} = @var{dividend} \bmod @var{divisor}}.
3809 @end deftypefun
3810
3811 @deftypefun void gcry_mpi_powm (@w{gcry_mpi_t @var{w}}, @w{const gcry_mpi_t @var{b}}, @w{const gcry_mpi_t @var{e}}, @w{const gcry_mpi_t @var{m}})
3812
3813 @c I don't know why TeX can grok @var{e} here.
3814 @math{@var{w} = @var{b}^e \bmod @var{m}}.
3815 @end deftypefun
3816
3817 @deftypefun int gcry_mpi_gcd (@w{gcry_mpi_t @var{g}}, @w{gcry_mpi_t @var{a}}, @w{gcry_mpi_t @var{b}})
3818
3819 Set @var{g} to the greatest common divisor of @var{a} and @var{b}.  
3820 Return true if the @var{g} is 1.
3821 @end deftypefun
3822
3823 @deftypefun int gcry_mpi_invm (@w{gcry_mpi_t @var{x}}, @w{gcry_mpi_t @var{a}}, @w{gcry_mpi_t @var{m}})
3824
3825 Set @var{x} to the multiplicative inverse of @math{@var{a} \bmod @var{m}}.
3826 Return true if the inverse exists.
3827 @end deftypefun
3828
3829
3830 @node Comparisons
3831 @section Comparisons
3832
3833 @noindent
3834 The next 2 functions are used to compare MPIs:
3835
3836
3837 @deftypefun int gcry_mpi_cmp (@w{const gcry_mpi_t @var{u}}, @w{const gcry_mpi_t @var{v}})
3838
3839 Compare the big integer number @var{u} and @var{v} returning 0 for
3840 equality, a positive value for @var{u} > @var{v} and a negative for
3841 @var{u} < @var{v}.
3842 @end deftypefun
3843
3844 @deftypefun int gcry_mpi_cmp_ui (@w{const gcry_mpi_t @var{u}}, @w{unsigned long @var{v}})
3845
3846 Compare the big integer number @var{u} with the unsigned integer @var{v}
3847 returning 0 for equality, a positive value for @var{u} > @var{v} and a
3848 negative for @var{u} < @var{v}.
3849 @end deftypefun
3850
3851
3852 @node Bit manipulations
3853 @section Bit manipulations
3854
3855 @noindent
3856 There are a couple of functions to get information on arbitrary bits
3857 in an MPI and to set or clear them:
3858
3859 @deftypefun {unsigned int} gcry_mpi_get_nbits (@w{gcry_mpi_t @var{a}})
3860
3861 Return the number of bits required to represent @var{a}.
3862 @end deftypefun
3863
3864 @deftypefun int gcry_mpi_test_bit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3865
3866 Return true if bit number @var{n} (counting from 0) is set in @var{a}.
3867 @end deftypefun
3868
3869 @deftypefun void gcry_mpi_set_bit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3870
3871 Set bit number @var{n} in @var{a}.
3872 @end deftypefun
3873
3874 @deftypefun void gcry_mpi_clear_bit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3875
3876 Clear bit number @var{n} in @var{a}.
3877 @end deftypefun
3878
3879 @deftypefun void gcry_mpi_set_highbit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3880
3881 Set bit number @var{n} in @var{a} and clear all bits greater than @var{n}.
3882 @end deftypefun
3883
3884 @deftypefun void gcry_mpi_clear_highbit (@w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3885
3886 Clear bit number @var{n} in @var{a} and all bits greater than @var{n}.
3887 @end deftypefun
3888
3889 @deftypefun void gcry_mpi_rshift (@w{gcry_mpi_t @var{x}}, @w{gcry_mpi_t @var{a}}, @w{unsigned int @var{n}})
3890
3891 Shift the value of @var{a} by @var{n} bits to the right and store the
3892 result in @var{x}.
3893 @end deftypefun
3894
3895 @node Miscellaneous
3896 @section Miscellanous
3897
3898 @deftypefun gcry_mpi_t gcry_mpi_set_opaque (@w{gcry_mpi_t @var{a}}, @w{void *@var{p}}, @w{unsigned int @var{nbits}})
3899
3900 Store @var{nbits} of the value @var{p} points to in @var{a} and mark
3901 @var{a} as an opaque value (i.e. an value that can't be used for any
3902 math calculation and is only used to store an arbitrary bit pattern in
3903 @var{a}).
3904
3905 WARNING: Never use an opaque MPI for actual math operations.  The only
3906 valid functions are gcry_mpi_get_opaque and gcry_mpi_release.  Use
3907 gcry_mpi_scan to convert a string of arbitrary bytes into an MPI.
3908
3909 @end deftypefun
3910
3911 @deftypefun {void *} gcry_mpi_get_opaque (@w{gcry_mpi_t @var{a}}, @w{unsigned int *@var{nbits}})
3912
3913 Return a pointer to an opaque value stored in @var{a} and return its
3914 size in @var{nbits}.  Note, that the returned pointer is still owned by
3915 @var{a} and that the function should never be used for an non-opaque
3916 MPI.
3917 @end deftypefun
3918
3919 @deftypefun void gcry_mpi_set_flag (@w{gcry_mpi_t @var{a}}, @w{enum gcry_mpi_flag @var{flag}})
3920
3921 Set the @var{flag} for the MPI @var{a}.  Currently only the flag
3922 @code{GCRYMPI_FLAG_SECURE} is allowed to convert @var{a} into an MPI
3923 stored in "secure memory".
3924 @end deftypefun
3925
3926 @deftypefun void gcry_mpi_clear_flag (@w{gcry_mpi_t @var{a}}, @w{enum gcry_mpi_flag @var{flag}})
3927
3928 Clear @var{flag} for the big integer @var{a}.  Note, that this function is
3929 currently useless as no flags are allowed.
3930 @end deftypefun
3931
3932 @deftypefun int gcry_mpi_get_flag (@w{gcry_mpi_t @var{a}}, @w{enum gcry_mpi_flag @var{flag}})
3933
3934 Return true when the @var{flag} is set for @var{a}.
3935 @end deftypefun
3936
3937 @deftypefun void gcry_mpi_randomize (@w{gcry_mpi_t @var{w}}, @w{unsigned int @var{nbits}}, @w{enum gcry_random_level @var{level}})
3938
3939 Set the big integer @var{w} to a random value of @var{nbits}, using
3940 random data quality of level @var{level}.  In case @var{nbits} is not
3941 a multiple of a byte, @var{nbits} is rounded up to the next byte
3942 boundary.
3943 @end deftypefun
3944
3945 @c **********************************************************
3946 @c ******************** Prime numbers ***********************
3947 @c **********************************************************
3948 @node Prime numbers
3949 @chapter Prime numbers
3950
3951 @menu
3952 * Generation::                  Generation of new prime numbers.
3953 * Checking::                    Checking if a given number is prime.
3954 @end menu
3955
3956 @node Generation
3957 @section Generation
3958
3959 @deftypefun gcry_error_t gcry_prime_generate (gcry_mpi_t *@var{prime},
3960 unsigned int @var{prime_bits}, unsigned int @var{factor_bits},
3961 gcry_mpi_t **@var{factors}, gcry_prime_check_func_t @var{cb_func},
3962 void *@var{cb_arg}, gcry_random_level_t @var{random_level},
3963 unsigned int @var{flags})
3964
3965 Generate a new prime number of @var{prime_bits} bits and store it in
3966 @var{prime}.  If @var{factor_bits} is non-zero, one of the prime factors
3967 of (@var{prime} - 1) / 2 must be @var{factor_bits} bits long.  If
3968 @var{factors} is non-zero, allocate a new, @code{NULL}-terminated array
3969 holding the prime factors and store it in @var{factors}.  @var{flags}
3970 might be used to influence the prime number generation process.
3971 @end deftypefun
3972
3973 @deftypefun gcry_prime_group_generator (gcry_mpi_t *@var{r_g},
3974 gcry_mpi_t @var{prime}, gcry_mpi_t *@var{factors}, gcry_mpi_t @var{start_g})
3975
3976 Find a generator for @var{prime} where the factorization of (@var{prime}
3977 - 1) is in the @code{NULL} terminated array @var{factors}.  Return the
3978 generator as a newly allocated MPI in @var{r_g}.  If @var{start_g} is
3979 not NULL, use this as the start for the search.
3980 @end deftypefun
3981
3982 @deftypefun void gcry_prime_release_factors (gcry_mpi_t *@var{factors})
3983
3984 Convenience function to release the @var{factors} array.
3985 @end deftypefun
3986
3987 @node Checking
3988 @section Checking
3989
3990 @deftypefun gcry_error_t gcry_prime_check (gcry_mpi_t @var{p},
3991 unsigned int @var{flags})
3992
3993 Check wether the number @var{p} is prime.  Returns zero in case @var{p}
3994 is indeed a prime, returns @code{GPG_ERR_NO_PRIME} in case @var{p} is
3995 not a prime and a different error code in case something went horribly
3996 wrong.
3997 @end deftypefun
3998
3999 @node Utilities
4000 @chapter Utilities
4001
4002 @menu
4003 * Memory allocation:: Functions related with memory allocation.
4004 @end menu
4005
4006 @node Memory allocation
4007 @section Memory allocation
4008
4009 @deftypefun void *gcry_malloc (size_t @var{n})
4010
4011 This function tries to allocate @var{n} bytes of memory.  On success
4012 it returns a pointer to the memory area, in an out-of-core condition,
4013 it returns NULL.
4014 @end deftypefun
4015
4016 @deftypefun void *gcry_malloc_secure (size_t @var{n})
4017 Like @code{gcry_malloc}, but uses secure memory.
4018 @end deftypefun
4019
4020 @deftypefun void *gcry_calloc (size_t @var{n})
4021
4022 This function tries to allocate @var{n} bytes of cleared memory
4023 (i.e. memory that is initialized with zero bytes).  On success it
4024 returns a pointer to the memory area, in an out-of-core condition, it
4025 returns NULL.
4026 @end deftypefun
4027
4028 @deftypefun void *gcry_calloc_secure (size_t @var{n})
4029 Like @code{gcry_calloc}, but uses secure memory.
4030 @end deftypefun
4031
4032 @deftypefun void *gcry_realloc (void *@var{p}, size_t @var{n})
4033
4034 This function tries to resize the memory area pointed to by @var{p} to
4035 @var{n} bytes.  On success it returns a pointer to the new memory
4036 area, in an out-of-core condition, it returns NULL.  Depending on
4037 whether the memory pointed to by @var{p} is secure memory or not,
4038 gcry_realloc tries to use secure memory as well.
4039 @end deftypefun
4040
4041 @deftypefun void gcry_free (void *@var{p})
4042 Release the memory area pointed to by @var{p}.
4043 @end deftypefun
4044
4045 @c **********************************************************
4046 @c *******************  Appendices  *************************
4047 @c **********************************************************
4048
4049 @include lgpl.texi
4050
4051 @include gpl.texi
4052
4053 @node Concept Index
4054 @unnumbered Concept Index
4055
4056 @printindex cp
4057
4058 @node Function and Data Index
4059 @unnumbered Function and Data Index
4060
4061 @printindex fn
4062
4063 @bye
4064
4065   /* Version check should be the very first gcry call because it
4066      makes sure that constructor functions are run. */
4067   if (!gcry_check_version (GCRYPT_VERSION))
4068     die ("version mismatch\n");
4069   /* Many applications don't require secure memory, so they should
4070      disable it right away.  There won't be a problem unless one makes
4071      use of a feature which requires secure memory - in that case the
4072      process would abort because the secmem is not initialized. */
4073   gcry_control (GCRYCTL_DISABLE_SECMEM, 0);
4074
4075   /* .. add whatever initialization you want, but better don't make calls
4076         to libgcrypt from more than one thread ... */
4077
4078   /* Tell Libgcrypt that initialization has completed. */
4079   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
4080
4081
4082 If you require secure memory, this code should be used: 
4083
4084   if (!gcry_check_version (GCRYPT_VERSION))
4085     die ("version mismatch\n");
4086   /* We don't want to see any warnings, e.g. because we have not yet
4087     parsed options which might be used to suppress such warnings */
4088   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
4089
4090   /* ... */
4091
4092   /* Allocate a pool of 16k secure memory.  This also drops priviliges
4093      on some systems. */
4094   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
4095
4096   /* It is now okay to let Libgcrypt complain when there was/is a problem
4097      with the secure memory. */
4098   gcry_control (GCRYCTL_RESUME_SECMEM_WARN);
4099
4100   /* Tell Libgcrypt that initialization has completed. */
4101   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
4102
4103
4104 This sounds a bit complicated but has the advantage that the caller
4105 must decide whether he wants secure memory or not - there is no
4106 default.
4107
4108 It is important that this initialization is not done by a library but
4109 in the application.  The library might want to check for finished
4110 initialization using:
4111
4112   if (!gcry_control (GCRYCTL_INITIALIZATION_FINISHED_P))
4113     return MYLIB_ERROR_LIBGCRYPT_NOT_INITIALIZED;
4114
4115
4116 @c  LocalWords:  int HD
4117
4118
4119
4120