Some changes
[gpgme.git] / gpgme / gpgme.c
1 /* gpgme.c -  GnuPG Made Easy
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *      Copyright (C) 2001 g10 Code GmbH
4  *
5  * This file is part of GPGME.
6  *
7  * GPGME is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GPGME is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <assert.h>
26
27 #include "util.h"
28 #include "context.h"
29 #include "ops.h"
30
31 #define my_isdigit(a)  ( (a) >='0' && (a) <= '9' )
32 #define my_isxdigit(a) ( my_isdigit((a))               \
33                          || ((a) >= 'A' && (a) <= 'F') \
34                          || ((a) >= 'f' && (a) <= 'f') )
35
36 /**
37  * gpgme_new:
38  * @r_ctx: Returns the new context
39  * 
40  * Create a new context to be used with most of the other GPGME
41  * functions.  Use gpgme_release_contect() to release all resources
42  *
43  * Return value: An error code 
44  **/
45 GpgmeError
46 gpgme_new (GpgmeCtx *r_ctx)
47 {
48     GpgmeCtx c;
49
50     c = xtrycalloc ( 1, sizeof *c );
51     if (!c)
52         return mk_error (Out_Of_Core);
53     c->verbosity = 1;
54     *r_ctx = c;
55
56     return 0;
57 }
58
59 /**
60  * gpgme_release:
61  * @c: Context to be released. 
62  * 
63  * Release all resources associated with the given context.
64  **/
65 void
66 gpgme_release ( GpgmeCtx c )
67 {
68     if (!c)
69         return;
70     _gpgme_gpg_release ( c->gpg ); 
71     _gpgme_release_result ( c );
72     gpgme_key_release ( c->tmp_key );
73     gpgme_data_release ( c->help_data_1 );
74     gpgme_data_release ( c->notation );
75     gpgme_signers_clear (c);
76     if (c->signers)
77         xfree (c->signers);
78     /* fixme: release the key_queue */
79     xfree (c);
80 }
81
82
83 void
84 _gpgme_release_result ( GpgmeCtx c )
85 {
86     switch (c->result_type) {
87       case RESULT_TYPE_NONE:
88         break;
89       case RESULT_TYPE_VERIFY:
90         _gpgme_release_verify_result ( c->result.verify );
91         break;
92       case RESULT_TYPE_DECRYPT:
93         _gpgme_release_decrypt_result ( c->result.decrypt );
94         break;
95       case RESULT_TYPE_SIGN:
96         _gpgme_release_sign_result ( c->result.sign );
97         break;
98       case RESULT_TYPE_ENCRYPT:
99         _gpgme_release_encrypt_result ( c->result.encrypt );
100         break;
101     }
102
103     c->result.verify = NULL;
104     c->result_type = RESULT_TYPE_NONE;
105     _gpgme_set_op_info (c, NULL);
106 }
107
108
109 /**
110  * gpgme_cancel:
111  * @c: the context
112  * 
113  * Cancel the current operation.  It is not guaranteed that it will work for
114  * all kinds of operations.  It is especially useful in a passphrase callback
115  * to stop the system from asking another time for the passphrase.
116  **/
117
118 void
119 gpgme_cancel (GpgmeCtx c)
120 {
121     return_if_fail (c);
122
123     c->cancel = 1;
124 }
125
126 /**
127  * gpgme_get_notation:
128  * @c: the context 
129  * 
130  * If there is notation data available from the last signature check, this
131  * function may be used to return this notation data as a string.  The string
132  * is an XML represantaton of that data embedded in a %<notation> container.
133  * 
134  * Return value: An XML string or NULL if no notation data is available.
135  **/
136 char *
137 gpgme_get_notation ( GpgmeCtx c )
138 {
139     if ( !c->notation )
140         return NULL;
141     return _gpgme_data_get_as_string ( c->notation );
142 }
143
144
145 /**
146  * gpgme_get_op_info:
147  * @c: the context 
148  * @reserved: 
149  * 
150  * Return information about the last information.  The caller has to
151  * free the string.  NULL is returned if there is not previous
152  * operation available or the operation has not yet finished.
153  *
154  * Here is a sample information we return:
155 <GnupgOperationInfo>
156   <signature>
157     <detached/> <!-- or cleartext or standard -->
158     <algo>17</algo>
159     <hashalgo>2</hashalgo>
160     <micalg>pgp-sha1</micalg>
161     <sigclass>01</sigclass>
162     <created>9222222</created>
163     <fpr>121212121212121212</fpr>
164   </signature>
165 </GnupgOperationInfo>
166  * 
167  * Return value: NULL for no info available or an XML string 
168  **/
169 char *
170 gpgme_get_op_info ( GpgmeCtx c, int reserved )
171 {
172     if (!c || reserved)
173         return NULL; /*invalid value */
174  
175     return _gpgme_data_get_as_string (c->op_info);
176 }
177
178 /*
179  * Store the data object with the operation info in the
180  * context. Caller should not use that object anymore.  
181  */
182 void
183 _gpgme_set_op_info (GpgmeCtx c, GpgmeData info)
184 {
185     assert (c);
186
187     gpgme_data_release (c->op_info); 
188     c->op_info = NULL;
189
190     if (info)
191         c->op_info = info;
192 }
193
194
195 /**
196  * gpgme_set_armor:
197  * @c: the contect 
198  * @yes: boolean value to set or clear that flag
199  * 
200  * Enable or disable the use of an ascii armor for all output.  
201  **/
202 void
203 gpgme_set_armor ( GpgmeCtx c, int yes )
204 {
205     if ( !c )
206         return; /* oops */
207     c->use_armor = yes;
208 }
209
210
211 /**
212  * gpgme_get_armor:
213  * @c: the context
214  * 
215  * Return the state of the armor flag which can be changed using
216  * gpgme_set_armor().
217  * 
218  * Return value: Boolean whether armor mode is to be used.
219  **/
220 int 
221 gpgme_get_armor (GpgmeCtx c)
222 {
223     return c && c->use_armor;
224 }
225
226
227 /**
228  * gpgme_set_textmode:
229  * @c: the context 
230  * @yes: boolean flag whether textmode should be enabled
231  * 
232  * Enable or disable the use of the special textmode.  Textmode is for example
233  * used for MIME (RFC2015) signatures
234  **/
235 void
236 gpgme_set_textmode ( GpgmeCtx c, int yes )
237 {
238     if ( !c )
239         return; /* oops */
240     c->use_textmode = yes;
241 }
242
243 /**
244  * gpgme_get_textmode:
245  * @c: the context
246  * 
247  * Return the state of the textmode flag which can be changed using
248  * gpgme_set_textmode().
249  * 
250  * Return value: Boolean whether textmode is to be used.
251  **/
252 int 
253 gpgme_get_textmode (GpgmeCtx c)
254 {
255     return c && c->use_textmode;
256 }
257
258
259
260 /**
261  * gpgme_set_keylist_mode:
262  * @c: the context
263  * @mode: listing mode
264  * 
265  * This function changes the default behaviour of the keylisting functions.
266  * Defines values for @mode are: %0 = normal, %1 = fast listing without
267  * information about key validity.
268  **/
269 void
270 gpgme_set_keylist_mode ( GpgmeCtx c, int mode )
271 {
272     if (!c)
273         return;
274     c->keylist_mode = mode;
275 }
276
277
278 /**
279  * gpgme_set_passphrase_cb:
280  * @c: the context 
281  * @cb: A callback function
282  * @cb_value: The value passed to the callback function
283  * 
284  * This function sets a callback function to be used to pass a passphrase
285  * to gpg. The preferred way to handle this is by using the gpg-agent, but
286  * because that beast is not ready for real use, you can use this passphrase
287  * thing.
288  *
289  * The callback function is defined as:
290  * <literal>
291  * typedef const char *(*GpgmePassphraseCb)(void*cb_value,
292  *                                          const char *desc,
293  *                                          void *r_hd);
294  * </literal>
295  * and called whenever gpgme needs a passphrase. DESC will have a nice
296  * text, to be used to prompt for the passphrase and R_HD is just a parameter
297  * to be used by the callback it self.  Becuase the callback returns a const
298  * string, the callback might want to know when it can release resources
299  * assocated with that returned string; gpgme helps here by calling this
300  * passphrase callback with an DESC of %NULL as soon as it does not need
301  * the returned string anymore.  The callback function might then choose
302  * to release resources depending on R_HD.
303  *
304  **/
305 void
306 gpgme_set_passphrase_cb ( GpgmeCtx c, GpgmePassphraseCb cb, void *cb_value )
307 {
308     c->passphrase_cb = cb;
309     c->passphrase_cb_value = cb_value;
310 }
311
312 /**
313  * gpgme_set_pprogress_cb:
314  * @c: the context 
315  * @cb: A callback function
316  * @cb_value: The value passed to the callback function
317  * 
318  * This function sets a callback function to be used as a progress indicator.
319  *
320  * The callback function is defined as:
321  * <literal>
322  * typedef void (*GpgmeProgressCb) (void*cb_value,
323  *                                  const char *what, int type,
324  *                                  int curretn, int total);
325  * </literal>
326  * For details on the progress events, see the entry for the PROGRESS
327  * status in the file doc/DETAILS of the GnuPG distribution.
328  **/
329 void
330 gpgme_set_progress_cb ( GpgmeCtx c, GpgmeProgressCb cb, void *cb_value )
331 {
332     c->progress_cb = cb;
333     c->progress_cb_value = cb_value;
334 }
335
336
337
338
339
340
341
342
343