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