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