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