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