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