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