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