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