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