Spelling fixes for comments and doc
[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 @end menu
2430
2431
2432 @node Protocol Selection
2433 @subsection Protocol Selection
2434 @cindex context, selecting protocol
2435 @cindex protocol, selecting
2436
2437 @deftypefun gpgme_error_t gpgme_set_protocol (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_protocol_t @var{proto}})
2438 The function @code{gpgme_set_protocol} sets the protocol used within
2439 the context @var{ctx} to @var{proto}.  All crypto operations will be
2440 performed by the crypto engine configured for that protocol.
2441 @xref{Protocols and Engines}.
2442
2443 Setting the protocol with @code{gpgme_set_protocol} does not check if
2444 the crypto engine for that protocol is available and installed
2445 correctly.  @xref{Engine Version Check}.
2446
2447 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2448 protocol could be set successfully, and @code{GPG_ERR_INV_VALUE} if
2449 @var{protocol} is not a valid protocol.
2450 @end deftypefun
2451
2452 @deftypefun gpgme_protocol_t gpgme_get_protocol (@w{gpgme_ctx_t @var{ctx}})
2453 The function @code{gpgme_get_protocol} retrieves the protocol currently
2454 use with the context @var{ctx}.
2455 @end deftypefun
2456
2457
2458 @node Crypto Engine
2459 @subsection Crypto Engine
2460 @cindex context, configuring engine
2461 @cindex engine, configuration per context
2462
2463 The following functions can be used to set and retrieve the
2464 configuration of the crypto engines of a specific context.  The
2465 default can also be retrieved without any particular context.
2466 @xref{Engine Information}.  The default can also be changed globally.
2467 @xref{Engine Configuration}.
2468
2469 @deftypefun gpgme_engine_info_t gpgme_ctx_get_engine_info (@w{gpgme_ctx_t @var{ctx}})
2470 @since{1.1.0}
2471
2472 The function @code{gpgme_ctx_get_engine_info} returns a linked list of
2473 engine info structures.  Each info structure describes the
2474 configuration of one configured backend, as used by the context
2475 @var{ctx}.
2476
2477 The result is valid until the next invocation of
2478 @code{gpgme_ctx_set_engine_info} for this particular context.
2479
2480 This function can not fail.
2481 @end deftypefun
2482
2483 @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}})
2484 @since{1.1.0}
2485
2486 The function @code{gpgme_ctx_set_engine_info} changes the
2487 configuration of the crypto engine implementing the protocol
2488 @var{proto} for the context @var{ctx}.
2489
2490 @var{file_name} is the file name of the executable program
2491 implementing this protocol, and @var{home_dir} is the directory name
2492 of the configuration directory for this crypto engine.  If
2493 @var{home_dir} is @code{NULL}, the engine's default will be used.
2494
2495 Currently this function must be used before starting the first crypto
2496 operation.  It is unspecified if and when the changes will take effect
2497 if the function is called after starting the first operation on the
2498 context @var{ctx}.
2499
2500 This function returns the error code @code{GPG_ERR_NO_ERROR} if
2501 successful, or an error code on failure.
2502 @end deftypefun
2503
2504
2505 @node Setting the Sender
2506 @subsection How to tell the engine the sender.
2507 @cindex context, sender
2508 @cindex sender
2509 @cindex From:
2510
2511 Some engines can make use of the sender’s address, for example to
2512 figure out the best user id in certain trust models.  For verification
2513 and signing of mails, it is thus suggested to let the engine know the
2514 sender ("From:") address.  @acronym{GPGME} provides two functions to
2515 accomplish that.  Note that the esoteric use of multiple "From:"
2516 addresses is not supported.
2517
2518 @deftypefun gpgme_error_t gpgme_set_sender @
2519       (@w{gpgme_ctx_t @var{ctx}}, @
2520        @w{int @var{address}})
2521
2522 @since{1.8.0}
2523
2524 The function @code{gpgme_set_sender} specifies the sender address for
2525 use in sign and verify operations.  @var{address} is expected to be
2526 the ``addr-spec'' part of an address but my also be a complete mailbox
2527 address, in which case this function extracts the ``addr-spec'' from
2528 it.  Using @code{NULL} for @var{address} clears the sender address.
2529
2530 The function returns 0 on success or an error code on failure.  The
2531 most likely failure is that no valid ``addr-spec'' was found in
2532 @var{address}.
2533
2534 @end deftypefun
2535
2536 @deftypefun @w{const char *} gpgme_get_sender @
2537       (@w{gpgme_ctx_t @var{ctx}})
2538
2539 @since{1.8.0}
2540
2541 The function @code{gpgme_get_sender} returns the current sender
2542 address from the context, or NULL if none was set.  The returned
2543 value is valid as long as the @var{ctx} is valid and
2544 @code{gpgme_set_sender} has not been called again.
2545
2546 @end deftypefun
2547
2548
2549
2550 @c FIXME: Unfortunately, using @acronym here breaks texi2dvi.
2551 @node ASCII Armor
2552 @subsection @acronym{ASCII} Armor
2553 @cindex context, armor mode
2554 @cindex @acronym{ASCII} armor
2555 @cindex armor mode
2556
2557 @deftypefun void gpgme_set_armor (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2558 The function @code{gpgme_set_armor} specifies if the output should be
2559 @acronym{ASCII} armored.  By default, output is not @acronym{ASCII}
2560 armored.
2561
2562 @acronym{ASCII} armored output is disabled if @var{yes} is zero, and
2563 enabled otherwise.
2564 @end deftypefun
2565
2566 @deftypefun int gpgme_get_armor (@w{gpgme_ctx_t @var{ctx}})
2567 The function @code{gpgme_get_armor} returns 1 if the output is
2568 @acronym{ASCII} armored, and @code{0} if it is not, or if @var{ctx} is
2569 not a valid pointer.
2570 @end deftypefun
2571
2572
2573 @node Text Mode
2574 @subsection Text Mode
2575 @cindex context, text mode
2576 @cindex text mode
2577 @cindex canonical text mode
2578
2579 @deftypefun void gpgme_set_textmode (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2580 The function @code{gpgme_set_textmode} specifies if canonical text mode
2581 should be used.  By default, text mode is not used.
2582
2583 Text mode is for example used for the RFC2015 signatures; note that
2584 the updated RFC 3156 mandates that the mail user agent does some
2585 preparations so that text mode is not needed anymore.
2586
2587 This option is only relevant to the OpenPGP crypto engine, and ignored
2588 by all other engines.
2589
2590 Canonical text mode is disabled if @var{yes} is zero, and enabled
2591 otherwise.
2592 @end deftypefun
2593
2594 @deftypefun int gpgme_get_textmode (@w{gpgme_ctx_t @var{ctx}})
2595 The function @code{gpgme_get_textmode} returns 1 if canonical text
2596 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2597 valid pointer.
2598 @end deftypefun
2599
2600
2601 @node Offline Mode
2602 @subsection Offline Mode
2603 @cindex context, offline mode
2604 @cindex offline mode
2605
2606 @deftypefun void gpgme_set_offline (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
2607 @since{1.6.0}
2608
2609 The function @code{gpgme_set_offline} specifies if offline mode
2610 should be used.  By default, offline mode is not used.
2611
2612 The offline mode specifies if dirmngr should be used to do additional
2613 validation that might require connections to external services.
2614 (e.g. CRL / OCSP checks).
2615
2616 Offline mode only affects the keylist mode @code{GPGME_KEYLIST_MODE_VALIDATE}
2617 and is only relevant to the CMS crypto engine. Offline mode
2618 is ignored otherwise.
2619
2620 This option may be extended in the future to completely disable
2621 the use of dirmngr for any engine.
2622
2623 Offline mode is disabled if @var{yes} is zero, and enabled
2624 otherwise.
2625 @end deftypefun
2626
2627 @deftypefun int gpgme_get_offline (@w{gpgme_ctx_t @var{ctx}})
2628 @since{1.6.0}
2629
2630 The function @code{gpgme_get_offline} returns 1 if offline
2631 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
2632 valid pointer.
2633 @end deftypefun
2634
2635
2636 @node Pinentry Mode
2637 @subsection Pinentry Mode
2638 @cindex context, pinentry mode
2639 @cindex pinentry mode
2640
2641 @deftypefun gpgme_error_t gpgme_set_pinentry_mode (@w{gpgme_ctx_t @var{ctx}},
2642 @w{gpgme_pinentry_mode_t @var{mode}})
2643
2644 @since{1.4.0}
2645
2646 The function @code{gpgme_set_pinentry_mode} specifies the pinentry mode
2647 to be used.
2648
2649 For GnuPG >= 2.1 this option is required to be set to
2650 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback
2651 mechanism in GPGME through @code{gpgme_set_passphrase_cb}.
2652 @end deftypefun
2653
2654 @deftypefun gpgme_pinentry_mode_t gpgme_get_pinentry_mode (@w{gpgme_ctx_t @var{ctx}})
2655 @since{1.4.0}
2656
2657 The function @code{gpgme_get_pinenty_mode} returns the
2658 mode set for the context.
2659 @end deftypefun
2660
2661 @deftp {Data type} {enum gpgme_pinentry_mode_t}
2662 @tindex gpgme_pinentry_mode_t
2663 @since{1.4.0}
2664
2665 The @code{gpgme_minentry_mode_t} type specifies the set of possible pinentry
2666 modes that are supported by @acronym{GPGME} if GnuPG >= 2.1 is used.
2667 The following modes are supported:
2668
2669 @table @code
2670 @item GPGME_PINENTRY_MODE_DEFAULT
2671 @since{1.4.0}
2672
2673 Use the default of the agent, which is ask.
2674
2675 @item GPGME_PINENTRY_MODE_ASK
2676 @since{1.4.0}
2677
2678 Force the use of the Pinentry.
2679
2680 @item GPGME_PINENTRY_MODE_CANCEL
2681 @since{1.4.0}
2682
2683 Emulate use of Pinentry's cancel button.
2684
2685 @item GPGME_PINENTRY_MODE_ERROR
2686 @since{1.4.0}
2687
2688 Return a Pinentry error @code{No Pinentry}.
2689
2690 @item GPGME_PINENTRY_MODE_LOOPBACK
2691 @since{1.4.0}
2692
2693 Redirect Pinentry queries to the caller.
2694 This enables the use of @code{gpgme_set_passphrase_cb} because pinentry
2695 queries are redirected to gpgme.
2696
2697 Note: For 2.1.0 - 2.1.12 this mode requires @code{allow-loopback-pinentry}
2698 to be enabled in the @file{gpg-agent.conf} or an agent started with that option.
2699
2700 @end table
2701 @end deftp
2702
2703
2704 @node Included Certificates
2705 @subsection Included Certificates
2706 @cindex certificates, included
2707
2708 @deftypefun void gpgme_set_include_certs (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{nr_of_certs}})
2709 The function @code{gpgme_set_include_certs} specifies how many
2710 certificates should be included in an S/MIME signed message.  By
2711 default, only the sender's certificate is included.  The possible
2712 values of @var{nr_of_certs} are:
2713
2714 @table @code
2715 @item GPGME_INCLUDE_CERTS_DEFAULT
2716 @since{1.0.3}
2717
2718 Fall back to the default of the crypto backend.  This is the default
2719 for GPGME.
2720 @item -2
2721 Include all certificates except the root certificate.
2722 @item -1
2723 Include all certificates.
2724 @item 0
2725 Include no certificates.
2726 @item 1
2727 Include the sender's certificate only.
2728 @item n
2729 Include the first n certificates of the certificates path, starting
2730 from the sender's certificate.  The number @code{n} must be positive.
2731 @end table
2732
2733 Values of @var{nr_of_certs} smaller than -2 are undefined.
2734
2735 This option is only relevant to the CMS crypto engine, and ignored by
2736 all other engines.
2737 @end deftypefun
2738
2739 @deftypefun int gpgme_get_include_certs (@w{gpgme_ctx_t @var{ctx}})
2740 The function @code{gpgme_get_include_certs} returns the number of
2741 certificates to include into an S/MIME signed message.
2742 @end deftypefun
2743
2744
2745 @node Key Listing Mode
2746 @subsection Key Listing Mode
2747 @cindex key listing mode
2748 @cindex key listing, mode of
2749
2750 @deftypefun gpgme_error_t gpgme_set_keylist_mode (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_keylist_mode_t @var{mode}})
2751 The function @code{gpgme_set_keylist_mode} changes the default
2752 behaviour of the key listing functions.  The value in @var{mode} is a
2753 bitwise-or combination of one or multiple of the following bit values:
2754
2755 @table @code
2756 @item GPGME_KEYLIST_MODE_LOCAL
2757 The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
2758 keyring should be searched for keys in the keylisting operation.  This
2759 is the default.
2760
2761 @item GPGME_KEYLIST_MODE_EXTERN
2762 The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
2763 source should be searched for keys in the keylisting operation.  The
2764 type of external source is dependent on the crypto engine used and
2765 whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}.  For
2766 example, it can be a remote keyserver or LDAP certificate server.
2767
2768 @item GPGME_KEYLIST_MODE_SIGS
2769 The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key
2770 signatures should be included in the listed keys.
2771
2772 @item GPGME_KEYLIST_MODE_SIG_NOTATIONS
2773 @since{1.1.1}
2774
2775 The @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} symbol specifies that the
2776 signature notations on key signatures should be included in the listed
2777 keys.  This only works if @code{GPGME_KEYLIST_MODE_SIGS} is also
2778 enabled.
2779
2780 @item GPGME_KEYLIST_MODE_WITH_TOFU
2781 @since{1.7.0}
2782
2783 The @code{GPGME_KEYLIST_MODE_WITH_TOFU} symbol specifies that
2784 information pertaining to the TOFU trust model should be included in
2785 the listed keys.
2786
2787 @item GPGME_KEYLIST_MODE_WITH_SECRET
2788 @since{1.5.1}
2789
2790 The @code{GPGME_KEYLIST_MODE_WITH_SECRET} returns information about
2791 the presence of a corresponding secret key in a public key listing.  A
2792 public key listing with this mode is slower than a standard listing
2793 but can be used instead of a second run to list the secret keys.  This
2794 is only supported for GnuPG versions >= 2.1.
2795
2796 @item GPGME_KEYLIST_MODE_EPHEMERAL
2797 @since{1.2.0}
2798
2799 The @code{GPGME_KEYLIST_MODE_EPHEMERAL} symbol specifies that keys
2800 flagged as ephemeral are included in the listing.
2801
2802 @item GPGME_KEYLIST_MODE_VALIDATE
2803 @since{0.4.5}
2804
2805 The @code{GPGME_KEYLIST_MODE_VALIDATE} symbol specifies that the
2806 backend should do key or certificate validation and not just get the
2807 validity information from an internal cache.  This might be an
2808 expensive operation and is in general not useful.  Currently only
2809 implemented for the S/MIME backend and ignored for other backends.
2810
2811 @end table
2812
2813 At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
2814 @code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
2815 compatibility, you should get the current mode with
2816 @code{gpgme_get_keylist_mode} and modify it by setting or clearing the
2817 appropriate bits, and then using that calculated value in the
2818 @code{gpgme_set_keylisting_mode} operation.  This will leave all other
2819 bits in the mode value intact (in particular those that are not used
2820 in the current version of the library).
2821
2822 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2823 mode could be set correctly, and @code{GPG_ERR_INV_VALUE} if @var{ctx}
2824 is not a valid pointer or @var{mode} is not a valid mode.
2825 @end deftypefun
2826
2827
2828 @deftypefun gpgme_keylist_mode_t gpgme_get_keylist_mode (@w{gpgme_ctx_t @var{ctx}})
2829 The function @code{gpgme_get_keylist_mode} returns the current key
2830 listing mode of the context @var{ctx}.  This value can then be
2831 modified and used in a subsequent @code{gpgme_set_keylist_mode}
2832 operation to only affect the desired bits (and leave all others
2833 intact).
2834
2835 The function returns 0 if @var{ctx} is not a valid pointer, and the
2836 current mode otherwise.  Note that 0 is not a valid mode value.
2837 @end deftypefun
2838
2839
2840 @node Passphrase Callback
2841 @subsection Passphrase Callback
2842 @cindex callback, passphrase
2843 @cindex passphrase callback
2844
2845 @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}})}
2846 @tindex gpgme_passphrase_cb_t
2847 The @code{gpgme_passphrase_cb_t} type is the type of functions usable as
2848 passphrase callback function.
2849
2850 The argument @var{uid_hint} might contain a string that gives an
2851 indication for which user ID the passphrase is required.  If this is
2852 not available, or not applicable (in the case of symmetric encryption,
2853 for example), @var{uid_hint} will be @code{NULL}.
2854
2855 The argument @var{passphrase_info}, if not @code{NULL}, will give
2856 further information about the context in which the passphrase is
2857 required.  This information is engine and operation specific.
2858
2859 If this is the repeated attempt to get the passphrase, because
2860 previous attempts failed, then @var{prev_was_bad} is 1, otherwise it
2861 will be 0.
2862
2863 The user must write the passphrase, followed by a newline character,
2864 to the file descriptor @var{fd}.  The function @code{gpgme_io_writen}
2865 should be used for the write operation.  Note that if the user returns
2866 0 to indicate success, the user must at least write a newline
2867 character before returning from the callback.
2868
2869 If an error occurs, return the corresponding @code{gpgme_error_t}
2870 value.  You can use the error code @code{GPG_ERR_CANCELED} to abort
2871 the operation.  Otherwise, return @code{0}.
2872
2873 Note: The passphrase_cb only works with GnuPG 1.x and 2.1.x and not
2874 with the 2.0.x series. See @code{gpgme_set_pinentry_mode} for more
2875 details on 2.1.x usage.
2876 @end deftp
2877
2878 @deftypefun void gpgme_set_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t @var{passfunc}}, @w{void *@var{hook_value}})
2879 The function @code{gpgme_set_passphrase_cb} sets the function that is
2880 used when a passphrase needs to be provided by the user to
2881 @var{passfunc}.  The function @var{passfunc} needs to implemented by
2882 the user, and whenever it is called, it is called with its first
2883 argument being @var{hook_value}.  By default, no passphrase callback
2884 function is set.
2885
2886 Not all crypto engines require this callback to retrieve the
2887 passphrase.  It is better if the engine retrieves the passphrase from
2888 a trusted agent (a daemon process), rather than having each user to
2889 implement their own passphrase query.  Some engines do not even
2890 support an external passphrase callback at all, in this case the error
2891 code @code{GPG_ERR_NOT_SUPPORTED} is returned.
2892
2893 For GnuPG >= 2.1 the pinentry mode has to be set to
2894 @code{GPGME_PINENTRY_MODE_LOOPBACK} to enable the passphrase callback.
2895 See @code{gpgme_set_pinentry_mode}.
2896
2897 The user can disable the use of a passphrase callback function by
2898 calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
2899 @code{NULL}.
2900 @end deftypefun
2901
2902 @deftypefun void gpgme_get_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t *@var{passfunc}}, @w{void **@var{hook_value}})
2903 The function @code{gpgme_get_passphrase_cb} returns the function that
2904 is used when a passphrase needs to be provided by the user in
2905 @var{*passfunc}, and the first argument for this function in
2906 @var{*hook_value}.  If no passphrase callback is set, or @var{ctx} is
2907 not a valid pointer, @code{NULL} is returned in both variables.
2908
2909 @var{passfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2910 the corresponding value will not be returned.
2911 @end deftypefun
2912
2913
2914 @node Progress Meter Callback
2915 @subsection Progress Meter Callback
2916 @cindex callback, progress meter
2917 @cindex progress meter callback
2918
2919 @deftp {Data type} {void (*gpgme_progress_cb_t)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
2920 @tindex gpgme_progress_cb_t
2921 The @code{gpgme_progress_cb_t} type is the type of functions usable as
2922 progress callback function.
2923
2924 The arguments are specific to the crypto engine.  More information
2925 about the progress information returned from the GnuPG engine can be
2926 found in the GnuPG source code in the file @file{doc/DETAILS} in the
2927 section PROGRESS.
2928 @end deftp
2929
2930 @deftypefun void gpgme_set_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t @var{progfunc}}, @w{void *@var{hook_value}})
2931 The function @code{gpgme_set_progress_cb} sets the function that is
2932 used when progress information about a cryptographic operation is
2933 available.  The function @var{progfunc} needs to implemented by the
2934 user, and whenever it is called, it is called with its first argument
2935 being @var{hook_value}.  By default, no progress callback function
2936 is set.
2937
2938 Setting a callback function allows an interactive program to display
2939 progress information about a long operation to the user.
2940
2941 The user can disable the use of a progress callback function by
2942 calling @code{gpgme_set_progress_cb} with @var{progfunc} being
2943 @code{NULL}.
2944 @end deftypefun
2945
2946 @deftypefun void gpgme_get_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t *@var{progfunc}}, @w{void **@var{hook_value}})
2947 The function @code{gpgme_get_progress_cb} returns the function that is
2948 used to inform the user about the progress made in @var{*progfunc},
2949 and the first argument for this function in @var{*hook_value}.  If no
2950 progress callback is set, or @var{ctx} is not a valid pointer,
2951 @code{NULL} is returned in both variables.
2952
2953 @var{progfunc} or @var{hook_value} can be @code{NULL}.  In this case,
2954 the corresponding value will not be returned.
2955 @end deftypefun
2956
2957
2958 @node Status Message Callback
2959 @subsection Status Message Callback
2960 @cindex callback, status message
2961 @cindex status message callback
2962
2963 @deftp {Data type} {gpgme_error_t (*gpgme_status_cb_t)(void *@var{hook}, const char *@var{keyword}, const char *@var{args})}
2964 @tindex gpgme_status_cb_t
2965 The @code{gpgme_status_cb_t} type is the type of function usable as
2966 a status message callback function.
2967
2968 The argument @var{keyword} is the name of the status message while the
2969 @var{args} argument contains any arguments for the status message.
2970
2971 If an error occurs, return the corresponding @code{gpgme_error_t}
2972 value. Otherwise, return @code{0}.
2973 @end deftp
2974
2975 @deftypefun void gpgme_set_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t @var{statusfunc}}, @w{void *@var{hook_value}})
2976 @since{1.6.0}
2977
2978 The function @code{gpgme_set_status_cb} sets the function that is used when a
2979 status message is received from gpg to @var{statusfunc}. The function
2980 @var{statusfunc} needs to be implemented by the user, and whenever it is
2981 called, it is called with its first argument being @var{hook_value}.  By
2982 default, no status message callback function is set.
2983
2984 The user can disable the use of a status message callback function by calling
2985 @code{gpgme_set_status_cb} with @var{statusfunc} being @code{NULL}.
2986 @end deftypefun
2987
2988 @deftypefun void gpgme_get_status_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_status_cb_t *@var{statusfunc}}, @w{void **@var{hook_value}})
2989 @since{1.6.0}
2990
2991 The function @code{gpgme_get_status_cb} returns the function that is used to
2992 process status messages from gpg in @var{*statusfunc}, and the first argument
2993 for this function in @var{*hook_value}.  If no status message callback is set,
2994 or @var{ctx} is not a valid pointer, @code{NULL} is returned in both
2995 variables.
2996 @end deftypefun
2997
2998 @deftypefun {gpgme_error_t} gpgme_set_ctx_flag  @
2999             (@w{gpgme_ctx_t @var{ctx}}, @
3000             @w{const char *@var{name}}, @
3001             @w{const char *@var{value}})
3002
3003 @since{1.7.0}
3004
3005 Some minor properties of the context can be controlled with flags set
3006 by this function.  The properties are identified by the following
3007 values for @var{name}:
3008
3009 @table @code
3010 @item "redraw"
3011 This flag is normally not changed by the caller because GPGME sets and
3012 clears it automatically: The flag is cleared before an operation and
3013 set if an operation noticed that the engine has launched a Pinentry.
3014 A Curses based application may use this information to redraw the
3015 screen; for example:
3016
3017 @example
3018     err = gpgme_op_keylist_start (ctx, "foo@@example.org", 0);
3019     while (!err)
3020       @{
3021         err = gpgme_op_keylist_next (ctx, &key);
3022         if (err)
3023           break;
3024         show_key (key);
3025         gpgme_key_release (key);
3026       @}
3027     if ((s = gpgme_get_ctx_flag (ctx, "redraw")) && *s)
3028       redraw_screen ();
3029     gpgme_release (ctx);
3030 @end example
3031
3032
3033 @item "full-status"
3034 Using a @var{value} of "1" the status callback set by
3035 gpgme_set_status_cb returns all status lines with the exception of
3036 PROGRESS lines.  With the default of "0" the status callback is only
3037 called in certain situations.
3038
3039 @item "raw-description"
3040 Setting the @var{value} to "1" returns human readable strings in a raw
3041 format.  For example the non breaking space characters ("~") will not
3042 be removed from the @code{description} field of the
3043 @code{gpgme_tofu_info_t} object.
3044
3045 @item "export-session-key"
3046 Using a @var{value} of "1" specifies that the context should try to
3047 export the symmetric session key when decrypting data.  By default, or
3048 when using an empty string or "0" for @var{value}, session keys are
3049 not exported.
3050
3051 @item "override-session-key"
3052 The string given in @var{value} is passed to the GnuPG engine to override
3053 the session key for decryption.  The format of that session key is
3054 specific to GnuPG and can be retrieved during a decrypt operation when
3055 the context flag "export-session-key" is enabled.  Please be aware that
3056 using this feature with GnuPG < 2.1.16 will leak the session key on
3057 many platforms via ps(1).
3058
3059 @item "auto-key-retrieve"
3060 Setting the @var{value} to "1" asks the backend to automatically
3061 retrieve a key for signature verification if possible.  Note that this
3062 option makes a "web bug" like behavior possible.  Keyserver or Web Key
3063 Directory operators can see which keys you request, so by sending you
3064 a message signed by a brand new key (which you naturally will not have
3065 on your local keyring), the operator can tell both your IP address and
3066 the time when you verified the signature.
3067
3068
3069 @end table
3070
3071 This function returns @code{0} on success.
3072 @end deftypefun
3073
3074
3075 @deftypefun {const char *} gpgme_get_ctx_flag  @
3076             (@w{gpgme_ctx_t @var{ctx}}, @
3077             @w{const char *@var{name}})
3078
3079 @since{1.8.0}
3080
3081 The value of flags settable by @code{gpgme_set_ctx_flag} can be
3082 retrieved by this function.  If @var{name} is unknown the function
3083 returns @code{NULL}.  For boolean flags an empty string is returned
3084 for False and the string "1" is returned for True; either atoi(3) or a
3085 test for an empty string can be used to get the boolean value.
3086
3087 @end deftypefun
3088
3089
3090 @node Locale
3091 @subsection Locale
3092 @cindex locale, default
3093 @cindex locale, of a context
3094
3095 A locale setting can be associated with a context.  This locale is
3096 passed to the crypto engine, and used for applications like the PIN
3097 entry, which is displayed to the user when entering a passphrase is
3098 required.
3099
3100 The default locale is used to initialize the locale setting of all
3101 contexts created afterwards.
3102
3103 @deftypefun gpgme_error_t gpgme_set_locale (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{category}}, @w{const char *@var{value}})
3104 @since{0.4.3}
3105
3106 The function @code{gpgme_set_locale} sets the locale of the context
3107 @var{ctx}, or the default locale if @var{ctx} is a null pointer.
3108
3109 The locale settings that should be changed are specified by
3110 @var{category}.  Supported categories are @code{LC_CTYPE},
3111 @code{LC_MESSAGES}, and @code{LC_ALL}, which is a wildcard you can use
3112 if you want to change all the categories at once.
3113
3114 The value to be used for the locale setting is @var{value}, which will
3115 be copied to @acronym{GPGME}'s internal data structures.  @var{value}
3116 can be a null pointer, which disables setting the locale, and will
3117 make PIN entry and other applications use their default setting, which
3118 is usually not what you want.
3119
3120 Note that the settings are only used if the application runs on a text
3121 terminal, and that the settings should fit the configuration of the
3122 output terminal.  Normally, it is sufficient to initialize the default
3123 value at startup.
3124
3125 The function returns an error if not enough memory is available.
3126 @end deftypefun
3127
3128
3129 @node Key Management
3130 @section Key Management
3131 @cindex key management
3132
3133 Some of the cryptographic operations require that recipients or
3134 signers are specified.  This is always done by specifying the
3135 respective keys that should be used for the operation.  The following
3136 section describes how such keys can be selected and manipulated.
3137
3138
3139 @menu
3140 * Key objects::                   Description of the key structures.
3141 * Listing Keys::                  Browsing the list of available keys.
3142 * Information About Keys::        Requesting detailed information about keys.
3143 * Manipulating Keys::             Operations on keys.
3144 * Generating Keys::               Creating new key pairs.
3145 * Signing Keys::                  Adding key signatures to public keys.
3146 * Exporting Keys::                Retrieving key data from the key ring.
3147 * Importing Keys::                Adding keys to the key ring.
3148 * Deleting Keys::                 Removing keys from the key ring.
3149 * Changing Passphrases::          Change the passphrase of a key.
3150 * Changing TOFU Data::            Changing data pertaining to TOFU.
3151 * Advanced Key Editing::          Advanced key edit operation.
3152 @end menu
3153
3154 @node Key objects
3155 @subsection Key objects
3156
3157 The keys are represented in GPGME by structures which may only be read
3158 by the application but never be allocated or changed.  They are valid
3159 as long as the key object itself is valid.
3160
3161 @deftp {Data type} gpgme_key_t
3162
3163 The @code{gpgme_key_t} type is a pointer to a key object.  It has the
3164 following members:
3165
3166 @table @code
3167 @item gpgme_keylist_mode_t keylist_mode
3168 @since{0.9.0}
3169
3170 The keylist mode that was active when the key was retrieved.
3171
3172 @item unsigned int revoked : 1
3173 This is true if the key is revoked.
3174
3175 @item unsigned int expired : 1
3176 This is true if the key is expired.
3177
3178 @item unsigned int disabled : 1
3179 This is true if the key is disabled.
3180
3181 @item unsigned int invalid : 1
3182 This is true if the key is invalid. This might have several reasons,
3183 for a example for the S/MIME backend, it will be set during key
3184 listings if the key could not be validated due to missing
3185 certificates or unmatched policies.
3186
3187 @item unsigned int can_encrypt : 1
3188 This is true if the key (ie one of its subkeys) can be used for
3189 encryption.
3190
3191 @item unsigned int can_sign : 1
3192 This is true if the key (ie one of its subkeys) can be used to create
3193 data signatures.
3194
3195 @item unsigned int can_certify : 1
3196 This is true if the key (ie one of its subkeys) can be used to create
3197 key certificates.
3198
3199 @item unsigned int can_authenticate : 1
3200 @since{0.4.5}
3201
3202 This is true if the key (ie one of its subkeys) can be used for
3203 authentication.
3204
3205 @item unsigned int is_qualified : 1
3206 @since{1.1.0}
3207
3208 This is true if the key can be used for qualified signatures according
3209 to local government regulations.
3210
3211 @item unsigned int secret : 1
3212 This is true if the key is a secret key.  Note, that this will always
3213 be true even if the corresponding subkey flag may be false
3214 (offline/stub keys).  This is only set if a listing of secret keys has
3215 been requested or if @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3216
3217 @item unsigned int origin : 5
3218 @since{1.8.0}
3219
3220 Reserved for the origin of this key.
3221
3222 @item gpgme_protocol_t protocol
3223 This is the protocol supported by this key.
3224
3225 @item char *issuer_serial
3226 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3227 issuer serial.
3228
3229 @item char *issuer_name
3230 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3231 issuer name.
3232
3233 @item char *chain_id
3234 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
3235 chain ID, which can be used to built the certificate chain.
3236
3237 @item gpgme_validity_t owner_trust
3238 If @code{protocol} is @code{GPGME_PROTOCOL_OpenPGP}, then this is the
3239 owner trust.
3240
3241 @item gpgme_subkey_t subkeys
3242 This is a linked list with the subkeys of the key.  The first subkey
3243 in the list is the primary key and usually available.
3244
3245 @item gpgme_user_id_t uids
3246 This is a linked list with the user IDs of the key.  The first user ID
3247 in the list is the main (or primary) user ID.
3248
3249 @item char *fpr
3250 @since{1.7.0}
3251
3252 This field gives the fingerprint of the primary key.  Note that
3253 this is a copy of the fingerprint of the first subkey.  For an
3254 incomplete key (for example from a verification result) a subkey may
3255 be missing but this field may be set nevertheless.
3256
3257 @item unsigned long last_update
3258 @since{1.8.0}
3259
3260 Reserved for the time of the last update of this key.
3261
3262 @end table
3263 @end deftp
3264
3265
3266 @deftp {Data type} gpgme_subkey_t
3267 @since{1.5.0}
3268
3269 The @code{gpgme_subkey_t} type is a pointer to a subkey structure.
3270 Subkeys are one component of a @code{gpgme_key_t} object.  In fact,
3271 subkeys are those parts that contains the real information about the
3272 individual cryptographic keys that belong to the same key object.  One
3273 @code{gpgme_key_t} can contain several subkeys.  The first subkey in
3274 the linked list is also called the primary key.
3275
3276 The subkey structure has the following members:
3277
3278 @table @code
3279 @item gpgme_subkey_t next
3280 This is a pointer to the next subkey structure in the linked list, or
3281 @code{NULL} if this is the last element.
3282
3283 @item unsigned int revoked : 1
3284 This is true if the subkey is revoked.
3285
3286 @item unsigned int expired : 1
3287 This is true if the subkey is expired.
3288
3289 @item unsigned int disabled : 1
3290 This is true if the subkey is disabled.
3291
3292 @item unsigned int invalid : 1
3293 This is true if the subkey is invalid.
3294
3295 @item unsigned int can_encrypt : 1
3296 This is true if the subkey can be used for encryption.
3297
3298 @item unsigned int can_sign : 1
3299 This is true if the subkey can be used to create data signatures.
3300
3301 @item unsigned int can_certify : 1
3302 This is true if the subkey can be used to create key certificates.
3303
3304 @item unsigned int can_authenticate : 1
3305 @since{0.4.5}
3306
3307 This is true if the subkey can be used for authentication.
3308
3309 @item unsigned int is_qualified : 1
3310 @since{1.1.0}
3311
3312 This is true if the subkey can be used for qualified signatures
3313 according to local government regulations.
3314
3315 @item unsigned int is_de_vs : 1
3316 @since{1.8.0}
3317
3318 This is true if the subkey complies with the rules for classified
3319 information in Germany at the restricted level (VS-NfD).  This are
3320 currently RSA keys of at least 2048 bits or ECDH/ECDSA keys using a
3321 Brainpool curve.
3322
3323 @item unsigned int secret : 1
3324 This is true if the subkey is a secret key.  Note that it will be
3325 false if the key is actually a stub key; i.e. a secret key operation
3326 is currently not possible (offline-key).  This is only set if a
3327 listing of secret keys has been requested or if
3328 @code{GPGME_KEYLIST_MODE_WITH_SECRET} is active.
3329
3330 @item gpgme_pubkey_algo_t pubkey_algo
3331 This is the public key algorithm supported by this subkey.
3332
3333 @item unsigned int length
3334 This is the length of the subkey (in bits).
3335
3336 @item char *keyid
3337 This is the key ID of the subkey in hexadecimal digits.
3338
3339 @item char *fpr
3340 This is the fingerprint of the subkey in hexadecimal digits, if
3341 available.
3342
3343 @item char *keygrip
3344 @since{1.7.0}
3345
3346 The keygrip of the subkey in hex digit form or @code{NULL} if not
3347 availabale.
3348
3349 @item long int timestamp
3350 This is the creation timestamp of the subkey.  This is -1 if the
3351 timestamp is invalid, and 0 if it is not available.
3352
3353 @item long int expires
3354 This is the expiration timestamp of the subkey, or 0 if the subkey
3355 does not expire.
3356
3357 @item unsigned int is_cardkey : 1
3358 @since{1.2.0}
3359
3360 True if the secret key is stored on a smart card.
3361
3362 @item char *card_number
3363 @since{1.2.0}
3364
3365 The serial number of a smart card holding this key or @code{NULL}.
3366
3367 @item char *curve
3368 For ECC algorithms the name of the curve.
3369
3370 @end table
3371 @end deftp
3372
3373 @deftp {Data type} gpgme_user_id_t
3374
3375 A user ID is a component of a @code{gpgme_key_t} object.  One key can
3376 have many user IDs.  The first one in the list is the main (or
3377 primary) user ID.
3378
3379 The user ID structure has the following members.
3380
3381 @table @code
3382 @item gpgme_user_id_t next
3383 This is a pointer to the next user ID structure in the linked list, or
3384 @code{NULL} if this is the last element.
3385
3386 @item unsigned int revoked : 1
3387 This is true if the user ID is revoked.
3388
3389 @item unsigned int invalid : 1
3390 This is true if the user ID is invalid.
3391
3392 @item gpgme_validity_t validity
3393 This specifies the validity of the user ID.
3394
3395 @item char *uid
3396 This is the user ID string.
3397
3398 @item char *name
3399 This is the name component of @code{uid}, if available.
3400
3401 @item char *comment
3402 This is the comment component of @code{uid}, if available.
3403
3404 @item char *email
3405 This is the email component of @code{uid}, if available.
3406
3407 @item char *address;
3408 The mail address (addr-spec from RFC-5322) of the user ID string.
3409 This is general the same as the @code{email} part of this structure
3410 but might be slightly different.  If no mail address is available
3411 @code{NULL} is stored.
3412
3413 @item gpgme_tofu_info_t tofu
3414 @since{1.7.0}
3415
3416 If not @code{NULL} information from the TOFU database pertaining to
3417 this user id.
3418
3419 @item gpgme_key_sig_t signatures
3420 This is a linked list with the signatures on this user ID.
3421
3422 @item unsigned int origin : 5
3423 @since{1.8.0}
3424
3425 Reserved for the origin of this user ID.
3426
3427 @item unsigned long last_update
3428 @since{1.8.0}
3429
3430 Reserved for the time of the last update of this user ID.
3431
3432 @end table
3433 @end deftp
3434
3435
3436 @deftp {Data type} gpgme_tofu_info_t
3437
3438 @since{1.7.0}
3439
3440 The @code{gpgme_tofu_info_t} type is a pointer to a tofu info
3441 structure.  Tofu info structures are one component of a
3442 @code{gpgme_user_id_t} object, and provide information from the TOFU
3443 database pertaining to the user ID.
3444
3445 The tofu info structure has the following members:
3446
3447 @table @code
3448 @item gpgme_key_sig_t next
3449 This is a pointer to the next tofu info structure in the linked
3450 list, or @code{NULL} if this is the last element.
3451
3452 @item unsigned int validity : 3
3453 This is the TOFU validity.  It can have the following values:
3454
3455 @table @code
3456 @item 0
3457 The value @code{0} indicates a conflict.
3458
3459 @item 1
3460 The value @code{1} indicates a key without history.
3461
3462 @item 2
3463 The value @code{2} indicates a key with too little history.
3464
3465 @item 3
3466 The value @code{3} indicates a key with enough history for basic trust.
3467
3468 @item 4
3469 The value @code{4} indicates a key with a lot of history.
3470
3471 @end table
3472
3473 @item unsigned int policy : 4
3474 This is the TOFU policy, see @code{gpgme_tofu_policy_t}.
3475
3476 @item unsigned short signcount
3477 This is the number of signatures seen for this binding (or
3478 @code{USHRT_MAX} if there are more than that).
3479
3480 @item unsigned short encrcount
3481 This is the number of encryptions done with this binding (or
3482 @code{USHRT_MAX} if there are more than that).
3483
3484 @item unsigned long signfirst
3485 Number of seconds since Epoch when the first signature was seen with
3486 this binding.
3487
3488 @item unsigned long signlast
3489 Number of seconds since Epoch when the last signature was seen with
3490 this binding.
3491
3492 @item unsigned long encrfirst
3493 Number of seconds since Epoch when the first encryption was done with
3494 this binding.
3495
3496 @item unsigned long encrlast
3497 Number of seconds since Epoch when the last encryption was done with
3498 this binding.
3499
3500 @item char *description
3501 A human-readable string summarizing the TOFU data (or NULL).
3502
3503 @end table
3504 @end deftp
3505
3506
3507 @deftp {Data type} gpgme_key_sig_t
3508
3509 The @code{gpgme_key_sig_t} type is a pointer to a key signature structure.
3510 Key signatures are one component of a @code{gpgme_key_t} object, and
3511 validate user IDs on the key in the OpenPGP protocol.
3512
3513 The signatures on a key are only available if the key was retrieved
3514 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
3515 enabled, because it can be expensive to retrieve all signatures of a
3516 key.
3517
3518 The signature notations on a key signature are only available if the
3519 key was retrieved via a listing operation with the
3520 @code{GPGME_KEYLIST_MODE_SIG_NOTATIONS} mode enabled, because it can
3521 be expensive to retrieve all signature notations.
3522
3523 The key signature structure has the following members:
3524
3525 @table @code
3526 @item gpgme_key_sig_t next
3527 This is a pointer to the next key signature structure in the linked
3528 list, or @code{NULL} if this is the last element.
3529
3530 @item unsigned int revoked : 1
3531 This is true if the key signature is a revocation signature.
3532
3533 @item unsigned int expired : 1
3534 This is true if the key signature is expired.
3535
3536 @item unsigned int invalid : 1
3537 This is true if the key signature is invalid.
3538
3539 @item unsigned int exportable : 1
3540 This is true if the key signature is exportable.
3541
3542 @item gpgme_pubkey_algo_t pubkey_algo
3543 This is the public key algorithm used to create the signature.
3544
3545 @item char *keyid
3546 This is the key ID of the key (in hexadecimal digits) used to create
3547 the signature.
3548
3549 @item long int timestamp
3550 This is the creation timestamp of the key signature.  This is -1 if
3551 the timestamp is invalid, and 0 if it is not available.
3552
3553 @item long int expires
3554 This is the expiration timestamp of the key signature, or 0 if the key
3555 signature does not expire.
3556
3557 @item gpgme_error_t status
3558 This is the status of the signature and has the same meaning as the
3559 member of the same name in a @code{gpgme_signature_t} object.
3560
3561 @item unsigned int sig_class
3562 This specifies the signature class of the key signature.  The meaning
3563 is specific to the crypto engine.
3564
3565 @item char *uid
3566 This is the main user ID of the key used to create the signature.
3567
3568 @item char *name
3569 This is the name component of @code{uid}, if available.
3570
3571 @item char *comment
3572 This is the comment component of @code{uid}, if available.
3573
3574 @item char *email
3575 This is the email component of @code{uid}, if available.
3576
3577 @item gpgme_sig_notation_t notations
3578 This is a linked list with the notation data and policy URLs.
3579 @end table
3580 @end deftp
3581
3582
3583
3584 @node Listing Keys
3585 @subsection Listing Keys
3586 @cindex listing keys
3587 @cindex key listing
3588 @cindex key listing, start
3589 @cindex key ring, list
3590 @cindex key ring, search
3591
3592 @deftypefun gpgme_error_t gpgme_op_keylist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
3593
3594 The function @code{gpgme_op_keylist_start} initiates a key listing
3595 operation inside the context @var{ctx}.  It sets everything up so that
3596 subsequent invocations of @code{gpgme_op_keylist_next} return the keys
3597 in the list.
3598
3599 If @var{pattern} is @code{NULL}, all available keys are returned.
3600 Otherwise, @var{pattern} contains an engine specific expression that
3601 is used to limit the list to all keys matching the pattern.  Note that
3602 the total length of the pattern is restricted to an engine-specific
3603 maximum (a couple of hundred characters are usually accepted).  The
3604 pattern should be used to restrict the search to a certain common name
3605 or user, not to list many specific keys at once by listing their
3606 fingerprints or key IDs.
3607
3608 If @var{secret_only} is not @code{0}, the list is restricted to secret
3609 keys only.
3610
3611 The context will be busy until either all keys are received (and
3612 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3613 @code{gpgme_op_keylist_end} is called to finish the operation.
3614
3615 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3616 @var{ctx} is not a valid pointer, and passes through any errors that
3617 are reported by the crypto engine support routines.
3618 @end deftypefun
3619
3620 @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}})
3621
3622 The function @code{gpgme_op_keylist_ext_start} initiates an extended
3623 key listing operation inside the context @var{ctx}.  It sets
3624 everything up so that subsequent invocations of
3625 @code{gpgme_op_keylist_next} return the keys in the list.
3626
3627 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
3628 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
3629 array of strings that are used to limit the list to all keys matching
3630 at least one of the patterns verbatim.  Note that the total length of
3631 all patterns is restricted to an engine-specific maximum (the exact
3632 limit also depends on the number of patterns and amount of quoting
3633 required, but a couple of hundred characters are usually accepted).
3634 Patterns should be used to restrict the search to a certain common
3635 name or user, not to list many specific keys at once by listing their
3636 fingerprints or key IDs.
3637
3638 If @var{secret_only} is not @code{0}, the list is restricted to secret
3639 keys only.
3640
3641 The value of @var{reserved} must be @code{0}.
3642
3643 The context will be busy until either all keys are received (and
3644 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3645 @code{gpgme_op_keylist_end} is called to finish the operation.
3646
3647 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3648 @var{ctx} is not a valid pointer, and passes through any errors that
3649 are reported by the crypto engine support routines.
3650 @end deftypefun
3651
3652 @deftypefun gpgme_error_t gpgme_op_keylist_from_data_start @
3653             (@w{gpgme_ctx_t @var{ctx}}, @
3654              @w{gpgme_data_t @var{data}}, @
3655              @w{int @var{reserved}})
3656
3657 @since{1.8.0}
3658
3659 The function @code{gpgme_op_keylist_from_data_start} initiates a key
3660 listing operation inside the context @var{ctx}.  In contrast to the
3661 other key listing operation the keys are read from the supplied
3662 @var{data} and not from the local key database.  The keys are also not
3663 imported into the local key database.  The function sets everything up
3664 so that subsequent invocations of @code{gpgme_op_keylist_next} return
3665 the keys from @var{data}.
3666
3667 The value of @var{reserved} must be @code{0}.
3668
3669 This function requires at least GnuPG version 2.1.14 and currently
3670 works only with OpenPGP keys.
3671
3672 The context will be busy until either all keys are received (and
3673 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
3674 @code{gpgme_op_keylist_end} is called to finish the operation.
3675 While the context is busy @var{data} may not be released.
3676
3677 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3678 @var{ctx} is not a valid pointer, and passes through any errors that
3679 are reported by the crypto engine support routines.
3680 @end deftypefun
3681
3682 @deftypefun gpgme_error_t gpgme_op_keylist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{r_key}})
3683
3684 The function @code{gpgme_op_keylist_next} returns the next key in the
3685 list created by a previous @code{gpgme_op_keylist_start} operation in
3686 the context @var{ctx}.  The key will have one reference for the user.
3687 @xref{Manipulating Keys}.
3688
3689 This is the only way to get at @code{gpgme_key_t} objects in
3690 @acronym{GPGME}.
3691
3692 If the last key in the list has already been returned,
3693 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}.
3694
3695 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3696 @var{ctx} or @var{r_key} is not a valid pointer, and
3697 @code{GPG_ERR_ENOMEM} if there is not enough memory for the operation.
3698 @end deftypefun
3699
3700 @deftypefun gpgme_error_t gpgme_op_keylist_end (@w{gpgme_ctx_t @var{ctx}})
3701
3702 The function @code{gpgme_op_keylist_end} ends a pending key list
3703 operation in the context @var{ctx}.
3704
3705 After the operation completed successfully, the result of the key
3706 listing operation can be retrieved with
3707 @code{gpgme_op_keylist_result}.
3708
3709 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3710 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if at some
3711 time during the operation there was not enough memory available.
3712 @end deftypefun
3713
3714 The following example illustrates how all keys containing a certain
3715 string (@code{g10code}) can be listed with their key ID and the name
3716 and email address of the main user ID:
3717
3718 @example
3719 gpgme_ctx_t ctx;
3720 gpgme_key_t key;
3721 gpgme_error_t err = gpgme_new (&ctx);
3722
3723 if (!err)
3724   @{
3725     err = gpgme_op_keylist_start (ctx, "g10code", 0);
3726     while (!err)
3727       @{
3728         err = gpgme_op_keylist_next (ctx, &key);
3729         if (err)
3730           break;