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