core: Extend gpgme_user_id_t with 'address'.
[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   /* The mail address (addr-spec from RFC5322) of the UID string.
806    * This is general the same as the EMAIL part of this struct but
807    * might be slightly different.  IF no mail address is available
808    * NULL is stored.  */
809   char *address;
810 };
811 typedef struct _gpgme_user_id *gpgme_user_id_t;
812
813
814 /* A key from the keyring.  */
815 struct _gpgme_key
816 {
817   /* Internal to GPGME, do not use.  */
818   unsigned int _refs;
819
820   /* True if key is revoked.  */
821   unsigned int revoked : 1;
822
823   /* True if key is expired.  */
824   unsigned int expired : 1;
825
826   /* True if key is disabled.  */
827   unsigned int disabled : 1;
828
829   /* True if key is invalid.  */
830   unsigned int invalid : 1;
831
832   /* True if key can be used for encryption.  */
833   unsigned int can_encrypt : 1;
834
835   /* True if key can be used for signing.  */
836   unsigned int can_sign : 1;
837
838   /* True if key can be used for certification.  */
839   unsigned int can_certify : 1;
840
841   /* True if key is secret.  */
842   unsigned int secret : 1;
843
844   /* True if key can be used for authentication.  */
845   unsigned int can_authenticate : 1;
846
847   /* True if subkey is qualified for signatures according to German law.  */
848   unsigned int is_qualified : 1;
849
850   /* Internal to GPGME, do not use.  */
851   unsigned int _unused : 22;
852
853   /* This is the protocol supported by this key.  */
854   gpgme_protocol_t protocol;
855
856   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
857      issuer serial.  */
858   char *issuer_serial;
859
860   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
861      issuer name.  */
862   char *issuer_name;
863
864   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the chain
865      ID.  */
866   char *chain_id;
867
868   /* If protocol is GPGME_PROTOCOL_OpenPGP, this field contains the
869      owner trust.  */
870   gpgme_validity_t owner_trust;
871
872   /* The subkeys of the key.  */
873   gpgme_subkey_t subkeys;
874
875   /* The user IDs of the key.  */
876   gpgme_user_id_t uids;
877
878   /* Internal to GPGME, do not use.  */
879   gpgme_subkey_t _last_subkey;
880
881   /* Internal to GPGME, do not use.  */
882   gpgme_user_id_t _last_uid;
883
884   /* The keylist mode that was active when listing the key.  */
885   gpgme_keylist_mode_t keylist_mode;
886 };
887 typedef struct _gpgme_key *gpgme_key_t;
888
889
890 /* An invalid key object.  */
891 struct _gpgme_invalid_key
892 {
893   struct _gpgme_invalid_key *next;
894
895   /* The string used to request the key.  Despite the name this may
896    * not be a fingerprint.  */
897   char *fpr;
898
899   /* The error code.  */
900   gpgme_error_t reason;
901 };
902 typedef struct _gpgme_invalid_key *gpgme_invalid_key_t;
903
904
905 \f
906 /*
907  * Types for callback functions.
908  */
909
910 /* Request a passphrase from the user.  */
911 typedef gpgme_error_t (*gpgme_passphrase_cb_t) (void *hook,
912                                                 const char *uid_hint,
913                                                 const char *passphrase_info,
914                                                 int prev_was_bad, int fd);
915
916 /* Inform the user about progress made.  */
917 typedef void (*gpgme_progress_cb_t) (void *opaque, const char *what,
918                                      int type, int current, int total);
919
920 /* Status messages from gpg. */
921 typedef gpgme_error_t (*gpgme_status_cb_t) (void *opaque, const char *keyword,
922                                             const char *args);
923
924
925 /* Interact with the user about an edit operation.  */
926 typedef gpgme_error_t (*gpgme_edit_cb_t) (void *opaque,
927                                           gpgme_status_code_t status,
928                                           const char *args, int fd);
929
930
931
932 \f
933 /*
934  * Context management functions.
935  */
936
937 /* Create a new context and return it in CTX.  */
938 gpgme_error_t gpgme_new (gpgme_ctx_t *ctx);
939
940 /* Release the context CTX.  */
941 void gpgme_release (gpgme_ctx_t ctx);
942
943 /* Set the flag NAME for CTX to VALUE.  */
944 gpgme_error_t gpgme_set_ctx_flag (gpgme_ctx_t ctx,
945                                   const char *name, const char *value);
946
947 /* Set the protocol to be used by CTX to PROTO.  */
948 gpgme_error_t gpgme_set_protocol (gpgme_ctx_t ctx, gpgme_protocol_t proto);
949
950 /* Get the protocol used with CTX */
951 gpgme_protocol_t gpgme_get_protocol (gpgme_ctx_t ctx);
952
953 /* Set the crypto protocol to be used by CTX to PROTO.
954    gpgme_set_protocol actually sets the backend engine.  This sets the
955    crypto protocol used in engines that support more than one crypto
956    prococol (for example, an UISERVER can support OpenPGP and CMS).
957    This is reset to the default with gpgme_set_protocol.  */
958 gpgme_error_t gpgme_set_sub_protocol (gpgme_ctx_t ctx,
959                                       gpgme_protocol_t proto);
960
961 /* Get the sub protocol.  */
962 gpgme_protocol_t gpgme_get_sub_protocol (gpgme_ctx_t ctx);
963
964 /* Get the string describing protocol PROTO, or NULL if invalid.  */
965 const char *gpgme_get_protocol_name (gpgme_protocol_t proto);
966
967 /* If YES is non-zero, enable armor mode in CTX, disable it otherwise.  */
968 void gpgme_set_armor (gpgme_ctx_t ctx, int yes);
969
970 /* Return non-zero if armor mode is set in CTX.  */
971 int gpgme_get_armor (gpgme_ctx_t ctx);
972
973 /* If YES is non-zero, enable text mode in CTX, disable it otherwise.  */
974 void gpgme_set_textmode (gpgme_ctx_t ctx, int yes);
975
976 /* Return non-zero if text mode is set in CTX.  */
977 int gpgme_get_textmode (gpgme_ctx_t ctx);
978
979 /* If YES is non-zero, enable offline mode in CTX, disable it otherwise.  */
980 void gpgme_set_offline (gpgme_ctx_t ctx, int yes);
981
982 /* Return non-zero if offline mode is set in CTX.  */
983 int gpgme_get_offline (gpgme_ctx_t ctx);
984
985 /* Use whatever the default of the backend crypto engine is.  */
986 #define GPGME_INCLUDE_CERTS_DEFAULT     -256
987
988 /* Include up to NR_OF_CERTS certificates in an S/MIME message.  */
989 void gpgme_set_include_certs (gpgme_ctx_t ctx, int nr_of_certs);
990
991 /* Return the number of certs to include in an S/MIME message.  */
992 int gpgme_get_include_certs (gpgme_ctx_t ctx);
993
994 /* Set keylist mode in CTX to MODE.  */
995 gpgme_error_t gpgme_set_keylist_mode (gpgme_ctx_t ctx,
996                                       gpgme_keylist_mode_t mode);
997
998 /* Get keylist mode in CTX.  */
999 gpgme_keylist_mode_t gpgme_get_keylist_mode (gpgme_ctx_t ctx);
1000
1001 /* Set the pinentry mode for CTX to MODE. */
1002 gpgme_error_t gpgme_set_pinentry_mode (gpgme_ctx_t ctx,
1003                                        gpgme_pinentry_mode_t mode);
1004
1005 /* Get the pinentry mode of CTX.  */
1006 gpgme_pinentry_mode_t gpgme_get_pinentry_mode (gpgme_ctx_t ctx);
1007
1008 /* Set the passphrase callback function in CTX to CB.  HOOK_VALUE is
1009    passed as first argument to the passphrase callback function.  */
1010 void gpgme_set_passphrase_cb (gpgme_ctx_t ctx,
1011                               gpgme_passphrase_cb_t cb, void *hook_value);
1012
1013 /* Get the current passphrase callback function in *CB and the current
1014    hook value in *HOOK_VALUE.  */
1015 void gpgme_get_passphrase_cb (gpgme_ctx_t ctx, gpgme_passphrase_cb_t *cb,
1016                               void **hook_value);
1017
1018 /* Set the progress callback function in CTX to CB.  HOOK_VALUE is
1019    passed as first argument to the progress callback function.  */
1020 void gpgme_set_progress_cb (gpgme_ctx_t c, gpgme_progress_cb_t cb,
1021                             void *hook_value);
1022
1023 /* Get the current progress callback function in *CB and the current
1024    hook value in *HOOK_VALUE.  */
1025 void gpgme_get_progress_cb (gpgme_ctx_t ctx, gpgme_progress_cb_t *cb,
1026                             void **hook_value);
1027
1028 /* Set the status callback function in CTX to CB.  HOOK_VALUE is
1029    passed as first argument to the status callback function.  */
1030 void gpgme_set_status_cb (gpgme_ctx_t c, gpgme_status_cb_t cb,
1031                           void *hook_value);
1032
1033 /* Get the current status callback function in *CB and the current
1034    hook value in *HOOK_VALUE.  */
1035 void gpgme_get_status_cb (gpgme_ctx_t ctx, gpgme_status_cb_t *cb,
1036                           void **hook_value);
1037
1038 /* This function sets the locale for the context CTX, or the default
1039    locale if CTX is a null pointer.  */
1040 gpgme_error_t gpgme_set_locale (gpgme_ctx_t ctx, int category,
1041                                 const char *value);
1042
1043 /* Get the information about the configured engines.  A pointer to the
1044    first engine in the statically allocated linked list is returned.
1045    The returned data is valid until the next gpgme_ctx_set_engine_info.  */
1046 gpgme_engine_info_t gpgme_ctx_get_engine_info (gpgme_ctx_t ctx);
1047
1048 /* Set the engine info for the context CTX, protocol PROTO, to the
1049    file name FILE_NAME and the home directory HOME_DIR.  */
1050 gpgme_error_t gpgme_ctx_set_engine_info (gpgme_ctx_t ctx,
1051                                          gpgme_protocol_t proto,
1052                                          const char *file_name,
1053                                          const char *home_dir);
1054
1055 /* Delete all signers from CTX.  */
1056 void gpgme_signers_clear (gpgme_ctx_t ctx);
1057
1058 /* Add KEY to list of signers in CTX.  */
1059 gpgme_error_t gpgme_signers_add (gpgme_ctx_t ctx, const gpgme_key_t key);
1060
1061 /* Return the number of signers in CTX.  */
1062 unsigned int gpgme_signers_count (const gpgme_ctx_t ctx);
1063
1064 /* Return the SEQth signer's key in CTX.  */
1065 gpgme_key_t gpgme_signers_enum (const gpgme_ctx_t ctx, int seq);
1066
1067 /* Retrieve the signature status of signature IDX in CTX after a
1068    successful verify operation in R_STAT (if non-null).  The creation
1069    time stamp of the signature is returned in R_CREATED (if non-null).
1070    The function returns a string containing the fingerprint.
1071    Deprecated, use verify result directly.  */
1072 const char *gpgme_get_sig_status (gpgme_ctx_t ctx, int idx,
1073                                   _gpgme_sig_stat_t *r_stat,
1074                                   time_t *r_created) _GPGME_DEPRECATED;
1075
1076 /* Retrieve certain attributes of a signature.  IDX is the index
1077    number of the signature after a successful verify operation.  WHAT
1078    is an attribute where GPGME_ATTR_EXPIRE is probably the most useful
1079    one.  WHATIDX is to be passed as 0 for most attributes . */
1080 unsigned long gpgme_get_sig_ulong_attr (gpgme_ctx_t c, int idx,
1081                                         _gpgme_attr_t what, int whatidx)
1082      _GPGME_DEPRECATED;
1083 const char *gpgme_get_sig_string_attr (gpgme_ctx_t c, int idx,
1084                                        _gpgme_attr_t what, int whatidx)
1085      _GPGME_DEPRECATED;
1086
1087
1088 /* Get the key used to create signature IDX in CTX and return it in
1089    R_KEY.  */
1090 gpgme_error_t gpgme_get_sig_key (gpgme_ctx_t ctx, int idx, gpgme_key_t *r_key)
1091      _GPGME_DEPRECATED;
1092
1093
1094 /* Clear all notation data from the context.  */
1095 void gpgme_sig_notation_clear (gpgme_ctx_t ctx);
1096
1097 /* Add the human-readable notation data with name NAME and value VALUE
1098    to the context CTX, using the flags FLAGS.  If NAME is NULL, then
1099    VALUE should be a policy URL.  The flag
1100    GPGME_SIG_NOTATION_HUMAN_READABLE is forced to be true for notation
1101    data, and false for policy URLs.  */
1102 gpgme_error_t gpgme_sig_notation_add (gpgme_ctx_t ctx, const char *name,
1103                                       const char *value,
1104                                       gpgme_sig_notation_flags_t flags);
1105
1106 /* Get the sig notations for this context.  */
1107 gpgme_sig_notation_t gpgme_sig_notation_get (gpgme_ctx_t ctx);
1108
1109
1110 \f
1111 /*
1112  * Run control.
1113  */
1114
1115 /* The type of an I/O callback function.  */
1116 typedef gpgme_error_t (*gpgme_io_cb_t) (void *data, int fd);
1117
1118 /* The type of a function that can register FNC as the I/O callback
1119    function for the file descriptor FD with direction dir (0: for writing,
1120    1: for reading).  FNC_DATA should be passed as DATA to FNC.  The
1121    function should return a TAG suitable for the corresponding
1122    gpgme_remove_io_cb_t, and an error value.  */
1123 typedef gpgme_error_t (*gpgme_register_io_cb_t) (void *data, int fd, int dir,
1124                                                  gpgme_io_cb_t fnc,
1125                                                  void *fnc_data, void **tag);
1126
1127 /* The type of a function that can remove a previously registered I/O
1128    callback function given TAG as returned by the register
1129    function.  */
1130 typedef void (*gpgme_remove_io_cb_t) (void *tag);
1131
1132 typedef enum
1133   {
1134     GPGME_EVENT_START,
1135     GPGME_EVENT_DONE,
1136     GPGME_EVENT_NEXT_KEY,
1137     GPGME_EVENT_NEXT_TRUSTITEM
1138   }
1139 gpgme_event_io_t;
1140
1141 struct gpgme_io_event_done_data
1142 {
1143   /* A fatal IPC error or an operational error in state-less
1144      protocols.  */
1145   gpgme_error_t err;
1146
1147   /* An operational errors in session-based protocols.  */
1148   gpgme_error_t op_err;
1149 };
1150 typedef struct gpgme_io_event_done_data *gpgme_io_event_done_data_t;
1151
1152 /* The type of a function that is called when a context finished an
1153    operation.  */
1154 typedef void (*gpgme_event_io_cb_t) (void *data, gpgme_event_io_t type,
1155                                      void *type_data);
1156
1157 struct gpgme_io_cbs
1158 {
1159   gpgme_register_io_cb_t add;
1160   void *add_priv;
1161   gpgme_remove_io_cb_t remove;
1162   gpgme_event_io_cb_t event;
1163   void *event_priv;
1164 };
1165 typedef struct gpgme_io_cbs *gpgme_io_cbs_t;
1166
1167 /* Set the I/O callback functions in CTX to IO_CBS.  */
1168 void gpgme_set_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
1169
1170 /* Get the current I/O callback functions.  */
1171 void gpgme_get_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
1172
1173 /* Wrappers around the internal I/O functions for use with
1174    gpgme_passphrase_cb_t and gpgme_edit_cb_t.  */
1175 @API__SSIZE_T@ gpgme_io_read (int fd, void *buffer, size_t count);
1176 @API__SSIZE_T@ gpgme_io_write (int fd, const void *buffer, size_t count);
1177 int     gpgme_io_writen (int fd, const void *buffer, size_t count);
1178
1179 /* Process the pending operation and, if HANG is non-zero, wait for
1180    the pending operation to finish.  */
1181 gpgme_ctx_t gpgme_wait (gpgme_ctx_t ctx, gpgme_error_t *status, int hang);
1182
1183 gpgme_ctx_t gpgme_wait_ext (gpgme_ctx_t ctx, gpgme_error_t *status,
1184                             gpgme_error_t *op_err, int hang);
1185
1186 /* Cancel a pending asynchronous operation.  */
1187 gpgme_error_t gpgme_cancel (gpgme_ctx_t ctx);
1188
1189 /* Cancel a pending operation asynchronously.  */
1190 gpgme_error_t gpgme_cancel_async (gpgme_ctx_t ctx);
1191
1192
1193 \f
1194 /*
1195  * Functions to handle data objects.
1196  */
1197
1198 /* Read up to SIZE bytes into buffer BUFFER from the data object with
1199    the handle HANDLE.  Return the number of characters read, 0 on EOF
1200    and -1 on error.  If an error occurs, errno is set.  */
1201 typedef @API__SSIZE_T@ (*gpgme_data_read_cb_t) (void *handle, void *buffer,
1202                                          size_t size);
1203
1204 /* Write up to SIZE bytes from buffer BUFFER to the data object with
1205    the handle HANDLE.  Return the number of characters written, or -1
1206    on error.  If an error occurs, errno is set.  */
1207 typedef @API__SSIZE_T@ (*gpgme_data_write_cb_t) (void *handle, const void *buffer,
1208                                           size_t size);
1209
1210 /* Set the current position from where the next read or write starts
1211    in the data object with the handle HANDLE to OFFSET, relativ to
1212    WHENCE.  Returns the new offset in bytes from the beginning of the
1213    data object.  */
1214 typedef @API__OFF_T@ (*gpgme_data_seek_cb_t) (void *handle,
1215                                        @API__OFF_T@ offset, int whence);
1216
1217 /* Close the data object with the handle HANDLE.  */
1218 typedef void (*gpgme_data_release_cb_t) (void *handle);
1219
1220 struct gpgme_data_cbs
1221 {
1222   gpgme_data_read_cb_t read;
1223   gpgme_data_write_cb_t write;
1224   gpgme_data_seek_cb_t seek;
1225   gpgme_data_release_cb_t release;
1226 };
1227 typedef struct gpgme_data_cbs *gpgme_data_cbs_t;
1228
1229 /* Read up to SIZE bytes into buffer BUFFER from the data object with
1230    the handle DH.  Return the number of characters read, 0 on EOF and
1231    -1 on error.  If an error occurs, errno is set.  */
1232 @API__SSIZE_T@ gpgme_data_read (gpgme_data_t dh, void *buffer, size_t size);
1233
1234 /* Write up to SIZE bytes from buffer BUFFER to the data object with
1235    the handle DH.  Return the number of characters written, or -1 on
1236    error.  If an error occurs, errno is set.  */
1237 @API__SSIZE_T@ gpgme_data_write (gpgme_data_t dh, const void *buffer, size_t size);
1238
1239 /* Set the current position from where the next read or write starts
1240    in the data object with the handle DH to OFFSET, relativ to WHENCE.
1241    Returns the new offset in bytes from the beginning of the data
1242    object.  */
1243 @API__OFF_T@ gpgme_data_seek (gpgme_data_t dh, @API__OFF_T@ offset, int whence);
1244
1245 /* Create a new data buffer and return it in R_DH.  */
1246 gpgme_error_t gpgme_data_new (gpgme_data_t *r_dh);
1247
1248 /* Destroy the data buffer DH.  */
1249 void gpgme_data_release (gpgme_data_t dh);
1250
1251 /* Create a new data buffer filled with SIZE bytes starting from
1252    BUFFER.  If COPY is zero, copying is delayed until necessary, and
1253    the data is taken from the original location when needed.  */
1254 gpgme_error_t gpgme_data_new_from_mem (gpgme_data_t *r_dh,
1255                                        const char *buffer, size_t size,
1256                                        int copy);
1257
1258 /* Destroy the data buffer DH and return a pointer to its content.
1259    The memory has be to released with gpgme_free() by the user.  It's
1260    size is returned in R_LEN.  */
1261 char *gpgme_data_release_and_get_mem (gpgme_data_t dh, size_t *r_len);
1262
1263 /* Release the memory returned by gpgme_data_release_and_get_mem() and
1264    some other functions.  */
1265 void gpgme_free (void *buffer);
1266
1267 gpgme_error_t gpgme_data_new_from_cbs (gpgme_data_t *dh,
1268                                        gpgme_data_cbs_t cbs,
1269                                        void *handle);
1270
1271 gpgme_error_t gpgme_data_new_from_fd (gpgme_data_t *dh, int fd);
1272
1273 gpgme_error_t gpgme_data_new_from_stream (gpgme_data_t *dh, FILE *stream);
1274
1275 /* Return the encoding attribute of the data buffer DH */
1276 gpgme_data_encoding_t gpgme_data_get_encoding (gpgme_data_t dh);
1277
1278 /* Set the encoding attribute of data buffer DH to ENC */
1279 gpgme_error_t gpgme_data_set_encoding (gpgme_data_t dh,
1280                                        gpgme_data_encoding_t enc);
1281
1282 /* Get the file name associated with the data object with handle DH, or
1283    NULL if there is none.  */
1284 char *gpgme_data_get_file_name (gpgme_data_t dh);
1285
1286 /* Set the file name associated with the data object with handle DH to
1287    FILE_NAME.  */
1288 gpgme_error_t gpgme_data_set_file_name (gpgme_data_t dh,
1289                                         const char *file_name);
1290
1291 /* Set a flag for the data object DH.  See the manual for details.  */
1292 gpg_error_t gpgme_data_set_flag (gpgme_data_t dh,
1293                                  const char *name, const char *value);
1294
1295 /* Try to identify the type of the data in DH.  */
1296 gpgme_data_type_t gpgme_data_identify (gpgme_data_t dh, int reserved);
1297
1298
1299 /* Create a new data buffer which retrieves the data from the callback
1300    function READ_CB.  Deprecated, please use gpgme_data_new_from_cbs
1301    instead.  */
1302 gpgme_error_t gpgme_data_new_with_read_cb (gpgme_data_t *r_dh,
1303                                            int (*read_cb) (void*,char *,
1304                                                            size_t,size_t*),
1305                                            void *read_cb_value)
1306      _GPGME_DEPRECATED;
1307
1308 /* Create a new data buffer filled with the content of file FNAME.
1309    COPY must be non-zero.  For delayed read, please use
1310    gpgme_data_new_from_fd or gpgme_data_new_from_stream instead.  */
1311 gpgme_error_t gpgme_data_new_from_file (gpgme_data_t *r_dh,
1312                                         const char *fname,
1313                                         int copy);
1314
1315 /* Create a new data buffer filled with LENGTH bytes starting from
1316    OFFSET within the file FNAME or stream FP (exactly one must be
1317    non-zero).  */
1318 gpgme_error_t gpgme_data_new_from_filepart (gpgme_data_t *r_dh,
1319                                             const char *fname, FILE *fp,
1320                                             @API__OFF_T@ offset, size_t length);
1321
1322 /* Reset the read pointer in DH.  Deprecated, please use
1323    gpgme_data_seek instead.  */
1324 gpgme_error_t gpgme_data_rewind (gpgme_data_t dh) _GPGME_DEPRECATED;
1325
1326
1327 \f
1328 /*
1329  * Key and trust functions.
1330  */
1331
1332 /* Get the key with the fingerprint FPR from the crypto backend.  If
1333    SECRET is true, get the secret key.  */
1334 gpgme_error_t gpgme_get_key (gpgme_ctx_t ctx, const char *fpr,
1335                              gpgme_key_t *r_key, int secret);
1336
1337 /* Create a dummy key to specify an email address.  */
1338 gpgme_error_t gpgme_key_from_uid (gpgme_key_t *key, const char *name);
1339
1340 /* Acquire a reference to KEY.  */
1341 void gpgme_key_ref (gpgme_key_t key);
1342
1343 /* Release a reference to KEY.  If this was the last one the key is
1344    destroyed.  */
1345 void gpgme_key_unref (gpgme_key_t key);
1346 void gpgme_key_release (gpgme_key_t key);
1347
1348 /* Return the value of the attribute WHAT of KEY, which has to be
1349    representable by a string.  IDX specifies the sub key or user ID
1350    for attributes related to sub keys or user IDs.  Deprecated, use
1351    key structure directly instead. */
1352 const char *gpgme_key_get_string_attr (gpgme_key_t key, _gpgme_attr_t what,
1353                                        const void *reserved, int idx)
1354      _GPGME_DEPRECATED;
1355
1356 /* Return the value of the attribute WHAT of KEY, which has to be
1357    representable by an unsigned integer.  IDX specifies the sub key or
1358    user ID for attributes related to sub keys or user IDs.
1359    Deprecated, use key structure directly instead.  */
1360 unsigned long gpgme_key_get_ulong_attr (gpgme_key_t key, _gpgme_attr_t what,
1361                                         const void *reserved, int idx)
1362      _GPGME_DEPRECATED;
1363
1364 /* Return the value of the attribute WHAT of a signature on user ID
1365    UID_IDX in KEY, which has to be representable by a string.  IDX
1366    specifies the signature.  Deprecated, use key structure directly
1367    instead.  */
1368 const char *gpgme_key_sig_get_string_attr (gpgme_key_t key, int uid_idx,
1369                                            _gpgme_attr_t what,
1370                                            const void *reserved, int idx)
1371      _GPGME_DEPRECATED;
1372
1373 /* Return the value of the attribute WHAT of a signature on user ID
1374    UID_IDX in KEY, which has to be representable by an unsigned
1375    integer string.  IDX specifies the signature.  Deprecated, use key
1376    structure directly instead.  */
1377 unsigned long gpgme_key_sig_get_ulong_attr (gpgme_key_t key, int uid_idx,
1378                                             _gpgme_attr_t what,
1379                                             const void *reserved, int idx)
1380      _GPGME_DEPRECATED;
1381
1382
1383 \f
1384 /*
1385  * Encryption.
1386  */
1387
1388 struct _gpgme_op_encrypt_result
1389 {
1390   /* The list of invalid recipients.  */
1391   gpgme_invalid_key_t invalid_recipients;
1392 };
1393 typedef struct _gpgme_op_encrypt_result *gpgme_encrypt_result_t;
1394
1395 /* Retrieve a pointer to the result of the encrypt operation.  */
1396 gpgme_encrypt_result_t gpgme_op_encrypt_result (gpgme_ctx_t ctx);
1397
1398 /* The valid encryption flags.  */
1399 typedef enum
1400   {
1401     GPGME_ENCRYPT_ALWAYS_TRUST = 1,
1402     GPGME_ENCRYPT_NO_ENCRYPT_TO = 2,
1403     GPGME_ENCRYPT_PREPARE = 4,
1404     GPGME_ENCRYPT_EXPECT_SIGN = 8,
1405     GPGME_ENCRYPT_NO_COMPRESS = 16,
1406     GPGME_ENCRYPT_SYMMETRIC = 32
1407   }
1408 gpgme_encrypt_flags_t;
1409
1410 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1411    store the resulting ciphertext in CIPHER.  */
1412 gpgme_error_t gpgme_op_encrypt_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
1413                                       gpgme_encrypt_flags_t flags,
1414                                       gpgme_data_t plain, gpgme_data_t cipher);
1415 gpgme_error_t gpgme_op_encrypt (gpgme_ctx_t ctx, gpgme_key_t recp[],
1416                                 gpgme_encrypt_flags_t flags,
1417                                 gpgme_data_t plain, gpgme_data_t cipher);
1418
1419 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1420    store the resulting ciphertext in CIPHER.  Also sign the ciphertext
1421    with the signers in CTX.  */
1422 gpgme_error_t gpgme_op_encrypt_sign_start (gpgme_ctx_t ctx,
1423                                            gpgme_key_t recp[],
1424                                            gpgme_encrypt_flags_t flags,
1425                                            gpgme_data_t plain,
1426                                            gpgme_data_t cipher);
1427 gpgme_error_t gpgme_op_encrypt_sign (gpgme_ctx_t ctx, gpgme_key_t recp[],
1428                                      gpgme_encrypt_flags_t flags,
1429                                      gpgme_data_t plain, gpgme_data_t cipher);
1430
1431 \f
1432 /*
1433  * Decryption.
1434  */
1435
1436 struct _gpgme_recipient
1437 {
1438   struct _gpgme_recipient *next;
1439
1440   /* The key ID of key for which the text was encrypted.  */
1441   char *keyid;
1442
1443   /* Internal to GPGME, do not use.  */
1444   char _keyid[16 + 1];
1445
1446   /* The public key algorithm of the recipient key.  */
1447   gpgme_pubkey_algo_t pubkey_algo;
1448
1449   /* The status of the recipient.  */
1450   gpgme_error_t status;
1451 };
1452 typedef struct _gpgme_recipient *gpgme_recipient_t;
1453
1454 struct _gpgme_op_decrypt_result
1455 {
1456   char *unsupported_algorithm;
1457
1458   /* Key should not have been used for encryption.  */
1459   unsigned int wrong_key_usage : 1;
1460
1461   /* Internal to GPGME, do not use.  */
1462   int _unused : 31;
1463
1464   gpgme_recipient_t recipients;
1465
1466   /* The original file name of the plaintext message, if
1467      available.  */
1468   char *file_name;
1469 };
1470 typedef struct _gpgme_op_decrypt_result *gpgme_decrypt_result_t;
1471
1472 /* Retrieve a pointer to the result of the decrypt operation.  */
1473 gpgme_decrypt_result_t gpgme_op_decrypt_result (gpgme_ctx_t ctx);
1474
1475 /* Decrypt ciphertext CIPHER within CTX and store the resulting
1476    plaintext in PLAIN.  */
1477 gpgme_error_t gpgme_op_decrypt_start (gpgme_ctx_t ctx, gpgme_data_t cipher,
1478                                       gpgme_data_t plain);
1479 gpgme_error_t gpgme_op_decrypt (gpgme_ctx_t ctx,
1480                                 gpgme_data_t cipher, gpgme_data_t plain);
1481
1482 /* Decrypt ciphertext CIPHER and make a signature verification within
1483    CTX and store the resulting plaintext in PLAIN.  */
1484 gpgme_error_t gpgme_op_decrypt_verify_start (gpgme_ctx_t ctx,
1485                                              gpgme_data_t cipher,
1486                                              gpgme_data_t plain);
1487 gpgme_error_t gpgme_op_decrypt_verify (gpgme_ctx_t ctx, gpgme_data_t cipher,
1488                                        gpgme_data_t plain);
1489
1490 \f
1491 /*
1492  * Signing.
1493  */
1494
1495 struct _gpgme_new_signature
1496 {
1497   struct _gpgme_new_signature *next;
1498
1499   /* The type of the signature.  */
1500   gpgme_sig_mode_t type;
1501
1502   /* The public key algorithm used to create the signature.  */
1503   gpgme_pubkey_algo_t pubkey_algo;
1504
1505   /* The hash algorithm used to create the signature.  */
1506   gpgme_hash_algo_t hash_algo;
1507
1508   /* Internal to GPGME, do not use.  Must be set to the same value as
1509      CLASS below.  */
1510   unsigned long _obsolete_class;
1511
1512   /* Signature creation time.  */
1513   long int timestamp;
1514
1515   /* The fingerprint of the signature.  */
1516   char *fpr;
1517
1518 #ifdef __cplusplus
1519   unsigned int _obsolete_class_2;
1520 #else
1521   /* Must be set to SIG_CLASS below.  */
1522   unsigned int class _GPGME_DEPRECATED_OUTSIDE_GPGME;
1523 #endif
1524
1525   /* Crypto backend specific signature class.  */
1526   unsigned int sig_class;
1527 };
1528 typedef struct _gpgme_new_signature *gpgme_new_signature_t;
1529
1530 struct _gpgme_op_sign_result
1531 {
1532   /* The list of invalid signers.  */
1533   gpgme_invalid_key_t invalid_signers;
1534   gpgme_new_signature_t signatures;
1535 };
1536 typedef struct _gpgme_op_sign_result *gpgme_sign_result_t;
1537
1538 /* Retrieve a pointer to the result of the signing operation.  */
1539 gpgme_sign_result_t gpgme_op_sign_result (gpgme_ctx_t ctx);
1540
1541 /* Sign the plaintext PLAIN and store the signature in SIG.  */
1542 gpgme_error_t gpgme_op_sign_start (gpgme_ctx_t ctx,
1543                                    gpgme_data_t plain, gpgme_data_t sig,
1544                                    gpgme_sig_mode_t mode);
1545 gpgme_error_t gpgme_op_sign (gpgme_ctx_t ctx,
1546                              gpgme_data_t plain, gpgme_data_t sig,
1547                              gpgme_sig_mode_t mode);
1548
1549 \f
1550 /*
1551  * Verify.
1552  */
1553
1554 /* Flags used for the SUMMARY field in a gpgme_signature_t.  */
1555 typedef enum
1556   {
1557     GPGME_SIGSUM_VALID       = 0x0001,  /* The signature is fully valid.  */
1558     GPGME_SIGSUM_GREEN       = 0x0002,  /* The signature is good.  */
1559     GPGME_SIGSUM_RED         = 0x0004,  /* The signature is bad.  */
1560     GPGME_SIGSUM_KEY_REVOKED = 0x0010,  /* One key has been revoked.  */
1561     GPGME_SIGSUM_KEY_EXPIRED = 0x0020,  /* One key has expired.  */
1562     GPGME_SIGSUM_SIG_EXPIRED = 0x0040,  /* The signature has expired.  */
1563     GPGME_SIGSUM_KEY_MISSING = 0x0080,  /* Can't verify: key missing.  */
1564     GPGME_SIGSUM_CRL_MISSING = 0x0100,  /* CRL not available.  */
1565     GPGME_SIGSUM_CRL_TOO_OLD = 0x0200,  /* Available CRL is too old.  */
1566     GPGME_SIGSUM_BAD_POLICY  = 0x0400,  /* A policy was not met.  */
1567     GPGME_SIGSUM_SYS_ERROR   = 0x0800,  /* A system error occurred.  */
1568     GPGME_SIGSUM_TOFU_CONFLICT=0x1000   /* Tofu conflict detected.  */
1569   }
1570 gpgme_sigsum_t;
1571
1572
1573 struct _gpgme_tofu_info
1574 {
1575   struct _gpgme_tofu_info *next;
1576
1577   /* The mail address (addr-spec from RFC5322) of the tofu binding.
1578    *
1579    * If no mail address is set for a User ID this is the name used
1580    * for the user ID. Can be ambiguous when the same mail address or
1581    * name is used in multiple user ids.
1582    */
1583   char *address;
1584
1585   /* The fingerprint of the primary key.  */
1586   char *fpr;
1587
1588   /* The TOFU validity:
1589    *  0 := conflict
1590    *  1 := key without history
1591    *  2 := key with too little history
1592    *  3 := key with enough history for basic trust
1593    *  4 := key with a lot of history
1594    */
1595   unsigned int validity : 3;
1596
1597   /* The TOFU policy (gpgme_tofu_policy_t).  */
1598   unsigned int policy : 4;
1599
1600   unsigned int _rfu : 25;
1601
1602   /* Number of signatures seen for this binding.  Capped at USHRT_MAX.  */
1603   unsigned short signcount;
1604   unsigned short reserved;
1605
1606   /* Number of seconds since the first and the most recently seen
1607    * message was verified.  */
1608   unsigned int firstseen;
1609   unsigned int lastseen;
1610
1611   /* If non-NULL a human readable string summarizing the TOFU data. */
1612   char *description;
1613 };
1614 typedef struct _gpgme_tofu_info *gpgme_tofu_info_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 or key ID of the signature.  */
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, TOFU info for this signature are available.  */
1664   gpgme_tofu_info_t tofu;
1665 };
1666 typedef struct _gpgme_signature *gpgme_signature_t;
1667
1668 struct _gpgme_op_verify_result
1669 {
1670   gpgme_signature_t signatures;
1671
1672   /* The original file name of the plaintext message, if
1673      available.  */
1674   char *file_name;
1675 };
1676 typedef struct _gpgme_op_verify_result *gpgme_verify_result_t;
1677
1678 /* Retrieve a pointer to the result of the verify operation.  */
1679 gpgme_verify_result_t gpgme_op_verify_result (gpgme_ctx_t ctx);
1680
1681 /* Verify within CTX that SIG is a valid signature for TEXT.  */
1682 gpgme_error_t gpgme_op_verify_start (gpgme_ctx_t ctx, gpgme_data_t sig,
1683                                      gpgme_data_t signed_text,
1684                                      gpgme_data_t plaintext);
1685 gpgme_error_t gpgme_op_verify (gpgme_ctx_t ctx, gpgme_data_t sig,
1686                                gpgme_data_t signed_text,
1687                                gpgme_data_t plaintext);
1688
1689 \f
1690 /*
1691  * Import/Export
1692  */
1693
1694 #define GPGME_IMPORT_NEW        1  /* The key was new.  */
1695 #define GPGME_IMPORT_UID        2  /* The key contained new user IDs.  */
1696 #define GPGME_IMPORT_SIG        4  /* The key contained new signatures.  */
1697 #define GPGME_IMPORT_SUBKEY     8  /* The key contained new sub keys.  */
1698 #define GPGME_IMPORT_SECRET    16  /* The key contained a secret key.  */
1699
1700
1701 struct _gpgme_import_status
1702 {
1703   struct _gpgme_import_status *next;
1704
1705   /* Fingerprint.  */
1706   char *fpr;
1707
1708   /* If a problem occurred, the reason why the key could not be
1709      imported.  Otherwise GPGME_No_Error.  */
1710   gpgme_error_t result;
1711
1712   /* The result of the import, the GPGME_IMPORT_* values bit-wise
1713      ORed.  0 means the key was already known and no new components
1714      have been added.  */
1715   unsigned int status;
1716 };
1717 typedef struct _gpgme_import_status *gpgme_import_status_t;
1718
1719 /* Import result object.  */
1720 struct _gpgme_op_import_result
1721 {
1722   /* Number of considered keys.  */
1723   int considered;
1724
1725   /* Keys without user ID.  */
1726   int no_user_id;
1727
1728   /* Imported keys.  */
1729   int imported;
1730
1731   /* Imported RSA keys.  */
1732   int imported_rsa;
1733
1734   /* Unchanged keys.  */
1735   int unchanged;
1736
1737   /* Number of new user ids.  */
1738   int new_user_ids;
1739
1740   /* Number of new sub keys.  */
1741   int new_sub_keys;
1742
1743   /* Number of new signatures.  */
1744   int new_signatures;
1745
1746   /* Number of new revocations.  */
1747   int new_revocations;
1748
1749   /* Number of secret keys read.  */
1750   int secret_read;
1751
1752   /* Number of secret keys imported.  */
1753   int secret_imported;
1754
1755   /* Number of secret keys unchanged.  */
1756   int secret_unchanged;
1757
1758   /* Number of new keys skipped.  */
1759   int skipped_new_keys;
1760
1761   /* Number of keys not imported.  */
1762   int not_imported;
1763
1764   /* List of keys for which an import was attempted.  */
1765   gpgme_import_status_t imports;
1766 };
1767 typedef struct _gpgme_op_import_result *gpgme_import_result_t;
1768
1769 /* Retrieve a pointer to the result of the import operation.  */
1770 gpgme_import_result_t gpgme_op_import_result (gpgme_ctx_t ctx);
1771
1772 /* Import the key in KEYDATA into the keyring.  */
1773 gpgme_error_t gpgme_op_import_start (gpgme_ctx_t ctx, gpgme_data_t keydata);
1774 gpgme_error_t gpgme_op_import (gpgme_ctx_t ctx, gpgme_data_t keydata);
1775 gpgme_error_t gpgme_op_import_ext (gpgme_ctx_t ctx, gpgme_data_t keydata,
1776                                    int *nr) _GPGME_DEPRECATED;
1777
1778 /* Import the keys from the array KEYS into the keyring.  */
1779 gpgme_error_t gpgme_op_import_keys_start (gpgme_ctx_t ctx, gpgme_key_t keys[]);
1780 gpgme_error_t gpgme_op_import_keys (gpgme_ctx_t ctx, gpgme_key_t keys[]);
1781
1782
1783 /* Export the keys found by PATTERN into KEYDATA.  */
1784 gpgme_error_t gpgme_op_export_start (gpgme_ctx_t ctx, const char *pattern,
1785                                      gpgme_export_mode_t mode,
1786                                      gpgme_data_t keydata);
1787 gpgme_error_t gpgme_op_export (gpgme_ctx_t ctx, const char *pattern,
1788                                gpgme_export_mode_t mode,
1789                                gpgme_data_t keydata);
1790
1791 gpgme_error_t gpgme_op_export_ext_start (gpgme_ctx_t ctx,
1792                                          const char *pattern[],
1793                                          gpgme_export_mode_t mode,
1794                                          gpgme_data_t keydata);
1795 gpgme_error_t gpgme_op_export_ext (gpgme_ctx_t ctx, const char *pattern[],
1796                                    gpgme_export_mode_t mode,
1797                                    gpgme_data_t keydata);
1798
1799 /* Export the keys from the array KEYS into KEYDATA.  */
1800 gpgme_error_t gpgme_op_export_keys_start (gpgme_ctx_t ctx,
1801                                           gpgme_key_t keys[],
1802                                           gpgme_export_mode_t mode,
1803                                           gpgme_data_t keydata);
1804 gpgme_error_t gpgme_op_export_keys (gpgme_ctx_t ctx,
1805                                     gpgme_key_t keys[],
1806                                     gpgme_export_mode_t mode,
1807                                     gpgme_data_t keydata);
1808
1809
1810 \f
1811 /*
1812  * Key generation.
1813  */
1814
1815 struct _gpgme_op_genkey_result
1816 {
1817   /* A primary key was generated.  */
1818   unsigned int primary : 1;
1819
1820   /* A sub key was generated.  */
1821   unsigned int sub : 1;
1822
1823   /* Internal to GPGME, do not use.  */
1824   unsigned int _unused : 30;
1825
1826   /* The fingerprint of the generated key.  */
1827   char *fpr;
1828 };
1829 typedef struct _gpgme_op_genkey_result *gpgme_genkey_result_t;
1830
1831 /* Generate a new keypair and add it to the keyring.  PUBKEY and
1832    SECKEY should be null for now.  PARMS specifies what keys should be
1833    generated.  */
1834 gpgme_error_t gpgme_op_genkey_start (gpgme_ctx_t ctx, const char *parms,
1835                                      gpgme_data_t pubkey, gpgme_data_t seckey);
1836 gpgme_error_t gpgme_op_genkey (gpgme_ctx_t ctx, const char *parms,
1837                                gpgme_data_t pubkey, gpgme_data_t seckey);
1838
1839 /* Retrieve a pointer to the result of the genkey operation.  */
1840 gpgme_genkey_result_t gpgme_op_genkey_result (gpgme_ctx_t ctx);
1841
1842
1843 /* Delete KEY from the keyring.  If ALLOW_SECRET is non-zero, secret
1844    keys are also deleted.  */
1845 gpgme_error_t gpgme_op_delete_start (gpgme_ctx_t ctx, const gpgme_key_t key,
1846                                      int allow_secret);
1847 gpgme_error_t gpgme_op_delete (gpgme_ctx_t ctx, const gpgme_key_t key,
1848                                int allow_secret);
1849
1850
1851 \f
1852 /*
1853  * Key Edit interface
1854  */
1855
1856 /* Edit the key KEY.  Send status and command requests to FNC and
1857    output of edit commands to OUT.  */
1858 gpgme_error_t gpgme_op_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1859                                    gpgme_edit_cb_t fnc, void *fnc_value,
1860                                    gpgme_data_t out);
1861 gpgme_error_t gpgme_op_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1862                              gpgme_edit_cb_t fnc, void *fnc_value,
1863                              gpgme_data_t out);
1864
1865 /* Edit the card for the key KEY.  Send status and command requests to
1866    FNC and output of edit commands to OUT.  */
1867 gpgme_error_t gpgme_op_card_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1868                                         gpgme_edit_cb_t fnc, void *fnc_value,
1869                                         gpgme_data_t out);
1870 gpgme_error_t gpgme_op_card_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1871                                   gpgme_edit_cb_t fnc, void *fnc_value,
1872                                   gpgme_data_t out);
1873
1874
1875 \f
1876 /*
1877  * Key listing
1878  */
1879
1880 struct _gpgme_op_keylist_result
1881 {
1882   unsigned int truncated : 1;
1883
1884   /* Internal to GPGME, do not use.  */
1885   unsigned int _unused : 31;
1886 };
1887 typedef struct _gpgme_op_keylist_result *gpgme_keylist_result_t;
1888
1889 /* Retrieve a pointer to the result of the key listing operation.  */
1890 gpgme_keylist_result_t gpgme_op_keylist_result (gpgme_ctx_t ctx);
1891
1892 /* Start a keylist operation within CTX, searching for keys which
1893    match PATTERN.  If SECRET_ONLY is true, only secret keys are
1894    returned.  */
1895 gpgme_error_t gpgme_op_keylist_start (gpgme_ctx_t ctx, const char *pattern,
1896                                       int secret_only);
1897 gpgme_error_t gpgme_op_keylist_ext_start (gpgme_ctx_t ctx,
1898                                           const char *pattern[],
1899                                           int secret_only, int reserved);
1900
1901 /* Return the next key from the keylist in R_KEY.  */
1902 gpgme_error_t gpgme_op_keylist_next (gpgme_ctx_t ctx, gpgme_key_t *r_key);
1903
1904 /* Terminate a pending keylist operation within CTX.  */
1905 gpgme_error_t gpgme_op_keylist_end (gpgme_ctx_t ctx);
1906
1907 /* Change the passphrase for KEY.  FLAGS is reserved for future use
1908    and must be passed as 0.  */
1909 gpgme_error_t gpgme_op_passwd_start (gpgme_ctx_t ctx, gpgme_key_t key,
1910                                      unsigned int flags);
1911 gpgme_error_t gpgme_op_passwd (gpgme_ctx_t ctx, gpgme_key_t key,
1912                                unsigned int flags);
1913
1914
1915 \f
1916 /*
1917  * Trust items and operations.
1918  */
1919
1920 struct _gpgme_trust_item
1921 {
1922   /* Internal to GPGME, do not use.  */
1923   unsigned int _refs;
1924
1925   /* The key ID to which the trust item belongs.  */
1926   char *keyid;
1927
1928   /* Internal to GPGME, do not use.  */
1929   char _keyid[16 + 1];
1930
1931   /* The type of the trust item, 1 refers to a key, 2 to a user ID.  */
1932   int type;
1933
1934   /* The trust level.  */
1935   int level;
1936
1937   /* The owner trust if TYPE is 1.  */
1938   char *owner_trust;
1939
1940   /* Internal to GPGME, do not use.  */
1941   char _owner_trust[2];
1942
1943   /* The calculated validity.  */
1944   char *validity;
1945
1946   /* Internal to GPGME, do not use.  */
1947   char _validity[2];
1948
1949   /* The user name if TYPE is 2.  */
1950   char *name;
1951 };
1952 typedef struct _gpgme_trust_item *gpgme_trust_item_t;
1953
1954 /* Start a trustlist operation within CTX, searching for trust items
1955    which match PATTERN.  */
1956 gpgme_error_t gpgme_op_trustlist_start (gpgme_ctx_t ctx,
1957                                         const char *pattern, int max_level);
1958
1959 /* Return the next trust item from the trustlist in R_ITEM.  */
1960 gpgme_error_t gpgme_op_trustlist_next (gpgme_ctx_t ctx,
1961                                        gpgme_trust_item_t *r_item);
1962
1963 /* Terminate a pending trustlist operation within CTX.  */
1964 gpgme_error_t gpgme_op_trustlist_end (gpgme_ctx_t ctx);
1965
1966 /* Acquire a reference to ITEM.  */
1967 void gpgme_trust_item_ref (gpgme_trust_item_t item);
1968
1969 /* Release a reference to ITEM.  If this was the last one the trust
1970    item is destroyed.  */
1971 void gpgme_trust_item_unref (gpgme_trust_item_t item);
1972
1973 /* Release the trust item ITEM.  Deprecated, use
1974    gpgme_trust_item_unref.  */
1975 void gpgme_trust_item_release (gpgme_trust_item_t item) _GPGME_DEPRECATED;
1976
1977 /* Return the value of the attribute WHAT of ITEM, which has to be
1978    representable by a string.  Deprecated, use trust item structure
1979    directly.  */
1980 const char *gpgme_trust_item_get_string_attr (gpgme_trust_item_t item,
1981                                               _gpgme_attr_t what,
1982                                               const void *reserved, int idx)
1983      _GPGME_DEPRECATED;
1984
1985 /* Return the value of the attribute WHAT of KEY, which has to be
1986    representable by an integer.  IDX specifies a running index if the
1987    attribute appears more than once in the key.  Deprecated, use trust
1988    item structure directly.  */
1989 int gpgme_trust_item_get_int_attr (gpgme_trust_item_t item, _gpgme_attr_t what,
1990                                    const void *reserved, int idx)
1991      _GPGME_DEPRECATED;
1992
1993
1994 \f
1995 /*
1996  * Audit log
1997  */
1998
1999 /* Return the auditlog for the current session.  This may be called
2000    after a successful or failed operation.  If no audit log is
2001    available GPG_ERR_NO_DATA is returned.  */
2002 gpgme_error_t gpgme_op_getauditlog_start (gpgme_ctx_t ctx, gpgme_data_t output,
2003                                           unsigned int flags);
2004 gpgme_error_t gpgme_op_getauditlog (gpgme_ctx_t ctx, gpgme_data_t output,
2005                                     unsigned int flags);
2006
2007
2008 \f
2009 /*
2010  * Spawn interface
2011  */
2012
2013 /* Flags for the spawn operations.  */
2014 #define GPGME_SPAWN_DETACHED      1
2015 #define GPGME_SPAWN_ALLOW_SET_FG  2
2016
2017
2018 /* Run the command FILE with the arguments in ARGV.  Connect stdin to
2019    DATAIN, stdout to DATAOUT, and STDERR to DATAERR.  If one the data
2020    streams is NULL, connect to /dev/null instead.  */
2021 gpgme_error_t gpgme_op_spawn_start (gpgme_ctx_t ctx,
2022                                     const char *file, const char *argv[],
2023                                     gpgme_data_t datain,
2024                                     gpgme_data_t dataout, gpgme_data_t dataerr,
2025                                     unsigned int flags);
2026 gpgme_error_t gpgme_op_spawn (gpgme_ctx_t ctx,
2027                               const char *file, const char *argv[],
2028                               gpgme_data_t datain,
2029                               gpgme_data_t dataout, gpgme_data_t dataerr,
2030                               unsigned int flags);
2031
2032 \f
2033 /*
2034  * Low-level Assuan protocol access.
2035  */
2036 typedef gpgme_error_t (*gpgme_assuan_data_cb_t)
2037      (void *opaque, const void *data, size_t datalen);
2038
2039 typedef gpgme_error_t (*gpgme_assuan_inquire_cb_t)
2040      (void *opaque, const char *name, const char *args,
2041       gpgme_data_t *r_data);
2042
2043 typedef gpgme_error_t (*gpgme_assuan_status_cb_t)
2044      (void *opaque, const char *status, const char *args);
2045
2046 /* Send the Assuan COMMAND and return results via the callbacks.
2047    Asynchronous variant. */
2048 gpgme_error_t gpgme_op_assuan_transact_start (gpgme_ctx_t ctx,
2049                                               const char *command,
2050                                               gpgme_assuan_data_cb_t data_cb,
2051                                               void *data_cb_value,
2052                                               gpgme_assuan_inquire_cb_t inq_cb,
2053                                               void *inq_cb_value,
2054                                               gpgme_assuan_status_cb_t stat_cb,
2055                                               void *stat_cb_value);
2056
2057 /* Send the Assuan COMMAND and return results via the callbacks.
2058    Synchronous variant. */
2059 gpgme_error_t gpgme_op_assuan_transact_ext (gpgme_ctx_t ctx,
2060                                             const char *command,
2061                                             gpgme_assuan_data_cb_t data_cb,
2062                                             void *data_cb_value,
2063                                             gpgme_assuan_inquire_cb_t inq_cb,
2064                                             void *inq_cb_value,
2065                                             gpgme_assuan_status_cb_t stat_cb,
2066                                             void *stat_cb_value,
2067                                             gpgme_error_t *op_err);
2068
2069 /* Compat.  */
2070 struct _gpgme_op_assuan_result
2071 {
2072   /* Deprecated.  Use the second value in a DONE event or the
2073      synchronous variant gpgme_op_assuan_transact_ext.  */
2074   gpgme_error_t err _GPGME_DEPRECATED_OUTSIDE_GPGME;
2075 };
2076 typedef struct _gpgme_op_assuan_result *gpgme_assuan_result_t;
2077
2078
2079 /* Return the result of the last Assuan command. */
2080 gpgme_assuan_result_t gpgme_op_assuan_result (gpgme_ctx_t ctx)
2081   _GPGME_DEPRECATED;
2082
2083 gpgme_error_t
2084 gpgme_op_assuan_transact (gpgme_ctx_t ctx,
2085                               const char *command,
2086                               gpgme_assuan_data_cb_t data_cb,
2087                               void *data_cb_value,
2088                               gpgme_assuan_inquire_cb_t inq_cb,
2089                               void *inq_cb_value,
2090                               gpgme_assuan_status_cb_t status_cb,
2091                               void *status_cb_value) _GPGME_DEPRECATED;
2092
2093 \f
2094 /*
2095  * Crypto container support.
2096  */
2097
2098 struct _gpgme_op_vfs_mount_result
2099 {
2100   char *mount_dir;
2101 };
2102 typedef struct _gpgme_op_vfs_mount_result *gpgme_vfs_mount_result_t;
2103
2104 gpgme_vfs_mount_result_t gpgme_op_vfs_mount_result (gpgme_ctx_t ctx);
2105
2106 /* The container is automatically unmounted when the context is reset
2107    or destroyed.  Transmission errors are returned directly,
2108    operational errors are returned in OP_ERR.  */
2109 gpgme_error_t gpgme_op_vfs_mount (gpgme_ctx_t ctx, const char *container_file,
2110                                   const char *mount_dir, unsigned int flags,
2111                                   gpgme_error_t *op_err);
2112
2113 gpgme_error_t gpgme_op_vfs_create (gpgme_ctx_t ctx, gpgme_key_t recp[],
2114                                    const char *container_file,
2115                                    unsigned int flags, gpgme_error_t *op_err);
2116
2117 \f
2118 /*
2119  * Interface to gpgconf(1).
2120  */
2121
2122 /* The expert level at which a configuration option or group of
2123    options should be displayed.  See the gpgconf(1) documentation for
2124    more details.  */
2125 typedef enum
2126   {
2127     GPGME_CONF_BASIC = 0,
2128     GPGME_CONF_ADVANCED = 1,
2129     GPGME_CONF_EXPERT = 2,
2130     GPGME_CONF_INVISIBLE = 3,
2131     GPGME_CONF_INTERNAL = 4
2132   }
2133 gpgme_conf_level_t;
2134
2135
2136 /* The data type of a configuration option argument.  See the gpgconf(1)
2137    documentation for more details.  */
2138 typedef enum
2139   {
2140     /* Basic types.  */
2141     GPGME_CONF_NONE = 0,
2142     GPGME_CONF_STRING = 1,
2143     GPGME_CONF_INT32 = 2,
2144     GPGME_CONF_UINT32 = 3,
2145
2146     /* Complex types.  */
2147     GPGME_CONF_FILENAME = 32,
2148     GPGME_CONF_LDAP_SERVER = 33,
2149     GPGME_CONF_KEY_FPR = 34,
2150     GPGME_CONF_PUB_KEY = 35,
2151     GPGME_CONF_SEC_KEY = 36,
2152     GPGME_CONF_ALIAS_LIST = 37
2153   }
2154 gpgme_conf_type_t;
2155
2156 /* For now, compatibility.  */
2157 #define GPGME_CONF_PATHNAME GPGME_CONF_FILENAME
2158
2159
2160 /* This represents a single argument for a configuration option.
2161    Which of the members of value is used depends on the ALT_TYPE.  */
2162 typedef struct gpgme_conf_arg
2163 {
2164   struct gpgme_conf_arg *next;
2165   /* True if the option appears without an (optional) argument.  */
2166   unsigned int no_arg;
2167   union
2168   {
2169     unsigned int count;
2170     unsigned int uint32;
2171     int int32;
2172     char *string;
2173   } value;
2174 } *gpgme_conf_arg_t;
2175
2176
2177 /* The flags of a configuration option.  See the gpg-conf
2178    documentation for details.  */
2179 #define GPGME_CONF_GROUP        (1 << 0)
2180 #define GPGME_CONF_OPTIONAL     (1 << 1)
2181 #define GPGME_CONF_LIST         (1 << 2)
2182 #define GPGME_CONF_RUNTIME      (1 << 3)
2183 #define GPGME_CONF_DEFAULT      (1 << 4)
2184 #define GPGME_CONF_DEFAULT_DESC (1 << 5)
2185 #define GPGME_CONF_NO_ARG_DESC  (1 << 6)
2186 #define GPGME_CONF_NO_CHANGE    (1 << 7)
2187
2188
2189 /* The representation of a single configuration option.  See the
2190    gpg-conf documentation for details.  */
2191 typedef struct gpgme_conf_opt
2192 {
2193   struct gpgme_conf_opt *next;
2194
2195   /* The option name.  */
2196   char *name;
2197
2198   /* The flags for this option.  */
2199   unsigned int flags;
2200
2201   /* The level of this option.  */
2202   gpgme_conf_level_t level;
2203
2204   /* The localized description of this option.  */
2205   char *description;
2206
2207   /* The type and alternate type of this option.  */
2208   gpgme_conf_type_t type;
2209   gpgme_conf_type_t alt_type;
2210
2211   /* The localized (short) name of the argument, if any.  */
2212   char *argname;
2213
2214   /* The default value.  */
2215   gpgme_conf_arg_t default_value;
2216   char *default_description;
2217
2218   /* The default value if the option is not set.  */
2219   gpgme_conf_arg_t no_arg_value;
2220   char *no_arg_description;
2221
2222   /* The current value if the option is set.  */
2223   gpgme_conf_arg_t value;
2224
2225   /* The new value, if any.  NULL means reset to default.  */
2226   int change_value;
2227   gpgme_conf_arg_t new_value;
2228
2229   /* Free for application use.  */
2230   void *user_data;
2231 } *gpgme_conf_opt_t;
2232
2233
2234 /* The representation of a component that can be configured.  See the
2235    gpg-conf documentation for details.  */
2236 typedef struct gpgme_conf_comp
2237 {
2238   struct gpgme_conf_comp *next;
2239
2240   /* Internal to GPGME, do not use!  */
2241   gpgme_conf_opt_t *_last_opt_p;
2242
2243   /* The component name.  */
2244   char *name;
2245
2246   /* A human-readable description for the component.  */
2247   char *description;
2248
2249   /* The program name (an absolute path to the program).  */
2250   char *program_name;
2251
2252   /* A linked list of options for this component.  */
2253   struct gpgme_conf_opt *options;
2254 } *gpgme_conf_comp_t;
2255
2256
2257 /* Allocate a new gpgme_conf_arg_t.  If VALUE is NULL, a "no arg
2258    default" is prepared.  If type is a string type, VALUE should point
2259    to the string.  Else, it should point to an unsigned or signed
2260    integer respectively.  */
2261 gpgme_error_t gpgme_conf_arg_new (gpgme_conf_arg_t *arg_p,
2262                                   gpgme_conf_type_t type, const void *value);
2263
2264 /* This also releases all chained argument structures!  */
2265 void gpgme_conf_arg_release (gpgme_conf_arg_t arg, gpgme_conf_type_t type);
2266
2267 /* Register a change for the value of OPT to ARG.  If RESET is 1 (do
2268    not use any values but 0 or 1), ARG is ignored and the option is
2269    not changed (reverting a previous change).  Otherwise, if ARG is
2270    NULL, the option is cleared or reset to its default.  */
2271 gpgme_error_t gpgme_conf_opt_change (gpgme_conf_opt_t opt, int reset,
2272                                      gpgme_conf_arg_t arg);
2273
2274 /* Release a set of configurations.  */
2275 void gpgme_conf_release (gpgme_conf_comp_t conf);
2276
2277 /* Retrieve the current configurations.  */
2278 gpgme_error_t gpgme_op_conf_load (gpgme_ctx_t ctx, gpgme_conf_comp_t *conf_p);
2279
2280 /* Save the configuration of component comp.  This function does not
2281    follow chained components!  */
2282 gpgme_error_t gpgme_op_conf_save (gpgme_ctx_t ctx, gpgme_conf_comp_t comp);
2283
2284
2285 \f
2286 /*
2287  * Various functions.
2288  */
2289
2290 /* Set special global flags; consult the manual before use.  */
2291 int gpgme_set_global_flag (const char *name, const char *value);
2292
2293 /* Check that the library fulfills the version requirement.  Note:
2294    This is here only for the case where a user takes a pointer from
2295    the old version of this function.  The new version and macro for
2296    run-time checks are below.  */
2297 const char *gpgme_check_version (const char *req_version);
2298
2299 /* Check that the library fulfills the version requirement and check
2300    for struct layout mismatch involving bitfields.  */
2301 const char *gpgme_check_version_internal (const char *req_version,
2302                                           size_t offset_sig_validity);
2303
2304 #define gpgme_check_version(req_version)                                \
2305   gpgme_check_version_internal (req_version,                            \
2306                                 offsetof (struct _gpgme_signature, validity))
2307
2308 /* Return the default values for various directories.  */
2309 const char *gpgme_get_dirinfo (const char *what);
2310
2311 /* Get the information about the configured and installed engines.  A
2312    pointer to the first engine in the statically allocated linked list
2313    is returned in *INFO.  If an error occurs, it is returned.  The
2314    returned data is valid until the next gpgme_set_engine_info.  */
2315 gpgme_error_t gpgme_get_engine_info (gpgme_engine_info_t *engine_info);
2316
2317 /* Set the default engine info for the protocol PROTO to the file name
2318    FILE_NAME and the home directory HOME_DIR.  */
2319 gpgme_error_t gpgme_set_engine_info (gpgme_protocol_t proto,
2320                                      const char *file_name,
2321                                      const char *home_dir);
2322
2323 /* Verify that the engine implementing PROTO is installed and
2324    available.  */
2325 gpgme_error_t gpgme_engine_check_version (gpgme_protocol_t proto);
2326
2327
2328 /* Reference counting for result objects.  */
2329 void gpgme_result_ref (void *result);
2330 void gpgme_result_unref (void *result);
2331
2332 /* Return a public key algorithm string (e.g. "rsa2048").  Caller must
2333    free using gpgme_free.  */
2334 char *gpgme_pubkey_algo_string (gpgme_subkey_t subkey);
2335
2336 /* Return a statically allocated string with the name of the public
2337    key algorithm ALGO, or NULL if that name is not known.  */
2338 const char *gpgme_pubkey_algo_name (gpgme_pubkey_algo_t algo);
2339
2340 /* Return a statically allocated string with the name of the hash
2341    algorithm ALGO, or NULL if that name is not known.  */
2342 const char *gpgme_hash_algo_name (gpgme_hash_algo_t algo);
2343
2344
2345 \f
2346 /*
2347  * Deprecated types.
2348  */
2349 typedef gpgme_ctx_t GpgmeCtx _GPGME_DEPRECATED;
2350 typedef gpgme_data_t GpgmeData _GPGME_DEPRECATED;
2351 typedef gpgme_error_t GpgmeError _GPGME_DEPRECATED;
2352 typedef gpgme_data_encoding_t GpgmeDataEncoding _GPGME_DEPRECATED;
2353 typedef gpgme_pubkey_algo_t GpgmePubKeyAlgo _GPGME_DEPRECATED;
2354 typedef gpgme_hash_algo_t GpgmeHashAlgo _GPGME_DEPRECATED;
2355 typedef gpgme_sig_stat_t GpgmeSigStat _GPGME_DEPRECATED;
2356 typedef gpgme_sig_mode_t GpgmeSigMode _GPGME_DEPRECATED;
2357 typedef gpgme_attr_t GpgmeAttr _GPGME_DEPRECATED;
2358 typedef gpgme_validity_t GpgmeValidity _GPGME_DEPRECATED;
2359 typedef gpgme_protocol_t GpgmeProtocol _GPGME_DEPRECATED;
2360 typedef gpgme_engine_info_t GpgmeEngineInfo _GPGME_DEPRECATED;
2361 typedef gpgme_subkey_t GpgmeSubkey _GPGME_DEPRECATED;
2362 typedef gpgme_key_sig_t GpgmeKeySig _GPGME_DEPRECATED;
2363 typedef gpgme_user_id_t GpgmeUserID _GPGME_DEPRECATED;
2364 typedef gpgme_key_t GpgmeKey _GPGME_DEPRECATED;
2365 typedef gpgme_passphrase_cb_t GpgmePassphraseCb _GPGME_DEPRECATED;
2366 typedef gpgme_progress_cb_t GpgmeProgressCb _GPGME_DEPRECATED;
2367 typedef gpgme_io_cb_t GpgmeIOCb _GPGME_DEPRECATED;
2368 typedef gpgme_register_io_cb_t GpgmeRegisterIOCb _GPGME_DEPRECATED;
2369 typedef gpgme_remove_io_cb_t GpgmeRemoveIOCb _GPGME_DEPRECATED;
2370 typedef gpgme_event_io_t GpgmeEventIO _GPGME_DEPRECATED;
2371 typedef gpgme_event_io_cb_t GpgmeEventIOCb _GPGME_DEPRECATED;
2372 #define GpgmeIOCbs gpgme_io_cbs
2373 typedef gpgme_data_read_cb_t GpgmeDataReadCb _GPGME_DEPRECATED;
2374 typedef gpgme_data_write_cb_t GpgmeDataWriteCb _GPGME_DEPRECATED;
2375 typedef gpgme_data_seek_cb_t GpgmeDataSeekCb _GPGME_DEPRECATED;
2376 typedef gpgme_data_release_cb_t GpgmeDataReleaseCb _GPGME_DEPRECATED;
2377 #define GpgmeDataCbs gpgme_data_cbs
2378 typedef gpgme_encrypt_result_t GpgmeEncryptResult _GPGME_DEPRECATED;
2379 typedef gpgme_sig_notation_t GpgmeSigNotation _GPGME_DEPRECATED;
2380 typedef gpgme_signature_t GpgmeSignature _GPGME_DEPRECATED;
2381 typedef gpgme_verify_result_t GpgmeVerifyResult _GPGME_DEPRECATED;
2382 typedef gpgme_import_status_t GpgmeImportStatus _GPGME_DEPRECATED;
2383 typedef gpgme_import_result_t GpgmeImportResult _GPGME_DEPRECATED;
2384 typedef gpgme_genkey_result_t GpgmeGenKeyResult _GPGME_DEPRECATED;
2385 typedef gpgme_trust_item_t GpgmeTrustItem _GPGME_DEPRECATED;
2386 typedef gpgme_status_code_t GpgmeStatusCode _GPGME_DEPRECATED;
2387
2388 #ifdef __cplusplus
2389 }
2390 #endif
2391 #endif /* GPGME_H */
2392 /*
2393 @emacs_local_vars_begin@
2394 @emacs_local_vars_read_only@
2395 @emacs_local_vars_end@
2396 */