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