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_user_id_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_user_id_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_user_id_t next = invalid_signer->next;
57       free (invalid_signer->id);
58       free (invalid_signer);
59       invalid_signer = next;
60     }
61
62   while (sig)
63     {
64       gpgme_new_signature_t next = sig->next;
65       free (sig->fpr);
66       free (sig);
67       sig = next;
68     }
69 }
70
71
72 gpgme_sign_result_t
73 gpgme_op_sign_result (gpgme_ctx_t ctx)
74 {
75   void *hook;
76   op_data_t opd;
77   gpgme_error_t err;
78
79   err = _gpgme_op_data_lookup (ctx, OPDATA_SIGN, &hook, -1, NULL);
80   opd = hook;
81   if (err || !opd)
82     return NULL;
83
84   return &opd->result;
85 }
86
87 \f
88 static gpgme_error_t
89 parse_sig_created (char *args, gpgme_new_signature_t *sigp)
90 {
91   gpgme_new_signature_t sig;
92   char *tail;
93
94   sig = malloc (sizeof (*sig));
95   if (!sig)
96     return gpg_error_from_errno (errno);
97
98   sig->next = NULL;
99   switch (*args)
100     {
101     case 'S':
102       sig->type = GPGME_SIG_MODE_NORMAL;
103       break;
104
105     case 'D':
106       sig->type = GPGME_SIG_MODE_DETACH;
107       break;
108
109     case 'C':
110       sig->type = GPGME_SIG_MODE_CLEAR;
111       break;
112
113     default:
114       /* The backend engine is not behaving.  */
115       free (sig);
116       return gpg_error (GPG_ERR_INV_ENGINE);
117     }
118
119   args++;
120   if (*args != ' ')
121     {
122       free (sig);
123       return gpg_error (GPG_ERR_INV_ENGINE);
124     }
125
126   errno = 0;
127   sig->pubkey_algo = strtol (args, &tail, 0);
128   if (errno || args == tail || *tail != ' ')
129     {
130       /* The crypto backend does not behave.  */
131       free (sig);
132       return gpg_error (GPG_ERR_INV_ENGINE);
133     }
134   args = tail;
135
136   sig->hash_algo = strtol (args, &tail, 0);
137   if (errno || args == tail || *tail != ' ')
138     {
139       /* The crypto backend does not behave.  */
140       free (sig);
141       return gpg_error (GPG_ERR_INV_ENGINE);
142     }
143   args = tail;
144
145   sig->class = strtol (args, &tail, 0);
146   if (errno || args == tail || *tail != ' ')
147     {
148       /* The crypto backend does not behave.  */
149       free (sig);
150       return gpg_error (GPG_ERR_INV_ENGINE);
151     }
152   args = tail;
153
154   sig->timestamp = strtol (args, &tail, 0);
155   if (errno || args == tail || *tail != ' ')
156     {
157       /* The crypto backend does not behave.  */
158       free (sig);
159       return gpg_error (GPG_ERR_INV_ENGINE);
160     }
161   args = tail;
162   while (*args == ' ')
163     args++;
164
165   if (!*args)
166     {
167       /* The crypto backend does not behave.  */
168       free (sig);
169       return gpg_error (GPG_ERR_INV_ENGINE);
170     }
171
172   tail = strchr (args, ' ');
173   if (tail)
174     *tail = '\0';
175
176   sig->fpr = strdup (args);
177   if (!sig->fpr)
178     {
179       int saved_errno = errno;
180       free (sig);
181       return gpg_error_from_errno (saved_errno);
182     }
183   *sigp = sig;
184   return 0;
185 }
186
187
188 gpgme_error_t
189 _gpgme_sign_status_handler (void *priv, gpgme_status_code_t code, char *args)
190 {
191   gpgme_ctx_t ctx = (gpgme_ctx_t) priv;
192   gpgme_error_t err;
193   void *hook;
194   op_data_t opd;
195
196   err = _gpgme_passphrase_status_handler (priv, code, args);
197   if (err)
198     return err;
199
200   err = _gpgme_op_data_lookup (ctx, OPDATA_SIGN, &hook, -1, NULL);
201   opd = hook;
202   if (err)
203     return err;
204
205   switch (code)
206     {
207     case GPGME_STATUS_SIG_CREATED:
208       err = parse_sig_created (args, opd->last_sig_p);
209       if (err)
210         return err;
211
212       opd->last_sig_p = &(*opd->last_sig_p)->next;
213       break;
214
215     case GPGME_STATUS_INV_RECP:
216       err = _gpgme_parse_inv_userid (args, opd->last_signer_p);
217       if (err)
218         return err;
219
220       opd->last_signer_p = &(*opd->last_signer_p)->next;
221       break;
222
223     case GPGME_STATUS_EOF:
224       if (opd->result.invalid_signers)
225         return gpg_error (GPG_ERR_INV_USER_ID);
226       break;
227
228     default:
229       break;
230     }
231   return err;
232 }
233
234
235 static gpgme_error_t
236 sign_status_handler (void *priv, gpgme_status_code_t code, char *args)
237 {
238   return _gpgme_progress_status_handler (priv, code, args)
239     || _gpgme_sign_status_handler (priv, code, args);
240 }
241
242
243 gpgme_error_t
244 _gpgme_op_sign_init_result (gpgme_ctx_t ctx)
245 {
246   gpgme_error_t err;
247   void *hook;
248   op_data_t opd;
249
250   err = _gpgme_op_data_lookup (ctx, OPDATA_SIGN, &hook,
251                                sizeof (*opd), release_op_data);
252   opd = hook;
253   if (err)
254     return err;
255   opd->last_signer_p = &opd->result.invalid_signers;
256   opd->last_sig_p = &opd->result.signatures;
257   return 0;
258 }
259
260
261 static gpgme_error_t
262 sign_start (gpgme_ctx_t ctx, int synchronous, gpgme_data_t plain,
263             gpgme_data_t sig, gpgme_sig_mode_t mode)
264 {
265   gpgme_error_t err;
266
267   err = _gpgme_op_reset (ctx, synchronous);
268   if (err)
269     return err;
270
271   err = _gpgme_op_sign_init_result (ctx);
272   if (err)
273     return err;
274
275   if (mode != GPGME_SIG_MODE_NORMAL && mode != GPGME_SIG_MODE_DETACH
276       && mode != GPGME_SIG_MODE_CLEAR)
277     return gpg_error (GPG_ERR_INV_VALUE);
278
279   if (!plain)
280     return gpg_error (GPG_ERR_NO_DATA);
281   if (!sig)
282     return gpg_error (GPG_ERR_INV_VALUE);
283
284   if (ctx->passphrase_cb)
285     {
286       err = _gpgme_engine_set_command_handler
287         (ctx->engine, _gpgme_passphrase_command_handler, ctx, NULL);
288       if (err)
289         return err;
290     }
291
292   _gpgme_engine_set_status_handler (ctx->engine, sign_status_handler,
293                                     ctx);
294
295   return _gpgme_engine_op_sign (ctx->engine, plain, sig, mode, ctx->use_armor,
296                                 ctx->use_textmode, ctx->include_certs,
297                                 ctx /* FIXME */);
298 }
299
300
301 /* Sign the plaintext PLAIN and store the signature in SIG.  */
302 gpgme_error_t
303 gpgme_op_sign_start (gpgme_ctx_t ctx, gpgme_data_t plain, gpgme_data_t sig,
304                      gpgme_sig_mode_t mode)
305 {
306   return sign_start (ctx, 0, plain, sig, mode);
307 }
308
309
310 /* Sign the plaintext PLAIN and store the signature in SIG.  */
311 gpgme_error_t
312 gpgme_op_sign (gpgme_ctx_t ctx, gpgme_data_t plain, gpgme_data_t sig,
313                gpgme_sig_mode_t mode)
314 {
315   gpgme_error_t err = sign_start (ctx, 1, plain, sig, mode);
316   if (!err)
317     err = _gpgme_wait_one (ctx);
318   return err;
319 }