ea8a875ad60dbcff231e24a479cabc12ab73d20a
[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_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   #if 0
215     FILE *fp = fopen("dump.pkc", "a");
216     int i=0;
217
218     fprintf(fp, "\nHashing PKC:\n");
219   #endif
220
221     /* build the packet */
222     init_packet(&pkt);
223     pkt.pkttype = PKT_PUBLIC_CERT;
224     pkt.pkt.public_cert = pkc;
225     if( (rc = build_packet( a, &pkt )) )
226         log_fatal("build public_cert for hashing failed: %s\n", g10_errstr(rc));
227     while( (c=iobuf_get(a)) != -1 ) {
228       #if 0
229         fprintf( fp," %02x", c );
230         if( (++i == 24) ) {
231             putc('\n', fp);
232             i=0;
233         }
234       #endif
235         md_putc( md, c );
236     }
237   #if 0
238     putc('\n', fp);
239     fclose(fp);
240   #endif
241     iobuf_cancel(a);
242 }
243
244
245 static int
246 do_secret_cert( IOBUF out, int ctb, PKT_secret_cert *skc )
247 {
248     int rc = 0;
249     IOBUF a = iobuf_temp();
250
251     if( !skc->version )
252         iobuf_put( a, 3 );
253     else
254         iobuf_put( a, skc->version );
255     write_32(a, skc->timestamp );
256     write_16(a, skc->valid_days );
257     iobuf_put(a, skc->pubkey_algo );
258     if( skc->pubkey_algo == PUBKEY_ALGO_ELGAMAL ) {
259         mpi_write(a, skc->d.elg.p );
260         mpi_write(a, skc->d.elg.g );
261         mpi_write(a, skc->d.elg.y );
262         if( skc->d.elg.is_protected ) {
263             iobuf_put(a, 0xff );
264             iobuf_put(a, skc->d.elg.protect.algo );
265             iobuf_put(a, skc->d.elg.protect.s2k );
266             iobuf_put(a, skc->d.elg.protect.hash );
267             if( skc->d.elg.protect.s2k == 1
268                 || skc->d.elg.protect.s2k == 3 )
269                 iobuf_write(a, skc->d.elg.protect.salt, 8 );
270             if( skc->d.elg.protect.s2k == 3 )
271                 iobuf_put(a, skc->d.elg.protect.count );
272             iobuf_write(a, skc->d.elg.protect.iv, 8 );
273         }
274         else
275             iobuf_put(a, 0 );
276
277         mpi_write(a, skc->d.elg.x );
278         write_16(a, skc->d.elg.csum );
279     }
280     else if( skc->pubkey_algo == PUBKEY_ALGO_RSA ) {
281         mpi_write(a, skc->d.rsa.rsa_n );
282         mpi_write(a, skc->d.rsa.rsa_e );
283         if( skc->d.rsa.is_protected ) {
284             assert( skc->d.rsa.protect_algo == CIPHER_ALGO_BLOWFISH );
285             iobuf_put(a, skc->d.rsa.protect_algo );
286             iobuf_write(a, skc->d.rsa.protect.blowfish.iv, 8 );
287         }
288         else
289             iobuf_put(a, 0 );
290         mpi_write(a, skc->d.rsa.rsa_d );
291         mpi_write(a, skc->d.rsa.rsa_p );
292         mpi_write(a, skc->d.rsa.rsa_q );
293         mpi_write(a, skc->d.rsa.rsa_u );
294         write_16(a, skc->d.rsa.csum );
295     }
296     else {
297         rc = G10ERR_PUBKEY_ALGO;
298         goto leave;
299     }
300
301     write_header2(out, ctb, iobuf_get_temp_length(a), skc->hdrbytes, 1 );
302     if( iobuf_write_temp( out, a ) )
303         rc = G10ERR_WRITE_FILE;
304
305   leave:
306     iobuf_close(a);
307     return rc;
308 }
309
310 static int
311 do_pubkey_enc( IOBUF out, int ctb, PKT_pubkey_enc *enc )
312 {
313     int rc = 0;
314     IOBUF a = iobuf_temp();
315
316     write_version( a, ctb );
317     write_32(a, enc->keyid[0] );
318     write_32(a, enc->keyid[1] );
319     iobuf_put(a,enc->pubkey_algo );
320     if( enc->pubkey_algo == PUBKEY_ALGO_ELGAMAL ) {
321         mpi_write(a, enc->d.elg.a );
322         mpi_write(a, enc->d.elg.b );
323     }
324     else if( enc->pubkey_algo == PUBKEY_ALGO_RSA ) {
325         mpi_write(a, enc->d.rsa.rsa_integer );
326     }
327     else {
328         rc = G10ERR_PUBKEY_ALGO;
329         goto leave;
330     }
331
332     write_header(out, ctb, iobuf_get_temp_length(a) );
333     if( iobuf_write_temp( out, a ) )
334         rc = G10ERR_WRITE_FILE;
335
336   leave:
337     iobuf_close(a);
338     return rc;
339 }
340
341
342
343
344
345 static u32
346 calc_plaintext( PKT_plaintext *pt )
347 {
348     return pt->len? (1 + 1 + pt->namelen + 4 + pt->len) : 0;
349 }
350
351 static int
352 do_plaintext( IOBUF out, int ctb, PKT_plaintext *pt )
353 {
354     int c, i, rc = 0;
355     u32 n;
356
357     write_header(out, ctb, calc_plaintext( pt ) );
358     iobuf_put(out, pt->mode );
359     iobuf_put(out, pt->namelen );
360     for(i=0; i < pt->namelen; i++ )
361         iobuf_put(out, pt->name[i] );
362     if( write_32(out, pt->timestamp ) )
363         rc = G10ERR_WRITE_FILE;
364
365     n = 0;
366     while( (c=iobuf_get(pt->buf)) != -1 ) {
367         if( iobuf_put(out, c) ) {
368             rc = G10ERR_WRITE_FILE;
369             break;
370         }
371         n++;
372     }
373     if( !pt->len )
374         iobuf_set_block_mode(out, 0 ); /* write end marker */
375     else if( n != pt->len )
376         log_error("do_plaintext(): wrote %lu bytes but expected %lu bytes\n",
377                         (ulong)n, (ulong)pt->len );
378
379     return rc;
380 }
381
382
383
384 static int
385 do_encrypted( IOBUF out, int ctb, PKT_encrypted *ed )
386 {
387     int rc = 0;
388     u32 n;
389
390     n = ed->len ? (ed->len + 10) : 0;
391     write_header(out, ctb, n );
392
393     /* This is all. The caller has to write the real data */
394
395     return rc;
396 }
397
398 static int
399 do_compressed( IOBUF out, int ctb, PKT_compressed *cd )
400 {
401     int rc = 0;
402
403     /* we must use the old convention and don't use blockmode */
404     write_header2(out, ctb, 0, 0, 0 );
405     iobuf_put(out, cd->algorithm );
406
407     /* This is all. The caller has to write the real data */
408
409     return rc;
410 }
411
412
413 static int
414 do_signature( IOBUF out, int ctb, PKT_signature *sig )
415 {
416     int rc = 0;
417     IOBUF a = iobuf_temp();
418
419     write_version( a, ctb );
420     iobuf_put(a, 5 ); /* constant */
421     iobuf_put(a, sig->sig_class );
422     write_32(a, sig->timestamp );
423     write_32(a, sig->keyid[0] );
424     write_32(a, sig->keyid[1] );
425     iobuf_put(a, sig->pubkey_algo );
426     if( sig->pubkey_algo == PUBKEY_ALGO_ELGAMAL ) {
427         iobuf_put(a, sig->d.elg.digest_algo );
428         iobuf_put(a, sig->d.elg.digest_start[0] );
429         iobuf_put(a, sig->d.elg.digest_start[1] );
430         mpi_write(a, sig->d.elg.a );
431         mpi_write(a, sig->d.elg.b );
432     }
433     else if( sig->pubkey_algo == PUBKEY_ALGO_RSA ) {
434         iobuf_put(a, sig->d.rsa.digest_algo );
435         iobuf_put(a, sig->d.rsa.digest_start[0] );
436         iobuf_put(a, sig->d.rsa.digest_start[1] );
437         mpi_write(a, sig->d.rsa.rsa_integer );
438     }
439     else {
440         rc = G10ERR_PUBKEY_ALGO;
441         goto leave;
442     }
443
444     write_header(out, ctb, iobuf_get_temp_length(a) );
445     if( iobuf_write_temp( out, a ) )
446         rc = G10ERR_WRITE_FILE;
447
448   leave:
449     iobuf_close(a);
450     return rc;
451 }
452
453
454 static int
455 do_onepass_sig( IOBUF out, int ctb, PKT_onepass_sig *ops )
456 {
457     int rc = 0;
458     IOBUF a = iobuf_temp();
459
460     write_version( a, ctb );
461     iobuf_put(a, ops->sig_class );
462     iobuf_put(a, ops->digest_algo );
463     iobuf_put(a, ops->pubkey_algo );
464     write_32(a, ops->keyid[0] );
465     write_32(a, ops->keyid[1] );
466     iobuf_put(a, ops->last );
467
468     write_header(out, ctb, iobuf_get_temp_length(a) );
469     if( iobuf_write_temp( out, a ) )
470         rc = G10ERR_WRITE_FILE;
471
472     iobuf_close(a);
473     return rc;
474 }
475
476
477 static int
478 write_16(IOBUF out, u16 a)
479 {
480     iobuf_put(out, a>>8);
481     if( iobuf_put(out,a) )
482         return -1;
483     return 0;
484 }
485
486 static int
487 write_32(IOBUF out, u32 a)
488 {
489     iobuf_put(out, a>> 24);
490     iobuf_put(out, a>> 16);
491     iobuf_put(out, a>> 8);
492     if( iobuf_put(out, a) )
493         return -1;
494     return 0;
495 }
496
497
498 /****************
499  * calculate the length of a header
500  */
501 static int
502 calc_header_length( u32 len )
503 {
504     if( !len )
505         return 1; /* only the ctb */
506     else if( len < 256 )
507         return 2;
508     else if( len < 65536 )
509         return 3;
510     else
511         return 5;
512 }
513
514 /****************
515  * Write the CTB and the packet length
516  */
517 static int
518 write_header( IOBUF out, int ctb, u32 len )
519 {
520     return write_header2( out, ctb, len, 0, 1 );
521 }
522
523 /****************
524  * if HDRLEN is > 0, try to build a header of this length.
525  * we need this, so hat we can hash packets without reading them again.
526  */
527 static int
528 write_header2( IOBUF out, int ctb, u32 len, int hdrlen, int blkmode )
529 {
530     if( ctb & 0x40 )
531         return write_new_header( out, ctb, len, hdrlen );
532
533     if( hdrlen ) {
534         if( !len )
535             ctb |= 3;
536         else if( hdrlen == 2 && len < 256 )
537             ;
538         else if( hdrlen == 3 && len < 65536 )
539             ctb |= 1;
540         else
541             ctb |= 2;
542     }
543     else {
544         if( !len )
545             ctb |= 3;
546         else if( len < 256 )
547             ;
548         else if( len < 65536 )
549             ctb |= 1;
550         else
551             ctb |= 2;
552     }
553     if( iobuf_put(out, ctb ) )
554         return -1;
555     if( !len ) {
556         if( blkmode )
557             iobuf_set_block_mode(out, 8196 );
558     }
559     else {
560         if( ctb & 2 ) {
561             iobuf_put(out, len >> 24 );
562             iobuf_put(out, len >> 16 );
563         }
564         if( ctb & 3 )
565             iobuf_put(out, len >> 8 );
566         if( iobuf_put(out, len ) )
567             return -1;
568     }
569     return 0;
570 }
571
572
573 static int
574 write_new_header( IOBUF out, int ctb, u32 len, int hdrlen )
575 {
576     if( hdrlen )
577         log_bug("can't cope with hdrlen yet\n");
578
579     if( iobuf_put(out, ctb ) )
580         return -1;
581     if( !len ) {
582         log_bug("can't write partial headers yet\n");
583     }
584     else {
585         if( len < 192 ) {
586             if( iobuf_put(out, len ) )
587                 return -1;
588         }
589         else if( len < 8384 ) {
590             len -= 192;
591             if( iobuf_put( out, (len / 256) + 192) )
592                 return -1;
593             if( iobuf_put( out, (len % 256) )  )
594                 return -1;
595         }
596         else
597             log_bug("need a partial header to code a length %lu\n", (ulong)len);
598     }
599     return 0;
600 }
601
602 static int
603 write_version( IOBUF out, int ctb )
604 {
605     if( iobuf_put( out, 3 ) )
606         return -1;
607     return 0;
608 }
609