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