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