source: mod_gnutls/src/gnutls_io.c @ e151b6f

asyncio
Last change on this file since e151b6f was 764fef3, checked in by Fiona Klute <fiona.klute@…>, 6 months ago

Load cached proxy TLS sessions from cache

  • Property mode set to 100644
File size: 36.5 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, and load cached
388     * session if any. */
389    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
390        mgs_set_proxy_handshake_ext(ctxt);
391
392tryagain:
393    do {
394        ret = gnutls_handshake(ctxt->session);
395        maxtries--;
396    } while ((ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN)
397            && maxtries > 0);
398
399    if (maxtries < 1) {
400        ctxt->status = -1;
401        ap_log_cerror(APLOG_MARK, APLOG_ERR, 0, ctxt->c,
402                "GnuTLS: Handshake Failed. Hit Maximum Attempts");
403        if (ctxt->session) {
404            gnutls_alert_send(ctxt->session, GNUTLS_AL_FATAL,
405                    gnutls_error_to_alert
406                    (GNUTLS_E_INTERNAL_ERROR, NULL));
407            gnutls_deinit(ctxt->session);
408        }
409        ctxt->session = NULL;
410        return -1;
411    }
412
413    if (ret < 0) {
414        if (ret == GNUTLS_E_WARNING_ALERT_RECEIVED
415                || ret == GNUTLS_E_FATAL_ALERT_RECEIVED) {
416            errcode = gnutls_alert_get(ctxt->session);
417            ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
418                          "GnuTLS: Handshake Alert (%d) '%s'.",
419                          errcode, gnutls_alert_get_name(errcode));
420        }
421
422        if (!gnutls_error_is_fatal(ret)) {
423            ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
424                          "GnuTLS: Non-Fatal Handshake Error: (%d) '%s'",
425                          ret, gnutls_strerror(ret));
426            goto tryagain;
427        }
428        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
429                "GnuTLS: Handshake Failed (%d) '%s'", ret,
430                gnutls_strerror(ret));
431        ctxt->status = -1;
432        if (ctxt->session) {
433            gnutls_alert_send(ctxt->session, GNUTLS_AL_FATAL,
434                    gnutls_error_to_alert(ret,
435                    NULL));
436            gnutls_deinit(ctxt->session);
437        }
438        ctxt->session = NULL;
439        return ret;
440    } else {
441        /* all done with the handshake */
442        ctxt->status = 1;
443        if (gnutls_session_is_resumed(ctxt->session))
444        {
445            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
446                          "%s: TLS session resumed.", __func__);
447        }
448        return GNUTLS_E_SUCCESS;
449    }
450}
451
452
453
454int mgs_reauth(mgs_handle_t *ctxt, request_rec *r)
455{
456    if (ctxt->session == NULL)
457        return GNUTLS_E_INVALID_REQUEST;
458
459    /* Initialize to error to avoid false-good return value. */
460    int rv = GNUTLS_E_INTERNAL_ERROR;
461    int tries = 0;
462
463    do
464    {
465        rv = gnutls_reauth(ctxt->session, 0);
466        tries++;
467
468        /* GNUTLS_E_GOT_APPLICATION_DATA can (randomly, depending on
469         * timing) happen with a request containing a body. According to
470         * https://tools.ietf.org/html/rfc8446#appendix-E.1.2
471         * post-handshake authentication proves that the authenticated
472         * party is the one that did the handshake, so caching the data
473         * is appropriate. */
474        if (rv == GNUTLS_E_GOT_APPLICATION_DATA)
475        {
476            /* Fill connection input buffer using a speculative read. */
477            apr_size_t len = sizeof(ctxt->input_buffer);
478            ctxt->input_mode = AP_MODE_SPECULATIVE;
479            apr_status_t status =
480                gnutls_io_input_read(ctxt, ctxt->input_buffer, &len);
481            if (status == APR_SUCCESS)
482            {
483                ap_log_rerror(APLOG_MARK, APLOG_DEBUG, status, r,
484                              "%s: cached %" APR_SIZE_T_FMT " bytes.",
485                              __func__, len);
486                /* If the cache was too small to accept all pending data
487                 * we'll get GNUTLS_E_GOT_APPLICATION_DATA again, and the
488                 * authz hook will return HTTP_REQUEST_ENTITY_TOO_LARGE to
489                 * the client. */
490                rv = gnutls_reauth(ctxt->session, 0);
491            }
492            else
493                ap_log_rerror(APLOG_MARK, APLOG_INFO, status, r,
494                              "%s: buffering request data failed!",
495                              __func__);
496        }
497        /* Retry on GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN, whether
498         * from initial gnutls_reauth() call or after buffering. */
499    } while (tries < HANDSHAKE_MAX_TRIES
500             && (rv == GNUTLS_E_INTERRUPTED || rv == GNUTLS_E_AGAIN));
501
502    if (rv != GNUTLS_E_SUCCESS)
503    {
504        ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
505                      "%s: post-handshake authentication failed: %s (%d)",
506                      __func__, gnutls_strerror(rv), rv);
507        return rv;
508    }
509
510    return GNUTLS_E_SUCCESS;
511}
512
513
514
515/**
516 * Close the TLS session associated with the given connection
517 * structure and free its resources
518 *
519 * @param ctxt the mod_gnutls session context
520 *
521 * @return a GnuTLS status code, hopefully `GNUTLS_E_SUCCESS`
522 */
523static int mgs_bye(mgs_handle_t* ctxt)
524{
525    int ret = GNUTLS_E_SUCCESS;
526    /* End Of Connection */
527    if (ctxt->session != NULL)
528    {
529        /* Try A Clean Shutdown */
530        do {
531            ret = gnutls_bye(ctxt->session, GNUTLS_SHUT_WR);
532        } while (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
533        if (ret != GNUTLS_E_SUCCESS)
534            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_EGENERAL, ctxt->c,
535                          "%s: Error while closing TLS %sconnection: "
536                          "'%s' (%d)",
537                          __func__, IS_PROXY_STR(ctxt),
538                          gnutls_strerror(ret), (int) ret);
539        else
540            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
541                          "%s: TLS %sconnection closed.",
542                          __func__, IS_PROXY_STR(ctxt));
543        /* De-Initialize Session */
544        gnutls_deinit(ctxt->session);
545        ctxt->session = NULL;
546    }
547    return ret;
548}
549
550
551
552apr_status_t mgs_filter_input(ap_filter_t * f,
553        apr_bucket_brigade * bb,
554        ap_input_mode_t mode,
555        apr_read_type_e block, apr_off_t readbytes)
556{
557    apr_status_t status = APR_SUCCESS;
558    mgs_handle_t *ctxt = (mgs_handle_t *) f->ctx;
559    apr_size_t len = sizeof (ctxt->input_buffer);
560
561    if (f->c->aborted) {
562        apr_bucket *bucket =
563                apr_bucket_eos_create(f->c->bucket_alloc);
564        APR_BRIGADE_INSERT_TAIL(bb, bucket);
565        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
566                      "%s: %sconnection aborted",
567                      __func__, IS_PROXY_STR(ctxt));
568        return APR_ECONNABORTED;
569    }
570
571    if (ctxt->status == 0) {
572        int ret = gnutls_do_handshake(ctxt);
573        if (ret == GNUTLS_E_SUCCESS)
574            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
575                          "%s: TLS %sconnection opened.",
576                          __func__, IS_PROXY_STR(ctxt));
577    }
578
579    if (ctxt->status < 0)
580    {
581        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
582                      "%s: %sconnection failed, cannot provide data!",
583                      __func__, IS_PROXY_STR(ctxt));
584        apr_bucket *bucket =
585                apr_bucket_eos_create(f->c->bucket_alloc);
586        APR_BRIGADE_INSERT_TAIL(bb, bucket);
587        return APR_ECONNABORTED;
588    }
589
590    /* XXX: we don't currently support anything other than these modes. */
591    if (mode != AP_MODE_READBYTES && mode != AP_MODE_GETLINE &&
592            mode != AP_MODE_SPECULATIVE && mode != AP_MODE_INIT) {
593        return APR_ENOTIMPL;
594    }
595
596    ctxt->input_mode = mode;
597    ctxt->input_block = block;
598
599    if (ctxt->input_mode == AP_MODE_READBYTES ||
600            ctxt->input_mode == AP_MODE_SPECULATIVE) {
601        if (readbytes < 0) {
602            /* you're asking us to speculatively read a negative number of bytes! */
603            return APR_ENOTIMPL;
604        }
605        /* 'readbytes' and 'len' are of different integer types, which
606         * might have different lengths. Read sizes should be too
607         * small for 32 or 64 bit to matter, but we have to make
608         * sure. */
609#if defined(__GNUC__) && __GNUC__ < 5 && !defined(__clang__)
610        if ((apr_size_t) readbytes < len)
611        {
612            /* If readbytes is negative the function fails in the
613             * check above, but the compiler doesn't get that. */
614            if (__builtin_expect(imaxabs(readbytes) > SIZE_MAX, 0))
615            {
616                ap_log_cerror(APLOG_MARK, APLOG_CRIT, APR_EINVAL, ctxt->c,
617                              "%s: prevented buffer length overflow",
618                              __func__);
619                return APR_EINVAL;
620            }
621            len = (apr_size_t) readbytes;
622        }
623#else
624        if ((apr_size_t) readbytes < len
625            && __builtin_add_overflow(readbytes, 0, &len))
626        {
627            ap_log_cerror(APLOG_MARK, APLOG_CRIT, APR_EINVAL, ctxt->c,
628                          "%s: prevented buffer length overflow",
629                          __func__);
630            return APR_EINVAL;
631        }
632#endif
633        status =
634                gnutls_io_input_read(ctxt, ctxt->input_buffer, &len);
635    } else if (ctxt->input_mode == AP_MODE_GETLINE) {
636        status =
637                gnutls_io_input_getline(ctxt, ctxt->input_buffer,
638                &len);
639    } else {
640        /* We have no idea what you are talking about, so return an error. */
641        return APR_ENOTIMPL;
642    }
643
644    if (status != APR_SUCCESS)
645    {
646        /* no data for nonblocking read, return APR_EAGAIN */
647        if ((block == APR_NONBLOCK_READ) && APR_STATUS_IS_EINTR(status))
648            return APR_EAGAIN;
649
650        /* Close TLS session and free resources on EOF,
651         * gnutls_io_filter_error will add an EOS bucket */
652        if (APR_STATUS_IS_EOF(status))
653            mgs_bye(ctxt);
654
655        return gnutls_io_filter_error(f, bb, status);
656    }
657
658    /* Create a transient bucket out of the decrypted data. */
659    if (len > 0) {
660        apr_bucket *bucket =
661                apr_bucket_transient_create(ctxt->input_buffer, len,
662                f->c->bucket_alloc);
663        APR_BRIGADE_INSERT_TAIL(bb, bucket);
664    }
665
666    return status;
667}
668
669/**
670 * Try to flush the output bucket brigade.
671 *
672 * @param ctxt the mod_gnutls session context
673 *
674 * @return `1` on success, `-1` on failure.
675 */
676static ssize_t write_flush(mgs_handle_t * ctxt) {
677    apr_bucket *e;
678
679    if (!(ctxt->output_blen || ctxt->output_length)) {
680        ctxt->output_rc = APR_SUCCESS;
681        return 1;
682    }
683
684    if (ctxt->output_blen) {
685        e = apr_bucket_transient_create(ctxt->output_buffer,
686                ctxt->output_blen,
687                ctxt->output_bb->
688                bucket_alloc);
689        /* we filled this buffer first so add it to the
690         *               * head of the brigade
691         *                               */
692        APR_BRIGADE_INSERT_HEAD(ctxt->output_bb, e);
693        ctxt->output_blen = 0;
694    }
695
696    ctxt->output_length = 0;
697    e = apr_bucket_flush_create(ctxt->output_bb->bucket_alloc);
698    APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, e);
699
700    ctxt->output_rc = ap_pass_brigade(ctxt->output_filter->next,
701            ctxt->output_bb);
702    /* clear the brigade to be ready for next time */
703    apr_brigade_cleanup(ctxt->output_bb);
704
705    return (ctxt->output_rc == APR_SUCCESS) ? 1 : -1;
706}
707
708apr_status_t mgs_filter_output(ap_filter_t * f, apr_bucket_brigade * bb) {
709    int ret;
710    mgs_handle_t *ctxt = (mgs_handle_t *) f->ctx;
711    apr_status_t status = APR_SUCCESS;
712    apr_read_type_e rblock = APR_NONBLOCK_READ;
713
714    if (f->c->aborted) {
715        apr_brigade_cleanup(bb);
716        return APR_ECONNABORTED;
717    }
718
719    if (ctxt->status == 0) {
720        ret = gnutls_do_handshake(ctxt);
721        if (ret == GNUTLS_E_SUCCESS)
722            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
723                          "%s: TLS %sconnection opened.",
724                          __func__, IS_PROXY_STR(ctxt));
725        else if (ctxt->is_proxy)
726        {
727            /* If mod_proxy receives an error while trying to send its
728             * request it sends an "invalid request" error to the
729             * client. By pretending we could send the request
730             * mod_proxy continues its processing and sends a proper
731             * "proxy error" message when there's no response to read. */
732            apr_bucket *bucket = apr_bucket_eos_create(f->c->bucket_alloc);
733            APR_BRIGADE_INSERT_TAIL(bb, bucket);
734            return APR_SUCCESS;
735        }
736        /* No final else here, the "ctxt->status < 0" check below will
737         * catch that. */
738    }
739
740    if (ctxt->status < 0)
741    {
742        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
743                      "%s: %sconnection failed, refusing to send.",
744                      __func__, IS_PROXY_STR(ctxt));
745        return APR_ECONNABORTED;
746    }
747
748    while (!APR_BRIGADE_EMPTY(bb)) {
749        apr_bucket *bucket = APR_BRIGADE_FIRST(bb);
750
751        if (APR_BUCKET_IS_EOS(bucket)) {
752            return ap_pass_brigade(f->next, bb);
753        } else if (APR_BUCKET_IS_FLUSH(bucket)) {
754            /* Try Flush */
755            if (write_flush(ctxt) < 0) {
756                /* Flush Error */
757                return ctxt->output_rc;
758            }
759            /* cleanup! */
760            apr_bucket_delete(bucket);
761        } else if (AP_BUCKET_IS_EOC(bucket)) {
762            /* End Of Connection, close TLS session and free
763             * resources */
764            mgs_bye(ctxt);
765            /* cleanup! */
766            apr_bucket_delete(bucket);
767            /* Pass next brigade! */
768            return ap_pass_brigade(f->next, bb);
769        } else {
770            /* filter output */
771            const char *data;
772            apr_size_t len;
773
774            status = apr_bucket_read(bucket, &data, &len, rblock);
775
776            if (APR_STATUS_IS_EAGAIN(status)) {
777                /* No data available so Flush! */
778                if (write_flush(ctxt) < 0) {
779                    return ctxt->output_rc;
780                }
781                /* Try again with a blocking read. */
782                rblock = APR_BLOCK_READ;
783                continue;
784            }
785
786            rblock = APR_NONBLOCK_READ;
787
788            if (!APR_STATUS_IS_EOF(status)
789                    && (status != APR_SUCCESS)) {
790                return status;
791            }
792
793            if (len > 0) {
794
795                if (ctxt->session == NULL) {
796                    ret = GNUTLS_E_INVALID_REQUEST;
797                } else {
798                    do {
799                        ret =
800                                gnutls_record_send
801                                (ctxt->session, data,
802                                len);
803                    } while (ret == GNUTLS_E_INTERRUPTED
804                            || ret == GNUTLS_E_AGAIN);
805                }
806
807                if (ret < 0) {
808                    /* error sending output */
809                    ap_log_cerror(APLOG_MARK, APLOG_INFO, ctxt->output_rc,
810                                  ctxt->c,
811                                  "GnuTLS: Error writing data. (%d) '%s'",
812                                  ret, gnutls_strerror(ret));
813                    if (ctxt->output_rc == APR_SUCCESS) {
814                        ctxt->output_rc =
815                                APR_EGENERAL;
816                        return ctxt->output_rc;
817                    }
818                } else if ((apr_size_t)(ret) != len) {
819                    /* we know the above cast is OK because len > 0 and ret >= 0 */
820                    /* Not able to send the entire bucket,
821                       split it and send it again. */
822                    apr_bucket_split(bucket, ret);
823                }
824            }
825
826            apr_bucket_delete(bucket);
827        }
828    }
829
830    return status;
831}
832
833int mgs_transport_read_ready(gnutls_transport_ptr_t ptr,
834                             unsigned int ms)
835{
836    mgs_handle_t *ctxt = ptr;
837    ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
838                  "%s: called with %u ms wait", __func__, ms);
839
840    apr_pool_t *tmp = NULL;
841    apr_status_t rv = apr_pool_create(&tmp, ctxt->c->pool);
842    if (rv != APR_SUCCESS)
843    {
844        ap_log_cerror(APLOG_MARK, APLOG_ERR, APR_ENOMEM, ctxt->c,
845                      "could not create temporary pool for %s",
846                     __func__);
847        return -1;
848    }
849
850    apr_bucket_brigade *bb = apr_brigade_create(tmp, ctxt->c->bucket_alloc);
851
852    /* one byte non-blocking speculative read to see if there's data
853     * in the filter chain */
854    rv = ap_get_brigade(ctxt->input_filter->next, bb, AP_MODE_SPECULATIVE,
855                        APR_NONBLOCK_READ, 1);
856
857    int result;
858    if (rv == APR_SUCCESS && !APR_BRIGADE_EMPTY(bb))
859        result = 1;
860    else
861        result = 0;
862
863    apr_brigade_destroy(bb);
864
865    /* If GnuTLS doesn't want to wait or we already have data,
866     * return. */
867    if (ms == 0 || result == 1)
868    {
869        apr_pool_destroy(tmp);
870        return result;
871    }
872
873    ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
874                  "%s: waiting for data", __func__);
875
876    /* No data yet, and we're supposed to wait, so wait for data on
877     * the socket. */
878    apr_socket_t *sock = ap_get_conn_socket(ctxt->c);
879    apr_interval_time_t timeout = -1;
880    apr_interval_time_t original_timeout;
881    rv = apr_socket_timeout_get(sock, &original_timeout);
882    if (rv != APR_SUCCESS)
883    {
884        ap_log_cerror(APLOG_MARK, APLOG_ERR, rv, ctxt->c,
885                      "%s: could not get socket timeout",
886                      __func__);
887        apr_pool_destroy(tmp);
888        return -1;
889    }
890
891    /* If GnuTLS requests an "indefinite" wait we do not want to mess
892     * with whatever Apache does by default. Otherwise temporarily
893     * adjust the socket timeout. */
894    if (ms != GNUTLS_INDEFINITE_TIMEOUT)
895    {
896        /* apr_interval_time_t is in microseconds */
897        if (__builtin_mul_overflow(ms, 1000, &timeout))
898        {
899            ap_log_cerror(APLOG_MARK, APLOG_ERR, APR_ENOMEM, ctxt->c,
900                          "%s: overflow while calculating timeout!",
901                          __func__);
902            apr_pool_destroy(tmp);
903            return -1;
904        }
905        rv = apr_socket_timeout_set(sock, timeout);
906        if (rv != APR_SUCCESS)
907        {
908            ap_log_cerror(APLOG_MARK, APLOG_ERR, rv, ctxt->c,
909                          "%s: could not set socket timeout",
910                          __func__);
911            apr_pool_destroy(tmp);
912            return -1;
913        }
914    }
915
916#if APR_MAJOR_VERSION < 2
917    apr_pollfd_t pollset;
918    apr_int32_t nsds;
919    pollset.p = tmp;
920    pollset.desc_type = APR_POLL_SOCKET;
921    pollset.reqevents = APR_POLLIN | APR_POLLHUP;
922    pollset.desc.s = sock;
923    rv = apr_poll(&pollset, 1, &nsds, timeout);
924#else
925    rv = apr_socket_wait(sock, APR_WAIT_READ);
926#endif
927    apr_pool_destroy(tmp);
928
929    if (ms != GNUTLS_INDEFINITE_TIMEOUT)
930    {
931        /* We still need "rv" below, so new variable. */
932        apr_status_t rc = apr_socket_timeout_set(sock, original_timeout);
933        if (rc != APR_SUCCESS)
934        {
935            ap_log_cerror(APLOG_MARK, APLOG_CRIT, rc, ctxt->c,
936                          "%s: could not restore socket timeout",
937                          __func__);
938            return -1;
939        }
940    }
941
942    if (rv == APR_SUCCESS)
943        return 1;
944    else if (APR_STATUS_IS_TIMEUP(rv))
945        return 0;
946    else
947    {
948        ap_log_cerror(APLOG_MARK, APLOG_ERR, rv, ctxt->c,
949                      "%s: waiting for data on connection socket failed",
950                      __func__);
951        return -1;
952    }
953}
954
955/**
956 * Pull function for GnuTLS
957 *
958 * Generic errnos used for `gnutls_transport_set_errno()`:
959 * * `EAGAIN`: no data available at the moment, try again (maybe later)
960 * * `EINTR`: read was interrupted, try again
961 * * `EIO`: Unknown I/O error
962 * * `ECONNABORTED`: Input BB does not exist (`NULL`)
963 *
964 * The reason we are not using `APR_TO_OS_ERROR` to map `apr_status_t`
965 * to errnos is this warning [in the APR documentation][apr-warn]:
966 *
967 * > If the statcode was not created by apr_get_os_error or
968 * > APR_FROM_OS_ERROR, the results are undefined.
969 *
970 * We cannot know if this applies to any error we might encounter.
971 *
972 * @param ptr GnuTLS session data pointer (the mod_gnutls context
973 * structure)
974 *
975 * @param buffer buffer for the read data
976 *
977 * @param len maximum number of bytes to read (must fit into the
978 * buffer)
979 *
980 * @return The number of bytes read (may be zero on EOF), or `-1` on
981 * error. Note that some errors may warrant another try (see above).
982 *
983 * [apr-warn]: https://apr.apache.org/docs/apr/1.4/group__apr__errno.html#ga2385cae04b04afbdcb65f1a45c4d8506 "Apache Portable Runtime: Error Codes"
984 */
985ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
986                           void *buffer, size_t len)
987{
988    mgs_handle_t *ctxt = ptr;
989    apr_status_t rc;
990    apr_size_t in = len;
991    apr_read_type_e block = ctxt->input_block;
992
993    ctxt->input_rc = APR_SUCCESS;
994
995    /* If Len = 0, we don't do anything. */
996    if (!len || buffer == NULL)
997    {
998        return 0;
999    }
1000    /* Input bucket brigade is missing, EOF */
1001    if (!ctxt->input_bb)
1002    {
1003        ctxt->input_rc = APR_EOF;
1004        gnutls_transport_set_errno(ctxt->session, ECONNABORTED);
1005        return -1;
1006    }
1007
1008    if (APR_BRIGADE_EMPTY(ctxt->input_bb))
1009    {
1010        rc = ap_get_brigade(ctxt->input_filter->next,
1011                            ctxt->input_bb, AP_MODE_READBYTES,
1012                            ctxt->input_block, in);
1013
1014        /* Not a problem, there was simply no data ready yet.
1015         */
1016        if (APR_STATUS_IS_EAGAIN(rc) || APR_STATUS_IS_EINTR(rc)
1017            || (rc == APR_SUCCESS
1018                && APR_BRIGADE_EMPTY(ctxt->input_bb)))
1019        {
1020            /* Turning APR_SUCCESS into APR_EINTR isn't ideal, but
1021             * it's the best matching error code for "didn't get data,
1022             * but read didn't permanently fail either." */
1023            ctxt->input_rc = (rc != APR_SUCCESS ? rc : APR_EINTR);
1024            gnutls_transport_set_errno(ctxt->session,
1025                                       EAI_APR_TO_RAW(ctxt->input_rc));
1026            return -1;
1027        }
1028
1029        /* Blocking ap_get_brigade() can return a timeout status,
1030         * sometimes after a very short time. "Don't give up, just
1031         * return the timeout" is what mod_ssl does. */
1032        if (ctxt->input_block == APR_BLOCK_READ
1033            && APR_STATUS_IS_TIMEUP(rc)
1034            && APR_BRIGADE_EMPTY(ctxt->input_bb))
1035        {
1036            ctxt->input_rc = rc;
1037            gnutls_transport_set_errno(ctxt->session, EAGAIN);
1038            return -1;
1039        }
1040
1041        if (rc != APR_SUCCESS)
1042        {
1043            /* Unexpected errors discard the brigade */
1044            ap_log_cerror(APLOG_MARK, APLOG_INFO, rc, ctxt->c,
1045                          "%s: Unexpected error!", __func__);
1046            apr_brigade_cleanup(ctxt->input_bb);
1047            ctxt->input_bb = NULL;
1048            gnutls_transport_set_errno(ctxt->session, EIO);
1049            return -1;
1050        }
1051    }
1052
1053    ctxt->input_rc = brigade_consume(ctxt->input_bb, block, buffer, &len);
1054
1055    if (ctxt->input_rc == APR_SUCCESS)
1056    {
1057        return (ssize_t) len;
1058    }
1059
1060    if (APR_STATUS_IS_EAGAIN(ctxt->input_rc)
1061        || APR_STATUS_IS_EINTR(ctxt->input_rc))
1062    {
1063        if (len == 0)
1064        {
1065            gnutls_transport_set_errno(ctxt->session,
1066                                       EAI_APR_TO_RAW(ctxt->input_rc));
1067            return -1;
1068        }
1069
1070        return (ssize_t) len;
1071    }
1072
1073    /* Unexpected errors and APR_EOF clean out the brigade.
1074     * Subsequent calls will return APR_EOF. */
1075    apr_brigade_cleanup(ctxt->input_bb);
1076    ctxt->input_bb = NULL;
1077
1078    if (APR_STATUS_IS_EOF(ctxt->input_rc) && len)
1079    {
1080        /* Some data has been received before EOF, return it. */
1081        return (ssize_t) len;
1082    }
1083
1084    gnutls_transport_set_errno(ctxt->session, EIO);
1085    return -1;
1086}
1087
1088/**
1089 * Push function for GnuTLS
1090 *
1091 * `gnutls_transport_set_errno()` will be called with `EAGAIN` or
1092 * `EINTR` on recoverable errors, or `EIO` in case of unexpected
1093 * errors. See the description of mgs_transport_read() for details on
1094 * possible error codes.
1095 *
1096 * @param ptr GnuTLS session data pointer (the mod_gnutls context
1097 * structure)
1098 *
1099 * @param buffer buffer containing the data to send
1100 *
1101 * @param len length of the data
1102 * buffer)
1103 *
1104 * @return The number of written bytes, or `-1` on error. Note that
1105 * some errors may warrant another try (see above).
1106 */
1107ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
1108                            const void *buffer, size_t len)
1109{
1110    mgs_handle_t *ctxt = ptr;
1111
1112    /* pass along the encrypted data
1113     * need to flush since we're using SSL's malloc-ed buffer
1114     * which will be overwritten once we leave here
1115     */
1116    apr_bucket *bucket = apr_bucket_transient_create(buffer, len,
1117            ctxt->output_bb->
1118            bucket_alloc);
1119    ctxt->output_length += len;
1120    APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, bucket);
1121
1122    if (write_flush(ctxt) < 0)
1123    {
1124        /* We encountered an error. APR_EINTR or APR_EAGAIN can be
1125         * handled, treat everything else as a generic I/O error. */
1126        int err = EIO;
1127        if (APR_STATUS_IS_EAGAIN(ctxt->output_rc)
1128            || APR_STATUS_IS_EINTR(ctxt->output_rc))
1129            err = EAI_APR_TO_RAW(ctxt->output_rc);
1130
1131        gnutls_transport_set_errno(ctxt->session, err);
1132        return -1;
1133    }
1134    return len;
1135}
Note: See TracBrowser for help on using the repository browser.