See ChangeLog: Tue Aug 31 17:20:44 CEST 1999 Werner Koch
[gnupg.git] / g10 / encode.c
1 /* encode.c - encode data
2  *      Copyright (C) 1998 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 <assert.h>
27
28 #include "options.h"
29 #include "packet.h"
30 #include "errors.h"
31 #include "iobuf.h"
32 #include "keydb.h"
33 #include "memory.h"
34 #include "util.h"
35 #include "main.h"
36 #include "filter.h"
37 #include "trustdb.h"
38 #include "i18n.h"
39
40
41 static int encode_simple( const char *filename, int mode );
42 static int write_pubkey_enc_from_list( PK_LIST pk_list, DEK *dek, IOBUF out );
43
44
45
46 /****************
47  * Encode FILENAME with only the symmetric cipher.  Take input from
48  * stdin if FILENAME is NULL.
49  */
50 int
51 encode_symmetric( const char *filename )
52 {
53     return encode_simple( filename, 1 );
54 }
55
56 /****************
57  * Encode FILENAME as a literal data packet only. Take input from
58  * stdin if FILENAME is NULL.
59  */
60 int
61 encode_store( const char *filename )
62 {
63     return encode_simple( filename, 0 );
64 }
65
66
67
68 static int
69 encode_simple( const char *filename, int mode )
70 {
71     IOBUF inp, out;
72     PACKET pkt;
73     PKT_plaintext *pt = NULL;
74     STRING2KEY *s2k = NULL;
75     int rc = 0;
76     u32 filesize;
77     cipher_filter_context_t cfx;
78     armor_filter_context_t afx;
79     compress_filter_context_t zfx;
80     text_filter_context_t tfx;
81     int do_compress = opt.compress && !opt.rfc1991;
82
83     memset( &cfx, 0, sizeof cfx);
84     memset( &afx, 0, sizeof afx);
85     memset( &zfx, 0, sizeof zfx);
86     memset( &tfx, 0, sizeof tfx);
87     init_packet(&pkt);
88
89     /* prepare iobufs */
90     if( !(inp = iobuf_open(filename)) ) {
91         log_error(_("%s: can't open: %s\n"), filename? filename: "[stdin]",
92                                         strerror(errno) );
93         return G10ERR_OPEN_FILE;
94     }
95
96     if( opt.textmode )
97         iobuf_push_filter( inp, text_filter, &tfx );
98
99     cfx.dek = NULL;
100     if( mode ) {
101         s2k = m_alloc_clear( sizeof *s2k );
102         s2k->mode = opt.rfc1991? 0:opt.s2k_mode;
103         s2k->hash_algo = opt.def_digest_algo ? opt.def_digest_algo
104                                              : opt.s2k_digest_algo;
105         cfx.dek = passphrase_to_dek( NULL, 0,
106                        opt.def_cipher_algo ? opt.def_cipher_algo
107                                            : opt.s2k_cipher_algo , s2k, 2 );
108         if( !cfx.dek || !cfx.dek->keylen ) {
109             rc = G10ERR_PASSPHRASE;
110             m_free(cfx.dek);
111             m_free(s2k);
112             iobuf_close(inp);
113             log_error(_("error creating passphrase: %s\n"), g10_errstr(rc) );
114             return rc;
115         }
116     }
117
118     if( (rc = open_outfile( filename, opt.armor? 1:0, &out )) ) {
119         iobuf_close(inp);
120         m_free(cfx.dek);
121         m_free(s2k);
122         return rc;
123     }
124
125     if( opt.armor )
126         iobuf_push_filter( out, armor_filter, &afx );
127   #ifdef ENABLE_COMMENT_PACKETS
128     else {
129         write_comment( out, "#created by GNUPG v" VERSION " ("
130                                             PRINTABLE_OS_NAME ")");
131         if( opt.comment_string )
132             write_comment( out, opt.comment_string );
133     }
134   #endif
135     if( s2k && !opt.rfc1991 ) {
136         PKT_symkey_enc *enc = m_alloc_clear( sizeof *enc );
137         enc->version = 4;
138         enc->cipher_algo = cfx.dek->algo;
139         enc->s2k = *s2k;
140         pkt.pkttype = PKT_SYMKEY_ENC;
141         pkt.pkt.symkey_enc = enc;
142         if( (rc = build_packet( out, &pkt )) )
143             log_error("build symkey packet failed: %s\n", g10_errstr(rc) );
144         m_free(enc);
145     }
146
147     if (!opt.no_literal) {
148         /* setup the inner packet */
149         if( filename || opt.set_filename ) {
150             char *s = make_basename( opt.set_filename ? opt.set_filename
151                                                       : filename );
152             pt = m_alloc( sizeof *pt + strlen(s) - 1 );
153             pt->namelen = strlen(s);
154             memcpy(pt->name, s, pt->namelen );
155             m_free(s);
156         }
157         else { /* no filename */
158             pt = m_alloc( sizeof *pt - 1 );
159             pt->namelen = 0;
160         }
161     }
162
163     /* pgp5 has problems to decrypt symmetrically encrypted data from
164      * GnuPG if the filelength is in the inner packet.  It works
165      * when only partial length headers are use.  Until we have
166      * tracked this problem down. We use this temporary fix
167      * (fixme: remove the && !mode )
168      */
169     if( filename && !opt.textmode && !mode ) {
170         if( !(filesize = iobuf_get_filelength(inp)) )
171             log_info(_("%s: WARNING: empty file\n"), filename );
172     }
173     else
174         filesize = opt.set_filesize ? opt.set_filesize : 0; /* stdin */
175
176     if (!opt.no_literal) {
177         pt->timestamp = make_timestamp();
178         pt->mode = opt.textmode? 't' : 'b';
179         pt->len = filesize;
180         pt->buf = inp;
181         pkt.pkttype = PKT_PLAINTEXT;
182         pkt.pkt.plaintext = pt;
183         cfx.datalen = filesize && !do_compress ? calc_packet_length( &pkt ) : 0;
184     }
185     else
186         cfx.datalen = filesize && !do_compress ? filesize : 0;
187
188     /* register the cipher filter */
189     if( mode )
190         iobuf_push_filter( out, cipher_filter, &cfx );
191     /* register the compress filter */
192     if( do_compress )
193         iobuf_push_filter( out, compress_filter, &zfx );
194
195     /* do the work */
196     if (!opt.no_literal) {
197         if( (rc = build_packet( out, &pkt )) )
198             log_error("build_packet failed: %s\n", g10_errstr(rc) );
199     }
200     else {
201         /* user requested not to create a literal packet,
202          * so we copy the plain data */
203         byte copy_buffer[4096];
204         int  bytes_copied;
205         while ((bytes_copied = iobuf_read(inp, copy_buffer, 4096)) != -1)
206             if (iobuf_write(out, copy_buffer, bytes_copied) == -1) {
207                 rc = G10ERR_WRITE_FILE;
208                 log_error("copying input to output failed: %s\n", g10_errstr(rc) );
209                 break;
210             }
211         memset(copy_buffer, 0, 4096); /* burn buffer */
212     }
213
214     /* finish the stuff */
215     iobuf_close(inp);
216     if (rc)
217         iobuf_cancel(out);
218     else
219         iobuf_close(out); /* fixme: check returncode */
220     if (pt)
221         pt->buf = NULL;
222     free_packet(&pkt);
223     m_free(cfx.dek);
224     m_free(s2k);
225     return rc;
226 }
227
228 /****************
229  * Encrypt the file with the given userids (or ask if none
230  * is supplied).
231  */
232 int
233 encode_crypt( const char *filename, STRLIST remusr )
234 {
235     IOBUF inp = NULL, out = NULL;
236     PACKET pkt;
237     PKT_plaintext *pt = NULL;
238     int rc = 0;
239     u32 filesize;
240     cipher_filter_context_t cfx;
241     armor_filter_context_t afx;
242     compress_filter_context_t zfx;
243     text_filter_context_t tfx;
244     PK_LIST pk_list;
245     int do_compress = opt.compress && !opt.rfc1991;
246
247
248     memset( &cfx, 0, sizeof cfx);
249     memset( &afx, 0, sizeof afx);
250     memset( &zfx, 0, sizeof zfx);
251     memset( &tfx, 0, sizeof tfx);
252     init_packet(&pkt);
253
254     if( (rc=build_pk_list( remusr, &pk_list, PUBKEY_USAGE_ENC)) )
255         return rc;
256
257     /* prepare iobufs */
258     if( !(inp = iobuf_open(filename)) ) {
259         log_error(_("can't open %s: %s\n"), filename? filename: "[stdin]",
260                                         strerror(errno) );
261         rc = G10ERR_OPEN_FILE;
262         goto leave;
263     }
264     else if( opt.verbose )
265         log_info(_("reading from `%s'\n"), filename? filename: "[stdin]");
266
267     if( opt.textmode )
268         iobuf_push_filter( inp, text_filter, &tfx );
269
270     if( (rc = open_outfile( filename, opt.armor? 1:0, &out )) )
271         goto leave;
272
273
274     if( opt.armor )
275         iobuf_push_filter( out, armor_filter, &afx );
276   #ifdef ENABLE_COMMENT_PACKETS
277     else {
278         write_comment( out, "#created by GNUPG v" VERSION " ("
279                                             PRINTABLE_OS_NAME ")");
280         if( opt.comment_string )
281             write_comment( out, opt.comment_string );
282     }
283   #endif
284     /* create a session key */
285     cfx.dek = m_alloc_secure( sizeof *cfx.dek );
286     if( !opt.def_cipher_algo ) { /* try to get it from the prefs */
287         cfx.dek->algo = select_algo_from_prefs( pk_list, PREFTYPE_SYM );
288         if( cfx.dek->algo == -1 )
289             cfx.dek->algo = DEFAULT_CIPHER_ALGO;
290     }
291     else
292         cfx.dek->algo = opt.def_cipher_algo;
293     make_session_key( cfx.dek );
294     if( DBG_CIPHER )
295         log_hexdump("DEK is: ", cfx.dek->key, cfx.dek->keylen );
296
297     rc = write_pubkey_enc_from_list( pk_list, cfx.dek, out );
298     if( rc  )
299         goto leave;
300
301     if (!opt.no_literal) {
302         /* setup the inner packet */
303         if( filename || opt.set_filename ) {
304             char *s = make_basename( opt.set_filename ? opt.set_filename : filename );
305             pt = m_alloc( sizeof *pt + strlen(s) - 1 );
306             pt->namelen = strlen(s);
307             memcpy(pt->name, s, pt->namelen );
308             m_free(s);
309         }
310         else { /* no filename */
311             pt = m_alloc( sizeof *pt - 1 );
312             pt->namelen = 0;
313         }
314     }
315
316     if( filename && !opt.textmode ) {
317         if( !(filesize = iobuf_get_filelength(inp)) )
318             log_info(_("%s: WARNING: empty file\n"), filename );
319     }
320     else
321         filesize = opt.set_filesize ? opt.set_filesize : 0; /* stdin */
322
323     if (!opt.no_literal) {
324         pt->timestamp = make_timestamp();
325         pt->mode = opt.textmode ? 't' : 'b';
326         pt->len = filesize;
327         pt->new_ctb = !pt->len && !opt.rfc1991;
328         pt->buf = inp;
329         pkt.pkttype = PKT_PLAINTEXT;
330         pkt.pkt.plaintext = pt;
331         cfx.datalen = filesize && !do_compress? calc_packet_length( &pkt ) : 0;
332     }
333     else
334         cfx.datalen = filesize && !do_compress ? filesize : 0;
335
336     /* register the cipher filter */
337     iobuf_push_filter( out, cipher_filter, &cfx );
338
339     /* register the compress filter */
340     if( do_compress ) {
341         int compr_algo = select_algo_from_prefs( pk_list, PREFTYPE_COMPR );
342         if( !compr_algo )
343             ; /* don't use compression */
344         else {
345             if( compr_algo == 1 )
346                 zfx.algo = 1; /* default is 2 */
347             iobuf_push_filter( out, compress_filter, &zfx );
348         }
349     }
350
351     /* do the work */
352     if (!opt.no_literal) {
353         if( (rc = build_packet( out, &pkt )) )
354             log_error("build_packet failed: %s\n", g10_errstr(rc) );
355     }
356     else {
357         /* user requested not to create a literal packet, so we copy the plain data */
358         byte copy_buffer[4096];
359         int  bytes_copied;
360         while ((bytes_copied = iobuf_read(inp, copy_buffer, 4096)) != -1)
361             if (iobuf_write(out, copy_buffer, bytes_copied) == -1) {
362                 rc = G10ERR_WRITE_FILE;
363                 log_error("copying input to output failed: %s\n", g10_errstr(rc) );
364                 break;
365             }
366         memset(copy_buffer, 0, 4096); /* burn buffer */
367     }
368
369     /* finish the stuff */
370   leave:
371     iobuf_close(inp);
372     if( rc )
373         iobuf_cancel(out);
374     else
375         iobuf_close(out); /* fixme: check returncode */
376     if( pt )
377         pt->buf = NULL;
378     free_packet(&pkt);
379     m_free(cfx.dek);
380     release_pk_list( pk_list );
381     return rc;
382 }
383
384
385
386
387 /****************
388  * Filter to do a complete public key encryption.
389  */
390 int
391 encrypt_filter( void *opaque, int control,
392                IOBUF a, byte *buf, size_t *ret_len)
393 {
394     size_t size = *ret_len;
395     encrypt_filter_context_t *efx = opaque;
396     int rc=0;
397
398     if( control == IOBUFCTRL_UNDERFLOW ) { /* decrypt */
399         BUG(); /* not used */
400     }
401     else if( control == IOBUFCTRL_FLUSH ) { /* encrypt */
402         if( !efx->header_okay ) {
403             efx->cfx.dek = m_alloc_secure( sizeof *efx->cfx.dek );
404
405             if( !opt.def_cipher_algo  ) { /* try to get it from the prefs */
406                 efx->cfx.dek->algo =
407                           select_algo_from_prefs( efx->pk_list, PREFTYPE_SYM );
408                 if( efx->cfx.dek->algo == -1 )
409                     efx->cfx.dek->algo = DEFAULT_CIPHER_ALGO;
410             }
411             else
412                 efx->cfx.dek->algo = opt.def_cipher_algo;
413             make_session_key( efx->cfx.dek );
414             if( DBG_CIPHER )
415                 log_hexdump("DEK is: ",
416                              efx->cfx.dek->key, efx->cfx.dek->keylen );
417
418             rc = write_pubkey_enc_from_list( efx->pk_list, efx->cfx.dek, a );
419             if( rc )
420                 return rc;
421
422             iobuf_push_filter( a, cipher_filter, &efx->cfx );
423
424             efx->header_okay = 1;
425         }
426         rc = iobuf_write( a, buf, size );
427
428     }
429     else if( control == IOBUFCTRL_FREE ) {
430     }
431     else if( control == IOBUFCTRL_DESC ) {
432         *(char**)buf = "encrypt_filter";
433     }
434     return rc;
435 }
436
437
438 /****************
439  * Write pubkey-enc packets from the list of PKs to OUT.
440  */
441 static int
442 write_pubkey_enc_from_list( PK_LIST pk_list, DEK *dek, IOBUF out )
443 {
444     PACKET pkt;
445     PKT_public_key *pk;
446     PKT_pubkey_enc  *enc;
447     int rc;
448
449     for( ; pk_list; pk_list = pk_list->next ) {
450         MPI frame;
451
452         pk = pk_list->pk;
453
454         print_pubkey_algo_note( pk->pubkey_algo );
455         enc = m_alloc_clear( sizeof *enc );
456         enc->pubkey_algo = pk->pubkey_algo;
457         keyid_from_pk( pk, enc->keyid );
458         enc->throw_keyid = opt.throw_keyid;
459
460         /* Okay, what's going on: We have the session key somewhere in
461          * the structure DEK and want to encode this session key in
462          * an integer value of n bits.  pubkey_nbits gives us the
463          * number of bits we have to use.  We then encode the session
464          * key in some way and we get it back in the big intger value
465          * FRAME.  Then we use FRAME, the public key PK->PKEY and the
466          * algorithm number PK->PUBKEY_ALGO and pass it to pubkey_encrypt
467          * which returns the encrypted value in the array ENC->DATA.
468          * This array has a size which depends on the used algorithm
469          * (e.g. 2 for ElGamal).  We don't need frame anymore because we
470          * have everything now in enc->data which is the passed to
471          * build_packet()
472          */
473         frame = encode_session_key( dek, pubkey_nbits( pk->pubkey_algo,
474                                                           pk->pkey ) );
475         rc = pubkey_encrypt( pk->pubkey_algo, enc->data, frame, pk->pkey );
476         mpi_free( frame );
477         if( rc )
478             log_error("pubkey_encrypt failed: %s\n", g10_errstr(rc) );
479         else {
480             if( opt.verbose ) {
481                 char *ustr = get_user_id_string( enc->keyid );
482                 log_info(_("%s/%s encrypted for: %s\n"),
483                     pubkey_algo_to_string(enc->pubkey_algo),
484                     cipher_algo_to_string(dek->algo), ustr );
485                 m_free(ustr);
486             }
487             /* and write it */
488             init_packet(&pkt);
489             pkt.pkttype = PKT_PUBKEY_ENC;
490             pkt.pkt.pubkey_enc = enc;
491             rc = build_packet( out, &pkt );
492             if( rc )
493                log_error("build_packet(pubkey_enc) failed: %s\n", g10_errstr(rc));
494         }
495         free_pubkey_enc(enc);
496         if( rc )
497             return rc;
498     }
499     return 0;
500 }
501