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