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