Sylvester Version
[gnupg.git] / g10 / armor.c
1 /* armor.c - Armor filter
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 <errno.h>
26 #include <assert.h>
27
28 #include "errors.h"
29 #include "iobuf.h"
30 #include "memory.h"
31 #include "util.h"
32 #include "filter.h"
33 #include "packet.h"
34 #include "options.h"
35
36
37
38
39 #define CRCINIT 0xB704CE
40 #define CRCPOLY 0X864CFB
41 #define CRCUPDATE(a,c) do {                                                 \
42                         a = ((a) << 8) ^ crc_table[((a)&0xff >> 16) ^ (c)]; \
43                         a &= 0x00ffffff;                                    \
44                     } while(0)
45 static u32 crc_table[256];
46 static byte bintoasc[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
47                          "abcdefghijklmnopqrstuvwxyz"
48                          "0123456789+/";
49 static byte asctobin[256]; /* runtime initialized */
50 static int is_initialized;
51
52 typedef enum {
53     fhdrINIT=0,
54     fhdrLF,
55     fhdrWAIT,
56     fhdrWAITINFO,
57     fhdrWAITCLEARSIG,
58     fhdrDASH,
59     fhdrHEAD,
60     fhdrDASH2,
61     fhdrINFO
62 } fhdr_state_t;
63
64 struct fhdr_struct {
65     fhdr_state_t state;
66     int count;
67     int hdr_line; /* number of the header line */
68     char buf[256];
69 };
70
71
72 /* if we encounter this armor string with this index, go
73  * into a mode, which fakes packets and wait for the next armor */
74 #define BEGIN_SIGNED_MSG_IDX 3
75 static char *head_strings[] = {
76     "BEGIN PGP MESSAGE",
77     "BEGIN PGP PUBLIC KEY BLOCK",
78     "BEGIN PGP SIGNATURE",
79     "BEGIN PGP SIGNED MESSAGE",
80     NULL
81 };
82 static char *tail_strings[] = {
83     "END PGP MESSAGE",
84     "END PGP PUBLIC KEY BLOCK",
85     "END PGP SIGNATURE",
86     NULL
87 };
88
89
90 static void
91 initialize(void)
92 {
93     int i, j;
94     u32 t;
95     byte *s;
96
97     /* init the crc lookup table */
98     crc_table[0] = 0;
99     for(i=j=0; j < 128; j++ ) {
100         t = crc_table[j];
101         if( t & 0x00800000 ) {
102             t <<= 1;
103             crc_table[i++] = t ^ CRCPOLY;
104             crc_table[i++] = t;
105         }
106         else {
107             t <<= 1;
108             crc_table[i++] = t;
109             crc_table[i++] = t ^ CRCPOLY;
110         }
111     }
112     /* build the helptable for radix64 to bin conversion */
113     for(i=0; i < 256; i++ )
114         asctobin[i] = 255; /* used to detect invalid characters */
115     for(s=bintoasc,i=0; *s; s++,i++ )
116         asctobin[*s] = i;
117
118     is_initialized=1;
119 }
120
121 /****************
122  * Check wether this is a armored file or not
123  * See also parse-packet.c for details on this code
124  * Returns: True if it seems to be armored
125  */
126 static int
127 is_armored( byte *buf, size_t len )
128 {
129     int ctb, pkttype;
130
131     if( len < 28 )
132         return 0; /* not even enough space for the "---BEGIN"... */
133
134     ctb = *buf;
135     if( !(ctb & 0x80) )
136         return 1; /* invalid packet: assume it is armored */
137     pkttype =  ctb & 0x40 ? (ctb & 0x3f) : ((ctb>>2)&0xf);
138     /*lenbytes = (ctb & 0x40) || ((ctb&3)==3)? 0 : (1<<(ctb & 3));*/
139     switch( pkttype ) {
140       case PKT_PUBLIC_CERT:
141       case PKT_SECRET_CERT:
142       case PKT_PUBKEY_ENC:
143       case PKT_SIGNATURE:
144       case PKT_COMMENT:
145       case PKT_PLAINTEXT:
146       case PKT_COMPRESSED:
147       case PKT_ENCRYPTED:
148         return 0; /* seems to be a regular packet: not armored */
149     }
150
151     return 1;
152 }
153
154
155
156
157 static int
158 find_header( struct fhdr_struct *fhdr, int c )
159 {
160     int i;
161     const char *s;
162
163     if( c == '\n' ) {
164         switch( fhdr->state ) {
165           case fhdrINFO:
166             if( !fhdr->count )
167                 return 1;   /* blank line: data starts with the next line */
168             fhdr->buf[fhdr->count] = 0;
169             log_debug("armor line: '%s'\n", fhdr->buf );
170             /* fall through */
171           case fhdrWAITINFO:
172             fhdr->state = fhdrINFO;
173             fhdr->count = 0;
174             break;
175           case fhdrWAITCLEARSIG:
176             if( fhdr->count++ == 1 ) /* skip the empty line */
177                 return 1; /* clear signed text follows */
178             else if( fhdr->count > 1 )
179                 fhdr->state = fhdrWAIT; /* was not valid */
180             break;
181           default:
182             fhdr->state = fhdrLF;
183             break;
184         }
185     }
186     else {
187         switch( fhdr->state ) {
188           case fhdrINIT:
189           case fhdrLF:
190             if( c == '-' ) {
191                 fhdr->state = fhdrDASH;
192                 fhdr->count = 1;
193             }
194             else
195                 fhdr->state = fhdrWAIT;
196             break;
197           case fhdrWAIT:
198           case fhdrWAITINFO:
199           case fhdrWAITCLEARSIG:
200             break;
201           case fhdrDASH:
202             if( c == '-' ) {
203                 if( ++fhdr->count == 5 ) {
204                     fhdr->state = fhdrHEAD;
205                     fhdr->count = 0;
206                 }
207             }
208             else
209                 fhdr->state = fhdrWAIT;
210             break;
211           case fhdrHEAD:
212             if( c != '-' ) {
213                 if( fhdr->count < DIM(fhdr->buf)-1 )
214                     fhdr->buf[fhdr->count++] = c;
215             }
216             else {
217                 fhdr->buf[fhdr->count] = 0;
218                 for(i=0; (s=head_strings[i]); i++ )
219                     if( !strcmp(s,fhdr->buf) )
220                         break;
221                 if( s ) { /* found string; wait for trailing dashes */
222                     fhdr->hdr_line = i;
223                     fhdr->state = fhdrDASH2;
224                     fhdr->count = 1;
225                 }
226                 else
227                     fhdr->state = fhdrWAIT;
228             }
229             break;
230
231           case fhdrDASH2:
232             if( c == '-' ) {
233                 if( ++fhdr->count == 5 ) {
234                     fhdr->state = fhdrWAITINFO;
235                     log_debug("armor head: '%s'\n",
236                                         head_strings[fhdr->hdr_line]);
237                     fhdr->state = fhdr->hdr_line == BEGIN_SIGNED_MSG_IDX
238                                    ? fhdrWAITCLEARSIG : fhdrWAITINFO;
239                     if( fhdr->state == fhdrWAITCLEARSIG )
240                         fhdr->count = 0;
241                 }
242             }
243             else
244                 fhdr->state = fhdrWAIT;
245             break;
246
247           case fhdrINFO:
248             if( fhdr->count < DIM(fhdr->buf)-1 )
249                 fhdr->buf[fhdr->count++] = c;
250             break;
251
252           default: abort();
253         }
254     }
255     return 0;
256 }
257
258 /****************
259  * check wether the trailer is okay.
260  * Returns: 0 := still in trailer
261  *          -1 := Okay
262  *          1 := Error in trailer
263  */
264 static int
265 check_trailer( struct fhdr_struct *fhdr, int c )
266 {
267     return -1;
268     /* FIXME: implement this ! */
269 }
270
271
272 /* figure out wether the data is armored or not */
273 static int
274 check_input( armor_filter_context_t *afx, IOBUF a )
275 {
276     int rc = 0;
277     int c;
278     size_t n = 0, nn=0, nn_limit=0;
279     struct fhdr_struct fhdr;
280
281     assert( DIM(afx->helpbuf) >= 50 );
282     memset( &fhdr, 0, sizeof(fhdr) );
283
284     /* read a couple of bytes */
285     for( n=0; n < DIM(afx->helpbuf); n++ ) {
286         if( (c=iobuf_get(a)) == -1 )
287             break;
288         afx->helpbuf[n] = c & 0xff;
289     }
290
291     if( !n )
292         rc = -1;
293     else if( is_armored( afx->helpbuf, n ) ) {
294         for(nn=0; nn < n; nn++ )
295             if( find_header( &fhdr, afx->helpbuf[nn] ) )
296                 break;
297         if( nn == n ) { /* continue read */
298             while( (c=iobuf_get(a)) != -1 )
299                 if( find_header( &fhdr, c ) )
300                     break;
301             if( c == -1 )
302                 rc = -1; /* eof */
303         }
304         if( !rc && fhdr.hdr_line == BEGIN_SIGNED_MSG_IDX ) {
305             /* start fake package mode (for clear signatures) */
306             nn++;
307             afx->helplen = n;
308             afx->helpidx = nn;
309             afx->templen = 0;
310             afx->tempidx = 0;
311             afx->fake = m_alloc_clear( sizeof(struct fhdr_struct) );
312         }
313         else if( !rc ) {
314             /* next byte to read or helpbuf[nn+1]
315              * is the first rad64 byte */
316             nn++;
317             afx->inp_checked = 1;
318             afx->crc = CRCINIT;
319             afx->idx = 0;
320             afx->radbuf[0] = 0;
321             afx->helplen = n;
322             afx->helpidx = nn;
323         }
324     }
325     else {
326         afx->inp_checked = 1;
327         afx->inp_bypass = 1;
328     }
329
330     return rc;
331 }
332
333
334
335 /* fake a literal data packet and wait for an armor line */
336 static int
337 fake_packet( armor_filter_context_t *afx, IOBUF a,
338              size_t *retn, byte *buf, size_t size  )
339 {
340     int rc = 0;
341     int c;
342     size_t n = 0, nn=0, nn_limit=0;
343     struct fhdr_struct *fhdr = afx->fake;
344     byte *helpbuf = afx->helpbuf;
345     int helpidx = afx->helpidx;
346     int helplen = afx->helplen;
347     byte *tempbuf = afx->tempbuf;
348     int tempidx = afx->tempidx;
349     int templen = afx->templen;
350     int defer=1;
351
352     /* FIXME: have to read one ahead or do some other mimic to
353      * get rid of the lf before the "begin signed message"
354      */
355     size = 100; /* FIXME: only used for testing (remove it)  */
356     n = 2; /* reserve 2 bytes for the length header */
357     while( n < size-2 ) { /* and 2 for the term header */
358         if( templen && (fhdr->state == fhdrWAIT || fhdr->state == fhdrLF) ) {
359             if( tempidx < templen ) {
360                 buf[n++] = tempbuf[tempidx++];
361                 continue;
362             }
363             tempidx = templen = 0;
364         }
365
366         if( helpidx < helplen )
367             c = helpbuf[helpidx++];
368         else if( (c=iobuf_get(a)) == -1 )
369             break;
370         if( find_header( fhdr, c ) ) {
371             m_free(afx->fake);
372             afx->fake = NULL;
373             afx->inp_checked = 1;
374             afx->crc = CRCINIT;
375             afx->idx = 0;
376             afx->radbuf[0] = 0;
377             /* we don't need to care about the tempbuf */
378             break;
379         }
380         if( fhdr->state == fhdrWAIT || fhdr->state == fhdrLF ) {
381             if( templen ) {
382                 tempidx = 0;
383                 continue;
384             }
385             buf[n++] = c;
386         }
387         else if( fhdr->state == fhdrWAITINFO
388                 || fhdr->state == fhdrINFO )
389             ;
390         else { /* store it in another temp. buf */
391             assert( templen < DIM(afx->tempbuf) );
392             tempbuf[templen++] = c;
393         }
394     }
395     buf[0] = (n-2) >> 8;
396     buf[1] = (n-2);
397     if( !afx->fake ) { /* write last (ending) length header */
398         buf[n++] = 0;
399         buf[n++] = 0;
400     }
401
402     afx->helpidx = helpidx;
403     afx->helplen = helplen;
404     afx->tempidx = tempidx;
405     afx->templen = templen;
406     *retn = n;
407     return rc;
408 }
409
410
411
412 static int
413 radix64_read( armor_filter_context_t *afx, IOBUF a, size_t *retn,
414               byte *buf, size_t size )
415 {
416     byte val;
417     int c, c2;
418     int checkcrc=0;
419     int rc = 0;
420     size_t n = 0, nn=0;
421     int  idx, i;
422     u32 crc;
423
424     crc = afx->crc;
425     idx = afx->idx;
426     val = afx->radbuf[0];
427     for( n=0; n < size; ) {
428         if( afx->helpidx < afx->helplen )
429             c = afx->helpbuf[afx->helpidx++];
430         else if( (c=iobuf_get(a)) == -1 )
431             break;
432         if( c == '\n' || c == ' ' || c == '\r' || c == '\t' )
433             continue;
434         else if( c == '=' ) { /* pad character: stop */
435             if( idx == 1 )
436                 buf[n++] = val;
437             checkcrc++;
438             break;
439         }
440         else if( (c = asctobin[(c2=c)]) == 255 ) {
441             log_error("invalid radix64 character %02x skipped\n", c2);
442             continue;
443         }
444         switch(idx) {
445           case 0: val =  c << 2; break;
446           case 1: val |= (c>>4)&3; buf[n++]=val;val=(c<<4)&0xf0;break;
447           case 2: val |= (c>>2)&15; buf[n++]=val;val=(c<<6)&0xc0;break;
448           case 3: val |= c&0x3f; buf[n++] = val; break;
449         }
450         idx = (idx+1) % 4;
451     }
452     for(i=0; i < n; i++ )
453         crc = (crc << 8) ^ crc_table[(crc >> 16)&0xff ^ buf[i]];
454     crc &= 0x00ffffff;
455     afx->crc = crc;
456     afx->idx = idx;
457     afx->radbuf[0] = val;
458     if( checkcrc ) {
459         afx->inp_eof = 1; /*assume eof */
460         for(;;) { /* skip lf and pad characters */
461             if( afx->helpidx < afx->helplen )
462                 c = afx->helpbuf[afx->helpidx++];
463             else if( (c=iobuf_get(a)) == -1 )
464                 break;
465             if( c == '\n' || c == ' ' || c == '\r'
466                 || c == '\t' || c == '=' )
467                 continue;
468             break;
469         }
470         if( c == -1 )
471             log_error("premature eof (no CRC)\n");
472         else {
473             u32 mycrc = 0;
474             idx = 0;
475             do {
476                 if( (c = asctobin[c]) == 255 )
477                     break;
478                 switch(idx) {
479                   case 0: val =  c << 2; break;
480                   case 1: val |= (c>>4)&3; mycrc |= val << 16;val=(c<<4)&0xf0;break;
481                   case 2: val |= (c>>2)&15; mycrc |= val << 8;val=(c<<6)&0xc0;break;
482                   case 3: val |= c&0x3f; mycrc |= val; break;
483                 }
484                 if( afx->helpidx < afx->helplen )
485                     c = afx->helpbuf[afx->helpidx++];
486                 else if( (c=iobuf_get(a)) == -1 )
487                     break;
488             } while( ++idx < 4 );
489             if( c == -1 )
490                 log_error("premature eof (in CRC)\n");
491             else if( idx != 4 )
492                 log_error("malformed CRC\n");
493             else if( mycrc != afx->crc )
494                 log_error("CRC error; %06lx - %06lx\n",
495                                     (ulong)afx->crc, (ulong)mycrc);
496             else {
497                 struct fhdr_struct fhdr;
498
499                 memset( &fhdr, 0, sizeof(fhdr) );
500                 for(rc=0;!rc;) {
501                     rc = check_trailer( &fhdr, c );
502                     if( !rc ) {
503                         if( afx->helpidx < afx->helplen )
504                             c = afx->helpbuf[afx->helpidx++];
505                         else if( (c=iobuf_get(a)) == -1 )
506                             rc = 2;
507                     }
508                 }
509                 if( rc == -1 )
510                     rc = 0;
511                 else if( rc == 2 )
512                     log_error("premature eof (in Trailer)\n");
513                 else
514                     log_error("error in trailer line\n");
515             }
516         }
517     }
518
519     if( !n )
520         rc = -1;
521
522     *retn = n;
523     return rc;
524 }
525
526
527 /****************
528  * The filter is used to handle the armor stuff
529  */
530 int
531 armor_filter( void *opaque, int control,
532              IOBUF a, byte *buf, size_t *ret_len)
533 {
534     size_t size = *ret_len;
535     armor_filter_context_t *afx = opaque;
536     int rc=0, i, c, c2;
537     byte radbuf[3];
538     int  idx, idx2;
539     size_t n=0;
540     u32 crc;
541
542     if( DBG_FILTER )
543         log_debug("armor-filter: control: %d\n", control );
544     if( control == IOBUFCTRL_UNDERFLOW && afx->inp_bypass ) {
545         for( n=0; n < size; n++ ) {
546             if( (c=iobuf_get(a)) == -1 )
547                 break;
548             buf[n] = c & 0xff;
549         }
550         if( !n )
551             rc = -1;
552         *ret_len = n;
553     }
554     else if( control == IOBUFCTRL_UNDERFLOW ) {
555         if( size < 20 )
556             log_bug(NULL); /* supplied buffer maybe too short */
557
558         if( afx->inp_eof ) {
559             *ret_len = 0;
560             if( DBG_FILTER )
561                 log_debug("armor-filter: eof due to inp_eof flag\n" );
562             return -1;
563         }
564
565         if( afx->fake )
566             rc = fake_packet( afx, a, &n, buf, size );
567         else if( !afx->inp_checked ) {
568             rc = check_input( afx, a );
569             if( afx->inp_bypass )
570                 ;
571             else if( afx->fake ) {
572                 /* the buffer is at least 20 bytes long, so it
573                  * is easy to construct a packet */
574                 buf[0] = 0xaf; /* old packet format, type 11, var length */
575                 buf[1] = 0;    /* set the length header */
576                 buf[2] = 6;
577                 buf[3] = 't';  /* canonical text */
578                 buf[4] = 0;    /* namelength */
579                 buf[5] = buf[6] = buf[7] = buf[8] = 0; /* timestamp */
580                 n = 9;
581             }
582             else if( !rc )
583                 rc = radix64_read( afx, a, &n, buf, size );
584         }
585         else
586             rc = radix64_read( afx, a, &n, buf, size );
587
588         *ret_len = n;
589     }
590     else if( control == IOBUFCTRL_FLUSH ) {
591         if( !afx->status ) { /* write the header line */
592             if( afx->what >= DIM(head_strings) )
593                 log_bug("afx->what=%d", afx->what);
594             iobuf_writestr(a, "-----");
595             iobuf_writestr(a, head_strings[afx->what] );
596             iobuf_writestr(a, "-----\n");
597             iobuf_writestr(a, "Version: G10 pre-release "  VERSION "\n");
598             iobuf_writestr(a, "Comment: This is a alpha test version!\n\n");
599             afx->status++;
600             afx->idx = 0;
601             afx->idx2 = 0;
602             afx->crc = CRCINIT;
603         }
604         crc = afx->crc;
605         idx = afx->idx;
606         idx2 = afx->idx2;
607         for(i=0; i < idx; i++ )
608             radbuf[i] = afx->radbuf[i];
609
610         for(i=0; i < size; i++ )
611             crc = (crc << 8) ^ crc_table[(crc >> 16)&0xff ^ buf[i]];
612         crc &= 0x00ffffff;
613
614         for( ; size; buf++, size-- ) {
615             radbuf[idx++] = *buf;
616             if( idx > 2 ) {
617                 idx = 0;
618                 c = bintoasc[(*radbuf >> 2) & 077];
619                 iobuf_put(a, c);
620                 c = bintoasc[(((*radbuf<<4)&060)|((radbuf[1] >> 4)&017))&077];
621                 iobuf_put(a, c);
622                 c = bintoasc[(((radbuf[1]<<2)&074)|((radbuf[2]>>6)&03))&077];
623                 iobuf_put(a, c);
624                 c = bintoasc[radbuf[2]&077];
625                 iobuf_put(a, c);
626                 if( ++idx2 > (72/4) ) {
627                     iobuf_put(a, '\n');
628                     idx2=0;
629                 }
630             }
631         }
632         for(i=0; i < idx; i++ )
633             afx->radbuf[i] = radbuf[i];
634         afx->idx = idx;
635         afx->idx2 = idx2;
636         afx->crc  = crc;
637     }
638     else if( control == IOBUFCTRL_INIT ) {
639         if( !is_initialized )
640             initialize();
641     }
642     else if( control == IOBUFCTRL_FREE ) {
643         if( afx->status ) { /* pad, write cecksum, and bottom line */
644             crc = afx->crc;
645             idx = afx->idx;
646             idx2 = afx->idx2;
647             for(i=0; i < idx; i++ )
648                 radbuf[i] = afx->radbuf[i];
649             if( idx ) {
650                 c = bintoasc[(*radbuf>>2)&077];
651                 iobuf_put(a, c);
652                 if( idx == 1 ) {
653                     c = bintoasc[((*radbuf << 4) & 060) & 077];
654                     iobuf_put(a, c);
655                     iobuf_put(a, '=');
656                     iobuf_put(a, '=');
657                 }
658                 else { /* 2 */
659                     c = bintoasc[(((*radbuf<<4)&060)|((radbuf[1]>>4)&017))&077];
660                     iobuf_put(a, c);
661                     c = bintoasc[((radbuf[1] << 2) & 074) & 077];
662                     iobuf_put(a, c);
663                     iobuf_put(a, '=');
664                 }
665                 ++idx2;
666             }
667             /* may need a linefeed */
668             if( idx2 < (72/4) )
669                 iobuf_put(a, '\n');
670             /* write the CRC */
671             iobuf_put(a, '=');
672             radbuf[0] = crc >>16;
673             radbuf[1] = crc >> 8;
674             radbuf[2] = crc;
675             c = bintoasc[(*radbuf >> 2) & 077];
676             iobuf_put(a, c);
677             c = bintoasc[(((*radbuf<<4)&060)|((radbuf[1] >> 4)&017))&077];
678             iobuf_put(a, c);
679             c = bintoasc[(((radbuf[1]<<2)&074)|((radbuf[2]>>6)&03))&077];
680             iobuf_put(a, c);
681             c = bintoasc[radbuf[2]&077];
682             iobuf_put(a, c);
683             iobuf_put(a, '\n');
684             /* and the the trailer */
685             if( afx->what >= DIM(tail_strings) )
686                 log_bug("afx->what=%d", afx->what);
687             iobuf_writestr(a, "-----");
688             iobuf_writestr(a, tail_strings[afx->what] );
689             iobuf_writestr(a, "-----\n");
690         }
691     }
692     else if( control == IOBUFCTRL_DESC )
693         *(char**)buf = "armor_filter";
694     return rc;
695 }
696