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