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