Add item about result structures.
[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 0.
1536
1537 In all other cases, the function returns -1 and sets @var{errno}.
1538 @end deftypefun
1539
1540 @deftypefun ssize_t gpgme_data_write (@w{gpgme_data_t @var{dh}}, @w{const void *@var{buffer}}, @w{size_t @var{size}})
1541 The function @code{gpgme_data_write} writes up to @var{size} bytes
1542 starting from @var{buffer} into the data object with the handle
1543 @var{dh} at the current write position.
1544
1545 The function returns the number of bytes actually written, or -1 if an
1546 error occurs.  If an error occurs, @var{errno} is set.
1547 @end deftypefun
1548
1549 @deftypefun off_t gpgme_data_seek (@w{gpgme_data_t @var{dh}}, @w{off_t *@var{offset}}, @w{int @var{whence}})
1550 The function @code{gpgme_data_seek} changes the current read/write
1551 position.
1552
1553 The @var{whence} argument specifies how the @var{offset} should be
1554 interpreted.  It must be one of the following symbolic constants:
1555
1556 @table @code
1557 @item SEEK_SET
1558 Specifies that @var{whence} is a count of characters from the
1559 beginning of the data object.
1560
1561 @item SEEK_CUR
1562 Specifies that @var{whence} is a count of characters from the current
1563 file position.  This count may be positive or negative.
1564
1565 @item SEEK_END
1566 Specifies that @var{whence} is a count of characters from the end of
1567 the data object.  A negative count specifies a position within the
1568 current extent of the data object; a positive count specifies a
1569 position past the current end.  If you set the position past the
1570 current end, and actually write data, you will extend the data object
1571 with zeros up to that position.
1572 @end table
1573
1574 If successful, the function returns the resulting file position,
1575 measured in bytes from the beginning of the data object.  You can use
1576 this feature together with @code{SEEK_CUR} to read the current
1577 read/write position.
1578
1579 If the function fails, -1 is returned and @var{errno} is set.
1580 @end deftypefun
1581
1582 The following function is deprecated and should not be used.  It will
1583 be removed in a future version of @acronym{GPGME}.
1584
1585 @deftypefun gpgme_error_t gpgme_data_rewind (@w{gpgme_data_t @var{dh}})
1586 The function @code{gpgme_data_rewind} is equivalent to:
1587
1588 @example
1589   return (gpgme_data_seek (dh, 0, SEEK_SET) == -1)
1590     ? gpgme_error_from_errno (errno) : 0;
1591 @end example
1592 @end deftypefun
1593
1594 @c
1595 @c  gpgme_data_encoding_t
1596 @c
1597 @deftp {Data type} {enum gpgme_data_encoding_t}
1598 @tindex gpgme_data_encoding_t
1599 The @code{gpgme_data_encoding_t} type specifies the encoding of a
1600 @code{gpgme_data_t} object.  This encoding is useful to give the backend
1601 a hint on the type of data.  The following data types are available:
1602
1603 @table @code
1604 @item GPGME_DATA_ENCODING_NONE
1605 This specifies that the encoding is not known.  This is the default
1606 for a new data object.  The backend will try its best to detect the
1607 encoding automatically.
1608
1609 @item GPGME_DATA_ENCODING_BINARY
1610 This specifies that the data is encoding in binary form; i.e. there is
1611 no special encoding.
1612
1613 @item GPGME_DATA_ENCODING_BASE64
1614 This specifies that the data is encoded using the Base-64 encoding
1615 scheme as used by @acronym{MIME} and other protocols.
1616
1617 @item GPGME_DATA_ENCODING_ARMOR
1618 This specifies that the data is encoded in an armored form as used by
1619 OpenPGP and PEM.
1620 @end table
1621 @end deftp
1622
1623 @deftypefun gpgme_data_encoding_t gpgme_data_get_encoding (@w{gpgme_data_t @var{dh}})
1624 The function @code{gpgme_data_get_encoding} returns the encoding of
1625 the data object with the handle @var{dh}.  If @var{dh} is not a valid
1626 pointer (e.g. @code{NULL}) @code{GPGME_DATA_ENCODING_NONE} is
1627 returned.
1628 @end deftypefun
1629
1630 @deftypefun gpgme_error_t gpgme_data_set_encoding (@w{gpgme_data_t @var{dh}, gpgme_data_encoding_t @var{enc}})
1631 The function @code{gpgme_data_set_encoding} changes the encoding of
1632 the data object with the handle @var{dh} to @var{enc}.
1633 @end deftypefun
1634
1635
1636 @c
1637 @c    Chapter Contexts
1638 @c 
1639 @node Contexts
1640 @chapter Contexts
1641 @cindex context
1642
1643 All cryptographic operations in @acronym{GPGME} are performed within a
1644 context, which contains the internal state of the operation as well as
1645 configuration parameters.  By using several contexts you can run
1646 several cryptographic operations in parallel, with different
1647 configuration.
1648
1649 @deftp {Data type} {gpgme_ctx_t}
1650 The @code{gpgme_ctx_t} type is a handle for a @acronym{GPGME} context,
1651 which is used to hold the configuration, status and result of
1652 cryptographic operations.
1653 @end deftp
1654
1655 @menu
1656 * Creating Contexts::             Creating new @acronym{GPGME} contexts.
1657 * Destroying Contexts::           Releasing @acronym{GPGME} contexts.
1658 * Context Attributes::            Setting properties of a context.
1659 * Key Management::                Managing keys with @acronym{GPGME}.
1660 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
1661 * Crypto Operations::             Using a context for cryptography.
1662 * Run Control::                   Controlling how operations are run.
1663 @end menu
1664
1665
1666 @node Creating Contexts
1667 @section Creating Contexts
1668 @cindex context, creation
1669
1670 @deftypefun gpgme_error_t gpgme_new (@w{gpgme_ctx_t *@var{ctx}})
1671 The function @code{gpgme_data_new} creates a new @code{gpgme_ctx_t}
1672 object and returns a handle for it in @var{ctx}.
1673
1674 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1675 context was successfully created, @code{GPG_ERR_INV_VALUE} if
1676 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if not
1677 enough memory is available.
1678 @end deftypefun
1679
1680
1681 @node Destroying Contexts
1682 @section Destroying Contexts
1683 @cindex context, destruction
1684
1685 @deftypefun void gpgme_release (@w{gpgme_ctx_t @var{ctx}})
1686 The function @code{gpgme_release} destroys the context with the handle
1687 @var{ctx} and releases all associated resources.
1688 @end deftypefun
1689
1690
1691 @node Context Attributes
1692 @section Context Attributes
1693 @cindex context, attributes
1694
1695 @menu
1696 * Protocol Selection::            Selecting the protocol used by a context.
1697 * ASCII Armor::                   Requesting @acronym{ASCII} armored output.
1698 * Text Mode::                     Choosing canonical text mode.
1699 * Included Certificates::       Including a number of certificates.
1700 * Key Listing Mode::              Selecting key listing mode.
1701 * Passphrase Callback::           Getting the passphrase from the user.
1702 * Progress Meter Callback::       Being informed about the progress.
1703 @end menu
1704
1705
1706 @node Protocol Selection
1707 @subsection Protocol Selection
1708 @cindex context, selecting protocol
1709 @cindex protocol, selecting
1710
1711 @deftypefun gpgme_error_t gpgme_set_protocol (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_protocol_t @var{proto}})
1712 The function @code{gpgme_set_protocol} sets the protocol used within
1713 the context @var{ctx} to @var{proto}.  All crypto operations will be
1714 performed by the crypto engine configured for that protocol.
1715 @xref{Protocols and Engines}.
1716
1717 Setting the protocol with @code{gpgme_set_protocol} does not check if
1718 the crypto engine for that protocol is available and installed
1719 correctly.  @xref{Engine Version Check}.
1720
1721 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1722 protocol could be set successfully, and @code{GPG_ERR_INV_VALUE} if
1723 @var{protocol} is not a valid protocol.
1724 @end deftypefun
1725
1726 @deftypefun gpgme_protocol_t gpgme_get_protocol (@w{gpgme_ctx_t @var{ctx}})
1727 The function @code{gpgme_get_protocol} retrieves the protocol currently
1728 use with the context @var{ctx}.
1729 @end deftypefun
1730
1731 @c FIXME: Unfortunately, using @acronym here breaks texi2dvi.
1732 @node ASCII Armor
1733 @subsection @acronym{ASCII} Armor
1734 @cindex context, armor mode
1735 @cindex @acronym{ASCII} armor
1736 @cindex armor mode
1737
1738 @deftypefun void gpgme_set_armor (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
1739 The function @code{gpgme_set_armor} specifies if the output should be
1740 @acronym{ASCII} armored.  By default, output is not @acronym{ASCII}
1741 armored.
1742
1743 @acronym{ASCII} armored output is disabled if @var{yes} is zero, and
1744 enabled otherwise.
1745 @end deftypefun
1746
1747 @deftypefun int gpgme_get_armor (@w{gpgme_ctx_t @var{ctx}})
1748 The function @code{gpgme_get_armor} returns 1 if the output is
1749 @acronym{ASCII} armored, and @code{0} if it is not, or if @var{ctx} is
1750 not a valid pointer.
1751 @end deftypefun
1752
1753
1754 @node Text Mode
1755 @subsection Text Mode
1756 @cindex context, text mode
1757 @cindex text mode
1758 @cindex canonical text mode
1759
1760 @deftypefun void gpgme_set_textmode (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{yes}})
1761 The function @code{gpgme_set_textmode} specifies if canonical text mode
1762 should be used.  By default, text mode is not used.
1763
1764 Text mode is for example used for the RFC2015 signatures; note that
1765 the updated RFC 3156 mandates that the mail user agent does some
1766 preparations so that text mode is not needed anymore.
1767
1768 This option is only relevant to the OpenPGP crypto engine, and ignored
1769 by all other engines.
1770
1771 Canonical text mode is disabled if @var{yes} is zero, and enabled
1772 otherwise.
1773 @end deftypefun
1774
1775 @deftypefun int gpgme_get_textmode (@w{gpgme_ctx_t @var{ctx}})
1776 The function @code{gpgme_get_textmode} returns 1 if canonical text
1777 mode is enabled, and @code{0} if it is not, or if @var{ctx} is not a
1778 valid pointer.
1779 @end deftypefun
1780
1781
1782 @node Included Certificates
1783 @subsection Included Certificates
1784 @cindex certificates, included
1785
1786 @deftypefun void gpgme_set_include_certs (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{nr_of_certs}})
1787 The function @code{gpgme_set_include_certs} specifies how many
1788 certificates should be included in an S/MIME signed message.  By
1789 default, only the sender's certificate is included.  The possible
1790 values of @var{nr_of_certs} are:
1791
1792 @table @code
1793 @item -2
1794 Include all certificates except the root certificate.
1795 @item -1
1796 Include all certificates.
1797 @item 0
1798 Include no certificates.
1799 @item 1
1800 Include the sender's certificate only.
1801 @item n
1802 Include the first n certificates of the certificates path, starting
1803 from the sender's certificate.  The number @code{n} must be positive.
1804 @end table
1805
1806 Values of @var{nr_of_certs} smaller than -2 are undefined.
1807
1808 This option is only relevant to the CMS crypto engine, and ignored by
1809 all other engines.
1810 @end deftypefun
1811
1812 @deftypefun int gpgme_get_include_certs (@w{gpgme_ctx_t @var{ctx}})
1813 The function @code{gpgme_get_include_certs} returns the number of
1814 certificates to include into an S/MIME signed message.
1815 @end deftypefun
1816
1817
1818 @node Key Listing Mode
1819 @subsection Key Listing Mode
1820 @cindex key listing mode
1821 @cindex key listing, mode of
1822
1823 @deftypefun void gpgme_set_keylist_mode (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_keylist_mode_t @var{mode}})
1824 The function @code{gpgme_set_keylist_mode} changes the default
1825 behaviour of the key listing functions.  The value in @var{mode} is a
1826 bitwise-or combination of one or multiple of the following bit values:
1827
1828 @table @code
1829 @item GPGME_KEYLIST_MODE_LOCAL
1830 The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
1831 keyring should be searched for keys in the keylisting operation.  This
1832 is the default.
1833
1834 @item GPGME_KEYLIST_MODE_EXTERN
1835 The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
1836 source should be searched for keys in the keylisting
1837 operation.  The type of external source is dependant on the crypto
1838 engine used.  For example, it can be a remote keyserver or LDAP
1839 certificate server.
1840
1841 @item GPGME_KEYLIST_MODE_SIGS
1842 The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key
1843 signatures should be included in the listed keys.
1844 @end table
1845
1846 At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
1847 @code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
1848 compatibility, you should get the current mode with
1849 @code{gpgme_get_keylist_mode} and modify it by setting or clearing the
1850 appropriate bits, and then using that calulcated value in the
1851 @code{gpgme_set_keylisting_mode} operation.  This will leave all other
1852 bits in the mode value intact (in particular those that are not used
1853 in the current version of the library).
1854
1855 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
1856 mode could be set correctly, and @code{GPG_ERR_INV_VALUE} if @var{ctx}
1857 is not a valid pointer or @var{mode} is not a valid mode.
1858 @end deftypefun
1859
1860
1861 @deftypefun gpgme_keylist_mode_t gpgme_get_keylist_mode (@w{gpgme_ctx_t @var{ctx}})
1862 The function @code{gpgme_get_keylist_mode} returns the current key
1863 listing mode of the context @var{ctx}.  This value can then be
1864 modified and used in a subsequent @code{gpgme_set_keylist_mode}
1865 operation to only affect the desired bits (and leave all others
1866 intact).
1867
1868 The function returns 0 if @var{ctx} is not a valid pointer, and the
1869 current mode otherwise.  Note that 0 is not a valid mode value.
1870 @end deftypefun
1871
1872
1873 @node Passphrase Callback
1874 @subsection Passphrase Callback
1875 @cindex callback, passphrase
1876 @cindex passphrase callback
1877
1878 @deftp {Data type} {gpgme_error_t (*gpgme_passphrase_cb_t)(void *@var{hook}, const char *@var{uid_hint}, const char *@var{passphrase_info}, @w{int @var{prev_was_bad}}, @w{int @var{fd}})}
1879 @tindex gpgme_passphrase_cb_t
1880 The @code{gpgme_passphrase_cb_t} type is the type of functions usable as
1881 passphrase callback function.
1882
1883 The argument @var{uid_hint} might contain a string that gives an
1884 indication for which user ID the passphrase is required.  If this is
1885 not available, or not applicable (in the case of symmetric encryption,
1886 for example), @var{uid_hint} will be @code{NULL}.
1887
1888 The argument @var{passphrase_info}, if not @code{NULL}, will give
1889 further information about the context in which the passphrase is
1890 required.  This information is engine and operation specific.
1891
1892 If this is the repeated attempt to get the passphrase, because
1893 previous attempts failed, then @var{prev_was_bad} is 1, otherwise it
1894 will be 0.
1895
1896 The user must write the passphrase, followed by a newline character,
1897 to the file descriptor @var{fd}.  If the user does not return 0
1898 indicating success, the user must at least write a newline character
1899 before returning from the callback.
1900
1901 If an error occurs, return the corresponding @code{gpgme_error_t}
1902 value.  You can use the error code @code{GPG_ERR_CANCELED} to abort
1903 the operation.  Otherwise, return @code{0}.
1904 @end deftp
1905
1906 @deftypefun void gpgme_set_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t @var{passfunc}}, @w{void *@var{hook_value}})
1907 The function @code{gpgme_set_passphrase_cb} sets the function that is
1908 used when a passphrase needs to be provided by the user to
1909 @var{passfunc}.  The function @var{passfunc} needs to implemented by
1910 the user, and whenever it is called, it is called with its first
1911 argument being @var{hook_value}.  By default, no passphrase callback
1912 function is set.
1913
1914 Not all crypto engines require this callback to retrieve the
1915 passphrase.  It is better if the engine retrieves the passphrase from
1916 a trusted agent (a daemon process), rather than having each user to
1917 implement their own passphrase query.
1918
1919 The user can disable the use of a passphrase callback function by
1920 calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
1921 @code{NULL}.
1922 @end deftypefun
1923
1924 @deftypefun void gpgme_get_passphrase_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_passphrase_cb_t *@var{passfunc}}, @w{void **@var{hook_value}})
1925 The function @code{gpgme_get_passphrase_cb} returns the function that
1926 is used when a passphrase needs to be provided by the user in
1927 @var{*passfunc}, and the first argument for this function in
1928 @var{*hook_value}.  If no passphrase callback is set, or @var{ctx} is
1929 not a valid pointer, @code{NULL} is returned in both variables.
1930
1931 @var{passfunc} or @var{hook_value} can be @code{NULL}.  In this case,
1932 the corresponding value will not be returned.
1933 @end deftypefun
1934
1935
1936 @node Progress Meter Callback
1937 @subsection Progress Meter Callback
1938 @cindex callback, progress meter
1939 @cindex progress meter callback
1940
1941 @deftp {Data type} {void (*gpgme_progress_cb_t)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
1942 @tindex gpgme_progress_cb_t
1943 The @code{gpgme_progress_cb_t} type is the type of functions usable as
1944 progress callback function.
1945
1946 The arguments are specific to the crypto engine.  More information
1947 about the progress information returned from the GnuPG engine can be
1948 found in the GnuPG source code in the file @file{doc/DETAILS} in the
1949 section PROGRESS.
1950 @end deftp
1951
1952 @deftypefun void gpgme_set_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t @var{progfunc}}, @w{void *@var{hook_value}})
1953 The function @code{gpgme_set_progress_cb} sets the function that is
1954 used when progress information about a cryptographic operation is
1955 available.  The function @var{progfunc} needs to implemented by the
1956 user, and whenever it is called, it is called with its first argument
1957 being @var{hook_value}.  By default, no progress callback function
1958 is set.
1959
1960 Setting a callback function allows an interactive program to display
1961 progress information about a long operation to the user.
1962
1963 The user can disable the use of a progress callback function by
1964 calling @code{gpgme_set_progress_cb} with @var{progfunc} being
1965 @code{NULL}.
1966 @end deftypefun
1967
1968 @deftypefun void gpgme_get_progress_cb (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_progress_cb_t *@var{progfunc}}, @w{void **@var{hook_value}})
1969 The function @code{gpgme_get_progress_cb} returns the function that is
1970 used to inform the user about the progress made in @var{*progfunc},
1971 and the first argument for this function in @var{*hook_value}.  If no
1972 progress callback is set, or @var{ctx} is not a valid pointer,
1973 @code{NULL} is returned in both variables.
1974
1975 @var{progfunc} or @var{hook_value} can be @code{NULL}.  In this case,
1976 the corresponding value will not be returned.
1977 @end deftypefun
1978
1979
1980 @node Key Management
1981 @section Key Management
1982 @cindex key management
1983
1984 Some of the cryptographic operations require that recipients or
1985 signers are specified.  This is always done by specifying the
1986 respective keys that should be used for the operation.  The following
1987 section describes how such keys can be selected and manipulated.
1988
1989 @deftp {Data type} gpgme_sub_key_t
1990 The @code{gpgme_sub_key_t} type is a pointer to a subkey structure.
1991 Sub keys are one component of a @code{gpgme_key_t} object.  In fact,
1992 subkeys are those parts that contains the real information about the
1993 individual cryptographic keys that belong to the same key object.  One
1994 @code{gpgme_key_t} can contain several subkeys.  The first subkey in
1995 the linked list is also called the primary key.
1996
1997 The subkey structure has the following members:
1998
1999 @table @code
2000 @item gpgme_sub_key_t next
2001 This is a pointer to the next subkey structure in the linked list, or
2002 @code{NULL} if this is the last element.
2003
2004 @item unsigned int revoked : 1
2005 This is true if the subkey is revoked.
2006
2007 @item unsigned int expired : 1
2008 This is true if the subkey is expired.
2009
2010 @item unsigned int disabled : 1
2011 This is true if the subkey is disabled.
2012
2013 @item unsigned int invalid : 1
2014 This is true if the subkey is invalid.
2015
2016 @item unsigned int can_encrypt : 1
2017 This is true if the subkey can be used for encryption.
2018
2019 @item unsigned int can_sign : 1
2020 This is true if the subkey can be used to create data signatures.
2021
2022 @item unsigned int can_certify : 1
2023 This is true if the subkey can be used to create key certificates.
2024
2025 @item unsigned int secret : 1
2026 This is true if the subkey is a secret key.
2027
2028 @item gpgme_pubkey_algo_t pubkey_algo
2029 This is the public key algorithm supported by this subkey.
2030
2031 @item unsigned int length
2032 This is the length of the subkey (in bits).
2033
2034 @item char *keyid
2035 This is the key ID of the subkey in hexadecimal digits.
2036
2037 @item char *fpr
2038 This is the fingerprint of the subkey in hexadecimal digits, if
2039 available.  This is usually only available for the primary key.
2040
2041 @item long int timestamp
2042 This is the creation timestamp of the subkey.  This is -1 if the
2043 timestamp is invalid, and 0 if it is not available.
2044
2045 @item long int expires
2046 This is the expiration timestamp of the subkey, or 0 if the subkey
2047 does not expire.
2048 @end table
2049 @end deftp
2050
2051 @deftp {Data type} gpgme_key_sig_t
2052 The @code{gpgme_key_sig_t} type is a pointer to a key signature structure.
2053 Key signatures are one component of a @code{gpgme_key_t} object, and
2054 validate user IDs on the key.
2055
2056 The signatures on a key are only available if the key was retrieved
2057 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
2058 enabled, because it is expensive to retrieve all signatures of a key.
2059
2060 The key signature structure has the following members:
2061
2062 @table @code
2063 @item gpgme_key_sig_t next
2064 This is a pointer to the next key signature structure in the linked
2065 list, or @code{NULL} if this is the last element.
2066
2067 @item unsigned int revoked : 1
2068 This is true if the key signature is a revocation signature.
2069
2070 @item unsigned int expired : 1
2071 This is true if the key signature is expired.
2072
2073 @item unsigned int invalid : 1
2074 This is true if the key signature is invalid.
2075
2076 @item unsigned int disabled : 1
2077 This is true if the key signature is exportable.
2078
2079 @item gpgme_pubkey_algo_t pubkey_algo
2080 This is the public key algorithm used to create the signature.
2081
2082 @item char *keyid
2083 This is the key ID of the key (in hexadecimal digits) used to create
2084 the signature.
2085
2086 @item long int timestamp
2087 This is the creation timestamp of the key signature.  This is -1 if
2088 the timestamp is invalid, and 0 if it is not available.
2089
2090 @item long int expires
2091 This is the expiration timestamp of the key signature, or 0 if the key
2092 signature does not expire.
2093
2094 @item gpgme_error_t status
2095 This is the status of the signature and has the same meaning as the
2096 member of the same name in a @code{gpgme_signature_t} object.
2097
2098 @item unsigned int class
2099 This specifies the signature class of the key signature.  The meaning
2100 is specific to the crypto engine.
2101
2102 @item char *uid
2103 This is the main user ID of the key used to create the signature.
2104
2105 @item char *name
2106 This is the name component of @code{uid}, if available.
2107
2108 @item char *comment
2109 This is the comment component of @code{uid}, if available.
2110
2111 @item char *email
2112 This is the email component of @code{uid}, if available.
2113 @end table
2114 @end deftp
2115
2116 @deftp {Data type} gpgme_user_id_t
2117 A user ID is a component of a @code{gpgme_key_t} object.  One key can
2118 have many user IDs.  The first one in the list is the main (or
2119 primary) user ID.
2120
2121 The user ID structure has the following members.
2122
2123 @table @code
2124 @item gpgme_user_id_t next
2125 This is a pointer to the next user ID structure in the linked list, or
2126 @code{NULL} if this is the last element.
2127
2128 @item unsigned int revoked : 1
2129 This is true if the user ID is revoked.
2130
2131 @item unsigned int invalid : 1
2132 This is true if the user ID is invalid.
2133
2134 @item gpgme_validity_t validity
2135 This specifies the validity of the user ID.
2136
2137 @item char *uid
2138 This is the user ID string.
2139
2140 @item char *name
2141 This is the name component of @code{uid}, if available.
2142
2143 @item char *comment
2144 This is the comment component of @code{uid}, if available.
2145
2146 @item char *email
2147 This is the email component of @code{uid}, if available.
2148
2149 @item gpgme_key_sig_t signatures
2150 This is a linked list with the signatures on this user ID.
2151 @end table
2152 @end deftp
2153
2154 @deftp {Data type} gpgme_key_t
2155 The @code{gpgme_key_t} type is a pointer to a key object.  It has the
2156 following members:
2157
2158 @table @code
2159 @item unsigned int revoked : 1
2160 This is true if the key is revoked.
2161
2162 @item unsigned int expired : 1
2163 This is true if the key is expired.
2164
2165 @item unsigned int disabled : 1
2166 This is true if the key is disabled.
2167
2168 @item unsigned int invalid : 1
2169 This is true if the key is invalid.
2170
2171 @item unsigned int can_encrypt : 1
2172 This is true if the key (ie one of its subkeys) can be used for
2173 encryption.
2174
2175 @item unsigned int can_sign : 1
2176 This is true if the key (ie one of its subkeys) can be used to create
2177 data signatures.
2178
2179 @item unsigned int can_certify : 1
2180 This is true if the key (ie one of its subkeys) can be used to create
2181 key certificates.
2182
2183 @item unsigned int secret : 1
2184 This is true if the key is a secret key.
2185
2186 @item gpgme_protocol_t protocol
2187 This is the protocol supported by this key.
2188
2189 @item char *issuer_serial
2190 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
2191 issuer serial.
2192
2193 @item char *issuer_name
2194 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
2195 issuer name.
2196
2197 @item char *chain_id
2198 If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the
2199 chain ID, which can be used to built the certificate chain.
2200  
2201 @item gpgme_validity_t owner_trust
2202 If @code{protocol} is @code{GPGME_PROTOCOL_OpenPGP}, then this is the
2203 owner trust.
2204
2205 @item gpgme_sub_key_t subkeys
2206 This is a linked list with the subkeys of the key.  The first subkey
2207 in the list is the primary key and usually available.
2208
2209 @item gpgme_user_id_t uids
2210 This is a linked list with the user IDs of the key.  The first user ID
2211 in the list is the main (or primary) user ID.
2212 @end table
2213 @end deftp
2214
2215 @menu
2216 * Listing Keys::                  Browsing the list of available keys.
2217 * Information About Keys::        Requesting detailed information about keys.
2218 * Key Signatures::                Listing the signatures on a key.
2219 * Manipulating Keys::             Operations on keys.
2220 * Generating Keys::               Creating new key pairs.
2221 * Exporting Keys::                Retrieving key data from the key ring.
2222 * Importing Keys::                Adding keys to the key ring.
2223 * Deleting Keys::                 Removing keys from the key ring.
2224 @end menu
2225
2226
2227 @node Listing Keys
2228 @subsection Listing Keys
2229 @cindex listing keys
2230 @cindex key listing
2231 @cindex key listing, start
2232 @cindex key ring, list
2233 @cindex key ring, search
2234
2235 @deftypefun gpgme_error_t gpgme_op_keylist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
2236 The function @code{gpgme_op_keylist_start} initiates a key listing
2237 operation inside the context @var{ctx}.  It sets everything up so that
2238 subsequent invocations of @code{gpgme_op_keylist_next} return the keys
2239 in the list.
2240
2241 If @var{pattern} is @code{NULL}, all available keys are returned.
2242 Otherwise, @var{pattern} contains an engine specific expression that
2243 is used to limit the list to all keys matching the pattern.
2244
2245 If @var{secret_only} is not @code{0}, the list is restricted to secret
2246 keys only.
2247
2248 The context will be busy until either all keys are received (and
2249 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
2250 @code{gpgme_op_keylist_end} is called to finish the operation.
2251
2252 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2253 @var{ctx} is not a valid pointer, and passes through any errors that
2254 are reported by the crypto engine support routines.
2255 @end deftypefun
2256
2257 @deftypefun gpgme_error_t gpgme_op_keylist_ext_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}[]}, @w{int @var{secret_only}}, @w{int @var{reserved}})
2258 The function @code{gpgme_op_keylist_ext_start} initiates an extended
2259 key listing operation inside the context @var{ctx}.  It sets
2260 everything up so that subsequent invocations of
2261 @code{gpgme_op_keylist_next} return the keys in the list.
2262
2263 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
2264 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
2265 array of strings that are used to limit the list to all keys matching
2266 at least one of the patterns verbatim.
2267
2268 If @var{secret_only} is not @code{0}, the list is restricted to secret
2269 keys only.
2270
2271 The value of @var{reserved} must be @code{0}.
2272
2273 The context will be busy until either all keys are received (and
2274 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}), or
2275 @code{gpgme_op_keylist_end} is called to finish the operation.
2276
2277 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2278 @var{ctx} is not a valid pointer, and passes through any errors that
2279 are reported by the crypto engine support routines.
2280 @end deftypefun
2281
2282 @deftypefun gpgme_error_t gpgme_op_keylist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t *@var{r_key}})
2283 The function @code{gpgme_op_keylist_next} returns the next key in the
2284 list created by a previous @code{gpgme_op_keylist_start} operation in
2285 the context @var{ctx}.  The key will have one reference for the user.
2286 @xref{Manipulating Keys}.
2287
2288 This is the only way to get at @code{gpgme_key_t} objects in
2289 @acronym{GPGME}.
2290
2291 If the last key in the list has already been returned,
2292 @code{gpgme_op_keylist_next} returns @code{GPG_ERR_EOF}.
2293
2294 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2295 @var{ctx} or @var{r_key} is not a valid pointer, and
2296 @code{GPG_ERR_ENOMEM} if there is not enough memory for the operation.
2297 @end deftypefun
2298
2299 @deftypefun gpgme_error_t gpgme_op_keylist_end (@w{gpgme_ctx_t @var{ctx}})
2300 The function @code{gpgme_op_keylist_next} ends a pending key list
2301 operation in the context @var{ctx}.
2302
2303 After the operation completed successfully, the result of the key
2304 listing operation can be retrieved with
2305 @code{gpgme_op_keylist_result}.
2306
2307 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2308 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if at some
2309 time during the operation there was not enough memory available.
2310 @end deftypefun
2311
2312 The following example illustrates how all keys containing a certain
2313 string (@code{g10code}) can be listed with their key ID and the name
2314 and e-mail address of the main user ID:
2315
2316 @example
2317 gpgme_ctx_t ctx;
2318 gpgme_error_t err = gpgme_new (&ctx);
2319
2320 if (!err)
2321   @{
2322     err = gpgme_op_keylist_start (ctx, "g10code", 0);
2323     while (!err)
2324       @{
2325         err = gpgme_op_keylist_next (ctx, &key);
2326         if (err)
2327           break;
2328         printf ("%s: %s <%s>\n", key->keyid, key->name, key->email);
2329         gpgme_key_release (key);
2330       @}
2331     gpgme_release (ctx);
2332   @}
2333 if (gpg_err_code (err) != GPG_ERR_EOF)
2334   @{
2335     fprintf (stderr, "%s: can not list keys: %s\n",
2336              argv[0], gpgme_strerror (err));
2337     exit (1);
2338   @}
2339 @end example
2340
2341 @deftp {Data type} {gpgme_keylist_result_t}
2342 This is a pointer to a structure used to store the result of a
2343 @code{gpgme_op_keylist_*} operation.  After successfully ending a key
2344 listing operation, you can retrieve the pointer to the result with
2345 @code{gpgme_op_keylist_result}.  The structure contains the following
2346 member:
2347
2348 @table @code
2349 @item unsigned int truncated : 1
2350 This is true if the crypto backend had to truncate the result, and
2351 less than the desired keys could be listed.
2352 @end table
2353 @end deftp
2354
2355 @deftypefun gpgme_keylist_result_t gpgme_op_keylist_result (@w{gpgme_ctx_t @var{ctx}})
2356 The function @code{gpgme_op_keylist_result} returns a
2357 @code{gpgme_keylist_result_t} pointer to a structure holding the
2358 result of a @code{gpgme_op_keylist_*} operation.  The pointer is only
2359 valid if the last operation on the context was a key listing
2360 operation, and if this operation finished successfully.  The returned
2361 pointer is only valid until the next operation is started on the
2362 context.
2363 @end deftypefun
2364
2365 In a simple program, for which a blocking operation is acceptable, the
2366 following function can be used to retrieve a single key.
2367
2368 @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}})
2369 The function @code{gpgme_get_key} gets the key with the fingerprint
2370 (or key ID) @var{fpr} from the crypto backend and return it in
2371 @var{r_key}.  If @var{secret} is true, get the secret key.  The
2372 currently active keylist mode is used to retrieve the key.
2373
2374 If the key is not found in the keyring, @code{gpgme_get_key} returns
2375 the error code @code{GPG_ERR_NO_ERROR} and *@var{r_key} will be set to
2376 @code{NULL}.
2377
2378 The function returns the error code @code{GPG_ERR_INV_VALUE} if
2379 @var{ctx} or @var{r_key} is not a valid pointer or @var{fpr} is not a
2380 fingerprint or key ID, and @code{GPG_ERR_ENOMEM} if at some time
2381 during the operation there was not enough memory available.
2382 @end deftypefun
2383
2384
2385 @node Information About Keys
2386 @subsection Information About Keys
2387 @cindex key, information about
2388 @cindex key, attributes
2389 @cindex attributes, of a key
2390
2391 Please see the beginning of this section for more information about
2392 @code{gpgme_key_t} objects.
2393
2394 @deftp {Data type} gpgme_validity_t
2395 The @code{gpgme_validity_t} type is used to specify the validity of a user ID
2396 in a key.  The following validities are defined:
2397
2398 @table @code
2399 @item GPGME_VALIDITY_UNKNOWN
2400 The user ID is of unknown validity.  The string representation of this
2401 validity is ``?''.
2402
2403 @item GPGME_VALIDITY_UNDEFINED
2404 The validity of the user ID is undefined.  The string representation of this
2405 validity is ``q''.
2406
2407 @item GPGME_VALIDITY_NEVER
2408 The user ID is never valid.  The string representation of this
2409 validity is ``n''.
2410
2411 @item GPGME_VALIDITY_MARGINAL
2412 The user ID is marginally valid.  The string representation of this
2413 validity is ``m''.
2414
2415 @item GPGME_VALIDITY_FULL
2416 The user ID is fully valid.  The string representation of this
2417 validity is ``f''.
2418
2419 @item GPGME_VALIDITY_ULTIMATE
2420 The user ID is ultimately valid.  The string representation of this
2421 validity is ``u''.
2422 @end table
2423 @end deftp
2424
2425
2426 The following interfaces are deprecated and only provided for backward
2427 compatibility.  Don't use them.  They will be removed in a future
2428 version of @acronym{GPGME}.
2429
2430 @deftp {Data type} gpgme_attr_t
2431 The @code{gpgme_attr_t} type is used to specify a key or trust item
2432 attribute.  The following attributes are defined:
2433
2434 @table @code
2435 @item GPGME_ATTR_KEYID
2436 This is the key ID of a sub key.  It is representable as a string.
2437
2438 For trust items, the trust item refers to the key with this ID.
2439
2440 @item GPGME_ATTR_FPR
2441 This is the fingerprint of a sub key.  It is representable as a
2442 string.
2443
2444 @item GPGME_ATTR_ALGO
2445 This is the crypto algorithm for which the sub key can be used.  It
2446 is representable as a string and as a number.  The numbers correspond
2447 to the @code{enum gcry_pk_algos} values in the gcrypt library.
2448
2449 @item GPGME_ATTR_LEN
2450 This is the key length of a sub key.  It is representable as a
2451 number.
2452
2453 @item GPGME_ATTR_CREATED
2454 This is the timestamp at creation time of a sub key.  It is
2455 representable as a number.
2456
2457 @item GPGME_ATTR_EXPIRE
2458 This is the expiration time of a sub key.  It is representable as a
2459 number.
2460
2461 @item GPGME_ATTR_OTRUST
2462 XXX FIXME  (also for trust items)
2463
2464 @item GPGME_ATTR_USERID
2465 This is a user ID.  There can be more than one user IDs in a
2466 @var{gpgme_key_t} object.  The first one (with index 0) is the primary
2467 user ID.  The user ID is representable as a number.
2468
2469 For trust items, this is the user ID associated with this trust item.
2470
2471 @item GPGME_ATTR_NAME
2472 This is the name belonging to a user ID.  It is representable as a string.
2473
2474 @item GPGME_ATTR_EMAIL
2475 This is the email address belonging to a user ID.  It is representable
2476 as a string.
2477
2478 @item GPGME_ATTR_COMMENT
2479 This is the comment belonging to a user ID.  It is representable as a
2480 string.
2481
2482 @item GPGME_ATTR_VALIDITY
2483 This is the validity belonging to a user ID.  It is representable as a
2484 string and as a number.  See below for a list of available validities.
2485
2486 For trust items, this is the validity that is associated with this
2487 trust item.
2488
2489 @item GPGME_ATTR_UID_REVOKED
2490 This specifies if a user ID is revoked.  It is representable as a
2491 number, and is @code{1} if the user ID is revoked, and @code{0}
2492 otherwise.
2493
2494 @item GPGME_ATTR_UID_INVALID
2495 This specifies if a user ID is invalid.  It is representable as a
2496 number, and is @code{1} if the user ID is invalid, and @code{0}
2497 otherwise.
2498
2499 @item GPGME_ATTR_LEVEL
2500 This is the trust level of a trust item.
2501
2502 @item GPGME_ATTR_TYPE
2503 This returns information about the type of key.  For the string function
2504 this will eother be "PGP" or "X.509".  The integer function returns 0
2505 for PGP and 1 for X.509.  It is also used for the type of a trust item.
2506
2507 @item GPGME_ATTR_IS_SECRET
2508 This specifies if the key is a secret key.  It is representable as a
2509 number, and is @code{1} if the key is revoked, and @code{0} otherwise.
2510
2511 @item GPGME_ATTR_KEY_REVOKED
2512 This specifies if a sub key is revoked.  It is representable as a
2513 number, and is @code{1} if the key is revoked, and @code{0} otherwise.
2514
2515 @item GPGME_ATTR_KEY_INVALID
2516 This specifies if a sub key is invalid.  It is representable as a
2517 number, and is @code{1} if the key is invalid, and @code{0} otherwise.
2518
2519 @item GPGME_ATTR_KEY_EXPIRED
2520 This specifies if a sub key is expired.  It is representable as a
2521 number, and is @code{1} if the key is expired, and @code{0} otherwise.
2522
2523 @item GPGME_ATTR_KEY_DISABLED
2524 This specifies if a sub key is disabled.  It is representable as a
2525 number, and is @code{1} if the key is disabled, and @code{0} otherwise.
2526
2527 @item GPGME_ATTR_KEY_CAPS
2528 This is a description of the capabilities of a sub key.  It is
2529 representable as a string.  The string contains the letter ``e'' if
2530 the key can be used for encryption, ``s'' if the key can be used for
2531 signatures, and ``c'' if the key can be used for certifications.
2532
2533 @item GPGME_ATTR_CAN_ENCRYPT
2534 This specifies if a sub key can be used for encryption.  It is
2535 representable as a number, and is @code{1} if the sub key can be used
2536 for encryption, and @code{0} otherwise.
2537
2538 @item GPGME_ATTR_CAN_SIGN
2539 This specifies if a sub key can be used to create data signatures.  It
2540 is representable as a number, and is @code{1} if the sub key can be
2541 used for signatures, and @code{0} otherwise.
2542
2543 @item GPGME_ATTR_CAN_CERTIFY
2544 This specifies if a sub key can be used to create key certificates.
2545 It is representable as a number, and is @code{1} if the sub key can be
2546 used for certifications, and @code{0} otherwise.
2547
2548 @item GPGME_ATTR_SERIAL
2549 The X.509 issuer serial attribute of the key.  It is representable as
2550 a string.
2551
2552 @item GPGME_ATTR_ISSUE
2553 The X.509 issuer name attribute of the key.  It is representable as a
2554 string.
2555
2556 @item GPGME_ATTR_CHAINID
2557 The X.509 chain ID can be used to build the certification chain.  It
2558 is representable as a string.
2559 @end table
2560 @end deftp
2561
2562 @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}})
2563 The function @code{gpgme_key_get_string_attr} returns the value of the
2564 string-representable attribute @var{what} of key @var{key}.  If the
2565 attribute is an attribute of a sub key or an user ID, @var{idx}
2566 specifies the sub key or user ID of which the attribute value is
2567 returned.  The argument @var{reserved} is reserved for later use and
2568 should be @code{NULL}.
2569
2570 The string returned is only valid as long as the key is valid.
2571
2572 The function returns @code{0} if an attribute can't be returned as a
2573 string, @var{key} is not a valid pointer, @var{idx} out of range,
2574 or @var{reserved} not @code{NULL}.
2575 @end deftypefun
2576
2577 @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}})
2578 The function @code{gpgme_key_get_ulong_attr} returns the value of the
2579 number-representable attribute @var{what} of key @var{key}.  If the
2580 attribute is an attribute of a sub key or an user ID, @var{idx}
2581 specifies the sub key or user ID of which the attribute value is
2582 returned.  The argument @var{reserved} is reserved for later use and
2583 should be @code{NULL}.
2584
2585 The function returns @code{0} if the attribute can't be returned as a
2586 number, @var{key} is not a valid pointer, @var{idx} out of range, or
2587 @var{reserved} not @code{NULL}.
2588 @end deftypefun
2589
2590
2591 @node Key Signatures
2592 @subsection Key Signatures
2593 @cindex key, signatures
2594 @cindex signatures, on a key
2595
2596 The following interfaces are deprecated and only provided for backward
2597 compatibility.  Don't use them.  They will be removed in a future
2598 version of @acronym{GPGME}.
2599
2600 The signatures on a key are only available if the key was retrieved
2601 via a listing operation with the @code{GPGME_KEYLIST_MODE_SIGS} mode
2602 enabled, because it is expensive to retrieve all signatures of a key.
2603
2604 So, before using the below interfaces to retrieve the signatures on a
2605 key, you have to make sure that the key was listed with signatures
2606 enabled.  One convenient, but blocking, way to do this is to use the
2607 function @code{gpgme_get_key}.
2608
2609 @deftp {Data type} gpgme_attr_t
2610 The @code{gpgme_attr_t} type is used to specify a key signature
2611 attribute.  The following attributes are defined:
2612
2613 @table @code
2614 @item GPGME_ATTR_KEYID
2615 This is the key ID of the key which was used for the signature.  It is
2616 representable as a string.
2617
2618 @item GPGME_ATTR_ALGO
2619 This is the crypto algorithm used to create the signature.  It is
2620 representable as a string and as a number.  The numbers correspond to
2621 the @code{enum gcry_pk_algos} values in the gcrypt library.
2622
2623 @item GPGME_ATTR_CREATED
2624 This is the timestamp at creation time of the signature.  It is
2625 representable as a number.
2626
2627 @item GPGME_ATTR_EXPIRE
2628 This is the expiration time of the signature.  It is representable as
2629 a number.
2630
2631 @item GPGME_ATTR_USERID
2632 This is the user ID associated with the signing key.  The user ID is
2633 representable as a number.
2634
2635 @item GPGME_ATTR_NAME
2636 This is the name belonging to a user ID.  It is representable as a string.
2637
2638 @item GPGME_ATTR_EMAIL
2639 This is the email address belonging to a user ID.  It is representable
2640 as a string.
2641
2642 @item GPGME_ATTR_COMMENT
2643 This is the comment belonging to a user ID.  It is representable as a
2644 string.
2645
2646 @item GPGME_ATTR_KEY_REVOKED
2647 This specifies if a key signature is a revocation signature.  It is
2648 representable as a number, and is @code{1} if the key is revoked, and
2649 @code{0} otherwise.
2650
2651 @c @item GPGME_ATTR_KEY_EXPIRED
2652 @c This specifies if a key signature is expired.  It is representable as
2653 @c a number, and is @code{1} if the key is revoked, and @code{0}
2654 @c otherwise.
2655 @c
2656 @item GPGME_ATTR_SIG_CLASS
2657 This specifies the signature class of a key signature.  It is
2658 representable as a number.  The meaning is specific to the crypto
2659 engine.
2660
2661 @item GPGME_ATTR_SIG_CLASS
2662 This specifies the signature class of a key signature.  It is
2663 representable as a number.  The meaning is specific to the crypto
2664 engine.
2665
2666 @item GPGME_ATTR_SIG_STATUS
2667 This is the same value as returned by @code{gpgme_get_sig_status}.
2668 @end table
2669 @end deftp
2670
2671 @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}})
2672 The function @code{gpgme_key_sig_get_string_attr} returns the value of
2673 the string-representable attribute @var{what} of the signature
2674 @var{idx} on the user ID @var{uid_idx} in the key @var{key}.  The
2675 argument @var{reserved} is reserved for later use and should be
2676 @code{NULL}.
2677
2678 The string returned is only valid as long as the key is valid.
2679
2680 The function returns @code{0} if an attribute can't be returned as a
2681 string, @var{key} is not a valid pointer, @var{uid_idx} or @var{idx}
2682 out of range, or @var{reserved} not @code{NULL}.
2683 @end deftypefun
2684
2685 @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}})
2686 The function @code{gpgme_key_sig_get_ulong_attr} returns the value of
2687 the number-representable attribute @var{what} of the signature
2688 @var{idx} on the user ID @var{uid_idx} in the key @var{key}.  The
2689 argument @var{reserved} is reserved for later use and should be
2690 @code{NULL}.
2691
2692 The function returns @code{0} if an attribute can't be returned as a
2693 string, @var{key} is not a valid pointer, @var{uid_idx} or @var{idx}
2694 out of range, or @var{reserved} not @code{NULL}.
2695 @end deftypefun
2696
2697
2698 @node Manipulating Keys
2699 @subsection Manipulating Keys
2700 @cindex key, manipulation
2701
2702 @deftypefun void gpgme_key_ref (@w{gpgme_key_t @var{key}})
2703 The function @code{gpgme_key_ref} acquires an additional reference for
2704 the key @var{key}.
2705 @end deftypefun
2706
2707 @deftypefun void gpgme_key_unref (@w{gpgme_key_t @var{key}})
2708 The function @code{gpgme_key_unref} releases a reference for the key
2709 @var{key}.  If this was the last reference, the key will be destroyed
2710 and all resources associated to it will be released.
2711 @end deftypefun
2712
2713
2714 The following interface is deprecated and only provided for backward
2715 compatibility.  Don't use it.  It will be removed in a future version
2716 of @acronym{GPGME}.
2717
2718 @deftypefun void gpgme_key_release (@w{gpgme_key_t @var{key}})
2719 The function @code{gpgme_key_release} is equivalent to
2720 @code{gpgme_key_unref}.
2721 @end deftypefun
2722
2723
2724 @node Generating Keys
2725 @subsection Generating Keys
2726 @cindex key, creation
2727 @cindex key ring, add
2728
2729 @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}})
2730 The function @code{gpgme_op_genkey} generates a new key pair in the
2731 context @var{ctx}.  The meaning of @var{public} and @var{secret}
2732 depends on the crypto backend.
2733
2734 GnuPG does not support @var{public} and @var{secret}, they should be
2735 @code{NULL}.  GnuPG will generate a key pair and add it to the
2736 standard key ring.  The fingerprint of the generated key is available
2737 with @code{gpgme_op_genkey_result}.
2738
2739 GpgSM requires @var{public} to be a writable data object.  GpgSM will
2740 generate a secret key (which will be stored by @command{gpg-agent},
2741 and return a certificate request in @var{public}, which then needs to
2742 be signed by the certification authority and imported before it can be
2743 used.  GpgSM does not make the fingerprint available.
2744
2745 The argument @var{parms} specifies parameters for the key in an XML
2746 string.  The details about the format of @var{parms} are specific to
2747 the crypto engine used by @var{ctx}.  Here is an example for GnuPG as
2748 the crypto engine:
2749
2750 @example
2751 <GnupgKeyParms format="internal">
2752 Key-Type: DSA
2753 Key-Length: 1024
2754 Subkey-Type: ELG-E
2755 Subkey-Length: 1024
2756 Name-Real: Joe Tester
2757 Name-Comment: with stupid passphrase
2758 Name-Email: joe@@foo.bar
2759 Expire-Date: 0
2760 Passphrase: abc
2761 </GnupgKeyParms>
2762 @end example
2763
2764 Here is an example for GpgSM as the crypto engine:
2765
2766 @example
2767 <GnupgKeyParms format="internal">
2768 Key-Type: RSA
2769 Key-Length: 1024
2770 Name-DN: C=de,O=g10 code,OU=Testlab,CN=Joe 2 Tester
2771 Name-Email: joe@@foo.bar
2772 </GnupgKeyParms>
2773 @end example
2774
2775 Strings should be given in UTF-8 encoding.  The only format supported
2776 for now is ``internal''.  The content of the @code{GnupgKeyParms}
2777 container is passed verbatim to the crypto backend.  Control
2778 statements are not allowed.
2779
2780 After the operation completed successfully, the result can be
2781 retrieved with @code{gpgme_op_genkey_result}.
2782
2783 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2784 operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
2785 @var{parms} is not a valid XML string, @code{GPG_ERR_NOT_SUPPORTED} if
2786 @var{public} or @var{secret} is not valid, and @code{GPG_ERR_GENERAL}
2787 if no key was created by the backend.
2788 @end deftypefun
2789
2790 @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}})
2791 The function @code{gpgme_op_genkey_start} initiates a
2792 @code{gpgme_op_genkey} operation.  It can be completed by calling
2793 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2794
2795 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2796 operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
2797 @var{parms} is not a valid XML string, and
2798 @code{GPG_ERR_NOT_SUPPORTED} if @var{public} or @var{secret} is not
2799 @code{NULL}.
2800 @end deftypefun
2801
2802 @deftp {Data type} {gpgme_genkey_result_t}
2803 This is a pointer to a structure used to store the result of a
2804 @code{gpgme_op_genkey} operation.  After successfully generating a
2805 key, you can retrieve the pointer to the result with
2806 @code{gpgme_op_genkey_result}.  The structure contains the following
2807 members:
2808
2809 @table @code
2810 @item unsigned int primary : 1
2811 This is a flag that is set to 1 if a primary key was created and to 0
2812 if not.
2813
2814 @item unsigned int sub : 1
2815 This is a flag that is set to 1 if a subkey was created and to 0
2816 if not.
2817
2818 @item char *fpr
2819 This is the fingerprint of the key that was created.  If both a
2820 primary and a sub key were generated, the fingerprint of the primary
2821 key will be returned.  If the crypto engine does not provide the
2822 fingerprint, @code{fpr} will be a null pointer.
2823 @end table
2824 @end deftp
2825
2826 @deftypefun gpgme_genkey_result_t gpgme_op_genkey_result (@w{gpgme_ctx_t @var{ctx}})
2827 The function @code{gpgme_op_genkey_result} returns a
2828 @code{gpgme_genkey_result_t} pointer to a structure holding the result of
2829 a @code{gpgme_op_genkey} operation.  The pointer is only valid if the
2830 last operation on the context was a @code{gpgme_op_genkey} or
2831 @code{gpgme_op_genkey_start} operation, and if this operation finished
2832 successfully.  The returned pointer is only valid until the next
2833 operation is started on the context.
2834 @end deftypefun
2835
2836
2837 @node Exporting Keys
2838 @subsection Exporting Keys
2839 @cindex key, export
2840 @cindex key ring, export from
2841
2842 @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}})
2843 The function @code{gpgme_op_export} extracts public keys and returns
2844 them in the data buffer @var{keydata}.  The output format of the key
2845 data returned is determined by the @acronym{ASCII} armor attribute set
2846 for the context @var{ctx}.
2847
2848 If @var{pattern} is @code{NULL}, all available keys are returned.
2849 Otherwise, @var{pattern} contains an engine specific expression that
2850 is used to limit the list to all keys matching the pattern.
2851
2852 @var{reserved} is reserved for future use and must be @code{0}.
2853
2854 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2855 operation completed successfully, @code{GPG_ERR_INV_VALUE} if
2856 @var{keydata} is not a valid empty data buffer, and passes through any
2857 errors that are reported by the crypto engine support routines.
2858 @end deftypefun
2859
2860 @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}})
2861 The function @code{gpgme_op_export_start} initiates a
2862 @code{gpgme_op_export} operation.  It can be completed by calling
2863 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2864
2865 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2866 operation could be started successfully, and @code{GPG_ERR_INV_VALUE}
2867 if @var{keydata} is not a valid empty data buffer.
2868 @end deftypefun
2869
2870 @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}})
2871 The function @code{gpgme_op_export} extracts public keys and returns
2872 them in the data buffer @var{keydata}.  The output format of the key
2873 data returned is determined by the @acronym{ASCII} armor attribute set
2874 for the context @var{ctx}.
2875
2876 If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
2877 are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
2878 array of strings that are used to limit the list to all keys matching
2879 at least one of the patterns verbatim.
2880
2881 @var{reserved} is reserved for future use and must be @code{0}.
2882
2883 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2884 operation completed successfully, @code{GPG_ERR_INV_VALUE} if
2885 @var{keydata} is not a valid empty data buffer, and passes through any
2886 errors that are reported by the crypto engine support routines.
2887 @end deftypefun
2888
2889 @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}})
2890 The function @code{gpgme_op_export_ext_start} initiates a
2891 @code{gpgme_op_export_ext} operation.  It can be completed by calling
2892 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2893
2894 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2895 operation could be started successfully, and @code{GPG_ERR_INV_VALUE}
2896 if @var{keydata} is not a valid empty data buffer.
2897 @end deftypefun
2898
2899
2900 @node Importing Keys
2901 @subsection Importing Keys
2902 @cindex key, import
2903 @cindex key ring, import to
2904
2905 @deftypefun gpgme_error_t gpgme_op_import (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}})
2906 The function @code{gpgme_op_import} adds the keys in the data buffer
2907 @var{keydata} to the key ring of the crypto engine used by @var{ctx}.
2908 The format of @var{keydata} can be @acronym{ASCII} armored, for example,
2909 but the details are specific to the crypto engine.
2910
2911 After the operation completed successfully, the result can be
2912 retrieved with @code{gpgme_op_import_result}.
2913
2914 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2915 import was completed successfully, @code{GPG_ERR_INV_VALUE} if
2916 @var{keydata} if @var{ctx} or @var{keydata} is not a valid pointer,
2917 and @code{GPG_ERR_NO_DATA} if @var{keydata} is an empty data buffer.
2918 @end deftypefun
2919
2920 @deftypefun gpgme_error_t gpgme_op_import_start (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}})
2921 The function @code{gpgme_op_import_start} initiates a
2922 @code{gpgme_op_import} operation.  It can be completed by calling
2923 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
2924
2925 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
2926 import could be started successfully, @code{GPG_ERR_INV_VALUE} if
2927 @var{keydata} if @var{ctx} or @var{keydata} is not a valid pointer,
2928 and @code{GPG_ERR_NO_DATA} if @var{keydata} is an empty data buffer.
2929 @end deftypefun
2930
2931 @deftp {Data type} {gpgme_import_status_t}
2932 This is a pointer to a structure used to store a part of the result of
2933 a @code{gpgme_op_import} operation.  For each considered key one
2934 status is added that contains information about the result of the
2935 import.  The structure contains the following members:
2936
2937 @table @code
2938 @item gpgme_import_status_t next
2939 This is a pointer to the next status structure in the linked list, or
2940 @code{NULL} if this is the last element.
2941
2942 @item char *fpr
2943 This is the fingerprint of the key that was considered.
2944
2945 @item gpgme_error_t result
2946 If the import was not successful, this is the error value that caused
2947 the import to fail.  Otherwise the error code is
2948 @code{GPG_ERR_NO_ERROR}.
2949
2950 @item unsigned int status
2951 This is a bit-wise OR of the following flags that give more
2952 information about what part of the key was imported.  If the key was
2953 already known, this might be 0.
2954
2955 @table @code
2956 @item GPGME_IMPORT_NEW
2957 The key was new.
2958
2959 @item GPGME_IMPORT_UID
2960 The key contained new user IDs.
2961
2962 @item GPGME_IMPORT_SIG
2963 The key contained new signatures.
2964
2965 @item GPGME_IMPORT_SUBKEY
2966 The key contained new sub keys.
2967
2968 @item GPGME_IMPORT_SECRET
2969 The key contained a secret key.
2970 @end table
2971 @end table
2972 @end deftp
2973
2974 @deftp {Data type} {gpgme_import_result_t}
2975 This is a pointer to a structure used to store the result of a
2976 @code{gpgme_op_import} operation.  After a successful import
2977 operation, you can retrieve the pointer to the result with
2978 @code{gpgme_op_import_result}.  The structure contains the following
2979 members:
2980
2981 @table @code
2982 @item int considered
2983 The total number of considered keys.
2984
2985 @item int no_user_id
2986 The number of keys without user ID.
2987
2988 @item int imported
2989 The total number of imported keys.
2990
2991 @item imported_rsa
2992 The number of imported RSA keys.
2993
2994 @item unchanged
2995 The number of unchanged keys.
2996
2997 @item new_user_ids
2998 The number of new user IDs.
2999
3000 @item new_sub_keys
3001 The number of new sub keys.
3002
3003 @item new_signatures
3004 The number of new signatures.
3005
3006 @item new_revocations
3007 The number of new revocations.
3008
3009 @item secret_read
3010 The total number of secret keys read.
3011
3012 @item secret_imported
3013 The number of imported secret keys.
3014
3015 @item secret_unchanged
3016 The number of unchanged secret keys.
3017
3018 @item not_imported
3019 The number of keys not imported.
3020
3021 @item gpgme_import_status_t imports
3022 A list of gpgme_import_status_t objects which contain more information
3023 about the keys for which an import was attempted.
3024 @end table
3025 @end deftp
3026
3027 @deftypefun gpgme_import_result_t gpgme_op_import_result (@w{gpgme_ctx_t @var{ctx}})
3028 The function @code{gpgme_op_import_result} returns a
3029 @code{gpgme_import_result_t} pointer to a structure holding the result
3030 of a @code{gpgme_op_import} operation.  The pointer is only valid if
3031 the last operation on the context was a @code{gpgme_op_import} or
3032 @code{gpgme_op_import_start} operation, and if this operation finished
3033 successfully.  The returned pointer is only valid until the next
3034 operation is started on the context.
3035 @end deftypefun
3036
3037 The following interface is deprecated and only provided for backward
3038 compatibility.  Don't use it.  It will be removed in a future version
3039 of @acronym{GPGME}.
3040
3041 @deftypefun gpgme_error_t gpgme_op_import_ext (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}}, @w{int *@var{nr}})
3042 The function @code{gpgme_op_import_ext} is equivalent to:
3043
3044 @example
3045   gpgme_error_t err = gpgme_op_import (ctx, keydata);
3046   if (!err)
3047     @{
3048       gpgme_import_result_t result = gpgme_op_import_result (ctx);
3049       *nr = result->considered;
3050     @}
3051 @end example
3052 @end deftypefun
3053
3054
3055 @node Deleting Keys
3056 @subsection Deleting Keys
3057 @cindex key, delete
3058 @cindex key ring, delete from
3059
3060 @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}})
3061 The function @code{gpgme_op_delete} deletes the key @var{key} from the
3062 key ring of the crypto engine used by @var{ctx}.  If
3063 @var{allow_secret} is @code{0}, only public keys are deleted,
3064 otherwise secret keys are deleted as well, if that is supported.
3065
3066 The function returns the error code @code{GPG_ERR_NO_ERROR} if the key
3067 was deleted successfully, @code{GPG_ERR_INV_VALUE} if @var{ctx} or
3068 @var{key} is not a valid pointer, @code{GPG_ERR_NO_PUBKEY} if
3069 @var{key} could not be found in the keyring,
3070 @code{GPG_ERR_AMBIGUOUS_NAME} if the key was not specified
3071 unambiguously, and @code{GPG_ERR_CONFLICT} if the secret key for
3072 @var{key} is available, but @var{allow_secret} is zero.
3073 @end deftypefun
3074
3075 @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}})
3076 The function @code{gpgme_op_delete_start} initiates a
3077 @code{gpgme_op_delete} operation.  It can be completed by calling
3078 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
3079
3080 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
3081 operation was started successfully, and @code{GPG_ERR_INV_VALUE} if
3082 @var{ctx} or @var{key} is not a valid pointer.
3083 @end deftypefun
3084
3085
3086 @node Trust Item Management
3087 @section Trust Item Management
3088 @cindex trust item
3089
3090 @strong{Caution:} The trust items interface is experimental.
3091
3092 @deftp {Data type} gpgme_trust_item_t
3093 The @code{gpgme_trust_item_t} type is a pointer to a trust item object.
3094 It has the following members:
3095
3096 @table @code
3097 @item char *keyid
3098 This is a string describing the key to which this trust items belongs.
3099
3100 @item int type
3101 This is the type of the trust item.  A value of 1 refers to a key, a
3102 value of 2 refers to a user ID.
3103
3104 @item int level
3105 This is the trust level.
3106
3107 @item char *owner_trust
3108 The owner trust if @code{type} is 1.
3109
3110 @item char *validity
3111 The calculated validity.
3112
3113 @item char *name
3114 The user name if @code{type} is 2.
3115 @end table
3116 @end deftp
3117
3118 @menu
3119 * Listing Trust Items::           Browsing the list of available trust items.
3120 * Information About Trust Items:: Requesting information about trust items.
3121 * Manipulating Trust Items::      Operations on trust items.
3122 @end menu
3123
3124
3125 @node Listing Trust Items
3126 @subsection Listing Trust Items
3127 @cindex trust item list
3128
3129 @deftypefun gpgme_error_t gpgme_op_trustlist_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{max_level}})
3130 The function @code{gpgme_op_trustlist_start} initiates a trust item
3131 listing operation inside the context @var{ctx}.  It sets everything up
3132 so that subsequent invocations of @code{gpgme_op_trustlist_next} return
3133 the trust items in the list.
3134
3135 The string @var{pattern} contains an engine specific expression that
3136 is used to limit the list to all trust items matching the pattern.  It
3137 can not be the empty string.
3138
3139 The argument @var{max_level} is currently ignored.
3140
3141 The context will be busy until either all trust items are received
3142 (and @code{gpgme_op_trustlist_next} returns @code{GPG_ERR_EOF}), or
3143 @code{gpgme_op_trustlist_end} is called to finish the operation.
3144
3145 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3146 @var{ctx} is not a valid pointer, and passes through any errors that
3147 are reported by the crypto engine support routines.
3148 @end deftypefun
3149
3150 @deftypefun gpgme_error_t gpgme_op_trustlist_next (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_trust_item_t *@var{r_item}})
3151 The function @code{gpgme_op_trustlist_next} returns the next trust
3152 item in the list created by a previous @code{gpgme_op_trustlist_start}
3153 operation in the context @var{ctx}.  The trust item can be destroyed
3154 with @code{gpgme_trust_item_release}.  @xref{Manipulating Trust Items}.
3155
3156 This is the only way to get at @code{gpgme_trust_item_t} objects in
3157 @acronym{GPGME}.
3158
3159 If the last trust item in the list has already been returned,
3160 @code{gpgme_op_trustlist_next} returns @code{GPG_ERR_EOF}.
3161
3162 The function returns the error code @code{GPG_ERR_INV_VALUE} if @var{ctx} or
3163 @var{r_item} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if
3164 there is not enough memory for the operation.
3165 @end deftypefun
3166
3167 @deftypefun gpgme_error_t gpgme_op_trustlist_end (@w{gpgme_ctx_t @var{ctx}})
3168 The function @code{gpgme_op_trustlist_next} ends a pending key list
3169 operation in the context @var{ctx}.
3170
3171 The function returns the error code @code{GPG_ERR_INV_VALUE} if
3172 @var{ctx} is not a valid pointer, and @code{GPG_ERR_ENOMEM} if at some
3173 time during the operation there was not enough memory available.
3174 @end deftypefun
3175
3176
3177 @node Information About Trust Items
3178 @subsection Information About Trust Items
3179 @cindex trust item, information about
3180 @cindex trust item, attributes
3181 @cindex attributes, of a trust item
3182
3183 The following interfaces are deprecated and only provided for backward
3184 compatibility.  Don't use them.  They will be removed in a future
3185 version of @acronym{GPGME}.
3186
3187 Trust items have attributes which can be queried using the interfaces
3188 below.  The attribute identifiers are shared with those for key
3189 attributes.  @xref{Information About Keys}.
3190
3191 @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}})
3192 The function @code{gpgme_trust_item_get_string_attr} returns the value
3193 of the string-representable attribute @var{what} of trust item
3194 @var{item}.  The arguments @var{idx} and @var{reserved} are reserved
3195 for later use and should be @code{0} and @code{NULL} respectively.
3196
3197 The string returned is only valid as long as the key is valid.
3198
3199 The function returns @code{0} if an attribute can't be returned as a
3200 string, @var{key} is not a valid pointer, @var{idx} out of range,
3201 or @var{reserved} not @code{NULL}.
3202 @end deftypefun
3203
3204 @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}})
3205 The function @code{gpgme_trust_item_get_int_attr} returns the value of
3206 the number-representable attribute @var{what} of trust item
3207 @var{item}.  If the attribute occurs more than once in the trust item,
3208 the index is specified by @var{idx}.  However, currently no such
3209 attribute exists, so @var{idx} should be @code{0}.  The argument
3210 @var{reserved} is reserved for later use and should be @code{NULL}.
3211
3212 The function returns @code{0} if the attribute can't be returned as a
3213 number, @var{key} is not a valid pointer, @var{idx} out of range,
3214 or @var{reserved} not @code{NULL}.
3215 @end deftypefun
3216
3217
3218 @node Manipulating Trust Items
3219 @subsection Manipulating Trust Items
3220 @cindex trust item, manipulation
3221
3222 @deftypefun void gpgme_trust_item_ref (@w{gpgme_trust_item_t @var{item}})
3223 The function @code{gpgme_trust_item_ref} acquires an additional
3224 reference for the trust item @var{item}.
3225 @end deftypefun
3226
3227 @deftypefun void gpgme_trust_item_unref (@w{gpgme_trust_item_t @var{item}})
3228 The function @code{gpgme_trust_item_unref} releases a reference for
3229 the trust item @var{item}.  If this was the last reference, the trust
3230 item will be destroyed and all resources associated to it will be
3231 released.
3232 @end deftypefun
3233
3234
3235 The following interface is deprecated and only provided for backward
3236 compatibility.  Don't use it.  It will be removed in a future version
3237 of @acronym{GPGME}.
3238
3239 @deftypefun void gpgme_trust_item_release (@w{gpgme_trust_item_t @var{item}})
3240 The function @code{gpgme_trust_item_release} is an alias for
3241 @code{gpgme_trust_item_unref}.
3242 @end deftypefun
3243
3244
3245 @node Crypto Operations
3246 @section Crypto Operations
3247 @cindex cryptographic operation
3248
3249 Sometimes, the result of a crypto operation returns a list of invalid
3250 keys encountered in processing the request.  The following structure
3251 is used to hold information about such a key.
3252
3253 @deftp {Data type} {gpgme_invalid_key_t}
3254 This is a pointer to a structure used to store a part of the result of
3255 a crypto operation which takes user IDs as one input parameter.  The
3256 structure contains the following members:
3257
3258 @table @code
3259 @item gpgme_invalid_key_t next
3260 This is a pointer to the next invalid key structure in the linked
3261 list, or @code{NULL} if this is the last element.
3262
3263 @item char *fpr
3264 The fingerprint or key ID of the invalid key encountered.
3265
3266 @item gpgme_error_t reason
3267 An error code describing the reason why the key was found invalid.
3268 @end table
3269 @end deftp
3270
3271
3272 @menu
3273 * Decrypt::                       Decrypting a ciphertext.
3274 * Verify::                        Verifying a signature.
3275 * Decrypt and Verify::            Decrypting a signed ciphertext.
3276 * Sign::                          Creating a signature.
3277 * Encrypt::                       Encrypting a plaintext.
3278 @end menu
3279
3280
3281 @node Decrypt
3282 @subsection Decrypt
3283 @cindex decryption
3284 @cindex cryptographic operation, decryption
3285
3286 @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}})
3287 The function @code{gpgme_op_decrypt} decrypts the ciphertext in the
3288 data object @var{cipher} and stores it into the data object
3289 @var{plain}.
3290
3291 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
3292 ciphertext could be decrypted successfully, @code{GPG_ERR_INV_VALUE}
3293 if @var{ctx}, @var{cipher} or @var{plain} is not a valid pointer,
3294 @code{GPG_ERR_NO_DATA} if @var{cipher} does not contain any data to
3295 decrypt, @code{GPG_ERR_DECRYPT_FAILED} if @var{cipher} is not a valid
3296 cipher text, @code{GPG_ERR_BAD_PASSPHRASE} if the passphrase for the
3297 secret key could not be retrieved, and passes through any errors that
3298 are reported by the crypto engine support routines.
3299 @end deftypefun
3300
3301 @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}})
3302 The function @code{gpgme_op_decrypt_start} initiates a
3303 @code{gpgme_op_decrypt} operation.  It can be completed by calling
3304 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
3305
3306 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
3307 operation could be started successfully, and @code{GPG_ERR_INV_VALUE}
3308 if @var{cipher} or @var{plain} is not a valid pointer.
3309 @end deftypefun
3310
3311 @deftp {Data type} {gpgme_decrypt_result_t}
3312 This is a pointer to a structure used to store the result of a
3313 @code{gpgme_op_decrypt} operation.  After successfully encrypting
3314 data, you can retrieve the pointer to the result with
3315 @code{gpgme_op_decrypt_result}.  The structure contains the following
3316 members:
3317
3318 @table @code
3319 @item char *unsupported_algorithm
3320 If an unsupported algorithm was encountered, this string describes the
3321 algorithm that is not supported.
3322 @end table
3323 @end deftp
3324
3325 @deftypefun gpgme_decrypt_result_t gpgme_op_decrypt_result (@w{gpgme_ctx_t @var{ctx}})
3326 The function @code{gpgme_op_decrypt_result} returns a
3327 @code{gpgme_decrypt_result_t} pointer to a structure holding the
3328 result of a @code{gpgme_op_decrypt} operation.  The pointer is only
3329 valid if the last operation on the context was a
3330 @code{gpgme_op_decrypt} or @code{gpgme_op_decrypt_start} operation.
3331 If the operation failed this might be a @code{NULL} pointer.  The
3332 returned pointer is only valid until the next operation is started on
3333 the context.
3334 @end deftypefun
3335
3336
3337 @node Verify
3338 @subsection Verify
3339 @cindex verification
3340 @cindex signature, verification
3341 @cindex cryptographic operation, verification
3342 @cindex cryptographic operation, signature check
3343
3344 @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}})
3345 The function @code{gpgme_op_verify} verifies that the signature in the
3346 data object @var{sig} is a valid signature.  If @var{sig} is a
3347 detached signature, then the signed text should be provided in
3348 @var{signed_text} and @var{plain} should be a null pointer.
3349 Otherwise, if @var{sig} is a normal (or cleartext) signature,
3350 @var{signed_text} should be a null pointer and @var{plain} should be a
3351 writable data object that will contain the plaintext after successful
3352 verification.
3353
3354 The results of the individual signature verifications can be retrieved
3355 with @code{gpgme_op_verify_result}.
3356
3357 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
3358 operation could be completed successfully, @code{GPG_ERR_INV_VALUE} if
3359 @var{ctx}, @var{sig} or @var{plain} is not a valid pointer,
3360 @code{GPG_ERR_NO_DATA} if @var{sig} does not contain any data to
3361 verify, and passes through any errors that are reported by the crypto
3362 engine support routines.
3363 @end deftypefun
3364
3365 @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}})
3366 The function @code{gpgme_op_verify_start} initiates a
3367 @code{gpgme_op_verify} operation.  It can be completed by calling
3368 @code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
3369
3370 The function returns the error code @code{GPG_ERR_NO_ERROR} if the
3371 operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
3372 @var{ctx}, @var{sig} or @var{plain} is not a valid pointer, and
3373 @code{GPG_ERR_NO_DATA} if @var{sig} or @var{plain} does not contain
3374 any data to verify.
3375 @end deftypefun
3376
3377 @deftp {Data type} {gpgme_sig_notation_t}
3378 This is a pointer to a structure used to store a part of the result of
3379 a @code{gpgme_op_verify} operation.  The structure contains the
3380 following members:
3381
3382 @table @code
3383 @item gpgme_sig_notation_t next
3384 This is a pointer to the next new signature notation structure in the
3385 linked list, or @code{NULL} if this is the last element.
3386
3387 @item char *name
3388 The name of the notation field.  If this is @code{NULL}, then the
3389 member @code{value} will contain a policy URL.
3390
3391 @item char *value
3392 The value of the notation field.  If @code{name} is @code{NULL}, then
3393 this is a policy URL.
3394 @end table
3395 @end deftp
3396
3397 @deftp {Data type} {gpgme_signature_t}
3398 This is a pointer to a structure used to store a part of the result of
3399 a @code{gpgme_op_verify} operation.  The structure contains the
3400 following members:
3401
3402 @table @code
3403 @item gpgme_signature_t next
3404 This is a pointer to the next new signature structure in the linked
3405 list, or @code{NULL} if this is the last element.
3406
3407 @item gpgme_sigsum_t summary;
3408 This is a bit vector giving a summary of the signature status.  It
3409 provides an easy interface to a defined semantic of the signature
3410 status.  Checking just one bit is sufficient to see whether a
3411 signature is valid without any restrictions.
3412
3413 The defined bits are:
3414   @table @code
3415   @item GPGME_SIGSUM_VALID
3416   The signature is fully valid.
3417
3418   @item GPGME_SIGSUM_GREEN
3419   The signature is good but one might want to display some extra
3420   information.  Check the other bits.
3421
3422   @item GPGME_SIGSUM_RED
3423   The signature is bad. It might be useful to check other bits and
3424   display more information, i.e. a revoked certificate might not render a
3425   signature invalid when the message was received prior to the cause for
3426   the revocation.
3427
3428   @item GPGME_SIGSUM_KEY_REVOKED
3429   The key or at least one certificate has been revoked.
3430
3431   @item GPGME_SIGSUM_KEY_EXPIRED
3432   The key or one of the certificates has expired. It is probably a good
3433   idea to display the date of the expiration.
3434
3435   @item GPGME_SIGSUM_SIG_EXPIRED
3436   The signature has expired.
3437
3438   @item GPGME_SIGSUM_KEY_MISSING
3439   Can't verify due to a missing key or certificate.
3440
3441   @item GPGME_SIGSUM_CRL_MISSING
3442   The CRL (or an equivalent mechanism) is not available. 
3443
3444   @item GPGME_SIGSUM_CRL_TOO_OLD
3445   Available CRL is too old.
3446
3447   @item GPGME_SIGSUM_BAD_POLICY
3448   A policy requirement was not met. 
3449
3450   @item GPGME_SIGSUM_SYS_ERROR
3451   A system error occured. 
3452   @end table
3453
3454 @item char *fpr
3455 This is the fingerprint or key ID of the signature.
3456
3457 @item gpgme_error_t status
3458 This is the status of the signature.  In particular, the following
3459 status codes are of interest:
3460
3461   @table @code
3462   @item GPG_ERR_NO_ERROR
3463   This status indicates that the signature is valid.  For the combined
3464   result this status means that all signatures are valid.
3465
3466   @item GPG_ERR_SIG_EXPIRED
3467   This status indicates that the signature is valid but expired.  For
3468   the combined result this status means that all signatures are valid
3469   and expired.
3470
3471   @item GPG_ERR_KEY_EXPIRED
3472   This status indicates that the signature is valid but the key used to
3473   verify the signature has expired.  For the combined result this status
3474   means that all signatures are valid and all keys are expired.
3475
3476   @item GPG_ERR_BAD_SIGNATURE
3477   This status indicates that the signature is invalid.  For the combined
3478   result this status means that all signatures are invalid.
3479
3480   @item GPG_ERR_NO_PUBKEY
3481   This status indicates that the signature could not be verified due to
3482   a missing key.  For the combined result this status means that all
3483   signatures could not be checked due to missing keys.
3484
3485   @item GPG_ERR_GENERAL
3486   This status indicates that there was some other error which prevented
3487   the signature verification.
3488   @end table
3489
3490 @item gpgme_sig_notation_t notations
3491 This is a linked list with the notation data and policy URLs.
3492
3493 @item unsigned long timestamp
3494 The creation timestamp of this signature.
3495
3496 @item unsigned long exp_timestamp
3497 The expiration timestamp of this signature, or 0 if the signature does
3498 not expire.
3499
3500 @item int wrong_key_usage : 1;
3501 This is true if the key was not used according to its policy.
3502
3503 @item gpgme_validity_t validity
3504 The validity of the signature.
3505
3506 @item gpgme_error_t validity_reason
3507 If a signature is not valid, this provides a reason why.
3508
3509 @end table
3510 @end deftp
3511
3512 @deftp {Data type} {gpgme_verify_result_t}
3513 This is a pointer to a structure used to store the result of a
3514 @code{gpgme_op_verify} operation.  After verifying a signature, you
3515 can retrieve the pointer to the result with
3516 @code{gpgme_op_verify_result}.  If the operation failed this might be
3517 a @code{NULL} pointer.  The structure contains the following member:
3518
3519 @table @code
3520 @item gpgme_signature_t signatures
3521 A linked list with information about all signatures for which a
3522 verification was attempted.
3523 @end table
3524 @end deftp
3525
3526 @deftypefun gpgme_sign_result_t gpgme_op_verify_result (@w{gpgme_ctx_t @var{ctx}})
3527 The function @code{gpgme_op_verify_result} returns a
3528 @code{gpgme_verify_result_t} pointer to a structure holding the result of
3529 a @code{gpgme_op_verify} operation.  The pointer is only valid if the
3530 last operation on the context was a @code{gpgme_op_verify} or
3531 @code{gpgme_op_verify_start} operation, and if this operation finished
3532 successfully.  The returned pointer is only valid until the next
3533 operation is started on the context.
3534 @end deftypefun
3535
3536
3537 The following interfaces are deprecated and only provided for backward
3538 compatibility.  Don't use them.  They will be removed in a future
3539 version of @acronym{GPGME}.
3540
3541 @deftp {Data type} {enum gpgme_sig_stat_t}
3542 @tindex gpgme_sig_stat_t
3543 The @code{gpgme_sig_stat_t} type holds the result of a signature check, or
3544 the combined result of all signatures.  The following results are
3545 possible:
3546
3547 @table @code
3548 @item GPGME_SIG_STAT_NONE
3549 This status should not occur in normal operation.
3550
3551 @item GPGME_SIG_STAT_GOOD
3552 This status indicates that the signature is valid.  For the combined
3553 result this status means that all signatures are valid.
3554
3555 @item GPGME_SIG_STAT_GOOD_EXP
3556 This status indicates that the signature is valid but expired.  For
3557 the combined result this status means that all signatures are valid
3558 and expired.
3559
3560 @item GPGME_SIG_STAT_GOOD_EXPKEY
3561 This status indicates that the signature is valid but the key used to
3562 verify the signature has expired.  For the combined result this status
3563 means that all signatures are valid and all keys are expired.
3564
3565 @item GPGME_SIG_STAT_BAD
3566 This status indicates that the signature is invalid.  For the combined
3567 result this status means that all signatures are invalid.
3568
3569 @item GPGME_SIG_STAT_NOKEY
3570 This status indicates that the signature could not be verified due to
3571 a missing key.  For the combined result this status means that all
3572 signatures could not be checked due to missing keys.
3573
3574 @item GPGME_SIG_STAT_NOSIG
3575 This status indicates that the signature data provided was not a real
3576 signature.
3577
3578 @item GPGME_SIG_STAT_ERROR
3579 This status indicates that there was some other error which prevented
3580 the signature verification.
3581
3582 @item GPGME_SIG_STAT_DIFF
3583 For the combined result this status means that at least two signatures
3584 have a different status.  You can get each key's status with
3585 @code{gpgme_get_sig_status}.
3586 @end table
3587 @end deftp
3588
3589 @deftypefun {const char *} gpgme_get_sig_status (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{idx}}, @w{gpgme_sig_stat_t *@var{r_stat}}, @w{time_t *@var{r_created}})
3590 The function @code{gpgme_get_sig_status} is equivalent to:
3591  
3592 @example
3593   gpgme_verify_result_t result;
3594   gpgme_signature_t sig;
3595
3596   result = gpgme_op_verify_result (ctx);
3597   sig = result->signatures;
3598
3599   while (sig && idx)
3600     @{
3601       sig = sig->next;
3602       idx--;
3603     @}
3604   if (!sig || idx)
3605     return NULL;
3606
3607   if (r_stat)
3608     @{
3609       switch (sig->status)
3610         @{
3611         case GPG_ERR_NO_ERROR:
3612           *r_stat = GPGME_SIG_STAT_GOOD;
3613           break;
3614           
3615         case GPG_ERR_BAD_SIGNATURE:
3616           *r_stat = GPGME_SIG_STAT_BAD;
3617           break;
3618           
3619         case GPG_ERR_NO_PUBKEY:
3620           *r_stat = GPGME_SIG_STAT_NOKEY;
3621           break;
3622           
3623         case GPG_ERR_NO_DATA:
3624           *r_stat = GPGME_SIG_STAT_NOSIG;
3625           break;
3626           
3627         case GPG_ERR_SIG_EXPIRED:
3628           *r_stat = GPGME_SIG_STAT_GOOD_EXP;
3629           break;
3630           
3631         case GPG_ERR_KEY_EXPIRED:
3632           *r_stat = GPGME_SIG_STAT_GOOD_EXPKEY;
3633           break;
3634           
3635         default:
3636           *r_stat = GPGME_SIG_STAT_ERROR;
3637           break;
3638         @}
3639     @}
3640   if (r_created)
3641     *r_created = sig->timestamp;
3642   return sig->fpr;
3643 @end example
3644 @end deftypefun
3645
3646 @deftypefun {const char *} gpgme_get_sig_string_attr (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{idx}}, @w{gpgme_attr_t @var{what}}, @w{int @var{whatidx}})
3647 The function @code{gpgme_get_sig_string_attr} is equivalent to:
3648  
3649 @example
3650   gpgme_verify_result_t result;
3651   gpgme_signature_t sig;
3652
3653   result = gpgme_op_verify_result (ctx);
3654   sig = result->signatures;
3655
3656   while (sig && idx)
3657     @{
3658       sig = sig->next;
3659       idx--;
3660     @}
3661   if (!sig || idx)
3662     return NULL;
3663
3664   switch (what)
3665     @{
3666     case GPGME_ATTR_FPR:
3667       return sig->fpr;
3668
3669     case GPGME_ATTR_ERRTOK:
3670       if (whatidx == 1)
3671         return sig->wrong_key_usage ? "Wrong_Key_Usage" : "";
3672       else
3673         return "";
3674     default:
3675       break;
3676     @}
3677
3678   return NULL;
3679 @end example
3680 @end deftypefun
3681
3682 @deftypefun {const char *} gpgme_get_sig_ulong_attr (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{idx}}, @w{gpgme_attr_t @var{waht}}, @w{int @var{whatidx}})
3683 The function @code{gpgme_get_sig_ulong_attr} is equivalent to:
3684  
3685 @example
3686   gpgme_verify_result_t result;
3687   gpgme_signature_t sig;
3688
3689   result = gpgme_op_verify_result (ctx);
3690   sig = result->signatures;
3691
3692   while (sig && idx)
3693     @{
3694       sig = sig->next;
3695       idx--;
3696     @}
3697   if (!sig || idx)
3698     return 0;
3699
3700   switch (what)
3701     @{
3702     case GPGME_ATTR_CREATED:
3703       return sig->timestamp;
3704
3705     case GPGME_ATTR_EXPIRE:
3706       return sig->exp_timestamp;
3707
3708     case GPGME_ATTR_VALIDITY:
3709       return (unsigned long) sig->validity;
3710
3711     case GPGME_ATTR_SIG_STATUS:
3712       switch (sig->status)
3713         @{
3714         case GPG_ERR_NO_ERROR:
3715           return GPGME_SIG_STAT_GOOD;
3716           
3717         case GPG_ERR_BAD_SIGNATURE:
3718           return GPGME_SIG_STAT_BAD;
3719           
3720         case GPG_ERR_NO_PUBKEY:
3721           return GPGME_SIG_STAT_NOKEY;
3722           
3723         case GPG_ERR_NO_DATA:
3724           return GPGME_SIG_STAT_NOSIG;
3725           
3726         case GPG_ERR_SIG_EXPIRED:
3727           return GPGME_SIG_STAT_GOOD_EXP;
3728           
3729         case GPG_ERR_KEY_EXPIRED: