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