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