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