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