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