Made it compile.
[gnupg.git] / sm / sign.c
1 /* sign.c - Sign a message
2  *      Copyright (C) 2001, 2002 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 /* Depending on the options in CTRL add the certificate CERT as well as
232    other certificate up in the chain to the Root-CA to the CMS
233    object. */
234 static int 
235 add_certificate_list (CTRL ctrl, KsbaCMS cms, KsbaCert cert)
236 {
237   KsbaError err;
238   int rc = 0;
239   KsbaCert next = NULL;
240   int n;
241   int not_root = 0;
242
243   ksba_cert_ref (cert);
244
245   n = ctrl->include_certs;
246   if (n == -2)
247     {
248       not_root = 1;
249       n = -1;
250     }
251   if (n < 0 || n > 50)
252     n = 50; /* We better apply an upper bound */
253
254   if (n)
255     {
256       if (not_root && gpgsm_is_root_cert (cert))
257         err = 0;
258       else
259         err = ksba_cms_add_cert (cms, cert);
260       if (err)
261         goto ksba_failure;
262     }
263   while ( n-- && !(rc = gpgsm_walk_cert_chain (cert, &next)) )
264     {
265       if (not_root && gpgsm_is_root_cert (next))
266         err = 0;
267       else
268         err = ksba_cms_add_cert (cms, next);
269       ksba_cert_release (cert);
270       cert = next; next = NULL;
271       if (err)
272         goto ksba_failure;
273     }
274   ksba_cert_release (cert);
275
276   return rc == -1? 0: rc;
277
278  ksba_failure:
279   ksba_cert_release (cert);
280   log_error ("ksba_cms_add_cert failed: %s\n", ksba_strerror (err));
281   return map_ksba_err (err);
282 }
283
284
285
286 \f
287 /* Perform a sign operation.  
288
289    Sign the data received on DATA-FD in embedded mode or in detached
290    mode when DETACHED is true.  Write the signature to OUT_FP.  The
291    keys used to sign are taken from SIGNERLIST or the default one will
292    be used if the value of this argument is NULL. */
293 int
294 gpgsm_sign (CTRL ctrl, CERTLIST signerlist,
295             int data_fd, int detached, FILE *out_fp)
296 {
297   int i, rc;
298   KsbaError err;
299   Base64Context b64writer = NULL;
300   KsbaWriter writer;
301   KsbaCMS cms = NULL;
302   KsbaStopReason stopreason;
303   KEYDB_HANDLE kh = NULL;
304   GCRY_MD_HD data_md = NULL;
305   int signer;
306   const char *algoid;
307   int algo;
308   time_t signed_at;
309   CERTLIST cl;
310   int release_signerlist = 0;
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   /* If no list of signers is given, use a default one. */
357   if (!signerlist)
358     {
359       KsbaCert cert = get_default_signer ();
360       if (!cert)
361         {
362           log_error ("no default signer found\n");
363           rc = seterr (General_Error);
364           goto leave;
365         }
366       signerlist = xtrycalloc (1, sizeof *signerlist);
367       if (!signerlist)
368         {
369           rc = GNUPG_Out_Of_Core;
370           ksba_cert_release (cert);
371           goto leave;
372         }
373       signerlist->cert = cert;
374       release_signerlist = 1;
375     }
376
377
378   /* Gather certificates of signers and store them in the CMS object. */
379   for (cl=signerlist; cl; cl = cl->next)
380     {
381       rc = gpgsm_cert_use_sign_p (cl->cert);
382       if (rc)
383         goto leave;
384       
385       err = ksba_cms_add_signer (cms, cl->cert);
386       if (err)
387         {
388           log_error ("ksba_cms_add_signer failed: %s\n",  ksba_strerror (err));
389           rc = map_ksba_err (err);
390           goto leave;
391         }
392       rc = add_certificate_list (ctrl, cms, cl->cert);
393       if (rc)
394         {
395           log_error ("failed to store list of certificates: %s\n",
396                      gnupg_strerror(rc));
397           goto leave;
398         }
399       /* Set the hash algorithm we are going to use */
400       err = ksba_cms_add_digest_algo (cms, "1.3.14.3.2.26" /*SHA-1*/);
401       if (err)
402         {
403           log_debug ("ksba_cms_add_digest_algo failed: %s\n",
404                      ksba_strerror (err));
405           rc = map_ksba_err (err);
406           goto leave;
407         }
408     }
409   
410   /* Prepare hashing (actually we are figuring out what we have set above)*/
411   data_md = gcry_md_open (0, 0);
412   if (!data_md)
413     {
414       rc = map_gcry_err (gcry_errno());
415       log_error ("md_open failed: %s\n", gcry_strerror (-1));
416       goto leave;
417     }
418   if (DBG_HASHING)
419     gcry_md_start_debug (data_md, "sign.data");
420
421   for (i=0; (algoid=ksba_cms_get_digest_algo_list (cms, i)); i++)
422     {
423       algo = gcry_md_map_name (algoid);
424       if (!algo)
425         {
426           log_error ("unknown hash algorithm `%s'\n", algoid? algoid:"?");
427           rc = GNUPG_Bug;
428           goto leave;
429         }
430       gcry_md_enable (data_md, algo);
431     }
432
433   if (detached)
434     { /* we hash the data right now so that we can store the message
435          digest.  ksba_cms_build() takes this as an flag that detached
436          data is expected. */
437       unsigned char *digest;
438       size_t digest_len;
439       /* Fixme do this for all signers and get the algo to use from
440          the signer's certificate - does not make mich sense, bu we
441          should do this consistent as we have already done it above */
442       algo = GCRY_MD_SHA1; 
443       hash_data (data_fd, data_md);
444       digest = gcry_md_read (data_md, algo);
445       digest_len = gcry_md_get_algo_dlen (algo);
446       if ( !digest || !digest_len)
447         {
448           log_error ("problem getting the hash of the data\n");
449           rc = GNUPG_Bug;
450           goto leave;
451         }
452       for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
453         {
454           err = ksba_cms_set_message_digest (cms, signer, digest, digest_len);
455           if (err)
456             {
457               log_error ("ksba_cms_set_message_digest failed: %s\n",
458                          ksba_strerror (err));
459               rc = map_ksba_err (err);
460               goto leave;
461             }
462         }
463     }
464
465   signed_at = gnupg_get_time ();
466   for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
467     {
468       err = ksba_cms_set_signing_time (cms, signer, signed_at);
469       if (err)
470         {
471           log_error ("ksba_cms_set_signing_time failed: %s\n",
472                      ksba_strerror (err));
473           rc = map_ksba_err (err);
474           goto leave;
475         }
476     }
477
478   do 
479     {
480       err = ksba_cms_build (cms, &stopreason);
481       if (err)
482         {
483           log_debug ("ksba_cms_build failed: %s\n", ksba_strerror (err));
484           rc = map_ksba_err (err);
485           goto leave;
486         }
487
488       if (stopreason == KSBA_SR_BEGIN_DATA)
489         { /* hash the data and store the message digest */
490           unsigned char *digest;
491           size_t digest_len;
492
493           assert (!detached);
494           /* Fixme: get the algo to use from the signer's certificate
495              - does not make much sense, but we should do this
496              consistent as we have already done it above.  Code is
497              mostly duplicated above. */
498
499           algo = GCRY_MD_SHA1; 
500           rc = hash_and_copy_data (data_fd, data_md, writer);
501           if (rc)
502             goto leave;
503           digest = gcry_md_read (data_md, algo);
504           digest_len = gcry_md_get_algo_dlen (algo);
505           if ( !digest || !digest_len)
506             {
507               log_error ("problem getting the hash of the data\n");
508               rc = GNUPG_Bug;
509               goto leave;
510             }
511           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
512             {
513               err = ksba_cms_set_message_digest (cms, signer,
514                                                  digest, digest_len);
515               if (err)
516                 {
517                   log_error ("ksba_cms_set_message_digest failed: %s\n",
518                              ksba_strerror (err));
519                   rc = map_ksba_err (err);
520                   goto leave;
521                 }
522             }
523         }
524       else if (stopreason == KSBA_SR_NEED_SIG)
525         { /* calculate the signature for all signers */
526           GCRY_MD_HD md;
527
528           algo = GCRY_MD_SHA1;
529           md = gcry_md_open (algo, 0);
530           if (DBG_HASHING)
531             gcry_md_start_debug (md, "sign.attr");
532
533           if (!md)
534             {
535               log_error ("md_open failed: %s\n", gcry_strerror (-1));
536               goto leave;
537             }
538           ksba_cms_set_hash_function (cms, HASH_FNC, md);
539           for (cl=signerlist,signer=0; cl; cl = cl->next, signer++)
540             {
541               char *sigval = NULL;
542               char *buf, *fpr;
543
544               if (signer)
545                 gcry_md_reset (md);
546               rc = ksba_cms_hash_signed_attrs (cms, signer);
547               if (rc)
548                 {
549                   log_debug ("hashing signed attrs failed: %s\n",
550                              ksba_strerror (rc));
551                   gcry_md_close (md);
552                   goto leave;
553                 }
554             
555               rc = gpgsm_create_cms_signature (cl->cert, md, algo, &sigval);
556               if (rc)
557                 {
558                   gcry_md_close (md);
559                   goto leave;
560                 }
561
562               err = ksba_cms_set_sig_val (cms, signer, sigval);
563               xfree (sigval);
564               if (err)
565                 {
566                   log_error ("failed to store the signature: %s\n",
567                              ksba_strerror (err));
568                   rc = map_ksba_err (err);
569                   gcry_md_close (md);
570                   goto leave;
571                 }
572
573               /* write a status message */
574               fpr = gpgsm_get_fingerprint_hexstring (cl->cert, GCRY_MD_SHA1);
575               if (!fpr)
576                 {
577                   rc = seterr (Out_Of_Core);
578                   gcry_md_close (md);
579                   goto leave;
580                 }
581               rc = asprintf (&buf, "%c %d %d 00 %lu %s",
582                              detached? 'D':'S',
583                              GCRY_PK_RSA,  /* FIXME: get pk algo from cert */
584                              algo, 
585                              (ulong)signed_at,
586                              fpr);
587               xfree (fpr);
588               if (rc < 0)
589                 {
590                   rc = seterr (Out_Of_Core);
591                   gcry_md_close (md);
592                   goto leave;
593                 }
594               rc = 0;
595               gpgsm_status (ctrl, STATUS_SIG_CREATED, buf);
596               free (buf); /* yes, we must use the regular free() here */
597             }
598           gcry_md_close (md);
599
600         }
601     }
602   while (stopreason != KSBA_SR_READY);   
603
604   rc = gpgsm_finish_writer (b64writer);
605   if (rc) 
606     {
607       log_error ("write failed: %s\n", gnupg_strerror (rc));
608       goto leave;
609     }
610
611   log_info ("signature created\n");
612
613
614  leave:
615   if (release_signerlist)
616     gpgsm_release_certlist (signerlist);
617   ksba_cms_release (cms);
618   gpgsm_destroy_writer (b64writer);
619   keydb_release (kh); 
620   gcry_md_close (data_md);
621   return rc;
622 }