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