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