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