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