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