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