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