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