core: Add GPGME_KEYLIST_MODE_WITH_TOFU.
[gpgme.git] / src / gpgme.h.in
1 /* gpgme.h - Public interface to GnuPG Made Easy.                   -*- c -*-
2  * Copyright (C) 2000 Werner Koch (dd9jn)
3  * Copyright (C) 2001-2015 g10 Code GmbH
4  *
5  * This file is part of GPGME.
6  *
7  * GPGME is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * GPGME is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
19  *
20  * Generated from gpgme.h.in for @GPGME_CONFIG_HOST@.
21  */
22
23 #ifndef GPGME_H
24 #define GPGME_H
25
26 /* Include stdio.h for the FILE type definition.  */
27 #include <stdio.h>
28 #include <time.h>
29 #include <gpg-error.h>
30
31 #ifdef __cplusplus
32 extern "C" {
33 #if 0 /*(Make Emacsen's auto-indent happy.)*/
34 }
35 #endif
36 #endif /* __cplusplus */
37
38
39 /* The version of this header should match the one of the library.  Do
40    not use this symbol in your application, use gpgme_check_version
41    instead.  The purpose of this macro is to let autoconf (using the
42    AM_PATH_GPGME macro) check that this header matches the installed
43    library.  */
44 #define GPGME_VERSION "@PACKAGE_VERSION@"
45
46 /* The version number of this header.  It may be used to handle minor
47    API incompatibilities.  */
48 #define GPGME_VERSION_NUMBER @VERSION_NUMBER@
49
50
51 /* System specific typedefs.  */
52 @INSERT__TYPEDEFS_FOR_GPGME_H@
53
54
55 \f
56 /*
57  * Check for compiler features.
58  */
59 #ifdef GPGRT_INLINE
60 # define _GPGME_INLINE GPGRT_INLINE
61 #elif defined(__GNUC__)
62 # define _GPGME_INLINE __inline__
63 #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
64 # define _GPGME_INLINE inline
65 #else
66 # define _GPGME_INLINE
67 #endif
68
69
70 #ifdef GPGRT_ATTR_DEPRECATED
71 # define _GPGME_DEPRECATED GPGRT_ATTR_DEPRECATED
72 #elif defined(__GNUC__)
73 # define _GPGME_GCC_VERSION (__GNUC__ * 10000 \
74                              + __GNUC_MINOR__ * 100 \
75                              + __GNUC_PATCHLEVEL__)
76
77 # if _GPGME_GCC_VERSION > 30100
78 #  define _GPGME_DEPRECATED  __attribute__ ((__deprecated__))
79 # else
80 #  define _GPGME_DEPRECATED
81 # endif
82 #else
83 # define _GPGME_DEPRECATED
84 #endif
85
86
87 /* The macro _GPGME_DEPRECATED_OUTSIDE_GPGME suppresses warnings for
88    fields we must access in GPGME for ABI compatibility.  */
89 #ifdef _GPGME_IN_GPGME
90 #define _GPGME_DEPRECATED_OUTSIDE_GPGME
91 #else
92 #define _GPGME_DEPRECATED_OUTSIDE_GPGME _GPGME_DEPRECATED
93 #endif
94
95
96 /* Check for a matching _FILE_OFFSET_BITS definition.  */
97 #if @NEED__FILE_OFFSET_BITS@
98 #ifndef _FILE_OFFSET_BITS
99 #error GPGME was compiled with _FILE_OFFSET_BITS = @NEED__FILE_OFFSET_BITS@, please see the section "Largefile support (LFS)" in the GPGME manual.
100 #else
101 #if (_FILE_OFFSET_BITS) != (@NEED__FILE_OFFSET_BITS@)
102 #error GPGME was compiled with a different value for _FILE_OFFSET_BITS, namely @NEED__FILE_OFFSET_BITS@, please see the section "Largefile support (LFS)" in the GPGME manual.
103 #endif
104 #endif
105 #endif
106
107
108 \f
109 /*
110  * Some opaque data types used by GPGME.
111  */
112
113 /* The context holds some global state and configuration options, as
114    well as the results of a crypto operation.  */
115 struct gpgme_context;
116 typedef struct gpgme_context *gpgme_ctx_t;
117
118 /* The data object is used by GPGME to exchange arbitrary data.  */
119 struct gpgme_data;
120 typedef struct gpgme_data *gpgme_data_t;
121
122
123 \f
124 /*
125  * Wrappers for the libgpg-error library.
126  */
127
128 typedef gpg_error_t gpgme_error_t;
129 typedef gpg_err_code_t gpgme_err_code_t;
130 typedef gpg_err_source_t gpgme_err_source_t;
131
132
133 static _GPGME_INLINE gpgme_error_t
134 gpgme_err_make (gpgme_err_source_t source, gpgme_err_code_t code)
135 {
136   return gpg_err_make (source, code);
137 }
138
139
140 /* The user can define GPGME_ERR_SOURCE_DEFAULT before including this
141    file to specify a default source for gpgme_error.  */
142 #ifndef GPGME_ERR_SOURCE_DEFAULT
143 #define GPGME_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
144 #endif
145
146 static _GPGME_INLINE gpgme_error_t
147 gpgme_error (gpgme_err_code_t code)
148 {
149   return gpgme_err_make (GPGME_ERR_SOURCE_DEFAULT, code);
150 }
151
152
153 static _GPGME_INLINE gpgme_err_code_t
154 gpgme_err_code (gpgme_error_t err)
155 {
156   return gpg_err_code (err);
157 }
158
159
160 static _GPGME_INLINE gpgme_err_source_t
161 gpgme_err_source (gpgme_error_t err)
162 {
163   return gpg_err_source (err);
164 }
165
166
167 /* Return a pointer to a string containing a description of the error
168    code in the error value ERR.  This function is not thread safe.  */
169 const char *gpgme_strerror (gpgme_error_t err);
170
171 /* Return the error string for ERR in the user-supplied buffer BUF of
172    size BUFLEN.  This function is, in contrast to gpg_strerror,
173    thread-safe if a thread-safe strerror_r() function is provided by
174    the system.  If the function succeeds, 0 is returned and BUF
175    contains the string describing the error.  If the buffer was not
176    large enough, ERANGE is returned and BUF contains as much of the
177    beginning of the error string as fits into the buffer.  */
178 int gpgme_strerror_r (gpg_error_t err, char *buf, size_t buflen);
179
180 /* Return a pointer to a string containing a description of the error
181    source in the error value ERR.  */
182 const char *gpgme_strsource (gpgme_error_t err);
183
184 /* Retrieve the error code for the system error ERR.  This returns
185    GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
186    this).  */
187 gpgme_err_code_t gpgme_err_code_from_errno (int err);
188
189 /* Retrieve the system error for the error code CODE.  This returns 0
190    if CODE is not a system error code.  */
191 int gpgme_err_code_to_errno (gpgme_err_code_t code);
192
193 /* Retrieve the error code directly from the ERRNO variable.  This
194    returns GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped
195    (report this) and GPG_ERR_MISSING_ERRNO if ERRNO has the value 0. */
196 gpgme_err_code_t gpgme_err_code_from_syserror (void);
197
198 /* Set the ERRNO variable.  This function is the preferred way to set
199    ERRNO due to peculiarities on WindowsCE.  */
200 void gpgme_err_set_errno (int err);
201
202 /* Return an error value with the error source SOURCE and the system
203    error ERR.  FIXME: Should be inline.  */
204 gpgme_error_t gpgme_err_make_from_errno (gpgme_err_source_t source, int err);
205
206 /* Return an error value with the system error ERR.  FIXME: Should be inline.  */
207 gpgme_error_t gpgme_error_from_errno (int err);
208
209
210 static _GPGME_INLINE gpgme_error_t
211 gpgme_error_from_syserror (void)
212 {
213   return gpgme_error (gpgme_err_code_from_syserror ());
214 }
215
216
217 \f
218 /*
219  * Various constants and types
220  */
221
222 /* The possible encoding mode of gpgme_data_t objects.  */
223 typedef enum
224   {
225     GPGME_DATA_ENCODING_NONE   = 0,     /* Not specified.  */
226     GPGME_DATA_ENCODING_BINARY = 1,
227     GPGME_DATA_ENCODING_BASE64 = 2,
228     GPGME_DATA_ENCODING_ARMOR  = 3,     /* Either PEM or OpenPGP Armor.  */
229     GPGME_DATA_ENCODING_URL    = 4,     /* LF delimited URL list.        */
230     GPGME_DATA_ENCODING_URLESC = 5,     /* Ditto, but percent escaped.   */
231     GPGME_DATA_ENCODING_URL0   = 6,     /* Nul delimited URL list.       */
232     GPGME_DATA_ENCODING_MIME   = 7      /* Data is a MIME part.          */
233   }
234 gpgme_data_encoding_t;
235
236
237 /* Known data types.  */
238 typedef enum
239   {
240     GPGME_DATA_TYPE_INVALID      = 0,   /* Not detected.  */
241     GPGME_DATA_TYPE_UNKNOWN      = 1,
242     GPGME_DATA_TYPE_PGP_SIGNED   = 0x10,
243     GPGME_DATA_TYPE_PGP_ENCRYPTED= 0x11,
244     GPGME_DATA_TYPE_PGP_OTHER    = 0x12,
245     GPGME_DATA_TYPE_PGP_KEY      = 0x13,
246     GPGME_DATA_TYPE_PGP_SIGNATURE= 0x18, /* Detached signature */
247     GPGME_DATA_TYPE_CMS_SIGNED   = 0x20,
248     GPGME_DATA_TYPE_CMS_ENCRYPTED= 0x21,
249     GPGME_DATA_TYPE_CMS_OTHER    = 0x22,
250     GPGME_DATA_TYPE_X509_CERT    = 0x23,
251     GPGME_DATA_TYPE_PKCS12       = 0x24,
252   }
253 gpgme_data_type_t;
254
255
256 /* Public key algorithms.  */
257 typedef enum
258   {
259     GPGME_PK_RSA   = 1,
260     GPGME_PK_RSA_E = 2,
261     GPGME_PK_RSA_S = 3,
262     GPGME_PK_ELG_E = 16,
263     GPGME_PK_DSA   = 17,
264     GPGME_PK_ECC   = 18,
265     GPGME_PK_ELG   = 20,
266     GPGME_PK_ECDSA = 301,
267     GPGME_PK_ECDH  = 302,
268     GPGME_PK_EDDSA = 303
269   }
270 gpgme_pubkey_algo_t;
271
272
273 /* Hash algorithms (the values match those from libgcrypt).  */
274 typedef enum
275   {
276     GPGME_MD_NONE          = 0,
277     GPGME_MD_MD5           = 1,
278     GPGME_MD_SHA1          = 2,
279     GPGME_MD_RMD160        = 3,
280     GPGME_MD_MD2           = 5,
281     GPGME_MD_TIGER         = 6,   /* TIGER/192. */
282     GPGME_MD_HAVAL         = 7,   /* HAVAL, 5 pass, 160 bit. */
283     GPGME_MD_SHA256        = 8,
284     GPGME_MD_SHA384        = 9,
285     GPGME_MD_SHA512        = 10,
286     GPGME_MD_SHA224        = 11,
287     GPGME_MD_MD4           = 301,
288     GPGME_MD_CRC32         = 302,
289     GPGME_MD_CRC32_RFC1510 = 303,
290     GPGME_MD_CRC24_RFC2440 = 304
291   }
292 gpgme_hash_algo_t;
293
294
295 /* The possible signature stati.  Deprecated, use error value in sig
296    status.  */
297 typedef enum
298   {
299     GPGME_SIG_STAT_NONE  = 0,
300     GPGME_SIG_STAT_GOOD  = 1,
301     GPGME_SIG_STAT_BAD   = 2,
302     GPGME_SIG_STAT_NOKEY = 3,
303     GPGME_SIG_STAT_NOSIG = 4,
304     GPGME_SIG_STAT_ERROR = 5,
305     GPGME_SIG_STAT_DIFF  = 6,
306     GPGME_SIG_STAT_GOOD_EXP = 7,
307     GPGME_SIG_STAT_GOOD_EXPKEY = 8
308   }
309 _gpgme_sig_stat_t;
310 typedef _gpgme_sig_stat_t gpgme_sig_stat_t _GPGME_DEPRECATED;
311
312
313 /* The available signature modes.  */
314 typedef enum
315   {
316     GPGME_SIG_MODE_NORMAL = 0,
317     GPGME_SIG_MODE_DETACH = 1,
318     GPGME_SIG_MODE_CLEAR  = 2
319   }
320 gpgme_sig_mode_t;
321
322
323 /* The available key and signature attributes.  Deprecated, use the
324    individual result structures instead.  */
325 typedef enum
326   {
327     GPGME_ATTR_KEYID        = 1,
328     GPGME_ATTR_FPR          = 2,
329     GPGME_ATTR_ALGO         = 3,
330     GPGME_ATTR_LEN          = 4,
331     GPGME_ATTR_CREATED      = 5,
332     GPGME_ATTR_EXPIRE       = 6,
333     GPGME_ATTR_OTRUST       = 7,
334     GPGME_ATTR_USERID       = 8,
335     GPGME_ATTR_NAME         = 9,
336     GPGME_ATTR_EMAIL        = 10,
337     GPGME_ATTR_COMMENT      = 11,
338     GPGME_ATTR_VALIDITY     = 12,
339     GPGME_ATTR_LEVEL        = 13,
340     GPGME_ATTR_TYPE         = 14,
341     GPGME_ATTR_IS_SECRET    = 15,
342     GPGME_ATTR_KEY_REVOKED  = 16,
343     GPGME_ATTR_KEY_INVALID  = 17,
344     GPGME_ATTR_UID_REVOKED  = 18,
345     GPGME_ATTR_UID_INVALID  = 19,
346     GPGME_ATTR_KEY_CAPS     = 20,
347     GPGME_ATTR_CAN_ENCRYPT  = 21,
348     GPGME_ATTR_CAN_SIGN     = 22,
349     GPGME_ATTR_CAN_CERTIFY  = 23,
350     GPGME_ATTR_KEY_EXPIRED  = 24,
351     GPGME_ATTR_KEY_DISABLED = 25,
352     GPGME_ATTR_SERIAL       = 26,
353     GPGME_ATTR_ISSUER       = 27,
354     GPGME_ATTR_CHAINID      = 28,
355     GPGME_ATTR_SIG_STATUS   = 29,
356     GPGME_ATTR_ERRTOK       = 30,
357     GPGME_ATTR_SIG_SUMMARY  = 31,
358     GPGME_ATTR_SIG_CLASS    = 32
359   }
360 _gpgme_attr_t;
361 typedef _gpgme_attr_t gpgme_attr_t _GPGME_DEPRECATED;
362
363
364 /* The available validities for a trust item or key.  */
365 typedef enum
366   {
367     GPGME_VALIDITY_UNKNOWN   = 0,
368     GPGME_VALIDITY_UNDEFINED = 1,
369     GPGME_VALIDITY_NEVER     = 2,
370     GPGME_VALIDITY_MARGINAL  = 3,
371     GPGME_VALIDITY_FULL      = 4,
372     GPGME_VALIDITY_ULTIMATE  = 5
373   }
374 gpgme_validity_t;
375
376
377 /* The TOFU policies. */
378 typedef enum
379   {
380     GPGME_TOFU_POLICY_NONE    = 0,
381     GPGME_TOFU_POLICY_AUTO    = 1,
382     GPGME_TOFU_POLICY_GOOD    = 2,
383     GPGME_TOFU_POLICY_UNKNOWN = 3,
384     GPGME_TOFU_POLICY_BAD     = 4,
385     GPGME_TOFU_POLICY_ASK     = 5
386   }
387 gpgme_tofu_policy_t;
388
389
390 /* The available protocols.  */
391 typedef enum
392   {
393     GPGME_PROTOCOL_OpenPGP = 0,  /* The default mode.  */
394     GPGME_PROTOCOL_CMS     = 1,
395     GPGME_PROTOCOL_GPGCONF = 2,  /* Special code for gpgconf.  */
396     GPGME_PROTOCOL_ASSUAN  = 3,  /* Low-level access to an Assuan server.  */
397     GPGME_PROTOCOL_G13     = 4,
398     GPGME_PROTOCOL_UISERVER= 5,
399     GPGME_PROTOCOL_SPAWN   = 6,  /* Direct access to any program.  */
400     GPGME_PROTOCOL_DEFAULT = 254,
401     GPGME_PROTOCOL_UNKNOWN = 255
402   }
403 gpgme_protocol_t;
404 /* Convenience macro for the surprisingly mixed spelling.  */
405 #define GPGME_PROTOCOL_OPENPGP GPGME_PROTOCOL_OpenPGP
406
407
408 /* The available keylist mode flags.  */
409 #define GPGME_KEYLIST_MODE_LOCAL                1
410 #define GPGME_KEYLIST_MODE_EXTERN               2
411 #define GPGME_KEYLIST_MODE_SIGS                 4
412 #define GPGME_KEYLIST_MODE_SIG_NOTATIONS        8
413 #define GPGME_KEYLIST_MODE_WITH_SECRET          16
414 #define GPGME_KEYLIST_MODE_WITH_TOFU            32
415 #define GPGME_KEYLIST_MODE_EPHEMERAL            128
416 #define GPGME_KEYLIST_MODE_VALIDATE             256
417
418 typedef unsigned int gpgme_keylist_mode_t;
419
420
421 /* The pinentry modes. */
422 typedef enum
423   {
424     GPGME_PINENTRY_MODE_DEFAULT  = 0,
425     GPGME_PINENTRY_MODE_ASK      = 1,
426     GPGME_PINENTRY_MODE_CANCEL   = 2,
427     GPGME_PINENTRY_MODE_ERROR    = 3,
428     GPGME_PINENTRY_MODE_LOOPBACK = 4
429   }
430 gpgme_pinentry_mode_t;
431
432
433 /* The available export mode flags.  */
434 #define GPGME_EXPORT_MODE_EXTERN                2
435 #define GPGME_EXPORT_MODE_MINIMAL               4
436 #define GPGME_EXPORT_MODE_SECRET               16
437 #define GPGME_EXPORT_MODE_RAW                  32
438 #define GPGME_EXPORT_MODE_PKCS12               64
439
440 typedef unsigned int gpgme_export_mode_t;
441
442
443 /* Flags for the audit log functions.  */
444 #define GPGME_AUDITLOG_HTML      1
445 #define GPGME_AUDITLOG_WITH_HELP 128
446
447 /* The possible stati for the edit operation.  */
448 typedef enum
449   {
450     GPGME_STATUS_EOF = 0,
451     /* mkstatus processing starts here */
452     GPGME_STATUS_ENTER = 1,
453     GPGME_STATUS_LEAVE = 2,
454     GPGME_STATUS_ABORT = 3,
455
456     GPGME_STATUS_GOODSIG = 4,
457     GPGME_STATUS_BADSIG = 5,
458     GPGME_STATUS_ERRSIG = 6,
459
460     GPGME_STATUS_BADARMOR = 7,
461
462     GPGME_STATUS_RSA_OR_IDEA = 8,      /* (legacy) */
463     GPGME_STATUS_KEYEXPIRED = 9,
464     GPGME_STATUS_KEYREVOKED = 10,
465
466     GPGME_STATUS_TRUST_UNDEFINED = 11,
467     GPGME_STATUS_TRUST_NEVER = 12,
468     GPGME_STATUS_TRUST_MARGINAL = 13,
469     GPGME_STATUS_TRUST_FULLY = 14,
470     GPGME_STATUS_TRUST_ULTIMATE = 15,
471
472     GPGME_STATUS_SHM_INFO = 16,        /* (legacy) */
473     GPGME_STATUS_SHM_GET = 17,         /* (legacy) */
474     GPGME_STATUS_SHM_GET_BOOL = 18,    /* (legacy) */
475     GPGME_STATUS_SHM_GET_HIDDEN = 19,  /* (legacy) */
476
477     GPGME_STATUS_NEED_PASSPHRASE = 20,
478     GPGME_STATUS_VALIDSIG = 21,
479     GPGME_STATUS_SIG_ID = 22,
480     GPGME_STATUS_ENC_TO = 23,
481     GPGME_STATUS_NODATA = 24,
482     GPGME_STATUS_BAD_PASSPHRASE = 25,
483     GPGME_STATUS_NO_PUBKEY = 26,
484     GPGME_STATUS_NO_SECKEY = 27,
485     GPGME_STATUS_NEED_PASSPHRASE_SYM = 28,
486     GPGME_STATUS_DECRYPTION_FAILED = 29,
487     GPGME_STATUS_DECRYPTION_OKAY = 30,
488     GPGME_STATUS_MISSING_PASSPHRASE = 31,
489     GPGME_STATUS_GOOD_PASSPHRASE = 32,
490     GPGME_STATUS_GOODMDC = 33,
491     GPGME_STATUS_BADMDC = 34,
492     GPGME_STATUS_ERRMDC = 35,
493     GPGME_STATUS_IMPORTED = 36,
494     GPGME_STATUS_IMPORT_OK = 37,
495     GPGME_STATUS_IMPORT_PROBLEM = 38,
496     GPGME_STATUS_IMPORT_RES = 39,
497     GPGME_STATUS_FILE_START = 40,
498     GPGME_STATUS_FILE_DONE = 41,
499     GPGME_STATUS_FILE_ERROR = 42,
500
501     GPGME_STATUS_BEGIN_DECRYPTION = 43,
502     GPGME_STATUS_END_DECRYPTION = 44,
503     GPGME_STATUS_BEGIN_ENCRYPTION = 45,
504     GPGME_STATUS_END_ENCRYPTION = 46,
505
506     GPGME_STATUS_DELETE_PROBLEM = 47,
507     GPGME_STATUS_GET_BOOL = 48,
508     GPGME_STATUS_GET_LINE = 49,
509     GPGME_STATUS_GET_HIDDEN = 50,
510     GPGME_STATUS_GOT_IT = 51,
511     GPGME_STATUS_PROGRESS = 52,
512     GPGME_STATUS_SIG_CREATED = 53,
513     GPGME_STATUS_SESSION_KEY = 54,
514     GPGME_STATUS_NOTATION_NAME = 55,
515     GPGME_STATUS_NOTATION_DATA = 56,
516     GPGME_STATUS_POLICY_URL = 57,
517     GPGME_STATUS_BEGIN_STREAM = 58,    /* (legacy) */
518     GPGME_STATUS_END_STREAM = 59,      /* (legacy) */
519     GPGME_STATUS_KEY_CREATED = 60,
520     GPGME_STATUS_USERID_HINT = 61,
521     GPGME_STATUS_UNEXPECTED = 62,
522     GPGME_STATUS_INV_RECP = 63,
523     GPGME_STATUS_NO_RECP = 64,
524     GPGME_STATUS_ALREADY_SIGNED = 65,
525     GPGME_STATUS_SIGEXPIRED = 66,      /* (legacy) */
526     GPGME_STATUS_EXPSIG = 67,
527     GPGME_STATUS_EXPKEYSIG = 68,
528     GPGME_STATUS_TRUNCATED = 69,
529     GPGME_STATUS_ERROR = 70,
530     GPGME_STATUS_NEWSIG = 71,
531     GPGME_STATUS_REVKEYSIG = 72,
532     GPGME_STATUS_SIG_SUBPACKET = 73,
533     GPGME_STATUS_NEED_PASSPHRASE_PIN = 74,
534     GPGME_STATUS_SC_OP_FAILURE = 75,
535     GPGME_STATUS_SC_OP_SUCCESS = 76,
536     GPGME_STATUS_CARDCTRL = 77,
537     GPGME_STATUS_BACKUP_KEY_CREATED = 78,
538     GPGME_STATUS_PKA_TRUST_BAD = 79,
539     GPGME_STATUS_PKA_TRUST_GOOD = 80,
540     GPGME_STATUS_PLAINTEXT = 81,
541     GPGME_STATUS_INV_SGNR = 82,
542     GPGME_STATUS_NO_SGNR = 83,
543     GPGME_STATUS_SUCCESS = 84,
544     GPGME_STATUS_DECRYPTION_INFO = 85,
545     GPGME_STATUS_PLAINTEXT_LENGTH = 86,
546     GPGME_STATUS_MOUNTPOINT = 87,
547     GPGME_STATUS_PINENTRY_LAUNCHED = 88,
548     GPGME_STATUS_ATTRIBUTE = 89,
549     GPGME_STATUS_BEGIN_SIGNING = 90,
550     GPGME_STATUS_KEY_NOT_CREATED = 91,
551     GPGME_STATUS_INQUIRE_MAXLEN = 92,
552     GPGME_STATUS_FAILURE = 93,
553     GPGME_STATUS_KEY_CONSIDERED = 94,
554     GPGME_STATUS_TOFU_USER = 95,
555     GPGME_STATUS_TOFU_STATS = 96,
556     GPGME_STATUS_TOFU_STATS_LONG = 97,
557     GPGME_STATUS_NOTATION_FLAGS = 98
558   }
559 gpgme_status_code_t;
560
561
562 /* The available signature notation flags.  */
563 #define GPGME_SIG_NOTATION_HUMAN_READABLE       1
564 #define GPGME_SIG_NOTATION_CRITICAL             2
565
566 typedef unsigned int gpgme_sig_notation_flags_t;
567
568 struct _gpgme_sig_notation
569 {
570   struct _gpgme_sig_notation *next;
571
572   /* If NAME is a null pointer, then VALUE contains a policy URL
573      rather than a notation.  */
574   char *name;
575
576   /* The value of the notation data.  */
577   char *value;
578
579   /* The length of the name of the notation data.  */
580   int name_len;
581
582   /* The length of the value of the notation data.  */
583   int value_len;
584
585   /* The accumulated flags.  */
586   gpgme_sig_notation_flags_t flags;
587
588   /* Notation data is human-readable.  */
589   unsigned int human_readable : 1;
590
591   /* Notation data is critical.  */
592   unsigned int critical : 1;
593
594   /* Internal to GPGME, do not use.  */
595   int _unused : 30;
596 };
597 typedef struct _gpgme_sig_notation *gpgme_sig_notation_t;
598
599
600 \f
601 /*
602  * Public structures.
603  */
604
605 /* The engine information structure.  */
606 struct _gpgme_engine_info
607 {
608   struct _gpgme_engine_info *next;
609
610   /* The protocol ID.  */
611   gpgme_protocol_t protocol;
612
613   /* The file name of the engine binary.  */
614   char *file_name;
615
616   /* The version string of the installed engine.  */
617   char *version;
618
619   /* The minimum version required for GPGME.  */
620   const char *req_version;
621
622   /* The home directory used, or NULL if default.  */
623   char *home_dir;
624 };
625 typedef struct _gpgme_engine_info *gpgme_engine_info_t;
626
627
628 /* An object with TOFU information.  */
629 struct _gpgme_tofu_info
630 {
631   struct _gpgme_tofu_info *next;
632
633   /* The TOFU validity:
634    *  0 := conflict
635    *  1 := key without history
636    *  2 := key with too little history
637    *  3 := key with enough history for basic trust
638    *  4 := key with a lot of history
639    */
640   unsigned int validity : 3;
641
642   /* The TOFU policy (gpgme_tofu_policy_t).  */
643   unsigned int policy : 4;
644
645   unsigned int _rfu : 25;
646
647   /* Number of signatures seen for this binding.  Capped at USHRT_MAX.  */
648   unsigned short signcount;
649   /* Number of encryptions done with this binding.  Capped at USHRT_MAX.  */
650   unsigned short encrcount;
651
652   /* Number of seconds since Epoch when the first and the most
653    * recently seen message were verified.  0 means unknown. */
654   unsigned long firstseen;
655   unsigned long lastseen;
656
657   /* If non-NULL a human readable string summarizing the TOFU data. */
658   char *description;
659 };
660 typedef struct _gpgme_tofu_info *gpgme_tofu_info_t;
661
662
663 /* A subkey from a key.  */
664 struct _gpgme_subkey
665 {
666   struct _gpgme_subkey *next;
667
668   /* True if subkey is revoked.  */
669   unsigned int revoked : 1;
670
671   /* True if subkey is expired.  */
672   unsigned int expired : 1;
673
674   /* True if subkey is disabled.  */
675   unsigned int disabled : 1;
676
677   /* True if subkey is invalid.  */
678   unsigned int invalid : 1;
679
680   /* True if subkey can be used for encryption.  */
681   unsigned int can_encrypt : 1;
682
683   /* True if subkey can be used for signing.  */
684   unsigned int can_sign : 1;
685
686   /* True if subkey can be used for certification.  */
687   unsigned int can_certify : 1;
688
689   /* True if subkey is secret.  */
690   unsigned int secret : 1;
691
692   /* True if subkey can be used for authentication.  */
693   unsigned int can_authenticate : 1;
694
695   /* True if subkey is qualified for signatures according to German law.  */
696   unsigned int is_qualified : 1;
697
698   /* True if the secret key is stored on a smart card.  */
699   unsigned int is_cardkey : 1;
700
701   /* Internal to GPGME, do not use.  */
702   unsigned int _unused : 21;
703
704   /* Public key algorithm supported by this subkey.  */
705   gpgme_pubkey_algo_t pubkey_algo;
706
707   /* Length of the subkey.  */
708   unsigned int length;
709
710   /* The key ID of the subkey.  */
711   char *keyid;
712
713   /* Internal to GPGME, do not use.  */
714   char _keyid[16 + 1];
715
716   /* The fingerprint of the subkey in hex digit form.  */
717   char *fpr;
718
719   /* The creation timestamp, -1 if invalid, 0 if not available.  */
720   long int timestamp;
721
722   /* The expiration timestamp, 0 if the subkey does not expire.  */
723   long int expires;
724
725   /* The serial number of a smart card holding this key or NULL.  */
726   char *card_number;
727
728   /* The name of the curve for ECC algorithms or NULL.  */
729   char *curve;
730
731   /* The keygrip of the subkey in hex digit form or NULL if not availabale.  */
732   char *keygrip;
733 };
734 typedef struct _gpgme_subkey *gpgme_subkey_t;
735
736
737 /* A signature on a user ID.  */
738 struct _gpgme_key_sig
739 {
740   struct _gpgme_key_sig *next;
741
742   /* True if the signature is a revocation signature.  */
743   unsigned int revoked : 1;
744
745   /* True if the signature is expired.  */
746   unsigned int expired : 1;
747
748   /* True if the signature is invalid.  */
749   unsigned int invalid : 1;
750
751   /* True if the signature should be exported.  */
752   unsigned int exportable : 1;
753
754   /* Internal to GPGME, do not use.  */
755   unsigned int _unused : 28;
756
757   /* The public key algorithm used to create the signature.  */
758   gpgme_pubkey_algo_t pubkey_algo;
759
760   /* The key ID of key used to create the signature.  */
761   char *keyid;
762
763   /* Internal to GPGME, do not use.  */
764   char _keyid[16 + 1];
765
766   /* The creation timestamp, -1 if invalid, 0 if not available.  */
767   long int timestamp;
768
769   /* The expiration timestamp, 0 if the subkey does not expire.  */
770   long int expires;
771
772   /* Same as in gpgme_signature_t.  */
773   gpgme_error_t status;
774
775 #ifdef __cplusplus
776   unsigned int _obsolete_class _GPGME_DEPRECATED;
777 #else
778   /* Must be set to SIG_CLASS below.  */
779   unsigned int class _GPGME_DEPRECATED_OUTSIDE_GPGME;
780 #endif
781
782   /* The user ID string.  */
783   char *uid;
784
785   /* The name part of the user ID.  */
786   char *name;
787
788   /* The email part of the user ID.  */
789   char *email;
790
791   /* The comment part of the user ID.  */
792   char *comment;
793
794   /* Crypto backend specific signature class.  */
795   unsigned int sig_class;
796
797   /* Notation data and policy URLs.  */
798   gpgme_sig_notation_t notations;
799
800   /* Internal to GPGME, do not use.  */
801   gpgme_sig_notation_t _last_notation;
802 };
803 typedef struct _gpgme_key_sig *gpgme_key_sig_t;
804
805
806 /* An user ID from a key.  */
807 struct _gpgme_user_id
808 {
809   struct _gpgme_user_id *next;
810
811   /* True if the user ID is revoked.  */
812   unsigned int revoked : 1;
813
814   /* True if the user ID is invalid.  */
815   unsigned int invalid : 1;
816
817   /* Internal to GPGME, do not use.  */
818   unsigned int _unused : 30;
819
820   /* The validity of the user ID.  */
821   gpgme_validity_t validity;
822
823   /* The user ID string.  */
824   char *uid;
825
826   /* The name part of the user ID.  */
827   char *name;
828
829   /* The email part of the user ID.  */
830   char *email;
831
832   /* The comment part of the user ID.  */
833   char *comment;
834
835   /* The signatures of the user ID.  */
836   gpgme_key_sig_t signatures;
837
838   /* Internal to GPGME, do not use.  */
839   gpgme_key_sig_t _last_keysig;
840
841   /* The mail address (addr-spec from RFC5322) of the UID string.
842    * This is general the same as the EMAIL part of this struct but
843    * might be slightly different.  IF no mail address is available
844    * NULL is stored.  */
845   char *address;
846
847   /* The malloced TOFU information or NULL.  */
848   gpgme_tofu_info_t tofu;
849 };
850 typedef struct _gpgme_user_id *gpgme_user_id_t;
851
852
853 /* A key from the keyring.  */
854 struct _gpgme_key
855 {
856   /* Internal to GPGME, do not use.  */
857   unsigned int _refs;
858
859   /* True if key is revoked.  */
860   unsigned int revoked : 1;
861
862   /* True if key is expired.  */
863   unsigned int expired : 1;
864
865   /* True if key is disabled.  */
866   unsigned int disabled : 1;
867
868   /* True if key is invalid.  */
869   unsigned int invalid : 1;
870
871   /* True if key can be used for encryption.  */
872   unsigned int can_encrypt : 1;
873
874   /* True if key can be used for signing.  */
875   unsigned int can_sign : 1;
876
877   /* True if key can be used for certification.  */
878   unsigned int can_certify : 1;
879
880   /* True if key is secret.  */
881   unsigned int secret : 1;
882
883   /* True if key can be used for authentication.  */
884   unsigned int can_authenticate : 1;
885
886   /* True if subkey is qualified for signatures according to German law.  */
887   unsigned int is_qualified : 1;
888
889   /* Internal to GPGME, do not use.  */
890   unsigned int _unused : 22;
891
892   /* This is the protocol supported by this key.  */
893   gpgme_protocol_t protocol;
894
895   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
896      issuer serial.  */
897   char *issuer_serial;
898
899   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
900      issuer name.  */
901   char *issuer_name;
902
903   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the chain
904      ID.  */
905   char *chain_id;
906
907   /* If protocol is GPGME_PROTOCOL_OpenPGP, this field contains the
908      owner trust.  */
909   gpgme_validity_t owner_trust;
910
911   /* The subkeys of the key.  */
912   gpgme_subkey_t subkeys;
913
914   /* The user IDs of the key.  */
915   gpgme_user_id_t uids;
916
917   /* Internal to GPGME, do not use.  */
918   gpgme_subkey_t _last_subkey;
919
920   /* Internal to GPGME, do not use.  */
921   gpgme_user_id_t _last_uid;
922
923   /* The keylist mode that was active when listing the key.  */
924   gpgme_keylist_mode_t keylist_mode;
925
926   /* This field gives the fingerprint of the primary key.  Note that
927    * this is a copy of the FPR of the first subkey.  We need it here
928    * to allow for an incomplete key object.  */
929   char *fpr;
930 };
931 typedef struct _gpgme_key *gpgme_key_t;
932
933
934 /* An invalid key object.  */
935 struct _gpgme_invalid_key
936 {
937   struct _gpgme_invalid_key *next;
938
939   /* The string used to request the key.  Despite the name this may
940    * not be a fingerprint.  */
941   char *fpr;
942
943   /* The error code.  */
944   gpgme_error_t reason;
945 };
946 typedef struct _gpgme_invalid_key *gpgme_invalid_key_t;
947
948
949 \f
950 /*
951  * Types for callback functions.
952  */
953
954 /* Request a passphrase from the user.  */
955 typedef gpgme_error_t (*gpgme_passphrase_cb_t) (void *hook,
956                                                 const char *uid_hint,
957                                                 const char *passphrase_info,
958                                                 int prev_was_bad, int fd);
959
960 /* Inform the user about progress made.  */
961 typedef void (*gpgme_progress_cb_t) (void *opaque, const char *what,
962                                      int type, int current, int total);
963
964 /* Status messages from gpg. */
965 typedef gpgme_error_t (*gpgme_status_cb_t) (void *opaque, const char *keyword,
966                                             const char *args);
967
968
969 /* Interact with the user about an edit operation.  */
970 typedef gpgme_error_t (*gpgme_edit_cb_t) (void *opaque,
971                                           gpgme_status_code_t status,
972                                           const char *args, int fd);
973
974
975
976 \f
977 /*
978  * Context management functions.
979  */
980
981 /* Create a new context and return it in CTX.  */
982 gpgme_error_t gpgme_new (gpgme_ctx_t *ctx);
983
984 /* Release the context CTX.  */
985 void gpgme_release (gpgme_ctx_t ctx);
986
987 /* Set the flag NAME for CTX to VALUE.  */
988 gpgme_error_t gpgme_set_ctx_flag (gpgme_ctx_t ctx,
989                                   const char *name, const char *value);
990
991 /* Set the protocol to be used by CTX to PROTO.  */
992 gpgme_error_t gpgme_set_protocol (gpgme_ctx_t ctx, gpgme_protocol_t proto);
993
994 /* Get the protocol used with CTX */
995 gpgme_protocol_t gpgme_get_protocol (gpgme_ctx_t ctx);
996
997 /* Set the crypto protocol to be used by CTX to PROTO.
998    gpgme_set_protocol actually sets the backend engine.  This sets the
999    crypto protocol used in engines that support more than one crypto
1000    prococol (for example, an UISERVER can support OpenPGP and CMS).
1001    This is reset to the default with gpgme_set_protocol.  */
1002 gpgme_error_t gpgme_set_sub_protocol (gpgme_ctx_t ctx,
1003                                       gpgme_protocol_t proto);
1004
1005 /* Get the sub protocol.  */
1006 gpgme_protocol_t gpgme_get_sub_protocol (gpgme_ctx_t ctx);
1007
1008 /* Get the string describing protocol PROTO, or NULL if invalid.  */
1009 const char *gpgme_get_protocol_name (gpgme_protocol_t proto);
1010
1011 /* If YES is non-zero, enable armor mode in CTX, disable it otherwise.  */
1012 void gpgme_set_armor (gpgme_ctx_t ctx, int yes);
1013
1014 /* Return non-zero if armor mode is set in CTX.  */
1015 int gpgme_get_armor (gpgme_ctx_t ctx);
1016
1017 /* If YES is non-zero, enable text mode in CTX, disable it otherwise.  */
1018 void gpgme_set_textmode (gpgme_ctx_t ctx, int yes);
1019
1020 /* Return non-zero if text mode is set in CTX.  */
1021 int gpgme_get_textmode (gpgme_ctx_t ctx);
1022
1023 /* If YES is non-zero, enable offline mode in CTX, disable it otherwise.  */
1024 void gpgme_set_offline (gpgme_ctx_t ctx, int yes);
1025
1026 /* Return non-zero if offline mode is set in CTX.  */
1027 int gpgme_get_offline (gpgme_ctx_t ctx);
1028
1029 /* Use whatever the default of the backend crypto engine is.  */
1030 #define GPGME_INCLUDE_CERTS_DEFAULT     -256
1031
1032 /* Include up to NR_OF_CERTS certificates in an S/MIME message.  */
1033 void gpgme_set_include_certs (gpgme_ctx_t ctx, int nr_of_certs);
1034
1035 /* Return the number of certs to include in an S/MIME message.  */
1036 int gpgme_get_include_certs (gpgme_ctx_t ctx);
1037
1038 /* Set keylist mode in CTX to MODE.  */
1039 gpgme_error_t gpgme_set_keylist_mode (gpgme_ctx_t ctx,
1040                                       gpgme_keylist_mode_t mode);
1041
1042 /* Get keylist mode in CTX.  */
1043 gpgme_keylist_mode_t gpgme_get_keylist_mode (gpgme_ctx_t ctx);
1044
1045 /* Set the pinentry mode for CTX to MODE. */
1046 gpgme_error_t gpgme_set_pinentry_mode (gpgme_ctx_t ctx,
1047                                        gpgme_pinentry_mode_t mode);
1048
1049 /* Get the pinentry mode of CTX.  */
1050 gpgme_pinentry_mode_t gpgme_get_pinentry_mode (gpgme_ctx_t ctx);
1051
1052 /* Set the passphrase callback function in CTX to CB.  HOOK_VALUE is
1053    passed as first argument to the passphrase callback function.  */
1054 void gpgme_set_passphrase_cb (gpgme_ctx_t ctx,
1055                               gpgme_passphrase_cb_t cb, void *hook_value);
1056
1057 /* Get the current passphrase callback function in *CB and the current
1058    hook value in *HOOK_VALUE.  */
1059 void gpgme_get_passphrase_cb (gpgme_ctx_t ctx, gpgme_passphrase_cb_t *cb,
1060                               void **hook_value);
1061
1062 /* Set the progress callback function in CTX to CB.  HOOK_VALUE is
1063    passed as first argument to the progress callback function.  */
1064 void gpgme_set_progress_cb (gpgme_ctx_t c, gpgme_progress_cb_t cb,
1065                             void *hook_value);
1066
1067 /* Get the current progress callback function in *CB and the current
1068    hook value in *HOOK_VALUE.  */
1069 void gpgme_get_progress_cb (gpgme_ctx_t ctx, gpgme_progress_cb_t *cb,
1070                             void **hook_value);
1071
1072 /* Set the status callback function in CTX to CB.  HOOK_VALUE is
1073    passed as first argument to the status callback function.  */
1074 void gpgme_set_status_cb (gpgme_ctx_t c, gpgme_status_cb_t cb,
1075                           void *hook_value);
1076
1077 /* Get the current status callback function in *CB and the current
1078    hook value in *HOOK_VALUE.  */
1079 void gpgme_get_status_cb (gpgme_ctx_t ctx, gpgme_status_cb_t *cb,
1080                           void **hook_value);
1081
1082 /* This function sets the locale for the context CTX, or the default
1083    locale if CTX is a null pointer.  */
1084 gpgme_error_t gpgme_set_locale (gpgme_ctx_t ctx, int category,
1085                                 const char *value);
1086
1087 /* Get the information about the configured engines.  A pointer to the
1088    first engine in the statically allocated linked list is returned.
1089    The returned data is valid until the next gpgme_ctx_set_engine_info.  */
1090 gpgme_engine_info_t gpgme_ctx_get_engine_info (gpgme_ctx_t ctx);
1091
1092 /* Set the engine info for the context CTX, protocol PROTO, to the
1093    file name FILE_NAME and the home directory HOME_DIR.  */
1094 gpgme_error_t gpgme_ctx_set_engine_info (gpgme_ctx_t ctx,
1095                                          gpgme_protocol_t proto,
1096                                          const char *file_name,
1097                                          const char *home_dir);
1098
1099 /* Delete all signers from CTX.  */
1100 void gpgme_signers_clear (gpgme_ctx_t ctx);
1101
1102 /* Add KEY to list of signers in CTX.  */
1103 gpgme_error_t gpgme_signers_add (gpgme_ctx_t ctx, const gpgme_key_t key);
1104
1105 /* Return the number of signers in CTX.  */
1106 unsigned int gpgme_signers_count (const gpgme_ctx_t ctx);
1107
1108 /* Return the SEQth signer's key in CTX.  */
1109 gpgme_key_t gpgme_signers_enum (const gpgme_ctx_t ctx, int seq);
1110
1111 /* Retrieve the signature status of signature IDX in CTX after a
1112    successful verify operation in R_STAT (if non-null).  The creation
1113    time stamp of the signature is returned in R_CREATED (if non-null).
1114    The function returns a string containing the fingerprint.
1115    Deprecated, use verify result directly.  */
1116 const char *gpgme_get_sig_status (gpgme_ctx_t ctx, int idx,
1117                                   _gpgme_sig_stat_t *r_stat,
1118                                   time_t *r_created) _GPGME_DEPRECATED;
1119
1120 /* Retrieve certain attributes of a signature.  IDX is the index
1121    number of the signature after a successful verify operation.  WHAT
1122    is an attribute where GPGME_ATTR_EXPIRE is probably the most useful
1123    one.  WHATIDX is to be passed as 0 for most attributes . */
1124 unsigned long gpgme_get_sig_ulong_attr (gpgme_ctx_t c, int idx,
1125                                         _gpgme_attr_t what, int whatidx)
1126      _GPGME_DEPRECATED;
1127 const char *gpgme_get_sig_string_attr (gpgme_ctx_t c, int idx,
1128                                        _gpgme_attr_t what, int whatidx)
1129      _GPGME_DEPRECATED;
1130
1131
1132 /* Get the key used to create signature IDX in CTX and return it in
1133    R_KEY.  */
1134 gpgme_error_t gpgme_get_sig_key (gpgme_ctx_t ctx, int idx, gpgme_key_t *r_key)
1135      _GPGME_DEPRECATED;
1136
1137
1138 /* Clear all notation data from the context.  */
1139 void gpgme_sig_notation_clear (gpgme_ctx_t ctx);
1140
1141 /* Add the human-readable notation data with name NAME and value VALUE
1142    to the context CTX, using the flags FLAGS.  If NAME is NULL, then
1143    VALUE should be a policy URL.  The flag
1144    GPGME_SIG_NOTATION_HUMAN_READABLE is forced to be true for notation
1145    data, and false for policy URLs.  */
1146 gpgme_error_t gpgme_sig_notation_add (gpgme_ctx_t ctx, const char *name,
1147                                       const char *value,
1148                                       gpgme_sig_notation_flags_t flags);
1149
1150 /* Get the sig notations for this context.  */
1151 gpgme_sig_notation_t gpgme_sig_notation_get (gpgme_ctx_t ctx);
1152
1153
1154 \f
1155 /*
1156  * Run control.
1157  */
1158
1159 /* The type of an I/O callback function.  */
1160 typedef gpgme_error_t (*gpgme_io_cb_t) (void *data, int fd);
1161
1162 /* The type of a function that can register FNC as the I/O callback
1163    function for the file descriptor FD with direction dir (0: for writing,
1164    1: for reading).  FNC_DATA should be passed as DATA to FNC.  The
1165    function should return a TAG suitable for the corresponding
1166    gpgme_remove_io_cb_t, and an error value.  */
1167 typedef gpgme_error_t (*gpgme_register_io_cb_t) (void *data, int fd, int dir,
1168                                                  gpgme_io_cb_t fnc,
1169                                                  void *fnc_data, void **tag);
1170
1171 /* The type of a function that can remove a previously registered I/O
1172    callback function given TAG as returned by the register
1173    function.  */
1174 typedef void (*gpgme_remove_io_cb_t) (void *tag);
1175
1176 typedef enum
1177   {
1178     GPGME_EVENT_START,
1179     GPGME_EVENT_DONE,
1180     GPGME_EVENT_NEXT_KEY,
1181     GPGME_EVENT_NEXT_TRUSTITEM
1182   }
1183 gpgme_event_io_t;
1184
1185 struct gpgme_io_event_done_data
1186 {
1187   /* A fatal IPC error or an operational error in state-less
1188      protocols.  */
1189   gpgme_error_t err;
1190
1191   /* An operational errors in session-based protocols.  */
1192   gpgme_error_t op_err;
1193 };
1194 typedef struct gpgme_io_event_done_data *gpgme_io_event_done_data_t;
1195
1196 /* The type of a function that is called when a context finished an
1197    operation.  */
1198 typedef void (*gpgme_event_io_cb_t) (void *data, gpgme_event_io_t type,
1199                                      void *type_data);
1200
1201 struct gpgme_io_cbs
1202 {
1203   gpgme_register_io_cb_t add;
1204   void *add_priv;
1205   gpgme_remove_io_cb_t remove;
1206   gpgme_event_io_cb_t event;
1207   void *event_priv;
1208 };
1209 typedef struct gpgme_io_cbs *gpgme_io_cbs_t;
1210
1211 /* Set the I/O callback functions in CTX to IO_CBS.  */
1212 void gpgme_set_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
1213
1214 /* Get the current I/O callback functions.  */
1215 void gpgme_get_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
1216
1217 /* Wrappers around the internal I/O functions for use with
1218    gpgme_passphrase_cb_t and gpgme_edit_cb_t.  */
1219 @API__SSIZE_T@ gpgme_io_read (int fd, void *buffer, size_t count);
1220 @API__SSIZE_T@ gpgme_io_write (int fd, const void *buffer, size_t count);
1221 int     gpgme_io_writen (int fd, const void *buffer, size_t count);
1222
1223 /* Process the pending operation and, if HANG is non-zero, wait for
1224    the pending operation to finish.  */
1225 gpgme_ctx_t gpgme_wait (gpgme_ctx_t ctx, gpgme_error_t *status, int hang);
1226
1227 gpgme_ctx_t gpgme_wait_ext (gpgme_ctx_t ctx, gpgme_error_t *status,
1228                             gpgme_error_t *op_err, int hang);
1229
1230 /* Cancel a pending asynchronous operation.  */
1231 gpgme_error_t gpgme_cancel (gpgme_ctx_t ctx);
1232
1233 /* Cancel a pending operation asynchronously.  */
1234 gpgme_error_t gpgme_cancel_async (gpgme_ctx_t ctx);
1235
1236
1237 \f
1238 /*
1239  * Functions to handle data objects.
1240  */
1241
1242 /* Read up to SIZE bytes into buffer BUFFER from the data object with
1243    the handle HANDLE.  Return the number of characters read, 0 on EOF
1244    and -1 on error.  If an error occurs, errno is set.  */
1245 typedef @API__SSIZE_T@ (*gpgme_data_read_cb_t) (void *handle, void *buffer,
1246                                          size_t size);
1247
1248 /* Write up to SIZE bytes from buffer BUFFER to the data object with
1249    the handle HANDLE.  Return the number of characters written, or -1
1250    on error.  If an error occurs, errno is set.  */
1251 typedef @API__SSIZE_T@ (*gpgme_data_write_cb_t) (void *handle, const void *buffer,
1252                                           size_t size);
1253
1254 /* Set the current position from where the next read or write starts
1255    in the data object with the handle HANDLE to OFFSET, relativ to
1256    WHENCE.  Returns the new offset in bytes from the beginning of the
1257    data object.  */
1258 typedef @API__OFF_T@ (*gpgme_data_seek_cb_t) (void *handle,
1259                                        @API__OFF_T@ offset, int whence);
1260
1261 /* Close the data object with the handle HANDLE.  */
1262 typedef void (*gpgme_data_release_cb_t) (void *handle);
1263
1264 struct gpgme_data_cbs
1265 {
1266   gpgme_data_read_cb_t read;
1267   gpgme_data_write_cb_t write;
1268   gpgme_data_seek_cb_t seek;
1269   gpgme_data_release_cb_t release;
1270 };
1271 typedef struct gpgme_data_cbs *gpgme_data_cbs_t;
1272
1273 /* Read up to SIZE bytes into buffer BUFFER from the data object with
1274    the handle DH.  Return the number of characters read, 0 on EOF and
1275    -1 on error.  If an error occurs, errno is set.  */
1276 @API__SSIZE_T@ gpgme_data_read (gpgme_data_t dh, void *buffer, size_t size);
1277
1278 /* Write up to SIZE bytes from buffer BUFFER to the data object with
1279    the handle DH.  Return the number of characters written, or -1 on
1280    error.  If an error occurs, errno is set.  */
1281 @API__SSIZE_T@ gpgme_data_write (gpgme_data_t dh, const void *buffer, size_t size);
1282
1283 /* Set the current position from where the next read or write starts
1284    in the data object with the handle DH to OFFSET, relativ to WHENCE.
1285    Returns the new offset in bytes from the beginning of the data
1286    object.  */
1287 @API__OFF_T@ gpgme_data_seek (gpgme_data_t dh, @API__OFF_T@ offset, int whence);
1288
1289 /* Create a new data buffer and return it in R_DH.  */
1290 gpgme_error_t gpgme_data_new (gpgme_data_t *r_dh);
1291
1292 /* Destroy the data buffer DH.  */
1293 void gpgme_data_release (gpgme_data_t dh);
1294
1295 /* Create a new data buffer filled with SIZE bytes starting from
1296    BUFFER.  If COPY is zero, copying is delayed until necessary, and
1297    the data is taken from the original location when needed.  */
1298 gpgme_error_t gpgme_data_new_from_mem (gpgme_data_t *r_dh,
1299                                        const char *buffer, size_t size,
1300                                        int copy);
1301
1302 /* Destroy the data buffer DH and return a pointer to its content.
1303    The memory has be to released with gpgme_free() by the user.  It's
1304    size is returned in R_LEN.  */
1305 char *gpgme_data_release_and_get_mem (gpgme_data_t dh, size_t *r_len);
1306
1307 /* Release the memory returned by gpgme_data_release_and_get_mem() and
1308    some other functions.  */
1309 void gpgme_free (void *buffer);
1310
1311 gpgme_error_t gpgme_data_new_from_cbs (gpgme_data_t *dh,
1312                                        gpgme_data_cbs_t cbs,
1313                                        void *handle);
1314
1315 gpgme_error_t gpgme_data_new_from_fd (gpgme_data_t *dh, int fd);
1316
1317 gpgme_error_t gpgme_data_new_from_stream (gpgme_data_t *dh, FILE *stream);
1318
1319 /* Return the encoding attribute of the data buffer DH */
1320 gpgme_data_encoding_t gpgme_data_get_encoding (gpgme_data_t dh);
1321
1322 /* Set the encoding attribute of data buffer DH to ENC */
1323 gpgme_error_t gpgme_data_set_encoding (gpgme_data_t dh,
1324                                        gpgme_data_encoding_t enc);
1325
1326 /* Get the file name associated with the data object with handle DH, or
1327    NULL if there is none.  */
1328 char *gpgme_data_get_file_name (gpgme_data_t dh);
1329
1330 /* Set the file name associated with the data object with handle DH to
1331    FILE_NAME.  */
1332 gpgme_error_t gpgme_data_set_file_name (gpgme_data_t dh,
1333                                         const char *file_name);
1334
1335 /* Set a flag for the data object DH.  See the manual for details.  */
1336 gpg_error_t gpgme_data_set_flag (gpgme_data_t dh,
1337                                  const char *name, const char *value);
1338
1339 /* Try to identify the type of the data in DH.  */
1340 gpgme_data_type_t gpgme_data_identify (gpgme_data_t dh, int reserved);
1341
1342
1343 /* Create a new data buffer which retrieves the data from the callback
1344    function READ_CB.  Deprecated, please use gpgme_data_new_from_cbs
1345    instead.  */
1346 gpgme_error_t gpgme_data_new_with_read_cb (gpgme_data_t *r_dh,
1347                                            int (*read_cb) (void*,char *,
1348                                                            size_t,size_t*),
1349                                            void *read_cb_value)
1350      _GPGME_DEPRECATED;
1351
1352 /* Create a new data buffer filled with the content of file FNAME.
1353    COPY must be non-zero.  For delayed read, please use
1354    gpgme_data_new_from_fd or gpgme_data_new_from_stream instead.  */
1355 gpgme_error_t gpgme_data_new_from_file (gpgme_data_t *r_dh,
1356                                         const char *fname,
1357                                         int copy);
1358
1359 /* Create a new data buffer filled with LENGTH bytes starting from
1360    OFFSET within the file FNAME or stream FP (exactly one must be
1361    non-zero).  */
1362 gpgme_error_t gpgme_data_new_from_filepart (gpgme_data_t *r_dh,
1363                                             const char *fname, FILE *fp,
1364                                             @API__OFF_T@ offset, size_t length);
1365
1366 /* Reset the read pointer in DH.  Deprecated, please use
1367    gpgme_data_seek instead.  */
1368 gpgme_error_t gpgme_data_rewind (gpgme_data_t dh) _GPGME_DEPRECATED;
1369
1370
1371 \f
1372 /*
1373  * Key and trust functions.
1374  */
1375
1376 /* Get the key with the fingerprint FPR from the crypto backend.  If
1377    SECRET is true, get the secret key.  */
1378 gpgme_error_t gpgme_get_key (gpgme_ctx_t ctx, const char *fpr,
1379                              gpgme_key_t *r_key, int secret);
1380
1381 /* Create a dummy key to specify an email address.  */
1382 gpgme_error_t gpgme_key_from_uid (gpgme_key_t *key, const char *name);
1383
1384 /* Acquire a reference to KEY.  */
1385 void gpgme_key_ref (gpgme_key_t key);
1386
1387 /* Release a reference to KEY.  If this was the last one the key is
1388    destroyed.  */
1389 void gpgme_key_unref (gpgme_key_t key);
1390 void gpgme_key_release (gpgme_key_t key);
1391
1392 /* Return the value of the attribute WHAT of KEY, which has to be
1393    representable by a string.  IDX specifies the sub key or user ID
1394    for attributes related to sub keys or user IDs.  Deprecated, use
1395    key structure directly instead. */
1396 const char *gpgme_key_get_string_attr (gpgme_key_t key, _gpgme_attr_t what,
1397                                        const void *reserved, int idx)
1398      _GPGME_DEPRECATED;
1399
1400 /* Return the value of the attribute WHAT of KEY, which has to be
1401    representable by an unsigned integer.  IDX specifies the sub key or
1402    user ID for attributes related to sub keys or user IDs.
1403    Deprecated, use key structure directly instead.  */
1404 unsigned long gpgme_key_get_ulong_attr (gpgme_key_t key, _gpgme_attr_t what,
1405                                         const void *reserved, int idx)
1406      _GPGME_DEPRECATED;
1407
1408 /* Return the value of the attribute WHAT of a signature on user ID
1409    UID_IDX in KEY, which has to be representable by a string.  IDX
1410    specifies the signature.  Deprecated, use key structure directly
1411    instead.  */
1412 const char *gpgme_key_sig_get_string_attr (gpgme_key_t key, int uid_idx,
1413                                            _gpgme_attr_t what,
1414                                            const void *reserved, int idx)
1415      _GPGME_DEPRECATED;
1416
1417 /* Return the value of the attribute WHAT of a signature on user ID
1418    UID_IDX in KEY, which has to be representable by an unsigned
1419    integer string.  IDX specifies the signature.  Deprecated, use key
1420    structure directly instead.  */
1421 unsigned long gpgme_key_sig_get_ulong_attr (gpgme_key_t key, int uid_idx,
1422                                             _gpgme_attr_t what,
1423                                             const void *reserved, int idx)
1424      _GPGME_DEPRECATED;
1425
1426
1427 \f
1428 /*
1429  * Encryption.
1430  */
1431
1432 struct _gpgme_op_encrypt_result
1433 {
1434   /* The list of invalid recipients.  */
1435   gpgme_invalid_key_t invalid_recipients;
1436 };
1437 typedef struct _gpgme_op_encrypt_result *gpgme_encrypt_result_t;
1438
1439 /* Retrieve a pointer to the result of the encrypt operation.  */
1440 gpgme_encrypt_result_t gpgme_op_encrypt_result (gpgme_ctx_t ctx);
1441
1442 /* The valid encryption flags.  */
1443 typedef enum
1444   {
1445     GPGME_ENCRYPT_ALWAYS_TRUST = 1,
1446     GPGME_ENCRYPT_NO_ENCRYPT_TO = 2,
1447     GPGME_ENCRYPT_PREPARE = 4,
1448     GPGME_ENCRYPT_EXPECT_SIGN = 8,
1449     GPGME_ENCRYPT_NO_COMPRESS = 16,
1450     GPGME_ENCRYPT_SYMMETRIC = 32
1451   }
1452 gpgme_encrypt_flags_t;
1453
1454 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1455    store the resulting ciphertext in CIPHER.  */
1456 gpgme_error_t gpgme_op_encrypt_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
1457                                       gpgme_encrypt_flags_t flags,
1458                                       gpgme_data_t plain, gpgme_data_t cipher);
1459 gpgme_error_t gpgme_op_encrypt (gpgme_ctx_t ctx, gpgme_key_t recp[],
1460                                 gpgme_encrypt_flags_t flags,
1461                                 gpgme_data_t plain, gpgme_data_t cipher);
1462
1463 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1464    store the resulting ciphertext in CIPHER.  Also sign the ciphertext
1465    with the signers in CTX.  */
1466 gpgme_error_t gpgme_op_encrypt_sign_start (gpgme_ctx_t ctx,
1467                                            gpgme_key_t recp[],
1468                                            gpgme_encrypt_flags_t flags,
1469                                            gpgme_data_t plain,
1470                                            gpgme_data_t cipher);
1471 gpgme_error_t gpgme_op_encrypt_sign (gpgme_ctx_t ctx, gpgme_key_t recp[],
1472                                      gpgme_encrypt_flags_t flags,
1473                                      gpgme_data_t plain, gpgme_data_t cipher);
1474
1475 \f
1476 /*
1477  * Decryption.
1478  */
1479
1480 struct _gpgme_recipient
1481 {
1482   struct _gpgme_recipient *next;
1483
1484   /* The key ID of key for which the text was encrypted.  */
1485   char *keyid;
1486
1487   /* Internal to GPGME, do not use.  */
1488   char _keyid[16 + 1];
1489
1490   /* The public key algorithm of the recipient key.  */
1491   gpgme_pubkey_algo_t pubkey_algo;
1492
1493   /* The status of the recipient.  */
1494   gpgme_error_t status;
1495 };
1496 typedef struct _gpgme_recipient *gpgme_recipient_t;
1497
1498 struct _gpgme_op_decrypt_result
1499 {
1500   char *unsupported_algorithm;
1501
1502   /* Key should not have been used for encryption.  */
1503   unsigned int wrong_key_usage : 1;
1504
1505   /* Internal to GPGME, do not use.  */
1506   int _unused : 31;
1507
1508   gpgme_recipient_t recipients;
1509
1510   /* The original file name of the plaintext message, if
1511      available.  */
1512   char *file_name;
1513 };
1514 typedef struct _gpgme_op_decrypt_result *gpgme_decrypt_result_t;
1515
1516 /* Retrieve a pointer to the result of the decrypt operation.  */
1517 gpgme_decrypt_result_t gpgme_op_decrypt_result (gpgme_ctx_t ctx);
1518
1519 /* Decrypt ciphertext CIPHER within CTX and store the resulting
1520    plaintext in PLAIN.  */
1521 gpgme_error_t gpgme_op_decrypt_start (gpgme_ctx_t ctx, gpgme_data_t cipher,
1522                                       gpgme_data_t plain);
1523 gpgme_error_t gpgme_op_decrypt (gpgme_ctx_t ctx,
1524                                 gpgme_data_t cipher, gpgme_data_t plain);
1525
1526 /* Decrypt ciphertext CIPHER and make a signature verification within
1527    CTX and store the resulting plaintext in PLAIN.  */
1528 gpgme_error_t gpgme_op_decrypt_verify_start (gpgme_ctx_t ctx,
1529                                              gpgme_data_t cipher,
1530                                              gpgme_data_t plain);
1531 gpgme_error_t gpgme_op_decrypt_verify (gpgme_ctx_t ctx, gpgme_data_t cipher,
1532                                        gpgme_data_t plain);
1533
1534 \f
1535 /*
1536  * Signing.
1537  */
1538
1539 struct _gpgme_new_signature
1540 {
1541   struct _gpgme_new_signature *next;
1542
1543   /* The type of the signature.  */
1544   gpgme_sig_mode_t type;
1545
1546   /* The public key algorithm used to create the signature.  */
1547   gpgme_pubkey_algo_t pubkey_algo;
1548
1549   /* The hash algorithm used to create the signature.  */
1550   gpgme_hash_algo_t hash_algo;
1551
1552   /* Internal to GPGME, do not use.  Must be set to the same value as
1553      CLASS below.  */
1554   unsigned long _obsolete_class;
1555
1556   /* Signature creation time.  */
1557   long int timestamp;
1558
1559   /* The fingerprint of the signature.  */
1560   char *fpr;
1561
1562 #ifdef __cplusplus
1563   unsigned int _obsolete_class_2;
1564 #else
1565   /* Must be set to SIG_CLASS below.  */
1566   unsigned int class _GPGME_DEPRECATED_OUTSIDE_GPGME;
1567 #endif
1568
1569   /* Crypto backend specific signature class.  */
1570   unsigned int sig_class;
1571 };
1572 typedef struct _gpgme_new_signature *gpgme_new_signature_t;
1573
1574 struct _gpgme_op_sign_result
1575 {
1576   /* The list of invalid signers.  */
1577   gpgme_invalid_key_t invalid_signers;
1578   gpgme_new_signature_t signatures;
1579 };
1580 typedef struct _gpgme_op_sign_result *gpgme_sign_result_t;
1581
1582 /* Retrieve a pointer to the result of the signing operation.  */
1583 gpgme_sign_result_t gpgme_op_sign_result (gpgme_ctx_t ctx);
1584
1585 /* Sign the plaintext PLAIN and store the signature in SIG.  */
1586 gpgme_error_t gpgme_op_sign_start (gpgme_ctx_t ctx,
1587                                    gpgme_data_t plain, gpgme_data_t sig,
1588                                    gpgme_sig_mode_t mode);
1589 gpgme_error_t gpgme_op_sign (gpgme_ctx_t ctx,
1590                              gpgme_data_t plain, gpgme_data_t sig,
1591                              gpgme_sig_mode_t mode);
1592
1593 \f
1594 /*
1595  * Verify.
1596  */
1597
1598 /* Flags used for the SUMMARY field in a gpgme_signature_t.  */
1599 typedef enum
1600   {
1601     GPGME_SIGSUM_VALID       = 0x0001,  /* The signature is fully valid.  */
1602     GPGME_SIGSUM_GREEN       = 0x0002,  /* The signature is good.  */
1603     GPGME_SIGSUM_RED         = 0x0004,  /* The signature is bad.  */
1604     GPGME_SIGSUM_KEY_REVOKED = 0x0010,  /* One key has been revoked.  */
1605     GPGME_SIGSUM_KEY_EXPIRED = 0x0020,  /* One key has expired.  */
1606     GPGME_SIGSUM_SIG_EXPIRED = 0x0040,  /* The signature has expired.  */
1607     GPGME_SIGSUM_KEY_MISSING = 0x0080,  /* Can't verify: key missing.  */
1608     GPGME_SIGSUM_CRL_MISSING = 0x0100,  /* CRL not available.  */
1609     GPGME_SIGSUM_CRL_TOO_OLD = 0x0200,  /* Available CRL is too old.  */
1610     GPGME_SIGSUM_BAD_POLICY  = 0x0400,  /* A policy was not met.  */
1611     GPGME_SIGSUM_SYS_ERROR   = 0x0800,  /* A system error occurred.  */
1612     GPGME_SIGSUM_TOFU_CONFLICT=0x1000   /* Tofu conflict detected.  */
1613   }
1614 gpgme_sigsum_t;
1615
1616
1617 struct _gpgme_signature
1618 {
1619   struct _gpgme_signature *next;
1620
1621   /* A summary of the signature status.  */
1622   gpgme_sigsum_t summary;
1623
1624   /* The fingerprint of the signature.  This can be a subkey.  */
1625   char *fpr;
1626
1627   /* The status of the signature.  */
1628   gpgme_error_t status;
1629
1630   /* Notation data and policy URLs.  */
1631   gpgme_sig_notation_t notations;
1632
1633   /* Signature creation time.  */
1634   unsigned long timestamp;
1635
1636   /* Signature expiration time or 0.  */
1637   unsigned long exp_timestamp;
1638
1639   /* Key should not have been used for signing.  */
1640   unsigned int wrong_key_usage : 1;
1641
1642   /* PKA status: 0 = not available, 1 = bad, 2 = okay, 3 = RFU. */
1643   unsigned int pka_trust : 2;
1644
1645   /* Validity has been verified using the chain model. */
1646   unsigned int chain_model : 1;
1647
1648   /* Internal to GPGME, do not use.  */
1649   int _unused : 28;
1650
1651   gpgme_validity_t validity;
1652   gpgme_error_t validity_reason;
1653
1654   /* The public key algorithm used to create the signature.  */
1655   gpgme_pubkey_algo_t pubkey_algo;
1656
1657   /* The hash algorithm used to create the signature.  */
1658   gpgme_hash_algo_t hash_algo;
1659
1660   /* The mailbox from the PKA information or NULL. */
1661   char *pka_address;
1662
1663   /* If non-NULL, a possible incomplete key object with the data
1664    * available for the signature.  */
1665   gpgme_key_t key;
1666 };
1667 typedef struct _gpgme_signature *gpgme_signature_t;
1668
1669 struct _gpgme_op_verify_result
1670 {
1671   gpgme_signature_t signatures;
1672
1673   /* The original file name of the plaintext message, if
1674      available.  */
1675   char *file_name;
1676 };
1677 typedef struct _gpgme_op_verify_result *gpgme_verify_result_t;
1678
1679 /* Retrieve a pointer to the result of the verify operation.  */
1680 gpgme_verify_result_t gpgme_op_verify_result (gpgme_ctx_t ctx);
1681
1682 /* Verify within CTX that SIG is a valid signature for TEXT.  */
1683 gpgme_error_t gpgme_op_verify_start (gpgme_ctx_t ctx, gpgme_data_t sig,
1684                                      gpgme_data_t signed_text,
1685                                      gpgme_data_t plaintext);
1686 gpgme_error_t gpgme_op_verify (gpgme_ctx_t ctx, gpgme_data_t sig,
1687                                gpgme_data_t signed_text,
1688                                gpgme_data_t plaintext);
1689
1690 \f
1691 /*
1692  * Import/Export
1693  */
1694
1695 #define GPGME_IMPORT_NEW        1  /* The key was new.  */
1696 #define GPGME_IMPORT_UID        2  /* The key contained new user IDs.  */
1697 #define GPGME_IMPORT_SIG        4  /* The key contained new signatures.  */
1698 #define GPGME_IMPORT_SUBKEY     8  /* The key contained new sub keys.  */
1699 #define GPGME_IMPORT_SECRET    16  /* The key contained a secret key.  */
1700
1701
1702 struct _gpgme_import_status
1703 {
1704   struct _gpgme_import_status *next;
1705
1706   /* Fingerprint.  */
1707   char *fpr;
1708
1709   /* If a problem occurred, the reason why the key could not be
1710      imported.  Otherwise GPGME_No_Error.  */
1711   gpgme_error_t result;
1712
1713   /* The result of the import, the GPGME_IMPORT_* values bit-wise
1714      ORed.  0 means the key was already known and no new components
1715      have been added.  */
1716   unsigned int status;
1717 };
1718 typedef struct _gpgme_import_status *gpgme_import_status_t;
1719
1720 /* Import result object.  */
1721 struct _gpgme_op_import_result
1722 {
1723   /* Number of considered keys.  */
1724   int considered;
1725
1726   /* Keys without user ID.  */
1727   int no_user_id;
1728
1729   /* Imported keys.  */
1730   int imported;
1731
1732   /* Imported RSA keys.  */
1733   int imported_rsa;
1734
1735   /* Unchanged keys.  */
1736   int unchanged;
1737
1738   /* Number of new user ids.  */
1739   int new_user_ids;
1740
1741   /* Number of new sub keys.  */
1742   int new_sub_keys;
1743
1744   /* Number of new signatures.  */
1745   int new_signatures;
1746
1747   /* Number of new revocations.  */
1748   int new_revocations;
1749
1750   /* Number of secret keys read.  */
1751   int secret_read;
1752
1753   /* Number of secret keys imported.  */
1754   int secret_imported;
1755
1756   /* Number of secret keys unchanged.  */
1757   int secret_unchanged;
1758
1759   /* Number of new keys skipped.  */
1760   int skipped_new_keys;
1761
1762   /* Number of keys not imported.  */
1763   int not_imported;
1764
1765   /* List of keys for which an import was attempted.  */
1766   gpgme_import_status_t imports;
1767 };
1768 typedef struct _gpgme_op_import_result *gpgme_import_result_t;
1769
1770 /* Retrieve a pointer to the result of the import operation.  */
1771 gpgme_import_result_t gpgme_op_import_result (gpgme_ctx_t ctx);
1772
1773 /* Import the key in KEYDATA into the keyring.  */
1774 gpgme_error_t gpgme_op_import_start (gpgme_ctx_t ctx, gpgme_data_t keydata);
1775 gpgme_error_t gpgme_op_import (gpgme_ctx_t ctx, gpgme_data_t keydata);
1776 gpgme_error_t gpgme_op_import_ext (gpgme_ctx_t ctx, gpgme_data_t keydata,
1777                                    int *nr) _GPGME_DEPRECATED;
1778
1779 /* Import the keys from the array KEYS into the keyring.  */
1780 gpgme_error_t gpgme_op_import_keys_start (gpgme_ctx_t ctx, gpgme_key_t keys[]);
1781 gpgme_error_t gpgme_op_import_keys (gpgme_ctx_t ctx, gpgme_key_t keys[]);
1782
1783
1784 /* Export the keys found by PATTERN into KEYDATA.  */
1785 gpgme_error_t gpgme_op_export_start (gpgme_ctx_t ctx, const char *pattern,
1786                                      gpgme_export_mode_t mode,
1787                                      gpgme_data_t keydata);
1788 gpgme_error_t gpgme_op_export (gpgme_ctx_t ctx, const char *pattern,
1789                                gpgme_export_mode_t mode,
1790                                gpgme_data_t keydata);
1791
1792 gpgme_error_t gpgme_op_export_ext_start (gpgme_ctx_t ctx,
1793                                          const char *pattern[],
1794                                          gpgme_export_mode_t mode,
1795                                          gpgme_data_t keydata);
1796 gpgme_error_t gpgme_op_export_ext (gpgme_ctx_t ctx, const char *pattern[],
1797                                    gpgme_export_mode_t mode,
1798                                    gpgme_data_t keydata);
1799
1800 /* Export the keys from the array KEYS into KEYDATA.  */
1801 gpgme_error_t gpgme_op_export_keys_start (gpgme_ctx_t ctx,
1802                                           gpgme_key_t keys[],
1803                                           gpgme_export_mode_t mode,
1804                                           gpgme_data_t keydata);
1805 gpgme_error_t gpgme_op_export_keys (gpgme_ctx_t ctx,
1806                                     gpgme_key_t keys[],
1807                                     gpgme_export_mode_t mode,
1808                                     gpgme_data_t keydata);
1809
1810
1811 \f
1812 /*
1813  * Key generation.
1814  */
1815
1816 struct _gpgme_op_genkey_result
1817 {
1818   /* A primary key was generated.  */
1819   unsigned int primary : 1;
1820
1821   /* A sub key was generated.  */
1822   unsigned int sub : 1;
1823
1824   /* Internal to GPGME, do not use.  */
1825   unsigned int _unused : 30;
1826
1827   /* The fingerprint of the generated key.  */
1828   char *fpr;
1829 };
1830 typedef struct _gpgme_op_genkey_result *gpgme_genkey_result_t;
1831
1832 /* Generate a new keypair and add it to the keyring.  PUBKEY and
1833    SECKEY should be null for now.  PARMS specifies what keys should be
1834    generated.  */
1835 gpgme_error_t gpgme_op_genkey_start (gpgme_ctx_t ctx, const char *parms,
1836                                      gpgme_data_t pubkey, gpgme_data_t seckey);
1837 gpgme_error_t gpgme_op_genkey (gpgme_ctx_t ctx, const char *parms,
1838                                gpgme_data_t pubkey, gpgme_data_t seckey);
1839
1840 /* Retrieve a pointer to the result of the genkey operation.  */
1841 gpgme_genkey_result_t gpgme_op_genkey_result (gpgme_ctx_t ctx);
1842
1843
1844 /* Delete KEY from the keyring.  If ALLOW_SECRET is non-zero, secret
1845    keys are also deleted.  */
1846 gpgme_error_t gpgme_op_delete_start (gpgme_ctx_t ctx, const gpgme_key_t key,
1847                                      int allow_secret);
1848 gpgme_error_t gpgme_op_delete (gpgme_ctx_t ctx, const gpgme_key_t key,
1849                                int allow_secret);
1850
1851
1852 \f
1853 /*
1854  * Key Edit interface
1855  */
1856
1857 /* Edit the key KEY.  Send status and command requests to FNC and
1858    output of edit commands to OUT.  */
1859 gpgme_error_t gpgme_op_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1860                                    gpgme_edit_cb_t fnc, void *fnc_value,
1861                                    gpgme_data_t out);
1862 gpgme_error_t gpgme_op_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1863                              gpgme_edit_cb_t fnc, void *fnc_value,
1864                              gpgme_data_t out);
1865
1866 /* Edit the card for the key KEY.  Send status and command requests to
1867    FNC and output of edit commands to OUT.  */
1868 gpgme_error_t gpgme_op_card_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1869                                         gpgme_edit_cb_t fnc, void *fnc_value,
1870                                         gpgme_data_t out);
1871 gpgme_error_t gpgme_op_card_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1872                                   gpgme_edit_cb_t fnc, void *fnc_value,
1873                                   gpgme_data_t out);
1874
1875
1876 \f
1877 /*
1878  * Key listing
1879  */
1880
1881 struct _gpgme_op_keylist_result
1882 {
1883   unsigned int truncated : 1;
1884
1885   /* Internal to GPGME, do not use.  */
1886   unsigned int _unused : 31;
1887 };
1888 typedef struct _gpgme_op_keylist_result *gpgme_keylist_result_t;
1889
1890 /* Retrieve a pointer to the result of the key listing operation.  */
1891 gpgme_keylist_result_t gpgme_op_keylist_result (gpgme_ctx_t ctx);
1892
1893 /* Start a keylist operation within CTX, searching for keys which
1894    match PATTERN.  If SECRET_ONLY is true, only secret keys are
1895    returned.  */
1896 gpgme_error_t gpgme_op_keylist_start (gpgme_ctx_t ctx, const char *pattern,
1897                                       int secret_only);
1898 gpgme_error_t gpgme_op_keylist_ext_start (gpgme_ctx_t ctx,
1899                                           const char *pattern[],
1900                                           int secret_only, int reserved);
1901
1902 /* Return the next key from the keylist in R_KEY.  */
1903 gpgme_error_t gpgme_op_keylist_next (gpgme_ctx_t ctx, gpgme_key_t *r_key);
1904
1905 /* Terminate a pending keylist operation within CTX.  */
1906 gpgme_error_t gpgme_op_keylist_end (gpgme_ctx_t ctx);
1907
1908 /* Change the passphrase for KEY.  FLAGS is reserved for future use
1909    and must be passed as 0.  */
1910 gpgme_error_t gpgme_op_passwd_start (gpgme_ctx_t ctx, gpgme_key_t key,
1911                                      unsigned int flags);
1912 gpgme_error_t gpgme_op_passwd (gpgme_ctx_t ctx, gpgme_key_t key,
1913                                unsigned int flags);
1914
1915
1916 \f
1917 /*
1918  * Trust items and operations.
1919  */
1920
1921 struct _gpgme_trust_item
1922 {
1923   /* Internal to GPGME, do not use.  */
1924   unsigned int _refs;
1925
1926   /* The key ID to which the trust item belongs.  */
1927   char *keyid;
1928
1929   /* Internal to GPGME, do not use.  */
1930   char _keyid[16 + 1];
1931
1932   /* The type of the trust item, 1 refers to a key, 2 to a user ID.  */
1933   int type;
1934
1935   /* The trust level.  */
1936   int level;
1937
1938   /* The owner trust if TYPE is 1.  */
1939   char *owner_trust;
1940
1941   /* Internal to GPGME, do not use.  */
1942   char _owner_trust[2];
1943
1944   /* The calculated validity.  */
1945   char *validity;
1946
1947   /* Internal to GPGME, do not use.  */
1948   char _validity[2];
1949
1950   /* The user name if TYPE is 2.  */
1951   char *name;
1952 };
1953 typedef struct _gpgme_trust_item *gpgme_trust_item_t;
1954
1955 /* Start a trustlist operation within CTX, searching for trust items
1956    which match PATTERN.  */
1957 gpgme_error_t gpgme_op_trustlist_start (gpgme_ctx_t ctx,
1958                                         const char *pattern, int max_level);
1959
1960 /* Return the next trust item from the trustlist in R_ITEM.  */
1961 gpgme_error_t gpgme_op_trustlist_next (gpgme_ctx_t ctx,
1962                                        gpgme_trust_item_t *r_item);
1963
1964 /* Terminate a pending trustlist operation within CTX.  */
1965 gpgme_error_t gpgme_op_trustlist_end (gpgme_ctx_t ctx);
1966
1967 /* Acquire a reference to ITEM.  */
1968 void gpgme_trust_item_ref (gpgme_trust_item_t item);
1969
1970 /* Release a reference to ITEM.  If this was the last one the trust
1971    item is destroyed.  */
1972 void gpgme_trust_item_unref (gpgme_trust_item_t item);
1973
1974 /* Release the trust item ITEM.  Deprecated, use
1975    gpgme_trust_item_unref.  */
1976 void gpgme_trust_item_release (gpgme_trust_item_t item) _GPGME_DEPRECATED;
1977
1978 /* Return the value of the attribute WHAT of ITEM, which has to be
1979    representable by a string.  Deprecated, use trust item structure
1980    directly.  */
1981 const char *gpgme_trust_item_get_string_attr (gpgme_trust_item_t item,
1982                                               _gpgme_attr_t what,
1983                                               const void *reserved, int idx)
1984      _GPGME_DEPRECATED;
1985
1986 /* Return the value of the attribute WHAT of KEY, which has to be
1987    representable by an integer.  IDX specifies a running index if the
1988    attribute appears more than once in the key.  Deprecated, use trust
1989    item structure directly.  */
1990 int gpgme_trust_item_get_int_attr (gpgme_trust_item_t item, _gpgme_attr_t what,
1991                                    const void *reserved, int idx)
1992      _GPGME_DEPRECATED;
1993
1994
1995 \f
1996 /*
1997  * Audit log
1998  */
1999
2000 /* Return the auditlog for the current session.  This may be called
2001    after a successful or failed operation.  If no audit log is
2002    available GPG_ERR_NO_DATA is returned.  */
2003 gpgme_error_t gpgme_op_getauditlog_start (gpgme_ctx_t ctx, gpgme_data_t output,
2004                                           unsigned int flags);
2005 gpgme_error_t gpgme_op_getauditlog (gpgme_ctx_t ctx, gpgme_data_t output,
2006                                     unsigned int flags);
2007
2008
2009 \f
2010 /*
2011  * Spawn interface
2012  */
2013
2014 /* Flags for the spawn operations.  */
2015 #define GPGME_SPAWN_DETACHED      1
2016 #define GPGME_SPAWN_ALLOW_SET_FG  2
2017
2018
2019 /* Run the command FILE with the arguments in ARGV.  Connect stdin to
2020    DATAIN, stdout to DATAOUT, and STDERR to DATAERR.  If one the data
2021    streams is NULL, connect to /dev/null instead.  */
2022 gpgme_error_t gpgme_op_spawn_start (gpgme_ctx_t ctx,
2023                                     const char *file, const char *argv[],
2024                                     gpgme_data_t datain,
2025                                     gpgme_data_t dataout, gpgme_data_t dataerr,
2026                                     unsigned int flags);
2027 gpgme_error_t gpgme_op_spawn (gpgme_ctx_t ctx,
2028                               const char *file, const char *argv[],
2029                               gpgme_data_t datain,
2030                               gpgme_data_t dataout, gpgme_data_t dataerr,
2031                               unsigned int flags);
2032
2033 \f
2034 /*
2035  * Low-level Assuan protocol access.
2036  */
2037 typedef gpgme_error_t (*gpgme_assuan_data_cb_t)
2038      (void *opaque, const void *data, size_t datalen);
2039
2040 typedef gpgme_error_t (*gpgme_assuan_inquire_cb_t)
2041      (void *opaque, const char *name, const char *args,
2042       gpgme_data_t *r_data);
2043
2044 typedef gpgme_error_t (*gpgme_assuan_status_cb_t)
2045      (void *opaque, const char *status, const char *args);
2046
2047 /* Send the Assuan COMMAND and return results via the callbacks.
2048    Asynchronous variant. */
2049 gpgme_error_t gpgme_op_assuan_transact_start (gpgme_ctx_t ctx,
2050                                               const char *command,
2051                                               gpgme_assuan_data_cb_t data_cb,
2052                                               void *data_cb_value,
2053                                               gpgme_assuan_inquire_cb_t inq_cb,
2054                                               void *inq_cb_value,
2055                                               gpgme_assuan_status_cb_t stat_cb,
2056                                               void *stat_cb_value);
2057
2058 /* Send the Assuan COMMAND and return results via the callbacks.
2059    Synchronous variant. */
2060 gpgme_error_t gpgme_op_assuan_transact_ext (gpgme_ctx_t ctx,
2061                                             const char *command,
2062                                             gpgme_assuan_data_cb_t data_cb,
2063                                             void *data_cb_value,
2064                                             gpgme_assuan_inquire_cb_t inq_cb,
2065                                             void *inq_cb_value,
2066                                             gpgme_assuan_status_cb_t stat_cb,
2067                                             void *stat_cb_value,
2068                                             gpgme_error_t *op_err);
2069
2070 /* Compat.  */
2071 struct _gpgme_op_assuan_result
2072 {
2073   /* Deprecated.  Use the second value in a DONE event or the
2074      synchronous variant gpgme_op_assuan_transact_ext.  */
2075   gpgme_error_t err _GPGME_DEPRECATED_OUTSIDE_GPGME;
2076 };
2077 typedef struct _gpgme_op_assuan_result *gpgme_assuan_result_t;
2078
2079
2080 /* Return the result of the last Assuan command. */
2081 gpgme_assuan_result_t gpgme_op_assuan_result (gpgme_ctx_t ctx)
2082   _GPGME_DEPRECATED;
2083
2084 gpgme_error_t
2085 gpgme_op_assuan_transact (gpgme_ctx_t ctx,
2086                               const char *command,
2087                               gpgme_assuan_data_cb_t data_cb,
2088                               void *data_cb_value,
2089                               gpgme_assuan_inquire_cb_t inq_cb,
2090                               void *inq_cb_value,
2091                               gpgme_assuan_status_cb_t status_cb,
2092                               void *status_cb_value) _GPGME_DEPRECATED;
2093
2094 \f
2095 /*
2096  * Crypto container support.
2097  */
2098
2099 struct _gpgme_op_vfs_mount_result
2100 {
2101   char *mount_dir;
2102 };
2103 typedef struct _gpgme_op_vfs_mount_result *gpgme_vfs_mount_result_t;
2104
2105 gpgme_vfs_mount_result_t gpgme_op_vfs_mount_result (gpgme_ctx_t ctx);
2106
2107 /* The container is automatically unmounted when the context is reset
2108    or destroyed.  Transmission errors are returned directly,
2109    operational errors are returned in OP_ERR.  */
2110 gpgme_error_t gpgme_op_vfs_mount (gpgme_ctx_t ctx, const char *container_file,
2111                                   const char *mount_dir, unsigned int flags,
2112                                   gpgme_error_t *op_err);
2113
2114 gpgme_error_t gpgme_op_vfs_create (gpgme_ctx_t ctx, gpgme_key_t recp[],
2115                                    const char *container_file,
2116                                    unsigned int flags, gpgme_error_t *op_err);
2117
2118 \f
2119 /*
2120  * Interface to gpgconf(1).
2121  */
2122
2123 /* The expert level at which a configuration option or group of
2124    options should be displayed.  See the gpgconf(1) documentation for
2125    more details.  */
2126 typedef enum
2127   {
2128     GPGME_CONF_BASIC = 0,
2129     GPGME_CONF_ADVANCED = 1,
2130     GPGME_CONF_EXPERT = 2,
2131     GPGME_CONF_INVISIBLE = 3,
2132     GPGME_CONF_INTERNAL = 4
2133   }
2134 gpgme_conf_level_t;
2135
2136
2137 /* The data type of a configuration option argument.  See the gpgconf(1)
2138    documentation for more details.  */
2139 typedef enum
2140   {
2141     /* Basic types.  */
2142     GPGME_CONF_NONE = 0,
2143     GPGME_CONF_STRING = 1,
2144     GPGME_CONF_INT32 = 2,
2145     GPGME_CONF_UINT32 = 3,
2146
2147     /* Complex types.  */
2148     GPGME_CONF_FILENAME = 32,
2149     GPGME_CONF_LDAP_SERVER = 33,
2150     GPGME_CONF_KEY_FPR = 34,
2151     GPGME_CONF_PUB_KEY = 35,
2152     GPGME_CONF_SEC_KEY = 36,
2153     GPGME_CONF_ALIAS_LIST = 37
2154   }
2155 gpgme_conf_type_t;
2156
2157 /* For now, compatibility.  */
2158 #define GPGME_CONF_PATHNAME GPGME_CONF_FILENAME
2159
2160
2161 /* This represents a single argument for a configuration option.
2162    Which of the members of value is used depends on the ALT_TYPE.  */
2163 typedef struct gpgme_conf_arg
2164 {
2165   struct gpgme_conf_arg *next;
2166   /* True if the option appears without an (optional) argument.  */
2167   unsigned int no_arg;
2168   union
2169   {
2170     unsigned int count;
2171     unsigned int uint32;
2172     int int32;
2173     char *string;
2174   } value;
2175 } *gpgme_conf_arg_t;
2176
2177
2178 /* The flags of a configuration option.  See the gpg-conf
2179    documentation for details.  */
2180 #define GPGME_CONF_GROUP        (1 << 0)
2181 #define GPGME_CONF_OPTIONAL     (1 << 1)
2182 #define GPGME_CONF_LIST         (1 << 2)
2183 #define GPGME_CONF_RUNTIME      (1 << 3)
2184 #define GPGME_CONF_DEFAULT      (1 << 4)
2185 #define GPGME_CONF_DEFAULT_DESC (1 << 5)
2186 #define GPGME_CONF_NO_ARG_DESC  (1 << 6)
2187 #define GPGME_CONF_NO_CHANGE    (1 << 7)
2188
2189
2190 /* The representation of a single configuration option.  See the
2191    gpg-conf documentation for details.  */
2192 typedef struct gpgme_conf_opt
2193 {
2194   struct gpgme_conf_opt *next;
2195
2196   /* The option name.  */
2197   char *name;
2198
2199   /* The flags for this option.  */
2200   unsigned int flags;
2201
2202   /* The level of this option.  */
2203   gpgme_conf_level_t level;
2204
2205   /* The localized description of this option.  */
2206   char *description;
2207
2208   /* The type and alternate type of this option.  */
2209   gpgme_conf_type_t type;
2210   gpgme_conf_type_t alt_type;
2211
2212   /* The localized (short) name of the argument, if any.  */
2213   char *argname;
2214
2215   /* The default value.  */
2216   gpgme_conf_arg_t default_value;
2217   char *default_description;
2218
2219   /* The default value if the option is not set.  */
2220   gpgme_conf_arg_t no_arg_value;
2221   char *no_arg_description;
2222
2223   /* The current value if the option is set.  */
2224   gpgme_conf_arg_t value;
2225
2226   /* The new value, if any.  NULL means reset to default.  */
2227   int change_value;
2228   gpgme_conf_arg_t new_value;
2229
2230   /* Free for application use.  */
2231   void *user_data;
2232 } *gpgme_conf_opt_t;
2233
2234
2235 /* The representation of a component that can be configured.  See the
2236    gpg-conf documentation for details.  */
2237 typedef struct gpgme_conf_comp
2238 {
2239   struct gpgme_conf_comp *next;
2240
2241   /* Internal to GPGME, do not use!  */
2242   gpgme_conf_opt_t *_last_opt_p;
2243
2244   /* The component name.  */
2245   char *name;
2246
2247   /* A human-readable description for the component.  */
2248   char *description;
2249
2250   /* The program name (an absolute path to the program).  */
2251   char *program_name;
2252
2253   /* A linked list of options for this component.  */
2254   struct gpgme_conf_opt *options;
2255 } *gpgme_conf_comp_t;
2256
2257
2258 /* Allocate a new gpgme_conf_arg_t.  If VALUE is NULL, a "no arg
2259    default" is prepared.  If type is a string type, VALUE should point
2260    to the string.  Else, it should point to an unsigned or signed
2261    integer respectively.  */
2262 gpgme_error_t gpgme_conf_arg_new (gpgme_conf_arg_t *arg_p,
2263                                   gpgme_conf_type_t type, const void *value);
2264
2265 /* This also releases all chained argument structures!  */
2266 void gpgme_conf_arg_release (gpgme_conf_arg_t arg, gpgme_conf_type_t type);
2267
2268 /* Register a change for the value of OPT to ARG.  If RESET is 1 (do
2269    not use any values but 0 or 1), ARG is ignored and the option is
2270    not changed (reverting a previous change).  Otherwise, if ARG is
2271    NULL, the option is cleared or reset to its default.  */
2272 gpgme_error_t gpgme_conf_opt_change (gpgme_conf_opt_t opt, int reset,
2273                                      gpgme_conf_arg_t arg);
2274
2275 /* Release a set of configurations.  */
2276 void gpgme_conf_release (gpgme_conf_comp_t conf);
2277
2278 /* Retrieve the current configurations.  */
2279 gpgme_error_t gpgme_op_conf_load (gpgme_ctx_t ctx, gpgme_conf_comp_t *conf_p);
2280
2281 /* Save the configuration of component comp.  This function does not
2282    follow chained components!  */
2283 gpgme_error_t gpgme_op_conf_save (gpgme_ctx_t ctx, gpgme_conf_comp_t comp);
2284
2285
2286 \f
2287 /*
2288  * Various functions.
2289  */
2290
2291 /* Set special global flags; consult the manual before use.  */
2292 int gpgme_set_global_flag (const char *name, const char *value);
2293
2294 /* Check that the library fulfills the version requirement.  Note:
2295    This is here only for the case where a user takes a pointer from
2296    the old version of this function.  The new version and macro for
2297    run-time checks are below.  */
2298 const char *gpgme_check_version (const char *req_version);
2299
2300 /* Check that the library fulfills the version requirement and check
2301    for struct layout mismatch involving bitfields.  */
2302 const char *gpgme_check_version_internal (const char *req_version,
2303                                           size_t offset_sig_validity);
2304
2305 #define gpgme_check_version(req_version)                                \
2306   gpgme_check_version_internal (req_version,                            \
2307                                 offsetof (struct _gpgme_signature, validity))
2308
2309 /* Return the default values for various directories.  */
2310 const char *gpgme_get_dirinfo (const char *what);
2311
2312 /* Get the information about the configured and installed engines.  A
2313    pointer to the first engine in the statically allocated linked list
2314    is returned in *INFO.  If an error occurs, it is returned.  The
2315    returned data is valid until the next gpgme_set_engine_info.  */
2316 gpgme_error_t gpgme_get_engine_info (gpgme_engine_info_t *engine_info);
2317
2318 /* Set the default engine info for the protocol PROTO to the file name
2319    FILE_NAME and the home directory HOME_DIR.  */
2320 gpgme_error_t gpgme_set_engine_info (gpgme_protocol_t proto,
2321                                      const char *file_name,
2322                                      const char *home_dir);
2323
2324 /* Verify that the engine implementing PROTO is installed and
2325    available.  */
2326 gpgme_error_t gpgme_engine_check_version (gpgme_protocol_t proto);
2327
2328
2329 /* Reference counting for result objects.  */
2330 void gpgme_result_ref (void *result);
2331 void gpgme_result_unref (void *result);
2332
2333 /* Return a public key algorithm string (e.g. "rsa2048").  Caller must
2334    free using gpgme_free.  */
2335 char *gpgme_pubkey_algo_string (gpgme_subkey_t subkey);
2336
2337 /* Return a statically allocated string with the name of the public
2338    key algorithm ALGO, or NULL if that name is not known.  */
2339 const char *gpgme_pubkey_algo_name (gpgme_pubkey_algo_t algo);
2340
2341 /* Return a statically allocated string with the name of the hash
2342    algorithm ALGO, or NULL if that name is not known.  */
2343 const char *gpgme_hash_algo_name (gpgme_hash_algo_t algo);
2344
2345
2346 \f
2347 /*
2348  * Deprecated types.
2349  */
2350 typedef gpgme_ctx_t GpgmeCtx _GPGME_DEPRECATED;
2351 typedef gpgme_data_t GpgmeData _GPGME_DEPRECATED;
2352 typedef gpgme_error_t GpgmeError _GPGME_DEPRECATED;
2353 typedef gpgme_data_encoding_t GpgmeDataEncoding _GPGME_DEPRECATED;
2354 typedef gpgme_pubkey_algo_t GpgmePubKeyAlgo _GPGME_DEPRECATED;
2355 typedef gpgme_hash_algo_t GpgmeHashAlgo _GPGME_DEPRECATED;
2356 typedef gpgme_sig_stat_t GpgmeSigStat _GPGME_DEPRECATED;
2357 typedef gpgme_sig_mode_t GpgmeSigMode _GPGME_DEPRECATED;
2358 typedef gpgme_attr_t GpgmeAttr _GPGME_DEPRECATED;
2359 typedef gpgme_validity_t GpgmeValidity _GPGME_DEPRECATED;
2360 typedef gpgme_protocol_t GpgmeProtocol _GPGME_DEPRECATED;
2361 typedef gpgme_engine_info_t GpgmeEngineInfo _GPGME_DEPRECATED;
2362 typedef gpgme_subkey_t GpgmeSubkey _GPGME_DEPRECATED;
2363 typedef gpgme_key_sig_t GpgmeKeySig _GPGME_DEPRECATED;
2364 typedef gpgme_user_id_t GpgmeUserID _GPGME_DEPRECATED;
2365 typedef gpgme_key_t GpgmeKey _GPGME_DEPRECATED;
2366 typedef gpgme_passphrase_cb_t GpgmePassphraseCb _GPGME_DEPRECATED;
2367 typedef gpgme_progress_cb_t GpgmeProgressCb _GPGME_DEPRECATED;
2368 typedef gpgme_io_cb_t GpgmeIOCb _GPGME_DEPRECATED;
2369 typedef gpgme_register_io_cb_t GpgmeRegisterIOCb _GPGME_DEPRECATED;
2370 typedef gpgme_remove_io_cb_t GpgmeRemoveIOCb _GPGME_DEPRECATED;
2371 typedef gpgme_event_io_t GpgmeEventIO _GPGME_DEPRECATED;
2372 typedef gpgme_event_io_cb_t GpgmeEventIOCb _GPGME_DEPRECATED;
2373 #define GpgmeIOCbs gpgme_io_cbs
2374 typedef gpgme_data_read_cb_t GpgmeDataReadCb _GPGME_DEPRECATED;
2375 typedef gpgme_data_write_cb_t GpgmeDataWriteCb _GPGME_DEPRECATED;
2376 typedef gpgme_data_seek_cb_t GpgmeDataSeekCb _GPGME_DEPRECATED;
2377 typedef gpgme_data_release_cb_t GpgmeDataReleaseCb _GPGME_DEPRECATED;
2378 #define GpgmeDataCbs gpgme_data_cbs
2379 typedef gpgme_encrypt_result_t GpgmeEncryptResult _GPGME_DEPRECATED;
2380 typedef gpgme_sig_notation_t GpgmeSigNotation _GPGME_DEPRECATED;
2381 typedef gpgme_signature_t GpgmeSignature _GPGME_DEPRECATED;
2382 typedef gpgme_verify_result_t GpgmeVerifyResult _GPGME_DEPRECATED;
2383 typedef gpgme_import_status_t GpgmeImportStatus _GPGME_DEPRECATED;
2384 typedef gpgme_import_result_t GpgmeImportResult _GPGME_DEPRECATED;
2385 typedef gpgme_genkey_result_t GpgmeGenKeyResult _GPGME_DEPRECATED;
2386 typedef gpgme_trust_item_t GpgmeTrustItem _GPGME_DEPRECATED;
2387 typedef gpgme_status_code_t GpgmeStatusCode _GPGME_DEPRECATED;
2388
2389 #ifdef __cplusplus
2390 }
2391 #endif
2392 #endif /* GPGME_H */
2393 /*
2394 @emacs_local_vars_begin@
2395 @emacs_local_vars_read_only@
2396 @emacs_local_vars_end@
2397 */