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