Moved 1.9 branch to trunk
[gnupg.git] / g10 / textfilter.c
1 /* textfilter.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2004 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <assert.h>
28
29 #include "gpg.h"
30 #include "errors.h"
31 #include "iobuf.h"
32 #include "util.h"
33 #include "filter.h"
34 #include "i18n.h"
35 #include "options.h"
36 #include "status.h"
37
38 #ifdef HAVE_DOSISH_SYSTEM
39 #define LF "\r\n"
40 #else
41 #define LF "\n"
42 #endif
43
44 #define MAX_LINELEN 19995 /* a little bit smaller than in armor.c */
45                           /* to make sure that a warning is displayed while */
46                           /* creating a message */
47
48 static unsigned
49 len_without_trailing_chars( byte *line, unsigned len, const char *trimchars )
50 {
51     byte *p, *mark;
52     unsigned n;
53
54     for(mark=NULL, p=line, n=0; n < len; n++, p++ ) {
55         if( strchr( trimchars, *p ) ) {
56             if( !mark )
57                 mark = p;
58         }
59         else
60             mark = NULL;
61     }
62
63     return mark? (mark - line) : len;
64 }
65
66
67 static int
68 standard( text_filter_context_t *tfx, IOBUF a,
69           byte *buf, size_t size, size_t *ret_len)
70 {
71     int rc=0;
72     size_t len = 0;
73     unsigned maxlen;
74
75     assert( size > 10 );
76     size -= 2;  /* reserve 2 bytes to append CR,LF */
77     while( !rc && len < size ) {
78         int lf_seen;
79
80         while( len < size && tfx->buffer_pos < tfx->buffer_len )
81             buf[len++] = tfx->buffer[tfx->buffer_pos++];
82         if( len >= size )
83             continue;
84
85         /* read the next line */
86         maxlen = MAX_LINELEN;
87         tfx->buffer_pos = 0;
88         tfx->buffer_len = iobuf_read_line( a, &tfx->buffer,
89                                            &tfx->buffer_size, &maxlen );
90         if( !maxlen )
91             tfx->truncated++;
92         if( !tfx->buffer_len ) {
93             if( !len )
94                 rc = -1; /* eof */
95             break;
96         }
97         lf_seen = tfx->buffer[tfx->buffer_len-1] == '\n';
98
99         /* The story behind this is that 2440 says that textmode
100            hashes should canonicalize line endings to CRLF and remove
101            spaces and tabs.  2440bis-12 says to just canonicalize to
102            CRLF.  1.4.0 was released using the bis-12 behavior, but it
103            was discovered that many mail clients do not canonicalize
104            PGP/MIME signature text appropriately (and were relying on
105            GnuPG to handle trailing spaces).  So, we default to the
106            2440 behavior, but use the 2440bis-12 behavior if the user
107            specifies --no-rfc2440-text.  The default will be changed
108            at some point in the future when the mail clients have been
109            upgraded.  Aside from PGP/MIME and broken mail clients,
110            this makes no difference to any signatures in the real
111            world except for a textmode detached signature.  PGP always
112            used the 2440bis-12 behavior (ignoring 2440 itself), so
113            this actually makes us compatible with PGP textmode
114            detached signatures for the first time. */
115         if(opt.rfc2440_text)
116           tfx->buffer_len=trim_trailing_chars(tfx->buffer,tfx->buffer_len,
117                                               " \t\r\n");
118         else
119           tfx->buffer_len=trim_trailing_chars(tfx->buffer,tfx->buffer_len,
120                                               "\r\n");
121
122         if( lf_seen ) {
123             tfx->buffer[tfx->buffer_len++] = '\r';
124             tfx->buffer[tfx->buffer_len++] = '\n';
125         }
126     }
127     *ret_len = len;
128     return rc;
129 }
130
131
132 /****************
133  * The filter is used to make canonical text: Lines are terminated by
134  * CR, LF, trailing white spaces are removed.
135  */
136 int
137 text_filter( void *opaque, int control,
138              IOBUF a, byte *buf, size_t *ret_len)
139 {
140     size_t size = *ret_len;
141     text_filter_context_t *tfx = opaque;
142     int rc=0;
143
144     if( control == IOBUFCTRL_UNDERFLOW ) {
145         rc = standard( tfx, a, buf, size, ret_len );
146     }
147     else if( control == IOBUFCTRL_FREE ) {
148         if( tfx->truncated )
149             log_error(_("can't handle text lines longer than %d characters\n"),
150                         MAX_LINELEN );
151         xfree( tfx->buffer );
152         tfx->buffer = NULL;
153     }
154     else if( control == IOBUFCTRL_DESC )
155         *(char**)buf = "text_filter";
156     return rc;
157 }
158
159
160 /****************
161  * Copy data from INP to OUT and do some escaping if requested.
162  * md is updated as required by rfc2440
163  */
164 int
165 copy_clearsig_text( IOBUF out, IOBUF inp, gcry_md_hd_t md,
166                     int escape_dash, int escape_from, int pgp2mode )
167 {
168     unsigned int maxlen;
169     byte *buffer = NULL;    /* malloced buffer */
170     unsigned int bufsize;   /* and size of this buffer */
171     unsigned int n;
172     int truncated = 0;
173     int pending_lf = 0;
174
175     if( !opt.pgp2_workarounds )
176         pgp2mode = 0;
177
178     if( !escape_dash )
179         escape_from = 0;
180
181     write_status (STATUS_BEGIN_SIGNING);
182
183     for(;;) {
184         maxlen = MAX_LINELEN;
185         n = iobuf_read_line( inp, &buffer, &bufsize, &maxlen );
186         if( !maxlen )
187             truncated++;
188
189         if( !n )
190             break; /* read_line has returned eof */
191
192         /* update the message digest */
193         if( escape_dash ) {
194             if( pending_lf ) {
195                 gcry_md_putc ( md, '\r' );
196                 gcry_md_putc ( md, '\n' );
197             }
198             gcry_md_write ( md, buffer,
199                             len_without_trailing_chars (buffer, n,
200                                                         pgp2mode?
201                                                         " \r\n":" \t\r\n"));
202         }
203         else
204             gcry_md_write ( md, buffer, n );
205         pending_lf = buffer[n-1] == '\n';
206
207         /* write the output */
208         if(    ( escape_dash && *buffer == '-')
209             || ( escape_from && n > 4 && !memcmp(buffer, "From ", 5 ) ) ) {
210             iobuf_put( out, '-' );
211             iobuf_put( out, ' ' );
212         }
213
214 #if  0 /*defined(HAVE_DOSISH_SYSTEM)*/
215         /* We don't use this anymore because my interpretation of rfc2440 7.1
216          * is that there is no conversion needed.  If one decides to
217          * clearsign a unix file on a DOS box he will get a mixed line endings.
218          * If at some point it turns out, that a conversion is a nice feature
219          * we can make an option out of it.
220          */
221         /* make sure the lines do end in CR,LF */
222         if( n > 1 && ( (buffer[n-2] == '\r' && buffer[n-1] == '\n' )
223                             || (buffer[n-2] == '\n' && buffer[n-1] == '\r'))) {
224             iobuf_write( out, buffer, n-2 );
225             iobuf_put( out, '\r');
226             iobuf_put( out, '\n');
227         }
228         else if( n && buffer[n-1] == '\n' ) {
229             iobuf_write( out, buffer, n-1 );
230             iobuf_put( out, '\r');
231             iobuf_put( out, '\n');
232         }
233         else
234             iobuf_write( out, buffer, n );
235
236 #else
237         iobuf_write( out, buffer, n );
238 #endif
239     }
240
241     /* at eof */
242     if( !pending_lf ) { /* make sure that the file ends with a LF */
243         iobuf_writestr( out, LF );
244         if( !escape_dash )
245             gcry_md_putc( md, '\n' );
246     }
247
248     if( truncated )
249         log_info(_("input line longer than %d characters\n"), MAX_LINELEN );
250
251     return 0; /* okay */
252 }