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