doc/
[gpgme.git] / gpgme / gpgme.h
1 /* gpgme.h - Public interface to GnuPG Made Easy.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004 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, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
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 #ifdef __cplusplus
44 extern "C" {
45 #if 0 /* just to make Emacs auto-indent happy */
46 }
47 #endif
48 #endif /* __cplusplus */
49
50 #include <gpg-error.h>
51
52 \f
53 /* Check for compiler features.  */
54 #if __GNUC__
55 #define _GPGME_GCC_VERSION (__GNUC__ * 10000 \
56                             + __GNUC_MINOR__ * 100 \
57                             + __GNUC_PATCHLEVEL__)
58
59 #if _GPGME_GCC_VERSION > 30100
60 #define _GPGME_DEPRECATED       __attribute__ ((__deprecated__))
61 #endif
62 #endif
63
64 #ifndef _GPGME_DEPRECATED
65 #define _GPGME_DEPRECATED
66 #endif
67
68 \f
69 /* The version of this header should match the one of the library.  Do
70    not use this symbol in your application, use gpgme_check_version
71    instead.  The purpose of this macro is to let autoconf (using the
72    AM_PATH_GPGME macro) check that this header matches the installed
73    library.  Warning: Do not edit the next line.  configure will do
74    that for you!  */
75 #define GPGME_VERSION "1.1.0-cvs"
76
77
78 \f
79 /* Some opaque data types used by GPGME.  */
80
81 /* The context holds some global state and configration options, as
82    well as the results of a crypto operation.  */
83 struct gpgme_context;
84 typedef struct gpgme_context *gpgme_ctx_t;
85
86 /* The data object is used by GPGME to exchange arbitrary data.  */
87 struct gpgme_data;
88 typedef struct gpgme_data *gpgme_data_t;
89
90 \f
91 /* Wrappers for the libgpg-error library.  */
92
93 typedef gpg_error_t gpgme_error_t;
94 typedef gpg_err_code_t gpgme_err_code_t;
95 typedef gpg_err_source_t gpgme_err_source_t;
96
97
98 static _GPGME_INLINE gpgme_error_t
99 gpgme_err_make (gpgme_err_source_t source, gpgme_err_code_t code)
100 {
101   return gpg_err_make (source, code);
102 }
103
104
105 /* The user can define GPGME_ERR_SOURCE_DEFAULT before including this
106    file to specify a default source for gpgme_error.  */
107 #ifndef GPGME_ERR_SOURCE_DEFAULT
108 #define GPGME_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
109 #endif
110
111 static _GPGME_INLINE gpgme_error_t
112 gpgme_error (gpgme_err_code_t code)
113 {
114   return gpgme_err_make (GPGME_ERR_SOURCE_DEFAULT, code);
115 }
116
117
118 static _GPGME_INLINE gpgme_err_code_t
119 gpgme_err_code (gpgme_error_t err)
120 {
121   return gpg_err_code (err);
122 }
123
124
125 static _GPGME_INLINE gpgme_err_source_t
126 gpgme_err_source (gpgme_error_t err)
127 {
128   return gpg_err_source (err);
129 }
130
131
132 /* Return a pointer to a string containing a description of the error
133    code in the error value ERR.  This function is not thread safe.  */
134 const char *gpgme_strerror (gpgme_error_t err);
135
136 /* Return the error string for ERR in the user-supplied buffer BUF of
137    size BUFLEN.  This function is, in contrast to gpg_strerror,
138    thread-safe if a thread-safe strerror_r() function is provided by
139    the system.  If the function succeeds, 0 is returned and BUF
140    contains the string describing the error.  If the buffer was not
141    large enough, ERANGE is returned and BUF contains as much of the
142    beginning of the error string as fits into the buffer.  */
143 int gpgme_strerror_r (gpg_error_t err, char *buf, size_t buflen);
144
145
146 /* Return a pointer to a string containing a description of the error
147    source in the error value ERR.  */
148 const char *gpgme_strsource (gpgme_error_t err);
149
150
151 /* Retrieve the error code for the system error ERR.  This returns
152    GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
153    this).  */
154 gpgme_err_code_t gpgme_err_code_from_errno (int err);
155
156
157 /* Retrieve the system error for the error code CODE.  This returns 0
158    if CODE is not a system error code.  */
159 int gpgme_err_code_to_errno (gpgme_err_code_t code);
160
161   
162 /* Return an error value with the error source SOURCE and the system
163    error ERR.  */
164 gpgme_error_t gpgme_err_make_from_errno (gpgme_err_source_t source, int err);
165
166
167 /* Return an error value with the system error ERR.  */
168 gpgme_err_code_t gpgme_error_from_errno (int err);
169
170 \f
171 /* The possible encoding mode of gpgme_data_t objects.  */
172 typedef enum
173   {
174     GPGME_DATA_ENCODING_NONE   = 0,     /* Not specified.  */
175     GPGME_DATA_ENCODING_BINARY = 1,
176     GPGME_DATA_ENCODING_BASE64 = 2,
177     GPGME_DATA_ENCODING_ARMOR  = 3      /* Either PEM or OpenPGP Armor.  */
178   }
179 gpgme_data_encoding_t;
180
181 \f
182 /* Public key algorithms from libgcrypt.  */
183 typedef enum
184   {
185     GPGME_PK_RSA   = 1,
186     GPGME_PK_RSA_E = 2,
187     GPGME_PK_RSA_S = 3,
188     GPGME_PK_ELG_E = 16,
189     GPGME_PK_DSA   = 17,
190     GPGME_PK_ELG   = 20
191   }
192 gpgme_pubkey_algo_t;
193
194
195 /* Hash algorithms from libgcrypt.  */
196 typedef enum
197   {
198     GPGME_MD_NONE          = 0,  
199     GPGME_MD_MD5           = 1,
200     GPGME_MD_SHA1          = 2,
201     GPGME_MD_RMD160        = 3,
202     GPGME_MD_MD2           = 5,
203     GPGME_MD_TIGER         = 6,   /* TIGER/192. */
204     GPGME_MD_HAVAL         = 7,   /* HAVAL, 5 pass, 160 bit. */
205     GPGME_MD_SHA256        = 8,
206     GPGME_MD_SHA384        = 9,
207     GPGME_MD_SHA512        = 10,
208     GPGME_MD_MD4           = 301,
209     GPGME_MD_CRC32         = 302,
210     GPGME_MD_CRC32_RFC1510 = 303,
211     GPGME_MD_CRC24_RFC2440 = 304
212   }
213 gpgme_hash_algo_t;
214
215 \f
216 /* The possible signature stati.  Deprecated, use error value in sig
217    status.  */
218 typedef enum
219   {
220     GPGME_SIG_STAT_NONE  = 0,
221     GPGME_SIG_STAT_GOOD  = 1,
222     GPGME_SIG_STAT_BAD   = 2,
223     GPGME_SIG_STAT_NOKEY = 3,
224     GPGME_SIG_STAT_NOSIG = 4,
225     GPGME_SIG_STAT_ERROR = 5,
226     GPGME_SIG_STAT_DIFF  = 6,
227     GPGME_SIG_STAT_GOOD_EXP = 7,
228     GPGME_SIG_STAT_GOOD_EXPKEY = 8
229   }
230 _gpgme_sig_stat_t;
231 typedef _gpgme_sig_stat_t gpgme_sig_stat_t _GPGME_DEPRECATED;
232
233
234 /* The available signature modes.  */
235 typedef enum
236   {
237     GPGME_SIG_MODE_NORMAL = 0,
238     GPGME_SIG_MODE_DETACH = 1,
239     GPGME_SIG_MODE_CLEAR  = 2
240   }
241 gpgme_sig_mode_t;
242
243 \f
244 /* The available key and signature attributes.  Deprecated, use the
245    individual result structures instead.  */
246 typedef enum
247   {
248     GPGME_ATTR_KEYID        = 1,
249     GPGME_ATTR_FPR          = 2,
250     GPGME_ATTR_ALGO         = 3,
251     GPGME_ATTR_LEN          = 4,
252     GPGME_ATTR_CREATED      = 5,
253     GPGME_ATTR_EXPIRE       = 6,
254     GPGME_ATTR_OTRUST       = 7,
255     GPGME_ATTR_USERID       = 8,
256     GPGME_ATTR_NAME         = 9,
257     GPGME_ATTR_EMAIL        = 10,
258     GPGME_ATTR_COMMENT      = 11,
259     GPGME_ATTR_VALIDITY     = 12,
260     GPGME_ATTR_LEVEL        = 13,
261     GPGME_ATTR_TYPE         = 14,
262     GPGME_ATTR_IS_SECRET    = 15,
263     GPGME_ATTR_KEY_REVOKED  = 16,
264     GPGME_ATTR_KEY_INVALID  = 17,
265     GPGME_ATTR_UID_REVOKED  = 18,
266     GPGME_ATTR_UID_INVALID  = 19,
267     GPGME_ATTR_KEY_CAPS     = 20,
268     GPGME_ATTR_CAN_ENCRYPT  = 21,
269     GPGME_ATTR_CAN_SIGN     = 22,
270     GPGME_ATTR_CAN_CERTIFY  = 23,
271     GPGME_ATTR_KEY_EXPIRED  = 24,
272     GPGME_ATTR_KEY_DISABLED = 25,
273     GPGME_ATTR_SERIAL       = 26,
274     GPGME_ATTR_ISSUER       = 27,
275     GPGME_ATTR_CHAINID      = 28,
276     GPGME_ATTR_SIG_STATUS   = 29,
277     GPGME_ATTR_ERRTOK       = 30,
278     GPGME_ATTR_SIG_SUMMARY  = 31,
279     GPGME_ATTR_SIG_CLASS    = 32
280   }
281 _gpgme_attr_t;
282 typedef _gpgme_attr_t gpgme_attr_t _GPGME_DEPRECATED;
283
284 \f
285 /* The available validities for a trust item or key.  */
286 typedef enum
287   {
288     GPGME_VALIDITY_UNKNOWN   = 0,
289     GPGME_VALIDITY_UNDEFINED = 1,
290     GPGME_VALIDITY_NEVER     = 2,
291     GPGME_VALIDITY_MARGINAL  = 3,
292     GPGME_VALIDITY_FULL      = 4,
293     GPGME_VALIDITY_ULTIMATE  = 5
294   }
295 gpgme_validity_t;
296
297 \f
298 /* The available protocols.  */
299 typedef enum
300   {
301     GPGME_PROTOCOL_OpenPGP = 0,  /* The default mode.  */
302     GPGME_PROTOCOL_CMS     = 1
303   }
304 gpgme_protocol_t;
305
306 \f
307 /* The available keylist mode flags.  */
308 #define GPGME_KEYLIST_MODE_LOCAL        1
309 #define GPGME_KEYLIST_MODE_EXTERN       2
310 #define GPGME_KEYLIST_MODE_SIGS         4
311 #define GPGME_KEYLIST_MODE_VALIDATE     256
312
313 typedef unsigned int gpgme_keylist_mode_t;
314
315 \f
316 /* The possible stati for the edit operation.  */
317 typedef enum
318   {
319     GPGME_STATUS_EOF,
320     /* mkstatus processing starts here */
321     GPGME_STATUS_ENTER,
322     GPGME_STATUS_LEAVE,
323     GPGME_STATUS_ABORT,
324
325     GPGME_STATUS_GOODSIG,
326     GPGME_STATUS_BADSIG,
327     GPGME_STATUS_ERRSIG,
328
329     GPGME_STATUS_BADARMOR,
330
331     GPGME_STATUS_RSA_OR_IDEA,
332     GPGME_STATUS_KEYEXPIRED,
333     GPGME_STATUS_KEYREVOKED,
334
335     GPGME_STATUS_TRUST_UNDEFINED,
336     GPGME_STATUS_TRUST_NEVER,
337     GPGME_STATUS_TRUST_MARGINAL,
338     GPGME_STATUS_TRUST_FULLY,
339     GPGME_STATUS_TRUST_ULTIMATE,
340
341     GPGME_STATUS_SHM_INFO,
342     GPGME_STATUS_SHM_GET,
343     GPGME_STATUS_SHM_GET_BOOL,
344     GPGME_STATUS_SHM_GET_HIDDEN,
345
346     GPGME_STATUS_NEED_PASSPHRASE,
347     GPGME_STATUS_VALIDSIG,
348     GPGME_STATUS_SIG_ID,
349     GPGME_STATUS_ENC_TO,
350     GPGME_STATUS_NODATA,
351     GPGME_STATUS_BAD_PASSPHRASE,
352     GPGME_STATUS_NO_PUBKEY,
353     GPGME_STATUS_NO_SECKEY,
354     GPGME_STATUS_NEED_PASSPHRASE_SYM,
355     GPGME_STATUS_DECRYPTION_FAILED,
356     GPGME_STATUS_DECRYPTION_OKAY,
357     GPGME_STATUS_MISSING_PASSPHRASE,
358     GPGME_STATUS_GOOD_PASSPHRASE,
359     GPGME_STATUS_GOODMDC,
360     GPGME_STATUS_BADMDC,
361     GPGME_STATUS_ERRMDC,
362     GPGME_STATUS_IMPORTED,
363     GPGME_STATUS_IMPORT_OK,
364     GPGME_STATUS_IMPORT_PROBLEM,
365     GPGME_STATUS_IMPORT_RES,
366     GPGME_STATUS_FILE_START,
367     GPGME_STATUS_FILE_DONE,
368     GPGME_STATUS_FILE_ERROR,
369
370     GPGME_STATUS_BEGIN_DECRYPTION,
371     GPGME_STATUS_END_DECRYPTION,
372     GPGME_STATUS_BEGIN_ENCRYPTION,
373     GPGME_STATUS_END_ENCRYPTION,
374
375     GPGME_STATUS_DELETE_PROBLEM,
376     GPGME_STATUS_GET_BOOL,
377     GPGME_STATUS_GET_LINE,
378     GPGME_STATUS_GET_HIDDEN,
379     GPGME_STATUS_GOT_IT,
380     GPGME_STATUS_PROGRESS,
381     GPGME_STATUS_SIG_CREATED,
382     GPGME_STATUS_SESSION_KEY,
383     GPGME_STATUS_NOTATION_NAME,
384     GPGME_STATUS_NOTATION_DATA,
385     GPGME_STATUS_POLICY_URL,
386     GPGME_STATUS_BEGIN_STREAM,
387     GPGME_STATUS_END_STREAM,
388     GPGME_STATUS_KEY_CREATED,
389     GPGME_STATUS_USERID_HINT,
390     GPGME_STATUS_UNEXPECTED,
391     GPGME_STATUS_INV_RECP,
392     GPGME_STATUS_NO_RECP,
393     GPGME_STATUS_ALREADY_SIGNED,
394     GPGME_STATUS_SIGEXPIRED,
395     GPGME_STATUS_EXPSIG,
396     GPGME_STATUS_EXPKEYSIG,
397     GPGME_STATUS_TRUNCATED,
398     GPGME_STATUS_ERROR,
399     GPGME_STATUS_NEWSIG,
400     GPGME_STATUS_REVKEYSIG,
401     GPGME_STATUS_SIG_SUBPACKET,
402     GPGME_STATUS_NEED_PASSPHRASE_PIN,
403     GPGME_STATUS_SC_OP_FAILURE,
404     GPGME_STATUS_SC_OP_SUCCESS,
405     GPGME_STATUS_CARDCTRL,
406     GPGME_STATUS_BACKUP_KEY_CREATED,
407
408     GPGME_STATUS_PLAINTEXT
409   }
410 gpgme_status_code_t;
411
412 \f
413 /* The engine information structure.  */
414 struct _gpgme_engine_info
415 {
416   struct _gpgme_engine_info *next;
417
418   /* The protocol ID.  */
419   gpgme_protocol_t protocol;
420
421   /* The file name of the engine binary.  */
422   char *file_name;
423   
424   /* The version string of the installed engine.  */
425   char *version;
426
427   /* The minimum version required for GPGME.  */
428   const char *req_version;
429
430   /* The home directory used, or NULL if default.  */
431   char *home_dir;
432 };
433 typedef struct _gpgme_engine_info *gpgme_engine_info_t;
434
435 \f
436 /* A subkey from a key.  */
437 struct _gpgme_subkey
438 {
439   struct _gpgme_subkey *next;
440
441   /* True if subkey is revoked.  */
442   unsigned int revoked : 1;
443
444   /* True if subkey is expired.  */
445   unsigned int expired : 1;
446
447   /* True if subkey is disabled.  */
448   unsigned int disabled : 1;
449
450   /* True if subkey is invalid.  */
451   unsigned int invalid : 1;
452
453   /* True if subkey can be used for encryption.  */
454   unsigned int can_encrypt : 1;
455
456   /* True if subkey can be used for signing.  */
457   unsigned int can_sign : 1;
458
459   /* True if subkey can be used for certification.  */
460   unsigned int can_certify : 1;
461
462   /* True if subkey is secret.  */
463   unsigned int secret : 1;
464
465   /* True if subkey can be used for authentication.  */
466   unsigned int can_authenticate : 1;
467
468   /* Internal to GPGME, do not use.  */
469   unsigned int _unused : 23;
470   
471   /* Public key algorithm supported by this subkey.  */
472   gpgme_pubkey_algo_t pubkey_algo;
473
474   /* Length of the subkey.  */
475   unsigned int length;
476
477   /* The key ID of the subkey.  */
478   char *keyid;
479
480   /* Internal to GPGME, do not use.  */
481   char _keyid[16 + 1];
482
483   /* The fingerprint of the subkey in hex digit form.  */
484   char *fpr;
485
486   /* The creation timestamp, -1 if invalid, 0 if not available.  */
487   long int timestamp;
488
489   /* The expiration timestamp, 0 if the subkey does not expire.  */
490   long int expires;
491 };
492 typedef struct _gpgme_subkey *gpgme_subkey_t;
493
494
495 /* A signature on a user ID.  */
496 struct _gpgme_key_sig
497 {
498   struct _gpgme_key_sig *next;
499
500   /* True if the signature is a revocation signature.  */
501   unsigned int revoked : 1;
502
503   /* True if the signature is expired.  */
504   unsigned int expired : 1;
505
506   /* True if the signature is invalid.  */
507   unsigned int invalid : 1;
508
509   /* True if the signature should be exported.  */
510   unsigned int exportable : 1;
511
512   /* Internal to GPGME, do not use.  */
513   unsigned int _unused : 28;
514
515   /* The public key algorithm used to create the signature.  */
516   gpgme_pubkey_algo_t pubkey_algo;
517
518   /* The key ID of key used to create the signature.  */
519   char *keyid;
520
521   /* Internal to GPGME, do not use.  */
522   char _keyid[16 + 1];
523
524   /* The creation timestamp, -1 if invalid, 0 if not available.  */
525   long int timestamp;
526
527   /* The expiration timestamp, 0 if the subkey does not expire.  */
528   long int expires;
529
530   /* Same as in gpgme_signature_t.  */
531   gpgme_error_t status;
532
533 #ifdef __cplusplus
534   unsigned int _obsolete_class _GPGME_DEPRECATED;
535 #else
536   /* Must be set to SIG_CLASS below.  */
537   unsigned int class _GPGME_DEPRECATED;
538 #endif
539
540   /* The user ID string.  */
541   char *uid;
542
543   /* The name part of the user ID.  */
544   char *name;
545
546   /* The email part of the user ID.  */
547   char *email;
548
549   /* The comment part of the user ID.  */
550   char *comment;
551
552   /* Crypto backend specific signature class.  */
553   unsigned int sig_class;
554 };
555 typedef struct _gpgme_key_sig *gpgme_key_sig_t;
556
557
558 /* An user ID from a key.  */
559 struct _gpgme_user_id
560 {
561   struct _gpgme_user_id *next;
562
563   /* True if the user ID is revoked.  */
564   unsigned int revoked : 1;
565
566   /* True if the user ID is invalid.  */
567   unsigned int invalid : 1;
568
569   /* Internal to GPGME, do not use.  */
570   unsigned int _unused : 30;
571
572   /* The validity of the user ID.  */
573   gpgme_validity_t validity; 
574
575   /* The user ID string.  */
576   char *uid;
577
578   /* The name part of the user ID.  */
579   char *name;
580
581   /* The email part of the user ID.  */
582   char *email;
583
584   /* The comment part of the user ID.  */
585   char *comment;
586
587   /* The signatures of the user ID.  */
588   gpgme_key_sig_t signatures;
589
590   /* Internal to GPGME, do not use.  */
591   gpgme_key_sig_t _last_keysig;
592 };
593 typedef struct _gpgme_user_id *gpgme_user_id_t;
594
595
596 /* A key from the keyring.  */
597 struct _gpgme_key
598 {
599   /* Internal to GPGME, do not use.  */
600   unsigned int _refs;
601
602   /* True if key is revoked.  */
603   unsigned int revoked : 1;
604
605   /* True if key is expired.  */
606   unsigned int expired : 1;
607
608   /* True if key is disabled.  */
609   unsigned int disabled : 1;
610
611   /* True if key is invalid.  */
612   unsigned int invalid : 1;
613
614   /* True if key can be used for encryption.  */
615   unsigned int can_encrypt : 1;
616
617   /* True if key can be used for signing.  */
618   unsigned int can_sign : 1;
619
620   /* True if key can be used for certification.  */
621   unsigned int can_certify : 1;
622
623   /* True if key is secret.  */
624   unsigned int secret : 1;
625
626   /* True if key can be used for authentication.  */
627   unsigned int can_authenticate : 1;
628
629   /* Internal to GPGME, do not use.  */
630   unsigned int _unused : 23;
631
632   /* This is the protocol supported by this key.  */
633   gpgme_protocol_t protocol;
634
635   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
636      issuer serial.  */
637   char *issuer_serial;
638
639   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
640      issuer name.  */
641   char *issuer_name;
642
643   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the chain
644      ID.  */
645   char *chain_id;
646
647   /* If protocol is GPGME_PROTOCOL_OpenPGP, this field contains the
648      owner trust.  */
649   gpgme_validity_t owner_trust;
650
651   /* The subkeys of the key.  */
652   gpgme_subkey_t subkeys;
653
654   /* The user IDs of the key.  */
655   gpgme_user_id_t uids;
656
657   /* Internal to GPGME, do not use.  */
658   gpgme_subkey_t _last_subkey;
659
660   /* Internal to GPGME, do not use.  */
661   gpgme_user_id_t _last_uid;
662
663   /* The keylist mode that was active when listing the key.  */
664   gpgme_keylist_mode_t keylist_mode;
665 };
666 typedef struct _gpgme_key *gpgme_key_t;
667
668
669 \f
670 /* Types for callback functions.  */
671
672 /* Request a passphrase from the user.  */
673 typedef gpgme_error_t (*gpgme_passphrase_cb_t) (void *hook,
674                                                 const char *uid_hint,
675                                                 const char *passphrase_info,
676                                                 int prev_was_bad, int fd);
677
678 /* Inform the user about progress made.  */
679 typedef void (*gpgme_progress_cb_t) (void *opaque, const char *what,
680                                      int type, int current, int total);
681
682 /* Interact with the user about an edit operation.  */
683 typedef gpgme_error_t (*gpgme_edit_cb_t) (void *opaque,
684                                           gpgme_status_code_t status,
685                                           const char *args, int fd);
686
687 \f
688 /* Context management functions.  */
689
690 /* Create a new context and return it in CTX.  */
691 gpgme_error_t gpgme_new (gpgme_ctx_t *ctx);
692
693 /* Release the context CTX.  */
694 void gpgme_release (gpgme_ctx_t ctx);
695
696 /* Set the protocol to be used by CTX to PROTO.  */
697 gpgme_error_t gpgme_set_protocol (gpgme_ctx_t ctx, gpgme_protocol_t proto);
698
699 /* Get the protocol used with CTX */
700 gpgme_protocol_t gpgme_get_protocol (gpgme_ctx_t ctx);
701
702 /* Get the string describing protocol PROTO, or NULL if invalid.  */
703 const char *gpgme_get_protocol_name (gpgme_protocol_t proto);
704
705 /* If YES is non-zero, enable armor mode in CTX, disable it otherwise.  */
706 void gpgme_set_armor (gpgme_ctx_t ctx, int yes);
707
708 /* Return non-zero if armor mode is set in CTX.  */
709 int gpgme_get_armor (gpgme_ctx_t ctx);
710
711 /* If YES is non-zero, enable text mode in CTX, disable it otherwise.  */
712 void gpgme_set_textmode (gpgme_ctx_t ctx, int yes);
713
714 /* Return non-zero if text mode is set in CTX.  */
715 int gpgme_get_textmode (gpgme_ctx_t ctx);
716
717 /* Use whatever the default of the backend crypto engine is.  */
718 #define GPGME_INCLUDE_CERTS_DEFAULT     -256
719
720 /* Include up to NR_OF_CERTS certificates in an S/MIME message.  */
721 void gpgme_set_include_certs (gpgme_ctx_t ctx, int nr_of_certs);
722
723 /* Return the number of certs to include in an S/MIME message.  */
724 int gpgme_get_include_certs (gpgme_ctx_t ctx);
725
726 /* Set keylist mode in CTX to MODE.  */
727 gpgme_error_t gpgme_set_keylist_mode (gpgme_ctx_t ctx,
728                                       gpgme_keylist_mode_t mode);
729
730 /* Get keylist mode in CTX.  */
731 gpgme_keylist_mode_t gpgme_get_keylist_mode (gpgme_ctx_t ctx);
732
733 /* Set the passphrase callback function in CTX to CB.  HOOK_VALUE is
734    passed as first argument to the passphrase callback function.  */
735 void gpgme_set_passphrase_cb (gpgme_ctx_t ctx,
736                               gpgme_passphrase_cb_t cb, void *hook_value);
737
738 /* Get the current passphrase callback function in *CB and the current
739    hook value in *HOOK_VALUE.  */
740 void gpgme_get_passphrase_cb (gpgme_ctx_t ctx, gpgme_passphrase_cb_t *cb,
741                               void **hook_value);
742
743 /* Set the progress callback function in CTX to CB.  HOOK_VALUE is
744    passed as first argument to the progress callback function.  */
745 void gpgme_set_progress_cb (gpgme_ctx_t c, gpgme_progress_cb_t cb,
746                             void *hook_value);
747
748 /* Get the current progress callback function in *CB and the current
749    hook value in *HOOK_VALUE.  */
750 void gpgme_get_progress_cb (gpgme_ctx_t ctx, gpgme_progress_cb_t *cb,
751                             void **hook_value);
752
753 /* This function sets the locale for the context CTX, or the default
754    locale if CTX is a null pointer.  */
755 gpgme_error_t gpgme_set_locale (gpgme_ctx_t ctx, int category,
756                                 const char *value);
757
758 /* Get the information about the configured engines.  A pointer to the
759    first engine in the statically allocated linked list is returned.
760    The returned data is valid until the next gpgme_ctx_set_engine_info.  */
761 gpgme_engine_info_t gpgme_ctx_get_engine_info (gpgme_ctx_t ctx);
762
763 /* Set the engine info for the context CTX, protocol PROTO, to the
764    file name FILE_NAME and the home directory HOME_DIR.  */
765 gpgme_error_t gpgme_ctx_set_engine_info (gpgme_ctx_t ctx,
766                                          gpgme_protocol_t proto,
767                                          const char *file_name,
768                                          const char *home_dir);
769
770 \f
771 /* Return a statically allocated string with the name of the public
772    key algorithm ALGO, or NULL if that name is not known.  */
773 const char *gpgme_pubkey_algo_name (gpgme_pubkey_algo_t algo);
774
775 /* Return a statically allocated string with the name of the hash
776    algorithm ALGO, or NULL if that name is not known.  */
777 const char *gpgme_hash_algo_name (gpgme_hash_algo_t algo);
778
779 \f
780 /* Delete all signers from CTX.  */
781 void gpgme_signers_clear (gpgme_ctx_t ctx);
782
783 /* Add KEY to list of signers in CTX.  */
784 gpgme_error_t gpgme_signers_add (gpgme_ctx_t ctx, const gpgme_key_t key);
785
786 /* Return the SEQth signer's key in CTX.  */
787 gpgme_key_t gpgme_signers_enum (const gpgme_ctx_t ctx, int seq);
788
789 /* Retrieve the signature status of signature IDX in CTX after a
790    successful verify operation in R_STAT (if non-null).  The creation
791    time stamp of the signature is returned in R_CREATED (if non-null).
792    The function returns a string containing the fingerprint.
793    Deprecated, use verify result directly.  */
794 const char *gpgme_get_sig_status (gpgme_ctx_t ctx, int idx,
795                                   _gpgme_sig_stat_t *r_stat,
796                                   time_t *r_created) _GPGME_DEPRECATED;
797
798 /* Retrieve certain attributes of a signature.  IDX is the index
799    number of the signature after a successful verify operation.  WHAT
800    is an attribute where GPGME_ATTR_EXPIRE is probably the most useful
801    one.  WHATIDX is to be passed as 0 for most attributes . */
802 unsigned long gpgme_get_sig_ulong_attr (gpgme_ctx_t c, int idx,
803                                         _gpgme_attr_t what, int whatidx)
804      _GPGME_DEPRECATED;
805 const char *gpgme_get_sig_string_attr (gpgme_ctx_t c, int idx,
806                                        _gpgme_attr_t what, int whatidx)
807      _GPGME_DEPRECATED;
808
809
810 /* Get the key used to create signature IDX in CTX and return it in
811    R_KEY.  */
812 gpgme_error_t gpgme_get_sig_key (gpgme_ctx_t ctx, int idx, gpgme_key_t *r_key)
813      _GPGME_DEPRECATED;
814
815 \f
816 /* Run control.  */
817
818 /* The type of an I/O callback function.  */
819 typedef gpgme_error_t (*gpgme_io_cb_t) (void *data, int fd);
820
821 /* The type of a function that can register FNC as the I/O callback
822    function for the file descriptor FD with direction dir (0: for writing,
823    1: for reading).  FNC_DATA should be passed as DATA to FNC.  The
824    function should return a TAG suitable for the corresponding
825    gpgme_remove_io_cb_t, and an error value.  */
826 typedef gpgme_error_t (*gpgme_register_io_cb_t) (void *data, int fd, int dir,
827                                                  gpgme_io_cb_t fnc,
828                                                  void *fnc_data, void **tag);
829
830 /* The type of a function that can remove a previously registered I/O
831    callback function given TAG as returned by the register
832    function.  */
833 typedef void (*gpgme_remove_io_cb_t) (void *tag);
834
835 typedef enum
836   {
837     GPGME_EVENT_START,
838     GPGME_EVENT_DONE,
839     GPGME_EVENT_NEXT_KEY,
840     GPGME_EVENT_NEXT_TRUSTITEM
841   }
842 gpgme_event_io_t;
843
844 /* The type of a function that is called when a context finished an
845    operation.  */
846 typedef void (*gpgme_event_io_cb_t) (void *data, gpgme_event_io_t type,
847                                      void *type_data);
848
849 struct gpgme_io_cbs
850 {
851   gpgme_register_io_cb_t add;
852   void *add_priv;
853   gpgme_remove_io_cb_t remove;
854   gpgme_event_io_cb_t event;
855   void *event_priv;
856 };
857 typedef struct gpgme_io_cbs *gpgme_io_cbs_t;
858
859 /* Set the I/O callback functions in CTX to IO_CBS.  */
860 void gpgme_set_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
861
862 /* Get the current I/O callback functions.  */
863 void gpgme_get_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
864
865 /* Process the pending operation and, if HANG is non-zero, wait for
866    the pending operation to finish.  */
867 gpgme_ctx_t gpgme_wait (gpgme_ctx_t ctx, gpgme_error_t *status, int hang);
868
869 \f
870 /* Functions to handle data objects.  */
871
872 /* Read up to SIZE bytes into buffer BUFFER from the data object with
873    the handle HANDLE.  Return the number of characters read, 0 on EOF
874    and -1 on error.  If an error occurs, errno is set.  */
875 typedef ssize_t (*gpgme_data_read_cb_t) (void *handle, void *buffer,
876                                          size_t size);
877
878 /* Write up to SIZE bytes from buffer BUFFER to the data object with
879    the handle HANDLE.  Return the number of characters written, or -1
880    on error.  If an error occurs, errno is set.  */
881 typedef ssize_t (*gpgme_data_write_cb_t) (void *handle, const void *buffer,
882                                           size_t size);
883
884 /* Set the current position from where the next read or write starts
885    in the data object with the handle HANDLE to OFFSET, relativ to
886    WHENCE.  */
887 typedef off_t (*gpgme_data_seek_cb_t) (void *handle, off_t offset, int whence);
888
889 /* Close the data object with the handle DL.  */
890 typedef void (*gpgme_data_release_cb_t) (void *handle);
891
892 struct gpgme_data_cbs
893 {
894   gpgme_data_read_cb_t read;
895   gpgme_data_write_cb_t write;
896   gpgme_data_seek_cb_t seek;
897   gpgme_data_release_cb_t release;
898 };
899 typedef struct gpgme_data_cbs *gpgme_data_cbs_t;
900
901 /* Read up to SIZE bytes into buffer BUFFER from the data object with
902    the handle DH.  Return the number of characters read, 0 on EOF and
903    -1 on error.  If an error occurs, errno is set.  */
904 ssize_t gpgme_data_read (gpgme_data_t dh, void *buffer, size_t size);
905
906 /* Write up to SIZE bytes from buffer BUFFER to the data object with
907    the handle DH.  Return the number of characters written, or -1 on
908    error.  If an error occurs, errno is set.  */
909 ssize_t gpgme_data_write (gpgme_data_t dh, const void *buffer, size_t size);
910
911 /* Set the current position from where the next read or write starts
912    in the data object with the handle DH to OFFSET, relativ to
913    WHENCE.  */
914 off_t gpgme_data_seek (gpgme_data_t dh, off_t offset, int whence);
915
916 /* Create a new data buffer and return it in R_DH.  */
917 gpgme_error_t gpgme_data_new (gpgme_data_t *r_dh);
918
919 /* Destroy the data buffer DH.  */
920 void gpgme_data_release (gpgme_data_t dh);
921
922 /* Create a new data buffer filled with SIZE bytes starting from
923    BUFFER.  If COPY is zero, copying is delayed until necessary, and
924    the data is taken from the original location when needed.  */
925 gpgme_error_t gpgme_data_new_from_mem (gpgme_data_t *r_dh,
926                                        const char *buffer, size_t size,
927                                        int copy);
928
929 /* Destroy the data buffer DH and return a pointer to its content.
930    The memory has be to released with free by the user.  It's size is
931    returned in R_LEN.  */
932 char *gpgme_data_release_and_get_mem (gpgme_data_t dh, size_t *r_len);
933
934 gpgme_error_t gpgme_data_new_from_cbs (gpgme_data_t *dh,
935                                        gpgme_data_cbs_t cbs,
936                                        void *handle);
937
938 gpgme_error_t gpgme_data_new_from_fd (gpgme_data_t *dh, int fd);
939
940 gpgme_error_t gpgme_data_new_from_stream (gpgme_data_t *dh, FILE *stream);
941
942 /* Return the encoding attribute of the data buffer DH */
943 gpgme_data_encoding_t gpgme_data_get_encoding (gpgme_data_t dh);
944
945 /* Set the encoding attribute of data buffer DH to ENC */
946 gpgme_error_t gpgme_data_set_encoding (gpgme_data_t dh,
947                                        gpgme_data_encoding_t enc);
948
949
950
951 /* Create a new data buffer which retrieves the data from the callback
952    function READ_CB.  Deprecated, please use gpgme_data_new_from_cbs
953    instead.  */
954 gpgme_error_t gpgme_data_new_with_read_cb (gpgme_data_t *r_dh,
955                                            int (*read_cb) (void*,char *,
956                                                            size_t,size_t*),
957                                            void *read_cb_value)
958      _GPGME_DEPRECATED;
959
960 /* Create a new data buffer filled with the content of file FNAME.
961    COPY must be non-zero.  For delayed read, please use
962    gpgme_data_new_from_fd or gpgme_data_new_from stream instead.  */
963 gpgme_error_t gpgme_data_new_from_file (gpgme_data_t *r_dh,
964                                         const char *fname,
965                                         int copy);
966
967 /* Create a new data buffer filled with LENGTH bytes starting from
968    OFFSET within the file FNAME or stream FP (exactly one must be
969    non-zero).  */
970 gpgme_error_t gpgme_data_new_from_filepart (gpgme_data_t *r_dh,
971                                             const char *fname, FILE *fp,
972                                             off_t offset, size_t length);
973
974 /* Reset the read pointer in DH.  Deprecated, please use
975    gpgme_data_seek instead.  */
976 gpgme_error_t gpgme_data_rewind (gpgme_data_t dh) _GPGME_DEPRECATED;
977
978 \f
979 /* Key and trust functions.  */
980
981 /* Get the key with the fingerprint FPR from the crypto backend.  If
982    SECRET is true, get the secret key.  */
983 gpgme_error_t gpgme_get_key (gpgme_ctx_t ctx, const char *fpr,
984                              gpgme_key_t *r_key, int secret);
985
986 /* Acquire a reference to KEY.  */
987 void gpgme_key_ref (gpgme_key_t key);
988
989 /* Release a reference to KEY.  If this was the last one the key is
990    destroyed.  */
991 void gpgme_key_unref (gpgme_key_t key);
992 void gpgme_key_release (gpgme_key_t key);
993
994 /* Return the value of the attribute WHAT of KEY, which has to be
995    representable by a string.  IDX specifies the sub key or user ID
996    for attributes related to sub keys or user IDs.  Deprecated, use
997    key structure directly instead. */
998 const char *gpgme_key_get_string_attr (gpgme_key_t key, _gpgme_attr_t what,
999                                        const void *reserved, int idx)
1000      _GPGME_DEPRECATED;
1001
1002 /* Return the value of the attribute WHAT of KEY, which has to be
1003    representable by an unsigned integer.  IDX specifies the sub key or
1004    user ID for attributes related to sub keys or user IDs.
1005    Deprecated, use key structure directly instead.  */
1006 unsigned long gpgme_key_get_ulong_attr (gpgme_key_t key, _gpgme_attr_t what,
1007                                         const void *reserved, int idx)
1008      _GPGME_DEPRECATED;
1009
1010 /* Return the value of the attribute WHAT of a signature on user ID
1011    UID_IDX in KEY, which has to be representable by a string.  IDX
1012    specifies the signature.  Deprecated, use key structure directly
1013    instead.  */
1014 const char *gpgme_key_sig_get_string_attr (gpgme_key_t key, int uid_idx,
1015                                            _gpgme_attr_t what,
1016                                            const void *reserved, int idx)
1017      _GPGME_DEPRECATED;
1018
1019 /* Return the value of the attribute WHAT of a signature on user ID
1020    UID_IDX in KEY, which has to be representable by an unsigned
1021    integer string.  IDX specifies the signature.  Deprecated, use key
1022    structure directly instead.  */
1023 unsigned long gpgme_key_sig_get_ulong_attr (gpgme_key_t key, int uid_idx,
1024                                             _gpgme_attr_t what,
1025                                             const void *reserved, int idx)
1026      _GPGME_DEPRECATED;
1027
1028 \f
1029 /* Crypto Operations.  */
1030
1031 /* Cancel a pending asynchronous operation.  */
1032 gpgme_error_t gpgme_cancel (gpgme_ctx_t ctx);
1033
1034 \f
1035 struct _gpgme_invalid_key
1036 {
1037   struct _gpgme_invalid_key *next;
1038   char *fpr;
1039   gpgme_error_t reason;
1040 };
1041 typedef struct _gpgme_invalid_key *gpgme_invalid_key_t;
1042
1043 \f
1044 /* Encryption.  */
1045 struct _gpgme_op_encrypt_result
1046 {
1047   /* The list of invalid recipients.  */
1048   gpgme_invalid_key_t invalid_recipients;
1049 };
1050 typedef struct _gpgme_op_encrypt_result *gpgme_encrypt_result_t;
1051
1052 /* Retrieve a pointer to the result of the encrypt operation.  */
1053 gpgme_encrypt_result_t gpgme_op_encrypt_result (gpgme_ctx_t ctx);
1054
1055 /* The valid encryption flags.  */
1056 typedef enum
1057   {
1058     GPGME_ENCRYPT_ALWAYS_TRUST = 1
1059   }
1060 gpgme_encrypt_flags_t;
1061
1062 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1063    store the resulting ciphertext in CIPHER.  */
1064 gpgme_error_t gpgme_op_encrypt_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
1065                                       gpgme_encrypt_flags_t flags,
1066                                       gpgme_data_t plain, gpgme_data_t cipher);
1067 gpgme_error_t gpgme_op_encrypt (gpgme_ctx_t ctx, gpgme_key_t recp[],
1068                                 gpgme_encrypt_flags_t flags,
1069                                 gpgme_data_t plain, gpgme_data_t cipher);
1070
1071 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1072    store the resulting ciphertext in CIPHER.  Also sign the ciphertext
1073    with the signers in CTX.  */
1074 gpgme_error_t gpgme_op_encrypt_sign_start (gpgme_ctx_t ctx,
1075                                            gpgme_key_t recp[],
1076                                            gpgme_encrypt_flags_t flags,
1077                                            gpgme_data_t plain,
1078                                            gpgme_data_t cipher);
1079 gpgme_error_t gpgme_op_encrypt_sign (gpgme_ctx_t ctx, gpgme_key_t recp[],
1080                                      gpgme_encrypt_flags_t flags,
1081                                      gpgme_data_t plain, gpgme_data_t cipher);
1082
1083 \f
1084 /* Decryption.  */
1085
1086 struct _gpgme_recipient
1087 {
1088   struct _gpgme_recipient *next;
1089
1090   /* The key ID of key for which the text was encrypted.  */
1091   char *keyid;
1092
1093   /* Internal to GPGME, do not use.  */
1094   char _keyid[16 + 1];
1095
1096   /* The public key algorithm of the recipient key.  */
1097   gpgme_pubkey_algo_t pubkey_algo;
1098
1099   /* The status of the recipient.  */
1100   gpgme_error_t status;
1101 };
1102 typedef struct _gpgme_recipient *gpgme_recipient_t;
1103
1104 struct _gpgme_op_decrypt_result
1105 {
1106   char *unsupported_algorithm;
1107
1108   /* Key should not have been used for encryption.  */
1109   unsigned int wrong_key_usage : 1;
1110
1111   /* Internal to GPGME, do not use.  */
1112   int _unused : 31;
1113
1114   gpgme_recipient_t recipients;
1115
1116   /* The original filename of the plaintext message, if available.  */
1117   char *plaintext_filename;
1118 };
1119 typedef struct _gpgme_op_decrypt_result *gpgme_decrypt_result_t;
1120
1121 /* Retrieve a pointer to the result of the decrypt operation.  */
1122 gpgme_decrypt_result_t gpgme_op_decrypt_result (gpgme_ctx_t ctx);
1123
1124 /* Decrypt ciphertext CIPHER within CTX and store the resulting
1125    plaintext in PLAIN.  */
1126 gpgme_error_t gpgme_op_decrypt_start (gpgme_ctx_t ctx, gpgme_data_t cipher,
1127                                       gpgme_data_t plain);
1128 gpgme_error_t gpgme_op_decrypt (gpgme_ctx_t ctx,
1129                                 gpgme_data_t cipher, gpgme_data_t plain);
1130
1131 /* Decrypt ciphertext CIPHER and make a signature verification within
1132    CTX and store the resulting plaintext in PLAIN.  */
1133 gpgme_error_t gpgme_op_decrypt_verify_start (gpgme_ctx_t ctx,
1134                                              gpgme_data_t cipher,
1135                                              gpgme_data_t plain);
1136 gpgme_error_t gpgme_op_decrypt_verify (gpgme_ctx_t ctx, gpgme_data_t cipher,
1137                                        gpgme_data_t plain);
1138
1139 \f
1140 /* Signing.  */
1141 struct _gpgme_new_signature
1142 {
1143   struct _gpgme_new_signature *next;
1144
1145   /* The type of the signature.  */
1146   gpgme_sig_mode_t type;
1147
1148   /* The public key algorithm used to create the signature.  */
1149   gpgme_pubkey_algo_t pubkey_algo;
1150
1151   /* The hash algorithm used to create the signature.  */
1152   gpgme_hash_algo_t hash_algo;
1153
1154   /* Internal to GPGME, do not use.  Must be set to the same value as
1155      CLASS below.  */
1156   unsigned long _obsolete_class;
1157
1158   /* Signature creation time.  */
1159   long int timestamp;
1160
1161   /* The fingerprint of the signature.  */
1162   char *fpr;
1163
1164 #ifdef __cplusplus
1165   unsigned int _obsolete_class_2;
1166 #else
1167   /* Must be set to SIG_CLASS below.  */
1168   unsigned int class _GPGME_DEPRECATED;
1169 #endif
1170
1171   /* Crypto backend specific signature class.  */
1172   unsigned int sig_class;
1173 };
1174 typedef struct _gpgme_new_signature *gpgme_new_signature_t;
1175
1176 struct _gpgme_op_sign_result
1177 {
1178   /* The list of invalid signers.  */
1179   gpgme_invalid_key_t invalid_signers;
1180   gpgme_new_signature_t signatures;
1181 };
1182 typedef struct _gpgme_op_sign_result *gpgme_sign_result_t;
1183
1184 /* Retrieve a pointer to the result of the signing operation.  */
1185 gpgme_sign_result_t gpgme_op_sign_result (gpgme_ctx_t ctx);
1186
1187 /* Sign the plaintext PLAIN and store the signature in SIG.  */
1188 gpgme_error_t gpgme_op_sign_start (gpgme_ctx_t ctx,
1189                                    gpgme_data_t plain, gpgme_data_t sig,
1190                                    gpgme_sig_mode_t mode);
1191 gpgme_error_t gpgme_op_sign (gpgme_ctx_t ctx,
1192                              gpgme_data_t plain, gpgme_data_t sig,
1193                              gpgme_sig_mode_t mode);
1194
1195 \f
1196 /* Verify.  */
1197 struct _gpgme_sig_notation
1198 {
1199   struct _gpgme_sig_notation *next;
1200
1201   /* If NAME is a null pointer, then VALUE contains a policy URL
1202      rather than a notation.  */
1203   char *name;
1204   char *value;
1205 };
1206 typedef struct _gpgme_sig_notation *gpgme_sig_notation_t;
1207
1208 /* Flags used for the SUMMARY field in a gpgme_signature_t.  */
1209 typedef enum
1210   {
1211     GPGME_SIGSUM_VALID       = 0x0001,  /* The signature is fully valid.  */
1212     GPGME_SIGSUM_GREEN       = 0x0002,  /* The signature is good.  */
1213     GPGME_SIGSUM_RED         = 0x0004,  /* The signature is bad.  */
1214     GPGME_SIGSUM_KEY_REVOKED = 0x0010,  /* One key has been revoked.  */
1215     GPGME_SIGSUM_KEY_EXPIRED = 0x0020,  /* One key has expired.  */
1216     GPGME_SIGSUM_SIG_EXPIRED = 0x0040,  /* The signature has expired.  */
1217     GPGME_SIGSUM_KEY_MISSING = 0x0080,  /* Can't verify: key missing.  */
1218     GPGME_SIGSUM_CRL_MISSING = 0x0100,  /* CRL not available.  */
1219     GPGME_SIGSUM_CRL_TOO_OLD = 0x0200,  /* Available CRL is too old.  */
1220     GPGME_SIGSUM_BAD_POLICY  = 0x0400,  /* A policy was not met.  */
1221     GPGME_SIGSUM_SYS_ERROR   = 0x0800   /* A system error occured.  */
1222   }
1223 gpgme_sigsum_t;
1224
1225 struct _gpgme_signature
1226 {
1227   struct _gpgme_signature *next;
1228
1229   /* A summary of the signature status.  */
1230   gpgme_sigsum_t summary;
1231
1232   /* The fingerprint or key ID of the signature.  */
1233   char *fpr;
1234
1235   /* The status of the signature.  */
1236   gpgme_error_t status;
1237
1238   /* Notation data and policy URLs.  */
1239   gpgme_sig_notation_t notations;
1240
1241   /* Signature creation time.  */
1242   unsigned long timestamp;
1243
1244   /* Signature exipration time or 0.  */
1245   unsigned long exp_timestamp;
1246
1247   /* Key should not have been used for signing.  */
1248   unsigned int wrong_key_usage : 1;
1249
1250   /* Internal to GPGME, do not use.  */
1251   int _unused : 31;
1252
1253   gpgme_validity_t validity;
1254   gpgme_error_t validity_reason;
1255
1256   /* The public key algorithm used to create the signature.  */
1257   gpgme_pubkey_algo_t pubkey_algo;
1258
1259   /* The hash algorithm used to create the signature.  */
1260   gpgme_hash_algo_t hash_algo;
1261 };
1262 typedef struct _gpgme_signature *gpgme_signature_t;
1263
1264 struct _gpgme_op_verify_result
1265 {
1266   gpgme_signature_t signatures;
1267
1268   /* The original filename of the plaintext message, if available.  */
1269   char *plaintext_filename;
1270 };
1271 typedef struct _gpgme_op_verify_result *gpgme_verify_result_t;
1272
1273 /* Retrieve a pointer to the result of the verify operation.  */
1274 gpgme_verify_result_t gpgme_op_verify_result (gpgme_ctx_t ctx);
1275
1276 /* Verify within CTX that SIG is a valid signature for TEXT.  */
1277 gpgme_error_t gpgme_op_verify_start (gpgme_ctx_t ctx, gpgme_data_t sig,
1278                                      gpgme_data_t signed_text,
1279                                      gpgme_data_t plaintext);
1280 gpgme_error_t gpgme_op_verify (gpgme_ctx_t ctx, gpgme_data_t sig,
1281                                gpgme_data_t signed_text,
1282                                gpgme_data_t plaintext);
1283
1284 \f
1285 /* Import.  */
1286
1287 /* The key was new.  */
1288 #define GPGME_IMPORT_NEW        1
1289
1290 /* The key contained new user IDs.  */
1291 #define GPGME_IMPORT_UID        2
1292
1293 /* The key contained new signatures.  */
1294 #define GPGME_IMPORT_SIG        4
1295
1296 /* The key contained new sub keys.  */
1297 #define GPGME_IMPORT_SUBKEY     8
1298
1299 /* The key contained a secret key.  */
1300 #define GPGME_IMPORT_SECRET     16
1301
1302
1303 struct _gpgme_import_status
1304 {
1305   struct _gpgme_import_status *next;
1306
1307   /* Fingerprint.  */
1308   char *fpr;
1309
1310   /* If a problem occured, the reason why the key could not be
1311      imported.  Otherwise GPGME_No_Error.  */
1312   gpgme_error_t result;
1313
1314   /* The result of the import, the GPGME_IMPORT_* values bit-wise
1315      ORed.  0 means the key was already known and no new components
1316      have been added.  */
1317   unsigned int status;
1318 };
1319 typedef struct _gpgme_import_status *gpgme_import_status_t;
1320
1321 /* Import.  */
1322 struct _gpgme_op_import_result
1323 {
1324   /* Number of considered keys.  */
1325   int considered;
1326
1327   /* Keys without user ID.  */
1328   int no_user_id;
1329
1330   /* Imported keys.  */
1331   int imported;
1332
1333   /* Imported RSA keys.  */
1334   int imported_rsa;
1335
1336   /* Unchanged keys.  */
1337   int unchanged;
1338
1339   /* Number of new user ids.  */
1340   int new_user_ids;
1341
1342   /* Number of new sub keys.  */
1343   int new_sub_keys;
1344
1345   /* Number of new signatures.  */
1346   int new_signatures;
1347
1348   /* Number of new revocations.  */
1349   int new_revocations;
1350
1351   /* Number of secret keys read.  */
1352   int secret_read;
1353
1354   /* Number of secret keys imported.  */
1355   int secret_imported;
1356
1357   /* Number of secret keys unchanged.  */
1358   int secret_unchanged;
1359
1360   /* Number of new keys skipped.  */
1361   int skipped_new_keys;
1362
1363   /* Number of keys not imported.  */
1364   int not_imported;
1365
1366   /* List of keys for which an import was attempted.  */
1367   gpgme_import_status_t imports;
1368 };
1369 typedef struct _gpgme_op_import_result *gpgme_import_result_t;
1370
1371 /* Retrieve a pointer to the result of the import operation.  */
1372 gpgme_import_result_t gpgme_op_import_result (gpgme_ctx_t ctx);
1373
1374 /* Import the key in KEYDATA into the keyring.  */
1375 gpgme_error_t gpgme_op_import_start (gpgme_ctx_t ctx, gpgme_data_t keydata);
1376 gpgme_error_t gpgme_op_import (gpgme_ctx_t ctx, gpgme_data_t keydata);
1377 gpgme_error_t gpgme_op_import_ext (gpgme_ctx_t ctx, gpgme_data_t keydata,
1378                                    int *nr) _GPGME_DEPRECATED;
1379
1380 \f
1381 /* Export the keys found by PATTERN into KEYDATA.  */
1382 gpgme_error_t gpgme_op_export_start (gpgme_ctx_t ctx, const char *pattern,
1383                                      unsigned int reserved,
1384                                      gpgme_data_t keydata);
1385 gpgme_error_t gpgme_op_export (gpgme_ctx_t ctx, const char *pattern,
1386                                unsigned int reserved, gpgme_data_t keydata);
1387
1388 gpgme_error_t gpgme_op_export_ext_start (gpgme_ctx_t ctx,
1389                                          const char *pattern[],
1390                                          unsigned int reserved,
1391                                          gpgme_data_t keydata);
1392 gpgme_error_t gpgme_op_export_ext (gpgme_ctx_t ctx, const char *pattern[],
1393                                    unsigned int reserved,
1394                                    gpgme_data_t keydata);
1395
1396 \f
1397 /* Key generation.  */
1398 struct _gpgme_op_genkey_result
1399 {
1400   /* A primary key was generated.  */
1401   unsigned int primary : 1;
1402
1403   /* A sub key was generated.  */
1404   unsigned int sub : 1;
1405
1406   /* Internal to GPGME, do not use.  */
1407   unsigned int _unused : 30;
1408
1409   /* The fingerprint of the generated key.  */
1410   char *fpr;
1411 };
1412 typedef struct _gpgme_op_genkey_result *gpgme_genkey_result_t;
1413
1414 /* Generate a new keypair and add it to the keyring.  PUBKEY and
1415    SECKEY should be null for now.  PARMS specifies what keys should be
1416    generated.  */
1417 gpgme_error_t gpgme_op_genkey_start (gpgme_ctx_t ctx, const char *parms,
1418                                      gpgme_data_t pubkey, gpgme_data_t seckey);
1419 gpgme_error_t gpgme_op_genkey (gpgme_ctx_t ctx, const char *parms,
1420                                gpgme_data_t pubkey, gpgme_data_t seckey);
1421
1422 /* Retrieve a pointer to the result of the genkey operation.  */
1423 gpgme_genkey_result_t gpgme_op_genkey_result (gpgme_ctx_t ctx);
1424
1425 \f
1426 /* Delete KEY from the keyring.  If ALLOW_SECRET is non-zero, secret
1427    keys are also deleted.  */
1428 gpgme_error_t gpgme_op_delete_start (gpgme_ctx_t ctx, const gpgme_key_t key,
1429                                      int allow_secret);
1430 gpgme_error_t gpgme_op_delete (gpgme_ctx_t ctx, const gpgme_key_t key,
1431                                int allow_secret);
1432
1433 \f
1434 /* Edit the key KEY.  Send status and command requests to FNC and
1435    output of edit commands to OUT.  */
1436 gpgme_error_t gpgme_op_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1437                                    gpgme_edit_cb_t fnc, void *fnc_value,
1438                                    gpgme_data_t out);
1439 gpgme_error_t gpgme_op_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1440                              gpgme_edit_cb_t fnc, void *fnc_value,
1441                              gpgme_data_t out);
1442
1443 /* Edit the card for the key KEY.  Send status and command requests to
1444    FNC and output of edit commands to OUT.  */
1445 gpgme_error_t gpgme_op_card_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1446                                         gpgme_edit_cb_t fnc, void *fnc_value,
1447                                         gpgme_data_t out);
1448 gpgme_error_t gpgme_op_card_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1449                                   gpgme_edit_cb_t fnc, void *fnc_value,
1450                                   gpgme_data_t out);
1451
1452 \f
1453 /* Key management functions.  */
1454 struct _gpgme_op_keylist_result
1455 {
1456   unsigned int truncated : 1;
1457
1458   /* Internal to GPGME, do not use.  */
1459   unsigned int _unused : 31;
1460 };
1461 typedef struct _gpgme_op_keylist_result *gpgme_keylist_result_t;
1462
1463 /* Retrieve a pointer to the result of the key listing operation.  */
1464 gpgme_keylist_result_t gpgme_op_keylist_result (gpgme_ctx_t ctx);
1465
1466 /* Start a keylist operation within CTX, searching for keys which
1467    match PATTERN.  If SECRET_ONLY is true, only secret keys are
1468    returned.  */
1469 gpgme_error_t gpgme_op_keylist_start (gpgme_ctx_t ctx, const char *pattern,
1470                                       int secret_only);
1471 gpgme_error_t gpgme_op_keylist_ext_start (gpgme_ctx_t ctx,
1472                                           const char *pattern[],
1473                                           int secret_only, int reserved);
1474
1475 /* Return the next key from the keylist in R_KEY.  */
1476 gpgme_error_t gpgme_op_keylist_next (gpgme_ctx_t ctx, gpgme_key_t *r_key);
1477
1478 /* Terminate a pending keylist operation within CTX.  */
1479 gpgme_error_t gpgme_op_keylist_end (gpgme_ctx_t ctx);
1480
1481 \f
1482 /* Trust items and operations.  */
1483
1484 struct _gpgme_trust_item
1485 {
1486   /* Internal to GPGME, do not use.  */
1487   unsigned int _refs;
1488
1489   /* The key ID to which the trust item belongs.  */
1490   char *keyid;
1491
1492   /* Internal to GPGME, do not use.  */
1493   char _keyid[16 + 1];
1494
1495   /* The type of the trust item, 1 refers to a key, 2 to a user ID.  */
1496   int type;
1497
1498   /* The trust level.  */
1499   int level;
1500
1501   /* The owner trust if TYPE is 1.  */
1502   char *owner_trust;
1503
1504   /* Internal to GPGME, do not use.  */
1505   char _owner_trust[2];
1506
1507   /* The calculated validity.  */
1508   char *validity;
1509  
1510   /* Internal to GPGME, do not use.  */
1511   char _validity[2];
1512
1513   /* The user name if TYPE is 2.  */
1514   char *name;
1515 };
1516 typedef struct _gpgme_trust_item *gpgme_trust_item_t;
1517
1518 /* Start a trustlist operation within CTX, searching for trust items
1519    which match PATTERN.  */
1520 gpgme_error_t gpgme_op_trustlist_start (gpgme_ctx_t ctx,
1521                                         const char *pattern, int max_level);
1522
1523 /* Return the next trust item from the trustlist in R_ITEM.  */
1524 gpgme_error_t gpgme_op_trustlist_next (gpgme_ctx_t ctx,
1525                                        gpgme_trust_item_t *r_item);
1526
1527 /* Terminate a pending trustlist operation within CTX.  */
1528 gpgme_error_t gpgme_op_trustlist_end (gpgme_ctx_t ctx);
1529
1530 /* Acquire a reference to ITEM.  */
1531 void gpgme_trust_item_ref (gpgme_trust_item_t item);
1532
1533 /* Release a reference to ITEM.  If this was the last one the trust
1534    item is destroyed.  */
1535 void gpgme_trust_item_unref (gpgme_trust_item_t item);
1536
1537 /* Release the trust item ITEM.  Deprecated, use
1538    gpgme_trust_item_unref.  */
1539 void gpgme_trust_item_release (gpgme_trust_item_t item) _GPGME_DEPRECATED;
1540
1541 /* Return the value of the attribute WHAT of ITEM, which has to be
1542    representable by a string.  Deprecated, use trust item structure
1543    directly.  */
1544 const char *gpgme_trust_item_get_string_attr (gpgme_trust_item_t item,
1545                                               _gpgme_attr_t what,
1546                                               const void *reserved, int idx)
1547      _GPGME_DEPRECATED;
1548
1549 /* Return the value of the attribute WHAT of KEY, which has to be
1550    representable by an integer.  IDX specifies a running index if the
1551    attribute appears more than once in the key.  Deprecated, use trust
1552    item structure directly.  */
1553 int gpgme_trust_item_get_int_attr (gpgme_trust_item_t item, _gpgme_attr_t what,
1554                                    const void *reserved, int idx)
1555      _GPGME_DEPRECATED;
1556
1557 \f
1558 /* Various functions.  */
1559
1560 /* Check that the library fulfills the version requirement.  */
1561 const char *gpgme_check_version (const char *req_version);
1562
1563 /* Get the information about the configured and installed engines.  A
1564    pointer to the first engine in the statically allocated linked list
1565    is returned in *INFO.  If an error occurs, it is returned.  The
1566    returned data is valid until the next gpgme_set_engine_info.  */
1567 gpgme_error_t gpgme_get_engine_info (gpgme_engine_info_t *engine_info);
1568
1569 /* Set the default engine info for the protocol PROTO to the file name
1570    FILE_NAME and the home directory HOME_DIR.  */
1571 gpgme_error_t gpgme_set_engine_info (gpgme_protocol_t proto,
1572                                      const char *file_name,
1573                                      const char *home_dir);
1574
1575 \f
1576 /* Engine support functions.  */
1577
1578 /* Verify that the engine implementing PROTO is installed and
1579    available.  */
1580 gpgme_error_t gpgme_engine_check_version (gpgme_protocol_t proto);
1581
1582 \f
1583 /* Deprecated types.  */
1584 typedef gpgme_ctx_t GpgmeCtx _GPGME_DEPRECATED;
1585 typedef gpgme_data_t GpgmeData _GPGME_DEPRECATED;
1586 typedef gpgme_error_t GpgmeError _GPGME_DEPRECATED;
1587 typedef gpgme_data_encoding_t GpgmeDataEncoding _GPGME_DEPRECATED;
1588 typedef gpgme_pubkey_algo_t GpgmePubKeyAlgo _GPGME_DEPRECATED;
1589 typedef gpgme_hash_algo_t GpgmeHashAlgo _GPGME_DEPRECATED;
1590 typedef gpgme_sig_stat_t GpgmeSigStat _GPGME_DEPRECATED;
1591 typedef gpgme_sig_mode_t GpgmeSigMode _GPGME_DEPRECATED;
1592 typedef gpgme_attr_t GpgmeAttr _GPGME_DEPRECATED;
1593 typedef gpgme_validity_t GpgmeValidity _GPGME_DEPRECATED;
1594 typedef gpgme_protocol_t GpgmeProtocol _GPGME_DEPRECATED;
1595 typedef gpgme_engine_info_t GpgmeEngineInfo _GPGME_DEPRECATED;
1596 typedef gpgme_subkey_t GpgmeSubkey _GPGME_DEPRECATED;
1597 typedef gpgme_key_sig_t GpgmeKeySig _GPGME_DEPRECATED;
1598 typedef gpgme_user_id_t GpgmeUserID _GPGME_DEPRECATED;
1599 typedef gpgme_key_t GpgmeKey _GPGME_DEPRECATED;
1600 typedef gpgme_passphrase_cb_t GpgmePassphraseCb _GPGME_DEPRECATED;
1601 typedef gpgme_progress_cb_t GpgmeProgressCb _GPGME_DEPRECATED;
1602 typedef gpgme_io_cb_t GpgmeIOCb _GPGME_DEPRECATED;
1603 typedef gpgme_register_io_cb_t GpgmeRegisterIOCb _GPGME_DEPRECATED;
1604 typedef gpgme_remove_io_cb_t GpgmeRemoveIOCb _GPGME_DEPRECATED;
1605 typedef gpgme_event_io_t GpgmeEventIO _GPGME_DEPRECATED;
1606 typedef gpgme_event_io_cb_t GpgmeEventIOCb _GPGME_DEPRECATED;
1607 #define GpgmeIOCbs gpgme_io_cbs
1608 typedef gpgme_data_read_cb_t GpgmeDataReadCb _GPGME_DEPRECATED;
1609 typedef gpgme_data_write_cb_t GpgmeDataWriteCb _GPGME_DEPRECATED;
1610 typedef gpgme_data_seek_cb_t GpgmeDataSeekCb _GPGME_DEPRECATED;
1611 typedef gpgme_data_release_cb_t GpgmeDataReleaseCb _GPGME_DEPRECATED;
1612 #define GpgmeDataCbs gpgme_data_cbs
1613 typedef gpgme_encrypt_result_t GpgmeEncryptResult _GPGME_DEPRECATED;
1614 typedef gpgme_sig_notation_t GpgmeSigNotation _GPGME_DEPRECATED;
1615 typedef gpgme_signature_t GpgmeSignature _GPGME_DEPRECATED;
1616 typedef gpgme_verify_result_t GpgmeVerifyResult _GPGME_DEPRECATED;
1617 typedef gpgme_import_status_t GpgmeImportStatus _GPGME_DEPRECATED;
1618 typedef gpgme_import_result_t GpgmeImportResult _GPGME_DEPRECATED;
1619 typedef gpgme_genkey_result_t GpgmeGenKeyResult _GPGME_DEPRECATED;
1620 typedef gpgme_trust_item_t GpgmeTrustItem _GPGME_DEPRECATED;
1621 typedef gpgme_status_code_t GpgmeStatusCode _GPGME_DEPRECATED;
1622
1623 #ifdef __cplusplus
1624 }
1625 #endif
1626 #endif /* GPGME_H */