* sign.c (gpgsm_sign): Print an error message on all failures.
[gnupg.git] / sm / sign.c
1 /* sign.c - Sign a message
2  *      Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <unistd.h> 
27 #include <time.h>
28 #include <assert.h>
29
30 #include "gpgsm.h"
31 #include <gcrypt.h>
32 #include <ksba.h>
33
34 #include "keydb.h"
35 #include "i18n.h"
36
37
38 static void
39 hash_data (int fd, gcry_md_hd_t md)
40 {
41   FILE *fp;
42   char buffer[4096];
43   int nread;
44
45   fp = fdopen ( dup (fd), "rb");
46   if (!fp)
47     {
48       log_error ("fdopen(%d) failed: %s\n", fd, strerror (errno));
49       return;
50     }
51
52   do 
53     {
54       nread = fread (buffer, 1, DIM(buffer), fp);
55       gcry_md_write (md, buffer, nread);
56     }
57   while (nread);
58   if (ferror (fp))
59       log_error ("read error on fd %d: %s\n", fd, strerror (errno));
60   fclose (fp);
61 }
62
63 static int
64 hash_and_copy_data (int fd, gcry_md_hd_t md, ksba_writer_t writer)
65 {
66   gpg_error_t err;
67   FILE *fp;
68   char buffer[4096];
69   int nread;
70   int rc = 0;
71   int any = 0;
72
73   fp = fdopen ( dup (fd), "rb");
74   if (!fp)
75     {
76       gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
77       log_error ("fdopen(%d) failed: %s\n", fd, strerror (errno));
78       return tmperr;
79     }
80
81   do 
82     {
83       nread = fread (buffer, 1, DIM(buffer), fp);
84       if (nread)
85         {
86           any = 1;
87           gcry_md_write (md, buffer, nread);
88           err = ksba_writer_write_octet_string (writer, buffer, nread, 0);
89           if (err)
90             {
91               log_error ("write failed: %s\n", gpg_strerror (err));
92               rc = err;
93             }
94         }
95     }
96   while (nread && !rc);
97   if (ferror (fp))
98     {
99       rc = gpg_error (gpg_err_code_from_errno (errno));
100       log_error ("read error on fd %d: %s\n", fd, strerror (errno));
101     }
102   fclose (fp);
103   if (!any)
104     {
105       /* We can't allow to sign an empty message because it does not
106          make much sense and more seriously, ksba-cms_build has
107          already written the tag for data and now expects an octet
108          string but an octet string of zeize 0 is illegal. */
109       log_error ("cannot sign an empty message\n");
110       rc = gpg_error (GPG_ERR_NO_DATA);
111     }
112   if (!rc)
113     {
114       err = ksba_writer_write_octet_string (writer, NULL, 0, 1);
115       if (err)
116         {
117           log_error ("write failed: %s\n", gpg_strerror (err));
118           rc = err;
119         }
120     }
121
122   return rc;
123 }
124
125
126 /* Get the default certificate which is defined as the first one our
127    keyDB returns and has a secret key available. */
128 int
129 gpgsm_get_default_cert (ksba_cert_t *r_cert)
130 {
131   KEYDB_HANDLE hd;
132   ksba_cert_t cert = NULL;
133   int rc;
134   char *p;
135
136   hd = keydb_new (0);
137   if (!hd)
138     return gpg_error (GPG_ERR_GENERAL);
139   rc = keydb_search_first (hd);
140   if (rc)
141     {
142       keydb_release (hd);
143       return rc;
144     }
145
146   do
147     {
148       rc = keydb_get_cert (hd, &cert);
149       if (rc) 
150         {
151           log_error ("keydb_get_cert failed: %s\n", gpg_strerror (rc));
152           keydb_release (hd);
153           return rc;
154         }
155       
156       p = gpgsm_get_keygrip_hexstring (cert);
157       if (p)
158         {
159           if (!gpgsm_agent_havekey (p))
160             {
161               xfree (p);
162               keydb_release (hd);
163               *r_cert = cert;
164               return 0; /* got it */
165             }
166           xfree (p);
167         }
168     
169       ksba_cert_release (cert); 
170       cert = NULL;
171     }
172   while (!(rc = keydb_search_next (hd)));
173   if (rc && rc != -1)
174     log_error ("keydb_search_next failed: %s\n", gpg_strerror (rc));
175   
176   ksba_cert_release (cert);
177   keydb_release (hd);
178   return rc;
179 }
180
181
182 static ksba_cert_t
183 get_default_signer (void)
184 {
185   KEYDB_SEARCH_DESC desc;
186   ksba_cert_t cert = NULL;
187   KEYDB_HANDLE kh = NULL;
188   int rc;
189
190   if (!opt.local_user)
191     {
192       rc = gpgsm_get_default_cert (&cert);
193       if (rc)
194         {
195           if (rc != -1)
196             log_debug ("failed to find default certificate: %s\n",
197                        gpg_strerror (rc));
198           return NULL;
199         }
200       return cert;
201     }
202
203   rc = keydb_classify_name (opt.local_user, &desc);
204   if (rc)
205     {
206       log_error ("failed to find default signer: %s\n", gpg_strerror (rc));
207       return NULL;
208     }
209
210   kh = keydb_new (0);
211   if (!kh)
212     return NULL;
213
214   rc = keydb_search (kh, &desc, 1);
215   if (rc)
216     {
217       log_debug ("failed to find default certificate: rc=%d\n", rc);
218     }
219   else 
220     {
221       rc = keydb_get_cert (kh, &cert);
222       if (rc)
223         {
224           log_debug ("failed to get cert: rc=%d\n", rc);
225         }
226     }
227
228   keydb_release (kh);
229   return cert;
230 }
231
232 /* Depending on the options in CTRL add the certificate CERT as well as
233    other certificate up in the chain to the Root-CA to the CMS
234    object. */
235 static int 
236 add_certificate_list (CTRL ctrl, ksba_cms_t cms, ksba_cert_t cert)
237 {
238   gpg_error_t err;
239   int rc = 0;
240   ksba_cert_t next = NULL;
241   int n;
242   int not_root = 0;
243
244   ksba_cert_ref (cert);
245
246   n = ctrl->include_certs;
247   if (n == -2)
248     {
249       not_root = 1;
250       n = -1;
251     }
252   if (n < 0 || n > 50)
253     n = 50; /* We better apply an upper bound */
254
255   if (n)
256     {
257       if (not_root && gpgsm_is_root_cert (cert))
258         err = 0;
259       else
260         err = ksba_cms_add_cert (cms, cert);
261       if (err)
262         goto ksba_failure;
263     }
264   while ( n-- && !(rc = gpgsm_walk_cert_chain (cert, &next)) )
265     {
266       if (not_root && gpgsm_is_root_cert (next))
267         err = 0;
268       else
269         err = ksba_cms_add_cert (cms, next);
270       ksba_cert_release (cert);
271       cert = next; next = NULL;
272       if (err)
273         goto ksba_failure;
274     }
275   ksba_cert_release (cert);
276
277   return rc == -1? 0: rc;
278
279  ksba_failure:
280   ksba_cert_release (cert);
281   log_error ("ksba_cms_add_cert failed: %s\n", gpg_strerror (err));
282   return err;
283 }
284
285
286
287 \f
288 /* Perform a sign operation.  
289
290    Sign the data received on DATA-FD in embedded mode or in detached
291    mode when DETACHED is true.  Write the signature to OUT_FP.  The
292    keys used to sign are taken from SIGNERLIST or the default one will
293    be used if the value of this argument is NULL. */
294 int
295 gpgsm_sign (CTRL ctrl, CERTLIST signerlist,
296             int data_fd, int detached, FILE *out_fp)
297 {
298   int i, rc;
299   gpg_error_t err;
300   Base64Context b64writer = NULL;
301   ksba_writer_t writer;
302   ksba_cms_t cms = NULL;
303   ksba_stop_reason_t stopreason;
304   KEYDB_HANDLE kh = NULL;
305   gcry_md_hd_t data_md = NULL;
306   int signer;
307   const char *algoid;
308   int algo;
309   ksba_isotime_t signed_at;
310   CERTLIST cl;
311   int release_signerlist = 0;
312
313   kh = keydb_new (0);
314   if (!kh)
315     {
316       log_error (_("failed to allocated keyDB handle\n"));
317       rc = gpg_error (GPG_ERR_GENERAL);
318       goto leave;
319     }
320
321   ctrl->pem_name = "SIGNED MESSAGE";
322   rc = gpgsm_create_writer (&b64writer, ctrl, out_fp, &writer);
323   if (rc)
324     {
325       log_error ("can't create writer: %s\n", gpg_strerror (rc));
326       goto leave;
327     }
328
329   err = ksba_cms_new (&cms);
330   if (err)
331     {
332       rc = err;
333       goto leave;
334     }
335
336   err = ksba_cms_set_reader_writer (cms, NULL, writer);
337   if (err)
338     {
339       log_debug ("ksba_cms_set_reader_writer failed: %s\n",
340                  gpg_strerror (err));
341       rc = err;
342       goto leave;
343     }
344
345   /* We are going to create signed data with data as encap. content */
346   err = ksba_cms_set_content_type (cms, 0, KSBA_CT_SIGNED_DATA);
347   if (!err)
348     err = ksba_cms_set_content_type (cms, 1, KSBA_CT_DATA);
349   if (err)
350     {
351       log_debug ("ksba_cms_set_content_type failed: %s\n",
352                  gpg_strerror (err));
353       rc = err;
354       goto leave;
355     }
356
357   /* If no list of signers is given, use a default one. */
358   if (!signerlist)
359     {
360       ksba_cert_t cert = get_default_signer ();
361       if (!cert)
362         {
363           log_error ("no default signer found\n");
364           rc = gpg_error (GPG_ERR_GENERAL);
365           goto leave;
366         }
367
368       /* Although we don't check for ambigious specification we will
369          check that the signer's certificate is is usable and
370          valid. */
371       rc = gpgsm_cert_use_sign_p (cert);
372       if (!rc)
373         rc = gpgsm_validate_chain (ctrl, cert, NULL);
374       if (rc)
375         goto leave;
376
377       /* That one is fine - create signerlist. */
378       signerlist = xtrycalloc (1, sizeof *signerlist);
379       if (!signerlist)
380         {
381           rc = OUT_OF_CORE (errno);
382           ksba_cert_release (cert);
383           goto leave;
384         }
385       signerlist->cert = cert;
386       release_signerlist = 1;
387     }
388
389
390   /* Gather certificates of signers and store them in the CMS object. */
391   for (cl=signerlist; cl; cl = cl->next)
392     {
393       rc = gpgsm_cert_use_sign_p (cl->cert);
394       if (rc)
395         goto leave;
396       
397       err = ksba_cms_add_signer (cms, cl->cert);
398       if (err)
399         {
400           log_error ("ksba_cms_add_signer failed: %s\n", gpg_strerror (err));
401           rc = err;
402           goto leave;
403         }
404       rc = add_certificate_list (ctrl, cms, cl->cert);
405       if (rc)
406         {
407           log_error ("failed to store list of certificates: %s\n",
408                      gpg_strerror(rc));
409           goto leave;
410         }
411       /* Set the hash algorithm we are going to use */
412       err = ksba_cms_add_digest_algo (cms, "1.3.14.3.2.26" /*SHA-1*/);
413       if (err)
414         {
415           log_debug ("ksba_cms_add_digest_algo failed: %s\n",
416                      gpg_strerror (err));
417           rc = err;
418           goto leave;
419         }
420     }
421   
422   /* Prepare hashing (actually we are figuring out what we have set above)*/
423   rc = gcry_md_open (&data_md, 0, 0);
424   if (rc)
425     {
426       log_error ("md_open failed: %s\n", gpg_strerror (rc));
427       goto leave;
428     }
429   if (DBG_HASHING)
430     gcry_md_start_debug (data_md, "sign.data");
431
432   for (i=0; (algoid=ksba_cms_get_digest_algo_list (cms, i)); i++)
433     {
434       algo = gcry_md_map_name (algoid);
435       if (!algo)
436         {
437           log_error ("unknown hash algorithm `%s'\n", algoid? algoid:"?");
438           rc = gpg_error (GPG_ERR_BUG);
439           goto leave;
440         }
441       gcry_md_enable (data_md, algo);
442     }
443
444   if (detached)
445     { /* we hash the data right now so that we can store the message
446          digest.  ksba_cms_build() takes this as an flag that detached
447          data is expected. */
448       unsigned char *digest;
449       size_t digest_len;
450       /* Fixme do this for all signers and get the algo to use from
451          the signer's certificate - does not make mich sense, bu we
452          should do this consistent as we have already done it above */
453       algo = GCRY_MD_SHA1; 
454       hash_data (data_fd, data_md);
455       digest = gcry_md_read (data_md, algo);
456       digest_len = gcry_md_get_algo_dlen (algo);
457       if ( !digest || !digest_len)
458         {
459           log_error ("problem getting the hash of the data\n");
460           rc = gpg_error (GPG_ERR_BUG);
461           goto leave;
462         }
463       for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
464         {
465           err = ksba_cms_set_message_digest (cms, signer, digest, digest_len);
466           if (err)
467             {
468               log_error ("ksba_cms_set_message_digest failed: %s\n",
469                          gpg_strerror (err));
470               rc = err;
471               goto leave;
472             }
473         }
474     }
475
476   gnupg_get_isotime (signed_at);
477   for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
478     {
479       err = ksba_cms_set_signing_time (cms, signer, signed_at);
480       if (err)
481         {
482           log_error ("ksba_cms_set_signing_time failed: %s\n",
483                      gpg_strerror (err));
484           rc = err;
485           goto leave;
486         }
487     }
488
489   do 
490     {
491       err = ksba_cms_build (cms, &stopreason);
492       if (err)
493         {
494           log_debug ("ksba_cms_build failed: %s\n", gpg_strerror (err));
495           rc = err;
496           goto leave;
497         }
498
499       if (stopreason == KSBA_SR_BEGIN_DATA)
500         { /* hash the data and store the message digest */
501           unsigned char *digest;
502           size_t digest_len;
503
504           assert (!detached);
505           /* Fixme: get the algo to use from the signer's certificate
506              - does not make much sense, but we should do this
507              consistent as we have already done it above.  Code is
508              mostly duplicated above. */
509
510           algo = GCRY_MD_SHA1; 
511           rc = hash_and_copy_data (data_fd, data_md, writer);
512           if (rc)
513             goto leave;
514           digest = gcry_md_read (data_md, algo);
515           digest_len = gcry_md_get_algo_dlen (algo);
516           if ( !digest || !digest_len)
517             {
518               log_error ("problem getting the hash of the data\n");
519               rc = gpg_error (GPG_ERR_BUG);
520               goto leave;
521             }
522           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
523             {
524               err = ksba_cms_set_message_digest (cms, signer,
525                                                  digest, digest_len);
526               if (err)
527                 {
528                   log_error ("ksba_cms_set_message_digest failed: %s\n",
529                              gpg_strerror (err));
530                   rc = err;
531                   goto leave;
532                 }
533             }
534         }
535       else if (stopreason == KSBA_SR_NEED_SIG)
536         { /* calculate the signature for all signers */
537           gcry_md_hd_t md;
538
539           algo = GCRY_MD_SHA1;
540           rc = gcry_md_open (&md, algo, 0);
541           if (rc)
542             {
543               log_error ("md_open failed: %s\n", gpg_strerror (rc));
544               goto leave;
545             }
546           if (DBG_HASHING)
547             gcry_md_start_debug (md, "sign.attr");
548           ksba_cms_set_hash_function (cms, HASH_FNC, md);
549           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
550             {
551               char *sigval = NULL;
552               char *buf, *fpr;
553
554               if (signer)
555                 gcry_md_reset (md);
556               rc = ksba_cms_hash_signed_attrs (cms, signer);
557               if (rc)
558                 {
559                   log_debug ("hashing signed attrs failed: %s\n",
560                              gpg_strerror (rc));
561                   gcry_md_close (md);
562                   goto leave;
563                 }
564             
565               rc = gpgsm_create_cms_signature (cl->cert, md, algo, &sigval);
566               if (rc)
567                 {
568                   gcry_md_close (md);
569                   goto leave;
570                 }
571
572               err = ksba_cms_set_sig_val (cms, signer, sigval);
573               xfree (sigval);
574               if (err)
575                 {
576                   log_error ("failed to store the signature: %s\n",
577                              gpg_strerror (err));
578                   rc = err;
579                   gcry_md_close (md);
580                   goto leave;
581                 }
582
583               /* write a status message */
584               fpr = gpgsm_get_fingerprint_hexstring (cl->cert, GCRY_MD_SHA1);
585               if (!fpr)
586                 {
587                   rc = gpg_error (GPG_ERR_ENOMEM);
588                   gcry_md_close (md);
589                   goto leave;
590                 }
591               rc = asprintf (&buf, "%c %d %d 00 %s %s",
592                              detached? 'D':'S',
593                              GCRY_PK_RSA,  /* FIXME: get pk algo from cert */
594                              algo, 
595                              signed_at,
596                              fpr);
597               xfree (fpr);
598               if (rc < 0)
599                 {
600                   rc = gpg_error (GPG_ERR_ENOMEM);
601                   gcry_md_close (md);
602                   goto leave;
603                 }
604               rc = 0;
605               gpgsm_status (ctrl, STATUS_SIG_CREATED, buf);
606               free (buf); /* yes, we must use the regular free() here */
607             }
608           gcry_md_close (md);
609
610         }
611     }
612   while (stopreason != KSBA_SR_READY);   
613
614   rc = gpgsm_finish_writer (b64writer);
615   if (rc) 
616     {
617       log_error ("write failed: %s\n", gpg_strerror (rc));
618       goto leave;
619     }
620
621   log_info ("signature created\n");
622
623
624  leave:
625   if (rc)
626     log_error ("error creating signature: %s\n", gpg_strerror (rc));
627   if (release_signerlist)
628     gpgsm_release_certlist (signerlist);
629   ksba_cms_release (cms);
630   gpgsm_destroy_writer (b64writer);
631   keydb_release (kh); 
632   gcry_md_close (data_md);
633   return rc;
634 }