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