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