Coverage Report

Created: 2026-01-10 06:56

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/httpd/server/apreq_parser_header.c
Line
Count
Source
1
/*
2
**  Licensed to the Apache Software Foundation (ASF) under one or more
3
** contributor license agreements.  See the NOTICE file distributed with
4
** this work for additional information regarding copyright ownership.
5
** The ASF licenses this file to You under the Apache License, Version 2.0
6
** (the "License"); you may not use this file except in compliance with
7
** the License.  You may obtain a copy of the License at
8
**
9
**      http://www.apache.org/licenses/LICENSE-2.0
10
**
11
**  Unless required by applicable law or agreed to in writing, software
12
**  distributed under the License is distributed on an "AS IS" BASIS,
13
**  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
**  See the License for the specific language governing permissions and
15
**  limitations under the License.
16
*/
17
#include <assert.h>
18
#include "apreq_parser.h"
19
#include "apreq_error.h"
20
#include "apreq_util.h"
21
22
#include "apr_lib.h" /* for apr_iscntrl() & co */
23
24
901
#define PARSER_STATUS_CHECK(PREFIX)   do {         \
25
901
    if (ctx->status == PREFIX##_ERROR)             \
26
901
        return APREQ_ERROR_GENERAL;                \
27
901
    else if (ctx->status == PREFIX##_COMPLETE)     \
28
901
        return APR_SUCCESS;                        \
29
901
    else if (bb == NULL)                           \
30
901
        return APR_INCOMPLETE;                     \
31
901
} while (0);
32
33
34
struct hdr_ctx {
35
    apr_bucket_brigade *bb;
36
    apr_size_t          nlen;
37
    apr_size_t          glen;
38
    apr_size_t          vlen;
39
    enum {
40
        HDR_NAME,
41
        HDR_GAP,
42
        HDR_VALUE,
43
        HDR_NEWLINE,
44
        HDR_ENDLINE,
45
        HDR_FOLDLINE,
46
        HDR_LASTLINE,
47
        HDR_COMPLETE,
48
        HDR_ERROR
49
    }                   status;
50
};
51
52
/********************* header parsing utils ********************/
53
54
55
static apr_bucket *split_header_line(apr_bucket *e, apr_size_t *off,
56
                                     const char **data, apr_size_t *dlen)
57
4.02k
{
58
4.02k
    if (*off > 1) {
59
4.02k
        apr_bucket_split(e, *off - 1);
60
4.02k
        e = APR_BUCKET_NEXT(e);
61
4.02k
        *dlen -= *off - 1;
62
4.02k
        *data += *off - 1;
63
4.02k
        *off = 1;
64
4.02k
    }
65
4.02k
    return e;
66
4.02k
}
67
68
static apr_status_t consume_header_line(apreq_param_t **p,
69
                                        apr_pool_t *pool,
70
                                        apr_bucket_brigade *bb,
71
                                        apr_size_t nlen,
72
                                        apr_size_t glen,
73
                                        apr_size_t vlen)
74
1.31k
{
75
1.31k
    apreq_param_t *param;
76
1.31k
    apreq_value_t *v;
77
1.31k
    apr_bucket *e, *f;
78
1.31k
    apr_status_t s;
79
1.31k
    struct iovec vec[APREQ_DEFAULT_NELTS], *iov;
80
1.31k
    apr_array_header_t arr;
81
1.31k
    char *dest;
82
1.31k
    const char *data;
83
1.31k
    apr_size_t dlen;
84
1.31k
    int i, eol = 0;
85
86
1.31k
    param = apreq_param_make(pool, NULL, nlen, NULL, vlen);
87
1.31k
    if (param == NULL)
88
0
        return APR_ENOMEM;
89
1.31k
    *(const apreq_value_t **)&v = &param->v;
90
91
1.31k
    arr.pool     = pool;
92
1.31k
    arr.elt_size = sizeof(struct iovec);
93
1.31k
    arr.nelts    = 0;
94
1.31k
    arr.nalloc   = APREQ_DEFAULT_NELTS;
95
1.31k
    arr.elts     = (char *)vec;
96
97
1.31k
    e = APR_BRIGADE_FIRST(bb);
98
99
    /* store name in a temporary iovec array */
100
1.32k
    do {
101
1.32k
        apr_size_t len;
102
103
1.32k
        assert(e != APR_BRIGADE_SENTINEL(bb));
104
1.32k
        iov = (struct iovec *)apr_array_push(&arr);
105
1.32k
        s = apr_bucket_read(e, (const char **)&iov->iov_base,
106
1.32k
                            &len, APR_BLOCK_READ);
107
1.32k
        if (s != APR_SUCCESS)
108
0
            return s;
109
1.32k
        iov->iov_len = len;
110
111
1.32k
        assert(nlen >= len);
112
1.32k
        nlen -= len;
113
114
1.32k
        e = APR_BUCKET_NEXT(e);
115
1.32k
    } while (nlen > 0);
116
117
    /* skip gap */
118
1.31k
    do {
119
1.31k
        assert(e != APR_BRIGADE_SENTINEL(bb));
120
1.31k
        s = apr_bucket_read(e, &data, &dlen, APR_BLOCK_READ);
121
1.31k
        if (s != APR_SUCCESS)
122
0
            return s;
123
124
1.31k
        assert(glen >= dlen);
125
1.31k
        glen -= dlen;
126
127
1.31k
        e = APR_BUCKET_NEXT(e);
128
1.31k
    } while (glen > 0);
129
130
    /* copy value */
131
1.31k
    dest = v->data;
132
1.31k
    do {
133
1.31k
        apr_size_t off;
134
135
1.31k
        assert(e != APR_BRIGADE_SENTINEL(bb));
136
1.31k
        s = apr_bucket_read(e, &data, &dlen, APR_BLOCK_READ);
137
1.31k
        if (s != APR_SUCCESS)
138
0
            return s;
139
140
13.6k
        for (off = 0; off < dlen; ++off) {
141
12.2k
            const char ch = data[off];
142
12.2k
            if (ch == '\r' || ch == '\n') {
143
                /* Eat [CR]LF of continuation or end of line */
144
1.86k
                if (!vlen && ch == '\n')
145
1.31k
                    eol = 1; /* done */
146
1.86k
                continue;
147
1.86k
            }
148
12.2k
            assert(vlen > 0);
149
10.4k
            *dest = ch;
150
10.4k
            ++dest;
151
10.4k
            --vlen;
152
10.4k
        }
153
154
1.31k
        e = APR_BUCKET_NEXT(e);
155
1.31k
    } while (!eol);
156
1.31k
    v->dlen = dest - v->data;
157
1.31k
    *dest++ = 0;
158
159
    /* write name */
160
1.31k
    v->name = dest;
161
2.63k
    for (i = 0; i < arr.nelts; ++i) {
162
1.32k
        iov = &((struct iovec *)arr.elts)[i];
163
1.32k
        memcpy(dest, iov->iov_base, iov->iov_len);
164
1.32k
        dest += iov->iov_len;
165
1.32k
        ++iov;
166
1.32k
    }
167
1.31k
    v->nlen = dest - v->name;
168
1.31k
    *dest = 0;
169
170
5.26k
    while ((f = APR_BRIGADE_FIRST(bb)) != e)
171
3.95k
        apr_bucket_delete(f);
172
173
1.31k
    apreq_param_tainted_on(param);
174
1.31k
    *p = param;
175
1.31k
    return APR_SUCCESS;
176
177
1.31k
}
178
179
10.5k
#define IS_TOKEN_CHAR(c) (apr_isalnum(c) \
180
10.5k
                          || ((c) && strchr("!#$%&'*+-.^_`|~", (c))))
