doc/
[gpgme.git] / gpgme / sign.c
1 /* sign.c - Signing function.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003 g10 Code GmbH
4
5    This file is part of GPGME.
6  
7    GPGME is free software; you can redistribute it and/or modify it
8    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, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    General Public License for more details.
16  
17    You should have received a copy of the GNU General Public License
18    along with GPGME; if not, write to the Free Software Foundation,
19    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20
21 #if HAVE_CONFIG_H
22 #include <config.h>
23 #endif
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27
28 #include "gpgme.h"
29 #include "context.h"
30 #include "ops.h"
31
32 \f
33 typedef struct
34 {
35   struct _gpgme_op_sign_result result;
36
37   /* A pointer to the next pointer of the last invalid signer in
38      the list.  This makes appending new invalid signers painless
39      while preserving the order.  */
40   gpgme_invalid_key_t *last_signer_p;
41
42   /* Likewise for signature information.  */
43   gpgme_new_signature_t *last_sig_p;
44 } *op_data_t;
45
46
47 static void
48 release_op_data (void *hook)
49 {
50   op_data_t opd = (op_data_t) hook;
51   gpgme_invalid_key_t invalid_signer = opd->result.invalid_signers;
52   gpgme_new_signature_t sig = opd->result.signatures;
53
54   while (invalid_signer)
55     {
56       gpgme_invalid_key_t next = invalid_signer->next;
57       if (invalid_signer->fpr)
58         free (invalid_signer->fpr);
59       free (invalid_signer);
60       invalid_signer = next;
61     }
62
63   while (sig)
64     {
65       gpgme_new_signature_t next = sig->next;
66       free (sig->fpr);
67       free (sig);
68       sig = next;
69     }
70 }
71
72
73 gpgme_sign_result_t
74 gpgme_op_sign_result (gpgme_ctx_t ctx)
75 {
76   void *hook;
77   op_data_t opd;
78   gpgme_error_t err;
79
80   err = _gpgme_op_data_lookup (ctx, OPDATA_SIGN, &hook, -1, NULL);
81   opd = hook;
82   if (err || !opd)
83     return NULL;
84
85   return &opd->result;
86 }
87
88 \f
89 static gpgme_error_t
90 parse_sig_created (char *args, gpgme_new_signature_t *sigp)
91 {
92   gpgme_new_signature_t sig;
93   char *tail;
94
95   sig = malloc (sizeof (*sig));
96   if (!sig)
97     return gpg_error_from_errno (errno);
98
99   sig->next = NULL;
100   switch (*args)
101     {
102     case 'S':
103       sig->type = GPGME_SIG_MODE_NORMAL;
104       break;
105
106     case 'D':
107       sig->type = GPGME_SIG_MODE_DETACH;
108       break;
109
110     case 'C':
111       sig->type = GPGME_SIG_MODE_CLEAR;
112       break;
113
114     default:
115       /* The backend engine is not behaving.  */
116       free (sig);
117       return gpg_error (GPG_ERR_INV_ENGINE);
118     }
119
120   args++;
121   if (*args != ' ')
122     {
123       free (sig);
124       return gpg_error (GPG_ERR_INV_ENGINE);
125     }
126
127   errno = 0;
128   sig->pubkey_algo = strtol (args, &tail, 0);
129   if (errno || args == tail || *tail != ' ')
130     {
131       /* The crypto backend does not behave.  */
132       free (sig);
133       return gpg_error (GPG_ERR_INV_ENGINE);
134     }
135   args = tail;
136
137   sig->hash_algo = strtol (args, &tail, 0);
138   if (errno || args == tail || *tail != ' ')
139     {
140       /* The crypto backend does not behave.  */
141       free (sig);
142       return gpg_error (GPG_ERR_INV_ENGINE);
143     }
144   args = tail;
145
146   sig->class = strtol (args, &tail, 0);
147   if (errno || args == tail || *tail != ' ')
148     {
149       /* The crypto backend does not behave.  */
150       free (sig);
151       return gpg_error (GPG_ERR_INV_ENGINE);
152     }
153   args = tail;
154
155   sig->timestamp = strtol (args, &tail, 0);
156   if (errno || args == tail || *tail != ' ')
157     {
158       /* The crypto backend does not behave.  */
159       free (sig);
160       return gpg_error (GPG_ERR_INV_ENGINE);
161     }
162   args = tail;
163   while (*args == ' ')
164     args++;
165
166   if (!*args)
167     {
168       /* The crypto backend does not behave.  */
169       free (sig);
170       return gpg_error (GPG_ERR_INV_ENGINE);
171     }
172
173   tail = strchr (args, ' ');
174   if (tail)
175     *tail = '\0';
176
177   sig->fpr = strdup (args);
178   if (!sig->fpr)
179     {
180       int saved_errno = errno;
181       free (sig);
182       return gpg_error_from_errno (saved_errno);
183     }
184   *sigp = sig;
185   return 0;
186 }
187
188
189 gpgme_error_t
190 _gpgme_sign_status_handler (void *priv, gpgme_status_code_t code, char *args)
191 {
192   gpgme_ctx_t ctx = (gpgme_ctx_t) priv;
193   gpgme_error_t err;
194   void *hook;
195   op_data_t opd;
196
197   err = _gpgme_passphrase_status_handler (priv, code, args);
198   if (err)
199     return err;
200
201   err = _gpgme_op_data_lookup (ctx, OPDATA_SIGN, &hook, -1, NULL);
202   opd = hook;
203   if (err)
204     return err;
205
206   switch (code)
207     {
208     case GPGME_STATUS_SIG_CREATED:
209       err = parse_sig_created (args, opd->last_sig_p);
210       if (err)
211         return err;
212
213       opd->last_sig_p = &(*opd->last_sig_p)->next;
214       break;
215
216     case GPGME_STATUS_INV_RECP:
217       err = _gpgme_parse_inv_recp (args, opd->last_signer_p);
218       if (err)
219         return err;
220
221       opd->last_signer_p = &(*opd->last_signer_p)->next;
222       break;
223
224     case GPGME_STATUS_EOF:
225       if (opd->result.invalid_signers)
226         return gpg_error (GPG_ERR_UNUSABLE_SECKEY);
227       break;
228
229     default:
230       break;
231     }
232   return err;
233 }
234
235
236 static gpgme_error_t
237 sign_status_handler (void *priv, gpgme_status_code_t code, char *args)
238 {
239   gpgme_error_t err;
240
241   err = _gpgme_progress_status_handler (priv, code, args);
242   if (!err)
243     err = _gpgme_sign_status_handler (priv, code, args);
244   return err;
245 }
246
247
248 gpgme_error_t
249 _gpgme_op_sign_init_result (gpgme_ctx_t ctx)
250 {
251   gpgme_error_t err;
252   void *hook;
253   op_data_t opd;
254
255   err = _gpgme_op_data_lookup (ctx, OPDATA_SIGN, &hook,
256                                sizeof (*opd), release_op_data);
257   opd = hook;
258   if (err)
259     return err;
260   opd->last_signer_p = &opd->result.invalid_signers;
261   opd->last_sig_p = &opd->result.signatures;
262   return 0;
263 }
264
265
266 static gpgme_error_t
267 sign_start (gpgme_ctx_t ctx, int synchronous, gpgme_data_t plain,
268             gpgme_data_t sig, gpgme_sig_mode_t mode)
269 {
270   gpgme_error_t err;
271
272   err = _gpgme_op_reset (ctx, synchronous);
273   if (err)
274     return err;
275
276   err = _gpgme_op_sign_init_result (ctx);
277   if (err)
278     return err;
279
280   if (mode != GPGME_SIG_MODE_NORMAL && mode != GPGME_SIG_MODE_DETACH
281       && mode != GPGME_SIG_MODE_CLEAR)
282     return gpg_error (GPG_ERR_INV_VALUE);
283
284   if (!plain)
285     return gpg_error (GPG_ERR_NO_DATA);
286   if (!sig)
287     return gpg_error (GPG_ERR_INV_VALUE);
288
289   if (ctx->passphrase_cb)
290     {
291       err = _gpgme_engine_set_command_handler
292         (ctx->engine, _gpgme_passphrase_command_handler, ctx, NULL);
293       if (err)
294         return err;
295     }
296
297   _gpgme_engine_set_status_handler (ctx->engine, sign_status_handler,
298                                     ctx);
299
300   return _gpgme_engine_op_sign (ctx->engine, plain, sig, mode, ctx->use_armor,
301                                 ctx->use_textmode, ctx->include_certs,
302                                 ctx /* FIXME */);
303 }
304
305
306 /* Sign the plaintext PLAIN and store the signature in SIG.  */
307 gpgme_error_t
308 gpgme_op_sign_start (gpgme_ctx_t ctx, gpgme_data_t plain, gpgme_data_t sig,
309                      gpgme_sig_mode_t mode)
310 {
311   return sign_start (ctx, 0, plain, sig, mode);
312 }
313
314
315 /* Sign the plaintext PLAIN and store the signature in SIG.  */
316 gpgme_error_t
317 gpgme_op_sign (gpgme_ctx_t ctx, gpgme_data_t plain, gpgme_data_t sig,
318                gpgme_sig_mode_t mode)
319 {
320   gpgme_error_t err = sign_start (ctx, 1, plain, sig, mode);
321   if (!err)
322     err = _gpgme_wait_one (ctx);
323   return err;
324 }