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