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