2003-10-02 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
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.3"
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 revoked.  */
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   /* Crypto backend specific signature class.  */
510   unsigned int class;
511
512   /* The user ID string.  */
513   char *uid;
514
515   /* The name part of the user ID.  */
516   char *name;
517
518   /* The email part of the user ID.  */
519   char *email;
520
521   /* The comment part of the user ID.  */
522   char *comment;
523 };
524 typedef struct _gpgme_key_sig *gpgme_key_sig_t;
525
526
527 /* An user ID from a key.  */
528 struct _gpgme_user_id
529 {
530   struct _gpgme_user_id *next;
531
532   /* True if the user ID is revoked.  */
533   unsigned int revoked : 1;
534
535   /* True if the user ID is invalid.  */
536   unsigned int invalid : 1;
537
538   /* Internal to GPGME, do not use.  */
539   unsigned int _unused : 30;
540
541   /* The validity of the user ID.  */
542   gpgme_validity_t validity; 
543
544   /* The user ID string.  */
545   char *uid;
546
547   /* The name part of the user ID.  */
548   char *name;
549
550   /* The email part of the user ID.  */
551   char *email;
552
553   /* The comment part of the user ID.  */
554   char *comment;
555
556   /* The signatures of the user ID.  */
557   gpgme_key_sig_t signatures;
558
559   /* Internal to GPGME, do not use.  */
560   gpgme_key_sig_t _last_keysig;
561 };
562 typedef struct _gpgme_user_id *gpgme_user_id_t;
563
564
565 /* A key from the keyring.  */
566 struct _gpgme_key
567 {
568   /* Internal to GPGME, do not use.  */
569   unsigned int _refs;
570
571   /* True if key is revoked.  */
572   unsigned int revoked : 1;
573
574   /* True if key is expired.  */
575   unsigned int expired : 1;
576
577   /* True if key is disabled.  */
578   unsigned int disabled : 1;
579
580   /* True if key is invalid.  */
581   unsigned int invalid : 1;
582
583   /* True if key can be used for encryption.  */
584   unsigned int can_encrypt : 1;
585
586   /* True if key can be used for signing.  */
587   unsigned int can_sign : 1;
588
589   /* True if key can be used for certification.  */
590   unsigned int can_certify : 1;
591
592   /* True if key is secret.  */
593   unsigned int secret : 1;
594
595   /* True if key can be used for authentication.  */
596   unsigned int can_authenticate : 1;
597
598   /* Internal to GPGME, do not use.  */
599   unsigned int _unused : 23;
600
601   /* This is the protocol supported by this key.  */
602   gpgme_protocol_t protocol;
603
604   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
605      issuer serial.  */
606   char *issuer_serial;
607
608   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
609      issuer name.  */
610   char *issuer_name;
611
612   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the chain
613      ID.  */
614   char *chain_id;
615
616   /* If protocol is GPGME_PROTOCOL_OpenPGP, this field contains the
617      owner trust.  */
618   gpgme_validity_t owner_trust;
619
620   /* The subkeys of the key.  */
621   gpgme_subkey_t subkeys;
622
623   /* The user IDs of the key.  */
624   gpgme_user_id_t uids;
625
626   /* Internal to GPGME, do not use.  */
627   gpgme_subkey_t _last_subkey;
628
629   /* Internal to GPGME, do not use.  */
630   gpgme_user_id_t _last_uid;
631 };
632 typedef struct _gpgme_key *gpgme_key_t;
633
634
635 \f
636 /* Types for callback functions.  */
637
638 /* Request a passphrase from the user.  */
639 typedef gpgme_error_t (*gpgme_passphrase_cb_t) (void *hook,
640                                                 const char *uid_hint,
641                                                 const char *passphrase_info,
642                                                 int prev_was_bad, int fd);
643
644 /* Inform the user about progress made.  */
645 typedef void (*gpgme_progress_cb_t) (void *opaque, const char *what,
646                                      int type, int current, int total);
647
648 /* Interact with the user about an edit operation.  */
649 typedef gpgme_error_t (*gpgme_edit_cb_t) (void *opaque,
650                                           gpgme_status_code_t status,
651                                           const char *args, int fd);
652
653 \f
654 /* Context management functions.  */
655
656 /* Create a new context and return it in CTX.  */
657 gpgme_error_t gpgme_new (gpgme_ctx_t *ctx);
658
659 /* Release the context CTX.  */
660 void gpgme_release (gpgme_ctx_t ctx);
661
662 /* Set the protocol to be used by CTX to PROTO.  */
663 gpgme_error_t gpgme_set_protocol (gpgme_ctx_t ctx, gpgme_protocol_t proto);
664
665 /* Get the protocol used with CTX */
666 gpgme_protocol_t gpgme_get_protocol (gpgme_ctx_t ctx);
667
668 /* Get the string describing protocol PROTO, or NULL if invalid.  */
669 const char *gpgme_get_protocol_name (gpgme_protocol_t proto);
670
671 /* If YES is non-zero, enable armor mode in CTX, disable it otherwise.  */
672 void gpgme_set_armor (gpgme_ctx_t ctx, int yes);
673
674 /* Return non-zero if armor mode is set in CTX.  */
675 int gpgme_get_armor (gpgme_ctx_t ctx);
676
677 /* If YES is non-zero, enable text mode in CTX, disable it otherwise.  */
678 void gpgme_set_textmode (gpgme_ctx_t ctx, int yes);
679
680 /* Return non-zero if text mode is set in CTX.  */
681 int gpgme_get_textmode (gpgme_ctx_t ctx);
682
683 /* Include up to NR_OF_CERTS certificates in an S/MIME message.  */
684 void gpgme_set_include_certs (gpgme_ctx_t ctx, int nr_of_certs);
685
686 /* Return the number of certs to include in an S/MIME message.  */
687 int gpgme_get_include_certs (gpgme_ctx_t ctx);
688
689 /* The available keylist mode flags.  */
690 typedef enum
691   {
692     GPGME_KEYLIST_MODE_LOCAL  = 1,
693     GPGME_KEYLIST_MODE_EXTERN = 2,
694     GPGME_KEYLIST_MODE_SIGS   = 4
695   }
696 gpgme_keylist_mode_t;
697
698 /* Set keylist mode in CTX to MODE.  */
699 gpgme_error_t gpgme_set_keylist_mode (gpgme_ctx_t ctx,
700                                       gpgme_keylist_mode_t mode);
701
702 /* Get keylist mode in CTX.  */
703 gpgme_keylist_mode_t gpgme_get_keylist_mode (gpgme_ctx_t ctx);
704
705 /* Set the passphrase callback function in CTX to CB.  HOOK_VALUE is
706    passed as first argument to the passphrase callback function.  */
707 void gpgme_set_passphrase_cb (gpgme_ctx_t ctx,
708                               gpgme_passphrase_cb_t cb, void *hook_value);
709
710 /* Get the current passphrase callback function in *CB and the current
711    hook value in *HOOK_VALUE.  */
712 void gpgme_get_passphrase_cb (gpgme_ctx_t ctx, gpgme_passphrase_cb_t *cb,
713                               void **hook_value);
714
715 /* Set the progress callback function in CTX to CB.  HOOK_VALUE is
716    passed as first argument to the progress callback function.  */
717 void gpgme_set_progress_cb (gpgme_ctx_t c, gpgme_progress_cb_t cb,
718                             void *hook_value);
719
720 /* Get the current progress callback function in *CB and the current
721    hook value in *HOOK_VALUE.  */
722 void gpgme_get_progress_cb (gpgme_ctx_t ctx, gpgme_progress_cb_t *cb,
723                             void **hook_value);
724
725 /* This function sets the locale for the context CTX, or the default
726    locale if CTX is a null pointer.  */
727 gpgme_error_t gpgme_set_locale (gpgme_ctx_t ctx, int category,
728                                 const char *value);
729 \f
730 /* Return a statically allocated string with the name of the public
731    key algorithm ALGO, or NULL if that name is not known.  */
732 const char *gpgme_pubkey_algo_name (gpgme_pubkey_algo_t algo);
733
734 /* Return a statically allocated string with the name of the hash
735    algorithm ALGO, or NULL if that name is not known.  */
736 const char *gpgme_hash_algo_name (gpgme_hash_algo_t algo);
737
738 \f
739 /* Delete all signers from CTX.  */
740 void gpgme_signers_clear (gpgme_ctx_t ctx);
741
742 /* Add KEY to list of signers in CTX.  */
743 gpgme_error_t gpgme_signers_add (gpgme_ctx_t ctx, const gpgme_key_t key);
744
745 /* Return the SEQth signer's key in CTX.  */
746 gpgme_key_t gpgme_signers_enum (const gpgme_ctx_t ctx, int seq);
747
748 /* Retrieve the signature status of signature IDX in CTX after a
749    successful verify operation in R_STAT (if non-null).  The creation
750    time stamp of the signature is returned in R_CREATED (if non-null).
751    The function returns a string containing the fingerprint.
752    Deprecated, use verify result directly.  */
753 const char *gpgme_get_sig_status (gpgme_ctx_t ctx, int idx,
754                                   _gpgme_sig_stat_t *r_stat,
755                                   time_t *r_created) _GPGME_DEPRECATED;
756
757 /* Retrieve certain attributes of a signature.  IDX is the index
758    number of the signature after a successful verify operation.  WHAT
759    is an attribute where GPGME_ATTR_EXPIRE is probably the most useful
760    one.  WHATIDX is to be passed as 0 for most attributes . */
761 unsigned long gpgme_get_sig_ulong_attr (gpgme_ctx_t c, int idx,
762                                         _gpgme_attr_t what, int whatidx)
763      _GPGME_DEPRECATED;
764 const char *gpgme_get_sig_string_attr (gpgme_ctx_t c, int idx,
765                                        _gpgme_attr_t what, int whatidx)
766      _GPGME_DEPRECATED;
767
768
769 /* Get the key used to create signature IDX in CTX and return it in
770    R_KEY.  */
771 gpgme_error_t gpgme_get_sig_key (gpgme_ctx_t ctx, int idx, gpgme_key_t *r_key)
772      _GPGME_DEPRECATED;
773
774 \f
775 /* Run control.  */
776
777 /* The type of an I/O callback function.  */
778 typedef gpgme_error_t (*gpgme_io_cb_t) (void *data, int fd);
779
780 /* The type of a function that can register FNC as the I/O callback
781    function for the file descriptor FD with direction dir (0: for writing,
782    1: for reading).  FNC_DATA should be passed as DATA to FNC.  The
783    function should return a TAG suitable for the corresponding
784    gpgme_remove_io_cb_t, and an error value.  */
785 typedef gpgme_error_t (*gpgme_register_io_cb_t) (void *data, int fd, int dir,
786                                                  gpgme_io_cb_t fnc,
787                                                  void *fnc_data, void **tag);
788
789 /* The type of a function that can remove a previously registered I/O
790    callback function given TAG as returned by the register
791    function.  */
792 typedef void (*gpgme_remove_io_cb_t) (void *tag);
793
794 typedef enum
795   {
796     GPGME_EVENT_START,
797     GPGME_EVENT_DONE,
798     GPGME_EVENT_NEXT_KEY,
799     GPGME_EVENT_NEXT_TRUSTITEM
800   }
801 gpgme_event_io_t;
802
803 /* The type of a function that is called when a context finished an
804    operation.  */
805 typedef void (*gpgme_event_io_cb_t) (void *data, gpgme_event_io_t type,
806                                      void *type_data);
807
808 struct gpgme_io_cbs
809 {
810   gpgme_register_io_cb_t add;
811   void *add_priv;
812   gpgme_remove_io_cb_t remove;
813   gpgme_event_io_cb_t event;
814   void *event_priv;
815 };
816 typedef struct gpgme_io_cbs *gpgme_io_cbs_t;
817
818 /* Set the I/O callback functions in CTX to IO_CBS.  */
819 void gpgme_set_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
820
821 /* Get the current I/O callback functions.  */
822 void gpgme_get_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
823
824 /* Process the pending operation and, if HANG is non-zero, wait for
825    the pending operation to finish.  */
826 gpgme_ctx_t gpgme_wait (gpgme_ctx_t ctx, gpgme_error_t *status, int hang);
827
828 \f
829 /* Functions to handle data objects.  */
830
831 /* Read up to SIZE bytes into buffer BUFFER from the data object with
832    the handle HANDLE.  Return the number of characters read, 0 on EOF
833    and -1 on error.  If an error occurs, errno is set.  */
834 typedef ssize_t (*gpgme_data_read_cb_t) (void *handle, void *buffer,
835                                          size_t size);
836
837 /* Write up to SIZE bytes from buffer BUFFER to the data object with
838    the handle HANDLE.  Return the number of characters written, or -1
839    on error.  If an error occurs, errno is set.  */
840 typedef ssize_t (*gpgme_data_write_cb_t) (void *handle, const void *buffer,
841                                           size_t size);
842
843 /* Set the current position from where the next read or write starts
844    in the data object with the handle HANDLE to OFFSET, relativ to
845    WHENCE.  */
846 typedef off_t (*gpgme_data_seek_cb_t) (void *handle, off_t offset, int whence);
847
848 /* Close the data object with the handle DL.  */
849 typedef void (*gpgme_data_release_cb_t) (void *handle);
850
851 struct gpgme_data_cbs
852 {
853   gpgme_data_read_cb_t read;
854   gpgme_data_write_cb_t write;
855   gpgme_data_seek_cb_t seek;
856   gpgme_data_release_cb_t release;
857 };
858 typedef struct gpgme_data_cbs *gpgme_data_cbs_t;
859
860 /* Read up to SIZE bytes into buffer BUFFER from the data object with
861    the handle DH.  Return the number of characters read, 0 on EOF and
862    -1 on error.  If an error occurs, errno is set.  */
863 ssize_t gpgme_data_read (gpgme_data_t dh, void *buffer, size_t size);
864
865 /* Write up to SIZE bytes from buffer BUFFER to the data object with
866    the handle DH.  Return the number of characters written, or -1 on
867    error.  If an error occurs, errno is set.  */
868 ssize_t gpgme_data_write (gpgme_data_t dh, const void *buffer, size_t size);
869
870 /* Set the current position from where the next read or write starts
871    in the data object with the handle DH to OFFSET, relativ to
872    WHENCE.  */
873 off_t gpgme_data_seek (gpgme_data_t dh, off_t offset, int whence);
874
875 /* Create a new data buffer and return it in R_DH.  */
876 gpgme_error_t gpgme_data_new (gpgme_data_t *r_dh);
877
878 /* Destroy the data buffer DH.  */
879 void gpgme_data_release (gpgme_data_t dh);
880
881 /* Create a new data buffer filled with SIZE bytes starting from
882    BUFFER.  If COPY is zero, copying is delayed until necessary, and
883    the data is taken from the original location when needed.  */
884 gpgme_error_t gpgme_data_new_from_mem (gpgme_data_t *r_dh,
885                                        const char *buffer, size_t size,
886                                        int copy);
887
888 /* Destroy the data buffer DH and return a pointer to its content.
889    The memory has be to released with free by the user.  It's size is
890    returned in R_LEN.  */
891 char *gpgme_data_release_and_get_mem (gpgme_data_t dh, size_t *r_len);
892
893 gpgme_error_t gpgme_data_new_from_cbs (gpgme_data_t *dh,
894                                        gpgme_data_cbs_t cbs,
895                                        void *handle);
896
897 gpgme_error_t gpgme_data_new_from_fd (gpgme_data_t *dh, int fd);
898
899 gpgme_error_t gpgme_data_new_from_stream (gpgme_data_t *dh, FILE *stream);
900
901 /* Return the encoding attribute of the data buffer DH */
902 gpgme_data_encoding_t gpgme_data_get_encoding (gpgme_data_t dh);
903
904 /* Set the encoding attribute of data buffer DH to ENC */
905 gpgme_error_t gpgme_data_set_encoding (gpgme_data_t dh,
906                                        gpgme_data_encoding_t enc);
907
908
909
910 /* Create a new data buffer which retrieves the data from the callback
911    function READ_CB.  Deprecated, please use gpgme_data_new_from_cbs
912    instead.  */
913 gpgme_error_t gpgme_data_new_with_read_cb (gpgme_data_t *r_dh,
914                                            int (*read_cb) (void*,char *,
915                                                            size_t,size_t*),
916                                            void *read_cb_value)
917      _GPGME_DEPRECATED;
918
919 /* Create a new data buffer filled with the content of file FNAME.
920    COPY must be non-zero.  For delayed read, please use
921    gpgme_data_new_from_fd or gpgme_data_new_from stream instead.  */
922 gpgme_error_t gpgme_data_new_from_file (gpgme_data_t *r_dh,
923                                         const char *fname,
924                                         int copy);
925
926 /* Create a new data buffer filled with LENGTH bytes starting from
927    OFFSET within the file FNAME or stream FP (exactly one must be
928    non-zero).  */
929 gpgme_error_t gpgme_data_new_from_filepart (gpgme_data_t *r_dh,
930                                             const char *fname, FILE *fp,
931                                             off_t offset, size_t length);
932
933 /* Reset the read pointer in DH.  Deprecated, please use
934    gpgme_data_seek instead.  */
935 gpgme_error_t gpgme_data_rewind (gpgme_data_t dh) _GPGME_DEPRECATED;
936
937 \f
938 /* Key and trust functions.  */
939
940 /* Get the key with the fingerprint FPR from the crypto backend.  If
941    SECRET is true, get the secret key.  */
942 gpgme_error_t gpgme_get_key (gpgme_ctx_t ctx, const char *fpr,
943                              gpgme_key_t *r_key, int secret);
944
945 /* Acquire a reference to KEY.  */
946 void gpgme_key_ref (gpgme_key_t key);
947
948 /* Release a reference to KEY.  If this was the last one the key is
949    destroyed.  */
950 void gpgme_key_unref (gpgme_key_t key);
951 void gpgme_key_release (gpgme_key_t key);
952
953 /* Return the value of the attribute WHAT of KEY, which has to be
954    representable by a string.  IDX specifies the sub key or user ID
955    for attributes related to sub keys or user IDs.  Deprecated, use
956    key structure directly instead. */
957 const char *gpgme_key_get_string_attr (gpgme_key_t key, _gpgme_attr_t what,
958                                        const void *reserved, int idx)
959      _GPGME_DEPRECATED;
960
961 /* Return the value of the attribute WHAT of KEY, which has to be
962    representable by an unsigned integer.  IDX specifies the sub key or
963    user ID for attributes related to sub keys or user IDs.
964    Deprecated, use key structure directly instead.  */
965 unsigned long gpgme_key_get_ulong_attr (gpgme_key_t key, _gpgme_attr_t what,
966                                         const void *reserved, int idx)
967      _GPGME_DEPRECATED;
968
969 /* Return the value of the attribute WHAT of a signature on user ID
970    UID_IDX in KEY, which has to be representable by a string.  IDX
971    specifies the signature.  Deprecated, use key structure directly
972    instead.  */
973 const char *gpgme_key_sig_get_string_attr (gpgme_key_t key, int uid_idx,
974                                            _gpgme_attr_t what,
975                                            const void *reserved, int idx)
976      _GPGME_DEPRECATED;
977
978 /* Return the value of the attribute WHAT of a signature on user ID
979    UID_IDX in KEY, which has to be representable by an unsigned
980    integer string.  IDX specifies the signature.  Deprecated, use key
981    structure directly instead.  */
982 unsigned long gpgme_key_sig_get_ulong_attr (gpgme_key_t key, int uid_idx,
983                                             _gpgme_attr_t what,
984                                             const void *reserved, int idx)
985      _GPGME_DEPRECATED;
986
987 \f
988 /* Crypto Operations.  */
989
990 struct _gpgme_invalid_key
991 {
992   struct _gpgme_invalid_key *next;
993   char *fpr;
994   gpgme_error_t reason;
995 };
996 typedef struct _gpgme_invalid_key *gpgme_invalid_key_t;
997
998 \f
999 /* Encryption.  */
1000 struct _gpgme_op_encrypt_result
1001 {
1002   /* The list of invalid recipients.  */
1003   gpgme_invalid_key_t invalid_recipients;
1004 };
1005 typedef struct _gpgme_op_encrypt_result *gpgme_encrypt_result_t;
1006
1007 /* Retrieve a pointer to the result of the encrypt operation.  */
1008 gpgme_encrypt_result_t gpgme_op_encrypt_result (gpgme_ctx_t ctx);
1009
1010 /* The valid encryption flags.  */
1011 typedef enum
1012   {
1013     GPGME_ENCRYPT_ALWAYS_TRUST = 1
1014   }
1015 gpgme_encrypt_flags_t;
1016
1017 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1018    store the resulting ciphertext in CIPHER.  */
1019 gpgme_error_t gpgme_op_encrypt_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
1020                                       gpgme_encrypt_flags_t flags,
1021                                       gpgme_data_t plain, gpgme_data_t cipher);
1022 gpgme_error_t gpgme_op_encrypt (gpgme_ctx_t ctx, gpgme_key_t recp[],
1023                                 gpgme_encrypt_flags_t flags,
1024                                 gpgme_data_t plain, gpgme_data_t cipher);
1025
1026 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1027    store the resulting ciphertext in CIPHER.  Also sign the ciphertext
1028    with the signers in CTX.  */
1029 gpgme_error_t gpgme_op_encrypt_sign_start (gpgme_ctx_t ctx,
1030                                            gpgme_key_t recp[],
1031                                            gpgme_encrypt_flags_t flags,
1032                                            gpgme_data_t plain,
1033                                            gpgme_data_t cipher);
1034 gpgme_error_t gpgme_op_encrypt_sign (gpgme_ctx_t ctx, gpgme_key_t recp[],
1035                                      gpgme_encrypt_flags_t flags,
1036                                      gpgme_data_t plain, gpgme_data_t cipher);
1037
1038 \f
1039 /* Decryption.  */
1040 struct _gpgme_op_decrypt_result
1041 {
1042   char *unsupported_algorithm;
1043 };
1044 typedef struct _gpgme_op_decrypt_result *gpgme_decrypt_result_t;
1045
1046 /* Retrieve a pointer to the result of the decrypt operation.  */
1047 gpgme_decrypt_result_t gpgme_op_decrypt_result (gpgme_ctx_t ctx);
1048
1049 /* Decrypt ciphertext CIPHER within CTX and store the resulting
1050    plaintext in PLAIN.  */
1051 gpgme_error_t gpgme_op_decrypt_start (gpgme_ctx_t ctx, gpgme_data_t cipher,
1052                                       gpgme_data_t plain);
1053 gpgme_error_t gpgme_op_decrypt (gpgme_ctx_t ctx,
1054                                 gpgme_data_t cipher, gpgme_data_t plain);
1055
1056 /* Decrypt ciphertext CIPHER and make a signature verification within
1057    CTX and store the resulting plaintext in PLAIN.  */
1058 gpgme_error_t gpgme_op_decrypt_verify_start (gpgme_ctx_t ctx,
1059                                              gpgme_data_t cipher,
1060                                              gpgme_data_t plain);
1061 gpgme_error_t gpgme_op_decrypt_verify (gpgme_ctx_t ctx, gpgme_data_t cipher,
1062                                        gpgme_data_t plain);
1063
1064 \f
1065 /* Signing.  */
1066 struct _gpgme_new_signature
1067 {
1068   struct _gpgme_new_signature *next;
1069
1070   /* The type of the signature.  */
1071   gpgme_sig_mode_t type;
1072
1073   /* The public key algorithm used to create the signature.  */
1074   gpgme_pubkey_algo_t pubkey_algo;
1075
1076   /* The hash algorithm used to create the signature.  */
1077   gpgme_hash_algo_t hash_algo;
1078
1079   /* Internal to GPGME, do not use.  Must be set to the same value as
1080      CLASS below.  */
1081   unsigned long _obsolete_class;
1082
1083   /* Signature creation time.  */
1084   long int timestamp;
1085
1086   /* The fingerprint of the signature.  */
1087   char *fpr;
1088
1089   /* Crypto backend specific signature class.  */
1090   unsigned int class;
1091 };
1092 typedef struct _gpgme_new_signature *gpgme_new_signature_t;
1093
1094 struct _gpgme_op_sign_result
1095 {
1096   /* The list of invalid signers.  */
1097   gpgme_invalid_key_t invalid_signers;
1098   gpgme_new_signature_t signatures;
1099 };
1100 typedef struct _gpgme_op_sign_result *gpgme_sign_result_t;
1101
1102 /* Retrieve a pointer to the result of the signing operation.  */
1103 gpgme_sign_result_t gpgme_op_sign_result (gpgme_ctx_t ctx);
1104
1105 /* Sign the plaintext PLAIN and store the signature in SIG.  */
1106 gpgme_error_t gpgme_op_sign_start (gpgme_ctx_t ctx,
1107                                    gpgme_data_t plain, gpgme_data_t sig,
1108                                    gpgme_sig_mode_t mode);
1109 gpgme_error_t gpgme_op_sign (gpgme_ctx_t ctx,
1110                              gpgme_data_t plain, gpgme_data_t sig,
1111                              gpgme_sig_mode_t mode);
1112
1113 \f
1114 /* Verify.  */
1115 struct _gpgme_sig_notation
1116 {
1117   struct _gpgme_sig_notation *next;
1118
1119   /* If NAME is a null pointer, then VALUE contains a policy URL
1120      rather than a notation.  */
1121   char *name;
1122   char *value;
1123 };
1124 typedef struct _gpgme_sig_notation *gpgme_sig_notation_t;
1125
1126 /* Flags used for the SUMMARY field in a gpgme_signature_t.  */
1127 typedef enum
1128   {
1129     GPGME_SIGSUM_VALID       = 0x0001,  /* The signature is fully valid.  */
1130     GPGME_SIGSUM_GREEN       = 0x0002,  /* The signature is good.  */
1131     GPGME_SIGSUM_RED         = 0x0004,  /* The signature is bad.  */
1132     GPGME_SIGSUM_KEY_REVOKED = 0x0010,  /* One key has been revoked.  */
1133     GPGME_SIGSUM_KEY_EXPIRED = 0x0020,  /* One key has expired.  */
1134     GPGME_SIGSUM_SIG_EXPIRED = 0x0040,  /* The signature has expired.  */
1135     GPGME_SIGSUM_KEY_MISSING = 0x0080,  /* Can't verify: key missing.  */
1136     GPGME_SIGSUM_CRL_MISSING = 0x0100,  /* CRL not available.  */
1137     GPGME_SIGSUM_CRL_TOO_OLD = 0x0200,  /* Available CRL is too old.  */
1138     GPGME_SIGSUM_BAD_POLICY  = 0x0400,  /* A policy was not met.  */
1139     GPGME_SIGSUM_SYS_ERROR   = 0x0800   /* A system error occured.  */
1140   }
1141 gpgme_sigsum_t;
1142
1143 struct _gpgme_signature
1144 {
1145   struct _gpgme_signature *next;
1146
1147   /* A summary of the signature status.  */
1148   gpgme_sigsum_t summary;
1149
1150   /* The fingerprint or key ID of the signature.  */
1151   char *fpr;
1152
1153   /* The status of the signature.  */
1154   gpgme_error_t status;
1155
1156   /* Notation data and policy URLs.  */
1157   gpgme_sig_notation_t notations;
1158
1159   /* Signature creation time.  */
1160   unsigned long timestamp;
1161
1162   /* Signature exipration time or 0.  */
1163   unsigned long exp_timestamp;
1164
1165   int wrong_key_usage : 1;
1166
1167   /* Internal to GPGME, do not use.  */
1168   int _unused : 31;
1169
1170   gpgme_validity_t validity;
1171   gpgme_error_t validity_reason;
1172 };
1173 typedef struct _gpgme_signature *gpgme_signature_t;
1174
1175 struct _gpgme_op_verify_result
1176 {
1177   gpgme_signature_t signatures;
1178 };
1179 typedef struct _gpgme_op_verify_result *gpgme_verify_result_t;
1180
1181 /* Retrieve a pointer to the result of the verify operation.  */
1182 gpgme_verify_result_t gpgme_op_verify_result (gpgme_ctx_t ctx);
1183
1184 /* Verify within CTX that SIG is a valid signature for TEXT.  */
1185 gpgme_error_t gpgme_op_verify_start (gpgme_ctx_t ctx, gpgme_data_t sig,
1186                                      gpgme_data_t signed_text,
1187                                      gpgme_data_t plaintext);
1188 gpgme_error_t gpgme_op_verify (gpgme_ctx_t ctx, gpgme_data_t sig,
1189                                gpgme_data_t signed_text,
1190                                gpgme_data_t plaintext);
1191
1192 \f
1193 /* Import.  */
1194 enum
1195   {
1196     /* The key was new.  */
1197     GPGME_IMPORT_NEW = 1,
1198
1199     /* The key contained new user IDs.  */
1200     GPGME_IMPORT_UID = 2,
1201
1202     /* The key contained new signatures.  */
1203     GPGME_IMPORT_SIG = 4,
1204
1205     /* The key contained new sub keys.  */
1206     GPGME_IMPORT_SUBKEY = 8,
1207
1208     /* The key contained a secret key.  */
1209     GPGME_IMPORT_SECRET = 16
1210   };
1211
1212 struct _gpgme_import_status
1213 {
1214   struct _gpgme_import_status *next;
1215
1216   /* Fingerprint.  */
1217   char *fpr;
1218
1219   /* If a problem occured, the reason why the key could not be
1220      imported.  Otherwise GPGME_No_Error.  */
1221   gpgme_error_t result;
1222
1223   /* The result of the import, the GPGME_IMPORT_* values bit-wise
1224      ORed.  0 means the key was already known and no new components
1225      have been added.  */
1226   unsigned int status;
1227 };
1228 typedef struct _gpgme_import_status *gpgme_import_status_t;
1229
1230 /* Import.  */
1231 struct _gpgme_op_import_result
1232 {
1233   /* Number of considered keys.  */
1234   int considered;
1235
1236   /* Keys without user ID.  */
1237   int no_user_id;
1238
1239   /* Imported keys.  */
1240   int imported;
1241
1242   /* Imported RSA keys.  */
1243   int imported_rsa;
1244
1245   /* Unchanged keys.  */
1246   int unchanged;
1247
1248   /* Number of new user ids.  */
1249   int new_user_ids;
1250
1251   /* Number of new sub keys.  */
1252   int new_sub_keys;
1253
1254   /* Number of new signatures.  */
1255   int new_signatures;
1256
1257   /* Number of new revocations.  */
1258   int new_revocations;
1259
1260   /* Number of secret keys read.  */
1261   int secret_read;
1262
1263   /* Number of secret keys imported.  */
1264   int secret_imported;
1265
1266   /* Number of secret keys unchanged.  */
1267   int secret_unchanged;
1268
1269   /* Number of new keys skipped.  */
1270   int skipped_new_keys;
1271
1272   /* Number of keys not imported.  */
1273   int not_imported;
1274
1275   /* List of keys for which an import was attempted.  */
1276   gpgme_import_status_t imports;
1277 };
1278 typedef struct _gpgme_op_import_result *gpgme_import_result_t;
1279
1280 /* Retrieve a pointer to the result of the import operation.  */
1281 gpgme_import_result_t gpgme_op_import_result (gpgme_ctx_t ctx);
1282
1283 /* Import the key in KEYDATA into the keyring.  */
1284 gpgme_error_t gpgme_op_import_start (gpgme_ctx_t ctx, gpgme_data_t keydata);
1285 gpgme_error_t gpgme_op_import (gpgme_ctx_t ctx, gpgme_data_t keydata);
1286 gpgme_error_t gpgme_op_import_ext (gpgme_ctx_t ctx, gpgme_data_t keydata,
1287                                    int *nr) _GPGME_DEPRECATED;
1288
1289 \f
1290 /* Export the keys found by PATTERN into KEYDATA.  */
1291 gpgme_error_t gpgme_op_export_start (gpgme_ctx_t ctx, const char *pattern,
1292                                      unsigned int reserved,
1293                                      gpgme_data_t keydata);
1294 gpgme_error_t gpgme_op_export (gpgme_ctx_t ctx, const char *pattern,
1295                                unsigned int reserved, gpgme_data_t keydata);
1296
1297 gpgme_error_t gpgme_op_export_ext_start (gpgme_ctx_t ctx,
1298                                          const char *pattern[],
1299                                          unsigned int reserved,
1300                                          gpgme_data_t keydata);
1301 gpgme_error_t gpgme_op_export_ext (gpgme_ctx_t ctx, const char *pattern[],
1302                                    unsigned int reserved,
1303                                    gpgme_data_t keydata);
1304
1305 \f
1306 /* Key generation.  */
1307 struct _gpgme_op_genkey_result
1308 {
1309   /* A primary key was generated.  */
1310   unsigned int primary : 1;
1311
1312   /* A sub key was generated.  */
1313   unsigned int sub : 1;
1314
1315   /* Internal to GPGME, do not use.  */
1316   unsigned int _unused : 30;
1317
1318   /* The fingerprint of the generated key.  */
1319   char *fpr;
1320 };
1321 typedef struct _gpgme_op_genkey_result *gpgme_genkey_result_t;
1322
1323 /* Generate a new keypair and add it to the keyring.  PUBKEY and
1324    SECKEY should be null for now.  PARMS specifies what keys should be
1325    generated.  */
1326 gpgme_error_t gpgme_op_genkey_start (gpgme_ctx_t ctx, const char *parms,
1327                                      gpgme_data_t pubkey, gpgme_data_t seckey);
1328 gpgme_error_t gpgme_op_genkey (gpgme_ctx_t ctx, const char *parms,
1329                                gpgme_data_t pubkey, gpgme_data_t seckey);
1330
1331 /* Retrieve a pointer to the result of the genkey operation.  */
1332 gpgme_genkey_result_t gpgme_op_genkey_result (gpgme_ctx_t ctx);
1333
1334 \f
1335 /* Delete KEY from the keyring.  If ALLOW_SECRET is non-zero, secret
1336    keys are also deleted.  */
1337 gpgme_error_t gpgme_op_delete_start (gpgme_ctx_t ctx, const gpgme_key_t key,
1338                                      int allow_secret);
1339 gpgme_error_t gpgme_op_delete (gpgme_ctx_t ctx, const gpgme_key_t key,
1340                                int allow_secret);
1341
1342 \f
1343 /* Edit the key KEY.  Send status and command requests to FNC and
1344    output of edit commands to OUT.  */
1345 gpgme_error_t gpgme_op_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1346                                    gpgme_edit_cb_t fnc, void *fnc_value,
1347                                    gpgme_data_t out);
1348 gpgme_error_t gpgme_op_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1349                              gpgme_edit_cb_t fnc, void *fnc_value,
1350                              gpgme_data_t out);
1351
1352 /* Edit the card for the key KEY.  Send status and command requests to
1353    FNC and output of edit commands to OUT.  */
1354 gpgme_error_t gpgme_op_card_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
1355                                         gpgme_edit_cb_t fnc, void *fnc_value,
1356                                         gpgme_data_t out);
1357 gpgme_error_t gpgme_op_card_edit (gpgme_ctx_t ctx, gpgme_key_t key,
1358                                   gpgme_edit_cb_t fnc, void *fnc_value,
1359                                   gpgme_data_t out);
1360
1361 \f
1362 /* Key management functions.  */
1363 struct _gpgme_op_keylist_result
1364 {
1365   unsigned int truncated : 1;
1366
1367   /* Internal to GPGME, do not use.  */
1368   unsigned int _unused : 31;
1369 };
1370 typedef struct _gpgme_op_keylist_result *gpgme_keylist_result_t;
1371
1372 /* Retrieve a pointer to the result of the key listing operation.  */
1373 gpgme_keylist_result_t gpgme_op_keylist_result (gpgme_ctx_t ctx);
1374
1375 /* Start a keylist operation within CTX, searching for keys which
1376    match PATTERN.  If SECRET_ONLY is true, only secret keys are
1377    returned.  */
1378 gpgme_error_t gpgme_op_keylist_start (gpgme_ctx_t ctx, const char *pattern,
1379                                       int secret_only);
1380 gpgme_error_t gpgme_op_keylist_ext_start (gpgme_ctx_t ctx,
1381                                           const char *pattern[],
1382                                           int secret_only, int reserved);
1383
1384 /* Return the next key from the keylist in R_KEY.  */
1385 gpgme_error_t gpgme_op_keylist_next (gpgme_ctx_t ctx, gpgme_key_t *r_key);
1386
1387 /* Terminate a pending keylist operation within CTX.  */
1388 gpgme_error_t gpgme_op_keylist_end (gpgme_ctx_t ctx);
1389
1390 \f
1391 /* Trust items and operations.  */
1392
1393 struct _gpgme_trust_item
1394 {
1395   /* Internal to GPGME, do not use.  */
1396   unsigned int _refs;
1397
1398   /* The key ID to which the trust item belongs.  */
1399   char *keyid;
1400
1401   /* Internal to GPGME, do not use.  */
1402   char _keyid[16 + 1];
1403
1404   /* The type of the trust item, 1 refers to a key, 2 to a user ID.  */
1405   int type;
1406
1407   /* The trust level.  */
1408   int level;
1409
1410   /* The owner trust if TYPE is 1.  */
1411   char *owner_trust;
1412
1413   /* Internal to GPGME, do not use.  */
1414   char _owner_trust[2];
1415
1416   /* The calculated validity.  */
1417   char *validity;
1418  
1419   /* Internal to GPGME, do not use.  */
1420   char _validity[2];
1421
1422   /* The user name if TYPE is 2.  */
1423   char *name;
1424 };
1425 typedef struct _gpgme_trust_item *gpgme_trust_item_t;
1426
1427 /* Start a trustlist operation within CTX, searching for trust items
1428    which match PATTERN.  */
1429 gpgme_error_t gpgme_op_trustlist_start (gpgme_ctx_t ctx,
1430                                         const char *pattern, int max_level);
1431
1432 /* Return the next trust item from the trustlist in R_ITEM.  */
1433 gpgme_error_t gpgme_op_trustlist_next (gpgme_ctx_t ctx,
1434                                        gpgme_trust_item_t *r_item);
1435
1436 /* Terminate a pending trustlist operation within CTX.  */
1437 gpgme_error_t gpgme_op_trustlist_end (gpgme_ctx_t ctx);
1438
1439 /* Acquire a reference to ITEM.  */
1440 void gpgme_trust_item_ref (gpgme_trust_item_t item);
1441
1442 /* Release a reference to ITEM.  If this was the last one the trust
1443    item is destroyed.  */
1444 void gpgme_trust_item_unref (gpgme_trust_item_t item);
1445
1446 /* Release the trust item ITEM.  Deprecated, use
1447    gpgme_trust_item_unref.  */
1448 void gpgme_trust_item_release (gpgme_trust_item_t item) _GPGME_DEPRECATED;
1449
1450 /* Return the value of the attribute WHAT of ITEM, which has to be
1451    representable by a string.  Deprecated, use trust item structure
1452    directly.  */
1453 const char *gpgme_trust_item_get_string_attr (gpgme_trust_item_t item,
1454                                               _gpgme_attr_t what,
1455                                               const void *reserved, int idx)
1456      _GPGME_DEPRECATED;
1457
1458 /* Return the value of the attribute WHAT of KEY, which has to be
1459    representable by an integer.  IDX specifies a running index if the
1460    attribute appears more than once in the key.  Deprecated, use trust
1461    item structure directly.  */
1462 int gpgme_trust_item_get_int_attr (gpgme_trust_item_t item, _gpgme_attr_t what,
1463                                    const void *reserved, int idx)
1464      _GPGME_DEPRECATED;
1465
1466 \f
1467 /* Various functions.  */
1468
1469 /* Check that the library fulfills the version requirement.  */
1470 const char *gpgme_check_version (const char *req_version);
1471
1472 /* Retrieve information about the backend engines.  */
1473 gpgme_error_t gpgme_get_engine_info (gpgme_engine_info_t *engine_info);
1474
1475 \f
1476 /* Engine support functions.  */
1477
1478 /* Verify that the engine implementing PROTO is installed and
1479    available.  */
1480 gpgme_error_t gpgme_engine_check_version (gpgme_protocol_t proto);
1481
1482 \f
1483 /* Deprecated types.  */
1484 typedef gpgme_ctx_t GpgmeCtx _GPGME_DEPRECATED;
1485 typedef gpgme_data_t GpgmeData _GPGME_DEPRECATED;
1486 typedef gpgme_error_t GpgmeError _GPGME_DEPRECATED;
1487 typedef gpgme_data_encoding_t GpgmeDataEncoding _GPGME_DEPRECATED;
1488 typedef gpgme_pubkey_algo_t GpgmePubKeyAlgo _GPGME_DEPRECATED;
1489 typedef gpgme_hash_algo_t GpgmeHashAlgo _GPGME_DEPRECATED;
1490 typedef gpgme_sig_stat_t GpgmeSigStat _GPGME_DEPRECATED;
1491 typedef gpgme_sig_mode_t GpgmeSigMode _GPGME_DEPRECATED;
1492 typedef gpgme_attr_t GpgmeAttr _GPGME_DEPRECATED;
1493 typedef gpgme_validity_t GpgmeValidity _GPGME_DEPRECATED;
1494 typedef gpgme_protocol_t GpgmeProtocol _GPGME_DEPRECATED;
1495 typedef gpgme_engine_info_t GpgmeEngineInfo _GPGME_DEPRECATED;
1496 typedef gpgme_subkey_t GpgmeSubkey _GPGME_DEPRECATED;
1497 typedef gpgme_key_sig_t GpgmeKeySig _GPGME_DEPRECATED;
1498 typedef gpgme_user_id_t GpgmeUserID _GPGME_DEPRECATED;
1499 typedef gpgme_key_t GpgmeKey _GPGME_DEPRECATED;
1500 typedef gpgme_passphrase_cb_t GpgmePassphraseCb _GPGME_DEPRECATED;
1501 typedef gpgme_progress_cb_t GpgmeProgressCb _GPGME_DEPRECATED;
1502 typedef gpgme_io_cb_t GpgmeIOCb _GPGME_DEPRECATED;
1503 typedef gpgme_register_io_cb_t GpgmeRegisterIOCb _GPGME_DEPRECATED;
1504 typedef gpgme_remove_io_cb_t GpgmeRemoveIOCb _GPGME_DEPRECATED;
1505 typedef gpgme_event_io_t GpgmeEventIO _GPGME_DEPRECATED;
1506 typedef gpgme_event_io_cb_t GpgmeEventIOCb _GPGME_DEPRECATED;
1507 #define GpgmeIOCbs gpgme_io_cbs
1508 typedef gpgme_data_read_cb_t GpgmeDataReadCb _GPGME_DEPRECATED;
1509 typedef gpgme_data_write_cb_t GpgmeDataWriteCb _GPGME_DEPRECATED;
1510 typedef gpgme_data_seek_cb_t GpgmeDataSeekCb _GPGME_DEPRECATED;
1511 typedef gpgme_data_release_cb_t GpgmeDataReleaseCb _GPGME_DEPRECATED;
1512 #define GpgmeDataCbs gpgme_data_cbs
1513 typedef gpgme_encrypt_result_t GpgmeEncryptResult _GPGME_DEPRECATED;
1514 typedef gpgme_sig_notation_t GpgmeSigNotation _GPGME_DEPRECATED;
1515 typedef gpgme_signature_t GpgmeSignature _GPGME_DEPRECATED;
1516 typedef gpgme_verify_result_t GpgmeVerifyResult _GPGME_DEPRECATED;
1517 typedef gpgme_import_status_t GpgmeImportStatus _GPGME_DEPRECATED;
1518 typedef gpgme_import_result_t GpgmeImportResult _GPGME_DEPRECATED;
1519 typedef gpgme_genkey_result_t GpgmeGenKeyResult _GPGME_DEPRECATED;
1520 typedef gpgme_trust_item_t GpgmeTrustItem _GPGME_DEPRECATED;
1521 typedef gpgme_status_code_t GpgmeStatusCode _GPGME_DEPRECATED;
1522
1523 #ifdef __cplusplus
1524 }
1525 #endif
1526 #endif /* GPGME_H */