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