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