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