source: mod_gnutls/src/gnutls_io.c @ 2038b76

debian/masterproxy-ticket
Last change on this file since 2038b76 was 2038b76, checked in by Fiona Klute <fiona.klute@…>, 22 months ago

Ensure nonblocking reads pass EAGAIN or EINTR status to caller

  • Property mode set to 100644
File size: 31.6 KB
Line 
1/*
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2008 Nikos Mavrogiannopoulos
4 *  Copyright 2011 Dash Shendy
5 *  Copyright 2015-2018 Fiona Klute
6 *
7 *  Licensed under the Apache License, Version 2.0 (the "License");
8 *  you may not use this file except in compliance with the License.
9 *  You may obtain a copy of the License at
10 *
11 *      http://www.apache.org/licenses/LICENSE-2.0
12 *
13 *  Unless required by applicable law or agreed to in writing, software
14 *  distributed under the License is distributed on an "AS IS" BASIS,
15 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 *  See the License for the specific language governing permissions and
17 *  limitations under the License.
18 */
19
20#include "mod_gnutls.h"
21
22#ifdef APLOG_USE_MODULE
23APLOG_USE_MODULE(gnutls);
24#endif
25
26#if defined(__GNUC__) && __GNUC__ < 5 && !defined(__clang__)
27#include <inttypes.h>
28#endif
29
30/**
31 * @file
32 * Describe how the GnuTLS Filter system works here
33 *  - Basicly the same as what mod_ssl does with OpenSSL.
34 *
35 */
36
37#define HTTP_ON_HTTPS_PORT \
38    "GET /" CRLF
39
40#define HTTP_ON_HTTPS_PORT_BUCKET(alloc) \
41    apr_bucket_immortal_create(HTTP_ON_HTTPS_PORT, \
42                               sizeof(HTTP_ON_HTTPS_PORT) - 1, \
43                               alloc)
44
45#define IS_PROXY_STR(c) \
46    ((c->is_proxy == GNUTLS_ENABLED_TRUE) ? "proxy " : "")
47
48/**
49 * Convert `APR_EINTR` or `APR_EAGAIN` to the matching errno. Needed
50 * to pass the status on to GnuTLS from the pull and push functions.
51 */
52#define EAI_APR_TO_RAW(s) (APR_STATUS_IS_EAGAIN(s) ? EAGAIN : EINTR)
53
54
55
56static apr_status_t gnutls_io_filter_error(ap_filter_t * f,
57        apr_bucket_brigade * bb,
58        apr_status_t status) {
59    mgs_handle_t *ctxt = (mgs_handle_t *) f->ctx;
60    apr_bucket *bucket;
61
62    switch (status) {
63    case HTTP_BAD_REQUEST:
64        /* log the situation */
65        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, f->c,
66                      "GnuTLS handshake failed: HTTP spoken on HTTPS port; "
67                      "trying to send HTML error page");
68        ctxt->status = -1;
69
70        /* fake the request line */
71        bucket = HTTP_ON_HTTPS_PORT_BUCKET(f->c->bucket_alloc);
72        break;
73
74    default:
75        return status;
76    }
77
78    APR_BRIGADE_INSERT_TAIL(bb, bucket);
79    bucket = apr_bucket_eos_create(f->c->bucket_alloc);
80    APR_BRIGADE_INSERT_TAIL(bb, bucket);
81
82    return APR_SUCCESS;
83}
84
85static int char_buffer_read(mgs_char_buffer_t * buffer, char *in, int inl) {
86    if (!buffer->length) {
87        return 0;
88    }
89
90    if (buffer->length > inl) {
91        /* we have have enough to fill the caller's buffer */
92        memmove(in, buffer->value, inl);
93        buffer->value += inl;
94        buffer->length -= inl;
95    } else {
96        /* swallow remainder of the buffer */
97        memmove(in, buffer->value, buffer->length);
98        inl = buffer->length;
99        buffer->value = NULL;
100        buffer->length = 0;
101    }
102
103    return inl;
104}
105
106static int char_buffer_write(mgs_char_buffer_t * buffer, char *in, int inl) {
107    buffer->value = in;
108    buffer->length = inl;
109    return inl;
110}
111
112/**
113 * From mod_ssl / ssl_engine_io.c
114 * This function will read from a brigade and discard the read buckets as it
115 * proceeds.  It will read at most *len bytes.
116 */
117static apr_status_t brigade_consume(apr_bucket_brigade * bb,
118        apr_read_type_e block,
119        char *c, apr_size_t * len) {
120    apr_size_t actual = 0;
121    apr_status_t status = APR_SUCCESS;
122
123    while (!APR_BRIGADE_EMPTY(bb)) {
124        apr_bucket *b = APR_BRIGADE_FIRST(bb);
125        const char *str;
126        apr_size_t str_len;
127        apr_size_t consume;
128
129        /* Justin points out this is an http-ism that might
130         * not fit if brigade_consume is added to APR.  Perhaps
131         * apr_bucket_read(eos_bucket) should return APR_EOF?
132         * Then this becomes mainline instead of a one-off.
133         */
134        if (APR_BUCKET_IS_EOS(b)) {
135            status = APR_EOF;
136            break;
137        }
138
139        /* The reason I'm not offering brigade_consume yet
140         * across to apr-util is that the following call
141         * illustrates how borked that API really is.  For
142         * this sort of case (caller provided buffer) it
143         * would be much more trivial for apr_bucket_consume
144         * to do all the work that follows, based on the
145         * particular characteristics of the bucket we are
146         * consuming here.
147         */
148        status = apr_bucket_read(b, &str, &str_len, block);
149
150        if (status != APR_SUCCESS) {
151            if (APR_STATUS_IS_EOF(status)) {
152                /* This stream bucket was consumed */
153                apr_bucket_delete(b);
154                continue;
155            }
156            break;
157        }
158
159        if (str_len > 0) {
160            /* Do not block once some data has been consumed */
161            block = APR_NONBLOCK_READ;
162
163            /* Assure we don't overflow. */
164            consume =
165                    (str_len + actual >
166                    *len) ? *len - actual : str_len;
167
168            memcpy(c, str, consume);
169
170            c += consume;
171            actual += consume;
172
173            if (consume >= b->length) {
174                /* This physical bucket was consumed */
175                apr_bucket_delete(b);
176            } else {
177                /* Only part of this physical bucket was consumed */
178                b->start += consume;
179                b->length -= consume;
180            }
181        } else if (b->length == 0) {
182            apr_bucket_delete(b);
183        }
184
185        /* This could probably be actual == *len, but be safe from stray
186         * photons. */
187        if (actual >= *len) {
188            break;
189        }
190    }
191
192    *len = actual;
193    return status;
194}
195
196static apr_status_t gnutls_io_input_read(mgs_handle_t * ctxt,
197        char *buf, apr_size_t * len)
198{
199    apr_size_t wanted = *len;
200    apr_size_t bytes = 0;
201    int rc;
202
203    *len = 0;
204
205    /* If we have something leftover from last time, try that first. */
206    if ((bytes = char_buffer_read(&ctxt->input_cbuf, buf, wanted))) {
207        *len = bytes;
208        if (ctxt->input_mode == AP_MODE_SPECULATIVE) {
209            /* We want to rollback this read. */
210            if (ctxt->input_cbuf.length > 0) {
211                ctxt->input_cbuf.value -= bytes;
212                ctxt->input_cbuf.length += bytes;
213            } else {
214                char_buffer_write(&ctxt->input_cbuf, buf,
215                        (int) bytes);
216            }
217            return APR_SUCCESS;
218        }
219        /* This could probably be *len == wanted, but be safe from stray
220         * photons.
221         */
222        if (*len >= wanted) {
223            return APR_SUCCESS;
224        }
225        if (ctxt->input_mode == AP_MODE_GETLINE) {
226            if (memchr(buf, APR_ASCII_LF, *len)) {
227                return APR_SUCCESS;
228            }
229        } else {
230            /* Down to a nonblock pattern as we have some data already
231             */
232            ctxt->input_block = APR_NONBLOCK_READ;
233        }
234    }
235
236    if (ctxt->session == NULL) {
237        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
238                      "%s: GnuTLS session is NULL!", __func__);
239        return APR_EGENERAL;
240    }
241
242    while (1)
243    {
244        /* Note: The pull function sets ctxt->input_rc */
245        rc = gnutls_record_recv(ctxt->session, buf + bytes, wanted - bytes);
246
247        if (rc > 0) {
248            *len += rc;
249            if (ctxt->input_mode == AP_MODE_SPECULATIVE) {
250                /* We want to rollback this read. */
251                char_buffer_write(&ctxt->input_cbuf, buf,
252                        rc);
253            }
254            return ctxt->input_rc;
255        } else if (rc == 0) {
256            /* EOF, return code depends on whether we still have data
257             * to return. */
258            if (*len > 0) {
259                ctxt->input_rc = APR_SUCCESS;
260            } else {
261                ctxt->input_rc = APR_EOF;
262            }
263            break;
264        } else { /* (rc < 0) */
265
266            if (rc == GNUTLS_E_INTERRUPTED || rc == GNUTLS_E_AGAIN)
267            {
268                ap_log_cerror(APLOG_MARK, APLOG_TRACE2, ctxt->input_rc, ctxt->c,
269                              "%s: looping recv after '%s' (%d)",
270                              __func__, gnutls_strerror(rc), rc);
271                /* For a blocking read, loop and try again
272                 * immediately. Otherwise just notify the caller. */
273                if (ctxt->input_block != APR_NONBLOCK_READ)
274                    continue;
275                else
276                    ctxt->input_rc =
277                        (rc == GNUTLS_E_AGAIN ? APR_EAGAIN : APR_EINTR);
278            } else if (rc == GNUTLS_E_REHANDSHAKE) {
279                /* A client has asked for a new Hankshake. Currently, we don't do it */
280                ap_log_cerror(APLOG_MARK, APLOG_INFO,
281                        ctxt->input_rc,
282                        ctxt->c,
283                        "GnuTLS: Error reading data. Client Requested a New Handshake."
284                        " (%d) '%s'", rc,
285                        gnutls_strerror(rc));
286            } else if (rc == GNUTLS_E_WARNING_ALERT_RECEIVED) {
287                rc = gnutls_alert_get(ctxt->session);
288                ap_log_cerror(APLOG_MARK, APLOG_INFO,
289                        ctxt->input_rc,
290                        ctxt->c,
291                        "GnuTLS: Warning Alert From Client: "
292                        " (%d) '%s'", rc,
293                        gnutls_alert_get_name(rc));
294            } else if (rc == GNUTLS_E_FATAL_ALERT_RECEIVED) {
295                rc = gnutls_alert_get(ctxt->session);
296                ap_log_cerror(APLOG_MARK, APLOG_INFO,
297                        ctxt->input_rc,
298                        ctxt->c,
299                        "GnuTLS: Fatal Alert From Client: "
300                        "(%d) '%s'", rc,
301                        gnutls_alert_get_name(rc));
302                ctxt->input_rc = APR_EGENERAL;
303                break;
304            } else {
305                /* Some Other Error. Report it. Die. */
306                if (gnutls_error_is_fatal(rc)) {
307                    ap_log_cerror(APLOG_MARK,
308                            APLOG_INFO,
309                            ctxt->input_rc,
310                            ctxt->c,
311                            "GnuTLS: Error reading data. (%d) '%s'",
312                            rc,
313                            gnutls_strerror(rc));
314                } else if (*len > 0) {
315                    ctxt->input_rc = APR_SUCCESS;
316                    break;
317                }
318            }
319
320            if (ctxt->input_rc == APR_SUCCESS) {
321                ap_log_cerror(APLOG_MARK, APLOG_INFO, ctxt->input_rc, ctxt->c,
322                              "%s: GnuTLS error: %s (%d)",
323                              __func__, gnutls_strerror(rc), rc);
324                ctxt->input_rc = APR_EGENERAL;
325            }
326            break;
327        }
328    }
329    return ctxt->input_rc;
330}
331
332static apr_status_t gnutls_io_input_getline(mgs_handle_t * ctxt,
333        char *buf, apr_size_t * len) {
334    const char *pos = NULL;
335    apr_status_t status;
336    apr_size_t tmplen = *len, buflen = *len, offset = 0;
337
338    *len = 0;
339
340    while (tmplen > 0) {
341        status = gnutls_io_input_read(ctxt, buf + offset, &tmplen);
342
343        if (status != APR_SUCCESS) {
344            return status;
345        }
346
347        *len += tmplen;
348
349        if ((pos = memchr(buf, APR_ASCII_LF, *len))) {
350            break;
351        }
352
353        offset += tmplen;
354        tmplen = buflen - offset;
355    }
356
357    if (pos) {
358        char *value;
359        int length;
360        apr_size_t bytes = pos - buf;
361
362        bytes += 1;
363        value = buf + bytes;
364        length = *len - bytes;
365
366        char_buffer_write(&ctxt->input_cbuf, value, length);
367
368        *len = bytes;
369    }
370
371    return APR_SUCCESS;
372}
373
374#define HANDSHAKE_MAX_TRIES 1024
375
376static int gnutls_do_handshake(mgs_handle_t * ctxt) {
377    int ret;
378    int errcode;
379    int maxtries = HANDSHAKE_MAX_TRIES;
380
381    if (ctxt->status != 0 || ctxt->session == NULL) {
382        return -1;
383    }
384
385    /* Enable SNI for proxy connections */
386    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
387    {
388        /* Get peer hostname from note left by mod_proxy */
389        const char *peer_hostname =
390            apr_table_get(ctxt->c->notes, PROXY_SNI_NOTE);
391        /* Used only as target for apr_ipsubnet_create() */
392        apr_ipsubnet_t *probe;
393        /* Check if the note is present (!= NULL) and NOT an IP
394         * address */
395        if ((peer_hostname) != NULL
396            && (apr_ipsubnet_create(&probe, peer_hostname, NULL, ctxt->c->pool)
397                != APR_SUCCESS))
398        {
399            ret = gnutls_server_name_set(ctxt->session, GNUTLS_NAME_DNS,
400                                         peer_hostname, strlen(peer_hostname));
401            if (ret != GNUTLS_E_SUCCESS)
402                ap_log_cerror(APLOG_MARK, APLOG_ERR, ret, ctxt->c,
403                              "Could not set SNI '%s' for proxy connection: "
404                              "%s (%d)",
405                              peer_hostname, gnutls_strerror(ret), ret);
406        }
407    }
408
409tryagain:
410    do {
411        ret = gnutls_handshake(ctxt->session);
412        maxtries--;
413    } while ((ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN)
414            && maxtries > 0);
415
416    if (maxtries < 1) {
417        ctxt->status = -1;
418        ap_log_cerror(APLOG_MARK, APLOG_ERR, 0, ctxt->c,
419                "GnuTLS: Handshake Failed. Hit Maximum Attempts");
420        if (ctxt->session) {
421            gnutls_alert_send(ctxt->session, GNUTLS_AL_FATAL,
422                    gnutls_error_to_alert
423                    (GNUTLS_E_INTERNAL_ERROR, NULL));
424            gnutls_deinit(ctxt->session);
425        }
426        ctxt->session = NULL;
427        return -1;
428    }
429
430    if (ret < 0) {
431        if (ret == GNUTLS_E_WARNING_ALERT_RECEIVED
432                || ret == GNUTLS_E_FATAL_ALERT_RECEIVED) {
433            errcode = gnutls_alert_get(ctxt->session);
434            ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
435                          "GnuTLS: Handshake Alert (%d) '%s'.",
436                          errcode, gnutls_alert_get_name(errcode));
437        }
438
439        if (!gnutls_error_is_fatal(ret)) {
440            ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
441                          "GnuTLS: Non-Fatal Handshake Error: (%d) '%s'",
442                          ret, gnutls_strerror(ret));
443            goto tryagain;
444        }
445        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
446                "GnuTLS: Handshake Failed (%d) '%s'", ret,
447                gnutls_strerror(ret));
448        ctxt->status = -1;
449        if (ctxt->session) {
450            gnutls_alert_send(ctxt->session, GNUTLS_AL_FATAL,
451                    gnutls_error_to_alert(ret,
452                    NULL));
453            gnutls_deinit(ctxt->session);
454        }
455        ctxt->session = NULL;
456        return ret;
457    } else {
458        /* all done with the handshake */
459        ctxt->status = 1;
460        if (gnutls_session_is_resumed(ctxt->session))
461        {
462            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
463                          "%s: TLS session resumed.", __func__);
464        }
465        return GNUTLS_E_SUCCESS;
466    }
467}
468
469int mgs_rehandshake(mgs_handle_t * ctxt) {
470    int rv;
471
472    if (ctxt->session == NULL)
473        return -1;
474
475    rv = gnutls_rehandshake(ctxt->session);
476
477    if (rv != 0) {
478        /* the client did not want to rehandshake. goodbye */
479        ap_log_cerror(APLOG_MARK, APLOG_WARNING, 0, ctxt->c,
480                      "GnuTLS: Client Refused Rehandshake request.");
481        return -1;
482    }
483
484    ctxt->status = 0;
485
486    rv = gnutls_do_handshake(ctxt);
487
488    return rv;
489}
490
491
492
493/**
494 * Close the TLS session associated with the given connection
495 * structure and free its resources
496 *
497 * @param ctxt the mod_gnutls session context
498 *
499 * @return a GnuTLS status code, hopefully `GNUTLS_E_SUCCESS`
500 */
501static int mgs_bye(mgs_handle_t* ctxt)
502{
503    int ret = GNUTLS_E_SUCCESS;
504    /* End Of Connection */
505    if (ctxt->session != NULL)
506    {
507        /* Try A Clean Shutdown */
508        do {
509            ret = gnutls_bye(ctxt->session, GNUTLS_SHUT_WR);
510        } while (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
511        if (ret != GNUTLS_E_SUCCESS)
512            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_EGENERAL, ctxt->c,
513                          "%s: Error while closing TLS %sconnection: "
514                          "'%s' (%d)",
515                          __func__, IS_PROXY_STR(ctxt),
516                          gnutls_strerror(ret), (int) ret);
517        else
518            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
519                          "%s: TLS %sconnection closed.",
520                          __func__, IS_PROXY_STR(ctxt));
521        /* De-Initialize Session */
522        gnutls_deinit(ctxt->session);
523        ctxt->session = NULL;
524    }
525    return ret;
526}
527
528
529
530apr_status_t mgs_filter_input(ap_filter_t * f,
531        apr_bucket_brigade * bb,
532        ap_input_mode_t mode,
533        apr_read_type_e block, apr_off_t readbytes)
534{
535    apr_status_t status = APR_SUCCESS;
536    mgs_handle_t *ctxt = (mgs_handle_t *) f->ctx;
537    apr_size_t len = sizeof (ctxt->input_buffer);
538
539    if (f->c->aborted) {
540        apr_bucket *bucket =
541                apr_bucket_eos_create(f->c->bucket_alloc);
542        APR_BRIGADE_INSERT_TAIL(bb, bucket);
543        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
544                      "%s: %sconnection aborted",
545                      __func__, IS_PROXY_STR(ctxt));
546        return APR_ECONNABORTED;
547    }
548
549    if (ctxt->status == 0) {
550        int ret = gnutls_do_handshake(ctxt);
551        if (ret == GNUTLS_E_SUCCESS)
552            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
553                          "%s: TLS %sconnection opened.",
554                          __func__, IS_PROXY_STR(ctxt));
555    }
556
557    if (ctxt->status < 0)
558    {
559        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
560                      "%s: %sconnection failed, cannot provide data!",
561                      __func__, IS_PROXY_STR(ctxt));
562        apr_bucket *bucket =
563                apr_bucket_eos_create(f->c->bucket_alloc);
564        APR_BRIGADE_INSERT_TAIL(bb, bucket);
565        return APR_ECONNABORTED;
566    }
567
568    /* XXX: we don't currently support anything other than these modes. */
569    if (mode != AP_MODE_READBYTES && mode != AP_MODE_GETLINE &&
570            mode != AP_MODE_SPECULATIVE && mode != AP_MODE_INIT) {
571        return APR_ENOTIMPL;
572    }
573
574    ctxt->input_mode = mode;
575    ctxt->input_block = block;
576
577    if (ctxt->input_mode == AP_MODE_READBYTES ||
578            ctxt->input_mode == AP_MODE_SPECULATIVE) {
579        if (readbytes < 0) {
580            /* you're asking us to speculatively read a negative number of bytes! */
581            return APR_ENOTIMPL;
582        }
583        /* 'readbytes' and 'len' are of different integer types, which
584         * might have different lengths. Read sizes should be too
585         * small for 32 or 64 bit to matter, but we have to make
586         * sure. */
587#if defined(__GNUC__) && __GNUC__ < 5 && !defined(__clang__)
588        if ((apr_size_t) readbytes < len)
589        {
590            /* If readbytes is negative the function fails in the
591             * check above, but the compiler doesn't get that. */
592            if (__builtin_expect(imaxabs(readbytes) > SIZE_MAX, 0))
593            {
594                ap_log_cerror(APLOG_MARK, APLOG_CRIT, APR_EINVAL, ctxt->c,
595                              "%s: prevented buffer length overflow",
596                              __func__);
597                return APR_EINVAL;
598            }
599            len = (apr_size_t) readbytes;
600        }
601#else
602        if ((apr_size_t) readbytes < len
603            && __builtin_add_overflow(readbytes, 0, &len))
604        {
605            ap_log_cerror(APLOG_MARK, APLOG_CRIT, APR_EINVAL, ctxt->c,
606                          "%s: prevented buffer length overflow",
607                          __func__);
608            return APR_EINVAL;
609        }
610#endif
611        status =
612                gnutls_io_input_read(ctxt, ctxt->input_buffer, &len);
613    } else if (ctxt->input_mode == AP_MODE_GETLINE) {
614        status =
615                gnutls_io_input_getline(ctxt, ctxt->input_buffer,
616                &len);
617    } else {
618        /* We have no idea what you are talking about, so return an error. */
619        return APR_ENOTIMPL;
620    }
621
622    if (status != APR_SUCCESS)
623    {
624        /* no data for nonblocking read, return APR_EAGAIN */
625        if ((block == APR_NONBLOCK_READ) && APR_STATUS_IS_EINTR(status))
626            return APR_EAGAIN;
627
628        /* Close TLS session and free resources on EOF,
629         * gnutls_io_filter_error will add an EOS bucket */
630        if (APR_STATUS_IS_EOF(status))
631            mgs_bye(ctxt);
632
633        return gnutls_io_filter_error(f, bb, status);
634    }
635
636    /* Create a transient bucket out of the decrypted data. */
637    if (len > 0) {
638        apr_bucket *bucket =
639                apr_bucket_transient_create(ctxt->input_buffer, len,
640                f->c->bucket_alloc);
641        APR_BRIGADE_INSERT_TAIL(bb, bucket);
642    }
643
644    return status;
645}
646
647/**
648 * Try to flush the output bucket brigade.
649 *
650 * @param ctxt the mod_gnutls session context
651 *
652 * @return `1` on success, `-1` on failure.
653 */
654static ssize_t write_flush(mgs_handle_t * ctxt) {
655    apr_bucket *e;
656
657    if (!(ctxt->output_blen || ctxt->output_length)) {
658        ctxt->output_rc = APR_SUCCESS;
659        return 1;
660    }
661
662    if (ctxt->output_blen) {
663        e = apr_bucket_transient_create(ctxt->output_buffer,
664                ctxt->output_blen,
665                ctxt->output_bb->
666                bucket_alloc);
667        /* we filled this buffer first so add it to the
668         *               * head of the brigade
669         *                               */
670        APR_BRIGADE_INSERT_HEAD(ctxt->output_bb, e);
671        ctxt->output_blen = 0;
672    }
673
674    ctxt->output_length = 0;
675    e = apr_bucket_flush_create(ctxt->output_bb->bucket_alloc);
676    APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, e);
677
678    ctxt->output_rc = ap_pass_brigade(ctxt->output_filter->next,
679            ctxt->output_bb);
680    /* clear the brigade to be ready for next time */
681    apr_brigade_cleanup(ctxt->output_bb);
682
683    return (ctxt->output_rc == APR_SUCCESS) ? 1 : -1;
684}
685
686apr_status_t mgs_filter_output(ap_filter_t * f, apr_bucket_brigade * bb) {
687    int ret;
688    mgs_handle_t *ctxt = (mgs_handle_t *) f->ctx;
689    apr_status_t status = APR_SUCCESS;
690    apr_read_type_e rblock = APR_NONBLOCK_READ;
691
692    if (f->c->aborted) {
693        apr_brigade_cleanup(bb);
694        return APR_ECONNABORTED;
695    }
696
697    if (ctxt->status == 0) {
698        ret = gnutls_do_handshake(ctxt);
699        if (ret == GNUTLS_E_SUCCESS)
700            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
701                          "%s: TLS %sconnection opened.",
702                          __func__, IS_PROXY_STR(ctxt));
703    }
704
705    if (ctxt->status < 0)
706    {
707        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
708                      "%s: %sconnection failed, refusing to send.",
709                      __func__, IS_PROXY_STR(ctxt));
710        if (ctxt->is_proxy)
711        {
712            /* If mod_proxy receives an error while trying to send its
713             * request it sends an "invalid request" error to the
714             * client. By pretending we could send the request
715             * mod_proxy continues its processing and sends a proper
716             * "proxy error" message when there's no response to read. */
717            apr_bucket *bucket = apr_bucket_eos_create(f->c->bucket_alloc);
718            APR_BRIGADE_INSERT_TAIL(bb, bucket);
719            return APR_SUCCESS;
720        }
721        else
722            return APR_ECONNABORTED;
723    }
724
725    while (!APR_BRIGADE_EMPTY(bb)) {
726        apr_bucket *bucket = APR_BRIGADE_FIRST(bb);
727
728        if (APR_BUCKET_IS_EOS(bucket)) {
729            return ap_pass_brigade(f->next, bb);
730        } else if (APR_BUCKET_IS_FLUSH(bucket)) {
731            /* Try Flush */
732            if (write_flush(ctxt) < 0) {
733                /* Flush Error */
734                return ctxt->output_rc;
735            }
736            /* cleanup! */
737            apr_bucket_delete(bucket);
738        } else if (AP_BUCKET_IS_EOC(bucket)) {
739            /* End Of Connection, close TLS session and free
740             * resources */
741            mgs_bye(ctxt);
742            /* cleanup! */
743            apr_bucket_delete(bucket);
744            /* Pass next brigade! */
745            return ap_pass_brigade(f->next, bb);
746        } else {
747            /* filter output */
748            const char *data;
749            apr_size_t len;
750
751            status = apr_bucket_read(bucket, &data, &len, rblock);
752
753            if (APR_STATUS_IS_EAGAIN(status)) {
754                /* No data available so Flush! */
755                if (write_flush(ctxt) < 0) {
756                    return ctxt->output_rc;
757                }
758                /* Try again with a blocking read. */
759                rblock = APR_BLOCK_READ;
760                continue;
761            }
762
763            rblock = APR_NONBLOCK_READ;
764
765            if (!APR_STATUS_IS_EOF(status)
766                    && (status != APR_SUCCESS)) {
767                return status;
768            }
769
770            if (len > 0) {
771
772                if (ctxt->session == NULL) {
773                    ret = GNUTLS_E_INVALID_REQUEST;
774                } else {
775                    do {
776                        ret =
777                                gnutls_record_send
778                                (ctxt->session, data,
779                                len);
780                    } while (ret == GNUTLS_E_INTERRUPTED
781                            || ret == GNUTLS_E_AGAIN);
782                }
783
784                if (ret < 0) {
785                    /* error sending output */
786                    ap_log_cerror(APLOG_MARK, APLOG_INFO, ctxt->output_rc,
787                                  ctxt->c,
788                                  "GnuTLS: Error writing data. (%d) '%s'",
789                                  ret, gnutls_strerror(ret));
790                    if (ctxt->output_rc == APR_SUCCESS) {
791                        ctxt->output_rc =
792                                APR_EGENERAL;
793                        return ctxt->output_rc;
794                    }
795                } else if ((apr_size_t)(ret) != len) {
796                    /* we know the above cast is OK because len > 0 and ret >= 0 */
797                    /* Not able to send the entire bucket,
798                       split it and send it again. */
799                    apr_bucket_split(bucket, ret);
800                }
801            }
802
803            apr_bucket_delete(bucket);
804        }
805    }
806
807    return status;
808}
809
810/**
811 * Pull function for GnuTLS
812 *
813 * Generic errnos used for `gnutls_transport_set_errno()`:
814 * * `EAGAIN`: no data available at the moment, try again (maybe later)
815 * * `EINTR`: read was interrupted, try again
816 * * `EIO`: Unknown I/O error
817 * * `ECONNABORTED`: Input BB does not exist (`NULL`)
818 *
819 * The reason we are not using `APR_TO_OS_ERROR` to map `apr_status_t`
820 * to errnos is this warning [in the APR documentation][apr-warn]:
821 *
822 * > If the statcode was not created by apr_get_os_error or
823 * > APR_FROM_OS_ERROR, the results are undefined.
824 *
825 * We cannot know if this applies to any error we might encounter.
826 *
827 * @param ptr GnuTLS session data pointer (the mod_gnutls context
828 * structure)
829 *
830 * @param buffer buffer for the read data
831 *
832 * @param len maximum number of bytes to read (must fit into the
833 * buffer)
834 *
835 * @return The number of bytes read (may be zero on EOF), or `-1` on
836 * error. Note that some errors may warrant another try (see above).
837 *
838 * [apr-warn]: https://apr.apache.org/docs/apr/1.4/group__apr__errno.html#ga2385cae04b04afbdcb65f1a45c4d8506 "Apache Portable Runtime: Error Codes"
839 */
840ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
841                           void *buffer, size_t len)
842{
843    mgs_handle_t *ctxt = ptr;
844    apr_status_t rc;
845    apr_size_t in = len;
846    apr_read_type_e block = ctxt->input_block;
847
848    ctxt->input_rc = APR_SUCCESS;
849
850    /* If Len = 0, we don't do anything. */
851    if (!len || buffer == NULL)
852    {
853        return 0;
854    }
855    /* Input bucket brigade is missing, EOF */
856    if (!ctxt->input_bb)
857    {
858        ctxt->input_rc = APR_EOF;
859        gnutls_transport_set_errno(ctxt->session, ECONNABORTED);
860        return -1;
861    }
862
863    if (APR_BRIGADE_EMPTY(ctxt->input_bb))
864    {
865        rc = ap_get_brigade(ctxt->input_filter->next,
866                            ctxt->input_bb, AP_MODE_READBYTES,
867                            ctxt->input_block, in);
868
869        /* Not a problem, there was simply no data ready yet.
870         */
871        if (APR_STATUS_IS_EAGAIN(rc) || APR_STATUS_IS_EINTR(rc)
872            || (rc == APR_SUCCESS
873                && APR_BRIGADE_EMPTY(ctxt->input_bb)))
874        {
875            /* Turning APR_SUCCESS into APR_EINTR isn't ideal, but
876             * it's the best matching error code for "didn't get data,
877             * but read didn't permanently fail either." */
878            ctxt->input_rc = (rc != APR_SUCCESS ? rc : APR_EINTR);
879            gnutls_transport_set_errno(ctxt->session,
880                                       EAI_APR_TO_RAW(ctxt->input_rc));
881            return -1;
882        }
883
884        /* Blocking ap_get_brigade() can return a timeout status,
885         * sometimes after a very short time. "Don't give up, just
886         * return the timeout" is what mod_ssl does. */
887        if (ctxt->input_block == APR_BLOCK_READ
888            && APR_STATUS_IS_TIMEUP(rc)
889            && APR_BRIGADE_EMPTY(ctxt->input_bb))
890        {
891            ctxt->input_rc = rc;
892            gnutls_transport_set_errno(ctxt->session, EAGAIN);
893            return -1;
894        }
895
896        if (rc != APR_SUCCESS)
897        {
898            /* Unexpected errors discard the brigade */
899            ap_log_cerror(APLOG_MARK, APLOG_INFO, rc, ctxt->c,
900                          "%s: Unexpected error!", __func__);
901            apr_brigade_cleanup(ctxt->input_bb);
902            ctxt->input_bb = NULL;
903            gnutls_transport_set_errno(ctxt->session, EIO);
904            return -1;
905        }
906    }
907
908    ctxt->input_rc = brigade_consume(ctxt->input_bb, block, buffer, &len);
909
910    if (ctxt->input_rc == APR_SUCCESS)
911    {
912        return (ssize_t) len;
913    }
914
915    if (APR_STATUS_IS_EAGAIN(ctxt->input_rc)
916        || APR_STATUS_IS_EINTR(ctxt->input_rc))
917    {
918        if (len == 0)
919        {
920            gnutls_transport_set_errno(ctxt->session,
921                                       EAI_APR_TO_RAW(ctxt->input_rc));
922            return -1;
923        }
924
925        return (ssize_t) len;
926    }
927
928    /* Unexpected errors and APR_EOF clean out the brigade.
929     * Subsequent calls will return APR_EOF. */
930    apr_brigade_cleanup(ctxt->input_bb);
931    ctxt->input_bb = NULL;
932
933    if (APR_STATUS_IS_EOF(ctxt->input_rc) && len)
934    {
935        /* Some data has been received before EOF, return it. */
936        return (ssize_t) len;
937    }
938
939    gnutls_transport_set_errno(ctxt->session, EIO);
940    return -1;
941}
942
943/**
944 * Push function for GnuTLS
945 *
946 * `gnutls_transport_set_errno()` will be called with `EAGAIN` or
947 * `EINTR` on recoverable errors, or `EIO` in case of unexpected
948 * errors. See the description of mgs_transport_read() for details on
949 * possible error codes.
950 *
951 * @param ptr GnuTLS session data pointer (the mod_gnutls context
952 * structure)
953 *
954 * @param buffer buffer containing the data to send
955 *
956 * @param len length of the data
957 * buffer)
958 *
959 * @return The number of written bytes, or `-1` on error. Note that
960 * some errors may warrant another try (see above).
961 */
962ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
963                            const void *buffer, size_t len)
964{
965    mgs_handle_t *ctxt = ptr;
966
967    /* pass along the encrypted data
968     * need to flush since we're using SSL's malloc-ed buffer
969     * which will be overwritten once we leave here
970     */
971    apr_bucket *bucket = apr_bucket_transient_create(buffer, len,
972            ctxt->output_bb->
973            bucket_alloc);
974    ctxt->output_length += len;
975    APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, bucket);
976
977    if (write_flush(ctxt) < 0)
978    {
979        /* We encountered an error. APR_EINTR or APR_EAGAIN can be
980         * handled, treat everything else as a generic I/O error. */
981        int err = EIO;
982        if (APR_STATUS_IS_EAGAIN(ctxt->output_rc)
983            || APR_STATUS_IS_EINTR(ctxt->output_rc))
984            err = EAI_APR_TO_RAW(ctxt->output_rc);
985
986        gnutls_transport_set_errno(ctxt->session, err);
987        return -1;
988    }
989    return len;
990}
Note: See TracBrowser for help on using the repository browser.