source: mod_gnutls/src/gnutls_io.c @ c3ad933

debian/masterdebian/stretch-backportsupstream
Last change on this file since c3ad933 was c3ad933, checked in by Thomas Klute <thomas2.klute@…>, 3 years ago

Remove stale support code for Apache versions before 2.2

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