4e388a4126f38b8d4a6751938a9de6233d99e0fb
[gpgme.git] / src / op-support.c
1 /* op-support.c - Supporting functions.
2    Copyright (C) 2002, 2003, 2004, 2007 g10 Code GmbH
3
4    This file is part of GPGME.
5
6    GPGME is free software; you can redistribute it and/or modify it
7    under the terms of the GNU Lesser General Public License as
8    published by the Free Software Foundation; either version 2.1 of
9    the License, or (at your option) any later version.
10
11    GPGME is distributed in the hope that it will be useful, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #if HAVE_CONFIG_H
21 #include <config.h>
22 #endif
23 #include <stdlib.h>
24 #include <errno.h>
25 #include <string.h>
26 #ifdef HAVE_LOCALE_H
27 #include <locale.h>
28 #endif
29
30 #include "gpgme.h"
31 #include "context.h"
32 #include "ops.h"
33 #include "util.h"
34 #include "debug.h"
35
36 #if GPG_ERROR_VERSION_NUMBER < 0x011700  /* 1.23 */
37 # define GPG_ERR_SUBKEYS_EXP_OR_REV 217
38 #endif
39
40
41 \f
42 gpgme_error_t
43 _gpgme_op_data_lookup (gpgme_ctx_t ctx, ctx_op_data_id_t type, void **hook,
44                        int size, void (*cleanup) (void *))
45 {
46   struct ctx_op_data *data;
47
48   if (!ctx)
49     return gpg_error (GPG_ERR_INV_VALUE);
50
51   data = ctx->op_data;
52   while (data && data->type != type)
53     data = data->next;
54   if (!data)
55     {
56       if (size < 0)
57         {
58           *hook = NULL;
59           return 0;
60         }
61
62       data = calloc (1, sizeof (struct ctx_op_data) + size);
63       if (!data)
64         return gpg_error_from_syserror ();
65       data->magic = CTX_OP_DATA_MAGIC;
66       data->next = ctx->op_data;
67       data->type = type;
68       data->cleanup = cleanup;
69       data->hook = (void *) (((char *) data) + sizeof (struct ctx_op_data));
70       data->references = 1;
71       ctx->op_data = data;
72     }
73   *hook = data->hook;
74   return 0;
75 }
76
77
78 /* type is: 0: asynchronous operation (use global or user event loop).
79             1: synchronous operation (always use private event loop).
80             2: asynchronous private operation (use private or user
81             event loop).
82             256: Modification flag to suppress the engine reset.
83 */
84 gpgme_error_t
85 _gpgme_op_reset (gpgme_ctx_t ctx, int type)
86 {
87   gpgme_error_t err = 0;
88   struct gpgme_io_cbs io_cbs;
89   int no_reset = (type & 256);
90   int reuse_engine = 0;
91
92   type &= 255;
93
94   _gpgme_release_result (ctx);
95   LOCK (ctx->lock);
96   ctx->canceled = 0;
97   UNLOCK (ctx->lock);
98
99   if (ctx->engine && no_reset)
100     reuse_engine = 1;
101   else if (ctx->engine)
102     {
103       /* Attempt to reset an existing engine.  */
104
105       err = _gpgme_engine_reset (ctx->engine);
106       if (gpg_err_code (err) == GPG_ERR_NOT_IMPLEMENTED)
107         {
108           _gpgme_engine_release (ctx->engine);
109           ctx->engine = NULL;
110         }
111     }
112
113   if (!ctx->engine)
114     {
115       gpgme_engine_info_t info;
116       info = ctx->engine_info;
117       while (info && info->protocol != ctx->protocol)
118         info = info->next;
119
120       if (!info)
121         return gpg_error (GPG_ERR_UNSUPPORTED_PROTOCOL);
122
123       /* Create an engine object.  */
124       err = _gpgme_engine_new (info, &ctx->engine);
125       if (err)
126         return err;
127     }
128
129   if (!reuse_engine)
130     {
131       err = 0;
132 #ifdef LC_CTYPE
133       err = _gpgme_engine_set_locale (ctx->engine, LC_CTYPE, ctx->lc_ctype);
134 #endif
135 #ifdef LC_MESSAGES
136       if (!err)
137         err = _gpgme_engine_set_locale (ctx->engine,
138                                         LC_MESSAGES, ctx->lc_messages);
139 #endif
140       if (gpg_err_code (err) == GPG_ERR_NOT_IMPLEMENTED)
141         err = 0;
142
143       if (!err)
144         {
145           err = _gpgme_engine_set_pinentry_mode (ctx->engine,
146                                                  ctx->pinentry_mode);
147           if (gpg_err_code (err) == GPG_ERR_NOT_IMPLEMENTED)
148             err = 0;
149         }
150
151       if (err)
152         {
153           _gpgme_engine_release (ctx->engine);
154           ctx->engine = NULL;
155           return err;
156         }
157     }
158
159   if (ctx->sub_protocol != GPGME_PROTOCOL_DEFAULT)
160     {
161       err = _gpgme_engine_set_protocol (ctx->engine, ctx->sub_protocol);
162       if (err)
163         return err;
164     }
165
166   if (type == 1 || (type == 2 && !ctx->io_cbs.add))
167     {
168       /* Use private event loop.  */
169       io_cbs.add = _gpgme_add_io_cb;
170       io_cbs.add_priv = ctx;
171       io_cbs.remove = _gpgme_remove_io_cb;
172       io_cbs.event = _gpgme_wait_private_event_cb;
173       io_cbs.event_priv = ctx;
174     }
175   else if (! ctx->io_cbs.add)
176     {
177       /* Use global event loop.  */
178       io_cbs.add = _gpgme_add_io_cb;
179       io_cbs.add_priv = ctx;
180       io_cbs.remove = _gpgme_remove_io_cb;
181       io_cbs.event = _gpgme_wait_global_event_cb;
182       io_cbs.event_priv = ctx;
183     }
184   else
185     {
186       /* Use user event loop.  */
187       io_cbs.add = _gpgme_wait_user_add_io_cb;
188       io_cbs.add_priv = ctx;
189       io_cbs.remove = _gpgme_wait_user_remove_io_cb;
190       io_cbs.event = _gpgme_wait_user_event_cb;
191       io_cbs.event_priv = ctx;
192     }
193   _gpgme_engine_set_io_cbs (ctx->engine, &io_cbs);
194   return err;
195 }
196
197 \f
198 /* Parse the INV_RECP or INV_SNDR status line in ARGS and return the
199    result in KEY.  If KC_FPR (from the KEY_CONSIDERED status line) is
200    not NULL take the KC_FLAGS in account. */
201 gpgme_error_t
202 _gpgme_parse_inv_recp (char *args, int for_signing,
203                        const char *kc_fpr, unsigned int kc_flags,
204                        gpgme_invalid_key_t *key)
205 {
206   gpgme_invalid_key_t inv_key;
207   char *tail;
208   long int reason;
209
210   inv_key = calloc (1, sizeof (*inv_key));
211   if (!inv_key)
212     return gpg_error_from_syserror ();
213   inv_key->next = NULL;
214   gpg_err_set_errno (0);
215   reason = strtol (args, &tail, 0);
216   if (errno || args == tail || (*tail && *tail != ' '))
217     {
218       /* The crypto backend does not behave.  */
219       free (inv_key);
220       return trace_gpg_error (GPG_ERR_INV_ENGINE);
221     }
222
223   switch (reason)
224     {
225     case 0:
226       if (kc_fpr && (kc_flags & 2))
227         inv_key->reason = gpg_error (GPG_ERR_SUBKEYS_EXP_OR_REV);
228       else
229         inv_key->reason = gpg_error (GPG_ERR_GENERAL);
230       break;
231
232     case 1:
233       inv_key->reason = gpg_error (GPG_ERR_NO_PUBKEY);
234       break;
235
236     case 2:
237       inv_key->reason = gpg_error (GPG_ERR_AMBIGUOUS_NAME);
238       break;
239
240     case 3:
241       inv_key->reason = gpg_error (GPG_ERR_WRONG_KEY_USAGE);
242       break;
243
244     case 4:
245       inv_key->reason = gpg_error (GPG_ERR_CERT_REVOKED);
246       break;
247
248     case 5:
249       inv_key->reason = gpg_error (GPG_ERR_CERT_EXPIRED);
250       break;
251
252     case 6:
253       inv_key->reason = gpg_error (GPG_ERR_NO_CRL_KNOWN);
254       break;
255
256     case 7:
257       inv_key->reason = gpg_error (GPG_ERR_CRL_TOO_OLD);
258       break;
259
260     case 8:
261       inv_key->reason = gpg_error (GPG_ERR_NO_POLICY_MATCH);
262       break;
263
264     case 9:
265       inv_key->reason = gpg_error (GPG_ERR_NO_SECKEY);
266       break;
267
268     case 10:
269       inv_key->reason = gpg_error (GPG_ERR_PUBKEY_NOT_TRUSTED);
270       break;
271
272     case 11:
273       inv_key->reason = gpg_error (GPG_ERR_MISSING_CERT);
274       break;
275
276     case 12:
277       inv_key->reason = gpg_error (GPG_ERR_MISSING_ISSUER_CERT);
278       break;
279
280     case 13:
281       inv_key->reason = gpg_error (252); /*GPG_ERR_KEY_DISABLED*/
282       break;
283
284     case 14:
285       inv_key->reason = gpg_error (GPG_ERR_INV_USER_ID);
286       break;
287
288     default:
289       inv_key->reason = gpg_error (GPG_ERR_GENERAL);
290       break;
291     }
292
293   while (*tail && *tail == ' ')
294     tail++;
295   if (*tail)
296     {
297       inv_key->fpr = strdup (tail);
298       if (!inv_key->fpr)
299         {
300           free (inv_key);
301           return gpg_error_from_syserror ();
302         }
303     }
304
305   *key = inv_key;
306   return 0;
307 }
308
309
310 \f
311 /* Parse a KEY_CONSIDERED status line in ARGS and store the
312  * fingerprint and the flags at R_FPR and R_FLAGS.  The caller must
313  * free the value at R_FPR on success.  */
314 gpgme_error_t
315 _gpgme_parse_key_considered (const char *args,
316                              char **r_fpr, unsigned int *r_flags)
317 {
318   char *pend;
319   size_t n;
320
321   *r_fpr = NULL;
322
323   pend = strchr (args, ' ');
324   if (!pend || pend == args)
325     return trace_gpg_error (GPG_ERR_INV_ENGINE);  /* Bogus status line.  */
326   n = pend - args;
327   *r_fpr = malloc (n + 1);
328   if (!*r_fpr)
329     return gpg_error_from_syserror ();
330   memcpy (*r_fpr, args, n);
331   (*r_fpr)[n] = 0;
332   args = pend + 1;
333
334   gpg_err_set_errno (0);
335   *r_flags = strtoul (args, &pend, 0);
336   if (errno || args == pend || (*pend && *pend != ' '))
337     {
338       free (*r_fpr);
339       *r_fpr = NULL;
340       return trace_gpg_error (GPG_ERR_INV_ENGINE);
341     }
342
343   return 0;
344 }
345
346
347 /* Parse the PLAINTEXT status line in ARGS and return the result in
348    FILENAMEP.  */
349 gpgme_error_t
350 _gpgme_parse_plaintext (char *args, char **filenamep)
351 {
352   char *tail;
353
354   while (*args == ' ')
355     args++;
356   if (*args == '\0')
357     return 0;
358
359   /* First argument is file type.  */
360   while (*args != ' ' && *args != '\0')
361     args++;
362   while (*args == ' ')
363     args++;
364   if (*args == '\0')
365     return 0;
366
367   /* Second argument is the timestamp.  */
368   while (*args != ' ' && *args != '\0')
369     args++;
370   while (*args == ' ')
371     args++;
372   if (*args == '\0')
373     return 0;
374
375   tail = args;
376   while (*tail != ' ' && *tail != '\0')
377     tail++;
378   *tail = '\0';
379   if (filenamep && *args != '\0')
380     {
381       char *filename = strdup (args);
382       if (!filename)
383         return gpg_error_from_syserror ();
384
385       *filenamep = filename;
386     }
387   return 0;
388 }
389
390
391 /* Parse a FAILURE status line and return the error code.  ARGS is
392    modified to contain the location part.  */
393 gpgme_error_t
394 _gpgme_parse_failure (char *args)
395 {
396   char *where, *which;
397
398   where = strchr (args, ' ');
399   if (!where)
400     return trace_gpg_error (GPG_ERR_INV_ENGINE);
401
402   *where = '\0';
403   which = where + 1;
404
405   where = strchr (which, ' ');
406   if (where)
407     *where = '\0';
408
409   where = args;
410
411   return atoi (which);
412 }