/
istream-header-filter.c
623 lines (535 loc) · 17.4 KB
/
istream-header-filter.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
/* Copyright (c) 2003-2016 Dovecot authors, see the included COPYING file */
#include "lib.h"
#include "array.h"
#include "message-parser.h"
#include "istream-private.h"
#include "istream-header-filter.h"
struct header_filter_istream {
struct istream_private istream;
pool_t pool;
struct message_header_parser_ctx *hdr_ctx;
const char **headers;
unsigned int headers_count;
header_filter_callback *callback;
void *context;
buffer_t *hdr_buf;
struct message_size header_size;
uoff_t skip_count;
uoff_t last_lf_offset;
unsigned int cur_line, parsed_lines;
ARRAY(unsigned int) match_change_lines;
unsigned int header_read:1;
unsigned int seen_eoh:1;
unsigned int header_parsed:1;
unsigned int headers_edited:1;
unsigned int exclude:1;
unsigned int crlf:1;
unsigned int crlf_preserve:1;
unsigned int hide_body:1;
unsigned int add_missing_eoh:1;
unsigned int end_body_with_lf:1;
unsigned int last_lf_added:1;
unsigned int eoh_not_matched:1;
unsigned int prev_matched:1;
};
header_filter_callback *null_header_filter_callback = NULL;
static ssize_t i_stream_header_filter_read(struct istream_private *stream);
static void i_stream_header_filter_destroy(struct iostream_private *stream)
{
struct header_filter_istream *mstream =
(struct header_filter_istream *)stream;
if (mstream->hdr_ctx != NULL)
message_parse_header_deinit(&mstream->hdr_ctx);
i_stream_unref(&mstream->istream.parent);
if (array_is_created(&mstream->match_change_lines))
array_free(&mstream->match_change_lines);
pool_unref(&mstream->pool);
}
static ssize_t
read_mixed(struct header_filter_istream *mstream, size_t body_highwater_size)
{
const unsigned char *data;
size_t pos;
ssize_t ret;
if (mstream->hide_body) {
mstream->istream.istream.eof = TRUE;
return -1;
}
data = i_stream_get_data(mstream->istream.parent, &pos);
if (pos <= body_highwater_size) {
i_assert(pos == body_highwater_size ||
(mstream->end_body_with_lf &&
pos+1 == body_highwater_size));
ret = i_stream_read(mstream->istream.parent);
mstream->istream.istream.stream_errno =
mstream->istream.parent->stream_errno;
mstream->istream.istream.eof = mstream->istream.parent->eof;
if (ret <= 0) {
data = mstream->hdr_buf->data;
pos = mstream->hdr_buf->used;
i_assert(pos > 0);
if (mstream->end_body_with_lf && data[pos-1] != '\n' &&
ret == -1 && mstream->istream.istream.eof) {
/* add missing trailing LF to body */
if (mstream->crlf)
buffer_append_c(mstream->hdr_buf, '\r');
buffer_append_c(mstream->hdr_buf, '\n');
mstream->istream.buffer =
buffer_get_data(mstream->hdr_buf,
&mstream->istream.pos);
return mstream->hdr_buf->used - pos;
}
return ret;
}
data = i_stream_get_data(mstream->istream.parent, &pos);
}
buffer_append(mstream->hdr_buf, data + body_highwater_size,
pos - body_highwater_size);
mstream->istream.buffer = buffer_get_data(mstream->hdr_buf, &pos);
ret = (ssize_t)(pos - mstream->istream.pos - mstream->istream.skip);
i_assert(ret > 0);
mstream->istream.pos = pos;
return ret;
}
static int cmp_uint(const unsigned int *i1, const unsigned int *i2)
{
return *i1 < *i2 ? -1 :
(*i1 > *i2 ? 1 : 0);
}
static bool match_line_changed(struct header_filter_istream *mstream)
{
if (!array_is_created(&mstream->match_change_lines))
return FALSE;
return array_bsearch(&mstream->match_change_lines, &mstream->cur_line,
cmp_uint) != NULL;
}
static void add_eol(struct header_filter_istream *mstream, bool orig_crlf)
{
if (mstream->crlf || (orig_crlf && mstream->crlf_preserve))
buffer_append(mstream->hdr_buf, "\r\n", 2);
else
buffer_append_c(mstream->hdr_buf, '\n');
}
static ssize_t hdr_stream_update_pos(struct header_filter_istream *mstream)
{
ssize_t ret;
size_t pos;
mstream->istream.buffer = buffer_get_data(mstream->hdr_buf, &pos);
ret = (ssize_t)(pos - mstream->istream.pos - mstream->istream.skip);
i_assert(ret >= 0);
mstream->istream.pos = pos;
if (pos >= mstream->istream.max_buffer_size)
return -2;
return ret;
}
static ssize_t read_header(struct header_filter_istream *mstream)
{
struct message_header_line *hdr;
uoff_t highwater_offset;
ssize_t ret, ret2;
int hdr_ret;
if (mstream->hdr_ctx == NULL) {
mstream->hdr_ctx =
message_parse_header_init(mstream->istream.parent,
NULL, 0);
}
/* remove skipped data from hdr_buf */
buffer_copy(mstream->hdr_buf, 0,
mstream->hdr_buf, mstream->istream.skip, (size_t)-1);
mstream->istream.pos -= mstream->istream.skip;
mstream->istream.skip = 0;
buffer_set_used_size(mstream->hdr_buf, mstream->istream.pos);
if (mstream->header_read) {
i_assert(mstream->istream.skip == 0);
highwater_offset = mstream->istream.istream.v_offset +
mstream->istream.pos;
if (highwater_offset >= mstream->header_size.virtual_size) {
/* we want to return mixed headers and body */
size_t body_highwater_size = highwater_offset -
mstream->header_size.virtual_size;
return read_mixed(mstream, body_highwater_size);
}
}
if (mstream->hdr_buf->used >= mstream->istream.max_buffer_size)
return -2;
while ((hdr_ret = message_parse_header_next(mstream->hdr_ctx,
&hdr)) > 0) {
bool matched;
if (!hdr->continued)
mstream->cur_line++;
if (hdr->eoh) {
mstream->seen_eoh = TRUE;
matched = TRUE;
if (mstream->header_parsed) {
if (mstream->eoh_not_matched)
matched = !matched;
} else if (mstream->callback != NULL) {
mstream->callback(mstream, hdr, &matched,
mstream->context);
}
if (!matched) {
mstream->seen_eoh = FALSE;
mstream->eoh_not_matched = TRUE;
continue;
}
add_eol(mstream, hdr->crlf_newline);
continue;
}
if (hdr->continued) {
/* Header line continued - use only the first line's
matched-result. Otherwise multiline headers might
end up being only partially picked, which wouldn't
be very good. However, allow callbacks to modify
the headers in any way they want. */
matched = mstream->prev_matched;
} else if (mstream->headers_count == 0) {
/* no include/exclude headers - default matching */
matched = FALSE;
} else {
matched = i_bsearch(hdr->name, mstream->headers,
mstream->headers_count,
sizeof(*mstream->headers),
bsearch_strcasecmp) != NULL;
}
if (mstream->callback == NULL) {
/* nothing gets excluded */
} else if (!mstream->header_parsed || mstream->headers_edited) {
/* first time in this line or we have actually modified
the header so we always want to call the callbacks */
bool orig_matched = matched;
mstream->parsed_lines = mstream->cur_line;
mstream->callback(mstream, hdr, &matched,
mstream->context);
if (matched != orig_matched &&
!hdr->continued && !mstream->headers_edited) {
if (!array_is_created(&mstream->match_change_lines))
i_array_init(&mstream->match_change_lines, 8);
array_append(&mstream->match_change_lines,
&mstream->cur_line, 1);
}
} else if (!hdr->continued) {
/* second time in this line. was it excluded by the
callback the first time? */
if (match_line_changed(mstream))
matched = !matched;
}
mstream->prev_matched = matched;
if (matched == mstream->exclude) {
/* ignore */
} else {
if (!hdr->continued) {
buffer_append(mstream->hdr_buf,
hdr->name, hdr->name_len);
buffer_append(mstream->hdr_buf,
hdr->middle, hdr->middle_len);
}
buffer_append(mstream->hdr_buf,
hdr->value, hdr->value_len);
if (!hdr->no_newline)
add_eol(mstream, hdr->crlf_newline);
if (mstream->skip_count >= mstream->hdr_buf->used) {
/* we need more */
mstream->skip_count -= mstream->hdr_buf->used;
buffer_set_used_size(mstream->hdr_buf, 0);
} else {
if (mstream->skip_count > 0) {
mstream->istream.skip =
mstream->skip_count;
mstream->skip_count = 0;
}
break;
}
}
if (mstream->hdr_buf->used >= mstream->istream.max_buffer_size)
break;
}
if (hdr_ret < 0) {
if (mstream->istream.parent->stream_errno != 0) {
mstream->istream.istream.stream_errno =
mstream->istream.parent->stream_errno;
mstream->istream.istream.eof =
mstream->istream.parent->eof;
return -1;
}
if (!mstream->seen_eoh && mstream->add_missing_eoh) {
mstream->seen_eoh = TRUE;
add_eol(mstream, FALSE);
}
}
/* don't copy eof here because we're only returning headers here.
the body will be returned in separate read() call. */
ret = hdr_stream_update_pos(mstream);
if (hdr_ret == 0) {
/* need more data to finish parsing headers. we may have some
data already available though. */
return ret;
}
if (hdr == NULL) {
/* finished */
message_parse_header_deinit(&mstream->hdr_ctx);
mstream->hdr_ctx = NULL;
if (!mstream->header_parsed && mstream->callback != NULL) {
bool matched = FALSE;
mstream->callback(mstream, NULL,
&matched, mstream->context);
/* check if the callback added more headers.
this is allowed only of EOH wasn't added yet. */
ret2 = hdr_stream_update_pos(mstream);
if (!mstream->seen_eoh)
ret += ret2;
else {
i_assert(ret2 == 0);
}
}
mstream->header_parsed = TRUE;
mstream->header_read = TRUE;
mstream->header_size.physical_size =
mstream->istream.parent->v_offset;
mstream->header_size.virtual_size =
mstream->istream.istream.v_offset +
mstream->istream.pos;
}
if (ret == 0) {
/* we're at the end of headers. */
i_assert(hdr == NULL);
i_assert(mstream->istream.istream.v_offset +
mstream->istream.pos ==
mstream->header_size.virtual_size);
return i_stream_header_filter_read(&mstream->istream);
}
return ret;
}
static ssize_t
handle_end_body_with_lf(struct header_filter_istream *mstream, ssize_t ret)
{
struct istream_private *stream = &mstream->istream;
const unsigned char *data;
size_t size, last_offset;
bool last_lf;
data = i_stream_get_data(stream->parent, &size);
last_offset = stream->parent->v_offset + size-1;
if (mstream->last_lf_offset == last_offset)
last_lf = TRUE;
else if (size > 0)
last_lf = data[size-1] == '\n';
else
last_lf = FALSE;
if (ret == -1 && stream->parent->eof && !last_lf) {
/* missing LF, need to add it */
i_assert(!mstream->last_lf_added);
i_assert(size == 0 || data[size-1] != '\n');
buffer_reset(mstream->hdr_buf);
buffer_append(mstream->hdr_buf, data, size);
if (mstream->crlf)
buffer_append_c(mstream->hdr_buf, '\r');
buffer_append_c(mstream->hdr_buf, '\n');
mstream->last_lf_offset = last_offset;
mstream->last_lf_added = TRUE;
stream->skip = 0;
stream->pos = mstream->hdr_buf->used;
stream->buffer = mstream->hdr_buf->data;
return mstream->crlf ? 2 : 1;
} else {
mstream->last_lf_offset = last_lf ? last_offset : (uoff_t)-1;
}
return ret;
}
static ssize_t i_stream_header_filter_read(struct istream_private *stream)
{
struct header_filter_istream *mstream =
(struct header_filter_istream *)stream;
uoff_t v_offset;
ssize_t ret;
if (mstream->last_lf_added) {
stream->istream.eof = TRUE;
return -1;
}
if (!mstream->header_read ||
stream->istream.v_offset < mstream->header_size.virtual_size) {
ret = read_header(mstream);
if (ret != -2 || stream->pos != stream->skip)
return ret;
}
if (mstream->hide_body) {
stream->istream.eof = TRUE;
return -1;
}
v_offset = stream->parent_start_offset + stream->istream.v_offset -
mstream->header_size.virtual_size +
mstream->header_size.physical_size;
i_stream_seek(stream->parent, v_offset);
ret = i_stream_read_copy_from_parent(&stream->istream);
if (mstream->end_body_with_lf)
ret = handle_end_body_with_lf(mstream, ret);
return ret;
}
static void
i_stream_header_filter_seek_to_header(struct header_filter_istream *mstream,
uoff_t v_offset)
{
i_stream_seek(mstream->istream.parent,
mstream->istream.parent_start_offset);
mstream->istream.parent_expected_offset =
mstream->istream.parent_start_offset;
mstream->istream.access_counter =
mstream->istream.parent->real_stream->access_counter;
if (mstream->hdr_ctx != NULL)
message_parse_header_deinit(&mstream->hdr_ctx);
mstream->skip_count = v_offset;
mstream->cur_line = 0;
mstream->prev_matched = FALSE;
mstream->header_read = FALSE;
mstream->seen_eoh = FALSE;
}
static int skip_header(struct header_filter_istream *mstream)
{
size_t pos;
if (mstream->header_read)
return 0;
if (mstream->istream.access_counter !=
mstream->istream.parent->real_stream->access_counter) {
/* need to re-parse headers */
i_stream_header_filter_seek_to_header(mstream, 0);
}
while (!mstream->header_read &&
i_stream_read(&mstream->istream.istream) != -1) {
pos = i_stream_get_data_size(&mstream->istream.istream);
i_stream_skip(&mstream->istream.istream, pos);
}
return mstream->istream.istream.stream_errno != 0 ? -1 : 0;
}
static void
stream_reset_to(struct header_filter_istream *mstream, uoff_t v_offset)
{
mstream->istream.istream.v_offset = v_offset;
mstream->istream.skip = mstream->istream.pos = 0;
mstream->istream.buffer = NULL;
buffer_set_used_size(mstream->hdr_buf, 0);
}
static void i_stream_header_filter_seek(struct istream_private *stream,
uoff_t v_offset, bool mark ATTR_UNUSED)
{
struct header_filter_istream *mstream =
(struct header_filter_istream *)stream;
if (stream->istream.v_offset == v_offset) {
/* just reset the input buffer */
stream_reset_to(mstream, v_offset);
i_stream_seek(mstream->istream.parent,
mstream->istream.parent_expected_offset);
return;
}
/* if last_lf_added=TRUE, we're currently at EOF. So reset it only if
we're seeking backwards, otherwise we would just add a duplicate */
mstream->last_lf_added = FALSE;
if (v_offset == 0) {
/* seeking to beginning of headers. */
stream_reset_to(mstream, 0);
i_stream_header_filter_seek_to_header(mstream, 0);
return;
}
/* if we haven't parsed the whole header yet, we don't know if we
want to seek inside header or body. so make sure we've parsed the
header. */
if (skip_header(mstream) < 0)
return;
stream_reset_to(mstream, v_offset);
if (v_offset < mstream->header_size.virtual_size) {
/* seek into headers. we'll have to re-parse them, use
skip_count to set the wanted position */
i_stream_header_filter_seek_to_header(mstream, v_offset);
} else {
/* body */
v_offset += mstream->header_size.physical_size -
mstream->header_size.virtual_size;
i_stream_seek(stream->parent,
stream->parent_start_offset + v_offset);
}
}
static void ATTR_NORETURN
i_stream_header_filter_sync(struct istream_private *stream ATTR_UNUSED)
{
i_panic("istream-header-filter sync() not implemented");
}
static int
i_stream_header_filter_stat(struct istream_private *stream, bool exact)
{
struct header_filter_istream *mstream =
(struct header_filter_istream *)stream;
const struct stat *st;
uoff_t old_offset;
if (i_stream_stat(stream->parent, exact, &st) < 0) {
stream->istream.stream_errno = stream->parent->stream_errno;
return -1;
}
stream->statbuf = *st;
if (stream->statbuf.st_size == -1 || !exact)
return 0;
/* fix the filtered header size */
old_offset = stream->istream.v_offset;
if (skip_header(mstream) < 0)
return -1;
stream->statbuf.st_size -=
(off_t)mstream->header_size.physical_size -
(off_t)mstream->header_size.virtual_size;
i_stream_seek(&stream->istream, old_offset);
return 0;
}
#undef i_stream_create_header_filter
struct istream *
i_stream_create_header_filter(struct istream *input,
enum header_filter_flags flags,
const char *const *headers,
unsigned int headers_count,
header_filter_callback *callback, void *context)
{
struct header_filter_istream *mstream;
unsigned int i, j;
int ret;
i_assert((flags & (HEADER_FILTER_INCLUDE|HEADER_FILTER_EXCLUDE)) != 0);
mstream = i_new(struct header_filter_istream, 1);
mstream->pool = pool_alloconly_create(MEMPOOL_GROWING
"header filter stream", 4096);
mstream->istream.max_buffer_size = input->real_stream->max_buffer_size;
mstream->headers = headers_count == 0 ? NULL :
p_new(mstream->pool, const char *, headers_count);
for (i = j = 0; i < headers_count; i++) {
ret = j == 0 ? -1 :
strcasecmp(mstream->headers[j-1], headers[i]);
if (ret == 0) {
/* drop duplicate */
continue;
}
i_assert(ret < 0);
mstream->headers[j++] = p_strdup(mstream->pool, headers[i]);
}
mstream->headers_count = j;
mstream->hdr_buf = buffer_create_dynamic(mstream->pool, 1024);
mstream->callback = callback;
mstream->context = context;
mstream->exclude = (flags & HEADER_FILTER_EXCLUDE) != 0;
if ((flags & HEADER_FILTER_CRLF_PRESERVE) != 0)
mstream->crlf_preserve = TRUE;
else if ((flags & HEADER_FILTER_NO_CR) != 0)
mstream->crlf = FALSE;
else
mstream->crlf = TRUE;
mstream->hide_body = (flags & HEADER_FILTER_HIDE_BODY) != 0;
mstream->add_missing_eoh = (flags & HEADER_FILTER_ADD_MISSING_EOH) != 0;
mstream->end_body_with_lf =
(flags & HEADER_FILTER_END_BODY_WITH_LF) != 0;
mstream->istream.iostream.destroy = i_stream_header_filter_destroy;
mstream->istream.read = i_stream_header_filter_read;
mstream->istream.seek = i_stream_header_filter_seek;
mstream->istream.sync = i_stream_header_filter_sync;
mstream->istream.stat = i_stream_header_filter_stat;
mstream->istream.istream.readable_fd = FALSE;
mstream->istream.istream.blocking = input->blocking;
mstream->istream.istream.seekable = input->seekable;
return i_stream_create(&mstream->istream, input, -1);
}
void i_stream_header_filter_add(struct header_filter_istream *input,
const void *data, size_t size)
{
buffer_append(input->hdr_buf, data, size);
input->headers_edited = TRUE;
}