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