3dac60d06da367934007db7d896a9096180f527d
[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--2017 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 mimimum 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
1913 @node Callback Based Data Buffers
1914 @subsection Callback Based Data Buffers
1915
1916 If neither memory nor file based data objects are a good fit for your
1917 application, you can implement the functions a data object provides
1918 yourself and create a data object from these callback functions.
1919
1920 @deftp {Data type} {ssize_t (*gpgme_data_read_cb_t) (@w{void *@var{handle}}, @w{void @var{*buffer}}, @w{size_t @var{size}})}
1921 @tindex gpgme_data_read_cb_t
1922 The @code{gpgme_data_read_cb_t} type is the type of functions which
1923 @acronym{GPGME} calls if it wants to read data from a user-implemented
1924 data object.  The function should read up to @var{size} bytes from the
1925 current read position into the space starting at @var{buffer}.  The
1926 @var{handle} is provided by the user at data object creation time.
1927
1928 Note that GPGME assumes that the read blocks until data is available.
1929 Errors during I/O operations, except for EINTR, are usually fatal for
1930 crypto operations.
1931
1932 The function should return the number of bytes read, 0 on EOF, and -1
1933 on error.  If an error occurs, @var{errno} should be set to describe
1934 the type of the error.
1935 @end deftp
1936
1937 @deftp {Data type} {ssize_t (*gpgme_data_write_cb_t) (@w{void *@var{handle}}, @w{const void @var{*buffer}}, @w{size_t @var{size}})}
1938 @tindex gpgme_data_write_cb_t
1939 The @code{gpgme_data_write_cb_t} type is the type of functions which
1940 @acronym{GPGME} calls if it wants to write data to a user-implemented
1941 data object.  The function should write up to @var{size} bytes to the
1942 current write position from the space starting at @var{buffer}.  The
1943 @var{handle} is provided by the user at data object creation time.
1944
1945 Note that GPGME assumes that the write blocks until data is available.
1946 Errors during I/O operations, except for EINTR, are usually fatal for
1947 crypto operations.
1948
1949 The function should return the number of bytes written, and -1 on
1950 error.  If an error occurs, @var{errno} should be set to describe the
1951 type of the error.
1952 @end deftp
1953
1954 @deftp {Data type} {off_t (*gpgme_data_seek_cb_t) (@w{void *@var{handle}}, @w{off_t @var{offset}}, @w{int @var{whence}})}
1955 @tindex gpgme_data_seek_cb_t
1956 The @code{gpgme_data_seek_cb_t} type is the type of functions which
1957 @acronym{GPGME} calls if it wants to change the current read/write
1958 position in a user-implemented data object, just like the @code{lseek}
1959 function.
1960
1961 The function should return the new read/write position, and -1 on
1962 error.  If an error occurs, @var{errno} should be set to describe the
1963 type of the error.
1964 @end deftp
1965
1966 @deftp {Data type} {void (*gpgme_data_release_cb_t) (@w{void *@var{handle}})}
1967 @tindex gpgme_data_release_cb_t
1968 The @code{gpgme_data_release_cb_t} type is the type of functions which
1969 @acronym{GPGME} calls if it wants to destroy a user-implemented data
1970 object.  The @var{handle} is provided by the user at data object
1971 creation time.
1972 @end deftp
1973
1974 @deftp {Data type} {struct gpgme_data_cbs}
1975 This structure is used to store the data callback interface functions
1976 described above.  It has the following members:
1977
1978 @table @code
1979 @item gpgme_data_read_cb_t read
1980 This is the function called by @acronym{GPGME} to read data from the
1981 data object.  It is only required for input data object.
1982
1983 @item gpgme_data_write_cb_t write
1984 This is the function called by @acronym{GPGME} to write data to the
1985 data object.  It is only required for output data object.
1986
1987 @item gpgme_data_seek_cb_t seek
1988 This is the function called by @acronym{GPGME} to change the current
1989 read/write pointer in the data object (if available).  It is optional.
1990
1991 @item gpgme_data_release_cb_t release
1992 This is the function called by @acronym{GPGME} to release a data
1993 object.  It is optional.
1994 @end table
1995 @end deftp
1996
1997 @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}})
1998 The function @code{gpgme_data_new_from_cbs} creates a new
1999 @code{gpgme_data_t} object and uses the user-provided callback functions
2000 to operate on the data object.
2001
2002 The handle @var{handle} is passed as first argument to the callback
2003 functions.  This can be used to identify this data object.
2004
2005 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2006 data object was successfully created, and @code{GPG_ERR_ENOMEM} if not
2007 enough memory is available.
2008 @end deftypefun
2009
2010
2011 @node Destroying Data Buffers
2012 @section Destroying Data Buffers
2013 @cindex data buffer, destruction
2014
2015 @deftypefun void gpgme_data_release (@w{gpgme_data_t @var{dh}})
2016 The function @code{gpgme_data_release} destroys the data object with
2017 the handle @var{dh}.  It releases all associated resources that were
2018 not provided by the user in the first place.
2019 @end deftypefun
2020
2021 @deftypefun {char *} gpgme_data_release_and_get_mem (@w{gpgme_data_t @var{dh}}, @w{size_t *@var{length}})
2022 The function @code{gpgme_data_release_and_get_mem} is like
2023 @code{gpgme_data_release}, except that it returns the data buffer and
2024 its length that was provided by the object.
2025
2026 The user has to release the buffer with @code{gpgme_free}.  In case
2027 the user provided the data buffer in non-copy mode, a copy will be
2028 made for this purpose.
2029
2030 In case an error returns, or there is no suitable data buffer that can
2031 be returned to the user, the function will return @code{NULL}.  In any
2032 case, the data object @var{dh} is destroyed.
2033 @end deftypefun
2034
2035
2036 @deftypefun void gpgme_free (@w{void *@var{buffer}})
2037 @since{1.1.1}
2038
2039 The function @code{gpgme_free} releases the memory returned by
2040 @code{gpgme_data_release_and_get_mem} and
2041 @code{gpgme_pubkey_algo_string}.  It should be used instead of the
2042 system libraries @code{free} function in case different allocators are
2043 used by a program.  This is often the case if gpgme is used under
2044 Windows as a DLL.
2045 @end deftypefun
2046
2047
2048 @node Manipulating Data Buffers
2049 @section Manipulating Data Buffers
2050 @cindex data buffer, manipulation
2051
2052 Data buffers contain data and meta-data.  The following operations can
2053 be used to manipulate both.
2054
2055
2056 @menu
2057 * Data Buffer I/O Operations::    I/O operations on data buffers.
2058 * Data Buffer Meta-Data::         Meta-data manipulation of data buffers.
2059 * Data Buffer Convenience::       Convenience function for data buffers.
2060 @end menu
2061
2062
2063 @node Data Buffer I/O Operations
2064 @subsection Data Buffer I/O Operations
2065 @cindex data buffer, I/O operations
2066 @cindex data buffer, read
2067 @cindex data buffer, write
2068 @cindex data buffer, seek
2069
2070 @deftypefun ssize_t gpgme_data_read (@w{gpgme_data_t @var{dh}}, @w{void *@var{buffer}}, @w{size_t @var{length}})
2071 The function @code{gpgme_data_read} reads up to @var{length} bytes
2072 from the data object with the handle @var{dh} into the space starting
2073 at @var{buffer}.
2074
2075 If no error occurs, the actual amount read is returned.  If the end of
2076 the data object is reached, the function returns 0.
2077
2078 In all other cases, the function returns -1 and sets @var{errno}.
2079 @end deftypefun
2080
2081 @deftypefun ssize_t gpgme_data_write (@w{gpgme_data_t @var{dh}}, @w{const void *@var{buffer}}, @w{size_t @var{size}})
2082 The function @code{gpgme_data_write} writes up to @var{size} bytes
2083 starting from @var{buffer} into the data object with the handle
2084 @var{dh} at the current write position.
2085
2086 The function returns the number of bytes actually written, or -1 if an
2087 error occurs.  If an error occurs, @var{errno} is set.
2088 @end deftypefun
2089
2090 @deftypefun off_t gpgme_data_seek (@w{gpgme_data_t @var{dh}}, @w{off_t @var{offset}}, @w{int @var{whence}})
2091 The function @code{gpgme_data_seek} changes the current read/write
2092 position.
2093
2094 The @var{whence} argument specifies how the @var{offset} should be
2095 interpreted.  It must be one of the following symbolic constants:
2096
2097 @table @code
2098 @item SEEK_SET
2099 Specifies that @var{offset} is a count of characters from the
2100 beginning of the data object.
2101
2102 @item SEEK_CUR
2103 Specifies that @var{offset} is a count of characters from the current
2104 file position.  This count may be positive or negative.
2105
2106 @item SEEK_END
2107 Specifies that @var{offset} is a count of characters from the end of
2108 the data object.  A negative count specifies a position within the
2109 current extent of the data object; a positive count specifies a
2110 position past the current end.  If you set the position past the
2111 current end, and actually write data, you will extend the data object
2112 with zeros up to that position.
2113 @end table
2114
2115 If successful, the function returns the resulting file position,
2116 measured in bytes from the beginning of the data object.  You can use
2117 this feature together with @code{SEEK_CUR} to read the current
2118 read/write position.
2119
2120 If the function fails, -1 is returned and @var{errno} is set.
2121 @end deftypefun
2122
2123
2124 @node Data Buffer Meta-Data
2125 @subsection Data Buffer Meta-Data
2126 @cindex data buffer, meta-data
2127 @cindex data buffer, file name
2128 @cindex data buffer, encoding
2129
2130 @deftypefun {char *} gpgme_data_get_file_name (@w{gpgme_data_t @var{dh}})
2131 @since{1.1.0}
2132
2133 The function @code{gpgme_data_get_file_name} returns a pointer to a
2134 string containing the file name associated with the data object.  The
2135 file name will be stored in the output when encrypting or signing the
2136 data and will be returned to the user when decrypting or verifying the
2137 output data.
2138
2139 If no error occurs, the string containing the file name is returned.
2140 Otherwise, @code{NULL} will be returned.
2141 @end deftypefun
2142
2143
2144 @deftypefun gpgme_error_t gpgme_data_set_file_name (@w{gpgme_data_t @var{dh}}, @w{const char *@var{file_name}})
2145 @since{1.1.0}
2146
2147 The function @code{gpgme_data_set_file_name} sets the file name
2148 associated with the data object.  The file name will be stored in the
2149 output when encrypting or signing the data and will be returned to the
2150 user when decrypting or verifying the output data.
2151
2152 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2153 @var{dh} is not a valid pointer and @code{GPG_ERR_ENOMEM} if not
2154 enough memory is available.
2155 @end deftypefun
2156
2157
2158 @deftp {Data type} {enum gpgme_data_encoding_t}
2159 @tindex gpgme_data_encoding_t
2160 The @code{gpgme_data_encoding_t} type specifies the encoding of a
2161 @code{gpgme_data_t} object.  For input data objects, the encoding is
2162 useful to give the backend a hint on the type of data.  For output
2163 data objects, the encoding can specify the output data format on
2164 certain operations.  Please note that not all backends support all
2165 encodings on all operations.  The following data types are available:
2166
2167 @table @code
2168 @item GPGME_DATA_ENCODING_NONE
2169 This specifies that the encoding is not known.  This is the default
2170 for a new data object.  The backend will try its best to detect the
2171 encoding automatically.
2172
2173 @item GPGME_DATA_ENCODING_BINARY
2174 This specifies that the data is encoding in binary form; i.e. there is
2175 no special encoding.
2176
2177 @item GPGME_DATA_ENCODING_BASE64
2178 This specifies that the data is encoded using the Base-64 encoding
2179 scheme as used by @acronym{MIME} and other protocols.
2180
2181 @item GPGME_DATA_ENCODING_ARMOR
2182 This specifies that the data is encoded in an armored form as used by
2183 OpenPGP and PEM.
2184
2185 @item GPGME_DATA_ENCODING_MIME
2186 @since{1.7.0}
2187
2188 This specifies that the data is encoded as a MIME part.
2189
2190 @item GPGME_DATA_ENCODING_URL
2191 @since{1.2.0}
2192
2193 The data is a list of linefeed delimited URLs.  This is only useful with
2194 @code{gpgme_op_import}.
2195
2196 @item GPGME_DATA_ENCODING_URL0
2197 @since{1.2.0}
2198
2199 The data is a list of binary zero delimited URLs.  This is only useful
2200 with @code{gpgme_op_import}.
2201
2202 @item GPGME_DATA_ENCODING_URLESC
2203 @since{1.2.0}
2204
2205 The data is a list of linefeed delimited URLs with all control and space
2206 characters percent escaped.  This mode is is not yet implemented.
2207
2208 @end table
2209 @end deftp
2210
2211 @deftypefun gpgme_data_encoding_t gpgme_data_get_encoding (@w{gpgme_data_t @var{dh}})
2212 The function @code{gpgme_data_get_encoding} returns the encoding of
2213 the data object with the handle @var{dh}.  If @var{dh} is not a valid
2214 pointer (e.g. @code{NULL}) @code{GPGME_DATA_ENCODING_NONE} is
2215 returned.
2216 @end deftypefun
2217
2218 @deftypefun gpgme_error_t gpgme_data_set_encoding (@w{gpgme_data_t @var{dh}, gpgme_data_encoding_t @var{enc}})
2219 The function @code{gpgme_data_set_encoding} changes the encoding of
2220 the data object with the handle @var{dh} to @var{enc}.
2221 @end deftypefun
2222
2223 @deftypefun {gpgme_error_t} gpgme_data_set_flag  @
2224             (@w{gpgme_data_t @var{dh}}, @
2225             @w{const char *@var{name}}, @
2226             @w{const char *@var{value}})
2227
2228 @since{1.7.0}
2229
2230 Some minor properties of the data object can be controlled with flags
2231 set by this function.  The properties are identified by the following
2232 values for @var{name}:
2233
2234 @table @code
2235 @item size-hint
2236 The value is a decimal number with the length gpgme shall assume for
2237 this data object.  This is useful if the data is provided by callbacks
2238 or via file descriptors but the applications knows the total size of
2239 the data.  If this is set the OpenPGP engine may use this to decide on
2240 buffer allocation strategies and to provide a total value for its
2241 progress information.
2242
2243 @end table
2244
2245 This function returns @code{0} on success.
2246 @end deftypefun
2247
2248
2249 @node Data Buffer Convenience
2250 @subsection Data Buffer Convenience Functions
2251 @cindex data buffer, convenience
2252 @cindex type of data
2253 @cindex identify
2254
2255 @deftp {Data type} {enum gpgme_data_type_t}
2256 @tindex gpgme_data_type_t
2257 @since{1.4.3}
2258
2259 The @code{gpgme_data_type_t} type is used to return the detected type
2260 of the content of a data buffer.
2261 @end deftp
2262
2263 @table @code
2264 @item GPGME_DATA_TYPE_INVALID
2265 This is returned by @code{gpgme_data_identify} if it was not possible
2266 to identify the data.  Reasons for this might be a non-seekable stream
2267 or a memory problem.  The value is 0.
2268 @item GPGME_DATA_TYPE_UNKNOWN
2269 The type of the data is not known.
2270 @item GPGME_DATA_TYPE_PGP_SIGNED
2271 The data is an OpenPGP signed message.  This may be a binary
2272 signature, a detached one or a cleartext signature.
2273 @item GPGME_DATA_TYPE_PGP_ENCRYPTED
2274 @since{1.7.0}
2275
2276 The data is an OpenPGP encrypted message.
2277 @item GPGME_DATA_TYPE_PGP_SIGNATURE
2278 @since{1.7.0}
2279
2280 The data is an OpenPGP detached signature.
2281 @item GPGME_DATA_TYPE_PGP_OTHER
2282 This is a generic OpenPGP message.  In most cases this will be
2283 encrypted data.
2284 @item GPGME_DATA_TYPE_PGP_KEY
2285 This is an OpenPGP key (private or public).
2286 @item GPGME_DATA_TYPE_CMS_SIGNED
2287 This is a CMS signed message.
2288 @item GPGME_DATA_TYPE_CMS_ENCRYPTED
2289 This is a CMS encrypted (enveloped data) message.
2290 @item GPGME_DATA_TYPE_CMS_OTHER
2291 This is used for other CMS message types.
2292 @item GPGME_DATA_TYPE_X509_CERT
2293 The data is a X.509 certificate
2294 @item GPGME_DATA_TYPE_PKCS12
2295 The data is a PKCS#12 message.  This is commonly used to exchange
2296 private keys for X.509.
2297 @end table
2298
2299 @deftypefun gpgme_data_type_t gpgme_data_identify (@w{gpgme_data_t @var{dh}})
2300 @since{1.4.3}
2301
2302 The function @code{gpgme_data_identify} returns the type of the data
2303 with the handle @var{dh}.  If it is not possible to perform the
2304 identification, the function returns zero
2305 (@code{GPGME_DATA_TYPE_INVALID}).  Note that depending on how the data
2306 object has been created the identification may not be possible or the
2307 data object may change its internal state (file pointer moved).  For
2308 file or memory based data object, the state should not change.
2309 @end deftypefun
2310
2311
2312 @c
2313 @c    Chapter Contexts
2314 @c
2315 @node Contexts
2316 @chapter Contexts
2317 @cindex context
2318
2319 All cryptographic operations in @acronym{GPGME} are performed within a
2320 context, which contains the internal state of the operation as well as
2321 configuration parameters.  By using several contexts you can run
2322 several cryptographic operations in parallel, with different
2323 configuration.
2324
2325 @deftp {Data type} {gpgme_ctx_t}
2326 The @code{gpgme_ctx_t} type is a handle for a @acronym{GPGME} context,
2327 which is used to hold the configuration, status and result of
2328 cryptographic operations.
2329 @end deftp
2330
2331 @menu
2332 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
2333 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
2334 * Result Management::             Managing the result of crypto operations.
2335 * Context Attributes::            Setting properties of a context.
2336 * Key Management::                Managing keys with @acronym{GPGME}.
2337 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
2338 * Crypto Operations::             Using a context for cryptography.
2339 * Miscellaneous::                 Miscellaneous operations
2340 * Run Control::                   Controlling how operations are run.
2341 @end menu
2342
2343
2344 @node Creating Contexts
2345 @section Creating Contexts
2346 @cindex context, creation
2347
2348 @deftypefun gpgme_error_t gpgme_new (@w{gpgme_ctx_t *@var{ctx}})
2349 The function @code{gpgme_new} creates a new @code{gpgme_ctx_t} object
2350 and returns a handle for it in @var{ctx}.
2351
2352 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2353 context was successfully created, @code{GPG_ERR_INV_VALUE} if
2354 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if not
2355 enough memory is available.  Also, it returns
2356 @code{GPG_ERR_NOT_OPERATIONAL} if @code{gpgme_check_version} was not
2357 called to initialize GPGME, and @code{GPG_ERR_SELFTEST_FAILED} if a
2358 selftest failed.  Currently, the only selftest is for Windows MingW32
2359 targets to see if @code{-mms-bitfields} was used (as required).
2360 @end deftypefun
2361
2362
2363 @node Destroying Contexts
2364 @section Destroying Contexts
2365 @cindex context, destruction
2366
2367 @deftypefun void gpgme_release (@w{gpgme_ctx_t @var{ctx}})
2368 The function @code{gpgme_release} destroys the context with the handle
2369 @var{ctx} and releases all associated resources.
2370 @end deftypefun
2371
2372
2373 @node Result Management
2374 @section Result Management
2375 @cindex context, result of operation
2376
2377 The detailed result of an operation is returned in operation-specific
2378 structures such as @code{gpgme_decrypt_result_t}.  The corresponding
2379 retrieval functions such as @code{gpgme_op_decrypt_result} provide
2380 static access to the results after an operation completes.  Those
2381 structures shall be considered read-only and an application must not
2382 allocate such a structure on its own.  The following interfaces make
2383 it possible to detach a result structure from its associated context
2384 and give it a lifetime beyond that of the current operation or
2385 context.
2386
2387 @deftypefun void gpgme_result_ref (@w{void *@var{result}})
2388 @since{1.2.0}
2389
2390 The function @code{gpgme_result_ref} acquires an additional reference
2391 for the result @var{result}, which may be of any type
2392 @code{gpgme_*_result_t}.  As long as the user holds a reference, the
2393 result structure is guaranteed to be valid and unmodified.
2394 @end deftypefun
2395
2396 @deftypefun void gpgme_result_unref (@w{void *@var{result}})
2397 @since{1.2.0}
2398
2399 The function @code{gpgme_result_unref} releases a reference for the
2400 result @var{result}.  If this was the last reference, the result
2401 structure will be destroyed and all resources associated to it will be
2402 released.
2403 @end deftypefun
2404
2405 Note that a context may hold its own references to result structures,
2406 typically until the context is destroyed or the next operation is
2407 started.  In fact, these references are accessed through the
2408 @code{gpgme_op_*_result} functions.
2409
2410
2411 @node Context Attributes
2412 @section Context Attributes
2413 @cindex context, attributes
2414
2415 @menu
2416 * Protocol Selection::            Selecting the protocol used by a context.
2417 * Crypto Engine::                 Configuring the crypto engine.
2418 * Setting the Sender::            How to tell the engine the sender.
2419 * ASCII Armor::                   Requesting @acronym{ASCII} armored output.
2420 * Text Mode::                     Choosing canonical text mode.
2421 * Offline Mode::                  Choosing offline mode.
2422 * Pinentry Mode::                 Choosing the pinentry mode.
2423 * Included Certificates::         Including a number of certificates.
2424 * Key Listing Mode::              Selecting key listing mode.
2425 * Passphrase Callback::           Getting the passphrase from the user.
2426 * Progress Meter Callback::       Being informed about the progress.
2427 * Status Message Callback::       Status messages received from gpg.
2428 * Locale::                        Setting the locale of a context.
2429 * Additional Logs::               Additional logs of a context.
2430 @end menu
2431
2432
2433 @node Protocol Selection
2434 @subsection Protocol Selection
2435 @cindex context, selecting protocol
2436 @cindex protocol, selecting
2437
2438 @deftypefun gpgme_error_t gpgme_set_protocol (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_protocol_t @var{proto}})
2439 The function @code{gpgme_set_protocol} sets the protocol used within
2440 the context @var{ctx} to @var{proto}.  All crypto operations will be
2441 performed by the crypto engine configured for that protocol.
2442 @xref{Protocols and Engines}.
2443
2444 Setting the protocol with @code{gpgme_set_protocol} does not check if
2445 the crypto engine for that protocol is available and installed
2446 correctly.  @xref{Engine Version Check}.
2447
2448 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2449 protocol could be set successfully, and @code{GPG_ERR_INV_VALUE} if
2450 @var{protocol} is not a valid protocol.
2451 @end deftypefun
2452
2453 @deftypefun gpgme_protocol_t gpgme_get_protocol (@w{gpgme_ctx_t @var{ctx}})
2454 The function @code{gpgme_get_protocol} retrieves the protocol currently
2455 use with the context @var{ctx}.
2456 @end deftypefun
2457
2458
2459 @node Crypto Engine
2460 @subsection Crypto Engine
2461 @cindex context, configuring engine
2462 @cindex engine, configuration per context
2463
2464 The following functions can be used to set and retrieve the
2465 configuration of the crypto engines of a specific context.  The
2466 default can also be retrieved without any particular context.
2467 @xref{Engine Information}.  The default can also be changed globally.
2468 @xref{Engine Configuration}.
2469
2470 @deftypefun gpgme_engine_info_t gpgme_ctx_get_engine_info (@w{gpgme_ctx_t @var{ctx}})
2471 @since{1.1.0}
2472
2473 The function @code{gpgme_ctx_get_engine_info} returns a linked list of
2474 engine info structures.  Each info structure describes the
2475 configuration of one configured backend, as used by the context
2476 @var{ctx}.
2477
2478 The result is valid until the next invocation of
2479 @code{gpgme_ctx_set_engine_info} for this particular context.
2480
2481 This function can not fail.
2482 @end deftypefun
2483
2484 @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}})
2485 @since{1.1.0}
2486
2487 The function @code{gpgme_ctx_set_engine_info} changes the
2488 configuration of the crypto engine implementing the protocol
2489 @var{proto} for the context @var{ctx}.
2490
2491 @var{file_name} is the file name of the executable program
2492 implementing this protocol, and @var{home_dir} is the directory name
2493 of the configuration directory for this crypto engine.  If
2494 @var{home_dir} is @code{NULL}, the engine's default will be used.
2495
2496 Currently this function must be used before starting the first crypto
2497 operation.  It is unspecified if and when the changes will take effect
2498 if the function is called after starting the first operation on the
2499 context @var{ctx}.
2500
2501 This function returns the error code @code{GPG_ERR_NO_ERROR} if
2502 successful, or an error code on failure.
2503 @end deftypefun
2504
2505
2506 @node Setting the Sender
2507 @subsection How to tell the engine the sender.
2508 @cindex context, sender
2509 @cindex sender
2510 @cindex From:
2511
2512 Some engines can make use of the sender’s address, for example to
2513 figure out the best user id in certain trust models.  For verification
2514 and signing of mails, it is thus suggested to let the engine know the
2515 sender ("From:") address.  @acronym{GPGME} provides two functions to
2516 accomplish that.  Note that the esoteric use of multiple "From:"
2517 addresses is not supported.
2518
2519 @deftypefun gpgme_error_t gpgme_set_sender @
2520       (@w{gpgme_ctx_t @var{ctx}}, @
2521        @w{int @var{address}})
2522
2523 @since{1.8.0}
2524
2525 The function @code{gpgme_set_sender} specifies the sender address for
2526 use in sign and verify operations.  @var{address} is expected to be
2527 the ``addr-spec'' part of an address but my also be a complete mailbox
2528 address, in which case this function extracts the ``addr-spec'' from
2529 it.  Using @code{NULL} for @var{address} clears the sender address.
2530
2531 The function returns 0 on success or an error code on failure.  The
2532 most likely failure is that no valid ``addr-spec'' was found in
2533 @var{address}.
2534
2535 @end deftypefun
2536
2537 @deftypefun @w{const char *} gpgme_get_sender @
2538       (@w{gpgme_ctx_t @var{ctx}})
2539
2540 @since{1.8.0}
2541
2542 The function @code{gpgme_get_sender} returns the current sender
2543 address from the context, or NULL if none was set.  The returned
2544 value is valid as long as the @var{ctx} is valid and
2545 @code{gpgme_set_sender} has not been called again.
2546
2547 @end deftypefun
2548
2549
2550
2551 @c FIXME: Unfortunately, using @acronym here breaks texi2dvi.
2552 @node ASCII Armor
2553 @subsection @acronym{ASCII} Armor
2554 @cindex context, armor mode
2555 @cindex @acronym{ASCII} armor
2556 @cindex armor mode
2557
2558 @deftypefun void gpgme_set_armor (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2559 The function @code{gpgme_set_armor} specifies if the output should be
2560 @acronym{ASCII} armored.  By default, output is not @acronym{ASCII}
2561 armored.
2562
2563 @acronym{ASCII} armored output is disabled if @var{yes} is zero, and
2564 enabled otherwise.
2565 @end deftypefun
2566
2567 @deftypefun int gpgme_get_armor (@w{gpgme_ctx_t @var{ctx}})
2568 The function @code{gpgme_get_armor} returns 1 if the output is
2569 @acronym{ASCII} armored, and @code{0} if it is not, or if @var{ctx} is
2570 not a valid pointer.
2571 @end deftypefun
2572
2573
2574 @node Text Mode
2575 @subsection Text Mode
2576 @cindex context, text mode
2577 @cindex text mode
2578 @cindex canonical text mode
2579
2580 @deftypefun void gpgme_set_textmode (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2581 The function @code{gpgme_set_textmode} specifies if canonical text mode
2582 should be used.  By default, text mode is not used.
2583
2584 Text mode is for example used for the RFC2015 signatures; note that
2585 the updated RFC 3156 mandates that the mail user agent does some
2586 preparations so that text mode is not needed anymore.
2587
2588 This option is only relevant to the OpenPGP crypto engine, and ignored
2589 by all other engines.
2590
2591 Canonical text mode is disabled if @var{yes} is zero, and enabled
2592 otherwise.
2593 @end deftypefun
2594
2595 @deftypefun int gpgme_get_textmode (@w{gpgme_ctx_t @var{ctx}})
2596 The function @code{gpgme_get_textmode} returns 1 if canonical text
2597 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2598 valid pointer.
2599 @end deftypefun
2600
2601
2602 @node Offline Mode
2603 @subsection Offline Mode
2604 @cindex context, offline mode
2605 @cindex offline mode
2606
2607 @deftypefun void gpgme_set_offline (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2608 @since{1.6.0}
2609
2610 The function @code{gpgme_set_offline} specifies if offline mode should
2611 be used.  Offline mode is disabled if @var{yes} is zero, and enabled
2612 otherwise.  By default, offline mode is disabled.
2613
2614 The details of the offline mode depend on the used protocol and its
2615 backend engine.  It may eventually be extended to be more stricter and
2616 for example completely disable the use of Dirmngr for any engine.
2617
2618 For the CMS protocol the offline mode specifies whether Dirmngr shall
2619 be used to do additional validation that might require connecting
2620 external services (e.g. CRL / OCSP checks).  Here the offline mode
2621 only affects the keylist mode @code{GPGME_KEYLIST_MODE_VALIDATE}.
2622
2623 For the OpenPGP protocol offline mode entirely disables the use of the
2624 Dirmngr and will thus guarantee that no network connections are done
2625 as part of an operation on this context.  It has only an effect with
2626 GnuPG versions 2.1.23 or later.
2627
2628 For all other protocols the offline mode is currently ignored.
2629
2630 @end deftypefun
2631
2632 @deftypefun int gpgme_get_offline (@w{gpgme_ctx_t @var{ctx}})
2633 @since{1.6.0}
2634
2635 The function @code{gpgme_get_offline} returns 1 if offline
2636 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2637 valid pointer.
2638 @end deftypefun
2639
2640
2641 @node Pinentry Mode
2642 @subsection Pinentry Mode
2643 @cindex context, pinentry mode
2644 @cindex pinentry mode
2645
2646 @deftypefun gpgme_error_t gpgme_set_pinentry_mode (@w{gpgme_ctx_t @var{ctx}},
2647 @w{gpgme_pinentry_mode_t @var{mode}})
2648
2649 @since{1.4.0}
2650
2651 The function @code{gpgme_set_pinentry_mode} specifies the pinentry mode
2652 to be used.
2653
2654 For GnuPG >= 2.1 this option is required to be set to
2655 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback
2656 mechanism in GPGME through @code{gpgme_set_passphrase_cb}.
2657 @end deftypefun
2658
2659 @deftypefun gpgme_pinentry_mode_t gpgme_get_pinentry_mode (@w{gpgme_ctx_t @var{ctx}})
2660 @since{1.4.0}
2661
2662 The function @code{gpgme_get_pinenty_mode} returns the
2663 mode set for the context.
2664 @end deftypefun
2665
2666 @deftp {Data type} {enum gpgme_pinentry_mode_t}
2667 @tindex gpgme_pinentry_mode_t
2668 @since{1.4.0}
2669
2670 The @code{gpgme_minentry_mode_t} type specifies the set of possible pinentry
2671 modes that are supported by @acronym{GPGME} if GnuPG >= 2.1 is used.
2672 The following modes are supported:
2673
2674 @table @code
2675 @item GPGME_PINENTRY_MODE_DEFAULT
2676 @since{1.4.0}
2677
2678 Use the default of the agent, which is ask.
2679
2680 @item GPGME_PINENTRY_MODE_ASK
2681 @since{1.4.0}
2682
2683 Force the use of the Pinentry.
2684
2685 @item GPGME_PINENTRY_MODE_CANCEL
2686 @since{1.4.0}
2687
2688 Emulate use of Pinentry's cancel button.
2689
2690 @item GPGME_PINENTRY_MODE_ERROR
2691 @since{1.4.0}
2692
2693 Return a Pinentry error @code{No Pinentry}.
2694
2695 @item GPGME_PINENTRY_MODE_LOOPBACK
2696 @since{1.4.0}
2697
2698 Redirect Pinentry queries to the caller.
2699 This enables the use of @code{gpgme_set_passphrase_cb} because pinentry
2700 queries are redirected to gpgme.
2701
2702 Note: For 2.1.0 - 2.1.12 this mode requires @code{allow-loopback-pinentry}
2703 to be enabled in the @file{gpg-agent.conf} or an agent started with that option.
2704
2705 @end table
2706 @end deftp
2707
2708
2709 @node Included Certificates
2710 @subsection Included Certificates
2711 @cindex certificates, included
2712
2713 @deftypefun void gpgme_set_include_certs (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{nr_of_certs}})
2714 The function @code{gpgme_set_include_certs} specifies how many
2715 certificates should be included in an S/MIME signed message.  By
2716 default, only the sender's certificate is included.  The possible
2717 values of @var{nr_of_certs} are:
2718
2719 @table @code
2720 @item GPGME_INCLUDE_CERTS_DEFAULT
2721 @since{1.0.3}
2722
2723 Fall back to the default of the crypto backend.  This is the default
2724 for GPGME.
2725 @item -2
2726 Include all certificates except the root certificate.
2727 @item -1
2728 Include all certificates.
2729 @item 0
2730 Include no certificates.
2731 @item 1
2732 Include the sender's certificate only.
2733 @item n
2734 Include the first n certificates of the certificates path, starting
2735 from the sender's certificate.  The number @code{n} must be positive.
2736 @end table
2737
2738 Values of @var{nr_of_certs} smaller than -2 are undefined.
2739
2740 This option is only relevant to the CMS crypto engine, and ignored by
2741 all other engines.
2742 @end deftypefun
2743
2744 @deftypefun int gpgme_get_include_certs (@w{gpgme_ctx_t @var{ctx}})
2745 The function @code{gpgme_get_include_certs} returns the number of
2746 certificates to include into an S/MIME signed message.
2747 @end deftypefun
2748
2749
2750 @node Key Listing Mode
2751 @subsection Key Listing Mode
2752 @cindex key listing mode
2753 @cindex key listing, mode of
2754
2755 @deftypefun gpgme_error_t gpgme_set_keylist_mode (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_keylist_mode_t @var{mode}})
2756 The function @code{gpgme_set_keylist_mode} changes the default
2757 behaviour of the key listing functions.  The value in @var{mode} is a
2758 bitwise-or combination of one or multiple of the following bit values:
2759
2760 @table @code
2761 @item GPGME_KEYLIST_MODE_LOCAL
2762 The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
2763 keyring should be searched for keys in the keylisting operation.  This
2764 is the default.
2765
2766 @item GPGME_KEYLIST_MODE_EXTERN
2767 The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
2768 source should be searched for keys in the keylisting operation.  The
2769 type of external source is dependent on the crypto engine used and
2770 whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}.  For
2771 example, it can be a remote keyserver or LDAP certificate server.
2772
2773 @item GPGME_KEYLIST_MODE_LOCATE
2774 This is a shortcut for the combination of
2775 @code{GPGME_KEYLIST_MODE_LOCAL} and @code{GPGME_KEYLIST_MODE_EXTERN}
2776 and convenient when the --locate-key feature of OpenPGP is desired.
2777
2778 @item GPGME_KEYLIST_MODE_SIGS
2779 The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key
2780 signatures should be included in the listed keys.
2781
2782 @item GPGME_KEYLIST_MODE_SIG_NOTATIONS
2783 @since{1.1.1}
2784
2785 The @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} symbol specifies that the
2786 signature notations on key signatures should be included in the listed
2787 keys.  This only works if @code{GPGME_KEYLIST_MODE_SIGS} is also
2788 enabled.
2789
2790 @item GPGME_KEYLIST_MODE_WITH_TOFU
2791 @since{1.7.0}
2792
2793 The @code{GPGME_KEYLIST_MODE_WITH_TOFU} symbol specifies that
2794 information pertaining to the TOFU trust model should be included in
2795 the listed keys.
2796
2797 @item GPGME_KEYLIST_MODE_WITH_SECRET
2798 @since{1.5.1}
2799
2800 The @code{GPGME_KEYLIST_MODE_WITH_SECRET} returns information about
2801 the presence of a corresponding secret key in a public key listing.  A
2802 public key listing with this mode is slower than a standard listing
2803 but can be used instead of a second run to list the secret keys.  This
2804 is only supported for GnuPG versions >= 2.1.
2805
2806 @item GPGME_KEYLIST_MODE_EPHEMERAL
2807 @since{1.2.0}
2808
2809 The @code{GPGME_KEYLIST_MODE_EPHEMERAL} symbol specifies that keys
2810 flagged as ephemeral are included in the listing.
2811
2812 @item GPGME_KEYLIST_MODE_VALIDATE
2813 @since{0.4.5}
2814
2815 The @code{GPGME_KEYLIST_MODE_VALIDATE} symbol specifies that the
2816 backend should do key or certificate validation and not just get the
2817 validity information from an internal cache.  This might be an
2818 expensive operation and is in general not useful.  Currently only
2819 implemented for the S/MIME backend and ignored for other backends.
2820
2821 @end table
2822
2823 At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
2824 @code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
2825 compatibility, you should get the current mode with
2826 @code{gpgme_get_keylist_mode} and modify it by setting or clearing the
2827 appropriate bits, and then using that calculated value in the
2828 @code{gpgme_set_keylisting_mode} operation.  This will leave all other
2829 bits in the mode value intact (in particular those that are not used
2830 in the current version of the library).
2831
2832 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2833 mode could be set correctly, and @code{GPG_ERR_INV_VALUE} if @var{ctx}
2834 is not a valid pointer or @var{mode} is not a valid mode.
2835 @end deftypefun
2836
2837
2838 @deftypefun gpgme_keylist_mode_t gpgme_get_keylist_mode (@w{gpgme_ctx_t @var{ctx}})
2839 The function @code{gpgme_get_keylist_mode} returns the current key
2840 listing mode of the context @var{ctx}.  This value can then be
2841 modified and used in a subsequent @code{gpgme_set_keylist_mode}
2842 operation to only affect the desired bits (and leave all others
2843 intact).
2844
2845 The function returns 0 if @var{ctx} is not a valid pointer, and the
2846 current mode otherwise.  Note that 0 is not a valid mode value.
2847 @end deftypefun
2848
2849
2850 @node Passphrase Callback
2851 @subsection Passphrase Callback
2852 @cindex callback, passphrase
2853 @cindex passphrase callback
2854
2855 @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}})}
2856 @tindex gpgme_passphrase_cb_t
2857 The @code{gpgme_passphrase_cb_t} type is the type of functions usable as
2858 passphrase callback function.
2859
2860 The argument @var{uid_hint} might contain a string that gives an
2861 indication for which user ID the passphrase is required.  If this is
2862 not available, or not applicable (in the case of symmetric encryption,
2863 for example), @var{uid_hint} will be @code{NULL}.
2864
2865 The argument @var{passphrase_info}, if not @code{NULL}, will give
2866 further information about the context in which the passphrase is
2867 required.  This information is engine and operation specific.
2868
2869 If this is the repeated attempt to get the passphrase, because
2870 previous attempts failed, then @var{prev_was_bad} is 1, otherwise it
2871 will be 0.
2872
2873 The user must write the passphrase, followed by a newline character,
2874 to the file descriptor @var{fd}.  The function @code{gpgme_io_writen}
2875 should be used for the write operation.  Note that if the user returns
2876 0 to indicate success, the user must at least write a newline
2877 character before returning from the callback.
2878
2879 If an error occurs, return the corresponding @code{gpgme_error_t}
2880 value.  You can use the error code @code{GPG_ERR_CANCELED} to abort
2881 the operation.  Otherwise, return @code{0}.
2882
2883 Note: The passphrase_cb only works with GnuPG 1.x and 2.1.x and not
2884 with the 2.0.x series. See @code{gpgme_set_pinentry_mode} for more
2885 details on 2.1.x usage.
2886 @end deftp
2887
2888 @deftypefun void gpgme_set_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t @var{passfunc}}, @w{void *@var{hook_value}})
2889 The function @code{gpgme_set_passphrase_cb} sets the function that is
2890 used when a passphrase needs to be provided by the user to
2891 @var{passfunc}.  The function @var{passfunc} needs to implemented by
2892 the user, and whenever it is called, it is called with its first
2893 argument being @var{hook_value}.  By default, no passphrase callback
2894 function is set.
2895
2896 Not all crypto engines require this callback to retrieve the
2897 passphrase.  It is better if the engine retrieves the passphrase from
2898 a trusted agent (a daemon process), rather than having each user to
2899 implement their own passphrase query.  Some engines do not even
2900 support an external passphrase callback at all, in this case the error
2901 code @code{GPG_ERR_NOT_SUPPORTED} is returned.
2902
2903 For GnuPG >= 2.1 the pinentry mode has to be set to
2904 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback.
2905 See @code{gpgme_set_pinentry_mode}.
2906
2907 The user can disable the use of a passphrase callback function by
2908 calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
2909 @code{NULL}.
2910 @end deftypefun
2911
2912 @deftypefun void gpgme_get_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t *@var{passfunc}}, @w{void **@var{hook_value}})
2913 The function @code{gpgme_get_passphrase_cb} returns the function that
2914 is used when a passphrase needs to be provided by the user in
2915 @var{*passfunc}, and the first argument for this function in
2916 @var{*hook_value}.  If no passphrase callback is set, or @var{ctx} is
2917 not a valid pointer, @code{NULL} is returned in both variables.
2918
2919 @var{passfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2920 the corresponding value will not be returned.
2921 @end deftypefun
2922
2923
2924 @node Progress Meter Callback
2925 @subsection Progress Meter Callback
2926 @cindex callback, progress meter
2927 @cindex progress meter callback
2928
2929 @deftp {Data type} {void (*gpgme_progress_cb_t)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
2930 @tindex gpgme_progress_cb_t
2931 The @code{gpgme_progress_cb_t} type is the type of functions usable as
2932 progress callback function.
2933
2934 The arguments are specific to the crypto engine.  More information
2935 about the progress information returned from the GnuPG engine can be
2936 found in the GnuPG source code in the file @file{doc/DETAILS} in the
2937 section PROGRESS.
2938 @end deftp
2939
2940 @deftypefun void gpgme_set_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t @var{progfunc}}, @w{void *@var{hook_value}})
2941 The function @code{gpgme_set_progress_cb} sets the function that is
2942 used when progress information about a cryptographic operation is
2943 available.  The function @var{progfunc} needs to implemented by the
2944 user, and whenever it is called, it is called with its first argument
2945 being @var{hook_value}.  By default, no progress callback function
2946 is set.
2947
2948 Setting a callback function allows an interactive program to display
2949 progress information about a long operation to the user.
2950
2951 The user can disable the use of a progress callback function by
2952 calling @code{gpgme_set_progress_cb} with @var{progfunc} being
2953 @code{NULL}.
2954 @end deftypefun
2955
2956 @deftypefun void gpgme_get_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t *@var{progfunc}}, @w{void **@var{hook_value}})
2957 The function @code{gpgme_get_progress_cb} returns the function that is
2958 used to inform the user about the progress made in @var{*progfunc},
2959 and the first argument for this function in @var{*hook_value}.  If no
2960 progress callback is set, or @var{ctx} is not a valid pointer,
2961 @code{NULL} is returned in both variables.
2962
2963 @var{progfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2964 the corresponding value will not be returned.
2965 @end deftypefun
2966
2967
2968 @node Status Message Callback
2969 @subsection Status Message Callback
2970 @cindex callback, status message
2971 @cindex status message callback
2972
2973 @deftp {Data type} {gpgme_error_t (*gpgme_status_cb_t)(void *@var{hook}, const char *@var{keyword}, const char *@var{args})}
2974 @tindex gpgme_status_cb_t
2975 The @code{gpgme_status_cb_t} type is the type of function usable as
2976 a status message callback function.
2977
2978 The argument @var{keyword} is the name of the status message while the
2979 @var{args} argument contains any arguments for the status message.
2980
2981 If an error occurs, return the corresponding @code{gpgme_error_t}
2982 value. Otherwise, return @code{0}.
2983 @end deftp
2984
2985 @deftypefun void gpgme_set_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t @var{statusfunc}}, @w{void *@var{hook_value}})
2986 @since{1.6.0}
2987
2988 The function @code{gpgme_set_status_cb} sets the function that is used when a
2989 status message is received from gpg to @var{statusfunc}. The function
2990 @var{statusfunc} needs to be implemented by the user, and whenever it is
2991 called, it is called with its first argument being @var{hook_value}.  By
2992 default, no status message callback function is set.
2993
2994 The user can disable the use of a status message callback function by calling
2995 @code{gpgme_set_status_cb} with @var{statusfunc} being @code{NULL}.
2996 @end deftypefun
2997
2998 @deftypefun void gpgme_get_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t *@var{statusfunc}}, @w{void **@var{hook_value}})
2999 @since{1.6.0}
3000
3001 The function @code{gpgme_get_status_cb} returns the function that is used to
3002 process status messages from gpg in @var{*statusfunc}, and the first argument
3003 for this function in @var{*hook_value}.  If no status message callback is set,
3004 or @var{ctx} is not a valid pointer, @code{NULL} is returned in both
3005 variables.
3006 @end deftypefun
3007
3008 @deftypefun {gpgme_error_t} gpgme_set_ctx_flag  @
3009             (@w{gpgme_ctx_t @var{ctx}}, @
3010             @w{const char *@var{name}}, @
3011             @w{const char *@var{value}})
3012
3013 @since{1.7.0}
3014
3015 Some minor properties of the context can be controlled with flags set
3016 by this function.  The properties are identified by the following
3017 values for @var{name}:
3018
3019 @table @code
3020 @item "redraw"
3021 This flag is normally not changed by the caller because GPGME sets and
3022 clears it automatically: The flag is cleared before an operation and
3023 set if an operation noticed that the engine has launched a Pinentry.
3024 A Curses based application may use this information to redraw the
3025 screen; for example:
3026
3027 @example
3028     err = gpgme_op_keylist_start (ctx, "foo@@example.org", 0);
3029     while (!err)
3030       @{
3031         err = gpgme_op_keylist_next (ctx, &key);
3032         if (err)
3033           break;
3034         show_key (key);
3035         gpgme_key_release (key);
3036       @}
3037     if ((s = gpgme_get_ctx_flag (ctx, "redraw")) && *s)
3038       redraw_screen ();
3039     gpgme_release (ctx);
3040 @end example
3041
3042
3043 @item "full-status"
3044 Using a @var{value} of "1" the status callback set by
3045 gpgme_set_status_cb returns all status lines with the exception of
3046 PROGRESS lines.  With the default of "0" the status callback is only
3047 called in certain situations.
3048
3049 @item "raw-description"
3050 Setting the @var{value} to "1" returns human readable strings in a raw
3051 format.  For example the non breaking space characters ("~") will not
3052 be removed from the @code{description} field of the
3053 @code{gpgme_tofu_info_t} object.
3054
3055 @item "export-session-key"
3056 Using a @var{value} of "1" specifies that the context should try to
3057 export the symmetric session key when decrypting data.  By default, or
3058 when using an empty string or "0" for @var{value}, session keys are
3059 not exported.
3060
3061 @item "override-session-key"
3062 The string given in @var{value} is passed to the GnuPG engine to override
3063 the session key for decryption.  The format of that session key is
3064 specific to GnuPG and can be retrieved during a decrypt operation when
3065 the context flag "export-session-key" is enabled.  Please be aware that
3066 using this feature with GnuPG < 2.1.16 will leak the session key on
3067 many platforms via ps(1).
3068
3069 @item "auto-key-retrieve"
3070 Setting the @var{value} to "1" asks the backend to automatically
3071 retrieve a key for signature verification if possible.  Note that this
3072 option makes a "web bug" like behavior possible.  Keyserver or Web Key
3073 Directory operators can see which keys you request, so by sending you
3074 a message signed by a brand new key (which you naturally will not have
3075 on your local keyring), the operator can tell both your IP address and
3076 the time when you verified the signature.
3077
3078 @item "request-origin"
3079 The string given in @var{value} is passed to the GnuPG engines to
3080 request restrictions based on the origin of the request.  Valid values
3081 are documented in the GnuPG manual and the gpg man page under the
3082 option @option{--request-origin}.  Requires at least GnuPG 2.2.6 to have an
3083 effect.
3084
3085 @item "no-symkey-cache"
3086 For OpenPGP disable the passphrase cache used for symmetrical en- and
3087 decryption.  This cache is based on the message specific salt value.
3088 Requires at least GnuPG 2.2.7 to have an effect.
3089
3090 @item "ignore-mdc-error"
3091 This flag passes the option @option{--ignore-mdc-error} to gpg.  This
3092 can be used to force decryption of a message which failed due to a
3093 missing integrity check.  This flag must be used with great caution
3094 and only if it is a known non-corrupted old message and the decryption
3095 result of the former try had the decryption result flag
3096 @code{legacy_cipher_nomdc} set.  For failsafe reasons this flag is
3097 reset after each operation.
3098
3099 @end table
3100
3101 This function returns @code{0} on success.
3102 @end deftypefun
3103
3104
3105 @deftypefun {const char *} gpgme_get_ctx_flag  @
3106             (@w{gpgme_ctx_t @var{ctx}}, @
3107             @w{const char *@var{name}})
3108
3109 @since{1.8.0}
3110
3111 The value of flags settable by @code{gpgme_set_ctx_flag} can be
3112 retrieved by this function.  If @var{name} is unknown the function
3113 returns @code{NULL}.  For boolean flags an empty string is returned
3114 for False and the string "1" is returned for True; either atoi(3) or a
3115 test for an empty string can be used to get the boolean value.
3116
3117 @end deftypefun
3118
3119
3120 @node Locale
3121 @subsection Locale
3122 @cindex locale, default
3123 @cindex locale, of a context
3124
3125 A locale setting can be associated with a context.  This locale is
3126 passed to the crypto engine, and used for applications like the PIN
3127 entry, which is displayed to the user when entering a passphrase is
3128 required.
3129
3130 The default locale is used to initialize the locale setting of all
3131 contexts created afterwards.
3132
3133 @deftypefun gpgme_error_t gpgme_set_locale (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{category}}, @w{const char *@var{value}})
3134 @since{0.4.3}
3135
3136 The function @code{gpgme_set_locale} sets the locale of the context
3137 @var{ctx}, or the default locale if @var{ctx} is a null pointer.
3138
3139 The locale settings that should be changed are specified by
3140 @var{category}.  Supported categories are @code{LC_CTYPE},
3141 @code{LC_MESSAGES}, and @code{LC_ALL}, which is a wildcard you can use
3142 if you want to change all the categories at once.
3143
3144 The value to be used for the locale setting is @var{value}, which will
3145 be copied to @acronym{GPGME}'s internal data structures.  @var{value}
3146 can be a null pointer, which disables setting the locale, and will
3147 make PIN entry and other applications use their default setting, which
3148 is usually not what you want.
3149
3150 Note that the settings are only used if the application runs on a text
3151 terminal, and that the settings should fit the configuration of the
3152 output terminal.  Normally, it is sufficient to initialize the default
3153 value at startup.
3154
3155 The function returns an error if not enough memory is available.
3156 @end deftypefun
3157
3158
3159 @node Additional Logs
3160 @subsection Additional Logs
3161 @cindex auditlog, of the engine
3162 @cindex auditlog
3163
3164 Additional logs can be associated with a context.  These logs are
3165 engine specific and can be be obtained with @code{gpgme_op_getauditlog}.
3166
3167 @deftypefun gpgme_error_t gpgme_op_getauditlog @
3168             (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{output}}, @
3169             @w{unsigned int @var{flags}})
3170 @since{1.1.1}
3171
3172 The function @code{gpgme_op_getauditlog} is used to obtain additional
3173 logs as specified by @var{flags} into the @var{output} data.  If
3174
3175 The function returns the error code @code{GPG_ERR_NO_ERROR} if a
3176 log could be queried from the engine, and @code{GPG_ERR_NOT_IMPLEMENTED}
3177 if the log specified in @var{flags} is not available for this engine.
3178 If no log is available @code{GPG_ERR_NO_DATA} is returned.
3179
3180 The value in @var{flags} is a bitwise-or combination of one or
3181 multiple of the following bit values:
3182
3183 @table @code
3184 @item GPGME_AUDITLOG_DIAG
3185 @since{1.11.2}
3186
3187 Obtain diagnostic output which would be written to @code{stderr} in
3188 interactive use of the engine.  This can be used to provide additional
3189 diagnostic information in case of errors in other operations.
3190
3191 Note: If log-file has been set in the configuration the log will
3192 be empty and @code{GPG_ERR_NO_DATA} will be returned.
3193
3194 Implemented for: @code{GPGME_PROTOCOL_OpenPGP}
3195
3196 @item GPGME_AUDITLOG_DEFAULT
3197 @since{1.11.2}
3198
3199 This flag has the value 0 for compatibility reasons.  Obtains additional
3200 information from the engine by issuing the @code{GETAUDITLOG} command.
3201 For @code{GPGME_PROTOCOL_CMS} this provides additional information about
3202 the X509 certificate chain.
3203
3204 Implemented for: @code{GPGME_PROTOCOL_CMS}
3205
3206 @item GPGME_AUDITLOG_HTML
3207 @since{1.1.1}
3208
3209 Same as @code{GPGME_AUDITLOG_DEFAULT} but in HTML.
3210
3211 Implemented for: @code{GPGME_PROTOCOL_CMS}
3212 @end table
3213 @end deftypefun
3214
3215 @deftypefun gpgme_error_t gpgme_op_getauditlog_start @
3216             (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{output}}, @
3217             @w{unsigned int @var{flags}})
3218 @since{1.1.1}
3219
3220 This is the asynchronous variant of @code{gpgme_op_getauditlog}.
3221 @end deftypefun
3222
3223 @node Key Management
3224 @section Key Management
3225 @cindex key management
3226
3227 Some of the cryptographic operations require that recipients or
3228 signers are specified.  This is always done by specifying the
3229 respective keys that should be used for the operation.  The following
3230 section describes how such keys can be selected and manipulated.
3231
3232
3233 @menu
3234 * Key objects::                   Description of the key structures.
3235 * Listing Keys::                  Browsing the list of available keys.
3236 * Information About Keys::        Requesting detailed information about keys.
3237 * Manipulating Keys::             Operations on keys.
3238 * Generating Keys::               Creating new key pairs.
3239 * Signing Keys::                  Adding key signatures to public keys.
3240 * Exporting Keys::                Retrieving key data from the key ring.
3241 * Importing Keys::                Adding keys to the key ring.
3242 * Deleting Keys::                 Removing keys from the key ring.
3243 * Changing Passphrases::          Change the passphrase of a key.
3244 * Changing TOFU Data::            Changing data pertaining to TOFU.
3245 * Advanced Key Editing::          Advanced key edit operation.
3246 @end menu
3247
3248 @node Key objects
3249 @subsection Key objects
3250
3251 The keys are represented in GPGME by structures which may only be read
3252 by the application but never be allocated or changed.  They are valid
3253 as long as the key object itself is valid.
3254
3255 @deftp {Data type} gpgme_key_t
3256
3257 The @code{gpgme_key_t} type is a pointer to a key object.  It has the
3258 following members:
3259
3260 @table @code
3261 @item gpgme_keylist_mode_t keylist_mode
3262 @since{0.9.0}
3263
3264 The keylist mode that was active when the key was retrieved.
3265
3266 @item unsigned int revoked : 1
3267 This is true if the key is revoked.
3268
3269 @item unsigned int expired : 1
3270 This is true if the key is expired.
3271
3272 @item unsigned int disabled : 1
3273 This is true if the key is disabled.
3274
3275 @item unsigned int invalid : 1
3276 This is true if the key is invalid. This might have several reasons,
3277 for a example for the S/MIME backend, it will be set during key
3278 listings if the key could not be validated due to missing
3279 certificates or unmatched policies.
3280
3281 @item unsigned int can_encrypt : 1
3282 This is true if the key (ie one of its subkeys) can be used for
3283 encryption.
3284
3285 @item unsigned int can_sign : 1
3286 This is true if the key (ie one of its subkeys) can be used to create
3287 data signatures.
3288
3289 @item unsigned int can_certify : 1
3290 This is true if the key (ie one of its subkeys) can be used to create
3291 key certificates.
3292
3293 @item unsigned int can_authenticate : 1
3294 @since{0.4.5}
3295
3296 This is true if the key (ie one of its subkeys) can be used for
3297 authentication.
3298
3299 @item unsigned int is_qualified : 1
3300 @since{1.1.0}
3301
3302 This is true if the key can be used for qualified signatures according
3303 to local government regulations.
3304
3305 @item unsigned int secret : 1
3306 This is true if the key is a secret key.  Note, that this will always
3307 be true even if the corresponding subkey flag may be false
3308 (offline/stub keys).  This is only set if a listing of secret keys has
3309 been requested or if @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3310
3311 @item unsigned int origin : 5
3312 @since{1.8.0}
3313
3314 Reserved for the origin of this key.
3315
3316 @item gpgme_protocol_t protocol
3317 This is the protocol supported by this key.
3318
3319 @item char *issuer_serial
3320 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3321 issuer serial.
3322
3323 @item char *issuer_name
3324 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3325 issuer name.
3326
3327 @item char *chain_id
3328 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3329 chain ID, which can be used to built the certificate chain.
3330
3331 @item gpgme_validity_t owner_trust
3332 If @code{protocol} is @code{GPGME_PROTOCOL_OpenPGP}, then this is the
3333 owner trust.
3334
3335 @item gpgme_subkey_t subkeys
3336 This is a linked list with the subkeys of the key.  The first subkey
3337 in the list is the primary key and usually available.
3338
3339 @item gpgme_user_id_t uids
3340 This is a linked list with the user IDs of the key.  The first user ID
3341 in the list is the main (or primary) user ID.
3342
3343 @item char *fpr
3344 @since{1.7.0}
3345
3346 This field gives the fingerprint of the primary key.  Note that
3347 this is a copy of the fingerprint of the first subkey.  For an
3348 incomplete key (for example from a verification result) a subkey may
3349 be missing but this field may be set nevertheless.
3350
3351 @item unsigned long last_update
3352 @since{1.8.0}
3353
3354 Reserved for the time of the last update of this key.
3355
3356 @end table
3357 @end deftp
3358
3359
3360 @deftp {Data type} gpgme_subkey_t
3361 @since{1.5.0}
3362
3363 The @code{gpgme_subkey_t} type is a pointer to a subkey structure.
3364 Subkeys are one component of a @code{gpgme_key_t} object.  In fact,
3365 subkeys are those parts that contains the real information about the
3366 individual cryptographic keys that belong to the same key object.  One
3367 @code{gpgme_key_t} can contain several subkeys.  The first subkey in
3368 the linked list is also called the primary key.
3369
3370 The subkey structure has the following members:
3371
3372 @table @code
3373 @item gpgme_subkey_t next
3374 This is a pointer to the next subkey structure in the linked list, or
3375 @code{NULL} if this is the last element.
3376
3377 @item unsigned int revoked : 1
3378 This is true if the subkey is revoked.
3379
3380 @item unsigned int expired : 1
3381 This is true if the subkey is expired.
3382
3383 @item unsigned int disabled : 1
3384 This is true if the subkey is disabled.
3385
3386 @item unsigned int invalid : 1
3387 This is true if the subkey is invalid.
3388
3389 @item unsigned int can_encrypt : 1
3390 This is true if the subkey can be used for encryption.
3391
3392 @item unsigned int can_sign : 1
3393 This is true if the subkey can be used to create data signatures.
3394
3395 @item unsigned int can_certify : 1
3396 This is true if the subkey can be used to create key certificates.
3397
3398 @item unsigned int can_authenticate : 1
3399 @since{0.4.5}
3400
3401 This is true if the subkey can be used for authentication.
3402
3403 @item unsigned int is_qualified : 1
3404 @since{1.1.0}
3405
3406 This is true if the subkey can be used for qualified signatures
3407 according to local government regulations.
3408
3409 @item unsigned int is_de_vs : 1
3410 @since{1.8.0}
3411
3412 This is true if the subkey complies with the rules for classified
3413 information in Germany at the restricted level (VS-NfD).  This are
3414 currently RSA keys of at least 2048 bits or ECDH/ECDSA keys using a
3415 Brainpool curve.
3416
3417 @item unsigned int secret : 1
3418 This is true if the subkey is a secret key.  Note that it will be
3419 false if the key is actually a stub key; i.e. a secret key operation
3420 is currently not possible (offline-key).  This is only set if a
3421 listing of secret keys has been requested or if
3422 @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3423
3424 @item gpgme_pubkey_algo_t pubkey_algo
3425 This is the public key algorithm supported by this subkey.
3426
3427 @item unsigned int length
3428 This is the length of the subkey (in bits).
3429
3430 @item char *keyid
3431 This is the key ID of the subkey in hexadecimal digits.
3432
3433 @item char *fpr
3434 This is the fingerprint of the subkey in hexadecimal digits, if
3435 available.
3436
3437 @item char *keygrip
3438 @since{1.7.0}
3439
3440 The keygrip of the subkey in hex digit form or @code{NULL} if not
3441 availabale.
3442
3443 @item long int timestamp
3444 This is the creation timestamp of the subkey.  This is -1 if the
3445 timestamp is invalid, and 0 if it is not available.
3446
3447 @item long int expires
3448 This is the expiration timestamp of the subkey, or 0 if the subkey
3449 does not expire.
3450
3451 @item unsigned int is_cardkey : 1
3452 @since{1.2.0}
3453
3454 True if the secret key is stored on a smart card.
3455
3456 @item char *card_number
3457 @since{1.2.0}
3458
3459 The serial number of a smart card holding this key or @code{NULL}.
3460
3461 @item char *curve
3462 For ECC algorithms the name of the curve.
3463
3464 @end table
3465 @end deftp
3466
3467 @deftp {Data type} gpgme_user_id_t
3468
3469 A user ID is a component of a @code{gpgme_key_t} object.  One key can
3470 have many user IDs.  The first one in the list is the main (or
3471 primary) user ID.
3472
3473 The user ID structure has the following members.
3474
3475 @table @code
3476 @item gpgme_user_id_t next
3477 This is a pointer to the next user ID structure in the linked list, or
3478 @code{NULL} if this is the last element.
3479
3480 @item unsigned int revoked : 1
3481 This is true if the user ID is revoked.
3482
3483 @item unsigned int invalid : 1
3484 This is true if the user ID is invalid.
3485
3486 @item gpgme_validity_t validity
3487 This specifies the validity of the user ID.
3488
3489 @item char *uid
3490 This is the user ID string.
3491
3492 @item char *name
3493 This is the name component of @code{uid}, if available.
3494
3495 @item char *comment
3496 This is the comment component of @code{uid}, if available.
3497
3498 @item char *email
3499 This is the email component of @code{uid}, if available.
3500
3501 @item char *address;
3502 The mail address (addr-spec from RFC-5322) of the user ID string.
3503 This is general the same as the @code{email} part of this structure
3504 but might be slightly different.  If no mail address is available
3505 @code{NULL} is stored.
3506
3507 @item gpgme_tofu_info_t tofu
3508 @since{1.7.0}
3509
3510 If not @code{NULL} information from the TOFU database pertaining to
3511 this user id.
3512
3513 @item gpgme_key_sig_t signatures
3514 This is a linked list with the signatures on this user ID.
3515
3516 @item unsigned int origin : 5
3517 @since{1.8.0}
3518
3519 Reserved for the origin of this user ID.
3520
3521 @item unsigned long last_update
3522 @since{1.8.0}
3523
3524 Reserved for the time of the last update of this user ID.
3525
3526 @end table
3527 @end deftp
3528
3529
3530 @deftp {Data type} gpgme_tofu_info_t
3531
3532 @since{1.7.0}
3533
3534 The @code{gpgme_tofu_info_t} type is a pointer to a tofu info
3535 structure.  Tofu info structures are one component of a
3536 @code{gpgme_user_id_t} object, and provide information from the TOFU
3537 database pertaining to the user ID.
3538
3539 The tofu info structure has the following members:
3540
3541 @table @code
3542 @item gpgme_key_sig_t next
3543 This is a pointer to the next tofu info structure in the linked
3544 list, or @code{NULL} if this is the last element.
3545
3546 @item unsigned int validity : 3
3547 This is the TOFU validity.  It can have the following values:
3548
3549 @table @code
3550 @item 0
3551 The value @code{0} indicates a conflict.
3552
3553 @item 1
3554 The value @code{1} indicates a key without history.
3555
3556 @item 2
3557 The value @code{2} indicates a key with too little history.
3558
3559 @item 3
3560 The value @code{3} indicates a key with enough history for basic trust.
3561
3562 @item 4
3563 The value @code{4} indicates a key with a lot of history.
3564
3565 @end table
3566
3567 @item unsigned int policy : 4
3568 This is the TOFU policy, see @code{gpgme_tofu_policy_t}.
3569
3570 @item unsigned short signcount
3571 This is the number of signatures seen for this binding (or
3572 @code{USHRT_MAX} if there are more than that).
3573
3574 @item unsigned short encrcount
3575 This is the number of encryptions done with this binding (or
3576 @code{USHRT_MAX} if there are more than that).
3577
3578 @item unsigned long signfirst
3579 Number of seconds since Epoch when the first signature was seen with
3580 this binding.
3581
3582 @item unsigned long signlast
3583 Number of seconds since Epoch when the last signature was seen with
3584 this binding.
3585
3586 @item unsigned long encrfirst
3587 Number of seconds since Epoch when the first encryption was done with
3588 this binding.
3589
3590 @item unsigned long encrlast
3591 Number of seconds since Epoch when the last encryption was done with
3592 this binding.
3593
3594 @item char *description
3595 A human-readable string summarizing the TOFU data (or NULL).
3596
3597 @end table
3598 @end deftp
3599
3600
3601 @deftp {Data type} gpgme_key_sig_t
3602
3603 The @code{gpgme_key_sig_t} type is a pointer to a key signature structure.
3604 Key signatures are one component of a @code{gpgme_key_t} object, and
3605 validate user IDs on the key in the OpenPGP protocol.
3606
3607 The signatures on a key are only available if the key was retrieved
3608 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
3609 enabled, because it can be expensive to retrieve all signatures of a
3610 key.
3611
3612 The signature notations on a key signature are only available if the
3613 key was retrieved via a listing operation with the
3614 @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} mode enabled, because it can
3615 be expensive to retrieve all signature notations.
3616
3617 The key signature structure has the following members:
3618
3619 @table @code
3620 @item gpgme_key_sig_t next
3621 This is a pointer to the next key signature structure in the linked
3622 list, or @code{NULL} if this is the last element.
3623
3624 @item unsigned int revoked : 1
3625 This is true if the key signature is a revocation signature.
3626
3627 @item unsigned int expired : 1
3628 This is true if the key signature is expired.
3629
3630 @item unsigned int invalid : 1
3631 This is true if the key signature is invalid.
3632
3633 @item unsigned int exportable : 1
3634 This is true if the key signature is exportable.
3635
3636 @item gpgme_pubkey_algo_t pubkey_algo
3637 This is the public key algorithm used to create the signature.
3638
3639 @item char *keyid
3640 This is the key ID of the key (in hexadecimal digits) used to create
3641 the signature.
3642
3643 @item long int timestamp
3644 This is the creation timestamp of the key signature.  This is -1 if
3645 the timestamp is invalid, and 0 if it is not available.
3646
3647 @item long int expires
3648 This is the expiration timestamp of the key signature, or 0 if the key
3649 signature does not expire.
3650
3651 @item gpgme_error_t status
3652 This is the status of the signature and has the same meaning as the
3653 member of the same name in a @code{gpgme_signature_t} object.
3654
3655 @item unsigned int sig_class
3656 This specifies the signature class of the key signature.  The meaning
3657 is specific to the crypto engine.
3658
3659 @item char *uid
3660 This is the main user ID of the key used to create the signature.
3661
3662 @item char *name
3663 This is the name component of @code{uid}, if available.
3664
3665 @item char *comment
3666 This is the comment component of @code{uid}, if available.
3667
3668 @item char *email
3669 This is the email component of @code{uid}, if available.
3670
3671 @item gpgme_sig_notation_t notations
3672 This is a linked list with the notation data and policy URLs.
3673 @end table
3674 @end deftp
3675
3676
3677
3678 @node Listing Keys
3679 @subsection Listing Keys
3680 @cindex listing keys
3681 @cindex key listing
3682 @cindex key listing, start
3683 @cindex key ring, list
3684 @cindex key ring, search
3685
3686 @deftypefun gpgme_error_t gpgme_op_keylist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
3687
3688 The function @code{gpgme_op_keylist_start} initiates a key listing
3689 operation inside the context @var{ctx}.  It sets everything up so that
3690 subsequent invocations of @code{gpgme_op_keylist_next} return the keys
3691 in the list.
3692
3693 If @var{pattern} is @code{NULL}, all available keys are returned.
3694 Otherwise, @var{pattern} contains an engine specific expression that
3695 is used to limit the list to all keys matching the pattern.  Note that
3696 the total length of the pattern is restricted to an engine-specific
3697 maximum (a couple of hundred characters are usually accepted).  The
3698 pattern should be used to restrict the search to a certain common name
3699 or user, not to list many specific keys at once by listing their
3700 fingerprints or key IDs.
3701
3702 If @var{secret_only} is not @code{0}, the list is restricted to secret
3703 keys only.
3704
3705 The context will be busy until either all keys are received (and
3706 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3707 @code{gpgme_op_keylist_end} is called to finish the operation.
3708
3709 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3710 @var{ctx} is not a valid pointer, and passes through any errors that
3711 are reported by the crypto engine support routines.
3712 @end deftypefun
3713
3714 @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}})
3715
3716 The function @code{gpgme_op_keylist_ext_start} initiates an extended
3717 key listing operation inside the context @var{ctx}.  It sets
3718 everything up so that subsequent invocations of
3719 @code{gpgme_op_keylist_next} return the keys in the list.
3720
3721 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
3722 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
3723 array of strings that are used to limit the list to all keys matching
3724 at least one of the patterns verbatim.  Note that the total length of
3725 all patterns is restricted to an engine-specific maximum (the exact
3726 limit also depends on the number of patterns and amount of quoting
3727 required, but a couple of hundred characters are usually accepted).
3728 Patterns should be used to restrict the search to a certain common
3729 name or user, not to list many specific keys at once by listing their
3730 fingerprints or key IDs.
3731
3732 If @var{secret_only} is not @code{0}, the list is restricted to secret
3733 keys only.
3734
3735 The value of @var{reserved} must be @code{0}.
3736
3737 The context will be busy until either all keys are received (and
3738 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3739 @code{gpgme_op_keylist_end} is called to finish the operation.
3740
3741 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3742 @var{ctx} is not a valid pointer, and passes through any errors that
3743 are reported by the crypto engine support routines.
3744 @end deftypefun
3745
3746 @deftypefun gpgme_error_t gpgme_op_keylist_from_data_start @
3747             (@w{gpgme_ctx_t @var{ctx}}, @
3748              @w{gpgme_data_t @var{data}}, @
3749              @w{int @var{reserved}})
3750
3751 @since{1.8.0}
3752
3753 The function @code{gpgme_op_keylist_from_data_start} initiates a key
3754 listing operation inside the context @var{ctx}.  In contrast to the
3755 other key listing operation the keys are read from the supplied
3756 @var{data} and not from the local key database.  The keys are also not
3757 imported into the local key database.  The function sets everything up
3758 so that subsequent invocations of @code{gpgme_op_keylist_next} return
3759 the keys from @var{data}.
3760
3761 The value of @var{reserved} must be @code{0}.
3762
3763 This function requires at least GnuPG version 2.1.14 and currently
3764 works only with OpenPGP keys.
3765
3766 The context will be busy until either all keys are received (and
3767 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3768 @code{gpgme_op_keylist_end} is called to finish the operation.
3769 While the context is busy @var{data} may not be released.
3770
3771 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3772 @var{ctx} is not a valid pointer, and passes through any errors that
3773 are reported by the crypto engine support routines.
3774 @end deftypefun
3775
3776 @deftypefun gpgme_error_t gpgme_op_keylist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{r_key}})
3777
3778 The function @code{gpgme_op_keylist_next} returns the next key in the
3779 list created by a previous @code{gpgme_op_keylist_start} operation in
3780 the context @var{ctx}.  The key will have one reference for the user.
3781 @xref{Manipulating Keys}.
3782
3783 This is the only way to get at @code{gpgme_key_t} objects in
3784 @acronym{GPGME}.
3785
3786 If the last key in the list has already been returned,
3787 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}.
3788
3789 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3790 @var{ctx} or @var{r_key} is not a valid pointer, and
3791 @code{GPG_ERR_ENOMEM} if there is not enough memory for the operation.
3792 @end deftypefun
3793
3794 @deftypefun gpgme_error_t gpgme_op_keylist_end (@w{gpgme_ctx_t @var{ctx}})
3795
3796 The function @code{gpgme_op_keylist_end} ends a pending key list
3797 operation in the context @var{ctx}.
3798
3799 After the operation completed successfully, the result of the key
3800 listing operation can be retrieved with
3801 @code{gpgme_op_keylist_result}.
3802
3803 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3804 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if at some
3805 time during the operation there was not enough memory available.
3806 @end deftypefun
3807
3808 The following example illustrates how all keys containing a certain
3809 string (@code{g10code}) can be listed with their key ID and the name
3810 and email address of the main user ID:
3811
3812 @example
3813 gpgme_ctx_t ctx;
3814 gpgme_key_t key;
3815 gpgme_error_t err = gpgme_new (&ctx);
3816
3817 if (!err)
3818   @{
3819     err = gpgme_op_keylist_start (ctx, "g10code", 0);
3820     while (!err)
3821       @{
3822         err = gpgme_op_keylist_next (ctx, &key);
3823         if (err)
3824           break;
3825         printf ("%s:", key->subkeys->keyid);
3826         if (key->uids && key->uids->name)
3827           printf (" %s", key->uids->name);
3828         if (key->uids && key->uids->email)
3829           printf (" <%s>", key->uids->email);
3830         putchar ('\n');
3831         gpgme_key_release (key);
3832       @}
3833     gpgme_release (ctx);
3834   @}
3835 if (gpg_err_code (err) != GPG_ERR_EOF)
3836   @{
3837     fprintf (stderr, "can not list keys: %s\n", gpgme_strerror (err));
3838     exit (1);
3839   @}
3840 @end example
3841
3842 @deftp {Data type} {gpgme_keylist_result_t}
3843 This is a pointer to a structure used to store the result of a
3844 @code{gpgme_op_keylist_*} operation.  After successfully ending a key
3845 listing operation, you can retrieve the pointer to the result with
3846 @code{gpgme_op_keylist_result}.  The structure contains the following
3847 member:
3848
3849 @table @code
3850 @item unsigned int truncated : 1
3851 This is true if the crypto backend had to truncate the result, and
3852 less than the desired keys could be listed.
3853 @end table
3854 @end deftp
3855
3856 @deftypefun gpgme_keylist_result_t gpgme_op_keylist_result (@w{gpgme_ctx_t @var{ctx}})
3857 The function @code{gpgme_op_keylist_result} returns a
3858 @code{gpgme_keylist_result_t} pointer to a structure holding the
3859 result of a @code{gpgme_op_keylist_*} operation.  The pointer is only
3860 valid if the last operation on the context was a key listing
3861 operation, and if this operation finished successfully.  The returned
3862 pointer is only valid until the next operation is started on the
3863 context.
3864 @end deftypefun
3865
3866 In a simple program, for which a blocking operation is acceptable, the
3867 following function can be used to retrieve a single key.
3868
3869 @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}})
3870 The function @code{gpgme_get_key} gets the key with the fingerprint
3871 (or key ID) @var{fpr} from the crypto backend and return it in
3872 @var{r_key}.  If @var{secret} is true, get the secret key.  The
3873 currently active keylist mode is used to retrieve the key.  The key
3874 will have one reference for the user.
3875
3876 If the key is not found in the keyring, @code{gpgme_get_key} returns
3877 the error code @code{GPG_ERR_EOF} and *@var{r_key} will be set to
3878 @code{NULL}.
3879
3880 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3881 @var{ctx} or @var{r_key} is not a valid pointer or @var{fpr} is not a
3882 fingerprint or key ID, @code{GPG_ERR_AMBIGUOUS_NAME} if the key ID was
3883 not a unique specifier for a key, and @code{GPG_ERR_ENOMEM} if at some
3884 time during the operation there was not enough memory available.
3885 @end deftypefun
3886
3887
3888 @node Information About Keys
3889 @subsection Information About Keys
3890 @cindex key, information about
3891 @cindex key, attributes
3892 @cindex attributes, of a key
3893
3894 Please see the beginning of this section for more information about
3895 @code{gpgme_key_t} objects.
3896
3897 @deftp {Data type} gpgme_validity_t
3898 The @code{gpgme_validity_t} type is used to specify the validity of a user ID
3899 in a key.  The following validities are defined:
3900
3901 @table @code
3902 @item GPGME_VALIDITY_UNKNOWN
3903 The user ID is of unknown validity.  The string representation of this
3904 validity is ``?''.
3905
3906 @item GPGME_VALIDITY_UNDEFINED
3907 The validity of the user ID is undefined.  The string representation of this
3908 validity is ``q''.
3909
3910 @item GPGME_VALIDITY_NEVER
3911 The user ID is never valid.  The string representation of this
3912 validity is ``n''.
3913
3914 @item GPGME_VALIDITY_MARGINAL
3915 The user ID is marginally valid.  The string representation of this
3916 validity is ``m''.
3917
3918 @item GPGME_VALIDITY_FULL
3919 The user ID is fully valid.  The string representation of this
3920 validity is ``f''.
3921
3922 @item GPGME_VALIDITY_ULTIMATE
3923 The user ID is ultimately valid.  The string representation of this
3924 validity is ``u''.
3925 @end table
3926 @end deftp
3927
3928
3929
3930
3931 @node Manipulating Keys
3932 @subsection Manipulating Keys
3933 @cindex key, manipulation
3934
3935 @deftypefun void gpgme_key_ref (@w{gpgme_key_t @var{key}})
3936 The function @code{gpgme_key_ref} acquires an additional reference for
3937 the key @var{key}.
3938 @end deftypefun
3939
3940 @deftypefun void gpgme_key_unref (@w{gpgme_key_t @var{key}})
3941 The function @code{gpgme_key_unref} releases a reference for the key
3942 @var{key}.  If this was the last reference, the key will be destroyed
3943 and all resources associated to it will be released.
3944 @end deftypefun
3945
3946
3947 @node Generating Keys
3948 @subsection Generating Keys
3949 @cindex key, creation
3950 @cindex key ring, add
3951
3952 GPGME provides a set of functions to create public key pairs.  Most of
3953 these functions require the use of GnuPG 2.1 and later; for older
3954 GnuPG versions the @code{gpgme_op_genkey} function can be used.
3955 Existing code which wants to update to the new functions or new code
3956 which shall supports older GnuPG versions may try the new functions
3957 first and provide a fallback to the old function if the error code
3958 @code{GPG_ERR_NOT_SUPPORTED} is received.
3959
3960 @c
3961 @c  gpgme_op_createkey
3962 @c
3963 @deftypefun gpgme_error_t gpgme_op_createkey @
3964       (@w{gpgme_ctx_t @var{ctx}}, @
3965        @w{const char *@var{userid}}, @
3966        @w{const char *@var{algo}}, @
3967        @w{unsigned long @var{reserved}}, @
3968        @w{unsigned long @var{expires}}, @
3969        @w{gpgme_key_t @var{extrakey}}, @
3970        @w{unsigned int @var{flags}});
3971
3972 @since{1.7.0}
3973
3974 The function @code{gpgme_op_createkey} generates a new key for the
3975 procotol active in the context @var{ctx}.  As of now this function
3976 does only work for OpenPGP and requires at least version 2.1.13 of
3977 GnuPG.
3978
3979 @var{userid} is commonly the mail address associated with the key.
3980 GPGME does not require a specificy syntax but if more than a mail
3981 address is given, RFC-822 style format is suggested.  The value is
3982 expected to be in UTF-8 encoding (i.e. no IDN encoding for mail
3983 addresses).  This is a required parameter.
3984
3985 @var{algo} specifies the algorithm for the new key (actually a keypair
3986 of public and private key).  For a list of supported algorithms, see
3987 the GnuPG manual.  If @var{algo} is @code{NULL} or the string
3988 "default", the key is generated using the default algorithm of the
3989 engine.  If the string "future-default" is used the engine may use an
3990 algorithm which is planned to be the default in a future release of
3991 the engine; however existing implementation of the protocol may not be
3992 able to already handle such future algorithms.  For the OpenPGP
3993 protocol, the specification of a default algorithm, without requesting
3994 a non-default usage via @var{flags}, triggers the creation of a
3995 primary key plus a secondary key (subkey).
3996
3997 @var{reserved} must be set to zero.
3998
3999 @var{expires} specifies the expiration time in seconds.  If you supply
4000 0, a reasonable expiration time is chosen.  Use the flag
4001 @code{GPGME_CREATE_NOEXPIRE} to create keys that do not expire.  Note
4002 that this parameter takes an unsigned long value and not a
4003 @code{time_t} to avoid problems on systems which use a signed 32 bit
4004 @code{time_t}.  Note further that the OpenPGP protocol uses 32 bit
4005 values for timestamps and thus can only encode dates up to the year
4006 2106.
4007
4008 @var{extrakey} is currently not used and must be set to @code{NULL}.
4009 A future version of GPGME may use this parameter to create X.509 keys.
4010
4011 @var{flags} can be set to the bit-wise OR of the following flags:
4012
4013 @table @code
4014 @item GPGME_CREATE_SIGN
4015 @itemx GPGME_CREATE_ENCR
4016 @itemx GPGME_CREATE_CERT
4017 @itemx GPGME_CREATE_AUTH
4018 @since{1.7.0}
4019
4020 Do not create the key with the default capabilities (key usage) of the
4021 requested algorithm but use those explicitly given by these flags:
4022 ``signing'', ``encryption'', ``certification'', or ``authentication''.
4023 The allowed combinations depend on the algorithm.
4024
4025 If any of these flags are set and a default algorithm has been
4026 selected only one key is created in the case of the OpenPGP
4027 protocol.
4028
4029 @item GPGME_CREATE_NOPASSWD
4030 @since{1.7.0}
4031
4032 Request generation of the key without password protection.
4033
4034 @item GPGME_CREATE_SELFSIGNED
4035 @since{1.7.0}
4036
4037 For an X.509 key do not create a CSR but a self-signed certificate.
4038 This has not yet been implemented.
4039
4040 @item GPGME_CREATE_NOSTORE
4041 @since{1.7.0}
4042
4043 Do not store the created key in the local key database.
4044 This has not yet been implemented.
4045
4046 @item GPGME_CREATE_WANTPUB
4047 @itemx GPGME_CREATE_WANTSEC
4048 @since{1.7.0}
4049
4050 Return the public or secret key as part of the result structure.
4051 This has not yet been implemented.
4052
4053 @item GPGME_CREATE_FORCE
4054 @since{1.7.0}
4055
4056 The engine does not allow the creation of a key with a user ID
4057 already existing in the local key database.  This flag can be used to
4058 override this check.
4059
4060 @item GPGME_CREATE_NOEXPIRE
4061 @since{1.8.0}
4062
4063 Request generation of keys that do not expire.
4064
4065 @end table
4066
4067 After the operation completed successfully, information about the
4068 created key can be retrieved with @code{gpgme_op_genkey_result}.
4069
4070 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4071 the engine does not support the command, or a bunch of other error
4072 codes.
4073
4074 @end deftypefun
4075
4076
4077 @deftypefun gpgme_error_t gpgme_op_createkey_start @
4078       (@w{gpgme_ctx_t @var{ctx}}, @
4079        @w{const char *@var{userid}}, @
4080        @w{const char *@var{algo}}, @
4081        @w{unsigned long @var{reserved}}, @
4082        @w{unsigned long @var{expires}}, @
4083        @w{gpgme_key_t @var{extrakey}}, @
4084        @w{unsigned int @var{flags}});
4085
4086 @since{1.7.0}
4087
4088 The function @code{gpgme_op_createkey_start} initiates a
4089 @code{gpgme_op_createkey} operation; see there for details.  It must
4090 be completed by calling @code{gpgme_wait} on the context.
4091 @xref{Waiting For Completion}.
4092
4093 @end deftypefun
4094
4095 @c
4096 @c  gpgme_op_createsubkey
4097 @c
4098 @deftypefun gpgme_error_t gpgme_op_createsubkey @
4099       (@w{gpgme_ctx_t @var{ctx}}, @
4100        @w{gpgme_key_t @var{key}}, @
4101        @w{const char *@var{algo}}, @
4102        @w{unsigned long @var{reserved}}, @
4103        @w{unsigned long @var{expires}}, @
4104        @w{unsigned int @var{flags}});
4105
4106 @since{1.7.0}
4107
4108 The function @code{gpgme_op_createsubkey} creates and adds a new
4109 subkey to the primary OpenPGP key given by @var{KEY}.  The only
4110 allowed protocol in @var{ctx} is @code{GPGME_PROTOCOL_OPENPGP}.
4111 Subkeys (aka secondary keys) are a concept in the OpenPGP protocol to
4112 bind several keys to a primary key.  As of now this function requires
4113 at least version 2.1.13 of GnuPG.
4114
4115 @var{key} specifies the key to operate on.
4116
4117 @var{algo} specifies the algorithm for the new subkey.  For a list of
4118 supported algorithms, see the GnuPG manual.  If @var{algo} is
4119 @code{NULL} or the string "default", the subkey is generated using the
4120 default algorithm for an encryption subkey of the engine.  If the
4121 string "future-default" is used the engine may use an encryption
4122 algorithm which is planned to be the default in a future release of
4123 the engine; however existing implementation of the protocol may not be
4124 able to already handle such future algorithms.
4125
4126 @var{reserved} must be set to zero.
4127
4128 @var{expires} specifies the expiration time in seconds.  If you supply
4129 0, a reasonable expiration time is chosen.  Use the flag
4130 @code{GPGME_CREATE_NOEXPIRE} to create keys that do not expire.  Note
4131 that this parameter takes an unsigned long value and not a
4132 @code{time_t} to avoid problems on systems which use a signed 32 bit
4133 @code{time_t}.  Note further that the OpenPGP protocol uses 32 bit
4134 values for timestamps and thus can only encode dates up to the year
4135 2106.
4136
4137 @var{flags} takes the same values as described above for
4138 @code{gpgme_op_createkey}.
4139
4140 After the operation completed successfully, information about the
4141 created key can be retrieved with @code{gpgme_op_genkey_result}.
4142
4143 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4144 the engine does not support the command, or a bunch of other error
4145 codes.
4146
4147
4148 @end deftypefun
4149
4150 @deftypefun gpgme_error_t gpgme_op_createsubkey_start @
4151       (@w{gpgme_ctx_t @var{ctx}}, @
4152        @w{gpgme_key_t @var{key}}, @
4153        @w{const char *@var{algo}}, @
4154        @w{unsigned long @var{reserved}}, @
4155        @w{unsigned long @var{expires}}, @
4156        @w{unsigned int @var{flags}});
4157
4158 @since{1.7.0}
4159
4160 The function @code{gpgme_op_createsubkey_start} initiates a
4161 @code{gpgme_op_createsubkey} operation; see there for details.  It must
4162 be completed by calling @code{gpgme_wait} on the context.
4163 @xref{Waiting For Completion}.
4164
4165 @end deftypefun
4166
4167
4168 @c
4169 @c  gpgme_op_adduid
4170 @c
4171 @deftypefun gpgme_error_t gpgme_op_adduid @
4172       (@w{gpgme_ctx_t @var{ctx}}, @
4173        @w{gpgme_key_t @var{key}}, @
4174        @w{const char *@var{userid}}, @
4175        @w{unsigned int @var{flags}});
4176
4177 @since{1.7.0}
4178
4179 The function @code{gpgme_op_adduid} adds a new user ID to the OpenPGP
4180 key given by @var{KEY}.  Adding additional user IDs after key creation
4181 is a feature of the OpenPGP protocol and thus the protocol for the
4182 context @var{ctx} must be set to OpenPGP.  As of now this function
4183 requires at least version 2.1.13 of GnuPG.
4184
4185 @var{key} specifies the key to operate on.
4186
4187 @var{userid} is the user ID to add to the key.  A user ID is commonly
4188 the mail address to be associated with the key.  GPGME does not
4189 require a specificy syntax but if more than a mail address is given,
4190 RFC-822 style format is suggested.  The value is expected to be in
4191 UTF-8 encoding (i.e. no IDN encoding for mail addresses).  This is a
4192 required parameter.
4193
4194 @var{flags} are currently not used and must be set to zero.
4195
4196 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4197 the engine does not support the command, or a bunch of other error
4198 codes.
4199
4200 @end deftypefun
4201
4202 @deftypefun gpgme_error_t gpgme_op_adduid_start @
4203       (@w{gpgme_ctx_t @var{ctx}}, @
4204        @w{gpgme_key_t @var{key}}, @
4205        @w{const char *@var{userid}}, @
4206        @w{unsigned int @var{flags}});
4207
4208 @since{1.7.0}
4209
4210 The function @code{gpgme_op_adduid_start} initiates a
4211 @code{gpgme_op_adduid} operation; see there for details.  It must
4212 be completed by calling @code{gpgme_wait} on the context.
4213 @xref{Waiting For Completion}.
4214
4215 @end deftypefun
4216
4217
4218 @c
4219 @c  gpgme_op_revuid
4220 @c
4221 @deftypefun gpgme_error_t gpgme_op_revuid @
4222       (@w{gpgme_ctx_t @var{ctx}}, @
4223        @w{gpgme_key_t @var{key}}, @
4224        @w{const char *@var{userid}}, @
4225        @w{unsigned int @var{flags}});
4226
4227 @since{1.7.0}
4228
4229 The function @code{gpgme_op_revuid} revokes a user ID from the OpenPGP
4230 key given by @var{KEY}.  Revoking user IDs after key creation is a
4231 feature of the OpenPGP protocol and thus the protocol for the context
4232 @var{ctx} must be set to OpenPGP.  As of now this function requires at
4233 least version 2.1.13 of GnuPG.
4234
4235 @var{key} specifies the key to operate on.
4236
4237 @var{userid} is the user ID to be revoked from the key.  The user ID
4238 must be given verbatim because the engine does an exact and case
4239 sensitive match.  Thus the @code{uid} field from the user ID object
4240 (@code{gpgme_user_id_t}) is to be used.  This is a required parameter.
4241
4242 @var{flags} are currently not used and must be set to zero.
4243
4244 Note that the engine won't allow to revoke the last valid user ID.  To
4245 change a user ID is better to first add the new user ID, then revoke
4246 the old one, and finally publish the key.
4247
4248 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4249 the engine does not support the command, or a bunch of other error
4250 codes.
4251
4252 @end deftypefun
4253
4254 @deftypefun gpgme_error_t gpgme_op_revuid_start @
4255       (@w{gpgme_ctx_t @var{ctx}}, @
4256        @w{gpgme_key_t @var{key}}, @
4257        @w{const char *@var{userid}}, @
4258        @w{unsigned int @var{flags}});
4259
4260 @since{1.7.0}
4261
4262 The function @code{gpgme_op_revuid_start} initiates a
4263 @code{gpgme_op_revuid} operation; see there for details.  It must
4264 be completed by calling @code{gpgme_wait} on the context.
4265 @xref{Waiting For Completion}.
4266
4267 @end deftypefun
4268
4269
4270 @c
4271 @c  gpgme_op_set_uid_flag
4272 @c
4273 @deftypefun gpgme_error_t gpgme_op_set_ui_flag @
4274       (@w{gpgme_ctx_t @var{ctx}}, @
4275        @w{gpgme_key_t @var{key}}, @
4276        @w{const char *@var{userid}}, @
4277        @w{cons char * @var{name}}, @
4278        @w{cons char * @var{value}});
4279
4280 @since{1.8.0}
4281
4282 The function @code{gpgme_op_set_uid_flag} is used to set flags on a
4283 user ID from the OpenPGP key given by @var{KEY}.  Setting flags on
4284 user IDs after key creation is a feature of the OpenPGP protocol and
4285 thus the protocol for the context @var{ctx} must be set to OpenPGP.
4286
4287 @var{key} specifies the key to operate on.  This parameters is required.
4288
4289 @var{userid} is the user ID of the key to be manipulated.  This user ID
4290 must be given verbatim because the engine does an exact and case
4291 sensitive match.  Thus the @code{uid} field from the user ID object
4292 (@code{gpgme_user_id_t}) is to be used.  This is a required parameter.
4293
4294 @var{name} names the flag which is to be changed.  The only currently
4295 supported flag is:
4296
4297 @table @code
4298 @item primary
4299 This sets the primary key flag on the given user ID.  All other
4300 primary key flag on other user IDs are removed.  @var{value} must be
4301 given as NULL.  For technical reasons this functions bumps the
4302 creation timestamp of all affected self-signatures up by one second.
4303 At least GnuPG version 2.1.20 is required.
4304
4305 @end table
4306
4307 The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if
4308 the engine does not support the command, or a bunch of other error
4309 codes.
4310
4311 @end deftypefun
4312
4313 @deftypefun gpgme_error_t gpgme_op_set_uid_flag_start @
4314       (@w{gpgme_ctx_t @var{ctx}}, @
4315        @w{gpgme_key_t @var{key}}, @
4316        @w{const char *@var{userid}}, @
4317        @w{cons char * @var{name}}, @
4318        @w{cons char * @var{value}});
4319
4320 @since{1.8.0}
4321
4322 The function @code{gpgme_op_set_uid_flag_start} initiates a
4323 @code{gpgme_op_set_uid_flag} operation; see there for details.  It must
4324 be completed by calling @code{gpgme_wait} on the context.
4325 @xref{Waiting For Completion}.
4326
4327 @end deftypefun
4328
4329 @c
4330 @c  gpgme_op_genkey
4331 @c
4332 @deftypefun gpgme_error_t gpgme_op_genkey @
4333       (@w{gpgme_ctx_t @var{ctx}}, @
4334        @w{const char *@var{parms}}, @
4335        @w{gpgme_data_t @var{public}}, @
4336        @w{gpgme_data_t @var{secret}})
4337
4338 The function @code{gpgme_op_genkey} generates a new key pair in the
4339 context @var{ctx}.  The meaning of @var{public} and @var{secret}
4340 depends on the crypto backend.
4341
4342 GPG does not support @var{public} and @var{secret}, they should be
4343 @code{NULL}.  GnuPG will generate a key pair and add it to the
4344 standard key ring.  The fingerprint of the generated key is available
4345 with @code{gpgme_op_genkey_result}.
4346
4347 GpgSM requires @var{public} to be a writable data object.  GpgSM will
4348 generate a secret key (which will be stored by @command{gpg-agent},
4349 and return a certificate request in @var{public}, which then needs to
4350 be signed by the certification authority and imported before it can be
4351 used.  GpgSM does not make the fingerprint available.
4352
4353 The argument @var{parms} specifies parameters for the key in an string
4354 that looks something like XML.  The details about the format of
4355 @var{parms} are specific to the crypto engine used by @var{ctx}.  The
4356 first line of the parameters must be @code{<GnupgKeyParams
4357 format="internal">} and the last line must be
4358 @code{</GnupgKeyParams>}.  Every line in between the first and last
4359 lines is treated as a Header: Value pair.  In particular, no XML
4360 escaping is necessary if you need to include the characters @code{<},
4361 @code{>}, or @code{&}.
4362
4363 Here is an example for GnuPG as the crypto engine (all parameters of
4364 OpenPGP key generation are documented in the GPG manual):
4365
4366 @example
4367 <GnupgKeyParms format="internal">
4368 Key-Type: default
4369 Subkey-Type: default
4370 Name-Real: Joe Tester
4371 Name-Comment: with stupid passphrase
4372 Name-Email: joe@@foo.bar
4373 Expire-Date: 0
4374 Passphrase: abc
4375 </GnupgKeyParms>
4376 @end example
4377
4378 Here is an example for GpgSM as the crypto engine (all parameters of
4379 OpenPGP key generation are documented in the GPGSM manual):
4380
4381 @example
4382 <GnupgKeyParms format="internal">
4383 Key-Type: RSA
4384 Key-Length: 1024
4385 Name-DN: C=de,O=g10 code,OU=Testlab,CN=Joe 2 Tester
4386 Name-Email: joe@@foo.bar
4387 </GnupgKeyParms>
4388 @end example
4389
4390 Strings should be given in UTF-8 encoding.  The only format supported
4391 for now is ``internal''.  The content of the @code{GnupgKeyParms}
4392 container is passed verbatim to the crypto backend.  Control
4393 statements are not allowed.
4394
4395 After the operation completed successfully, the result can be
4396 retrieved with @code{gpgme_op_genkey_result}.
4397
4398 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4399 operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
4400 @var{parms} is not a well-formed string (e.g. does not have the
4401 expected tag-like headers and footers), @code{GPG_ERR_NOT_SUPPORTED}
4402 if @var{public} or @var{secret} is not valid, and
4403 @code{GPG_ERR_GENERAL} if no key was created by the backend.
4404 @end deftypefun
4405
4406 @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}})
4407
4408 The function @code{gpgme_op_genkey_start} initiates a
4409 @code{gpgme_op_genkey} operation.  It can be completed by calling
4410 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
4411
4412 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
4413 operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
4414 @var{parms} is not a valid XML string, and
4415 @code{GPG_ERR_NOT_SUPPORTED} if @var{public} or @var{secret} is not
4416 @code{NULL}.
4417 @end deftypefun
4418
4419
4420 @c
4421 @c  gpgme_op_genkey_result
4422 @c
4423 @deftp {Data type} {gpgme_genkey_result_t}
4424
4425 This is a pointer to a structure used to store the result of a
4426 @code{gpgme_op_genkey} operation.  After successfully generating a
4427 key, you can retrieve the pointer to the result with
4428 @code{gpgme_op_genkey_result}.  The structure contains the following
4429 members:
4430
4431 @table @code
4432 @item unsigned int primary : 1
4433 This flag is set to 1 if a primary key was created and to 0
4434 if not.
4435
4436 @item unsigned int sub : 1