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