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