Add better debug printing. Use reader threads for W32
[gpgme.git] / gpgme / gpgme.h
1 /* gpgme.h -  GnuPG Made Easy
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GPGME is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef GPGME_H
22 #define GPGME_H
23
24 #ifdef _MSC_VER
25   typedef long off_t;
26 #else
27 # include <sys/types.h>
28 #endif
29
30 #ifdef __cplusplus
31 extern "C" { 
32 #if 0 /* just to make Emacs auto-indent happy */
33 }
34 #endif
35 #endif
36
37
38 /*
39  * The version of this header should match the one of the library
40  * It should not be used by a program because gpgme_check_version(NULL)
41  * does return the same version.  The purpose of this macro is to
42  * let autoconf (using the AM_PATH_GPGME macro) check that this
43  * header matches the installed library.
44  * Warning: Do not edit the next line.  configure will do that for you! */
45 #define GPGME_VERSION "0.1.4a"
46
47
48
49 struct gpgme_context_s;
50 typedef struct gpgme_context_s *GpgmeCtx;
51
52 struct gpgme_data_s;
53 typedef struct gpgme_data_s *GpgmeData;
54
55 struct gpgme_recipients_s;
56 typedef struct gpgme_recipients_s *GpgmeRecipients;
57
58 struct gpgme_key_s;
59 typedef struct gpgme_key_s *GpgmeKey;
60
61 struct gpgme_trust_item_s;
62 typedef struct gpgme_trust_item_s *GpgmeTrustItem;
63
64
65 typedef enum {
66     GPGME_EOF = -1,
67     GPGME_No_Error = 0,
68     GPGME_General_Error = 1,
69     GPGME_Out_Of_Core = 2,
70     GPGME_Invalid_Value = 3,
71     GPGME_Busy = 4,
72     GPGME_No_Request = 5,
73     GPGME_Exec_Error = 6,
74     GPGME_Too_Many_Procs = 7,
75     GPGME_Pipe_Error = 8,
76     GPGME_No_Recipients = 9,
77     GPGME_No_Data = 10,
78     GPGME_Conflict = 11,
79     GPGME_Not_Implemented = 12,
80     GPGME_Read_Error = 13,
81     GPGME_Write_Error = 14,
82     GPGME_Invalid_Type = 15,
83     GPGME_Invalid_Mode = 16,
84     GPGME_File_Error = 17,  /* errno is set in this case */
85     GPGME_Decryption_Failed = 18,
86     GPGME_No_Passphrase = 19,
87     GPGME_Canceled = 20,
88     GPGME_Invalid_Key = 21,
89     GPGME_Invalid_Engine = 22,
90 } GpgmeError;
91
92 typedef enum {
93     GPGME_DATA_TYPE_NONE = 0,
94     GPGME_DATA_TYPE_MEM  = 1,
95     GPGME_DATA_TYPE_FD   = 2,
96     GPGME_DATA_TYPE_FILE = 3,
97     GPGME_DATA_TYPE_CB   = 4
98 } GpgmeDataType;
99
100 typedef enum {
101     GPGME_SIG_STAT_NONE = 0,
102     GPGME_SIG_STAT_GOOD = 1,
103     GPGME_SIG_STAT_BAD  = 2,
104     GPGME_SIG_STAT_NOKEY = 3,
105     GPGME_SIG_STAT_NOSIG = 4,
106     GPGME_SIG_STAT_ERROR = 5
107 } GpgmeSigStat;
108
109 typedef enum {
110     GPGME_SIG_MODE_NORMAL = 0,
111     GPGME_SIG_MODE_DETACH = 1,
112     GPGME_SIG_MODE_CLEAR = 2
113 } GpgmeSigMode;
114
115 typedef enum {
116     GPGME_ATTR_KEYID   = 1,
117     GPGME_ATTR_FPR     = 2,
118     GPGME_ATTR_ALGO    = 3,
119     GPGME_ATTR_LEN     = 4,
120     GPGME_ATTR_CREATED = 5,
121     GPGME_ATTR_EXPIRE  = 6,
122     GPGME_ATTR_OTRUST  = 7,
123     GPGME_ATTR_USERID  = 8,
124     GPGME_ATTR_NAME    = 9,
125     GPGME_ATTR_EMAIL   = 10,
126     GPGME_ATTR_COMMENT = 11,
127     GPGME_ATTR_VALIDITY= 12,
128     GPGME_ATTR_LEVEL   = 13,
129     GPGME_ATTR_TYPE    = 14,
130     GPGME_ATTR_IS_SECRET= 15
131 } GpgmeAttr;
132
133 typedef enum {
134     GPGME_VALIDITY_UNKNOWN = 0,
135     GPGME_VALIDITY_UNDEFINED = 1,
136     GPGME_VALIDITY_NEVER = 2,
137     GPGME_VALIDITY_MARGINAL = 3,
138     GPGME_VALIDITY_FULL = 4,
139     GPGME_VALIDITY_ULTIMATE = 5
140 } GpgmeValidity;
141
142
143 typedef const char *(*GpgmePassphraseCb)(void*,
144                                          const char *desc, void *r_hd);
145 typedef void (*GpgmeProgressCb)(void *opaque,
146                                 const char *what, 
147                                 int type, int current, int total );
148
149
150 /* Context management */
151 GpgmeError gpgme_new (GpgmeCtx *r_ctx);
152 void       gpgme_release (GpgmeCtx c);
153 void       gpgme_cancel (GpgmeCtx c);
154 GpgmeCtx   gpgme_wait (GpgmeCtx c, int hang);
155
156 char *gpgme_get_notation (GpgmeCtx c);
157 void gpgme_set_armor (GpgmeCtx c, int yes);
158 void gpgme_set_textmode (GpgmeCtx c, int yes);
159 void gpgme_set_keylist_mode ( GpgmeCtx c, int mode );
160 void gpgme_set_passphrase_cb (GpgmeCtx c,
161                               GpgmePassphraseCb cb, void *cb_value);
162 void gpgme_set_progress_cb (GpgmeCtx c, GpgmeProgressCb cb, void *cb_value);
163
164 void       gpgme_signers_clear (GpgmeCtx c);
165 GpgmeError gpgme_signers_add (GpgmeCtx c, const GpgmeKey key);
166 GpgmeKey   gpgme_signers_enum (const GpgmeCtx c, int seq);
167
168
169 /* Functions to handle recipients */
170 GpgmeError   gpgme_recipients_new (GpgmeRecipients *r_rset);
171 void         gpgme_recipients_release ( GpgmeRecipients rset);
172 GpgmeError   gpgme_recipients_add_name (GpgmeRecipients rset,
173                                         const char *name);
174 GpgmeError   gpgme_recipients_add_name_with_validity (GpgmeRecipients rset,
175                                                       const char *name,
176                                                       GpgmeValidity val );
177 unsigned int gpgme_recipients_count ( const GpgmeRecipients rset );
178 GpgmeError gpgme_recipients_enum_open (const GpgmeRecipients rset,void **ctx);
179 const char *gpgme_recipients_enum_read (const GpgmeRecipients rset,void **ctx);
180 GpgmeError gpgme_recipients_enum_close (const GpgmeRecipients rset,void **ctx);
181
182
183 /* Functions to handle data sources */
184 GpgmeError    gpgme_data_new ( GpgmeData *r_dh );
185 GpgmeError    gpgme_data_new_from_mem ( GpgmeData *r_dh,
186                                         const char *buffer, size_t size,
187                                         int copy );
188 GpgmeError    gpgme_data_new_with_read_cb ( GpgmeData *r_dh,
189                               int (*read_cb)(void*,char *,size_t,size_t*),
190                               void *read_cb_value );
191
192 GpgmeError    gpgme_data_new_from_file ( GpgmeData *r_dh,
193                                          const char *fname,
194                                          int copy );
195 GpgmeError    gpgme_data_new_from_filepart ( GpgmeData *r_dh,
196                                              const char *fname, FILE *fp,
197                                              off_t offset, off_t length );
198 void          gpgme_data_release ( GpgmeData dh );
199 char *        gpgme_data_release_and_get_mem ( GpgmeData dh, size_t *r_len );
200 GpgmeDataType gpgme_data_get_type ( GpgmeData dh );
201 GpgmeError    gpgme_data_rewind ( GpgmeData dh );
202 GpgmeError    gpgme_data_read ( GpgmeData dh,
203                                 char *buffer, size_t length, size_t *nread );
204 GpgmeError    gpgme_data_write ( GpgmeData dh,
205                                  const char *buffer, size_t length );
206
207
208 /* Key and trust functions */
209 void gpgme_key_ref (GpgmeKey key);
210 void gpgme_key_unref (GpgmeKey key);
211 void gpgme_key_release ( GpgmeKey key );
212 char *gpgme_key_get_as_xml ( GpgmeKey key );
213 const char  *gpgme_key_get_string_attr ( GpgmeKey key, GpgmeAttr what,
214                                          const void *reserved, int idx );
215 unsigned long gpgme_key_get_ulong_attr ( GpgmeKey key, GpgmeAttr what,
216                                          const void *reserved, int idx );
217
218 void gpgme_trust_item_release ( GpgmeTrustItem item );
219 const char *gpgme_trust_item_get_string_attr ( GpgmeTrustItem item,
220                                                GpgmeAttr what,
221                                                const void *reserved, int idx );
222 int gpgme_trust_item_get_int_attr ( GpgmeTrustItem item, GpgmeAttr what,
223                                     const void *reserved, int idx );
224
225
226
227
228 /* Basic GnuPG functions */
229 GpgmeError gpgme_op_encrypt_start ( GpgmeCtx c,
230                                     GpgmeRecipients recp,
231                                     GpgmeData in, GpgmeData out );
232 GpgmeError gpgme_op_decrypt_start ( GpgmeCtx c, 
233                                     GpgmeData ciph, GpgmeData plain );
234 GpgmeError gpgme_op_sign_start ( GpgmeCtx c,
235                                  GpgmeData in, GpgmeData out,
236                                  GpgmeSigMode mode );
237 GpgmeError gpgme_op_verify_start ( GpgmeCtx c,
238                                    GpgmeData sig, GpgmeData text );
239 GpgmeError gpgme_op_import_start ( GpgmeCtx c, GpgmeData keydata );
240 GpgmeError gpgme_op_export_start ( GpgmeCtx c, GpgmeRecipients recp,
241                                    GpgmeData keydata );
242 GpgmeError gpgme_op_genkey_start ( GpgmeCtx c, const char *parms,
243                                    GpgmeData pubkey, GpgmeData seckey );
244 GpgmeError gpgme_op_delete_start ( GpgmeCtx c, const GpgmeKey key,
245                                    int allow_secret );
246
247
248
249
250 /* Key management functions */
251 GpgmeError gpgme_op_keylist_start ( GpgmeCtx c,
252                                     const char *pattern, int secret_only );
253 GpgmeError gpgme_op_keylist_next ( GpgmeCtx c, GpgmeKey *r_key );
254 GpgmeError gpgme_op_trustlist_start ( GpgmeCtx c,
255                                       const char *pattern, int max_level );
256 GpgmeError gpgme_op_trustlist_next ( GpgmeCtx c, GpgmeTrustItem *r_item );
257
258
259
260 /* Convenience functions for normal usage */
261 GpgmeError gpgme_op_encrypt ( GpgmeCtx c, GpgmeRecipients recp,
262                               GpgmeData in, GpgmeData out );
263 GpgmeError gpgme_op_decrypt ( GpgmeCtx c, 
264                               GpgmeData in, GpgmeData out );
265 GpgmeError gpgme_op_sign ( GpgmeCtx c, GpgmeData in, GpgmeData out,
266                            GpgmeSigMode mode);
267 GpgmeError gpgme_op_verify ( GpgmeCtx c, GpgmeData sig, GpgmeData text,
268                              GpgmeSigStat *r_status );
269 GpgmeError gpgme_op_import ( GpgmeCtx c, GpgmeData keydata );
270 GpgmeError gpgme_op_export ( GpgmeCtx c, GpgmeRecipients recp,
271                              GpgmeData keydata );
272 GpgmeError gpgme_op_genkey ( GpgmeCtx c, const char *parms,
273                              GpgmeData pubkey, GpgmeData seckey );
274 GpgmeError gpgme_op_delete ( GpgmeCtx c, const GpgmeKey key, int allow_secret);
275
276
277 /* miscellaneous functions */
278 const char *gpgme_check_version (const char *req_version);
279 GpgmeError  gpgme_check_engine (void);
280 const char *gpgme_get_engine_info (void);
281 const char *gpgme_strerror (GpgmeError err);
282 void        gpgme_register_idle (void (*fnc)(void));
283
284
285 #ifdef __cplusplus
286 }
287 #endif
288 #endif /* GPGME_H */
289
290
291
292
293
294
295