source: mod_gnutls/src/gnutls_io.c @ 9db4dcd

proxy-ticket
Last change on this file since 9db4dcd was 9db4dcd, checked in by Fiona Klute <fiona.klute@…>, 10 months ago

Handle GNUTLS_E_GOT_APPLICATION_DATA on gnutls_reauth()

Pending application data is cached in the connection input buffer, so
repeated attempts won't cause more memory allocations. If the buffer
is too small HTTP_REQUEST_ENTITY_TOO_LARGE is sent to the client.

The reauthentication test now contains a POST request so this code
path may (!) be taken during the test suite run.

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