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