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