qt: Handle diagnostic audit log for CMS
[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--2018 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{string}
35   @sc{c:} \string\
36 @end macro
37 @macro srvr{string}
38   @sc{s:} \string\
39 @end macro
40
41 @c API version.
42 @macro since{string}
43   @sc{Since:} \string\
44 @end macro
45
46
47 @c
48 @c  T I T L E  P A G E
49 @c
50 @ifinfo
51 This file documents the @acronym{GPGME} library.
52
53 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
54 @cite{The `GnuPG Made Easy' Reference Manual}, for Version
55 @value{VERSION}.
56
57 @c NOTE: Don't forget to update the year for the TeX version, too.
58 @insertcopying
59
60 @end ifinfo
61
62 @c We do not want that bastard short titlepage.
63 @c @iftex
64 @c @shorttitlepage The `GnuPG Made Easy' Reference Manual
65 @c @end iftex
66 @titlepage
67 @center @titlefont{The `GnuPG Made Easy'}
68 @sp 1
69 @center @titlefont{Reference Manual}
70 @sp 6
71 @center Edition @value{EDITION}
72 @sp 1
73 @center last updated @value{UPDATED}
74 @sp 1
75 @center for version @value{VERSION}
76 @page
77 @vskip 0pt plus 1filll
78 Published by The GnuPG Project@* c/o g10 Code GmbH@* Hüttenstr. 61@* 40699 Erkrath, Germany
79
80 @insertcopying
81 @end titlepage
82 @page
83
84 @summarycontents
85 @contents
86
87 @ifnottex
88 @node Top
89 @top Main Menu
90 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
91 @cite{The `GnuPG Made Easy' Reference Manual}, for Version
92 @value{VERSION} of the @acronym{GPGME} library.
93 @end ifnottex
94
95 @menu
96 * Introduction::                  How to use this manual.
97 * Preparation::                   What you should do before using the library.
98 * Protocols and Engines::         Supported crypto protocols.
99 * Algorithms::                    Supported algorithms.
100 * Error Handling::                Error numbers and their meanings.
101 * Exchanging Data::               Passing data to and from @acronym{GPGME}.
102 * Contexts::                      Handling @acronym{GPGME} contexts.
103
104 Appendices
105
106 * UI Server Protocol::            The GnuPG UI Server Protocol.
107 * Debugging::                     How to solve problems.
108 * Deprecated Functions::          Documentation of deprecated functions.
109
110 * Library Copying::               The GNU Lesser General Public License says
111                                   how you can copy and share `GnuPG Made Easy'.
112 * Copying::                       The GNU General Public License says how you
113                                   can copy and share this manual.
114
115 Indices
116
117 * Concept Index::                 Index of concepts and programs.
118 * Function and Data Index::       Index of functions, variables and data types.
119
120 @detailmenu
121  --- The Detailed Node Listing ---
122
123 Introduction
124
125 * Getting Started::               Purpose of the manual, and how to use it.
126 * Features::                      Reasons to install and use @acronym{GPGME}.
127 * Overview::                      Basic architecture of the @acronym{GPGME} library.
128
129 Preparation
130
131 * Header::                        What header file you need to include.
132 * Building the Source::           Compiler options to be used.
133 * Largefile Support (LFS)::       How to use @acronym{GPGME} with LFS.
134 * Using Automake::                Compiler options to be used the easy way.
135 * Using Libtool::                 Avoiding compiler options entirely.
136 * Library Version Check::         Getting and verifying the library version.
137 * Signal Handling::               How @acronym{GPGME} affects signal handling.
138 * Multi-Threading::               How @acronym{GPGME} can be used in an MT environment.
139
140 Protocols and Engines
141
142 * Engine Version Check::          Verifying the engine version.
143 * Engine Information::            Obtaining more information about the engines.
144 * Engine Configuration::          Changing the engine configuration.
145 * OpenPGP::                       Support for the OpenPGP protocol.
146 * Cryptographic Message Syntax::  Support for the CMS.
147
148 Algorithms
149
150 * Public Key Algorithms::         A list of all public key algorithms.
151 * Hash Algorithms::               A list of all hash algorithms.
152
153 Error Handling
154
155 * Error Values::                  The error value and what it means.
156 * Error Codes::                   A list of important error codes.
157 * Error Sources::                 A list of important error sources.
158 * Error Strings::                 How to get a descriptive string from a value.
159
160 Exchanging Data
161
162 * Creating Data Buffers::         Creating new data buffers.
163 * Destroying Data Buffers::       Releasing data buffers.
164 * Manipulating Data Buffers::     Operations on data buffers.
165
166 Creating Data Buffers
167
168 * Memory Based Data Buffers::     Creating memory based data buffers.
169 * File Based Data Buffers::       Creating file based data buffers.
170 * Callback Based Data Buffers::   Creating callback based data buffers.
171
172 Manipulating Data Buffers
173
174 * Data Buffer I/O Operations::    I/O operations on data buffers.
175 * Data Buffer Meta-Data::         Meta-data manipulation of data buffers.
176 * Data Buffer Convenience::       Convenience function for data buffers.
177
178 Contexts
179
180 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
181 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
182 * Result Management::             Managing the result of crypto operations.
183 * Context Attributes::            Setting properties of a context.
184 * Key Management::                Managing keys with @acronym{GPGME}.
185 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
186 * Crypto Operations::             Using a context for cryptography.
187 * Miscellaneous::                 Miscellaneous operations.
188 * Run Control::                   Controlling how operations are run.
189
190 Context Attributes
191
192 * Protocol Selection::            Selecting the protocol used by a context.
193 * Crypto Engine::                 Configuring the crypto engine.
194 * Setting the Sender::            How to tell the engine the sender.
195 * ASCII Armor::                   Requesting @acronym{ASCII} armored output.
196 * Text Mode::                     Choosing canonical text mode.
197 * Offline Mode::                  Choosing offline mode.
198 * Included Certificates::         Including a number of certificates.
199 * Key Listing Mode::              Selecting key listing mode.
200 * Passphrase Callback::           Getting the passphrase from the user.
201 * Progress Meter Callback::       Being informed about the progress.
202 * Status Message Callback::       Status messages received from gpg.
203 * Locale::                        Setting the locale of a context.
204
205 Key Management
206
207 * Key objects::                   Description of the key structures.
208 * Listing Keys::                  Browsing the list of available keys.
209 * Information About Keys::        Requesting detailed information about keys.
210 * Manipulating Keys::             Operations on keys.
211 * Generating Keys::               Creating new key pairs.
212 * Signing Keys::                  Adding key signatures to public keys.
213 * Exporting Keys::                Retrieving key data from the key ring.
214 * Importing Keys::                Adding keys to the key ring.
215 * Deleting Keys::                 Removing keys from the key ring.
216 * Changing Passphrases::          Change the passphrase of a key.
217 * Changing TOFU Data::            Changing data pertaining to TOFU.
218 * Advanced Key Editing::          Advanced key edit operation.
219
220 Trust Item Management
221
222 * Listing Trust Items::           Browsing the list of available trust items.
223 * Manipulating Trust Items::      Operations on trust items.
224
225 Crypto Operations
226
227 * Decrypt::                       Decrypting a ciphertext.
228 * Verify::                        Verifying a signature.
229 * Decrypt and Verify::            Decrypting a signed ciphertext.
230 * Sign::                          Creating a signature.
231 * Encrypt::                       Encrypting a plaintext.
232
233 Sign
234
235 * Selecting Signers::             How to choose the keys to sign with.
236 * Creating a Signature::          How to create a signature.
237 * Signature Notation Data::       How to add notation data to a signature.
238
239 Encrypt
240
241 * Encrypting a Plaintext::        How to encrypt a plaintext.
242
243 Miscellaneous
244
245 * Running other Programs::        Running other Programs.
246 * Using the Assuan protocol::     Using the Assuan protocol.
247 * Checking for updates::          How to check for software updates.
248
249 Run Control
250
251 * Waiting For Completion::        Waiting until an operation is completed.
252 * Using External Event Loops::    Advanced control over what happens when.
253 * Cancellation::                  How to end pending operations prematurely.
254
255 Using External Event Loops
256
257 * I/O Callback Interface::        How I/O callbacks are registered.
258 * Registering I/O Callbacks::     How to use I/O callbacks for a context.
259 * I/O Callback Example::          An example how to use I/O callbacks.
260 * I/O Callback Example GTK+::     How to integrate @acronym{GPGME} in GTK+.
261 * I/O Callback Example GDK::      How to integrate @acronym{GPGME} in GDK.
262 * I/O Callback Example Qt::       How to integrate @acronym{GPGME} in Qt.
263
264 @end detailmenu
265 @end menu
266
267 @node Introduction
268 @chapter Introduction
269
270 `GnuPG Made Easy' (@acronym{GPGME}) is a C language library that
271 allows to add support for cryptography to a program.  It is designed
272 to make access to public key crypto engines like GnuPG or GpgSM easier
273 for applications.  @acronym{GPGME} provides a high-level crypto API
274 for encryption, decryption, signing, signature verification and key
275 management.
276
277 @acronym{GPGME} uses GnuPG and GpgSM as its backends to support
278 OpenPGP and the Cryptographic Message Syntax (CMS).
279
280 @menu
281 * Getting Started::               Purpose of the manual, and how to use it.
282 * Features::                      Reasons to install and use @acronym{GPGME}.
283 * Overview::                      Basic architecture of the @acronym{GPGME} library.
284 @end menu
285
286
287 @node Getting Started
288 @section Getting Started
289
290 This manual documents the @acronym{GPGME} library programming
291 interface.  All functions and data types provided by the library are
292 explained.
293
294 The reader is assumed to possess basic knowledge about cryptography in
295 general, and public key cryptography in particular.  The underlying
296 cryptographic engines that are used by the library are not explained,
297 but where necessary, special features or requirements by an engine are
298 mentioned as far as they are relevant to @acronym{GPGME} or its users.
299
300 This manual can be used in several ways.  If read from the beginning
301 to the end, it gives a good introduction into the library and how it
302 can be used in an application.  Forward references are included where
303 necessary.  Later on, the manual can be used as a reference manual to
304 get just the information needed about any particular interface of the
305 library.  Experienced programmers might want to start looking at the
306 examples at the end of the manual, and then only read up those parts
307 of the interface which are unclear.
308
309 The documentation for the language bindings is currently not included
310 in this manual.  Those languages bindings follow the general
311 programming model of @acronym{GPGME} but may provide some extra high
312 level abstraction on top of the @acronym{GPGME} style API.  For now
313 please see the README files in the @file{lang/} directory of the
314 source distribution.
315
316
317 @node Features
318 @section Features
319
320 @acronym{GPGME} has a couple of advantages over other libraries doing
321 a similar job, and over implementing support for GnuPG or other crypto
322 engines into your application directly.
323
324 @table @asis
325 @item it's free software
326 Anybody can use, modify, and redistribute it under the terms of the GNU
327 Lesser General Public License (@pxref{Library Copying}).
328
329 @item it's flexible
330 @acronym{GPGME} provides transparent support for several cryptographic
331 protocols by different engines.  Currently, @acronym{GPGME} supports
332 the OpenPGP protocol using GnuPG as the backend, and the Cryptographic
333 Message Syntax using GpgSM as the backend.
334
335 @item it's easy
336 @acronym{GPGME} hides the differences between the protocols and
337 engines from the programmer behind an easy-to-use interface.  This way
338 the programmer can focus on the other parts of the program, and still
339 integrate strong cryptography in his application.  Once support for
340 @acronym{GPGME} has been added to a program, it is easy to add support
341 for other crypto protocols once @acronym{GPGME} backends provide them.
342
343 @item it's language friendly
344 @acronym{GPGME} comes with languages bindings for several common
345 programming languages: Common Lisp, C++, Python 2, and Python 3.
346 @end table
347
348 @node Overview
349 @section Overview
350
351 @acronym{GPGME} provides a data abstraction that is used to pass data
352 to the crypto engine, and receive returned data from it.  Data can be
353 read from memory or from files, but it can also be provided by a
354 callback function.
355
356 The actual cryptographic operations are always set within a context.
357 A context provides configuration parameters that define the behaviour
358 of all operations performed within it.  Only one operation per context
359 is allowed at any time, but when one operation is finished, you can
360 run the next operation in the same context.  There can be more than
361 one context, and all can run different operations at the same time.
362
363 Furthermore, @acronym{GPGME} has rich key management facilities
364 including listing keys, querying their attributes, generating,
365 importing, exporting and deleting keys, and acquiring information
366 about the trust path.
367
368 With some precautions, @acronym{GPGME} can be used in a multi-threaded
369 environment, although it is not completely thread safe and thus needs
370 the support of the application.
371
372
373 @node Preparation
374 @chapter Preparation
375
376 To use @acronym{GPGME}, you have to perform some changes to your
377 sources and the build system.  The necessary changes are small and
378 explained in the following sections.  At the end of this chapter, it
379 is described how the library is initialized, and how the requirements
380 of the library are verified.
381
382 @menu
383 * Header::                        What header file you need to include.
384 * Building the Source::           Compiler options to be used.
385 * Largefile Support (LFS)::       How to use @acronym{GPGME} with LFS.
386 * Using Automake::                Compiler options to be used the easy way.
387 * Using Libtool::                 Avoiding compiler options entirely.
388 * Library Version Check::         Getting and verifying the library version.
389 * Signal Handling::               How @acronym{GPGME} affects signal handling.
390 * Multi-Threading::               How @acronym{GPGME} can be used in an MT environment.
391 @end menu
392
393
394 @node Header
395 @section Header
396 @cindex header file
397 @cindex include file
398
399 All interfaces (data types and functions) of the library are defined
400 in the header file `gpgme.h'.  You must include this in all programs
401 using the library, either directly or through some other header file,
402 like this:
403
404 @example
405 #include <gpgme.h>
406 @end example
407
408 The name space of @acronym{GPGME} is @code{gpgme_*} for function names
409 and data types and @code{GPGME_*} for other symbols.  Symbols internal
410 to @acronym{GPGME} take the form @code{_gpgme_*} and @code{_GPGME_*}.
411
412 Because @acronym{GPGME} makes use of the GPG Error library, using
413 @acronym{GPGME} will also use the @code{GPG_ERR_*} name space
414 directly, and the @code{gpg_err*}, @code{gpg_str*}, and @code{gpgrt_*}
415 name space indirectly.
416
417
418 @node Building the Source
419 @section Building the Source
420 @cindex compiler options
421 @cindex compiler flags
422
423 If you want to compile a source file including the `gpgme.h' header
424 file, you must make sure that the compiler can find it in the
425 directory hierarchy.  This is accomplished by adding the path to the
426 directory in which the header file is located to the compilers include
427 file search path (via the @option{-I} option).
428
429 However, the path to the include file is determined at the time the
430 source is configured.  To solve this problem, gpgme ships with a small
431 helper program @command{gpgme-config} that knows about the path to the
432 include file and other configuration options.  The options that need
433 to be added to the compiler invocation at compile time are output by
434 the @option{--cflags} option to @command{gpgme-config}.  The following
435 example shows how it can be used at the command line:
436
437 @example
438 gcc -c foo.c `gpgme-config --cflags`
439 @end example
440
441 Adding the output of @samp{gpgme-config --cflags} to the compiler
442 command line will ensure that the compiler can find the
443 @acronym{GPGME} header file.
444
445 A similar problem occurs when linking the program with the library.
446 Again, the compiler has to find the library files.  For this to work,
447 the path to the library files has to be added to the library search
448 path (via the @option{-L} option).  For this, the option
449 @option{--libs} to @command{gpgme-config} can be used.  For
450 convenience, this option also outputs all other options that are
451 required to link the program with @acronym{GPGME} (in particular, the
452 @samp{-lgpgme} option).  The example shows how to link @file{foo.o}
453 with the @acronym{GPGME} library to a program @command{foo}.
454
455 @example
456 gcc -o foo foo.o `gpgme-config --libs`
457 @end example
458
459 Of course you can also combine both examples to a single command by
460 specifying both options to @command{gpgme-config}:
461
462 @example
463 gcc -o foo foo.c `gpgme-config --cflags --libs`
464 @end example
465
466 If you need to detect the installed language bindings you can use list
467 them using:
468
469 @example
470 gpgme-config --print-lang
471 @end example
472
473 or test for the availability using
474
475 @example
476 gpgme-config --have-lang=python && echo 'Bindings for Pythons available'
477 @end example
478
479
480 @node Largefile Support (LFS)
481 @section Largefile Support (LFS)
482 @cindex largefile support
483 @cindex LFS
484
485 @acronym{GPGME} is compiled with largefile support by default, if it
486 is available on the system.  This means that GPGME supports files
487 larger than two gigabyte in size, if the underlying operating system
488 can.  On some systems, largefile support is already the default.  On
489 such systems, nothing special is required.  However, some systems
490 provide only support for files up to two gigabyte in size by default.
491 Support for larger file sizes has to be specifically enabled.
492
493 To make a difficult situation even more complex, such systems provide
494 two different types of largefile support.  You can either get all
495 relevant functions replaced with alternatives that are largefile
496 capable, or you can get new functions and data types for largefile
497 support added.  Those new functions have the same name as their
498 smallfile counterparts, but with a suffix of 64.
499
500 An example: The data type @code{off_t} is 32 bit wide on GNU/Linux PC
501 systems.  To address offsets in large files, you can either enable
502 largefile support add-on.  Then a new data type @code{off64_t} is
503 provided, which is 64 bit wide.  Or you can replace the existing
504 @code{off_t} data type with its 64 bit wide counterpart.  All
505 occurrences of @code{off_t} are then automagically replaced.
506
507 As if matters were not complex enough, there are also two different
508 types of file descriptors in such systems.  This is important because
509 if file descriptors are exchanged between programs that use a
510 different maximum file size, certain errors must be produced on some
511 file descriptors to prevent subtle overflow bugs from occurring.
512
513 As you can see, supporting two different maximum file sizes at the
514 same time is not at all an easy task.  However, the maximum file size
515 does matter for @acronym{GPGME}, because some data types it uses in
516 its interfaces are affected by that.  For example, the @code{off_t}
517 data type is used in the @code{gpgme_data_seek} function, to match its
518 @acronym{POSIX} counterpart.  This affects the call-frame of the
519 function, and thus the ABI of the library.  Furthermore, file
520 descriptors can be exchanged between GPGME and the application.
521
522 For you as the user of the library, this means that your program must
523 be compiled in the same file size mode as the library.  Luckily, there
524 is absolutely no valid reason for new programs to not enable largefile
525 support by default and just use that.  The compatibility modes (small
526 file sizes or dual mode) can be considered an historic artefact, only
527 useful to allow for a transitional period.
528
529 On POSIX platforms @acronym{GPGME} is compiled using largefile support
530 by default.  This means that your application must do the same, at
531 least as far as it is relevant for using the @file{gpgme.h} header
532 file.  All types in this header files refer to their largefile
533 counterparts, if they are different from any default types on the
534 system.
535
536 On 32 and 64 bit Windows platforms @code{off_t} is declared as 32 bit
537 signed integer.  There is no specific support for LFS in the C
538 library.  The recommendation from Microsoft is to use the native
539 interface (@code{CreateFile} et al.) for large files.  Released binary
540 versions of @acronym{GPGME} (libgpgme-11.dll) have always been build
541 with a 32 bit @code{off_t}.  To avoid an ABI break we stick to this
542 convention for 32 bit Windows by using @code{long} there.
543 @acronym{GPGME} versions for 64 bit Windows have never been released
544 and thus we are able to use @code{int64_t} instead of @code{off_t}
545 there.  For easier migration the typedef @code{gpgme_off_t} has been
546 defined.  The reason we cannot use @code{off_t} directly is that some
547 toolchains (e.g. mingw64) introduce a POSIX compatible hack for
548 @code{off_t}.  Some widely used toolkits make use of this hack and in
549 turn @acronym{GPGME} would need to use it also.  However, this would
550 introduce an ABI break and existing software making use of libgpgme
551 might suffer from a severe break.  Thus with version 1.4.2 we
552 redefined all functions using @code{off_t} to use @code{gpgme_off_t}
553 which is defined as explained above.  This way we keep the ABI well
554 defined and independent of any toolchain hacks.  The bottom line is
555 that LFS support in @acronym{GPGME} is only available on 64 bit
556 versions of Windows.
557
558 On POSIX platforms you can enable largefile support, if it is
559 different from the default on the system the application is compiled
560 on, by using the Autoconf macro @code{AC_SYS_LARGEFILE}.  If you do
561 this, then you don't need to worry about anything else: It will just
562 work.  In this case you might also want to use @code{AC_FUNC_FSEEKO}
563 to take advantage of some new interfaces, and @code{AC_TYPE_OFF_T}
564 (just in case).
565
566 If you do not use Autoconf, you can define the preprocessor symbol
567 @code{_FILE_OFFSET_BITS} to 64 @emph{before} including any header
568 files, for example by specifying the option
569 @code{-D_FILE_OFFSET_BITS=64} on the compiler command line.  You will
570 also want to define the preprocessor symbol @code{LARGEFILE_SOURCE} to
571 1 in this case, to take advantage of some new interfaces.
572
573 If you do not want to do either of the above, you probably know enough
574 about the issue to invent your own solution.  Just keep in mind that
575 the @acronym{GPGME} header file expects that largefile support is
576 enabled, if it is available.  In particular, we do not support dual
577 mode (@code{_LARGEFILE64_SOURCE}).
578
579
580 @node Using Automake
581 @section Using Automake
582 @cindex automake
583 @cindex autoconf
584
585 It is much easier if you use GNU Automake instead of writing your own
586 Makefiles.  If you do that you do not have to worry about finding and
587 invoking the @command{gpgme-config} script at all.  @acronym{GPGME}
588 provides an extension to Automake that does all the work for you.
589
590 @c A simple macro for optional variables.
591 @macro ovar{varname}
592 @r{[}@var{\varname\}@r{]}
593 @end macro
594 @defmac AM_PATH_GPGME (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
595 @defmacx AM_PATH_GPGME_PTH (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
596 @defmacx AM_PATH_GPGME_PTHREAD (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
597 Check whether @acronym{GPGME} (at least version @var{minimum-version},
598 if given) exists on the host system.  If it is found, execute
599 @var{action-if-found}, otherwise do @var{action-if-not-found}, if
600 given.
601
602 Additionally, the function defines @code{GPGME_CFLAGS} to the flags
603 needed for compilation of the program to find the @file{gpgme.h}
604 header file, and @code{GPGME_LIBS} to the linker flags needed to link
605 the program to the @acronym{GPGME} library.  If the used helper script
606 does not match the target type you are building for a warning is
607 printed and the string @code{libgcrypt} is appended to the variable
608 @code{gpg_config_script_warn}.
609
610 @code{AM_PATH_GPGME_PTH} checks for the version of @acronym{GPGME}
611 that can be used with GNU Pth, and defines @code{GPGME_PTH_CFLAGS} and
612 @code{GPGME_PTH_LIBS}.
613
614 @code{AM_PATH_GPGME_PTHREAD} checks for the version of @acronym{GPGME}
615 that can be used with the native pthread implementation, and defines
616 @code{GPGME_PTHREAD_CFLAGS} and @code{GPGME_PTHREAD_LIBS}. Since
617 version 1.8.0 this is no longer required to GPGME_PTHREAD as
618 @acronym{GPGME} itself is thread safe.
619
620 This macro searches for @command{gpgme-config} along the PATH.  If
621 you are cross-compiling, it is useful to set the environment variable
622 @code{SYSROOT} to the top directory of your target.  The macro will
623 then first look for the helper program in the @file{bin} directory
624 below that top directory.  An absolute directory name must be used for
625 @code{SYSROOT}.  Finally, if the configure command line option
626 @code{--with-gpgme-prefix} is used, only its value is used for the top
627 directory below which the helper script is expected.
628
629 @end defmac
630
631 You can use the defined Autoconf variables like this in your
632 @file{Makefile.am}:
633
634 @example
635 AM_CPPFLAGS = $(GPGME_CFLAGS)
636 LDADD = $(GPGME_LIBS)
637 @end example
638
639
640 @node Using Libtool
641 @section Using Libtool
642 @cindex libtool
643
644 The easiest way is to just use GNU Libtool.  If you use libtool, and
645 link to @code{libgpgme.la}, @code{libgpgme-pth.la} or
646 @code{libgpgme-pthread.la} respectively, everything will be done
647 automatically by Libtool.
648
649
650 @node Library Version Check
651 @section Library Version Check
652 @cindex version check, of the library
653
654 @deftypefun {const char *} gpgme_check_version (@w{const char *@var{required_version}})
655 The function @code{gpgme_check_version} has four purposes.  It can be
656 used to retrieve the version number of the library.  In addition it
657 can verify that the version number is higher than a certain required
658 version number.  In either case, the function initializes some
659 sub-systems, and for this reason alone it must be invoked early in
660 your program, before you make use of the other functions in
661 @acronym{GPGME}.  The last purpose is to run selftests.
662
663 As a side effect for W32 based systems, the socket layer will get
664 initialized.
665
666
667 If @var{required_version} is @code{NULL}, the function returns a
668 pointer to a statically allocated string containing the version number
669 of the library.
670
671 If @var{required_version} is not @code{NULL}, it should point to a
672 string containing a version number, and the function checks that the
673 version of the library is at least as high as the version number
674 provided.  In this case, the function returns a pointer to a
675 statically allocated string containing the version number of the
676 library.  If @var{REQUIRED_VERSION} is not a valid version number, or
677 if the version requirement is not met, the function returns
678 @code{NULL}.
679
680 If you use a version of a library that is backwards compatible with
681 older releases, but contains additional interfaces which your program
682 uses, this function provides a run-time check if the necessary
683 features are provided by the installed version of the library.
684
685 If a selftest fails, the function may still succeed.  Selftest errors
686 are returned later when invoking @code{gpgme_new} or
687 @code{gpgme-data_new}, so that a detailed error code can be returned
688 (historically, @code{gpgme_check_version} does not return a detailed
689 error code).
690 @end deftypefun
691
692
693 @deftypefun {int} gpgme_set_global_flag  @
694             (@w{const char *@var{name}}, @
695             @w{const char *@var{value}})
696
697 @since{1.4.0}
698
699 On some systems it is not easy to set environment variables and thus
700 hard to use @acronym{GPGME}'s internal trace facility for debugging.
701 This function has been introduced as an alternative way to enable
702 debugging and for a couple of other rarely used tweaks.  It is
703 important to assure that only one thread accesses @acronym{GPGME}
704 functions between a call to this function and after the return from
705 the call to @code{gpgme_check_version}.
706
707 All currently supported features require that this function is called
708 as early as possible --- even before @code{gpgme_check_version}.  The
709 features are identified by the following values for @var{name}:
710
711 @table @code
712 @item debug
713 To enable debugging use the string ``debug'' for @var{name} and
714 @var{value} identical to the value used with the environment variable
715 @code{GPGME_DEBUG}.
716
717 @item disable-gpgconf
718 Using this feature with any @var{value} disables the detection of the
719 gpgconf program and thus forces GPGME to fallback into the simple
720 OpenPGP only mode.  It may be used to force the use of GnuPG-1 on
721 systems which have both GPG versions installed.  Note that in general
722 the use of @code{gpgme_set_engine_info} is a better way to select a
723 specific engine version.
724
725 @item gpgconf-name
726 @itemx gpg-name
727 Set the name of the gpgconf respective gpg binary.  The defaults are
728 @code{GNU/GnuPG/gpgconf} and @code{GNU/GnuPG/gpg}.  Under Unix the
729 leading directory part is ignored.  Under Windows the leading
730 directory part is used as the default installation directory; the
731 @code{.exe} suffix is added by GPGME.  Use forward slashed even under
732 Windows.
733
734 @item require-gnupg
735 Set the minimum version of the required GnuPG engine.  If that version
736 is not met, GPGME fails early instead of trying to use the existent
737 version.  The given version must be a string with major, minor, and
738 micro number.  Example: "2.1.0".
739
740 @item w32-inst-dir
741 On Windows GPGME needs to know its installation directory to find its
742 spawn helper.  This is in general no problem because a DLL has this
743 information.  Some applications however link statically to GPGME and
744 thus GPGME can only figure out the installation directory of this
745 application which may be wrong in certain cases.  By supplying an
746 installation directory as value to this flag, GPGME will assume that
747 that directory is the installation directory.  This flag has no effect
748 on non-Windows platforms.
749
750 @end table
751
752 This function returns @code{0} on success.  In contrast to other
753 functions the non-zero return value on failure does not convey any
754 error code.  For setting ``debug'' the only possible error cause is an
755 out of memory condition; which would exhibit itself later anyway.
756 Thus the return value may be ignored.
757 @end deftypefun
758
759
760 After initializing @acronym{GPGME}, you should set the locale
761 information to the locale required for your output terminal.  This
762 locale information is needed for example for the curses and Gtk
763 pinentry.  Here is an example of a complete initialization:
764
765 @example
766 #include <locale.h>
767 #include <gpgme.h>
768
769 void
770 init_gpgme (void)
771 @{
772   /* Initialize the locale environment.  */
773   setlocale (LC_ALL, "");
774   gpgme_check_version (NULL);
775   gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
776 #ifdef LC_MESSAGES
777   gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
778 #endif
779 @}
780 @end example
781
782 Note that you are highly recommended to initialize the locale settings
783 like this.  @acronym{GPGME} can not do this for you because it would
784 not be thread safe.  The conditional on LC_MESSAGES is only necessary
785 for portability to W32 systems.
786
787
788 @node Signal Handling
789 @section Signal Handling
790 @cindex signals
791 @cindex signal handling
792
793 The @acronym{GPGME} library communicates with child processes (the
794 crypto engines).  If a child process dies unexpectedly, for example
795 due to a bug, or system problem, a @code{SIGPIPE} signal will be
796 delivered to the application.  The default action is to abort the
797 program.  To protect against this, @code{gpgme_check_version} sets the
798 @code{SIGPIPE} signal action to @code{SIG_IGN}, which means that the
799 signal will be ignored.
800
801 @acronym{GPGME} will only do that if the signal action for
802 @code{SIGPIPE} is @code{SIG_DEF} at the time
803 @code{gpgme_check_version} is called.  If it is something different,
804 @code{GPGME} will take no action.
805
806 This means that if your application does not install any signal
807 handler for @code{SIGPIPE}, you don't need to take any precautions.
808 If you do install a signal handler for @code{SIGPIPE}, you must be
809 prepared to handle any @code{SIGPIPE} events that occur due to
810 @acronym{GPGME} writing to a defunct pipe.  Furthermore, if your
811 application is multi-threaded, and you install a signal action for
812 @code{SIGPIPE}, you must make sure you do this either before
813 @code{gpgme_check_version} is called or afterwards.
814
815
816 @node Multi-Threading
817 @section Multi-Threading
818 @cindex thread-safeness
819 @cindex multi-threading
820
821 The @acronym{GPGME} library is mostly thread-safe, and can be used
822 in a multi-threaded environment but there are some requirements
823 for multi-threaded use:
824
825 @itemize @bullet
826 @item
827 The function @code{gpgme_check_version} must be called before any
828 other function in the library, because it initializes the thread
829 support subsystem in @acronym{GPGME}.  To achieve this in
830 multi-threaded programs, you must synchronize the memory with respect
831 to other threads that also want to use @acronym{GPGME}.  For this, it
832 is sufficient to call @code{gpgme_check_version} before creating the
833 other threads using @acronym{GPGME}@footnote{At least this is true for
834 POSIX threads, as @code{pthread_create} is a function that
835 synchronizes memory with respects to other threads.  There are many
836 functions which have this property, a complete list can be found in
837 POSIX, IEEE Std 1003.1-2003, Base Definitions, Issue 6, in the
838 definition of the term ``Memory Synchronization''.  For other thread
839 packages other, more relaxed or more strict rules may apply.}.
840
841 @item
842 Any @code{gpgme_data_t} and @code{gpgme_ctx_t} object must only be
843 accessed by one thread at a time.  If multiple threads want to deal
844 with the same object, the caller has to make sure that operations on
845 that object are fully synchronized.
846
847 @item
848 Only one thread at any time is allowed to call @code{gpgme_wait}.  If
849 multiple threads call this function, the caller must make sure that
850 all invocations are fully synchronized.  It is safe to start
851 asynchronous operations while a thread is running in gpgme_wait.
852
853 @item
854 The function @code{gpgme_strerror} is not thread safe.  You have to
855 use @code{gpgme_strerror_r} instead.
856 @end itemize
857
858
859 @node Protocols and Engines
860 @chapter Protocols and Engines
861 @cindex protocol
862 @cindex engine
863 @cindex crypto engine
864 @cindex backend
865 @cindex crypto backend
866
867 @acronym{GPGME} supports several cryptographic protocols, however, it
868 does not implement them.  Rather it uses backends (also called
869 engines) which implement the protocol.  @acronym{GPGME} uses
870 inter-process communication to pass data back and forth between the
871 application and the backend, but the details of the communication
872 protocol and invocation of the backend is completely hidden by the
873 interface.  All complexity is handled by @acronym{GPGME}.  Where an
874 exchange of information between the application and the backend is
875 necessary, @acronym{GPGME} provides the necessary callback function
876 hooks and further interfaces.
877
878 @deftp {Data type} {enum gpgme_protocol_t}
879 @tindex gpgme_protocol_t
880 The @code{gpgme_protocol_t} type specifies the set of possible protocol
881 values that are supported by @acronym{GPGME}.  The following protocols
882 are supported:
883
884 @table @code
885 @item GPGME_PROTOCOL_OpenPGP
886 @itemx GPGME_PROTOCOL_OPENPGP
887 This specifies the OpenPGP protocol.
888
889 @item GPGME_PROTOCOL_CMS
890 This specifies the Cryptographic Message Syntax.
891
892 @item GPGME_PROTOCOL_GPGCONF
893 Under development.  Please ask on @email{gnupg-devel@@gnupg.org} for help.
894
895 @item GPGME_PROTOCOL_ASSUAN
896 @since{1.2.0}
897
898 This specifies the raw Assuan protocol.
899
900 @item GPGME_PROTOCOL_G13
901 @since{1.3.0}
902
903 Under development.  Please ask on @email{gnupg-devel@@gnupg.org} for help.
904
905 @item GPGME_PROTOCOL_UISERVER
906 Under development.  Please ask on @email{gnupg-devel@@gnupg.org} for help.
907
908 @item GPGME_PROTOCOL_SPAWN
909 @since{1.5.0}
910
911 Special protocol for use with @code{gpgme_op_spawn}.
912
913 @item GPGME_PROTOCOL_UNKNOWN
914 Reserved for future extension.  You may use this to indicate that the
915 used protocol is not known to the application.  Currently,
916 @acronym{GPGME} does not accept this value in any operation, though,
917 except for @code{gpgme_get_protocol_name}.
918 @end table
919 @end deftp
920
921
922 @deftypefun {const char *} gpgme_get_protocol_name (@w{gpgme_protocol_t @var{protocol}})
923 The function @code{gpgme_get_protocol_name} returns a statically
924 allocated string describing the protocol @var{protocol}, or
925 @code{NULL} if the protocol number is not valid.
926 @end deftypefun
927
928 @menu
929 * Engine Version Check::          Verifying the engine version.
930 * Engine Information::            Obtaining more information about the engines.
931 * Engine Configuration::          Changing the engine configuration.
932 * OpenPGP::                       Support for the OpenPGP protocol.
933 * Cryptographic Message Syntax::  Support for the CMS.
934 * Assuan::                        Support for the raw Assuan protocol.
935 @end menu
936
937
938 @node Engine Version Check
939 @section Engine Version Check
940 @cindex version check, of the engines
941
942 @deftypefun @w{const char *} gpgme_get_dirinfo (@w{cons char *@var{what}})
943 @since{1.5.0}
944
945 The function @code{gpgme_get_dirinfo} returns a statically allocated
946 string with the value associated to @var{what}.  The returned values
947 are the defaults and won't change even after
948 @code{gpgme_set_engine_info} has been used to configure a different
949 engine.  @code{NULL} is returned if no value is available.  Commonly
950 supported values for @var{what} are:
951
952 @table @code
953 @item homedir
954 Return the default home directory.
955
956 @item sysconfdir
957 Return the name of the system configuration directory
958
959 @item bindir
960 Return the name of the directory with GnuPG program files.
961
962 @item libdir
963 Return the name of the directory with GnuPG related library files.
964
965 @item libexecdir
966 Return the name of the directory with GnuPG helper program files.
967
968 @item datadir
969 Return the name of the directory with GnuPG shared data.
970
971 @item localedir
972 Return the name of the directory with GnuPG locale data.
973
974 @item agent-socket
975 Return the name of the socket to connect to the gpg-agent.
976
977 @item agent-ssh-socket
978 Return the name of the socket to connect to the ssh-agent component of
979 gpg-agent.
980
981 @item dirmngr-socket
982 Return the name of the socket to connect to the dirmngr.
983
984 @item uiserver-socket
985 Return the name of the socket to connect to the user interface server.
986
987 @item gpgconf-name
988 Return the file name of the engine configuration tool.
989
990 @item gpg-name
991 Return the file name of the OpenPGP engine.
992
993 @item gpgsm-name
994 Return the file name of the CMS engine.
995
996 @item g13-name
997 Return the name of the file container encryption engine.
998
999 @item gpg-wks-client-name
1000 Return the name of the Web Key Service tool.
1001
1002 @end table
1003
1004 @end deftypefun
1005
1006
1007 @deftypefun gpgme_error_t gpgme_engine_check_version (@w{gpgme_protocol_t @var{protocol}})
1008 The function @code{gpgme_engine_check_version} verifies that the
1009 engine implementing the protocol @var{PROTOCOL} is installed in the
1010 expected path and meets the version requirement of @acronym{GPGME}.
1011
1012 This function returns the error code @code{GPG_ERR_NO_ERROR} if the
1013 engine is available and @code{GPG_ERR_INV_ENGINE} if it is not.
1014 @end deftypefun
1015
1016
1017 @node Engine Information
1018 @section Engine Information
1019 @cindex engine, information about
1020
1021 @deftp {Data type} {gpgme_engine_info_t}
1022 @tindex gpgme_protocol_t
1023 The @code{gpgme_engine_info_t} type specifies a pointer to a structure
1024 describing a crypto engine.  The structure contains the following
1025 elements:
1026
1027 @table @code
1028 @item gpgme_engine_info_t next
1029 This is a pointer to the next engine info structure in the linked
1030 list, or @code{NULL} if this is the last element.
1031
1032 @item gpgme_protocol_t protocol
1033 This is the protocol for which the crypto engine is used.  You can
1034 convert this to a string with @code{gpgme_get_protocol_name} for
1035 printing.
1036
1037 @item const char *file_name
1038 This is a string holding the file name of the executable of the crypto
1039 engine.  Currently, it is never @code{NULL}, but using @code{NULL} is
1040 reserved for future use, so always check before you use it.
1041
1042 @item const char *home_dir
1043 This is a string holding the directory name of the crypto engine's
1044 configuration directory.  If it is @code{NULL}, then the default
1045 directory is used.  See @code{gpgme_get_dirinfo} on how to get the
1046 default directory.
1047
1048 @item const char *version
1049 This is a string containing the version number of the crypto engine.
1050 It might be @code{NULL} if the version number can not be determined,
1051 for example because the executable doesn't exist or is invalid.
1052
1053 @item const char *req_version
1054 This is a string containing the minimum required version number of the
1055 crypto engine for @acronym{GPGME} to work correctly.  This is the
1056 version number that @code{gpgme_engine_check_version} verifies
1057 against.  Currently, it is never @code{NULL}, but using @code{NULL} is
1058 reserved for future use, so always check before you use it.
1059 @end table
1060 @end deftp
1061
1062 @deftypefun gpgme_error_t gpgme_get_engine_info (@w{gpgme_engine_info_t *@var{info}})
1063 The function @code{gpgme_get_engine_info} returns a linked list of
1064 engine info structures in @var{info}.  Each info structure describes
1065 the defaults of one configured backend.
1066
1067 The memory for the info structures is allocated the first time this
1068 function is invoked, and must not be freed by the caller.
1069
1070 This function returns the error code @code{GPG_ERR_NO_ERROR} if
1071 successful, and a system error if the memory could not be allocated.
1072 @end deftypefun
1073
1074 Here is an example how you can provide more diagnostics if you receive
1075 an error message which indicates that the crypto engine is invalid.
1076
1077 @example
1078 gpgme_ctx_t ctx;
1079 gpgme_error_t err;
1080
1081 [...]
1082
1083 if (gpgme_err_code (err) == GPG_ERR_INV_ENGINE)
1084   @{
1085     gpgme_engine_info_t info;
1086     err = gpgme_get_engine_info (&info);
1087     if (!err)
1088       @{
1089         while (info && info->protocol != gpgme_get_protocol (ctx))
1090           info = info->next;
1091         if (!info)
1092           fprintf (stderr, "GPGME compiled without support for protocol %s",
1093                    gpgme_get_protocol_name (info->protocol));
1094         else if (info->file_name && !info->version)
1095           fprintf (stderr, "Engine %s not installed properly",
1096                    info->file_name);
1097         else if (info->file_name && info->version && info->req_version)
1098           fprintf (stderr, "Engine %s version %s installed, "
1099                    "but at least version %s required", info->file_name,
1100                    info->version, info->req_version);
1101         else
1102           fprintf (stderr, "Unknown problem with engine for protocol %s",
1103                    gpgme_get_protocol_name (info->protocol));
1104       @}
1105   @}
1106 @end example
1107
1108
1109 @node Engine Configuration
1110 @section Engine Configuration
1111 @cindex engine, configuration of
1112 @cindex configuration of crypto backend
1113
1114 You can change the configuration of a backend engine, and thus change
1115 the executable program and configuration directory to be used.  You
1116 can make these changes the default or set them for some contexts
1117 individually.
1118
1119 @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}})
1120 @since{1.1.0}
1121
1122 The function @code{gpgme_set_engine_info} changes the default
1123 configuration of the crypto engine implementing the protocol
1124 @var{proto}.
1125
1126 @var{file_name} is the file name of the executable program
1127 implementing this protocol, and @var{home_dir} is the directory name
1128 of the configuration directory for this crypto engine.  If
1129 @var{home_dir} is @code{NULL}, the engine's default will be used.
1130
1131 The new defaults are not applied to already created GPGME contexts.
1132
1133 This function returns the error code @code{GPG_ERR_NO_ERROR} if
1134 successful, or an error code on failure.
1135 @end deftypefun
1136
1137 The functions @code{gpgme_ctx_get_engine_info} and
1138 @code{gpgme_ctx_set_engine_info} can be used to change the engine
1139 configuration per context.  @xref{Crypto Engine}.
1140
1141
1142 @node OpenPGP
1143 @section OpenPGP
1144 @cindex OpenPGP
1145 @cindex GnuPG
1146 @cindex protocol, GnuPG
1147 @cindex engine, GnuPG
1148
1149 OpenPGP is implemented by GnuPG, the @acronym{GNU} Privacy Guard.
1150 This is the first protocol that was supported by @acronym{GPGME}.
1151
1152 The OpenPGP protocol is specified by @code{GPGME_PROTOCOL_OpenPGP}.
1153
1154
1155 @node Cryptographic Message Syntax
1156 @section Cryptographic Message Syntax
1157 @cindex CMS
1158 @cindex cryptographic message syntax
1159 @cindex GpgSM
1160 @cindex protocol, CMS
1161 @cindex engine, GpgSM
1162 @cindex S/MIME
1163 @cindex protocol, S/MIME
1164
1165 @acronym{CMS} is implemented by GpgSM, the S/MIME implementation for
1166 GnuPG.
1167
1168 The @acronym{CMS} protocol is specified by @code{GPGME_PROTOCOL_CMS}.
1169
1170
1171 @node Assuan
1172 @section Assuan
1173 @cindex ASSUAN
1174 @cindex protocol, ASSUAN
1175 @cindex engine, ASSUAN
1176
1177 Assuan is the RPC library used by the various @acronym{GnuPG}
1178 components.  The Assuan protocol allows one to talk to arbitrary
1179 Assuan servers using @acronym{GPGME}.  @xref{Using the Assuan
1180 protocol}.
1181
1182 The ASSUAN protocol is specified by @code{GPGME_PROTOCOL_ASSUAN}.
1183
1184
1185 @node Algorithms
1186 @chapter Algorithms
1187 @cindex algorithms
1188
1189 The crypto backends support a variety of algorithms used in public key
1190 cryptography.@footnote{Some engines also provide symmetric only
1191 encryption; see the description of the encryption function on how to use
1192 this.}  The following sections list the identifiers used to denote such
1193 an algorithm.
1194
1195 @menu
1196 * Public Key Algorithms::         A list of all public key algorithms.
1197 * Hash Algorithms::               A list of all hash algorithms.
1198 @end menu
1199
1200
1201 @node Public Key Algorithms
1202 @section Public Key Algorithms
1203 @cindex algorithms, public key
1204 @cindex public key algorithms
1205
1206 Public key algorithms are used for encryption, decryption, signing and
1207 verification of signatures.
1208
1209 @deftp {Data type} {enum gpgme_pubkey_algo_t}
1210 @tindex gpgme_pubkey_algo_t
1211 The @code{gpgme_pubkey_algo_t} type specifies the set of all public key
1212 algorithms that are supported by @acronym{GPGME}.  Possible values
1213 are:
1214
1215 @table @code
1216 @item GPGME_PK_RSA
1217 This value indicates the RSA (Rivest, Shamir, Adleman) algorithm.
1218
1219 @item GPGME_PK_RSA_E
1220 Deprecated.  This value indicates the RSA (Rivest, Shamir, Adleman)
1221 algorithm for encryption and decryption only.
1222
1223 @item GPGME_PK_RSA_S
1224 Deprecated.  This value indicates the RSA (Rivest, Shamir, Adleman)
1225 algorithm for signing and verification only.
1226
1227 @item GPGME_PK_DSA
1228 This value indicates DSA, the Digital Signature Algorithm.
1229
1230 @item GPGME_PK_ELG
1231 This value indicates ElGamal.
1232
1233 @item GPGME_PK_ELG_E
1234 This value also indicates ElGamal and is used specifically in GnuPG.
1235
1236 @item GPGME_PK_ECC
1237 @since{1.5.0}
1238
1239 This value is a generic indicator for ellipic curve algorithms.
1240
1241 @item GPGME_PK_ECDSA
1242 @since{1.3.0}
1243
1244 This value indicates ECDSA, the Elliptic Curve Digital Signature
1245 Algorithm as defined by FIPS 186-2 and RFC-6637.
1246
1247 @item GPGME_PK_ECDH
1248 @since{1.3.0}
1249
1250 This value indicates ECDH, the Eliptic Curve Diffie-Hellmann
1251 encryption algorithm as defined by RFC-6637.
1252
1253 @item GPGME_PK_EDDSA
1254 @since{1.7.0}
1255
1256 This value indicates the EdDSA algorithm.
1257
1258 @end table
1259 @end deftp
1260
1261 @deftypefun {const char *} gpgme_pubkey_algo_name (@w{gpgme_pubkey_algo_t @var{algo}})
1262 The function @code{gpgme_pubkey_algo_name} returns a pointer to a
1263 statically allocated string containing a description of the public key
1264 algorithm @var{algo}.  This string can be used to output the name of
1265 the public key algorithm to the user.
1266
1267 If @var{algo} is not a valid public key algorithm, @code{NULL} is
1268 returned.
1269 @end deftypefun
1270
1271 @deftypefun {char *} gpgme_pubkey_algo_string (@w{gpgme_subkey_t @var{key}})
1272 @since{1.7.0}
1273
1274 The function @code{gpgme_pubkey_algo_string} is a convenience function
1275 to build and return an algorithm string in the same way GnuPG does
1276 (e.g. ``rsa2048'' or ``ed25519'').  The caller must free the result
1277 using @code{gpgme_free}.  On error (e.g. invalid argument or memory
1278 exhausted), the function returns NULL and sets @code{ERRNO}.
1279 @end deftypefun
1280
1281
1282 @node Hash Algorithms
1283 @section Hash Algorithms
1284 @cindex algorithms, hash
1285 @cindex algorithms, message digest
1286 @cindex hash algorithms
1287 @cindex message digest algorithms
1288
1289 Hash (message digest) algorithms are used to compress a long message
1290 to make it suitable for public key cryptography.
1291
1292 @deftp {Data type} {enum gpgme_hash_algo_t}
1293 @tindex gpgme_hash_algo_t
1294 The @code{gpgme_hash_algo_t} type specifies the set of all hash algorithms
1295 that are supported by @acronym{GPGME}.  Possible values are:
1296
1297 @table @code
1298 @item GPGME_MD_MD5
1299 @item GPGME_MD_SHA1
1300 @item GPGME_MD_RMD160
1301 @item GPGME_MD_MD2
1302 @item GPGME_MD_TIGER
1303 @item GPGME_MD_HAVAL
1304 @item GPGME_MD_SHA256
1305 @item GPGME_MD_SHA384
1306 @item GPGME_MD_SHA512
1307 @item GPGME_MD_SHA224
1308 @since{1.5.0}
1309
1310 @item GPGME_MD_MD4
1311 @item GPGME_MD_CRC32
1312 @item GPGME_MD_CRC32_RFC1510
1313 @item GPGME_MD_CRC24_RFC2440
1314 @end table
1315 @end deftp
1316
1317 @deftypefun {const char *} gpgme_hash_algo_name (@w{gpgme_hash_algo_t @var{algo}})
1318 The function @code{gpgme_hash_algo_name} returns a pointer to a
1319 statically allocated string containing a description of the hash
1320 algorithm @var{algo}.  This string can be used to output the name of
1321 the hash algorithm to the user.
1322
1323 If @var{algo} is not a valid hash algorithm, @code{NULL} is returned.
1324 @end deftypefun
1325
1326
1327 @node Error Handling
1328 @chapter Error Handling
1329 @cindex error handling
1330
1331 Many functions in @acronym{GPGME} can return an error if they fail.
1332 For this reason, the application should always catch the error
1333 condition and take appropriate measures, for example by releasing the
1334 resources and passing the error up to the caller, or by displaying a
1335 descriptive message to the user and cancelling the operation.
1336
1337 Some error values do not indicate a system error or an error in the
1338 operation, but the result of an operation that failed properly.  For
1339 example, if you try to decrypt a tempered message, the decryption will
1340 fail.  Another error value actually means that the end of a data
1341 buffer or list has been reached.  The following descriptions explain
1342 for many error codes what they mean usually.  Some error values have
1343 specific meanings if returned by a certain functions.  Such cases are
1344 described in the documentation of those functions.
1345
1346 @acronym{GPGME} uses the @code{libgpg-error} library.  This allows to
1347 share the error codes with other components of the GnuPG system, and
1348 thus pass error values transparently from the crypto engine, or some
1349 helper application of the crypto engine, to the user.  This way no
1350 information is lost.  As a consequence, @acronym{GPGME} does not use
1351 its own identifiers for error codes, but uses those provided by
1352 @code{libgpg-error}.  They usually start with @code{GPG_ERR_}.
1353
1354 However, @acronym{GPGME} does provide aliases for the functions
1355 defined in libgpg-error, which might be preferred for name space
1356 consistency.
1357
1358 @menu
1359 * Error Values::                  The error value and what it means.
1360 * Error Sources::                 A list of important error sources.
1361 * Error Codes::                   A list of important error codes.
1362 * Error Strings::                 How to get a descriptive string from a value.
1363 @end menu
1364
1365
1366 @node Error Values
1367 @section Error Values
1368 @cindex error values
1369 @cindex error codes
1370 @cindex error sources
1371
1372 @deftp {Data type} {gpgme_err_code_t}
1373 The @code{gpgme_err_code_t} type is an alias for the @code{libgpg-error}
1374 type @code{gpg_err_code_t}.  The error code indicates the type of an
1375 error, or the reason why an operation failed.
1376
1377 A list of important error codes can be found in the next section.
1378 @end deftp
1379
1380 @deftp {Data type} {gpgme_err_source_t}
1381 The @code{gpgme_err_source_t} type is an alias for the
1382 @code{libgpg-error} type @code{gpg_err_source_t}.  The error source
1383 has not a precisely defined meaning.  Sometimes it is the place where
1384 the error happened, sometimes it is the place where an error was
1385 encoded into an error value.  Usually the error source will give an
1386 indication to where to look for the problem.  This is not always true,
1387 but it is attempted to achieve this goal.
1388
1389 A list of important error sources can be found in the next section.
1390 @end deftp
1391
1392 @deftp {Data type} {gpgme_error_t}
1393 The @code{gpgme_error_t} type is an alias for the @code{libgpg-error}
1394 type @code{gpg_error_t}.  An error value like this has always two
1395 components, an error code and an error source.  Both together form the
1396 error value.
1397
1398 Thus, the error value can not be directly compared against an error
1399 code, but the accessor functions described below must be used.
1400 However, it is guaranteed that only 0 is used to indicate success
1401 (@code{GPG_ERR_NO_ERROR}), and that in this case all other parts of
1402 the error value are set to 0, too.
1403
1404 Note that in @acronym{GPGME}, the error source is used purely for
1405 diagnostical purposes.  Only the error code should be checked to test
1406 for a certain outcome of a function.  The manual only documents the
1407 error code part of an error value.  The error source is left
1408 unspecified and might be anything.
1409 @end deftp
1410
1411 @deftypefun {static inline gpgme_err_code_t} gpgme_err_code (@w{gpgme_error_t @var{err}})
1412 The static inline function @code{gpgme_err_code} returns the
1413 @code{gpgme_err_code_t} component of the error value @var{err}.  This
1414 function must be used to extract the error code from an error value in
1415 order to compare it with the @code{GPG_ERR_*} error code macros.
1416 @end deftypefun
1417
1418 @deftypefun {static inline gpgme_err_source_t} gpgme_err_source (@w{gpgme_error_t @var{err}})
1419 The static inline function @code{gpgme_err_source} returns the
1420 @code{gpgme_err_source_t} component of the error value @var{err}.  This
1421 function must be used to extract the error source from an error value in
1422 order to compare it with the @code{GPG_ERR_SOURCE_*} error source macros.
1423 @end deftypefun
1424
1425 @deftypefun {static inline gpgme_error_t} gpgme_err_make (@w{gpgme_err_source_t @var{source}}, @w{gpgme_err_code_t @var{code}})
1426 The static inline function @code{gpgme_err_make} returns the error
1427 value consisting of the error source @var{source} and the error code
1428 @var{code}.
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 @deftypefun {static inline gpgme_error_t} gpgme_error (@w{gpgme_err_code_t @var{code}})
1435 The static inline function @code{gpgme_error} returns the error value
1436 consisting of the default error source and the error code @var{code}.
1437
1438 For @acronym{GPGME} applications, the default error source is
1439 @code{GPG_ERR_SOURCE_USER_1}.  You can define
1440 @code{GPGME_ERR_SOURCE_DEFAULT} before including @file{gpgme.h} to
1441 change this default.
1442
1443 This function can be used in callback functions to construct an error
1444 value to return it to the library.
1445 @end deftypefun
1446
1447 The @code{libgpg-error} library provides error codes for all system
1448 error numbers it knows about.  If @var{err} is an unknown error
1449 number, the error code @code{GPG_ERR_UNKNOWN_ERRNO} is used.  The
1450 following functions can be used to construct error values from system
1451 errnor numbers.
1452
1453 @deftypefun {gpgme_error_t} gpgme_err_make_from_errno (@w{gpgme_err_source_t @var{source}}, @w{int @var{err}})
1454 The function @code{gpgme_err_make_from_errno} is like
1455 @code{gpgme_err_make}, but it takes a system error like @code{errno}
1456 instead of a @code{gpgme_err_code_t} error code.
1457 @end deftypefun
1458
1459 @deftypefun {gpgme_error_t} gpgme_error_from_errno (@w{int @var{err}})
1460 The function @code{gpgme_error_from_errno} is like @code{gpgme_error},
1461 but it takes a system error like @code{errno} instead of a
1462 @code{gpgme_err_code_t} error code.
1463 @end deftypefun
1464
1465 Sometimes you might want to map system error numbers to error codes
1466 directly, or map an error code representing a system error back to the
1467 system error number.  The following functions can be used to do that.
1468
1469 @deftypefun {gpgme_err_code_t} gpgme_err_code_from_errno (@w{int @var{err}})
1470 The function @code{gpgme_err_code_from_errno} returns the error code
1471 for the system error @var{err}.  If @var{err} is not a known system
1472 error, the function returns @code{GPG_ERR_UNKNOWN_ERRNO}.
1473 @end deftypefun
1474
1475 @deftypefun {int} gpgme_err_code_to_errno (@w{gpgme_err_code_t @var{err}})
1476 The function @code{gpgme_err_code_to_errno} returns the system error
1477 for the error code @var{err}.  If @var{err} is not an error code
1478 representing a system error, or if this system error is not defined on
1479 this system, the function returns @code{0}.
1480 @end deftypefun
1481
1482
1483 @node Error Sources
1484 @section Error Sources
1485 @cindex error codes, list of
1486
1487 The library @code{libgpg-error} defines an error source for every
1488 component of the GnuPG system.  The error source part of an error
1489 value is not well defined.  As such it is mainly useful to improve the
1490 diagnostic error message for the user.
1491
1492 If the error code part of an error value is @code{0}, the whole error
1493 value will be @code{0}.  In this case the error source part is of
1494 course @code{GPG_ERR_SOURCE_UNKNOWN}.
1495
1496 The list of error sources that might occur in applications using
1497 @acronym{GPGME} is:
1498
1499 @table @code
1500 @item GPG_ERR_SOURCE_UNKNOWN
1501 The error source is not known.  The value of this error source is
1502 @code{0}.
1503
1504 @item GPG_ERR_SOURCE_GPGME
1505 The error source is @acronym{GPGME} itself.  This is the default for
1506 errors that occur in the @acronym{GPGME} library.
1507
1508 @item GPG_ERR_SOURCE_GPG
1509 The error source is GnuPG, which is the crypto engine used for the
1510 OpenPGP protocol.
1511
1512 @item GPG_ERR_SOURCE_GPGSM
1513 The error source is GPGSM, which is the crypto engine used for the
1514 CMS protocol.
1515
1516 @item GPG_ERR_SOURCE_GCRYPT
1517 The error source is @code{libgcrypt}, which is used by crypto engines
1518 to perform cryptographic operations.
1519
1520 @item GPG_ERR_SOURCE_GPGAGENT
1521 The error source is @command{gpg-agent}, which is used by crypto
1522 engines to perform operations with the secret key.
1523
1524 @item GPG_ERR_SOURCE_PINENTRY
1525 The error source is @command{pinentry}, which is used by
1526 @command{gpg-agent} to query the passphrase to unlock a secret key.
1527
1528 @item GPG_ERR_SOURCE_SCD
1529 The error source is the SmartCard Daemon, which is used by
1530 @command{gpg-agent} to delegate operations with the secret key to a
1531 SmartCard.
1532
1533 @item GPG_ERR_SOURCE_KEYBOX
1534 The error source is @code{libkbx}, a library used by the crypto
1535 engines to manage local keyrings.
1536
1537 @item GPG_ERR_SOURCE_USER_1
1538 @item GPG_ERR_SOURCE_USER_2
1539 @item GPG_ERR_SOURCE_USER_3
1540 @item GPG_ERR_SOURCE_USER_4
1541 These error sources are not used by any GnuPG component and can be
1542 used by other software.  For example, applications using
1543 @acronym{GPGME} can use them to mark error values coming from callback
1544 handlers.  Thus @code{GPG_ERR_SOURCE_USER_1} is the default for errors
1545 created with @code{gpgme_error} and @code{gpgme_error_from_errno},
1546 unless you define @code{GPGME_ERR_SOURCE_DEFAULT} before including
1547 @file{gpgme.h}.
1548 @end table
1549
1550
1551 @node Error Codes
1552 @section Error Codes
1553 @cindex error codes, list of
1554
1555 The library @code{libgpg-error} defines many error values.  Most of
1556 them are not used by @code{GPGME} directly, but might be returned by
1557 @acronym{GPGME} because it received them from the crypto engine.  The
1558 below list only includes such error codes that have a specific meaning
1559 in @code{GPGME}, or which are so common that you should know about
1560 them.
1561
1562 @table @code
1563 @item GPG_ERR_EOF
1564 This value indicates the end of a list, buffer or file.
1565
1566 @item GPG_ERR_NO_ERROR
1567 This value indicates success.  The value of this error code is
1568 @code{0}.  Also, it is guaranteed that an error value made from the
1569 error code @code{0} will be @code{0} itself (as a whole).  This means
1570 that the error source information is lost for this error code,
1571 however, as this error code indicates that no error occurred, this is
1572 generally not a problem.
1573
1574 @item GPG_ERR_GENERAL
1575 This value means that something went wrong, but either there is not
1576 enough information about the problem to return a more useful error
1577 value, or there is no separate error value for this type of problem.
1578
1579 @item GPG_ERR_ENOMEM
1580 This value means that an out-of-memory condition occurred.
1581
1582 @item GPG_ERR_E...
1583 System errors are mapped to GPG_ERR_FOO where FOO is the symbol for
1584 the system error.
1585
1586 @item GPG_ERR_INV_VALUE
1587 This value means that some user provided data was out of range.  This
1588 can also refer to objects.  For example, if an empty
1589 @code{gpgme_data_t} object was expected, but one containing data was
1590 provided, this error value is returned.
1591
1592 @item GPG_ERR_UNUSABLE_PUBKEY
1593 This value means that some recipients for a message were invalid.
1594
1595 @item GPG_ERR_UNUSABLE_SECKEY
1596 This value means that some signers were invalid.
1597
1598 @item GPG_ERR_NO_DATA
1599 This value means that a @code{gpgme_data_t} object which was expected
1600 to have content was found empty.
1601
1602 @item GPG_ERR_CONFLICT
1603 This value means that a conflict of some sort occurred.
1604
1605 @item GPG_ERR_NOT_IMPLEMENTED
1606 This value indicates that the specific function (or operation) is not
1607 implemented.  This error should never happen.  It can only occur if
1608 you use certain values or configuration options which do not work,
1609 but for which we think that they should work at some later time.
1610
1611 @item GPG_ERR_DECRYPT_FAILED
1612 This value indicates that a decryption operation was unsuccessful.
1613
1614 @item GPG_ERR_BAD_PASSPHRASE
1615 This value means that the user did not provide a correct passphrase
1616 when requested.
1617
1618 @item GPG_ERR_CANCELED
1619 This value means that the operation was canceled.
1620
1621 @item GPG_ERR_INV_ENGINE
1622 This value means that the engine that implements the desired protocol
1623 is currently not available.  This can either be because the sources
1624 were configured to exclude support for this engine, or because the
1625 engine is not installed properly.
1626
1627 @item GPG_ERR_AMBIGUOUS_NAME
1628 This value indicates that a user ID or other specifier did not specify
1629 a unique key.
1630
1631 @item GPG_ERR_WRONG_KEY_USAGE
1632 This value indicates that a key is not used appropriately.
1633
1634 @item GPG_ERR_CERT_REVOKED
1635 This value indicates that a key signature was revoced.
1636
1637 @item GPG_ERR_CERT_EXPIRED
1638 This value indicates that a key signature expired.
1639
1640 @item GPG_ERR_NO_CRL_KNOWN
1641 This value indicates that no certificate revocation list is known for
1642 the certificate.
1643
1644 @item GPG_ERR_NO_POLICY_MATCH
1645 This value indicates that a policy issue occurred.
1646
1647 @item GPG_ERR_NO_SECKEY
1648 This value indicates that no secret key for the user ID is available.
1649
1650 @item GPG_ERR_MISSING_CERT
1651 This value indicates that a key could not be imported because the
1652 issuer certificate is missing.
1653
1654 @item GPG_ERR_BAD_CERT_CHAIN
1655 This value indicates that a key could not be imported because its
1656 certificate chain is not good, for example it could be too long.
1657
1658 @item GPG_ERR_UNSUPPORTED_ALGORITHM
1659 This value means a verification failed because the cryptographic
1660 algorithm is not supported by the crypto backend.
1661
1662 @item GPG_ERR_BAD_SIGNATURE
1663 This value means a verification failed because the signature is bad.
1664
1665 @item GPG_ERR_NO_PUBKEY
1666 This value means a verification failed because the public key is not
1667 available.
1668
1669 @item GPG_ERR_USER_1
1670 @item GPG_ERR_USER_2
1671 @item ...
1672 @item GPG_ERR_USER_16
1673 These error codes are not used by any GnuPG component and can be
1674 freely used by other software.  Applications using @acronym{GPGME}
1675 might use them to mark specific errors returned by callback handlers
1676 if no suitable error codes (including the system errors) for
1677 these errors exist already.
1678 @end table
1679
1680
1681 @node Error Strings
1682 @section Error Strings
1683 @cindex error values, printing of
1684 @cindex error codes, printing of
1685 @cindex error sources, printing of
1686 @cindex error strings
1687
1688 @deftypefun {const char *} gpgme_strerror (@w{gpgme_error_t @var{err}})
1689 The function @code{gpgme_strerror} returns a pointer to a statically
1690 allocated string containing a description of the error code contained
1691 in the error value @var{err}.  This string can be used to output a
1692 diagnostic message to the user.
1693
1694 This function is not thread safe.  Use @code{gpgme_strerror_r} in
1695 multi-threaded programs.
1696 @end deftypefun
1697
1698
1699 @deftypefun {int} gpgme_strerror_r (@w{gpgme_error_t @var{err}}, @w{char *@var{buf}}, @w{size_t @var{buflen}})
1700 The function @code{gpgme_strerror_r} returns the error string for
1701 @var{err} in the user-supplied buffer @var{buf} of size @var{buflen}.
1702 This function is, in contrast to @code{gpgme_strerror}, thread-safe if
1703 a thread-safe @code{strerror_r} function is provided by the system.
1704 If the function succeeds, 0 is returned and @var{buf} contains the
1705 string describing the error.  If the buffer was not large enough,
1706 ERANGE is returned and @var{buf} contains as much of the beginning of
1707 the error string as fits into the buffer.
1708 @end deftypefun
1709
1710
1711 @deftypefun {const char *} gpgme_strsource (@w{gpgme_error_t @var{err}})
1712 The function @code{gpgme_strerror} returns a pointer to a statically
1713 allocated string containing a description of the error source
1714 contained in the error value @var{err}.  This string can be used to
1715 output a diagnostic message to the user.
1716 @end deftypefun
1717
1718 The following example illustrates the use of @code{gpgme_strerror}:
1719
1720 @example
1721 gpgme_ctx_t ctx;
1722 gpgme_error_t err = gpgme_new (&ctx);
1723 if (err)
1724   @{
1725     fprintf (stderr, "%s: creating GpgME context failed: %s: %s\n",
1726              argv[0], gpgme_strsource (err), gpgme_strerror (err));
1727     exit (1);
1728   @}
1729 @end example
1730
1731
1732 @node Exchanging Data
1733 @chapter Exchanging Data
1734 @cindex data, exchanging
1735
1736 A lot of data has to be exchanged between the user and the crypto
1737 engine, like plaintext messages, ciphertext, signatures and
1738 information about the keys.  The technical details about exchanging
1739 the data information are completely abstracted by @acronym{GPGME}.
1740 The user provides and receives the data via @code{gpgme_data_t} objects,
1741 regardless of the communication protocol between @acronym{GPGME} and
1742 the crypto engine in use.
1743
1744 @deftp {Data type} {gpgme_data_t}
1745 The @code{gpgme_data_t} type is a handle for a container for generic
1746 data, which is used by @acronym{GPGME} to exchange data with the user.
1747 @end deftp
1748
1749 @code{gpgme_data_t} objects do not provide notifications on events.
1750 It is assumed that read and write operations are blocking until data
1751 is available.  If this is undesirable, the application must ensure
1752 that all GPGME data operations always have data available, for example
1753 by using memory buffers or files rather than pipes or sockets.  This
1754 might be relevant, for example, if the external event loop mechanism
1755 is used.
1756
1757 @deftp {Data type} {gpgme_off_t}
1758 @since{1.4.1}
1759
1760 On POSIX platforms the @code{gpgme_off_t} type is an alias for
1761 @code{off_t}; it may be used interchangeable.  On Windows platforms
1762 @code{gpgme_off_t} is defined as a long (i.e. 32 bit) for 32 bit
1763 Windows and as a 64 bit signed integer for 64 bit Windows.
1764 @end deftp
1765
1766 @deftp {Data type} {gpgme_ssize_t}
1767 The @code{gpgme_ssize_t} type is an alias for @code{ssize_t}.  It has
1768 only been introduced to overcome portability problems pertaining to
1769 the declaration of @code{ssize_t} by different toolchains.
1770 @end deftp
1771
1772
1773 @menu
1774 * Creating Data Buffers::         Creating new data buffers.
1775 * Destroying Data Buffers::       Releasing data buffers.
1776 * Manipulating Data Buffers::     Operations on data buffers.
1777 @end menu
1778
1779
1780 @node Creating Data Buffers
1781 @section Creating Data Buffers
1782 @cindex data buffer, creation
1783
1784 Data objects can be based on memory, files, or callback functions
1785 provided by the user.  Not all operations are supported by all
1786 objects.
1787
1788
1789 @menu
1790 * Memory Based Data Buffers::     Creating memory based data buffers.
1791 * File Based Data Buffers::       Creating file based data buffers.
1792 * Callback Based Data Buffers::   Creating callback based data buffers.
1793 @end menu
1794
1795
1796 @node Memory Based Data Buffers
1797 @subsection Memory Based Data Buffers
1798
1799 Memory based data objects store all data in allocated memory.  This is
1800 convenient, but only practical for an amount of data that is a
1801 fraction of the available physical memory.  The data has to be copied
1802 from its source and to its destination, which can often be avoided by
1803 using one of the other data object
1804
1805 @deftypefun gpgme_error_t gpgme_data_new (@w{gpgme_data_t *@var{dh}})
1806 The function @code{gpgme_data_new} creates a new @code{gpgme_data_t}
1807 object and returns a handle for it in @var{dh}.  The data object is
1808 memory based and initially empty.
1809
1810 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1811 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1812 @var{dh} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if not
1813 enough memory is available.
1814 @end deftypefun
1815
1816 @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}})
1817 The function @code{gpgme_data_new_from_mem} creates a new
1818 @code{gpgme_data_t} object and fills it with @var{size} bytes starting
1819 from @var{buffer}.
1820
1821 If @var{copy} is not zero, a private copy of the data is made.  If
1822 @var{copy} is zero, the data is taken from the specified buffer as
1823 needed, and the user has to ensure that the buffer remains valid for
1824 the whole life span of the data object.
1825
1826 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1827 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1828 @var{dh} or @var{buffer} is not a valid pointer, and
1829 @code{GPG_ERR_ENOMEM} if not enough memory is available.
1830 @end deftypefun
1831
1832 @deftypefun gpgme_error_t gpgme_data_new_from_file (@w{gpgme_data_t *@var{dh}}, @w{const char *@var{filename}}, @w{int @var{copy}})
1833 The function @code{gpgme_data_new_from_file} creates a new
1834 @code{gpgme_data_t} object and fills it with the content of the file
1835 @var{filename}.
1836
1837 If @var{copy} is not zero, the whole file is read in at initialization
1838 time and the file is not used anymore after that.  This is the only
1839 mode supported currently.  Later, a value of zero for @var{copy} might
1840 cause all reads to be delayed until the data is needed, but this is
1841 not yet implemented.
1842
1843 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1844 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1845 @var{dh} or @var{filename} is not a valid pointer,
1846 @code{GPG_ERR_NOT_IMPLEMENTED} if @var{code} is zero, and
1847 @code{GPG_ERR_ENOMEM} if not enough memory is available.
1848 @end deftypefun
1849
1850 @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}})
1851 The function @code{gpgme_data_new_from_filepart} creates a new
1852 @code{gpgme_data_t} object and fills it with a part of the file specified
1853 by @var{filename} or @var{fp}.
1854
1855 Exactly one of @var{filename} and @var{fp} must be non-zero, the other
1856 must be zero.  The argument that is not zero specifies the file from
1857 which @var{length} bytes are read into the data object, starting from
1858 @var{offset}.
1859
1860 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1861 data object was successfully created, @code{GPG_ERR_INV_VALUE} if
1862 @var{dh} and exactly one of @var{filename} and @var{fp} is not a valid
1863 pointer, and @code{GPG_ERR_ENOMEM} if not enough memory is available.
1864 @end deftypefun
1865
1866
1867 @node File Based Data Buffers
1868 @subsection File Based Data Buffers
1869
1870 File based data objects operate directly on file descriptors or
1871 streams.  Only a small amount of data is stored in core at any time,
1872 so the size of the data objects is not limited by @acronym{GPGME}.
1873
1874 @deftypefun gpgme_error_t gpgme_data_new_from_fd (@w{gpgme_data_t *@var{dh}}, @w{int @var{fd}})
1875 The function @code{gpgme_data_new_from_fd} creates a new
1876 @code{gpgme_data_t} object and uses the file descriptor @var{fd} to read
1877 from (if used as an input data object) and write to (if used as an
1878 output data object).
1879
1880 When using the data object as an input buffer, the function might read
1881 a bit more from the file descriptor than is actually needed by the
1882 crypto engine in the desired operation because of internal buffering.
1883
1884 Note that GPGME assumes that the file descriptor is set to blocking
1885 mode.  Errors during I/O operations, except for EINTR, are usually
1886 fatal for crypto operations.
1887
1888 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1889 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
1890 enough memory is available.
1891 @end deftypefun
1892
1893 @deftypefun gpgme_error_t gpgme_data_new_from_stream (@w{gpgme_data_t *@var{dh}}, @w{FILE *@var{stream}})
1894 The function @code{gpgme_data_new_from_stream} creates a new
1895 @code{gpgme_data_t} object and uses the I/O stream @var{stream} to read
1896 from (if used as an input data object) and write to (if used as an
1897 output data object).
1898
1899 When using the data object as an input buffer, the function might read
1900 a bit more from the stream than is actually needed by the crypto
1901 engine in the desired operation because of internal buffering.
1902
1903 Note that GPGME assumes that the stream is in blocking mode.  Errors
1904 during I/O operations, except for EINTR, are usually fatal for crypto
1905 operations.
1906
1907 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1908 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
1909 enough memory is available.
1910 @end deftypefun
1911
1912 @deftypefun gpgme_error_t gpgme_data_new_from_estream (@w{gpgme_data_t *@var{dh}}, @w{gpgrt_stream_t @var{stream}})
1913 The function @code{gpgme_data_new_from_estream} creates a new
1914 @code{gpgme_data_t} object and uses the gpgrt stream @var{stream} to read
1915 from (if used as an input data object) and write to (if used as an
1916 output data object).
1917
1918 When using the data object as an input buffer, the function might read
1919 a bit more from the stream than is actually needed by the crypto
1920 engine in the desired operation because of internal buffering.
1921
1922 Note that GPGME assumes that the stream is in blocking mode.  Errors
1923 during I/O operations, except for EINTR, are usually fatal for crypto
1924 operations.
1925
1926 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1927 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
1928 enough memory is available.
1929 @end deftypefun
1930
1931
1932 @node Callback Based Data Buffers
1933 @subsection Callback Based Data Buffers
1934
1935 If neither memory nor file based data objects are a good fit for your
1936 application, you can implement the functions a data object provides
1937 yourself and create a data object from these callback functions.
1938
1939 @deftp {Data type} {ssize_t (*gpgme_data_read_cb_t) (@w{void *@var{handle}}, @w{void @var{*buffer}}, @w{size_t @var{size}})}
1940 @tindex gpgme_data_read_cb_t
1941 The @code{gpgme_data_read_cb_t} type is the type of functions which
1942 @acronym{GPGME} calls if it wants to read data from a user-implemented
1943 data object.  The function should read up to @var{size} bytes from the
1944 current read position into the space starting at @var{buffer}.  The
1945 @var{handle} is provided by the user at data object creation time.
1946
1947 Note that GPGME assumes that the read blocks until data is available.
1948 Errors during I/O operations, except for EINTR, are usually fatal for
1949 crypto operations.
1950
1951 The function should return the number of bytes read, 0 on EOF, and -1
1952 on error.  If an error occurs, @var{errno} should be set to describe
1953 the type of the error.
1954 @end deftp
1955
1956 @deftp {Data type} {ssize_t (*gpgme_data_write_cb_t) (@w{void *@var{handle}}, @w{const void @var{*buffer}}, @w{size_t @var{size}})}
1957 @tindex gpgme_data_write_cb_t
1958 The @code{gpgme_data_write_cb_t} type is the type of functions which
1959 @acronym{GPGME} calls if it wants to write data to a user-implemented
1960 data object.  The function should write up to @var{size} bytes to the
1961 current write position from the space starting at @var{buffer}.  The
1962 @var{handle} is provided by the user at data object creation time.
1963
1964 Note that GPGME assumes that the write blocks until data is available.
1965 Errors during I/O operations, except for EINTR, are usually fatal for
1966 crypto operations.
1967
1968 The function should return the number of bytes written, and -1 on
1969 error.  If an error occurs, @var{errno} should be set to describe the
1970 type of the error.
1971 @end deftp
1972
1973 @deftp {Data type} {off_t (*gpgme_data_seek_cb_t) (@w{void *@var{handle}}, @w{off_t @var{offset}}, @w{int @var{whence}})}
1974 @tindex gpgme_data_seek_cb_t
1975 The @code{gpgme_data_seek_cb_t} type is the type of functions which
1976 @acronym{GPGME} calls if it wants to change the current read/write
1977 position in a user-implemented data object, just like the @code{lseek}
1978 function.
1979
1980 The function should return the new read/write position, and -1 on
1981 error.  If an error occurs, @var{errno} should be set to describe the
1982 type of the error.
1983 @end deftp
1984
1985 @deftp {Data type} {void (*gpgme_data_release_cb_t) (@w{void *@var{handle}})}
1986 @tindex gpgme_data_release_cb_t
1987 The @code{gpgme_data_release_cb_t} type is the type of functions which
1988 @acronym{GPGME} calls if it wants to destroy a user-implemented data
1989 object.  The @var{handle} is provided by the user at data object
1990 creation time.
1991 @end deftp
1992
1993 @deftp {Data type} {struct gpgme_data_cbs}
1994 This structure is used to store the data callback interface functions
1995 described above.  It has the following members:
1996
1997 @table @code
1998 @item gpgme_data_read_cb_t read
1999 This is the function called by @acronym{GPGME} to read data from the
2000 data object.  It is only required for input data object.
2001
2002 @item gpgme_data_write_cb_t write
2003 This is the function called by @acronym{GPGME} to write data to the
2004 data object.  It is only required for output data object.
2005
2006 @item gpgme_data_seek_cb_t seek
2007 This is the function called by @acronym{GPGME} to change the current
2008 read/write pointer in the data object (if available).  It is optional.
2009
2010 @item gpgme_data_release_cb_t release
2011 This is the function called by @acronym{GPGME} to release a data
2012 object.  It is optional.
2013 @end table
2014 @end deftp
2015
2016 @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}})
2017 The function @code{gpgme_data_new_from_cbs} creates a new
2018 @code{gpgme_data_t} object and uses the user-provided callback functions
2019 to operate on the data object.
2020
2021 The handle @var{handle} is passed as first argument to the callback
2022 functions.  This can be used to identify this data object.
2023
2024 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2025 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
2026 enough memory is available.
2027 @end deftypefun
2028
2029
2030 @node Destroying Data Buffers
2031 @section Destroying Data Buffers
2032 @cindex data buffer, destruction
2033
2034 @deftypefun void gpgme_data_release (@w{gpgme_data_t @var{dh}})
2035 The function @code{gpgme_data_release} destroys the data object with
2036 the handle @var{dh}.  It releases all associated resources that were
2037 not provided by the user in the first place.
2038 @end deftypefun
2039
2040 @deftypefun {char *} gpgme_data_release_and_get_mem (@w{gpgme_data_t @var{dh}}, @w{size_t *@var{length}})
2041 The function @code{gpgme_data_release_and_get_mem} is like
2042 @code{gpgme_data_release}, except that it returns the data buffer and
2043 its length that was provided by the object.
2044
2045 The user has to release the buffer with @code{gpgme_free}.  In case
2046 the user provided the data buffer in non-copy mode, a copy will be
2047 made for this purpose.
2048
2049 In case an error returns, or there is no suitable data buffer that can
2050 be returned to the user, the function will return @code{NULL}.  In any
2051 case, the data object @var{dh} is destroyed.
2052 @end deftypefun
2053
2054
2055 @deftypefun void gpgme_free (@w{void *@var{buffer}})
2056 @since{1.1.1}
2057
2058 The function @code{gpgme_free} releases the memory returned by
2059 @code{gpgme_data_release_and_get_mem} and
2060 @code{gpgme_pubkey_algo_string}.  It should be used instead of the
2061 system libraries @code{free} function in case different allocators are
2062 used by a program.  This is often the case if gpgme is used under
2063 Windows as a DLL.
2064 @end deftypefun
2065
2066
2067 @node Manipulating Data Buffers
2068 @section Manipulating Data Buffers
2069 @cindex data buffer, manipulation
2070
2071 Data buffers contain data and meta-data.  The following operations can
2072 be used to manipulate both.
2073
2074
2075 @menu
2076 * Data Buffer I/O Operations::    I/O operations on data buffers.
2077 * Data Buffer Meta-Data::         Meta-data manipulation of data buffers.
2078 * Data Buffer Convenience::       Convenience function for data buffers.
2079 @end menu
2080
2081
2082 @node Data Buffer I/O Operations
2083 @subsection Data Buffer I/O Operations
2084 @cindex data buffer, I/O operations
2085 @cindex data buffer, read
2086 @cindex data buffer, write
2087 @cindex data buffer, seek
2088
2089 @deftypefun ssize_t gpgme_data_read (@w{gpgme_data_t @var{dh}}, @w{void *@var{buffer}}, @w{size_t @var{length}})
2090 The function @code{gpgme_data_read} reads up to @var{length} bytes
2091 from the data object with the handle @var{dh} into the space starting
2092 at @var{buffer}.
2093
2094 If no error occurs, the actual amount read is returned.  If the end of
2095 the data object is reached, the function returns 0.
2096
2097 In all other cases, the function returns -1 and sets @var{errno}.
2098 @end deftypefun
2099
2100 @deftypefun ssize_t gpgme_data_write (@w{gpgme_data_t @var{dh}}, @w{const void *@var{buffer}}, @w{size_t @var{size}})
2101 The function @code{gpgme_data_write} writes up to @var{size} bytes
2102 starting from @var{buffer} into the data object with the handle
2103 @var{dh} at the current write position.
2104
2105 The function returns the number of bytes actually written, or -1 if an
2106 error occurs.  If an error occurs, @var{errno} is set.
2107 @end deftypefun
2108
2109 @deftypefun off_t gpgme_data_seek (@w{gpgme_data_t @var{dh}}, @w{off_t @var{offset}}, @w{int @var{whence}})
2110 The function @code{gpgme_data_seek} changes the current read/write
2111 position.
2112
2113 The @var{whence} argument specifies how the @var{offset} should be
2114 interpreted.  It must be one of the following symbolic constants:
2115
2116 @table @code
2117 @item SEEK_SET
2118 Specifies that @var{offset} is a count of characters from the
2119 beginning of the data object.
2120
2121 @item SEEK_CUR
2122 Specifies that @var{offset} is a count of characters from the current
2123 file position.  This count may be positive or negative.
2124
2125 @item SEEK_END
2126 Specifies that @var{offset} is a count of characters from the end of
2127 the data object.  A negative count specifies a position within the
2128 current extent of the data object; a positive count specifies a
2129 position past the current end.  If you set the position past the
2130 current end, and actually write data, you will extend the data object
2131 with zeros up to that position.
2132 @end table
2133
2134 If successful, the function returns the resulting file position,
2135 measured in bytes from the beginning of the data object.  You can use
2136 this feature together with @code{SEEK_CUR} to read the current
2137 read/write position.
2138
2139 If the function fails, -1 is returned and @var{errno} is set.
2140 @end deftypefun
2141
2142
2143 @node Data Buffer Meta-Data
2144 @subsection Data Buffer Meta-Data
2145 @cindex data buffer, meta-data
2146 @cindex data buffer, file name
2147 @cindex data buffer, encoding
2148
2149 @deftypefun {char *} gpgme_data_get_file_name (@w{gpgme_data_t @var{dh}})
2150 @since{1.1.0}
2151
2152 The function @code{gpgme_data_get_file_name} returns a pointer to a
2153 string containing the file name associated with the data object.  The
2154 file name will be stored in the output when encrypting or signing the
2155 data and will be returned to the user when decrypting or verifying the
2156 output data.
2157
2158 If no error occurs, the string containing the file name is returned.
2159 Otherwise, @code{NULL} will be returned.
2160 @end deftypefun
2161
2162
2163 @deftypefun gpgme_error_t gpgme_data_set_file_name (@w{gpgme_data_t @var{dh}}, @w{const char *@var{file_name}})
2164 @since{1.1.0}
2165
2166 The function @code{gpgme_data_set_file_name} sets the file name
2167 associated with the data object.  The file name will be stored in the
2168 output when encrypting or signing the data and will be returned to the
2169 user when decrypting or verifying the output data.
2170
2171 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2172 @var{dh} is not a valid pointer and @code{GPG_ERR_ENOMEM} if not
2173 enough memory is available.
2174 @end deftypefun
2175
2176
2177 @deftp {Data type} {enum gpgme_data_encoding_t}
2178 @tindex gpgme_data_encoding_t
2179 The @code{gpgme_data_encoding_t} type specifies the encoding of a
2180 @code{gpgme_data_t} object.  For input data objects, the encoding is
2181 useful to give the backend a hint on the type of data.  For output
2182 data objects, the encoding can specify the output data format on
2183 certain operations.  Please note that not all backends support all
2184 encodings on all operations.  The following data types are available:
2185
2186 @table @code
2187 @item GPGME_DATA_ENCODING_NONE
2188 This specifies that the encoding is not known.  This is the default
2189 for a new data object.  The backend will try its best to detect the
2190 encoding automatically.
2191
2192 @item GPGME_DATA_ENCODING_BINARY
2193 This specifies that the data is encoding in binary form; i.e. there is
2194 no special encoding.
2195
2196 @item GPGME_DATA_ENCODING_BASE64
2197 This specifies that the data is encoded using the Base-64 encoding
2198 scheme as used by @acronym{MIME} and other protocols.
2199
2200 @item GPGME_DATA_ENCODING_ARMOR
2201 This specifies that the data is encoded in an armored form as used by
2202 OpenPGP and PEM.
2203
2204 @item GPGME_DATA_ENCODING_MIME
2205 @since{1.7.0}
2206
2207 This specifies that the data is encoded as a MIME part.
2208
2209 @item GPGME_DATA_ENCODING_URL
2210 @since{1.2.0}
2211
2212 The data is a list of linefeed delimited URLs.  This is only useful with
2213 @code{gpgme_op_import}.
2214
2215 @item GPGME_DATA_ENCODING_URL0
2216 @since{1.2.0}
2217
2218 The data is a list of binary zero delimited URLs.  This is only useful
2219 with @code{gpgme_op_import}.
2220
2221 @item GPGME_DATA_ENCODING_URLESC
2222 @since{1.2.0}
2223
2224 The data is a list of linefeed delimited URLs with all control and space
2225 characters percent escaped.  This mode is is not yet implemented.
2226
2227 @end table
2228 @end deftp
2229
2230 @deftypefun gpgme_data_encoding_t gpgme_data_get_encoding (@w{gpgme_data_t @var{dh}})
2231 The function @code{gpgme_data_get_encoding} returns the encoding of
2232 the data object with the handle @var{dh}.  If @var{dh} is not a valid
2233 pointer (e.g. @code{NULL}) @code{GPGME_DATA_ENCODING_NONE} is
2234 returned.
2235 @end deftypefun
2236
2237 @deftypefun gpgme_error_t gpgme_data_set_encoding (@w{gpgme_data_t @var{dh}, gpgme_data_encoding_t @var{enc}})
2238 The function @code{gpgme_data_set_encoding} changes the encoding of
2239 the data object with the handle @var{dh} to @var{enc}.
2240 @end deftypefun
2241
2242 @deftypefun {gpgme_error_t} gpgme_data_set_flag  @
2243             (@w{gpgme_data_t @var{dh}}, @
2244             @w{const char *@var{name}}, @
2245             @w{const char *@var{value}})
2246
2247 @since{1.7.0}
2248
2249 Some minor properties of the data object can be controlled with flags
2250 set by this function.  The properties are identified by the following
2251 values for @var{name}:
2252
2253 @table @code
2254 @item size-hint
2255 The value is a decimal number with the length gpgme shall assume for
2256 this data object.  This is useful if the data is provided by callbacks
2257 or via file descriptors but the applications knows the total size of
2258 the data.  If this is set the OpenPGP engine may use this to decide on
2259 buffer allocation strategies and to provide a total value for its
2260 progress information.
2261
2262 @end table
2263
2264 This function returns @code{0} on success.
2265 @end deftypefun
2266
2267
2268 @node Data Buffer Convenience
2269 @subsection Data Buffer Convenience Functions
2270 @cindex data buffer, convenience
2271 @cindex type of data
2272 @cindex identify
2273
2274 @deftp {Data type} {enum gpgme_data_type_t}
2275 @tindex gpgme_data_type_t
2276 @since{1.4.3}
2277
2278 The @code{gpgme_data_type_t} type is used to return the detected type
2279 of the content of a data buffer.
2280 @end deftp
2281
2282 @table @code
2283 @item GPGME_DATA_TYPE_INVALID
2284 This is returned by @code{gpgme_data_identify} if it was not possible
2285 to identify the data.  Reasons for this might be a non-seekable stream
2286 or a memory problem.  The value is 0.
2287 @item GPGME_DATA_TYPE_UNKNOWN
2288 The type of the data is not known.
2289 @item GPGME_DATA_TYPE_PGP_SIGNED
2290 The data is an OpenPGP signed message.  This may be a binary
2291 signature, a detached one or a cleartext signature.
2292 @item GPGME_DATA_TYPE_PGP_ENCRYPTED
2293 @since{1.7.0}
2294
2295 The data is an OpenPGP encrypted message.
2296 @item GPGME_DATA_TYPE_PGP_SIGNATURE
2297 @since{1.7.0}
2298
2299 The data is an OpenPGP detached signature.
2300 @item GPGME_DATA_TYPE_PGP_OTHER
2301 This is a generic OpenPGP message.  In most cases this will be
2302 encrypted data.
2303 @item GPGME_DATA_TYPE_PGP_KEY
2304 This is an OpenPGP key (private or public).
2305 @item GPGME_DATA_TYPE_CMS_SIGNED
2306 This is a CMS signed message.
2307 @item GPGME_DATA_TYPE_CMS_ENCRYPTED
2308 This is a CMS encrypted (enveloped data) message.
2309 @item GPGME_DATA_TYPE_CMS_OTHER
2310 This is used for other CMS message types.
2311 @item GPGME_DATA_TYPE_X509_CERT
2312 The data is a X.509 certificate
2313 @item GPGME_DATA_TYPE_PKCS12
2314 The data is a PKCS#12 message.  This is commonly used to exchange
2315 private keys for X.509.
2316 @end table
2317
2318 @deftypefun gpgme_data_type_t gpgme_data_identify (@w{gpgme_data_t @var{dh}})
2319 @since{1.4.3}
2320
2321 The function @code{gpgme_data_identify} returns the type of the data
2322 with the handle @var{dh}.  If it is not possible to perform the
2323 identification, the function returns zero
2324 (@code{GPGME_DATA_TYPE_INVALID}).  Note that depending on how the data
2325 object has been created the identification may not be possible or the
2326 data object may change its internal state (file pointer moved).  For
2327 file or memory based data object, the state should not change.
2328 @end deftypefun
2329
2330
2331 @c
2332 @c    Chapter Contexts
2333 @c
2334 @node Contexts
2335 @chapter Contexts
2336 @cindex context
2337
2338 All cryptographic operations in @acronym{GPGME} are performed within a
2339 context, which contains the internal state of the operation as well as
2340 configuration parameters.  By using several contexts you can run
2341 several cryptographic operations in parallel, with different
2342 configuration.
2343
2344 @deftp {Data type} {gpgme_ctx_t}
2345 The @code{gpgme_ctx_t} type is a handle for a @acronym{GPGME} context,
2346 which is used to hold the configuration, status and result of
2347 cryptographic operations.
2348 @end deftp
2349
2350 @menu
2351 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
2352 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
2353 * Result Management::             Managing the result of crypto operations.
2354 * Context Attributes::            Setting properties of a context.
2355 * Key Management::                Managing keys with @acronym{GPGME}.
2356 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
2357 * Crypto Operations::             Using a context for cryptography.
2358 * Miscellaneous::                 Miscellaneous operations
2359 * Run Control::                   Controlling how operations are run.
2360 @end menu
2361
2362
2363 @node Creating Contexts
2364 @section Creating Contexts
2365 @cindex context, creation
2366
2367 @deftypefun gpgme_error_t gpgme_new (@w{gpgme_ctx_t *@var{ctx}})
2368 The function @code{gpgme_new} creates a new @code{gpgme_ctx_t} object
2369 and returns a handle for it in @var{ctx}.
2370
2371 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2372 context was successfully created, @code{GPG_ERR_INV_VALUE} if
2373 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if not
2374 enough memory is available.  Also, it returns
2375 @code{GPG_ERR_NOT_OPERATIONAL} if @code{gpgme_check_version} was not
2376 called to initialize GPGME, and @code{GPG_ERR_SELFTEST_FAILED} if a
2377 selftest failed.  Currently, the only selftest is for Windows MingW32
2378 targets to see if @code{-mms-bitfields} was used (as required).
2379 @end deftypefun
2380
2381
2382 @node Destroying Contexts
2383 @section Destroying Contexts
2384 @cindex context, destruction
2385
2386 @deftypefun void gpgme_release (@w{gpgme_ctx_t @var{ctx}})
2387 The function @code{gpgme_release} destroys the context with the handle
2388 @var{ctx} and releases all associated resources.
2389 @end deftypefun
2390
2391
2392 @node Result Management
2393 @section Result Management
2394 @cindex context, result of operation
2395
2396 The detailed result of an operation is returned in operation-specific
2397 structures such as @code{gpgme_decrypt_result_t}.  The corresponding
2398 retrieval functions such as @code{gpgme_op_decrypt_result} provide
2399 static access to the results after an operation completes.  Those
2400 structures shall be considered read-only and an application must not
2401 allocate such a structure on its own.  The following interfaces make
2402 it possible to detach a result structure from its associated context
2403 and give it a lifetime beyond that of the current operation or
2404 context.
2405
2406 @deftypefun void gpgme_result_ref (@w{void *@var{result}})
2407 @since{1.2.0}
2408
2409 The function @code{gpgme_result_ref} acquires an additional reference
2410 for the result @var{result}, which may be of any type
2411 @code{gpgme_*_result_t}.  As long as the user holds a reference, the
2412 result structure is guaranteed to be valid and unmodified.
2413 @end deftypefun
2414
2415 @deftypefun void gpgme_result_unref (@w{void *@var{result}})
2416 @since{1.2.0}
2417
2418 The function @code{gpgme_result_unref} releases a reference for the
2419 result @var{result}.  If this was the last reference, the result
2420 structure will be destroyed and all resources associated to it will be
2421 released.
2422 @end deftypefun
2423
2424 Note that a context may hold its own references to result structures,
2425 typically until the context is destroyed or the next operation is
2426 started.  In fact, these references are accessed through the
2427 @code{gpgme_op_*_result} functions.
2428
2429
2430 @node Context Attributes
2431 @section Context Attributes
2432 @cindex context, attributes
2433
2434 @menu
2435 * Protocol Selection::            Selecting the protocol used by a context.
2436 * Crypto Engine::                 Configuring the crypto engine.
2437 * Setting the Sender::            How to tell the engine the sender.
2438 * ASCII Armor::                   Requesting @acronym{ASCII} armored output.
2439 * Text Mode::                     Choosing canonical text mode.
2440 * Offline Mode::                  Choosing offline mode.
2441 * Pinentry Mode::                 Choosing the pinentry mode.
2442 * Included Certificates::         Including a number of certificates.
2443 * Key Listing Mode::              Selecting key listing mode.
2444 * Passphrase Callback::           Getting the passphrase from the user.
2445 * Progress Meter Callback::       Being informed about the progress.
2446 * Status Message Callback::       Status messages received from gpg.
2447 * Context Flags::                 Additional flags for a context.
2448 * Locale::                        Setting the locale of a context.
2449 * Additional Logs::               Additional logs of a context.
2450 @end menu
2451
2452
2453 @node Protocol Selection
2454 @subsection Protocol Selection
2455 @cindex context, selecting protocol
2456 @cindex protocol, selecting
2457
2458 @deftypefun gpgme_error_t gpgme_set_protocol (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_protocol_t @var{proto}})
2459 The function @code{gpgme_set_protocol} sets the protocol used within
2460 the context @var{ctx} to @var{proto}.  All crypto operations will be
2461 performed by the crypto engine configured for that protocol.
2462 @xref{Protocols and Engines}.
2463
2464 Setting the protocol with @code{gpgme_set_protocol} does intentionally
2465 not check if the crypto engine for that protocol is available and
2466 installed correctly.  @xref{Engine Version Check}.
2467
2468 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2469 protocol could be set successfully, and @code{GPG_ERR_INV_VALUE} if
2470 @var{protocol} is not a valid protocol.
2471 @end deftypefun
2472
2473 @deftypefun gpgme_protocol_t gpgme_get_protocol (@w{gpgme_ctx_t @var{ctx}})
2474 The function @code{gpgme_get_protocol} retrieves the protocol currently
2475 use with the context @var{ctx}.
2476 @end deftypefun
2477
2478
2479 @node Crypto Engine
2480 @subsection Crypto Engine
2481 @cindex context, configuring engine
2482 @cindex engine, configuration per context
2483
2484 The following functions can be used to set and retrieve the
2485 configuration of the crypto engines of a specific context.  The
2486 default can also be retrieved without any particular context.
2487 @xref{Engine Information}.  The default can also be changed globally.
2488 @xref{Engine Configuration}.
2489
2490 @deftypefun gpgme_engine_info_t gpgme_ctx_get_engine_info (@w{gpgme_ctx_t @var{ctx}})
2491 @since{1.1.0}
2492
2493 The function @code{gpgme_ctx_get_engine_info} returns a linked list of
2494 engine info structures.  Each info structure describes the
2495 configuration of one configured backend, as used by the context
2496 @var{ctx}.
2497
2498 The result is valid until the next invocation of
2499 @code{gpgme_ctx_set_engine_info} for this particular context.
2500
2501 This function can not fail.
2502 @end deftypefun
2503
2504 @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}})
2505 @since{1.1.0}
2506
2507 The function @code{gpgme_ctx_set_engine_info} changes the
2508 configuration of the crypto engine implementing the protocol
2509 @var{proto} for the context @var{ctx}.
2510
2511 @var{file_name} is the file name of the executable program
2512 implementing this protocol, and @var{home_dir} is the directory name
2513 of the configuration directory for this crypto engine.  If
2514 @var{home_dir} is @code{NULL}, the engine's default will be used.
2515
2516 Currently this function must be used before starting the first crypto
2517 operation.  It is unspecified if and when the changes will take effect
2518 if the function is called after starting the first operation on the
2519 context @var{ctx}.
2520
2521 This function returns the error code @code{GPG_ERR_NO_ERROR} if
2522 successful, or an error code on failure.
2523 @end deftypefun
2524
2525
2526 @node Setting the Sender
2527 @subsection How to tell the engine the sender.
2528 @cindex context, sender
2529 @cindex sender
2530 @cindex From:
2531
2532 Some engines can make use of the sender’s address, for example to
2533 figure out the best user id in certain trust models.  For verification
2534 and signing of mails, it is thus suggested to let the engine know the
2535 sender ("From:") address.  @acronym{GPGME} provides two functions to
2536 accomplish that.  Note that the esoteric use of multiple "From:"
2537 addresses is not supported.
2538
2539 @deftypefun gpgme_error_t gpgme_set_sender @
2540       (@w{gpgme_ctx_t @var{ctx}}, @
2541        @w{int @var{address}})
2542
2543 @since{1.8.0}
2544
2545 The function @code{gpgme_set_sender} specifies the sender address for
2546 use in sign and verify operations.  @var{address} is expected to be
2547 the ``addr-spec'' part of an address but my also be a complete mailbox
2548 address, in which case this function extracts the ``addr-spec'' from
2549 it.  Using @code{NULL} for @var{address} clears the sender address.
2550
2551 The function returns 0 on success or an error code on failure.  The
2552 most likely failure is that no valid ``addr-spec'' was found in
2553 @var{address}.
2554
2555 @end deftypefun
2556
2557 @deftypefun @w{const char *} gpgme_get_sender @
2558       (@w{gpgme_ctx_t @var{ctx}})
2559
2560 @since{1.8.0}
2561
2562 The function @code{gpgme_get_sender} returns the current sender
2563 address from the context, or NULL if none was set.  The returned
2564 value is valid as long as the @var{ctx} is valid and
2565 @code{gpgme_set_sender} has not been called again.
2566
2567 @end deftypefun
2568
2569
2570
2571 @c FIXME: Unfortunately, using @acronym here breaks texi2dvi.
2572 @node ASCII Armor
2573 @subsection @acronym{ASCII} Armor
2574 @cindex context, armor mode
2575 @cindex @acronym{ASCII} armor
2576 @cindex armor mode
2577
2578 @deftypefun void gpgme_set_armor (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2579 The function @code{gpgme_set_armor} specifies if the output should be
2580 @acronym{ASCII} armored.  By default, output is not @acronym{ASCII}
2581 armored.
2582
2583 @acronym{ASCII} armored output is disabled if @var{yes} is zero, and
2584 enabled otherwise.
2585 @end deftypefun
2586
2587 @deftypefun int gpgme_get_armor (@w{gpgme_ctx_t @var{ctx}})
2588 The function @code{gpgme_get_armor} returns 1 if the output is
2589 @acronym{ASCII} armored, and @code{0} if it is not, or if @var{ctx} is
2590 not a valid pointer.
2591 @end deftypefun
2592
2593
2594 @node Text Mode
2595 @subsection Text Mode
2596 @cindex context, text mode
2597 @cindex text mode
2598 @cindex canonical text mode
2599
2600 @deftypefun void gpgme_set_textmode (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2601 The function @code{gpgme_set_textmode} specifies if canonical text mode
2602 should be used.  By default, text mode is not used.
2603
2604 Text mode is for example used for the RFC2015 signatures; note that
2605 the updated RFC 3156 mandates that the mail user agent does some
2606 preparations so that text mode is not needed anymore.
2607
2608 This option is only relevant to the OpenPGP crypto engine, and ignored
2609 by all other engines.
2610
2611 Canonical text mode is disabled if @var{yes} is zero, and enabled
2612 otherwise.
2613 @end deftypefun
2614
2615 @deftypefun int gpgme_get_textmode (@w{gpgme_ctx_t @var{ctx}})
2616 The function @code{gpgme_get_textmode} returns 1 if canonical text
2617 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2618 valid pointer.
2619 @end deftypefun
2620
2621
2622 @node Offline Mode
2623 @subsection Offline Mode
2624 @cindex context, offline mode
2625 @cindex offline mode
2626
2627 @deftypefun void gpgme_set_offline (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2628 @since{1.6.0}
2629
2630 The function @code{gpgme_set_offline} specifies if offline mode should
2631 be used.  Offline mode is disabled if @var{yes} is zero, and enabled
2632 otherwise.  By default, offline mode is disabled.
2633
2634 The details of the offline mode depend on the used protocol and its
2635 backend engine.  It may eventually be extended to be more stricter and
2636 for example completely disable the use of Dirmngr for any engine.
2637
2638 For the CMS protocol the offline mode specifies whether Dirmngr shall
2639 be used to do additional validation that might require connecting
2640 external services (e.g. CRL / OCSP checks).  Here the offline mode
2641 only affects the keylist mode @code{GPGME_KEYLIST_MODE_VALIDATE}.
2642
2643 For the OpenPGP protocol offline mode entirely disables the use of the
2644 Dirmngr and will thus guarantee that no network connections are done
2645 as part of an operation on this context.  It has only an effect with
2646 GnuPG versions 2.1.23 or later.
2647
2648 For all other protocols the offline mode is currently ignored.
2649
2650 @end deftypefun
2651
2652 @deftypefun int gpgme_get_offline (@w{gpgme_ctx_t @var{ctx}})
2653 @since{1.6.0}
2654
2655 The function @code{gpgme_get_offline} returns 1 if offline
2656 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2657 valid pointer.
2658 @end deftypefun
2659
2660
2661 @node Pinentry Mode
2662 @subsection Pinentry Mode
2663 @cindex context, pinentry mode
2664 @cindex pinentry mode
2665
2666 @deftypefun gpgme_error_t gpgme_set_pinentry_mode (@w{gpgme_ctx_t @var{ctx}},
2667 @w{gpgme_pinentry_mode_t @var{mode}})
2668
2669 @since{1.4.0}
2670
2671 The function @code{gpgme_set_pinentry_mode} specifies the pinentry mode
2672 to be used.
2673
2674 For GnuPG >= 2.1 this option is required to be set to
2675 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback
2676 mechanism in GPGME through @code{gpgme_set_passphrase_cb}.
2677 @end deftypefun
2678
2679 @deftypefun gpgme_pinentry_mode_t gpgme_get_pinentry_mode (@w{gpgme_ctx_t @var{ctx}})
2680 @since{1.4.0}
2681
2682 The function @code{gpgme_get_pinenty_mode} returns the
2683 mode set for the context.
2684 @end deftypefun
2685
2686 @deftp {Data type} {enum gpgme_pinentry_mode_t}
2687 @tindex gpgme_pinentry_mode_t
2688 @since{1.4.0}
2689
2690 The @code{gpgme_minentry_mode_t} type specifies the set of possible pinentry
2691 modes that are supported by @acronym{GPGME} if GnuPG >= 2.1 is used.
2692 The following modes are supported:
2693
2694 @table @code
2695 @item GPGME_PINENTRY_MODE_DEFAULT
2696 @since{1.4.0}
2697
2698 Use the default of the agent, which is ask.
2699
2700 @item GPGME_PINENTRY_MODE_ASK
2701 @since{1.4.0}
2702
2703 Force the use of the Pinentry.
2704
2705 @item GPGME_PINENTRY_MODE_CANCEL
2706 @since{1.4.0}
2707
2708 Emulate use of Pinentry's cancel button.
2709
2710 @item GPGME_PINENTRY_MODE_ERROR
2711 @since{1.4.0}
2712
2713 Return a Pinentry error @code{No Pinentry}.
2714
2715 @item GPGME_PINENTRY_MODE_LOOPBACK
2716 @since{1.4.0}
2717
2718 Redirect Pinentry queries to the caller.
2719 This enables the use of @code{gpgme_set_passphrase_cb} because pinentry
2720 queries are redirected to gpgme.
2721
2722 Note: For 2.1.0 - 2.1.12 this mode requires @code{allow-loopback-pinentry}
2723 to be enabled in the @file{gpg-agent.conf} or an agent started with that option.
2724
2725 @end table
2726 @end deftp
2727
2728
2729 @node Included Certificates
2730 @subsection Included Certificates
2731 @cindex certificates, included
2732
2733 @deftypefun void gpgme_set_include_certs (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{nr_of_certs}})
2734 The function @code{gpgme_set_include_certs} specifies how many
2735 certificates should be included in an S/MIME signed message.  By
2736 default, only the sender's certificate is included.  The possible
2737 values of @var{nr_of_certs} are:
2738
2739 @table @code
2740 @item GPGME_INCLUDE_CERTS_DEFAULT
2741 @since{1.0.3}
2742
2743 Fall back to the default of the crypto backend.  This is the default
2744 for GPGME.
2745 @item -2
2746 Include all certificates except the root certificate.
2747 @item -1
2748 Include all certificates.
2749 @item 0
2750 Include no certificates.
2751 @item 1
2752 Include the sender's certificate only.
2753 @item n
2754 Include the first n certificates of the certificates path, starting
2755 from the sender's certificate.  The number @code{n} must be positive.
2756 @end table
2757
2758 Values of @var{nr_of_certs} smaller than -2 are undefined.
2759
2760 This option is only relevant to the CMS crypto engine, and ignored by
2761 all other engines.
2762 @end deftypefun
2763
2764 @deftypefun int gpgme_get_include_certs (@w{gpgme_ctx_t @var{ctx}})
2765 The function @code{gpgme_get_include_certs} returns the number of
2766 certificates to include into an S/MIME signed message.
2767 @end deftypefun
2768
2769
2770 @node Key Listing Mode
2771 @subsection Key Listing Mode
2772 @cindex key listing mode
2773 @cindex key listing, mode of
2774
2775 @deftypefun gpgme_error_t gpgme_set_keylist_mode (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_keylist_mode_t @var{mode}})
2776 The function @code{gpgme_set_keylist_mode} changes the default
2777 behaviour of the key listing functions.  The value in @var{mode} is a
2778 bitwise-or combination of one or multiple of the following bit values:
2779
2780 @table @code
2781 @item GPGME_KEYLIST_MODE_LOCAL
2782 The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
2783 keyring should be searched for keys in the keylisting operation.  This
2784 is the default.
2785
2786 Using only this option results in a @code{--list-keys}.
2787
2788 @item GPGME_KEYLIST_MODE_EXTERN
2789 The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
2790 source should be searched for keys in the keylisting operation.  The
2791 type of external source is dependent on the crypto engine used and
2792 whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}.  For
2793 example, it can be a remote keyserver or LDAP certificate server.
2794
2795 Using only this option results in a @code{--search-keys} for
2796 @code{GPGME_PROTOCOL_OpenPGP} and something similar to
2797 @code{--list-external-keys} for @code{GPGME_PROTOCOL_CMS}.
2798
2799 @item GPGME_KEYLIST_MODE_LOCATE
2800 This is a shortcut for the combination of
2801 @code{GPGME_KEYLIST_MODE_LOCAL} and @code{GPGME_KEYLIST_MODE_EXTERN}, which
2802 results in a @code{--locate-keys} for @code{GPGME_PROTOCOL_OpenPGP}.
2803
2804 @item GPGME_KEYLIST_MODE_SIGS
2805 The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key
2806 signatures should be included in the listed keys.
2807
2808 @item GPGME_KEYLIST_MODE_SIG_NOTATIONS
2809 @since{1.1.1}
2810
2811 The @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} symbol specifies that the
2812 signature notations on key signatures should be included in the listed
2813 keys.  This only works if @code{GPGME_KEYLIST_MODE_SIGS} is also
2814 enabled.
2815
2816 @item GPGME_KEYLIST_MODE_WITH_TOFU
2817 @since{1.7.0}
2818
2819 The @code{GPGME_KEYLIST_MODE_WITH_TOFU} symbol specifies that
2820 information pertaining to the TOFU trust model should be included in
2821 the listed keys.
2822
2823 @item GPGME_KEYLIST_MODE_WITH_SECRET
2824 @since{1.5.1}
2825
2826 The @code{GPGME_KEYLIST_MODE_WITH_SECRET} returns information about
2827 the presence of a corresponding secret key in a public key listing.  A
2828 public key listing with this mode is slower than a standard listing
2829 but can be used instead of a second run to list the secret keys.  This
2830 is only supported for GnuPG versions >= 2.1.
2831
2832 @item GPGME_KEYLIST_MODE_EPHEMERAL
2833 @since{1.2.0}
2834
2835 The @code{GPGME_KEYLIST_MODE_EPHEMERAL} symbol specifies that keys
2836 flagged as ephemeral are included in the listing.
2837
2838 @item GPGME_KEYLIST_MODE_VALIDATE
2839 @since{0.4.5}
2840
2841 The @code{GPGME_KEYLIST_MODE_VALIDATE} symbol specifies that the
2842 backend should do key or certificate validation and not just get the
2843 validity information from an internal cache.  This might be an
2844 expensive operation and is in general not useful.  Currently only
2845 implemented for the S/MIME backend and ignored for other backends.
2846
2847 @end table
2848
2849 At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
2850 @code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
2851 compatibility, you should get the current mode with
2852 @code{gpgme_get_keylist_mode} and modify it by setting or clearing the
2853 appropriate bits, and then using that calculated value in the
2854 @code{gpgme_set_keylisting_mode} operation.  This will leave all other
2855 bits in the mode value intact (in particular those that are not used
2856 in the current version of the library).
2857
2858 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2859 mode could be set correctly, and @code{GPG_ERR_INV_VALUE} if @var{ctx}
2860 is not a valid pointer or @var{mode} is not a valid mode.
2861 @end deftypefun
2862
2863
2864 @deftypefun gpgme_keylist_mode_t gpgme_get_keylist_mode (@w{gpgme_ctx_t @var{ctx}})
2865 The function @code{gpgme_get_keylist_mode} returns the current key
2866 listing mode of the context @var{ctx}.  This value can then be
2867 modified and used in a subsequent @code{gpgme_set_keylist_mode}
2868 operation to only affect the desired bits (and leave all others
2869 intact).
2870
2871 The function returns 0 if @var{ctx} is not a valid pointer, and the
2872 current mode otherwise.  Note that 0 is not a valid mode value.
2873 @end deftypefun
2874
2875
2876 @node Passphrase Callback
2877 @subsection Passphrase Callback
2878 @cindex callback, passphrase
2879 @cindex passphrase callback
2880
2881 @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}})}
2882 @tindex gpgme_passphrase_cb_t
2883 The @code{gpgme_passphrase_cb_t} type is the type of functions usable as
2884 passphrase callback function.
2885
2886 The argument @var{uid_hint} might contain a string that gives an
2887 indication for which user ID the passphrase is required.  If this is
2888 not available, or not applicable (in the case of symmetric encryption,
2889 for example), @var{uid_hint} will be @code{NULL}.
2890
2891 The argument @var{passphrase_info}, if not @code{NULL}, will give
2892 further information about the context in which the passphrase is
2893 required.  This information is engine and operation specific.
2894
2895 If this is the repeated attempt to get the passphrase, because
2896 previous attempts failed, then @var{prev_was_bad} is 1, otherwise it
2897 will be 0.
2898
2899 The user must write the passphrase, followed by a newline character,
2900 to the file descriptor @var{fd}.  The function @code{gpgme_io_writen}
2901 should be used for the write operation.  Note that if the user returns
2902 0 to indicate success, the user must at least write a newline
2903 character before returning from the callback.
2904
2905 If an error occurs, return the corresponding @code{gpgme_error_t}
2906 value.  You can use the error code @code{GPG_ERR_CANCELED} to abort
2907 the operation.  Otherwise, return @code{0}.
2908
2909 Note: The passphrase_cb only works with GnuPG 1.x and 2.1.x and not
2910 with the 2.0.x series. See @code{gpgme_set_pinentry_mode} for more
2911 details on 2.1.x usage.
2912 @end deftp
2913
2914 @deftypefun void gpgme_set_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t @var{passfunc}}, @w{void *@var{hook_value}})
2915 The function @code{gpgme_set_passphrase_cb} sets the function that is
2916 used when a passphrase needs to be provided by the user to
2917 @var{passfunc}.  The function @var{passfunc} needs to implemented by
2918 the user, and whenever it is called, it is called with its first
2919 argument being @var{hook_value}.  By default, no passphrase callback
2920 function is set.
2921
2922 Not all crypto engines require this callback to retrieve the
2923 passphrase.  It is better if the engine retrieves the passphrase from
2924 a trusted agent (a daemon process), rather than having each user to
2925 implement their own passphrase query.  Some engines do not even
2926 support an external passphrase callback at all, in this case the error
2927 code @code{GPG_ERR_NOT_SUPPORTED} is returned.
2928
2929 For GnuPG >= 2.1 the pinentry mode has to be set to
2930 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback.
2931 See @code{gpgme_set_pinentry_mode}.
2932
2933 The user can disable the use of a passphrase callback function by
2934 calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
2935 @code{NULL}.
2936 @end deftypefun
2937
2938 @deftypefun void gpgme_get_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t *@var{passfunc}}, @w{void **@var{hook_value}})
2939 The function @code{gpgme_get_passphrase_cb} returns the function that
2940 is used when a passphrase needs to be provided by the user in
2941 @var{*passfunc}, and the first argument for this function in
2942 @var{*hook_value}.  If no passphrase callback is set, or @var{ctx} is
2943 not a valid pointer, @code{NULL} is returned in both variables.
2944
2945 @var{passfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2946 the corresponding value will not be returned.
2947 @end deftypefun
2948
2949
2950 @node Progress Meter Callback
2951 @subsection Progress Meter Callback
2952 @cindex callback, progress meter
2953 @cindex progress meter callback
2954
2955 @deftp {Data type} {void (*gpgme_progress_cb_t)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
2956 @tindex gpgme_progress_cb_t
2957 The @code{gpgme_progress_cb_t} type is the type of functions usable as
2958 progress callback function.
2959
2960 The arguments are specific to the crypto engine.  More information
2961 about the progress information returned from the GnuPG engine can be
2962 found in the GnuPG source code in the file @file{doc/DETAILS} in the
2963 section PROGRESS.
2964 @end deftp
2965
2966 @deftypefun void gpgme_set_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t @var{progfunc}}, @w{void *@var{hook_value}})
2967 The function @code{gpgme_set_progress_cb} sets the function that is
2968 used when progress information about a cryptographic operation is
2969 available.  The function @var{progfunc} needs to implemented by the
2970 user, and whenever it is called, it is called with its first argument
2971 being @var{hook_value}.  By default, no progress callback function
2972 is set.
2973
2974 Setting a callback function allows an interactive program to display
2975 progress information about a long operation to the user.
2976
2977 The user can disable the use of a progress callback function by
2978 calling @code{gpgme_set_progress_cb} with @var{progfunc} being
2979 @code{NULL}.
2980 @end deftypefun
2981
2982 @deftypefun void gpgme_get_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t *@var{progfunc}}, @w{void **@var{hook_value}})
2983 The function @code{gpgme_get_progress_cb} returns the function that is
2984 used to inform the user about the progress made in @var{*progfunc},
2985 and the first argument for this function in @var{*hook_value}.  If no
2986 progress callback is set, or @var{ctx} is not a valid pointer,
2987 @code{NULL} is returned in both variables.
2988
2989 @var{progfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2990 the corresponding value will not be returned.
2991 @end deftypefun
2992
2993
2994 @node Status Message Callback
2995 @subsection Status Message Callback
2996 @cindex callback, status message
2997 @cindex status message callback
2998
2999 @deftp {Data type} {gpgme_error_t (*gpgme_status_cb_t)(void *@var{hook}, const char *@var{keyword}, const char *@var{args})}
3000 @tindex gpgme_status_cb_t
3001 The @code{gpgme_status_cb_t} type is the type of function usable as
3002 a status message callback function.
3003
3004 The argument @var{keyword} is the name of the status message while the
3005 @var{args} argument contains any arguments for the status message.
3006
3007 If an error occurs, return the corresponding @code{gpgme_error_t}
3008 value. Otherwise, return @code{0}.
3009 @end deftp
3010
3011 @deftypefun void gpgme_set_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t @var{statusfunc}}, @w{void *@var{hook_value}})
3012 @since{1.6.0}
3013
3014 The function @code{gpgme_set_status_cb} sets the function that is used when a
3015 status message is received from gpg to @var{statusfunc}. The function
3016 @var{statusfunc} needs to be implemented by the user, and whenever it is
3017 called, it is called with its first argument being @var{hook_value}.  By
3018 default, no status message callback function is set.
3019
3020 The user can disable the use of a status message callback function by calling
3021 @code{gpgme_set_status_cb} with @var{statusfunc} being @code{NULL}.
3022 @end deftypefun
3023
3024 @deftypefun void gpgme_get_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t *@var{statusfunc}}, @w{void **@var{hook_value}})
3025 @since{1.6.0}
3026
3027 The function @code{gpgme_get_status_cb} returns the function that is used to
3028 process status messages from gpg in @var{*statusfunc}, and the first argument
3029 for this function in @var{*hook_value}.  If no status message callback is set,
3030 or @var{ctx} is not a valid pointer, @code{NULL} is returned in both
3031 variables.
3032 @end deftypefun
3033
3034 @node Context Flags
3035 @subsection Context Flags
3036 @cindex flags, of a context
3037
3038 @deftypefun {gpgme_error_t} gpgme_set_ctx_flag  @
3039             (@w{gpgme_ctx_t @var{ctx}}, @
3040             @w{const char *@var{name}}, @
3041             @w{const char *@var{value}})
3042
3043 @since{1.7.0}
3044
3045 Some minor properties of the context can be controlled with flags set
3046 by this function.  The properties are identified by the following
3047 values for @var{name}:
3048
3049 @table @code
3050 @item "redraw"
3051 This flag is normally not changed by the caller because GPGME sets and
3052 clears it automatically: The flag is cleared before an operation and
3053 set if an operation noticed that the engine has launched a Pinentry.
3054 A Curses based application may use this information to redraw the
3055 screen; for example:
3056
3057 @example
3058     err = gpgme_op_keylist_start (ctx, "foo@@example.org", 0);
3059     while (!err)
3060       @{
3061         err = gpgme_op_keylist_next (ctx, &key);
3062         if (err)
3063           break;
3064         show_key (key);
3065         gpgme_key_release (key);
3066       @}
3067     if ((s = gpgme_get_ctx_flag (ctx, "redraw")) && *s)
3068       redraw_screen ();
3069     gpgme_release (ctx);
3070 @end example
3071
3072
3073 @item "full-status"
3074 Using a @var{value} of "1" the status callback set by
3075 gpgme_set_status_cb returns all status lines with the exception of
3076 PROGRESS lines.  With the default of "0" the status callback is only
3077 called in certain situations.
3078
3079 @item "raw-description"
3080 Setting the @var{value} to "1" returns human readable strings in a raw
3081 format.  For example the non breaking space characters ("~") will not
3082 be removed from the @code{description} field of the
3083 @code{gpgme_tofu_info_t} object.
3084
3085 @item "export-session-key"
3086 Using a @var{value} of "1" specifies that the context should try to
3087 export the symmetric session key when decrypting data.  By default, or
3088 when using an empty string or "0" for @var{value}, session keys are
3089 not exported.
3090
3091 @item "override-session-key"
3092 The string given in @var{value} is passed to the GnuPG engine to override
3093 the session key for decryption.  The format of that session key is
3094 specific to GnuPG and can be retrieved during a decrypt operation when
3095 the context flag "export-session-key" is enabled.  Please be aware that
3096 using this feature with GnuPG < 2.1.16 will leak the session key on
3097 many platforms via ps(1).
3098
3099 @item "auto-key-retrieve"
3100 Setting the @var{value} to "1" asks the backend to automatically
3101 retrieve a key for signature verification if possible.  Note that this
3102 option makes a "web bug" like behavior possible.  Keyserver or Web Key
3103 Directory operators can see which keys you request, so by sending you
3104 a message signed by a brand new key (which you naturally will not have
3105 on your local keyring), the operator can tell both your IP address and
3106 the time when you verified the signature.
3107
3108 @item "request-origin"
3109 The string given in @var{value} is passed to the GnuPG engines to
3110 request restrictions based on the origin of the request.  Valid values
3111 are documented in the GnuPG manual and the gpg man page under the
3112 option @option{--request-origin}.  Requires at least GnuPG 2.2.6 to have an
3113 effect.
3114
3115 @item "no-symkey-cache"
3116 For OpenPGP disable the passphrase cache used for symmetrical en- and
3117 decryption.  This cache is based on the message specific salt value.
3118 Requires at least GnuPG 2.2.7 to have an effect.
3119
3120 @item "ignore-mdc-error"
3121 This flag passes the option @option{--ignore-mdc-error} to gpg.  This
3122 can be used to force decryption of a message which failed due to a
3123 missing integrity check.  This flag must be used with great caution
3124 and only if it is a known non-corrupted old message and the decryption
3125 result of the former try had the decryption result flag
3126 @code{legacy_cipher_nomdc} set.  For failsafe reasons this flag is
3127 reset after each operation.
3128
3129 @item "auto-key-locate"
3130 The string given in @var{value} is passed to gpg.  This can be used
3131 to change the behavior of a @code{GPGME_KEYLIST_MODE_LOCATE} keylisting.
3132 Valid values are documented in the GnuPG manual and the gpg man page under
3133 the option @option{--auto-key-locate}.
3134 Requires at least GnuPG 2.1.18.
3135
3136 Note: Keys retrieved through @code{auto-key-locate} are automatically
3137 imported in the keyring.
3138
3139 @item trust-model
3140 @since{1.11.2}
3141
3142 Change the trust-model for all GnuPG engine operations.  An empty
3143 string sets the trust-model back to the users default.  If the
3144 trust-model is not supported by GnuPG the behavior is undefined
3145 and will likely cause all operations to fail.  Example: "tofu+pgp".
3146
3147 This options should be used carefully with a strict version
3148 requirement.  In some versions of GnuPG setting the
3149 trust-model changes the default trust-model for future operations.
3150 A change in the trust-model also can have unintended side effects, like
3151 rebuilding the trust-db.
3152
3153 @end table
3154
3155 This function returns @code{0} on success.
3156 @end deftypefun
3157
3158
3159 @deftypefun {const char *} gpgme_get_ctx_flag  @
3160             (@w{gpgme_ctx_t @var{ctx}}, @
3161             @w{const char *@var{name}})
3162
3163 @since{1.8.0}
3164
3165 The value of flags settable by @code{gpgme_set_ctx_flag} can be
3166 retrieved by this function.  If @var{name} is unknown the function
3167 returns @code{NULL}.  For boolean flags an empty string is returned
3168 for False and the string "1" is returned for True; either atoi(3) or a
3169 test for an empty string can be used to get the boolean value.
3170
3171 @end deftypefun
3172
3173
3174 @node Locale
3175 @subsection Locale
3176 @cindex locale, default
3177 @cindex locale, of a context
3178
3179 A locale setting can be associated with a context.  This locale is
3180 passed to the crypto engine, and used for applications like the PIN
3181 entry, which is displayed to the user when entering a passphrase is
3182 required.
3183
3184 The default locale is used to initialize the locale setting of all
3185 contexts created afterwards.
3186
3187 @deftypefun gpgme_error_t gpgme_set_locale (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{category}}, @w{const char *@var{value}})
3188 @since{0.4.3}
3189
3190 The function @code{gpgme_set_locale} sets the locale of the context
3191 @var{ctx}, or the default locale if @var{ctx} is a null pointer.
3192
3193 The locale settings that should be changed are specified by
3194 @var{category}.  Supported categories are @code{LC_CTYPE},
3195 @code{LC_MESSAGES}, and @code{LC_ALL}, which is a wildcard you can use
3196 if you want to change all the categories at once.
3197
3198 The value to be used for the locale setting is @var{value}, which will
3199 be copied to @acronym{GPGME}'s internal data structures.  @var{value}
3200 can be a null pointer, which disables setting the locale, and will
3201 make PIN entry and other applications use their default setting, which
3202 is usually not what you want.
3203
3204 Note that the settings are only used if the application runs on a text
3205 terminal, and that the settings should fit the configuration of the
3206 output terminal.  Normally, it is sufficient to initialize the default
3207 value at startup.
3208
3209 The function returns an error if not enough memory is available.
3210 @end deftypefun
3211
3212
3213 @node Additional Logs
3214 @subsection Additional Logs
3215 @cindex auditlog, of the engine
3216 @cindex auditlog
3217
3218 Additional logs can be associated with a context.  These logs are
3219 engine specific and can be be obtained with @code{gpgme_op_getauditlog}.
3220
3221 @deftypefun gpgme_error_t gpgme_op_getauditlog @
3222             (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{output}}, @
3223             @w{unsigned int @var{flags}})
3224 @since{1.1.1}
3225
3226 The function @code{gpgme_op_getauditlog} is used to obtain additional
3227 logs as specified by @var{flags} into the @var{output} data.  If
3228
3229 The function returns the error code @code{GPG_ERR_NO_ERROR} if a
3230 log could be queried from the engine, and @code{GPG_ERR_NOT_IMPLEMENTED}
3231 if the log specified in @var{flags} is not available for this engine.
3232 If no log is available @code{GPG_ERR_NO_DATA} is returned.
3233
3234 The value in @var{flags} is a bitwise-or combination of one or
3235 multiple of the following bit values:
3236
3237 @table @code
3238 @item GPGME_AUDITLOG_DIAG
3239 @since{1.11.2}
3240
3241 Obtain diagnostic output which would be written to @code{stderr} in
3242 interactive use of the engine.  This can be used to provide additional
3243 diagnostic information in case of errors in other operations.
3244
3245 Note: If log-file has been set in the configuration the log will
3246 be empty and @code{GPG_ERR_NO_DATA} will be returned.
3247
3248 Implemented for: @code{GPGME_PROTOCOL_OpenPGP}
3249
3250 @item GPGME_AUDITLOG_DEFAULT
3251 @since{1.11.2}
3252
3253 This flag has the value 0 for compatibility reasons.  Obtains additional
3254 information from the engine by issuing the @code{GETAUDITLOG} command.
3255 For @code{GPGME_PROTOCOL_CMS} this provides additional information about
3256 the X509 certificate chain.
3257
3258 Implemented for: @code{GPGME_PROTOCOL_CMS}
3259
3260 @item GPGME_AUDITLOG_HTML
3261 @since{1.1.1}
3262
3263 Same as @code{GPGME_AUDITLOG_DEFAULT} but in HTML.
3264
3265 Implemented for: @code{GPGME_PROTOCOL_CMS}
3266 @end table
3267 @end deftypefun
3268
3269 @deftypefun gpgme_error_t gpgme_op_getauditlog_start @
3270             (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{output}}, @
3271             @w{unsigned int @var{flags}})
3272 @since{1.1.1}
3273
3274 This is the asynchronous variant of @code{gpgme_op_getauditlog}.
3275 @end deftypefun
3276
3277 @node Key Management
3278 @section Key Management
3279 @cindex key management
3280
3281 Some of the cryptographic operations require that recipients or
3282 signers are specified.  This is always done by specifying the
3283 respective keys that should be used for the operation.  The following
3284 section describes how such keys can be selected and manipulated.
3285
3286
3287 @menu
3288 * Key objects::                   Description of the key structures.
3289 * Listing Keys::                  Browsing the list of available keys.
3290 * Information About Keys::        Requesting detailed information about keys.
3291 * Manipulating Keys::             Operations on keys.
3292 * Generating Keys::               Creating new key pairs.
3293 * Signing Keys::                  Adding key signatures to public keys.
3294 * Exporting Keys::                Retrieving key data from the key ring.
3295 * Importing Keys::                Adding keys to the key ring.
3296 * Deleting Keys::                 Removing keys from the key ring.
3297 * Changing Passphrases::          Change the passphrase of a key.
3298 * Changing TOFU Data::            Changing data pertaining to TOFU.
3299 * Advanced Key Editing::          Advanced key edit operation.
3300 @end menu
3301
3302 @node Key objects
3303 @subsection Key objects
3304
3305 The keys are represented in GPGME by structures which may only be read
3306 by the application but never be allocated or changed.  They are valid
3307 as long as the key object itself is valid.
3308
3309 @deftp {Data type} gpgme_key_t
3310
3311 The @code{gpgme_key_t} type is a pointer to a key object.  It has the
3312 following members:
3313
3314 @table @code
3315 @item gpgme_keylist_mode_t keylist_mode
3316 @since{0.9.0}
3317
3318 The keylist mode that was active when the key was retrieved.
3319
3320 @item unsigned int revoked : 1
3321 This is true if the key is revoked.
3322
3323 @item unsigned int expired : 1
3324 This is true if the key is expired.
3325
3326 @item unsigned int disabled : 1
3327 This is true if the key is disabled.
3328
3329 @item unsigned int invalid : 1
3330 This is true if the key is invalid. This might have several reasons,
3331 for a example for the S/MIME backend, it will be set during key
3332 listings if the key could not be validated due to missing
3333 certificates or unmatched policies.
3334
3335 @item unsigned int can_encrypt : 1
3336 This is true if the key (ie one of its subkeys) can be used for
3337 encryption.
3338
3339 @item unsigned int can_sign : 1
3340 This is true if the key (ie one of its subkeys) can be used to create
3341 data signatures.
3342
3343 @item unsigned int can_certify : 1
3344 This is true if the key (ie one of its subkeys) can be used to create
3345 key certificates.
3346
3347 @item unsigned int can_authenticate : 1
3348 @since{0.4.5}
3349
3350 This is true if the key (ie one of its subkeys) can be used for
3351 authentication.
3352
3353 @item unsigned int is_qualified : 1
3354 @since{1.1.0}
3355
3356 This is true if the key can be used for qualified signatures according
3357 to local government regulations.
3358
3359 @item unsigned int secret : 1
3360 This is true if the key is a secret key.  Note, that this will always
3361 be true even if the corresponding subkey flag may be false
3362 (offline/stub keys).  This is only set if a listing of secret keys has
3363 been requested or if @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3364
3365 @item unsigned int origin : 5
3366 @since{1.8.0}
3367
3368 Reserved for the origin of this key.
3369
3370 @item gpgme_protocol_t protocol
3371 This is the protocol supported by this key.
3372
3373 @item char *issuer_serial
3374 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3375 issuer serial.
3376
3377 @item char *issuer_name
3378 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3379 issuer name.
3380
3381 @item char *chain_id
3382 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3383 chain ID, which can be used to built the certificate chain.
3384
3385 @item gpgme_validity_t owner_trust
3386 If @code{protocol} is @code{GPGME_PROTOCOL_OpenPGP}, then this is the
3387 owner trust.
3388
3389 @item gpgme_subkey_t subkeys
3390 This is a linked list with the subkeys of the key.  The first subkey
3391 in the list is the primary key and usually available.
3392
3393 @item gpgme_user_id_t uids
3394 This is a linked list with the user IDs of the key.  The first user ID
3395 in the list is the main (or primary) user ID.
3396
3397 @item char *fpr
3398 @since{1.7.0}
3399
3400 This field gives the fingerprint of the primary key.  Note that
3401 this is a copy of the fingerprint of the first subkey.  For an
3402 incomplete key (for example from a verification result) a subkey may
3403 be missing but this field may be set nevertheless.
3404
3405 @item unsigned long last_update
3406 @since{1.8.0}
3407
3408 Reserved for the time of the last update of this key.
3409
3410 @end table
3411 @end deftp
3412
3413
3414 @deftp {Data type} gpgme_subkey_t
3415 @since{1.5.0}
3416
3417 The @code{gpgme_subkey_t} type is a pointer to a subkey structure.
3418 Subkeys are one component of a @code{gpgme_key_t} object.  In fact,
3419 subkeys are those parts that contains the real information about the
3420 individual cryptographic keys that belong to the same key object.  One
3421 @code{gpgme_key_t} can contain several subkeys.  The first subkey in
3422 the linked list is also called the primary key.
3423
3424 The subkey structure has the following members:
3425
3426 @table @code
3427 @item gpgme_subkey_t next
3428 This is a pointer to the next subkey structure in the linked list, or
3429 @code{NULL} if this is the last element.
3430
3431 @item unsigned int revoked : 1
3432 This is true if the subkey is revoked.
3433
3434 @item unsigned int expired : 1
3435 This is true if the subkey is expired.
3436
3437 @item unsigned int disabled : 1
3438 This is true if the subkey is disabled.
3439
3440 @item unsigned int invalid : 1
3441 This is true if the subkey is invalid.
3442
3443 @item unsigned int can_encrypt : 1
3444 This is true if the subkey can be used for encryption.
3445
3446 @item unsigned int can_sign : 1
3447 This is true if the subkey can be used to create data signatures.
3448
3449 @item unsigned int can_certify : 1
3450 This is true if the subkey can be used to create key certificates.
3451
3452 @item unsigned int can_authenticate : 1
3453 @since{0.4.5}
3454
3455 This is true if the subkey can be used for authentication.
3456
3457 @item unsigned int is_qualified : 1
3458 @since{1.1.0}
3459
3460 This is true if the subkey can be used for qualified signatures
3461 according to local government regulations.
3462
3463 @item unsigned int is_de_vs : 1
3464 @since{1.8.0}
3465
3466 This is true if the subkey complies with the rules for classified
3467 information in Germany at the restricted level (VS-NfD).  This are
3468 currently RSA keys of at least 2048 bits or ECDH/ECDSA keys using a
3469 Brainpool curve.
3470
3471 @item unsigned int secret : 1
3472 This is true if the subkey is a secret key.  Note that it will be
3473 false if the key is actually a stub key; i.e. a secret key operation
3474 is currently not possible (offline-key).  This is only set if a
3475 listing of secret keys has been requested or if
3476 @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3477
3478 @item gpgme_pubkey_algo_t pubkey_algo
3479 This is the public key algorithm supported by this subkey.
3480
3481 @item unsigned int length
3482 This is the length of the subkey (in bits).
3483
3484 @item char *keyid
3485 This is the key ID of the subkey in hexadecimal digits.
3486
3487 @item char *fpr
3488 This is the fingerprint of the subkey in hexadecimal digits, if
3489 available.
3490
3491 @item char *keygrip
3492 @since{1.7.0}
3493
3494 The keygrip of the subkey in hex digit form or @code{NULL} if not
3495 availabale.
3496
3497 @item long int timestamp
3498 This is the creation timestamp of the subkey.  This is -1 if the
3499 timestamp is invalid, and 0 if it is not available.
3500
3501 @item long int expires
3502 This is the expiration timestamp of the subkey, or 0 if the subkey
3503 does not expire.
3504
3505 @item unsigned int is_cardkey : 1
3506 @since{1.2.0}
3507
3508 True if the secret key is stored on a smart card.
3509
3510 @item char *card_number
3511 @since{1.2.0}
3512
3513 The serial number of a smart card holding this key or @code{NULL}.
3514
3515 @item char *curve
3516 For ECC algorithms the name of the curve.
3517
3518 @end table
3519 @end deftp
3520
3521 @deftp {Data type} gpgme_user_id_t
3522
3523 A user ID is a component of a @code{gpgme_key_t} object.  One key can
3524 have many user IDs.  The first one in the list is the main (or
3525 primary) user ID.
3526
3527 The user ID structure has the following members.
3528
3529 @table @code
3530 @item gpgme_user_id_t next
3531 This is a pointer to the next user ID structure in the linked list, or
3532 @code{NULL} if this is the last element.
3533
3534 @item unsigned int revoked : 1
3535 This is true if the user ID is revoked.
3536
3537 @item unsigned int invalid : 1
3538 This is true if the user ID is invalid.
3539
3540 @item gpgme_validity_t validity
3541 This specifies the validity of the user ID.
3542
3543 @item char *uid
3544 This is the user ID string.
3545
3546 @item char *name
3547 This is the name component of @code{uid}, if available.
3548
3549 @item char *comment
3550 This is the comment component of @code{uid}, if available.
3551
3552 @item char *email
3553 This is the email component of @code{uid}, if available.
3554
3555 @item char *address;
3556 The mail address (addr-spec from RFC-5322) of the user ID string.
3557 This is general the same as the @code{email} part of this structure
3558 but might be slightly different.  If no mail address is available
3559 @code{NULL} is stored.
3560
3561 @item gpgme_tofu_info_t tofu
3562 @since{1.7.0}
3563
3564 If not @code{NULL} information from the TOFU database pertaining to
3565 this user id.
3566
3567 @item gpgme_key_sig_t signatures
3568 This is a linked list with the signatures on this user ID.
3569
3570 @item unsigned int origin : 5
3571 @since{1.8.0}
3572
3573 Reserved for the origin of this user ID.
3574
3575 @item unsigned long last_update
3576 @since{1.8.0}
3577
3578 Reserved for the time of the last update of this user ID.
3579
3580 @end table
3581 @end deftp
3582
3583
3584 @deftp {Data type} gpgme_tofu_info_t
3585
3586 @since{1.7.0}
3587
3588 The @code{gpgme_tofu_info_t} type is a pointer to a tofu info
3589 structure.  Tofu info structures are one component of a
3590 @code{gpgme_user_id_t} object, and provide information from the TOFU
3591 database pertaining to the user ID.
3592
3593 The tofu info structure has the following members:
3594
3595 @table @code
3596 @item gpgme_key_sig_t next
3597 This is a pointer to the next tofu info structure in the linked
3598 list, or @code{NULL} if this is the last element.
3599
3600 @item unsigned int validity : 3
3601 This is the TOFU validity.  It can have the following values:
3602
3603 @table @code
3604 @item 0
3605 The value @code{0} indicates a conflict.
3606
3607 @item 1
3608 The value @code{1} indicates a key without history.
3609
3610 @item 2
3611 The value @code{2} indicates a key with too little history.
3612
3613 @item 3
3614 The value @code{3} indicates a key with enough history for basic trust.
3615
3616 @item 4
3617 The value @code{4} indicates a key with a lot of history.
3618
3619 @end table
3620
3621 @item unsigned int policy : 4
3622 This is the TOFU policy, see @code{gpgme_tofu_policy_t}.
3623
3624 @item unsigned short signcount
3625 This is the number of signatures seen for this binding (or
3626 @code{USHRT_MAX} if there are more than that).
3627
3628 @item unsigned short encrcount
3629 This is the number of encryptions done with this binding (or
3630 @code{USHRT_MAX} if there are more than that).
3631
3632 @item unsigned long signfirst
3633 Number of seconds since Epoch when the first signature was seen with
3634 this binding.
3635
3636 @item unsigned long signlast
3637 Number of seconds since Epoch when the last signature was seen with
3638 this binding.
3639
3640 @item unsigned long encrfirst
3641 Number of seconds since Epoch when the first encryption was done with
3642 this binding.
3643
3644 @item unsigned long encrlast
3645 Number of seconds since Epoch when the last encryption was done with
3646 this binding.
3647
3648 @item char *description
3649 A human-readable string summarizing the TOFU data (or NULL).
3650
3651 @end table
3652 @end deftp
3653
3654
3655 @deftp {Data type} gpgme_key_sig_t
3656
3657 The @code{gpgme_key_sig_t} type is a pointer to a key signature structure.
3658 Key signatures are one component of a @code{gpgme_key_t} object, and
3659 validate user IDs on the key in the OpenPGP protocol.
3660
3661 The signatures on a key are only available if the key was retrieved
3662 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
3663 enabled, because it can be expensive to retrieve all signatures of a
3664 key.
3665
3666 The signature notations on a key signature are only available if the
3667 key was retrieved via a listing operation with the
3668 @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} mode enabled, because it can
3669 be expensive to retrieve all signature notations.
3670
3671 The key signature structure has the following members:
3672
3673 @table @code
3674 @item gpgme_key_sig_t next
3675 This is a pointer to the next key signature structure in the linked
3676 list, or @code{NULL} if this is the last element.
3677
3678 @item unsigned int revoked : 1
3679 This is true if the key signature is a revocation signature.
3680
3681 @item unsigned int expired : 1
3682 This is true if the key signature is expired.
3683
3684 @item unsigned int invalid : 1
3685 This is true if the key signature is invalid.
3686
3687 @item unsigned int exportable : 1
3688 This is true if the key signature is exportable.
3689
3690 @item gpgme_pubkey_algo_t pubkey_algo
3691 This is the public key algorithm used to create the signature.
3692
3693 @item char *keyid
3694 This is the key ID of the key (in hexadecimal digits) used to create
3695 the signature.
3696
3697 @item long int timestamp
3698 This is the creation timestamp of the key signature.  This is -1 if
3699 the timestamp is invalid, and 0 if it is not available.
3700
3701 @item long int expires
3702 This is the expiration timestamp of the key signature, or 0 if the key
3703 signature does not expire.
3704
3705 @item gpgme_error_t status
3706 This is the status of the signature and has the same meaning as the
3707 member of the same name in a @code{gpgme_signature_t} object.
3708
3709 @item unsigned int sig_class
3710 This specifies the signature class of the key signature.  The meaning
3711 is specific to the crypto engine.
3712
3713 @item char *uid
3714 This is the main user ID of the key used to create the signature.
3715
3716 @item char *name
3717 This is the name component of @code{uid}, if available.
3718
3719 @item char *comment
3720 This is the comment component of @code{uid}, if available.
3721
3722 @item char *email
3723 This is the email component of @code{uid}, if available.
3724
3725 @item gpgme_sig_notation_t notations
3726 This is a linked list with the notation data and policy URLs.
3727 @end table
3728 @end deftp
3729
3730
3731
3732 @node Listing Keys
3733 @subsection Listing Keys
3734 @cindex listing keys
3735 @cindex key listing
3736 @cindex key listing, start
3737 @cindex key ring, list
3738 @cindex key ring, search
3739
3740 @deftypefun gpgme_error_t gpgme_op_keylist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
3741
3742 The function @code{gpgme_op_keylist_start} initiates a key listing
3743 operation inside the context @var{ctx}.  It sets everything up so that
3744 subsequent invocations of @code{gpgme_op_keylist_next} return the keys
3745 in the list.
3746
3747 If @var{pattern} is @code{NULL}, all available keys are returned.
3748 Otherwise, @var{pattern} contains an engine specific expression that
3749 is used to limit the list to all keys matching the pattern.  Note that
3750 the total length of the pattern is restricted to an engine-specific
3751 maximum (a couple of hundred characters are usually accepted).  The
3752 pattern should be used to restrict the search to a certain common name
3753 or user, not to list many specific keys at once by listing their
3754 fingerprints or key IDs.
3755
3756 If @var{secret_only} is not @code{0}, the list is restricted to secret
3757 keys only.
3758
3759 The context will be busy until either all keys are received (and
3760 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3761 @code{gpgme_op_keylist_end} is called to finish the operation.
3762
3763 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3764 @var{ctx} is not a valid pointer, and passes through any errors that
3765 are reported by the crypto engine support routines.
3766 @end deftypefun
3767
3768 @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}})
3769
3770 The function @code{gpgme_op_keylist_ext_start} initiates an extended
3771 key listing operation inside the context @var{ctx}.  It sets
3772 everything up so that subsequent invocations of
3773 @code{gpgme_op_keylist_next} return the keys in the list.
3774
3775 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
3776 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
3777 array of strings that are used to limit the list to all keys matching
3778 at least one of the patterns verbatim.  Note that the total length of
3779 all patterns is restricted to an engine-specific maximum (the exact
3780 limit also depends on the number of patterns and amount of quoting
3781 required, but a couple of hundred characters are usually accepted).
3782 Patterns should be used to restrict the search to a certain common
3783 name or user, not to list many specific keys at once by listing their
3784 fingerprints or key IDs.
3785
3786 If @var{secret_only} is not @code{0}, the list is restricted to secret
3787 keys only.
3788
3789 The value of @var{reserved} must be @code{0}.
3790
3791 The context will be busy until either all keys are received (and
3792 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3793 @code{gpgme_op_keylist_end} is called to finish the operation.
3794
3795 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3796 @var{ctx} is not a valid pointer, and passes through any errors that
3797 are reported by the crypto engine support routines.
3798 @end deftypefun
3799
3800 @deftypefun gpgme_error_t gpgme_op_keylist_from_data_start @
3801             (@w{gpgme_ctx_t @var{ctx}}, @
3802              @w{gpgme_data_t @var{data}}, @
3803              @w{int @var{reserved}})
3804
3805 @since{1.8.0}
3806
3807 The function @code{gpgme_op_keylist_from_data_start} initiates a key
3808 listing operation inside the context @var{ctx}.  In contrast to the
3809 other key listing operation the keys are read from the supplied
3810 @var{data} and not from the local key database.  The keys are also not
3811 imported into the local key database.  The function sets everything up
3812 so that subsequent invocations of @code{gpgme_op_keylist_next} return
3813 the keys from @var{data}.
3814
3815 The value of @var{reserved} must be @code{0}.
3816
3817 This function requires at least GnuPG version 2.1.14 and currently
3818 works only with OpenPGP keys.
3819
3820 The context will be busy until either all keys are received (and
3821 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3822 @code{gpgme_op_keylist_end} is called to finish the operation.
3823 While the context is busy @var{data} may not be released.
3824
3825 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3826 @var{ctx} is not a valid pointer, and passes through any errors that
3827 are reported by the crypto engine support routines.
3828 @end deftypefun
3829
3830 @deftypefun gpgme_error_t gpgme_op_keylist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{r_key}})
3831
3832 The function @code{gpgme_op_keylist_next} returns the next key in the
3833 list created by a previous @code{gpgme_op_keylist_start} operation in
3834 the context @var{ctx}.  The key will have one reference for the user.
3835 @xref{Manipulating Keys}.
3836
3837 This is the only way to get at @code{gpgme_key_t} objects in
3838 @acronym{GPGME}.
3839
3840 If the last key in the list has already been returned,
3841 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}.
3842
3843 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3844 @var{ctx} or @var{r_key} is not a valid pointer, and
3845 @code{GPG_ERR_ENOMEM} if there is not enough memory for the operation.
3846 @end deftypefun
3847
3848 @deftypefun gpgme_error_t gpgme_op_keylist_end (@w{gpgme_ctx_t @var{ctx}})
3849
3850 The function @code{gpgme_op_keylist_end} ends a pending key list
3851 operation in the context @var{ctx}.
3852
3853 After the operation completed successfully, the result of the key
3854 listing operation can be retrieved with
3855 @code{gpgme_op_keylist_result}.
3856
3857 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3858 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if at some
3859 time during the operation there was not enough memory available.
3860 @end deftypefun
3861
3862 The following example illustrates how all keys containing a certain
3863 string (@code{g10code}) can be listed with their key ID and the name
3864 and email address of the main user ID:
3865
3866 @example
3867 gpgme_ctx_t ctx;
3868 gpgme_key_t key;
3869 gpgme_error_t err = gpgme_new (&ctx);
3870
3871 if (!err)
3872   @{
3873     err = gpgme_op_keylist_start (ctx, "g10code", 0);
3874     while (!err)
3875       @{
3876         err = gpgme_op_keylist_next (ctx, &key);
3877         if (err)
3878           break;
3879         printf ("%s:", key->subkeys->keyid);
3880         if (key->uids && key->uids->name)
3881           printf (" %s", key->uids->name);
3882         if (key->uids && key->uids->email)
3883           printf (" <%s>", key->uids->email);
3884         putchar ('\n');
3885         gpgme_key_release (key);
3886       @}
3887     gpgme_release (ctx);
3888   @}
3889 if (gpg_err_code (err) != GPG_ERR_EOF)
3890   @{
3891     fprintf (stderr, "can not list keys: %s\n", gpgme_strerror (err));
3892     exit (1);
3893   @}
3894 @end example
3895
3896 @deftp {Data type} {gpgme_keylist_result_t}
3897 This is a pointer to a structure used to store the result of a
3898 @code{gpgme_op_keylist_*} operation.  After successfully ending a key
3899 listing operation, you can retrieve the pointer to the result with
3900 @code{gpgme_op_keylist_result}.  The structure contains the following
3901 member:
3902
3903 @table @code
3904 @item unsigned int truncated : 1
3905 This is true if the crypto backend had to truncate the result, and
3906 less than the desired keys could be listed.
3907 @end table
3908 @end deftp
3909
3910 @deftypefun gpgme_keylist_result_t gpgme_op_keylist_result (@w{gpgme_ctx_t @var{ctx}})
3911 The function @code{gpgme_op_keylist_result} returns a
3912 @code{gpgme_keylist_result_t} pointer to a structure holding the
3913 result of a @code{gpgme_op_keylist_*} operation.  The pointer is only
3914 valid if the last operation on the context was a key listing
3915 operation, and if this operation finished successfully.  The returned
3916 pointer is only valid until the next operation is started on the
3917 context.
3918 @end deftypefun
3919
3920 In a simple program, for which a blocking operation is acceptable, the
3921 following function can be used to retrieve a single key.
3922
3923 @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}})
3924 The function @code{gpgme_get_key} gets the key with the fingerprint
3925 (or key ID) @var{fpr} from the crypto backend and return it in
3926 @var{r_key}.  If @var{secret} is true, get the secret key.  The
3927 currently active keylist mode is used to retrieve the key.  The key
3928 will have one reference for the user.
3929
3930 If the key is not found in the keyring, @code{gpgme_get_key} returns
3931 the error code @code{GPG_ERR_EOF} and *@var{r_key} will be set to
3932 @code{NULL}.
3933
3934 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3935 @var{ctx} or @var{r_key} is not a valid pointer or @var{fpr} is not a
3936 fingerprint or key ID, @code{GPG_ERR_AMBIGUOUS_NAME} if the key ID was
3937 not a unique specifier for a key, and @code{GPG_ERR_ENOMEM} if at some
3938 time during the operation there was not enough memory available.
3939 @end deftypefun
3940
3941
3942 @node Information About Keys
3943 @subsection Information About Keys
3944 @cindex key, information about
3945 @cindex key, attributes
3946 @cindex attributes, of a key
3947
3948 Please see the beginning of this section for more information about
3949 @code{gpgme_key_t} objects.
3950
3951 @deftp {Data type} gpgme_validity_t
3952 The @code{gpgme_validity_t} type is used to specify the validity of a user ID
3953 in a key.  The following validities are defined:
3954
3955 @table @code
3956 @item GPGME_VALIDITY_UNKNOWN
3957 The user ID is of unknown validity.  The string representation of this
3958 validity is ``?''.
3959
3960 @item GPGME_VALIDITY_UNDEFINED
3961 The validity of the user ID is undefined.  The string representation of this
3962 validity is ``q''.
3963
3964 @item GPGME_VALIDITY_NEVER
3965 The user ID is never valid.  The string representation of this
3966 validity is ``n''.
3967
3968 @item GPGME_VALIDITY_MARGINAL
3969 The user ID is marginally valid.  The string representation of this
3970 validity is ``m''.
3971
3972 @item GPGME_VALIDITY_FULL
3973 The user ID is fully valid.  The string representation of this
3974 validity is ``f''.
3975
3976 @item GPGME_VALIDITY_ULTIMATE
3977 The user ID is ultimately valid.  The string representation of this
3978 validity is ``u''.
3979 @end table
3980 @end deftp
3981
3982
3983
3984
3985 @node Manipulating Keys
3986 @subsection Manipulating Keys
3987 @cindex key, manipulation
3988
3989 @deftypefun void gpgme_key_ref (@w{gpgme_key_t @var{key}})
3990 The function @code{gpgme_key_ref} acquires an additional reference for
3991 the key @var{key}.
3992 @end deftypefun
3993
3994 @deftypefun void gpgme_key_unref (@w{gpgme_key_t @var{key}})
3995 The function @code{gpgme_key_unref} releases a reference for the key
3996 @var{key}.  If this was the last reference, the key will be destroyed
3997 and all resources associated to it will be released.
3998 @end deftypefun
3999
4000
4001 @node Generating Keys
4002 @subsection Generating Keys
4003 @cindex key, creation
4004 @cindex key ring, add
4005
4006 GPGME provides a set of functions to create public key pairs.  Most of
4007 these functions require the use of GnuPG 2.1 and later; for older
4008 GnuPG versions the @code{gpgme_op_genkey} function can be used.
4009 Existing code which wants to update to the new functions or new code
4010 which shall supports older GnuPG versions may try the new functions
4011 first and provide a fallback to the old function if the error code
4012 @code{GPG_ERR_NOT_SUPPORTED} is received.
4013
4014 @c
4015 @c  gpgme_op_createkey
4016 @c
4017 @deftypefun gpgme_error_t gpgme_op_createkey @
4018       (@w{gpgme_ctx_t @var{ctx}}, @
4019        @w{const char *@var{userid}}, @
4020        @w{const char *@var{algo}}, @
4021        @w{unsigned long @var{reserved}}, @
4022        @w{unsigned long @var{expires}}, @
4023        @w{gpgme_key_t @var{extrakey}}, @
4024        @w{unsigned int @var{flags}});
4025
4026 @since{1.7.0}
4027
4028 The function @code{gpgme_op_createkey} generates a new key for the
4029 procotol active in the context @var{ctx}.  As of now this function
4030 does only work for OpenPGP and requires at least version 2.1.13 of
4031 GnuPG.
4032
4033 @var{userid} is commonly the mail address associated with the key.
4034 GPGME does not require a specific syntax but if more than a mail
4035 address is given, RFC-822 style format is suggested.  The value is
4036 expected to be in UTF-8 encoding (i.e. no IDN encoding for mail
4037 addresses).  This is a required parameter.
4038
4039 @var{algo} specifies the algorithm for the new key (actually a keypair
4040 of public and private key).  For a list of supported algorithms, see
4041 the GnuPG manual.  If @var{algo} is @code{NULL} or the string
4042 "default", the key is generated using the default algorithm of the
4043 engine.  If the string "future-default" is used the engine may use an
4044 algorithm which is planned to be the default in a future release of
4045 the engine; however existing implementation of the protocol may not be
4046 able to already handle such future algorithms.  For the OpenPGP
4047 protocol, the specification of a default algorithm, without requesting
4048 a non-default usage via @var{flags}, triggers the creation of a
4049 primary key plus a secondary key (subkey).
4050
4051 @var{reserved} must be set to zero.
4052
4053 @var{expires} specifies the expiration time in seconds.  If you supply
4054 0, a reasonable expiration time is chosen.  Use the flag
4055 @code{GPGME_CREATE_NOEXPIRE} to create keys that do not expire.  Note
4056 that this parameter takes an unsigned long value and not a
4057 @code{time_t} to avoid problems on systems which use a signed 32 bit
4058 @code{time_t}.  Note further that the OpenPGP protocol uses 32 bit
4059 values for timestamps and thus can only encode dates up to the year
4060 2106.
4061
4062 @var{extrakey} is currently not used and must be set to @code{NULL}.
4063 A future version of GPGME may use this parameter to create X.509 keys.
4064
4065 @var{flags} can be set to the bit-wise OR of the following flags:
4066
4067 @table @code
4068 @item GPGME_CREATE_SIGN
4069 @itemx GPGME_CREATE_ENCR
4070 @itemx GPGME_CREATE_CERT
4071 @itemx GPGME_CREATE_AUTH
4072 @since{1.7.0}
4073
4074 Do not create the key with the default capabilities (key usage) of the
4075 requested algorithm but use those explicitly given by these flags:
4076 ``signing'', ``encryption'', ``certification'', or ``authentication''.
4077 The allowed combinations depend on the algorithm.
4078
4079 If any of these flags are set and a default algorithm has been
4080 selected only one key is created in the case of the OpenPGP
4081 protocol.
4082
4083 @item GPGME_CREATE_NOPASSWD
4084 @since{1.7.0}
4085
4086 Request generation of the key without password protection.
4087
4088 @item GPGME_CREATE_SELFSIGNED
4089 @since{1.7.0}
4090
4091 For an X.509 key do not create a CSR but a self-signed certificate.
4092 This has not yet been implemented.
4093
4094 @item GPGME_CREATE_NOSTORE
4095 @since{1.7.0}
4096
4097 Do not store the created key in the local key database.
4098 This has not yet been implemented.
4099
4100 @item GPGME_CREATE_WANTPUB
4101 @itemx GPGME_CREATE_WANTSEC
4102 @since{1.7.0}
4103
4104 Return the public or secret key as part of the result structure.
4105 This has not yet been implemented.
4106
4107 @item GPGME_CREATE_FORCE
4108 @since{1.7.0}
4109
4110 The engine does not allow the creation of a key with a user ID
4111 already existing in the local key database.  This flag can be used to
4112 override this check.
4113
4114 @item GPGME_CREATE_NOEXPIRE
4115 @since{1.8.0}
4116
4117 Request generation of keys that do not expire.
4118
4119 @end table
4120
4121 After the operation completed successfully, information about the
4122 created key can be retrieved with @code{gpgme_op_genkey_result}.
4123
4124 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4125 the engine does not support the command, or a bunch of other error
4126 codes.
4127
4128 @end deftypefun
4129
4130
4131 @deftypefun gpgme_error_t gpgme_op_createkey_start @
4132       (@w{gpgme_ctx_t @var{ctx}}, @
4133        @w{const char *@var{userid}}, @
4134        @w{const char *@var{algo}}, @
4135        @w{unsigned long @var{reserved}}, @
4136        @w{unsigned long @var{expires}}, @
4137        @w{gpgme_key_t @var{extrakey}}, @
4138        @w{unsigned int @var{flags}});
4139
4140 @since{1.7.0}
4141
4142 The function @code{gpgme_op_createkey_start} initiates a
4143 @code{gpgme_op_createkey} operation; see there for details.  It must
4144 be completed by calling @code{gpgme_wait} on the context.
4145 @xref{Waiting For Completion}.
4146
4147 @end deftypefun
4148
4149 @c
4150 @c  gpgme_op_createsubkey
4151 @c
4152 @deftypefun gpgme_error_t gpgme_op_createsubkey @
4153       (@w{gpgme_ctx_t @var{ctx}}, @
4154        @w{gpgme_key_t @var{key}}, @
4155        @w{const char *@var{algo}}, @
4156        @w{unsigned long @var{reserved}}, @
4157        @w{unsigned long @var{expires}}, @
4158        @w{unsigned int @var{flags}});
4159
4160 @since{1.7.0}
4161
4162 The function @code{gpgme_op_createsubkey} creates and adds a new
4163 subkey to the primary OpenPGP key given by @var{KEY}.  The only
4164 allowed protocol in @var{ctx} is @code{GPGME_PROTOCOL_OPENPGP}.
4165 Subkeys (aka secondary keys) are a concept in the OpenPGP protocol to
4166 bind several keys to a primary key.  As of now this function requires
4167 at least version 2.1.13 of GnuPG.
4168
4169 @var{key} specifies the key to operate on.
4170
4171 @var{algo} specifies the algorithm for the new subkey.  For a list of
4172 supported algorithms, see the GnuPG manual.  If @var{algo} is
4173 @code{NULL} or the string "default", the subkey is generated using the
4174 default algorithm for an encryption subkey of the engine.  If the
4175 string "future-default" is used the engine may use an encryption
4176 algorithm which is planned to be the default in a future release of
4177 the engine; however existing implementation of the protocol may not be
4178 able to already handle such future algorithms.
4179
4180 @var{reserved} must be set to zero.
4181
4182 @var{expires} specifies the expiration time in seconds.  If you supply
4183 0, a reasonable expiration time is chosen.  Use the flag
4184 @code{GPGME_CREATE_NOEXPIRE} to create keys that do not expire.  Note
4185 that this parameter takes an unsigned long value and not a
4186 @code{time_t} to avoid problems on systems which use a signed 32 bit
4187 @code{time_t}.  Note further that the OpenPGP protocol uses 32 bit
4188 values for timestamps and thus can only encode dates up to the year
4189 2106.
4190
4191 @var{flags} takes the same values as described above for
4192 @code{gpgme_op_createkey}.
4193
4194 After the operation completed successfully, information about the
4195 created key can be retrieved with @code{gpgme_op_genkey_result}.
4196
4197 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4198 the engine does not support the command, or a bunch of other error
4199 codes.
4200
4201
4202 @end deftypefun
4203
4204 @deftypefun gpgme_error_t gpgme_op_createsubkey_start @
4205       (@w{gpgme_ctx_t @var{ctx}}, @
4206        @w{gpgme_key_t @var{key}}, @
4207        @w{const char *@var{algo}}, @
4208        @w{unsigned long @var{reserved}}, @
4209        @w{unsigned long @var{expires}}, @
4210        @w{unsigned int @var{flags}});
4211
4212 @since{1.7.0}
4213
4214 The function @code{gpgme_op_createsubkey_start} initiates a
4215 @code{gpgme_op_createsubkey} operation; see there for details.  It must
4216 be completed by calling @code{gpgme_wait} on the context.
4217 @xref{Waiting For Completion}.
4218
4219 @end deftypefun
4220
4221
4222 @c
4223 @c  gpgme_op_adduid
4224 @c
4225 @deftypefun gpgme_error_t gpgme_op_adduid @
4226       (@w{gpgme_ctx_t @var{ctx}}, @
4227        @w{gpgme_key_t @var{key}}, @
4228        @w{const char *@var{userid}}, @
4229        @w{unsigned int @var{flags}});
4230
4231 @since{1.7.0}
4232
4233 The function @code{gpgme_op_adduid} adds a new user ID to the OpenPGP
4234 key given by @var{KEY}.  Adding additional user IDs after key creation
4235 is a feature of the OpenPGP protocol and thus the protocol for the
4236 context @var{ctx} must be set to OpenPGP.  As of now this function
4237 requires at least version 2.1.13 of GnuPG.
4238
4239 @var{key} specifies the key to operate on.
4240
4241 @var{userid} is the user ID to add to the key.  A user ID is commonly
4242 the mail address to be associated with the key.  GPGME does not
4243 require a specific syntax but if more than a mail address is given,
4244 RFC-822 style format is suggested.  The value is expected to be in
4245 UTF-8 encoding (i.e. no IDN encoding for mail addresses).  This is a
4246 required parameter.
4247
4248 @var{flags} are currently not used and must be set to zero.
4249
4250 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4251 the engine does not support the command, or a bunch of other error
4252 codes.
4253
4254 @end deftypefun
4255
4256 @deftypefun gpgme_error_t gpgme_op_adduid_start @
4257       (@w{gpgme_ctx_t @var{ctx}}, @
4258        @w{gpgme_key_t @var{key}}, @
4259        @w{const char *@var{userid}}, @
4260        @w{unsigned int @var{flags}});
4261
4262 @since{1.7.0}
4263
4264 The function @code{gpgme_op_adduid_start} initiates a
4265 @code{gpgme_op_adduid} operation; see there for details.  It must
4266 be completed by calling @code{gpgme_wait} on the context.
4267 @xref{Waiting For Completion}.
4268
4269 @end deftypefun
4270
4271
4272 @c
4273 @c  gpgme_op_revuid
4274 @c
4275 @deftypefun gpgme_error_t gpgme_op_revuid @
4276       (@w{gpgme_ctx_t @var{ctx}}, @
4277        @w{gpgme_key_t @var{key}}, @
4278        @w{const char *@var{userid}}, @
4279        @w{unsigned int @var{flags}});
4280
4281 @since{1.7.0}
4282
4283 The function @code{gpgme_op_revuid} revokes a user ID from the OpenPGP
4284 key given by @var{KEY}.  Revoking user IDs after key creation is a
4285 feature of the OpenPGP protocol and thus the protocol for the context
4286 @var{ctx} must be set to OpenPGP.  As of now this function requires at
4287 least version 2.1.13 of GnuPG.
4288
4289 @var{key} specifies the key to operate on.
4290
4291 @var{userid} is the user ID to be revoked from the key.  The user ID
4292 must be given verbatim because the engine does an exact and case
4293 sensitive match.  Thus the @code{uid} field from the user ID object
4294 (@code{gpgme_user_id_t}) is to be used.  This is a required parameter.
4295
4296 @var{flags} are currently not used and must be set to zero.
4297
4298 Note that the engine won't allow to revoke the last valid user ID.  To
4299 change a user ID is better to first add the new user ID, then revoke
4300 the old one, and finally publish the key.
4301
4302 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4303 the engine does not support the command, or a bunch of other error
4304 codes.
4305
4306 @end deftypefun
4307
4308 @deftypefun gpgme_error_t gpgme_op_revuid_start @
4309       (@w{gpgme_ctx_t @var{ctx}}, @
4310        @w{gpgme_key_t @var{key}}, @
4311        @w{const char *@var{userid}}, @
4312        @w{unsigned int @var{flags}});
4313
4314 @since{1.7.0}
4315
4316 The function @code{gpgme_op_revuid_start} initiates a
4317 @code{gpgme_op_revuid} operation; see there for details.  It must
4318 be completed by calling @code{gpgme_wait} on the context.
4319 @xref{Waiting For Completion}.
4320
4321 @end deftypefun
4322
4323
4324 @c
4325 @c  gpgme_op_set_uid_flag
4326 @c
4327 @deftypefun gpgme_error_t gpgme_op_set_ui_flag @
4328       (@w{gpgme_ctx_t @var{ctx}}, @
4329        @w{gpgme_key_t @var{key}}, @
4330        @w{const char *@var{userid}}, @
4331        @w{cons char * @var{name}}, @
4332        @w{cons char * @var{value}});
4333
4334 @since{1.8.0}
4335
4336 The function @code{gpgme_op_set_uid_flag} is used to set flags on a
4337 user ID from the OpenPGP key given by @var{KEY}.  Setting flags on
4338 user IDs after key creation is a feature of the OpenPGP protocol and
4339 thus the protocol for the context @var{ctx} must be set to OpenPGP.
4340
4341 @var{key} specifies the key to operate on.  This parameters is required.
4342
4343 @var{userid} is the user ID of the key to be manipulated.  This user ID
4344 must be given verbatim because the engine does an exact and case
4345 sensitive match.  Thus the @code{uid} field from the user ID object
4346 (@code{gpgme_user_id_t}) is to be used.  This is a required parameter.
4347
4348 @var{name} names the flag which is to be changed.  The only currently
4349 supported flag is:
4350
4351 @table @code
4352 @item primary
4353 This sets the primary key flag on the given user ID.  All other
4354 primary key flag on other user IDs are removed.  @var{value} must be
4355 given as NULL.  For technical reasons this functions bumps the
4356 creation timestamp of all affected self-signatures up by one second.
4357 At least GnuPG version 2.1.20 is required.
4358
4359 @end table
4360
4361 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4362 the engine does not support the command, or a bunch of other error
4363 codes.
4364
4365 @end deftypefun
4366
4367 @deftypefun gpgme_error_t gpgme_op_set_uid_flag_start @
4368       (@w{gpgme_ctx_t @var{ctx}}, @
4369        @w{gpgme_key_t @var{key}}, @
4370        @w{const char *@var{userid}}, @
4371        @w{cons char * @var{name}}, @
4372        @w{cons char * @var{value}});
4373
4374 @since{1.8.0}
4375
4376 The function @code{gpgme_op_set_uid_flag_start} initiates a
4377 @code{gpgme_op_set_uid_flag} operation; see there for details.  It must
4378 be completed by calling @code{gpgme_wait} on the context.
4379 @xref{Waiting For Completion}.
4380
4381 @end deftypefun
4382
4383 @c
4384 @c  gpgme_op_genkey
4385 @c
4386 @deftypefun gpgme_error_t gpgme_op_genkey @
4387       (@w{gpgme_ctx_t @var{ctx}}, @
4388        @w{const char *@var{parms}}, @
4389        @w{gpgme_data_t @var{public}}, @
4390        @w{gpgme_data_t @var{secret}})
4391
4392 The function @code{gpgme_op_genkey} generates a new key pair in the
4393 context @var{ctx}.  The meaning of @var{public} and @var{secret}
4394 depends on the crypto backend.
4395
4396 GPG does not support @var{public} and @var{secret}, they should be
4397 @code{NULL}.  GnuPG will generate a key pair and add it to the
4398 standard key ring.  The fingerprint of the generated key is available
4399 with @code{gpgme_op_genkey_result}.
4400
4401 GpgSM requires @var{public} to be a writable data object.  GpgSM will
4402 generate a secret key (which will be stored by @command{gpg-agent},
4403 and return a certificate request in @var{public}, which then needs to
4404 be signed by the certification authority and imported before it can be
4405 used.  GpgSM does not make the fingerprint available.
4406
4407 The argument @var{parms} specifies parameters for the key in an string
4408 that looks something like XML.  The details about the format of
4409 @var{parms} are specific to the crypto engine used by @var{ctx}.  The
4410 first line of the parameters must be @code{<GnupgKeyParams
4411 format="internal">} and the last line must be
4412 @code{</GnupgKeyParams>}.  Every line in between the first and last
4413 lines is treated as a Header: Value pair.  In particular, no XML
4414 escaping is necessary if you need to include the characters @code{<},
4415 @code{>}, or @code{&}.
4416
4417 Here is an example for GnuPG as the crypto engine (all parameters of
4418 OpenPGP key generation are documented in the GPG manual):
4419
4420 @example
4421 <GnupgKeyParms format="internal">
4422 Key-Type: default
4423 Subkey-Type: default
4424 Name-Real: Joe Tester
4425 Name-Comment: with stupid passphrase
4426 Name-Email: joe@@foo.bar
4427 Expire-Date: 0
4428 Passphrase: abc
4429 </GnupgKeyParms>
4430 @end example
4431
4432 Here is an example for GpgSM as the crypto engine (all parameters of
4433 OpenPGP key generation are documented in the GPGSM manual):
4434
4435 @example
4436 <GnupgKeyParms format="internal">
4437 Key-Type: RSA
4438 Key-Length: 1024
4439 Name-DN: C=de,O=g10 code,OU=Testlab,CN=Joe 2 Tester
4440 Name-Email: joe@@foo.bar
4441 </GnupgKeyParms>
4442 @end example
4443
4444 Strings should be given in UTF-8 encoding.  The only format supported
4445 for now is ``internal''.  The content of the @code{GnupgKeyParms}
4446 container is passed verbatim to the crypto backend.  Control
4447 statements are not allowed.
4448
4449 After the operation completed successfully, the result can be
4450 retrieved with @code{gpgme_op_genkey_result}.
4451
4452 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4453 operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
4454 @var{parms} is not a well-formed string (e.g. does not have the
4455 expected tag-like headers and footers), @code{GPG_ERR_NOT_SUPPORTED}
4456 if @var{public} or @var{secret} is not valid, and
4457 @code{GPG_ERR_GENERAL} if no key was created by the backend.
4458 @end deftypefun
4459
4460 @deftypefun gpgme_error_t gpgme_op_genkey_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{parms}}, @w{gpgme_data_t @var{public}}, @w{gpgme_data_t @var{secret}})
4461
4462 The function @code{gpgme_op_genkey_start} initiates a
4463 @code{gpgme_op_genkey} operation.  It can be completed by calling
4464 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
4465
4466 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4467 operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
4468 @var{parms} is not a valid XML string, and
4469 @code{GPG_ERR_NOT_SUPPORTED} if @var{public} or @var{secret} is not
4470 @code{NULL}.
4471 @end deftypefun
4472
4473
4474 @c
4475 @c  gpgme_op_genkey_result
4476 @c
4477 @deftp {Data type} {gpgme_genkey_result_t}
4478
4479 This is a pointer to a structure used to store the result of a
4480 @code{gpgme_op_genkey} operation.  After successfully generating a
4481 key, you can retrieve the pointer to the result with
4482 @code{gpgme_op_genkey_result}.  The structure contains the following
4483 members:
4484
4485 @table @code
4486 @item unsigned int primary : 1
4487 This flag is set to 1 if a primary key was created and to 0
4488 if not.
4489
4490 @item unsigned int sub : 1
4491 This flag is set to 1 if a subkey was created and to 0 if not.
4492
4493 @item unsigned int uid : 1
4494 This flag is set to 1 if a user ID was created and to 0 if not.
4495
4496 @item char *fpr
4497 This is the fingerprint of the key that was created.  If both a
4498 primary and a subkey were generated, the fingerprint of the primary
4499 key will be returned.  If the crypto engine does not provide the
4500 fingerprint, @code{fpr} will be a null pointer.
4501
4502 @item gpgme_data_t pubkey
4503 @since{1.7.0}
4504
4505 This will eventually be used to return the public key.  It is
4506 currently not used.
4507
4508 @item gpgme_data_t seckey
4509 @since{1.7.0}
4510
4511 This will eventually be used to return the secret key.  It is
4512 currently not used.
4513
4514 @end table
4515 @end deftp
4516
4517 @deftypefun gpgme_genkey_result_t gpgme_op_genkey_result (@w{gpgme_ctx_t @var{ctx}})
4518
4519 The function @code{gpgme_op_genkey_result} returns a
4520 @code{gpgme_genkey_result_t} pointer to a structure holding the result of
4521 a @code{gpgme_op_genkey} operation.  The pointer is only valid if the
4522 last operation on the context was a @code{gpgme_op_genkey} or
4523 @code{gpgme_op_genkey_start} operation, and if this operation finished
4524 successfully.  The returned pointer is only valid until the next
4525 operation is started on the context.
4526
4527 @end deftypefun
4528
4529
4530 @c
4531 @c  SIGNING KEYS
4532 @c
4533 @node Signing Keys
4534 @subsection Signing Keys
4535 @cindex key, signing
4536
4537 Key signatures are a unique concept of the OpenPGP protocol.  They can
4538 be used to certify the validity of a key and are used to create the
4539 Web-of-Trust (WoT).  Instead of using the @code{gpgme_op_interact}
4540 function along with a finite state machine, GPGME provides a
4541 convenient function to create key signatures when using modern GnuPG
4542 versions.
4543
4544
4545 @c
4546 @c  gpgme_op_keysign
4547 @c
4548 @deftypefun gpgme_error_t gpgme_op_keysign @
4549       (@w{gpgme_ctx_t @var{ctx}}, @
4550        @w{gpgme_key_t @var{key}}, @
4551        @w{const char *@var{userid}}, @
4552        @w{unsigned long @var{expires}}, @
4553        @w{unsigned int @var{flags}});
4554
4555 @since{1.7.0}
4556
4557 The function @code{gpgme_op_keysign} adds a new key signature to the
4558 public key @var{KEY}.   This function requires at least version 2.1.12 of
4559 GnuPG.
4560
4561 @var{CTX} is the usual context which describes the protocol to use
4562 (which must be OpenPGP) and has also the list of signer keys to be
4563 used for the signature.  The common case is to use the default key for
4564 signing other keys.  If another key or more than one key shall be used
4565 for a key signature, @code{gpgme_signers_add} can be used.
4566 @xref{Selecting Signers}.
4567
4568 @var{key} specifies the key to operate on.
4569
4570 @var{userid} selects the user ID or user IDs to be signed.  If
4571 @var{userid} is set to @code{NULL} all valid user IDs are signed.  The
4572 user ID must be given verbatim because the engine does an exact and
4573 case sensitive match.  Thus the @code{uid} field from the user ID
4574 object (@code{gpgme_user_id_t}) is to be used.  To select more than
4575 one user ID put them all into one string separated by linefeeds
4576 characters (@code{\n}) and set the flag @code{GPGME_KEYSIGN_LFSEP}.
4577
4578 @var{expires} specifies the expiration time of the new signature in
4579 seconds.  The common case is to use 0 to not set an expiration date.
4580 However, if the configuration of the engine defines a default
4581 expiration for key signatures, that is still used unless the flag
4582 @code{GPGME_KEYSIGN_NOEXPIRE} is used.  Note that this parameter takes
4583 an unsigned long value and not a @code{time_t} to avoid problems on
4584 systems which use a signed 32 bit @code{time_t}.  Note further that
4585 the OpenPGP protocol uses 32 bit values for timestamps and thus can
4586 only encode dates up to the year 2106.
4587
4588 @var{flags} can be set to the bit-wise OR of the following flags:
4589
4590 @table @code
4591 @item GPGME_KEYSIGN_LOCAL
4592 @since{1.7.0}
4593
4594 Instead of creating an exportable key signature, create a key
4595 signature which is is marked as non-exportable.
4596
4597 @item GPGME_KEYSIGN_LFSEP
4598 @since{1.7.0}
4599
4600 Although linefeeds are uncommon in user IDs this flag is required to
4601 explicitly declare that @var{userid} may contain several linefeed
4602 separated user IDs.
4603
4604 @item GPGME_KEYSIGN_NOEXPIRE
4605 Force the creation of a key signature without an expiration date.  This
4606 overrides @var{expire} and any local configuration of the engine.
4607
4608 @end table
4609
4610 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4611 the engine does not support the command, or a bunch of other error
4612 codes.
4613
4614 @end deftypefun
4615
4616
4617 @deftypefun gpgme_error_t gpgme_op_keysign_start @
4618       (@w{gpgme_ctx_t @var{ctx}}, @
4619        @w{gpgme_key_t @var{key}}, @
4620        @w{const char *@var{userid}}, @
4621        @w{unsigned long @var{expires}}, @
4622        @w{unsigned int @var{flags}});
4623
4624 @since{1.7.0}
4625
4626 The function @code{gpgme_op_keysign_start} initiates a
4627 @code{gpgme_op_keysign} operation; see there for details.  It must
4628 be completed by calling @code{gpgme_wait} on the context.
4629 @xref{Waiting For Completion}.
4630
4631 @end deftypefun
4632
4633
4634 @c
4635 @c  EXPORTING KEYS
4636 @c
4637 @node Exporting Keys
4638 @subsection Exporting Keys
4639 @cindex key, export
4640 @cindex key ring, export from
4641
4642 Exporting keys means the same as running @command{gpg} with the command
4643 @option{--export}.  However, a mode flag can be used to change the way
4644 the export works.  The available mode flags are described below, they
4645 may be or-ed together.
4646
4647 @table @code
4648
4649 @item GPGME_EXPORT_MODE_EXTERN
4650 If this bit is set, the output is send directly to the default
4651 keyserver. This is currently only allowed for OpenPGP keys.  It is good
4652 practise to not send more than a few dozens key to a keyserver at one
4653 time.  Using this flag requires that the @var{keydata} argument of the
4654 export function is set to @code{NULL}.
4655
4656 @item GPGME_EXPORT_MODE_MINIMAL
4657 @since{1.3.1}
4658
4659 If this bit is set, the smallest possible key is exported.  For OpenPGP
4660 keys it removes all signatures except for the latest self-signatures.
4661 For X.509 keys it has no effect.
4662
4663
4664 @item GPGME_EXPORT_MODE_SECRET
4665 @since{1.6.0}
4666
4667 Instead of exporting the public key, the secret key is exported.  This
4668 may not be combined with @code{GPGME_EXPORT_MODE_EXTERN}.  For X.509
4669 the export format is PKCS#8.
4670
4671 @item GPGME_EXPORT_MODE_RAW
4672 @since{1.6.0}
4673
4674 If this flag is used with @code{GPGME_EXPORT_MODE_SECRET} for an X.509
4675 key the export format will be changed to PKCS#1.  This flag may not be
4676 used with OpenPGP.
4677
4678 @item GPGME_EXPORT_MODE_PKCS12
4679 @since{1.6.0}
4680
4681 If this flag is used with @code{GPGME_EXPORT_MODE_SECRET} for an X.509
4682 key the export format will be changed to PKCS#12 which also includes
4683 the certificate.  This flag may not be used with OpenPGP.
4684
4685 @item GPGME_EXPORT_MODE_NOUID
4686 @since{1.12.0 - experimental}
4687 Do not export user ids.  Works only with certain gpg version.
4688
4689 @end table
4690
4691
4692
4693 @deftypefun gpgme_error_t gpgme_op_export (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{gpgme_export_mode_t @var{mode}}, @w{gpgme_data_t @var{keydata}})
4694 The function @code{gpgme_op_export} extracts public keys and returns
4695 them in the data buffer @var{keydata}.  The output format of the key
4696 data returned is determined by the @acronym{ASCII} armor attribute set
4697 for the context @var{ctx}, or, if that is not set, by the encoding
4698 specified for @var{keydata}.
4699
4700 If @var{pattern} is @code{NULL}, all available keys are returned.
4701 Otherwise, @var{pattern} contains an engine specific expression that
4702 is used to limit the list to all keys matching the pattern.
4703
4704 @var{mode} is usually 0; other values are described above.
4705
4706 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4707 operation completed successfully, @code{GPG_ERR_INV_VALUE} if
4708 @var{keydata} is not a valid empty data buffer, and passes through any
4709 errors that are reported by the crypto engine support routines.
4710 @end deftypefun
4711
4712 @deftypefun gpgme_error_t gpgme_op_export_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{gpgme_export_mode_t @var{mode}}, @w{gpgme_data_t @var{keydata}})
4713 The function @code{gpgme_op_export_start} initiates a
4714 @code{gpgme_op_export} operation.  It can be completed by calling
4715 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
4716
4717 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4718 operation could be started successfully, and @code{GPG_ERR_INV_VALUE}
4719 if @var{keydata} is not a valid empty data buffer.
4720 @end deftypefun
4721
4722 @deftypefun gpgme_error_t gpgme_op_export_ext (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}[]}, @w{gpgme_export_mode_t @var{mode}}, @w{gpgme_data_t @var{keydata}})
4723 The function @code{gpgme_op_export} extracts public keys and returns
4724 them in the data buffer @var{keydata}.  The output format of the key
4725 data returned is determined by the @acronym{ASCII} armor attribute set
4726 for the context @var{ctx}, or, if that is not set, by the encoding
4727 specified for @var{keydata}.
4728
4729 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
4730 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
4731 array of strings that are used to limit the list to all keys matching
4732 at least one of the patterns verbatim.
4733
4734 @var{mode} is usually 0; other values are described above.
4735
4736 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4737 operation completed successfully, @code{GPG_ERR_INV_VALUE} if
4738 @var{keydata} is not a valid empty data buffer, and passes through any
4739 errors that are reported by the crypto engine support routines.
4740 @end deftypefun
4741
4742 @deftypefun gpgme_error_t gpgme_op_export_ext_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}[]}, @w{gpgme_export_mode_t @var{mode}}, @w{gpgme_data_t @var{keydata}})
4743 The function @code{gpgme_op_export_ext_start} initiates a
4744 @code{gpgme_op_export_ext} operation.  It can be completed by calling
4745 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
4746
4747 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4748 operation could be started successfully, and @code{GPG_ERR_INV_VALUE}
4749 if @var{keydata} is not a valid empty data buffer.
4750 @end deftypefun
4751
4752
4753 @deftypefun gpgme_error_t gpgme_op_export_keys (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t keys[]}, @w{gpgme_export_mode_t @var{mode}}, @w{gpgme_data_t @var{keydata}})
4754 @since{1.2.0}
4755
4756 The function @code{gpgme_op_export_keys} extracts public keys and returns
4757 them in the data buffer @var{keydata}.  The output format of the key
4758 data returned is determined by the @acronym{ASCII} armor attribute set
4759 for the context @var{ctx}, or, if that is not set, by the encoding
4760 specified for @var{keydata}.
4761
4762 The keys to export are taken form the @code{NULL} terminated array
4763 @var{keys}.  Only keys of the currently selected protocol of
4764 @var{ctx} which do have a fingerprint set are considered for export.
4765 Other keys specified by the @var{keys} are ignored.  In particular
4766 OpenPGP keys retrieved via an external key listing are not included.
4767
4768 @var{mode} is usually 0; other values are described above.
4769
4770 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4771 operation completed successfully, @code{GPG_ERR_INV_VALUE} if
4772 @var{keydata} is not a valid empty data buffer, @code{GPG_ERR_NO_DATA}
4773 if no useful keys are in @var{keys} and passes through any errors that
4774 are reported by the crypto engine support routines.
4775 @end deftypefun
4776
4777 @deftypefun gpgme_error_t gpgme_op_export_keys_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t @var{keys}[]}, @w{gpgme_export_mode_t @var{mode}}, @w{gpgme_data_t @var{keydata}})
4778 @since{1.2.0}
4779
4780 The function @code{gpgme_op_export_keys_start} initiates a
4781 @code{gpgme_op_export_ext} operation.  It can be completed by calling
4782 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
4783
4784 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4785 operation could be started successfully, and @code{GPG_ERR_INV_VALUE}
4786 if @var{keydata} is not a valid empty data buffer, @code{GPG_ERR_NO_DATA}
4787 if no useful keys are in @var{keys} and passes through any errors that
4788 are reported by the crypto engine support routines.
4789 @end deftypefun
4790
4791
4792 @node Importing Keys
4793 @subsection Importing Keys
4794 @cindex key, import
4795 @cindex key ring, import to
4796
4797 Importing keys means the same as running @command{gpg} with the command
4798 @option{--import}.
4799
4800
4801 @deftypefun gpgme_error_t gpgme_op_import (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}})
4802 The function @code{gpgme_op_import} adds the keys in the data buffer
4803 @var{keydata} to the key ring of the crypto engine used by @var{ctx}.
4804 The format of @var{keydata} can be @acronym{ASCII} armored, for example,
4805 but the details are specific to the crypto engine.
4806
4807 After the operation completed successfully, the result can be
4808 retrieved with @code{gpgme_op_import_result}.
4809
4810 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4811 import was completed successfully, @code{GPG_ERR_INV_VALUE} if
4812 @var{keydata} if @var{ctx} or @var{keydata} is not a valid pointer,
4813 and @code{GPG_ERR_NO_DATA} if @var{keydata} is an empty data buffer.
4814 @end deftypefun
4815
4816 @deftypefun gpgme_error_t gpgme_op_import_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}})
4817 The function @code{gpgme_op_import_start} initiates a
4818 @code{gpgme_op_import} operation.  It can be completed by calling
4819 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
4820
4821 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4822 import could be started successfully, @code{GPG_ERR_INV_VALUE} if
4823 @var{ctx} or @var{keydata} is not a valid pointer, and
4824 @code{GPG_ERR_NO_DATA} if @var{keydata} is an empty data buffer.
4825 @end deftypefun
4826
4827 @deftypefun gpgme_error_t gpgme_op_import_keys (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{keys}})
4828 @since{1.2.0}
4829
4830 The function @code{gpgme_op_import_keys} adds the keys described by
4831 the @code{NULL} terminated array @var{keys} to the key ring of the
4832 crypto engine used by @var{ctx}.  It is used to actually import and
4833 make keys permanent which have been retrieved from an external source
4834 (i.e. using @code{GPGME_KEYLIST_MODE_EXTERN}) earlier.  The external
4835 keylisting must have been made with the same context configuration (in
4836 particular the same home directory).  @footnote{Thus it is a
4837 replacement for the usual workaround of exporting and then importing a
4838 key to make an X.509 key permanent.}  Note that for OpenPGP this may
4839 require another access to the keyserver over the network.
4840
4841 Only keys of the currently selected protocol of @var{ctx} are
4842 considered for import.  Other keys specified by the @var{keys} are
4843 ignored.  As of now all considered keys must have been retrieved using
4844 the same method, i.e. the used key listing mode must be identical.
4845
4846 After the operation completed successfully, the result can be
4847 retrieved with @code{gpgme_op_import_result}.
4848
4849 To move keys from one home directory to another, export and import the
4850 keydata using @code{gpgme_op_export} and @code{gpgme_op_import}.
4851
4852 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4853 import was completed successfully, @code{GPG_ERR_INV_VALUE} if
4854 @var{ctx} is not a valid pointer, @code{GPG_ERR_CONFLICT} if the key
4855 listing mode does not match, and @code{GPG_ERR_NO_DATA} if no keys are
4856 considered for export.
4857 @end deftypefun
4858
4859 @deftypefun gpgme_error_t gpgme_op_import_keys_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{keys}})
4860 @since{1.2.0}
4861
4862 The function @code{gpgme_op_import_keys_start} initiates a
4863 @code{gpgme_op_import_keys} operation.  It can be completed by calling
4864 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
4865
4866 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4867 import was completed successfully, @code{GPG_ERR_INV_VALUE} if
4868 @var{keydata} if @var{ctx} or @var{keydata} is not a valid pointer,
4869 @code{GPG_ERR_CONFLICT} if the key listing mode does not match, and
4870 @code{GPG_ERR_NO_DATA} if no keys are considered for export.
4871 @end deftypefun
4872
4873 @deftp {Data type} {gpgme_import_status_t}
4874 This is a pointer to a structure used to store a part of the result of
4875 a @code{gpgme_op_import} operation.  For each considered key one
4876 status is added that contains information about the result of the
4877 import.  The structure contains the following members:
4878
4879 @table @code
4880 @item gpgme_import_status_t next
4881 This is a pointer to the next status structure in the linked list, or
4882 @code{NULL} if this is the last element.
4883
4884 @item char *fpr
4885 This is the fingerprint of the key that was considered.
4886
4887 @item gpgme_error_t result
4888 If the import was not successful, this is the error value that caused
4889 the import to fail.  Otherwise the error code is
4890 @code{GPG_ERR_NO_ERROR}.
4891
4892 @item unsigned int status
4893 This is a bit-wise OR of the following flags that give more
4894 information about what part of the key was imported.  If the key was
4895 already known, this might be 0.
4896
4897 @table @code
4898 @item GPGME_IMPORT_NEW
4899 The key was new.
4900
4901 @item GPGME_IMPORT_UID
4902 The key contained new user IDs.
4903
4904 @item GPGME_IMPORT_SIG
4905 The key contained new signatures.
4906
4907 @item GPGME_IMPORT_SUBKEY
4908 The key contained new sub keys.
4909
4910 @item GPGME_IMPORT_SECRET
4911 The key contained a secret key.
4912 @end table
4913 @end table
4914 @end deftp
4915
4916 @deftp {Data type} {gpgme_import_result_t}
4917 This is a pointer to a structure used to store the result of a
4918 @code{gpgme_op_import} operation.  After a successful import
4919 operation, you can retrieve the pointer to the result with
4920 @code{gpgme_op_import_result}.  The structure contains the following
4921 members:
4922
4923 @table @code
4924 @item int considered
4925 The total number of considered keys.
4926
4927 @item int no_user_id
4928 The number of keys without user ID.
4929
4930 @item int imported
4931 The total number of imported keys.
4932
4933 @item int imported_rsa
4934 The number of imported RSA keys.
4935
4936 @item int unchanged
4937 The number of unchanged keys.
4938
4939 @item int new_user_ids
4940 The number of new user IDs.
4941
4942 @item int new_sub_keys
4943 The number of new sub keys.
4944
4945 @item int new_signatures
4946 The number of new signatures.
4947
4948 @item int new_revocations
4949 The number of new revocations.
4950
4951 @item int secret_read
4952 The total number of secret keys read.
4953
4954 @item int secret_imported
4955 The number of imported secret keys.
4956
4957 @item int secret_unchanged
4958 The number of unchanged secret keys.
4959
4960 @item int not_imported
4961 The number of keys not imported.
4962
4963 @item gpgme_import_status_t imports
4964 A list of gpgme_import_status_t objects which contain more information
4965 about the keys for which an import was attempted.
4966
4967 @item int skipped_v3_keys
4968 For security reasons modern versions of GnuPG do not anymore support
4969 v3 keys (created with PGP 2.x) and ignores them on import.  This
4970 counter provides the number of such skipped v3 keys.
4971
4972 @end table
4973 @end deftp
4974
4975 @deftypefun gpgme_import_result_t gpgme_op_import_result (@w{gpgme_ctx_t @var{ctx}})
4976 The function @code{gpgme_op_import_result} returns a
4977 @code{gpgme_import_result_t} pointer to a structure holding the result
4978 of a @code{gpgme_op_import} operation.  The pointer is only valid if
4979 the last operation on the context was a @code{gpgme_op_import} or
4980 @code{gpgme_op_import_start} operation, and if this operation finished
4981 successfully.  The returned pointer is only valid until the next
4982 operation is started on the context.
4983 @end deftypefun
4984
4985 @node Deleting Keys
4986 @subsection Deleting Keys
4987 @cindex key, delete
4988 @cindex key ring, delete from
4989
4990 @deftypefun gpgme_error_t gpgme_op_delete_ext (@w{gpgme_ctx_t @var{ctx}}, @w{const gpgme_key_t @var{key}}, @w{unsigned int @var{flags}})
4991 @since{1.9.1}
4992
4993 The function @code{gpgme_op_delete_ext} deletes the key @var{key} from
4994 the key ring of the crypto engine used by @var{ctx}.
4995
4996 @var{flags} can be set to the bit-wise OR of the following flags:
4997
4998 @table @code
4999 @item GPGME_DELETE_ALLOW_SECRET
5000 @since{1.9.1}
5001
5002 If not set, only public keys are deleted. If set, secret keys are
5003 deleted as well, if that is supported.
5004
5005 @item GPGME_DELETE_FORCE
5006 @since{1.9.1}
5007
5008 If set, the user is not asked to confirm the deletion.
5009 @end table
5010
5011 The function returns the error code @code{GPG_ERR_NO_ERROR} if the key
5012 was deleted successfully, @code{GPG_ERR_INV_VALUE} if @var{ctx} or
5013 @var{key} is not a valid pointer, @code{GPG_ERR_NO_PUBKEY} if
5014 @var{key} could not be found in the keyring,
5015 @code{GPG_ERR_AMBIGUOUS_NAME} if the key was not specified
5016 unambiguously, and @code{GPG_ERR_CONFLICT} if the secret key for
5017 @var{key} is available, but @var{allow_secret} is zero.
5018 @end deftypefun
5019
5020 @deftypefun gpgme_error_t gpgme_op_delete_ext_start (@w{gpgme_ctx_t @var{ctx}}, @w{const gpgme_key_t @var{key}}, @w{unsigned int @var{flags}})
5021 @since{1.9.1}
5022
5023 The function @code{gpgme_op_delete_ext_start} initiates a
5024 @code{gpgme_op_delete} operation.  It can be completed by calling
5025 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
5026
5027 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
5028 operation was started successfully, and @code{GPG_ERR_INV_VALUE} if
5029 @var{ctx} or @var{key} is not a valid pointer.
5030 @end deftypefun
5031
5032 The following functions allow only to use one particular flag.
5033
5034 @deftypefun gpgme_error_t gpgme_op_delete (@w{gpgme_ctx_t @var{ctx}}, @w{const gpgme_key_t @var{key}}, @w{int @var{allow_secret}})
5035 Similar to @code{gpgme_op_delete_ext}, but only the flag
5036 @code{GPGME_DELETE_ALLOW_SECRET} can be provided.
5037 @end deftypefun
5038
5039 @deftypefun gpgme_error_t gpgme_op_delete_start (@w{gpgme_ctx_t @var{ctx}}, @w{const gpgme_key_t @var{key}}, @w{int @var{allow_secret}})
5040 Similar to @code{gpgme_op_delete_ext_start}, but only the flag
5041 @code{GPGME_DELETE_ALLOW_SECRET} can be provided.
5042 @end deftypefun
5043
5044
5045 @node Changing Passphrases
5046 @subsection Changing Passphrases
5047 @cindex passphrase, change
5048
5049 @deftypefun gpgme_error_t gpgme_op_passwd      @
5050              (@w{gpgme_ctx_t @var{ctx}},       @
5051               @w{const gpgme_key_t @var{key}}, @
5052               @w{unsigned int @var{flags}})
5053
5054 @since{1.3.0}
5055
5056 The function @code{gpgme_op_passwd} changes the passphrase of the
5057 private key associated with @var{key}.  The only allowed value for
5058 @var{flags} is @code{0}.  The backend engine will usually popup a window
5059 to ask for the old and the new passphrase.  Thus this function is not
5060 useful in a server application (where passphrases are not required
5061 anyway).
5062
5063 Note that old @code{gpg} engines (before version 2.0.15) do not support
5064 this command and will silently ignore it.
5065 @end deftypefun
5066
5067 @deftypefun gpgme_error_t gpgme_op_passwd_start      @
5068              (@w{gpgme_ctx_t @var{ctx}},       @
5069               @w{const gpgme_key_t @var{key}}, @
5070               @w{unsigned int @var{flags}})
5071
5072 @since{1.3.0}
5073
5074 The function @code{gpgme_op_passwd_start} initiates a
5075 @code{gpgme_op_passwd} operation.    It can be completed by calling
5076 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
5077
5078 The function returns @code{0} if the operation was started successfully,
5079 and an error code if one of the arguments is not valid or the oepration
5080 could not be started.
5081 @end deftypefun
5082
5083
5084 @c
5085 @c  CHANGING TOFU DATA
5086 @c
5087 @node Changing TOFU Data
5088 @subsection Changing TOFU Data
5089 @cindex validity, TOFU
5090
5091 The OpenPGP engine features a Trust-On-First-Use (TOFU) key validation
5092 model.  For resolving conflicts it is necessary to declare the policy
5093 for a key.  See the GnuPG manual for details on the TOFU
5094 implementation.
5095
5096 @deftp {Data type} {enum gpgme_tofu_policy_t}
5097 @since{1.7.0}
5098
5099 @tindex gpgme_tofu_policy_t
5100 The @code{gpgme_tofu_policy_t} type specifies the set of possible
5101 policy values that are supported by @acronym{GPGME}:
5102
5103 @table @code
5104 @item GPGME_TOFU_POLICY_AUTO
5105 Set the policy to ``auto''.
5106 @item GPGME_TOFU_POLICY_GOOD
5107 Set the policy to ``good''.
5108 @item GPGME_TOFU_POLICY_BAD
5109 Set the policy to ``bad''.
5110 @item GPGME_TOFU_POLICY_ASK
5111 Set the policy to ``ask''.
5112 @item GPGME_TOFU_POLICY_UNKNOWN
5113 Set the policy to ``unknown''.
5114 @end table
5115
5116 @end deftp
5117
5118 To change the policy for a key the following functions can be used:
5119
5120 @deftypefun gpgme_error_t gpgme_op_tofu_policy @
5121              (@w{gpgme_ctx_t @var{ctx}},       @
5122               @w{const gpgme_key_t @var{key}}, @
5123               @w{gpgme_tofu_policy_t @var{policy}})
5124
5125 @since{1.7.0}
5126
5127 The function @code{gpgme_op_tofu_policy} changes the TOFU policy of
5128 @var{key}.  The valid values for @var{policy} are listed above.  As of
5129 now this function does only work for OpenPGP and requires at least
5130 version 2.1.10 of GnuPG.
5131
5132 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
5133 the engine does not support the command, or a bunch of other error
5134 codes.
5135
5136 @end deftypefun
5137
5138 @deftypefun gpgme_error_t gpgme_op_tofu_policy_start @
5139              (@w{gpgme_ctx_t @var{ctx}},       @
5140               @w{const gpgme_key_t @var{key}}, @
5141               @w{gpgme_tofu_policy_t @var{policy}})
5142
5143 @since{1.7.0}
5144
5145 The function @code{gpgme_op_tofu_policy_start} initiates a
5146 @code{gpgme_op_tofu_policy} operation.    It can be completed by calling
5147 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
5148
5149 The function returns @code{0} if the operation was started successfully,
5150 and an error code if one of the arguments is not valid or the oepration
5151 could not be started.
5152
5153 @end deftypefun
5154
5155
5156 @node Advanced Key Editing
5157 @subsection Advanced Key Editing
5158 @cindex key, edit
5159
5160 @deftp {Data type} {gpgme_error_t (*gpgme_interact_cb_t) @
5161    (@w{void *@var{handle}}, @
5162     @w{const char *@var{status}}, @
5163     @w{const char *@var{args}}, @
5164     @w{int @var{fd}})}
5165
5166 @since{1.7.0}
5167
5168 @tindex gpgme_interact_cb_t
5169 The @code{gpgme_interact_cb_t} type is the type of functions which
5170 @acronym{GPGME} calls if it a key interact operation is on-going.  The
5171 status keyword @var{status} and the argument line @var{args} are
5172 passed through by @acronym{GPGME} from the crypto engine.  An empty
5173 string represents EOF.  The file descriptor @var{fd} is -1 for normal
5174 status messages.  If @var{status} indicates a command rather than a
5175 status message, the response to the command should be written to
5176 @var{fd}.  The @var{handle} is provided by the user at start of
5177 operation.
5178
5179 The function should return @code{GPG_ERR_FALSE} if it did not handle
5180 the status code, @code{0} for success, or any other error value.
5181 @end deftp
5182
5183 @deftypefun gpgme_error_t gpgme_op_interact (@w{gpgme_ctx_t @var{ctx}}, @
5184    @w{gpgme_key_t @var{key}}, @
5185    @w{unsigned int @var{flags}}, @
5186    @w{gpgme_interact_cb_t @var{fnc}}, @
5187    @w{void *@var{handle}}, @
5188    @w{gpgme_data_t @var{out}})
5189
5190 @since{1.7.0}
5191
5192 The function @code{gpgme_op_interact} processes the key @var{KEY}
5193 interactively, using the interact callback function @var{FNC} with the
5194 handle @var{HANDLE}.  The callback is invoked for every status and
5195 command request from the crypto engine.  The output of the crypto
5196 engine is written to the data object @var{out}.
5197
5198 Note that the protocol between the callback function and the crypto
5199 engine is specific to the crypto engine and no further support in
5200 implementing this protocol correctly is provided by @acronym{GPGME}.
5201
5202 @var{flags} modifies the behaviour of the function; the only defined
5203 bit value is:
5204
5205 @table @code
5206 @item GPGME_INTERACT_CARD
5207 @since{1.7.0}
5208
5209 This is used for smartcard based keys and uses gpg’s
5210 @code{--card-edit} command.
5211
5212 @end table
5213