A small step for GnuPG but a huge leap for error codes.
[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 <gcrypt.h>
31 #include <ksba.h>
32
33 #include "gpgsm.h"
34 #include "keydb.h"
35 #include "i18n.h"
36
37
38 static void
39 hash_data (int fd, GCRY_MD_HD 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 md, KsbaWriter writer)
65 {
66   KsbaError 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", ksba_strerror (err));
92               rc = map_ksba_err (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", ksba_strerror (err));
118           rc = map_ksba_err (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 retruns and has a secret key available */
128 int
129 gpgsm_get_default_cert (KsbaCert *r_cert)
130 {
131   KEYDB_HANDLE hd;
132   KsbaCert 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 KsbaCert
183 get_default_signer (void)
184 {
185   KEYDB_SEARCH_DESC desc;
186   KsbaCert 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", gnupg_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, KsbaCMS cms, KsbaCert cert)
237 {
238   KsbaError err;
239   int rc = 0;
240   KsbaCert 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", ksba_strerror (err));
282   return map_ksba_err (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   KsbaError err;
300   Base64Context b64writer = NULL;
301   KsbaWriter writer;
302   KsbaCMS cms = NULL;
303   KsbaStopReason stopreason;
304   KEYDB_HANDLE kh = NULL;
305   GCRY_MD_HD data_md = NULL;
306   int signer;
307   const char *algoid;
308   int algo;
309   time_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", gnupg_strerror (rc));
326       goto leave;
327     }
328
329   cms = ksba_cms_new ();
330   if (!cms)
331     {
332       rc = gpg_error (GPG_ERR_ENOMEM);
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                  ksba_strerror (err));
341       rc = map_ksba_err (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                  ksba_strerror (err));
353       rc = map_ksba_err (err);
354       goto leave;
355     }
356
357   /* If no list of signers is given, use a default one. */
358   if (!signerlist)
359     {
360       KsbaCert 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       signerlist = xtrycalloc (1, sizeof *signerlist);
368       if (!signerlist)
369         {
370           rc = OUT_OF_CORE (errno);
371           ksba_cert_release (cert);
372           goto leave;
373         }
374       signerlist->cert = cert;
375       release_signerlist = 1;
376     }
377
378
379   /* Gather certificates of signers and store them in the CMS object. */
380   for (cl=signerlist; cl; cl = cl->next)
381     {
382       rc = gpgsm_cert_use_sign_p (cl->cert);
383       if (rc)
384         goto leave;
385       
386       err = ksba_cms_add_signer (cms, cl->cert);
387       if (err)
388         {
389           log_error ("ksba_cms_add_signer failed: %s\n",  ksba_strerror (err));
390           rc = map_ksba_err (err);
391           goto leave;
392         }
393       rc = add_certificate_list (ctrl, cms, cl->cert);
394       if (rc)
395         {
396           log_error ("failed to store list of certificates: %s\n",
397                      gnupg_strerror(rc));
398           goto leave;
399         }
400       /* Set the hash algorithm we are going to use */
401       err = ksba_cms_add_digest_algo (cms, "1.3.14.3.2.26" /*SHA-1*/);
402       if (err)
403         {
404           log_debug ("ksba_cms_add_digest_algo failed: %s\n",
405                      ksba_strerror (err));
406           rc = map_ksba_err (err);
407           goto leave;
408         }
409     }
410   
411   /* Prepare hashing (actually we are figuring out what we have set above)*/
412   data_md = gcry_md_open (0, 0);
413   if (!data_md)
414     {
415       rc = map_gcry_err (gcry_errno());
416       log_error ("md_open failed: %s\n", gcry_strerror (-1));
417       goto leave;
418     }
419   if (DBG_HASHING)
420     gcry_md_start_debug (data_md, "sign.data");
421
422   for (i=0; (algoid=ksba_cms_get_digest_algo_list (cms, i)); i++)
423     {
424       algo = gcry_md_map_name (algoid);
425       if (!algo)
426         {
427           log_error ("unknown hash algorithm `%s'\n", algoid? algoid:"?");
428           rc = gpg_error (GPG_ERR_BUG);
429           goto leave;
430         }
431       gcry_md_enable (data_md, algo);
432     }
433
434   if (detached)
435     { /* we hash the data right now so that we can store the message
436          digest.  ksba_cms_build() takes this as an flag that detached
437          data is expected. */
438       unsigned char *digest;
439       size_t digest_len;
440       /* Fixme do this for all signers and get the algo to use from
441          the signer's certificate - does not make mich sense, bu we
442          should do this consistent as we have already done it above */
443       algo = GCRY_MD_SHA1; 
444       hash_data (data_fd, data_md);
445       digest = gcry_md_read (data_md, algo);
446       digest_len = gcry_md_get_algo_dlen (algo);
447       if ( !digest || !digest_len)
448         {
449           log_error ("problem getting the hash of the data\n");
450           rc = gpg_error (GPG_ERR_BUG);
451           goto leave;
452         }
453       for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
454         {
455           err = ksba_cms_set_message_digest (cms, signer, digest, digest_len);
456           if (err)
457             {
458               log_error ("ksba_cms_set_message_digest failed: %s\n",
459                          ksba_strerror (err));
460               rc = map_ksba_err (err);
461               goto leave;
462             }
463         }
464     }
465
466   signed_at = gnupg_get_time ();
467   for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
468     {
469       err = ksba_cms_set_signing_time (cms, signer, signed_at);
470       if (err)
471         {
472           log_error ("ksba_cms_set_signing_time failed: %s\n",
473                      ksba_strerror (err));
474           rc = map_ksba_err (err);
475           goto leave;
476         }
477     }
478
479   do 
480     {
481       err = ksba_cms_build (cms, &stopreason);
482       if (err)
483         {
484           log_debug ("ksba_cms_build failed: %s\n", ksba_strerror (err));
485           rc = map_ksba_err (err);
486           goto leave;
487         }
488
489       if (stopreason == KSBA_SR_BEGIN_DATA)
490         { /* hash the data and store the message digest */
491           unsigned char *digest;
492           size_t digest_len;
493
494           assert (!detached);
495           /* Fixme: get the algo to use from the signer's certificate
496              - does not make much sense, but we should do this
497              consistent as we have already done it above.  Code is
498              mostly duplicated above. */
499
500           algo = GCRY_MD_SHA1; 
501           rc = hash_and_copy_data (data_fd, data_md, writer);
502           if (rc)
503             goto leave;
504           digest = gcry_md_read (data_md, algo);
505           digest_len = gcry_md_get_algo_dlen (algo);
506           if ( !digest || !digest_len)
507             {
508               log_error ("problem getting the hash of the data\n");
509               rc = gpg_error (GPG_ERR_BUG);
510               goto leave;
511             }
512           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
513             {
514               err = ksba_cms_set_message_digest (cms, signer,
515                                                  digest, digest_len);
516               if (err)
517                 {
518                   log_error ("ksba_cms_set_message_digest failed: %s\n",
519                              ksba_strerror (err));
520                   rc = map_ksba_err (err);
521                   goto leave;
522                 }
523             }
524         }
525       else if (stopreason == KSBA_SR_NEED_SIG)
526         { /* calculate the signature for all signers */
527           GCRY_MD_HD md;
528
529           algo = GCRY_MD_SHA1;
530           md = gcry_md_open (algo, 0);
531           if (DBG_HASHING)
532             gcry_md_start_debug (md, "sign.attr");
533
534           if (!md)
535             {
536               log_error ("md_open failed: %s\n", gcry_strerror (-1));
537               goto leave;
538             }
539           ksba_cms_set_hash_function (cms, HASH_FNC, md);
540           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
541             {
542               char *sigval = NULL;
543               char *buf, *fpr;
544
545               if (signer)
546                 gcry_md_reset (md);
547               rc = ksba_cms_hash_signed_attrs (cms, signer);
548               if (rc)
549                 {
550                   log_debug ("hashing signed attrs failed: %s\n",
551                              ksba_strerror (rc));
552                   gcry_md_close (md);
553                   goto leave;
554                 }
555             
556               rc = gpgsm_create_cms_signature (cl->cert, md, algo, &sigval);
557               if (rc)
558                 {
559                   gcry_md_close (md);
560                   goto leave;
561                 }
562
563               err = ksba_cms_set_sig_val (cms, signer, sigval);
564               xfree (sigval);
565               if (err)
566                 {
567                   log_error ("failed to store the signature: %s\n",
568                              ksba_strerror (err));
569                   rc = map_ksba_err (err);
570                   gcry_md_close (md);
571                   goto leave;
572                 }
573
574               /* write a status message */
575               fpr = gpgsm_get_fingerprint_hexstring (cl->cert, GCRY_MD_SHA1);
576               if (!fpr)
577                 {
578                   rc = gpg_error (GPG_ERR_ENOMEM);
579                   gcry_md_close (md);
580                   goto leave;
581                 }
582               rc = asprintf (&buf, "%c %d %d 00 %lu %s",
583                              detached? 'D':'S',
584                              GCRY_PK_RSA,  /* FIXME: get pk algo from cert */
585                              algo, 
586                              (ulong)signed_at,
587                              fpr);
588               xfree (fpr);
589               if (rc < 0)
590                 {
591                   rc = gpg_error (GPG_ERR_ENOMEM);
592                   gcry_md_close (md);
593                   goto leave;
594                 }
595               rc = 0;
596               gpgsm_status (ctrl, STATUS_SIG_CREATED, buf);
597               free (buf); /* yes, we must use the regular free() here */
598             }
599           gcry_md_close (md);
600
601         }
602     }
603   while (stopreason != KSBA_SR_READY);   
604
605   rc = gpgsm_finish_writer (b64writer);
606   if (rc) 
607     {
608       log_error ("write failed: %s\n", gnupg_strerror (rc));
609       goto leave;
610     }
611
612   log_info ("signature created\n");
613
614
615  leave:
616   if (release_signerlist)
617     gpgsm_release_certlist (signerlist);
618   ksba_cms_release (cms);
619   gpgsm_destroy_writer (b64writer);
620   keydb_release (kh); 
621   gcry_md_close (data_md);
622   return rc;
623 }