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