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