84516f91dda9af37d45853f67b50d6ffa8865223
[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-2017 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  * Generated from gpgme.h.in for @GPGME_CONFIG_HOST@.
21  */
22
23 #ifndef GPGME_H
24 #define GPGME_H
25
26 /* Include stdio.h for the FILE type definition.  */
27 #include <stdio.h>
28 #include <time.h>
29 #include <gpg-error.h>
30
31 #ifdef __cplusplus
32 extern "C" {
33 #if 0 /*(Make Emacsen's auto-indent happy.)*/
34 }
35 #endif
36 #endif /* __cplusplus */
37
38
39 /* The version of this header should match the one of the library.  Do
40  * not use this symbol in your application, use gpgme_check_version
41  * instead.  The purpose of this macro is to let autoconf (using the
42  * AM_PATH_GPGME macro) check that this header matches the installed
43  * library.  */
44 #define GPGME_VERSION "@PACKAGE_VERSION@"
45
46 /* The version number of this header.  It may be used to handle minor
47  * API incompatibilities.  */
48 #define GPGME_VERSION_NUMBER @VERSION_NUMBER@
49
50
51 /* System specific typedefs.  */
52 @INSERT__TYPEDEFS_FOR_GPGME_H@
53
54
55 \f
56 /*
57  * Check for compiler features.
58  */
59 #ifdef GPGRT_INLINE
60 # define _GPGME_INLINE GPGRT_INLINE
61 #elif defined(__GNUC__)
62 # define _GPGME_INLINE __inline__
63 #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
64 # define _GPGME_INLINE inline
65 #else
66 # define _GPGME_INLINE
67 #endif
68
69
70 /* The deprecated macro takes the version number of GPGME which
71  * introduced the deprecation as parameter for documentation.  */
72 #ifdef GPGRT_ATTR_DEPRECATED
73 # define _GPGME_DEPRECATED(a,b) GPGRT_ATTR_DEPRECATED
74 #elif defined(__GNUC__)
75 # define _GPGME_GCC_VERSION (__GNUC__ * 10000 \
76                              + __GNUC_MINOR__ * 100 \
77                              + __GNUC_PATCHLEVEL__)
78
79 # if _GPGME_GCC_VERSION > 30100
80 #  define _GPGME_DEPRECATED(a,b)  __attribute__ ((__deprecated__))
81 # else
82 #  define _GPGME_DEPRECATED(a,b)
83 # endif
84 #else
85 # define _GPGME_DEPRECATED(a,b)
86 #endif
87
88
89 /* The macro _GPGME_DEPRECATED_OUTSIDE_GPGME suppresses warnings for
90  * fields we must access in GPGME for ABI compatibility.  */
91 #ifdef _GPGME_IN_GPGME
92 #define _GPGME_DEPRECATED_OUTSIDE_GPGME(a,b)
93 #else
94 #define _GPGME_DEPRECATED_OUTSIDE_GPGME(a,b) _GPGME_DEPRECATED(a,b)
95 #endif
96
97
98 /* Check for a matching _FILE_OFFSET_BITS definition.  */
99 #if @NEED__FILE_OFFSET_BITS@
100 #ifndef _FILE_OFFSET_BITS
101 #error GPGME was compiled with _FILE_OFFSET_BITS = @NEED__FILE_OFFSET_BITS@, please see the section "Largefile support (LFS)" in the GPGME manual.
102 #else
103 #if (_FILE_OFFSET_BITS) != (@NEED__FILE_OFFSET_BITS@)
104 #error GPGME was compiled with a different value for _FILE_OFFSET_BITS, namely @NEED__FILE_OFFSET_BITS@, please see the section "Largefile support (LFS)" in the GPGME manual.
105 #endif
106 #endif
107 #endif
108
109
110 \f
111 /*
112  * Some opaque data types used by GPGME.
113  */
114
115 /* The context holds some global state and configuration options, as
116  * well as the results of a crypto operation.  */
117 struct gpgme_context;
118 typedef struct gpgme_context *gpgme_ctx_t;
119
120 /* The data object is used by GPGME to exchange arbitrary data.  */
121 struct gpgme_data;
122 typedef struct gpgme_data *gpgme_data_t;
123
124
125 \f
126 /*
127  * Wrappers for the libgpg-error library.  They are generally not
128  * needed and the gpg-error versions may be used instead.
129  */
130
131 typedef gpg_error_t gpgme_error_t;
132 typedef gpg_err_code_t gpgme_err_code_t;
133 typedef gpg_err_source_t gpgme_err_source_t;
134
135
136 static _GPGME_INLINE gpgme_error_t
137 gpgme_err_make (gpgme_err_source_t source, gpgme_err_code_t code)
138 {
139   return gpg_err_make (source, code);
140 }
141
142
143 /* The user can define GPGME_ERR_SOURCE_DEFAULT before including this
144  * file to specify a default source for gpgme_error.  */
145 #ifndef GPGME_ERR_SOURCE_DEFAULT
146 #define GPGME_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_USER_1
147 #endif
148
149 static _GPGME_INLINE gpgme_error_t
150 gpgme_error (gpgme_err_code_t code)
151 {
152   return gpgme_err_make (GPGME_ERR_SOURCE_DEFAULT, code);
153 }
154
155
156 static _GPGME_INLINE gpgme_err_code_t
157 gpgme_err_code (gpgme_error_t err)
158 {
159   return gpg_err_code (err);
160 }
161
162
163 static _GPGME_INLINE gpgme_err_source_t
164 gpgme_err_source (gpgme_error_t err)
165 {
166   return gpg_err_source (err);
167 }
168
169
170 /* Return a pointer to a string containing a description of the error
171  * code in the error value ERR.  This function is not thread safe.  */
172 const char *gpgme_strerror (gpgme_error_t err);
173
174 /* Return the error string for ERR in the user-supplied buffer BUF of
175  * size BUFLEN.  This function is, in contrast to gpg_strerror,
176  * thread-safe if a thread-safe strerror_r() function is provided by
177  * the system.  If the function succeeds, 0 is returned and BUF
178  * contains the string describing the error.  If the buffer was not
179  * large enough, ERANGE is returned and BUF contains as much of the
180  * beginning of the error string as fits into the buffer.  */
181 int gpgme_strerror_r (gpg_error_t err, char *buf, size_t buflen);
182
183 /* Return a pointer to a string containing a description of the error
184  * source in the error value ERR.  */
185 const char *gpgme_strsource (gpgme_error_t err);
186
187 /* Retrieve the error code for the system error ERR.  This returns
188  * GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
189  * this).  */
190 gpgme_err_code_t gpgme_err_code_from_errno (int err);
191
192 /* Retrieve the system error for the error code CODE.  This returns 0
193  * if CODE is not a system error code.  */
194 int gpgme_err_code_to_errno (gpgme_err_code_t code);
195
196 /* Retrieve the error code directly from the ERRNO variable.  This
197  * returns GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped
198  * (report this) and GPG_ERR_MISSING_ERRNO if ERRNO has the value 0. */
199 gpgme_err_code_t gpgme_err_code_from_syserror (void);
200
201 /* Set the ERRNO variable.  This function is the preferred way to set
202  * ERRNO due to peculiarities on WindowsCE.  */
203 void gpgme_err_set_errno (int err);
204
205 /* Return an error value with the error source SOURCE and the system
206  *  error ERR.  FIXME: Should be inline.  */
207 gpgme_error_t gpgme_err_make_from_errno (gpgme_err_source_t source, int err);
208
209 /* Return an error value with the system error ERR.
210  * inline.  */
211 gpgme_error_t gpgme_error_from_errno (int err);
212
213
214 static _GPGME_INLINE gpgme_error_t
215 gpgme_error_from_syserror (void)
216 {
217   return gpgme_error (gpgme_err_code_from_syserror ());
218 }
219
220
221 \f
222 /*
223  * Various constants and types
224  */
225
226 /* The possible encoding mode of gpgme_data_t objects.  */
227 typedef enum
228   {
229     GPGME_DATA_ENCODING_NONE   = 0,     /* Not specified.  */
230     GPGME_DATA_ENCODING_BINARY = 1,
231     GPGME_DATA_ENCODING_BASE64 = 2,
232     GPGME_DATA_ENCODING_ARMOR  = 3,     /* Either PEM or OpenPGP Armor.  */
233     GPGME_DATA_ENCODING_URL    = 4,     /* LF delimited URL list.        */
234     GPGME_DATA_ENCODING_URLESC = 5,     /* Ditto, but percent escaped.   */
235     GPGME_DATA_ENCODING_URL0   = 6,     /* Nul delimited URL list.       */
236     GPGME_DATA_ENCODING_MIME   = 7      /* Data is a MIME part.          */
237   }
238 gpgme_data_encoding_t;
239
240
241 /* Known data types.  */
242 typedef enum
243   {
244     GPGME_DATA_TYPE_INVALID      = 0,   /* Not detected.  */
245     GPGME_DATA_TYPE_UNKNOWN      = 1,
246     GPGME_DATA_TYPE_PGP_SIGNED   = 0x10,
247     GPGME_DATA_TYPE_PGP_ENCRYPTED= 0x11,
248     GPGME_DATA_TYPE_PGP_OTHER    = 0x12,
249     GPGME_DATA_TYPE_PGP_KEY      = 0x13,
250     GPGME_DATA_TYPE_PGP_SIGNATURE= 0x18, /* Detached signature */
251     GPGME_DATA_TYPE_CMS_SIGNED   = 0x20,
252     GPGME_DATA_TYPE_CMS_ENCRYPTED= 0x21,
253     GPGME_DATA_TYPE_CMS_OTHER    = 0x22,
254     GPGME_DATA_TYPE_X509_CERT    = 0x23,
255     GPGME_DATA_TYPE_PKCS12       = 0x24,
256   }
257 gpgme_data_type_t;
258
259
260 /* Public key algorithms.  */
261 typedef enum
262   {
263     GPGME_PK_RSA   = 1,
264     GPGME_PK_RSA_E = 2,
265     GPGME_PK_RSA_S = 3,
266     GPGME_PK_ELG_E = 16,
267     GPGME_PK_DSA   = 17,
268     GPGME_PK_ECC   = 18,
269     GPGME_PK_ELG   = 20,
270     GPGME_PK_ECDSA = 301,
271     GPGME_PK_ECDH  = 302,
272     GPGME_PK_EDDSA = 303
273   }
274 gpgme_pubkey_algo_t;
275
276
277 /* Hash algorithms (the values match those from libgcrypt).  */
278 typedef enum
279   {
280     GPGME_MD_NONE          = 0,
281     GPGME_MD_MD5           = 1,
282     GPGME_MD_SHA1          = 2,
283     GPGME_MD_RMD160        = 3,
284     GPGME_MD_MD2           = 5,
285     GPGME_MD_TIGER         = 6,   /* TIGER/192. */
286     GPGME_MD_HAVAL         = 7,   /* HAVAL, 5 pass, 160 bit. */
287     GPGME_MD_SHA256        = 8,
288     GPGME_MD_SHA384        = 9,
289     GPGME_MD_SHA512        = 10,
290     GPGME_MD_SHA224        = 11,
291     GPGME_MD_MD4           = 301,
292     GPGME_MD_CRC32         = 302,
293     GPGME_MD_CRC32_RFC1510 = 303,
294     GPGME_MD_CRC24_RFC2440 = 304
295   }
296 gpgme_hash_algo_t;
297
298
299 /* The available signature modes.  */
300 typedef enum
301   {
302     GPGME_SIG_MODE_NORMAL = 0,
303     GPGME_SIG_MODE_DETACH = 1,
304     GPGME_SIG_MODE_CLEAR  = 2
305   }
306 gpgme_sig_mode_t;
307
308
309 /* The available validities for a trust item or key.  */
310 typedef enum
311   {
312     GPGME_VALIDITY_UNKNOWN   = 0,
313     GPGME_VALIDITY_UNDEFINED = 1,
314     GPGME_VALIDITY_NEVER     = 2,
315     GPGME_VALIDITY_MARGINAL  = 3,
316     GPGME_VALIDITY_FULL      = 4,
317     GPGME_VALIDITY_ULTIMATE  = 5
318   }
319 gpgme_validity_t;
320
321
322 /* The TOFU policies. */
323 typedef enum
324   {
325     GPGME_TOFU_POLICY_NONE    = 0,
326     GPGME_TOFU_POLICY_AUTO    = 1,
327     GPGME_TOFU_POLICY_GOOD    = 2,
328     GPGME_TOFU_POLICY_UNKNOWN = 3,
329     GPGME_TOFU_POLICY_BAD     = 4,
330     GPGME_TOFU_POLICY_ASK     = 5
331   }
332 gpgme_tofu_policy_t;
333
334
335 /* The key origin values. */
336 typedef enum
337   {
338     GPGME_KEYORG_UNKNOWN      = 0,
339     GPGME_KEYORG_KS           = 1,
340     GPGME_KEYORG_DANE         = 3,
341     GPGME_KEYORG_WKD          = 4,
342     GPGME_KEYORG_URL          = 5,
343     GPGME_KEYORG_FILE         = 6,
344     GPGME_KEYORG_SELF         = 7,
345     GPGME_KEYORG_OTHER        = 31
346   }
347 gpgme_keyorg_t;
348
349
350 /* The available protocols.  */
351 typedef enum
352   {
353     GPGME_PROTOCOL_OpenPGP = 0,  /* The default mode.  */
354     GPGME_PROTOCOL_CMS     = 1,
355     GPGME_PROTOCOL_GPGCONF = 2,  /* Special code for gpgconf.  */
356     GPGME_PROTOCOL_ASSUAN  = 3,  /* Low-level access to an Assuan server.  */
357     GPGME_PROTOCOL_G13     = 4,
358     GPGME_PROTOCOL_UISERVER= 5,
359     GPGME_PROTOCOL_SPAWN   = 6,  /* Direct access to any program.  */
360     GPGME_PROTOCOL_DEFAULT = 254,
361     GPGME_PROTOCOL_UNKNOWN = 255
362   }
363 gpgme_protocol_t;
364 /* Convenience macro for the surprisingly mixed spelling.  */
365 #define GPGME_PROTOCOL_OPENPGP GPGME_PROTOCOL_OpenPGP
366
367
368 /* The available keylist mode flags.  */
369 #define GPGME_KEYLIST_MODE_LOCAL                1
370 #define GPGME_KEYLIST_MODE_EXTERN               2
371 #define GPGME_KEYLIST_MODE_SIGS                 4
372 #define GPGME_KEYLIST_MODE_SIG_NOTATIONS        8
373 #define GPGME_KEYLIST_MODE_WITH_SECRET          16
374 #define GPGME_KEYLIST_MODE_WITH_TOFU            32
375 #define GPGME_KEYLIST_MODE_EPHEMERAL            128
376 #define GPGME_KEYLIST_MODE_VALIDATE             256
377
378 #define GPGME_KEYLIST_MODE_LOCATE               (1|2)
379
380 typedef unsigned int gpgme_keylist_mode_t;
381
382
383 /* The pinentry modes. */
384 typedef enum
385   {
386     GPGME_PINENTRY_MODE_DEFAULT  = 0,
387     GPGME_PINENTRY_MODE_ASK      = 1,
388     GPGME_PINENTRY_MODE_CANCEL   = 2,
389     GPGME_PINENTRY_MODE_ERROR    = 3,
390     GPGME_PINENTRY_MODE_LOOPBACK = 4
391   }
392 gpgme_pinentry_mode_t;
393
394
395 /* The available export mode flags.  */
396 #define GPGME_EXPORT_MODE_EXTERN                2
397 #define GPGME_EXPORT_MODE_MINIMAL               4
398 #define GPGME_EXPORT_MODE_SECRET               16
399 #define GPGME_EXPORT_MODE_RAW                  32
400 #define GPGME_EXPORT_MODE_PKCS12               64
401
402 typedef unsigned int gpgme_export_mode_t;
403
404
405 /* Flags for the audit log functions.  */
406 #define GPGME_AUDITLOG_HTML      1
407 #define GPGME_AUDITLOG_WITH_HELP 128
408
409
410 /* The available signature notation flags.  */
411 #define GPGME_SIG_NOTATION_HUMAN_READABLE       1
412 #define GPGME_SIG_NOTATION_CRITICAL             2
413
414 typedef unsigned int gpgme_sig_notation_flags_t;
415
416 /* An object to hold information about notation data.  This structure
417  * shall be considered read-only and an application must not allocate
418  * such a structure on its own.  */
419 struct _gpgme_sig_notation
420 {
421   struct _gpgme_sig_notation *next;
422
423   /* If NAME is a null pointer, then VALUE contains a policy URL
424    * rather than a notation.  */
425   char *name;
426
427   /* The value of the notation data.  */
428   char *value;
429
430   /* The length of the name of the notation data.  */
431   int name_len;
432
433   /* The length of the value of the notation data.  */
434   int value_len;
435
436   /* The accumulated flags.  */
437   gpgme_sig_notation_flags_t flags;
438
439   /* Notation data is human-readable.  */
440   unsigned int human_readable : 1;
441
442   /* Notation data is critical.  */
443   unsigned int critical : 1;
444
445   /* Internal to GPGME, do not use.  */
446   int _unused : 30;
447 };
448 typedef struct _gpgme_sig_notation *gpgme_sig_notation_t;
449
450
451 \f
452 /*
453  * Public structures.
454  */
455
456 /* The engine information structure.
457  * This structure shall be considered read-only and an application
458  * must not allocate such a structure on its own.  */
459 struct _gpgme_engine_info
460 {
461   struct _gpgme_engine_info *next;
462
463   /* The protocol ID.  */
464   gpgme_protocol_t protocol;
465
466   /* The file name of the engine binary.  */
467   char *file_name;
468
469   /* The version string of the installed engine.  */
470   char *version;
471
472   /* The minimum version required for GPGME.  */
473   const char *req_version;
474
475   /* The home directory used, or NULL if default.  */
476   char *home_dir;
477 };
478 typedef struct _gpgme_engine_info *gpgme_engine_info_t;
479
480
481 /* An object with TOFU information.
482  * This structure shall be considered read-only and an application
483  * must not allocate such a structure on its own.  */
484 struct _gpgme_tofu_info
485 {
486   struct _gpgme_tofu_info *next;
487
488   /* The TOFU validity:
489    *  0 := conflict
490    *  1 := key without history
491    *  2 := key with too little history
492    *  3 := key with enough history for basic trust
493    *  4 := key with a lot of history
494    */
495   unsigned int validity : 3;
496
497   /* The TOFU policy (gpgme_tofu_policy_t).  */
498   unsigned int policy : 4;
499
500   unsigned int _rfu : 25;
501
502   /* Number of signatures seen for this binding.  Capped at USHRT_MAX.  */
503   unsigned short signcount;
504   /* Number of encryptions done with this binding.  Capped at USHRT_MAX.  */
505   unsigned short encrcount;
506
507   /* Number of seconds since Epoch when the first and the most
508    * recently seen message were verified/decrypted.  0 means unknown. */
509   unsigned long signfirst;
510   unsigned long signlast;
511   unsigned long encrfirst;
512   unsigned long encrlast;
513
514   /* If non-NULL a human readable string summarizing the TOFU data. */
515   char *description;
516 };
517 typedef struct _gpgme_tofu_info *gpgme_tofu_info_t;
518
519
520 /* A subkey from a key.
521  * This structure shall be considered read-only and an application
522  * must not allocate such a structure on its own.  */
523 struct _gpgme_subkey
524 {
525   struct _gpgme_subkey *next;
526
527   /* True if subkey is revoked.  */
528   unsigned int revoked : 1;
529
530   /* True if subkey is expired.  */
531   unsigned int expired : 1;
532
533   /* True if subkey is disabled.  */
534   unsigned int disabled : 1;
535
536   /* True if subkey is invalid.  */
537   unsigned int invalid : 1;
538
539   /* True if subkey can be used for encryption.  */
540   unsigned int can_encrypt : 1;
541
542   /* True if subkey can be used for signing.  */
543   unsigned int can_sign : 1;
544
545   /* True if subkey can be used for certification.  */
546   unsigned int can_certify : 1;
547
548   /* True if subkey is secret.  */
549   unsigned int secret : 1;
550
551   /* True if subkey can be used for authentication.  */
552   unsigned int can_authenticate : 1;
553
554   /* True if subkey is qualified for signatures according to German law.  */
555   unsigned int is_qualified : 1;
556
557   /* True if the secret key is stored on a smart card.  */
558   unsigned int is_cardkey : 1;
559
560   /* True if the key is compliant to the de-vs mode.  */
561   unsigned int is_de_vs : 1;
562
563   /* Internal to GPGME, do not use.  */
564   unsigned int _unused : 20;
565
566   /* Public key algorithm supported by this subkey.  */
567   gpgme_pubkey_algo_t pubkey_algo;
568
569   /* Length of the subkey.  */
570   unsigned int length;
571
572   /* The key ID of the subkey.  */
573   char *keyid;
574
575   /* Internal to GPGME, do not use.  */
576   char _keyid[16 + 1];
577
578   /* The fingerprint of the subkey in hex digit form.  */
579   char *fpr;
580
581   /* The creation timestamp, -1 if invalid, 0 if not available.  */
582   long int timestamp;
583
584   /* The expiration timestamp, 0 if the subkey does not expire.  */
585   long int expires;
586
587   /* The serial number of a smart card holding this key or NULL.  */
588   char *card_number;
589
590   /* The name of the curve for ECC algorithms or NULL.  */
591   char *curve;
592
593   /* The keygrip of the subkey in hex digit form or NULL if not availabale.  */
594   char *keygrip;
595 };
596 typedef struct _gpgme_subkey *gpgme_subkey_t;
597
598
599 /* A signature on a user ID.
600  * This structure shall be considered read-only and an application
601  * must not allocate such a structure on its own.  */
602 struct _gpgme_key_sig
603 {
604   struct _gpgme_key_sig *next;
605
606   /* True if the signature is a revocation signature.  */
607   unsigned int revoked : 1;
608
609   /* True if the signature is expired.  */
610   unsigned int expired : 1;
611
612   /* True if the signature is invalid.  */
613   unsigned int invalid : 1;
614
615   /* True if the signature should be exported.  */
616   unsigned int exportable : 1;
617
618   /* Internal to GPGME, do not use.  */
619   unsigned int _unused : 28;
620
621   /* The public key algorithm used to create the signature.  */
622   gpgme_pubkey_algo_t pubkey_algo;
623
624   /* The key ID of key used to create the signature.  */
625   char *keyid;
626
627   /* Internal to GPGME, do not use.  */
628   char _keyid[16 + 1];
629
630   /* The creation timestamp, -1 if invalid, 0 if not available.  */
631   long int timestamp;
632
633   /* The expiration timestamp, 0 if the subkey does not expire.  */
634   long int expires;
635
636   /* Same as in gpgme_signature_t.  */
637   gpgme_error_t status;
638
639   /* Deprecated; use SIG_CLASS instead.  */
640 #ifdef __cplusplus
641   unsigned int _obsolete_class _GPGME_DEPRECATED(0,4);
642 #else
643   unsigned int class _GPGME_DEPRECATED_OUTSIDE_GPGME(0,4);
644 #endif
645
646   /* The user ID string.  */
647   char *uid;
648
649   /* The name part of the user ID.  */
650   char *name;
651
652   /* The email part of the user ID.  */
653   char *email;
654
655   /* The comment part of the user ID.  */
656   char *comment;
657
658   /* Crypto backend specific signature class.  */
659   unsigned int sig_class;
660
661   /* Notation data and policy URLs.  */
662   gpgme_sig_notation_t notations;
663
664   /* Internal to GPGME, do not use.  */
665   gpgme_sig_notation_t _last_notation;
666 };
667 typedef struct _gpgme_key_sig *gpgme_key_sig_t;
668
669
670 /* An user ID from a key.
671  * This structure shall be considered read-only and an application
672  * must not allocate such a structure on its own.  */
673 struct _gpgme_user_id
674 {
675   struct _gpgme_user_id *next;
676
677   /* True if the user ID is revoked.  */
678   unsigned int revoked : 1;
679
680   /* True if the user ID is invalid.  */
681   unsigned int invalid : 1;
682
683   /* Internal to GPGME, do not use.  */
684   unsigned int _unused : 25;
685
686   /* Origin of this user ID.  */
687   unsigned int origin : 5;
688
689   /* The validity of the user ID.  */
690   gpgme_validity_t validity;
691
692   /* The user ID string.  */
693   char *uid;
694
695   /* The name part of the user ID.  */
696   char *name;
697
698   /* The email part of the user ID.  */
699   char *email;
700
701   /* The comment part of the user ID.  */
702   char *comment;
703
704   /* The signatures of the user ID.  */
705   gpgme_key_sig_t signatures;
706
707   /* Internal to GPGME, do not use.  */
708   gpgme_key_sig_t _last_keysig;
709
710   /* The mail address (addr-spec from RFC5322) of the UID string.
711    * This is general the same as the EMAIL part of this struct but
712    * might be slightly different.  If no mail address is available
713    * NULL is stored.  */
714   char *address;
715
716   /* The malloced TOFU information or NULL.  */
717   gpgme_tofu_info_t tofu;
718
719   /* Time of the last refresh of this user id.  0 if unknown.  */
720   unsigned long last_update;
721 };
722 typedef struct _gpgme_user_id *gpgme_user_id_t;
723
724
725 /* A key from the keyring.
726  * This structure shall be considered read-only and an application
727  * must not allocate such a structure on its own.  */
728 struct _gpgme_key
729 {
730   /* Internal to GPGME, do not use.  */
731   unsigned int _refs;
732
733   /* True if key is revoked.  */
734   unsigned int revoked : 1;
735
736   /* True if key is expired.  */
737   unsigned int expired : 1;
738
739   /* True if key is disabled.  */
740   unsigned int disabled : 1;
741
742   /* True if key is invalid.  */
743   unsigned int invalid : 1;
744
745   /* True if key can be used for encryption.  */
746   unsigned int can_encrypt : 1;
747
748   /* True if key can be used for signing.  */
749   unsigned int can_sign : 1;
750
751   /* True if key can be used for certification.  */
752   unsigned int can_certify : 1;
753
754   /* True if key is secret.  */
755   unsigned int secret : 1;
756
757   /* True if key can be used for authentication.  */
758   unsigned int can_authenticate : 1;
759
760   /* True if subkey is qualified for signatures according to German law.  */
761   unsigned int is_qualified : 1;
762
763   /* Internal to GPGME, do not use.  */
764   unsigned int _unused : 17;
765
766   /* Origin of this key.  */
767   unsigned int origin : 5;
768
769   /* This is the protocol supported by this key.  */
770   gpgme_protocol_t protocol;
771
772   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
773      issuer serial.  */
774   char *issuer_serial;
775
776   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the
777      issuer name.  */
778   char *issuer_name;
779
780   /* If protocol is GPGME_PROTOCOL_CMS, this string contains the chain
781      ID.  */
782   char *chain_id;
783
784   /* If protocol is GPGME_PROTOCOL_OpenPGP, this field contains the
785      owner trust.  */
786   gpgme_validity_t owner_trust;
787
788   /* The subkeys of the key.  */
789   gpgme_subkey_t subkeys;
790
791   /* The user IDs of the key.  */
792   gpgme_user_id_t uids;
793
794   /* Internal to GPGME, do not use.  */
795   gpgme_subkey_t _last_subkey;
796
797   /* Internal to GPGME, do not use.  */
798   gpgme_user_id_t _last_uid;
799
800   /* The keylist mode that was active when listing the key.  */
801   gpgme_keylist_mode_t keylist_mode;
802
803   /* This field gives the fingerprint of the primary key.  Note that
804    * this is a copy of the FPR of the first subkey.  We need it here
805    * to allow for an incomplete key object.  */
806   char *fpr;
807
808   /* Time of the last refresh of the entire key.  0 if unknown.  */
809   unsigned long last_update;
810 };
811 typedef struct _gpgme_key *gpgme_key_t;
812
813
814 /* An invalid key object.
815  * This structure shall be considered read-only and an application
816  * must not allocate such a structure on its own.  */
817 struct _gpgme_invalid_key
818 {
819   struct _gpgme_invalid_key *next;
820
821   /* The string used to request the key.  Despite the name this may
822    * not be a fingerprint.  */
823   char *fpr;
824
825   /* The error code.  */
826   gpgme_error_t reason;
827 };
828 typedef struct _gpgme_invalid_key *gpgme_invalid_key_t;
829
830
831 \f
832 /*
833  * Types for callback functions.
834  */
835
836 /* Request a passphrase from the user.  */
837 typedef gpgme_error_t (*gpgme_passphrase_cb_t) (void *hook,
838                                                 const char *uid_hint,
839                                                 const char *passphrase_info,
840                                                 int prev_was_bad, int fd);
841
842 /* Inform the user about progress made.  */
843 typedef void (*gpgme_progress_cb_t) (void *opaque, const char *what,
844                                      int type, int current, int total);
845
846 /* Status messages from gpg. */
847 typedef gpgme_error_t (*gpgme_status_cb_t) (void *opaque, const char *keyword,
848                                             const char *args);
849
850 /* Interact with the user about an edit operation.  */
851 typedef gpgme_error_t (*gpgme_interact_cb_t) (void *opaque,
852                                               const char *keyword,
853                                               const char *args, int fd);
854
855
856 \f
857 /*
858  * Context management functions.
859  */
860
861 /* Create a new context and return it in CTX.  */
862 gpgme_error_t gpgme_new (gpgme_ctx_t *ctx);
863
864 /* Release the context CTX.  */
865 void gpgme_release (gpgme_ctx_t ctx);
866
867 /* Set the flag NAME for CTX to VALUE.  */
868 gpgme_error_t gpgme_set_ctx_flag (gpgme_ctx_t ctx,
869                                   const char *name, const char *value);
870
871 /* Get the value of the flag NAME from CTX.  */
872 const char *gpgme_get_ctx_flag (gpgme_ctx_t ctx, const char *name);
873
874 /* Set the protocol to be used by CTX to PROTO.  */
875 gpgme_error_t gpgme_set_protocol (gpgme_ctx_t ctx, gpgme_protocol_t proto);
876
877 /* Get the protocol used with CTX */
878 gpgme_protocol_t gpgme_get_protocol (gpgme_ctx_t ctx);
879
880 /* Set the crypto protocol to be used by CTX to PROTO.
881  * gpgme_set_protocol actually sets the backend engine.  This sets the
882  * crypto protocol used in engines that support more than one crypto
883  * prococol (for example, an UISERVER can support OpenPGP and CMS).
884  * This is reset to the default with gpgme_set_protocol.  */
885 gpgme_error_t gpgme_set_sub_protocol (gpgme_ctx_t ctx,
886                                       gpgme_protocol_t proto);
887
888 /* Get the sub protocol.  */
889 gpgme_protocol_t gpgme_get_sub_protocol (gpgme_ctx_t ctx);
890
891 /* Get the string describing protocol PROTO, or NULL if invalid.  */
892 const char *gpgme_get_protocol_name (gpgme_protocol_t proto);
893
894 /* If YES is non-zero, enable armor mode in CTX, disable it otherwise.  */
895 void gpgme_set_armor (gpgme_ctx_t ctx, int yes);
896
897 /* Return non-zero if armor mode is set in CTX.  */
898 int gpgme_get_armor (gpgme_ctx_t ctx);
899
900 /* If YES is non-zero, enable text mode in CTX, disable it otherwise.  */
901 void gpgme_set_textmode (gpgme_ctx_t ctx, int yes);
902
903 /* Return non-zero if text mode is set in CTX.  */
904 int gpgme_get_textmode (gpgme_ctx_t ctx);
905
906 /* If YES is non-zero, enable offline mode in CTX, disable it otherwise.  */
907 void gpgme_set_offline (gpgme_ctx_t ctx, int yes);
908
909 /* Return non-zero if offline mode is set in CTX.  */
910 int gpgme_get_offline (gpgme_ctx_t ctx);
911
912 /* Use whatever the default of the backend crypto engine is.  */
913 #define GPGME_INCLUDE_CERTS_DEFAULT     -256
914
915 /* Include up to NR_OF_CERTS certificates in an S/MIME message.  */
916 void gpgme_set_include_certs (gpgme_ctx_t ctx, int nr_of_certs);
917
918 /* Return the number of certs to include in an S/MIME message.  */
919 int gpgme_get_include_certs (gpgme_ctx_t ctx);
920
921 /* Set keylist mode in CTX to MODE.  */
922 gpgme_error_t gpgme_set_keylist_mode (gpgme_ctx_t ctx,
923                                       gpgme_keylist_mode_t mode);
924
925 /* Get keylist mode in CTX.  */
926 gpgme_keylist_mode_t gpgme_get_keylist_mode (gpgme_ctx_t ctx);
927
928 /* Set the pinentry mode for CTX to MODE. */
929 gpgme_error_t gpgme_set_pinentry_mode (gpgme_ctx_t ctx,
930                                        gpgme_pinentry_mode_t mode);
931
932 /* Get the pinentry mode of CTX.  */
933 gpgme_pinentry_mode_t gpgme_get_pinentry_mode (gpgme_ctx_t ctx);
934
935 /* Set the passphrase callback function in CTX to CB.  HOOK_VALUE is
936  * passed as first argument to the passphrase callback function.  */
937 void gpgme_set_passphrase_cb (gpgme_ctx_t ctx,
938                               gpgme_passphrase_cb_t cb, void *hook_value);
939
940 /* Get the current passphrase callback function in *CB and the current
941  * hook value in *HOOK_VALUE.  */
942 void gpgme_get_passphrase_cb (gpgme_ctx_t ctx, gpgme_passphrase_cb_t *cb,
943                               void **hook_value);
944
945 /* Set the progress callback function in CTX to CB.  HOOK_VALUE is
946  * passed as first argument to the progress callback function.  */
947 void gpgme_set_progress_cb (gpgme_ctx_t c, gpgme_progress_cb_t cb,
948                             void *hook_value);
949
950 /* Get the current progress callback function in *CB and the current
951  * hook value in *HOOK_VALUE.  */
952 void gpgme_get_progress_cb (gpgme_ctx_t ctx, gpgme_progress_cb_t *cb,
953                             void **hook_value);
954
955 /* Set the status callback function in CTX to CB.  HOOK_VALUE is
956  * passed as first argument to the status callback function.  */
957 void gpgme_set_status_cb (gpgme_ctx_t c, gpgme_status_cb_t cb,
958                           void *hook_value);
959
960 /* Get the current status callback function in *CB and the current
961  * hook value in *HOOK_VALUE.  */
962 void gpgme_get_status_cb (gpgme_ctx_t ctx, gpgme_status_cb_t *cb,
963                           void **hook_value);
964
965 /* This function sets the locale for the context CTX, or the default
966  * locale if CTX is a null pointer.  */
967 gpgme_error_t gpgme_set_locale (gpgme_ctx_t ctx, int category,
968                                 const char *value);
969
970 /* Get the information about the configured engines.  A pointer to the
971  * first engine in the statically allocated linked list is returned.
972  * The returned data is valid until the next gpgme_ctx_set_engine_info.  */
973 gpgme_engine_info_t gpgme_ctx_get_engine_info (gpgme_ctx_t ctx);
974
975 /* Set the engine info for the context CTX, protocol PROTO, to the
976  * file name FILE_NAME and the home directory HOME_DIR.  */
977 gpgme_error_t gpgme_ctx_set_engine_info (gpgme_ctx_t ctx,
978                                          gpgme_protocol_t proto,
979                                          const char *file_name,
980                                          const char *home_dir);
981
982 /* Delete all signers from CTX.  */
983 void gpgme_signers_clear (gpgme_ctx_t ctx);
984
985 /* Add KEY to list of signers in CTX.  */
986 gpgme_error_t gpgme_signers_add (gpgme_ctx_t ctx, const gpgme_key_t key);
987
988 /* Return the number of signers in CTX.  */
989 unsigned int gpgme_signers_count (const gpgme_ctx_t ctx);
990
991 /* Return the SEQth signer's key in CTX.  */
992 gpgme_key_t gpgme_signers_enum (const gpgme_ctx_t ctx, int seq);
993
994 /* Clear all notation data from the context.  */
995 void gpgme_sig_notation_clear (gpgme_ctx_t ctx);
996
997 /* Add the human-readable notation data with name NAME and value VALUE
998  * to the context CTX, using the flags FLAGS.  If NAME is NULL, then
999  * VALUE should be a policy URL.  The flag
1000  * GPGME_SIG_NOTATION_HUMAN_READABLE is forced to be true for notation
1001  * data, and false for policy URLs.  */
1002 gpgme_error_t gpgme_sig_notation_add (gpgme_ctx_t ctx, const char *name,
1003                                       const char *value,
1004                                       gpgme_sig_notation_flags_t flags);
1005
1006 /* Get the sig notations for this context.  */
1007 gpgme_sig_notation_t gpgme_sig_notation_get (gpgme_ctx_t ctx);
1008
1009 /* Store a sender address in the context.  */
1010 gpgme_error_t gpgme_set_sender (gpgme_ctx_t ctx, const char *address);
1011
1012 /* Get the sender address from the context.  */
1013 const char *gpgme_get_sender (gpgme_ctx_t ctx);
1014
1015
1016 \f
1017 /*
1018  * Run control.
1019  */
1020
1021 /* The type of an I/O callback function.  */
1022 typedef gpgme_error_t (*gpgme_io_cb_t) (void *data, int fd);
1023
1024 /* The type of a function that can register FNC as the I/O callback
1025  * function for the file descriptor FD with direction dir (0: for writing,
1026  * 1: for reading).  FNC_DATA should be passed as DATA to FNC.  The
1027  * function should return a TAG suitable for the corresponding
1028  * gpgme_remove_io_cb_t, and an error value.  */
1029 typedef gpgme_error_t (*gpgme_register_io_cb_t) (void *data, int fd, int dir,
1030                                                  gpgme_io_cb_t fnc,
1031                                                  void *fnc_data, void **tag);
1032
1033 /* The type of a function that can remove a previously registered I/O
1034  * callback function given TAG as returned by the register
1035  * function.  */
1036 typedef void (*gpgme_remove_io_cb_t) (void *tag);
1037
1038 typedef enum
1039   {
1040     GPGME_EVENT_START,
1041     GPGME_EVENT_DONE,
1042     GPGME_EVENT_NEXT_KEY,
1043     GPGME_EVENT_NEXT_TRUSTITEM
1044   }
1045 gpgme_event_io_t;
1046
1047 struct gpgme_io_event_done_data
1048 {
1049   /* A fatal IPC error or an operational error in state-less
1050    * protocols.  */
1051   gpgme_error_t err;
1052
1053   /* An operational errors in session-based protocols.  */
1054   gpgme_error_t op_err;
1055 };
1056 typedef struct gpgme_io_event_done_data *gpgme_io_event_done_data_t;
1057
1058 /* The type of a function that is called when a context finished an
1059  * operation.  */
1060 typedef void (*gpgme_event_io_cb_t) (void *data, gpgme_event_io_t type,
1061                                      void *type_data);
1062
1063 struct gpgme_io_cbs
1064 {
1065   gpgme_register_io_cb_t add;
1066   void *add_priv;
1067   gpgme_remove_io_cb_t remove;
1068   gpgme_event_io_cb_t event;
1069   void *event_priv;
1070 };
1071 typedef struct gpgme_io_cbs *gpgme_io_cbs_t;
1072
1073 /* Set the I/O callback functions in CTX to IO_CBS.  */
1074 void gpgme_set_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
1075
1076 /* Get the current I/O callback functions.  */
1077 void gpgme_get_io_cbs (gpgme_ctx_t ctx, gpgme_io_cbs_t io_cbs);
1078
1079 /* Wrappers around the internal I/O functions for use with
1080  * gpgme_passphrase_cb_t and gpgme_interact_cb_t.  */
1081 @API__SSIZE_T@ gpgme_io_read (int fd, void *buffer, size_t count);
1082 @API__SSIZE_T@ gpgme_io_write (int fd, const void *buffer, size_t count);
1083 int     gpgme_io_writen (int fd, const void *buffer, size_t count);
1084
1085 /* Process the pending operation and, if HANG is non-zero, wait for
1086  * the pending operation to finish.  */
1087 gpgme_ctx_t gpgme_wait (gpgme_ctx_t ctx, gpgme_error_t *status, int hang);
1088
1089 gpgme_ctx_t gpgme_wait_ext (gpgme_ctx_t ctx, gpgme_error_t *status,
1090                             gpgme_error_t *op_err, int hang);
1091
1092 /* Cancel a pending asynchronous operation.  */
1093 gpgme_error_t gpgme_cancel (gpgme_ctx_t ctx);
1094
1095 /* Cancel a pending operation asynchronously.  */
1096 gpgme_error_t gpgme_cancel_async (gpgme_ctx_t ctx);
1097
1098
1099 \f
1100 /*
1101  * Functions to handle data objects.
1102  */
1103
1104 /* Read up to SIZE bytes into buffer BUFFER from the data object with
1105  * the handle HANDLE.  Return the number of characters read, 0 on EOF
1106  * and -1 on error.  If an error occurs, errno is set.  */
1107 typedef @API__SSIZE_T@ (*gpgme_data_read_cb_t) (void *handle, void *buffer,
1108                                          size_t size);
1109
1110 /* Write up to SIZE bytes from buffer BUFFER to the data object with
1111  * the handle HANDLE.  Return the number of characters written, or -1
1112  * on error.  If an error occurs, errno is set.  */
1113 typedef @API__SSIZE_T@ (*gpgme_data_write_cb_t) (void *handle, const void *buffer,
1114                                           size_t size);
1115
1116 /* Set the current position from where the next read or write starts
1117  * in the data object with the handle HANDLE to OFFSET, relativ to
1118  * WHENCE.  Returns the new offset in bytes from the beginning of the
1119  * data object.  */
1120 typedef @API__OFF_T@ (*gpgme_data_seek_cb_t) (void *handle,
1121                                        @API__OFF_T@ offset, int whence);
1122
1123 /* Close the data object with the handle HANDLE.  */
1124 typedef void (*gpgme_data_release_cb_t) (void *handle);
1125
1126 struct gpgme_data_cbs
1127 {
1128   gpgme_data_read_cb_t read;
1129   gpgme_data_write_cb_t write;
1130   gpgme_data_seek_cb_t seek;
1131   gpgme_data_release_cb_t release;
1132 };
1133 typedef struct gpgme_data_cbs *gpgme_data_cbs_t;
1134
1135 /* Read up to SIZE bytes into buffer BUFFER from the data object with
1136  * the handle DH.  Return the number of characters read, 0 on EOF and
1137  * -1 on error.  If an error occurs, errno is set.  */
1138 @API__SSIZE_T@ gpgme_data_read (gpgme_data_t dh, void *buffer, size_t size);
1139
1140 /* Write up to SIZE bytes from buffer BUFFER to the data object with
1141  * the handle DH.  Return the number of characters written, or -1 on
1142  * error.  If an error occurs, errno is set.  */
1143 @API__SSIZE_T@ gpgme_data_write (gpgme_data_t dh, const void *buffer, size_t size);
1144
1145 /* Set the current position from where the next read or write starts
1146  * in the data object with the handle DH to OFFSET, relativ to WHENCE.
1147  * Returns the new offset in bytes from the beginning of the data
1148  * object.  */
1149 @API__OFF_T@ gpgme_data_seek (gpgme_data_t dh, @API__OFF_T@ offset, int whence);
1150
1151 /* Create a new data buffer and return it in R_DH.  */
1152 gpgme_error_t gpgme_data_new (gpgme_data_t *r_dh);
1153
1154 /* Destroy the data buffer DH.  */
1155 void gpgme_data_release (gpgme_data_t dh);
1156
1157 /* Create a new data buffer filled with SIZE bytes starting from
1158  * BUFFER.  If COPY is zero, copying is delayed until necessary, and
1159  * the data is taken from the original location when needed.  */
1160 gpgme_error_t gpgme_data_new_from_mem (gpgme_data_t *r_dh,
1161                                        const char *buffer, size_t size,
1162                                        int copy);
1163
1164 /* Destroy the data buffer DH and return a pointer to its content.
1165  * The memory has be to released with gpgme_free() by the user.  It's
1166  * size is returned in R_LEN.  */
1167 char *gpgme_data_release_and_get_mem (gpgme_data_t dh, size_t *r_len);
1168
1169 /* Release the memory returned by gpgme_data_release_and_get_mem() and
1170  * some other functions.  */
1171 void gpgme_free (void *buffer);
1172
1173 gpgme_error_t gpgme_data_new_from_cbs (gpgme_data_t *dh,
1174                                        gpgme_data_cbs_t cbs,
1175                                        void *handle);
1176
1177 gpgme_error_t gpgme_data_new_from_fd (gpgme_data_t *dh, int fd);
1178
1179 gpgme_error_t gpgme_data_new_from_stream (gpgme_data_t *dh, FILE *stream);
1180
1181 /* Return the encoding attribute of the data buffer DH */
1182 gpgme_data_encoding_t gpgme_data_get_encoding (gpgme_data_t dh);
1183
1184 /* Set the encoding attribute of data buffer DH to ENC */
1185 gpgme_error_t gpgme_data_set_encoding (gpgme_data_t dh,
1186                                        gpgme_data_encoding_t enc);
1187
1188 /* Get the file name associated with the data object with handle DH, or
1189  * NULL if there is none.  */
1190 char *gpgme_data_get_file_name (gpgme_data_t dh);
1191
1192 /* Set the file name associated with the data object with handle DH to
1193  * FILE_NAME.  */
1194 gpgme_error_t gpgme_data_set_file_name (gpgme_data_t dh,
1195                                         const char *file_name);
1196
1197 /* Set a flag for the data object DH.  See the manual for details.  */
1198 gpg_error_t gpgme_data_set_flag (gpgme_data_t dh,
1199                                  const char *name, const char *value);
1200
1201 /* Try to identify the type of the data in DH.  */
1202 gpgme_data_type_t gpgme_data_identify (gpgme_data_t dh, int reserved);
1203
1204
1205 /* Create a new data buffer filled with the content of file FNAME.
1206  * COPY must be non-zero.  For delayed read, please use
1207  * gpgme_data_new_from_fd or gpgme_data_new_from_stream instead.  */
1208 gpgme_error_t gpgme_data_new_from_file (gpgme_data_t *r_dh,
1209                                         const char *fname,
1210                                         int copy);
1211
1212 /* Create a new data buffer filled with LENGTH bytes starting from
1213  * OFFSET within the file FNAME or stream FP (exactly one must be
1214  * non-zero).  */
1215 gpgme_error_t gpgme_data_new_from_filepart (gpgme_data_t *r_dh,
1216                                             const char *fname, FILE *fp,
1217                                             @API__OFF_T@ offset, size_t length);
1218
1219 /* Convenience function to do a gpgme_data_seek (dh, 0, SEEK_SET).  */
1220 gpgme_error_t gpgme_data_rewind (gpgme_data_t dh);
1221
1222
1223 \f
1224 /*
1225  * Key and trust functions.
1226  */
1227
1228 /* Get the key with the fingerprint FPR from the crypto backend.  If
1229  * SECRET is true, get the secret key.  */
1230 gpgme_error_t gpgme_get_key (gpgme_ctx_t ctx, const char *fpr,
1231                              gpgme_key_t *r_key, int secret);
1232
1233 /* Create a dummy key to specify an email address.  */
1234 gpgme_error_t gpgme_key_from_uid (gpgme_key_t *key, const char *name);
1235
1236 /* Acquire a reference to KEY.  */
1237 void gpgme_key_ref (gpgme_key_t key);
1238
1239 /* Release a reference to KEY.  If this was the last one the key is
1240  * destroyed.  */
1241 void gpgme_key_unref (gpgme_key_t key);
1242 void gpgme_key_release (gpgme_key_t key);
1243
1244
1245 \f
1246 /*
1247  * Encryption.
1248  */
1249
1250 /* An object to return results from an encryption operation.
1251  * This structure shall be considered read-only and an application
1252  * must not allocate such a structure on its own.  */
1253 struct _gpgme_op_encrypt_result
1254 {
1255   /* The list of invalid recipients.  */
1256   gpgme_invalid_key_t invalid_recipients;
1257 };
1258 typedef struct _gpgme_op_encrypt_result *gpgme_encrypt_result_t;
1259
1260 /* Retrieve a pointer to the result of the encrypt operation.  */
1261 gpgme_encrypt_result_t gpgme_op_encrypt_result (gpgme_ctx_t ctx);
1262
1263 /* The valid encryption flags.  */
1264 typedef enum
1265   {
1266     GPGME_ENCRYPT_ALWAYS_TRUST = 1,
1267     GPGME_ENCRYPT_NO_ENCRYPT_TO = 2,
1268     GPGME_ENCRYPT_PREPARE = 4,
1269     GPGME_ENCRYPT_EXPECT_SIGN = 8,
1270     GPGME_ENCRYPT_NO_COMPRESS = 16,
1271     GPGME_ENCRYPT_SYMMETRIC = 32,
1272     GPGME_ENCRYPT_THROW_KEYIDS = 64,
1273     GPGME_ENCRYPT_WRAP = 128,
1274     GPGME_ENCRYPT_WANT_ADDRESS = 256
1275   }
1276 gpgme_encrypt_flags_t;
1277
1278 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1279  * store the resulting ciphertext in CIPHER.  */
1280 gpgme_error_t gpgme_op_encrypt_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
1281                                       gpgme_encrypt_flags_t flags,
1282                                       gpgme_data_t plain,
1283                                       gpgme_data_t cipher);
1284 gpgme_error_t gpgme_op_encrypt (gpgme_ctx_t ctx, gpgme_key_t recp[],
1285                                 gpgme_encrypt_flags_t flags,
1286                                 gpgme_data_t plain,
1287                                 gpgme_data_t cipher);
1288 gpgme_error_t gpgme_op_encrypt_ext_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
1289                                           const char *recpstring,
1290                                           gpgme_encrypt_flags_t flags,
1291                                           gpgme_data_t plain,
1292                                           gpgme_data_t cipher);
1293 gpgme_error_t gpgme_op_encrypt_ext (gpgme_ctx_t ctx, gpgme_key_t recp[],
1294                                     const char *recpstring,
1295                                     gpgme_encrypt_flags_t flags,
1296                                     gpgme_data_t plain,
1297                                     gpgme_data_t cipher);
1298
1299 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
1300  * store the resulting ciphertext in CIPHER.  Also sign the ciphertext
1301  * with the signers in CTX.  */
1302 gpgme_error_t gpgme_op_encrypt_sign_start (gpgme_ctx_t ctx,
1303                                            gpgme_key_t recp[],
1304                                            gpgme_encrypt_flags_t flags,
1305                                            gpgme_data_t plain,
1306                                            gpgme_data_t cipher);
1307 gpgme_error_t gpgme_op_encrypt_sign (gpgme_ctx_t ctx, gpgme_key_t recp[],
1308                                      gpgme_encrypt_flags_t flags,
1309                                      gpgme_data_t plain,
1310                                      gpgme_data_t cipher);
1311 gpgme_error_t gpgme_op_encrypt_sign_ext_start (gpgme_ctx_t ctx,
1312                                                gpgme_key_t recp[],
1313                                                const char *recpstring,
1314                                                gpgme_encrypt_flags_t flags,
1315                                                gpgme_data_t plain,
1316                                                gpgme_data_t cipher);
1317 gpgme_error_t gpgme_op_encrypt_sign_ext (gpgme_ctx_t ctx, gpgme_key_t recp[],
1318                                          const char *recpstring,
1319                                          gpgme_encrypt_flags_t flags,
1320                                          gpgme_data_t plain,
1321                                          gpgme_data_t cipher);
1322
1323 \f
1324 /*
1325  * Decryption.
1326  */
1327
1328 /* An object to hold information about a recipient.
1329  * This structure shall be considered read-only and an application
1330  * must not allocate such a structure on its own.  */
1331 struct _gpgme_recipient
1332 {
1333   struct _gpgme_recipient *next;
1334
1335   /* The key ID of key for which the text was encrypted.  */
1336   char *keyid;
1337
1338   /* Internal to GPGME, do not use.  */
1339   char _keyid[16 + 1];
1340
1341   /* The public key algorithm of the recipient key.  */
1342   gpgme_pubkey_algo_t pubkey_algo;
1343
1344   /* The status of the recipient.  */
1345   gpgme_error_t status;
1346 };
1347 typedef struct _gpgme_recipient *gpgme_recipient_t;
1348
1349
1350 /* An object to return results from a decryption operation.
1351  * This structure shall be considered read-only and an application
1352  * must not allocate such a structure on its own.  */
1353 struct _gpgme_op_decrypt_result
1354 {
1355   char *unsupported_algorithm;
1356
1357   /* Key should not have been used for encryption.  */
1358   unsigned int wrong_key_usage : 1;
1359
1360   /* True if the message was encrypted in compliance to the de-vs
1361    * mode.  */
1362   unsigned int is_de_vs : 1;
1363
1364   /* The message claims that the content is a MIME object.  */
1365   unsigned int is_mime : 1;
1366
1367   /* Internal to GPGME, do not use.  */
1368   int _unused : 29;
1369
1370   gpgme_recipient_t recipients;
1371
1372   /* The original file name of the plaintext message, if
1373    * available.  */
1374   char *file_name;
1375
1376   /* A textual representation of the session key used to decrypt the
1377    * message, if available */
1378   char *session_key;
1379
1380   /* A string with the symmetric encryption algorithm and mode using
1381    * the format "<algo>.<mode>".  */
1382   char *symkey_algo;
1383 };
1384 typedef struct _gpgme_op_decrypt_result *gpgme_decrypt_result_t;
1385
1386
1387 /* Retrieve a pointer to the result of the decrypt operation.  */
1388 gpgme_decrypt_result_t gpgme_op_decrypt_result (gpgme_ctx_t ctx);
1389
1390
1391 /* The valid decryption flags.  */
1392 typedef enum
1393   {
1394     GPGME_DECRYPT_VERIFY = 1,
1395     GPGME_DECRYPT_UNWRAP = 128
1396   }
1397 gpgme_decrypt_flags_t;
1398
1399
1400 /* Decrypt ciphertext CIPHER within CTX and store the resulting
1401  * plaintext in PLAIN.  */
1402 gpgme_error_t gpgme_op_decrypt_start (gpgme_ctx_t ctx, gpgme_data_t cipher,
1403                                       gpgme_data_t plain);
1404 gpgme_error_t gpgme_op_decrypt (gpgme_ctx_t ctx,
1405                                 gpgme_data_t cipher, gpgme_data_t plain);
1406
1407 /* Decrypt ciphertext CIPHER and make a signature verification within
1408  * CTX and store the resulting plaintext in PLAIN.  */
1409 gpgme_error_t gpgme_op_decrypt_verify_start (gpgme_ctx_t ctx,
1410                                              gpgme_data_t cipher,
1411                                              gpgme_data_t plain);
1412 gpgme_error_t gpgme_op_decrypt_verify (gpgme_ctx_t ctx, gpgme_data_t cipher,
1413                                        gpgme_data_t plain);
1414
1415 /* Decrypt ciphertext CIPHER within CTX and store the resulting
1416  * plaintext in PLAIN.  With the flag GPGME_DECRYPT_VERIFY also do a
1417  * signature verification pn the plaintext.  */
1418 gpgme_error_t gpgme_op_decrypt_ext_start (gpgme_ctx_t ctx,
1419                                           gpgme_decrypt_flags_t flags,
1420                                           gpgme_data_t cipher,
1421                                           gpgme_data_t plain);
1422 gpgme_error_t gpgme_op_decrypt_ext (gpgme_ctx_t ctx,
1423                                     gpgme_decrypt_flags_t flags,
1424                                     gpgme_data_t cipher,
1425                                     gpgme_data_t plain);
1426
1427
1428 \f
1429 /*
1430  * Signing.
1431  */
1432
1433 /* An object with signatures data.
1434  * This structure shall be considered read-only and an application
1435  * must not allocate such a structure on its own.  */
1436 struct _gpgme_new_signature
1437 {
1438   struct _gpgme_new_signature *next;
1439
1440   /* The type of the signature.  */
1441   gpgme_sig_mode_t type;
1442
1443   /* The public key algorithm used to create the signature.  */
1444   gpgme_pubkey_algo_t pubkey_algo;
1445
1446   /* The hash algorithm used to create the signature.  */
1447   gpgme_hash_algo_t hash_algo;
1448
1449   /* Internal to GPGME, do not use.  Must be set to the same value as
1450    * CLASS below.  */
1451   unsigned long _obsolete_class;
1452
1453   /* Signature creation time.  */
1454   long int timestamp;
1455
1456   /* The fingerprint of the signature.  */
1457   char *fpr;
1458
1459   /* Deprecated; use SIG_CLASS instead.  */
1460 #ifdef __cplusplus
1461   unsigned int _obsolete_class_2;
1462 #else
1463   unsigned int class _GPGME_DEPRECATED_OUTSIDE_GPGME(0,4);
1464 #endif
1465
1466   /* Crypto backend specific signature class.  */
1467   unsigned int sig_class;
1468 };
1469 typedef struct _gpgme_new_signature *gpgme_new_signature_t;
1470
1471
1472 /* An object to return results from a signing operation.
1473  * This structure shall be considered read-only and an application
1474  * must not allocate such a structure on its own.  */
1475 struct _gpgme_op_sign_result
1476 {
1477   /* The list of invalid signers.  */
1478   gpgme_invalid_key_t invalid_signers;
1479   gpgme_new_signature_t signatures;
1480 };
1481 typedef struct _gpgme_op_sign_result *gpgme_sign_result_t;
1482
1483
1484 /* Retrieve a pointer to the result of the signing operation.  */
1485 gpgme_sign_result_t gpgme_op_sign_result (gpgme_ctx_t ctx);
1486
1487 /* Sign the plaintext PLAIN and store the signature in SIG.  */
1488 gpgme_error_t gpgme_op_sign_start (gpgme_ctx_t ctx,
1489                                    gpgme_data_t plain, gpgme_data_t sig,
1490                                    gpgme_sig_mode_t mode);
1491 gpgme_error_t gpgme_op_sign (gpgme_ctx_t ctx,
1492                              gpgme_data_t plain, gpgme_data_t sig,
1493                              gpgme_sig_mode_t mode);
1494
1495 \f
1496 /*
1497  * Verify.
1498  */
1499
1500 /* Flags used for the SUMMARY field in a gpgme_signature_t.  */
1501 typedef enum
1502   {
1503     GPGME_SIGSUM_VALID       = 0x0001,  /* The signature is fully valid.  */
1504     GPGME_SIGSUM_GREEN       = 0x0002,  /* The signature is good.  */
1505     GPGME_SIGSUM_RED         = 0x0004,  /* The signature is bad.  */
1506     GPGME_SIGSUM_KEY_REVOKED = 0x0010,  /* One key has been revoked.  */
1507     GPGME_SIGSUM_KEY_EXPIRED = 0x0020,  /* One key has expired.  */
1508     GPGME_SIGSUM_SIG_EXPIRED = 0x0040,  /* The signature has expired.  */
1509     GPGME_SIGSUM_KEY_MISSING = 0x0080,  /* Can't verify: key missing.  */
1510     GPGME_SIGSUM_CRL_MISSING = 0x0100,  /* CRL not available.  */
1511     GPGME_SIGSUM_CRL_TOO_OLD = 0x0200,  /* Available CRL is too old.  */
1512     GPGME_SIGSUM_BAD_POLICY  = 0x0400,  /* A policy was not met.  */
1513     GPGME_SIGSUM_SYS_ERROR   = 0x0800,  /* A system error occurred.  */
1514     GPGME_SIGSUM_TOFU_CONFLICT=0x1000   /* Tofu conflict detected.  */
1515   }
1516 gpgme_sigsum_t;
1517
1518
1519 /* An object to hold the verification status of a signature.
1520  * This structure shall be considered read-only and an application
1521  * must not allocate such a structure on its own.  */
1522 struct _gpgme_signature
1523 {
1524   struct _gpgme_signature *next;
1525
1526   /* A summary of the signature status.  */
1527   gpgme_sigsum_t summary;
1528
1529   /* The fingerprint of the signature.  This can be a subkey.  */
1530   char *fpr;
1531
1532   /* The status of the signature.  */
1533   gpgme_error_t status;
1534
1535   /* Notation data and policy URLs.  */
1536   gpgme_sig_notation_t notations;
1537
1538   /* Signature creation time.  */
1539   unsigned long timestamp;
1540
1541   /* Signature expiration time or 0.  */
1542   unsigned long exp_timestamp;
1543
1544   /* Key should not have been used for signing.  */
1545   unsigned int wrong_key_usage : 1;
1546
1547   /* PKA status: 0 = not available, 1 = bad, 2 = okay, 3 = RFU. */
1548   unsigned int pka_trust : 2;
1549
1550   /* Validity has been verified using the chain model. */
1551   unsigned int chain_model : 1;
1552
1553   /* True if the signature is in compliance to the de-vs mode.  */
1554   unsigned int is_de_vs : 1;
1555
1556   /* Internal to GPGME, do not use.  */
1557   int _unused : 27;
1558
1559   gpgme_validity_t validity;
1560   gpgme_error_t validity_reason;
1561
1562   /* The public key algorithm used to create the signature.  */
1563   gpgme_pubkey_algo_t pubkey_algo;
1564
1565   /* The hash algorithm used to create the signature.  */
1566   gpgme_hash_algo_t hash_algo;
1567
1568   /* The mailbox from the PKA information or NULL. */
1569   char *pka_address;
1570
1571   /* If non-NULL, a possible incomplete key object with the data
1572    * available for the signature.  */
1573   gpgme_key_t key;
1574 };
1575 typedef struct _gpgme_signature *gpgme_signature_t;
1576
1577
1578 /* An object to return the results of a verify operation.
1579  * This structure shall be considered read-only and an application
1580  * must not allocate such a structure on its own.  */
1581 struct _gpgme_op_verify_result
1582 {
1583   gpgme_signature_t signatures;
1584
1585   /* The original file name of the plaintext message, if
1586      available.  */
1587   char *file_name;
1588
1589   /* The message claims that the content is a MIME object.  */
1590   unsigned int is_mime : 1;
1591
1592   /* Internal to GPGME; do not use.  */
1593   unsigned int _unused : 31;
1594 };
1595 typedef struct _gpgme_op_verify_result *gpgme_verify_result_t;
1596
1597
1598 /* Retrieve a pointer to the result of the verify operation.  */
1599 gpgme_verify_result_t gpgme_op_verify_result (gpgme_ctx_t ctx);
1600
1601 /* Verify within CTX that SIG is a valid signature for TEXT.  */
1602 gpgme_error_t gpgme_op_verify_start (gpgme_ctx_t ctx, gpgme_data_t sig,
1603                                      gpgme_data_t signed_text,
1604                                      gpgme_data_t plaintext);
1605 gpgme_error_t gpgme_op_verify (gpgme_ctx_t ctx, gpgme_data_t sig,
1606                                gpgme_data_t signed_text,
1607                                gpgme_data_t plaintext);
1608
1609 \f
1610 /*
1611  * Import/Export
1612  */
1613
1614 #define GPGME_IMPORT_NEW        1  /* The key was new.  */
1615 #define GPGME_IMPORT_UID        2  /* The key contained new user IDs.  */
1616 #define GPGME_IMPORT_SIG        4  /* The key contained new signatures.  */
1617 #define GPGME_IMPORT_SUBKEY     8  /* The key contained new sub keys.  */
1618 #define GPGME_IMPORT_SECRET    16  /* The key contained a secret key.  */
1619
1620
1621 /* An object to hold results for one imported key.
1622  * This structure shall be considered read-only and an application
1623  * must not allocate such a structure on its own.  */
1624 struct _gpgme_import_status
1625 {
1626   struct _gpgme_import_status *next;
1627
1628   /* Fingerprint.  */
1629   char *fpr;
1630
1631   /* If a problem occurred, the reason why the key could not be
1632      imported.  Otherwise GPGME_No_Error.  */
1633   gpgme_error_t result;
1634
1635   /* The result of the import, the GPGME_IMPORT_* values bit-wise
1636      ORed.  0 means the key was already known and no new components
1637      have been added.  */
1638   unsigned int status;
1639 };
1640 typedef struct _gpgme_import_status *gpgme_import_status_t;
1641
1642
1643 /* Import result object.
1644  * This structure shall be considered read-only and an application
1645  * must not allocate such a structure on its own.  */
1646 struct _gpgme_op_import_result
1647 {
1648   /* Number of considered keys.  */
1649   int considered;
1650
1651   /* Keys without user ID.  */
1652   int no_user_id;
1653
1654   /* Imported keys.  */
1655   int imported;
1656
1657   /* Imported RSA keys.  */
1658   int imported_rsa;
1659
1660   /* Unchanged keys.  */
1661   int unchanged;
1662
1663   /* Number of new user ids.  */
1664   int new_user_ids;
1665
1666   /* Number of new sub keys.  */
1667   int new_sub_keys;
1668
1669   /* Number of new signatures.  */
1670   int new_signatures;
1671
1672   /* Number of new revocations.  */
1673   int new_revocations;
1674
1675   /* Number of secret keys read.  */
1676   int secret_read;
1677
1678   /* Number of secret keys imported.  */
1679   int secret_imported;
1680
1681   /* Number of secret keys unchanged.  */
1682   int secret_unchanged;
1683
1684   /* Number of new keys skipped.  */
1685   int skipped_new_keys;
1686
1687   /* Number of keys not imported.  */
1688   int not_imported;
1689
1690   /* List of keys for which an import was attempted.  */
1691   gpgme_import_status_t imports;
1692
1693   /* Number of v3 keys skipped.  */
1694   int skipped_v3_keys;
1695 };
1696 typedef struct _gpgme_op_import_result *gpgme_import_result_t;
1697
1698
1699 /* Retrieve a pointer to the result of the import operation.  */
1700 gpgme_import_result_t gpgme_op_import_result (gpgme_ctx_t ctx);
1701
1702 /* Import the key in KEYDATA into the keyring.  */
1703 gpgme_error_t gpgme_op_import_start (gpgme_ctx_t ctx, gpgme_data_t keydata);
1704 gpgme_error_t gpgme_op_import (gpgme_ctx_t ctx, gpgme_data_t keydata);
1705
1706 /* Import the keys from the array KEYS into the keyring.  */
1707 gpgme_error_t gpgme_op_import_keys_start (gpgme_ctx_t ctx, gpgme_key_t keys[]);
1708 gpgme_error_t gpgme_op_import_keys (gpgme_ctx_t ctx, gpgme_key_t keys[]);
1709
1710
1711 /* Export the keys found by PATTERN into KEYDATA.  */
1712 gpgme_error_t gpgme_op_export_start (gpgme_ctx_t ctx, const char *pattern,
1713                                      gpgme_export_mode_t mode,
1714                                      gpgme_data_t keydata);
1715 gpgme_error_t gpgme_op_export (gpgme_ctx_t ctx, const char *pattern,
1716                                gpgme_export_mode_t mode,
1717                                gpgme_data_t keydata);
1718
1719 gpgme_error_t gpgme_op_export_ext_start (gpgme_ctx_t ctx,
1720                                          const char *pattern[],
1721                                          gpgme_export_mode_t mode,
1722                                          gpgme_data_t keydata);
1723 gpgme_error_t gpgme_op_export_ext (gpgme_ctx_t ctx, const char *pattern[],
1724                                    gpgme_export_mode_t mode,
1725                                    gpgme_data_t keydata);
1726
1727 /* Export the keys from the array KEYS into KEYDATA.  */
1728 gpgme_error_t gpgme_op_export_keys_start (gpgme_ctx_t ctx,
1729                                           gpgme_key_t keys[],
1730                                           gpgme_export_mode_t mode,
1731                                           gpgme_data_t keydata);
1732 gpgme_error_t gpgme_op_export_keys (gpgme_ctx_t ctx,
1733                                     gpgme_key_t keys[],
1734                                     gpgme_export_mode_t mode,
1735                                     gpgme_data_t keydata);
1736
1737
1738 \f
1739 /*
1740  * Key generation.
1741  */
1742
1743 /* Flags for the key creation functions.  */
1744 #define GPGME_CREATE_SIGN       (1 << 0)  /* Allow usage: signing.     */
1745 #define GPGME_CREATE_ENCR       (1 << 1)  /* Allow usage: encryption.  */
1746 #define GPGME_CREATE_CERT       (1 << 2)  /* Allow usage: certification.  */
1747 #define GPGME_CREATE_AUTH       (1 << 3)  /* Allow usage: authentication.  */
1748 #define GPGME_CREATE_NOPASSWD   (1 << 7)  /* Create w/o passphrase.    */
1749 #define GPGME_CREATE_SELFSIGNED (1 << 8)  /* Create self-signed cert.  */
1750 #define GPGME_CREATE_NOSTORE    (1 << 9)  /* Do not store the key.     */
1751 #define GPGME_CREATE_WANTPUB    (1 << 10) /* Return the public key.    */
1752 #define GPGME_CREATE_WANTSEC    (1 << 11) /* Return the secret key.    */
1753 #define GPGME_CREATE_FORCE      (1 << 12) /* Force creation.           */
1754 #define GPGME_CREATE_NOEXPIRE   (1 << 13) /* Create w/o expiration.    */
1755
1756
1757 /* An object to return result from a key generation.
1758  * This structure shall be considered read-only and an application
1759  * must not allocate such a structure on its own.  */
1760 struct _gpgme_op_genkey_result
1761 {
1762   /* A primary key was generated.  */
1763   unsigned int primary : 1;
1764
1765   /* A sub key was generated.  */
1766   unsigned int sub : 1;
1767
1768   /* A user id was generated.  */
1769   unsigned int uid : 1;
1770
1771   /* Internal to GPGME, do not use.  */
1772   unsigned int _unused : 29;
1773
1774   /* The fingerprint of the generated key.  */
1775   char *fpr;
1776
1777   /* A memory data object with the created public key.  Only set when
1778    * GPGME_CREATE_WANTPUB has been used. */
1779   gpgme_data_t pubkey;
1780
1781   /* A memory data object with the created secret key.  Only set when
1782    * GPGME_CREATE_WANTSEC has been used. */
1783   gpgme_data_t seckey;
1784 };
1785 typedef struct _gpgme_op_genkey_result *gpgme_genkey_result_t;
1786
1787
1788 /* Generate a new keypair and add it to the keyring.  PUBKEY and
1789  * SECKEY should be null for now.  PARMS specifies what keys should be
1790  * generated.  */
1791 gpgme_error_t gpgme_op_genkey_start (gpgme_ctx_t ctx, const char *parms,
1792                                      gpgme_data_t pubkey, gpgme_data_t seckey);
1793 gpgme_error_t gpgme_op_genkey (gpgme_ctx_t ctx, const char *parms,
1794                                gpgme_data_t pubkey, gpgme_data_t seckey);
1795
1796 /* Generate a key pair using the modern interface.  */
1797 gpgme_error_t gpgme_op_createkey_start (gpgme_ctx_t ctx,
1798                                         const char *userid,
1799                                         const char *algo,
1800                                         unsigned long reserved,
1801                                         unsigned long expires,
1802                                         gpgme_key_t certkey,
1803                                         unsigned int flags);
1804 gpgme_error_t gpgme_op_createkey       (gpgme_ctx_t ctx,
1805                                         const char *userid,
1806                                         const char *algo,
1807                                         unsigned long reserved,
1808                                         unsigned long expires,
1809                                         gpgme_key_t certkey,
1810                                         unsigned int flags);
1811 /* Add a new subkey to KEY.  */
1812 gpgme_error_t gpgme_op_createsubkey_start (gpgme_ctx_t ctx,
1813                                            gpgme_key_t key,
1814                                            const char *algo,
1815                                            unsigned long reserved,
1816                                            unsigned long expires,
1817                                            unsigned int flags);
1818 gpgme_error_t gpgme_op_createsubkey       (gpgme_ctx_t ctx,
1819                                            gpgme_key_t key,
1820                                            const char *algo,
1821                                            unsigned long reserved,
1822                                            unsigned long expires,
1823                                            unsigned int flags);
1824
1825 /* Add USERID to an existing KEY.  */
1826 gpgme_error_t gpgme_op_adduid_start (gpgme_ctx_t ctx,
1827                                      gpgme_key_t key, const char *userid,
1828                                      unsigned int reserved);
1829 gpgme_error_t gpgme_op_adduid       (gpgme_ctx_t ctx,
1830                                      gpgme_key_t key, const char *userid,
1831                                      unsigned int reserved);
1832
1833 /* Revoke a USERID from a KEY.  */
1834 gpgme_error_t gpgme_op_revuid_start (gpgme_ctx_t ctx,
1835                                      gpgme_key_t key, const char *userid,
1836                                      unsigned int reserved);
1837 gpgme_error_t gpgme_op_revuid       (gpgme_ctx_t ctx,
1838                                      gpgme_key_t key, const char *userid,
1839                                      unsigned int reserved);
1840
1841 /* Set a flag on the USERID of KEY.  See the manual for supported flags.  */
1842 gpgme_error_t gpgme_op_set_uid_flag_start (gpgme_ctx_t ctx,
1843                                            gpgme_key_t key, const char *userid,
1844                                            const char *name, const char *value);
1845 gpgme_error_t gpgme_op_set_uid_flag       (gpgme_ctx_t ctx,
1846                                            gpgme_key_t key, const char *userid,
1847                                            const char *name, const char *value);
1848
1849
1850 /* Retrieve a pointer to the result of a genkey, createkey, or
1851  * createsubkey operation.  */
1852 gpgme_genkey_result_t gpgme_op_genkey_result (gpgme_ctx_t ctx);
1853
1854
1855 /* Delete KEY from the keyring.  If ALLOW_SECRET is non-zero, secret
1856  * keys are also deleted.  */
1857 gpgme_error_t gpgme_op_delete_start (gpgme_ctx_t ctx, const gpgme_key_t key,
1858                                      int allow_secret);
1859 gpgme_error_t gpgme_op_delete (gpgme_ctx_t ctx, const gpgme_key_t key,
1860                                int allow_secret);
1861
1862 /* Flags for the key delete functions.  */
1863 #define GPGME_DELETE_ALLOW_SECRET (1 << 0)  /* Also delete secret key.     */
1864 #define GPGME_DELETE_FORCE        (1 << 1)  /* Do not ask user to confirm.  */
1865
1866 gpgme_error_t gpgme_op_delete_ext_start (gpgme_ctx_t ctx, const gpgme_key_t key,
1867                                          unsigned int flags);
1868 gpgme_error_t gpgme_op_delete_ext (gpgme_ctx_t ctx, const gpgme_key_t key,
1869                                    unsigned int flags);
1870
1871 \f
1872 /*
1873  * Key signing interface
1874  */
1875
1876 /* Flags for the key signing functions.  */
1877 #define GPGME_KEYSIGN_LOCAL     (1 << 7)  /* Create a local signature.  */
1878 #define GPGME_KEYSIGN_LFSEP     (1 << 8)  /* Indicate LF separated user ids. */
1879 #define GPGME_KEYSIGN_NOEXPIRE  (1 << 9)  /* Force no expiration.  */
1880
1881
1882 /* Sign the USERID of KEY using the current set of signers.  */
1883 gpgme_error_t gpgme_op_keysign_start (gpgme_ctx_t ctx,
1884                                       gpgme_key_t key, const char *userid,
1885                                       unsigned long expires,
1886                                       unsigned int flags);
1887 gpgme_error_t gpgme_op_keysign       (gpgme_ctx_t ctx,
1888                                       gpgme_key_t key, const char *userid,
1889                                       unsigned long expires,
1890                                       unsigned int flags);
1891
1892
1893
1894 \f
1895 /*
1896  * Key edit interface
1897  */
1898
1899 /* Flags to select the mode of the interact.  */
1900 #define GPGME_INTERACT_CARD   (1 << 0)  /* Use --card-edit mode. */
1901
1902
1903 /* Edit the KEY.  Send status and command requests to FNC and
1904    output of edit commands to OUT.  */
1905 gpgme_error_t gpgme_op_interact_start (gpgme_ctx_t ctx,
1906                                        gpgme_key_t key,
1907                                        unsigned int flags,
1908                                        gpgme_interact_cb_t fnc,
1909                                        void *fnc_value,
1910                                        gpgme_data_t out);
1911 gpgme_error_t gpgme_op_interact (gpgme_ctx_t ctx, gpgme_key_t key,
1912                                  unsigned int flags,
1913                                  gpgme_interact_cb_t fnc,
1914                                  void *fnc_value,
1915                                  gpgme_data_t out);
1916
1917
1918 /* Set the Tofu policy of KEY to POLCIY.  */
1919 gpgme_error_t gpgme_op_tofu_policy_start (gpgme_ctx_t ctx,
1920                                           gpgme_key_t key,
1921                                           gpgme_tofu_policy_t policy);
1922 gpgme_error_t gpgme_op_tofu_policy       (gpgme_ctx_t ctx,
1923                                           gpgme_key_t key,
1924                                           gpgme_tofu_policy_t policy);
1925
1926
1927
1928 \f
1929 /*
1930  * Key listing
1931  */
1932
1933 /* An object to return results from a key listing operation.
1934  * This structure shall be considered read-only and an application
1935  * must not allocate such a structure on its own.  */
1936 struct _gpgme_op_keylist_result
1937 {
1938   unsigned int truncated : 1;
1939
1940   /* Internal to GPGME, do not use.  */
1941   unsigned int _unused : 31;
1942 };
1943 typedef struct _gpgme_op_keylist_result *gpgme_keylist_result_t;
1944
1945 /* Retrieve a pointer to the result of the key listing operation.  */
1946 gpgme_keylist_result_t gpgme_op_keylist_result (gpgme_ctx_t ctx);
1947
1948 /* Start a keylist operation within CTX, searching for keys which
1949  * match PATTERN.  If SECRET_ONLY is true, only secret keys are
1950  * returned.  */
1951 gpgme_error_t gpgme_op_keylist_start (gpgme_ctx_t ctx, const char *pattern,
1952                                       int secret_only);
1953 gpgme_error_t gpgme_op_keylist_ext_start (gpgme_ctx_t ctx,
1954                                           const char *pattern[],
1955                                           int secret_only, int reserved);
1956
1957 /* List the keys contained in DATA.  */
1958 gpgme_error_t gpgme_op_keylist_from_data_start (gpgme_ctx_t ctx,
1959                                                 gpgme_data_t data,
1960                                                 int reserved);
1961
1962 /* Return the next key from the keylist in R_KEY.  */
1963 gpgme_error_t gpgme_op_keylist_next (gpgme_ctx_t ctx, gpgme_key_t *r_key);
1964
1965 /* Terminate a pending keylist operation within CTX.  */
1966 gpgme_error_t gpgme_op_keylist_end (gpgme_ctx_t ctx);
1967
1968
1969 \f
1970 /*
1971  * Protecting keys
1972  */
1973
1974 /* Change the passphrase for KEY.  FLAGS is reserved for future use
1975  * and must be passed as 0.  */
1976 gpgme_error_t gpgme_op_passwd_start (gpgme_ctx_t ctx, gpgme_key_t key,
1977                                      unsigned int flags);
1978 gpgme_error_t gpgme_op_passwd (gpgme_ctx_t ctx, gpgme_key_t key,
1979                                unsigned int flags);
1980
1981
1982 \f
1983 /*
1984  * Trust items and operations.
1985  */
1986
1987 /* An object to hold data of a trust item.
1988  * This structure shall be considered read-only and an application
1989  * must not allocate such a structure on its own.  */
1990 struct _gpgme_trust_item
1991 {
1992   /* Internal to GPGME, do not use.  */
1993   unsigned int _refs;
1994
1995   /* The key ID to which the trust item belongs.  */
1996   char *keyid;
1997
1998   /* Internal to GPGME, do not use.  */
1999   char _keyid[16 + 1];
2000
2001   /* The type of the trust item, 1 refers to a key, 2 to a user ID.  */
2002   int type;
2003
2004   /* The trust level.  */
2005   int level;
2006
2007   /* The owner trust if TYPE is 1.  */
2008   char *owner_trust;
2009
2010   /* Internal to GPGME, do not use.  */
2011   char _owner_trust[2];
2012
2013   /* The calculated validity.  */
2014   char *validity;
2015
2016   /* Internal to GPGME, do not use.  */
2017   char _validity[2];
2018
2019   /* The user name if TYPE is 2.  */
2020   char *name;
2021 };
2022 typedef struct _gpgme_trust_item *gpgme_trust_item_t;
2023
2024 /* Start a trustlist operation within CTX, searching for trust items
2025    which match PATTERN.  */
2026 gpgme_error_t gpgme_op_trustlist_start (gpgme_ctx_t ctx,
2027                                         const char *pattern, int max_level);
2028
2029 /* Return the next trust item from the trustlist in R_ITEM.  */
2030 gpgme_error_t gpgme_op_trustlist_next (gpgme_ctx_t ctx,
2031                                        gpgme_trust_item_t *r_item);
2032
2033 /* Terminate a pending trustlist operation within CTX.  */
2034 gpgme_error_t gpgme_op_trustlist_end (gpgme_ctx_t ctx);
2035
2036 /* Acquire a reference to ITEM.  */
2037 void gpgme_trust_item_ref (gpgme_trust_item_t item);
2038
2039 /* Release a reference to ITEM.  If this was the last one the trust
2040  * item is destroyed.  */
2041 void gpgme_trust_item_unref (gpgme_trust_item_t item);
2042
2043
2044 \f
2045 /*
2046  * Audit log
2047  */
2048
2049 /* Return the auditlog for the current session.  This may be called
2050    after a successful or failed operation.  If no audit log is
2051    available GPG_ERR_NO_DATA is returned.  */
2052 gpgme_error_t gpgme_op_getauditlog_start (gpgme_ctx_t ctx, gpgme_data_t output,
2053                                           unsigned int flags);
2054 gpgme_error_t gpgme_op_getauditlog (gpgme_ctx_t ctx, gpgme_data_t output,
2055                                     unsigned int flags);
2056
2057
2058 \f
2059 /*
2060  * Spawn interface
2061  */
2062
2063 /* Flags for the spawn operations.  */
2064 #define GPGME_SPAWN_DETACHED      1
2065 #define GPGME_SPAWN_ALLOW_SET_FG  2
2066 #define GPGME_SPAWN_SHOW_WINDOW   4
2067
2068
2069 /* Run the command FILE with the arguments in ARGV.  Connect stdin to
2070  * DATAIN, stdout to DATAOUT, and STDERR to DATAERR.  If one the data
2071  * streams is NULL, connect to /dev/null instead.  */
2072 gpgme_error_t gpgme_op_spawn_start (gpgme_ctx_t ctx,
2073                                     const char *file, const char *argv[],
2074                                     gpgme_data_t datain,
2075                                     gpgme_data_t dataout, gpgme_data_t dataerr,
2076                                     unsigned int flags);
2077 gpgme_error_t gpgme_op_spawn (gpgme_ctx_t ctx,
2078                               const char *file, const char *argv[],
2079                               gpgme_data_t datain,
2080                               gpgme_data_t dataout, gpgme_data_t dataerr,
2081                               unsigned int flags);
2082
2083 \f
2084 /*
2085  * Low-level Assuan protocol access.
2086  */
2087
2088 typedef gpgme_error_t (*gpgme_assuan_data_cb_t)
2089      (void *opaque, const void *data, size_t datalen);
2090
2091 typedef gpgme_error_t (*gpgme_assuan_inquire_cb_t)
2092      (void *opaque, const char *name, const char *args,
2093       gpgme_data_t *r_data);
2094
2095 typedef gpgme_error_t (*gpgme_assuan_status_cb_t)
2096      (void *opaque, const char *status, const char *args);
2097
2098 /* Send the Assuan COMMAND and return results via the callbacks.
2099  * Asynchronous variant. */
2100 gpgme_error_t gpgme_op_assuan_transact_start (gpgme_ctx_t ctx,
2101                                               const char *command,
2102                                               gpgme_assuan_data_cb_t data_cb,
2103                                               void *data_cb_value,
2104                                               gpgme_assuan_inquire_cb_t inq_cb,
2105                                               void *inq_cb_value,
2106                                               gpgme_assuan_status_cb_t stat_cb,
2107                                               void *stat_cb_value);
2108
2109 /* Send the Assuan COMMAND and return results via the callbacks.
2110  * Synchronous variant. */
2111 gpgme_error_t gpgme_op_assuan_transact_ext (gpgme_ctx_t ctx,
2112                                             const char *command,
2113                                             gpgme_assuan_data_cb_t data_cb,
2114                                             void *data_cb_value,
2115                                             gpgme_assuan_inquire_cb_t inq_cb,
2116                                             void *inq_cb_value,
2117                                             gpgme_assuan_status_cb_t stat_cb,
2118                                             void *stat_cb_value,
2119                                             gpgme_error_t *op_err);
2120
2121 \f
2122 /*
2123  * Crypto container support.
2124  */
2125
2126 /* An object to return results from a VFS mount operation.
2127  * This structure shall be considered read-only and an application
2128  * must not allocate such a structure on its own.  */
2129 struct _gpgme_op_vfs_mount_result
2130 {
2131   char *mount_dir;
2132 };
2133 typedef struct _gpgme_op_vfs_mount_result *gpgme_vfs_mount_result_t;
2134
2135 gpgme_vfs_mount_result_t gpgme_op_vfs_mount_result (gpgme_ctx_t ctx);
2136
2137 /* The container is automatically unmounted when the context is reset
2138  * or destroyed.  Transmission errors are returned directly,
2139  * operational errors are returned in OP_ERR.  */
2140 gpgme_error_t gpgme_op_vfs_mount (gpgme_ctx_t ctx, const char *container_file,
2141                                   const char *mount_dir, unsigned int flags,
2142                                   gpgme_error_t *op_err);
2143
2144 gpgme_error_t gpgme_op_vfs_create (gpgme_ctx_t ctx, gpgme_key_t recp[],
2145                                    const char *container_file,
2146                                    unsigned int flags, gpgme_error_t *op_err);
2147
2148 \f
2149 /*
2150  * Interface to gpgconf(1).
2151  */
2152
2153 /* The expert level at which a configuration option or group of
2154  * options should be displayed.  See the gpgconf(1) documentation for
2155  * more details.  */
2156 typedef enum
2157   {
2158     GPGME_CONF_BASIC = 0,
2159     GPGME_CONF_ADVANCED = 1,
2160     GPGME_CONF_EXPERT = 2,
2161     GPGME_CONF_INVISIBLE = 3,
2162     GPGME_CONF_INTERNAL = 4
2163   }
2164 gpgme_conf_level_t;
2165
2166
2167 /* The data type of a configuration option argument.  See the gpgconf(1)
2168  * documentation for more details.  */
2169 typedef enum
2170   {
2171     /* Basic types.  */
2172     GPGME_CONF_NONE = 0,
2173     GPGME_CONF_STRING = 1,
2174     GPGME_CONF_INT32 = 2,
2175     GPGME_CONF_UINT32 = 3,
2176
2177     /* Complex types.  */
2178     GPGME_CONF_FILENAME = 32,
2179     GPGME_CONF_LDAP_SERVER = 33,
2180     GPGME_CONF_KEY_FPR = 34,
2181     GPGME_CONF_PUB_KEY = 35,
2182     GPGME_CONF_SEC_KEY = 36,
2183     GPGME_CONF_ALIAS_LIST = 37
2184   }
2185 gpgme_conf_type_t;
2186
2187 /* For now, compatibility.  */
2188 #define GPGME_CONF_PATHNAME GPGME_CONF_FILENAME
2189
2190
2191 /* This represents a single argument for a configuration option.
2192  * Which of the members of value is used depends on the ALT_TYPE.  */
2193 typedef struct gpgme_conf_arg
2194 {
2195   struct gpgme_conf_arg *next;
2196   /* True if the option appears without an (optional) argument.  */
2197   unsigned int no_arg;
2198   union
2199   {
2200     unsigned int count;
2201     unsigned int uint32;
2202     int int32;
2203     char *string;
2204   } value;
2205 } *gpgme_conf_arg_t;
2206
2207
2208 /* The flags of a configuration option.  See the gpgconf
2209  * documentation for details.  */
2210 #define GPGME_CONF_GROUP        (1 << 0)
2211 #define GPGME_CONF_OPTIONAL     (1 << 1)
2212 #define GPGME_CONF_LIST         (1 << 2)
2213 #define GPGME_CONF_RUNTIME      (1 << 3)
2214 #define GPGME_CONF_DEFAULT      (1 << 4)
2215 #define GPGME_CONF_DEFAULT_DESC (1 << 5)
2216 #define GPGME_CONF_NO_ARG_DESC  (1 << 6)
2217 #define GPGME_CONF_NO_CHANGE    (1 << 7)
2218
2219
2220 /* The representation of a single configuration option.  See the
2221  * gpg-conf documentation for details.  */
2222 typedef struct gpgme_conf_opt
2223 {
2224   struct gpgme_conf_opt *next;
2225
2226   /* The option name.  */
2227   char *name;
2228
2229   /* The flags for this option.  */
2230   unsigned int flags;
2231
2232   /* The level of this option.  */
2233   gpgme_conf_level_t level;
2234
2235   /* The localized description of this option.  */
2236   char *description;
2237
2238   /* The type and alternate type of this option.  */
2239   gpgme_conf_type_t type;
2240   gpgme_conf_type_t alt_type;
2241
2242   /* The localized (short) name of the argument, if any.  */
2243   char *argname;
2244
2245   /* The default value.  */
2246   gpgme_conf_arg_t default_value;
2247   char *default_description;
2248
2249   /* The default value if the option is not set.  */
2250   gpgme_conf_arg_t no_arg_value;
2251   char *no_arg_description;
2252
2253   /* The current value if the option is set.  */
2254   gpgme_conf_arg_t value;
2255
2256   /* The new value, if any.  NULL means reset to default.  */
2257   int change_value;
2258   gpgme_conf_arg_t new_value;
2259
2260   /* Free for application use.  */
2261   void *user_data;
2262 } *gpgme_conf_opt_t;
2263
2264
2265 /* The representation of a component that can be configured.  See the
2266  * gpg-conf documentation for details.  */
2267 typedef struct gpgme_conf_comp
2268 {
2269   struct gpgme_conf_comp *next;
2270
2271   /* Internal to GPGME, do not use!  */
2272   gpgme_conf_opt_t *_last_opt_p;
2273
2274   /* The component name.  */
2275   char *name;
2276
2277   /* A human-readable description for the component.  */
2278   char *description;
2279
2280   /* The program name (an absolute path to the program).  */
2281   char *program_name;
2282
2283   /* A linked list of options for this component.  */
2284   struct gpgme_conf_opt *options;
2285 } *gpgme_conf_comp_t;
2286
2287
2288 /* Allocate a new gpgme_conf_arg_t.  If VALUE is NULL, a "no arg
2289  * default" is prepared.  If type is a string type, VALUE should point
2290  * to the string.  Else, it should point to an unsigned or signed
2291  * integer respectively.  */
2292 gpgme_error_t gpgme_conf_arg_new (gpgme_conf_arg_t *arg_p,
2293                                   gpgme_conf_type_t type, const void *value);
2294
2295 /* This also releases all chained argument structures!  */
2296 void gpgme_conf_arg_release (gpgme_conf_arg_t arg, gpgme_conf_type_t type);
2297
2298 /* Register a change for the value of OPT to ARG.  If RESET is 1 (do
2299  * not use any values but 0 or 1), ARG is ignored and the option is
2300  * not changed (reverting a previous change).  Otherwise, if ARG is
2301  * NULL, the option is cleared or reset to its default. The change
2302  * is done with gpgconf's --runtime option to immediately take effect. */
2303 gpgme_error_t gpgme_conf_opt_change (gpgme_conf_opt_t opt, int reset,
2304                                      gpgme_conf_arg_t arg);
2305
2306 /* Release a set of configurations.  */
2307 void gpgme_conf_release (gpgme_conf_comp_t conf);
2308
2309 /* Retrieve the current configurations.  */
2310 gpgme_error_t gpgme_op_conf_load (gpgme_ctx_t ctx, gpgme_conf_comp_t *conf_p);
2311
2312 /* Save the configuration of component comp.  This function does not
2313    follow chained components!  */
2314 gpgme_error_t gpgme_op_conf_save (gpgme_ctx_t ctx, gpgme_conf_comp_t comp);
2315
2316 /* Retrieve the configured directory.  */
2317 gpgme_error_t gpgme_op_conf_dir(gpgme_ctx_t ctx, const char *what,
2318                                 char **result);
2319
2320
2321 /* Information about software versions.
2322  * This structure shall be considered read-only and an application
2323  * must not allocate such a structure on its own.  */
2324 typedef struct _gpgme_op_query_swdb_result
2325 {
2326   /* RFU */
2327   struct _gpgme_op_query_swdb_result *next;
2328
2329   /* The name of the package (e.g. "gpgme", "gnupg") */
2330   char *name;
2331
2332   /* The version number of the installed version.  */
2333   char *iversion;
2334
2335   /* The time the online info was created.  */
2336   unsigned long created;
2337
2338   /* The time the online info was retrieved.  */
2339   unsigned long retrieved;
2340
2341   /* This bit is set if an error occured or some of the information
2342    * in this structure may not be set.  */
2343   unsigned int warning : 1;
2344
2345   /* An update is available.  */
2346   unsigned int update : 1;
2347
2348   /* The update is important.  */
2349   unsigned int urgent : 1;
2350
2351   /* No information at all available.  */
2352   unsigned int noinfo : 1;
2353
2354   /* The package name is not known. */
2355   unsigned int unknown : 1;
2356
2357   /* The information here is too old.  */
2358   unsigned int tooold : 1;
2359
2360   /* Other error.  */
2361   unsigned int error : 1;
2362
2363   unsigned int _reserved : 25;
2364
2365   /* The version number of the latest released version.  */
2366   char *version;
2367
2368   /* The release date of that version.  */
2369   unsigned long reldate;
2370
2371 } *gpgme_query_swdb_result_t;
2372
2373
2374 /* Run the gpgconf --query-swdb command.  */
2375 gpgme_error_t gpgme_op_query_swdb (gpgme_ctx_t ctx,
2376                                    const char *name, const char *iversion,
2377                                    unsigned int reserved);
2378
2379 /* Return the result from the last query_swdb operation.  */
2380 gpgme_query_swdb_result_t gpgme_op_query_swdb_result (gpgme_ctx_t ctx);
2381
2382
2383
2384 \f
2385 /*
2386  * Various functions.
2387  */
2388
2389 /* Set special global flags; consult the manual before use.  */
2390 int gpgme_set_global_flag (const char *name, const char *value);
2391
2392 /* Check that the library fulfills the version requirement.  Note:
2393  * This is here only for the case where a user takes a pointer from
2394  * the old version of this function.  The new version and macro for
2395  * run-time checks are below.  */
2396 const char *gpgme_check_version (const char *req_version);
2397
2398 /* Do not call this directly; use the macro below.  */
2399 const char *gpgme_check_version_internal (const char *req_version,
2400                                           size_t offset_sig_validity);
2401
2402 /* Check that the library fulfills the version requirement and check
2403  * for struct layout mismatch involving bitfields.  */
2404 #define gpgme_check_version(req_version)                                \
2405   gpgme_check_version_internal (req_version,                            \
2406                                 offsetof (struct _gpgme_signature, validity))
2407
2408 /* Return the default values for various directories.  */
2409 const char *gpgme_get_dirinfo (const char *what);
2410
2411 /* Get the information about the configured and installed engines.  A
2412  * pointer to the first engine in the statically allocated linked list
2413  * is returned in *INFO.  If an error occurs, it is returned.  The
2414  * returned data is valid until the next gpgme_set_engine_info.  */
2415 gpgme_error_t gpgme_get_engine_info (gpgme_engine_info_t *engine_info);
2416
2417 /* Set the default engine info for the protocol PROTO to the file name
2418  * FILE_NAME and the home directory HOME_DIR.  */
2419 gpgme_error_t gpgme_set_engine_info (gpgme_protocol_t proto,
2420                                      const char *file_name,
2421                                      const char *home_dir);
2422
2423 /* Verify that the engine implementing PROTO is installed and
2424  * available.  */
2425 gpgme_error_t gpgme_engine_check_version (gpgme_protocol_t proto);
2426
2427
2428 /* Reference counting for result objects.  */
2429 void gpgme_result_ref (void *result);
2430 void gpgme_result_unref (void *result);
2431
2432 /* Return a public key algorithm string (e.g. "rsa2048").  Caller must
2433  * free using gpgme_free.  */
2434 char *gpgme_pubkey_algo_string (gpgme_subkey_t subkey);
2435
2436 /* Return a statically allocated string with the name of the public
2437  * key algorithm ALGO, or NULL if that name is not known.  */
2438 const char *gpgme_pubkey_algo_name (gpgme_pubkey_algo_t algo);
2439
2440 /* Return a statically allocated string with the name of the hash
2441  * algorithm ALGO, or NULL if that name is not known.  */
2442 const char *gpgme_hash_algo_name (gpgme_hash_algo_t algo);
2443
2444 /* Return the addr-spec from a user id.  Caller must free the result
2445  * with gpgme_free. */
2446 char *gpgme_addrspec_from_uid (const char *uid);
2447
2448
2449 \f
2450 /*
2451  * Deprecated types, constants and functions.
2452  */
2453
2454 /* The possible stati for gpgme_op_edit.  The use of that function and
2455  * these status codes are deprecated in favor of gpgme_op_interact. */
2456 typedef enum
2457   {
2458     GPGME_STATUS_EOF = 0,
2459     /* mkstatus processing starts here */
2460     GPGME_STATUS_ENTER = 1,
2461     GPGME_STATUS_LEAVE = 2,
2462     GPGME_STATUS_ABORT = 3,
2463
2464     GPGME_STATUS_GOODSIG = 4,
2465     GPGME_STATUS_BADSIG = 5,
2466     GPGME_STATUS_ERRSIG = 6,
2467
2468     GPGME_STATUS_BADARMOR = 7,
2469
2470     GPGME_STATUS_RSA_OR_IDEA = 8,      /* (legacy) */
2471     GPGME_STATUS_KEYEXPIRED = 9,
2472     GPGME_STATUS_KEYREVOKED = 10,
2473
2474     GPGME_STATUS_TRUST_UNDEFINED = 11,
2475     GPGME_STATUS_TRUST_NEVER = 12,
2476     GPGME_STATUS_TRUST_MARGINAL = 13,
2477     GPGME_STATUS_TRUST_FULLY = 14,
2478     GPGME_STATUS_TRUST_ULTIMATE = 15,
2479
2480     GPGME_STATUS_SHM_INFO = 16,        /* (legacy) */
2481     GPGME_STATUS_SHM_GET = 17,         /* (legacy) */
2482     GPGME_STATUS_SHM_GET_BOOL = 18,    /* (legacy) */
2483     GPGME_STATUS_SHM_GET_HIDDEN = 19,  /* (legacy) */
2484
2485     GPGME_STATUS_NEED_PASSPHRASE = 20,
2486     GPGME_STATUS_VALIDSIG = 21,
2487     GPGME_STATUS_SIG_ID = 22,
2488     GPGME_STATUS_ENC_TO = 23,
2489     GPGME_STATUS_NODATA = 24,
2490     GPGME_STATUS_BAD_PASSPHRASE = 25,
2491     GPGME_STATUS_NO_PUBKEY = 26,
2492     GPGME_STATUS_NO_SECKEY = 27,
2493     GPGME_STATUS_NEED_PASSPHRASE_SYM = 28,
2494     GPGME_STATUS_DECRYPTION_FAILED = 29,
2495     GPGME_STATUS_DECRYPTION_OKAY = 30,
2496     GPGME_STATUS_MISSING_PASSPHRASE = 31,
2497     GPGME_STATUS_GOOD_PASSPHRASE = 32,
2498     GPGME_STATUS_GOODMDC = 33,
2499     GPGME_STATUS_BADMDC = 34,
2500     GPGME_STATUS_ERRMDC = 35,
2501     GPGME_STATUS_IMPORTED = 36,
2502     GPGME_STATUS_IMPORT_OK = 37,
2503     GPGME_STATUS_IMPORT_PROBLEM = 38,
2504     GPGME_STATUS_IMPORT_RES = 39,
2505     GPGME_STATUS_FILE_START = 40,
2506     GPGME_STATUS_FILE_DONE = 41,
2507     GPGME_STATUS_FILE_ERROR = 42,
2508
2509     GPGME_STATUS_BEGIN_DECRYPTION = 43,
2510     GPGME_STATUS_END_DECRYPTION = 44,
2511     GPGME_STATUS_BEGIN_ENCRYPTION = 45,
2512     GPGME_STATUS_END_ENCRYPTION = 46,
2513
2514     GPGME_STATUS_DELETE_PROBLEM = 47,
2515     GPGME_STATUS_GET_BOOL = 48,
2516     GPGME_STATUS_GET_LINE = 49,
2517     GPGME_STATUS_GET_HIDDEN = 50,
2518     GPGME_STATUS_GOT_IT = 51,
2519     GPGME_STATUS_PROGRESS = 52,
2520     GPGME_STATUS_SIG_CREATED = 53,
2521     GPGME_STATUS_SESSION_KEY = 54,
2522     GPGME_STATUS_NOTATION_NAME = 55,
2523     GPGME_STATUS_NOTATION_DATA = 56,
2524     GPGME_STATUS_POLICY_URL = 57,
2525     GPGME_STATUS_BEGIN_STREAM = 58,    /* (legacy) */
2526     GPGME_STATUS_END_STREAM = 59,      /* (legacy) */
2527     GPGME_STATUS_KEY_CREATED = 60,
2528     GPGME_STATUS_USERID_HINT = 61,
2529     GPGME_STATUS_UNEXPECTED = 62,
2530     GPGME_STATUS_INV_RECP = 63,
2531     GPGME_STATUS_NO_RECP = 64,
2532     GPGME_STATUS_ALREADY_SIGNED = 65,
2533     GPGME_STATUS_SIGEXPIRED = 66,      /* (legacy) */
2534     GPGME_STATUS_EXPSIG = 67,
2535     GPGME_STATUS_EXPKEYSIG = 68,
2536     GPGME_STATUS_TRUNCATED = 69,
2537     GPGME_STATUS_ERROR = 70,
2538     GPGME_STATUS_NEWSIG = 71,
2539     GPGME_STATUS_REVKEYSIG = 72,
2540     GPGME_STATUS_SIG_SUBPACKET = 73,
2541     GPGME_STATUS_NEED_PASSPHRASE_PIN = 74,
2542     GPGME_STATUS_SC_OP_FAILURE = 75,
2543     GPGME_STATUS_SC_OP_SUCCESS = 76,
2544     GPGME_STATUS_CARDCTRL = 77,
2545     GPGME_STATUS_BACKUP_KEY_CREATED = 78,
2546     GPGME_STATUS_PKA_TRUST_BAD = 79,
2547     GPGME_STATUS_PKA_TRUST_GOOD = 80,
2548     GPGME_STATUS_PLAINTEXT = 81,
2549     GPGME_STATUS_INV_SGNR = 82,
2550     GPGME_STATUS_NO_SGNR = 83,
2551     GPGME_STATUS_SUCCESS = 84,
2552     GPGME_STATUS_DECRYPTION_INFO = 85,
2553     GPGME_STATUS_PLAINTEXT_LENGTH = 86,
2554     GPGME_STATUS_MOUNTPOINT = 87,
2555     GPGME_STATUS_PINENTRY_LAUNCHED = 88,
2556     GPGME_STATUS_ATTRIBUTE = 89,
2557     GPGME_STATUS_BEGIN_SIGNING = 90,
2558     GPGME_STATUS_KEY_NOT_CREATED = 91,
2559     GPGME_STATUS_INQUIRE_MAXLEN = 92,
2560     GPGME_STATUS_FAILURE = 93,
2561     GPGME_STATUS_KEY_CONSIDERED = 94,
2562     GPGME_STATUS_TOFU_USER = 95,
2563     GPGME_STATUS_TOFU_STATS = 96,
2564     GPGME_STATUS_TOFU_STATS_LONG = 97,
2565     GPGME_STATUS_NOTATION_FLAGS = 98,
2566     GPGME_STATUS_DECRYPTION_COMPLIANCE_MODE = 99,
2567     GPGME_STATUS_VERIFICATION_COMPLIANCE_MODE = 100
2568   }
2569 gpgme_status_code_t;
2570
2571 /* The callback type used by the deprecated functions gpgme_op_edit
2572  * and gpgme_op_card_edit.  */
2573 typedef gpgme_error_t (*gpgme_edit_cb_t) (void *opaque,
2574                                           gpgme_status_code_t status,
2575                                           const char *args, int fd);
2576
2577 gpgme_error_t gpgme_op_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
2578                                    gpgme_edit_cb_t fnc, void *fnc_value,
2579                                    gpgme_data_t out) _GPGME_DEPRECATED(1,7);
2580 gpgme_error_t gpgme_op_edit       (gpgme_ctx_t ctx, gpgme_key_t key,
2581                                    gpgme_edit_cb_t fnc, void *fnc_value,
2582                                    gpgme_data_t out) _GPGME_DEPRECATED(1,7);
2583 gpgme_error_t gpgme_op_card_edit_start (gpgme_ctx_t ctx, gpgme_key_t key,
2584                                         gpgme_edit_cb_t fnc, void *fnc_value,
2585                                         gpgme_data_t out)
2586                                         _GPGME_DEPRECATED(1,7);
2587 gpgme_error_t gpgme_op_card_edit       (gpgme_ctx_t ctx, gpgme_key_t key,
2588                                         gpgme_edit_cb_t fnc, void *fnc_value,
2589                                         gpgme_data_t out)
2590                                         _GPGME_DEPRECATED(1,7);
2591
2592 /* The possible signature stati.  Deprecated, use error value in sig
2593  * status.  */
2594 typedef enum
2595   {
2596     GPGME_SIG_STAT_NONE  = 0,
2597     GPGME_SIG_STAT_GOOD  = 1,
2598     GPGME_SIG_STAT_BAD   = 2,
2599     GPGME_SIG_STAT_NOKEY = 3,
2600     GPGME_SIG_STAT_NOSIG = 4,
2601     GPGME_SIG_STAT_ERROR = 5,
2602     GPGME_SIG_STAT_DIFF  = 6,
2603     GPGME_SIG_STAT_GOOD_EXP = 7,
2604     GPGME_SIG_STAT_GOOD_EXPKEY = 8
2605   }
2606 _gpgme_sig_stat_t;
2607 typedef _gpgme_sig_stat_t gpgme_sig_stat_t _GPGME_DEPRECATED(0,4);
2608
2609 /* The available key and signature attributes.  Deprecated, use the
2610  * individual result structures instead.  */
2611 typedef enum
2612   {
2613     GPGME_ATTR_KEYID        = 1,
2614     GPGME_ATTR_FPR          = 2,
2615     GPGME_ATTR_ALGO         = 3,
2616     GPGME_ATTR_LEN          = 4,
2617     GPGME_ATTR_CREATED      = 5,
2618     GPGME_ATTR_EXPIRE       = 6,
2619     GPGME_ATTR_OTRUST       = 7,
2620     GPGME_ATTR_USERID       = 8,
2621     GPGME_ATTR_NAME         = 9,
2622     GPGME_ATTR_EMAIL        = 10,
2623     GPGME_ATTR_COMMENT      = 11,
2624     GPGME_ATTR_VALIDITY     = 12,
2625     GPGME_ATTR_LEVEL        = 13,
2626     GPGME_ATTR_TYPE         = 14,
2627     GPGME_ATTR_IS_SECRET    = 15,
2628     GPGME_ATTR_KEY_REVOKED  = 16,
2629     GPGME_ATTR_KEY_INVALID  = 17,
2630     GPGME_ATTR_UID_REVOKED  = 18,
2631     GPGME_ATTR_UID_INVALID  = 19,
2632     GPGME_ATTR_KEY_CAPS     = 20,
2633     GPGME_ATTR_CAN_ENCRYPT  = 21,
2634     GPGME_ATTR_CAN_SIGN     = 22,
2635     GPGME_ATTR_CAN_CERTIFY  = 23,
2636     GPGME_ATTR_KEY_EXPIRED  = 24,
2637     GPGME_ATTR_KEY_DISABLED = 25,
2638     GPGME_ATTR_SERIAL       = 26,
2639     GPGME_ATTR_ISSUER       = 27,
2640     GPGME_ATTR_CHAINID      = 28,
2641     GPGME_ATTR_SIG_STATUS   = 29,
2642     GPGME_ATTR_ERRTOK       = 30,
2643     GPGME_ATTR_SIG_SUMMARY  = 31,
2644     GPGME_ATTR_SIG_CLASS    = 32
2645   }
2646 _gpgme_attr_t;
2647 typedef _gpgme_attr_t gpgme_attr_t _GPGME_DEPRECATED(0,4);
2648
2649 /* Retrieve the signature status of signature IDX in CTX after a
2650  * successful verify operation in R_STAT (if non-null).  The creation
2651  * time stamp of the signature is returned in R_CREATED (if non-null).
2652  * The function returns a string containing the fingerprint.
2653  * Deprecated, use verify result directly.  */
2654 const char *gpgme_get_sig_status (gpgme_ctx_t ctx, int idx,
2655                                   _gpgme_sig_stat_t *r_stat,
2656                                   time_t *r_created) _GPGME_DEPRECATED(0,4);
2657
2658 /* Retrieve certain attributes of a signature.  IDX is the index
2659  * number of the signature after a successful verify operation.  WHAT
2660  * is an attribute where GPGME_ATTR_EXPIRE is probably the most useful
2661  * one.  WHATIDX is to be passed as 0 for most attributes . */
2662 unsigned long gpgme_get_sig_ulong_attr (gpgme_ctx_t c, int idx,
2663                                         _gpgme_attr_t what, int whatidx)
2664      _GPGME_DEPRECATED(0,4);
2665 const char *gpgme_get_sig_string_attr (gpgme_ctx_t c, int idx,
2666                                        _gpgme_attr_t what, int whatidx)
2667      _GPGME_DEPRECATED(0,4);
2668
2669
2670 /* Get the key used to create signature IDX in CTX and return it in
2671  * R_KEY.  */
2672 gpgme_error_t gpgme_get_sig_key (gpgme_ctx_t ctx, int idx, gpgme_key_t *r_key)
2673      _GPGME_DEPRECATED(0,4);
2674
2675 /* Create a new data buffer which retrieves the data from the callback
2676  * function READ_CB.  Deprecated, please use gpgme_data_new_from_cbs
2677  * instead.  */
2678 gpgme_error_t gpgme_data_new_with_read_cb (gpgme_data_t *r_dh,
2679                                            int (*read_cb) (void*,char *,
2680                                                            size_t,size_t*),
2681                                            void *read_cb_value)
2682      _GPGME_DEPRECATED(0,4);
2683
2684 /* Return the value of the attribute WHAT of KEY, which has to be
2685  * representable by a string.  IDX specifies the sub key or user ID
2686  * for attributes related to sub keys or user IDs.  Deprecated, use
2687  * key structure directly instead. */
2688 const char *gpgme_key_get_string_attr (gpgme_key_t key, _gpgme_attr_t what,
2689                                        const void *reserved, int idx)
2690      _GPGME_DEPRECATED(0,4);
2691
2692 /* Return the value of the attribute WHAT of KEY, which has to be
2693  * representable by an unsigned integer.  IDX specifies the sub key or
2694  * user ID for attributes related to sub keys or user IDs.
2695  * Deprecated, use key structure directly instead.  */
2696 unsigned long gpgme_key_get_ulong_attr (gpgme_key_t key, _gpgme_attr_t what,
2697                                         const void *reserved, int idx)
2698      _GPGME_DEPRECATED(0,4);
2699
2700 /* Return the value of the attribute WHAT of a signature on user ID
2701  * UID_IDX in KEY, which has to be representable by a string.  IDX
2702  * specifies the signature.  Deprecated, use key structure directly
2703  * instead.  */
2704 const char *gpgme_key_sig_get_string_attr (gpgme_key_t key, int uid_idx,
2705                                            _gpgme_attr_t what,
2706                                            const void *reserved, int idx)
2707      _GPGME_DEPRECATED(0,4);
2708
2709 /* Return the value of the attribute WHAT of a signature on user ID
2710  * UID_IDX in KEY, which has to be representable by an unsigned
2711  * integer string.  IDX specifies the signature.  Deprecated, use key
2712  * structure directly instead.  */
2713 unsigned long gpgme_key_sig_get_ulong_attr (gpgme_key_t key, int uid_idx,
2714                                             _gpgme_attr_t what,
2715                                             const void *reserved, int idx)
2716      _GPGME_DEPRECATED(0,4);
2717
2718
2719 gpgme_error_t gpgme_op_import_ext (gpgme_ctx_t ctx, gpgme_data_t keydata,
2720                                    int *nr) _GPGME_DEPRECATED(0,4);
2721
2722 /* Release the trust item ITEM.  Deprecated, use
2723  * gpgme_trust_item_unref.  */
2724 void gpgme_trust_item_release (gpgme_trust_item_t item) _GPGME_DEPRECATED(0,4);
2725
2726 /* Return the value of the attribute WHAT of ITEM, which has to be
2727  * representable by a string.  Deprecated, use trust item structure
2728  * directly.  */
2729 const char *gpgme_trust_item_get_string_attr (gpgme_trust_item_t item,
2730                                               _gpgme_attr_t what,
2731                                               const void *reserved, int idx)
2732      _GPGME_DEPRECATED(0,4);
2733
2734 /* Return the value of the attribute WHAT of KEY, which has to be
2735  * representable by an integer.  IDX specifies a running index if the
2736  * attribute appears more than once in the key.  Deprecated, use trust
2737  * item structure directly.  */
2738 int gpgme_trust_item_get_int_attr (gpgme_trust_item_t item, _gpgme_attr_t what,
2739                                    const void *reserved, int idx)
2740      _GPGME_DEPRECATED(0,4);
2741
2742 /* Compat.
2743  * This structure shall be considered read-only and an application
2744  * must not allocate such a structure on its own.  */
2745 struct _gpgme_op_assuan_result
2746 {
2747   /* Deprecated.  Use the second value in a DONE event or the
2748      synchronous variant gpgme_op_assuan_transact_ext.  */
2749   gpgme_error_t err _GPGME_DEPRECATED_OUTSIDE_GPGME(1,2);
2750 };
2751 typedef struct _gpgme_op_assuan_result *gpgme_assuan_result_t;
2752
2753
2754 /* Return the result of the last Assuan command. */
2755 gpgme_assuan_result_t gpgme_op_assuan_result (gpgme_ctx_t ctx)
2756   _GPGME_DEPRECATED(1,2);
2757
2758 gpgme_error_t
2759 gpgme_op_assuan_transact (gpgme_ctx_t ctx,
2760                               const char *command,
2761                               gpgme_assuan_data_cb_t data_cb,
2762                               void *data_cb_value,
2763                               gpgme_assuan_inquire_cb_t inq_cb,
2764                               void *inq_cb_value,
2765                               gpgme_assuan_status_cb_t status_cb,
2766                           void *status_cb_value) _GPGME_DEPRECATED(1,2);
2767
2768
2769
2770 typedef gpgme_ctx_t GpgmeCtx _GPGME_DEPRECATED(0,4);
2771 typedef gpgme_data_t GpgmeData _GPGME_DEPRECATED(0,4);
2772 typedef gpgme_error_t GpgmeError _GPGME_DEPRECATED(0,4);
2773 typedef gpgme_data_encoding_t GpgmeDataEncoding _GPGME_DEPRECATED(0,4);
2774 typedef gpgme_pubkey_algo_t GpgmePubKeyAlgo _GPGME_DEPRECATED(0,4);
2775 typedef gpgme_hash_algo_t GpgmeHashAlgo _GPGME_DEPRECATED(0,4);
2776 typedef gpgme_sig_stat_t GpgmeSigStat _GPGME_DEPRECATED(0,4);
2777 typedef gpgme_sig_mode_t GpgmeSigMode _GPGME_DEPRECATED(0,4);
2778 typedef gpgme_attr_t GpgmeAttr _GPGME_DEPRECATED(0,4);
2779 typedef gpgme_validity_t GpgmeValidity _GPGME_DEPRECATED(0,4);
2780 typedef gpgme_protocol_t GpgmeProtocol _GPGME_DEPRECATED(0,4);
2781 typedef gpgme_engine_info_t GpgmeEngineInfo _GPGME_DEPRECATED(0,4);
2782 typedef gpgme_subkey_t GpgmeSubkey _GPGME_DEPRECATED(0,4);
2783 typedef gpgme_key_sig_t GpgmeKeySig _GPGME_DEPRECATED(0,4);
2784 typedef gpgme_user_id_t GpgmeUserID _GPGME_DEPRECATED(0,4);
2785 typedef gpgme_key_t GpgmeKey _GPGME_DEPRECATED(0,4);
2786 typedef gpgme_passphrase_cb_t GpgmePassphraseCb _GPGME_DEPRECATED(0,4);
2787 typedef gpgme_progress_cb_t GpgmeProgressCb _GPGME_DEPRECATED(0,4);
2788 typedef gpgme_io_cb_t GpgmeIOCb _GPGME_DEPRECATED(0,4);
2789 typedef gpgme_register_io_cb_t GpgmeRegisterIOCb _GPGME_DEPRECATED(0,4);
2790 typedef gpgme_remove_io_cb_t GpgmeRemoveIOCb _GPGME_DEPRECATED(0,4);
2791 typedef gpgme_event_io_t GpgmeEventIO _GPGME_DEPRECATED(0,4);
2792 typedef gpgme_event_io_cb_t GpgmeEventIOCb _GPGME_DEPRECATED(0,4);
2793 #define GpgmeIOCbs gpgme_io_cbs
2794 typedef gpgme_data_read_cb_t GpgmeDataReadCb _GPGME_DEPRECATED(0,4);
2795 typedef gpgme_data_write_cb_t GpgmeDataWriteCb _GPGME_DEPRECATED(0,4);
2796 typedef gpgme_data_seek_cb_t GpgmeDataSeekCb _GPGME_DEPRECATED(0,4);
2797 typedef gpgme_data_release_cb_t GpgmeDataReleaseCb _GPGME_DEPRECATED(0,4);
2798 #define GpgmeDataCbs gpgme_data_cbs
2799 typedef gpgme_encrypt_result_t GpgmeEncryptResult _GPGME_DEPRECATED(0,4);
2800 typedef gpgme_sig_notation_t GpgmeSigNotation _GPGME_DEPRECATED(0,4);
2801 typedef gpgme_signature_t GpgmeSignature _GPGME_DEPRECATED(0,4);
2802 typedef gpgme_verify_result_t GpgmeVerifyResult _GPGME_DEPRECATED(0,4);
2803 typedef gpgme_import_status_t GpgmeImportStatus _GPGME_DEPRECATED(0,4);
2804 typedef gpgme_import_result_t GpgmeImportResult _GPGME_DEPRECATED(0,4);
2805 typedef gpgme_genkey_result_t GpgmeGenKeyResult _GPGME_DEPRECATED(0,4);
2806 typedef gpgme_trust_item_t GpgmeTrustItem _GPGME_DEPRECATED(0,4);
2807 typedef gpgme_status_code_t GpgmeStatusCode _GPGME_DEPRECATED(0,4);
2808
2809 #ifdef __cplusplus
2810 }
2811 #endif
2812 #endif /* GPGME_H */
2813 /*
2814 @emacs_local_vars_begin@
2815 @emacs_local_vars_read_only@
2816 @emacs_local_vars_end@
2817 */