new release
[gnupg.git] / g10 / build-packet.c
1 /* build-packet.c - assemble packets and write them
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 <assert.h>
26
27 #include "packet.h"
28 #include "errors.h"
29 #include "iobuf.h"
30 #include "mpi.h"
31 #include "util.h"
32 #include "cipher.h"
33 #include "memory.h"
34 #include "options.h"
35
36
37 static int do_comment( IOBUF out, int ctb, PKT_comment *rem );
38 static int do_user_id( IOBUF out, int ctb, PKT_user_id *uid );
39 static int do_public_cert( IOBUF out, int ctb, PKT_public_cert *pk );
40 static int do_secret_cert( IOBUF out, int ctb, PKT_secret_cert *pk );
41 static int do_symkey_enc( IOBUF out, int ctb, PKT_symkey_enc *enc );
42 static int do_pubkey_enc( IOBUF out, int ctb, PKT_pubkey_enc *enc );
43 static u32 calc_plaintext( PKT_plaintext *pt );
44 static int do_plaintext( IOBUF out, int ctb, PKT_plaintext *pt );
45 static int do_encrypted( IOBUF out, int ctb, PKT_encrypted *ed );
46 static int do_compressed( IOBUF out, int ctb, PKT_compressed *cd );
47 static int do_signature( IOBUF out, int ctb, PKT_signature *sig );
48 static int do_onepass_sig( IOBUF out, int ctb, PKT_onepass_sig *ops );
49
50 static int calc_header_length( u32 len );
51 static int write_16(IOBUF inp, u16 a);
52 static int write_32(IOBUF inp, u32 a);
53 static int write_header( IOBUF out, int ctb, u32 len );
54 static int write_header2( IOBUF out, int ctb, u32 len, int hdrlen, int blkmode );
55 static int write_new_header( IOBUF out, int ctb, u32 len, int hdrlen );
56 static int write_version( IOBUF out, int ctb );
57
58 /****************
59  * Build a packet and write it to INP
60  * Returns: 0 := okay
61  *         >0 := error
62  * Note: Caller must free the packet
63  */
64 int
65 build_packet( IOBUF out, PACKET *pkt )
66 {
67     int rc=0, ctb;
68
69     if( DBG_PACKET )
70         log_debug("build_packet() type=%d\n", pkt->pkttype );
71     if( pkt->pkttype == PKT_OLD_COMMENT )
72         pkt->pkttype = PKT_COMMENT;
73     assert( pkt->pkt.generic );
74     if( pkt->pkttype > 15 ) /* new format */
75         ctb = 0xc0 | (pkt->pkttype & 0x3f);
76     else
77         ctb = 0x80 | ((pkt->pkttype & 15)<<2);
78     switch( pkt->pkttype ) {
79       case PKT_USER_ID:
80         rc = do_user_id( out, ctb, pkt->pkt.user_id );
81         break;
82       case PKT_COMMENT:
83         rc = do_comment( out, ctb, pkt->pkt.comment );
84         break;
85       case PKT_PUBLIC_CERT:
86         rc = do_public_cert( out, ctb, pkt->pkt.public_cert );
87         break;
88       case PKT_SECRET_CERT:
89         rc = do_secret_cert( out, ctb, pkt->pkt.secret_cert );
90         break;
91       case PKT_SYMKEY_ENC:
92         rc = do_symkey_enc( out, ctb, pkt->pkt.symkey_enc );
93         break;
94       case PKT_PUBKEY_ENC:
95         rc = do_pubkey_enc( out, ctb, pkt->pkt.pubkey_enc );
96         break;
97       case PKT_PLAINTEXT:
98         rc = do_plaintext( out, ctb, pkt->pkt.plaintext );
99         break;
100       case PKT_ENCRYPTED:
101         rc = do_encrypted( out, ctb, pkt->pkt.encrypted );
102         break;
103       case PKT_COMPRESSED:
104         rc = do_compressed( out, ctb, pkt->pkt.compressed );
105         break;
106       case PKT_SIGNATURE:
107         rc = do_signature( out, ctb, pkt->pkt.signature );
108         break;
109       case PKT_ONEPASS_SIG:
110         rc = do_onepass_sig( out, ctb, pkt->pkt.onepass_sig );
111         break;
112       case PKT_RING_TRUST:
113       default:
114         log_bug("invalid packet type in build_packet()\n");
115         break;
116     }
117
118     return rc;
119 }
120
121 /****************
122  * calculate the length of a packet described by PKT
123  */
124 u32
125 calc_packet_length( PACKET *pkt )
126 {
127     u32 n=0;
128
129     assert( pkt->pkt.generic );
130     switch( pkt->pkttype ) {
131       case PKT_PLAINTEXT:
132         n = calc_plaintext( pkt->pkt.plaintext );
133         break;
134       case PKT_USER_ID:
135       case PKT_COMMENT:
136       case PKT_PUBLIC_CERT:
137       case PKT_SECRET_CERT:
138       case PKT_SYMKEY_ENC:
139       case PKT_PUBKEY_ENC:
140       case PKT_ENCRYPTED:
141       case PKT_SIGNATURE:
142       case PKT_ONEPASS_SIG:
143       case PKT_RING_TRUST:
144       case PKT_COMPRESSED:
145       default:
146         log_bug("invalid packet type in calc_packet_length()");
147         break;
148     }
149     n += calc_header_length(n);
150     return n;
151 }
152
153
154 static int
155 do_comment( IOBUF out, int ctb, PKT_comment *rem )
156 {
157     if( !opt.no_comment ) {
158         write_header(out, ctb, rem->len);
159         if( iobuf_write( out, rem->data, rem->len ) )
160             return G10ERR_WRITE_FILE;
161     }
162     return 0;
163 }
164
165 static int
166 do_user_id( IOBUF out, int ctb, PKT_user_id *uid )
167 {
168     write_header(out, ctb, uid->len);
169     if( iobuf_write( out, uid->name, uid->len ) )
170         return G10ERR_WRITE_FILE;
171     return 0;
172 }
173
174 static int
175 do_public_cert( IOBUF out, int ctb, PKT_public_cert *pkc )
176 {
177     int rc = 0;
178     IOBUF a = iobuf_temp();
179
180     if( !pkc->version )
181         iobuf_put( a, 3 );
182     else
183         iobuf_put( a, pkc->version );
184     write_32(a, pkc->timestamp );
185     if( pkc->version < 4 )
186         write_16(a, pkc->valid_days );
187     iobuf_put(a, pkc->pubkey_algo );
188     if( is_ELGAMAL(pkc->pubkey_algo) ) {
189         mpi_write(a, pkc->d.elg.p );
190         mpi_write(a, pkc->d.elg.g );
191         mpi_write(a, pkc->d.elg.y );
192     }
193     else if( pkc->pubkey_algo == PUBKEY_ALGO_DSA ) {
194         mpi_write(a, pkc->d.dsa.p );
195         mpi_write(a, pkc->d.dsa.q );
196         mpi_write(a, pkc->d.dsa.g );
197         mpi_write(a, pkc->d.dsa.y );
198     }
199     else if( is_RSA(pkc->pubkey_algo) ) {
200         mpi_write(a, pkc->d.rsa.n );
201         mpi_write(a, pkc->d.rsa.e );
202     }
203     else {
204         rc = G10ERR_PUBKEY_ALGO;
205         goto leave;
206     }
207
208     write_header2(out, ctb, iobuf_get_temp_length(a), pkc->hdrbytes, 1 );
209     if( iobuf_write_temp( out, a ) )
210         rc = G10ERR_WRITE_FILE;
211
212   leave:
213     iobuf_close(a);
214     return rc;
215 }
216
217
218 /****************
219  * Make a hash value from the public key certificate
220  */
221 void
222 hash_public_cert( MD_HANDLE md, PKT_public_cert *pkc )
223 {
224     PACKET pkt;
225     int rc = 0;
226     int c;
227     IOBUF a = iobuf_temp();
228   #if 0
229     FILE *fp = fopen("dump.pkc", "a");
230     int i=0;
231
232     fprintf(fp, "\nHashing PKC:\n");
233   #endif
234
235     /* build the packet */
236     init_packet(&pkt);
237     pkt.pkttype = PKT_PUBLIC_CERT;
238     pkt.pkt.public_cert = pkc;
239     if( (rc = build_packet( a, &pkt )) )
240         log_fatal("build public_cert for hashing failed: %s\n", g10_errstr(rc));
241     while( (c=iobuf_get(a)) != -1 ) {
242       #if 0
243         fprintf( fp," %02x", c );
244         if( (++i == 24) ) {
245             putc('\n', fp);
246             i=0;
247         }
248       #endif
249         md_putc( md, c );
250     }
251   #if 0
252     putc('\n', fp);
253     fclose(fp);
254   #endif
255     iobuf_cancel(a);
256 }
257
258
259 static int
260 do_secret_cert( IOBUF out, int ctb, PKT_secret_cert *skc )
261 {
262     int rc = 0;
263     IOBUF a = iobuf_temp();
264
265     if( !skc->version )
266         iobuf_put( a, 3 );
267     else
268         iobuf_put( a, skc->version );
269     write_32(a, skc->timestamp );
270     if( skc->version < 4 )
271         write_16(a, skc->valid_days );
272     iobuf_put(a, skc->pubkey_algo );
273     if( is_ELGAMAL(skc->pubkey_algo) ) {
274         mpi_write(a, skc->d.elg.p );
275         mpi_write(a, skc->d.elg.g );
276         mpi_write(a, skc->d.elg.y );
277         if( skc->is_protected ) {
278             iobuf_put(a, 0xff );
279             iobuf_put(a, skc->protect.algo );
280             iobuf_put(a, skc->protect.s2k.mode );
281             iobuf_put(a, skc->protect.s2k.hash_algo );
282             if( skc->protect.s2k.mode == 1
283                 || skc->protect.s2k.mode == 4 )
284                 iobuf_write(a, skc->protect.s2k.salt, 8 );
285             if( skc->protect.s2k.mode == 4 )
286                 write_32(a, skc->protect.s2k.count );
287             iobuf_write(a, skc->protect.iv, 8 );
288         }
289         else
290             iobuf_put(a, 0 );
291
292         mpi_write(a, skc->d.elg.x );
293         write_16(a, skc->csum );
294     }
295     else if( is_RSA(skc->pubkey_algo) ) {
296         mpi_write(a, skc->d.rsa.n );
297         mpi_write(a, skc->d.rsa.e );
298         if( skc->is_protected ) {
299             iobuf_put(a, skc->protect.algo );
300             iobuf_write(a, skc->protect.iv, 8 );
301         }
302         else
303             iobuf_put(a, 0 );
304         mpi_write(a, skc->d.rsa.d );
305         mpi_write(a, skc->d.rsa.p );
306         mpi_write(a, skc->d.rsa.q );
307         mpi_write(a, skc->d.rsa.u );
308         write_16(a, skc->csum );
309     }
310     else {
311         rc = G10ERR_PUBKEY_ALGO;
312         goto leave;
313     }
314
315     write_header2(out, ctb, iobuf_get_temp_length(a), skc->hdrbytes, 1 );
316     if( iobuf_write_temp( out, a ) )
317         rc = G10ERR_WRITE_FILE;
318
319   leave:
320     iobuf_close(a);
321     return rc;
322 }
323
324 static int
325 do_symkey_enc( IOBUF out, int ctb, PKT_symkey_enc *enc )
326 {
327     int rc = 0;
328     IOBUF a = iobuf_temp();
329
330     assert( enc->version == 4 );
331     switch( enc->s2k.mode ) {
332       case 0: case 1: case 4: break;
333       default: log_bug("do_symkey_enc: s2k=%d\n", enc->s2k.mode );
334     }
335     iobuf_put( a, enc->version );
336     iobuf_put( a, enc->cipher_algo );
337     iobuf_put( a, enc->s2k.mode );
338     iobuf_put( a, enc->s2k.hash_algo );
339     if( enc->s2k.mode == 1 || enc->s2k.mode == 4 ) {
340         iobuf_write(a, enc->s2k.salt, 8 );
341         if( enc->s2k.mode == 4 )
342             write_32(a, enc->s2k.count);
343     }
344     if( enc->seskeylen )
345         iobuf_write(a, enc->seskey, enc->seskeylen );
346
347     write_header(out, ctb, iobuf_get_temp_length(a) );
348     if( iobuf_write_temp( out, a ) )
349         rc = G10ERR_WRITE_FILE;
350
351     iobuf_close(a);
352     return rc;
353 }
354
355 static int
356 do_pubkey_enc( IOBUF out, int ctb, PKT_pubkey_enc *enc )
357 {
358     int rc = 0;
359     IOBUF a = iobuf_temp();
360
361     write_version( a, ctb );
362     write_32(a, enc->keyid[0] );
363     write_32(a, enc->keyid[1] );
364     iobuf_put(a,enc->pubkey_algo );
365     if( is_ELGAMAL(enc->pubkey_algo) ) {
366         mpi_write(a, enc->d.elg.a );
367         mpi_write(a, enc->d.elg.b );
368     }
369     else if( is_RSA(enc->pubkey_algo) ) {
370         mpi_write(a, enc->d.rsa.rsa_integer );
371     }
372     else {
373         rc = G10ERR_PUBKEY_ALGO;
374         goto leave;
375     }
376
377     write_header(out, ctb, iobuf_get_temp_length(a) );
378     if( iobuf_write_temp( out, a ) )
379         rc = G10ERR_WRITE_FILE;
380
381   leave:
382     iobuf_close(a);
383     return rc;
384 }
385
386
387
388
389 static u32
390 calc_plaintext( PKT_plaintext *pt )
391 {
392     return pt->len? (1 + 1 + pt->namelen + 4 + pt->len) : 0;
393 }
394
395 static int
396 do_plaintext( IOBUF out, int ctb, PKT_plaintext *pt )
397 {
398     int i, rc = 0;
399     u32 n;
400     byte buf[1000]; /* FIXME: this buffer has the plaintext! */
401     int nbytes;
402
403     write_header(out, ctb, calc_plaintext( pt ) );
404     iobuf_put(out, pt->mode );
405     iobuf_put(out, pt->namelen );
406     for(i=0; i < pt->namelen; i++ )
407         iobuf_put(out, pt->name[i] );
408     if( write_32(out, pt->timestamp ) )
409         rc = G10ERR_WRITE_FILE;
410
411     n = 0;
412     while( (nbytes=iobuf_read(pt->buf, buf, 1000)) != -1 ) {
413         if( iobuf_write(out, buf, nbytes) == -1 ) {
414             rc = G10ERR_WRITE_FILE;
415             break;
416         }
417         n += nbytes;
418     }
419     memset(buf,0,1000); /* at least burn the buffer */
420     if( !pt->len )
421         iobuf_set_block_mode(out, 0 ); /* write end marker */
422     else if( n != pt->len )
423         log_error("do_plaintext(): wrote %lu bytes but expected %lu bytes\n",
424                         (ulong)n, (ulong)pt->len );
425
426     return rc;
427 }
428
429
430
431 static int
432 do_encrypted( IOBUF out, int ctb, PKT_encrypted *ed )
433 {
434     int rc = 0;
435     u32 n;
436
437     n = ed->len ? (ed->len + 10) : 0;
438     write_header(out, ctb, n );
439
440     /* This is all. The caller has to write the real data */
441
442     return rc;
443 }
444
445 static int
446 do_compressed( IOBUF out, int ctb, PKT_compressed *cd )
447 {
448     int rc = 0;
449
450     /* we must use the old convention and don't use blockmode */
451     write_header2(out, ctb, 0, 0, 0 );
452     iobuf_put(out, cd->algorithm );
453
454     /* This is all. The caller has to write the real data */
455
456     return rc;
457 }
458
459
460 static int
461 do_signature( IOBUF out, int ctb, PKT_signature *sig )
462 {
463     int rc = 0;
464     IOBUF a = iobuf_temp();
465
466     if( !sig->version )
467         iobuf_put( a, 3 );
468     else
469         iobuf_put( a, sig->version );
470     if( sig->version < 4 )
471         iobuf_put(a, 5 ); /* constant */
472     iobuf_put(a, sig->sig_class );
473     if( sig->version < 4 ) {
474         write_32(a, sig->timestamp );
475         write_32(a, sig->keyid[0] );
476         write_32(a, sig->keyid[1] );
477     }
478     iobuf_put(a, sig->pubkey_algo );
479     iobuf_put(a, sig->digest_algo );
480     if( sig->version >= 4 ) {
481         /* fixme: write v4 subpackets here */
482         log_error("WARNING: note writing of v4 subpackets is not implemented\n");
483     }
484     iobuf_put(a, sig->digest_start[0] );
485     iobuf_put(a, sig->digest_start[1] );
486     if( is_ELGAMAL(sig->pubkey_algo) ) {
487         mpi_write(a, sig->d.elg.a );
488         mpi_write(a, sig->d.elg.b );
489     }
490     else if( sig->pubkey_algo == PUBKEY_ALGO_DSA ) {
491         mpi_write(a, sig->d.dsa.r );
492         mpi_write(a, sig->d.dsa.s );
493     }
494     else if( is_RSA(sig->pubkey_algo) ) {
495         mpi_write(a, sig->d.rsa.rsa_integer );
496     }
497     else {
498         rc = G10ERR_PUBKEY_ALGO;
499         goto leave;
500     }
501
502     write_header(out, ctb, iobuf_get_temp_length(a) );
503     if( iobuf_write_temp( out, a ) )
504         rc = G10ERR_WRITE_FILE;
505
506   leave:
507     iobuf_close(a);
508     return rc;
509 }
510
511
512 static int
513 do_onepass_sig( IOBUF out, int ctb, PKT_onepass_sig *ops )
514 {
515     int rc = 0;
516     IOBUF a = iobuf_temp();
517
518     write_version( a, ctb );
519     iobuf_put(a, ops->sig_class );
520     iobuf_put(a, ops->digest_algo );
521     iobuf_put(a, ops->pubkey_algo );
522     write_32(a, ops->keyid[0] );
523     write_32(a, ops->keyid[1] );
524     iobuf_put(a, ops->last );
525
526     write_header(out, ctb, iobuf_get_temp_length(a) );
527     if( iobuf_write_temp( out, a ) )
528         rc = G10ERR_WRITE_FILE;
529
530     iobuf_close(a);
531     return rc;
532 }
533
534
535 static int
536 write_16(IOBUF out, u16 a)
537 {
538     iobuf_put(out, a>>8);
539     if( iobuf_put(out,a) )
540         return -1;
541     return 0;
542 }
543
544 static int
545 write_32(IOBUF out, u32 a)
546 {
547     iobuf_put(out, a>> 24);
548     iobuf_put(out, a>> 16);
549     iobuf_put(out, a>> 8);
550     if( iobuf_put(out, a) )
551         return -1;
552     return 0;
553 }
554
555
556 /****************
557  * calculate the length of a header
558  */
559 static int
560 calc_header_length( u32 len )
561 {
562     if( !len )
563         return 1; /* only the ctb */
564     else if( len < 256 )
565         return 2;
566     else if( len < 65536 )
567         return 3;
568     else
569         return 5;
570 }
571
572 /****************
573  * Write the CTB and the packet length
574  */
575 static int
576 write_header( IOBUF out, int ctb, u32 len )
577 {
578     return write_header2( out, ctb, len, 0, 1 );
579 }
580
581 /****************
582  * if HDRLEN is > 0, try to build a header of this length.
583  * we need this, so that we can hash packets without reading them again.
584  */
585 static int
586 write_header2( IOBUF out, int ctb, u32 len, int hdrlen, int blkmode )
587 {
588     if( ctb & 0x40 )
589         return write_new_header( out, ctb, len, hdrlen );
590
591     if( hdrlen ) {
592         if( !len )
593             ctb |= 3;
594         else if( hdrlen == 2 && len < 256 )
595             ;
596         else if( hdrlen == 3 && len < 65536 )
597             ctb |= 1;
598         else
599             ctb |= 2;
600     }
601     else {
602         if( !len )
603             ctb |= 3;
604         else if( len < 256 )
605             ;
606         else if( len < 65536 )
607             ctb |= 1;
608         else
609             ctb |= 2;
610     }
611     if( iobuf_put(out, ctb ) )
612         return -1;
613     if( !len ) {
614         if( blkmode )
615             iobuf_set_block_mode(out, 8196 );
616     }
617     else {
618         if( ctb & 2 ) {
619             iobuf_put(out, len >> 24 );
620             iobuf_put(out, len >> 16 );
621         }
622         if( ctb & 3 )
623             iobuf_put(out, len >> 8 );
624         if( iobuf_put(out, len ) )
625             return -1;
626     }
627     return 0;
628 }
629
630
631 static int
632 write_new_header( IOBUF out, int ctb, u32 len, int hdrlen )
633 {
634     if( hdrlen )
635         log_bug("can't cope with hdrlen yet\n");
636
637     if( iobuf_put(out, ctb ) )
638         return -1;
639     if( !len ) {
640         log_bug("can't write partial headers yet\n");
641     }
642     else {
643         if( len < 192 ) {
644             if( iobuf_put(out, len ) )
645                 return -1;
646         }
647         else if( len < 8384 ) {
648             len -= 192;
649             if( iobuf_put( out, (len / 256) + 192) )
650                 return -1;
651             if( iobuf_put( out, (len % 256) )  )
652                 return -1;
653         }
654         else
655             log_bug("need a partial header to code a length %lu\n", (ulong)len);
656     }
657     return 0;
658 }
659
660 static int
661 write_version( IOBUF out, int ctb )
662 {
663     if( iobuf_put( out, 3 ) )
664         return -1;
665     return 0;
666 }
667