core: New helper function gpgme_addrspec_from_uid.
[gpgme.git] / doc / gpgme.texi
1 \input texinfo                   @c -*- mode: texinfo; coding: utf-8; -*-
2 @documentencoding UTF-8
3 @setfilename gpgme.info
4 @include defs.inc
5 @settitle The `GnuPG Made Easy' Reference Manual
6
7 @dircategory GNU Libraries
8 @direntry
9 * @acronym{GPGME}: (gpgme).          Adding support for cryptography to your program.
10 @end direntry
11
12 @c Unify some of the indices.
13 @syncodeindex tp fn
14 @syncodeindex pg fn
15
16 @copying
17 Copyright @copyright{} 2002--2008, 2010, 2012--2016 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 3 of the License, or (at your
23 option) any later version. The text of the license can be found in the
24 section entitled ``Copying''.
25 @end quotation
26
27 This document is distributed in the hope that it will be useful, but
28 WITHOUT ANY WARRANTY; without even the implied warranty of
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
30 General Public License for more details.
31 @end copying
32
33 @c Macros used by the description of the UI server protocol
34 @macro clnt
35   @sc{c:} @c
36 @end macro
37 @macro srvr
38   @sc{s:} @c
39 @end macro
40
41
42 @c
43 @c  T I T L E  P A G E
44 @c
45 @ifinfo
46 This file documents the @acronym{GPGME} library.
47
48 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
49 @cite{The `GnuPG Made Easy' Reference Manual}, for Version
50 @value{VERSION}.
51
52 @c NOTE: Don't forget to update the year for the TeX version, too.
53 @insertcopying
54
55 @end ifinfo
56
57 @c We do not want that bastard short titlepage.
58 @c @iftex
59 @c @shorttitlepage The `GnuPG Made Easy' Reference Manual
60 @c @end iftex
61 @titlepage
62 @center @titlefont{The `GnuPG Made Easy'}
63 @sp 1
64 @center @titlefont{Reference Manual}
65 @sp 6
66 @center Edition @value{EDITION}
67 @sp 1
68 @center last updated @value{UPDATED}
69 @sp 1
70 @center for version @value{VERSION}
71 @page
72 @vskip 0pt plus 1filll
73 Published by The GnuPG Project@* c/o g10 Code GmbH@* Hüttenstr. 61@* 40699 Erkrath, Germany
74
75 @insertcopying
76 @end titlepage
77 @page
78
79 @summarycontents
80 @contents
81
82 @ifnottex
83 @node Top
84 @top Main Menu
85 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
86 @cite{The `GnuPG Made Easy' Reference Manual}, for Version
87 @value{VERSION} of the @acronym{GPGME} library.
88 @end ifnottex
89
90 @menu
91 * Introduction::                  How to use this manual.
92 * Preparation::                   What you should do before using the library.
93 * Protocols and Engines::         Supported crypto protocols.
94 * Algorithms::                    Supported algorithms.
95 * Error Handling::                Error numbers and their meanings.
96 * Exchanging Data::               Passing data to and from @acronym{GPGME}.
97 * Contexts::                      Handling @acronym{GPGME} contexts.
98
99 Appendices
100
101 * UI Server Protocol::            The GnuPG UI Server Protocol.
102 * Debugging::                     How to solve problems.
103 * Deprecated Functions::          Documentation of deprecated functions.
104
105 * Library Copying::               The GNU Lesser General Public License says
106                                   how you can copy and share `GnuPG Made Easy'.
107 * Copying::                       The GNU General Public License says how you
108                                   can copy and share this manual.
109
110 Indices
111
112 * Concept Index::                 Index of concepts and programs.
113 * Function and Data Index::       Index of functions, variables and data types.
114
115 @detailmenu
116  --- The Detailed Node Listing ---
117
118 Introduction
119
120 * Getting Started::               Purpose of the manual, and how to use it.
121 * Features::                      Reasons to install and use @acronym{GPGME}.
122 * Overview::                      Basic architecture of the @acronym{GPGME} library.
123
124 Preparation
125
126 * Header::                        What header file you need to include.
127 * Building the Source::           Compiler options to be used.
128 * Largefile Support (LFS)::       How to use @acronym{GPGME} with LFS.
129 * Using Automake::                Compiler options to be used the easy way.
130 * Using Libtool::                 Avoiding compiler options entirely.
131 * Library Version Check::         Getting and verifying the library version.
132 * Signal Handling::               How @acronym{GPGME} affects signal handling.
133 * Multi Threading::               How @acronym{GPGME} can be used in an MT environment.
134
135 Protocols and Engines
136
137 * Engine Version Check::          Verifying the engine version.
138 * Engine Information::            Obtaining more information about the engines.
139 * Engine Configuration::          Changing the engine configuration.
140 * OpenPGP::                       Support for the OpenPGP protocol.
141 * Cryptographic Message Syntax::  Support for the CMS.
142
143 Algorithms
144
145 * Public Key Algorithms::         A list of all public key algorithms.
146 * Hash Algorithms::               A list of all hash algorithms.
147
148 Error Handling
149
150 * Error Values::                  The error value and what it means.
151 * Error Codes::                   A list of important error codes.
152 * Error Sources::                 A list of important error sources.
153 * Error Strings::                 How to get a descriptive string from a value.
154
155 Exchanging Data
156
157 * Creating Data Buffers::         Creating new data buffers.
158 * Destroying Data Buffers::       Releasing data buffers.
159 * Manipulating Data Buffers::     Operations on data buffers.
160
161 Creating Data Buffers
162
163 * Memory Based Data Buffers::     Creating memory based data buffers.
164 * File Based Data Buffers::       Creating file based data buffers.
165 * Callback Based Data Buffers::   Creating callback based data buffers.
166
167 Manipulating Data Buffers
168
169 * Data Buffer I/O Operations::    I/O operations on data buffers.
170 * Data Buffer Meta-Data::         Meta-data manipulation of data buffers.
171 * Data Buffer Convenience::       Convenience function for data buffers.
172
173 Contexts
174
175 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
176 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
177 * Result Management::             Managing the result of crypto operations.
178 * Context Attributes::            Setting properties of a context.
179 * Key Management::                Managing keys with @acronym{GPGME}.
180 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
181 * Crypto Operations::             Using a context for cryptography.
182 * Miscellaneous::                 Miscellaneous operations.
183 * Run Control::                   Controlling how operations are run.
184
185 Context Attributes
186
187 * Protocol Selection::            Selecting the protocol used by a context.
188 * Crypto Engine::                 Configuring the crypto engine.
189 * ASCII Armor::                   Requesting @acronym{ASCII} armored output.
190 * Text Mode::                     Choosing canonical text mode.
191 * Offline Mode::                  Choosing offline mode.
192 * Included Certificates::         Including a number of certificates.
193 * Key Listing Mode::              Selecting key listing mode.
194 * Passphrase Callback::           Getting the passphrase from the user.
195 * Progress Meter Callback::       Being informed about the progress.
196 * Status Message Callback::       Status messages received from gpg.
197 * Locale::                        Setting the locale of a context.
198
199 Key Management
200
201 * Key objects::                   Description of the key structures.
202 * Listing Keys::                  Browsing the list of available keys.
203 * Information About Keys::        Requesting detailed information about keys.
204 * Manipulating Keys::             Operations on keys.
205 * Generating Keys::               Creating new key pairs.
206 * Signing Keys::                  Adding key signatures to public keys.
207 * Exporting Keys::                Retrieving key data from the key ring.
208 * Importing Keys::                Adding keys to the key ring.
209 * Deleting Keys::                 Removing keys from the key ring.
210 * Changing Passphrases::          Change the passphrase of a key.
211 * Changing TOFU Data::            Changing data pertaining to TOFU.
212 * Advanced Key Editing::          Advanced key edit operation.
213
214 Trust Item Management
215
216 * Listing Trust Items::           Browsing the list of available trust items.
217 * Manipulating Trust Items::      Operations on trust items.
218
219 Crypto Operations
220
221 * Decrypt::                       Decrypting a ciphertext.
222 * Verify::                        Verifying a signature.
223 * Decrypt and Verify::            Decrypting a signed ciphertext.
224 * Sign::                          Creating a signature.
225 * Encrypt::                       Encrypting a plaintext.
226
227 Sign
228
229 * Selecting Signers::             How to choose the keys to sign with.
230 * Creating a Signature::          How to create a signature.
231 * Signature Notation Data::       How to add notation data to a signature.
232
233 Encrypt
234
235 * Encrypting a Plaintext::        How to encrypt a plaintext.
236
237 Miscellaneous
238
239 * Running other Programs::        Running other Programs
240
241 Run Control
242
243 * Waiting For Completion::        Waiting until an operation is completed.
244 * Using External Event Loops::    Advanced control over what happens when.
245 * Cancellation::                  How to end pending operations prematurely.
246
247 Using External Event Loops
248
249 * I/O Callback Interface::        How I/O callbacks are registered.
250 * Registering I/O Callbacks::     How to use I/O callbacks for a context.
251 * I/O Callback Example::          An example how to use I/O callbacks.
252 * I/O Callback Example GTK+::     How to integrate @acronym{GPGME} in GTK+.
253 * I/O Callback Example GDK::      How to integrate @acronym{GPGME} in GDK.
254 * I/O Callback Example Qt::       How to integrate @acronym{GPGME} in Qt.
255
256 @end detailmenu
257 @end menu
258
259 @node Introduction
260 @chapter Introduction
261
262 `GnuPG Made Easy' (@acronym{GPGME}) is a C language library that
263 allows to add support for cryptography to a program.  It is designed
264 to make access to public key crypto engines like GnuPG or GpgSM easier
265 for applications.  @acronym{GPGME} provides a high-level crypto API
266 for encryption, decryption, signing, signature verification and key
267 management.
268
269 @acronym{GPGME} uses GnuPG and GpgSM as its backends to support
270 OpenPGP and the Cryptographic Message Syntax (CMS).
271
272 @menu
273 * Getting Started::               Purpose of the manual, and how to use it.
274 * Features::                      Reasons to install and use @acronym{GPGME}.
275 * Overview::                      Basic architecture of the @acronym{GPGME} library.
276 @end menu
277
278
279 @node Getting Started
280 @section Getting Started
281
282 This manual documents the @acronym{GPGME} library programming
283 interface.  All functions and data types provided by the library are
284 explained.
285
286 The reader is assumed to possess basic knowledge about cryptography in
287 general, and public key cryptography in particular.  The underlying
288 cryptographic engines that are used by the library are not explained,
289 but where necessary, special features or requirements by an engine are
290 mentioned as far as they are relevant to @acronym{GPGME} or its users.
291
292 This manual can be used in several ways.  If read from the beginning
293 to the end, it gives a good introduction into the library and how it
294 can be used in an application.  Forward references are included where
295 necessary.  Later on, the manual can be used as a reference manual to
296 get just the information needed about any particular interface of the
297 library.  Experienced programmers might want to start looking at the
298 examples at the end of the manual, and then only read up those parts
299 of the interface which are unclear.
300
301 The documentation for the language bindings is currently not included
302 in this manual.  Those languages bindings follow the general
303 programming model of @acronym{GPGME} but may provide some extra high
304 level abstraction on top of the @acronym{GPGME} style API.  For now
305 please see the README files in the @file{lang/} directory of the
306 source distribution.
307
308
309 @node Features
310 @section Features
311
312 @acronym{GPGME} has a couple of advantages over other libraries doing
313 a similar job, and over implementing support for GnuPG or other crypto
314 engines into your application directly.
315
316 @table @asis
317 @item it's free software
318 Anybody can use, modify, and redistribute it under the terms of the GNU
319 Lesser General Public License (@pxref{Library Copying}).
320
321 @item it's flexible
322 @acronym{GPGME} provides transparent support for several cryptographic
323 protocols by different engines.  Currently, @acronym{GPGME} supports
324 the OpenPGP protocol using GnuPG as the backend, and the Cryptographic
325 Message Syntax using GpgSM as the backend.
326
327 @item it's easy
328 @acronym{GPGME} hides the differences between the protocols and
329 engines from the programmer behind an easy-to-use interface.  This way
330 the programmer can focus on the other parts of the program, and still
331 integrate strong cryptography in his application.  Once support for
332 @acronym{GPGME} has been added to a program, it is easy to add support
333 for other crypto protocols once @acronym{GPGME} backends provide them.
334
335 @item it's language friendly
336 @acronym{GPGME} comes with languages bindings for several common
337 programming languages: Common Lisp, C++, Python 2, and Python 3.
338 @end table
339
340 @node Overview
341 @section Overview
342
343 @acronym{GPGME} provides a data abstraction that is used to pass data
344 to the crypto engine, and receive returned data from it.  Data can be
345 read from memory or from files, but it can also be provided by a
346 callback function.
347
348 The actual cryptographic operations are always set within a context.
349 A context provides configuration parameters that define the behaviour
350 of all operations performed within it.  Only one operation per context
351 is allowed at any time, but when one operation is finished, you can
352 run the next operation in the same context.  There can be more than
353 one context, and all can run different operations at the same time.
354
355 Furthermore, @acronym{GPGME} has rich key management facilities
356 including listing keys, querying their attributes, generating,
357 importing, exporting and deleting keys, and acquiring information
358 about the trust path.
359
360 With some precautions, @acronym{GPGME} can be used in a multi-threaded
361 environment, although it is not completely thread safe and thus needs
362 the support of the application.
363
364
365 @node Preparation
366 @chapter Preparation
367
368 To use @acronym{GPGME}, you have to perform some changes to your
369 sources and the build system.  The necessary changes are small and
370 explained in the following sections.  At the end of this chapter, it
371 is described how the library is initialized, and how the requirements
372 of the library are verified.
373
374 @menu
375 * Header::                        What header file you need to include.
376 * Building the Source::           Compiler options to be used.
377 * Largefile Support (LFS)::       How to use @acronym{GPGME} with LFS.
378 * Using Automake::                Compiler options to be used the easy way.
379 * Using Libtool::                 Avoiding compiler options entirely.
380 * Library Version Check::         Getting and verifying the library version.
381 * Signal Handling::               How @acronym{GPGME} affects signal handling.
382 * Multi Threading::               How @acronym{GPGME} can be used in an MT environment.
383 @end menu
384
385
386 @node Header
387 @section Header
388 @cindex header file
389 @cindex include file
390
391 All interfaces (data types and functions) of the library are defined
392 in the header file `gpgme.h'.  You must include this in all programs
393 using the library, either directly or through some other header file,
394 like this:
395
396 @example
397 #include <gpgme.h>
398 @end example
399
400 The name space of @acronym{GPGME} is @code{gpgme_*} for function names
401 and data types and @code{GPGME_*} for other symbols.  Symbols internal
402 to @acronym{GPGME} take the form @code{_gpgme_*} and @code{_GPGME_*}.
403
404 Because @acronym{GPGME} makes use of the GPG Error library, using
405 @acronym{GPGME} will also use the @code{GPG_ERR_*} name space
406 directly, and the @code{gpg_err*}, @code{gpg_str*}, and @code{gpgrt_*}
407 name space indirectly.
408
409
410 @node Building the Source
411 @section Building the Source
412 @cindex compiler options
413 @cindex compiler flags
414
415 If you want to compile a source file including the `gpgme.h' header
416 file, you must make sure that the compiler can find it in the
417 directory hierarchy.  This is accomplished by adding the path to the
418 directory in which the header file is located to the compilers include
419 file search path (via the @option{-I} option).
420
421 However, the path to the include file is determined at the time the
422 source is configured.  To solve this problem, gpgme ships with a small
423 helper program @command{gpgme-config} that knows about the path to the
424 include file and other configuration options.  The options that need
425 to be added to the compiler invocation at compile time are output by
426 the @option{--cflags} option to @command{gpgme-config}.  The following
427 example shows how it can be used at the command line:
428
429 @example
430 gcc -c foo.c `gpgme-config --cflags`
431 @end example
432
433 Adding the output of @samp{gpgme-config --cflags} to the compiler
434 command line will ensure that the compiler can find the
435 @acronym{GPGME} header file.
436
437 A similar problem occurs when linking the program with the library.
438 Again, the compiler has to find the library files.  For this to work,
439 the path to the library files has to be added to the library search
440 path (via the @option{-L} option).  For this, the option
441 @option{--libs} to @command{gpgme-config} can be used.  For
442 convenience, this option also outputs all other options that are
443 required to link the program with @acronym{GPGME} (in particular, the
444 @samp{-lgpgme} option).  The example shows how to link @file{foo.o}
445 with the @acronym{GPGME} library to a program @command{foo}.
446
447 @example
448 gcc -o foo foo.o `gpgme-config --libs`
449 @end example
450
451 Of course you can also combine both examples to a single command by
452 specifying both options to @command{gpgme-config}:
453
454 @example
455 gcc -o foo foo.c `gpgme-config --cflags --libs`
456 @end example
457
458 If you want to link to one of the thread-safe versions of
459 @acronym{GPGME}, you must specify the @option{--thread} option before
460 any other option to select the thread package you want to link with.
461 Supported thread packages are @option{--thread=pth} and
462 @option{--thread=pthread}.
463
464 If you need to detect the installed language bindings you can use list
465 them using:
466
467 @example
468 gpgme-config --print-lang
469 @end example
470
471 or test for the availability using
472
473 @example
474 gpgme-config --have-lang=python && echo 'Bindings for Pythons available'
475 @end example
476
477
478 @node Largefile Support (LFS)
479 @section Largefile Support (LFS)
480 @cindex largefile support
481 @cindex LFS
482
483 @acronym{GPGME} is compiled with largefile support by default, if it
484 is available on the system.  This means that GPGME supports files
485 larger than two gigabyte in size, if the underlying operating system
486 can.  On some systems, largefile support is already the default.  On
487 such systems, nothing special is required.  However, some systems
488 provide only support for files up to two gigabyte in size by default.
489 Support for larger file sizes has to be specifically enabled.
490
491 To make a difficult situation even more complex, such systems provide
492 two different types of largefile support.  You can either get all
493 relevant functions replaced with alternatives that are largefile
494 capable, or you can get new functions and data types for largefile
495 support added.  Those new functions have the same name as their
496 smallfile counterparts, but with a suffix of 64.
497
498 An example: The data type @code{off_t} is 32 bit wide on GNU/Linux PC
499 systems.  To address offsets in large files, you can either enable
500 largefile support add-on.  Then a new data type @code{off64_t} is
501 provided, which is 64 bit wide.  Or you can replace the existing
502 @code{off_t} data type with its 64 bit wide counterpart.  All
503 occurences of @code{off_t} are then automagically replaced.
504
505 As if matters were not complex enough, there are also two different
506 types of file descriptors in such systems.  This is important because
507 if file descriptors are exchanged between programs that use a
508 different maximum file size, certain errors must be produced on some
509 file descriptors to prevent subtle overflow bugs from occuring.
510
511 As you can see, supporting two different maximum file sizes at the
512 same time is not at all an easy task.  However, the maximum file size
513 does matter for @acronym{GPGME}, because some data types it uses in
514 its interfaces are affected by that.  For example, the @code{off_t}
515 data type is used in the @code{gpgme_data_seek} function, to match its
516 @acronym{POSIX} counterpart.  This affects the call-frame of the
517 function, and thus the ABI of the library.  Furthermore, file
518 descriptors can be exchanged between GPGME and the application.
519
520 For you as the user of the library, this means that your program must
521 be compiled in the same file size mode as the library.  Luckily, there
522 is absolutely no valid reason for new programs to not enable largefile
523 support by default and just use that.  The compatibility modes (small
524 file sizes or dual mode) can be considered an historic artefact, only
525 useful to allow for a transitional period.
526
527 On POSIX platforms @acronym{GPGME} is compiled using largefile support
528 by default.  This means that your application must do the same, at
529 least as far as it is relevant for using the @file{gpgme.h} header
530 file.  All types in this header files refer to their largefile
531 counterparts, if they are different from any default types on the
532 system.
533
534 On 32 and 64 bit Windows platforms @code{off_t} is declared as 32 bit
535 signed integer.  There is no specific support for LFS in the C
536 library.  The recommendation from Microsoft is to use the native
537 interface (@code{CreateFile} et al.) for large files.  Released binary
538 versions of @acronym{GPGME} (libgpgme-11.dll) have always been build
539 with a 32 bit @code{off_t}.  To avoid an ABI break we stick to this
540 convention for 32 bit Windows by using @code{long} there.
541 @acronym{GPGME} versions for 64 bit Windows have never been released
542 and thus we are able to use @code{int64_t} instead of @code{off_t}
543 there.  For easier migration the typedef @code{gpgme_off_t} has been
544 defined.  The reason we cannot use @code{off_t} directly is that some
545 toolchains (e.g. mingw64) introduce a POSIX compatible hack for
546 @code{off_t}.  Some widely used toolkits make use of this hack and in
547 turn @acronym{GPGME} would need to use it also.  However, this would
548 introduce an ABI break and existing software making use of libgpgme
549 might suffer from a severe break.  Thus with version 1.4.2 we
550 redefined all functions using @code{off_t} to use @code{gpgme_off_t}
551 which is defined as explained above.  This way we keep the ABI well
552 defined and independent of any toolchain hacks.  The bottom line is
553 that LFS support in @acronym{GPGME} is only available on 64 bit
554 versions of Windows.
555
556 On POSIX platforms you can enable largefile support, if it is
557 different from the default on the system the application is compiled
558 on, by using the Autoconf macro @code{AC_SYS_LARGEFILE}.  If you do
559 this, then you don't need to worry about anything else: It will just
560 work.  In this case you might also want to use @code{AC_FUNC_FSEEKO}
561 to take advantage of some new interfaces, and @code{AC_TYPE_OFF_T}
562 (just in case).
563
564 If you do not use Autoconf, you can define the preprocessor symbol
565 @code{_FILE_OFFSET_BITS} to 64 @emph{before} including any header
566 files, for example by specifying the option
567 @code{-D_FILE_OFFSET_BITS=64} on the compiler command line.  You will
568 also want to define the preprocessor symbol @code{LARGEFILE_SOURCE} to
569 1 in this case, to take advantage of some new interfaces.
570
571 If you do not want to do either of the above, you probably know enough
572 about the issue to invent your own solution.  Just keep in mind that
573 the @acronym{GPGME} header file expects that largefile support is
574 enabled, if it is available.  In particular, we do not support dual
575 mode (@code{_LARGEFILE64_SOURCE}).
576
577
578 @node Using Automake
579 @section Using Automake
580 @cindex automake
581 @cindex autoconf
582
583 It is much easier if you use GNU Automake instead of writing your own
584 Makefiles.  If you do that you do not have to worry about finding and
585 invoking the @command{gpgme-config} script at all.  @acronym{GPGME}
586 provides an extension to Automake that does all the work for you.
587
588 @c A simple macro for optional variables.
589 @macro ovar{varname}
590 @r{[}@var{\varname\}@r{]}
591 @end macro
592 @defmac AM_PATH_GPGME (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
593 @defmacx AM_PATH_GPGME_PTH (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
594 @defmacx AM_PATH_GPGME_PTHREAD (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
595 Check whether @acronym{GPGME} (at least version @var{minimum-version},
596 if given) exists on the host system.  If it is found, execute
597 @var{action-if-found}, otherwise do @var{action-if-not-found}, if
598 given.
599
600 Additionally, the function defines @code{GPGME_CFLAGS} to the flags
601 needed for compilation of the program to find the @file{gpgme.h}
602 header file, and @code{GPGME_LIBS} to the linker flags needed to link
603 the program to the @acronym{GPGME} library.  If the used helper script
604 does not match the target type you are building for a warning is
605 printed and the string @code{libgcrypt} is appended to the variable
606 @code{gpg_config_script_warn}.
607
608 @code{AM_PATH_GPGME_PTH} checks for the version of @acronym{GPGME}
609 that can be used with GNU Pth, and defines @code{GPGME_PTH_CFLAGS} and
610 @code{GPGME_PTH_LIBS}.
611
612 @code{AM_PATH_GPGME_PTHREAD} checks for the version of @acronym{GPGME}
613 that can be used with the native pthread implementation, and defines
614 @code{GPGME_PTHREAD_CFLAGS} and @code{GPGME_PTHREAD_LIBS}.
615
616 This macro searches for @command{gpgme-config} along the PATH.  If
617 you are cross-compiling, it is useful to set the environment variable
618 @code{SYSROOT} to the top directory of your target.  The macro will
619 then first look for the helper program in the @file{bin} directory
620 below that top directory.  An absolute directory name must be used for
621 @code{SYSROOT}.  Finally, if the configure command line option
622 @code{--with-gpgme-prefix} is used, only its value is used for the top
623 directory below which the helper script is expected.
624
625 @end defmac
626
627 You can use the defined Autoconf variables like this in your
628 @file{Makefile.am}:
629
630 @example
631 AM_CPPFLAGS = $(GPGME_CFLAGS)
632 LDADD = $(GPGME_LIBS)
633 @end example
634
635
636 @node Using Libtool
637 @section Using Libtool
638 @cindex libtool
639
640 The easiest way is to just use GNU Libtool.  If you use libtool, and
641 link to @code{libgpgme.la}, @code{libgpgme-pth.la} or
642 @code{libgpgme-pthread.la} respectively, everything will be done
643 automatically by Libtool.
644
645
646 @node Library Version Check
647 @section Library Version Check
648 @cindex version check, of the library
649
650 @deftypefun {const char *} gpgme_check_version (@w{const char *@var{required_version}})
651 The function @code{gpgme_check_version} has four purposes.  It can be
652 used to retrieve the version number of the library.  In addition it
653 can verify that the version number is higher than a certain required
654 version number.  In either case, the function initializes some
655 sub-systems, and for this reason alone it must be invoked early in
656 your program, before you make use of the other functions in
657 @acronym{GPGME}.  The last purpose is to run selftests.
658
659 As a side effect for W32 based systems, the socket layer will get
660 initialized.
661
662
663 If @var{required_version} is @code{NULL}, the function returns a
664 pointer to a statically allocated string containing the version number
665 of the library.
666
667 If @var{required_version} is not @code{NULL}, it should point to a
668 string containing a version number, and the function checks that the
669 version of the library is at least as high as the version number
670 provided.  In this case, the function returns a pointer to a
671 statically allocated string containing the version number of the
672 library.  If @var{REQUIRED_VERSION} is not a valid version number, or
673 if the version requirement is not met, the function returns
674 @code{NULL}.
675
676 If you use a version of a library that is backwards compatible with
677 older releases, but contains additional interfaces which your program
678 uses, this function provides a run-time check if the necessary
679 features are provided by the installed version of the library.
680
681 If a selftest fails, the function may still succeed.  Selftest errors
682 are returned later when invoking @code{gpgme_new}, so that a detailed
683 error code can be returned (historically, @code{gpgme_check_version}
684 does not return a detailed error code).
685 @end deftypefun
686
687
688 @deftypefun {int} gpgme_set_global_flag  @
689             (@w{const char *@var{name}}, @
690             @w{const char *@var{value}})
691
692 On some systems it is not easy to set environment variables and thus
693 hard to use @acronym{GPGME}'s internal trace facility for debugging.
694 This function has been introduced as an alternative way to enable
695 debugging and for a couple of other rarely used tweaks.  It is
696 important to assure that only one thread accesses @acronym{GPGME}
697 functions between a call to this function and after the return from
698 the call to @code{gpgme_check_version}.
699
700 All currently supported features require that this function is called
701 as early as possible --- even before @code{gpgme_check_version}.  The
702 features are identified by the following values for @var{name}:
703
704 @table @code
705 @item debug
706 To enable debugging use the string ``debug'' for @var{name} and
707 @var{value} identical to the value used with the environment variable
708 @code{GPGME_DEBUG}.
709
710 @item disable-gpgconf
711 Using this feature with any @var{value} disables the detection of the
712 gpgconf program and thus forces GPGME to fallback into the simple
713 OpenPGP only mode.  It may be used to force the use of GnuPG-1 on
714 systems which have both GPG versions installed.  Note that in general
715 the use of @code{gpgme_set_engine_info} is a better way to select a
716 specific engine version.
717
718 @item gpgconf-name
719 @itemx gpg-name
720 Set the name of the gpgconf respective gpg binary.  The defaults are
721 @code{GNU/GnuPG/gpgconf} and @code{GNU/GnuPG/gpg}.  Under Unix the
722 leading directory part is ignored.  Under Windows the leading
723 directory part is used as the default installation directory; the
724 @code{.exe} suffix is added by GPGME.  Use forward slashed even under
725 Windows.
726
727 @item require-gnupg
728 Set the mimimum version of the required GnuPG engine.  If that version
729 is not met, GPGME fails early instead of trying to use the existant
730 version.  The given version must be a string with major, minor, and
731 micro number.  Example: "2.1.0".
732
733 @item w32-inst-dir
734 On Windows GPGME needs to know its installation directory to find its
735 spawn helper.  This is in general no problem because a DLL has this
736 information.  Some applications however link statically to GPGME and
737 thus GPGME can only figure out the installation directory of this
738 application which may be wrong in certain cases.  By supplying an
739 installation directory as value to this flag, GPGME will assume that
740 that directory is the installation directory.  This flag has no effect
741 on non-Windows platforms.
742
743 @end table
744
745 This function returns @code{0} on success.  In contrast to other
746 functions the non-zero return value on failure does not convey any
747 error code.  For setting ``debug'' the only possible error cause is an
748 out of memory condition; which would exhibit itself later anyway.
749 Thus the return value may be ignored.
750 @end deftypefun
751
752
753 After initializing @acronym{GPGME}, you should set the locale
754 information to the locale required for your output terminal.  This
755 locale information is needed for example for the curses and Gtk
756 pinentry.  Here is an example of a complete initialization:
757
758 @example
759 #include <locale.h>
760 #include <gpgme.h>
761
762 void
763 init_gpgme (void)
764 @{
765   /* Initialize the locale environment.  */
766   setlocale (LC_ALL, "");
767   gpgme_check_version (NULL);
768   gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
769 #ifdef LC_MESSAGES
770   gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
771 #endif
772 @}
773 @end example
774
775 Note that you are highly recommended to initialize the locale settings
776 like this.  @acronym{GPGME} can not do this for you because it would
777 not be thread safe.  The conditional on LC_MESSAGES is only necessary
778 for portability to W32 systems.
779
780
781 @node Signal Handling
782 @section Signal Handling
783 @cindex signals
784 @cindex signal handling
785
786 The @acronym{GPGME} library communicates with child processes (the
787 crypto engines).  If a child process dies unexpectedly, for example
788 due to a bug, or system problem, a @code{SIGPIPE} signal will be
789 delivered to the application.  The default action is to abort the
790 program.  To protect against this, @code{gpgme_check_version} sets the
791 @code{SIGPIPE} signal action to @code{SIG_IGN}, which means that the
792 signal will be ignored.
793
794 @acronym{GPGME} will only do that if the signal action for
795 @code{SIGPIPE} is @code{SIG_DEF} at the time
796 @code{gpgme_check_version} is called.  If it is something different,
797 @code{GPGME} will take no action.
798
799 This means that if your application does not install any signal
800 handler for @code{SIGPIPE}, you don't need to take any precautions.
801 If you do install a signal handler for @code{SIGPIPE}, you must be
802 prepared to handle any @code{SIGPIPE} events that occur due to
803 @acronym{GPGME} writing to a defunct pipe.  Furthermore, if your
804 application is multi-threaded, and you install a signal action for
805 @code{SIGPIPE}, you must make sure you do this either before
806 @code{gpgme_check_version} is called or afterwards.
807
808
809 @node Multi Threading
810 @section Multi Threading
811 @cindex thread-safeness
812 @cindex multi-threading
813
814 The @acronym{GPGME} library is not entirely thread-safe, but it can
815 still be used in a multi-threaded environment if some care is taken.
816 If the following requirements are met, there should be no race
817 conditions to worry about:
818
819 @itemize @bullet
820 @item
821 @acronym{GPGME} supports the thread libraries pthread and GNU Pth.
822 The support for this has to be enabled at compile time.
823 @acronym{GPGME} will automatically detect the location in which the
824 thread libraries are installed and activate the support for them at
825 build time.
826
827 Support for other thread libraries is very easy to add.  Please
828 contact us if you have the need.
829
830 @item
831 If you want to use @acronym{GPGME} with threads, you must link to the
832 right version of the library.  The name of the right library is
833 @code{libgpgme-} followed by the name of the thread package you use.
834 For example, if you use GNU Pth, the right name is
835 @code{libgpgme-pth}.  Use the Automake macros or
836 @command{gpgme-config} program for simplicity.
837
838
839 @item
840 The function @code{gpgme_check_version} must be called before any
841 other function in the library, because it initializes the thread
842 support subsystem in @acronym{GPGME}.  To achieve this in
843 multi-threaded programs, you must synchronize the memory with respect
844 to other threads that also want to use @acronym{GPGME}.  For this, it
845 is sufficient to call @code{gpgme_check_version} before creating the
846 other threads using @acronym{GPGME}@footnote{At least this is true for
847 POSIX threads, as @code{pthread_create} is a function that
848 synchronizes memory with respects to other threads.  There are many
849 functions which have this property, a complete list can be found in
850 POSIX, IEEE Std 1003.1-2003, Base Definitions, Issue 6, in the
851 definition of the term ``Memory Synchronization''.  For other thread
852 packages other, more relaxed or more strict rules may apply.}.
853
854 @item
855 Any @code{gpgme_data_t} and @code{gpgme_ctx_t} object must only be
856 accessed by one thread at a time.  If multiple threads want to deal
857 with the same object, the caller has to make sure that operations on
858 that object are fully synchronized.
859
860 @item
861 Only one thread at any time is allowed to call @code{gpgme_wait}.  If
862 multiple threads call this function, the caller must make sure that
863 all invocations are fully synchronized.  It is safe to start
864 asynchronous operations while a thread is running in gpgme_wait.
865
866 @item
867 The function @code{gpgme_strerror} is not thread safe.  You have to
868 use @code{gpgme_strerror_r} instead.
869 @end itemize
870
871
872 @node Protocols and Engines
873 @chapter Protocols and Engines
874 @cindex protocol
875 @cindex engine
876 @cindex crypto engine
877 @cindex backend
878 @cindex crypto backend
879
880 @acronym{GPGME} supports several cryptographic protocols, however, it
881 does not implement them.  Rather it uses backends (also called
882 engines) which implement the protocol.  @acronym{GPGME} uses
883 inter-process communication to pass data back and forth between the
884 application and the backend, but the details of the communication
885 protocol and invocation of the backend is completely hidden by the
886 interface.  All complexity is handled by @acronym{GPGME}.  Where an
887 exchange of information between the application and the backend is
888 necessary, @acronym{GPGME} provides the necessary callback function
889 hooks and further interfaces.
890
891 @deftp {Data type} {enum gpgme_protocol_t}
892 @tindex gpgme_protocol_t
893 The @code{gpgme_protocol_t} type specifies the set of possible protocol
894 values that are supported by @acronym{GPGME}.  The following protocols
895 are supported:
896
897 @table @code
898 @item GPGME_PROTOCOL_OpenPGP
899 This specifies the OpenPGP protocol.
900
901 @item GPGME_PROTOCOL_CMS
902 This specifies the Cryptographic Message Syntax.
903
904 @item GPGME_PROTOCOL_GPGCONF
905 Under development.  Please ask on @email{gnupg-devel@@gnupg.org} for help.
906
907 @item GPGME_PROTOCOL_ASSUAN
908 This specifies the raw Assuan protocol.
909
910 @item GPGME_PROTOCOL_G13
911 Under development.  Please ask on @email{gnupg-devel@@gnupg.org} for help.
912
913 @item GPGME_PROTOCOL_UISERVER
914 Under development.  Please ask on @email{gnupg-devel@@gnupg.org} for help.
915
916 @item GPGME_PROTOCOL_SPAWN
917 Special protocol for use with @code{gpgme_op_spawn}.
918
919 @item GPGME_PROTOCOL_UNKNOWN
920 Reserved for future extension.  You may use this to indicate that the
921 used protocol is not known to the application.  Currently,
922 @acronym{GPGME} does not accept this value in any operation, though,
923 except for @code{gpgme_get_protocol_name}.
924 @end table
925 @end deftp
926
927
928 @deftypefun {const char *} gpgme_get_protocol_name (@w{gpgme_protocol_t @var{protocol}})
929 The function @code{gpgme_get_protocol_name} returns a statically
930 allocated string describing the protocol @var{protocol}, or
931 @code{NULL} if the protocol number is not valid.
932 @end deftypefun
933
934 @menu
935 * Engine Version Check::          Verifying the engine version.
936 * Engine Information::            Obtaining more information about the engines.
937 * Engine Configuration::          Changing the engine configuration.
938 * OpenPGP::                       Support for the OpenPGP protocol.
939 * Cryptographic Message Syntax::  Support for the CMS.
940 * Assuan::                        Support for the raw Assuan protocol.
941 @end menu
942
943
944 @node Engine Version Check
945 @section Engine Version Check
946 @cindex version check, of the engines
947
948 @deftypefun @w{const char *} gpgme_get_dirinfo (@w{cons char *@var{what}})
949 The function @code{gpgme_get_dirinfo} returns a statically allocated
950 string with the value associated to @var{what}.  The returned values
951 are the defaults and won't change even after
952 @code{gpgme_set_engine_info} has been used to configure a different
953 engine.  @code{NULL} is returned if no value is available.  Commonly
954 supported values for @var{what} are:
955
956 @table @code
957 @item homedir
958 Return the default home directory.
959
960 @item sysconfdir
961 Return the name of the system configuration directory
962
963 @item bindir
964 Return the name of the directory with GnuPG program files.
965
966 @item libdir
967 Return the name of the directory with GnuPG related library files.
968
969 @item libexecdir
970 Return the name of the directory with GnuPG helper program files.
971
972 @item datadir
973 Return the name of the directory with GnuPG shared data.
974
975 @item localedir
976 Return the name of the directory with GnuPG locale data.
977
978 @item agent-socket
979 Return the name of the socket to connect to the gpg-agent.
980
981 @item agent-ssh-socket
982 Return the name of the socket to connect to the ssh-agent component of
983 gpg-agent.
984
985 @item dirmngr-socket
986 Return the name of the socket to connect to the dirmngr.
987
988 @item uiserver-socket
989 Return the name of the socket to connect to the user interface server.
990
991 @item gpgconf-name
992 Return the file name of the engine configuration tool.
993
994 @item gpg-name
995 Return the file name of the OpenPGP engine.
996
997 @item gpgsm-name
998 Return the file name of the CMS engine.
999
1000 @item g13-name
1001 Return the name of the file container encryption engine.
1002
1003 @end table
1004
1005 @end deftypefun
1006
1007
1008 @deftypefun gpgme_error_t gpgme_engine_check_version (@w{gpgme_protocol_t @var{protocol}})
1009 The function @code{gpgme_engine_check_version} verifies that the
1010 engine implementing the protocol @var{PROTOCOL} is installed in the
1011 expected path and meets the version requirement of @acronym{GPGME}.
1012
1013 This function returns the error code @code{GPG_ERR_NO_ERROR} if the
1014 engine is available and @code{GPG_ERR_INV_ENGINE} if it is not.
1015 @end deftypefun
1016
1017
1018 @node Engine Information
1019 @section Engine Information
1020 @cindex engine, information about
1021
1022 @deftp {Data type} {gpgme_engine_info_t}
1023 @tindex gpgme_protocol_t
1024 The @code{gpgme_engine_info_t} type specifies a pointer to a structure
1025 describing a crypto engine.  The structure contains the following
1026 elements:
1027
1028 @table @code
1029 @item gpgme_engine_info_t next
1030 This is a pointer to the next engine info structure in the linked
1031 list, or @code{NULL} if this is the last element.
1032
1033 @item gpgme_protocol_t protocol
1034 This is the protocol for which the crypto engine is used.  You can
1035 convert this to a string with @code{gpgme_get_protocol_name} for
1036 printing.
1037
1038 @item const char *file_name
1039 This is a string holding the file name of the executable of the crypto
1040 engine.  Currently, it is never @code{NULL}, but using @code{NULL} is
1041 reserved for future use, so always check before you use it.
1042
1043 @item const char *home_dir
1044 This is a string holding the directory name of the crypto engine's
1045 configuration directory.  If it is @code{NULL}, then the default
1046 directory is used.  See @code{gpgme_get_dirinfo} on how to get the
1047 default directory.
1048
1049 @item const char *version
1050 This is a string containing the version number of the crypto engine.
1051 It might be @code{NULL} if the version number can not be determined,
1052 for example because the executable doesn't exist or is invalid.
1053
1054 @item const char *req_version
1055 This is a string containing the minimum required version number of the
1056 crypto engine for @acronym{GPGME} to work correctly.  This is the
1057 version number that @code{gpgme_engine_check_version} verifies
1058 against.  Currently, it is never @code{NULL}, but using @code{NULL} is
1059 reserved for future use, so always check before you use it.
1060 @end table
1061 @end deftp
1062
1063 @deftypefun gpgme_error_t gpgme_get_engine_info (@w{gpgme_engine_info_t *@var{info}})
1064 The function @code{gpgme_get_engine_info} returns a linked list of
1065 engine info structures in @var{info}.  Each info structure describes
1066 the defaults of one configured backend.
1067
1068 The memory for the info structures is allocated the first time this
1069 function is invoked, and must not be freed by the caller.
1070
1071 This function returns the error code @code{GPG_ERR_NO_ERROR} if
1072 successful, and a system error if the memory could not be allocated.
1073 @end deftypefun
1074
1075 Here is an example how you can provide more diagnostics if you receive
1076 an error message which indicates that the crypto engine is invalid.
1077
1078 @example
1079 gpgme_ctx_t ctx;
1080 gpgme_error_t err;
1081
1082 [...]
1083
1084 if (gpgme_err_code (err) == GPG_ERR_INV_ENGINE)
1085   @{
1086     gpgme_engine_info_t info;
1087     err = gpgme_get_engine_info (&info);
1088     if (!err)
1089       @{
1090         while (info && info->protocol != gpgme_get_protocol (ctx))
1091           info = info->next;
1092         if (!info)
1093           fprintf (stderr, "GPGME compiled without support for protocol %s",
1094                    gpgme_get_protocol_name (info->protocol));
1095         else if (info->file_name && !info->version)
1096           fprintf (stderr, "Engine %s not installed properly",
1097                    info->file_name);
1098         else if (info->file_name && info->version && info->req_version)
1099           fprintf (stderr, "Engine %s version %s installed, "
1100                    "but at least version %s required", info->file_name,
1101                    info->version, info->req_version);
1102         else
1103           fprintf (stderr, "Unknown problem with engine for protocol %s",
1104                    gpgme_get_protocol_name (info->protocol));
1105       @}
1106   @}
1107 @end example
1108
1109
1110 @node Engine Configuration
1111 @section Engine Configuration
1112 @cindex engine, configuration of
1113 @cindex configuration of crypto backend
1114
1115 You can change the configuration of a backend engine, and thus change
1116 the executable program and configuration directory to be used.  You
1117 can make these changes the default or set them for some contexts
1118 individually.
1119
1120 @deftypefun gpgme_error_t gpgme_set_engine_info (@w{gpgme_protocol_t @var{proto}}, @w{const char *@var{file_name}}, @w{const char *@var{home_dir}})
1121 The function @code{gpgme_set_engine_info} changes the default
1122 configuration of the crypto engine implementing the protocol
1123 @var{proto}.
1124
1125 @var{file_name} is the file name of the executable program
1126 implementing this protocol, and @var{home_dir} is the directory name
1127 of the configuration directory for this crypto engine.  If
1128 @var{home_dir} is @code{NULL}, the engine's default will be used.
1129
1130 The new defaults are not applied to already created GPGME contexts.
1131
1132 This function returns the error code @code{GPG_ERR_NO_ERROR} if
1133 successful, or an eror code on failure.
1134 @end deftypefun
1135
1136 The functions @code{gpgme_ctx_get_engine_info} and
1137 @code{gpgme_ctx_set_engine_info} can be used to change the engine
1138 configuration per context.  @xref{Crypto Engine}.
1139
1140
1141 @node OpenPGP
1142 @section OpenPGP
1143 @cindex OpenPGP
1144 @cindex GnuPG
1145 @cindex protocol, GnuPG
1146 @cindex engine, GnuPG
1147
1148 OpenPGP is implemented by GnuPG, the @acronym{GNU} Privacy Guard.
1149 This is the first protocol that was supported by @acronym{GPGME}.
1150
1151 The OpenPGP protocol is specified by @code{GPGME_PROTOCOL_OpenPGP}.
1152
1153
1154 @node Cryptographic Message Syntax
1155 @section Cryptographic Message Syntax
1156 @cindex CMS
1157 @cindex cryptographic message syntax
1158 @cindex GpgSM
1159 @cindex protocol, CMS
1160 @cindex engine, GpgSM
1161 @cindex S/MIME
1162 @cindex protocol, S/MIME
1163
1164 @acronym{CMS} is implemented by GpgSM, the S/MIME implementation for
1165 GnuPG.
1166
1167 The @acronym{CMS} protocol is specified by @code{GPGME_PROTOCOL_CMS}.
1168
1169
1170 @node Assuan
1171 @section Assuan
1172 @cindex ASSUAN
1173 @cindex protocol, ASSUAN
1174 @cindex engine, ASSUAN
1175
1176 Assuan is the RPC library used by the various @acronym{GnuPG}
1177 components.  The Assuan protocol allows one to talk to arbitrary
1178 Assuan servers using @acronym{GPGME}.  @xref{Using the Assuan
1179 protocol}.
1180
1181 The ASSUAN protocol is specified by @code{GPGME_PROTOCOL_ASSUAN}.
1182
1183
1184 @node Algorithms
1185 @chapter Algorithms
1186 @cindex algorithms
1187
1188 The crypto backends support a variety of algorithms used in public key
1189 cryptography.@footnote{Some engines also provide symmetric only
1190 encryption; see the description of the encryption function on how to use
1191 this.}  The following sections list the identifiers used to denote such
1192 an algorithm.
1193
1194 @menu
1195 * Public Key Algorithms::         A list of all public key algorithms.
1196 * Hash Algorithms::               A list of all hash algorithms.
1197 @end menu
1198
1199
1200 @node Public Key Algorithms
1201 @section Public Key Algorithms
1202 @cindex algorithms, public key
1203 @cindex public key algorithms
1204
1205 Public key algorithms are used for encryption, decryption, signing and
1206 verification of signatures.
1207
1208 @deftp {Data type} {enum gpgme_pubkey_algo_t}
1209 @tindex gpgme_pubkey_algo_t
1210 The @code{gpgme_pubkey_algo_t} type specifies the set of all public key
1211 algorithms that are supported by @acronym{GPGME}.  Possible values
1212 are:
1213
1214 @table @code
1215 @item GPGME_PK_RSA
1216 This value indicates the RSA (Rivest, Shamir, Adleman) algorithm.
1217
1218 @item GPGME_PK_RSA_E
1219 Deprecated.  This value indicates the RSA (Rivest, Shamir, Adleman)
1220 algorithm for encryption and decryption only.
1221
1222 @item GPGME_PK_RSA_S
1223 Deprecated.  This value indicates the RSA (Rivest, Shamir, Adleman)
1224 algorithm for signing and verification only.
1225
1226 @item GPGME_PK_DSA
1227 This value indicates DSA, the Digital Signature Algorithm.
1228
1229 @item GPGME_PK_ELG
1230 This value indicates ElGamal.
1231
1232 @item GPGME_PK_ELG_E
1233 This value also indicates ElGamal and is used specifically in GnuPG.
1234
1235 @item GPGME_PK_ECC
1236 This value is a generic indicator for ellipic curve algorithms.
1237
1238 @item GPGME_PK_ECDSA
1239 This value indicates ECDSA, the Elliptic Curve Digital Signature
1240 Algorithm as defined by FIPS 186-2 and RFC-6637.
1241
1242 @item GPGME_PK_ECDH
1243 This value indicates ECDH, the Eliptic Curve Diffie-Hellmann
1244 encryption algorithm as defined by RFC-6637.
1245
1246 @item GPGME_PK_EDDSA
1247 This value indicates the EdDSA algorithm.
1248
1249 @end table
1250 @end deftp
1251
1252 @deftypefun {const char *} gpgme_pubkey_algo_name (@w{gpgme_pubkey_algo_t @var{algo}})
1253 The function @code{gpgme_pubkey_algo_name} returns a pointer to a
1254 statically allocated string containing a description of the public key
1255 algorithm @var{algo}.  This string can be used to output the name of
1256 the public key algorithm to the user.
1257
1258 If @var{algo} is not a valid public key algorithm, @code{NULL} is
1259 returned.
1260 @end deftypefun
1261
1262 @deftypefun {char *} gpgme_pubkey_algo_string (@w{gpgme_subkey_t @var{key}})
1263 The function @code{gpgme_pubkey_algo_string} is a convenience function
1264 to build and return an algorithm string in the same way GnuPG does
1265 (e.g. ``rsa2048'' or ``ed25519'').  The caller must free the result
1266 using @code{gpgme_free}.  On error (e.g. invalid argument or memory
1267 exhausted), the function returns NULL and sets @code{ERRNO}.
1268 @end deftypefun
1269
1270
1271 @node Hash Algorithms
1272 @section Hash Algorithms
1273 @cindex algorithms, hash
1274 @cindex algorithms, message digest
1275 @cindex hash algorithms
1276 @cindex message digest algorithms
1277
1278 Hash (message digest) algorithms are used to compress a long message
1279 to make it suitable for public key cryptography.
1280
1281 @deftp {Data type} {enum gpgme_hash_algo_t}
1282 @tindex gpgme_hash_algo_t
1283 The @code{gpgme_hash_algo_t} type specifies the set of all hash algorithms
1284 that are supported by @acronym{GPGME}.  Possible values are:
1285
1286 @table @code
1287 @item GPGME_MD_MD5
1288 @item GPGME_MD_SHA1
1289 @item GPGME_MD_RMD160
1290 @item GPGME_MD_MD2
1291 @item GPGME_MD_TIGER
1292 @item GPGME_MD_HAVAL
1293 @item GPGME_MD_SHA256
1294 @item GPGME_MD_SHA384
1295 @item GPGME_MD_SHA512
1296 @item GPGME_MD_SHA224
1297 @item GPGME_MD_MD4
1298 @item GPGME_MD_CRC32
1299 @item GPGME_MD_CRC32_RFC1510
1300 @item GPGME_MD_CRC24_RFC2440
1301 @end table
1302 @end deftp
1303
1304 @deftypefun {const char *} gpgme_hash_algo_name (@w{gpgme_hash_algo_t @var{algo}})
1305 The function @code{gpgme_hash_algo_name} returns a pointer to a
1306 statically allocated string containing a description of the hash
1307 algorithm @var{algo}.  This string can be used to output the name of
1308 the hash algorithm to the user.
1309
1310 If @var{algo} is not a valid hash algorithm, @code{NULL} is returned.
1311 @end deftypefun
1312
1313
1314 @node Error Handling
1315 @chapter Error Handling
1316 @cindex error handling
1317
1318 Many functions in @acronym{GPGME} can return an error if they fail.
1319 For this reason, the application should always catch the error
1320 condition and take appropriate measures, for example by releasing the
1321 resources and passing the error up to the caller, or by displaying a
1322 descriptive message to the user and cancelling the operation.
1323
1324 Some error values do not indicate a system error or an error in the
1325 operation, but the result of an operation that failed properly.  For
1326 example, if you try to decrypt a tempered message, the decryption will
1327 fail.  Another error value actually means that the end of a data
1328 buffer or list has been reached.  The following descriptions explain
1329 for many error codes what they mean usually.  Some error values have
1330 specific meanings if returned by a certain functions.  Such cases are
1331 described in the documentation of those functions.
1332
1333 @acronym{GPGME} uses the @code{libgpg-error} library.  This allows to
1334 share the error codes with other components of the GnuPG system, and
1335 thus pass error values transparently from the crypto engine, or some
1336 helper application of the crypto engine, to the user.  This way no
1337 information is lost.  As a consequence, @acronym{GPGME} does not use
1338 its own identifiers for error codes, but uses those provided by
1339 @code{libgpg-error}.  They usually start with @code{GPG_ERR_}.
1340
1341 However, @acronym{GPGME} does provide aliases for the functions
1342 defined in libgpg-error, which might be preferred for name space
1343 consistency.
1344
1345 @menu
1346 * Error Values::                  The error value and what it means.
1347 * Error Sources::                 A list of important error sources.
1348 * Error Codes::                   A list of important error codes.
1349 * Error Strings::                 How to get a descriptive string from a value.
1350 @end menu
1351
1352
1353 @node Error Values
1354 @section Error Values
1355 @cindex error values
1356 @cindex error codes
1357 @cindex error sources
1358
1359 @deftp {Data type} {gpgme_err_code_t}
1360 The @code{gpgme_err_code_t} type is an alias for the @code{libgpg-error}
1361 type @code{gpg_err_code_t}.  The error code indicates the type of an
1362 error, or the reason why an operation failed.
1363
1364 A list of important error codes can be found in the next section.
1365 @end deftp
1366
1367 @deftp {Data type} {gpgme_err_source_t}
1368 The @code{gpgme_err_source_t} type is an alias for the
1369 @code{libgpg-error} type @code{gpg_err_source_t}.  The error source
1370 has not a precisely defined meaning.  Sometimes it is the place where
1371 the error happened, sometimes it is the place where an error was
1372 encoded into an error value.  Usually the error source will give an
1373 indication to where to look for the problem.  This is not always true,
1374 but it is attempted to achieve this goal.
1375
1376 A list of important error sources can be found in the next section.
1377 @end deftp
1378
1379 @deftp {Data type} {gpgme_error_t}
1380 The @code{gpgme_error_t} type is an alias for the @code{libgpg-error}
1381 type @code{gpg_error_t}.  An error value like this has always two
1382 components, an error code and an error source.  Both together form the
1383 error value.
1384
1385 Thus, the error value can not be directly compared against an error
1386 code, but the accessor functions described below must be used.
1387 However, it is guaranteed that only 0 is used to indicate success
1388 (@code{GPG_ERR_NO_ERROR}), and that in this case all other parts of
1389 the error value are set to 0, too.
1390
1391 Note that in @acronym{GPGME}, the error source is used purely for
1392 diagnostical purposes.  Only the error code should be checked to test
1393 for a certain outcome of a function.  The manual only documents the
1394 error code part of an error value.  The error source is left
1395 unspecified and might be anything.
1396 @end deftp
1397
1398 @deftypefun {static inline gpgme_err_code_t} gpgme_err_code (@w{gpgme_error_t @var{err}})
1399 The static inline function @code{gpgme_err_code} returns the
1400 @code{gpgme_err_code_t} component of the error value @var{err}.  This
1401 function must be used to extract the error code from an error value in
1402 order to compare it with the @code{GPG_ERR_*} error code macros.
1403 @end deftypefun
1404
1405 @deftypefun {static inline gpgme_err_source_t} gpgme_err_source (@w{gpgme_error_t @var{err}})
1406 The static inline function @code{gpgme_err_source} returns the
1407 @code{gpgme_err_source_t} component of the error value @var{err}.  This
1408 function must be used to extract the error source from an error value in
1409 order to compare it with the @code{GPG_ERR_SOURCE_*} error source macros.
1410 @end deftypefun
1411
1412 @deftypefun {static inline gpgme_error_t} gpgme_err_make (@w{gpgme_err_source_t @var{source}}, @w{gpgme_err_code_t @var{code}})
1413 The static inline function @code{gpgme_err_make} returns the error
1414 value consisting of the error source @var{source} and the error code
1415 @var{code}.
1416
1417 This function can be used in callback functions to construct an error
1418 value to return it to the library.
1419 @end deftypefun
1420
1421 @deftypefun {static inline gpgme_error_t} gpgme_error (@w{gpgme_err_code_t @var{code}})
1422 The static inline function @code{gpgme_error} returns the error value
1423 consisting of the default error source and the error code @var{code}.
1424
1425 For @acronym{GPGME} applications, the default error source is
1426 @code{GPG_ERR_SOURCE_USER_1}.  You can define
1427 @code{GPGME_ERR_SOURCE_DEFAULT} before including @file{gpgme.h} to
1428 change this default.
1429
1430 This function can be used in callback functions to construct an error
1431 value to return it to the library.
1432 @end deftypefun
1433
1434 The @code{libgpg-error} library provides error codes for all system
1435 error numbers it knows about.  If @var{err} is an unknown error
1436 number, the error code @code{GPG_ERR_UNKNOWN_ERRNO} is used.  The
1437 following functions can be used to construct error values from system
1438 errnor numbers.
1439
1440 @deftypefun {gpgme_error_t} gpgme_err_make_from_errno (@w{gpgme_err_source_t @var{source}}, @w{int @var{err}})
1441 The function @code{gpgme_err_make_from_errno} is like
1442 @code{gpgme_err_make}, but it takes a system error like @code{errno}
1443 instead of a @code{gpgme_err_code_t} error code.
1444 @end deftypefun
1445
1446 @deftypefun {gpgme_error_t} gpgme_error_from_errno (@w{int @var{err}})
1447 The function @code{gpgme_error_from_errno} is like @code{gpgme_error},
1448 but it takes a system error like @code{errno} instead of a
1449 @code{gpgme_err_code_t} error code.
1450 @end deftypefun
1451
1452 Sometimes you might want to map system error numbers to error codes
1453 directly, or map an error code representing a system error back to the
1454 system error number.  The following functions can be used to do that.
1455
1456 @deftypefun {gpgme_err_code_t} gpgme_err_code_from_errno (@w{int @var{err}})
1457 The function @code{gpgme_err_code_from_errno} returns the error code
1458 for the system error @var{err}.  If @var{err} is not a known system
1459 error, the function returns @code{GPG_ERR_UNKNOWN_ERRNO}.
1460 @end deftypefun
1461
1462 @deftypefun {int} gpgme_err_code_to_errno (@w{gpgme_err_code_t @var{err}})
1463 The function @code{gpgme_err_code_to_errno} returns the system error
1464 for the error code @var{err}.  If @var{err} is not an error code
1465 representing a system error, or if this system error is not defined on
1466 this system, the function returns @code{0}.
1467 @end deftypefun
1468
1469
1470 @node Error Sources
1471 @section Error Sources
1472 @cindex error codes, list of
1473
1474 The library @code{libgpg-error} defines an error source for every
1475 component of the GnuPG system.  The error source part of an error
1476 value is not well defined.  As such it is mainly useful to improve the
1477 diagnostic error message for the user.
1478
1479 If the error code part of an error value is @code{0}, the whole error
1480 value will be @code{0}.  In this case the error source part is of
1481 course @code{GPG_ERR_SOURCE_UNKNOWN}.
1482
1483 The list of error sources that might occur in applications using
1484 @acronym{GPGME} is:
1485
1486 @table @code
1487 @item GPG_ERR_SOURCE_UNKNOWN
1488 The error source is not known.  The value of this error source is
1489 @code{0}.
1490
1491 @item GPG_ERR_SOURCE_GPGME
1492 The error source is @acronym{GPGME} itself.  This is the default for
1493 errors that occur in the @acronym{GPGME} library.
1494
1495 @item GPG_ERR_SOURCE_GPG
1496 The error source is GnuPG, which is the crypto engine used for the
1497 OpenPGP protocol.
1498
1499 @item GPG_ERR_SOURCE_GPGSM
1500 The error source is GPGSM, which is the crypto engine used for the
1501 CMS protocol.
1502
1503 @item GPG_ERR_SOURCE_GCRYPT
1504 The error source is @code{libgcrypt}, which is used by crypto engines
1505 to perform cryptographic operations.
1506
1507 @item GPG_ERR_SOURCE_GPGAGENT
1508 The error source is @command{gpg-agent}, which is used by crypto
1509 engines to perform operations with the secret key.
1510
1511 @item GPG_ERR_SOURCE_PINENTRY
1512 The error source is @command{pinentry}, which is used by
1513 @command{gpg-agent} to query the passphrase to unlock a secret key.
1514
1515 @item GPG_ERR_SOURCE_SCD
1516 The error source is the SmartCard Daemon, which is used by
1517 @command{gpg-agent} to delegate operations with the secret key to a
1518 SmartCard.
1519
1520 @item GPG_ERR_SOURCE_KEYBOX
1521 The error source is @code{libkbx}, a library used by the crypto
1522 engines to manage local keyrings.
1523
1524 @item GPG_ERR_SOURCE_USER_1
1525 @item GPG_ERR_SOURCE_USER_2
1526 @item GPG_ERR_SOURCE_USER_3
1527 @item GPG_ERR_SOURCE_USER_4
1528 These error sources are not used by any GnuPG component and can be
1529 used by other software.  For example, applications using
1530 @acronym{GPGME} can use them to mark error values coming from callback
1531 handlers.  Thus @code{GPG_ERR_SOURCE_USER_1} is the default for errors
1532 created with @code{gpgme_error} and @code{gpgme_error_from_errno},
1533 unless you define @code{GPGME_ERR_SOURCE_DEFAULT} before including
1534 @file{gpgme.h}.
1535 @end table
1536
1537
1538 @node Error Codes
1539 @section Error Codes
1540 @cindex error codes, list of
1541
1542 The library @code{libgpg-error} defines many error values.  Most of
1543 them are not used by @code{GPGME} directly, but might be returned by
1544 @acronym{GPGME} because it received them from the crypto engine.  The
1545 below list only includes such error codes that have a specific meaning
1546 in @code{GPGME}, or which are so common that you should know about
1547 them.
1548
1549 @table @code
1550 @item GPG_ERR_EOF
1551 This value indicates the end of a list, buffer or file.
1552
1553 @item GPG_ERR_NO_ERROR
1554 This value indicates success.  The value of this error code is
1555 @code{0}.  Also, it is guaranteed that an error value made from the
1556 error code @code{0} will be @code{0} itself (as a whole).  This means
1557 that the error source information is lost for this error code,
1558 however, as this error code indicates that no error occured, this is
1559 generally not a problem.
1560
1561 @item GPG_ERR_GENERAL
1562 This value means that something went wrong, but either there is not
1563 enough information about the problem to return a more useful error
1564 value, or there is no separate error value for this type of problem.
1565
1566 @item GPG_ERR_ENOMEM
1567 This value means that an out-of-memory condition occurred.
1568
1569 @item GPG_ERR_E...
1570 System errors are mapped to GPG_ERR_FOO where FOO is the symbol for
1571 the system error.
1572
1573 @item GPG_ERR_INV_VALUE
1574 This value means that some user provided data was out of range.  This
1575 can also refer to objects.  For example, if an empty
1576 @code{gpgme_data_t} object was expected, but one containing data was
1577 provided, this error value is returned.
1578
1579 @item GPG_ERR_UNUSABLE_PUBKEY
1580 This value means that some recipients for a message were invalid.
1581
1582 @item GPG_ERR_UNUSABLE_SECKEY
1583 This value means that some signers were invalid.
1584
1585 @item GPG_ERR_NO_DATA
1586 This value means that a @code{gpgme_data_t} object which was expected
1587 to have content was found empty.
1588
1589 @item GPG_ERR_CONFLICT
1590 This value means that a conflict of some sort occurred.
1591
1592 @item GPG_ERR_NOT_IMPLEMENTED
1593 This value indicates that the specific function (or operation) is not
1594 implemented.  This error should never happen.  It can only occur if
1595 you use certain values or configuration options which do not work,
1596 but for which we think that they should work at some later time.
1597
1598 @item GPG_ERR_DECRYPT_FAILED
1599 This value indicates that a decryption operation was unsuccessful.
1600
1601 @item GPG_ERR_BAD_PASSPHRASE
1602 This value means that the user did not provide a correct passphrase
1603 when requested.
1604
1605 @item GPG_ERR_CANCELED
1606 This value means that the operation was canceled.
1607
1608 @item GPG_ERR_INV_ENGINE
1609 This value means that the engine that implements the desired protocol
1610 is currently not available.  This can either be because the sources
1611 were configured to exclude support for this engine, or because the
1612 engine is not installed properly.
1613
1614 @item GPG_ERR_AMBIGUOUS_NAME
1615 This value indicates that a user ID or other specifier did not specify
1616 a unique key.
1617
1618 @item GPG_ERR_WRONG_KEY_USAGE
1619 This value indicates that a key is not used appropriately.
1620
1621 @item GPG_ERR_CERT_REVOKED
1622 This value indicates that a key signature was revoced.
1623
1624 @item GPG_ERR_CERT_EXPIRED
1625 This value indicates that a key signature expired.
1626
1627 @item GPG_ERR_NO_CRL_KNOWN
1628 This value indicates that no certificate revocation list is known for
1629 the certificate.
1630
1631 @item GPG_ERR_NO_POLICY_MATCH
1632 This value indicates that a policy issue occured.
1633
1634 @item GPG_ERR_NO_SECKEY
1635 This value indicates that no secret key for the user ID is available.
1636
1637 @item GPG_ERR_MISSING_CERT
1638 This value indicates that a key could not be imported because the
1639 issuer certificate is missing.
1640
1641 @item GPG_ERR_BAD_CERT_CHAIN
1642 This value indicates that a key could not be imported because its
1643 certificate chain is not good, for example it could be too long.
1644
1645 @item GPG_ERR_UNSUPPORTED_ALGORITHM
1646 This value means a verification failed because the cryptographic
1647 algorithm is not supported by the crypto backend.
1648
1649 @item GPG_ERR_BAD_SIGNATURE
1650 This value means a verification failed because the signature is bad.
1651
1652 @item GPG_ERR_NO_PUBKEY
1653 This value means a verification failed because the public key is not
1654 available.
1655
1656 @item GPG_ERR_USER_1
1657 @item GPG_ERR_USER_2
1658 @item ...
1659 @item GPG_ERR_USER_16
1660 These error codes are not used by any GnuPG component and can be
1661 freely used by other software.  Applications using @acronym{GPGME}
1662 might use them to mark specific errors returned by callback handlers
1663 if no suitable error codes (including the system errors) for
1664 these errors exist already.
1665 @end table
1666
1667
1668 @node Error Strings
1669 @section Error Strings
1670 @cindex error values, printing of
1671 @cindex error codes, printing of
1672 @cindex error sources, printing of
1673 @cindex error strings
1674
1675 @deftypefun {const char *} gpgme_strerror (@w{gpgme_error_t @var{err}})
1676 The function @code{gpgme_strerror} returns a pointer to a statically
1677 allocated string containing a description of the error code contained
1678 in the error value @var{err}.  This string can be used to output a
1679 diagnostic message to the user.
1680
1681 This function is not thread safe.  Use @code{gpgme_strerror_r} in
1682 multi-threaded programs.
1683 @end deftypefun
1684
1685
1686 @deftypefun {int} gpgme_strerror_r (@w{gpgme_error_t @var{err}}, @w{char *@var{buf}}, @w{size_t @var{buflen}})
1687 The function @code{gpgme_strerror_r} returns the error string for
1688 @var{err} in the user-supplied buffer @var{buf} of size @var{buflen}.
1689 This function is, in contrast to @code{gpgme_strerror}, thread-safe if
1690 a thread-safe @code{strerror_r} function is provided by the system.
1691 If the function succeeds, 0 is returned and @var{buf} contains the
1692 string describing the error.  If the buffer was not large enough,
1693 ERANGE is returned and @var{buf} contains as much of the beginning of
1694 the error string as fits into the buffer.
1695 @end deftypefun
1696
1697
1698 @deftypefun {const char *} gpgme_strsource (@w{gpgme_error_t @var{err}})
1699 The function @code{gpgme_strerror} returns a pointer to a statically
1700 allocated string containing a description of the error source
1701 contained in the error value @var{err}.  This string can be used to
1702 output a diagnostic message to the user.
1703 @end deftypefun
1704
1705 The following example illustrates the use of @code{gpgme_strerror}:
1706
1707 @example
1708 gpgme_ctx_t ctx;
1709 gpgme_error_t err = gpgme_new (&ctx);
1710 if (err)
1711   @{
1712     fprintf (stderr, "%s: creating GpgME context failed: %s: %s\n",
1713              argv[0], gpgme_strsource (err), gpgme_strerror (err));
1714     exit (1);
1715   @}
1716 @end example
1717
1718
1719 @node Exchanging Data
1720 @chapter Exchanging Data
1721 @cindex data, exchanging
1722
1723 A lot of data has to be exchanged between the user and the crypto
1724 engine, like plaintext messages, ciphertext, signatures and
1725 information about the keys.  The technical details about exchanging
1726 the data information are completely abstracted by @acronym{GPGME}.
1727 The user provides and receives the data via @code{gpgme_data_t} objects,
1728 regardless of the communication protocol between @acronym{GPGME} and
1729 the crypto engine in use.
1730
1731 @deftp {Data type} {gpgme_data_t}
1732 The @code{gpgme_data_t} type is a handle for a container for generic
1733 data, which is used by @acronym{GPGME} to exchange data with the user.
1734 @end deftp
1735
1736 @code{gpgme_data_t} objects do not provide notifications on events.
1737 It is assumed that read and write operations are blocking until data
1738 is available.  If this is undesirable, the application must ensure
1739 that all GPGME data operations always have data available, for example
1740 by using memory buffers or files rather than pipes or sockets.  This
1741 might be relevant, for example, if the external event loop mechanism
1742 is used.
1743
1744 @deftp {Data type} {gpgme_off_t}
1745 On POSIX platforms the @code{gpgme_off_t} type is an alias for
1746 @code{off_t}; it may be used interchangeable.  On Windows platforms
1747 @code{gpgme_off_t} is defined as a long (i.e. 32 bit) for 32 bit
1748 Windows and as a 64 bit signed integer for 64 bit Windows.
1749 @end deftp
1750
1751 @deftp {Data type} {gpgme_ssize_t}
1752 The @code{gpgme_ssize_t} type is an alias for @code{ssize_t}.  It has
1753 only been introduced to overcome portability problems pertaining to
1754 the declaration of @code{ssize_t} by different toolchains.
1755 @end deftp
1756
1757
1758 @menu
1759 * Creating Data Buffers::         Creating new data buffers.
1760 * Destroying Data Buffers::       Releasing data buffers.
1761 * Manipulating Data Buffers::     Operations on data buffers.
1762 @end menu
1763
1764
1765 @node Creating Data Buffers
1766 @section Creating Data Buffers
1767 @cindex data buffer, creation
1768
1769 Data objects can be based on memory, files, or callback functions
1770 provided by the user.  Not all operations are supported by all
1771 objects.
1772
1773
1774 @menu
1775 * Memory Based Data Buffers::     Creating memory based data buffers.
1776 * File Based Data Buffers::       Creating file based data buffers.
1777 * Callback Based Data Buffers::   Creating callback based data buffers.
1778 @end menu
1779
1780
1781 @node Memory Based Data Buffers
1782 @subsection Memory Based Data Buffers
1783
1784 Memory based data objects store all data in allocated memory.  This is
1785 convenient, but only practical for an amount of data that is a
1786 fraction of the available physical memory.  The data has to be copied
1787 from its source and to its destination, which can often be avoided by
1788 using one of the other data object
1789
1790 @deftypefun gpgme_error_t gpgme_data_new (@w{gpgme_data_t *@var{dh}})
1791 The function @code{gpgme_data_new} creates a new @code{gpgme_data_t}
1792 object and returns a handle for it in @var{dh}.  The data object is
1793 memory based and initially empty.
1794
1795 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1796 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1797 @var{dh} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if not
1798 enough memory is available.
1799 @end deftypefun
1800
1801 @deftypefun gpgme_error_t gpgme_data_new_from_mem (@w{gpgme_data_t *@var{dh}}, @w{const char *@var{buffer}}, @w{size_t @var{size}}, @w{int @var{copy}})
1802 The function @code{gpgme_data_new_from_mem} creates a new
1803 @code{gpgme_data_t} object and fills it with @var{size} bytes starting
1804 from @var{buffer}.
1805
1806 If @var{copy} is not zero, a private copy of the data is made.  If
1807 @var{copy} is zero, the data is taken from the specified buffer as
1808 needed, and the user has to ensure that the buffer remains valid for
1809 the whole life span of the data object.
1810
1811 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1812 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1813 @var{dh} or @var{buffer} is not a valid pointer, and
1814 @code{GPG_ERR_ENOMEM} if not enough memory is available.
1815 @end deftypefun
1816
1817 @deftypefun gpgme_error_t gpgme_data_new_from_file (@w{gpgme_data_t *@var{dh}}, @w{const char *@var{filename}}, @w{int @var{copy}})
1818 The function @code{gpgme_data_new_from_file} creates a new
1819 @code{gpgme_data_t} object and fills it with the content of the file
1820 @var{filename}.
1821
1822 If @var{copy} is not zero, the whole file is read in at initialization
1823 time and the file is not used anymore after that.  This is the only
1824 mode supported currently.  Later, a value of zero for @var{copy} might
1825 cause all reads to be delayed until the data is needed, but this is
1826 not yet implemented.
1827
1828 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1829 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1830 @var{dh} or @var{filename} is not a valid pointer,
1831 @code{GPG_ERR_NOT_IMPLEMENTED} if @var{code} is zero, and
1832 @code{GPG_ERR_ENOMEM} if not enough memory is available.
1833 @end deftypefun
1834
1835 @deftypefun gpgme_error_t gpgme_data_new_from_filepart (@w{gpgme_data_t *@var{dh}}, @w{const char *@var{filename}}, @w{FILE *@var{fp}}, @w{off_t @var{offset}}, @w{size_t @var{length}})
1836 The function @code{gpgme_data_new_from_filepart} creates a new
1837 @code{gpgme_data_t} object and fills it with a part of the file specified
1838 by @var{filename} or @var{fp}.
1839
1840 Exactly one of @var{filename} and @var{fp} must be non-zero, the other
1841 must be zero.  The argument that is not zero specifies the file from
1842 which @var{length} bytes are read into the data object, starting from
1843 @var{offset}.
1844
1845 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1846 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1847 @var{dh} and exactly one of @var{filename} and @var{fp} is not a valid
1848 pointer, and @code{GPG_ERR_ENOMEM} if not enough memory is available.
1849 @end deftypefun
1850
1851
1852 @node File Based Data Buffers
1853 @subsection File Based Data Buffers
1854
1855 File based data objects operate directly on file descriptors or
1856 streams.  Only a small amount of data is stored in core at any time,
1857 so the size of the data objects is not limited by @acronym{GPGME}.
1858
1859 @deftypefun gpgme_error_t gpgme_data_new_from_fd (@w{gpgme_data_t *@var{dh}}, @w{int @var{fd}})
1860 The function @code{gpgme_data_new_from_fd} creates a new
1861 @code{gpgme_data_t} object and uses the file descriptor @var{fd} to read
1862 from (if used as an input data object) and write to (if used as an
1863 output data object).
1864
1865 When using the data object as an input buffer, the function might read
1866 a bit more from the file descriptor than is actually needed by the
1867 crypto engine in the desired operation because of internal buffering.
1868
1869 Note that GPGME assumes that the file descriptor is set to blocking
1870 mode.  Errors during I/O operations, except for EINTR, are usually
1871 fatal for crypto operations.
1872
1873 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1874 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
1875 enough memory is available.
1876 @end deftypefun
1877
1878 @deftypefun gpgme_error_t gpgme_data_new_from_stream (@w{gpgme_data_t *@var{dh}}, @w{FILE *@var{stream}})
1879 The function @code{gpgme_data_new_from_stream} creates a new
1880 @code{gpgme_data_t} object and uses the I/O stream @var{stream} to read
1881 from (if used as an input data object) and write to (if used as an
1882 output data object).
1883
1884 When using the data object as an input buffer, the function might read
1885 a bit more from the stream than is actually needed by the crypto
1886 engine in the desired operation because of internal buffering.
1887
1888 Note that GPGME assumes that the stream is in blocking mode.  Errors
1889 during I/O operations, except for EINTR, are usually fatal for crypto
1890 operations.
1891
1892 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1893 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
1894 enough memory is available.
1895 @end deftypefun
1896
1897
1898 @node Callback Based Data Buffers
1899 @subsection Callback Based Data Buffers
1900
1901 If neither memory nor file based data objects are a good fit for your
1902 application, you can implement the functions a data object provides
1903 yourself and create a data object from these callback functions.
1904
1905 @deftp {Data type} {ssize_t (*gpgme_data_read_cb_t) (@w{void *@var{handle}}, @w{void @var{*buffer}}, @w{size_t @var{size}})}
1906 @tindex gpgme_data_read_cb_t
1907 The @code{gpgme_data_read_cb_t} type is the type of functions which
1908 @acronym{GPGME} calls if it wants to read data from a user-implemented
1909 data object.  The function should read up to @var{size} bytes from the
1910 current read position into the space starting at @var{buffer}.  The
1911 @var{handle} is provided by the user at data object creation time.
1912
1913 Note that GPGME assumes that the read blocks until data is available.
1914 Errors during I/O operations, except for EINTR, are usually fatal for
1915 crypto operations.
1916
1917 The function should return the number of bytes read, 0 on EOF, and -1
1918 on error.  If an error occurs, @var{errno} should be set to describe
1919 the type of the error.
1920 @end deftp
1921
1922 @deftp {Data type} {ssize_t (*gpgme_data_write_cb_t) (@w{void *@var{handle}}, @w{const void @var{*buffer}}, @w{size_t @var{size}})}
1923 @tindex gpgme_data_write_cb_t
1924 The @code{gpgme_data_write_cb_t} type is the type of functions which
1925 @acronym{GPGME} calls if it wants to write data to a user-implemented
1926 data object.  The function should write up to @var{size} bytes to the
1927 current write position from the space starting at @var{buffer}.  The
1928 @var{handle} is provided by the user at data object creation time.
1929
1930 Note that GPGME assumes that the write blocks until data is available.
1931 Errors during I/O operations, except for EINTR, are usually fatal for
1932 crypto operations.
1933
1934 The function should return the number of bytes written, and -1 on
1935 error.  If an error occurs, @var{errno} should be set to describe the
1936 type of the error.
1937 @end deftp
1938
1939 @deftp {Data type} {off_t (*gpgme_data_seek_cb_t) (@w{void *@var{handle}}, @w{off_t @var{offset}}, @w{int @var{whence}})}
1940 @tindex gpgme_data_seek_cb_t
1941 The @code{gpgme_data_seek_cb_t} type is the type of functions which
1942 @acronym{GPGME} calls if it wants to change the current read/write
1943 position in a user-implemented data object, just like the @code{lseek}
1944 function.
1945
1946 The function should return the new read/write position, and -1 on
1947 error.  If an error occurs, @var{errno} should be set to describe the
1948 type of the error.
1949 @end deftp
1950
1951 @deftp {Data type} {void (*gpgme_data_release_cb_t) (@w{void *@var{handle}})}
1952 @tindex gpgme_data_release_cb_t
1953 The @code{gpgme_data_release_cb_t} type is the type of functions which
1954 @acronym{GPGME} calls if it wants to destroy a user-implemented data
1955 object.  The @var{handle} is provided by the user at data object
1956 creation time.
1957 @end deftp
1958
1959 @deftp {Data type} {struct gpgme_data_cbs}
1960 This structure is used to store the data callback interface functions
1961 described above.  It has the following members:
1962
1963 @table @code
1964 @item gpgme_data_read_cb_t read
1965 This is the function called by @acronym{GPGME} to read data from the
1966 data object.  It is only required for input data object.
1967
1968 @item gpgme_data_write_cb_t write
1969 This is the function called by @acronym{GPGME} to write data to the
1970 data object.  It is only required for output data object.
1971
1972 @item gpgme_data_seek_cb_t seek
1973 This is the function called by @acronym{GPGME} to change the current
1974 read/write pointer in the data object (if available).  It is optional.
1975
1976 @item gpgme_data_release_cb_t release
1977 This is the function called by @acronym{GPGME} to release a data
1978 object.  It is optional.
1979 @end table
1980 @end deftp
1981
1982 @deftypefun gpgme_error_t gpgme_data_new_from_cbs (@w{gpgme_data_t *@var{dh}}, @w{gpgme_data_cbs_t @var{cbs}}, @w{void *@var{handle}})
1983 The function @code{gpgme_data_new_from_cbs} creates a new
1984 @code{gpgme_data_t} object and uses the user-provided callback functions
1985 to operate on the data object.
1986
1987 The handle @var{handle} is passed as first argument to the callback
1988 functions.  This can be used to identify this data object.
1989
1990 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1991 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
1992 enough memory is available.
1993 @end deftypefun
1994
1995
1996 @node Destroying Data Buffers
1997 @section Destroying Data Buffers
1998 @cindex data buffer, destruction
1999
2000 @deftypefun void gpgme_data_release (@w{gpgme_data_t @var{dh}})
2001 The function @code{gpgme_data_release} destroys the data object with
2002 the handle @var{dh}.  It releases all associated resources that were
2003 not provided by the user in the first place.
2004 @end deftypefun
2005
2006 @deftypefun {char *} gpgme_data_release_and_get_mem (@w{gpgme_data_t @var{dh}}, @w{size_t *@var{length}})
2007 The function @code{gpgme_data_release_and_get_mem} is like
2008 @code{gpgme_data_release}, except that it returns the data buffer and
2009 its length that was provided by the object.
2010
2011 The user has to release the buffer with @code{gpgme_free}.  In case
2012 the user provided the data buffer in non-copy mode, a copy will be
2013 made for this purpose.
2014
2015 In case an error returns, or there is no suitable data buffer that can
2016 be returned to the user, the function will return @code{NULL}.  In any
2017 case, the data object @var{dh} is destroyed.
2018 @end deftypefun
2019
2020
2021 @deftypefun void gpgme_free (@w{void *@var{buffer}})
2022 The function @code{gpgme_free} releases the memory returned by
2023 @code{gpgme_data_release_and_get_mem} and
2024 @code{gpgme_pubkey_algo_string}.  It should be used instead of the
2025 system libraries @code{free} function in case different allocators are
2026 used by a program.  This is often the case if gpgme is used under
2027 Windows as a DLL.
2028 @end deftypefun
2029
2030
2031 @node Manipulating Data Buffers
2032 @section Manipulating Data Buffers
2033 @cindex data buffer, manipulation
2034
2035 Data buffers contain data and meta-data.  The following operations can
2036 be used to manipulate both.
2037
2038
2039 @menu
2040 * Data Buffer I/O Operations::    I/O operations on data buffers.
2041 * Data Buffer Meta-Data::         Meta-data manipulation of data buffers.
2042 * Data Buffer Convenience::       Convenience function for data buffers.
2043 @end menu
2044
2045
2046 @node Data Buffer I/O Operations
2047 @subsection Data Buffer I/O Operations
2048 @cindex data buffer, I/O operations
2049 @cindex data buffer, read
2050 @cindex data buffer, write
2051 @cindex data buffer, seek
2052
2053 @deftypefun ssize_t gpgme_data_read (@w{gpgme_data_t @var{dh}}, @w{void *@var{buffer}}, @w{size_t @var{length}})
2054 The function @code{gpgme_data_read} reads up to @var{length} bytes
2055 from the data object with the handle @var{dh} into the space starting
2056 at @var{buffer}.
2057
2058 If no error occurs, the actual amount read is returned.  If the end of
2059 the data object is reached, the function returns 0.
2060
2061 In all other cases, the function returns -1 and sets @var{errno}.
2062 @end deftypefun
2063
2064 @deftypefun ssize_t gpgme_data_write (@w{gpgme_data_t @var{dh}}, @w{const void *@var{buffer}}, @w{size_t @var{size}})
2065 The function @code{gpgme_data_write} writes up to @var{size} bytes
2066 starting from @var{buffer} into the data object with the handle
2067 @var{dh} at the current write position.
2068
2069 The function returns the number of bytes actually written, or -1 if an
2070 error occurs.  If an error occurs, @var{errno} is set.
2071 @end deftypefun
2072
2073 @deftypefun off_t gpgme_data_seek (@w{gpgme_data_t @var{dh}}, @w{off_t @var{offset}}, @w{int @var{whence}})
2074 The function @code{gpgme_data_seek} changes the current read/write
2075 position.
2076
2077 The @var{whence} argument specifies how the @var{offset} should be
2078 interpreted.  It must be one of the following symbolic constants:
2079
2080 @table @code
2081 @item SEEK_SET
2082 Specifies that @var{offset} is a count of characters from the
2083 beginning of the data object.
2084
2085 @item SEEK_CUR
2086 Specifies that @var{offset} is a count of characters from the current
2087 file position.  This count may be positive or negative.
2088
2089 @item SEEK_END
2090 Specifies that @var{offset} is a count of characters from the end of
2091 the data object.  A negative count specifies a position within the
2092 current extent of the data object; a positive count specifies a
2093 position past the current end.  If you set the position past the
2094 current end, and actually write data, you will extend the data object
2095 with zeros up to that position.
2096 @end table
2097
2098 If successful, the function returns the resulting file position,
2099 measured in bytes from the beginning of the data object.  You can use
2100 this feature together with @code{SEEK_CUR} to read the current
2101 read/write position.
2102
2103 If the function fails, -1 is returned and @var{errno} is set.
2104 @end deftypefun
2105
2106
2107 @node Data Buffer Meta-Data
2108 @subsection Data Buffer Meta-Data
2109 @cindex data buffer, meta-data
2110 @cindex data buffer, file name
2111 @cindex data buffer, encoding
2112
2113 @deftypefun {char *} gpgme_data_get_file_name (@w{gpgme_data_t @var{dh}})
2114 The function @code{gpgme_data_get_file_name} returns a pointer to a
2115 string containing the file name associated with the data object.  The
2116 file name will be stored in the output when encrypting or signing the
2117 data and will be returned to the user when decrypting or verifying the
2118 output data.
2119
2120 If no error occurs, the string containing the file name is returned.
2121 Otherwise, @code{NULL} will be returned.
2122 @end deftypefun
2123
2124
2125 @deftypefun gpgme_error_t gpgme_data_set_file_name (@w{gpgme_data_t @var{dh}}, @w{const char *@var{file_name}})
2126 The function @code{gpgme_data_set_file_name} sets the file name
2127 associated with the data object.  The file name will be stored in the
2128 output when encrypting or signing the data and will be returned to the
2129 user when decrypting or verifying the output data.
2130
2131 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2132 @var{dh} is not a valid pointer and @code{GPG_ERR_ENOMEM} if not
2133 enough memory is available.
2134 @end deftypefun
2135
2136
2137 @deftp {Data type} {enum gpgme_data_encoding_t}
2138 @tindex gpgme_data_encoding_t
2139 The @code{gpgme_data_encoding_t} type specifies the encoding of a
2140 @code{gpgme_data_t} object.  For input data objects, the encoding is
2141 useful to give the backend a hint on the type of data.  For output
2142 data objects, the encoding can specify the output data format on
2143 certain operations.  Please note that not all backends support all
2144 encodings on all operations.  The following data types are available:
2145
2146 @table @code
2147 @item GPGME_DATA_ENCODING_NONE
2148 This specifies that the encoding is not known.  This is the default
2149 for a new data object.  The backend will try its best to detect the
2150 encoding automatically.
2151
2152 @item GPGME_DATA_ENCODING_BINARY
2153 This specifies that the data is encoding in binary form; i.e. there is
2154 no special encoding.
2155
2156 @item GPGME_DATA_ENCODING_BASE64
2157 This specifies that the data is encoded using the Base-64 encoding
2158 scheme as used by @acronym{MIME} and other protocols.
2159
2160 @item GPGME_DATA_ENCODING_ARMOR
2161 This specifies that the data is encoded in an armored form as used by
2162 OpenPGP and PEM.
2163
2164 @item GPGME_DATA_ENCODING_MIME
2165 This specifies that the data is encoded as a MIME part.
2166
2167 @item GPGME_DATA_ENCODING_URL
2168 The data is a list of linefeed delimited URLs.  This is only useful with
2169 @code{gpgme_op_import}.
2170
2171 @item GPGME_DATA_ENCODING_URL0
2172 The data is a list of binary zero delimited URLs.  This is only useful
2173 with @code{gpgme_op_import}.
2174
2175 @item GPGME_DATA_ENCODING_URLESC
2176 The data is a list of linefeed delimited URLs with all control and space
2177 characters percent escaped.  This mode is is not yet implemented.
2178
2179 @end table
2180 @end deftp
2181
2182 @deftypefun gpgme_data_encoding_t gpgme_data_get_encoding (@w{gpgme_data_t @var{dh}})
2183 The function @code{gpgme_data_get_encoding} returns the encoding of
2184 the data object with the handle @var{dh}.  If @var{dh} is not a valid
2185 pointer (e.g. @code{NULL}) @code{GPGME_DATA_ENCODING_NONE} is
2186 returned.
2187 @end deftypefun
2188
2189 @deftypefun gpgme_error_t gpgme_data_set_encoding (@w{gpgme_data_t @var{dh}, gpgme_data_encoding_t @var{enc}})
2190 The function @code{gpgme_data_set_encoding} changes the encoding of
2191 the data object with the handle @var{dh} to @var{enc}.
2192 @end deftypefun
2193
2194 @deftypefun {gpgme_error_t} gpgme_data_set_flag  @
2195             (@w{gpgme_data_t @var{dh}}, @
2196             @w{const char *@var{name}}, @
2197             @w{const char *@var{value}})
2198
2199 Some minor properties of the data object can be controlled with flags
2200 set by this function.  The properties are identified by the following
2201 values for @var{name}:
2202
2203 @table @code
2204 @item size-hint
2205 The value is a decimal number with the length gpgme shall assume for
2206 this data object.  This is useful if the data is provided by callbacks
2207 or via file descriptors but the applications knows the total size of
2208 the data.  If this is set the OpenPGP engine may use this to decide on
2209 buffer allocation strategies and to provide a total value for its
2210 progress information.
2211
2212 @end table
2213
2214 This function returns @code{0} on success.
2215 @end deftypefun
2216
2217
2218 @node Data Buffer Convenience
2219 @subsection Data Buffer Convenience Functions
2220 @cindex data buffer, convenience
2221 @cindex type of data
2222 @cindex identify
2223
2224 @deftp {Data type} {enum gpgme_data_type_t}
2225 @tindex gpgme_data_type_t
2226 The @code{gpgme_data_type_t} type is used to return the detected type
2227 of the content of a data buffer.
2228 @end deftp
2229
2230 @table @code
2231 @item GPGME_DATA_TYPE_INVALID
2232 This is returned by @code{gpgme_data_identify} if it was not possible
2233 to identify the data.  Reasons for this might be a non-seekable stream
2234 or a memory problem.  The value is 0.
2235 @item GPGME_DATA_TYPE_UNKNOWN
2236 The type of the data is not known.
2237 @item GPGME_DATA_TYPE_PGP_SIGNED
2238 The data is an OpenPGP signed message.  This may be a binary
2239 signature, a detached one or a cleartext signature.
2240 @item GPGME_DATA_TYPE_PGP_OTHER
2241 This is a generic OpenPGP message.  In most cases this will be
2242 encrypted data.
2243 @item GPGME_DATA_TYPE_PGP_KEY
2244 This is an OpenPGP key (private or public).
2245 @item GPGME_DATA_TYPE_CMS_SIGNED
2246 This is a CMS signed message.
2247 @item GPGME_DATA_TYPE_CMS_ENCRYPTED
2248 This is a CMS encrypted (enveloped data) message.
2249 @item GPGME_DATA_TYPE_CMS_OTHER
2250 This is used for other CMS message types.
2251 @item GPGME_DATA_TYPE_X509_CERT
2252 The data is a X.509 certificate
2253 @item GPGME_DATA_TYPE_PKCS12
2254 The data is a PKCS#12 message.  This is commonly used to exchange
2255 private keys for X.509.
2256 @end table
2257
2258 @deftypefun gpgme_data_type_t gpgme_data_identify (@w{gpgme_data_t @var{dh}})
2259 The function @code{gpgme_data_identify} returns the type of the data
2260 with the handle @var{dh}.  If it is not possible to perform the
2261 identification, the function returns zero
2262 (@code{GPGME_DATA_TYPE_INVALID}).  Note that depending on how the data
2263 object has been created the identification may not be possible or the
2264 data object may change its internal state (file pointer moved).  For
2265 file or memory based data object, the state should not change.
2266 @end deftypefun
2267
2268
2269 @c
2270 @c    Chapter Contexts
2271 @c
2272 @node Contexts
2273 @chapter Contexts
2274 @cindex context
2275
2276 All cryptographic operations in @acronym{GPGME} are performed within a
2277 context, which contains the internal state of the operation as well as
2278 configuration parameters.  By using several contexts you can run
2279 several cryptographic operations in parallel, with different
2280 configuration.
2281
2282 @deftp {Data type} {gpgme_ctx_t}
2283 The @code{gpgme_ctx_t} type is a handle for a @acronym{GPGME} context,
2284 which is used to hold the configuration, status and result of
2285 cryptographic operations.
2286 @end deftp
2287
2288 @menu
2289 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
2290 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
2291 * Result Management::             Managing the result of crypto operations.
2292 * Context Attributes::            Setting properties of a context.
2293 * Key Management::                Managing keys with @acronym{GPGME}.
2294 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
2295 * Crypto Operations::             Using a context for cryptography.
2296 * Miscellaneous::                 Miscellaneous operations
2297 * Run Control::                   Controlling how operations are run.
2298 @end menu
2299
2300
2301 @node Creating Contexts
2302 @section Creating Contexts
2303 @cindex context, creation
2304
2305 @deftypefun gpgme_error_t gpgme_new (@w{gpgme_ctx_t *@var{ctx}})
2306 The function @code{gpgme_new} creates a new @code{gpgme_ctx_t} object
2307 and returns a handle for it in @var{ctx}.
2308
2309 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2310 context was successfully created, @code{GPG_ERR_INV_VALUE} if
2311 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if not
2312 enough memory is available.  Also, it returns
2313 @code{GPG_ERR_NOT_OPERATIONAL} if @code{gpgme_check_version} was not
2314 called to initialize GPGME, and @code{GPG_ERR_SELFTEST_FAILED} if a
2315 selftest failed.  Currently, the only selftest is for Windows MingW32
2316 targets to see if @code{-mms-bitfields} was used (as required).
2317 @end deftypefun
2318
2319
2320 @node Destroying Contexts
2321 @section Destroying Contexts
2322 @cindex context, destruction
2323
2324 @deftypefun void gpgme_release (@w{gpgme_ctx_t @var{ctx}})
2325 The function @code{gpgme_release} destroys the context with the handle
2326 @var{ctx} and releases all associated resources.
2327 @end deftypefun
2328
2329
2330 @node Result Management
2331 @section Result Management
2332 @cindex context, result of operation
2333
2334 The detailed result of an operation is returned in operation-specific
2335 structures such as @code{gpgme_decrypt_result_t}.  The corresponding
2336 retrieval functions such as @code{gpgme_op_decrypt_result} provide
2337 static access to the results after an operation completes.  The
2338 following interfaces make it possible to detach a result structure
2339 from its associated context and give it a lifetime beyond that of the
2340 current operation or context.
2341
2342 @deftypefun void gpgme_result_ref (@w{void *@var{result}})
2343 The function @code{gpgme_result_ref} acquires an additional reference
2344 for the result @var{result}, which may be of any type
2345 @code{gpgme_*_result_t}.  As long as the user holds a reference, the
2346 result structure is guaranteed to be valid and unmodified.
2347 @end deftypefun
2348
2349 @deftypefun void gpgme_result_unref (@w{void *@var{result}})
2350 The function @code{gpgme_result_unref} releases a reference for the
2351 result @var{result}.  If this was the last reference, the result
2352 structure will be destroyed and all resources associated to it will be
2353 released.
2354 @end deftypefun
2355
2356 Note that a context may hold its own references to result structures,
2357 typically until the context is destroyed or the next operation is
2358 started.  In fact, these references are accessed through the
2359 @code{gpgme_op_*_result} functions.
2360
2361
2362 @node Context Attributes
2363 @section Context Attributes
2364 @cindex context, attributes
2365
2366 @menu
2367 * Protocol Selection::            Selecting the protocol used by a context.
2368 * Crypto Engine::                 Configuring the crypto engine.
2369 * ASCII Armor::                   Requesting @acronym{ASCII} armored output.
2370 * Text Mode::                     Choosing canonical text mode.
2371 * Offline Mode::                  Choosing offline mode.
2372 * Pinentry Mode::                 Choosing the pinentry mode.
2373 * Included Certificates::         Including a number of certificates.
2374 * Key Listing Mode::              Selecting key listing mode.
2375 * Passphrase Callback::           Getting the passphrase from the user.
2376 * Progress Meter Callback::       Being informed about the progress.
2377 * Status Message Callback::       Status messages received from gpg.
2378 * Locale::                        Setting the locale of a context.
2379 @end menu
2380
2381
2382 @node Protocol Selection
2383 @subsection Protocol Selection
2384 @cindex context, selecting protocol
2385 @cindex protocol, selecting
2386
2387 @deftypefun gpgme_error_t gpgme_set_protocol (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_protocol_t @var{proto}})
2388 The function @code{gpgme_set_protocol} sets the protocol used within
2389 the context @var{ctx} to @var{proto}.  All crypto operations will be
2390 performed by the crypto engine configured for that protocol.
2391 @xref{Protocols and Engines}.
2392
2393 Setting the protocol with @code{gpgme_set_protocol} does not check if
2394 the crypto engine for that protocol is available and installed
2395 correctly.  @xref{Engine Version Check}.
2396
2397 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2398 protocol could be set successfully, and @code{GPG_ERR_INV_VALUE} if
2399 @var{protocol} is not a valid protocol.
2400 @end deftypefun
2401
2402 @deftypefun gpgme_protocol_t gpgme_get_protocol (@w{gpgme_ctx_t @var{ctx}})
2403 The function @code{gpgme_get_protocol} retrieves the protocol currently
2404 use with the context @var{ctx}.
2405 @end deftypefun
2406
2407
2408 @node Crypto Engine
2409 @subsection Crypto Engine
2410 @cindex context, configuring engine
2411 @cindex engine, configuration per context
2412
2413 The following functions can be used to set and retrieve the
2414 configuration of the crypto engines of a specific context.  The
2415 default can also be retrieved without any particular context.
2416 @xref{Engine Information}.  The default can also be changed globally.
2417 @xref{Engine Configuration}.
2418
2419 @deftypefun gpgme_engine_info_t gpgme_ctx_get_engine_info (@w{gpgme_ctx_t @var{ctx}})
2420 The function @code{gpgme_ctx_get_engine_info} returns a linked list of
2421 engine info structures.  Each info structure describes the
2422 configuration of one configured backend, as used by the context
2423 @var{ctx}.
2424
2425 The result is valid until the next invocation of
2426 @code{gpgme_ctx_set_engine_info} for this particular context.
2427
2428 This function can not fail.
2429 @end deftypefun
2430
2431 @deftypefun gpgme_error_t gpgme_ctx_set_engine_info (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_protocol_t @var{proto}}, @w{const char *@var{file_name}}, @w{const char *@var{home_dir}})
2432 The function @code{gpgme_ctx_set_engine_info} changes the
2433 configuration of the crypto engine implementing the protocol
2434 @var{proto} for the context @var{ctx}.
2435
2436 @var{file_name} is the file name of the executable program
2437 implementing this protocol, and @var{home_dir} is the directory name
2438 of the configuration directory for this crypto engine.  If
2439 @var{home_dir} is @code{NULL}, the engine's default will be used.
2440
2441 Currently this function must be used before starting the first crypto
2442 operation.  It is unspecified if and when the changes will take effect
2443 if the function is called after starting the first operation on the
2444 context @var{ctx}.
2445
2446 This function returns the error code @code{GPG_ERR_NO_ERROR} if
2447 successful, or an eror code on failure.
2448 @end deftypefun
2449
2450
2451 @c FIXME: Unfortunately, using @acronym here breaks texi2dvi.
2452 @node ASCII Armor
2453 @subsection @acronym{ASCII} Armor
2454 @cindex context, armor mode
2455 @cindex @acronym{ASCII} armor
2456 @cindex armor mode
2457
2458 @deftypefun void gpgme_set_armor (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2459 The function @code{gpgme_set_armor} specifies if the output should be
2460 @acronym{ASCII} armored.  By default, output is not @acronym{ASCII}
2461 armored.
2462
2463 @acronym{ASCII} armored output is disabled if @var{yes} is zero, and
2464 enabled otherwise.
2465 @end deftypefun
2466
2467 @deftypefun int gpgme_get_armor (@w{gpgme_ctx_t @var{ctx}})
2468 The function @code{gpgme_get_armor} returns 1 if the output is
2469 @acronym{ASCII} armored, and @code{0} if it is not, or if @var{ctx} is
2470 not a valid pointer.
2471 @end deftypefun
2472
2473
2474 @node Text Mode
2475 @subsection Text Mode
2476 @cindex context, text mode
2477 @cindex text mode
2478 @cindex canonical text mode
2479
2480 @deftypefun void gpgme_set_textmode (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2481 The function @code{gpgme_set_textmode} specifies if canonical text mode
2482 should be used.  By default, text mode is not used.
2483
2484 Text mode is for example used for the RFC2015 signatures; note that
2485 the updated RFC 3156 mandates that the mail user agent does some
2486 preparations so that text mode is not needed anymore.
2487
2488 This option is only relevant to the OpenPGP crypto engine, and ignored
2489 by all other engines.
2490
2491 Canonical text mode is disabled if @var{yes} is zero, and enabled
2492 otherwise.
2493 @end deftypefun
2494
2495 @deftypefun int gpgme_get_textmode (@w{gpgme_ctx_t @var{ctx}})
2496 The function @code{gpgme_get_textmode} returns 1 if canonical text
2497 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2498 valid pointer.
2499 @end deftypefun
2500
2501
2502 @node Offline Mode
2503 @subsection Offline Mode
2504 @cindex context, offline mode
2505 @cindex offline mode
2506
2507 @deftypefun void gpgme_set_offline (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2508 The function @code{gpgme_set_offline} specifies if offline mode
2509 should be used.  By default, offline mode is not used.
2510
2511 The offline mode specifies if dirmngr should be used to do additional
2512 validation that might require connections to external services.
2513 (e.g. CRL / OCSP checks).
2514
2515 Offline mode only affects the keylist mode @code{GPGME_KEYLIST_MODE_VALIDATE}
2516 and is only relevant to the CMS crypto engine. Offline mode
2517 is ignored otherwise.
2518
2519 This option may be extended in the future to completely disable
2520 the use of dirmngr for any engine.
2521
2522 Offline mode is disabled if @var{yes} is zero, and enabled
2523 otherwise.
2524 @end deftypefun
2525
2526 @deftypefun int gpgme_get_offline (@w{gpgme_ctx_t @var{ctx}})
2527 The function @code{gpgme_get_offline} returns 1 if offline
2528 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2529 valid pointer.
2530 @end deftypefun
2531
2532
2533 @node Pinentry Mode
2534 @subsection Pinentry Mode
2535 @cindex context, pinentry mode
2536 @cindex pinentry mode
2537
2538 @deftypefun gpgme_error_t gpgme_set_pinentry_mode (@w{gpgme_ctx_t @var{ctx}},
2539 @w{gpgme_pinentry_mode_t @var{mode}})
2540 The function @code{gpgme_set_pinentry_mode} specifies the pinentry mode
2541 to be used.
2542
2543 For GnuPG >= 2.1 this option is required to be set to
2544 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback
2545 mechanism in GPGME through @code{gpgme_set_passphrase_cb}.
2546 @end deftypefun
2547
2548 @deftypefun gpgme_pinentry_mode_t gpgme_get_pinentry_mode (@w{gpgme_ctx_t @var{ctx}})
2549 The function @code{gpgme_get_pinenty_mode} returns the
2550 mode set for the context.
2551 @end deftypefun
2552
2553 @deftp {Data type} {enum gpgme_pinentry_mode_t}
2554 @tindex gpgme_pinentry_mode_t
2555 The @code{gpgme_minentry_mode_t} type specifies the set of possible pinentry
2556 modes that are supported by @acronym{GPGME} if GnuPG >= 2.1 is used.
2557 The following modes are supported:
2558
2559 @table @code
2560 @item GPGME_PINENTRY_MODE_DEFAULT
2561 Use the default of the agent, which is ask.
2562
2563 @item GPGME_PINENTRY_MODE_ASK
2564 Force the use of the Pinentry.
2565
2566 @item GPGME_PINENTRY_MODE_CANCEL
2567 Emulate use of Pinentry's cancel button.
2568
2569 @item GPGME_PINENTRY_MODE_ERROR
2570 Return a Pinentry error @code{No Pinentry}.
2571
2572 @item GPGME_PINENTRY_MODE_LOOPBACK
2573 Redirect Pinentry queries to the caller.
2574 This enables the use of @code{gpgme_set_passphrase_cb} whis pinentry
2575 queries redirected to gpgme.
2576
2577 Note: This mode requires @code{allow-loopback-pinentry} to be enabled
2578 in the @file{gpg-agent.conf} or an agent started with that option.
2579
2580 @end table
2581 @end deftp
2582
2583
2584 @node Included Certificates
2585 @subsection Included Certificates
2586 @cindex certificates, included
2587
2588 @deftypefun void gpgme_set_include_certs (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{nr_of_certs}})
2589 The function @code{gpgme_set_include_certs} specifies how many
2590 certificates should be included in an S/MIME signed message.  By
2591 default, only the sender's certificate is included.  The possible
2592 values of @var{nr_of_certs} are:
2593
2594 @table @code
2595 @item GPGME_INCLUDE_CERTS_DEFAULT
2596 Fall back to the default of the crypto backend.  This is the default
2597 for GPGME.
2598 @item -2
2599 Include all certificates except the root certificate.
2600 @item -1
2601 Include all certificates.
2602 @item 0
2603 Include no certificates.
2604 @item 1
2605 Include the sender's certificate only.
2606 @item n
2607 Include the first n certificates of the certificates path, starting
2608 from the sender's certificate.  The number @code{n} must be positive.
2609 @end table
2610
2611 Values of @var{nr_of_certs} smaller than -2 are undefined.
2612
2613 This option is only relevant to the CMS crypto engine, and ignored by
2614 all other engines.
2615 @end deftypefun
2616
2617 @deftypefun int gpgme_get_include_certs (@w{gpgme_ctx_t @var{ctx}})
2618 The function @code{gpgme_get_include_certs} returns the number of
2619 certificates to include into an S/MIME signed message.
2620 @end deftypefun
2621
2622
2623 @node Key Listing Mode
2624 @subsection Key Listing Mode
2625 @cindex key listing mode
2626 @cindex key listing, mode of
2627
2628 @deftypefun gpgme_error_t gpgme_set_keylist_mode (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_keylist_mode_t @var{mode}})
2629 The function @code{gpgme_set_keylist_mode} changes the default
2630 behaviour of the key listing functions.  The value in @var{mode} is a
2631 bitwise-or combination of one or multiple of the following bit values:
2632
2633 @table @code
2634 @item GPGME_KEYLIST_MODE_LOCAL
2635 The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
2636 keyring should be searched for keys in the keylisting operation.  This
2637 is the default.
2638
2639 @item GPGME_KEYLIST_MODE_EXTERN
2640 The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
2641 source should be searched for keys in the keylisting operation.  The
2642 type of external source is dependant on the crypto engine used and
2643 whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}.  For
2644 example, it can be a remote keyserver or LDAP certificate server.
2645
2646 @item GPGME_KEYLIST_MODE_SIGS
2647 The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key
2648 signatures should be included in the listed keys.
2649
2650 @item GPGME_KEYLIST_MODE_SIG_NOTATIONS
2651 The @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} symbol specifies that the
2652 signature notations on key signatures should be included in the listed
2653 keys.  This only works if @code{GPGME_KEYLIST_MODE_SIGS} is also
2654 enabled.
2655
2656 @item GPGME_KEYLIST_MODE_WITH_TOFU
2657 The @code{GPGME_KEYLIST_MODE_WITH_TOFU} symbol specifies that
2658 information pertaining to the TOFU trust model should be included in
2659 the listed keys.
2660
2661 @item GPGME_KEYLIST_MODE_WITH_SECRET
2662 The @code{GPGME_KEYLIST_MODE_WITH_SECRET} returns information about
2663 the presence of a corresponding secret key in a public key listing.  A
2664 public key listing with this mode is slower than a standard listing
2665 but can be used instead of a second run to list the secret keys.  This
2666 is only supported for GnuPG versions >= 2.1.
2667
2668 @item GPGME_KEYLIST_MODE_EPHEMERAL
2669 The @code{GPGME_KEYLIST_MODE_EPHEMERAL} symbol specifies that keys
2670 flagged as ephemeral are included in the listing.
2671
2672 @item GPGME_KEYLIST_MODE_VALIDATE
2673 The @code{GPGME_KEYLIST_MODE_VALIDATE} symbol specifies that the
2674 backend should do key or certificate validation and not just get the
2675 validity information from an internal cache.  This might be an
2676 expensive operation and is in general not useful.  Currently only
2677 implemented for the S/MIME backend and ignored for other backends.
2678
2679 @end table
2680
2681 At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
2682 @code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
2683 compatibility, you should get the current mode with
2684 @code{gpgme_get_keylist_mode} and modify it by setting or clearing the
2685 appropriate bits, and then using that calculated value in the
2686 @code{gpgme_set_keylisting_mode} operation.  This will leave all other
2687 bits in the mode value intact (in particular those that are not used
2688 in the current version of the library).
2689
2690 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2691 mode could be set correctly, and @code{GPG_ERR_INV_VALUE} if @var{ctx}
2692 is not a valid pointer or @var{mode} is not a valid mode.
2693 @end deftypefun
2694
2695
2696 @deftypefun gpgme_keylist_mode_t gpgme_get_keylist_mode (@w{gpgme_ctx_t @var{ctx}})
2697 The function @code{gpgme_get_keylist_mode} returns the current key
2698 listing mode of the context @var{ctx}.  This value can then be
2699 modified and used in a subsequent @code{gpgme_set_keylist_mode}
2700 operation to only affect the desired bits (and leave all others
2701 intact).
2702
2703 The function returns 0 if @var{ctx} is not a valid pointer, and the
2704 current mode otherwise.  Note that 0 is not a valid mode value.
2705 @end deftypefun
2706
2707
2708 @node Passphrase Callback
2709 @subsection Passphrase Callback
2710 @cindex callback, passphrase
2711 @cindex passphrase callback
2712
2713 @deftp {Data type} {gpgme_error_t (*gpgme_passphrase_cb_t)(void *@var{hook}, const char *@var{uid_hint}, const char *@var{passphrase_info}, @w{int @var{prev_was_bad}}, @w{int @var{fd}})}
2714 @tindex gpgme_passphrase_cb_t
2715 The @code{gpgme_passphrase_cb_t} type is the type of functions usable as
2716 passphrase callback function.
2717
2718 The argument @var{uid_hint} might contain a string that gives an
2719 indication for which user ID the passphrase is required.  If this is
2720 not available, or not applicable (in the case of symmetric encryption,
2721 for example), @var{uid_hint} will be @code{NULL}.
2722
2723 The argument @var{passphrase_info}, if not @code{NULL}, will give
2724 further information about the context in which the passphrase is
2725 required.  This information is engine and operation specific.
2726
2727 If this is the repeated attempt to get the passphrase, because
2728 previous attempts failed, then @var{prev_was_bad} is 1, otherwise it
2729 will be 0.
2730
2731 The user must write the passphrase, followed by a newline character,
2732 to the file descriptor @var{fd}.  The function @code{gpgme_io_writen}
2733 should be used for the write operation.  Note that if the user returns
2734 0 to indicate success, the user must at least write a newline
2735 character before returning from the callback.
2736
2737 If an error occurs, return the corresponding @code{gpgme_error_t}
2738 value.  You can use the error code @code{GPG_ERR_CANCELED} to abort
2739 the operation.  Otherwise, return @code{0}.
2740 @end deftp
2741
2742 @deftypefun void gpgme_set_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t @var{passfunc}}, @w{void *@var{hook_value}})
2743 The function @code{gpgme_set_passphrase_cb} sets the function that is
2744 used when a passphrase needs to be provided by the user to
2745 @var{passfunc}.  The function @var{passfunc} needs to implemented by
2746 the user, and whenever it is called, it is called with its first
2747 argument being @var{hook_value}.  By default, no passphrase callback
2748 function is set.
2749
2750 Not all crypto engines require this callback to retrieve the
2751 passphrase.  It is better if the engine retrieves the passphrase from
2752 a trusted agent (a daemon process), rather than having each user to
2753 implement their own passphrase query.  Some engines do not even
2754 support an external passphrase callback at all, in this case the error
2755 code @code{GPG_ERR_NOT_SUPPORTED} is returned.
2756
2757 For GnuPG >= 2.1 the pinentry mode has to be set to
2758 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback.
2759 See @code{gpgme_set_pinentry_mode}.
2760
2761 The user can disable the use of a passphrase callback function by
2762 calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
2763 @code{NULL}.
2764 @end deftypefun
2765
2766 @deftypefun void gpgme_get_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t *@var{passfunc}}, @w{void **@var{hook_value}})
2767 The function @code{gpgme_get_passphrase_cb} returns the function that
2768 is used when a passphrase needs to be provided by the user in
2769 @var{*passfunc}, and the first argument for this function in
2770 @var{*hook_value}.  If no passphrase callback is set, or @var{ctx} is
2771 not a valid pointer, @code{NULL} is returned in both variables.
2772
2773 @var{passfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2774 the corresponding value will not be returned.
2775 @end deftypefun
2776
2777
2778 @node Progress Meter Callback
2779 @subsection Progress Meter Callback
2780 @cindex callback, progress meter
2781 @cindex progress meter callback
2782
2783 @deftp {Data type} {void (*gpgme_progress_cb_t)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
2784 @tindex gpgme_progress_cb_t
2785 The @code{gpgme_progress_cb_t} type is the type of functions usable as
2786 progress callback function.
2787
2788 The arguments are specific to the crypto engine.  More information
2789 about the progress information returned from the GnuPG engine can be
2790 found in the GnuPG source code in the file @file{doc/DETAILS} in the
2791 section PROGRESS.
2792 @end deftp
2793
2794 @deftypefun void gpgme_set_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t @var{progfunc}}, @w{void *@var{hook_value}})
2795 The function @code{gpgme_set_progress_cb} sets the function that is
2796 used when progress information about a cryptographic operation is
2797 available.  The function @var{progfunc} needs to implemented by the
2798 user, and whenever it is called, it is called with its first argument
2799 being @var{hook_value}.  By default, no progress callback function
2800 is set.
2801
2802 Setting a callback function allows an interactive program to display
2803 progress information about a long operation to the user.
2804
2805 The user can disable the use of a progress callback function by
2806 calling @code{gpgme_set_progress_cb} with @var{progfunc} being
2807 @code{NULL}.
2808 @end deftypefun
2809
2810 @deftypefun void gpgme_get_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t *@var{progfunc}}, @w{void **@var{hook_value}})
2811 The function @code{gpgme_get_progress_cb} returns the function that is
2812 used to inform the user about the progress made in @var{*progfunc},
2813 and the first argument for this function in @var{*hook_value}.  If no
2814 progress callback is set, or @var{ctx} is not a valid pointer,
2815 @code{NULL} is returned in both variables.
2816
2817 @var{progfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2818 the corresponding value will not be returned.
2819 @end deftypefun
2820
2821
2822 @node Status Message Callback
2823 @subsection Status Message Callback
2824 @cindex callback, status message
2825 @cindex status message callback
2826
2827 @deftp {Data type} {gpgme_error_t (*gpgme_status_cb_t)(void *@var{hook}, const char *@var{keyword}, const char *@var{args})}
2828 @tindex gpgme_status_cb_t
2829 The @code{gpgme_status_cb_t} type is the type of function usable as
2830 a status message callback function.
2831
2832 The argument @var{keyword} is the name of the status message while the
2833 @var{args} argument contains any arguments for the status message.
2834
2835 If an error occurs, return the corresponding @code{gpgme_error_t}
2836 value. Otherwise, return @code{0}.
2837 @end deftp
2838
2839 @deftypefun void gpgme_set_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t @var{statusfunc}}, @w{void *@var{hook_value}})
2840 The function @code{gpgme_set_status_cb} sets the function that is used when a
2841 status message is received from gpg to @var{statusfunc}. The function
2842 @var{statusfunc} needs to be implemented by the user, and whenever it is
2843 called, it is called with its first argument being @var{hook_value}.  By
2844 default, no status message callback function is set.
2845
2846 The user can disable the use of a status message callback function by calling
2847 @code{gpgme_set_status_cb} with @var{statusfunc} being @code{NULL}.
2848 @end deftypefun
2849
2850 @deftypefun void gpgme_get_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t *@var{statusfunc}}, @w{void **@var{hook_value}})
2851 The function @code{gpgme_get_status_cb} returns the function that is used to
2852 process status messages from gpg in @var{*statusfunc}, and the first argument
2853 for this function in @var{*hook_value}.  If no status message callback is set,
2854 or @var{ctx} is not a valid pointer, @code{NULL} is returned in both
2855 variables.
2856 @end deftypefun
2857
2858 @deftypefun {gpgme_error_t} gpgme_set_ctx_flag  @
2859             (@w{gpgme_ctx_t @var{ctx}}, @
2860             @w{const char *@var{name}}, @
2861             @w{const char *@var{value}})
2862
2863 Some minor properties of the context can be controlled with flags set
2864 by this function.  The properties are identified by the following
2865 values for @var{name}:
2866
2867 @table @code
2868 @item "full-status"
2869 Using a @var{value} of "1" the status callback set by
2870 gpgme_set_status_cb returns all status lines with the exception of
2871 PROGRESS lines.  With the default of "0" the status callback is only
2872 called in certain situations.
2873
2874 @item "raw-description"
2875 Setting the @var{value} to "1" returns human readable strings in a raw
2876 format.  For example the non breaking space characters ("~") will not
2877 be removed from the @code{description} field of the
2878 @code{gpgme_tofu_info_t} object.
2879
2880 @end table
2881
2882 This function returns @code{0} on success.
2883 @end deftypefun
2884
2885
2886 @node Locale
2887 @subsection Locale
2888 @cindex locale, default
2889 @cindex locale, of a context
2890
2891 A locale setting can be associated with a context.  This locale is
2892 passed to the crypto engine, and used for applications like the PIN
2893 entry, which is displayed to the user when entering a passphrase is
2894 required.
2895
2896 The default locale is used to initialize the locale setting of all
2897 contexts created afterwards.
2898
2899 @deftypefun gpgme_error_t gpgme_set_locale (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{category}}, @w{const char *@var{value}})
2900 The function @code{gpgme_set_locale} sets the locale of the context
2901 @var{ctx}, or the default locale if @var{ctx} is a null pointer.
2902
2903 The locale settings that should be changed are specified by
2904 @var{category}.  Supported categories are @code{LC_CTYPE},
2905 @code{LC_MESSAGES}, and @code{LC_ALL}, which is a wildcard you can use
2906 if you want to change all the categories at once.
2907
2908 The value to be used for the locale setting is @var{value}, which will
2909 be copied to @acronym{GPGME}'s internal data structures.  @var{value}
2910 can be a null pointer, which disables setting the locale, and will
2911 make PIN entry and other applications use their default setting, which
2912 is usually not what you want.
2913
2914 Note that the settings are only used if the application runs on a text
2915 terminal, and that the settings should fit the configuration of the
2916 output terminal.  Normally, it is sufficient to initialize the default
2917 value at startup.
2918
2919 The function returns an error if not enough memory is available.
2920 @end deftypefun
2921
2922
2923 @node Key Management
2924 @section Key Management
2925 @cindex key management
2926
2927 Some of the cryptographic operations require that recipients or
2928 signers are specified.  This is always done by specifying the
2929 respective keys that should be used for the operation.  The following
2930 section describes how such keys can be selected and manipulated.
2931
2932
2933 @menu
2934 * Key objects::                   Description of the key structures.
2935 * Listing Keys::                  Browsing the list of available keys.
2936 * Information About Keys::        Requesting detailed information about keys.
2937 * Manipulating Keys::             Operations on keys.
2938 * Generating Keys::               Creating new key pairs.
2939 * Signing Keys::                  Adding key signatures to public keys.
2940 * Exporting Keys::                Retrieving key data from the key ring.
2941 * Importing Keys::                Adding keys to the key ring.
2942 * Deleting Keys::                 Removing keys from the key ring.
2943 * Changing Passphrases::          Change the passphrase of a key.
2944 * Changing TOFU Data::            Changing data pertaining to TOFU.
2945 * Advanced Key Editing::          Advanced key edit operation.
2946 @end menu
2947
2948 @node Key objects
2949 @subsection Key objects
2950
2951 The keys are represented in GPGME by structures which may only be read
2952 by the application but never be allocated or changed.  They are valid
2953 as long as the key object itself is valid.
2954
2955 @deftp {Data type} gpgme_key_t
2956
2957 The @code{gpgme_key_t} type is a pointer to a key object.  It has the
2958 following members:
2959
2960 @table @code
2961 @item gpgme_keylist_mode_t keylist_mode
2962 The keylist mode that was active when the key was retrieved.
2963
2964 @item unsigned int revoked : 1
2965 This is true if the key is revoked.
2966
2967 @item unsigned int expired : 1
2968 This is true if the key is expired.
2969
2970 @item unsigned int disabled : 1
2971 This is true if the key is disabled.
2972
2973 @item unsigned int invalid : 1
2974 This is true if the key is invalid. This might have several reasons,
2975 for a example for the S/MIME backend, it will be set during key
2976 listings if the key could not be validated due to missing
2977 certificates or unmatched policies.
2978
2979 @item unsigned int can_encrypt : 1
2980 This is true if the key (ie one of its subkeys) can be used for
2981 encryption.
2982
2983 @item unsigned int can_sign : 1
2984 This is true if the key (ie one of its subkeys) can be used to create
2985 data signatures.
2986
2987 @item unsigned int can_certify : 1
2988 This is true if the key (ie one of its subkeys) can be used to create
2989 key certificates.
2990
2991 @item unsigned int can_authenticate : 1
2992 This is true if the key (ie one of its subkeys) can be used for
2993 authentication.
2994
2995 @item unsigned int is_qualified : 1
2996 This is true if the key can be used for qualified signatures according
2997 to local government regulations.
2998
2999 @item unsigned int secret : 1
3000 This is true if the key is a secret key.  Note, that this will always
3001 be true even if the corresponding subkey flag may be false
3002 (offline/stub keys).  This is only set if a listing of secret keys has
3003 been requested or if @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3004
3005 @item gpgme_protocol_t protocol
3006 This is the protocol supported by this key.
3007
3008 @item char *issuer_serial
3009 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3010 issuer serial.
3011
3012 @item char *issuer_name
3013 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3014 issuer name.
3015
3016 @item char *chain_id
3017 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3018 chain ID, which can be used to built the certificate chain.
3019
3020 @item gpgme_validity_t owner_trust
3021 If @code{protocol} is @code{GPGME_PROTOCOL_OpenPGP}, then this is the
3022 owner trust.
3023
3024 @item gpgme_subkey_t subkeys
3025 This is a linked list with the subkeys of the key.  The first subkey
3026 in the list is the primary key and usually available.
3027
3028 @item gpgme_user_id_t uids
3029 This is a linked list with the user IDs of the key.  The first user ID
3030 in the list is the main (or primary) user ID.
3031
3032 @item char *fpr
3033 This field gives the fingerprint of the primary key.  Note that
3034 this is a copy of the fingerprint of the first subkey.  For an
3035 incomplete key (for example from a verification result) a subkey may
3036 be missing but this field may be set nevertheless.
3037
3038 @end table
3039 @end deftp
3040
3041
3042 @deftp {Data type} gpgme_subkey_t
3043
3044 The @code{gpgme_subkey_t} type is a pointer to a subkey structure.
3045 Subkeys are one component of a @code{gpgme_key_t} object.  In fact,
3046 subkeys are those parts that contains the real information about the
3047 individual cryptographic keys that belong to the same key object.  One
3048 @code{gpgme_key_t} can contain several subkeys.  The first subkey in
3049 the linked list is also called the primary key.
3050
3051 The subkey structure has the following members:
3052
3053 @table @code
3054 @item gpgme_subkey_t next
3055 This is a pointer to the next subkey structure in the linked list, or
3056 @code{NULL} if this is the last element.
3057
3058 @item unsigned int revoked : 1
3059 This is true if the subkey is revoked.
3060
3061 @item unsigned int expired : 1
3062 This is true if the subkey is expired.
3063
3064 @item unsigned int disabled : 1
3065 This is true if the subkey is disabled.
3066
3067 @item unsigned int invalid : 1
3068 This is true if the subkey is invalid.
3069
3070 @item unsigned int can_encrypt : 1
3071 This is true if the subkey can be used for encryption.
3072
3073 @item unsigned int can_sign : 1
3074 This is true if the subkey can be used to create data signatures.
3075
3076 @item unsigned int can_certify : 1
3077 This is true if the subkey can be used to create key certificates.
3078
3079 @item unsigned int can_authenticate : 1
3080 This is true if the subkey can be used for authentication.
3081
3082 @item unsigned int is_qualified : 1
3083 This is true if the subkey can be used for qualified signatures
3084 according to local government regulations.
3085
3086 @item unsigned int secret : 1
3087 This is true if the subkey is a secret key.  Note that it will be
3088 false if the key is actually a stub key; i.e. a secret key operation
3089 is currently not possible (offline-key).  This is only set if a
3090 listing of secret keys has been requested or if
3091 @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3092
3093 @item gpgme_pubkey_algo_t pubkey_algo
3094 This is the public key algorithm supported by this subkey.
3095
3096 @item unsigned int length
3097 This is the length of the subkey (in bits).
3098
3099 @item char *keyid
3100 This is the key ID of the subkey in hexadecimal digits.
3101
3102 @item char *fpr
3103 This is the fingerprint of the subkey in hexadecimal digits, if
3104 available.
3105
3106 @item char *keygrip
3107 The keygrip of the subkey in hex digit form or @code{NULL} if not
3108 availabale.
3109
3110 @item long int timestamp
3111 This is the creation timestamp of the subkey.  This is -1 if the
3112 timestamp is invalid, and 0 if it is not available.
3113
3114 @item long int expires
3115 This is the expiration timestamp of the subkey, or 0 if the subkey
3116 does not expire.
3117
3118 @item unsigned int is_cardkey : 1
3119 True if the secret key is stored on a smart card.
3120
3121 @item char *card_number
3122 The serial number of a smart card holding this key or @code{NULL}.
3123
3124 @item char *curve
3125 For ECC algorithms the name of the curve.
3126
3127 @end table
3128 @end deftp
3129
3130 @deftp {Data type} gpgme_user_id_t
3131
3132 A user ID is a component of a @code{gpgme_key_t} object.  One key can
3133 have many user IDs.  The first one in the list is the main (or
3134 primary) user ID.
3135
3136 The user ID structure has the following members.
3137
3138 @table @code
3139 @item gpgme_user_id_t next
3140 This is a pointer to the next user ID structure in the linked list, or
3141 @code{NULL} if this is the last element.
3142
3143 @item unsigned int revoked : 1
3144 This is true if the user ID is revoked.
3145
3146 @item unsigned int invalid : 1
3147 This is true if the user ID is invalid.
3148
3149 @item gpgme_validity_t validity
3150 This specifies the validity of the user ID.
3151
3152 @item char *uid
3153 This is the user ID string.
3154
3155 @item char *name
3156 This is the name component of @code{uid}, if available.
3157
3158 @item char *comment
3159 This is the comment component of @code{uid}, if available.
3160
3161 @item char *email
3162 This is the email component of @code{uid}, if available.
3163
3164 @item char *address;
3165 The mail address (addr-spec from RFC-5322) of the user ID string.
3166 This is general the same as the @code{email} part of this structure
3167 but might be slightly different.  If no mail address is available
3168 @code{NULL} is stored.
3169
3170 @item gpgme_tofu_info_t tofu
3171 If not @code{NULL} information from the TOFU database pertaining to
3172 this user id.
3173
3174 @item gpgme_key_sig_t signatures
3175 This is a linked list with the signatures on this user ID.
3176 @end table
3177 @end deftp
3178
3179
3180 @deftp {Data type} gpgme_key_sig_t
3181
3182 The @code{gpgme_key_sig_t} type is a pointer to a key signature structure.
3183 Key signatures are one component of a @code{gpgme_key_t} object, and
3184 validate user IDs on the key in the OpenPGP protocol.
3185
3186 The signatures on a key are only available if the key was retrieved
3187 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
3188 enabled, because it can be expensive to retrieve all signatures of a
3189 key.
3190
3191 The signature notations on a key signature are only available if the
3192 key was retrieved via a listing operation with the
3193 @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} mode enabled, because it can
3194 be expensive to retrieve all signature notations.
3195
3196 The key signature structure has the following members:
3197
3198 @table @code
3199 @item gpgme_key_sig_t next
3200 This is a pointer to the next key signature structure in the linked
3201 list, or @code{NULL} if this is the last element.
3202
3203 @item unsigned int revoked : 1
3204 This is true if the key signature is a revocation signature.
3205
3206 @item unsigned int expired : 1
3207 This is true if the key signature is expired.
3208
3209 @item unsigned int invalid : 1
3210 This is true if the key signature is invalid.
3211
3212 @item unsigned int exportable : 1
3213 This is true if the key signature is exportable.
3214
3215 @item gpgme_pubkey_algo_t pubkey_algo
3216 This is the public key algorithm used to create the signature.
3217
3218 @item char *keyid
3219 This is the key ID of the key (in hexadecimal digits) used to create
3220 the signature.
3221
3222 @item long int timestamp
3223 This is the creation timestamp of the key signature.  This is -1 if
3224 the timestamp is invalid, and 0 if it is not available.
3225
3226 @item long int expires
3227 This is the expiration timestamp of the key signature, or 0 if the key
3228 signature does not expire.
3229
3230 @item gpgme_error_t status
3231 This is the status of the signature and has the same meaning as the
3232 member of the same name in a @code{gpgme_signature_t} object.
3233
3234 @item unsigned int sig_class
3235 This specifies the signature class of the key signature.  The meaning
3236 is specific to the crypto engine.
3237
3238 @item char *uid
3239 This is the main user ID of the key used to create the signature.
3240
3241 @item char *name
3242 This is the name component of @code{uid}, if available.
3243
3244 @item char *comment
3245 This is the comment component of @code{uid}, if available.
3246
3247 @item char *email
3248 This is the email component of @code{uid}, if available.
3249
3250 @item gpgme_sig_notation_t notations
3251 This is a linked list with the notation data and policy URLs.
3252 @end table
3253 @end deftp
3254
3255
3256
3257 @node Listing Keys
3258 @subsection Listing Keys
3259 @cindex listing keys
3260 @cindex key listing
3261 @cindex key listing, start
3262 @cindex key ring, list
3263 @cindex key ring, search
3264
3265 @deftypefun gpgme_error_t gpgme_op_keylist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
3266 The function @code{gpgme_op_keylist_start} initiates a key listing
3267 operation inside the context @var{ctx}.  It sets everything up so that
3268 subsequent invocations of @code{gpgme_op_keylist_next} return the keys
3269 in the list.
3270
3271 If @var{pattern} is @code{NULL}, all available keys are returned.
3272 Otherwise, @var{pattern} contains an engine specific expression that
3273 is used to limit the list to all keys matching the pattern.  Note that
3274 the total length of the pattern is restricted to an engine-specific
3275 maximum (a couple of hundred characters are usually accepted).  The
3276 pattern should be used to restrict the search to a certain common name
3277 or user, not to list many specific keys at once by listing their
3278 fingerprints or key IDs.
3279
3280 If @var{secret_only} is not @code{0}, the list is restricted to secret
3281 keys only.
3282
3283 The context will be busy until either all keys are received (and
3284 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3285 @code{gpgme_op_keylist_end} is called to finish the operation.
3286
3287 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3288 @var{ctx} is not a valid pointer, and passes through any errors that
3289 are reported by the crypto engine support routines.
3290 @end deftypefun
3291
3292 @deftypefun gpgme_error_t gpgme_op_keylist_ext_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}[]}, @w{int @var{secret_only}}, @w{int @var{reserved}})
3293 The function @code{gpgme_op_keylist_ext_start} initiates an extended
3294 key listing operation inside the context @var{ctx}.  It sets
3295 everything up so that subsequent invocations of
3296 @code{gpgme_op_keylist_next} return the keys in the list.
3297
3298 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
3299 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
3300 array of strings that are used to limit the list to all keys matching
3301 at least one of the patterns verbatim.  Note that the total length of
3302 all patterns is restricted to an engine-specific maximum (the exact
3303 limit also depends on the number of patterns and amount of quoting
3304 required, but a couple of hundred characters are usually accepted).
3305 Patterns should be used to restrict the search to a certain common
3306 name or user, not to list many specific keys at once by listing their
3307 fingerprints or key IDs.
3308
3309 If @var{secret_only} is not @code{0}, the list is restricted to secret
3310 keys only.
3311
3312 The value of @var{reserved} must be @code{0}.
3313
3314 The context will be busy until either all keys are received (and
3315 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3316 @code{gpgme_op_keylist_end} is called to finish the operation.
3317
3318 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3319 @var{ctx} is not a valid pointer, and passes through any errors that
3320 are reported by the crypto engine support routines.
3321 @end deftypefun
3322
3323 @deftypefun gpgme_error_t gpgme_op_keylist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{r_key}})
3324 The function @code{gpgme_op_keylist_next} returns the next key in the
3325 list created by a previous @code{gpgme_op_keylist_start} operation in
3326 the context @var{ctx}.  The key will have one reference for the user.
3327 @xref{Manipulating Keys}.
3328
3329 This is the only way to get at @code{gpgme_key_t} objects in
3330 @acronym{GPGME}.
3331
3332 If the last key in the list has already been returned,
3333 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}.
3334
3335 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3336 @var{ctx} or @var{r_key} is not a valid pointer, and
3337 @code{GPG_ERR_ENOMEM} if there is not enough memory for the operation.
3338 @end deftypefun
3339
3340 @deftypefun gpgme_error_t gpgme_op_keylist_end (@w{gpgme_ctx_t @var{ctx}})
3341 The function @code{gpgme_op_keylist_end} ends a pending key list
3342 operation in the context @var{ctx}.
3343
3344 After the operation completed successfully, the result of the key
3345 listing operation can be retrieved with
3346 @code{gpgme_op_keylist_result}.
3347
3348 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3349 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if at some
3350 time during the operation there was not enough memory available.
3351 @end deftypefun
3352
3353 The following example illustrates how all keys containing a certain
3354 string (@code{g10code}) can be listed with their key ID and the name
3355 and e-mail address of the main user ID:
3356
3357 @example
3358 gpgme_ctx_t ctx;
3359 gpgme_key_t key;
3360 gpgme_error_t err = gpgme_new (&ctx);
3361
3362 if (!err)
3363   @{
3364     err = gpgme_op_keylist_start (ctx, "g10code", 0);
3365     while (!err)
3366       @{
3367         err = gpgme_op_keylist_next (ctx, &key);
3368         if (err)
3369           break;
3370         printf ("%s:", key->subkeys->keyid);
3371         if (key->uids && key->uids->name)
3372           printf (" %s", key->uids->name);
3373         if (key->uids && key->uids->email)
3374           printf (" <%s>", key->uids->email);
3375         putchar ('\n');
3376         gpgme_key_release (key);
3377       @}
3378     gpgme_release (ctx);
3379   @}
3380 if (gpg_err_code (err) != GPG_ERR_EOF)
3381   @{
3382     fprintf (stderr, "can not list keys: %s\n", gpgme_strerror (err));
3383     exit (1);
3384   @}
3385 @end example
3386
3387 @deftp {Data type} {gpgme_keylist_result_t}
3388 This is a pointer to a structure used to store the result of a
3389 @code{gpgme_op_keylist_*} operation.  After successfully ending a key
3390 listing operation, you can retrieve the pointer to the result with
3391 @code{gpgme_op_keylist_result}.  The structure contains the following
3392 member:
3393
3394 @table @code
3395 @item unsigned int truncated : 1
3396 This is true if the crypto backend had to truncate the result, and
3397 less than the desired keys could be listed.
3398 @end table
3399 @end deftp
3400
3401 @deftypefun gpgme_keylist_result_t gpgme_op_keylist_result (@w{gpgme_ctx_t @var{ctx}})
3402 The function @code{gpgme_op_keylist_result} returns a
3403 @code{gpgme_keylist_result_t} pointer to a structure holding the
3404 result of a @code{gpgme_op_keylist_*} operation.  The pointer is only
3405 valid if the last operation on the context was a key listing
3406 operation, and if this operation finished successfully.  The returned
3407 pointer is only valid until the next operation is started on the
3408 context.
3409 @end deftypefun
3410
3411 In a simple program, for which a blocking operation is acceptable, the
3412 following function can be used to retrieve a single key.
3413
3414 @deftypefun gpgme_error_t gpgme_get_key (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{fpr}}, @w{gpgme_key_t *@var{r_key}}, @w{int @var{secret}})
3415 The function @code{gpgme_get_key} gets the key with the fingerprint
3416 (or key ID) @var{fpr} from the crypto backend and return it in
3417 @var{r_key}.  If @var{secret} is true, get the secret key.  The
3418 currently active keylist mode is used to retrieve the key.  The key
3419 will have one reference for the user.
3420
3421 If the key is not found in the keyring, @code{gpgme_get_key} returns
3422 the error code @code{GPG_ERR_EOF} and *@var{r_key} will be set to
3423 @code{NULL}.
3424
3425 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3426 @var{ctx} or @var{r_key} is not a valid pointer or @var{fpr} is not a
3427 fingerprint or key ID, @code{GPG_ERR_AMBIGUOUS_NAME} if the key ID was
3428 not a unique specifier for a key, and @code{GPG_ERR_ENOMEM} if at some
3429 time during the operation there was not enough memory available.
3430 @end deftypefun
3431
3432
3433 @node Information About Keys
3434 @subsection Information About Keys
3435 @cindex key, information about
3436 @cindex key, attributes
3437 @cindex attributes, of a key
3438
3439 Please see the beginning of this section for more information about
3440 @code{gpgme_key_t} objects.
3441
3442 @deftp {Data type} gpgme_validity_t
3443 The @code{gpgme_validity_t} type is used to specify the validity of a user ID
3444 in a key.  The following validities are defined:
3445
3446 @table @code
3447 @item GPGME_VALIDITY_UNKNOWN
3448 The user ID is of unknown validity.  The string representation of this
3449 validity is ``?''.
3450
3451 @item GPGME_VALIDITY_UNDEFINED
3452 The validity of the user ID is undefined.  The string representation of this
3453 validity is ``q''.
3454
3455 @item GPGME_VALIDITY_NEVER
3456 The user ID is never valid.  The string representation of this
3457 validity is ``n''.
3458
3459 @item GPGME_VALIDITY_MARGINAL
3460 The user ID is marginally valid.  The string representation of this
3461 validity is ``m''.
3462
3463 @item GPGME_VALIDITY_FULL
3464 The user ID is fully valid.  The string representation of this
3465 validity is ``f''.
3466
3467 @item GPGME_VALIDITY_ULTIMATE
3468 The user ID is ultimately valid.  The string representation of this
3469 validity is ``u''.
3470 @end table
3471 @end deftp
3472
3473
3474
3475
3476 @node Manipulating Keys
3477 @subsection Manipulating Keys
3478 @cindex key, manipulation
3479
3480 @deftypefun void gpgme_key_ref (@w{gpgme_key_t @var{key}})
3481 The function @code{gpgme_key_ref} acquires an additional reference for
3482 the key @var{key}.
3483 @end deftypefun
3484
3485 @deftypefun void gpgme_key_unref (@w{gpgme_key_t @var{key}})
3486 The function @code{gpgme_key_unref} releases a reference for the key
3487 @var{key}.  If this was the last reference, the key will be destroyed
3488 and all resources associated to it will be released.
3489 @end deftypefun
3490
3491
3492 @node Generating Keys
3493 @subsection Generating Keys
3494 @cindex key, creation
3495 @cindex key ring, add
3496
3497 GPGME provides a set of functions to create public key pairs.  Most of
3498 these functions require the use of GnuPG 2.1 and later; for older
3499 GnuPG versions the @code{gpgme_op_genkey} function can be used.
3500 Existing code which wants to update to the new functions or new code
3501 which shall supports older GnuPG versions may try the new functions
3502 first and provide a fallback to the old function if the error code
3503 @code{GPG_ERR_NOT_SUPPORTED} is received.
3504
3505 @c
3506 @c  gpgme_op_createkey
3507 @c
3508 @deftypefun gpgme_error_t gpgme_op_createkey @
3509       (@w{gpgme_ctx_t @var{ctx}}, @
3510        @w{const char *@var{userid}}, @
3511        @w{const char *@var{algo}}, @
3512        @w{unsigned long @var{reserved}}, @
3513        @w{unsigned long @var{expires}}, @
3514        @w{gpgme_key_t @var{extrakey}}, @
3515        @w{unsigned int @var{flags}});
3516
3517 The function @code{gpgme_op_createkey} generates a new key for the
3518 procotol active in the context @var{ctx}.  As of now this function
3519 does only work for OpenPGP and requires at least version 2.1.13 of
3520 GnuPG.
3521
3522 @var{userid} is commonly the mail address associated with the key.
3523 GPGME does not require a specificy syntax but if more than a mail
3524 address is given, RFC-822 style format is suggested.  The value is
3525 expected to be in UTF-8 encoding (i.e. no IDN encoding for mail
3526 addresses).  This is a required parameter.
3527
3528 @var{algo} specifies the algorithm for the new key (actually a keypair
3529 of public and private key).  For a list of supported algorithms, see
3530 the GnuPG manual.  If @var{algo} is @code{NULL} or the string
3531 "default", the key is generated using the default algorithm of the
3532 engine.  If the string "future-default" is used the engine may use an
3533 algorithm which is planned to be the default in a future release of
3534 the engine; however existing implementation of the protocol may not be
3535 able to already handle such future algorithms.  For the OpenPGP
3536 protocol, the specification of a default algorithm, without requesting
3537 a non-default usage via @var{flags}, triggers the creation of a
3538 primary key plus a secondary key (subkey).
3539
3540 @var{reserved} must be set to zero.
3541
3542 @var{expires} can be set to the number of seconds since Epoch of the
3543 desired expiration date in UTC for the new key.   Using 0 does not
3544 set an expiration date.  Note that this parameter takes an unsigned long
3545 value and not a @code{time_t} to avoid problems on systems which use a
3546 signed 32 bit @code{time_t}.  Note further that the OpenPGP protocol
3547 uses 32 bit values for timestamps and thus can only encode dates up to
3548 the year 2106.
3549
3550 @var{extrakey} is currently not used and must be set to @code{NULL}.
3551 A future version of GPGME may use this parameter to create X.509 keys.
3552
3553 @var{flags} can be set to the bit-wise OR of the following flags:
3554
3555 @table @code
3556 @item GPGME_CREATE_SIGN
3557 @itemx GPGME_CREATE_ENCR
3558 @itemx GPGME_CREATE_CERT
3559 @itemx GPGME_CREATE_AUTH
3560 Do not create the key with the default capabilities (key usage) of the
3561 requested algorithm but use those explicitly given by these flags:
3562 ``signing'', ``encryption'', ``certification'', or ``authentication''.
3563 The allowed combinations depend on the algorithm.
3564
3565 If any of these flags are set and a default algorithm has been
3566 selected only one key is created in the case of the OpenPGP
3567 protocol.
3568
3569 @item GPGME_CREATE_NOPASSWD
3570 Request generation of the key without password protection.
3571
3572 @item GPGME_CREATE_SELFSIGNED
3573 For an X.509 key do not create a CSR but a self-signed certificate.
3574 This has not yet been implemented.
3575
3576 @item GPGME_CREATE_NOSTORE
3577 Do not store the created key in the local key database.
3578 This has not yet been implemented.
3579
3580 @item GPGME_CREATE_WANTPUB
3581 @itemx GPGME_CREATE_WANTSEC
3582 Return the public or secret key as part of the result structure.
3583 This has not yet been implemented.
3584
3585 @item GPGME_CREATE_FORCE
3586 The engine does not allow the creation of a key with a user ID
3587 already existing in the local key database.  This flag can be used to
3588 override this check.
3589
3590 @end table
3591
3592 After the operation completed successfully, information about the
3593 created key can be retrieved with @code{gpgme_op_genkey_result}.
3594
3595 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
3596 the engine does not support the command, or a bunch of other error
3597 codes.
3598
3599 @end deftypefun
3600
3601
3602 @deftypefun gpgme_error_t gpgme_op_createkey_start @
3603       (@w{gpgme_ctx_t @var{ctx}}, @
3604        @w{const char *@var{userid}}, @
3605        @w{const char *@var{algo}}, @
3606        @w{unsigned long @var{reserved}}, @
3607        @w{unsigned long @var{expires}}, @
3608        @w{gpgme_key_t @var{extrakey}}, @
3609        @w{unsigned int @var{flags}});
3610
3611 The function @code{gpgme_op_createkey_start} initiates a
3612 @code{gpgme_op_createkey} operation; see there for details.  It must
3613 be completed by calling @code{gpgme_wait} on the context.
3614 @xref{Waiting For Completion}.
3615
3616 @end deftypefun
3617
3618 @c
3619 @c  gpgme_op_createsubkey
3620 @c
3621 @deftypefun gpgme_error_t gpgme_op_createsubkey @
3622       (@w{gpgme_ctx_t @var{ctx}}, @
3623        @w{gpgme_key_t @var{key}}, @
3624        @w{const char *@var{algo}}, @
3625        @w{unsigned long @var{reserved}}, @
3626        @w{unsigned long @var{expires}}, @
3627        @w{unsigned int @var{flags}});
3628
3629 The function @code{gpgme_op_createsubkey} creates and adds a new
3630 subkey to the primary OpenPGP key given by @var{KEY}.  The only
3631 allowed protocol in @var{ctx} is @code{GPGME_PROTOCOL_OPENPGP}.
3632 Subkeys (aka secondary keys) are a concept in the OpenPGP protocol to
3633 bind several keys to a primary key.  As of now this function requires
3634 at least version 2.1.13 of GnuPG.
3635
3636 @var{key} specifies the key to operate on.
3637
3638 @var{algo} specifies the algorithm for the new subkey.  For a list of
3639 supported algorithms, see the GnuPG manual.  If @var{algo} is
3640 @code{NULL} or the string "default", the subkey is generated using the
3641 default algorithm for an encryption subkey of the engine.  If the
3642 string "future-default" is used the engine may use an encryption
3643 algorithm which is planned to be the default in a future release of
3644 the engine; however existing implementation of the protocol may not be
3645 able to already handle such future algorithms.
3646
3647 @var{reserved} must be set to zero.
3648
3649 @var{expires} can be set to the number of seconds since Epoch of the
3650 desired expiration date in UTC for the new subkey.   Using 0 does not
3651 set an expiration date.  Note that this parameter takes an unsigned long
3652 value and not a @code{time_t} to avoid problems on systems which use a
3653 signed 32 bit @code{time_t}.  Note further that the OpenPGP protocol
3654 uses 32 bit values for timestamps and thus can only encode dates up to
3655 the year 2106.
3656
3657 @var{flags} takes the same values as described above for
3658 @code{gpgme_op_createkey}.
3659
3660 After the operation completed successfully, information about the
3661 created key can be retrieved with @code{gpgme_op_genkey_result}.
3662
3663 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
3664 the engine does not support the command, or a bunch of other error
3665 codes.
3666
3667
3668 @end deftypefun
3669
3670 @deftypefun gpgme_error_t gpgme_op_createsubkey_start @
3671       (@w{gpgme_ctx_t @var{ctx}}, @
3672        @w{gpgme_key_t @var{key}}, @
3673        @w{const char *@var{algo}}, @
3674        @w{unsigned long @var{reserved}}, @
3675        @w{unsigned long @var{expires}}, @
3676        @w{unsigned int @var{flags}});
3677
3678 The function @code{gpgme_op_createsubkey_start} initiates a
3679 @code{gpgme_op_createsubkey} operation; see there for details.  It must
3680 be completed by calling @code{gpgme_wait} on the context.
3681 @xref{Waiting For Completion}.
3682
3683 @end deftypefun
3684
3685
3686 @c
3687 @c  gpgme_op_adduid
3688 @c
3689 @deftypefun gpgme_error_t gpgme_op_adduid @
3690       (@w{gpgme_ctx_t @var{ctx}}, @
3691        @w{gpgme_key_t @var{key}}, @
3692        @w{const char *@var{userid}}, @
3693        @w{unsigned int @var{flags}});
3694
3695 The function @code{gpgme_op_adduid} adds a new user ID to the OpenPGP
3696 key given by @var{KEY}.  Adding additional user IDs after key creation
3697 is a feature of the OpenPGP protocol and thus the protocol for the
3698 context @var{ctx} must be set to OpenPGP.  As of&n