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