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