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