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