181
182
APREQ_DECLARE_PARSER(apreq_parse_headers)
183
901
{
184
901
    apr_pool_t *pool = parser->pool;
185
901
    apr_bucket *e;
186
901
    struct hdr_ctx *ctx;
187
901
    char ch;
188
189
901
    if (parser->ctx == NULL) {
190
901
        ctx = apr_pcalloc(pool, sizeof *ctx);
191
901
        ctx->bb = apr_brigade_create(pool, parser->bucket_alloc);
192
901
        parser->ctx = ctx;
193
901
        ctx->status = HDR_NAME;
194
901
    }
195
0
    else
196
0
        ctx = parser->ctx;
197
198
901
    PARSER_STATUS_CHECK(HDR);
199
901
    e = APR_BRIGADE_LAST(ctx->bb);
200
901
    APR_BRIGADE_CONCAT(ctx->bb, bb);
201
202
    /* parse the brigade for CRLF_CRLF-terminated header block,
203
     * each time starting from the front of the brigade.
204
     */
205
206
901
    for (e = APR_BUCKET_NEXT(e);
207
993
         e != APR_BRIGADE_SENTINEL(ctx->bb);
208
901
         e = APR_BUCKET_NEXT(e))
209
925
    {
210
925
        apr_size_t off = 0, dlen;
211
925
        const char *data;
212
925
        apr_status_t s;
213
925
        apreq_param_t *param = NULL; /* silences gcc-4.0 warning */
214
215
925
        if (APR_BUCKET_IS_EOS(e)) {
216
0
            ctx->status = HDR_COMPLETE;
217
0
            APR_BRIGADE_CONCAT(bb, ctx->bb);
218
0
            return APR_SUCCESS;
219
0
        }
220
221
925
        s = apr_bucket_read(e, &data, &dlen, APR_BLOCK_READ);
222
925
        if ( s != APR_SUCCESS ) {
223
0
            ctx->status = HDR_ERROR;
224
0
            return s;
225
0
        }
226
925
        if (dlen == 0)
227
0
            continue;
228
229
6.40k
    parse_hdr_bucket:
230
231
        /*              gap           nlen = 13
232
         *              vvv           glen =  3
233
         * Sample-Header:  grape      vlen =  5
234
         * ^^^^^^^^^^^^^   ^^^^^
235
         *     name        value
236
         */
237
238
6.40k
        switch (ctx->status) {
239
240
1.42k
        case HDR_NAME:
241
242
11.3k
            while (off < dlen) {
243
11.3k
                ch = data[off++];
244
11.3k
                switch (ch) {
245
1.36k
                case ':':
246
1.36k
                    if (!ctx->nlen) {
247
1
                        ctx->status = HDR_ERROR;
248
1
                        return APREQ_ERROR_BADHEADER;
249
1
                    }
250
1.36k
                    e = split_header_line(e, &off, &data, &dlen);
251
1.36k
                    ++ctx->glen;
252
1.36k
                    ctx->status = HDR_GAP;
253
1.36k
                    goto parse_hdr_bucket;
254
255
9.99k
                default:
256
9.99k
                    if (!IS_TOKEN_CHAR(ch)) {
257
29
                        ctx->status = HDR_ERROR;
258
29
                        return APREQ_ERROR_BADCHAR;
259
29
                    }
260
9.96k
                    ++ctx->nlen;
261
11.3k
                }
262
11.3k
            }
263
29
            break;
264
265
266
1.37k
        case HDR_GAP:
267
268
1.75k
            while (off < dlen) {
269
1.73k
                ch = data[off++];
270
1.73k
                switch (ch) {
271
226
                case ' ':
272
383
                case '\t':
273
383
                    ++ctx->glen;
274
383
                    break;
275
276
405
                case '\n':
277
405
                    e = split_header_line(e, &off, &data, &dlen);
278
405
                    ctx->status = HDR_NEWLINE;
279
405
                    goto parse_hdr_bucket;
280
281
98
                case '\r':
282
98
                    e = split_header_line(e, &off, &data, &dlen);
283
98
                    ctx->status = HDR_ENDLINE;
284
98
                    goto parse_hdr_bucket;
285
286
853
                default:
287
853
                    if (apr_iscntrl(ch)) {
288
2
                        ctx->status = HDR_ERROR;
289
2
                        return APREQ_ERROR_BADCHAR;
290
2
                    }
291
851
                    e = split_header_line(e, &off, &data, &dlen);
292
851
                    ++ctx->vlen;
293
851
                    ctx->status = HDR_VALUE;
294
851
                    goto parse_hdr_bucket;
295
1.73k
                }
296
1.73k
            }
297
20
            break;
298
299
300
962
        case HDR_VALUE:
301
302
10.2k
            while (off < dlen) {
303
10.2k
                ch = data[off++];
304
10.2k
                switch (ch) {
305
754
                case '\n':
306
754
                    ctx->status = HDR_NEWLINE;
307
754
                    goto parse_hdr_bucket;
308
309
193
                case '\r':
310
193
                    ctx->status = HDR_ENDLINE;
311
193
                    goto parse_hdr_bucket;
312
313
9.25k
                default:
314
9.25k
                    if (apr_iscntrl(ch)) {
315
2
                        ctx->status = HDR_ERROR;
316
2
                        return APREQ_ERROR_BADCHAR;
317
2
                    }
318
9.25k
                    ++ctx->vlen;
319
10.2k
                }
320
10.2k
            }
321
13
            break;
322
323
324
384
        case HDR_ENDLINE:
325
489
        case HDR_LASTLINE:
326
327
489
            if (off == dlen)
328
6
                break;
329
330
483
            if (data[off++] != '\n') {
331
12
                ctx->status = HDR_ERROR;
332
12
                return APREQ_ERROR_BADHEADER;
333
12
            }
334
335
471
            if (ctx->status == HDR_LASTLINE) {
336
99
                ctx->status = HDR_COMPLETE;
337
99
                goto parse_hdr_bucket;
338
99
            }
339
340
            /* fall thru */
341
372
            ctx->status = HDR_NEWLINE;
342
343
1.75k
        case HDR_NEWLINE:
344
345
1.75k
            if (off == dlen)
346
15
                break;
347
348
1.73k
            ch = data[off++];
349
1.73k
            switch (ch) {
350
227
            case ' ':
351
425
            case '\t':
352
425
                ++ctx->vlen;
353
425
                break;
354
355
1.31k
            default:
356
1.31k
                e = split_header_line(e, &off, &data, &dlen);
357
358
                /* consume from splitted brigade now */
359
1.31k
                s = consume_header_line(&param, pool, ctx->bb,
360
1.31k
                                        ctx->nlen, ctx->glen, ctx->vlen);
361
1.31k
                if (parser->hook != NULL && s == APR_SUCCESS)
362
0
                    s = apreq_hook_run(parser->hook, param, NULL);
363
1.31k
                if (s != APR_SUCCESS) {
364
0
                    ctx->status = HDR_ERROR;
365
0
                    return s;
366
0
                }
367
1.31k
                apreq_value_table_add(&param->v, t);
368
1.31k
                ctx->nlen = 0;
369
1.31k
                ctx->vlen = 0;
370
1.31k
                ctx->glen = 0;
371
372
1.31k
                switch (ch) {
373
671
                case '\n':
374
671
                    ctx->status = HDR_COMPLETE;
375
671
                    break;
376
377
104
                case '\r':
378
104
                    ctx->status = HDR_LASTLINE;
379
104
                    break;
380
381
536
                default:
382
536
                    if (!IS_TOKEN_CHAR(ch)) {
383
16
                        ctx->status = HDR_ERROR;
384
16
                        return APREQ_ERROR_BADCHAR;
385
16
                    }
386
520
                    ++ctx->nlen;
387
520
                    ctx->status = HDR_NAME;
388
520
                    break;
389
1.31k
                }
390
1.29k
                goto parse_hdr_bucket;
391
1.73k
            }
392
393
            /* fall thru */
394
425
            ctx->status = HDR_FOLDLINE;
395
396
428
        case HDR_FOLDLINE:
397
398
746
            while (off < dlen) {
399
737
                ch = data[off++];
400
737
                switch (ch) {
401
176
                case ' ':
402
318
                case '\t':
403
318
                    ++ctx->vlen;
404
318
                    break;
405
406
217
                case '\n':
407
217
                    ctx->status = HDR_NEWLINE;
408
217
                    goto parse_hdr_bucket;
409
410
92
                case '\r':
411
92
                    ctx->status = HDR_ENDLINE;
412
92
                    goto parse_hdr_bucket;
413
414
110
                default:
415
110
                    if (apr_iscntrl(ch)) {
416
1
                        ctx->status = HDR_ERROR;
417
1
                        return APREQ_ERROR_BADCHAR;
418
1
                    }
419
109
                    ctx->status = HDR_VALUE;
420
109
                    ++ctx->vlen;
421
109
                    goto parse_hdr_bucket;
422
737
                }
423
737
            }
424
9
            break;
425
426
427
770
        case HDR_COMPLETE:
428
429
770
            if (off < dlen)
430
763
                apr_bucket_split(e, off);
431
432
770
            e = APR_BUCKET_NEXT(e);
433
771
            do {
434
771
                apr_bucket *f = APR_BRIGADE_FIRST(ctx->bb);
435
771
                apr_bucket_delete(f);
436
771
            } while (e != APR_BRIGADE_FIRST(ctx->bb));
437
438
770
            APR_BRIGADE_CONCAT(bb, ctx->bb);
439
770
            return APR_SUCCESS;
440
441
442
0
        default:
443
0
            assert(0); /* not reached */
444
6.40k
        }
445
6.40k
    }
446
68
    apreq_brigade_setaside(ctx->bb,pool);
447
68
    return APR_INCOMPLETE;
448
901
}