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