Forgot to commit this:
[gnupg.git] / sm / sign.c
1 /* sign.c - Sign a message
2  *      Copyright (C) 2001 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       log_error ("fdopen(%d) failed: %s\n", fd, strerror (errno));
77       return GNUPG_File_Open_Error;
78     }
79
80   do 
81     {
82       nread = fread (buffer, 1, DIM(buffer), fp);
83       if (nread)
84         {
85           any = 1;
86           gcry_md_write (md, buffer, nread);
87           err = ksba_writer_write_octet_string (writer, buffer, nread, 0);
88           if (err)
89             {
90               log_error ("write failed: %s\n", ksba_strerror (err));
91               rc = map_ksba_err (err);
92             }
93         }
94     }
95   while (nread && !rc);
96   if (ferror (fp))
97     {
98       log_error ("read error on fd %d: %s\n", fd, strerror (errno));
99       rc = GNUPG_Read_Error;
100     }
101   fclose (fp);
102   if (!any)
103     {
104       /* We can't allow to sign an empty message becuase it does not
105          make mnuch sense and more seriously, ksba-cms_build has
106          already written the tag for data and now expects an octet
107          string but an octet string of zeize 0 is illegal. */
108       log_error ("cannot sign an empty message\n");
109       rc = GNUPG_No_Data;
110     }
111   if (!rc)
112     {
113       err = ksba_writer_write_octet_string (writer, NULL, 0, 1);
114       if (err)
115         {
116           log_error ("write failed: %s\n", ksba_strerror (err));
117           rc = map_ksba_err (err);
118         }
119     }
120
121   return rc;
122 }
123
124
125 /* Get the default certificate which is defined as the first one our
126    keyDB retruns and has a secret key available */
127 int
128 gpgsm_get_default_cert (KsbaCert *r_cert)
129 {
130   KEYDB_HANDLE hd;
131   KsbaCert cert = NULL;
132   int rc;
133   char *p;
134
135   hd = keydb_new (0);
136   if (!hd)
137     return GNUPG_General_Error;
138   rc = keydb_search_first (hd);
139   if (rc)
140     {
141       keydb_release (hd);
142       return rc;
143     }
144
145   do
146     {
147       rc = keydb_get_cert (hd, &cert);
148       if (rc) 
149         {
150           log_error ("keydb_get_cert failed: %s\n", gnupg_strerror (rc));
151           keydb_release (hd);
152           return rc;
153         }
154       
155       p = gpgsm_get_keygrip_hexstring (cert);
156       if (p)
157         {
158           if (!gpgsm_agent_havekey (p))
159             {
160               xfree (p);
161               keydb_release (hd);
162               *r_cert = cert;
163               return 0; /* got it */
164             }
165           xfree (p);
166         }
167     
168       ksba_cert_release (cert); 
169       cert = NULL;
170     }
171   while (!(rc = keydb_search_next (hd)));
172   if (rc && rc != -1)
173     log_error ("keydb_search_next failed: %s\n", gnupg_strerror (rc));
174   
175   ksba_cert_release (cert);
176   keydb_release (hd);
177   return rc;
178 }
179
180
181 static KsbaCert
182 get_default_signer (void)
183 {
184   KEYDB_SEARCH_DESC desc;
185   KsbaCert cert = NULL;
186   KEYDB_HANDLE kh = NULL;
187   int rc;
188
189   if (!opt.local_user)
190     {
191       rc = gpgsm_get_default_cert (&cert);
192       if (rc)
193         {
194           if (rc != -1)
195             log_debug ("failed to find default certificate: %s\n",
196                        gnupg_strerror (rc));
197           return NULL;
198         }
199       return cert;
200     }
201
202   rc = keydb_classify_name (opt.local_user, &desc);
203   if (rc)
204     {
205       log_error ("failed to find default signer: %s\n", gnupg_strerror (rc));
206       return NULL;
207     }
208
209   kh = keydb_new (0);
210   if (!kh)
211     return NULL;
212
213   rc = keydb_search (kh, &desc, 1);
214   if (rc)
215     {
216       log_debug ("failed to find default certificate: rc=%d\n", rc);
217     }
218   else 
219     {
220       rc = keydb_get_cert (kh, &cert);
221       if (rc)
222         {
223           log_debug ("failed to get cert: rc=%d\n", rc);
224         }
225     }
226
227   keydb_release (kh);
228   return cert;
229 }
230
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 ctrl, KsbaCMS cms, KsbaCert cert)
238 {
239   KsbaError err;
240   int rc = 0;
241   KsbaCert next = NULL;
242   int n;
243   int not_root = 0;
244
245   ksba_cert_ref (cert);
246
247   n = ctrl->include_certs;
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   if (n)
257     {
258       if (not_root && gpgsm_is_root_cert (cert))
259         err = 0;
260       else
261         err = ksba_cms_add_cert (cms, cert);
262       if (err)
263         goto ksba_failure;
264     }
265   while ( n-- && !(rc = gpgsm_walk_cert_chain (cert, &next)) )
266     {
267       if (not_root && gpgsm_is_root_cert (next))
268         err = 0;
269       else
270         err = ksba_cms_add_cert (cms, next);
271       ksba_cert_release (cert);
272       cert = next; next = NULL;
273       if (err)
274         goto ksba_failure;
275     }
276   ksba_cert_release (cert);
277
278   return rc == -1? 0: rc;
279
280  ksba_failure:
281   ksba_cert_release (cert);
282   log_error ("ksba_cms_add_cert failed: %s\n", ksba_strerror (err));
283   return map_ksba_err (err);
284 }
285
286
287
288 \f
289 /* Perform a sign operation.  
290
291    Sign the data received on DATA-FD in embedded mode or in detached
292    mode when DETACHED is true.  Write the signature to OUT_FP.  The
293    key used to sign is the default one - we will extend the function
294    to take a list of fingerprints in the future. */
295 int
296 gpgsm_sign (CTRL ctrl, 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   KsbaCert cert = NULL;
305   KEYDB_HANDLE kh = NULL;
306   GCRY_MD_HD data_md = NULL;
307   int signer;
308   const char *algoid;
309   int algo;
310   time_t signed_at;
311
312   kh = keydb_new (0);
313   if (!kh)
314     {
315       log_error (_("failed to allocated keyDB handle\n"));
316       rc = GNUPG_General_Error;
317       goto leave;
318     }
319
320   ctrl->pem_name = "SIGNED MESSAGE";
321   rc = gpgsm_create_writer (&b64writer, ctrl, out_fp, &writer);
322   if (rc)
323     {
324       log_error ("can't create writer: %s\n", gnupg_strerror (rc));
325       goto leave;
326     }
327
328   cms = ksba_cms_new ();
329   if (!cms)
330     {
331       rc = seterr (Out_Of_Core);
332       goto leave;
333     }
334
335   err = ksba_cms_set_reader_writer (cms, NULL, writer);
336   if (err)
337     {
338       log_debug ("ksba_cms_set_reader_writer failed: %s\n",
339                  ksba_strerror (err));
340       rc = map_ksba_err (err);
341       goto leave;
342     }
343
344   /* We are going to create signed data with data as encap. content */
345   err = ksba_cms_set_content_type (cms, 0, KSBA_CT_SIGNED_DATA);
346   if (!err)
347     err = ksba_cms_set_content_type (cms, 1, KSBA_CT_DATA);
348   if (err)
349     {
350       log_debug ("ksba_cms_set_content_type failed: %s\n",
351                  ksba_strerror (err));
352       rc = map_ksba_err (err);
353       goto leave;
354     }
355
356
357   /* gather certificates of signers  and store in theCMS object */
358   /* fixme: process a list of fingerprints and store the certificate of
359      each given fingerprint */
360   cert = get_default_signer ();
361   if (!cert)
362     {
363       log_error ("no default signer found\n");
364       rc = seterr (General_Error);
365       goto leave;
366     }
367   rc = gpgsm_cert_use_sign_p (cert);
368   if (rc)
369     goto leave;
370
371   err = ksba_cms_add_signer (cms, cert);
372   if (err)
373     {
374       log_error ("ksba_cms_add_signer failed: %s\n",  ksba_strerror (err));
375       rc = map_ksba_err (err);
376       goto leave;
377     }
378   rc = add_certificate_list (ctrl, cms, cert);
379   if (rc)
380     {
381       log_error ("failed to store list of certificates: %s\n",
382                  gnupg_strerror(rc));
383       goto leave;
384     }
385   ksba_cert_release (cert); cert = NULL;
386
387   
388   /* Set the hash algorithm we are going to use */
389   err = ksba_cms_add_digest_algo (cms, "1.3.14.3.2.26" /*SHA-1*/);
390   if (err)
391     {
392       log_debug ("ksba_cms_add_digest_algo failed: %s\n", ksba_strerror (err));
393       rc = map_ksba_err (err);
394       goto leave;
395     }
396
397   /* Prepare hashing (actually we are figuring out what we have set above)*/
398   data_md = gcry_md_open (0, 0);
399   if (!data_md)
400     {
401       rc = map_gcry_err (gcry_errno());
402       log_error ("md_open failed: %s\n", gcry_strerror (-1));
403       goto leave;
404     }
405   if (DBG_HASHING)
406     gcry_md_start_debug (data_md, "sign.data");
407
408   for (i=0; (algoid=ksba_cms_get_digest_algo_list (cms, i)); i++)
409     {
410       algo = gcry_md_map_name (algoid);
411       if (!algo)
412         {
413           log_error ("unknown hash algorithm `%s'\n", algoid? algoid:"?");
414           rc = GNUPG_Bug;
415           goto leave;
416         }
417       gcry_md_enable (data_md, algo);
418     }
419
420   signer = 0;
421   if (detached)
422     { /* we hash the data right now so that we can store the message
423          digest.  ksba_cms_build() takes this as an flag that detached
424          data is expected. */
425       unsigned char *digest;
426       size_t digest_len;
427       /* Fixme do this for all signers and get the algo to use from
428          the signer's certificate - does not make mich sense, bu we
429          should do this consistent as we have already done it above */
430       algo = GCRY_MD_SHA1; 
431       hash_data (data_fd, data_md);
432       digest = gcry_md_read (data_md, algo);
433       digest_len = gcry_md_get_algo_dlen (algo);
434       if ( !digest || !digest_len)
435         {
436           log_error ("problem getting the hash of the data\n");
437           rc = GNUPG_Bug;
438           goto leave;
439         }
440       err = ksba_cms_set_message_digest (cms, signer, digest, digest_len);
441       if (err)
442         {
443           log_error ("ksba_cms_set_message_digest failed: %s\n",
444                      ksba_strerror (err));
445           rc = map_ksba_err (err);
446           goto leave;
447         }
448     }
449
450   signed_at = gnupg_get_time ();
451   err = ksba_cms_set_signing_time (cms, signer, signed_at);
452   if (err)
453     {
454       log_error ("ksba_cms_set_signing_time failed: %s\n",
455                  ksba_strerror (err));
456       rc = map_ksba_err (err);
457       goto leave;
458     }
459
460   do 
461     {
462       err = ksba_cms_build (cms, &stopreason);
463       if (err)
464         {
465           log_debug ("ksba_cms_build failed: %s\n", ksba_strerror (err));
466           rc = map_ksba_err (err);
467           goto leave;
468         }
469
470       if (stopreason == KSBA_SR_BEGIN_DATA)
471         { /* hash the data and store the message digest */
472           unsigned char *digest;
473           size_t digest_len;
474
475           assert (!detached);
476           /* Fixme do this for all signers and get the algo to use from
477              the signer's certificate - does not make mich sense, bu we
478              should do this consistent as we have already done it above.
479              Code is mostly duplicated above. */
480
481           algo = GCRY_MD_SHA1; 
482           rc = hash_and_copy_data (data_fd, data_md, writer);
483           if (rc)
484             goto leave;
485           digest = gcry_md_read (data_md, algo);
486           digest_len = gcry_md_get_algo_dlen (algo);
487           if ( !digest || !digest_len)
488             {
489               log_error ("problem getting the hash of the data\n");
490               rc = GNUPG_Bug;
491               goto leave;
492             }
493           err = ksba_cms_set_message_digest (cms, signer, digest, digest_len);
494           if (err)
495             {
496               log_error ("ksba_cms_set_message_digest failed: %s\n",
497                          ksba_strerror (err));
498               rc = map_ksba_err (err);
499               goto leave;
500             }
501         }
502       else if (stopreason == KSBA_SR_NEED_SIG)
503         { /* calculate the signature for all signers */
504           GCRY_MD_HD md;
505
506           algo = GCRY_MD_SHA1;
507           signer = 0;
508           md = gcry_md_open (algo, 0);
509           if (DBG_HASHING)
510             gcry_md_start_debug (md, "sign.attr");
511
512           if (!md)
513             {
514               log_error ("md_open failed: %s\n", gcry_strerror (-1));
515               goto leave;
516             }
517           ksba_cms_set_hash_function (cms, HASH_FNC, md);
518           rc = ksba_cms_hash_signed_attrs (cms, signer);
519           if (rc)
520             {
521               log_debug ("hashing signed attrs failed: %s\n",
522                          ksba_strerror (rc));
523               gcry_md_close (md);
524               goto leave;
525             }
526           
527           { /* This is all an temporary hack */
528             char *sigval;
529             
530             ksba_cert_release (cert); 
531             cert = get_default_signer ();
532             if (!cert)
533               {
534                 log_error ("oops - failed to get cert again\n");
535                 rc = seterr (General_Error);
536                 goto leave;
537               }
538
539             sigval = NULL;
540             rc = gpgsm_create_cms_signature (cert, md, algo, &sigval);
541             if (rc)
542               goto leave;
543
544             err = ksba_cms_set_sig_val (cms, signer, sigval);
545             xfree (sigval);
546             if (err)
547               {
548                 log_error ("failed to store the signature: %s\n",
549                            ksba_strerror (err));
550                 rc = map_ksba_err (err);
551                 goto leave;
552               }
553
554             /* And write a status message */
555             {
556               char *buf, *fpr;
557               
558               fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
559               if (!fpr)
560                 {
561                   rc = seterr (Out_Of_Core);
562                   goto leave;
563                 }
564               rc = asprintf (&buf, "%c %d %d 00 %lu %s",
565                         detached? 'D':'S',
566                         GCRY_PK_RSA,  /* FIXME: get pk algo from cert */
567                         algo, 
568                         (ulong)signed_at,
569                         fpr);
570               xfree (fpr);
571               if (rc < 0)
572                 {
573                   rc = seterr (Out_Of_Core);
574                   goto leave;
575                 }
576               rc = 0;
577               gpgsm_status (ctrl, STATUS_SIG_CREATED, buf );
578               free (buf); /* yes, we must use the regular free() here */
579             }
580
581           }
582         }
583     }
584   while (stopreason != KSBA_SR_READY);   
585
586   rc = gpgsm_finish_writer (b64writer);
587   if (rc) 
588     {
589       log_error ("write failed: %s\n", gnupg_strerror (rc));
590       goto leave;
591     }
592
593   log_info ("signature created\n");
594
595
596  leave:
597   ksba_cert_release (cert); 
598   ksba_cms_release (cms);
599   gpgsm_destroy_writer (b64writer);
600   keydb_release (kh); 
601   gcry_md_close (data_md);
602   return rc;
603 }