source: mod_gnutls/src/gnutls_io.c @ 6fa6095

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

Partial post-handshake auth support

Needs proper error handling, especially for
GNUTLS_E_GOT_APPLICATION_DATA, which can randomly happen with requests
containing a body.

  • Property mode set to 100644
File size: 31.9 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                        rc);
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)
454{
455    if (ctxt->session == NULL)
456        return GNUTLS_E_INVALID_REQUEST;
457
458    int rv = gnutls_reauth(ctxt->session, 0);
459    // TODO: Handle non-fatal errors: GNUTLS_E_INTERRUPTED,
460    // GNUTLS_E_AGAIN, GNUTLS_E_GOT_APPLICATION_DATA
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    /* Allocate cache to content-length (if available), with an upper
469     * limit to prevent resource exhaustion attacks. Do we have to
470     * prevent creating multiple caches for one connection? */
471    /* ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r, */
472    /*               "Request content: %s bytes", */
473    /*               apr_table_get(r->headers_in, "Content-Length")); */
474    /* If the cache is too small,
475     * a) return HTTP_REQUEST_ENTITY_TOO_LARGE to the client
476     * b) IF reauth was successful set Retry-After to immediately: */
477    /* apr_table_setn(r->err_headers_out, "Retry-After", "0"); */
478
479    if (rv != GNUTLS_E_SUCCESS)
480    {
481        ap_log_cerror(APLOG_MARK, APLOG_WARNING, 0, ctxt->c,
482                      "Reauthentication failed: %s (%d)",
483                      gnutls_strerror(rv), rv);
484        return rv;
485    }
486
487    return GNUTLS_E_SUCCESS;
488}
489
490
491
492/**
493 * Close the TLS session associated with the given connection
494 * structure and free its resources
495 *
496 * @param ctxt the mod_gnutls session context
497 *
498 * @return a GnuTLS status code, hopefully `GNUTLS_E_SUCCESS`
499 */
500static int mgs_bye(mgs_handle_t* ctxt)
501{
502    int ret = GNUTLS_E_SUCCESS;
503    /* End Of Connection */
504    if (ctxt->session != NULL)
505    {
506        /* Try A Clean Shutdown */
507        do {
508            ret = gnutls_bye(ctxt->session, GNUTLS_SHUT_WR);
509        } while (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
510        if (ret != GNUTLS_E_SUCCESS)
511            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_EGENERAL, ctxt->c,
512                          "%s: Error while closing TLS %sconnection: "
513                          "'%s' (%d)",
514                          __func__, IS_PROXY_STR(ctxt),
515                          gnutls_strerror(ret), (int) ret);
516        else
517            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
518                          "%s: TLS %sconnection closed.",
519                          __func__, IS_PROXY_STR(ctxt));
520        /* De-Initialize Session */
521        gnutls_deinit(ctxt->session);
522        ctxt->session = NULL;
523    }
524    return ret;
525}
526
527
528
529apr_status_t mgs_filter_input(ap_filter_t * f,
530        apr_bucket_brigade * bb,
531        ap_input_mode_t mode,
532        apr_read_type_e block, apr_off_t readbytes)
533{
534    apr_status_t status = APR_SUCCESS;
535    mgs_handle_t *ctxt = (mgs_handle_t *) f->ctx;
536    apr_size_t len = sizeof (ctxt->input_buffer);
537
538    if (f->c->aborted) {
539        apr_bucket *bucket =
540                apr_bucket_eos_create(f->c->bucket_alloc);
541        APR_BRIGADE_INSERT_TAIL(bb, bucket);
542        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
543                      "%s: %sconnection aborted",
544                      __func__, IS_PROXY_STR(ctxt));
545        return APR_ECONNABORTED;
546    }
547
548    if (ctxt->status == 0) {
549        int ret = gnutls_do_handshake(ctxt);
550        if (ret == GNUTLS_E_SUCCESS)
551            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
552                          "%s: TLS %sconnection opened.",
553                          __func__, IS_PROXY_STR(ctxt));
554    }
555
556    if (ctxt->status < 0)
557    {
558        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
559                      "%s: %sconnection failed, cannot provide data!",
560                      __func__, IS_PROXY_STR(ctxt));
561        apr_bucket *bucket =
562                apr_bucket_eos_create(f->c->bucket_alloc);
563        APR_BRIGADE_INSERT_TAIL(bb, bucket);
564        return APR_ECONNABORTED;
565    }
566
567    /* XXX: we don't currently support anything other than these modes. */
568    if (mode != AP_MODE_READBYTES && mode != AP_MODE_GETLINE &&
569            mode != AP_MODE_SPECULATIVE && mode != AP_MODE_INIT) {
570        return APR_ENOTIMPL;
571    }
572
573    ctxt->input_mode = mode;
574    ctxt->input_block = block;
575
576    if (ctxt->input_mode == AP_MODE_READBYTES ||
577            ctxt->input_mode == AP_MODE_SPECULATIVE) {
578        if (readbytes < 0) {
579            /* you're asking us to speculatively read a negative number of bytes! */
580            return APR_ENOTIMPL;
581        }
582        /* 'readbytes' and 'len' are of different integer types, which
583         * might have different lengths. Read sizes should be too
584         * small for 32 or 64 bit to matter, but we have to make
585         * sure. */
586#if defined(__GNUC__) && __GNUC__ < 5 && !defined(__clang__)
587        if ((apr_size_t) readbytes < len)
588        {
589            /* If readbytes is negative the function fails in the
590             * check above, but the compiler doesn't get that. */
591            if (__builtin_expect(imaxabs(readbytes) > SIZE_MAX, 0))
592            {
593                ap_log_cerror(APLOG_MARK, APLOG_CRIT, APR_EINVAL, ctxt->c,
594                              "%s: prevented buffer length overflow",
595                              __func__);
596                return APR_EINVAL;
597            }
598            len = (apr_size_t) readbytes;
599        }
600#else
601        if ((apr_size_t) readbytes < len
602            && __builtin_add_overflow(readbytes, 0, &len))
603        {
604            ap_log_cerror(APLOG_MARK, APLOG_CRIT, APR_EINVAL, ctxt->c,
605                          "%s: prevented buffer length overflow",
606                          __func__);
607            return APR_EINVAL;
608        }
609#endif
610        status =
611                gnutls_io_input_read(ctxt, ctxt->input_buffer, &len);
612    } else if (ctxt->input_mode == AP_MODE_GETLINE) {
613        status =
614                gnutls_io_input_getline(ctxt, ctxt->input_buffer,
615                &len);
616    } else {
617        /* We have no idea what you are talking about, so return an error. */
618        return APR_ENOTIMPL;
619    }
620
621    if (status != APR_SUCCESS)
622    {
623        /* no data for nonblocking read, return APR_EAGAIN */
624        if ((block == APR_NONBLOCK_READ) && APR_STATUS_IS_EINTR(status))
625            return APR_EAGAIN;
626
627        /* Close TLS session and free resources on EOF,
628         * gnutls_io_filter_error will add an EOS bucket */
629        if (APR_STATUS_IS_EOF(status))
630            mgs_bye(ctxt);
631
632        return gnutls_io_filter_error(f, bb, status);
633    }
634
635    /* Create a transient bucket out of the decrypted data. */
636    if (len > 0) {
637        apr_bucket *bucket =
638                apr_bucket_transient_create(ctxt->input_buffer, len,
639                f->c->bucket_alloc);
640        APR_BRIGADE_INSERT_TAIL(bb, bucket);
641    }
642
643    return status;
644}
645
646/**
647 * Try to flush the output bucket brigade.
648 *
649 * @param ctxt the mod_gnutls session context
650 *
651 * @return `1` on success, `-1` on failure.
652 */
653static ssize_t write_flush(mgs_handle_t * ctxt) {
654    apr_bucket *e;
655
656    if (!(ctxt->output_blen || ctxt->output_length)) {
657        ctxt->output_rc = APR_SUCCESS;
658        return 1;
659    }
660
661    if (ctxt->output_blen) {
662        e = apr_bucket_transient_create(ctxt->output_buffer,
663                ctxt->output_blen,
664                ctxt->output_bb->
665                bucket_alloc);
666        /* we filled this buffer first so add it to the
667         *               * head of the brigade
668         *                               */
669        APR_BRIGADE_INSERT_HEAD(ctxt->output_bb, e);
670        ctxt->output_blen = 0;
671    }
672
673    ctxt->output_length = 0;
674    e = apr_bucket_flush_create(ctxt->output_bb->bucket_alloc);
675    APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, e);
676
677    ctxt->output_rc = ap_pass_brigade(ctxt->output_filter->next,
678            ctxt->output_bb);
679    /* clear the brigade to be ready for next time */
680    apr_brigade_cleanup(ctxt->output_bb);
681
682    return (ctxt->output_rc == APR_SUCCESS) ? 1 : -1;
683}
684
685apr_status_t mgs_filter_output(ap_filter_t * f, apr_bucket_brigade * bb) {
686    int ret;
687    mgs_handle_t *ctxt = (mgs_handle_t *) f->ctx;
688    apr_status_t status = APR_SUCCESS;
689    apr_read_type_e rblock = APR_NONBLOCK_READ;
690
691    if (f->c->aborted) {
692        apr_brigade_cleanup(bb);
693        return APR_ECONNABORTED;
694    }
695
696    if (ctxt->status == 0) {
697        ret = gnutls_do_handshake(ctxt);
698        if (ret == GNUTLS_E_SUCCESS)
699            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
700                          "%s: TLS %sconnection opened.",
701                          __func__, IS_PROXY_STR(ctxt));
702        else if (ctxt->is_proxy)
703        {
704            /* If mod_proxy receives an error while trying to send its
705             * request it sends an "invalid request" error to the
706             * client. By pretending we could send the request
707             * mod_proxy continues its processing and sends a proper
708             * "proxy error" message when there's no response to read. */
709            apr_bucket *bucket = apr_bucket_eos_create(f->c->bucket_alloc);
710            APR_BRIGADE_INSERT_TAIL(bb, bucket);
711            return APR_SUCCESS;
712        }
713        /* No final else here, the "ctxt->status < 0" check below will
714         * catch that. */
715    }
716
717    if (ctxt->status < 0)
718    {
719        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
720                      "%s: %sconnection failed, refusing to send.",
721                      __func__, IS_PROXY_STR(ctxt));
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.