source: mod_gnutls/src/gnutls_io.c @ 265159d

debian/masterdebian/stretch-backportsupstream
Last change on this file since 265159d was 265159d, checked in by Thomas Klute <thomas2.klute@…>, 11 months ago

Send SNI for proxy connections

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