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