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