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