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 * @acronym{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 * @acronym{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 @node @acronym{ASCII} Armor
1542 @subsection @acronym{ASCII} Armor
1543 @cindex context, armor mode
1544 @cindex @acronym{ASCII} armor
1545 @cindex armor mode
1546
1547 @deftypefun void gpgme_set_armor (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
1548 The function @code{gpgme_set_armor} specifies if the output should be
1549 @acronym{ASCII} armored.  By default, output is not @acronym{ASCII}
1550 armored.
1551
1552 @acronym{ASCII} armored output is disabled if @var{yes} is zero, and
1553 enabled otherwise.
1554 @end deftypefun
1555
1556 @deftypefun int gpgme_get_armor (@w{gpgme_ctx_t @var{ctx}})
1557 The function @code{gpgme_get_armor} returns 1 if the output is
1558 @acronym{ASCII} armored, and @code{0} if it is not, or if @var{ctx} is
1559 not a valid pointer.
1560 @end deftypefun
1561
1562
1563 @node Text Mode
1564 @subsection Text Mode
1565 @cindex context, text mode
1566 @cindex text mode
1567 @cindex canonical text mode
1568
1569 @deftypefun void gpgme_set_textmode (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
1570 The function @code{gpgme_set_textmode} specifies if canonical text mode
1571 should be used.  By default, text mode is not used.
1572
1573 Text mode is for example used for the RFC2015 signatures; note that
1574 the updated RFC 3156 mandates that the mail user agent does some
1575 preparations so that text mode is not needed anymore.
1576
1577 This option is only relevant to the OpenPGP crypto engine, and ignored
1578 by all other engines.
1579
1580 Canonical text mode is disabled if @var{yes} is zero, and enabled
1581 otherwise.
1582 @end deftypefun
1583
1584 @deftypefun int gpgme_get_textmode (@w{gpgme_ctx_t @var{ctx}})
1585 The function @code{gpgme_get_textmode} returns 1 if canonical text
1586 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
1587 valid pointer.
1588 @end deftypefun
1589
1590
1591 @node Included Certificates
1592 @subsection Included Certificates
1593 @cindex certificates, included
1594
1595 @deftypefun void gpgme_set_include_certs (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{nr_of_certs}})
1596 The function @code{gpgme_set_include_certs} specifies how many
1597 certificates should be included in an S/MIME signed message.  By
1598 default, only the sender's certificate is included.  The possible
1599 values of @var{nr_of_certs} are:
1600
1601 @table @code
1602 @item -2
1603 Include all certificates except the root certificate.
1604 @item -1
1605 Include all certificates.
1606 @item 0
1607 Include no certificates.
1608 @item 1
1609 Include the sender's certificate only.
1610 @item n
1611 Include the first n certificates of the certificates path, starting
1612 from the sender's certificate.  The number @code{n} must be positive.
1613 @end table
1614
1615 Values of @var{nr_of_certs} smaller than -2 are undefined.
1616
1617 This option is only relevant to the CMS crypto engine, and ignored
1618 by all other engines.
1619 @end deftypefun
1620
1621 @deftypefun int gpgme_get_include_certs (@w{gpgme_ctx_t @var{ctx}})
1622 The function @code{gpgme_get_include_certs} returns the number of
1623 certificates to include into an S/MIME signed message.
1624 @end deftypefun
1625
1626
1627 @node Key Listing Mode
1628 @subsection Key Listing Mode
1629 @cindex key listing mode
1630 @cindex key listing, mode of
1631
1632 @deftypefun void gpgme_set_keylist_mode (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{mode}})
1633 The function @code{gpgme_set_keylist_mode} changes the default
1634 behaviour of the key listing functions.  The value in @var{mode} is a
1635 bitwise-or combination of one or multiple of the following bit values:
1636
1637 @table @code
1638 @item GPGME_KEYLIST_MODE_LOCAL
1639 The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
1640 keyring should be searched for keys in the keylisting operation.  This
1641 is the default.
1642
1643 @item GPGME_KEYLIST_MODE_EXTERN
1644 The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
1645 source should be should be searched for keys in the keylisting
1646 operation.  The type of external source is dependant on the crypto
1647 engine used.  For example, it can be a remote keyserver or LDAP
1648 certificate server.
1649
1650 @item GPGME_KEYLIST_MODE_SIGS
1651 The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key
1652 signatures should be included in the listed keys.
1653 @end table
1654
1655 At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
1656 @code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
1657 compatibility, you should get the current mode with
1658 @code{gpgme_get_keylist_mode} and modify it by setting or clearing the
1659 appropriate bits, and then using that calulcated value in the
1660 @code{gpgme_set_keylisting_mode} operation.  This will leave all other
1661 bits in the mode value intact (in particular those that are not used
1662 in the current version of the library).
1663
1664 The function returns @code{GPGME_No_Error} if the mode could be set
1665 correctly, and @code{GPGME_Invalid_Value} if @var{ctx} is not a valid
1666 pointer or @var{mode} is not a valid mode.
1667 @end deftypefun
1668
1669
1670 @deftypefun int gpgme_get_keylist_mode (@w{gpgme_ctx_t @var{ctx}})
1671 The function @code{gpgme_get_keylist_mode} returns the current key
1672 listing mode of the context @var{ctx}.  This value can then be
1673 modified and used in a subsequent @code{gpgme_set_keylist_mode}
1674 operation to only affect the desired bits (and leave all others
1675 intact).
1676
1677 The function returns 0 if @var{ctx} is not a valid pointer, and the
1678 current mode otherwise.  Note that 0 is not a valid mode value.
1679 @end deftypefun
1680
1681
1682 @node Passphrase Callback
1683 @subsection Passphrase Callback
1684 @cindex callback, passphrase
1685 @cindex passphrase callback
1686
1687 @deftp {Data type} {gpgme_error_t (*gpgme_passphrase_cb_t)(void *@var{hook}, const char *@var{uid_hint}, const char *@var{passphrase_info}, @w{int @var{prev_was_bad}}, @w{int @var{fd}})}
1688 @tindex gpgme_passphrase_cb_t
1689 The @code{gpgme_passphrase_cb_t} type is the type of functions usable as
1690 passphrase callback function.
1691
1692 The argument @var{uid_hint} might contain a string that gives an
1693 indication for which user ID the passphrase is required.  If this is
1694 not available, or not applicable (in the case of symmetric encryption,
1695 for example), @var{uid_hint} will be @code{NULL}.
1696
1697 The argument @var{passphrase_info}, if not @code{NULL}, will give
1698 further information about the context in which the passphrase is
1699 required.  This information is engine and operation specific.
1700
1701 If this is the repeated attempt to get the passphrase, because
1702 previous attempts failed, then @var{prev_was_bad} is 1, otherwise it
1703 will be 0.
1704
1705 The user must write the passphrase, followed by a newline character,
1706 to the file descriptor @var{fd}.  If the user does not return 0
1707 indicating success, the user must at least write a newline character
1708 before returning from the callback.
1709
1710 If an error occurs, return the corresponding @code{gpgme_error_t} value.
1711 You can use @code{GPGME_Canceled} to abort the operation.  Otherwise,
1712 return @code{0}.
1713 @end deftp
1714
1715 @deftypefun void gpgme_set_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t @var{passfunc}}, @w{void *@var{hook_value}})
1716 The function @code{gpgme_set_passphrase_cb} sets the function that is
1717 used when a passphrase needs to be provided by the user to
1718 @var{passfunc}.  The function @var{passfunc} needs to implemented by
1719 the user, and whenever it is called, it is called with its first
1720 argument being @var{hook_value}.  By default, no passphrase callback
1721 function is set.
1722
1723 Not all crypto engines require this callback to retrieve the
1724 passphrase.  It is better if the engine retrieves the passphrase from
1725 a trusted agent (a daemon process), rather than having each user to
1726 implement their own passphrase query.
1727
1728 The user can disable the use of a passphrase callback function by
1729 calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
1730 @code{NULL}.
1731 @end deftypefun
1732
1733 @deftypefun void gpgme_get_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t *@var{passfunc}}, @w{void **@var{hook_value}})
1734 The function @code{gpgme_get_passphrase_cb} returns the function that
1735 is used when a passphrase needs to be provided by the user in
1736 @var{*passfunc}, and the first argument for this function in
1737 @var{*hook_value}.  If no passphrase callback is set, or @var{ctx} is
1738 not a valid pointer, @code{NULL} is returned in both variables.
1739
1740 @var{passfunc} or @var{hook_value} can be @code{NULL}.  In this case,
1741 the corresponding value will not be returned.
1742 @end deftypefun
1743
1744
1745 @node Progress Meter Callback
1746 @subsection Progress Meter Callback
1747 @cindex callback, progress meter
1748 @cindex progress meter callback
1749
1750 @deftp {Data type} {const char *(*gpgme_progress_cb_t)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
1751 @tindex gpgme_progress_cb_t
1752 The @code{gpgme_progress_cb_t} type is the type of functions usable as
1753 progress callback function.
1754
1755 The arguments are specific to the crypto engine.  More information
1756 about the progress information returned from the GnuPG engine can be
1757 found in the GnuPG source code in the file @file{doc/DETAILS} in the
1758 section PROGRESS.
1759 @end deftp
1760
1761 @deftypefun void gpgme_set_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t @var{progfunc}}, @w{void *@var{hook_value}})
1762 The function @code{gpgme_set_progress_cb} sets the function that is
1763 used when progress information about a cryptographic operation is
1764 available.  The function @var{progfunc} needs to implemented by the
1765 user, and whenever it is called, it is called with its first argument
1766 being @var{hook_value}.  By default, no progress callback function
1767 is set.
1768
1769 Setting a callback function allows an interactive program to display
1770 progress information about a long operation to the user.
1771
1772 The user can disable the use of a progress callback function by
1773 calling @code{gpgme_set_progress_cb} with @var{progfunc} being
1774 @code{NULL}.
1775 @end deftypefun
1776
1777 @deftypefun void gpgme_get_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t *@var{progfunc}}, @w{void **@var{hook_value}})
1778 The function @code{gpgme_get_progress_cb} returns the function that is
1779 used to inform the user about the progress made in @var{*progfunc},
1780 and the first argument for this function in @var{*hook_value}.  If no
1781 progress callback is set, or @var{ctx} is not a valid pointer,
1782 @code{NULL} is returned in both variables.
1783
1784 @var{progfunc} or @var{hook_value} can be @code{NULL}.  In this case,
1785 the corresponding value will not be returned.
1786 @end deftypefun
1787
1788
1789 @node Key Management
1790 @section Key Management
1791 @cindex key management
1792
1793 Some of the cryptographic operations require that recipients or
1794 signers are specified.  This is always done by specifying the
1795 respective keys that should be used for the operation.  The following
1796 section describes how such keys can be selected and manipulated.
1797
1798 @deftp {Data type} gpgme_sub_key_t
1799 The @code{gpgme_sub_key_t} type is a pointer to a subkey structure.  Sub
1800 keys are one component of a @code{gpgme_key_t} object.  In fact, subkeys
1801 are those parts that contains the real information about the
1802 individual cryptographic keys that belong to the same key object.  One
1803 @code{gpgme_key_t} can contain several subkeys.  The first subkey in the
1804 linked list is also called the primary key.
1805
1806 The subkey structure has the following members:
1807
1808 @table @code
1809 @item gpgme_sub_key_t next
1810 This is a pointer to the next subkey structure in the linked list, or
1811 @code{NULL} if this is the last element.
1812
1813 @item unsigned int revoked : 1
1814 This is true if the subkey is revoked.
1815
1816 @item unsigned int expired : 1
1817 This is true if the subkey is expired.
1818
1819 @item unsigned int disabled : 1
1820 This is true if the subkey is disabled.
1821
1822 @item unsigned int invalid : 1
1823 This is true if the subkey is invalid.
1824
1825 @item unsigned int can_encrypt : 1
1826 This is true if the subkey can be used for encryption.
1827
1828 @item unsigned int can_sign : 1
1829 This is true if the subkey can be used for signing.
1830
1831 @item unsigned int can_certify : 1
1832 This is true if the subkey can be used for certification.
1833
1834 @item unsigned int secret : 1
1835 This is true if the subkey is a secret key.
1836
1837 @item gpgme_pubkey_algo_t pubkey_algo
1838 This is the public key algorithm supported by this subkey.
1839
1840 @item unsigned int length
1841 This is the length of the subkey (in bits).
1842
1843 @item char *keyid
1844 This is the key ID of the subkey in hexadecimal digits.
1845
1846 @item char *fpr
1847 This is the fingerprint of the subkey in hexadecimal digits, if
1848 available.  This is usually only available for the primary key.
1849
1850 @item long int timestamp
1851 This is the creation timestamp of the subkey.  This is -1 if the
1852 timestamp is invalid, and 0 if it is not available.
1853
1854 @item long int expires
1855 This is the expiration timestamp of the subkey, or 0 if the subkey
1856 does not expire.
1857 @end table
1858 @end deftp
1859
1860 @deftp {Data type} gpgme_key_sig_t
1861 The @code{gpgme_key_sig_t} type is a pointer to a key signature structure.
1862 Key signatures are one component of a @code{gpgme_key_t} object, and
1863 validate user IDs on the key.
1864
1865 The signatures on a key are only available if the key was retrieved
1866 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
1867 enabled, because it is expensive to retrieve all signatures of a key.
1868
1869 The key signature structure has the following members:
1870
1871 @table @code
1872 @item gpgme_key_sig_t next
1873 This is a pointer to the next key signature structure in the linked
1874 list, or @code{NULL} if this is the last element.
1875
1876 @item unsigned int revoked : 1
1877 This is true if the key signature is a revocation signature.
1878
1879 @item unsigned int expired : 1
1880 This is true if the key signature is expired.
1881
1882 @item unsigned int invalid : 1
1883 This is true if the key signature is invalid.
1884
1885 @item unsigned int disabled : 1
1886 This is true if the key signature is exportable.
1887
1888 @item gpgme_pubkey_algo_t pubkey_algo
1889 This is the public key algorithm used to create the signature.
1890
1891 @item char *keyid
1892 This is the key ID of the key (in hexadecimal digits) used to create
1893 the signature.
1894
1895 @item long int timestamp
1896 This is the creation timestamp of the key signature.  This is -1 if
1897 the timestamp is invalid, and 0 if it is not available.
1898
1899 @item long int expires
1900 This is the expiration timestamp of the key signature, or 0 if the key
1901 signature does not expire.
1902
1903 @item gpgme_error_t status
1904 This is the status of the signature and has the same meaning as the
1905 member of the same name in a @code{gpgme_signature_t} object.
1906
1907 @item unsigned int class
1908 This specifies the signature class of the key signature.  The meaning
1909 is specific to the crypto engine.
1910
1911 @item char *uid
1912 This is the main user ID of the key used to create the signature.
1913
1914 @item char *name
1915 This is the name component of @code{uid}, if available.
1916
1917 @item char *comment
1918 This is the comment component of @code{uid}, if available.
1919
1920 @item char *email
1921 This is the email component of @code{uid}, if available.
1922 @end table
1923 @end deftp
1924
1925 @deftp {Data type} gpgme_user_id_t
1926 A user ID is a component of a @code{gpgme_key_t} object.  One key can
1927 have many user IDs.  The first one in the list is the main (or
1928 primary) user ID.
1929
1930 The user ID structure has the following members.
1931
1932 @table @code
1933 @item gpgme_user_id_t next
1934 This is a pointer to the next user ID structure in the linked list, or
1935 @code{NULL} if this is the last element.
1936
1937 @item unsigned int revoked : 1
1938 This is true if the user ID is revoked.
1939
1940 @item unsigned int invalid : 1
1941 This is true if the user ID is invalid.
1942
1943 @item gpgme_validity_t validity
1944 This specifies the validity of the user ID.
1945
1946 @item char *uid
1947 This is the user ID string.
1948
1949 @item char *name
1950 This is the name component of @code{uid}, if available.
1951
1952 @item char *comment
1953 This is the comment component of @code{uid}, if available.
1954
1955 @item char *email
1956 This is the email component of @code{uid}, if available.
1957
1958 @item gpgme_key_sig_t signatures
1959 This is a linked list with the signatures on this user ID.
1960 @end table
1961 @end deftp
1962
1963 @deftp {Data type} gpgme_key_t
1964 The @code{gpgme_key_t} type is a pointer to a key object.  It has the
1965 following members:
1966
1967 @table @code
1968 @item unsigned int revoked : 1
1969 This is true if the key is revoked.
1970
1971 @item unsigned int expired : 1
1972 This is true if the key is expired.
1973
1974 @item unsigned int disabled : 1
1975 This is true if the key is disabled.
1976
1977 @item unsigned int invalid : 1
1978 This is true if the key is invalid.
1979
1980 @item unsigned int can_encrypt : 1
1981 This is true if the key (ie one of its subkeys) can be used for
1982 encryption.
1983
1984 @item unsigned int can_sign : 1
1985 This is true if the key (ie one of its subkeys) can be used for
1986 signing.
1987
1988 @item unsigned int can_certify : 1
1989 This is true if the key (ie one of its subkeys) can be used for
1990 certification.
1991
1992 @item unsigned int secret : 1
1993 This is true if the key is a secret key.
1994
1995 @item gpgme_protocol_t protocol
1996 This is the protocol supported by this key.
1997
1998 @item char *issuer_serial
1999 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
2000 issuer serial.
2001
2002 @item char *issuer_name
2003 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
2004 issuer name.
2005
2006 @item char *chain_id
2007 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
2008 chain ID, which can be used to built the certificate chain.
2009  
2010 @item gpgme_validity_t owner_trust
2011 If @code{protocol} is @code{GPGME_PROTOCOL_OpenPGP}, then this is the
2012 owner trust.
2013
2014 @item gpgme_sub_key_t subkeys
2015 This is a linked list with the subkeys of the key.  The first subkey
2016 in the list is the primary key and usually available.
2017
2018 @item gpgme_user_id_t uids
2019 This is a linked list with the user IDs of the key.  The first user ID
2020 in the list is the main (or primary) user ID.
2021 @end table
2022 @end deftp
2023
2024 @menu
2025 * Listing Keys::                  Browsing the list of available keys.
2026 * Information About Keys::        Requesting detailed information about keys.
2027 * Key Signatures::                Listing the signatures on a key.
2028 * Manipulating Keys::             Operations on keys.
2029 * Generating Keys::               Creating new key pairs.
2030 * Exporting Keys::                Retrieving key data from the key ring.
2031 * Importing Keys::                Adding keys to the key ring.
2032 * Deleting Keys::                 Removing keys from the key ring.
2033 @end menu
2034
2035
2036 @node Listing Keys
2037 @subsection Listing Keys
2038 @cindex listing keys
2039 @cindex key listing
2040 @cindex key listing, start
2041 @cindex key ring, list
2042 @cindex key ring, search
2043
2044 @deftypefun gpgme_error_t gpgme_op_keylist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
2045 The function @code{gpgme_op_keylist_start} initiates a key listing
2046 operation inside the context @var{ctx}.  It sets everything up so that
2047 subsequent invocations of @code{gpgme_op_keylist_next} return the keys
2048 in the list.
2049
2050 If @var{pattern} is @code{NULL}, all available keys are returned.
2051 Otherwise, @var{pattern} contains an engine specific expression that
2052 is used to limit the list to all keys matching the pattern.
2053
2054 If @var{secret_only} is not @code{0}, the list is restricted to secret
2055 keys only.
2056
2057 The context will be busy until either all keys are received (and
2058 @code{gpgme_op_keylist_next} returns @code{GPGME_EOF}), or
2059 @code{gpgme_op_keylist_end} is called to finish the operation.
2060
2061 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
2062 valid pointer, and passes through any errors that are reported by the
2063 crypto engine support routines.
2064 @end deftypefun
2065
2066 @deftypefun gpgme_error_t gpgme_op_keylist_ext_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}[]}, @w{int @var{secret_only}}, @w{int @var{reserved}})
2067 The function @code{gpgme_op_keylist_ext_start} initiates an extended
2068 key listing operation inside the context @var{ctx}.  It sets
2069 everything up so that subsequent invocations of
2070 @code{gpgme_op_keylist_next} return the keys in the list.
2071
2072 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
2073 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
2074 array of strings that are used to limit the list to all keys matching
2075 at least one of the patterns verbatim.
2076
2077 If @var{secret_only} is not @code{0}, the list is restricted to secret
2078 keys only.
2079
2080 The value of @var{reserved} must be @code{0}.
2081
2082 The context will be busy until either all keys are received (and
2083 @code{gpgme_op_keylist_next} returns @code{GPGME_EOF}), or
2084 @code{gpgme_op_keylist_end} is called to finish the operation.
2085
2086 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
2087 valid pointer, and passes through any errors that are reported by the
2088 crypto engine support routines.
2089 @end deftypefun
2090
2091 @deftypefun gpgme_error_t gpgme_op_keylist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{r_key}})
2092 The function @code{gpgme_op_keylist_next} returns the next key in the
2093 list created by a previous @code{gpgme_op_keylist_start} operation in
2094 the context @var{ctx}.  The key will have one reference for the user.
2095 @xref{Manipulating Keys}.
2096
2097 This is the only way to get at @code{gpgme_key_t} objects in
2098 @acronym{GPGME}.
2099
2100 If the last key in the list has already been returned,
2101 @code{gpgme_op_keylist_next} returns @code{GPGME_EOF}.
2102
2103 The function returns @code{GPGME_Invalid_Value} if @var{ctx} or
2104 @var{r_key} is not a valid pointer, and @code{GPGME_Out_Of_Core} if
2105 there is not enough memory for the operation.
2106 @end deftypefun
2107
2108 @deftypefun gpgme_error_t gpgme_op_keylist_end (@w{gpgme_ctx_t @var{ctx}})
2109 The function @code{gpgme_op_keylist_next} ends a pending key list
2110 operation in the context @var{ctx}.
2111
2112 After the operation completed successfully, the result of the key
2113 listing operation can be retrieved with
2114 @code{gpgme_op_keylist_result}.
2115
2116 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
2117 valid pointer, and @code{GPGME_Out_Of_Core} if at some time during the
2118 operation there was not enough memory available.
2119 @end deftypefun
2120
2121 The following example illustrates how all keys containing a certain
2122 string (@code{g10code}) can be listed with their key ID and the name
2123 and e-mail address of the main user ID:
2124
2125 @example
2126 gpgme_ctx_t ctx;
2127 gpgme_error_t err = gpgme_new (&ctx);
2128
2129 if (!err)
2130   @{
2131     err = gpgme_op_keylist_start (ctx, "g10code", 0);
2132     while (!err && (err = gpgme_op_keylist_next (ctx, &key)) != GPGME_EOF)
2133       @{
2134         printf ("%s: %s <%s>\n",
2135                 gpgme_key_get_string_attr (key, GPGME_ATTR_KEYID, 0, 0),
2136                 gpgme_key_get_string_attr (key, GPGME_ATTR_NAME, 0, 0),
2137                 gpgme_key_get_string_attr (key, GPGME_ATTR_EMAIL, 0, 0));
2138         gpgme_key_release (key);
2139       @}
2140     gpgme_release (ctx);
2141   @}
2142 if (err)
2143   @{
2144     fprintf (stderr, "%s: can not list keys: %s\n",
2145              argv[0], gpgme_strerror (err));
2146     exit (1);
2147   @}
2148 @end example
2149
2150 @deftp {Data type} {gpgme_keylist_result_t}
2151 This is a pointer to a structure used to store the result of a
2152 @code{gpgme_op_keylist_*} operation.  After successfully ending a key
2153 listing operation, you can retrieve the pointer to the result with
2154 @code{gpgme_op_keylist_result}.  The structure contains the following
2155 member:
2156
2157 @table @code
2158 @item unsigned int truncated : 1
2159 This is true if the crypto backend had to truncate the result, and
2160 less than the desired keys could be listed.
2161 @end table
2162 @end deftp
2163
2164 @deftypefun gpgme_keylist_result_t gpgme_op_keylist_result (@w{gpgme_ctx_t @var{ctx}})
2165 The function @code{gpgme_op_keylist_result} returns a
2166 @code{gpgme_keylist_result_t} pointer to a structure holding the result of
2167 a @code{gpgme_op_keylist_*} operation.  The pointer is only valid if
2168 the last operation on the context was a key listing operation, and if
2169 this operation finished successfully.  The returned pointer is only
2170 valid until the next operation is started on the context.
2171 @end deftypefun
2172
2173 In a simple program, for which a blocking operation is acceptable, the
2174 following function can be used to retrieve a single key.
2175
2176 @deftypefun gpgme_error_t gpgme_get_key (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{fpr}}, @w{gpgme_key_t *@var{r_key}}, @w{int @var{secret}})
2177 The function @code{gpgme_get_key} gets the key with the fingerprint
2178 (or key ID) @var{fpr} from the crypto backend and return it in
2179 @var{r_key}.  If @var{force_update} is true, force a refresh of the
2180 key from the crypto backend and replace the key in the cache, if any.
2181 If @var{secret} is true, get the secret key.  The currently active
2182 keylist mode is used to retrieve the key.
2183
2184 If the key is not found in the keyring, @code{gpgme_get_key} returns
2185 @code{GPGME_No_Error} and *@var{r_key} will be set to @code{NULL}.
2186
2187 The function returns @code{GPGME_Invalid_Value} if @var{ctx} or
2188 @var{r_key} is not a valid pointer, @code{GPGME_Invalid_Key} if
2189 @var{fpr} is not a fingerprint or key ID, @code{GPGME_Out_Of_Core} if
2190 at some time during the operation there was not enough memory
2191 available.
2192 @end deftypefun
2193
2194
2195 @node Information About Keys
2196 @subsection Information About Keys
2197 @cindex key, information about
2198 @cindex key, attributes
2199 @cindex attributes, of a key
2200
2201 Please see the beginning of this section for more information about
2202 @code{gpgme_key_t} objects.
2203
2204 @deftp {Data type} gpgme_validity_t
2205 The @code{gpgme_validity_t} type is used to specify the validity of a user ID
2206 in a key.  The following validities are defined:
2207
2208 @table @code
2209 @item GPGME_VALIDITY_UNKNOWN
2210 The user ID is of unknown validity.  The string representation of this
2211 validity is ``?''.
2212
2213 @item GPGME_VALIDITY_UNDEFINED
2214 The validity of the user ID is undefined.  The string representation of this
2215 validity is ``q''.
2216
2217 @item GPGME_VALIDITY_NEVER
2218 The user ID is never valid.  The string representation of this
2219 validity is ``n''.
2220
2221 @item GPGME_VALIDITY_MARGINAL
2222 The user ID is marginally valid.  The string representation of this
2223 validity is ``m''.
2224
2225 @item GPGME_VALIDITY_FULL
2226 The user ID is fully valid.  The string representation of this
2227 validity is ``f''.
2228
2229 @item GPGME_VALIDITY_ULTIMATE
2230 The user ID is ultimately valid.  The string representation of this
2231 validity is ``u''.
2232 @end table
2233 @end deftp
2234
2235
2236 The following interfaces are deprecated and only provided for backward
2237 compatibility.  Don't use them.  They will be removed in a future
2238 version of @acronym{GPGME}.
2239
2240 @deftp {Data type} gpgme_attr_t
2241 The @code{gpgme_attr_t} type is used to specify a key or trust item
2242 attribute.  The following attributes are defined:
2243
2244 @table @code
2245 @item GPGME_ATTR_KEYID
2246 This is the key ID of a sub key.  It is representable as a string.
2247
2248 For trust items, the trust item refers to the key with this ID.
2249
2250 @item GPGME_ATTR_FPR
2251 This is the fingerprint of a sub key.  It is representable as a
2252 string.
2253
2254 @item GPGME_ATTR_ALGO
2255 This is the crypto algorithm for which the sub key can be used.  It
2256 is representable as a string and as a number.  The numbers correspond
2257 to the @code{enum gcry_pk_algos} values in the gcrypt library.
2258
2259 @item GPGME_ATTR_LEN
2260 This is the key length of a sub key.  It is representable as a
2261 number.
2262
2263 @item GPGME_ATTR_CREATED
2264 This is the timestamp at creation time of a sub key.  It is
2265 representable as a number.
2266
2267 @item GPGME_ATTR_EXPIRE
2268 This is the expiration time of a sub key.  It is representable as a
2269 number.
2270
2271 @item GPGME_ATTR_OTRUST
2272 XXX FIXME  (also for trust items)
2273
2274 @item GPGME_ATTR_USERID
2275 This is a user ID.  There can be more than one user IDs in a
2276 @var{gpgme_key_t} object.  The first one (with index 0) is the primary
2277 user ID.  The user ID is representable as a number.
2278
2279 For trust items, this is the user ID associated with this trust item.
2280
2281 @item GPGME_ATTR_NAME
2282 This is the name belonging to a user ID.  It is representable as a string.
2283
2284 @item GPGME_ATTR_EMAIL
2285 This is the email address belonging to a user ID.  It is representable
2286 as a string.
2287
2288 @item GPGME_ATTR_COMMENT
2289 This is the comment belonging to a user ID.  It is representable as a
2290 string.
2291
2292 @item GPGME_ATTR_VALIDITY
2293 This is the validity belonging to a user ID.  It is representable as a
2294 string and as a number.  See below for a list of available validities.
2295
2296 For trust items, this is the validity that is associated with this
2297 trust item.
2298
2299 @item GPGME_ATTR_UID_REVOKED
2300 This specifies if a user ID is revoked.  It is representable as a
2301 number, and is @code{1} if the user ID is revoked, and @code{0}
2302 otherwise.
2303
2304 @item GPGME_ATTR_UID_INVALID
2305 This specifies if a user ID is invalid.  It is representable as a
2306 number, and is @code{1} if the user ID is invalid, and @code{0}
2307 otherwise.
2308
2309 @item GPGME_ATTR_LEVEL
2310 This is the trust level of a trust item.
2311
2312 @item GPGME_ATTR_TYPE
2313 This returns information about the type of key.  For the string function
2314 this will eother be "PGP" or "X.509".  The integer function returns 0
2315 for PGP and 1 for X.509.  It is also used for the type of a trust item.
2316
2317 @item GPGME_ATTR_IS_SECRET
2318 This specifies if the key is a secret key.  It is representable as a
2319 number, and is @code{1} if the key is revoked, and @code{0} otherwise.
2320
2321 @item GPGME_ATTR_KEY_REVOKED
2322 This specifies if a sub key is revoked.  It is representable as a
2323 number, and is @code{1} if the key is revoked, and @code{0} otherwise.
2324
2325 @item GPGME_ATTR_KEY_INVALID
2326 This specifies if a sub key is invalid.  It is representable as a
2327 number, and is @code{1} if the key is invalid, and @code{0} otherwise.
2328
2329 @item GPGME_ATTR_KEY_EXPIRED
2330 This specifies if a sub key is expired.  It is representable as a
2331 number, and is @code{1} if the key is expired, and @code{0} otherwise.
2332
2333 @item GPGME_ATTR_KEY_DISABLED
2334 This specifies if a sub key is disabled.  It is representable as a
2335 number, and is @code{1} if the key is disabled, and @code{0} otherwise.
2336
2337 @item GPGME_ATTR_KEY_CAPS
2338 This is a description of the capabilities of a sub key.  It is
2339 representable as a string.  The string contains the letter ``e'' if
2340 the key can be used for encryption, ``s'' if the key can be used for
2341 signatures, and ``c'' if the key can be used for certifications.
2342
2343 @item GPGME_ATTR_CAN_ENCRYPT
2344 This specifies if a sub key can be used for encryption.  It is
2345 representable as a number, and is @code{1} if the sub key can be used
2346 for encryption, and @code{0} otherwise.
2347
2348 @item GPGME_ATTR_CAN_SIGN
2349 This specifies if a sub key can be used for signatures.  It is
2350 representable as a number, and is @code{1} if the sub key can be used
2351 for signatures, and @code{0} otherwise.
2352
2353 @item GPGME_ATTR_CAN_CERTIFY
2354 This specifies if a sub key can be used for certifications.  It is
2355 representable as a number, and is @code{1} if the sub key can be used
2356 for certifications, and @code{0} otherwise.
2357
2358 @item GPGME_ATTR_SERIAL
2359 The X.509 issuer serial attribute of the key.  It is representable as
2360 a string.
2361
2362 @item GPGME_ATTR_ISSUE
2363 The X.509 issuer name attribute of the key.  It is representable as a
2364 string.
2365
2366 @item GPGME_ATTR_CHAINID
2367 The X.509 chain ID can be used to build the certification chain.  It
2368 is representable as a string.
2369 @end table
2370 @end deftp
2371
2372 @deftypefun {const char *} gpgme_key_get_string_attr (@w{gpgme_key_t @var{key}}, @w{gpgme_attr_t @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
2373 The function @code{gpgme_key_get_string_attr} returns the value of the
2374 string-representable attribute @var{what} of key @var{key}.  If the
2375 attribute is an attribute of a sub key or an user ID, @var{idx}
2376 specifies the sub key or user ID of which the attribute value is
2377 returned.  The argument @var{reserved} is reserved for later use and
2378 should be @code{NULL}.
2379
2380 The string returned is only valid as long as the key is valid.
2381
2382 The function returns @code{0} if an attribute can't be returned as a
2383 string, @var{key} is not a valid pointer, @var{idx} out of range,
2384 or @var{reserved} not @code{NULL}.
2385 @end deftypefun
2386
2387 @deftypefun {unsigned long} gpgme_key_get_ulong_attr (@w{gpgme_key_t @var{key}}, @w{gpgme_attr_t @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
2388 The function @code{gpgme_key_get_ulong_attr} returns the value of the
2389 number-representable attribute @var{what} of key @var{key}.  If the
2390 attribute is an attribute of a sub key or an user ID, @var{idx}
2391 specifies the sub key or user ID of which the attribute value is
2392 returned.  The argument @var{reserved} is reserved for later use and
2393 should be @code{NULL}.
2394
2395 The function returns @code{0} if the attribute can't be returned as a
2396 number, @var{key} is not a valid pointer, @var{idx} out of range,
2397 or @var{reserved} not @code{NULL}.
2398 @end deftypefun
2399
2400
2401 @node Key Signatures
2402 @subsection Key Signatures
2403 @cindex key, signatures
2404 @cindex signatures, on a key
2405
2406 The following interfaces are deprecated and only provided for backward
2407 compatibility.  Don't use them.  They will be removed in a future
2408 version of @acronym{GPGME}.
2409
2410 The signatures on a key are only available if the key was retrieved
2411 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
2412 enabled, because it is expensive to retrieve all signatures of a key.
2413
2414 So, before using the below interfaces to retrieve the signatures on a
2415 key, you have to make sure that the key was listed with signatures
2416 enabled.  One convenient, but blocking, way to do this is to use the
2417 function @code{gpgme_get_key}.
2418
2419 @deftp {Data type} gpgme_attr_t
2420 The @code{gpgme_attr_t} type is used to specify a key signature
2421 attribute.  The following attributes are defined:
2422
2423 @table @code
2424 @item GPGME_ATTR_KEYID
2425 This is the key ID of the key which was used for the signature.  It is
2426 representable as a string.
2427
2428 @item GPGME_ATTR_ALGO
2429 This is the crypto algorithm used to create the signature.  It is
2430 representable as a string and as a number.  The numbers correspond to
2431 the @code{enum gcry_pk_algos} values in the gcrypt library.
2432
2433 @item GPGME_ATTR_CREATED
2434 This is the timestamp at creation time of the signature.  It is
2435 representable as a number.
2436
2437 @item GPGME_ATTR_EXPIRE
2438 This is the expiration time of the signature.  It is representable as
2439 a number.
2440
2441 @item GPGME_ATTR_USERID
2442 This is the user ID associated with the signing key.  The user ID is
2443 representable as a number.
2444
2445 @item GPGME_ATTR_NAME
2446 This is the name belonging to a user ID.  It is representable as a string.
2447
2448 @item GPGME_ATTR_EMAIL
2449 This is the email address belonging to a user ID.  It is representable
2450 as a string.
2451
2452 @item GPGME_ATTR_COMMENT
2453 This is the comment belonging to a user ID.  It is representable as a
2454 string.
2455
2456 @item GPGME_ATTR_KEY_REVOKED
2457 This specifies if a key signature is a revocation signature.  It is
2458 representable as a number, and is @code{1} if the key is revoked, and
2459 @code{0} otherwise.
2460
2461 @c @item GPGME_ATTR_KEY_EXPIRED
2462 @c This specifies if a key signature is expired.  It is representable as
2463 @c a number, and is @code{1} if the key is revoked, and @code{0}
2464 @c otherwise.
2465 @c
2466 @item GPGME_ATTR_SIG_CLASS
2467 This specifies the signature class of a key signature.  It is
2468 representable as a number.  The meaning is specific to the crypto
2469 engine.
2470
2471 @item GPGME_ATTR_SIG_CLASS
2472 This specifies the signature class of a key signature.  It is
2473 representable as a number.  The meaning is specific to the crypto
2474 engine.
2475
2476 @item GPGME_ATTR_SIG_STATUS
2477 This is the same value as returned by @code{gpgme_get_sig_status}.
2478 @end table
2479 @end deftp
2480
2481 @deftypefun {const char *} gpgme_key_sig_get_string_attr (@w{gpgme_key_t @var{key}}, @w{int @var{uid_idx}}, @w{gpgme_attr_t @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
2482 The function @code{gpgme_key_sig_get_string_attr} returns the value of
2483 the string-representable attribute @var{what} of the signature
2484 @var{idx} on the user ID @var{uid_idx} in the key @var{key}.  The
2485 argument @var{reserved} is reserved for later use and should be
2486 @code{NULL}.
2487
2488 The string returned is only valid as long as the key is valid.
2489
2490 The function returns @code{0} if an attribute can't be returned as a
2491 string, @var{key} is not a valid pointer, @var{uid_idx} or @var{idx}
2492 out of range, or @var{reserved} not @code{NULL}.
2493 @end deftypefun
2494
2495 @deftypefun {unsigned long} gpgme_key_sig_get_ulong_attr (@w{gpgme_key_t @var{key}}, @w{int @var{uid_idx}}, @w{gpgme_attr_t @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
2496 The function @code{gpgme_key_sig_get_ulong_attr} returns the value of
2497 the number-representable attribute @var{what} of the signature
2498 @var{idx} on the user ID @var{uid_idx} in the key @var{key}.  The
2499 argument @var{reserved} is reserved for later use and should be
2500 @code{NULL}.
2501
2502 The function returns @code{0} if an attribute can't be returned as a
2503 string, @var{key} is not a valid pointer, @var{uid_idx} or @var{idx}
2504 out of range, or @var{reserved} not @code{NULL}.
2505 @end deftypefun
2506
2507
2508 @node Manipulating Keys
2509 @subsection Manipulating Keys
2510 @cindex key, manipulation
2511
2512 @deftypefun void gpgme_key_ref (@w{gpgme_key_t @var{key}})
2513 The function @code{gpgme_key_ref} acquires an additional reference for
2514 the key @var{key}.
2515 @end deftypefun
2516
2517 @deftypefun void gpgme_key_unref (@w{gpgme_key_t @var{key}})
2518 The function @code{gpgme_key_unref} releases a reference for the key
2519 @var{key}.  If this was the last reference, the key will be destroyed
2520 and all resources associated to it will be released.
2521 @end deftypefun
2522
2523
2524 The following interface is deprecated and only provided for backward
2525 compatibility.  Don't use it.  It will be removed in a future version
2526 of @acronym{GPGME}.
2527
2528 @deftypefun void gpgme_key_release (@w{gpgme_key_t @var{key}})
2529 The function @code{gpgme_key_release} is equivalent to
2530 @code{gpgme_key_unref}.
2531 @end deftypefun
2532
2533
2534 @node Generating Keys
2535 @subsection Generating Keys
2536 @cindex key, creation
2537 @cindex key ring, add
2538
2539 @deftypefun gpgme_error_t gpgme_op_genkey (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{parms}}, @w{gpgme_data_t @var{public}}, @w{gpgme_data_t @var{secret}})
2540 The function @code{gpgme_op_genkey} generates a new key pair in the
2541 context @var{ctx}.  The meaning of @var{public} and @var{secret}
2542 depends on the crypto backend.
2543
2544 GnuPG does not support @var{public} and @var{secret}, they should be
2545 @code{NULL}.  GnuPG will generate a key pair and add it to the
2546 standard key ring.  The fingerprint of the generated key is available
2547 with @code{gpgme_op_genkey_result}.
2548
2549 GpgSM requires @var{public} to be a writable data object.  GpgSM will
2550 generate a secret key (which will be stored by @command{gpg-agent},
2551 and return a certificate request in @var{public}, which then needs to
2552 be signed by the certification authority and imported before it can be
2553 used.  GpgSM does not make the fingerprint available.
2554
2555 The argument @var{parms} specifies parameters for the key in an XML
2556 string.  The details about the format of @var{parms} are specific to
2557 the crypto engine used by @var{ctx}.  Here is an example for GnuPG as
2558 the crypto engine:
2559
2560 @example
2561 <GnupgKeyParms format="internal">
2562 Key-Type: DSA
2563 Key-Length: 1024
2564 Subkey-Type: ELG-E
2565 Subkey-Length: 1024
2566 Name-Real: Joe Tester
2567 Name-Comment: with stupid passphrase
2568 Name-Email: joe@@foo.bar
2569 Expire-Date: 0
2570 Passphrase: abc
2571 </GnupgKeyParms>
2572 @end example
2573
2574 Here is an example for GpgSM as the crypto engine:
2575
2576 @example
2577 <GnupgKeyParms format="internal">
2578 Key-Type: RSA
2579 Key-Length: 1024
2580 Name-DN: C=de,O=g10 code,OU=Testlab,CN=Joe 2 Tester
2581 Name-Email: joe@@foo.bar
2582 </GnupgKeyParms>
2583 @end example
2584
2585 Strings should be given in UTF-8 encoding.  The only format supported
2586 for now is ``internal''.  The content of the @code{GnupgKeyParms}
2587 container is passed verbatim to the crypto backend.  Control
2588 statements are not allowed.
2589
2590 After the operation completed successfully, the result can be
2591 retrieved with @code{gpgme_op_genkey_result}.
2592
2593 The function returns @code{GPGME_No_Error} if the operation could be
2594 started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
2595 a valid XML string, @code{GPGME_Not_Supported} if @var{public} or
2596 @var{secret} is not valid, and @code{GPGME_General_Error} if no key
2597 was created by the backend.
2598 @end deftypefun
2599
2600 @deftypefun gpgme_error_t gpgme_op_genkey_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{parms}}, @w{gpgme_data_t @var{public}}, @w{gpgme_data_t @var{secret}})
2601 The function @code{gpgme_op_genkey_start} initiates a
2602 @code{gpgme_op_genkey} operation.  It can be completed by calling
2603 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2604
2605 The function returns @code{GPGME_No_Error} if the operation could be
2606 started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
2607 a valid XML string, and @code{GPGME_Not_Supported} if @var{public} or
2608 @var{secret} is not @code{NULL}.
2609 @end deftypefun
2610
2611 @deftp {Data type} {gpgme_genkey_result_t}
2612 This is a pointer to a structure used to store the result of a
2613 @code{gpgme_op_genkey} operation.  After successfully generating a
2614 key, you can retrieve the pointer to the result with
2615 @code{gpgme_op_genkey_result}.  The structure contains the following
2616 members:
2617
2618 @table @code
2619 @item unsigned int primary : 1
2620 This is a flag that is set to 1 if a primary key was created and to 0
2621 if not.
2622
2623 @item unsigned int sub : 1
2624 This is a flag that is set to 1 if a subkey was created and to 0
2625 if not.
2626
2627 @item char *fpr
2628 This is the fingerprint of the key that was created.  If both a
2629 primary and a sub key were generated, the fingerprint of the primary
2630 key will be returned.  If the crypto engine does not provide the
2631 fingerprint, @code{fpr} will be a null pointer.
2632 @end table
2633 @end deftp
2634
2635 @deftypefun gpgme_genkey_result_t gpgme_op_genkey_result (@w{gpgme_ctx_t @var{ctx}})
2636 The function @code{gpgme_op_genkey_result} returns a
2637 @code{gpgme_genkey_result_t} pointer to a structure holding the result of
2638 a @code{gpgme_op_genkey} operation.  The pointer is only valid if the
2639 last operation on the context was a @code{gpgme_op_genkey} or
2640 @code{gpgme_op_genkey_start} operation, and if this operation finished
2641 successfully.  The returned pointer is only valid until the next
2642 operation is started on the context.
2643 @end deftypefun
2644
2645
2646 @node Exporting Keys
2647 @subsection Exporting Keys
2648 @cindex key, export
2649 @cindex key ring, export from
2650
2651 @deftypefun gpgme_error_t gpgme_op_export (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_recipients_t @var{recipients}}, @w{gpgme_data_t @var{keydata}})
2652 The function @code{gpgme_op_export} extracts the public keys of the
2653 user IDs in @var{recipients} and returns them in the data buffer
2654 @var{keydata}.  The type of the public keys returned is determined by
2655 the @acronym{ASCII} armor attribute set for the context @var{ctx}.
2656
2657 The function returns @code{GPGME_No_Error} if the operation completed
2658 successfully, @code{GPGME_Invalid_Value} if @var{recipients} is
2659 @code{NULL} or @var{keydata} is not a valid empty data buffer, and
2660 passes through any errors that are reported by the crypto engine
2661 support routines.
2662 @end deftypefun
2663
2664 @deftypefun gpgme_error_t gpgme_op_export_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_recipients_t @var{recipients}}, @w{gpgme_data_t @var{keydata}})
2665 The function @code{gpgme_op_export_start} initiates a
2666 @code{gpgme_op_export} operation.  It can be completed by calling
2667 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2668
2669 The function returns @code{GPGME_No_Error} if the operation could be
2670 started successfully, and @code{GPGME_Invalid_Value} if
2671 @var{recipients} is @code{NULL} or @var{keydata} is not a valid empty
2672 data buffer.
2673 @end deftypefun
2674
2675
2676 @node Importing Keys
2677 @subsection Importing Keys
2678 @cindex key, import
2679 @cindex key ring, import to
2680
2681 @deftypefun gpgme_error_t gpgme_op_import (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}})
2682 The function @code{gpgme_op_import} adds the keys in the data buffer
2683 @var{keydata} to the key ring of the crypto engine used by @var{ctx}.
2684 The format of @var{keydata} can be @var{ASCII} armored, for example,
2685 but the details are specific to the crypto engine.
2686
2687 After the operation completed successfully, the result can be
2688 retrieved with @code{gpgme_op_import_result}.
2689
2690 The function returns @code{GPGME_No_Error} if the import was completed
2691 successfully, @code{GPGME_Invalid_Value} if @var{keydata} if @var{ctx}
2692 or @var{keydata} is not a valid pointer, and @code{GPGME_No_Data} if
2693 @var{keydata} is an empty data buffer.
2694 @end deftypefun
2695
2696 @deftypefun gpgme_error_t gpgme_op_import_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}})
2697 The function @code{gpgme_op_import_start} initiates a
2698 @code{gpgme_op_import} operation.  It can be completed by calling
2699 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2700
2701 The function returns @code{GPGME_No_Error} if the import could be
2702 started successfully, @code{GPGME_Invalid_Value} if @var{keydata} if
2703 @var{ctx} or @var{keydata} is not a valid pointer, and
2704 @code{GPGME_No_Data} if @var{keydata} is an empty data buffer.
2705 @end deftypefun
2706
2707 @deftp {Data type} {gpgme_import_status_t}
2708 This is a pointer to a structure used to store a part of the result of
2709 a @code{gpgme_op_import} operation.  For each considered key one
2710 status is added that contains information about the result of the
2711 import.  The structure contains the following members:
2712
2713 @table @code
2714 @item gpgme_import_status_t next
2715 This is a pointer to the next status structure in the linked list, or
2716 @code{NULL} if this is the last element.
2717
2718 @item char *fpr
2719 This is the fingerprint of the key that was considered.
2720
2721 @item gpgme_error_t result
2722 If the import was not successful, this is the error value that caused
2723 the import to fail.  Otherwise it is @code{GPGME_No_Error}.
2724
2725 @item unsigned int status
2726 This is a bit-wise OR of the following flags that give more
2727 information about what part of the key was imported.  If the key was
2728 already known, this might be 0.
2729
2730 @table @code
2731 @item GPGME_IMPORT_NEW
2732 The key was new.
2733
2734 @item GPGME_IMPORT_UID
2735 The key contained new user IDs.
2736
2737 @item GPGME_IMPORT_SIG
2738 The key contained new signatures.
2739
2740 @item GPGME_IMPORT_SUBKEY
2741 The key contained new sub keys.
2742
2743 @item GPGME_IMPORT_SECRET
2744 The key contained a secret key.
2745 @end table
2746 @end table
2747 @end deftp
2748
2749 @deftp {Data type} {gpgme_import_result_t}
2750 This is a pointer to a structure used to store the result of a
2751 @code{gpgme_op_import} operation.  After a successful import
2752 operation, you can retrieve the pointer to the result with
2753 @code{gpgme_op_import_result}.  The structure contains the following
2754 members:
2755
2756 @table @code
2757 @item int considered
2758 The total number of considered keys.
2759
2760 @item int no_user_id
2761 The number of keys without user ID.
2762
2763 @item int imported
2764 The total number of imported keys.
2765
2766 @item imported_rsa
2767 The number of imported RSA keys.
2768
2769 @item unchanged
2770 The number of unchanged keys.
2771
2772 @item new_user_ids
2773 The number of new user IDs.
2774
2775 @item new_sub_keys
2776 The number of new sub keys.
2777
2778 @item new_signatures
2779 The number of new signatures.
2780
2781 @item new_revocations
2782 The number of new revocations.
2783
2784 @item secret_read
2785 The total number of secret keys read.
2786
2787 @item secret_imported
2788 The number of imported secret keys.
2789
2790 @item secret_unchanged
2791 The number of unchanged secret keys.
2792
2793 @item not_imported
2794 The number of keys not imported.
2795
2796 @item gpgme_import_status_t imports
2797 A list of gpgme_import_status_t objects which contain more information
2798 about the keys for which an import was attempted.
2799 @end table
2800 @end deftp
2801
2802 @deftypefun gpgme_import_result_t gpgme_op_import_result (@w{gpgme_ctx_t @var{ctx}})
2803 The function @code{gpgme_op_import_result} returns a
2804 @code{gpgme_import_result_t} pointer to a structure holding the result of
2805 a @code{gpgme_op_import} operation.  The pointer is only valid if the
2806 last operation on the context was a @code{gpgme_op_import} or
2807 @code{gpgme_op_import_start} operation, and if this operation finished
2808 successfully.  The returned pointer is only valid until the next
2809 operation is started on the context.
2810 @end deftypefun
2811
2812 The following interface is deprecated and only provided for backward
2813 compatibility.  Don't use it.  It will be removed in a future version
2814 of @acronym{GPGME}.
2815
2816 @deftypefun gpgme_error_t gpgme_op_import_ext (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}}, @w{int *@var{nr}})
2817 The function @code{gpgme_op_import_ext} is equivalent to:
2818
2819 @example
2820   gpgme_error_t err = gpgme_op_import (ctx, keydata);
2821   if (!err)
2822     @{
2823       gpgme_import_result_t result = gpgme_op_import_result (ctx);
2824       *nr = result->considered;
2825     @}
2826 @end example
2827 @end deftypefun
2828
2829
2830 @node Deleting Keys
2831 @subsection Deleting Keys
2832 @cindex key, delete
2833 @cindex key ring, delete from
2834
2835 @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}})
2836 The function @code{gpgme_op_delete} deletes the key @var{key} from the
2837 key ring of the crypto engine used by @var{ctx}.  If
2838 @var{allow_secret} is @code{0}, only public keys are deleted,
2839 otherwise secret keys are deleted as well, if that is supported.
2840
2841 The function returns @code{GPGME_No_Error} if the key was deleted
2842 successfully, @code{GPGME_Invalid_Value} if @var{ctx} or @var{key} is
2843 not a valid pointer, @code{GPGME_Invalid_Key} if @var{key} could not
2844 be found in the keyring, @code{GPGME_Ambiguous_Specification} if the
2845 key was not specified unambiguously, and @code{GPGME_Conflict} if the
2846 secret key for @var{key} is available, but @var{allow_secret} is zero.
2847 @end deftypefun
2848
2849 @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}})
2850 The function @code{gpgme_op_delete_start} initiates a
2851 @code{gpgme_op_delete} operation.  It can be completed by calling
2852 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2853
2854 The function returns @code{GPGME_No_Error} if the operation was
2855 started successfully, and @code{GPGME_Invalid_Value} if @var{ctx} or
2856 @var{key} is not a valid pointer.
2857 @end deftypefun
2858
2859
2860 @node Trust Item Management
2861 @section Trust Item Management
2862 @cindex trust item
2863
2864 @strong{Caution:} The trust items interface is experimental.
2865
2866 @deftp {Data type} gpgme_trust_item_t
2867 The @code{gpgme_trust_item_t} type is a pointer to a trust item object.
2868 It has the following members:
2869
2870 @table @code
2871 @item char *keyid
2872 This is a string describing the key to which this trust items belongs.
2873
2874 @item int type
2875 This is the type of the trust item.  A value of 1 refers to a key, a
2876 value of 2 refers to a user ID.
2877
2878 @item int level
2879 This is the trust level.
2880
2881 @item char *owner_trust
2882 The owner trust if @code{type} is 1.
2883
2884 @item char *validity
2885 The calculated validity.
2886
2887 @item char *name
2888 The user name if @code{type} is 2.
2889 @end table
2890 @end deftp
2891
2892 @menu
2893 * Listing Trust Items::           Browsing the list of available trust items.
2894 * Information About Trust Items:: Requesting information about trust items.
2895 * Manipulating Trust Items::      Operations on trust items.
2896 @end menu
2897
2898
2899 @node Listing Trust Items
2900 @subsection Listing Trust Items
2901 @cindex trust item list
2902
2903 @deftypefun gpgme_error_t gpgme_op_trustlist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{max_level}})
2904 The function @code{gpgme_op_trustlist_start} initiates a trust item
2905 listing operation inside the context @var{ctx}.  It sets everything up
2906 so that subsequent invocations of @code{gpgme_op_trustlist_next} return
2907 the trust items in the list.
2908
2909 The string @var{pattern} contains an engine specific expression that
2910 is used to limit the list to all trust items matching the pattern.  It
2911 can not be the empty string.
2912
2913 The argument @var{max_level} is currently ignored.
2914
2915 The context will be busy until either all trust items are received
2916 (and @code{gpgme_op_trustlist_next} returns @code{GPGME_EOF}), or
2917 @code{gpgme_op_trustlist_end} is called to finish the operation.
2918
2919 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
2920 valid pointer, and passes through any errors that are reported by the
2921 crypto engine support routines.
2922 @end deftypefun
2923
2924 @deftypefun gpgme_error_t gpgme_op_trustlist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_trust_item_t *@var{r_item}})
2925 The function @code{gpgme_op_trustlist_next} returns the next trust
2926 item in the list created by a previous @code{gpgme_op_trustlist_start}
2927 operation in the context @var{ctx}.  The trust item can be destroyed
2928 with @code{gpgme_trust_item_release}.  @xref{Manipulating Trust Items}.
2929
2930 This is the only way to get at @code{gpgme_trust_item_t} objects in
2931 @acronym{GPGME}.
2932
2933 If the last trust item in the list has already been returned,
2934 @code{gpgme_op_trustlist_next} returns @code{GPGME_EOF}.
2935
2936 The function returns @code{GPGME_Invalid_Value} if @var{ctx} or
2937 @var{r_item} is not a valid pointer, and @code{GPGME_Out_Of_Core} if
2938 there is not enough memory for the operation.
2939 @end deftypefun
2940
2941 @deftypefun gpgme_error_t gpgme_op_trustlist_end (@w{gpgme_ctx_t @var{ctx}})
2942 The function @code{gpgme_op_trustlist_next} ends a pending key list
2943 operation in the context @var{ctx}.
2944
2945 The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
2946 valid pointer, and @code{GPGME_Out_Of_Core} if at some time during the
2947 operation there was not enough memory available.
2948 @end deftypefun
2949
2950
2951 @node Information About Trust Items
2952 @subsection Information About Trust Items
2953 @cindex trust item, information about
2954 @cindex trust item, attributes
2955 @cindex attributes, of a trust item
2956
2957 The following interfaces are deprecated and only provided for backward
2958 compatibility.  Don't use them.  They will be removed in a future
2959 version of @acronym{GPGME}.
2960
2961 Trust items have attributes which can be queried using the interfaces
2962 below.  The attribute identifiers are shared with those for key
2963 attributes.  @xref{Information About Keys}.
2964
2965 @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}})
2966 The function @code{gpgme_trust_item_get_string_attr} returns the value
2967 of the string-representable attribute @var{what} of trust item
2968 @var{item}.  The arguments @var{idx} and @var{reserved} are reserved
2969 for later use and should be @code{0} and @code{NULL} respectively.
2970
2971 The string returned is only valid as long as the key is valid.
2972
2973 The function returns @code{0} if an attribute can't be returned as a
2974 string, @var{key} is not a valid pointer, @var{idx} out of range,
2975 or @var{reserved} not @code{NULL}.
2976 @end deftypefun
2977
2978 @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}})
2979 The function @code{gpgme_trust_item_get_int_attr} returns the value of
2980 the number-representable attribute @var{what} of trust item
2981 @var{item}.  If the attribute occurs more than once in the trust item,
2982 the index is specified by @var{idx}.  However, currently no such
2983 attribute exists, so @var{idx} should be @code{0}.  The argument
2984 @var{reserved} is reserved for later use and should be @code{NULL}.
2985
2986 The function returns @code{0} if the attribute can't be returned as a
2987 number, @var{key} is not a valid pointer, @var{idx} out of range,
2988 or @var{reserved} not @code{NULL}.
2989 @end deftypefun
2990
2991
2992 @node Manipulating Trust Items
2993 @subsection Manipulating Trust Items
2994 @cindex trust item, manipulation
2995
2996 @deftypefun void gpgme_trust_item_ref (@w{gpgme_trust_item_t @var{item}})
2997 The function @code{gpgme_trust_item_ref} acquires an additional
2998 reference for the trust item @var{item}.
2999 @end deftypefun
3000
3001 @deftypefun void gpgme_trust_item_unref (@w{gpgme_trust_item_t @var{item}})
3002 The function @code{gpgme_trust_item_unref} releases a reference for
3003 the trust item @var{item}.  If this was the last reference, the trust
3004 item will be destroyed and all resources associated to it will be
3005 released.
3006 @end deftypefun
3007
3008
3009 The following interface is deprecated and only provided for backward
3010 compatibility.  Don't use it.  It will be removed in a future version
3011 of @acronym{GPGME}.
3012
3013 @deftypefun void gpgme_trust_item_release (@w{gpgme_trust_item_t @var{item}})
3014 The function @code{gpgme_trust_item_release} is an alias for
3015 @code{gpgme_trust_item_unref}.
3016 @end deftypefun
3017
3018
3019 @node Crypto Operations
3020 @section Crypto Operations
3021 @cindex cryptographic operation
3022
3023 Sometimes, the result of a crypto operation returns a list of invalid
3024 user IDs encountered in processing the request.  The following
3025 structure is used to hold information about such an user ID.
3026
3027 @deftp {Data type} {gpgme_invalid_user_id_t}
3028 This is a pointer to a structure used to store a part of the result of
3029 a crypto operation which takes user IDs as one input parameter.  The
3030 structure contains the following members:
3031
3032 @table @code
3033 @item gpgme_invalid_user_id_t next
3034 This is a pointer to the next invalid user ID structure in the linked
3035 list, or @code{NULL} if this is the last element.
3036
3037 @item char *id
3038 The invalid user ID encountered.
3039
3040 @item gpgme_error_t reason
3041 An error code describing the reason why the user ID was found invalid.
3042 @end table
3043 @end deftp
3044
3045
3046 @menu
3047 * Decrypt::                       Decrypting a ciphertext.
3048 * Verify::                        Verifying a signature.
3049 * Decrypt and Verify::            Decrypting a signed ciphertext.
3050 * Sign::                          Creating a signature.
3051 * Encrypt::                       Encrypting a plaintext.
3052 @end menu
3053
3054
3055 @node Decrypt
3056 @subsection Decrypt
3057 @cindex decryption
3058 @cindex cryptographic operation, decryption
3059
3060 @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}})
3061 The function @code{gpgme_op_decrypt} decrypts the ciphertext in the
3062 data object @var{cipher} and stores it into the data object
3063 @var{plain}.
3064
3065 The function returns @code{GPGME_No_Error} if the ciphertext could be
3066 decrypted successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3067 @var{cipher} or @var{plain} is not a valid pointer,
3068 @code{GPGME_No_Data} if @var{cipher} does not contain any data to
3069 decrypt, @code{GPGME_Decryption_Failed} if @var{cipher} is not a valid
3070 cipher text, @code{GPGME_Bad_Passphrase} if the passphrase for the
3071 secret key could not be retrieved, and passes through any errors that
3072 are reported by the crypto engine support routines.
3073 @end deftypefun
3074
3075 @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}})
3076 The function @code{gpgme_op_decrypt_start} initiates a
3077 @code{gpgme_op_decrypt} operation.  It can be completed by calling
3078 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
3079
3080 The function returns @code{GPGME_No_Error} if the operation could be
3081 started successfully, and @code{GPGME_Invalid_Value} if @var{cipher}
3082 or @var{plain} is not a valid pointer.
3083 @end deftypefun
3084
3085 @deftp {Data type} {gpgme_decrypt_result_t}
3086 This is a pointer to a structure used to store the result of a
3087 @code{gpgme_op_decrypt} operation.  After successfully encrypting
3088 data, you can retrieve the pointer to the result with
3089 @code{gpgme_op_decrypt_result}.  The structure contains the following
3090 members:
3091
3092 @table @code
3093 @item char *unsupported_algorithm
3094 If an unsupported algorithm was encountered, this string describes the
3095 algorithm that is not supported.
3096 @end table
3097 @end deftp
3098
3099 @deftypefun gpgme_decrypt_result_t gpgme_op_decrypt_result (@w{gpgme_ctx_t @var{ctx}})
3100 The function @code{gpgme_op_decrypt_result} returns a
3101 @code{gpgme_decrypt_result_t} pointer to a structure holding the result of
3102 a @code{gpgme_op_decrypt} operation.  The pointer is only valid if the
3103 last operation on the context was a @code{gpgme_op_decrypt} or
3104 @code{gpgme_op_decrypt_start} operation, and if this operation
3105 finished successfully.  The returned pointer is only valid until the
3106 next operation is started on the context.
3107 @end deftypefun
3108
3109
3110 @node Verify
3111 @subsection Verify
3112 @cindex verification
3113 @cindex signature, verification
3114 @cindex cryptographic operation, verification
3115 @cindex cryptographic operation, signature check
3116
3117 @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}})
3118 The function @code{gpgme_op_verify} verifies that the signature in the
3119 data object @var{sig} is a valid signature.  If @var{sig} is a
3120 detached signature, then the signed text should be provided in
3121 @var{signed_text} and @var{plain} should be a null pointer.
3122 Otherwise, if @var{sig} is a normal (or cleartext) signature,
3123 @var{signed_text} should be a null pointer and @var{plain} should be a
3124 writable data object that will contain the plaintext after successful
3125 verification.
3126
3127 The results of the individual signature verifications can be retrieved
3128 with @code{gpgme_op_verify_result}.
3129
3130 The function returns @code{GPGME_No_Error} if the operation could be
3131 completed successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3132 @var{sig}, @var{plain} or @var{r_stat} is not a valid pointer,
3133 @code{GPGME_No_Data} if @var{sig} does not contain any data to verify,
3134 and passes through any errors that are reported by the crypto engine
3135 support routines.
3136 @end deftypefun
3137
3138 @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}})
3139 The function @code{gpgme_op_verify_start} initiates a
3140 @code{gpgme_op_verify} operation.  It can be completed by calling
3141 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
3142
3143 The function returns @code{GPGME_No_Error} if the operation could be
3144 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3145 @var{sig}, @var{plain} or @var{r_stat} is not a valid pointer, and
3146 @code{GPGME_No_Data} if @var{sig} or @var{plain} does not contain any
3147 data to verify.
3148 @end deftypefun
3149
3150 @deftp {Data type} {gpgme_sig_notation_t}
3151 This is a pointer to a structure used to store a part of the result of
3152 a @code{gpgme_op_verify} operation.  The structure contains the
3153 following members:
3154
3155 @table @code
3156 @item gpgme_sig_notation_t next
3157 This is a pointer to the next new signature notation structure in the
3158 linked list, or @code{NULL} if this is the last element.
3159
3160 @item char *name
3161 The name of the notation field.  If this is @code{NULL}, then the
3162 member @code{value} will contain a policy URL.
3163
3164 @item char *value
3165 The value of the notation field.  If @code{name} is @code{NULL}, then
3166 this is a policy URL.
3167 @end table
3168 @end deftp
3169
3170 @deftp {Data type} {gpgme_signature_t}
3171 This is a pointer to a structure used to store a part of the result of
3172 a @code{gpgme_op_verify} operation.  The structure contains the
3173 following members:
3174
3175 @table @code
3176 @item gpgme_signature_t next
3177 This is a pointer to the next new signature structure in the linked
3178 list, or @code{NULL} if this is the last element.
3179
3180 @item unsigned int summary;
3181 This is a bit vector giving a summary of the signature status.  It
3182 provides an easy interface to a defined semantic of the signature
3183 status.  Checking just one bit is sufficient to see whether a
3184 signature is valid without any restrictions.
3185
3186 The defined bits are:
3187   @table @code
3188   @item GPGME_SIGSUM_VALID
3189   The signature is fully valid.
3190
3191   @item GPGME_SIGSUM_GREEN
3192   The signature is good but one might want to display some extra
3193   information.  Check the other bits.
3194
3195   @item GPGME_SIGSUM_RED
3196   The signature is bad. It might be useful to checkother bits and
3197   display moe information, i.e. a revoked certificate might not render a
3198   signature invalid when the message was received prior to the cause for
3199   the revocation.
3200
3201   @item GPGME_SIGSUM_KEY_REVOKED
3202   The key or at least one certificate has been revoked.
3203
3204   @item GPGME_SIGSUM_KEY_EXPIRED
3205   The key or one of the certificates has expired. It is probably a good
3206   idea to display the date of the expiration.
3207
3208   @item GPGME_SIGSUM_SIG_EXPIRED
3209   The signature has expired.
3210
3211   @item GPGME_SIGSUM_KEY_MISSING
3212   Can't verifydue to a missing key o certificate.
3213
3214   @item GPGME_SIGSUM_CRL_MISSING
3215   The CRL (or an equivalent mechanism) is not available. 
3216
3217   @item GPGME_SIGSUM_CRL_TOO_OLD
3218   Available CRL is too old.
3219
3220   @item GPGME_SIGSUM_BAD_POLICY
3221   A policy requirement was not met. 
3222
3223   @item GPGME_SIGSUM_SYS_ERROR
3224   A system error occured. 
3225   @end table
3226
3227 @item char *fpr
3228 This is the fingerprint or key ID of the signature.
3229
3230 @item gpgme_error_t status
3231 This is the status of the signature.  In particular, the following
3232 status codes are of interest:
3233
3234   @table @code
3235   @item GPGME_No_Error
3236   This status indicates that the signature is valid.  For the combined
3237   result this status means that all signatures are valid.
3238
3239   @item GPGME_Sig_Expired
3240   This status indicates that the signature is valid but expired.  For
3241   the combined result this status means that all signatures are valid
3242   and expired.
3243
3244   @item GPGME_Key_Expired
3245   This status indicates that the signature is valid but the key used to
3246   verify the signature has expired.  For the combined result this status
3247   means that all signatures are valid and all keys are expired.
3248
3249   @item GPGME_Bad_Signature
3250   This status indicates that the signature is invalid.  For the combined
3251   result this status means that all signatures are invalid.
3252
3253   @item GPGME_No_Public_Key
3254   This status indicates that the signature could not be verified due to
3255   a missing key.  For the combined result this status means that all
3256   signatures could not be checked due to missing keys.
3257
3258   @item GPGME_General_Error
3259   This status indicates that there was some other error which prevented
3260   the signature verification.
3261   @end table
3262
3263 @item gpgme_sig_notation_t notations
3264 This is a linked list with the notation data and policy URLs.
3265
3266 @item unsigned long timestamp
3267 The creation timestamp of this signature.
3268
3269 @item unsigned long exp_timestamp
3270 The expiration timestamp of this signature, or 0 if the signature does
3271 not expire.
3272
3273 @item int wrong_key_usage : 1;
3274
3275 @item gpgme_validity_t validity
3276
3277 @item gpgme_error_t validity_reason
3278 @end table
3279 @end deftp
3280
3281 @deftp {Data type} {gpgme_verify_result_t}
3282 This is a pointer to a structure used to store the result of a
3283 @code{gpgme_op_verify} operation.  After successfully verifying a
3284 signature, you can retrieve the pointer to the result with
3285 @code{gpgme_op_verify_result}.  The structure contains the following
3286 member:
3287
3288 @table @code
3289 @item gpgme_signature_t signatures
3290 A linked list with information about all signatures for which a
3291 verification was attempted.
3292 @end table
3293 @end deftp
3294
3295 @deftypefun gpgme_sign_result_t gpgme_op_verify_result (@w{gpgme_ctx_t @var{ctx}})
3296 The function @code{gpgme_op_verify_result} returns a
3297 @code{gpgme_verify_result_t} pointer to a structure holding the result of
3298 a @code{gpgme_op_verify} operation.  The pointer is only valid if the
3299 last operation on the context was a @code{gpgme_op_verify} or
3300 @code{gpgme_op_verify_start} operation, and if this operation finished
3301 successfully.  The returned pointer is only valid until the next
3302 operation is started on the context.
3303 @end deftypefun
3304
3305
3306 The following interfaces are deprecated and only provided for backward
3307 compatibility.  Don't use them.  They will be removed in a future
3308 version of @acronym{GPGME}.
3309
3310 @deftp {Data type} {enum gpgme_sig_stat_t}
3311 @tindex gpgme_sig_stat_t
3312 The @code{gpgme_sig_stat_t} type holds the result of a signature check, or
3313 the combined result of all signatures.  The following results are
3314 possible:
3315
3316 @table @code
3317 @item GPGME_SIG_STAT_NONE
3318 This status should not occur in normal operation.
3319
3320 @item GPGME_SIG_STAT_GOOD
3321 This status indicates that the signature is valid.  For the combined
3322 result this status means that all signatures are valid.
3323
3324 @item GPGME_SIG_STAT_GOOD_EXP
3325 This status indicates that the signature is valid but expired.  For
3326 the combined result this status means that all signatures are valid
3327 and expired.
3328
3329 @item GPGME_SIG_STAT_GOOD_EXPKEY
3330 This status indicates that the signature is valid but the key used to
3331 verify the signature has expired.  For the combined result this status
3332 means that all signatures are valid and all keys are expired.
3333
3334 @item GPGME_SIG_STAT_BAD
3335 This status indicates that the signature is invalid.  For the combined
3336 result this status means that all signatures are invalid.
3337
3338 @item GPGME_SIG_STAT_NOKEY
3339 This status indicates that the signature could not be verified due to
3340 a missing key.  For the combined result this status means that all
3341 signatures could not be checked due to missing keys.
3342
3343 @item GPGME_SIG_STAT_NOSIG
3344 This status indicates that the signature data provided was not a real
3345 signature.
3346
3347 @item GPGME_SIG_STAT_ERROR
3348 This status indicates that there was some other error which prevented
3349 the signature verification.
3350
3351 @item GPGME_SIG_STAT_DIFF
3352 For the combined result this status means that at least two signatures
3353 have a different status.  You can get each key's status with
3354 @code{gpgme_get_sig_status}.
3355 @end table
3356 @end deftp
3357
3358 @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}})
3359 The function @code{gpgme_get_sig_status} is equivalent to:
3360  
3361 @example
3362   gpgme_verify_result_t result;
3363   gpgme_signature_t sig;
3364
3365   result = gpgme_op_verify_result (ctx);
3366   sig = result->signatures;
3367
3368   while (sig && idx)
3369     @{
3370       sig = sig->next;
3371       idx--;
3372     @}
3373   if (!sig || idx)
3374     return NULL;
3375
3376   if (r_stat)
3377     @{
3378       switch (sig->status)
3379         @{
3380         case GPGME_No_Error:
3381           *r_stat = GPGME_SIG_STAT_GOOD;
3382           break;
3383           
3384         case GPGME_Bad_Signature:
3385           *r_stat = GPGME_SIG_STAT_BAD;
3386           break;
3387           
3388         case GPGME_No_Public_Key:
3389           *r_stat = GPGME_SIG_STAT_NOKEY;
3390           break;
3391           
3392         case GPGME_No_Data:
3393           *r_stat = GPGME_SIG_STAT_NOSIG;
3394           break;
3395           
3396         case GPGME_Sig_Expired:
3397           *r_stat = GPGME_SIG_STAT_GOOD_EXP;
3398           break;
3399           
3400         case GPGME_Key_Expired:
3401           *r_stat = GPGME_SIG_STAT_GOOD_EXPKEY;
3402           break;
3403           
3404         default:
3405           *r_stat = GPGME_SIG_STAT_ERROR;
3406           break;
3407         @}
3408     @}
3409   if (r_created)
3410     *r_created = sig->timestamp;
3411   return sig->fpr;
3412 @end example
3413 @end deftypefun
3414
3415 @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}})
3416 The function @code{gpgme_get_sig_string_attr} is equivalent to:
3417  
3418 @example
3419   gpgme_verify_result_t result;
3420   gpgme_signature_t sig;
3421
3422   result = gpgme_op_verify_result (ctx);
3423   sig = result->signatures;
3424
3425   while (sig && idx)
3426     @{
3427       sig = sig->next;
3428       idx--;
3429     @}
3430   if (!sig || idx)
3431     return NULL;
3432
3433   switch (what)
3434     @{
3435     case GPGME_ATTR_FPR:
3436       return sig->fpr;
3437
3438     case GPGME_ATTR_ERRTOK:
3439       if (whatidx == 1)
3440         return sig->wrong_key_usage ? "Wrong_Key_Usage" : "";
3441       else
3442         return "";
3443     default:
3444       break;
3445     @}
3446
3447   return NULL;
3448 @end example
3449 @end deftypefun
3450
3451 @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}})
3452 The function @code{gpgme_get_sig_ulong_attr} is equivalent to:
3453  
3454 @example
3455   gpgme_verify_result_t result;
3456   gpgme_signature_t sig;
3457
3458   result = gpgme_op_verify_result (ctx);
3459   sig = result->signatures;
3460
3461   while (sig && idx)
3462     @{
3463       sig = sig->next;
3464       idx--;
3465     @}
3466   if (!sig || idx)
3467     return 0;
3468
3469   switch (what)
3470     @{
3471     case GPGME_ATTR_CREATED:
3472       return sig->timestamp;
3473
3474     case GPGME_ATTR_EXPIRE:
3475       return sig->exp_timestamp;
3476
3477     case GPGME_ATTR_VALIDITY:
3478       return (unsigned long) sig->validity;
3479
3480     case GPGME_ATTR_SIG_STATUS:
3481       switch (sig->status)
3482         @{
3483         case GPGME_No_Error:
3484           return GPGME_SIG_STAT_GOOD;
3485           
3486         case GPGME_Bad_Signature:
3487           return GPGME_SIG_STAT_BAD;
3488           
3489         case GPGME_No_Public_Key:
3490           return GPGME_SIG_STAT_NOKEY;
3491           
3492         case GPGME_No_Data:
3493           return GPGME_SIG_STAT_NOSIG;
3494           
3495         case GPGME_Sig_Expired:
3496           return GPGME_SIG_STAT_GOOD_EXP;
3497           
3498         case GPGME_Key_Expired:
3499           return GPGME_SIG_STAT_GOOD_EXPKEY;
3500           
3501         default:
3502           return GPGME_SIG_STAT_ERROR;
3503         @}
3504
3505     case GPGME_ATTR_SIG_SUMMARY:
3506       return sig->summary;
3507
3508     default:
3509       break;
3510     @}
3511   return 0;
3512 @end example
3513 @end deftypefun
3514
3515 @deftypefun {const char *} gpgme_get_sig_key (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{idx}}, @w{gpgme_key_t *@var{r_key}})
3516 The function @code{gpgme_get_sig_key} is equivalent to:
3517
3518 @example
3519   gpgme_verify_result_t result;
3520   gpgme_signature_t sig;
3521
3522   result = gpgme_op_verify_result (ctx);
3523   sig = result->signatures;
3524
3525   while (sig && idx)
3526     @{
3527       sig = sig->next;
3528       idx--;
3529     @}
3530   if (!sig || idx)
3531     return GPGME_EOF;
3532
3533   return gpgme_get_key (ctx, sig->fpr, r_key, 0, 0);
3534 @end example
3535 @end deftypefun
3536
3537
3538 @node Decrypt and Verify
3539 @subsection Decrypt and Verify
3540 @cindex decryption and verification
3541 @cindex verification and decryption
3542 @cindex signature check
3543 @cindex cryptographic operation, decryption and verification
3544
3545 @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}})
3546 The function @code{gpgme_op_decrypt_verify} decrypts the ciphertext in
3547 the data object @var{cipher} and stores it into the data object
3548 @var{plain}.  If @var{cipher} contains signatures, they will be
3549 verified.
3550
3551 After the operation completed, @code{gpgme_op_get_sig_status} and
3552 @code{gpgme_op_get_sig_key} can be used to retrieve more information
3553 about the signatures.
3554
3555 The function returns @code{GPGME_No_Error} if the ciphertext could be
3556 decrypted successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3557 @var{cipher}, @var{plain} or @var{r_stat} is not a valid pointer,
3558 @code{GPGME_No_Data} if @var{cipher} does not contain any data to
3559 decrypt, @code{GPGME_Decryption_Failed} if @var{cipher} is not a valid
3560 cipher text, @code{GPGME_Bad_Passphrase} if the passphrase for the
3561 secret key could not be retrieved, and passes through any errors that
3562 are reported by the crypto engine support routines.
3563 @end deftypefun
3564
3565 @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}})
3566 The function @code{gpgme_op_decrypt_verify_start} initiates a
3567 @code{gpgme_op_decrypt_verify} operation.  It can be completed by
3568 calling @code{gpgme_wait} on the context.  @xref{Waiting For
3569 Completion}.
3570
3571 The function returns @code{GPGME_No_Error} if the operation could be
3572 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3573 @var{cipher}, @var{plain} or @var{r_stat} is not a valid pointer, and
3574 @code{GPGME_No_Data} if @var{cipher} does not contain any data to
3575 decrypt.
3576 @end deftypefun
3577
3578
3579 @node Sign
3580 @subsection Sign
3581 @cindex signature, creation
3582 @cindex sign
3583 @cindex cryptographic operation, signing
3584
3585 A signature can contain signatures by one or more keys.  The set of
3586 keys used to create a signatures is contained in a context, and is
3587 applied to all following signing operations in this context (until the
3588 set is changed).
3589
3590 @menu
3591 * Selecting Signers::             How to choose the keys to sign with.
3592 * Creating a Signature::          How to create a signature.
3593 @end menu
3594
3595
3596 @node Selecting Signers
3597 @subsubsection Selecting Signers
3598 @cindex signature, selecting signers
3599 @cindex signers, selecting
3600
3601 @deftypefun void gpgme_signers_clear (@w{gpgme_ctx_t @var{ctx}})
3602 The function @code{gpgme_signers_clear} releases a reference for each
3603 key on the signers list and removes the list of signers from the
3604 context @var{ctx}.
3605
3606 Every context starts with an empty list.
3607 @end deftypefun
3608
3609 @deftypefun gpgme_error_t gpgme_signers_add (@w{gpgme_ctx_t @var{ctx}}, @w{const gpgme_key_t @var{key}})
3610 The function @code{gpgme_signers_add} adds the key @var{key} to the
3611 list of signers in the context @var{ctx}.
3612
3613 Calling this function acquires an additional reference for the key.
3614 @end deftypefun
3615
3616 @deftypefun gpgme_key_t gpgme_signers_enum (@w{const gpgme_ctx_t @var{ctx}}, @w{int @var{seq}})
3617 The function @code{gpgme_signers_enum} returns the @var{seq}th key in
3618 the list of signers in the context @var{ctx}.  An additional reference
3619 is acquired for the user.
3620
3621 If @var{seq} is out of range, @code{NULL} is returned.
3622 @end deftypefun
3623
3624
3625 @node Creating a Signature
3626 @subsubsection Creating a Signature
3627
3628 @deftp {Data type} {enum gpgme_sig_mode_t}
3629 @tindex gpgme_sig_mode_t
3630 The @code{gpgme_sig_mode_t} type is used to specify the desired type of a
3631 signature.  The following modes are available:
3632
3633 @table @code
3634 @item GPGME_SIG_MODE_NORMAL
3635 A normal signature is made, the output includes the plaintext and the
3636 signature.
3637
3638 @item GPGME_SIG_MODE_DETACH
3639 A detached signature is made.
3640
3641 @item GPGME_SIG_MODE_CLEAR
3642 A clear text signature is made.  The @acronym{ASCII} armor and text
3643 mode settings of the context are ignored.
3644 @end table
3645 @end deftp
3646
3647 @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}})
3648 The function @code{gpgme_op_sign} creates a signature for the text in
3649 the data object @var{plain} and returns it in the data object
3650 @var{sig}.  The type of the signature created is determined by the
3651 @acronym{ASCII} armor and text mode attributes set for the context
3652 @var{ctx} and the requested signature mode @var{mode}.
3653
3654 After the operation completed successfully, the result can be
3655 retrieved with @code{gpgme_op_sign_result}.
3656
3657 If an S/MIME signed message is created using the CMS crypto engine,
3658 the number of certificates to include in the message can be specified
3659 with @code{gpgme_set_include_certs}.  @xref{Included Certificates}.
3660
3661 The function returns @code{GPGME_No_Error} if the signature could be
3662 created successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3663 @var{plain} or @var{sig} is not a valid pointer, @code{GPGME_No_Data}
3664 if the signature could not be created, @code{GPGME_Bad_Passphrase} if
3665 the passphrase for the secret key could not be retrieved, and passes
3666 through any errors that are reported by the crypto engine support
3667 routines.
3668 @end deftypefun
3669
3670 @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}})
3671 The function @code{gpgme_op_sign_start} initiates a
3672 @code{gpgme_op_sign} operation.  It can be completed by calling
3673 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
3674
3675 The function returns @code{GPGME_No_Error} if the operation could be
3676 started successfully, and @code{GPGME_Invalid_Value} if @var{ctx},
3677 @var{plain} or @var{sig} is not a valid pointer.
3678 @end deftypefun
3679
3680 @deftp {Data type} {gpgme_new_signature_t}
3681 This is a pointer to a structure used to store a part of the result of
3682 a @code{gpgme_op_sign} operation.  The structure contains the
3683 following members:
3684
3685 @table @code
3686 @item gpgme_new_signature_t next
3687 This is a pointer to the next new signature structure in the linked
3688 list, or @code{NULL} if this is the last element.
3689
3690 @item gpgme_sig_mode_t type
3691 The type of this signature.
3692
3693 @item gpgme_pubkey_algo_t
3694 The public key algorithm used to create this signature.
3695
3696 @item gpgme_hash_algo_t
3697 The hash algorithm used to create this signature.
3698
3699 @item unsigned long class
3700 The signature class of this signature.
3701
3702 @item long int timestamp
3703 The creation timestamp of this signature.
3704
3705 @item char *fpr
3706 The fingerprint of the key which was used to create this signature.
3707 @end table
3708 @end deftp
3709
3710 @deftp {Data type} {gpgme_sign_result_t}
3711 This is a pointer to a structure used to store the result of a
3712 @code{gpgme_op_sign} operation.  After successfully generating a
3713 signature, you can retrieve the pointer to the result with
3714 @code{gpgme_op_sign_result}.  The structure contains the following
3715 members:
3716
3717 @table @code
3718 @item gpgme_invalid_user_id_t invalid_signers
3719 A linked list with information about all invalid user IDs for which a
3720 signature could not be created.
3721
3722 @item gpgme_new_signature_t signatures
3723 A linked list with information about all signatures created.
3724 @end table
3725 @end deftp
3726
3727 @deftypefun gpgme_sign_result_t gpgme_op_sign_result (@w{gpgme_ctx_t @var{ctx}})
3728 The function @code{gpgme_op_sign_result} returns a
3729 @code{gpgme_sign_result_t} pointer to a structure holding the result of a
3730 @code{gpgme_op_sign} operation.  The pointer is only valid if the last
3731 operation on the context was a @code{gpgme_op_sign} or
3732 @code{gpgme_op_sign_start} operation, and if this operation finished
3733 successfully.  The returned pointer is only valid until the next
3734 operation is started on the context.
3735 @end deftypefun
3736
3737
3738 @node Encrypt
3739 @subsection Encrypt
3740 @cindex encryption
3741 @cindex cryptographic operation, encryption
3742
3743 One plaintext can be encrypted for several recipients at the same
3744 time.  The list of recipients is created independently of any context,
3745 and then passed to the encryption operation.
3746
3747 @menu
3748 * Selecting Recipients::          How to choose the recipients.
3749 * Encrypting a Plaintext::        How to encrypt a plaintext.
3750 @end menu
3751
3752
3753 @node Selecting Recipients
3754 @subsubsection Selecting Recipients
3755 @cindex encryption, selecting recipients
3756 @cindex recipients
3757
3758 @deftp {Data type} gpgme_recipients_t
3759 The @code{gpgme_recipients_t} type is a handle for a set of recipients
3760 that can be used in an encryption process.
3761 @end deftp
3762
3763 @deftypefun gpgme_error_t gpgme_recipients_new (@w{gpgme_recipients_t *@var{r_rset}})
3764 The function @code{gpgme_recipients_new} creates a new, empty set of
3765 recipients and returns a handle for it in @var{r_rset}.
3766
3767 The function returns @code{GPGME_No_Error} if the recipient set could
3768 be created successfully, and @code{GPGME_Out_Of_Core} if not enough
3769 memory was available.
3770 @end deftypefun
3771
3772 @deftypefun void gpgme_recipients_release (@w{gpgme_recipients_t @var{rset}})
3773 The function @code{gpgme_recipients_release} destroys the set of
3774 recipients @var{rset} and releases all associated resources.
3775 @end deftypefun
3776
3777 @deftypefun gpgme_error_t gpgme_recipients_add_name (@w{gpgme_recipients_t @var{rset}}, @w{const char *@var{name}})
3778 The function @code{gpgme_recipients_add_name} adds the recipient
3779 @var{name} to the set of recipients @var{rset}.  This is equivalent to
3780 @code{gpgme_recipients_add_name_with_validity} with a validity of
3781 @code{GPGME_VALIDITY_UNKNOWN}.
3782
3783 The function returns @code{GPGME_No_Error} if the recipient was added
3784 successfully, @code{GPGME_Invalid_Value} if @var{rset} or @var{name}
3785 is not a valid pointer, and @code{GPGME_Out_Of_Core} if not enough
3786 memory is available.
3787 @end deftypefun
3788
3789 @deftypefun gpgme_error_t gpgme_recipients_add_name_with_validity (@w{gpgme_recipients_t @var{rset}}, @w{const char *@var{name}}, @w{gpgme_validity_t @var{val}})
3790 The function @code{gpgme_recipients_add_name_with_validity} adds the
3791 recipient @var{name} with the validity @var{val} to the set of
3792 recipients @var{rset}.  If the validity is not known, the function
3793 @code{gpgme_recipients_add_name} can be used.
3794 @xref{Information About Keys}, for the possible values for @var{val}.
3795
3796 The function returns @code{GPGME_No_Error} if the recipient was added
3797 successfully, @code{GPGME_Invalid_Value} if @var{rset} or @var{name}
3798 is not a valid pointer, and @code{GPGME_Out_Of_Core} if not enough
3799 memory is available.
3800 @end deftypefun
3801
3802 @deftypefun {unsigned int} gpgme_recipients_count (@w{const @var{gpgme_recipients_t rset}})
3803 The function @code{gpgme_recipients_count} returns the number of
3804 recipients in the set @var{rset}.
3805 @end deftypefun
3806
3807 @deftypefun gpgme_error_t gpgme_recipients_enum_open (@w{const gpgme_recipients_t @var{rset}}, @w{void **@var{iter}})
3808 The function @code{gpgme_recipients_enum_open} creates a new iterator
3809 @var{iter} that can be used to walk through the set of recipients in
3810 @var{rset}, using @code{gpgme_recipients_enum_read}.
3811
3812 If the iterator is not needed anymore, it can be closed with
3813 @code{gpgme_recipients_enum_close}.
3814
3815 The function returns @code{GPGME_No_Error} if the enumerator was
3816 successfully created and @code{GPGME_Invalid_Value} if @var{rset} or
3817 @var{iter} is not a valid pointer.
3818 @end deftypefun
3819
3820 @deftypefun {const char *} gpgme_recipients_enum_read (@w{const gpgme_recipients_t @var{rset}}, @w{void **@var{iter}})
3821 The function @code{gpgme_recipients_enum_read} returns a string
3822 containing the name of the next recipient in the set @var{rset} for
3823 the iterator @var{iter}.  The string is valid as long as @var{rset} is
3824 valid or the function is called the next time with the same recipient
3825 set and iterator, whatever is earlier.
3826 @end deftypefun
3827
3828 @deftypefun gpgme_error_t gpgme_recipients_enum_close (@w{const gpgme_recipients_t @var{rset}}, @w{void **@var{iter}})
3829 The function @code{gpgme_recipients_enum_close} releases the iterator
3830 @var{iter} for the recipient set @var{rset}.
3831 @end deftypefun
3832
3833
3834 @node Encrypting a Plaintext
3835 @subsubsection Encrypting a Plaintext
3836
3837 @deftypefun gpgme_error_t gpgme_op_encrypt (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_recipients_t @var{rset}}, @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}})
3838 The function @code{gpgme_op_encrypt} encrypts the plaintext in the data
3839 object @var{plain} for the recipients @var{rset} and stores the
3840 ciphertext in the data object @var{cipher}.  The type of the
3841 ciphertext created is determined by the @acronym{ASCII} armor and text
3842 mode attributes set for the context @var{ctx}.
3843
3844 If @code{GPGME_Invalid_UserID} is returned, some recipients in
3845 @var{rset} are invalid, but not all.  In this case the plaintext is
3846 encrypted for all valid recipients and returned in @var{cipher}.  More
3847 information about the invalid recipients is available with
3848 @code{gpgme_op_encrypt_result}.
3849
3850 If @var{recp} is @code{NULL}, symmetric rather than public key
3851 encryption is performed.  Symmetrically encrypted cipher text can be
3852 deciphered with @code{gpgme_op_decrypt}.  Note that in this case the
3853 crypto backend needs to retrieve a passphrase from the user.
3854 Symmetric encryption is currently only supported for the OpenPGP
3855 crypto backend.
3856
3857 The function returns @code{GPGME_No_Error} if the ciphertext could be
3858 created successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3859 @var{rset}, @var{plain} or @var{cipher} is not a valid pointer,
3860 @code{GPGME_No_UserID} if @var{rset} does not contain any valid
3861 recipients, @code{GPGME_Invalid_UserID} if @var{rset} contains some
3862 invalid recipients, @code{GPGME_Bad_Passphrase} if the passphrase for
3863 the secret key could not be retrieved, and passes through any errors
3864 that are reported by the crypto engine support routines.
3865 @end deftypefun
3866
3867 @deftypefun gpgme_error_t gpgme_op_encrypt_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_recipients_t @var{rset}}, @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}})
3868 The function @code{gpgme_op_encrypt_start} initiates a
3869 @code{gpgme_op_encrypt} operation.  It can be completed by calling
3870 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
3871
3872 The function returns @code{GPGME_No_Error} if the operation could be
3873 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3874 @var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
3875 @code{GPGME_No_UserID} if @var{rset} does not contain any valid
3876 recipients.
3877 @end deftypefun
3878
3879 @deftp {Data type} {gpgme_encrypt_result_t}
3880 This is a pointer to a structure used to store the result of a
3881 @code{gpgme_op_encrypt} operation.  After successfully encrypting
3882 data, you can retrieve the pointer to the result with
3883 @code{gpgme_op_encrypt_result}.  The structure contains the following
3884 members:
3885
3886 @table @code
3887 @item gpgme_invalid_user_id_t invalid_recipients
3888 A linked list with information about all invalid user IDs for which
3889 the data could not be encrypted.
3890 @end table
3891 @end deftp
3892
3893 @deftypefun gpgme_encrypt_result_t gpgme_op_encrypt_result (@w{gpgme_ctx_t @var{ctx}})
3894 The function @code{gpgme_op_encrypt_result} returns a
3895 @code{gpgme_encrypt_result_t} pointer to a structure holding the result of
3896 a @code{gpgme_op_encrypt} operation.  The pointer is only valid if the
3897 last operation on the context was a @code{gpgme_op_encrypt} or
3898 @code{gpgme_op_encrypt_start} operation, and if this operation
3899 finished successfully.  The returned pointer is only valid until the
3900 next operation is started on the context.
3901 @end deftypefun
3902
3903
3904 @deftypefun gpgme_error_t gpgme_op_encrypt_sign (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_recipients_t @var{rset}}, @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}})
3905 The function @code{gpgme_op_encrypt_sign} does a combined encrypt and
3906 sign operation.  It is used like @code{gpgme_op_encrypt}, but the
3907 ciphertext also contains signatures for the signers listed in
3908 @var{ctx}.
3909
3910 The combined encrypt and sign operation is currently only available
3911 for the OpenPGP crypto engine.
3912 @end deftypefun
3913
3914 @deftypefun gpgme_error_t gpgme_op_encrypt_sign_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_recipients_t @var{rset}}, @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}})
3915 The function @code{gpgme_op_encrypt_sign_start} initiates a
3916 @code{gpgme_op_encrypt_sign} operation.  It can be completed by
3917 calling @code{gpgme_wait} on the context.  @xref{Waiting For
3918 Completion}.
3919
3920 The function returns @code{GPGME_No_Error} if the operation could be
3921 started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
3922 @var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
3923 @code{GPGME_No_UserID} if @var{rset} does not contain any valid
3924 recipients.
3925 @end deftypefun
3926
3927
3928 @node Run Control
3929 @section Run Control
3930 @cindex run control
3931 @cindex cryptographic operation, running
3932
3933 @acronym{GPGME} supports running operations synchronously and
3934 asynchronously.  You can use asynchronous operation to set up a
3935 context up to initiating the desired operation, but delay performing
3936 it to a later point.
3937
3938 Furthermore, you can use an external event loop to control exactly
3939 when @acronym{GPGME} runs.  This ensures that @acronym{GPGME} only
3940 runs when necessary and also prevents it from blocking for a long
3941 time.
3942
3943 @menu
3944 * Waiting For Completion::        Waiting until an operation is completed.
3945 * Using External Event Loops::    Advanced control over what happens when.
3946 @end menu
3947
3948
3949 @node Waiting For Completion
3950 @subsection Waiting For Completion
3951 @cindex cryptographic operation, wait for
3952 @cindex wait for completion
3953
3954 @deftypefun gpgme_ctx_t gpgme_wait (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_error_t *@var{status}}, @w{int @var{hang}})
3955 The function @code{gpgme_wait} continues the pending operation within
3956 the context @var{ctx}.  In particular, it ensures the data exchange
3957 between @acronym{GPGME} and the crypto backend and watches over the
3958 run time status of the backend process.
3959
3960 If @var{hang} is true, the function does not return until the
3961 operation is completed or cancelled.  Otherwise the function will not
3962 block for a long time.
3963
3964 The error status of the finished operation is returned in @var{status}
3965 if @code{gpgme_wait} does not return @code{NULL}.
3966
3967 The @var{ctx} argument can be @code{NULL}.  In that case,
3968 @code{gpgme_wait} waits for any context to complete its operation.
3969
3970 @code{gpgme_wait} can be used only in conjunction with any context
3971 that has a pending operation initiated with one of the
3972 @code{gpgme_op_*_start} functions except @code{gpgme_op_keylist_start}
3973 and @code{gpgme_op_trustlist_start} (for which you should use the
3974 corresponding @code{gpgme_op_*_next} functions).  If @var{ctx} is
3975 @code{NULL}, all of such contexts are waited upon and possibly
3976 returned.  Synchronous operations running in parallel, as well as key
3977 and trust item list operations, do not affect @code{gpgme_wait}.
3978
3979 In a multi-threaded environment, only one thread should ever call
3980 @code{gpgme_wait} at any time, irregardless if @var{ctx} is specified
3981 or not.  This means that all calls to this function should be fully
3982 synchronized by locking primitives.  It is safe to start asynchronous
3983 operations while a thread is running in @code{gpgme_wait}.
3984
3985 The function returns the @var{ctx} of the context which has finished
3986 the operation.  If @var{hang} is false, and the timeout expires,
3987 @code{NULL} is returned and @code{*status} will be set to 0.  If an
3988 error occurs, @code{NULL} is returned and the error is returned in
3989 @code{*status}.
3990 @end deftypefun
3991
3992
3993 @node Using External Event Loops
3994 @subsection Using External Event Loops
3995 @cindex event loop, external
3996
3997 @acronym{GPGME} hides the complexity of the communication between the
3998 library and the crypto engine.  The price of this convenience is that
3999 the calling thread can block arbitrary long waiting for the data
4000 returned by the crypto engine.  In single-threaded programs, in
4001 particular if they are interactive, this is an unwanted side-effect.
4002 OTOH, if @code{gpgme_wait} is used without the @var{hang} option being
4003 enabled, it might be called unnecessarily often, wasting CPU time that
4004 could be used otherwise.
4005
4006 The I/O callback interface described in this section lets the user
4007 take control over what happens when.  @acronym{GPGME} will provide the
4008 user with the file descriptors that should be monitored, and the
4009 callback functions that should be invoked when a file descriptor is
4010 ready for reading or writing.  It is then the user's responsibility to
4011 decide when to check the file descriptors and when to invoke the
4012 callback functions.  Usually this is done in an event loop, that also
4013 checks for events in other parts of the program.  If the callback
4014 functions are only called when the file descriptors are ready,
4015 @acronym{GPGME} will never block.  This gives the user mroe control
4016 over the program flow, and allows to perform other tasks when
4017 @acronym{GPGME} would block otherwise.
4018
4019 By using this advanced mechanism, @acronym{GPGME} can be integrated
4020 smoothly into GUI toolkits like GTK+ even for single-threaded
4021 programs.
4022
4023 @menu
4024 * I/O Callback Interface::        How I/O callbacks are registered.
4025 * Registering I/O Callbacks::     How to use I/O callbacks for a context.
4026 * I/O Callback Example::          An example how to use I/O callbacks.
4027 * I/O Callback Example GTK+::     How to use @acronym{GPGME} with GTK+.
4028 * I/O Callback Example GDK::      How to use @acronym{GPGME} with GDK.
4029 @end menu
4030
4031
4032 @node I/O Callback Interface
4033 @subsubsection I/O Callback Interface
4034
4035 @deftp {Data type} {gpgme_error_t (*gpgme_io_cb_t) (@w{void *@var{data}}, @w{int @var{fd}})}
4036 @tindex gpgme_io_cb_t
4037 The @code{gpgme_io_cb_t} type is the type of functions which
4038 @acronym{GPGME} wants to register as I/O callback handlers using the
4039 @code{gpgme_register_io_cb_t} functions provided by the user.
4040
4041 @var{data} and @var{fd} are provided by @acronym{GPGME} when the I/O
4042 callback handler is registered, and should be passed through to the
4043 handler when it is invoked by the user because it noticed activity on
4044 the file descriptor @var{fd}.
4045
4046 The callback handler always returns @code{0}, but you should consider
4047 the return value to be reserved for later use.
4048 @end deftp
4049
4050 @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}})}
4051 @tindex gpgme_register_io_cb_t
4052 The @code{gpgme_register_io_cb_t} type is the type of functions which can
4053 be called by @acronym{GPGME} to register an I/O callback funtion
4054 @var{fnc} for the file descriptor @var{fd} with the user.
4055 @var{fnc_data} should be passed as the first argument to @var{fnc}
4056 when the handler is invoked (the second argument should be @var{fd}).
4057 If @var{dir} is 0, @var{fnc} should be called by the user when
4058 @var{fd} is ready for writing.  If @var{dir} is 1, @var{fnc} should be
4059 called when @var{fd} is ready for reading.
4060
4061 @var{data} was provided by the user when registering the
4062 @code{gpgme_register_io_cb_t} function with @acronym{GPGME} and will always
4063 be passed as the first argument when registering a callback function.
4064 For example, the user can use this to determine the event loop to
4065 which the file descriptor should be added.
4066
4067 @acronym{GPGME} will call this function when a crypto operation is
4068 initiated in a context for which the user has registered I/O callback
4069 handler functions with @code{gpgme_set_io_cbs}.  It can also call this
4070 function when it is in an I/O callback handler for a file descriptor
4071 associated to this context.
4072
4073 The user should return a unique handle in @var{tag} identifying this
4074 I/O callback registration, which will be passed to the
4075 @code{gpgme_register_io_cb_t} function without interpretation when the file
4076 descriptor should not be monitored anymore.
4077 @end deftp
4078
4079 @deftp {Data type} {void (*gpgme_remove_io_cb_t) (@w{void *@var{tag}})}
4080 The @code{gpgme_remove_io_cb_t} type is the type of functions which can be
4081 called by @acronym{GPGME} to remove an I/O callback handler that was
4082 registered before.  @var{tag} is the handle that was returned by the
4083 @code{gpgme_register_io_cb_t} for this I/O callback.
4084
4085 @acronym{GPGME} can call this function when a crypto operation is in
4086 an I/O callback.  It will also call this function when the context is
4087 destroyed while an operation is pending.
4088 @end deftp
4089
4090 @deftp {Data type} {enum gpgme_event_io_t}
4091 @tindex gpgme_event_io_t
4092 The @code{gpgme_event_io_t} type specifies the type of an event that is
4093 reported to the user by @acronym{GPGME} as a consequence of an I/O
4094 operation.  The following events are defined:
4095
4096 @table @code
4097 @item GPGME_EVENT_START
4098 The operation is fully initialized now, and you can start to run the
4099 registered I/O callback handlers now.  Note that registered I/O
4100 callback handlers must not be run before this event is signalled.
4101 @var{type_data} is @code{NULL} and reserved for later use.
4102
4103 @item GPGME_EVENT_DONE
4104 The operation is finished, the last I/O callback for this operation
4105 was removed.  The accompanying @var{type_data} points to a
4106 @code{gpgme_error_t} variable that contains the status of the operation
4107 that finished.  This event is signalled after the last I/O callback
4108 has been removed.
4109
4110 @item GPGME_EVENT_NEXT_KEY
4111 In a @code{gpgme_op_keylist_start} operation, the next key was
4112 received from the crypto engine.  The accompanying @var{type_data} is
4113 a @code{gpgme_key_t} variable that contains the key with one reference
4114 for the user.
4115
4116 @item GPGME_EVENT_NEXT_TRUSTITEM
4117 In a @code{gpgme_op_trustlist_start} operation, the next trust item
4118 was received from the crypto engine.  The accompanying @var{type_data}
4119 is a @code{gpgme_trust_item_t} variable that contains the trust item with
4120 one reference for the user.
4121 @end table
4122 @end deftp
4123
4124 @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}})}
4125 The @code{gpgme_event_io_cb_t} type is the type of functions which can be
4126 called by @acronym{GPGME} to signal an event for an operation running
4127 in a context which has I/O callback functions registered by the user.
4128
4129 @var{data} was provided by the user when registering the
4130 @code{gpgme_event_io_cb_t} function with @acronym{GPGME} and will always be
4131 passed as the first argument when registering a callback function.
4132 For example, the user can use this to determine the context in which
4133 this event has occured.
4134
4135 @var{type} will specify the type of event that has occured.
4136 @var{type_data} specifies the event further, as described in the above
4137 list of possible @code{gpgme_event_io_t} types.
4138
4139 @acronym{GPGME} can call this function in an I/O callback handler.
4140 @end deftp
4141
4142
4143 @node Registering I/O Callbacks
4144 @subsubsection Registering I/O Callbacks
4145
4146 @deftp {Data type} {struct gpgme_io_cb_ts}
4147 @tindex gpgme_event_io_t
4148 This structure is used to store the I/O callback interface functions
4149 described in the previous section.  It has the following members:
4150
4151 @table @code
4152 @item gpgme_register_io_cb_t add
4153 This is the function called by @acronym{GPGME} to register an I/O
4154 callback handler.  It must be specified.
4155
4156 @item void *add_data
4157 This is passed as the first argument to the @code{add} function when
4158 it is called by @acronym{GPGME}.  For example, it can be used to
4159 determine the event loop to which the file descriptor should be added.
4160
4161 @item gpgme_remove_io_cb_t remove
4162 This is the function called by @acronym{GPGME} to remove an I/O
4163 callback handler.  It must be specified.
4164
4165 @item gpgme_event_io_cb_t event
4166 This is the function called by @acronym{GPGME} to signal an event for
4167 an operation.  It is optional, but if you don't specify it, you can
4168 not retrieve the return value of the operation.
4169
4170 @item void *event_data
4171 This is passed as the first argument to the @code{event} function when
4172 it is called by @acronym{GPGME}.  For example, it can be used to
4173 determine the context in which the event has occured.
4174 @end table
4175 @end deftp
4176
4177 @deftypefun void gpgme_set_io_cbs (@w{gpgme_ctx_t @var{ctx}}, @w{struct gpgme_io_cb_ts *@var{io_cbs}})
4178 The function @code{gpgme_set_io_cbs} enables the I/O callback
4179 interface for the context @var{ctx}.  The I/O callback functions are
4180 specified by @var{io_cbs}.
4181
4182 If @var{io_cbs}->@code{add} is @code{NULL}, the I/O callback interface
4183 is disabled for the context, and normal operation is restored.
4184 @end deftypefun
4185
4186 @deftypefun void gpgme_get_io_cbs (@w{gpgme_ctx_t @var{ctx}}, @w{struct gpgme_io_cb_ts *@var{io_cbs}})
4187 The function @code{gpgme_get_io_cbs} returns the I/O callback
4188 functions set with @code{gpgme_set_io_cbs} in @var{io_cbs}.
4189 @end deftypefun
4190
4191
4192 @node I/O Callback Example
4193 @subsubsection I/O Callback Example
4194
4195 To actually use an external event loop, you have to implement the I/O
4196 callback functions that are used by @acronym{GPGME} to register and
4197 unregister file descriptors.  Furthermore, you have to actually
4198 monitor these file descriptors for activity and call the appropriate
4199 I/O callbacks.
4200
4201 The following example illustrates how to do that.  The example uses
4202 locking to show in which way the the callbacks and the event loop can
4203 run concurrently.  For the event loop, we use a fixed array.  For a
4204 real-world implementation, you should use a dynamically sized
4205 structure because the number of file descriptors needed for a crypto
4206 operation in @acronym{GPGME} is not predictable.
4207
4208 @example
4209 #include <pthread.h>
4210 #include <sys/types.h>
4211 #include <gpgme.h>
4212
4213 /* The following structure holds the result of a crypto operation.  */
4214 struct op_result
4215 @{
4216   int done;
4217   gpgme_error_t err;
4218 @};
4219
4220 /* The following structure holds the data associated with one I/O
4221 callback.  */
4222 struct one_fd
4223 @{
4224   int fd;
4225   int dir;
4226   gpgme_io_cb_t fnc;
4227   void *fnc_data;
4228 @};
4229
4230 struct event_loop
4231 @{
4232   pthread_mutex_t lock;
4233 #define MAX_FDS 32
4234   /* Unused slots are marked with FD being -1.  */
4235   struct one_fd fds[MAX_FDS];
4236 @};
4237 @end example
4238
4239 The following functions implement the I/O callback interface.
4240
4241 @example
4242 gpgme_error_t
4243 add_io_cb (void *data, int fd, int dir, gpgme_io_cb_t fnc, void *fnc_data,
4244            void **r_tag)
4245 @{
4246   struct event_loop *loop = data;
4247   struct one_fd *fds = loop->fds;
4248   int i;
4249
4250   pthread_mutex_lock (&loop->lock);
4251   for (i = 0; i < MAX_FDS; i++)
4252     @{
4253       if (fds[i].fd == -1)
4254         @{
4255           fds[i].fd = fd;
4256           fds[i].dir = dir;
4257           fds[i].fnc = fnc;
4258           fds[i].fnc_data = fnc_data;
4259           break;
4260         @}
4261     @}
4262   pthread_mutex_unlock (&loop->lock);
4263   if (i == MAX_FDS)
4264     return GPGME_General_Error;
4265   *r_tag = &fds[i];
4266   return 0;
4267 @}
4268
4269 void
4270 remove_io_cb (void *tag)
4271 @{
4272   struct one_fd *fd = tag;
4273
4274   pthread_mutex_lock (&loop->lock);
4275   fd->fd = -1;
4276   pthread_mutex_unlock (&loop->lock);
4277 @}
4278
4279 void
4280 event_io_cb (void *data, gpgme_event_io_t type, void *type_data)
4281 @{
4282   struct op_result *result = data;
4283   gpgme_error_t *err = data;
4284
4285   /* We don't support list operations here.  */
4286   if (type == GPGME_EVENT_DONE)
4287     @{
4288       result->done = 1;
4289       result->err = *data;
4290     @}
4291 @}
4292 @end example
4293
4294 The final missing piece is the event loop, which will be presented
4295 next.  We only support waiting for the success of a single operation.
4296
4297 @example
4298 int
4299 do_select (struct event_loop *loop)
4300 @{
4301   fd_set rfds;
4302   fd_set wfds;
4303   int i, n;
4304   int any = 0;
4305
4306   pthread_mutex_lock (&loop->lock);
4307   FD_ZERO (&rfds);
4308   FD_ZERO (&wfds);
4309   for (i = 0; i < FDLIST_MAX; i++)
4310     if (fdlist[i].fd != -1)
4311       FD_SET (fdlist[i].fd, fdlist[i].dir ? &rfds : &wfds);
4312   pthread_mutex_unlock (&loop->unlock);
4313
4314   do
4315     @{
4316       n = select (FD_SETSIZE, &rfds, &wfds, NULL, 0);
4317     @}
4318   while (n < 0 && errno == EINTR);
4319
4320   if (n < 0)
4321     return n;   /* Error or timeout.  */
4322
4323   pthread_mutex_lock (&loop->lock);
4324   for (i = 0; i < FDLIST_MAX && n; i++)
4325     @{
4326       if (fdlist[i].fd != -1)
4327         @{
4328           if (FD_ISSET (fdlist[i].fd, fdlist[i].dir ? &rfds : &wfds))
4329             @{
4330               assert (n);
4331               n--;
4332               any = 1;
4333               /* The I/O callback handler can register/remove callbacks,
4334                  so we have to unlock the file descriptor list.  */
4335               pthread_mutex_unlock (&loop->lock);
4336               (*fdlist[i].fnc) (fdlist[i].fnc_data, fdlist[i].fd);
4337               pthread_mutex_lock (&loop->lock);
4338             @}
4339         @}
4340     @}
4341   pthread_mutex_unlock (&loop->lock);
4342   return any;
4343 @}
4344
4345 void
4346 wait_for_op (struct event_loop *loop, struct op_result *result)
4347 @{
4348   int ret;
4349
4350   do
4351     @{
4352       ret = do_select (loop);
4353     @}
4354   while (ret >= 0 && !result->done);
4355   return ret;
4356 @}
4357 @end example
4358
4359 The main function shows how to put it all together.
4360
4361 @example
4362 int
4363 main (int argc, char *argv[])
4364 @{
4365   struct event_loop loop;
4366   struct op_result result;
4367   gpgme_ctx_t ctx;
4368   gpgme_error_t err;
4369   gpgme_data_t sig, text;
4370   gpgme_sig_stat_t status;
4371   int i;
4372   struct gpgme_io_cb_ts io_cbs =
4373   @{
4374     add_io_cb,
4375     &loop,
4376     remove_io_cb,
4377     event_io_cb,
4378     &result
4379   @};
4380
4381   /* Initialize the loop structure.  */
4382   loop.lock = PTHREAD_MUTEX_INITIALIZER;
4383   for (i = 0; i < MAX_FDS; i++)
4384     loop->fds[i].fd = -1;
4385
4386   /* Initialize the result structure.  */
4387   result.done = 0;
4388
4389   err = gpgme_data_new_from_file (&sig, "signature", 1);
4390   if (!err)
4391     err = gpgme_data_new_from_file (&text, "text", 1);
4392   if (!err)
4393     err = gpgme_new (&ctx);
4394   if (!err)
4395     @{
4396        gpgme_set_io_cbs (ctx, &io_cbs);
4397        err = gpgme_op_verify_start (ctx, sig, text, &status);
4398     @}
4399   if (err)
4400     @{
4401       fprintf (stderr, "gpgme error: %s\n", gpgme_strerror (err));
4402       exit (1);
4403     @}
4404
4405   wait_for_op (&loop, &result);
4406   if (!result.done)
4407     @{
4408       fprintf (stderr, "select error\n");
4409       exit (1);
4410     @}
4411   if (!result.err)
4412     @{
4413       fprintf (stderr, "verification failed: %s\n", gpgme_strerror (result.err));
4414       exit (1);
4415     @}
4416   /* Evaluate STATUS.  */
4417   @dots{}
4418   return 0;
4419 @}
4420 @end example
4421
4422
4423 @node I/O Callback Example GTK+
4424 @subsubsection I/O Callback Example GTK+
4425 @cindex GTK+, using @acronym{GPGME} with
4426
4427 The&nb