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