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