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