Added qualified signature features.
[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 (ctrl_t ctrl, 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 (ctrl, 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 (ctrl_t ctrl)
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 (ctrl, &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   log_debug ("adding certificates at level %d\n", n);
248   if (n == -2)
249     {
250       not_root = 1;
251       n = -1;
252     }
253   if (n < 0 || n > 50)
254     n = 50; /* We better apply an upper bound */
255
256   /* First add my own certificate unless we don't want any certificate
257      included at all. */
258   if (n)
259     {
260       if (not_root && gpgsm_is_root_cert (cert))
261         err = 0;
262       else
263         err = ksba_cms_add_cert (cms, cert);
264       if (err)
265         goto ksba_failure;
266       if (n>0)
267         n--;
268     }
269   /* Walk the chain to include all other certificates.  Note that a -1
270      used for N makes sure that there is no limit and all certs get
271      included. */
272   while ( n-- && !(rc = gpgsm_walk_cert_chain (cert, &next)) )
273     {
274       if (not_root && gpgsm_is_root_cert (next))
275         err = 0;
276       else
277         err = ksba_cms_add_cert (cms, next);
278       ksba_cert_release (cert);
279       cert = next; next = NULL;
280       if (err)
281         goto ksba_failure;
282     }
283   ksba_cert_release (cert);
284
285   return rc == -1? 0: rc;
286
287  ksba_failure:
288   ksba_cert_release (cert);
289   log_error ("ksba_cms_add_cert failed: %s\n", gpg_strerror (err));
290   return err;
291 }
292
293
294
295 \f
296 /* Perform a sign operation.  
297
298    Sign the data received on DATA-FD in embedded mode or in detached
299    mode when DETACHED is true.  Write the signature to OUT_FP.  The
300    keys used to sign are taken from SIGNERLIST or the default one will
301    be used if the value of this argument is NULL. */
302 int
303 gpgsm_sign (CTRL ctrl, CERTLIST signerlist,
304             int data_fd, int detached, FILE *out_fp)
305 {
306   int i, rc;
307   gpg_error_t err;
308   Base64Context b64writer = NULL;
309   ksba_writer_t writer;
310   ksba_cms_t cms = NULL;
311   ksba_stop_reason_t stopreason;
312   KEYDB_HANDLE kh = NULL;
313   gcry_md_hd_t data_md = NULL;
314   int signer;
315   const char *algoid;
316   int algo;
317   ksba_isotime_t signed_at;
318   CERTLIST cl;
319   int release_signerlist = 0;
320
321   kh = keydb_new (0);
322   if (!kh)
323     {
324       log_error (_("failed to allocated keyDB handle\n"));
325       rc = gpg_error (GPG_ERR_GENERAL);
326       goto leave;
327     }
328
329   ctrl->pem_name = "SIGNED MESSAGE";
330   rc = gpgsm_create_writer (&b64writer, ctrl, out_fp, &writer);
331   if (rc)
332     {
333       log_error ("can't create writer: %s\n", gpg_strerror (rc));
334       goto leave;
335     }
336
337   err = ksba_cms_new (&cms);
338   if (err)
339     {
340       rc = err;
341       goto leave;
342     }
343
344   err = ksba_cms_set_reader_writer (cms, NULL, writer);
345   if (err)
346     {
347       log_debug ("ksba_cms_set_reader_writer failed: %s\n",
348                  gpg_strerror (err));
349       rc = err;
350       goto leave;
351     }
352
353   /* We are going to create signed data with data as encap. content */
354   err = ksba_cms_set_content_type (cms, 0, KSBA_CT_SIGNED_DATA);
355   if (!err)
356     err = ksba_cms_set_content_type (cms, 1, KSBA_CT_DATA);
357   if (err)
358     {
359       log_debug ("ksba_cms_set_content_type failed: %s\n",
360                  gpg_strerror (err));
361       rc = err;
362       goto leave;
363     }
364
365   /* If no list of signers is given, use a default one. */
366   if (!signerlist)
367     {
368       ksba_cert_t cert = get_default_signer (ctrl);
369       if (!cert)
370         {
371           log_error ("no default signer found\n");
372           rc = gpg_error (GPG_ERR_GENERAL);
373           goto leave;
374         }
375
376       /* Although we don't check for ambigious specification we will
377          check that the signer's certificate is is usable and
378          valid. */
379       rc = gpgsm_cert_use_sign_p (cert);
380       if (!rc)
381         rc = gpgsm_validate_chain (ctrl, cert, NULL, 0, NULL, 0);
382       if (rc)
383         goto leave;
384
385       /* That one is fine - create signerlist. */
386       signerlist = xtrycalloc (1, sizeof *signerlist);
387       if (!signerlist)
388         {
389           rc = OUT_OF_CORE (errno);
390           ksba_cert_release (cert);
391           goto leave;
392         }
393       signerlist->cert = cert;
394       release_signerlist = 1;
395     }
396
397
398   /* Gather certificates of signers and store them in the CMS object. */
399   for (cl=signerlist; cl; cl = cl->next)
400     {
401       rc = gpgsm_cert_use_sign_p (cl->cert);
402       if (rc)
403         goto leave;
404       
405       err = ksba_cms_add_signer (cms, cl->cert);
406       if (err)
407         {
408           log_error ("ksba_cms_add_signer failed: %s\n", gpg_strerror (err));
409           rc = err;
410           goto leave;
411         }
412       rc = add_certificate_list (ctrl, cms, cl->cert);
413       if (rc)
414         {
415           log_error ("failed to store list of certificates: %s\n",
416                      gpg_strerror(rc));
417           goto leave;
418         }
419       /* Set the hash algorithm we are going to use */
420       err = ksba_cms_add_digest_algo (cms, "1.3.14.3.2.26" /*SHA-1*/);
421       if (err)
422         {
423           log_debug ("ksba_cms_add_digest_algo failed: %s\n",
424                      gpg_strerror (err));
425           rc = err;
426           goto leave;
427         }
428     }
429
430
431   /* Check whether one of the certificates is qualified.  Note that we
432      already validated the certificate and thus the user data stored
433      flag must be available. */
434   for (cl=signerlist; cl; cl = cl->next)
435     {
436       size_t buflen;
437       char buffer[1];
438       
439       err = ksba_cert_get_user_data (cl->cert, "is_qualified", 
440                                      &buffer, sizeof (buffer), &buflen);
441       if (err || !buflen)
442         {
443           log_error (_("checking for qualified certificate failed: %s\n"),
444                      gpg_strerror (err)); 
445           rc = err;
446           goto leave;
447         }
448       if (*buffer)
449         {
450           err = gpgsm_qualified_consent (ctrl, cl->cert);
451           if (err)
452             {
453               rc = err;
454               goto leave;
455             }
456         }
457     }
458   
459   /* Prepare hashing (actually we are figuring out what we have set above)*/
460   rc = gcry_md_open (&data_md, 0, 0);
461   if (rc)
462     {
463       log_error ("md_open failed: %s\n", gpg_strerror (rc));
464       goto leave;
465     }
466   if (DBG_HASHING)
467     gcry_md_start_debug (data_md, "sign.data");
468
469   for (i=0; (algoid=ksba_cms_get_digest_algo_list (cms, i)); i++)
470     {
471       algo = gcry_md_map_name (algoid);
472       if (!algo)
473         {
474           log_error ("unknown hash algorithm `%s'\n", algoid? algoid:"?");
475           if (algoid
476               && (  !strcmp (algoid, "1.2.840.113549.1.1.2")
477                     ||!strcmp (algoid, "1.2.840.113549.2.2")))
478             log_info (_("(this is the MD2 algorithm)\n"));
479           rc = gpg_error (GPG_ERR_BUG);
480           goto leave;
481         }
482       gcry_md_enable (data_md, algo);
483     }
484
485   if (detached)
486     { /* we hash the data right now so that we can store the message
487          digest.  ksba_cms_build() takes this as an flag that detached
488          data is expected. */
489       unsigned char *digest;
490       size_t digest_len;
491       /* Fixme do this for all signers and get the algo to use from
492          the signer's certificate - does not make mich sense, but we
493          should do this consistent as we have already done it above. */
494       algo = GCRY_MD_SHA1; 
495       hash_data (data_fd, data_md);
496       digest = gcry_md_read (data_md, algo);
497       digest_len = gcry_md_get_algo_dlen (algo);
498       if ( !digest || !digest_len)
499         {
500           log_error ("problem getting the hash of the data\n");
501           rc = gpg_error (GPG_ERR_BUG);
502           goto leave;
503         }
504       for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
505         {
506           err = ksba_cms_set_message_digest (cms, signer, digest, digest_len);
507           if (err)
508             {
509               log_error ("ksba_cms_set_message_digest failed: %s\n",
510                          gpg_strerror (err));
511               rc = err;
512               goto leave;
513             }
514         }
515     }
516
517   gnupg_get_isotime (signed_at);
518   for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
519     {
520       err = ksba_cms_set_signing_time (cms, signer, signed_at);
521       if (err)
522         {
523           log_error ("ksba_cms_set_signing_time failed: %s\n",
524                      gpg_strerror (err));
525           rc = err;
526           goto leave;
527         }
528     }
529
530   /* We need to write at least a minimal list of our capabilities to
531      try to convince some MUAs to use 3DEs and not the crippled
532      RC2. Our list is:
533
534         aes128-CBC
535         des-EDE3-CBC
536   */
537   err = ksba_cms_add_smime_capability (cms, "2.16.840.1.101.3.4.1.2", NULL, 0);
538   if (!err)
539     err = ksba_cms_add_smime_capability (cms, "1.2.840.113549.3.7", NULL, 0);
540   if (err)
541     {
542       log_error ("ksba_cms_add_smime_capability failed: %s\n",
543                  gpg_strerror (err));
544       goto leave;
545     }
546
547
548   /* Main building loop. */
549   do 
550     {
551       err = ksba_cms_build (cms, &stopreason);
552       if (err)
553         {
554           log_debug ("ksba_cms_build failed: %s\n", gpg_strerror (err));
555           rc = err;
556           goto leave;
557         }
558
559       if (stopreason == KSBA_SR_BEGIN_DATA)
560         { /* hash the data and store the message digest */
561           unsigned char *digest;
562           size_t digest_len;
563
564           assert (!detached);
565           /* Fixme: get the algo to use from the signer's certificate
566              - does not make much sense, but we should do this
567              consistent as we have already done it above.  Code is
568              mostly duplicated above. */
569
570           algo = GCRY_MD_SHA1; 
571           rc = hash_and_copy_data (data_fd, data_md, writer);
572           if (rc)
573             goto leave;
574           digest = gcry_md_read (data_md, algo);
575           digest_len = gcry_md_get_algo_dlen (algo);
576           if ( !digest || !digest_len)
577             {
578               log_error ("problem getting the hash of the data\n");
579               rc = gpg_error (GPG_ERR_BUG);
580               goto leave;
581             }
582           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
583             {
584               err = ksba_cms_set_message_digest (cms, signer,
585                                                  digest, digest_len);
586               if (err)
587                 {
588                   log_error ("ksba_cms_set_message_digest failed: %s\n",
589                              gpg_strerror (err));
590                   rc = err;
591                   goto leave;
592                 }
593             }
594         }
595       else if (stopreason == KSBA_SR_NEED_SIG)
596         { /* calculate the signature for all signers */
597           gcry_md_hd_t md;
598
599           algo = GCRY_MD_SHA1;
600           rc = gcry_md_open (&md, algo, 0);
601           if (rc)
602             {
603               log_error ("md_open failed: %s\n", gpg_strerror (rc));
604               goto leave;
605             }
606           if (DBG_HASHING)
607             gcry_md_start_debug (md, "sign.attr");
608           ksba_cms_set_hash_function (cms, HASH_FNC, md);
609           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
610             {
611               unsigned char *sigval = NULL;
612               char *buf, *fpr;
613
614               if (signer)
615                 gcry_md_reset (md);
616               rc = ksba_cms_hash_signed_attrs (cms, signer);
617               if (rc)
618                 {
619                   log_debug ("hashing signed attrs failed: %s\n",
620                              gpg_strerror (rc));
621                   gcry_md_close (md);
622                   goto leave;
623                 }
624             
625               rc = gpgsm_create_cms_signature (ctrl, cl->cert,
626                                                md, algo, &sigval);
627               if (rc)
628                 {
629                   gcry_md_close (md);
630                   goto leave;
631                 }
632
633               err = ksba_cms_set_sig_val (cms, signer, sigval);
634               xfree (sigval);
635               if (err)
636                 {
637                   log_error ("failed to store the signature: %s\n",
638                              gpg_strerror (err));
639                   rc = err;
640                   gcry_md_close (md);
641                   goto leave;
642                 }
643
644               /* write a status message */
645               fpr = gpgsm_get_fingerprint_hexstring (cl->cert, GCRY_MD_SHA1);
646               if (!fpr)
647                 {
648                   rc = gpg_error (GPG_ERR_ENOMEM);
649                   gcry_md_close (md);
650                   goto leave;
651                 }
652               {
653                 int pkalgo = gpgsm_get_key_algo_info (cl->cert, NULL);
654                 rc = asprintf (&buf, "%c %d %d 00 %s %s",
655                                detached? 'D':'S',
656                                pkalgo, 
657                                algo, 
658                                signed_at,
659                                fpr);
660               }
661               xfree (fpr);
662               if (rc < 0)
663                 {
664                   rc = gpg_error (GPG_ERR_ENOMEM);
665                   gcry_md_close (md);
666                   goto leave;
667                 }
668               rc = 0;
669               gpgsm_status (ctrl, STATUS_SIG_CREATED, buf);
670               free (buf); /* yes, we must use the regular free() here */
671             }
672           gcry_md_close (md);
673
674         }
675     }
676   while (stopreason != KSBA_SR_READY);   
677
678   rc = gpgsm_finish_writer (b64writer);
679   if (rc) 
680     {
681       log_error ("write failed: %s\n", gpg_strerror (rc));
682       goto leave;
683     }
684
685   log_info ("signature created\n");
686
687
688  leave:
689   if (rc)
690     log_error ("error creating signature: %s <%s>\n",
691                gpg_strerror (rc), gpg_strsource (rc) );
692   if (release_signerlist)
693     gpgsm_release_certlist (signerlist);
694   ksba_cms_release (cms);
695   gpgsm_destroy_writer (b64writer);
696   keydb_release (kh); 
697   gcry_md_close (data_md);
698   return rc;
699 }