* keylist.c (list_internal_keys): Renamed from gpgsm_list_keys.
[gnupg.git] / sm / encrypt.c
1 /* encrypt.c - Encrypt 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 struct dek_s {
39   const char *algoid;
40   int algo;
41   GCRY_CIPHER_HD chd;
42   char key[32];
43   int keylen;
44   char iv[32];
45   int ivlen;
46 };
47 typedef struct dek_s *DEK;
48
49 struct encrypt_cb_parm_s {
50   FILE *fp;
51   DEK dek;
52   int eof_seen;
53   int ready;
54   int readerror;
55   int bufsize;
56   unsigned char *buffer;
57   int buflen;
58 };
59
60
61
62
63 \f
64 /* initialize the data encryptionkey (session key) */
65 static int
66 init_dek (DEK dek)
67 {
68   int rc=0, mode, i;
69
70   dek->algo = gcry_cipher_map_name (dek->algoid);
71   mode = gcry_cipher_mode_from_oid (dek->algoid);
72   if (!dek->algo || !mode)
73     {
74       log_error ("unsupported algorithm `%s'\n", dek->algoid);
75       return GNUPG_Unsupported_Algorithm;
76     }
77
78   dek->keylen = gcry_cipher_get_algo_keylen (dek->algo);
79   if (!dek->keylen || dek->keylen > sizeof (dek->key))
80     return GNUPG_Bug;
81
82   dek->ivlen = gcry_cipher_get_algo_blklen (dek->algo);
83   if (!dek->ivlen || dek->ivlen > sizeof (dek->iv))
84     return GNUPG_Bug;
85
86   if (dek->keylen < 100/8)
87     { /* make sure we don't use weak keys */
88       log_error ("key length of `%s' too small\n", dek->algoid);
89       return GNUPG_Unsupported_Algorithm;
90     }
91   
92   dek->chd = gcry_cipher_open (dek->algo, mode, GCRY_CIPHER_SECURE);
93   if (!dek->chd)
94     {
95       log_error ("failed to create cipher context: %s\n", gcry_strerror (-1));
96       return GNUPG_General_Error;
97     }
98   
99   for (i=0; i < 8; i++)
100     {
101       gcry_randomize (dek->key, dek->keylen, GCRY_STRONG_RANDOM );
102       rc = gcry_cipher_setkey (dek->chd, dek->key, dek->keylen);
103       if (rc != GCRYERR_WEAK_KEY)
104         break;
105       log_info(_("weak key created - retrying\n") );
106     }
107   if (rc)
108     {
109       log_error ("failed to set the key: %s\n", gcry_strerror (rc));
110       gcry_cipher_close (dek->chd);
111       dek->chd = NULL;
112       return map_gcry_err (rc);
113     }
114
115   gcry_randomize (dek->iv, dek->ivlen, GCRY_STRONG_RANDOM);
116   rc = gcry_cipher_setiv (dek->chd, dek->iv, dek->ivlen);
117   if (rc)
118     {
119       log_error ("failed to set the IV: %s\n", gcry_strerror (rc));
120       gcry_cipher_close (dek->chd);
121       dek->chd = NULL;
122       return map_gcry_err (rc);
123     }
124   
125   return 0;
126 }
127
128
129 /* Encode the session key. NBITS is the number of bits which should be
130    used for packing the session key.  returns: An mpi with the session
131    key (caller must free) */
132 static GCRY_MPI
133 encode_session_key (DEK dek, unsigned int nbits)
134 {
135   int nframe = (nbits+7) / 8;
136   byte *p;
137   byte *frame;
138   int i,n;
139   MPI a;
140
141   if (dek->keylen + 7 > nframe || !nframe)
142     log_bug ("can't encode a %d bit key in a %d bits frame\n",
143              dek->keylen*8, nbits );
144
145   /* We encode the session key in this way:
146    *
147    *       0  2  RND(n bytes)  0  KEY(k bytes)
148    *
149    * (But how can we store the leading 0 - the external representaion
150    *    of MPIs doesn't allow leading zeroes =:-)
151    *
152    * RND are non-zero random bytes.
153    * KEY is the encryption key (session key) 
154    */
155
156   frame = gcry_xmalloc_secure (nframe);
157   n = 0;
158   frame[n++] = 0;
159   frame[n++] = 2;
160   i = nframe - 3 - dek->keylen;
161   assert (i > 0);
162   p = gcry_random_bytes_secure (i, GCRY_STRONG_RANDOM);
163   /* replace zero bytes by new values */
164   for (;;)
165     {
166       int j, k;
167       byte *pp;
168
169       /* count the zero bytes */
170       for(j=k=0; j < i; j++ )
171         {
172           if( !p[j] )
173             k++;
174         }
175       if( !k )
176         break; /* okay: no zero bytes */
177
178       k += k/128; /* better get some more */
179       pp = gcry_random_bytes_secure (k, GCRY_STRONG_RANDOM);
180       for (j=0; j < i && k; j++)
181         {
182           if( !p[j] )
183             p[j] = pp[--k];
184         }
185       xfree (pp);
186     }
187   memcpy (frame+n, p, i);
188   xfree (p);
189
190   n += i;
191   frame[n++] = 0;
192   memcpy (frame+n, dek->key, dek->keylen);
193   n += dek->keylen;
194   assert (n == nframe);
195   if (gcry_mpi_scan (&a, GCRYMPI_FMT_USG, frame, &nframe) )
196     BUG ();
197   gcry_free(frame);
198
199   return a;
200 }
201
202
203
204 /* encrypt the DEK under the key contained in CERT and return it as a
205    canonical S-Exp in encval */
206 static int
207 encrypt_dek (const DEK dek, KsbaCert cert, char **encval)
208 {
209   GCRY_SEXP s_ciph, s_data, s_pkey;
210   int rc;
211   KsbaSexp buf;
212   size_t len;
213
214   *encval = NULL;
215
216   /* get the key from the cert */
217   buf = ksba_cert_get_public_key (cert);
218   if (!buf)
219     {
220       log_error ("no public key for recipient\n");
221       return GNUPG_No_Public_Key;
222     }
223   len = gcry_sexp_canon_len (buf, 0, NULL, NULL);
224   if (!len)
225     {
226       log_error ("libksba did not return a proper S-Exp\n");
227       return GNUPG_Bug;
228     }
229   rc = gcry_sexp_sscan (&s_pkey, NULL, buf, len);
230   xfree (buf); buf = NULL;
231   if (rc)
232     {
233       log_error ("gcry_sexp_scan failed: %s\n", gcry_strerror (rc));
234       return map_gcry_err (rc);
235     }
236
237   /* put the encoded cleartext into a simple list */
238   {
239     /* fixme: actually the pkcs-1 encoding should go into libgcrypt */
240     GCRY_MPI data = encode_session_key (dek, gcry_pk_get_nbits (s_pkey));
241     if (!data)
242       {
243         gcry_mpi_release (data);
244         return GNUPG_General_Error;
245       }
246     if (gcry_sexp_build (&s_data, NULL, "%m", data))
247       BUG ();
248     gcry_mpi_release (data);
249   }
250
251   /* pass it to libgcrypt */
252   rc = gcry_pk_encrypt (&s_ciph, s_data, s_pkey);
253   gcry_sexp_release (s_data);
254   gcry_sexp_release (s_pkey);
255   
256   /* reformat it */
257   len = gcry_sexp_sprint (s_ciph, GCRYSEXP_FMT_CANON, NULL, 0);
258   assert (len); 
259   buf = xtrymalloc (len);
260   if (!buf)
261     {
262       gcry_sexp_release (s_ciph);
263       return GNUPG_Out_Of_Core;
264     }
265   len = gcry_sexp_sprint (s_ciph, GCRYSEXP_FMT_CANON, buf, len);
266   assert (len);
267
268   *encval = buf;
269   return 0;
270 }
271
272
273 \f
274 /* do the actual encryption */
275 static int
276 encrypt_cb (void *cb_value, char *buffer, size_t count, size_t *nread)
277 {
278   struct encrypt_cb_parm_s *parm = cb_value;
279   int blklen = parm->dek->ivlen;
280   unsigned char *p;
281   size_t n;
282
283   *nread = 0;
284   if (!buffer)
285     return -1; /* not supported */
286
287   if (parm->ready)
288     return -1;
289
290   if (count < blklen)
291     BUG ();
292      
293   if (!parm->eof_seen)
294     { /* fillup the buffer */
295       p = parm->buffer;
296       for (n=parm->buflen; n < parm->bufsize; n++)
297         {
298           int c = getc (parm->fp);
299           if (c == EOF)
300             {
301               if (ferror (parm->fp))
302                 {
303                   parm->readerror = errno;
304                   return -1;
305                 }
306               parm->eof_seen = 1;
307               break; 
308             }
309           p[n] = c;
310         }
311       parm->buflen = n;
312     }
313   
314   n = parm->buflen < count? parm->buflen : count;
315   n = n/blklen * blklen;
316   if (n)
317     { /* encrypt the stuff */
318       gcry_cipher_encrypt (parm->dek->chd, buffer, n, parm->buffer, n);
319       *nread = n;
320       /* Who cares about cycles, take the easy way and shift the buffer */
321       parm->buflen -= n;
322       memmove (parm->buffer, parm->buffer+n, parm->buflen);
323     }
324   else if (parm->eof_seen)
325     { /* no complete block but eof: add padding */
326       /* fixme: we should try to do this also in the above code path */
327       int i, npad = blklen - (parm->buflen % blklen);
328       p = parm->buffer;
329       for (n=parm->buflen, i=0; n < parm->bufsize && i < npad; n++, i++)
330         p[n] = npad;
331       gcry_cipher_encrypt (parm->dek->chd, buffer, n, parm->buffer, n);
332       *nread = n;
333       parm->ready = 1;
334     }
335
336   return 0;
337 }
338
339
340
341 \f
342 /* Perform an encrypt operation.  
343
344    Encrypt the data received on DATA-FD and write it to OUT_FP.  The
345    recipients are take from the certificate given in recplist; if this
346    is NULL it will be encrypted for a default recipient */
347 int
348 gpgsm_encrypt (CTRL ctrl, CERTLIST recplist, int data_fd, FILE *out_fp)
349 {
350   int rc = 0;
351   Base64Context b64writer = NULL;
352   KsbaError err;
353   KsbaWriter writer;
354   KsbaReader reader = NULL;
355   KsbaCMS cms = NULL;
356   KsbaStopReason stopreason;
357   KEYDB_HANDLE kh = NULL;
358   struct encrypt_cb_parm_s encparm;
359   DEK dek = NULL;
360   int recpno;
361   FILE *data_fp = NULL;
362   CERTLIST cl;
363
364   memset (&encparm, 0, sizeof encparm);
365
366   if (!recplist)
367     {
368       log_error(_("no valid recipients given\n"));
369       gpgsm_status (ctrl, STATUS_NO_RECP, "0");
370       rc = GNUPG_No_Public_Key;
371       goto leave;
372     }
373
374   kh = keydb_new (0);
375   if (!kh)
376     {
377       log_error (_("failed to allocated keyDB handle\n"));
378       rc = GNUPG_General_Error;
379       goto leave;
380     }
381
382   data_fp = fdopen ( dup (data_fd), "rb");
383   if (!data_fp)
384     {
385       log_error ("fdopen() failed: %s\n", strerror (errno));
386       rc = seterr (IO_Error);
387       goto leave;
388     }
389
390   reader = ksba_reader_new ();
391   if (!reader)
392       rc = KSBA_Out_Of_Core;
393   if (!rc)
394     rc = ksba_reader_set_cb (reader, encrypt_cb, &encparm);
395   if (rc)
396     {
397       rc = map_ksba_err (rc);
398       goto leave;
399     }
400   encparm.fp = data_fp;
401
402   ctrl->pem_name = "ENCRYPTED MESSAGE";
403   rc = gpgsm_create_writer (&b64writer, ctrl, out_fp, &writer);
404   if (rc)
405     {
406       log_error ("can't create writer: %s\n", gnupg_strerror (rc));
407       goto leave;
408     }
409
410   cms = ksba_cms_new ();
411   if (!cms)
412     {
413       rc = seterr (Out_Of_Core);
414       goto leave;
415     }
416
417   err = ksba_cms_set_reader_writer (cms, reader, writer);
418   if (err)
419     {
420       log_debug ("ksba_cms_set_reader_writer failed: %s\n",
421                  ksba_strerror (err));
422       rc = map_ksba_err (err);
423       goto leave;
424     }
425
426   /* We are going to create enveloped data with uninterpreted data as
427      inner content */
428   err = ksba_cms_set_content_type (cms, 0, KSBA_CT_ENVELOPED_DATA);
429   if (!err)
430     err = ksba_cms_set_content_type (cms, 1, KSBA_CT_DATA);
431   if (err)
432     {
433       log_debug ("ksba_cms_set_content_type failed: %s\n",
434                  ksba_strerror (err));
435       rc = map_ksba_err (err);
436       goto leave;
437     }
438
439   /* create a session key */
440   dek = xtrycalloc (1, sizeof *dek); /* hmmm: should we put it into secmem?*/
441   if (!dek)
442     rc = GNUPG_Out_Of_Core;
443   else
444   {
445     dek->algoid = opt.def_cipher_algoid;
446     rc = init_dek (dek);
447   }
448   if (rc)
449     {
450       log_error ("failed to create the session key: %s\n",
451                  gnupg_strerror (rc));
452       goto leave;
453     }
454
455   err = ksba_cms_set_content_enc_algo (cms, dek->algoid, dek->iv, dek->ivlen);
456   if (err)
457     {
458       log_error ("ksba_cms_set_content_enc_algo failed: %s\n",
459                  ksba_strerror (err));
460       rc = map_ksba_err (err);
461       goto leave;
462     }
463
464   encparm.dek = dek;
465   /* Use a ~8k (AES) or ~4k (3DES) buffer */
466   encparm.bufsize = 500 * dek->ivlen;
467   encparm.buffer = xtrymalloc (encparm.bufsize);
468   if (!encparm.buffer)
469     {
470       rc = seterr (Out_Of_Core);
471       goto leave;
472     }
473
474   /* gather certificates of recipients, encrypt the session key for
475      each and store them in the CMS object */
476   for (recpno = 0, cl = recplist; cl; recpno++, cl = cl->next)
477     {
478       char *encval;
479       
480       rc = encrypt_dek (dek, cl->cert, &encval);
481       if (rc)
482         {
483           log_error ("encryption failed for recipient no. %d: %s\n",
484                      recpno, gnupg_strerror (rc));
485           goto leave;
486         }
487       
488       err = ksba_cms_add_recipient (cms, cl->cert);
489       if (err)
490         {
491           log_error ("ksba_cms_add_recipient failed: %s\n",
492                      ksba_strerror (err));
493           rc = map_ksba_err (err);
494           xfree (encval);
495           goto leave;
496         }
497       
498       err = ksba_cms_set_enc_val (cms, recpno, encval);
499       xfree (encval);
500       if (err)
501         {
502           log_error ("ksba_cms_set_enc_val failed: %s\n",
503                      ksba_strerror (err));
504           rc = map_ksba_err (err);
505           goto leave;
506         }
507   }
508
509   /* main control loop for encryption */
510   recpno = 0;
511   do 
512     {
513       err = ksba_cms_build (cms, &stopreason);
514       if (err)
515         {
516           log_debug ("ksba_cms_build failed: %s\n", ksba_strerror (err));
517           rc = map_ksba_err (err);
518           goto leave;
519         }
520     }
521   while (stopreason != KSBA_SR_READY);   
522
523   if (encparm.readerror)
524     {
525       log_error ("error reading input: %s\n", strerror (encparm.readerror));
526       rc = seterr (Read_Error);
527       goto leave;
528     }
529
530
531   rc = gpgsm_finish_writer (b64writer);
532   if (rc) 
533     {
534       log_error ("write failed: %s\n", gnupg_strerror (rc));
535       goto leave;
536     }
537   log_info ("encrypted data created\n");
538
539  leave:
540   ksba_cms_release (cms);
541   gpgsm_destroy_writer (b64writer);
542   ksba_reader_release (reader);
543   keydb_release (kh); 
544   xfree (dek);
545   if (data_fp)
546     fclose (data_fp);
547   xfree (encparm.buffer);
548   return rc;
549 }