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