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