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