source: mod_gnutls/src/gnutls_io.c @ 31645b2

debian/masterdebian/stretch-backportsjessie-backportsmsvaupstream
Last change on this file since 31645b2 was 31645b2, checked in by Paul Querna <chip@…>, 15 years ago

working SNI. Not so working Client Cert support.

  • Property mode set to 100644
File size: 21.3 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *
4 *  Licensed under the Apache License, Version 2.0 (the "License");
5 *  you may not use this file except in compliance with the License.
6 *  You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 *  Unless required by applicable law or agreed to in writing, software
11 *  distributed under the License is distributed on an "AS IS" BASIS,
12 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 *  See the License for the specific language governing permissions and
14 *  limitations under the License.
15 *
16 */
17
18#include "mod_gnutls.h"
19
20/**
21 * Describe how the GnuTLS Filter system works here
22 *  - Basicly the same as what mod_ssl does with OpenSSL.
23 *
24 */
25
26#define HTTP_ON_HTTPS_PORT \
27    "GET /" CRLF
28
29#define HTTP_ON_HTTPS_PORT_BUCKET(alloc) \
30    apr_bucket_immortal_create(HTTP_ON_HTTPS_PORT, \
31                               sizeof(HTTP_ON_HTTPS_PORT) - 1, \
32                               alloc)
33
34static apr_status_t gnutls_io_filter_error(ap_filter_t * f,
35                                           apr_bucket_brigade * bb,
36                                           apr_status_t status)
37{
38    mod_gnutls_handle_t *ctxt = (mod_gnutls_handle_t *) f->ctx;
39    apr_bucket *bucket;
40
41    switch (status) {
42    case HTTP_BAD_REQUEST:
43        /* log the situation */
44        ap_log_error(APLOG_MARK, APLOG_INFO, 0,
45                     f->c->base_server,
46                     "GnuTLS handshake failed: HTTP spoken on HTTPS port; "
47                     "trying to send HTML error page");
48
49        ctxt->status = -1;
50
51        /* fake the request line */
52        bucket = HTTP_ON_HTTPS_PORT_BUCKET(f->c->bucket_alloc);
53        break;
54
55    default:
56        return status;
57    }
58
59    APR_BRIGADE_INSERT_TAIL(bb, bucket);
60    bucket = apr_bucket_eos_create(f->c->bucket_alloc);
61    APR_BRIGADE_INSERT_TAIL(bb, bucket);
62
63    return APR_SUCCESS;
64}
65
66static int char_buffer_read(mod_gnutls_char_buffer_t * buffer, char *in,
67                            int inl)
68{
69    if (!buffer->length) {
70        return 0;
71    }
72
73    if (buffer->length > inl) {
74        /* we have have enough to fill the caller's buffer */
75        memcpy(in, buffer->value, inl);
76        buffer->value += inl;
77        buffer->length -= inl;
78    }
79    else {
80        /* swallow remainder of the buffer */
81        memcpy(in, buffer->value, buffer->length);
82        inl = buffer->length;
83        buffer->value = NULL;
84        buffer->length = 0;
85    }
86
87    return inl;
88}
89
90static int char_buffer_write(mod_gnutls_char_buffer_t * buffer, char *in,
91                             int inl)
92{
93    buffer->value = in;
94    buffer->length = inl;
95    return inl;
96}
97
98/**
99 * From mod_ssl / ssl_engine_io.c
100 * This function will read from a brigade and discard the read buckets as it
101 * proceeds.  It will read at most *len bytes.
102 */
103static apr_status_t brigade_consume(apr_bucket_brigade * bb,
104                                    apr_read_type_e block,
105                                    char *c, apr_size_t * len)
106{
107    apr_size_t actual = 0;
108    apr_status_t status = APR_SUCCESS;
109
110    while (!APR_BRIGADE_EMPTY(bb)) {
111        apr_bucket *b = APR_BRIGADE_FIRST(bb);
112        const char *str;
113        apr_size_t str_len;
114        apr_size_t consume;
115
116        /* Justin points out this is an http-ism that might
117         * not fit if brigade_consume is added to APR.  Perhaps
118         * apr_bucket_read(eos_bucket) should return APR_EOF?
119         * Then this becomes mainline instead of a one-off.
120         */
121        if (APR_BUCKET_IS_EOS(b)) {
122            status = APR_EOF;
123            break;
124        }
125
126        /* The reason I'm not offering brigade_consume yet
127         * across to apr-util is that the following call
128         * illustrates how borked that API really is.  For
129         * this sort of case (caller provided buffer) it
130         * would be much more trivial for apr_bucket_consume
131         * to do all the work that follows, based on the
132         * particular characteristics of the bucket we are
133         * consuming here.
134         */
135        status = apr_bucket_read(b, &str, &str_len, block);
136
137        if (status != APR_SUCCESS) {
138            if (APR_STATUS_IS_EOF(status)) {
139                /* This stream bucket was consumed */
140                apr_bucket_delete(b);
141                continue;
142            }
143            break;
144        }
145
146        if (str_len > 0) {
147            /* Do not block once some data has been consumed */
148            block = APR_NONBLOCK_READ;
149
150            /* Assure we don't overflow. */
151            consume = (str_len + actual > *len) ? *len - actual : str_len;
152
153            memcpy(c, str, consume);
154
155            c += consume;
156            actual += consume;
157
158            if (consume >= b->length) {
159                /* This physical bucket was consumed */
160                apr_bucket_delete(b);
161            }
162            else {
163                /* Only part of this physical bucket was consumed */
164                b->start += consume;
165                b->length -= consume;
166            }
167        }
168        else if (b->length == 0) {
169            apr_bucket_delete(b);
170        }
171
172        /* This could probably be actual == *len, but be safe from stray
173         * photons. */
174        if (actual >= *len) {
175            break;
176        }
177    }
178
179    *len = actual;
180    return status;
181}
182
183
184static apr_status_t gnutls_io_input_read(mod_gnutls_handle_t * ctxt,
185                                         char *buf, apr_size_t * len)
186{
187    apr_size_t wanted = *len;
188    apr_size_t bytes = 0;
189    int rc;
190
191    *len = 0;
192
193    /* If we have something leftover from last time, try that first. */
194    if ((bytes = char_buffer_read(&ctxt->input_cbuf, buf, wanted))) {
195        *len = bytes;
196        if (ctxt->input_mode == AP_MODE_SPECULATIVE) {
197            /* We want to rollback this read. */
198            if (ctxt->input_cbuf.length > 0) {
199                ctxt->input_cbuf.value -= bytes;
200                ctxt->input_cbuf.length += bytes;
201            }
202            else {
203                char_buffer_write(&ctxt->input_cbuf, buf, (int) bytes);
204            }
205            return APR_SUCCESS;
206        }
207        /* This could probably be *len == wanted, but be safe from stray
208         * photons.
209         */
210        if (*len >= wanted) {
211            return APR_SUCCESS;
212        }
213        if (ctxt->input_mode == AP_MODE_GETLINE) {
214            if (memchr(buf, APR_ASCII_LF, *len)) {
215                return APR_SUCCESS;
216            }
217        }
218        else {
219            /* Down to a nonblock pattern as we have some data already
220             */
221            ctxt->input_block = APR_NONBLOCK_READ;
222        }
223    }
224
225    while (1) {
226
227        rc = gnutls_record_recv(ctxt->session, buf + bytes, wanted - bytes);
228
229        if (rc > 0) {
230            *len += rc;
231            if (ctxt->input_mode == AP_MODE_SPECULATIVE) {
232                /* We want to rollback this read. */
233                char_buffer_write(&ctxt->input_cbuf, buf, rc);
234            }
235            return ctxt->input_rc;
236        }
237        else if (rc == 0) {
238            /* If EAGAIN, we will loop given a blocking read,
239             * otherwise consider ourselves at EOF.
240             */
241            if (APR_STATUS_IS_EAGAIN(ctxt->input_rc)
242                || APR_STATUS_IS_EINTR(ctxt->input_rc)) {
243                /* Already read something, return APR_SUCCESS instead.
244                 * On win32 in particular, but perhaps on other kernels,
245                 * a blocking call isn't 'always' blocking.
246                 */
247                if (*len > 0) {
248                    ctxt->input_rc = APR_SUCCESS;
249                    break;
250                }
251                if (ctxt->input_block == APR_NONBLOCK_READ) {
252                    break;
253                }
254            }
255            else {
256                if (*len > 0) {
257                    ctxt->input_rc = APR_SUCCESS;
258                }
259                else {
260                    ctxt->input_rc = APR_EOF;
261                }
262                break;
263            }
264        }
265        else {                  /* (rc < 0) */
266
267            if (rc == GNUTLS_E_REHANDSHAKE) {
268                /* A client has asked for a new Hankshake. Currently, we don't do it */
269                ap_log_error(APLOG_MARK, APLOG_INFO, ctxt->input_rc,
270                             ctxt->c->base_server,
271                             "GnuTLS: Error reading data. Client Requested a New Handshake."
272                             " (%d) '%s'", rc, gnutls_strerror(rc));
273            }
274            else if (rc == GNUTLS_E_WARNING_ALERT_RECEIVED) {
275                rc = gnutls_alert_get(ctxt->session);
276                ap_log_error(APLOG_MARK, APLOG_INFO, ctxt->input_rc,
277                             ctxt->c->base_server,
278                             "GnuTLS: Warning Alert From Client: "
279                             " (%d) '%s'", rc, gnutls_alert_get_name(rc)); 
280            }
281            else if (rc == GNUTLS_E_FATAL_ALERT_RECEIVED) {
282                rc = gnutls_alert_get(ctxt->session);
283                ap_log_error(APLOG_MARK, APLOG_INFO, ctxt->input_rc,
284                             ctxt->c->base_server,
285                             "GnuTLS: Fatal Alert From Client: "
286                             "(%d) '%s'", rc, gnutls_alert_get_name(rc));
287                ctxt->input_rc = APR_EGENERAL;
288                break;
289            }
290            else {
291                /* Some Other Error. Report it. Die. */
292                if(gnutls_error_is_fatal(rc)) {
293                    ap_log_error(APLOG_MARK, APLOG_INFO, ctxt->input_rc,
294                                 ctxt->c->base_server,
295                                 "GnuTLS: Error reading data. (%d) '%s'", rc,
296                                 gnutls_strerror(rc));
297                }
298                else if(*len > 0) {
299                    ctxt->input_rc = APR_SUCCESS;
300                    break;
301                }
302            }
303
304            if (ctxt->input_rc == APR_SUCCESS) {
305                ctxt->input_rc = APR_EGENERAL;
306            }
307            break;
308        }
309    }
310    return ctxt->input_rc;
311}
312
313static apr_status_t gnutls_io_input_getline(mod_gnutls_handle_t * ctxt,
314                                            char *buf, apr_size_t * len)
315{
316    const char *pos = NULL;
317    apr_status_t status;
318    apr_size_t tmplen = *len, buflen = *len, offset = 0;
319
320    *len = 0;
321
322    while (tmplen > 0) {
323        status = gnutls_io_input_read(ctxt, buf + offset, &tmplen);
324
325        if (status != APR_SUCCESS) {
326            return status;
327        }
328
329        *len += tmplen;
330
331        if ((pos = memchr(buf, APR_ASCII_LF, *len))) {
332            break;
333        }
334
335        offset += tmplen;
336        tmplen = buflen - offset;
337    }
338
339    if (pos) {
340        char *value;
341        int length;
342        apr_size_t bytes = pos - buf;
343
344        bytes += 1;
345        value = buf + bytes;
346        length = *len - bytes;
347
348        char_buffer_write(&ctxt->input_cbuf, value, length);
349
350        *len = bytes;
351    }
352
353    return APR_SUCCESS;
354}
355
356static int gnutls_do_handshake(mod_gnutls_handle_t * ctxt)
357{
358    int ret;
359    int errcode;
360    if (ctxt->status != 0) {
361        return 0;
362    }
363
364tryagain:
365
366    ret = gnutls_handshake(ctxt->session);
367    if (ret < 0) {
368        if (ret == GNUTLS_E_WARNING_ALERT_RECEIVED
369            || ret == GNUTLS_E_FATAL_ALERT_RECEIVED) {
370            errcode = gnutls_alert_get(ctxt->session);
371            ap_log_error(APLOG_MARK, APLOG_ERR, 0, ctxt->c->base_server,
372                         "GnuTLS: Hanshake Alert (%d) '%s'.", errcode,
373                         gnutls_alert_get_name(errcode));
374        }
375   
376        if (!gnutls_error_is_fatal(ret)) {
377            ap_log_error(APLOG_MARK, APLOG_INFO, 0, ctxt->c->base_server,
378                     "GnuTLS: Non-Fatal Handshake Error: (%d) '%s'", ret,
379                      gnutls_strerror(ret));
380            goto tryagain;
381        }
382
383        ap_log_error(APLOG_MARK, APLOG_ERR, 0, ctxt->c->base_server,
384                     "GnuTLS: Handshake Failed (%d) '%s'", ret,
385                      gnutls_strerror(ret));
386        ctxt->status = -1;
387        gnutls_alert_send(ctxt->session, GNUTLS_AL_FATAL, 
388                          gnutls_error_to_alert(ret, NULL));
389        gnutls_deinit(ctxt->session);
390        return ret;
391    }
392    else {
393        /* all done with the handshake */
394        ctxt->status = 1;
395        return ret;
396    }
397}
398
399int mod_gnutls_rehandshake(mod_gnutls_handle_t * ctxt)
400{
401    int rv;
402
403    rv = gnutls_rehandshake(ctxt->session);
404   
405    if (rv != 0) {
406        /* the client did not want to rehandshake. goodbye */
407        ap_log_error(APLOG_MARK, APLOG_ERR, 0, ctxt->c->base_server,
408                     "GnuTLS: Client Refused Rehandshake request.");
409        return -1;
410    }
411   
412    ctxt->status = 0;
413
414    gnutls_do_handshake(ctxt);
415   
416    if (ctxt->status == 1) {
417        return 0;
418    }
419    else {
420        return -1;
421    }
422}
423
424
425apr_status_t mod_gnutls_filter_input(ap_filter_t* f,
426                                     apr_bucket_brigade * bb,
427                                     ap_input_mode_t mode,
428                                     apr_read_type_e block,
429                                     apr_off_t readbytes)
430{
431    apr_status_t status = APR_SUCCESS;
432    mod_gnutls_handle_t *ctxt = (mod_gnutls_handle_t *) f->ctx;
433    apr_size_t len = sizeof(ctxt->input_buffer);
434
435    if (f->c->aborted) {
436        apr_bucket *bucket = apr_bucket_eos_create(f->c->bucket_alloc);
437        APR_BRIGADE_INSERT_TAIL(bb, bucket);
438        return APR_ECONNABORTED;
439    }
440
441    if (ctxt->status == 0) {
442        gnutls_do_handshake(ctxt);
443    }
444
445    if (ctxt->status < 0) {
446        return ap_get_brigade(f->next, bb, mode, block, readbytes);
447    }
448
449    /* XXX: we don't currently support anything other than these modes. */
450    if (mode != AP_MODE_READBYTES && mode != AP_MODE_GETLINE &&
451        mode != AP_MODE_SPECULATIVE && mode != AP_MODE_INIT) {
452        return APR_ENOTIMPL;
453    }
454
455    ctxt->input_mode = mode;
456    ctxt->input_block = block;
457
458    if (ctxt->input_mode == AP_MODE_READBYTES ||
459        ctxt->input_mode == AP_MODE_SPECULATIVE) {
460        /* Err. This is bad. readbytes *can* be a 64bit int! len.. is NOT */
461        if (readbytes < len) {
462            len = (apr_size_t) readbytes;
463        }
464        status = gnutls_io_input_read(ctxt, ctxt->input_buffer, &len);
465    }
466    else if (ctxt->input_mode == AP_MODE_GETLINE) {
467        status = gnutls_io_input_getline(ctxt, ctxt->input_buffer, &len);
468    }
469    else {
470        /* We have no idea what you are talking about, so return an error. */
471        return APR_ENOTIMPL;
472    }
473
474    if (status != APR_SUCCESS) {
475        return gnutls_io_filter_error(f, bb, status);
476    }
477
478    /* Create a transient bucket out of the decrypted data. */
479    if (len > 0) {
480        apr_bucket *bucket =
481            apr_bucket_transient_create(ctxt->input_buffer, len,
482                                        f->c->bucket_alloc);
483        APR_BRIGADE_INSERT_TAIL(bb, bucket);
484    }
485
486    return status;
487}
488
489apr_status_t mod_gnutls_filter_output(ap_filter_t * f,
490                                      apr_bucket_brigade * bb)
491{
492    apr_size_t ret;
493    apr_bucket* e;
494    mod_gnutls_handle_t *ctxt = (mod_gnutls_handle_t *) f->ctx;
495    apr_status_t status = APR_SUCCESS;
496    apr_read_type_e rblock = APR_NONBLOCK_READ;
497
498    if (f->c->aborted) {
499        apr_brigade_cleanup(bb);
500        return APR_ECONNABORTED;
501    }
502
503    if (ctxt->status == 0) {
504        gnutls_do_handshake(ctxt);
505    }
506
507    if (ctxt->status < 0) {
508        return ap_pass_brigade(f->next, bb);
509    }
510
511    while (!APR_BRIGADE_EMPTY(bb)) {
512        apr_bucket *bucket = APR_BRIGADE_FIRST(bb);
513        if (AP_BUCKET_IS_EOC(bucket)) {
514            do {
515                ret = gnutls_alert_send(ctxt->session, GNUTLS_AL_FATAL,
516                                        GNUTLS_A_CLOSE_NOTIFY);
517            } while(ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
518
519            apr_bucket_copy(bucket, &e);
520            APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, e);
521           
522            if ((status = ap_pass_brigade(f->next, ctxt->output_bb)) != APR_SUCCESS) {
523                apr_brigade_cleanup(ctxt->output_bb);
524                return status;
525            }
526
527            apr_brigade_cleanup(ctxt->output_bb);
528            gnutls_bye(ctxt->session, GNUTLS_SHUT_WR);
529            gnutls_deinit(ctxt->session);
530            continue;
531
532        } else if (APR_BUCKET_IS_FLUSH(bucket) || APR_BUCKET_IS_EOS(bucket)) {
533
534            apr_bucket_copy(bucket, &e);
535            APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, e);
536            if ((status = ap_pass_brigade(f->next, bb)) != APR_SUCCESS) {
537                apr_brigade_cleanup(ctxt->output_bb);
538                return status;
539            }
540            apr_brigade_cleanup(ctxt->output_bb);
541            continue;
542        }
543        else {
544            /* filter output */
545            const char *data;
546            apr_size_t len;
547
548            status = apr_bucket_read(bucket, &data, &len, rblock);
549
550            if (APR_STATUS_IS_EAGAIN(status)) {
551                rblock = APR_BLOCK_READ;
552                continue;       /* and try again with a blocking read. */
553            }
554
555            rblock = APR_NONBLOCK_READ;
556
557            if (!APR_STATUS_IS_EOF(status) && (status != APR_SUCCESS)) {
558                break;
559            }
560
561            do {
562                ret = gnutls_record_send(ctxt->session, data, len);
563            }
564            while(ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
565
566            if (ret < 0) {
567                /* error sending output */
568                ap_log_error(APLOG_MARK, APLOG_INFO, ctxt->output_rc,
569                             ctxt->c->base_server,
570                             "GnuTLS: Error writing data."
571                             " (%d) '%s'", ret, gnutls_strerror(ret));
572                if (ctxt->output_rc == APR_SUCCESS) {
573                    ctxt->output_rc = APR_EGENERAL;
574                }
575            }
576            else if (ret != len) {
577                /* Not able to send the entire bucket,
578                   split it and send it again. */
579                apr_bucket_split(bucket, ret);
580            }
581
582            apr_bucket_delete(bucket);
583
584            if (ctxt->output_rc != APR_SUCCESS) {
585                break;
586            }
587        }
588    }
589
590    return status;
591}
592
593ssize_t mod_gnutls_transport_read(gnutls_transport_ptr_t ptr,
594                                  void *buffer, size_t len)
595{
596    mod_gnutls_handle_t *ctxt = ptr;
597    apr_status_t rc;
598    apr_size_t in = len;
599    apr_read_type_e block = ctxt->input_block;
600
601    ctxt->input_rc = APR_SUCCESS;
602
603    /* If Len = 0, we don't do anything. */
604    if (!len)
605        return 0;
606
607    if (!ctxt->input_bb) {
608        ctxt->input_rc = APR_EOF;
609        return -1;
610    }
611
612    if (APR_BRIGADE_EMPTY(ctxt->input_bb)) {
613
614        rc = ap_get_brigade(ctxt->input_filter->next, ctxt->input_bb,
615                            AP_MODE_READBYTES, ctxt->input_block, in);
616
617        /* Not a problem, there was simply no data ready yet.
618         */
619        if (APR_STATUS_IS_EAGAIN(rc) || APR_STATUS_IS_EINTR(rc)
620            || (rc == APR_SUCCESS && APR_BRIGADE_EMPTY(ctxt->input_bb))) {
621            return 0;
622        }
623
624        if (rc != APR_SUCCESS) {
625            /* Unexpected errors discard the brigade */
626            apr_brigade_cleanup(ctxt->input_bb);
627            ctxt->input_bb = NULL;
628            return -1;
629        }
630    }
631
632    ctxt->input_rc = brigade_consume(ctxt->input_bb, block, buffer, &len);
633
634    if (ctxt->input_rc == APR_SUCCESS) {
635        return (ssize_t) len;
636    }
637
638    if (APR_STATUS_IS_EAGAIN(ctxt->input_rc)
639        || APR_STATUS_IS_EINTR(ctxt->input_rc)) {
640        return (ssize_t) len;
641    }
642
643    /* Unexpected errors and APR_EOF clean out the brigade.
644     * Subsequent calls will return APR_EOF.
645     */
646    apr_brigade_cleanup(ctxt->input_bb);
647    ctxt->input_bb = NULL;
648
649    if (APR_STATUS_IS_EOF(ctxt->input_rc) && len) {
650        /* Provide the results of this read pass,
651         * without resetting the BIO retry_read flag
652         */
653        return (ssize_t) len;
654    }
655
656    return -1;
657}
658
659
660static ssize_t write_flush(mod_gnutls_handle_t * ctxt)
661{
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->bucket_alloc);
673        /* we filled this buffer first so add it to the
674         * head of the brigade
675         */
676        APR_BRIGADE_INSERT_HEAD(ctxt->output_bb, e);
677        ctxt->output_blen = 0;
678    }
679
680    ctxt->output_length = 0;
681    e = apr_bucket_flush_create(ctxt->output_bb->bucket_alloc);
682    APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, e);
683
684    ctxt->output_rc = ap_pass_brigade(ctxt->output_filter->next,
685                                      ctxt->output_bb);
686    /* clear the brigade to be ready for next time */
687    apr_brigade_cleanup(ctxt->output_bb);
688
689    return (ctxt->output_rc == APR_SUCCESS) ? 1 : -1;
690}
691
692ssize_t mod_gnutls_transport_write(gnutls_transport_ptr_t ptr,
693                                   const void *buffer, size_t len)
694{
695    mod_gnutls_handle_t *ctxt = ptr;
696
697    /* pass along the encrypted data
698     * need to flush since we're using SSL's malloc-ed buffer
699     * which will be overwritten once we leave here
700     */
701    apr_bucket *bucket = apr_bucket_transient_create(buffer, len,
702                                                    ctxt->output_bb->bucket_alloc);
703    ctxt->output_length += len;
704    APR_BRIGADE_INSERT_TAIL(ctxt->output_bb, bucket);
705
706    if (write_flush(ctxt) < 0) {
707        return -1;
708    }
709    return len;
710}
Note: See TracBrowser for help on using the repository browser.