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