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