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