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