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