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