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