2002-07-25 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / doc / gpgme.texi
1 \input texinfo                  @c -*- Texinfo -*-
2 @setfilename gpgme.info
3 @settitle The `GnuPG Made Easy' Reference Manual
4
5 @dircategory GNU Libraries
6 @direntry
7 * @acronym{GPGME}: (gpgme).          Adding support for cryptography to your program.
8 @end direntry
9
10 @include version.texi
11
12 @c Unify some of the indices.
13 @syncodeindex tp fn
14 @syncodeindex pg fn
15
16 @ifinfo
17 This file documents the @acronym{GPGME} library.
18
19 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
20 @cite{The `GnuPG Made Easy' Reference Manual}, for Version
21 @value{VERSION}.
22
23 Copyright @copyright{} 2002 g10 Code GmbH.
24
25 Permission is granted to copy, distribute and/or modify this document
26 under the terms of the GNU Free Documentation License, Version 1.1 or
27 any later version published by the Free Software Foundation; with the
28 Invariant Sections being ``Free Software Needs Free Documentation'' and
29 ``GNU Lesser General Public License'', the Front-Cover texts being (a)
30 (see below), and with the Back-Cover Texts being (b) (see below).  A
31 copy of the license is included in the section entitled ``GNU Free
32 Documentation License''.
33
34 @end ifinfo
35
36 @iftex
37 @shorttitlepage The `GnuPG Made Easy' Reference Manual
38 @end iftex
39 @titlepage
40 @center @titlefont{The `GnuPG Made Easy'}
41 @sp 1
42 @center @titlefont{Reference Manual}
43 @sp 6
44 @center Edition @value{EDITION}
45 @sp 1
46 @center last updated @value{UPDATED}
47 @sp 1
48 @center for version @value{VERSION}
49 @page
50 @vskip 0pt plus 1filll
51 Copyright @copyright{} 2002 g10 Code GmbH.
52
53 Permission is granted to copy, distribute and/or modify this document
54 under the terms of the GNU Free Documentation License, Version 1.1 or
55 any later version published by the Free Software Foundation; with the
56 Invariant Sections being ``Free Software Needs Free Documentation'' and
57 ``GNU Lesser General Public License'', the Front-Cover texts being (a)
58 (see below), and with the Back-Cover Texts being (b) (see below).  A
59 copy of the license is included in the section entitled ``GNU Free
60 Documentation License''.
61 @end titlepage
62 @page
63
64 @ifnottex
65 @node Top
66 @top Main Menu
67 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
68 @cite{The `GnuPG Made Easy' Reference Manual}, for Version
69 @value{VERSION} of the @acronym{GPGME} library.
70 @end ifnottex
71
72 @menu
73 * Introduction::                  How to use this manual.
74 * Preparation::                   What you should do before using the library.
75 * Protocols and Engines::         Supported crypto protocols.
76 * Error Handling::                Error numbers and their meanings.
77 * Exchanging Data::               Passing data to and from @acronym{GPGME}.
78 * Contexts::                      Handling @acronym{GPGME} contexts.
79
80 Appendices
81
82 * Copying::                       The GNU General Public License says how you
83                                   can copy and share `GnuPG Made Easy'.
84 * Free Documentation License::    This manual is under the GNU Free
85                                   Documentation License.
86
87 Indices
88
89 * Concept Index::                 Index of concepts and programs.
90 * Function and Data Index::       Index of functions, variables and data types.
91
92
93 @detailmenu
94  --- The Detailed Node Listing ---
95
96 Introduction
97
98 * Getting Started::               Purpose of the manual, and how to use it.
99 * Features::                      Reasons to install and use @acronym{GPGME}.
100 * Overview::                      Basic architecture of the @acronym{GPGME} library.
101
102 Preparation
103
104 * Header::                        What header file you need to include.
105 * Building the Source::           Compiler options to be used.
106 * Using Automake::                Compiler options to be used the easy way.
107 * Library Version Check::         Getting and verifying the library version.
108 * Multi Threading::               How GPGME can be used in an MT environment.
109
110 Protocols and Engines
111
112 * Engine Version Check::          Verifying the engine version.
113 * Engine Information::            Obtaining more information about the engines.
114 * OpenPGP::                       Support for the OpenPGP protocol.
115 * Cryptographic Message Syntax::  Support for the CMS.
116
117 Error Handling
118
119 * Error Values::                  A list of all error values used.
120 * Error Strings::                 How to get a descriptive string from a value.
121
122 Exchanging Data 
123
124 * Creating Data Buffers::         Creating new data buffers.
125 * Destroying Data Buffers::       Releasing data buffers.
126 * Manipulating Data Buffers::     Operations on data buffers.
127
128 Contexts
129
130 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
131 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
132 * Context Attributes::            Setting properties of a context.
133 * Key Management::                Managing keys with @acronym{GPGME}.
134 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
135 * Crypto Operations::             Using a context for cryptography.
136 * Run Control::                   Controlling how operations are run.
137
138 Context Attributes
139
140 * Protocol Selection::            Selecting the protocol used by a context.
141 * @acronym{ASCII} Armor::                   Requesting @acronym{ASCII} armored output.
142 * Text Mode::                     Choosing canonical text mode.
143 * Included Certificates::         Including a number of certificates.
144 * Key Listing Mode::              Selecting key listing mode.
145 * Passphrase Callback::           Getting the passphrase from the user.
146 * Progress Meter Callback::       Being informed about the progress.
147
148 Key Management
149
150 * Listing Keys::                  Browsing the list of available keys.
151 * Information About Keys::        Requesting detailed information about keys.
152 * Manipulating Keys::             Operations on keys.
153 * Generating Keys::               Creating new key pairs.
154 * Exporting Keys::                Retrieving key data from the key ring.
155 * Importing Keys::                Adding keys to the key ring.
156 * Deleting Keys::                 Removing keys from the key ring.
157
158 Trust Item Management
159
160 * Listing Trust Items::           Browsing the list of available trust items.
161 * Information About Trust Items:: Requesting detailed information about trust items.
162 * Manipulating Trust Items::      Operations on trust items.
163
164 Crypto Operations
165
166 * Decrypt::                       Decrypting a ciphertext.
167 * Verify::                        Verifying a signature.
168 * Decrypt and Verify::            Decrypting a signed ciphertext.
169 * Sign::                          Creating a signature.
170 * Encrypt::                       Encrypting a plaintext.
171 * Detailed Results::              How to obtain more info about the operation.
172
173 Sign
174
175 * Selecting Signers::             How to choose the keys to sign with.
176 * Creating a Signature::          How to create a signature.
177
178 Encrypt
179
180 * Selecting Recipients::          How to choose the recipients.
181 * Encrypting a Plaintext::        How to encrypt a plaintext.
182
183 Run Control
184
185 * Waiting For Completion::        Waiting until an operation is completed.
186 * Cancelling an Operation::       Interrupting a running operation.
187 * Hooking Up Into Idle Time::     Doing something when nothing has to be done.
188 * Using External Event Loops::    Advanced control over what happens when.
189
190 Using External Event Loops
191
192 * I/O Callback Interface::        How I/O callbacks are registered.
193 * Registering I/O Callbacks::     How to use I/O callbacks for a context.
194 * I/O Callback Example::          An example how to use I/O callbacks.
195 * I/O Callback Example GTK+::     How to integrate @acronym{GPGME} in GTK+.
196 * I/O Callback Example GDK::      How to integrate @acronym{GPGME} in GDK.
197
198 @end detailmenu
199 @end menu
200
201 @node Introduction
202 @chapter Introduction
203
204 `GnuPG Made Easy' (@acronym{GPGME}) is a C language library that
205 allows to add support for cryptography to a program.  It is designed
206 to make access to crypto engines like GnuPG or GpgSM easier for
207 applications.  @acronym{GPGME} provides a high-level crypto API for
208 encryption, decryption, signing, signature verification and key
209 management.
210
211 @acronym{GPGME} uses GnuPG and GpgSM as its backends to support
212 OpenPGP and the Cryptographic Message Syntax (CMS).
213
214 @menu
215 * Getting Started::               Purpose of the manual, and how to use it.
216 * Features::                      Reasons to install and use @acronym{GPGME}.
217 * Overview::                      Basic architecture of the @acronym{GPGME} library.
218 @end menu
219
220
221 @node Getting Started
222 @section Getting Started
223
224 This library documents the @acronym{GPGME} library programming
225 interface.  All functions and data types provided by the library are
226 explained.
227
228 The reader is assumed to possess basic knowledge about cryptography in
229 general, and public key cryptography in particular.  The underlying
230 cryptographic engines that are used by the library are not explained,
231 but where necessary, special features or requirements by an engine are
232 mentioned as far as they are relevant to @acronym{GPGME} or its users.
233
234 This manual can be used in several ways.  If read from the beginning
235 to the end, it gives a good introduction into the library and how it
236 can be used in an application.  Forward references are included where
237 necessary.  Later on, the manual can be used as a reference manual to
238 get just the information needed about any particular interface of the
239 library.  Experienced programmers might want to start looking at the
240 examples at the end of the manual, and then only read up those parts
241 of the interface which are unclear.
242
243
244 @node Features
245 @section Features
246
247 @acronym{GPGME} has a couple of advantages over other libraries doing
248 a similar job, and over implementing support for GnuPG or other crypto
249 engines into your application directly.
250
251 @table @asis
252 @item it's free software
253 Anybody can use, modify, and redistribute it under the terms of the GNU
254 General Public License (@pxref{Copying}).
255
256 @item it's flexible
257 @acronym{GPGME} provides transparent support for several cryptographic
258 protocols by different engines.  Currently, @acronym{GPGME} supports
259 the OpenPGP protocol using GnuPG as the backend, and the Cryptographic
260 Message Syntax using GpgSM as the backend.
261
262 @item it's easy
263 @acronym{GPGME} hides the differences between the protocols and
264 engines from the programmer behind an easy-to-use interface.  This way
265 the programmer can focus on the other parts of the program, and still
266 integrate strong cryptography in his application.  Once support for
267 @acronym{GPGME} has been added to a program, it is easy to add support
268 for other crypto protocols once @acronym{GPGME} backends provide them.
269 @end table
270
271
272 @node Overview
273 @section Overview
274
275 @acronym{GPGME} provides a data abstraction that is used to pass data
276 to the crypto engine, and receive returned data from it.  Data can be
277 read from memory or from files, but it can also be provided by a
278 callback function.
279
280 The actual cryptographic operations are always set within a context.
281 A context provides configuration parameters that define the behaviour
282 of all operations performed within it.  Only one operation per context
283 is allowed at any time, but when one operation is finished, you can
284 run the next operation in the same context.  There can be more than
285 one context, and all can run different operations at the same time.
286
287 Furthermore, @acronym{GPGME} has rich key management facilities
288 including listing keys, querying their attributes, generating,
289 importing, exporting and deleting keys, and acquiring information
290 about the trust path.
291
292 With some precautions, @acronym{GPGME} can be used in a multi-threaded
293 environment, although it is not completely thread safe and thus needs
294 the support of the application.
295
296
297 @node Preparation
298 @chapter Preparation
299
300 To use @acronym{GPGME}, you have to perform some changes to your
301 sources and the build system.  The necessary changes are small and
302 explained in the following sections.  At the end of this chapter, it
303 is described how the library is initialized, and how the requirements
304 of the library are verified.
305
306 @menu
307 * Header::                        What header file you need to include.
308 * Building the Source::           Compiler options to be used.
309 * Using Automake::                Compiler options to be used the easy way.
310 * Library Version Check::         Getting and verifying the library version.
311 * Multi Threading::               How GPGME can be used in an MT environment.
312 @end menu
313
314
315 @node Header
316 @section Header
317 @cindex header file
318 @cindex include file
319
320 All interfaces (data types and functions) of the library are defined
321 in the header file `gpgme.h'.  You must include this in all programs
322 using the library, either directly or through some other header file,
323 like this:
324
325 @example
326 #include <gpgme.h>
327 @end example
328
329 The name space of @acronym{GPGME} is @code{gpgme_*} for function
330 names, @code{Gpgme*} for data types and @code{GPGME_*} for other
331 symbols.
332
333
334 @node Building the Source
335 @section Building the Source
336 @cindex compiler options
337 @cindex compiler flags
338
339 If you want to compile a source file including the `gpgme.h' header
340 file, you must make sure that the compiler can find it in the
341 directory hierarchy.  This is accomplished by adding the path to the
342 directory in which the header file is located to the compilers include
343 file search path (via the @option{-I} option).
344
345 However, the path to the include file is determined at the time the
346 source is configured.  To solve this problem, gpgme ships with a small
347 helper program @command{gpgme-config} that knows about the path to the
348 include file and other configuration options.  The options that need
349 to be added to the compiler invocation at compile time are output by
350 the @option{--cflags} option to @command{gpgme-config}.  The following
351 example shows how it can be used at the command line:
352
353 @example
354 gcc -c foo.c `gpgme-config --cflags`
355 @end example
356
357 Adding the output of @samp{gpgme-config --cflags} to the compilers
358 command line will ensure that the compiler can find the @acronym{GPGME} header
359 file.
360
361 A similar problem occurs when linking the program with the library.
362 Again, the compiler has to find the library files.  For this to work,
363 the path to the library files has to be added to the library search
364 path (via the @option{-L} option).  For this, the option
365 @option{--libs} to @command{gpgme-config} can be used.  For
366 convenience, this option also outputs all other options that are
367 required to link the program with @acronym{GPGME} (in particular, the
368 @samp{-lgpgme} option).  The example shows how to link @file{foo.o}
369 with the @acronym{GPGME} library to a program @command{foo}.
370
371 @example
372 gcc -o foo foo.o `gpgme-config --libs`
373 @end example
374
375 Of course you can also combine both examples to a single command by
376 specifying both options to @command{gpgme-config}:
377
378 @example
379 gcc -o foo foo.c `gpgme-config --cflags --libs`
380 @end example
381
382
383 @node Using Automake
384 @section Using Automake
385 @cindex automake
386 @cindex autoconf
387
388 It is much easier if you use GNU Automake instead writing your own
389 Makefiles.  If you do that you don't have to worry about finding and
390 invoking the @command{gpgme-config} script at all.  @acronym{GPGME}
391 provides an extension to Automake that does all the work for you.
392
393 @c A simple macro for optional variables.
394 @macro ovar{varname}
395 @r{[}@var{\varname\}@r{]}
396 @end macro
397 @defmac AM_PATH_GPGME (@ovar{minimum-version}, @ovar{action-if-found}, @ovar{action-if-not-found})
398 Check whether @acronym{GPGME} (at least version @var{minimum-version},
399 if given) exists on the host system.  If it is found, execute
400 @var{action-if-found}, otherwise do @var{action-if-not-found}, if
401 given.
402
403 Additionally, the function defines @code{GPGME_CFLAGS} to the flags
404 needed for compilation of the program to find the @file{gpgme.h}
405 header file, and @code{GPGME_LIBS} to the linker flags needed to link
406 the program to the @acronym{GPGME} library.
407 @end defmac
408
409 You can use the defined Autoconf variables like this in your
410 @file{Makefile.am}:
411
412 @example
413 AM_CPPFLAGS = $(GPGME_CFLAGS)
414 LDADD = $(GPGME_LIBS)
415 @end example
416
417
418 @node Library Version Check
419 @section Library Version Check
420 @cindex version check, of the library
421
422 @deftypefun {const char *} gpgme_check_version (@w{const char *@var{required_version}})
423 The function @code{gpgme_check_version} has three purposes.  It can be
424 used to retrieve the version number of the library.  In addition it
425 can verify that the version number is higher than a certain required
426 version number.  In either case, the function initializes some
427 sub-systems, and for this reason alone it must be invoked early in
428 your program, before you make use of the other functions in
429 @acronym{GPGME}.
430
431 If @var{required_version} is @code{NULL}, the function returns a
432 pointer to a statically allocated string containing the version number
433 of the library.
434
435 If @var{required_version} is not @code{NULL}, it should point to a
436 string containing a version number, and the function checks that the
437 version of the library is at least as high as the version number
438 provided.  In this case, the function returns a pointer to a
439 statically allocated string containing the version number of the
440 library.  If @var{REQUIRED_VERSION} is not a valid version number, or
441 if the version requirement is not met, the function returns
442 @code{NULL}.
443
444 If you use a version of a library that is backwards compatible with
445 older releases, but contains additional interfaces which your program
446 uses, this function provides a run-time check if the necessary
447 features are provided by the installed version of the library.
448 @end deftypefun
449
450
451 @node Multi Threading
452 @section Multi Threading
453 @cindex thread-safeness
454 @cindex multi-threading
455
456 The @acronym{GPGME} library is not entirely thread-safe, but it can
457 still be used in a multi-threaded environment if some care is taken.
458 If the following requirements are met, there should be no race
459 conditions to worry about:
460
461 @itemize @bullet
462 @item
463 @acronym{GPGME} supports the thread libraries pthread and GNU Pth.
464 The support for this has to be enabled at compile time.
465 @acronym{GPGME} will automatically detect the location in which the
466 thread libraries are installed and activate the support for them.
467
468 Support for other thread libraries is very easy to add.  Please
469 contact us if you have the need.
470
471 @item
472 If you link your program dynamically to @acronym{GPGME} and your
473 supported thread library, @acronym{GPGME} will automatically detect
474 the presence of this library and activate its use.  If you link to
475 both pthread and GNU Pth, @acronym{GPGME} will use the pthread
476 support.  This feature requires weak symbol support.
477
478 @item
479 If you link your program statically to @acronym{GPGME}, there is
480 currently no easy way to make sure that @acronym{GPGME} detects the
481 presence of the thread library.  This will be solved in a future
482 version.
483
484 @item
485 The function @code{gpgme_check_version} must be called before any
486 other function in the library, because it initializes the thread
487 support subsystem in @acronym{GPGME}.  To achieve this in all
488 generality, it is necessary to synchronize the call to this function
489 with all other calls to functions in the library, using the
490 synchronization mechanisms available in your thread library.
491 Otherwise, specific compiler or CPU memory cache optimizations could
492 lead to the situation where a thread is started and uses
493 @acronym{GPGME} before the effects of the initialization are visible
494 for this thread.  It doesn't even suffice to call
495 @code{gpgme_check_version} before creating this other
496 thread@footnote{In SMP systems the new thread could be started on
497 another CPU before the effects of the initialization are seen by that
498 CPU's memory cache.  Not doing proper synchronization here leads to
499 the same problems the double-checked locking idiom has.  You might
500 find that if you don't do proper synchronization, it still works in
501 most configurations.  Don't let this fool you.  Someday it might lead
502 to subtle bugs when someone tries it on a DEC Alpha or an SMP
503 machine.}.
504
505 For example, if you are using POSIX threads, each thread that wants to
506 call functions in @acronym{GPGME} could call the following function
507 before any function in the library:
508
509 @example
510 #include <pthread.h>
511
512 void
513 initialize_gpgme (void)
514 @{
515   static int gpgme_init;
516   static pthread_mutext_t gpgme_init_lock = PTHREAD_MUTEX_INITIALIZER;
517
518   pthread_mutex_lock (&gpgme_init_lock);
519   if (!gpgme_init)
520     @{
521       gpgme_check_version ();
522       gpgme_init = 1;
523     @}
524   pthread_mutex_unlock (&gpgme_init_lock);
525 @}
526 @end example
527
528 @item
529 Any @code{GpgmeData}, @code{GpgmeCtx} and @code{GpgmeRecipients}
530 object must only be accessed by one thread at a time.  If multiple
531 threads want to deal with the same object, the caller has to make sure
532 that operations on this object are fully synchronized.
533
534 @item
535 Only one thread at any time is allowed to call @code{gpgme_wait}.  If
536 multiple threads call this function, the caller must make sure that
537 all invocations are fully synchronized.
538 @end itemize
539
540
541 @node Protocols and Engines
542 @chapter Protocols and Engines
543 @cindex protocol
544 @cindex engine
545 @cindex crypto engine
546 @cindex backend
547 @cindex crypto backend
548
549 @acronym{GPGME} supports several cryptographic protocols, however, it
550 does not implement them.  Rather it uses backends (also called
551 engines) which implement the protocol.  @acronym{GPGME} uses
552 inter-process communication to pass data back and forth between the
553 application and the backend, but the details of the communication
554 protocol and invocation of the backends is completely hidden by the
555 interface.  All complexity is handled by @acronym{GPGME}.  Where an
556 exchange of information between the application and the backend is
557 necessary, @acronym{GPGME} provides the necessary callback function
558 hooks and further interfaces.
559
560 @deftp {Data type} {enum GpgmeProtocol}
561 @tindex GpgmeProtocol
562 The @code{GpgmeProtocol} type specifies the set of possible protocol
563 values that are supported by @acronym{GPGME}.  The following protocols
564 are supported:
565
566 @table @code
567 @item GPGME_PROTOCOL_OpenPGP
568 This specifies the OpenPGP protocol.
569 @item GPGME_PROTOCOL_CMS
570 This specifies the Cryptographic Message Syntax.
571 @end table
572 @end deftp
573
574 @menu
575 * Engine Version Check::          Verifying the engine version.
576 * Engine Information::            Obtaining more information about the engines.
577 * OpenPGP::                       Support for the OpenPGP protocol.
578 * Cryptographic Message Syntax::  Support for the CMS.
579 @end menu
580
581
582 @node Engine Version Check
583 @section Engine Version Check
584 @cindex version check, of the engines
585
586 @deftypefun GpgmeError gpgme_engine_check_version (@w{GpgmeProtocol @var{protocol}})
587 The function @code{gpgme_engine_check_version} verifies that the
588 engine implementing the protocol @var{PROTOCOL} is installed in the
589 expected path and meets the version requirement of @acronym{GPGME}.
590
591 This function returns @code{GPGME_No_Error} if the engine is available
592 and @code{GPGME_Invalid_Engine} if it is not.
593 @end deftypefun
594
595 @deftypefun GpgmeError gpgme_check_engine (void)
596 The function @code{gpgme_check_engine} is equivalent to
597
598 @example
599 gpgme_engine_check_version (GPGME_PROTOCOL_OpenPGP);
600 @end example
601
602 This function is deprecated and provided for backwards compatibility
603 only.  It is obsoleted by @code{gpgme_engine_check_version}.
604 @end deftypefun
605
606
607 @node Engine Information
608 @section Engine Information
609 @cindex engine, information about
610
611 @deftypefun {const char *} gpgme_get_engine_info (void)
612 The function @code{gpgme_get_engine_info} returns an @acronym{XML}
613 string containing information about the available protocols and the
614 engine which implement them.  The following information is returned
615 for each engine:
616
617 @table @samp
618 @item <protocol>
619 The name of the protocol.
620 @item <version>
621 The version of the engine.
622 @item <path>
623 The path to the engine binary.
624 @end table
625
626 A string is always returned.  If an error occurs, the string will
627 contain an @samp{<error>} tag with a description of the failure.
628 @end deftypefun
629
630 Here is the example output of what @code{gpgme_get_engine_info} might
631 return on your system:
632
633 @example
634 <EngineInfo>
635  <engine>
636   <protocol>OpenPGP</protocol>
637   <version>1.0.6</version>
638   <path>/usr/bin/gpg</path>
639  </engine>
640  <engine>
641   <protocol>CMS</protocol>
642   <version>0.0.0</version>
643   <path>/usr/bin/gpgsm</path>
644  </engine>
645 </EngineInfo>
646 @end example
647
648
649 @node OpenPGP
650 @section OpenPGP
651 @cindex OpenPGP
652 @cindex GnuPG
653 @cindex protocol, GnuPG
654 @cindex engine, GnuPG
655
656 OpenPGP is implemented by GnuPG, the @acronym{GNU} Privacy Guard.
657 This is the first protocol that was supported by @acronym{GPGME}.
658
659 The OpenPGP protocol is specified by @code{GPGME_PROTOCOL_OpenPGP}.
660
661
662 @node Cryptographic Message Syntax
663 @section Cryptographic Message Syntax
664 @cindex CMS
665 @cindex cryptographic message syntax
666 @cindex GpgSM
667 @cindex protocol, CMS
668 @cindex engine, GpgSM
669 @cindex S/MIME
670 @cindex protocol, S/MIME
671
672 @acronym{CMS} is implemented by GpgSM, the S/MIME implementation for
673 GnuPG.
674
675 The @acronym{CMS} protocol is specified by @code{GPGME_PROTOCOL_CMS}.
676
677
678 @node Error Handling
679 @chapter Error Handling
680 @cindex error handling
681
682 Many functions in @acronym{GPGME} can return an error if they fail.
683 For this reason, the application should always catch the error
684 condition and take appropriate measures, for example by releasing the
685 resources and passing the error up to the caller, or by displaying a
686 descriptive message to the user and cancelling the operation.
687
688 Some error values do not indicate a system error or an error in the
689 operation, but the result of an operation that failed properly.  For
690 example, if you try to decrypt a tempered message, the decryption will
691 fail.  Another error value actually means that the end of a data
692 buffer or list has been reached.  The following descriptions explain
693 what each error message means in general.  Some error values have
694 specific meanings if returned by a specific function.  Such cases are
695 described in the documentation of those functions.
696
697 @menu
698 * Error Values::                  A list of all error values used.
699 * Error Strings::                 How to get a descriptive string from a value.
700 @end menu
701
702
703 @node Error Values
704 @section Error Values
705 @cindex error values, list of
706
707 @deftp {Data type} {enum GpgmeError}
708 @tindex GpgmeError
709 The @code{GpgmeError} type specifies the set of all error values that
710 are used by @acronym{GPGME}.  Possible values are:
711
712 @table @code
713 @item GPGME_EOF
714 This value indicates the end of a list, buffer or file.
715
716 @item GPGME_No_Error
717 This value indicates success.  The value of this error is @code{0}.
718
719 @item GPGME_General_Error
720 This value means that something went wrong, but either there is not
721 enough information about the problem to return a more useful error
722 value, or there is no separate error value for this type of problem.
723
724 @item GPGME_Out_Of_Core
725 This value means that an out-of-memory condition occurred.
726
727 @item GPGME_Invalid_Value
728 This value means that some user provided data was out of range.  This
729 can also refer to objects.  For example, if an empty @code{GpgmeData}
730 object was expected, but one containing data was provided, this error
731 value is returned.
732
733 @item GPGME_Busy
734 This value is returned if you try to start a new operation in a
735 context that is already busy with some earlier operation which was not
736 cancelled or finished yet.
737
738 @item GPGME_No_Request
739 This value is in some sense the opposite of @code{GPGME_Busy}.  There
740 is no pending operation, but it is required for the function to
741 succeed.
742
743 @item GPGME_Exec_Error
744 This value means that an error occurred when trying to spawn a child
745 process.
746
747 @item GPGME_Too_Many_Procs
748 This value means that there are too many active backend processes.
749
750 @item GPGME_Pipe_Error
751 This value means that the creation of a pipe failed.
752
753 @item GPGME_No_Recipients 
754 This value means that no valid recipients for a message have been set.
755
756 @item GPGME_Invalid_Recipients 
757 This value means that some, but not all, recipients for a message have
758 been invalid.
759
760 @item GPGME_No_Data
761 This value means that a @code{GpgmeData} object which was expected to
762 have content was found empty.
763
764 @item GPGME_Conflict
765 This value means that a conflict of some sort occurred.
766
767 @item GPGME_Not_Implemented
768 This value indicates that the specific function (or operation) is not
769 implemented.  This error should never happen.  It can only occur if
770 you use certain values or configuration options which do not work,
771 but for which we think that they should work at some later time.
772
773 @item GPGME_Read_Error
774 This value means that an I/O read operation failed.
775
776 @item GPGME_Write_Error
777 This value means that an I/O write operation failed.
778
779 @item GPGME_Invalid_Type
780 This value means that a user provided object was of a wrong or
781 incompatible type.  Usually this refers to the type of a
782 @code{GpgmeData} object.
783
784 @item GPGME_Invalid_Mode
785 This value means that a @code{GpgmeData} object has an incorrect mode
786 of operation (for example, doesn't support output although it is
787 attempted to use it as an output buffer).
788
789 @item GPGME_File_Error
790 This value means that a file I/O operation failed.  The value of
791 @code{errno} contains the system error value.
792
793 @item GPGME_Decryption_Failed
794 This value indicates that a decryption operation was unsuccessful.
795
796 @item GPGME_No_Passphrase
797 This value means that the user did not provide a passphrase when
798 requested.
799
800 @item GPGME_Canceled
801 This value means that the operation was canceled.
802
803 @item GPGME_Invalid_Key
804 This value means that a key was invalid.
805
806 @item GPGME_Invalid_Engine
807 This value means that the engine that implements the desired protocol
808 is currently not available.  This can either be because the sources
809 were configured to exclude support for this engine, or because the
810 engine is not installed properly.
811 @end table
812 @end deftp
813
814
815 @node Error Strings
816 @section Error Strings
817 @cindex error values, printing of
818 @cindex error strings
819
820 @deftypefun {const char *} gpgme_strerror (@w{GpgmeError @var{err}})
821 The function @code{gpgme_strerror} returns a pointer to a statically
822 allocated string containing a description of the error with the error
823 value @var{err}.  This string can be used to output a diagnostic
824 message to the user.
825
826 The following example illustrates the use of @code{gpgme_strerror}:
827
828 @example
829 GpgmeCtx ctx;
830 GpgmeError err = gpgme_new (&ctx);
831 if (err)
832   @{
833     fprintf (stderr, "%s: creating GpgME context failed: %s\n",
834              argv[0], gpgme_strerror (err));
835     exit (1);
836   @}
837 @end example
838 @end deftypefun
839
840
841 @node Exchanging Data
842 @chapter Exchanging Data
843 @cindex data, exchanging
844
845 A lot of data has to be exchanged between the user and the crypto
846 engine, like plaintext messages, ciphertext, signatures and
847 information about the keys.  The technical details about exchanging
848 the data information are completely abstracted by @acronym{GPGME}.
849 The user provides and receives the data via @code{GpgmeData} objects,
850 regardless of the communication protocol between @acronym{GPGME} and
851 the crypto engine in use.
852
853 @deftp {Data type} {GpgmeData}
854 The @code{GpgmeData} type is a handle for a container for generic
855 data, which is used by @acronym{GPGME} to exchange data with the user.
856 @end deftp
857
858 @menu
859 * Creating Data Buffers::         Creating new data buffers.
860 * Destroying Data Buffers::       Releasing data buffers.
861 * Manipulating Data Buffers::     Operations on data buffers.
862 @end menu
863
864
865 @node Creating Data Buffers
866 @section Creating Data Buffers
867 @cindex data buffer, creation
868
869 @deftypefun GpgmeError gpgme_data_new (@w{GpgmeData *@var{dh}})
870 The function @code{gpgme_data_new} creates a new @code{GpgmeData}
871 object and returns a handle for it in @var{dh}.  The data object is
872 initially empty.
873
874 The function returns @code{GPGME_No_Error} if the data object was
875 successfully created, @code{GPGME_Invalid_Value} if @var{dh} is not a
876 valid pointer, and @code{GPGME_Out_Of_Core} if not enough memory is
877 available.
878 @end deftypefun
879
880 @deftypefun GpgmeError gpgme_data_new_from_mem (@w{GpgmeData *@var{dh}}, @w{const char *@var{buffer}}, @w{size_t @var{size}}, @w{int @var{copy}})
881 The function @code{gpgme_data_new_from_mem} creates a new
882 @code{GpgmeData} object and fills it with @var{size} bytes starting
883 from @var{buffer}.
884
885 If @var{copy} is not zero, a private copy of the data is made.  If
886 @var{copy} is zero, the data is taken from the specified buffer as
887 needed, and the user has to ensure that the buffer remains valid for
888 the whole life span of the data object.
889
890 The function returns @code{GPGME_No_Error} if the data object was
891 successfully created, @code{GPGME_Invalid_Value} if @var{dh} or
892 @var{buffer} is not a valid pointer, and @code{GPGME_Out_Of_Core} if
893 not enough memory is available.
894 @end deftypefun
895
896 @deftypefun GpgmeError gpgme_data_new_from_file (@w{GpgmeData *@var{dh}}, @w{const char *@var{filename}}, @w{int @var{copy}})
897 The function @code{gpgme_data_new_from_file} creates a new
898 @code{GpgmeData} object and fills it with the content of the file
899 @var{filename}.
900
901 If @var{copy} is not zero, the whole file is read in at initialization
902 time and the file is not used anymore after that.  This is the only
903 mode supported currently.  Later, a value of zero for @var{copy} might
904 cause all reads to be delayed until the data is needed, but this is
905 not yet implemented.
906
907 The function returns @code{GPGME_No_Error} if the data object was
908 successfully created, @code{GPGME_Invalid_Value} if @var{dh} or
909 @var{filename} is not a valid pointer, @code{GPGME_File_Error} if an
910 I/O operation fails, @code{GPGME_Not_Implemented} if @var{code} is
911 zero, and @code{GPGME_Out_Of_Core} if not enough memory is available.
912 @end deftypefun
913
914 @deftypefun GpgmeError gpgme_data_new_from_filepart (@w{GpgmeData *@var{dh}}, @w{const char *@var{filename}}, @w{FILE *@var{fp}}, @w{off_t @var{offset}}, @w{size_t @var{length}})
915 The function @code{gpgme_data_new_from_filepart} creates a new
916 @code{GpgmeData} object and fills it with a part of the file specified
917 by @var{filename} or @var{fp}.
918
919 Exactly one of @var{filename} and @var{fp} must be non-zero, the other
920 must be zero.  The argument that is not zero specifies the file from
921 which @var{length} bytes are read into the data object, starting from
922 @var{offset}.
923
924 The function returns @code{GPGME_No_Error} if the data object was
925 successfully created, @code{GPGME_Invalid_Value} if @var{dh} and
926 exactly one of @var{filename} and @var{fp} is not a valid pointer,
927 @code{GPGME_File_Error} if an I/O operation fails, and
928 @code{GPGME_Out_Of_Core} if not enough memory is available.
929 @end deftypefun
930
931 @deftypefun GpgmeError gpgme_data_new_with_read_cb (@w{GpgmeData *@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}})
932 The function @code{gpgme_data_new_with_read_cb} creates a new
933 @code{GpgmeData} object and uses the callback function @var{readfunc}
934 to retrieve the data on demand.  As the callback function can supply
935 the data in any way it wants, this is the most flexible data type
936 @acronym{GPGME} provides.  However, it can not be used to write data.
937
938 The callback function receives @var{hook_value} as its first argument
939 whenever it is invoked.  It should return up to @var{count} bytes in
940 @var{buffer}, and return the number of bytes actually read in
941 @var{nread}.  It may return @code{0} in @var{nread} if no data is
942 currently available.  To indicate @code{EOF} the function should
943 return with an error code of @code{-1} and set @var{nread} to
944 @code{0}.  The callback function may support to reset its internal
945 read pointer if it is invoked with @var{buffer} and @var{nread} being
946 @code{NULL} and @var{count} being @code{0}.
947
948 The function returns @code{GPGME_No_Error} if the data object was
949 successfully created, @code{GPGME_Invalid_Value} if @var{dh} or
950 @var{readfunc} is not a valid pointer, and @code{GPGME_Out_Of_Core} if
951 not enough memory is available.
952 @end deftypefun
953
954
955 @node Destroying Data Buffers
956 @section Destroying Data Buffers
957 @cindex data buffer, destruction
958
959 @deftypefun void gpgme_data_release (@w{GpgmeData @var{dh}})
960 The function @code{gpgme_data_release} destroys the data object with
961 the handle @var{dh}.  It releases all associated resources that were
962 not provided by the user in the first place.
963 @end deftypefun
964
965 @deftypefun {char *} gpgme_data_release_and_get_mem (@w{GpgmeData @var{dh}}, @w{size_t *@var{length}})
966 The function @code{gpgme_data_release_and_get_mem} is like
967 @code{gpgme_data_release}, except that it returns the data buffer and
968 its length that was provided by the object.
969
970 The user has to release the buffer with @code{free}.  In case the user
971 provided the data buffer in non-copy mode, a copy will be made for
972 this purpose.
973
974 In case an error returns, or there is no suitable data buffer that can
975 be returned to the user, the function will return @code{NULL}.
976 @end deftypefun
977
978
979 @node Manipulating Data Buffers
980 @section Manipulating Data Buffers
981 @cindex data buffere, manipulation
982
983 @deftypefun GpgmeError gpgme_data_read (@w{GpgmeData @var{dh}}, @w{void *@var{buffer}}, @w{size_t @var{length}}, @w{size_t *@var{nread}})
984 The function @code{gpgme_data_read} reads up to @var{length} bytes
985 from the data object with the handle @var{dh} into the space starting
986 at @var{buffer}.  The actual amount read is returned in @var{nread}.
987
988 If @var{buffer} is @code{NULL}, the function returns the amount of
989 bytes available in @var{nread} without changing the read pointer.
990 This is not supported by all types of data objects.  If this function
991 is not supported, @code{GPGME_Invalid_Type} is returned.
992
993 If the end of the data object is reached, the function returns
994 @code{GPGME_EOF} and sets @var{nread} to zero.
995
996 In all other cases, the function returns @code{GPGME_No_Error} if the
997 operation was successfully performed and @code{GPGME_Invalid_Value} if
998 @var{dh} is not a valid pointer.
999 @end deftypefun
1000
1001 @deftypefun GpgmeError gpgme_data_rewind (@w{GpgmeData @var{dh}})
1002 The function @code{gpgme_data_rewind} resets the read pointer of the
1003 data object with the handle @var{dh}, so that a subsequent
1004 @code{gpgme_data_read} operation starts at the beginning of the data.
1005
1006 The function returns @code{GPGME_No_Error} if the operation was
1007 successfully performed, @code{GPGME_Not_Implemented} if the operation
1008 is not supported (for example, by a read callback function supplied by
1009 the user) and @code{GPGME_Invalid_Value} if @var{dh} is not a valid
1010 pointer.
1011 @end deftypefun
1012
1013 @deftypefun GpgmeError gpgme_data_write (@w{GpgmeData @var{dh}}, @w{const void *@var{buffer}}, @w{size_t @var{length}})
1014 The function @code{gpgme_data_write} writes @var{length} bytes
1015 starting from @var{buffer} into the data object with the handle
1016 @var{dh} at the current write position.
1017
1018 The function returns @code{GPGME_No_Error} if the operation was
1019 successfully performed, @code{GPGME_Invalid_Value} if @var{dh} or
1020 @var{buffer} is not a valid pointer, @code{GPGME_Invalid_Type} or
1021 @code{GPGME_Invalid_Mode} if the data object type does not support
1022 writing, and @code{GPGME_Out_Of_Core} if not enough memory is
1023 available.
1024 @end deftypefun
1025
1026 @c
1027 @c  GpgmeDataType
1028 @c
1029 @deftp {Data type} {enum GpgmeDataType}
1030 @tindex GpgmeDataType
1031 The @code{GpgmeDataType} type specifies the type of a @code{GpgmeData} object.
1032 The following data types are available:
1033
1034 @table @code
1035 @item GPGME_DATA_TYPE_NONE
1036 This specifies that the type is not yet determined.
1037
1038 @item GPGME_DATA_TYPE_MEM
1039 This specifies that the data is stored in memory.
1040
1041 @item GPGME_DATA_TYPE_FD
1042 This type is not implemented.
1043
1044 @item GPGME_DATA_TYPE_FILE
1045 This type is not implemented.
1046
1047 @item GPGME_DATA_TYPE_CB
1048 This type specifies that the data is provided by a callback function
1049 implemented by the user.
1050 @end table
1051 @end deftp
1052
1053 @deftypefun GpgmeDataType gpgme_data_get_type (@w{GpgmeData @var{dh}})
1054 The function @code{gpgme_data_get_type} returns the type of the data
1055 object with the handle @var{dh}.  If @var{dh} is not a valid pointer,
1056 @code{GPGME_DATA_TYPE_NONE} is returned.
1057 @end deftypefun
1058
1059 @c
1060 @c  GpgmeDataEncoding
1061 @c
1062 @deftp {Data type} {enum GpgmeDataEncoding}
1063 @tindex GpgmeDataEncoding
1064 The @code{GpgmeDataEncoding} type specifies the encoding of a
1065 @code{GpgmeData} object.  This encoding is useful to give the backend
1066 a hint on the type of data.  The following data types are available:
1067
1068 @table @code
1069 @item GPGME_DATA_ENCODING_NONE
1070 This specifies that the encoding is not known.  This is the default
1071 for a new data object.
1072
1073 @item GPGME_DATA_ENCODING_BINARY
1074 This specifies that the data is encoding in binary form; i.e. there is
1075 no special encoding.
1076
1077 @item GPGME_DATA_ENCODING_BASE64
1078 This specifies that the data is encoded using the Base-64 encoding
1079 scheme as used by @acronym{MIME} and other protocols.
1080
1081 @item GPGME_DATA_ENCODING_ARMOR
1082 This specifies that the data is encoded in an armored form as used by
1083 OpenPGP and PEM.
1084 @end table
1085 @end deftp
1086
1087 @deftypefun GpgmeDataEncoding gpgme_data_get_encoding (@w{GpgmeData @var{dh}})
1088 The function @code{gpgme_data_get_encoding} returns the encoding of
1089 the data object with the handle @var{dh}.  If @var{dh} is not a valid
1090 pointer (e.g. @code{NULL}) @code{GPGME_DATA_ENCODING_NONE} is
1091 returned.
1092 @end deftypefun
1093
1094 @deftypefun GpgmeError gpgme_data_set_encoding (@w{GpgmeData @var{dh}, GpgmeDataEncoding @var{enc}})
1095 The function @code{gpgme_data_set_encoding} changes the encoding of
1096 the data object with the handle @var{dh} to @var{enc}.
1097 @end deftypefun
1098
1099
1100 @c
1101 @c    Chapter Contexts
1102 @c 
1103 @node Contexts
1104 @chapter Contexts
1105 @cindex context
1106
1107 All cryptographic operations in @acronym{GPGME} are performed within a
1108 context, which contains the internal state of the operation as well as
1109 configuration parameters.  By using several contexts you can run
1110 several cryptographic operations in parallel, with different
1111 configuration.
1112
1113 @deftp {Data type} {GpgmeCtx}
1114 The @code{GpgmeCtx} type is a handle for a @acronym{GPGME} context,
1115 which is used to hold the configuration, status and result of
1116 cryptographic operations.
1117 @end deftp
1118
1119 @menu
1120 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
1121 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
1122 * Context Attributes::            Setting properties of a context.
1123 * Key Management::                Managing keys with @acronym{GPGME}.
1124 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
1125 * Crypto Operations::             Using a context for cryptography.
1126 * Run Control::                   Controlling how operations are run.
1127 @end menu
1128
1129
1130 @node Creating Contexts
1131 @section Creating Contexts
1132 @cindex context, creation
1133
1134 @deftypefun GpgmeError gpgme_new (@w{GpgmeCtx *@var{ctx}})
1135 The function @code{gpgme_data_new} creates a new @code{GpgmeCtx}
1136 object and returns a handle for it in @var{ctx}.
1137
1138 The function returns @code{GPGME_No_Error} if the context was
1139 successfully created, @code{GPGME_Invalid_Value} if @var{ctx} is not a
1140 valid pointer, and @code{GPGME_Out_Of_Core} if not enough memory is
1141 available.
1142 @end deftypefun
1143
1144
1145 @node Destroying Contexts
1146 @section Destroying Contexts
1147 @cindex context, destruction
1148
1149 @deftypefun void gpgme_release (@w{GpgmeCtx @var{ctx}})
1150 The function @code{gpgme_release} destroys the context with the handle
1151 @var{ctx} and releases all associated resources.
1152 @end deftypefun
1153
1154
1155 @node Context Attributes
1156 @section Context Attributes
1157 @cindex context, attributes
1158
1159 @menu
1160 * Protocol Selection::            Selecting the protocol used by a context.
1161 * @acronym{ASCII} Armor::                   Requesting @acronym{ASCII} armored output.
1162 * Text Mode::                     Choosing canonical text mode.
1163 * Included Certificates::       Including a number of certificates.
1164 * Key Listing Mode::              Selecting key listing mode.
1165 * Passphrase Callback::           Getting the passphrase from the user.
1166 * Progress Meter Callback::       Being informed about the progress.
1167 @end menu
1168
1169
1170 @node Protocol Selection
1171 @subsection Protocol Selection
1172 @cindex context, selecting protocol
1173 @cindex protocol, selecting
1174
1175 @deftypefun GpgmeError gpgme_set_protocol (@w{GpgmeCtx @var{ctx}}, @w{GpgmeProtocol @var{proto}})
1176 The function @code{gpgme_set_protocol} sets the protocol used within
1177 the context @var{ctx} to @var{proto}.  All crypto operations will be
1178 performed by the crypto engine configured for that protocol.
1179 @xref{Protocols and Engines}.
1180
1181 Setting the protocol with @code{gpgme_set_protocol} does not check if
1182 the crypto engine for that protocol is available and installed
1183 correctly.  @xref{Engine Version Check}.
1184
1185 The function returns @code{GPGME_No_Error} if the protocol could be
1186 set successfully, and @code{GPGME_Invalid_Value} if @var{protocol} is
1187 not a valid protocol.
1188 @end deftypefun
1189
1190 @deftypefun GpgmeProtocol gpgme_get_protocol (@w{GpgmeCtx @var{ctx}})
1191 The function @code{gpgme_get_protocol} retrieves the protocol currently
1192 use with the context @var{ctx}.
1193 @end deftypefun
1194
1195 @node @acronym{ASCII} Armor
1196 @subsection @acronym{ASCII} Armor
1197 @cindex context, armor mode
1198 @cindex @acronym{ASCII} armor
1199 @cindex armor mode
1200
1201 @deftypefun void gpgme_set_armor (@w{GpgmeCtx @var{ctx}}, @w{int @var{yes}})
1202 The function @code{gpgme_set_armor} specifies if the output should be
1203 @acronym{ASCII} armored.  By default, output is not @acronym{ASCII}
1204 armored.
1205
1206 @acronym{ASCII} armored output is disabled if @var{yes} is zero, and
1207 enabled otherwise.
1208 @end deftypefun
1209
1210 @deftypefun int gpgme_get_armor (@w{GpgmeCtx @var{ctx}})
1211 The function @code{gpgme_get_armor} returns 1 if the output is
1212 @acronym{ASCII} armored, and @code{0} if it is not, or if @var{ctx} is
1213 not a valid pointer.
1214 @end deftypefun
1215
1216
1217 @node Text Mode
1218 @subsection Text Mode
1219 @cindex context, text mode
1220 @cindex text mode
1221 @cindex canonical text mode
1222
1223 @deftypefun void gpgme_set_textmode (@w{GpgmeCtx @var{ctx}}, @w{int @var{yes}})
1224 The function @code{gpgme_set_textmode} specifies if canonical text mode
1225 should be used.  By default, text mode is not used.
1226
1227 Text mode is for example used for the RFC2015 signatures; note that
1228 the updated RFC 3156 mandates that the mail user agent does some
1229 preparations so that text mode is not needed anymore.
1230
1231 This option is only relevant to the OpenPGP crypto engine, and ignored
1232 by all other engines.
1233
1234 Canonical text mode is disabled if @var{yes} is zero, and enabled
1235 otherwise.
1236 @end deftypefun
1237
1238 @deftypefun int gpgme_get_textmode (@w{GpgmeCtx @var{ctx}})
1239 The function @code{gpgme_get_textmode} returns 1 if canonical text
1240 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
1241 valid pointer.
1242 @end deftypefun
1243
1244
1245 @node Included Certificates
1246 @subsection Included Certificates
1247 @cindex certificates, included
1248
1249 @deftypefun void gpgme_set_include_certs (@w{GpgmeCtx @var{ctx}}, @w{int @var{nr_of_certs}})
1250 The function @code{gpgme_set_include_certs} specifies how many
1251 certificates should be included in an S/MIME signed message.  By
1252 default, only the sender's certificate is included.  The possible
1253 values of @var{nr_of_certs} are:
1254
1255 @table @code
1256 @item -2
1257 Include all certificates except the root certificate.
1258 @item -1
1259 Include all certificates.
1260 @item 0
1261 Include no certificates.
1262 @item 1
1263 Include the sender's certificate only.
1264 @item n
1265 Include the first n certificates of the certificates path, starting
1266 from the sender's certificate.  The number @code{n} must be positive.
1267 @end table
1268
1269 Values of @var{nr_of_certs} smaller than -2 are undefined.
1270
1271 This option is only relevant to the CMS crypto engine, and ignored
1272 by all other engines.
1273 @end deftypefun
1274
1275 @deftypefun int gpgme_get_include_certs (@w{GpgmeCtx @var{ctx}})
1276 The function @code{gpgme_get_include_certs} returns the number of
1277 certificates to include into an S/MIME signed message.
1278 @end deftypefun
1279
1280
1281 @node Key Listing Mode
1282 @subsection Key Listing Mode
1283 @cindex key listing mode
1284 @cindex key listing, mode of
1285
1286 @deftypefun void gpgme_set_keylist_mode (@w{GpgmeCtx @var{ctx}}, @w{int @var{mode}})
1287 The function @code{gpgme_set_keylist_mode} changes the default
1288 behaviour of the key listing functions.  The value in @var{mode} is a
1289 bitwise-or combination of one or multiple of the following bit values:
1290
1291 @table @code
1292 @item GPGME_KEYLIST_MODE_LOCAL
1293 The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
1294 keyring should be searched for keys in the keylisting operation.  This
1295 is the default.
1296
1297 @item GPGME_KEYLIST_MODE_EXTERN
1298 The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
1299 source should be should be searched for keys in the keylisting
1300 operation.  The type of external source is dependant on the crypto
1301 engine used.  For example, it can be a remote keyserver or LDAP
1302 certificate server.
1303 @end table
1304
1305 At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
1306 @code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
1307 compatibility, you should get the current mode with
1308 @code{gpgme_get_keylist_mode} and modify it by setting or clearing the
1309 appropriate bits, and then using that calulcated value in the
1310 @code{gpgme_set_keylisting_mode} operation.  This will leave all other
1311 bits in the mode value intact (in particular those that are not used
1312 in the current version of the library).
1313
1314 The function returns @code{GPGME_No_Error} if the mode could be set
1315 correctly, and @code{GPGME_Invalid_Value} if @var{ctx} is not a valid
1316 pointer or @var{mode} is not a valid mode.
1317 @end deftypefun
1318
1319
1320 @deftypefun int gpgme_get_keylist_mode (@w{GpgmeCtx @var{ctx}})
1321 The function @code{gpgme_get_keylist_mode} returns the current key
1322 listing mode of the context @var{ctx}.  This value can then be
1323 modified and used in a subsequent @code{gpgme_set_keylist_mode}
1324 operation to only affect the desired bits (and leave all others
1325 intact).
1326
1327 The function returns 0 if @var{ctx} is not a valid pointer, and the
1328 current mode otherwise.  Note that 0 is not a valid mode value.
1329 @end deftypefun
1330
1331
1332 @node Passphrase Callback
1333 @subsection Passphrase Callback
1334 @cindex callback, passphrase
1335 @cindex passphrase callback
1336
1337 @deftp {Data type} {const char *(*GpgmePassphraseCb)(void *@var{hook}, const char *@var{desc}, void **@var{r_hd})}
1338 @tindex GpgmePassphraseCb
1339 The @code{GpgmePassphraseCb} type is the type of functions usable as
1340 passphrase callback function.
1341
1342 The string @var{desc} contains a text usable to be displayed to the
1343 user of the application.  The function should return a passphrase for
1344 the context when invoked with @var{desc} not being @code{NULL}.
1345
1346 The user may store information about the resources associated with the
1347 returned passphrase in @var{*r_hd}.  When the passphrase is no longer
1348 needed by @acronym{GPGME}, the passphrase callback function will be
1349 called with @var{desc} being @var{NULL}, and @var{r_hd} being the same
1350 as at the first invocation.
1351 @end deftp
1352
1353 @deftypefun void gpgme_set_passphrase_cb (@w{GpgmeCtx @var{ctx}}, @w{GpgmePassphraseCb @var{passfunc}}, @w{void *@var{hook_value}})
1354 The function @code{gpgme_set_passphrase_cb} sets the function that is
1355 used when a passphrase needs to be provided by the user to
1356 @var{passfunc}.  The function @var{passfunc} needs to implemented by
1357 the user, and whenever it is called, it is called with its first
1358 argument being @var{hook_value}.  By default, no passphrase callback
1359 function is set.
1360
1361 Not all crypto engines require this callback to retrieve the
1362 passphrase.  It is better if the engine retrieves the passphrase from
1363 a trusted agent (a daemon process), rather than having each user to
1364 implement their own passphrase query.
1365
1366 The user can disable the use of a passphrase callback function by
1367 calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
1368 @code{NULL}.
1369 @end deftypefun
1370
1371 @deftypefun void gpgme_get_passphrase_cb (@w{GpgmeCtx @var{ctx}}, @w{GpgmePassphraseCb *@var{passfunc}}, @w{void **@var{hook_value}})
1372 The function @code{gpgme_get_passphrase_cb} returns the function that
1373 is used when a passphrase needs to be provided by the user in
1374 @var{*passfunc}, and the first argument for this function in
1375 @var{*hook_value}.  If no passphrase callback is set, or @var{ctx} is
1376 not a valid pointer, @code{NULL} is returned in both variables.
1377
1378 @var{passfunc} or @var{hook_value} can be @code{NULL}.  In this case,
1379 the corresponding value will not be returned.
1380 @end deftypefun
1381
1382
1383 @node Progress Meter Callback
1384 @subsection Progress Meter Callback
1385 @cindex callback, progress meter
1386 @cindex progress meter callback
1387
1388 @deftp {Data type} {const char *(*GpgmeProgressCb)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
1389 @tindex GpgmeProgressCb
1390 The @code{GpgmeProgressCb} type is the type of functions usable as
1391 progress callback function.
1392
1393 The arguments are specific to the crypto engine.  More information
1394 about the progress information returned from the GnuPG engine can be
1395 found in the GnuPG source code in the file @file{doc/DETAILS} in the
1396 section PROGRESS.
1397 @end deftp
1398
1399 @deftypefun void gpgme_set_progress_cb (@w{GpgmeCtx @var{ctx}}, @w{GpgmeProgressCb @var{progfunc}}, @w{void *@var{hook_value}})
1400 The function @code{gpgme_set_progress_cb} sets the function that is
1401 used when progress information about a cryptographic operation is
1402 available.  The function @var{progfunc} needs to implemented by the
1403 user, and whenever it is called, it is called with its first argument
1404 being @var{hook_value}.  By default, no progress callback function
1405 is set.
1406
1407 Setting a callback function allows an interactive program to display
1408 progress information about a long operation to the user.
1409
1410 The user can disable the use of a progress callback function by
1411 calling @code{gpgme_set_progress_cb} with @var{progfunc} being
1412 @code{NULL}.
1413 @end deftypefun
1414
1415 @deftypefun void gpgme_get_progress_cb (@w{GpgmeCtx @var{ctx}}, @w{GpgmeProgressCb *@var{progfunc}}, @w{void **@var{hook_value}})
1416 The function @code{gpgme_get_progress_cb} returns the function that is
1417 used to inform the user about the progress made in @var{*progfunc},
1418 and the first argument for this function in @var{*hook_value}.  If no
1419 progress callback is set, or @var{ctx} is not a valid pointer,
1420 @code{NULL} is returned in both variables.
1421
1422 @var{progfunc} or @var{hook_value} can be @code{NULL}.  In this case,
1423 the corresponding value will not be returned.
1424 @end deftypefun
1425
1426
1427 @node Key Management
1428 @section Key Management
1429 @cindex key management
1430
1431 Some of the cryptographic operations require that recipients or
1432 signers are specified.  This is always done by specifying the
1433 respective keys that should be used for the operation.  The following
1434 section describes how such keys can be selected and manipulated.
1435
1436 @deftp {Data type} GpgmeKey
1437 The @code{GpgmeKey} type is a handle for a public or secret key, and
1438 is used to select the key for operations involving it.
1439
1440 A key can contain several user IDs and sub keys.
1441 @end deftp
1442
1443 @menu
1444 * Listing Keys::                  Browsing the list of available keys.
1445 * Information About Keys::        Requesting detailed information about keys.
1446 * Manipulating Keys::             Operations on keys.
1447 * Generating Keys::               Creating new key pairs.
1448 * Exporting Keys::                Retrieving key data from the key ring.
1449 * Importing Keys::                Adding keys to the key ring.
1450 * Deleting Keys::                 Removing keys from the key ring.
1451 @end menu
1452
1453
1454 @node Listing Keys
1455 @subsection Listing Keys
1456 @cindex listing keys
1457 @cindex key listing
1458 @cindex key listing, start
1459 @cindex key ring, list
1460 @cindex key ring, search
1461
1462 @deftypefun GpgmeError gpgme_op_keylist_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
1463 The function @code{gpgme_op_keylist_start} initiates a key listing
1464 operation inside the context @var{ctx}.  It sets everything up so that
1465 subsequent invocations of @code{gpgme_op_keylist_next} return the keys
1466 in the list.
1467
1468 If @var{pattern} is @code{NULL}, all available keys are returned.
1469 Otherwise, @var{pattern} contains an engine specific expression that
1470 is used to limit the list to all keys matching the pattern.
1471
1472 If @var{secret_only} is not @code{0}, the list is restricted to secret
1473 keys only.
1474
1475 The context will be busy until either all keys are received (and
1476 @code{gpgme_op_keylist_next} returns @code{GPGME_EOF}), or
1477 @code{gpgme_op_keylist_end} is called to finish the operation.
1478
1479 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
1480 valid pointer, and passes through any errors that are reported by the
1481 crypto engine support routines.
1482 @end deftypefun
1483
1484 @deftypefun GpgmeError gpgme_op_keylist_ext_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{pattern}[]}, @w{int @var{secret_only}}, @w{int @var{reserved}})
1485 The function @code{gpgme_op_keylist_ext_start} initiates an extended
1486 key listing operation inside the context @var{ctx}.  It sets
1487 everything up so that subsequent invocations of
1488 @code{gpgme_op_keylist_next} return the keys in the list.
1489
1490 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
1491 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
1492 array of strings that are used to limit the list to all keys matching
1493 at least one of the patterns verbatim.
1494
1495 If @var{secret_only} is not @code{0}, the list is restricted to secret
1496 keys only.
1497
1498 The value of @var{reserved} must be @code{0}.
1499
1500 The context will be busy until either all keys are received (and
1501 @code{gpgme_op_keylist_next} returns @code{GPGME_EOF}), or
1502 @code{gpgme_op_keylist_end} is called to finish the operation.
1503
1504 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
1505 valid pointer, and passes through any errors that are reported by the
1506 crypto engine support routines.
1507 @end deftypefun
1508
1509 @deftypefun GpgmeError gpgme_op_keylist_next (@w{GpgmeCtx @var{ctx}}, @w{GpgmeKey *@var{r_key}})
1510 The function @code{gpgme_op_keylist_next} returns the next key in the
1511 list created by a previous @code{gpgme_op_keylist_start} operation in
1512 the context @var{ctx}.  The key will have one reference for the user.
1513 @xref{Manipulating Keys}.
1514
1515 This is the only way to get at @code{GpgmeKey} objects in
1516 @acronym{GPGME}.
1517
1518 If the last key in the list has already been returned,
1519 @code{gpgme_op_keylist_next} returns @code{GPGME_EOF}.
1520
1521 The function returns @code{GPGME_Invalid_Value} if @var{ctx} or
1522 @var{r_key} is not a valid pointer, @code{GPGME_No_Request} if there
1523 is no pending operation, @code{GPGME_Out_Of_Core} if there is not
1524 enough memory for the operation.
1525 @end deftypefun
1526
1527 @deftypefun GpgmeError gpgme_op_keylist_end (@w{GpgmeCtx @var{ctx}})
1528 The function @code{gpgme_op_keylist_next} ends a pending key list
1529 operation in the context @var{ctx}.
1530
1531 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
1532 valid pointer, @code{GPGME_No_Request} if there is no pending
1533 operation, @code{GPGME_Out_Of_Core} if at some time during the
1534 operation there was not enough memory available.
1535 @end deftypefun
1536
1537 The following example illustrates how all keys containing a certain
1538 string (@code{g10code}) can be listed with their key ID and the name
1539 and e-mail address of the main user ID:
1540
1541 @example
1542 GpgmeCtx ctx;
1543 GpgmeError err = gpgme_new (&ctx);
1544
1545 if (!err)
1546   @{
1547     err = gpgme_op_keylist_start (ctx, "g10code", 0);
1548     while (!err && (err = gpgme_op_keylist_next (ctx, &key)) != GPGME_EOF)
1549       @{
1550         printf ("%s: %s <%s>\n",
1551                 gpgme_key_get_string_attr (key, GPGME_ATTR_KEYID, 0, 0),
1552                 gpgme_key_get_string_attr (key, GPGME_ATTR_NAME, 0, 0),
1553                 gpgme_key_get_string_attr (key, GPGME_ATTR_EMAIL, 0, 0));
1554         gpgme_key_release (key);
1555       @}
1556     gpgme_release (ctx);
1557   @}
1558 if (err)
1559   @{
1560     fprintf (stderr, "%s: can not list keys: %s\n",
1561              argv[0], gpgme_strerror (err));
1562     exit (1);
1563   @}
1564 @end example
1565
1566
1567 @node Information About Keys
1568 @subsection Information About Keys
1569 @cindex key, information about
1570 @cindex key, attributes
1571 @cindex attributes, of a key
1572
1573 @deftypefun {char *} gpgme_key_get_as_xml (@w{GpgmeKey @var{key}})
1574 The function @code{gpgme_key_get_as_xml} returns a string in
1575 @acronym{XML} format describing the key @var{key}.  The user has to
1576 release the string with @code{free}.
1577
1578 The function returns @code{NULL} if @var{key} is not a valid pointer,
1579 or there is not enough memory available.
1580 @end deftypefun
1581
1582 @deftp {Data type} GpgmeAttr
1583 The @code{GpgmeAttr} type is used to specify a key or trust item
1584 attribute.  The following attributes are defined:
1585
1586 @table @code
1587 @item GPGME_ATTR_KEYID
1588 This is the key ID of a sub key.  It is representable as a string.
1589
1590 For trust items, the trust item refers to the key with this ID.
1591
1592 @item GPGME_ATTR_FPR
1593 This is the fingerprint of a sub key.  It is representable as a
1594 string.
1595
1596 @item GPGME_ATTR_ALGO
1597 This is the crypto algorithm for which the sub key can be used.  It
1598 is representable as a string and as a number.  The numbers correspond
1599 to the @code{enum gcry_pk_algos} values in the gcrypt library.
1600
1601 @item GPGME_ATTR_LEN
1602 This is the key length of a sub key.  It is representable as a
1603 number.
1604
1605 @item GPGME_ATTR_CREATED
1606 This is the timestamp at creation time of a sub key.  It is
1607 representable as a number.
1608
1609 @item GPGME_ATTR_EXPIRE
1610 This is the expiration time of a sub key.  It is representable as a
1611 number.
1612
1613 @item GPGME_ATTR_OTRUST
1614 XXX FIXME  (also for trust items)
1615
1616 @item GPGME_ATTR_USERID
1617 This is a user ID.  There can be more than one user IDs in a
1618 @var{GpgmeKey} object.  The first one (with index 0) is the primary
1619 user ID.  The user ID is representable as a number.
1620
1621 For trust items, this is the user ID associated with this trust item.
1622
1623 @item GPGME_ATTR_NAME
1624 This is the name belonging to a user ID.  It is representable as a string.
1625
1626 @item GPGME_ATTR_EMAIL
1627 This is the email address belonging to a user ID.  It is representable
1628 as a string.
1629
1630 @item GPGME_ATTR_COMMENT
1631 This is the comment belonging to a user ID.  It is representable as a
1632 string.
1633
1634 @item GPGME_ATTR_VALIDITY
1635 This is the validity belonging to a user ID.  It is representable as a
1636 string and as a number.  See below for a list of available validities.
1637
1638 For trust items, this is the validity that is associated with this
1639 trust item.
1640
1641 @item GPGME_ATTR_UID_REVOKED
1642 This specifies if a user ID is revoked.  It is representable as a
1643 number, and is @code{1} if the user ID is revoked, and @code{0}
1644 otherwise.
1645
1646 @item GPGME_ATTR_UID_INVALID
1647 This specifies if a user ID is invalid.  It is representable as a
1648 number, and is @code{1} if the user ID is invalid, and @code{0}
1649 otherwise.
1650
1651 @item GPGME_ATTR_LEVEL
1652 This is the trust level of a trust item.
1653
1654 @item GPGME_ATTR_TYPE
1655 This is the type of a trust item.
1656
1657 @item GPGME_ATTR_IS_SECRET
1658 This specifies if the key is a secret key.  It is representable as a
1659 string or a number.  If the key is a secret key, the representation is
1660 ``1'' or @code{1}, otherwise it is @code{NULL} or @code{0}.
1661
1662 @item GPGME_ATTR_KEY_REVOKED
1663 This specifies if a sub key is revoked.  It is representable as a
1664 number, and is @code{1} if the key is revoked, and @code{0} otherwise.
1665
1666 @item GPGME_ATTR_KEY_INVALID
1667 This specifies if a sub key is invalid.  It is representable as a
1668 number, and is @code{1} if the key is invalid, and @code{0} otherwise.
1669
1670 @item GPGME_ATTR_KEY_EXPIRED
1671 This specifies if a sub key is expired.  It is representable as a
1672 number, and is @code{1} if the key is expired, and @code{0} otherwise.
1673
1674 @item GPGME_ATTR_KEY_DISABLED
1675 This specifies if a sub key is disabled.  It is representable as a
1676 number, and is @code{1} if the key is disabled, and @code{0} otherwise.
1677
1678 @item GPGME_ATTR_KEY_CAPS
1679 This is a description of the capabilities of a sub key.  It is
1680 representable as a string.  The string contains the letter ``e'' if
1681 the key can be used for encryption, ``s'' if the key can be used for
1682 signatures, and ``c'' if the key can be used for certifications.
1683
1684 @item GPGME_ATTR_CAN_ENCRYPT
1685 This specifies if a sub key can be used for encryption.  It is
1686 representable as a number, and is @code{1} if the sub key can be used
1687 for encryption, and @code{0} otherwise.
1688
1689 @item GPGME_ATTR_CAN_SIGN
1690 This specifies if a sub key can be used for signatures.  It is
1691 representable as a number, and is @code{1} if the sub key can be used
1692 for signatures, and @code{0} otherwise.
1693
1694 @item GPGME_ATTR_CAN_CERTIFY
1695 This specifies if a sub key can be used for certifications.  It is
1696 representable as a number, and is @code{1} if the sub key can be used
1697 for certifications, and @code{0} otherwise.
1698
1699 @item GPGME_ATTR_SERIAL
1700 The X.509 issuer serial attribute of the key.  It is representable as
1701 a string.
1702
1703 @item GPGME_ATTR_ISSUE
1704 The X.509 issuer name attribute of the key.  It is representable as a
1705 string.
1706
1707 @item GPGME_ATTR_CHAINID
1708 The X.509 chain ID can be used to build the certification chain.  It
1709 is representable as a string.
1710 @end table
1711 @end deftp
1712
1713 @deftp {Data type} GpgmeValidity
1714 The @code{GpgmeValidity} type is used to specify the validity of a user ID
1715 in a key.  The following validities are defined:
1716
1717 @table @code
1718 @item GPGME_VALIDITY_UNKNOWN
1719 The user ID is of unknown validity.  The string representation of this
1720 validity is ``?''.
1721
1722 @item GPGME_VALIDITY_UNDEFINED
1723 The validity of the user ID is undefined.  The string representation of this
1724 validity is ``q''.
1725
1726 @item GPGME_VALIDITY_NEVER
1727 The user ID is never valid.  The string representation of this
1728 validity is ``n''.
1729
1730 @item GPGME_VALIDITY_MARGINAL
1731 The user ID is marginally valid.  The string representation of this
1732 validity is ``m''.
1733
1734 @item GPGME_VALIDITY_FULL
1735 The user ID is fully valid.  The string representation of this
1736 validity is ``f''.
1737
1738 @item GPGME_VALIDITY_ULTIMATE
1739 The user ID is ultimately valid.  The string representation of this
1740 validity is ``u''.
1741 @end table
1742 @end deftp
1743
1744 @deftypefun {const char *} gpgme_key_get_string_attr (@w{GpgmeKey @var{key}}, @w{GpgmeAttr @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
1745 The function @code{gpgme_key_get_string_attr} returns the value of the
1746 string-representable attribute @var{what} of key @var{key}.  If the
1747 attribute is an attribute of a sub key or an user ID, @var{idx}
1748 specifies the sub key or user ID of which the attribute value is
1749 returned.  The argument @var{reserved} is reserved for later use and
1750 should be @code{NULL}.
1751
1752 The string returned is only valid as long as the key is valid.
1753
1754 The function returns @code{0} if an attribute can't be returned as a
1755 string, @var{key} is not a valid pointer, @var{idx} out of range,
1756 or @var{reserved} not @code{NULL}.
1757 @end deftypefun
1758
1759 @deftypefun {unsigned long} gpgme_key_get_ulong_attr (@w{GpgmeKey @var{key}}, @w{GpgmeAttr @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
1760 The function @code{gpgme_key_get_ulong_attr} returns the value of the
1761 number-representable attribute @var{what} of key @var{key}.  If the
1762 attribute is an attribute of a sub key or an user ID, @var{idx}
1763 specifies the sub key or user ID of which the attribute value is
1764 returned.  The argument @var{reserved} is reserved for later use and
1765 should be @code{NULL}.
1766
1767 The function returns @code{0} if the attribute can't be returned as a
1768 number, @var{key} is not a valid pointer, @var{idx} out of range,
1769 or @var{reserved} not @code{NULL}.
1770 @end deftypefun
1771
1772
1773 @node Manipulating Keys
1774 @subsection Manipulating Keys
1775 @cindex key, manipulation
1776
1777 @deftypefun void gpgme_key_ref (@w{GpgmeKey @var{key}})
1778 The function @code{gpgme_key_ref} acquires an additional reference for
1779 the key @var{key}.
1780 @end deftypefun
1781
1782 @deftypefun void gpgme_key_unref (@w{GpgmeKey @var{key}})
1783 @deftypefunx void gpgme_key_release (@w{GpgmeKey @var{key}})
1784 The function @code{gpgme_key_ref} releases a reference for the key
1785 @var{key}.  If this was the last reference, the key will be destroyed
1786 and all resources associated to it will be released.
1787
1788 The function @code{gpgme_key_release} is an alias for
1789 @code{gpgme_key_unref}.
1790 @end deftypefun
1791
1792
1793 @node Generating Keys
1794 @subsection Generating Keys
1795 @cindex key, creation
1796 @cindex key ring, add
1797
1798 @deftypefun GpgmeError gpgme_op_genkey (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}})
1799 The function @code{gpgme_op_genkey} generates a new key pair in the
1800 context @var{ctx} and puts it into the standard key ring if both
1801 @var{pubkey} and @var{seckey} are @code{NULL}.  In this case the
1802 function returns immediately after starting the operation, and does
1803 not wait for it to complete.  If @var{pubkey} is not @code{NULL} it
1804 should be the handle for an empty (newly created) data object, and
1805 upon successful completion the data object will contain the public
1806 key.  If @var{seckey} is not @code{NULL} it should be the handle for
1807 an empty (newly created) data object, and upon successful completion
1808 the data object will contain the secret key.
1809
1810 Note that not all crypto engines support this interface equally.
1811 GnuPG does not support @var{pubkey} and @var{subkey}, they should be
1812 both @code{NULL}, and the key pair will be added to the standard key
1813 ring.  GpgSM does only support @var{pubkey}, the secret key will be
1814 stored by @command{gpg-agent}.  GpgSM expects @var{pubkey} being not
1815 @code{NULL}.
1816
1817 The argument @var{parms} specifies parameters for the key in an XML
1818 string.  The details about the format of @var{parms} are specific to
1819 the crypto engine used by @var{ctx}.  Here is an example for GnuPG as
1820 the crypto engine:
1821
1822 @example
1823 <GnupgKeyParms format="internal">
1824 Key-Type: DSA
1825 Key-Length: 1024
1826 Subkey-Type: ELG-E
1827 Subkey-Length: 1024
1828 Name-Real: Joe Tester
1829 Name-Comment: with stupid passphrase
1830 Name-Email: joe@@foo.bar
1831 Expire-Date: 0
1832 Passphrase: abc
1833 </GnupgKeyParms>
1834 @end example
1835
1836 Here is an example for GpgSM as the crypto engine:
1837 @example
1838 <GnupgKeyParms format="internal">
1839 Key-Type: RSA
1840 Key-Length: 1024
1841 Name-DN: C=de,O=g10 code,OU=Testlab,CN=Joe 2 Tester
1842 Name-Email: joe@@foo.bar
1843 </GnupgKeyParms>
1844 @end example
1845
1846 Strings should be given in UTF-8 encoding.  The only format supported
1847 for now is ``internal''.  The content of the @code{GnupgKeyParms}
1848 container is passed verbatim to GnuPG.  Control statements are not
1849 allowed.
1850
1851 The function returns @code{GPGME_No_Error} if the operation could be
1852 started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
1853 a valid XML string, @code{GPGME_Not_Supported} if @var{pubkey} or
1854 @var{seckey} is not valid, and @code{GPGME_General_Error} if no key
1855 was created by the backend.
1856 @end deftypefun
1857
1858 @deftypefun GpgmeError gpgme_op_genkey_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}})
1859 The function @code{gpgme_op_genkey_start} initiates a
1860 @code{gpgme_op_genkey} operation.  It can be completed by calling
1861 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
1862
1863 The function returns @code{GPGME_No_Error} if the operation could be
1864 started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
1865 a valid XML string, and @code{GPGME_Not_Supported} if @var{pubkey} or
1866 @var{seckey} is not @code{NULL}.
1867 @end deftypefun
1868
1869
1870 @node Exporting Keys
1871 @subsection Exporting Keys
1872 @cindex key, export
1873 @cindex key ring, export from
1874
1875 @deftypefun GpgmeError gpgme_op_export (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{recipients}}, @w{GpgmeData @var{keydata}})
1876 The function @code{gpgme_op_export} extracts the public keys of the
1877 user IDs in @var{recipients} and returns them in the data buffer
1878 @var{keydata}.  The type of the public keys returned is determined by
1879 the @acronym{ASCII} armor attribute set for the context @var{ctx}.
1880
1881 The function returns @code{GPGME_No_Error} if the operation completed
1882 successfully, @code{GPGME_Invalid_Value} if @var{recipients} is
1883 @code{NULL} or @var{keydata} is not a valid empty data buffer, and
1884 passes through any errors that are reported by the crypto engine
1885 support routines.
1886 @end deftypefun
1887
1888 @deftypefun GpgmeError gpgme_op_export_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{recipients}}, @w{GpgmeData @var{keydata}})
1889 The function @code{gpgme_op_export_start} initiates a
1890 @code{gpgme_op_export} operation.  It can be completed by calling
1891 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
1892
1893 The function returns @code{GPGME_No_Error} if the operation could be
1894 started successfully, and @code{GPGME_Invalid_Value} if
1895 @var{recipients} is @code{NULL} or @var{keydata} is not a valid empty
1896 data buffer.
1897 @end deftypefun
1898
1899
1900 @node Importing Keys
1901 @subsection Importing Keys
1902 @cindex key, import
1903 @cindex key ring, import to
1904
1905 @deftypefun GpgmeError gpgme_op_import (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{keydata}})
1906 The function @code{gpgme_op_import} adds the keys in the data buffer
1907 @var{keydata} to the key ring of the crypto engine used by @var{ctx}.
1908 The format of @var{keydata} can be @var{ASCII} armored, for example,
1909 but the details are specific to the crypto engine.
1910
1911 More information about the import is available with
1912 @code{gpgme_get_op_info}.  @xref{Detailed Results}.
1913
1914 The function returns @code{GPGME_No_Error} if the import was completed
1915 successfully, @code{GPGME_Invalid_Value} if @var{keydata} if @var{ctx}
1916 or @var{keydata} is not a valid pointer, @code{GPGME_No_Data} if
1917 @var{keydata} is an empty data buffer, and @code{GPGME_EOF} if the
1918 operation was completed successfully but no data was actually imported.
1919 @end deftypefun
1920
1921 @deftypefun GpgmeError gpgme_op_import_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{keydata}})
1922 The function @code{gpgme_op_import_start} initiates a
1923 @code{gpgme_op_import} operation.  It can be completed by calling
1924 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
1925
1926 The function returns @code{GPGME_No_Error} if the import could be
1927 started successfully, @code{GPGME_Invalid_Value} if @var{keydata} if
1928 @var{ctx} or @var{keydata} is not a valid pointer, and
1929 @code{GPGME_No_Data} if @var{keydata} is an empty data buffer.
1930 @end deftypefun
1931
1932
1933 @node Deleting Keys
1934 @subsection Deleting Keys
1935 @cindex key, delete
1936 @cindex key ring, delete from
1937
1938 @deftypefun GpgmeError gpgme_op_delete (@w{GpgmeCtx @var{ctx}}, @w{const GpgmeKey @var{key}}, @w{int @var{allow_secret}})
1939 The function @code{gpgme_op_delete} deletes the key @var{key} from the
1940 key ring of the crypto engine used by @var{ctx}.  If
1941 @var{allow_secret} is @code{0}, only public keys are deleted,
1942 otherwise secret keys are deleted as well.
1943
1944 The function returns @code{GPGME_No_Error} if the key was deleted
1945 successfully, @code{GPGME_Invalid_Value} if @var{ctx} or @var{key} is
1946 not a valid pointer, @code{GPGME_Invalid_Key} if @var{key} could not
1947 be found in the keyring, and @code{GPGME_Conflict} if the secret key
1948 for @var{key} is available, but @var{allow_secret} is zero.
1949 @end deftypefun
1950
1951 @deftypefun GpgmeError gpgme_op_delete_start (@w{GpgmeCtx @var{ctx}}, @w{const GpgmeKey @var{key}}, @w{int @var{allow_secret}})
1952 The function @code{gpgme_op_delete_start} initiates a
1953 @code{gpgme_op_delete} operation.  It can be completed by calling
1954 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
1955
1956 The function returns @code{GPGME_No_Error} if the operation was
1957 started successfully, and @code{GPGME_Invalid_Value} if @var{ctx} or
1958 @var{key} is not a valid pointer.
1959 @end deftypefun
1960
1961
1962 @node Trust Item Management
1963 @section Trust Item Management
1964 @cindex trust item
1965
1966 @strong{Caution:} The trust items interface is experimental.
1967
1968 @deftp {Data type} GpgmeTrustItem
1969 The @code{GpgmeTrustItem} type is a handle for a trust item.
1970 @end deftp
1971
1972 @menu
1973 * Listing Trust Items::           Browsing the list of available trust items.
1974 * Information About Trust Items:: Requesting detailed information about trust items.
1975 * Manipulating Trust Items::      Operations on trust items.
1976 @end menu
1977
1978
1979 @node Listing Trust Items
1980 @subsection Listing Trust Items
1981 @cindex trust item list
1982
1983 @deftypefun GpgmeError gpgme_op_trustlist_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{max_level}})
1984 The function @code{gpgme_op_trustlist_start} initiates a trust item
1985 listing operation inside the context @var{ctx}.  It sets everything up
1986 so that subsequent invocations of @code{gpgme_op_trustlist_next} return
1987 the trust items in the list.
1988
1989 The string @var{pattern} contains an engine specific expression that
1990 is used to limit the list to all trust items matching the pattern.  It
1991 can not be the empty string.
1992
1993 The argument @var{max_level} is currently ignored.
1994
1995 The context will be busy until either all trust items are received
1996 (and @code{gpgme_op_trustlist_next} returns @code{GPGME_EOF}), or
1997 @code{gpgme_op_trustlist_end} is called to finish the operation.
1998
1999 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
2000 valid pointer, and passes through any errors that are reported by the
2001 crypto engine support routines.
2002 @end deftypefun
2003
2004 @deftypefun GpgmeError gpgme_op_trustlist_next (@w{GpgmeCtx @var{ctx}}, @w{GpgmeTrustItem *@var{r_item}})
2005 The function @code{gpgme_op_trustlist_next} returns the next trust
2006 item in the list created by a previous @code{gpgme_op_trustlist_start}
2007 operation in the context @var{ctx}.  The trust item can be destroyed
2008 with @code{gpgme_trust_item_release}.  @xref{Manipulating Trust Items}.
2009
2010 This is the only way to get at @code{GpgmeTrustItem} objects in
2011 @acronym{GPGME}.
2012
2013 If the last trust item in the list has already been returned,
2014 @code{gpgme_op_trustlist_next} returns @code{GPGME_EOF}.
2015
2016 The function returns @code{GPGME_Invalid_Value} if @var{ctx} or
2017 @var{r_item} is not a valid pointer, @code{GPGME_No_Request} if there
2018 is no pending operation, @code{GPGME_Out_Of_Core} if there is not
2019 enough memory for the operation.
2020 @end deftypefun
2021
2022 @deftypefun GpgmeError gpgme_op_trustlist_end (@w{GpgmeCtx @var{ctx}})
2023 The function @code{gpgme_op_trustlist_next} ends a pending key list
2024 operation in the context @var{ctx}.
2025
2026 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
2027 valid pointer, @code{GPGME_No_Request} if there is no pending
2028 operation, @code{GPGME_Out_Of_Core} if at some time during the
2029 operation there was not enough memory available.
2030 @end deftypefun
2031
2032
2033 @node Information About Trust Items
2034 @subsection Information About Trust Items
2035 @cindex trust item, information about
2036 @cindex trust item, attributes
2037 @cindex attributes, of a trust item
2038
2039 Trust items have attributes which can be queried using the interfaces
2040 below.  The attribute identifiers are shared with those for key
2041 attributes.  @xref{Information About Keys}.
2042
2043 @deftypefun {const char *} gpgme_trust_item_get_string_attr (@w{GpgmeTrustItem @var{item}}, @w{GpgmeAttr @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
2044 The function @code{gpgme_trust_item_get_string_attr} returns the value
2045 of the string-representable attribute @var{what} of trust item
2046 @var{item}.  The arguments @var{idx} and @var{reserved} are reserved
2047 for later use and should be @code{0} and @code{NULL} respectively.
2048
2049 The string returned is only valid as long as the key is valid.
2050
2051 The function returns @code{0} if an attribute can't be returned as a
2052 string, @var{key} is not a valid pointer, @var{idx} out of range,
2053 or @var{reserved} not @code{NULL}.
2054 @end deftypefun
2055
2056 @deftypefun int gpgme_trust_item_get_int_attr (@w{GpgmeTrustItem @var{item}}, @w{GpgmeAttr @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
2057 The function @code{gpgme_trust_item_get_int_attr} returns the value of
2058 the number-representable attribute @var{what} of trust item
2059 @var{item}.  If the attribute occurs more than once in the trust item,
2060 the index is specified by @var{idx}.  However, currently no such
2061 attribute exists, so @var{idx} should be @code{0}.  The argument
2062 @var{reserved} is reserved for later use and should be @code{NULL}.
2063
2064 The function returns @code{0} if the attribute can't be returned as a
2065 number, @var{key} is not a valid pointer, @var{idx} out of range,
2066 or @var{reserved} not @code{NULL}.
2067 @end deftypefun
2068
2069
2070 @node Manipulating Trust Items
2071 @subsection Manipulating Trust Items
2072 @cindex trust item, manipulation
2073
2074 @deftypefun void gpgme_trust_item_release (@w{GpgmeTrustItem @var{item}})
2075 The function @code{gpgme_trust_item_release} destroys a
2076 @code{GpgmeTrustItem} object and releases all associated resources.
2077 @end deftypefun
2078
2079 @node Crypto Operations
2080 @section Crypto Operations
2081 @cindex cryptographic operation
2082
2083 @menu
2084 * Decrypt::                       Decrypting a ciphertext.
2085 * Verify::                        Verifying a signature.
2086 * Decrypt and Verify::            Decrypting a signed ciphertext.
2087 * Sign::                          Creating a signature.
2088 * Encrypt::                       Encrypting a plaintext.
2089 * Detailed Results::              How to obtain more info about the operation.
2090 @end menu
2091
2092
2093 @node Decrypt
2094 @subsection Decrypt
2095 @cindex decryption
2096 @cindex cryptographic operation, decryption
2097
2098 @deftypefun GpgmeError gpgme_op_decrypt (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}})
2099 The function @code{gpgme_op_decrypt} decrypts the ciphertext in the
2100 data object @var{cipher} and stores it into the data object
2101 @var{plain}.
2102
2103 The function returns @code{GPGME_No_Error} if the ciphertext could be
2104 decrypted successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2105 @var{cipher} or @var{plain} is not a valid pointer,
2106 @code{GPGME_No_Data} if @var{cipher} does not contain any data to
2107 decrypt, @code{GPGME_Decryption_Failed} if @var{cipher} is not a valid
2108 cipher text, @code{GPGME_No_Passphrase} if the passphrase for the
2109 secret key could not be retrieved, and passes through any errors that
2110 are reported by the crypto engine support routines.
2111 @end deftypefun
2112
2113 @deftypefun GpgmeError gpgme_op_decrypt_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}})
2114 The function @code{gpgme_op_decrypt_start} initiates a
2115 @code{gpgme_op_decrypt} operation.  It can be completed by calling
2116 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2117
2118 The function returns @code{GPGME_No_Error} if the operation could be
2119 started successfully, and @code{GPGME_Invalid_Value} if @var{cipher}
2120 or @var{plain} is not a valid pointer.
2121 @end deftypefun
2122
2123
2124 @node Verify
2125 @subsection Verify
2126 @cindex verification
2127 @cindex signature, verification
2128 @cindex cryptographic operation, verification
2129 @cindex cryptographic operation, signature check
2130 @cindex signature, status
2131
2132 @deftp {Data type} {enum GpgmeSigStat}
2133 @tindex GpgmeSigStat
2134 The @code{GpgmeSigStat} type holds the result of a signature check, or
2135 the combined result of all signatures.  The following results are
2136 possible:
2137
2138 @table @code
2139 @item GPGME_SIG_STAT_NONE
2140 This status should not occur in normal operation.
2141
2142 @item GPGME_SIG_STAT_GOOD
2143 This status indicates that the signature is valid.  For the combined
2144 result this status means that all signatures are valid.
2145
2146 @item GPGME_SIG_STAT_GOOD_EXP
2147 This status indicates that the signature is valid but expired.  For
2148 the combined result this status means that all signatures are valid
2149 and expired.
2150
2151 @item GPGME_SIG_STAT_GOOD_EXPKEY
2152 This status indicates that the signature is valid but the key used to
2153 verify the signature has expired.  For the combined result this status
2154 means that all signatures are valid and all keys are expired.
2155
2156 @item GPGME_SIG_STAT_BAD
2157 This status indicates that the signature is invalid.  For the combined
2158 result this status means that all signatures are invalid.
2159
2160 @item GPGME_SIG_STAT_NOKEY
2161 This status indicates that the signature could not be verified due to
2162 a missing key.  For the combined result this status means that all
2163 signatures could not be checked due to missing keys.
2164
2165 @item GPGME_SIG_STAT_NOSIG
2166 This status indicates that the signature data provided was not a real
2167 signature.
2168
2169 @item GPGME_SIG_STAT_ERROR
2170 This status indicates that there was some other error which prevented
2171 the signature verification.
2172
2173 @item GPGME_SIG_STAT_DIFF
2174 For the combined result this status means that at least two signatures
2175 have a different status.  You can get each key's status with
2176 @code{gpgme_get_sig_status}.
2177 @end table
2178 @end deftp
2179
2180 @deftypefun GpgmeError gpgme_op_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{plain}}, @w{GpgmeSigStat *@var{r_stat}})
2181 The function @code{gpgme_op_verify} verifies that the signature in the
2182 data object @var{sig} is a valid signature.  If @var{plain} is
2183 initialized with plaintext data, it is assumed that @var{sig} is a
2184 detached signature, and its validity for the plaintext given in
2185 @var{plain} is verified.  If @var{plain} is an uninitialized data
2186 object, it is assumed that @var{sig} is a normal (or cleartext)
2187 signature, and the plaintext is available in @var{plain} after
2188 successful verification.
2189
2190 The combined status of all signatures is returned in @var{r_stat}.
2191 The results of the individual signature verifications can be retrieved
2192 with @code{gpgme_get_sig_status} and @code{gpgme_get_sig_key}.
2193
2194 The function returns @code{GPGME_No_Error} if the operation could be
2195 completed successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2196 @var{sig}, @var{plain} or @var{r_stat} is not a valid pointer,
2197 @code{GPGME_No_Data} if @var{sig} does not contain any data to verify,
2198 and passes through any errors that are reported by the crypto engine
2199 support routines.
2200 @end deftypefun
2201
2202 @deftypefun GpgmeError gpgme_op_verify_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{plain}})
2203 The function @code{gpgme_op_verify_start} initiates a
2204 @code{gpgme_op_verify} operation.  It can be completed by calling
2205 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2206
2207 The function returns @code{GPGME_No_Error} if the operation could be
2208 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2209 @var{sig}, @var{plain} or @var{r_stat} is not a valid pointer, and
2210 @code{GPGME_No_Data} if @var{sig} or @var{plain} does not contain any
2211 data to verify.
2212 @end deftypefun
2213
2214 @deftypefun {const char *} gpgme_get_sig_status (@w{GpgmeCtx @var{ctx}}, @w{int @var{idx}}, @w{GpgmeSigStat *@var{r_stat}}, @w{time_t *@var{r_created}})
2215 The function @code{gpgme_get_sig_status} receives information about a
2216 signature after the @code{gpgme_op_verify} or
2217 @code{gpgme_op_verify_decrypt} operation.  A single detached signature
2218 can contain signatures by more than one key.  The @var{idx} specifies
2219 which signature's information should be retrieved, starting from
2220 @var{0}.
2221
2222 The status of the signature will be returned in @var{r_stat} if it is
2223 not @code{NULL}.  The creation time stamp of the signature will be
2224 returned in @var{r_created} if it is not @var{NULL}.
2225
2226 The function returns a statically allocated string that contains the
2227 fingerprint of the key which signed the plaintext, or @code{NULL} if
2228 @var{ctx} is not a valid pointer, the operation is still pending, or
2229 no verification could be performed.
2230 @end deftypefun
2231
2232 @deftypefun {const char *} gpgme_get_sig_string_attr (@w{GpgmeCtx @var{ctx}}, @w{int @var{idx}}, @w{GpgmeAttr @var{what}}, @w{int @var{whatidx}})
2233 This function is similar to @code{gpgme_get_sig_status} but may be used
2234 to retrieve more detailed information.  @var{ctx} should be the context
2235 used for the last signature verification, @var{idx} is used to enumerate
2236 over all signatures starting with @code{0} and @var{whatidx} should be
2237 @code{0} unless otherwise stated.
2238
2239 The following values may be used for @var{what}:
2240 @table @code
2241 @item GPGME_ATTR_FPR
2242 Return the fingerprint of the key used to create the signature.
2243
2244 @item GPGME_ATTR_ERRTOK
2245 Return a token with a more detailed error description.  A @var{whatidx}
2246 of @code{0} returns an error token associated with validity calculation,
2247 a value of @code{1} return an error token related to the certificate
2248 checking.
2249
2250 @end table
2251 @end deftypefun
2252
2253 @deftypefun {const char *} gpgme_get_sig_ulong_attr (@w{GpgmeCtx @var{ctx}}, @w{int @var{idx}}, @w{GpgmeAttr @var{waht}}, @w{int @var{whatidx}})
2254 This function is similar to @code{gpgme_get_sig_string_attr} but used
2255 for attributes which can be represented by an @code{unsigned long} data
2256 type.  @var{ctx} should be the context used for the last signature
2257 verification, @var{idx} is used to enumerate over all signatures
2258 starting with @code{0} and @var{whatidx} should be @code{0} unless
2259 otherwise stated.
2260
2261 The following values may be used for @var{what}:
2262 @table @code
2263 @item GPGME_ATTR_CREATED
2264 Return the creation time of the signature in seconds since Epoch.  This
2265 is the same value as returned by @code{gpgme_get_sig_status}.
2266
2267 @item GPGME_ATTR_EXPIRE
2268 Return the expiration time of the signature in seconds since Epoch. 
2269
2270 @item GPGME_ATTR_VALIDITY
2271 Returns the validity of the key used to create the signature.  This is a
2272 shortcut function which avoids an extra key lookup.  The value returned
2273 is one of @code{GPGME_VALIDITY_UNKNOWN}, @code{GPGME_VALIDITY_NEVER},
2274 @code{GPGME_VALIDITY_MARGINAL} or @code{GPGME_VALIDITY_FULL}.
2275
2276 @item GPGME_ATTR_SIG_STATUS
2277 This is the same value as returned by @code{gpgme_get_sig_status}.
2278
2279 @item GPGME_ATTR_SIG_SUMMARY
2280 This returns a bit vector giving a summary of the signature status.
2281 Itprovides an easy interface to a defined semantic of the signature
2282 status.  Checking just one bit is sufficient to see whether a signature
2283 is valid without any restrictions.
2284
2285 The defined bits are:
2286   @table @code
2287   @item GPGME_SIGSUM_VALID
2288   The signature is fully valid.
2289
2290   @item GPGME_SIGSUM_GREEN
2291   The signature is good but one might want to display some extra
2292   information.  Check the other bits.
2293
2294   @item GPGME_SIGSUM_RED
2295   The signature is bad. It might be useful to checkother bits and
2296   display moe information, i.e. a revoked certificate might not render a
2297   signature invalid when the message was received prior to the cause for
2298   the revocation.
2299
2300   @item GPGME_SIGSUM_KEY_REVOKED
2301   The key or at least one certificate has been revoked.
2302
2303   @item GPGME_SIGSUM_KEY_EXPIRED
2304   The key or one of the certificates has expired. It is probably a good
2305   idea to display the date of the expiration.
2306
2307   @item GPGME_SIGSUM_SIG_EXPIRED
2308   The signature has expired.
2309
2310   @item GPGME_SIGSUM_KEY_MISSING
2311   Can't verifydue to a missing key o certificate.
2312
2313   @item GPGME_SIGSUM_CRL_MISSING
2314   The CRL (or an equivalent mechanism) is not available. 
2315
2316   @item GPGME_SIGSUM_CRL_TOO_OLD
2317   Available CRL is too old.
2318
2319   @item GPGME_SIGSUM_BAD_POLICY
2320   A policy requirement was not met. 
2321
2322   @item GPGME_SIGSUM_SYS_ERROR
2323   A system error occured. 
2324
2325   @end table
2326
2327 @end table
2328 @end deftypefun
2329
2330
2331 @deftypefun {const char *} gpgme_get_sig_key (@w{GpgmeCtx @var{ctx}}, @w{int @var{idx}}, @w{GpgmeSigKey *@var{r_stat}})
2332 The function @code{gpgme_get_sig_status} receives a @code{GpgmeKey}
2333 object for the key which was used to verify the signature after the
2334 @code{gpgme_op_verify} or @code{gpgme_op_verify_decrypt} operation.  A
2335 single detached signature can contain signatures by more than one key.
2336 The @var{idx} specifies which signature's information should be
2337 retrieved, starting from @var{0}.  The key will have on reference for
2338 the user.
2339
2340 The function is a convenient way to retrieve the keys belonging to the
2341 fingerprints returned by @code{gpgme_get_sig_status}.
2342
2343 The function returns @code{GPGME_No_Error} if the key could be
2344 returned, @code{GPGME_Invalid_Value} if @var{r_key} is not a valid
2345 pointer, @code{GPGME_Invalid_Key} if the fingerprint is not valid,
2346 @code{GPGME_EOF} if @var{idx} is too large, or some other error value
2347 if a problem occurred requesting the key.
2348 @end deftypefun
2349
2350 @deftypefun {char *} gpgme_get_notation (@w{GpgmeCtx @var{ctx}})
2351 The function @code{gpgme_get_notation} can be used to retrieve
2352 notation data from the last signature check in the context @var{ctx}.
2353
2354 If there is notation data available from the last signature check,
2355 this function may be used to return this notation data as a string.
2356 The string is an XML representation of that data embedded in a
2357 <notation> container.  The user has to release the string with
2358 @code{free}.
2359
2360 The function returns a string if the notation data is available or
2361 @code{NULL} if there is no such data available.
2362 @end deftypefun
2363
2364
2365 @node Decrypt and Verify
2366 @subsection Decrypt and Verify
2367 @cindex decryption and verification
2368 @cindex verification and decryption
2369 @cindex signature check
2370 @cindex cryptographic operation, decryption and verification
2371
2372 @deftypefun GpgmeError gpgme_op_decrypt_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}}, @w{GpgmeSigStat *@var{r_stat}})
2373 The function @code{gpgme_op_decrypt_verify} decrypts the ciphertext in
2374 the data object @var{cipher} and stores it into the data object
2375 @var{plain}.  If @var{cipher} contains signatures, they will be
2376 verified and their combined status will be returned in @var{r_stat}.
2377
2378 After the operation completed, @code{gpgme_op_get_sig_status} and
2379 @code{gpgme_op_get_sig_key} can be used to retrieve more information
2380 about the signatures.
2381
2382 The function returns @code{GPGME_No_Error} if the ciphertext could be
2383 decrypted successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2384 @var{cipher}, @var{plain} or @var{r_stat} is not a valid pointer,
2385 @code{GPGME_No_Data} if @var{cipher} does not contain any data to
2386 decrypt, @code{GPGME_Decryption_Failed} if @var{cipher} is not a valid
2387 cipher text, @code{GPGME_No_Passphrase} if the passphrase for the
2388 secret key could not be retrieved, and passes through any errors that
2389 are reported by the crypto engine support routines.
2390 @end deftypefun
2391
2392 @deftypefun GpgmeError gpgme_op_decrypt_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}})
2393 The function @code{gpgme_op_decrypt_verify_start} initiates a
2394 @code{gpgme_op_decrypt_verify} operation.  It can be completed by
2395 calling @code{gpgme_wait} on the context.  @xref{Waiting For
2396 Completion}.
2397
2398 The function returns @code{GPGME_No_Error} if the operation could be
2399 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2400 @var{cipher}, @var{plain} or @var{r_stat} is not a valid pointer, and
2401 @code{GPGME_No_Data} if @var{cipher} does not contain any data to
2402 decrypt.
2403 @end deftypefun
2404
2405
2406 @node Sign
2407 @subsection Sign
2408 @cindex signature, creation
2409 @cindex sign
2410 @cindex cryptographic operation, signing
2411
2412 A signature can contain signatures by one or more keys.  The set of
2413 keys used to create a signatures is contained in a context, and is
2414 applied to all following signing operations in this context (until the
2415 set is changed).
2416
2417 @menu
2418 * Selecting Signers::             How to choose the keys to sign with.
2419 * Creating a Signature::          How to create a signature.
2420 @end menu
2421
2422
2423 @node Selecting Signers
2424 @subsubsection Selecting Signers
2425 @cindex signature, selecting signers
2426 @cindex signers, selecting
2427
2428 @deftypefun void gpgme_signers_clear (@w{GpgmeCtx @var{ctx}})
2429 The function @code{gpgme_signers_clear} releases a reference for each
2430 key on the signers list and removes the list of signers from the
2431 context @var{ctx}.
2432
2433 Every context starts with an empty list.
2434 @end deftypefun
2435
2436 @deftypefun GpgmeError gpgme_signers_add (@w{GpgmeCtx @var{ctx}}, @w{const GpgmeKey @var{key}})
2437 The function @code{gpgme_signers_add} adds the key @var{key} to the
2438 list of signers in the context @var{ctx}.
2439
2440 One reference for the key is consumed.
2441 @end deftypefun
2442
2443 @deftypefun GpgmeKey gpgme_signers_enum (@w{const GpgmeCtx @var{ctx}}, @w{int @var{seq}})
2444 The function @code{gpgme_signers_enum} returns the @var{seq}th key in
2445 the list of signers in the context @var{ctx}.  An additional reference
2446 is acquired for the user.
2447
2448 If @var{seq} is out of range, @code{NULL} is returned.
2449 @end deftypefun
2450
2451
2452 @node Creating a Signature
2453 @subsubsection Creating a Signature
2454
2455 @deftp {Data type} {enum GpgmeSigMode}
2456 @tindex GpgmeSigMode
2457 The @code{GpgmeSigMode} type is used to specify the desired type of a
2458 signature.  The following modes are available:
2459
2460 @table @code
2461 @item GPGME_SIG_MODE_NORMAL
2462 A normal signature is made, the output includes the plaintext and the
2463 signature.
2464
2465 @item GPGME_SIG_MODE_DETACH
2466 A detached signature is made.
2467
2468 @item GPGME_SIG_MODE_CLEAR
2469 A clear text signature is made.  The @acronym{ASCII} armor and text
2470 mode settings of the context are ignored.
2471 @end table
2472 @end deftp
2473
2474 @deftypefun GpgmeError gpgme_op_sign (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{sig}}, @w{GpgmeSigMode @var{mode}})
2475 The function @code{gpgme_op_sign} creates a signature for the text in
2476 the data object @var{plain} and returns it in the data object
2477 @var{sig}.  The type of the signature created is determined by the
2478 @acronym{ASCII} armor and text mode attributes set for the context
2479 @var{ctx} and the requested signature mode @var{mode}.
2480
2481 More information about the signatures is available with
2482 @code{gpgme_get_op_info}.  @xref{Detailed Results}.
2483
2484 If an S/MIME signed message is created using the CMS crypto engine,
2485 the number of certificates to include in the message can be specified
2486 with @code{gpgme_set_include_certs}.  @xref{Included Certificates}.
2487
2488 The function returns @code{GPGME_No_Error} if the signature could be
2489 created successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2490 @var{plain} or @var{sig} is not a valid pointer, @code{GPGME_No_Data}
2491 if the signature could not be created, @code{GPGME_No_Passphrase} if
2492 the passphrase for the secret key could not be retrieved, and passes
2493 through any errors that are reported by the crypto engine support
2494 routines.
2495 @end deftypefun
2496
2497 @deftypefun GpgmeError gpgme_op_sign_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{sig}}, @w{GpgmeSigMode @var{mode}})
2498 The function @code{gpgme_op_sign_start} initiates a
2499 @code{gpgme_op_sign} operation.  It can be completed by calling
2500 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2501
2502 The function returns @code{GPGME_No_Error} if the operation could be
2503 started successfully, and @code{GPGME_Invalid_Value} if @var{ctx},
2504 @var{plain} or @var{sig} is not a valid pointer.
2505 @end deftypefun
2506
2507
2508 @node Encrypt
2509 @subsection Encrypt
2510 @cindex encryption
2511 @cindex cryptographic operation, encryption
2512
2513 One plaintext can be encrypted for several recipients at the same
2514 time.  The list of recipients is created independently of any context,
2515 and then passed to the encryption operation.
2516
2517 @menu
2518 * Selecting Recipients::          How to choose the recipients.
2519 * Encrypting a Plaintext::        How to encrypt a plaintext.
2520 @end menu
2521
2522
2523 @node Selecting Recipients
2524 @subsubsection Selecting Recipients
2525 @cindex encryption, selecting recipients
2526 @cindex recipients
2527
2528 @deftp {Data type} GpgmeRecipients
2529 The @code{GpgmeRecipients} type is a handle for a set of recipients
2530 that can be used in an encryption process.
2531 @end deftp
2532
2533 @deftypefun GpgmeError gpgme_recipients_new (@w{GpgmeRecipients *@var{r_rset}})
2534 The function @code{gpgme_recipients_new} creates a new, empty set of
2535 recipients and returns a handle for it in @var{r_rset}.
2536
2537 The function returns @code{GPGME_No_Error} if the recipient set could
2538 be created successfully, and @code{GPGME_Out_Of_Core} if not enough
2539 memory was available.
2540 @end deftypefun
2541
2542 @deftypefun void gpgme_recipients_release (@w{GpgmeRecipients @var{rset}})
2543 The function @code{gpgme_recipients_release} destroys the set of
2544 recipients @var{rset} and releases all associated resources.
2545 @end deftypefun
2546
2547 @deftypefun GpgmeError gpgme_recipients_add_name (@w{GpgmeRecipients @var{rset}}, @w{const char *@var{name}})
2548 The function @code{gpgme_recipients_add_name} adds the recipient
2549 @var{name} to the set of recipients @var{rset}.  This is equivalent to
2550 @code{gpgme_recipients_add_name_with_validity} with a validity of
2551 @code{GPGME_VALIDITY_UNKNOWN}.
2552
2553 The function returns @code{GPGME_No_Error} if the recipient was added
2554 successfully, @code{GPGME_Invalid_Value} if @var{rset} or @var{name}
2555 is not a valid pointer, and @code{GPGME_Out_Of_Core} if not enough
2556 memory is available.
2557 @end deftypefun
2558
2559 @deftypefun GpgmeError gpgme_recipients_add_name_with_validity (@w{GpgmeRecipients @var{rset}}, @w{const char *@var{name}}, @w{GpgmeValidity @var{val}})
2560 The function @code{gpgme_recipients_add_name_with_validity} adds the
2561 recipient @var{name} with the validity @var{val} to the set of
2562 recipients @var{rset}.  If the validity is not known, the function
2563 @code{gpgme_recipients_add_name} can be used.
2564 @xref{Information About Keys}, for the possible values for @var{val}.
2565
2566 The function returns @code{GPGME_No_Error} if the recipient was added
2567 successfully, @code{GPGME_Invalid_Value} if @var{rset} or @var{name}
2568 is not a valid pointer, and @code{GPGME_Out_Of_Core} if not enough
2569 memory is available.
2570 @end deftypefun
2571
2572 @deftypefun {unsigned int} gpgme_recipients_count (@w{const @var{GpgmeRecipients rset}})
2573 The function @code{gpgme_recipients_count} returns the number of
2574 recipients in the set @var{rset}.
2575 @end deftypefun
2576
2577 @deftypefun GpgmeError gpgme_recipients_enum_open (@w{const GpgmeRecipients @var{rset}}, @w{void **@var{iter}})
2578 The function @code{gpgme_recipients_enum_open} creates a new iterator
2579 @var{iter} that can be used to walk through the set of recipients in
2580 @var{rset}, using @code{gpgme_recipients_enum_read}.
2581
2582 If the iterator is not needed anymore, it can be closed with
2583 @code{gpgme_recipients_enum_close}.
2584
2585 The function returns @code{GPGME_No_Error} if the enumerator was
2586 successfully created and @code{GPGME_Invalid_Value} if @var{rset} or
2587 @var{iter} is not a valid pointer.
2588 @end deftypefun
2589
2590 @deftypefun {const char *} gpgme_recipients_enum_read (@w{const GpgmeRecipients @var{rset}}, @w{void **@var{iter}})
2591 The function @code{gpgme_recipients_enum_read} returns a string
2592 containing the name of the next recipient in the set @var{rset} for
2593 the iterator @var{iter}.  The string is valid as long as @var{rset} is
2594 valid or the function is called the next time with the same recipient
2595 set and iterator, whatever is earlier.
2596 @end deftypefun
2597
2598 @deftypefun GpgmeError gpgme_recipients_enum_close (@w{const GpgmeRecipients @var{rset}}, @w{void **@var{iter}})
2599 The function @code{gpgme_recipients_enum_close} releases the iterator
2600 @var{iter} for the recipient set @var{rset}.
2601 @end deftypefun
2602
2603
2604 @node Encrypting a Plaintext
2605 @subsubsection Encrypting a Plaintext
2606
2607 @deftypefun GpgmeError gpgme_op_encrypt (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
2608 The function @code{gpgme_op_encrypt} encrypts the plaintext in the data
2609 object @var{plain} for the recipients @var{rset} and stores the
2610 ciphertext in the data object @var{cipher}.  The type of the
2611 ciphertext created is determined by the @acronym{ASCII} armor and text
2612 mode attributes set for the context @var{ctx}.
2613
2614 If @code{GPGME_Invalid_Recipients} is returned, some recipients in
2615 @var{rset} are invalid, but not all.  In this case the plaintext is
2616 encrypted for all valid recipients and returned in @var{cipher}.  More
2617 information about the invalid recipients is available with
2618 @code{gpgme_get_op_info}.  @xref{Detailed Results}.
2619
2620 If @var{recp} is @code{NULL}, symmetric rather than public key
2621 encryption is performed.  Symmetrically encrypted cipher text can be
2622 deciphered with @code{gpgme_op_decrypt}.  Note that in this case the
2623 crypto backend needs to retrieve a passphrase from the user.
2624 Symmetric encryption is currently only supported for the OpenPGP
2625 crypto backend.
2626
2627 The function returns @code{GPGME_No_Error} if the ciphertext could be
2628 created successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2629 @var{rset}, @var{plain} or @var{cipher} is not a valid pointer,
2630 @code{GPGME_No_Recipients} if @var{rset} does not contain any valid
2631 recipients, @code{GPGME_Invalid_Recipients} if @var{rset} contains
2632 some invalid recipients, @code{GPGME_No_Passphrase} if the passphrase
2633 for the secret key could not be retrieved, and passes through any
2634 errors that are reported by the crypto engine support routines.
2635 @end deftypefun
2636
2637 @deftypefun GpgmeError gpgme_op_encrypt_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
2638 The function @code{gpgme_op_encrypt_start} initiates a
2639 @code{gpgme_op_encrypt} operation.  It can be completed by calling
2640 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2641
2642 The function returns @code{GPGME_No_Error} if the operation could be
2643 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2644 @var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
2645 @code{GPGME_No_Recipients} if @var{rset} does not contain any valid
2646 recipients.
2647 @end deftypefun
2648
2649
2650 @deftypefun GpgmeError gpgme_op_encrypt_sign (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
2651 The function @code{gpgme_op_encrypt_sign} does a combined encrypt and
2652 sign operation.  It is used like @code{gpgme_op_encrypt}, but the
2653 ciphertext also contains signatures for the signers listed in
2654 @var{ctx}.
2655
2656 The combined encrypt and sign operation is currently only available
2657 for the OpenPGP crypto engine.
2658 @end deftypefun
2659
2660 @deftypefun GpgmeError gpgme_op_encrypt_sign_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
2661 The function @code{gpgme_op_encrypt_sign_start} initiates a
2662 @code{gpgme_op_encrypt_sign} operation.  It can be completed by
2663 calling @code{gpgme_wait} on the context.  @xref{Waiting For
2664 Completion}.
2665
2666 The function returns @code{GPGME_No_Error} if the operation could be
2667 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
2668 @var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
2669 @code{GPGME_No_Recipients} if @var{rset} does not contain any valid
2670 recipients.
2671 @end deftypefun
2672
2673
2674 @node Detailed Results
2675 @subsection Detailed Results
2676 @cindex cryptographic operation, detailed results
2677
2678 @deftypefun {char *} gpgme_get_op_info (@w{GpgmeCtx @var{ctx}}, @w{int @var{reserved}})
2679 The function @code{gpgme_get_op_info} retrieves more information about
2680 the last crypto operation.
2681
2682 The function returns a string in the XML format.  The user has to
2683 release the string with @code{free}.
2684
2685 Here is a sample of the information that might be returned:
2686 @example
2687 <GnupgOperationInfo>
2688   <signature>
2689     <detached/> <!-- or cleartext or standard -->
2690     <algo>17</algo>
2691     <hashalgo>2</hashalgo>
2692     <micalg>pgp-sha1</micalg>
2693     <sigclass>01</sigclass>
2694     <created>9222222</created>
2695     <fpr>121212121212121212</fpr>
2696   </signature>
2697 </GnupgOperationInfo>
2698 @end example
2699
2700 Currently, the only operations that return additional information are
2701 encrypt, sign and import.  @xref{Encrypt}, @xref{Sign},
2702 @xref{Importing Keys}.
2703
2704 The function returns a string or @code{NULL} if no such data is
2705 available.
2706 @end deftypefun
2707
2708
2709 @node Run Control
2710 @section Run Control
2711 @cindex run control
2712 @cindex cryptographic operation, running
2713
2714 @acronym{GPGME} supports running operations synchronously and
2715 asynchronously.  You can use asynchronous operation to set up a
2716 context up to initiating the desired operation, but delay performing
2717 it to a later point.
2718
2719 Furthermore, you can use an external event loop to control exactly
2720 when @acronym{GPGME} runs.  This ensures that @acronym{GPGME} only
2721 runs when necessary and also prevents it from blocking for a long
2722 time.
2723
2724 @menu
2725 * Waiting For Completion::        Waiting until an operation is completed.
2726 * Cancelling an Operation::       Interrupting a running operation.
2727 * Hooking Up Into Idle Time::     Doing something when nothing has to be done.
2728 * Using External Event Loops::    Advanced control over what happens when.
2729 @end menu
2730
2731
2732 @node Waiting For Completion
2733 @subsection Waiting For Completion
2734 @cindex cryptographic operation, wait for
2735 @cindex wait for completion
2736
2737 @deftypefun GpgmeCtx gpgme_wait (@w{GpgmeCtx @var{ctx}}, @w{GpgmeError *@var{status}}, @w{int @var{hang}})
2738 The function @code{gpgme_wait} continues the pending operation within
2739 the context @var{ctx}.  In particular, it ensures the data exchange
2740 between @acronym{GPGME} and the crypto backend and watches over the
2741 run time status of the backend process.
2742
2743 If @var{hang} is true, the function does not return until the
2744 operation is completed or cancelled.  Otherwise the function will not
2745 block for a long time.
2746
2747 The error status of the finished operation is returned in @var{status}
2748 if @code{gpgme_wait} does not return @code{NULL}.
2749
2750 The @var{ctx} argument can be @code{NULL}.  In that case,
2751 @code{gpgme_wait} waits for any context to complete its operation.
2752
2753 @code{gpgme_wait} can be used only in conjunction with any context
2754 that has a pending operation initiated with one of the
2755 @code{gpgme_op_*_start} functions except @code{gpgme_op_keylist_start}
2756 and @code{gpgme_op_trustlist_start} (for which you should use the
2757 corresponding @code{gpgme_op_*_next} functions).  If @var{ctx} is
2758 @code{NULL}, all of such contexts are waited upon and possibly
2759 returned.  Synchronous operations running in parallel, as well as key
2760 and trust item list operations, do not affect @code{gpgme_wait}.
2761
2762 In a multi-threaded environment, only one thread should ever call
2763 @code{gpgme_wait} at any time, irregardless if @var{ctx} is specified
2764 or not.  This means that all calls to this function should be fully
2765 synchronized by locking primitives.
2766
2767 The function returns the @var{ctx} of the context which has finished
2768 the operation.
2769 @end deftypefun
2770
2771
2772 @node Cancelling an Operation
2773 @subsection Cancelling an Operation
2774 @cindex cancellation
2775 @cindex cryptographic operation, cancel
2776
2777 @deftypefun void gpgme_cancel (@w{GpgmeCtx @var{ctx}})
2778 The function @code{gpgme_cancel} tries to cancel the pending
2779 operation.  A running synchronous operation in the context or the
2780 function @code{gpgme_wait} with this context as its @var{ctx} argument
2781 might notice the cancellation flag and return.  It is currently not
2782 guaranteed to work under all circumstances.  Its current primary
2783 purpose is to prevent asking for a passphrase again in the passphrase
2784 callback.
2785 @end deftypefun
2786
2787
2788 @node Hooking Up Into Idle Time
2789 @subsection Hooking Up Into Idle Time
2790 @cindex idle time
2791 @cindex idle function
2792
2793 @deftp {Data type} {void (*GpgmeIdleFunc) (void)}
2794 @tindex GpgmeIdleFunc
2795 The @code{GpgmeIdleFunc} type is the type of functions usable as
2796 an idle function that can be registered with @code{gpgme_register_idle}.
2797 @end deftp
2798
2799 @deftypefun GpgmeIdleFunc gpgme_register_idle (@w{GpgmeIdleFunc @var{idle}})
2800 The function @code{gpgme_register_idle} can be used to register
2801 @var{idle} as the idle function.
2802
2803 @var{idle} will be called whenever @acronym{GPGME} thinks that it is
2804 idle and time can better be spent elsewhere.  Setting @var{idle} to
2805 @code{NULL} disables use of the idle function (this is the default).
2806
2807 The function returns the old idle function, or @code{NULL} if none was
2808 registered yet.
2809 @end deftypefun
2810
2811
2812 @node Using External Event Loops
2813 @subsection Using External Event Loops
2814 @cindex event loop, external
2815
2816 @acronym{GPGME} hides the complexity of the communication between the
2817 library and the crypto engine.  The price of this convenience is that
2818 the calling thread can block arbitrary long waiting for the data
2819 returned by the crypto engine.  In single-threaded programs, in
2820 particular if they are interactive, this is an unwanted side-effect.
2821 OTOH, if @code{gpgme_wait} is used without the @var{hang} option being
2822 enabled, it might be called unnecessarily often, wasting CPU time that
2823 could be used otherwise.
2824
2825 The I/O callback interface described in this section lets the user
2826 take control over what happens when.  @acronym{GPGME} will provide the
2827 user with the file descriptors that should be monitored, and the
2828 callback functions that should be invoked when a file descriptor is
2829 ready for reading or writing.  It is then the user's responsibility to
2830 decide when to check the file descriptors and when to invoke the
2831 callback functions.  Usually this is done in an event loop, that also
2832 checks for events in other parts of the program.  If the callback
2833 functions are only called when the file descriptors are ready,
2834 @acronym{GPGME} will never block.  This gives the user mroe control
2835 over the program flow, and allows to perform other tasks when
2836 @acronym{GPGME} would block otherwise.
2837
2838 By using this advanced mechanism, @acronym{GPGME} can be integrated
2839 smoothly into GUI toolkits like GTK+ even for single-threaded
2840 programs.
2841
2842 @menu
2843 * I/O Callback Interface::        How I/O callbacks are registered.
2844 * Registering I/O Callbacks::     How to use I/O callbacks for a context.
2845 * I/O Callback Example::          An example how to use I/O callbacks.
2846 * I/O Callback Example GTK+::     How to use @acronym{GPGME} with GTK+.
2847 * I/O Callback Example GDK::      How to use @acronym{GPGME} with GDK.
2848 @end menu
2849
2850
2851 @node I/O Callback Interface
2852 @subsubsection I/O Callback Interface
2853
2854 @deftp {Data type} {void (*GpgmeIOCb) (@w{void *@var{data}}, @w{int @var{fd}})}
2855 @tindex GpgmeIOCb
2856 The @code{GpgmeIOCb} type is the type of functions which
2857 @acronym{GPGME} wants to register as I/O callback handlers using the
2858 @code{GpgmeRegisterIOCb} functions provided by the user.
2859
2860 @var{data} and @var{fd} are provided by @acronym{GPGME} when the I/O
2861 callback handler is registered, and should be passed through to the
2862 handler when it is invoked by the user because it noticed activity on
2863 the file descriptor @var{fd}.
2864 @end deftp
2865
2866 @deftp {Data type} {GpgmeError (*GpgmeRegisterIOCb) (@w{void *@var{data}}, @w{int @var{fd}}, @w{int @var{dir}}, @w{GpgmeIOCb @var{fnc}}, @w{void *@var{fnc_data}}, @w{void **@var{tag}})}
2867 @tindex GpgmeRegisterIOCb
2868 The @code{GpgmeRegisterIOCb} type is the type of functions which can
2869 be called by @acronym{GPGME} to register an I/O callback funtion
2870 @var{fnc} for the file descriptor @var{fd} with the user.
2871 @var{fnc_data} should be passed as the first argument to @var{fnc}
2872 when the handler is invoked (the second argument should be @var{fd}).
2873 If @var{dir} is 0, @var{fnc} should be called by the user when
2874 @var{fd} is ready for writing.  If @var{dir} is 1, @var{fnc} should be
2875 called when @var{fd} is ready for reading.
2876
2877 @var{data} was provided by the user when registering the
2878 @code{GpgmeRegisterIOCb} function with @acronym{GPGME} and will always
2879 be passed as the first argument when registering a callback function.
2880 For example, the user can use this to determine the event loop to
2881 which the file descriptor should be added.
2882
2883 @acronym{GPGME} will call this function when a crypto operation is
2884 initiated in a context for which the user has registered I/O callback
2885 handler functions with @code{gpgme_set_io_cbs}.  It can also call this
2886 function when it is in an I/O callback handler for a file descriptor
2887 associated to this context.
2888
2889 The user should return a unique handle in @var{tag} identifying this
2890 I/O callback registration, which will be passed to the
2891 @code{GpgmeRegisterIOCb} function without interpretation when the file
2892 descriptor should not be monitored anymore.
2893 @end deftp
2894
2895 @deftp {Data type} {void (*GpgmeRemoveIOCb) (@w{void *@var{tag}})}
2896 The @code{GpgmeRemoveIOCb} type is the type of functions which can be
2897 called by @acronym{GPGME} to remove an I/O callback handler that was
2898 registered before.  @var{tag} is the handle that was returned by the
2899 @code{GpgmeRegisterIOCb} for this I/O callback.
2900
2901 @acronym{GPGME} can call this function when a crypto operation is in
2902 an I/O callback.  It will also call this function when the context is
2903 destroyed while an operation is pending.
2904 @end deftp
2905
2906 @deftp {Data type} {enum GpgmeEventIO}
2907 @tindex GpgmeEventIO
2908 The @code{GpgmeEventIO} type specifies the type of an event that is
2909 reported to the user by @acronym{GPGME} as a consequence of an I/O
2910 operation.  The following events are defined:
2911
2912 @table @code
2913 @item GPGME_EVENT_DONE
2914 The operation is finished, the last I/O callback for this operation
2915 was removed.  The accompanying @var{type_data} points to a
2916 @code{GpgmeError} variable that contains the status of the operation
2917 that finished.  This event is signalled after the last I/O callback
2918 has been removed.
2919
2920 @item GPGME_EVENT_NEXT_KEY
2921 In a @code{gpgme_op_keylist_start} operation, the next key was
2922 received from the crypto engine.  The accompanying @var{type_data} is
2923 a @code{GpgmeKey} variable that contains the key with one reference
2924 for the user.
2925
2926 @item GPGME_EVENT_NEXT_TRUSTITEM
2927 In a @code{gpgme_op_trustlist_start} operation, the next trust item
2928 was received from the crypto engine.  The accompanying @var{type_data}
2929 is a @code{GpgmeTrustItem} variable that contains the trust item with
2930 one reference for the user.
2931 @end table
2932 @end deftp
2933
2934 @deftp {Data type} {void (*GpgmeEventIOCb) (@w{void *@var{data}}, @w{GpgmeEventIO @var{type}}, @w{void *@var{type_data}})}
2935 The @code{GpgmeEventIOCb} type is the type of functions which can be
2936 called by @acronym{GPGME} to signal an event for an operation running
2937 in a context which has I/O callback functions registered by the user.
2938
2939 @var{data} was provided by the user when registering the
2940 @code{GpgmeEventIOCb} function with @acronym{GPGME} and will always be
2941 passed as the first argument when registering a callback function.
2942 For example, the user can use this to determine the context in which
2943 this event has occured.
2944
2945 @var{type} will specify the type of event that has occured.
2946 @var{type_data} specifies the event further, as described in the above
2947 list of possible @code{GpgmeEventIO} types.
2948
2949 @acronym{GPGME} can call this function in an I/O callback handler.
2950 @end deftp
2951
2952
2953 @node Registering I/O Callbacks
2954 @subsubsection Registering I/O Callbacks
2955
2956 @deftp {Data type} {struct GpgmeIOCbs}
2957 @tindex GpgmeEventIO
2958 This structure is used to store the I/O callback interface functions
2959 described in the previous section.  It has the following members:
2960
2961 @table @code
2962 @item GpgmeRegisterIOCb add
2963 This is the function called by @acronym{GPGME} to register an I/O
2964 callback handler.  It must be specified.
2965
2966 @item void *add_data
2967 This is passed as the first argument to the @code{add} function when
2968 it is called by @acronym{GPGME}.  For example, it can be used to
2969 determine the event loop to which the file descriptor should be added.
2970
2971 @item GpgmeRemoveIOCb remove
2972 This is the function called by @acronym{GPGME} to remove an I/O
2973 callback handler.  It must be specified.
2974
2975 @item GpgmeEventIOCb event
2976 This is the function called by @acronym{GPGME} to signal an event for
2977 an operation.  It is optional, but if you don't specify it, you can
2978 not retrieve the return value of the operation.
2979
2980 @item void *event_data
2981 This is passed as the first argument to the @code{event} function when
2982 it is called by @acronym{GPGME}.  For example, it can be used to
2983 determine the context in which the event has occured.
2984 @end table
2985 @end deftp
2986
2987 @deftypefun void gpgme_set_io_cbs (@w{GpgmeCtx @var{ctx}}, @w{struct GpgmeIOCbs *@var{io_cbs}})
2988 The function @code{gpgme_set_io_cbs} enables the I/O callback
2989 interface for the context @var{ctx}.  The I/O callback functions are
2990 specified by @var{io_cbs}.
2991
2992 If @var{io_cbs}->@code{add} is @code{NULL}, the I/O callback interface
2993 is disabled for the context, and normal operation is restored.
2994 @end deftypefun
2995
2996 @deftypefun void gpgme_get_io_cbs (@w{GpgmeCtx @var{ctx}}, @w{struct GpgmeIOCbs *@var{io_cbs}})
2997 The function @code{gpgme_get_io_cbs} returns the I/O callback
2998 functions set with @code{gpgme_set_io_cbs} in @var{io_cbs}.
2999 @end deftypefun
3000
3001
3002 @node I/O Callback Example
3003 @subsubsection I/O Callback Example
3004
3005 To actually use an external event loop, you have to implement the I/O
3006 callback functions that are used by @acronym{GPGME} to register and
3007 unregister file descriptors.  Furthermore, you have to actually
3008 monitor these file descriptors for activity and call the appropriate
3009 I/O callbacks.
3010
3011 The following example illustrates how to do that.  The example uses
3012 locking to show in which way the the callbacks and the event loop can
3013 run concurrently.  For the event loop, we use a fixed array.  For a
3014 real-world implementation, you should use a dynamically sized
3015 structure because the number of file descriptors needed for a crypto
3016 operation in @acronym{GPGME} is not predictable.
3017
3018 @example
3019 #include <pthread.h>
3020 #include <sys/types.h>
3021 #include <gpgme.h>
3022
3023 /* The following structure holds the result of a crypto operation.  */
3024 struct op_result
3025 @{
3026   int done;
3027   GpgmeError err;
3028 @};
3029
3030 /* The following structure holds the data associated with one I/O
3031 callback.  */
3032 struct one_fd
3033 @{
3034   int fd;
3035   int dir;
3036   GpgmeIOCb fnc;
3037   void *fnc_data;
3038 @};
3039
3040 struct event_loop
3041 @{
3042   pthread_mutex_t lock;
3043 #define MAX_FDS 32
3044   /* Unused slots are marked with FD being -1.  */
3045   struct one_fd fds[MAX_FDS];
3046 @};
3047 @end example
3048
3049 The following functions implement the I/O callback interface.
3050
3051 @example
3052 GpgmeError
3053 add_io_cb (void *data, int fd, int dir, GpgmeIOCb fnc, void *fnc_data,
3054            void **r_tag)
3055 @{
3056   struct event_loop *loop = data;
3057   struct one_fd *fds = loop->fds;
3058   int i;
3059
3060   pthread_mutex_lock (&loop->lock);
3061   for (i = 0; i < MAX_FDS; i++)
3062     @{
3063       if (fds[i].fd == -1)
3064         @{
3065           fds[i].fd = fd;
3066           fds[i].dir = dir;
3067           fds[i].fnc = fnc;
3068           fds[i].fnc_data = fnc_data;
3069           break;
3070         @}
3071     @}
3072   pthread_mutex_unlock (&loop->lock);
3073   if (i == MAX_FDS)
3074     return GPGME_General_Error;
3075   *r_tag = &fds[i];
3076   return 0;
3077 @}
3078
3079 void
3080 remove_io_cb (void *tag)
3081 @{
3082   struct one_fd *fd = tag;
3083
3084   pthread_mutex_lock (&loop->lock);
3085   fd->fd = -1;
3086   pthread_mutex_unlock (&loop->lock);
3087 @}
3088
3089 void
3090 event_io_cb (void *data, GpgmeEventIO type, void *type_data)
3091 @{
3092   struct op_result *result = data;
3093   GpgmeError *err = data;
3094
3095   /* We don't support list operations here.  */
3096   if (type == GPGME_EVENT_DONE)
3097     @{
3098       result->done = 1;
3099       result->err = *data;
3100     @}
3101 @}
3102 @end example
3103
3104 The final missing piece is the event loop, which will be presented
3105 next.  We only support waiting for the success of a single operation.
3106
3107 @example
3108 int
3109 do_select (struct event_loop *loop)
3110 @{
3111   fd_set rfds;
3112   fd_set wfds;
3113   int i, n;
3114   int any = 0;
3115
3116   pthread_mutex_lock (&loop->lock);
3117   FD_ZERO (&rfds);
3118   FD_ZERO (&wfds);
3119   for (i = 0; i < FDLIST_MAX; i++)
3120     if (fdlist[i].fd != -1)
3121       FD_SET (fdlist[i].fd, fdlist[i].dir ? &rfds : &wfds);
3122   pthread_mutex_unlock (&loop->unlock);
3123
3124   do
3125     @{
3126       n = select (FD_SETSIZE, &rfds, &wfds, NULL, 0);
3127     @}
3128   while (n < 0 && errno == EINTR);
3129
3130   if (n < 0)
3131     return n;   /* Error or timeout.  */
3132
3133   pthread_mutex_lock (&loop->lock);
3134   for (i = 0; i < FDLIST_MAX && n; i++)
3135     @{
3136       if (fdlist[i].fd != -1)
3137         @{
3138           if (FD_ISSET (fdlist[i].fd, fdlist[i].dir ? &rfds : &wfds))
3139             @{
3140               assert (n);
3141               n--;
3142               any = 1;
3143               /* The I/O callback handler can register/remove callbacks,
3144                  so we have to unlock the file descriptor list.  */
3145               pthread_mutex_unlock (&loop->lock);
3146               (*fdlist[i].fnc) (fdlist[i].fnc_data, fdlist[i].fd);
3147               pthread_mutex_lock (&loop->lock);
3148             @}
3149         @}
3150     @}
3151   pthread_mutex_unlock (&loop->lock);
3152   return any;
3153 @}
3154
3155 void
3156 wait_for_op (struct event_loop *loop, struct op_result *result)
3157 @{
3158   int ret;
3159
3160   do
3161     @{
3162       ret = do_select (loop);
3163     @}
3164   while (ret >= 0 && !result->done);
3165   return ret;
3166 @}
3167 @end example
3168
3169 The main function shows how to put it all together.
3170
3171 @example
3172 int
3173 main (int argc, char *argv[])
3174 @{
3175   struct event_loop loop;
3176   struct op_result result;
3177   GpgmeCtx ctx;
3178   GpgmeError err;
3179   GpgmeData sig, text;
3180   GpgmeSigStat status;
3181   int i;
3182   struct GpgmeIOCbs io_cbs =
3183   @{
3184     add_io_cb,
3185     &loop,
3186     remove_io_cb,
3187     event_io_cb,
3188     &result
3189   @};
3190
3191   /* Initialize the loop structure.  */
3192   loop.lock = PTHREAD_MUTEX_INITIALIZER;
3193   for (i = 0; i < MAX_FDS; i++)
3194     loop->fds[i].fd = -1;
3195
3196   /* Initialize the result structure.  */
3197   result.done = 0;
3198
3199   err = gpgme_data_new_from_file (&sig, "signature", 1);
3200   if (!err)
3201     err = gpgme_data_new_from_file (&text, "text", 1);
3202   if (!err)
3203     err = gpgme_new (&ctx);
3204   if (!err)
3205     @{
3206        gpgme_set_io_cbs (ctx, &io_cbs);
3207        err = gpgme_op_verify_start (ctx, sig, text, &status);
3208     @}
3209   if (err)
3210     @{
3211       fprintf (stderr, "gpgme error: %s\n", gpgme_strerror (err));
3212       exit (1);
3213     @}
3214
3215   wait_for_op (&loop, &result);
3216   if (!result.done)
3217     @{
3218       fprintf (stderr, "select error\n");
3219       exit (1);
3220     @}
3221   if (!result.err)
3222     @{
3223       fprintf (stderr, "verification failed: %s\n", gpgme_strerror (result.err));
3224       exit (1);
3225     @}
3226   /* Evaluate STATUS.  */
3227   @dots{}
3228   return 0;
3229 @}
3230 @end example
3231
3232
3233 @node I/O Callback Example GTK+
3234 @subsubsection I/O Callback Example GTK+
3235 @cindex GTK+, using @acronym{GPGME} with
3236
3237 The I/O callback interface can be used to integrate @acronym{GPGME}
3238 with the GTK+ event loop.  The following code snippets shows how this
3239 can be done using the appropriate register and remove I/O callback
3240 functions.  In this example, the private data of the register I/O
3241 callback function is unused.  The event notifications is missing
3242 because it does not require any GTK+ specific setup.
3243
3244 @example
3245 #include <gtk/gtk.h>
3246
3247 struct my_gpgme_io_cb
3248 @{
3249   GpgmeIOCb fnc;
3250   void *fnc_data;
3251   guint input_handler_id
3252 @};
3253
3254 void
3255 my_gpgme_io_cb (gpointer data, gint source, GdkInputCondition condition)
3256 @{
3257   struct my_gpgme_io_cb *iocb = data;
3258   (*(iocb->fnc)) (iocb->data, source);
3259 @}
3260
3261 void
3262 my_gpgme_remove_io_cb (void *data)
3263 @{
3264   struct my_gpgme_io_cb *iocb = data;
3265   gtk_input_remove (data->input_handler_id);
3266 @}
3267
3268 void
3269 my_gpgme_register_io_callback (void *data, int fd, int dir, GpgmeIOCb fnc,
3270                                void *fnc_data, void **tag)
3271 @{
3272   struct my_gpgme_io_cb *iocb = g_malloc (sizeof (struct my_gpgme_io_cb));
3273   iocb->fnc = fnc;
3274   iocb->data = fnc_data;
3275   iocb->input_handler_id = gtk_input_add_full (fd, dir
3276                                                    ? GDK_INPUT_READ
3277                                                    : GDK_INPUT_WRITE,
3278                                                my_gpgme_io_callback,
3279                                                0, iocb, NULL);
3280   *tag = iocb;
3281   return 0;
3282 @}
3283 @end example
3284
3285
3286 @node I/O Callback Example GDK
3287 @subsubsection I/O Callback Example GDK
3288 @cindex GDK, using @acronym{GPGME} with
3289
3290 The I/O callback interface can also be used to integrate
3291 @acronym{GPGME} with the GDK event loop.  The following code snippets
3292 shows how this can be done using the appropriate register and remove
3293 I/O callback functions.  In this example, the private data of the
3294 register I/O callback function is unused.  The event notifications is
3295 missing because it does not require any GDK specific setup.
3296
3297 It is very similar to the GTK+ example in the previous section.
3298
3299 @example
3300 #include <gdk/gdk.h>
3301
3302 struct my_gpgme_io_cb
3303 @{
3304   GpgmeIOCb fnc;
3305   void *fnc_data;
3306   gint tag;
3307 @};
3308
3309 void
3310 my_gpgme_io_cb (gpointer data, gint source, GdkInputCondition condition)
3311 @{
3312   struct my_gpgme_io_cb *iocb = data;
3313   (*(iocb->fnc)) (iocb->data, source);
3314 @}
3315
3316 void
3317 my_gpgme_remove_io_cb (void *data)
3318 @{
3319   struct my_gpgme_io_cb *iocb = data;
3320   gdk_input_remove (data->tag);
3321 @}
3322
3323 void
3324 my_gpgme_register_io_callback (void *data, int fd, int dir, GpgmeIOCb fnc,
3325                                void *fnc_data, void **tag)
3326 @{
3327   struct my_gpgme_io_cb *iocb = g_malloc (sizeof (struct my_gpgme_io_cb));
3328   iocb->fnc = fnc;
3329   iocb->data = fnc_data;
3330   iocb->tag = gtk_input_add_full (fd, dir ? GDK_INPUT_READ : GDK_INPUT_WRITE,
3331                                   my_gpgme_io_callback, iocb, NULL);
3332   *tag = iocb;
3333   return 0;
3334 @}
3335 @end example
3336
3337
3338 @include gpl.texi
3339
3340
3341 @include fdl.texi
3342
3343
3344 @node Concept Index
3345 @unnumbered Concept Index
3346
3347 @printindex cp
3348
3349
3350 @node Function and Data Index
3351 @unnumbered Function and Data Index
3352
3353 @printindex fn
3354
3355
3356 @summarycontents
3357 @contents
3358 @bye