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