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