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