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