Typo fixes and new gpgme_get_op_info
[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     }
99
100     c->result.verify = NULL;
101     c->result_type = RESULT_TYPE_NONE;
102     _gpgme_set_op_info (c, NULL);
103 }
104
105
106 /**
107  * gpgme_cancel:
108  * @c: the context
109  * 
110  * Cancel the current operation.  It is not guaranteed that it will work for
111  * all kinds of operations.  It is especially useful in a passphrase callback
112  * to stop the system from asking another time for the passphrase.
113  **/
114
115 void
116 gpgme_cancel (GpgmeCtx c)
117 {
118     return_if_fail (c);
119
120     c->cancel = 1;
121 }
122
123 /**
124  * gpgme_get_notation:
125  * @c: the context 
126  * 
127  * If there is notation data available from the last signature check, this
128  * function may be used to return this notation data as a string.  The string
129  * is an XML represantaton of that data embedded in a %<notation> container.
130  * 
131  * Return value: An XML string or NULL if no notation data is available.
132  **/
133 char *
134 gpgme_get_notation ( GpgmeCtx c )
135 {
136     if ( !c->notation )
137         return NULL;
138     return _gpgme_data_get_as_string ( c->notation );
139 }
140
141
142 /**
143  * gpgme_get_op_info:
144  * @c: the context 
145  * @reserved: 
146  * 
147  * Return information about the last information.  The caller has to
148  * free the string.  NULL is returned if there is not previous
149  * operation available or the operation has not yet finished.
150  *
151  * Here is a sample information we return:
152 <GnupgOperationInfo>
153   <signature>
154     <detached/> <!-- or cleartext or standard -->
155     <algo>17</algo>
156     <hashalgo>2</hashalgo>
157     <micalg>pgp-sha1</micalg>
158     <sigclass>01</sigclass>
159     <created>9222222</created>
160     <fpr>121212121212121212</fpr>
161   </signature>
162 </GnupgOperationInfo>
163  * 
164  * Return value: NULL for no info available or an XML string 
165  **/
166 char *
167 gpgme_get_op_info ( GpgmeCtx c, int reserved )
168 {
169     if (!c || reserved)
170         return NULL; /*invalid value */
171  
172     return _gpgme_data_get_as_string (c->op_info);
173 }
174
175 /*
176  * Store the data object with the operation info in the
177  * context. Caller should not use that object anymore.  
178  */
179 void
180 _gpgme_set_op_info (GpgmeCtx c, GpgmeData info)
181 {
182     assert (c);
183
184     gpgme_data_release (c->op_info); 
185     c->op_info = NULL;
186
187     if (info)
188         c->op_info = info;
189 }
190
191
192 /**
193  * gpgme_set_armor:
194  * @c: the contect 
195  * @yes: boolean value to set or clear that flag
196  * 
197  * Enable or disable the use of an ascii armor for all output.  
198  **/
199 void
200 gpgme_set_armor ( GpgmeCtx c, int yes )
201 {
202     if ( !c )
203         return; /* oops */
204     c->use_armor = yes;
205 }
206
207
208 /**
209  * gpgme_get_armor:
210  * @c: the context
211  * 
212  * Return the state of the armor flag which can be changed using
213  * gpgme_set_armor().
214  * 
215  * Return value: Boolean whether armor mode is to be used.
216  **/
217 int 
218 gpgme_get_armor (GpgmeCtx c)
219 {
220     return c && c->use_armor;
221 }
222
223
224 /**
225  * gpgme_set_textmode:
226  * @c: the context 
227  * @yes: boolean flag whether textmode should be enabled
228  * 
229  * Enable or disable the use of the special textmode.  Textmode is for example
230  * used for MIME (RFC2015) signatures
231  **/
232 void
233 gpgme_set_textmode ( GpgmeCtx c, int yes )
234 {
235     if ( !c )
236         return; /* oops */
237     c->use_textmode = yes;
238 }
239
240 /**
241  * gpgme_get_textmode:
242  * @c: the context
243  * 
244  * Return the state of the textmode flag which can be changed using
245  * gpgme_set_textmode().
246  * 
247  * Return value: Boolean whether textmode is to be used.
248  **/
249 int 
250 gpgme_get_textmode (GpgmeCtx c)
251 {
252     return c && c->use_textmode;
253 }
254
255
256
257 /**
258  * gpgme_set_keylist_mode:
259  * @c: the context
260  * @mode: listing mode
261  * 
262  * This function changes the default behaviour of the keylisting functions.
263  * Defines values for @mode are: %0 = normal, %1 = fast listing without
264  * information about key validity.
265  **/
266 void
267 gpgme_set_keylist_mode ( GpgmeCtx c, int mode )
268 {
269     if (!c)
270         return;
271     c->keylist_mode = mode;
272 }
273
274
275 /**
276  * gpgme_set_passphrase_cb:
277  * @c: the context 
278  * @cb: A callback function
279  * @cb_value: The value passed to the callback function
280  * 
281  * This function sets a callback function to be used to pass a passphrase
282  * to gpg. The preferred way to handle this is by using the gpg-agent, but
283  * because that beast is not ready for real use, you can use this passphrase
284  * thing.
285  *
286  * The callback function is defined as:
287  * <literal>
288  * typedef const char *(*GpgmePassphraseCb)(void*cb_value,
289  *                                          const char *desc,
290  *                                          void *r_hd);
291  * </literal>
292  * and called whenever gpgme needs a passphrase. DESC will have a nice
293  * text, to be used to prompt for the passphrase and R_HD is just a parameter
294  * to be used by the callback it self.  Becuase the callback returns a const
295  * string, the callback might want to know when it can release resources
296  * assocated with that returned string; gpgme helps here by calling this
297  * passphrase callback with an DESC of %NULL as soon as it does not need
298  * the returned string anymore.  The callback function might then choose
299  * to release resources depending on R_HD.
300  *
301  **/
302 void
303 gpgme_set_passphrase_cb ( GpgmeCtx c, GpgmePassphraseCb cb, void *cb_value )
304 {
305     c->passphrase_cb = cb;
306     c->passphrase_cb_value = cb_value;
307 }
308
309 /**
310  * gpgme_set_pprogress_cb:
311  * @c: the context 
312  * @cb: A callback function
313  * @cb_value: The value passed to the callback function
314  * 
315  * This function sets a callback function to be used as a progress indicator.
316  *
317  * The callback function is defined as:
318  * <literal>
319  * typedef void (*GpgmeProgressCb) (void*cb_value,
320  *                                  const char *what, int type,
321  *                                  int curretn, int total);
322  * </literal>
323  * For details on the progress events, see the entry for the PROGRESS
324  * status in the file doc/DETAILS of the GnuPG distribution.
325  **/
326 void
327 gpgme_set_progress_cb ( GpgmeCtx c, GpgmeProgressCb cb, void *cb_value )
328 {
329     c->progress_cb = cb;
330     c->progress_cb_value = cb_value;
331 }
332
333
334
335
336
337
338
339
340