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