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