1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
60 * http_protocol.c --- routines which directly communicate with the client.
62 * Code originally by Rob McCool; much redone by Robert S. Thau
63 * and the Apache Software Foundation.
67 #include "apr_strings.h"
68 #include "apr_buckets.h"
70 #include "apr_signal.h"
72 #define APR_WANT_STDIO /* for sscanf */
73 #define APR_WANT_STRFUNC
74 #define APR_WANT_MEMFUNC
78 #include "util_filter.h"
79 #include "ap_config.h"
81 #include "http_config.h"
82 #include "http_core.h"
83 #include "http_protocol.h"
84 #include "http_main.h"
85 #include "http_request.h"
86 #include "http_vhost.h"
87 #include "http_log.h" /* For errors detected in basic auth common
89 #include "util_charset.h"
90 #include "util_ebcdic.h"
101 APR_HOOK_LINK(post_read_request)
102 APR_HOOK_LINK(log_transaction)
103 APR_HOOK_LINK(http_method)
104 APR_HOOK_LINK(default_port)
107 AP_DECLARE_DATA ap_filter_rec_t *ap_old_write_func;
110 * Builds the content-type that should be sent to the client from the
111 * content-type specified. The following rules are followed:
112 * - if type is NULL, type is set to ap_default_type(r)
113 * - if charset adding is disabled, stop processing and return type.
114 * - then, if there are no parameters on type, add the default charset
117 AP_DECLARE(const char *)ap_make_content_type(request_rec *r, const char *type)
119 static const char *needcset[] = {
124 core_dir_config *conf =
125 (core_dir_config *)ap_get_module_config(r->per_dir_config,
129 type = ap_default_type(r);
131 if (conf->add_default_charset != ADD_DEFAULT_CHARSET_ON) {
135 if (ap_strcasestr(type, "charset=") != NULL) {
136 /* already has parameter, do nothing */
137 /* XXX we don't check the validity */
141 /* see if it makes sense to add the charset. At present,
142 * we only add it if the Content-type is one of needcset[]
144 for (pcset = needcset; *pcset ; pcset++) {
145 if (ap_strcasestr(type, *pcset) != NULL) {
146 type = apr_pstrcat(r->pool, type, "; charset=",
147 conf->add_default_charset_name, NULL);
155 AP_DECLARE(void) ap_set_content_length(request_rec *r, apr_off_t clength)
157 r->clength = clength;
158 apr_table_setn(r->headers_out, "Content-Length",
159 apr_off_t_toa(r->pool, clength));
163 * Return the latest rational time from a request/mtime (modification time)
164 * pair. We return the mtime unless it's in the future, in which case we
165 * return the current time. We use the request time as a reference in order
166 * to limit the number of calls to time(). We don't check for futurosity
167 * unless the mtime is at least as new as the reference.
169 AP_DECLARE(apr_time_t) ap_rationalize_mtime(request_rec *r, apr_time_t mtime)
173 /* For all static responses, it's almost certain that the file was
174 * last modified before the beginning of the request. So there's
175 * no reason to call time(NULL) again. But if the response has been
176 * created on demand, then it might be newer than the time the request
177 * started. In this event we really have to call time(NULL) again
178 * so that we can give the clients the most accurate Last-Modified. If we
179 * were given a time in the future, we return the current time - the
180 * Last-Modified can't be in the future.
182 now = (mtime < r->request_time) ? r->request_time : apr_time_now();
183 return (mtime > now) ? now : mtime;
186 /* Get a line of protocol input, including any continuation lines
187 * caused by MIME folding (or broken clients) if fold != 0, and place it
188 * in the buffer s, of size n bytes, without the ending newline.
191 * the length of s (normal case),
195 * Notes: Because the buffer uses 1 char for NUL, the most we can return is
196 * (n - 1) actual characters.
198 * If no LF is detected on the last line due to a dropped connection
199 * or a full buffer, that's considered an error.
201 AP_DECLARE(int) ap_rgetline(char **s, int n, request_rec *r, int fold)
207 apr_size_t total = 0;
208 int looking_ahead = 0;
210 core_request_config *req_cfg;
211 apr_bucket_brigade *b;
213 int do_alloc = (*s == NULL);
214 apr_size_t alloc_size = 0;
216 req_cfg = (core_request_config *)
217 ap_get_module_config(r->request_config, &core_module);
219 /* make sure it's empty unless we're folding */
220 AP_DEBUG_ASSERT(fold || APR_BRIGADE_EMPTY(b));
223 if (APR_BRIGADE_EMPTY(b)) {
225 if ((retval = ap_get_brigade(r->input_filters, b,
227 &zero /* readline */)) != APR_SUCCESS ||
228 APR_BRIGADE_EMPTY(b)) {
229 apr_brigade_destroy(b);
233 e = APR_BRIGADE_FIRST(b);
234 if (APR_BUCKET_IS_EOS(e)) {
235 apr_brigade_destroy(b);
238 if (e->length == 0) {
239 apr_bucket_delete(e);
242 retval = apr_bucket_read(e, &temp, &length, APR_BLOCK_READ);
243 if (retval != APR_SUCCESS) {
244 apr_brigade_destroy(b);
245 ap_log_rerror(APLOG_MARK, APLOG_ERR, retval, r, "apr_bucket_read() failed");
247 break; /* report previously-read data to caller, do ap_xlate_proto_to_ascii() */
254 if ((looking_ahead) && (*temp != APR_ASCII_BLANK) && (*temp != APR_ASCII_TAB)) {
255 /* can't fold because next line isn't indented,
256 * so return what we have. lookahead brigade is
257 * stashed on req_cfg->bb
259 AP_DEBUG_ASSERT(!APR_BRIGADE_EMPTY(req_cfg->bb));
262 if (total + length - 1 < (apr_size_t)n) {
266 *s = apr_palloc(r->pool, length + 2); /* +2 for LF, null */
268 else if (total + length > alloc_size) {
269 apr_size_t new_size = alloc_size;
273 } while (total + length > new_size);
274 new_buffer = apr_palloc(r->pool, new_size + 2);
275 memcpy(new_buffer, *s, total);
276 alloc_size = new_size;
281 last_char = pos + length - 1;
282 memcpy(pos, temp, length);
283 apr_bucket_delete(e);
286 /* input line was larger than the caller's buffer */
287 apr_brigade_destroy(b);
289 /* don't need to worry about req_cfg->bb being bogus.
290 * the request is about to die, and ErrorDocument
291 * redirects get a new req_cfg->bb
297 pos = last_char; /* Point at the last character */
299 if (*pos == APR_ASCII_LF) { /* Did we get a full line of input? */
301 if (pos > *s && *(pos - 1) == APR_ASCII_CR) {
302 --pos; /* zap optional CR before LF */
306 * Trim any extra trailing spaces or tabs except for the first
307 * space or tab at the beginning of a blank string. This makes
308 * it much easier to check field values for exact matches, and
309 * saves memory as well. Terminate string at end of line.
311 while (pos > ((*s) + 1) &&
312 (*(pos - 1) == APR_ASCII_BLANK || *(pos - 1) == APR_ASCII_TAB)) {
313 --pos; /* trim extra trailing spaces or tabs */
315 *pos = '\0'; /* zap end of string */
316 total = pos - *s; /* update total string length */
318 /* look ahead another line if line folding is desired
319 * and this line isn't empty
325 AP_DEBUG_ASSERT(APR_BRIGADE_EMPTY(req_cfg->bb));
330 /* no LF yet...character mode client (telnet)...keep going
331 * bump past last character read,
332 * and set total in case we bail before finding a LF
335 looking_ahead = 0; /* only appropriate right after LF */
338 ap_xlate_proto_from_ascii(*s, total);
342 AP_DECLARE(int) ap_getline(char *s, int n, request_rec *r, int fold)
345 return ap_rgetline(&tmp_s, n, r, fold);
348 /* parse_uri: break apart the uri
350 * - sets r->args to rest after '?' (or NULL if no '?')
351 * - sets r->uri to request uri (without r->args part)
352 * - sets r->hostname (if not set already) from request (scheme://host:port)
354 AP_CORE_DECLARE(void) ap_parse_uri(request_rec *r, const char *uri)
356 int status = HTTP_OK;
358 r->unparsed_uri = apr_pstrdup(r->pool, uri);
360 if (r->method_number == M_CONNECT) {
361 status = apr_uri_parse_hostinfo(r->pool, uri, &r->parsed_uri);
364 /* Simple syntax Errors in URLs are trapped by parse_uri_components(). */
365 status = apr_uri_parse(r->pool, uri, &r->parsed_uri);
368 if (status == APR_SUCCESS) {
369 /* if it has a scheme we may need to do absoluteURI vhost stuff */
370 if (r->parsed_uri.scheme
371 && !strcasecmp(r->parsed_uri.scheme, ap_http_method(r))) {
372 r->hostname = r->parsed_uri.hostname;
374 else if (r->method_number == M_CONNECT) {
375 r->hostname = r->parsed_uri.hostname;
377 r->args = r->parsed_uri.query;
378 r->uri = r->parsed_uri.path ? r->parsed_uri.path
379 : apr_pstrdup(r->pool, "/");
380 #if defined(OS2) || defined(WIN32)
381 /* Handle path translations for OS/2 and plug security hole.
382 * This will prevent "http://www.wherever.com/..\..\/" from
383 * returning a directory for the root drive.
388 for (x = r->uri; (x = strchr(x, '\\')) != NULL; )
391 #endif /* OS2 || WIN32 */
396 r->status = HTTP_BAD_REQUEST; /* set error status */
397 r->uri = apr_pstrdup(r->pool, uri);
401 static int read_request_line(request_rec *r)
408 conn_rec *conn = r->connection;
410 int major = 1, minor = 0; /* Assume HTTP/1.0 if non-"HTTP" protocol */
413 /* Read past empty lines until we get a real request line,
414 * a read error, the connection closes (EOF), or we timeout.
416 * We skip empty lines because browsers have to tack a CRLF on to the end
417 * of POSTs to support old CERN webservers. But note that we may not
418 * have flushed any previous response completely to the client yet.
419 * We delay the flush as long as possible so that we can improve
420 * performance for clients that are pipelining requests. If a request
421 * is pipelined then we won't block during the (implicit) read() below.
422 * If the requests aren't pipelined, then the client is still waiting
423 * for the final buffer flush from us, and we will block in the implicit
424 * read(). B_SAFEREAD ensures that the BUFF layer flushes if it will
425 * have to block during a read.
428 while ((len = ap_rgetline(&(r->the_request),
429 DEFAULT_LIMIT_REQUEST_LINE + 2, r, 0)) <= 0) {
430 if (len < 0) { /* includes EOF */
431 /* this is a hack to make sure that request time is set,
432 * it's not perfect, but it's better than nothing
434 r->request_time = apr_time_now();
438 /* we've probably got something to do, ignore graceful restart requests */
440 r->request_time = apr_time_now();
442 r->method = ap_getword_white(r->pool, &ll);
445 /* XXX If we want to keep track of the Method, the protocol module should do
446 * it. That support isn't in the scoreboard yet. Hopefully next week
448 ap_update_connection_status(AP_CHILD_THREAD_FROM_ID(conn->id), "Method", r->method);
450 uri = ap_getword_white(r->pool, &ll);
452 /* Provide quick information about the request method as soon as known */
454 r->method_number = ap_method_number_of(r->method);
455 if (r->method_number == M_GET && r->method[0] == 'H') {
459 ap_parse_uri(r, uri);
461 /* ap_getline returns (size of max buffer - 1) if it fills up the
462 * buffer before finding the end-of-line. This is only going to
463 * happen if it exceeds the configured limit for a request-line.
465 if (len > r->server->limit_req_line) {
466 r->status = HTTP_REQUEST_URI_TOO_LARGE;
467 r->proto_num = HTTP_VERSION(1,0);
468 r->protocol = apr_pstrdup(r->pool, "HTTP/1.0");
481 r->protocol = apr_pstrmemdup(r->pool, pro, len);
483 /* XXX ap_update_connection_status(conn->id, "Protocol", r->protocol); */
485 /* Avoid sscanf in the common case */
487 pro[0] == 'H' && pro[1] == 'T' && pro[2] == 'T' && pro[3] == 'P' &&
488 pro[4] == '/' && apr_isdigit(pro[5]) && pro[6] == '.' &&
489 apr_isdigit(pro[7])) {
490 r->proto_num = HTTP_VERSION(pro[5] - '0', pro[7] - '0');
491 } else if (2 == sscanf(r->protocol, "HTTP/%u.%u", &major, &minor)
492 && minor < HTTP_VERSION(1,0)) /* don't allow HTTP/0.1000 */
493 r->proto_num = HTTP_VERSION(major, minor);
495 r->proto_num = HTTP_VERSION(1,0);
500 static void get_mime_headers(request_rec *r)
506 apr_table_t *tmp_headers;
508 /* We'll use apr_table_overlap later to merge these into r->headers_in. */
509 tmp_headers = apr_table_make(r->pool, 50);
512 * Read header lines until we get the empty separator line, a read error,
513 * the connection closes (EOF), reach the server limit, or we timeout.
516 while ((len = ap_rgetline(&field, DEFAULT_LIMIT_REQUEST_FIELDSIZE + 2,
519 if (r->server->limit_req_fields &&
520 (++fields_read > r->server->limit_req_fields)) {
521 r->status = HTTP_BAD_REQUEST;
522 apr_table_setn(r->notes, "error-notes",
523 "The number of request header fields exceeds "
524 "this server's limit.");
527 /* ap_getline returns (size of max buffer - 1) if it fills up the
528 * buffer before finding the end-of-line. This is only going to
529 * happen if it exceeds the configured limit for a field size.
531 if (len > r->server->limit_req_fieldsize) {
532 r->status = HTTP_BAD_REQUEST;
533 apr_table_setn(r->notes, "error-notes",
535 "Size of a request header field "
536 "exceeds server limit.<br />\n"
538 ap_escape_html(r->pool, field),
543 if (!(value = strchr(field, ':'))) { /* Find the colon separator */
544 r->status = HTTP_BAD_REQUEST; /* or abort the bad request */
545 apr_table_setn(r->notes, "error-notes",
547 "Request header field is missing "
548 "colon separator.<br />\n"
550 ap_escape_html(r->pool, field),
557 while (*value == ' ' || *value == '\t') {
558 ++value; /* Skip to start of value */
561 apr_table_addn(tmp_headers, field, value);
562 field = NULL; /* to cause ap_rgetline to allocate a new one */
565 apr_table_overlap(r->headers_in, tmp_headers, APR_OVERLAP_TABLES_MERGE);
568 request_rec *ap_read_request(conn_rec *conn)
575 apr_pool_create(&p, conn->pool);
576 r = apr_pcalloc(p, sizeof(request_rec));
578 r->connection = conn;
579 r->server = conn->base_server;
582 r->ap_auth_type = NULL;
584 r->allowed_methods = ap_make_method_list(p, 2);
586 r->headers_in = apr_table_make(r->pool, 50);
587 r->subprocess_env = apr_table_make(r->pool, 50);
588 r->headers_out = apr_table_make(r->pool, 12);
589 r->err_headers_out = apr_table_make(r->pool, 5);
590 r->notes = apr_table_make(r->pool, 5);
592 r->request_config = ap_create_request_config(r->pool);
593 /* Must be set before we run create request hook */
594 r->output_filters = conn->output_filters;
595 r->input_filters = conn->input_filters;
596 ap_run_create_request(r);
597 r->per_dir_config = r->server->lookup_defaults;
599 r->sent_bodyct = 0; /* bytect isn't for body */
602 r->read_body = REQUEST_NO_BODY;
604 r->status = HTTP_REQUEST_TIME_OUT; /* Until we get a request */
605 r->the_request = NULL;
607 /* Get the request... */
608 if (!read_request_line(r)) {
609 if (r->status == HTTP_REQUEST_URI_TOO_LARGE) {
610 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
611 "request failed: URI too long");
612 ap_send_error_response(r, 0);
613 ap_run_log_transaction(r);
619 if (!r->assbackwards) {
621 if (r->status != HTTP_REQUEST_TIME_OUT) {
622 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
623 "request failed: error reading the headers");
624 ap_send_error_response(r, 0);
625 ap_run_log_transaction(r);
630 if (r->header_only) {
632 * Client asked for headers only with HTTP/0.9, which doesn't send
633 * headers! Have to dink things just to make sure the error message
636 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
637 "client sent invalid HTTP/0.9 request: HEAD %s",
640 r->status = HTTP_BAD_REQUEST;
641 ap_send_error_response(r, 0);
642 ap_run_log_transaction(r);
647 r->status = HTTP_OK; /* Until further notice. */
649 /* update what we think the virtual host is based on the headers we've
650 * now read. may update status.
652 ap_update_vhost_from_headers(r);
654 /* we may have switched to another server */
655 r->per_dir_config = r->server->lookup_defaults;
657 if ((!r->hostname && (r->proto_num >= HTTP_VERSION(1,1))) ||
658 ((r->proto_num == HTTP_VERSION(1,1)) &&
659 !apr_table_get(r->headers_in, "Host"))) {
661 * Client sent us an HTTP/1.1 or later request without telling us the
662 * hostname, either with a full URL or a Host: header. We therefore
663 * need to (as per the 1.1 spec) send an error. As a special case,
664 * HTTP/1.1 mentions twice (S9, S14.23) that a request MUST contain
665 * a Host: header, and the server MUST respond with 400 if it doesn't.
667 r->status = HTTP_BAD_REQUEST;
668 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
669 "client sent HTTP/1.1 request without hostname "
670 "(see RFC2616 section 14.23): %s", r->uri);
672 if (r->status != HTTP_OK) {
673 ap_send_error_response(r, 0);
674 ap_run_log_transaction(r);
677 if (((expect = apr_table_get(r->headers_in, "Expect")) != NULL) &&
678 (expect[0] != '\0')) {
680 * The Expect header field was added to HTTP/1.1 after RFC 2068
681 * as a means to signal when a 100 response is desired and,
682 * unfortunately, to signal a poor man's mandatory extension that
683 * the server must understand or return 417 Expectation Failed.
685 if (strcasecmp(expect, "100-continue") == 0) {
686 r->expecting_100 = 1;
689 r->status = HTTP_EXPECTATION_FAILED;
690 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r,
691 "client sent an unrecognized expectation value of "
692 "Expect: %s", expect);
693 ap_send_error_response(r, 0);
694 (void) ap_discard_request_body(r);
695 ap_run_log_transaction(r);
700 ap_add_input_filter("HTTP_IN", NULL, r, r->connection);
702 if ((access_status = ap_run_post_read_request(r))) {
703 ap_die(access_status, r);
704 ap_run_log_transaction(r);
712 * A couple of other functions which initialize some of the fields of
713 * a request structure, as appropriate for adjuncts of one kind or another
714 * to a request in progress. Best here, rather than elsewhere, since
715 * *someone* has to set the protocol-specific fields...
718 void ap_set_sub_req_protocol(request_rec *rnew, const request_rec *r)
720 rnew->the_request = r->the_request; /* Keep original request-line */
722 rnew->assbackwards = 1; /* Don't send headers from this. */
723 rnew->no_local_copy = 1; /* Don't try to send HTTP_NOT_MODIFIED for a
725 rnew->method = "GET";
726 rnew->method_number = M_GET;
727 rnew->protocol = "INCLUDED";
729 rnew->status = HTTP_OK;
731 rnew->headers_in = r->headers_in;
732 rnew->subprocess_env = apr_table_copy(rnew->pool, r->subprocess_env);
733 rnew->headers_out = apr_table_make(rnew->pool, 5);
734 rnew->err_headers_out = apr_table_make(rnew->pool, 5);
735 rnew->notes = apr_table_make(rnew->pool, 5);
737 rnew->expecting_100 = r->expecting_100;
738 rnew->read_length = r->read_length;
739 rnew->read_body = REQUEST_NO_BODY;
741 rnew->main = (request_rec *) r;
744 static void end_output_stream(request_rec *r)
746 apr_bucket_brigade *bb;
749 bb = apr_brigade_create(r->pool);
750 b = apr_bucket_eos_create();
751 APR_BRIGADE_INSERT_TAIL(bb, b);
752 ap_pass_brigade(r->output_filters, bb);
755 void ap_finalize_sub_req_protocol(request_rec *sub)
757 end_output_stream(sub);
760 /* finalize_request_protocol is called at completion of sending the
761 * response. Its sole purpose is to send the terminating protocol
762 * information for any wrappers around the response message body
763 * (i.e., transfer encodings). It should have been named finalize_response.
765 AP_DECLARE(void) ap_finalize_request_protocol(request_rec *r)
770 /* tell the filter chain there is no more content coming */
772 end_output_stream(r);
777 * Support for the Basic authentication protocol, and a bit for Digest.
780 AP_DECLARE(void) ap_note_auth_failure(request_rec *r)
782 const char *type = ap_auth_type(r);
784 if (!strcasecmp(type, "Basic"))
785 ap_note_basic_auth_failure(r);
786 else if (!strcasecmp(type, "Digest"))
787 ap_note_digest_auth_failure(r);
790 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR,
791 0, r, "need AuthType to note auth failure: %s", r->uri);
795 AP_DECLARE(void) ap_note_basic_auth_failure(request_rec *r)
797 const char *type = ap_auth_type(r);
798 /* if there is no AuthType configure or it is something other than
799 * Basic, let ap_note_auth_failure() deal with it
801 if (!type || strcasecmp(type, "Basic"))
802 ap_note_auth_failure(r);
804 apr_table_setn(r->err_headers_out,
805 (PROXYREQ_PROXY == r->proxyreq) ? "Proxy-Authenticate" : "WWW-Authenticate",
806 apr_pstrcat(r->pool, "Basic realm=\"", ap_auth_name(r), "\"",
810 AP_DECLARE(void) ap_note_digest_auth_failure(request_rec *r)
812 apr_table_setn(r->err_headers_out,
813 (PROXYREQ_PROXY == r->proxyreq) ? "Proxy-Authenticate" : "WWW-Authenticate",
814 apr_psprintf(r->pool, "Digest realm=\"%s\", nonce=\"%llx\"",
815 ap_auth_name(r), r->request_time));
818 AP_DECLARE(int) ap_get_basic_auth_pw(request_rec *r, const char **pw)
820 const char *auth_line = apr_table_get(r->headers_in,
821 (PROXYREQ_PROXY == r->proxyreq) ? "Proxy-Authorization"
825 if (!(t = ap_auth_type(r)) || strcasecmp(t, "Basic"))
828 if (!ap_auth_name(r)) {
829 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR,
830 0, r, "need AuthName: %s", r->uri);
831 return HTTP_INTERNAL_SERVER_ERROR;
835 ap_note_basic_auth_failure(r);
836 return HTTP_UNAUTHORIZED;
839 if (strcasecmp(ap_getword(r->pool, &auth_line, ' '), "Basic")) {
840 /* Client tried to authenticate using wrong auth scheme */
841 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
842 "client used wrong authentication scheme: %s", r->uri);
843 ap_note_basic_auth_failure(r);
844 return HTTP_UNAUTHORIZED;
847 while (*auth_line== ' ' || *auth_line== '\t') {
851 t = ap_pbase64decode(r->pool, auth_line);
852 /* Note that this allocation has to be made from r->connection->pool
853 * because it has the lifetime of the connection. The other allocations
854 * are temporary and can be tossed away any time.
856 r->user = ap_getword_nulls (r->pool, &t, ':');
857 r->ap_auth_type = "Basic";
864 struct content_length_ctx {
865 apr_bucket_brigade *saved;
870 /* This filter computes the content length, but it also computes the number
871 * of bytes sent to the client. This means that this filter will always run
872 * through all of the buckets in all brigades
874 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_content_length_filter(ap_filter_t *f,
875 apr_bucket_brigade *b)
877 request_rec *r = f->r;
878 struct content_length_ctx *ctx;
881 int eos = 0, flush = 0, partial_send_okay = 0;
882 apr_bucket_brigade *more, *split;
883 apr_read_type_e eblock = APR_NONBLOCK_READ;
886 if (!ctx) { /* first time through */
887 f->ctx = ctx = apr_pcalloc(r->pool, sizeof(struct content_length_ctx));
888 ctx->compute_len = 1; /* Assume we will compute the length */
891 /* Humm, is this check the best it can be?
892 * - protocol >= HTTP/1.1 implies support for chunking
893 * - non-keepalive implies the end of byte stream will be signaled
894 * by a connection close
895 * In both cases, we can send bytes to the client w/o needing to
896 * compute content-length.
898 * We should be able to force connection close from this filter
899 * when we see we are buffering too much.
901 if ((r->proto_num >= HTTP_VERSION(1,1)) ||
902 (!f->r->connection->keepalive)) {
903 partial_send_okay = 1;
913 APR_BRIGADE_FOREACH(e, b) {
917 if (APR_BUCKET_IS_EOS(e)) {
920 else if (APR_BUCKET_IS_FLUSH(e)) {
921 if (partial_send_okay) {
923 more = apr_brigade_split(b, APR_BUCKET_NEXT(e));
927 else if ((ctx->curr_len > 4*AP_MIN_BYTES_TO_WRITE)) {
928 /* If we've accumulated more than 4xAP_MIN_BYTES_TO_WRITE and
929 * the client supports chunked encoding, send what we have
930 * and come back for more.
932 if (partial_send_okay) {
934 more = apr_brigade_split(b, e);
938 if (e->length == -1) { /* if length unknown */
939 rv = apr_bucket_read(e, &ignored, &len, eblock);
940 if (rv == APR_SUCCESS) {
941 /* Attempt a nonblocking read next time through */
942 eblock = APR_NONBLOCK_READ;
944 else if (APR_STATUS_IS_EAGAIN(rv)) {
945 /* Make the next read blocking. If the client supports chunked
946 * encoding, flush the filter stack to the network.
948 eblock = APR_BLOCK_READ;
949 if (partial_send_okay) {
951 more = apr_brigade_split(b, e);
956 else if (rv != APR_EOF) {
957 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
958 "ap_content_length_filter: apr_bucket_read() failed");
965 ctx->curr_len += len;
966 r->bytes_sent += len;
970 ctx->compute_len = 0; /* Ooops, can't compute the length now */
973 APR_BRIGADE_CONCAT(ctx->saved, split);
974 apr_brigade_destroy(split);
979 rv = ap_fflush(f->next, split);
982 rv = ap_pass_brigade(f->next, split);
984 if (rv != APR_SUCCESS)
989 if ((ctx->curr_len < AP_MIN_BYTES_TO_WRITE) && !eos) {
990 return ap_save_brigade(f, &ctx->saved, &b, (r->main) ? r->main->pool : r->pool);
993 if (ctx->compute_len) {
994 /* save the brigade; we can't pass any data to the next
995 * filter until we have the entire content length
998 return ap_save_brigade(f, &ctx->saved, &b, r->pool);
1000 ap_set_content_length(r, r->bytes_sent);
1003 APR_BRIGADE_CONCAT(ctx->saved, b);
1004 apr_brigade_destroy(b);
1010 return ap_pass_brigade(f->next, b);
1014 * Send the body of a response to the client.
1016 AP_DECLARE(apr_status_t) ap_send_fd(apr_file_t *fd, request_rec *r, apr_off_t offset,
1017 apr_size_t len, apr_size_t *nbytes)
1019 apr_bucket_brigade *bb = NULL;
1023 bb = apr_brigade_create(r->pool);
1024 b = apr_bucket_file_create(fd, offset, len, r->pool);
1025 APR_BRIGADE_INSERT_TAIL(bb, b);
1027 rv = ap_pass_brigade(r->output_filters, bb);
1028 if (rv != APR_SUCCESS) {
1029 *nbytes = 0; /* no way to tell how many were actually sent */
1039 /* send data from an in-memory buffer */
1040 AP_DECLARE(size_t) ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset,
1043 apr_bucket_brigade *bb = NULL;
1046 bb = apr_brigade_create(r->pool);
1047 b = apr_bucket_mmap_create(mm, offset, length);
1048 APR_BRIGADE_INSERT_TAIL(bb, b);
1049 ap_pass_brigade(r->output_filters, bb);
1051 return mm->size; /* XXX - change API to report apr_status_t? */
1053 #endif /* APR_HAS_MMAP */
1056 apr_bucket_brigade *bb;
1057 } old_write_filter_ctx;
1059 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_old_write_filter(
1060 ap_filter_t *f, apr_bucket_brigade *bb)
1062 old_write_filter_ctx *ctx = f->ctx;
1064 AP_DEBUG_ASSERT(ctx);
1067 /* whatever is coming down the pipe (we don't care), we
1068 * can simply insert our buffered data at the front and
1069 * pass the whole bundle down the chain.
1071 APR_BRIGADE_CONCAT(ctx->bb, bb);
1074 return ap_pass_brigade(f->next, ctx->bb);
1077 static apr_status_t buffer_output(request_rec *r,
1078 const char *str, apr_size_t len)
1081 old_write_filter_ctx *ctx;
1086 /* future optimization: record some flags in the request_rec to
1087 * say whether we've added our filter, and whether it is first.
1090 /* this will typically exit on the first test */
1091 for (f = r->output_filters; f != NULL; f = f->next)
1092 if (ap_old_write_func == f->frec)
1095 /* our filter hasn't been added yet */
1096 ctx = apr_pcalloc(r->pool, sizeof(*ctx));
1097 ap_add_output_filter("OLD_WRITE", ctx, r, r->connection);
1098 f = r->output_filters;
1101 /* if the first filter is not our buffering filter, then we have to
1102 * deliver the content through the normal filter chain */
1103 if (f != r->output_filters) {
1104 apr_bucket_brigade *bb = apr_brigade_create(r->pool);
1105 apr_bucket *b = apr_bucket_transient_create(str, len);
1106 APR_BRIGADE_INSERT_TAIL(bb, b);
1108 return ap_pass_brigade(r->output_filters, bb);
1111 /* grab the context from our filter */
1112 ctx = r->output_filters->ctx;
1114 if (ctx->bb == NULL) {
1115 ctx->bb = apr_brigade_create(r->pool);
1118 return ap_fwrite(f->next, ctx->bb, str, len);
1121 AP_DECLARE(int) ap_rputc(int c, request_rec *r)
1125 if (r->connection->aborted) {
1129 if (buffer_output(r, &c2, 1) != APR_SUCCESS)
1135 AP_DECLARE(int) ap_rputs(const char *str, request_rec *r)
1139 if (r->connection->aborted)
1142 if (buffer_output(r, str, len = strlen(str)) != APR_SUCCESS)
1148 AP_DECLARE(int) ap_rwrite(const void *buf, int nbyte, request_rec *r)
1150 if (r->connection->aborted)
1153 if (buffer_output(r, buf, nbyte) != APR_SUCCESS)
1159 struct ap_vrprintf_data {
1160 apr_vformatter_buff_t vbuff;
1165 static apr_status_t r_flush(apr_vformatter_buff_t *buff)
1167 /* callback function passed to ap_vformatter to be called when
1168 * vformatter needs to write into buff and buff.curpos > buff.endpos */
1170 /* ap_vrprintf_data passed as a apr_vformatter_buff_t, which is then
1171 * "downcast" to an ap_vrprintf_data */
1172 struct ap_vrprintf_data *vd = (struct ap_vrprintf_data*)buff;
1174 if (vd->r->connection->aborted)
1177 /* r_flush is called when vbuff is completely full */
1178 if (buffer_output(vd->r, vd->buff, AP_IOBUFSIZE)) {
1182 /* reset the buffer position */
1183 vd->vbuff.curpos = vd->buff;
1184 vd->vbuff.endpos = vd->buff + AP_IOBUFSIZE;
1189 AP_DECLARE(int) ap_vrprintf(request_rec *r, const char *fmt, va_list va)
1192 struct ap_vrprintf_data vd;
1193 char vrprintf_buf[AP_IOBUFSIZE];
1195 vd.vbuff.curpos = vrprintf_buf;
1196 vd.vbuff.endpos = vrprintf_buf + AP_IOBUFSIZE;
1198 vd.buff = vrprintf_buf;
1200 if (r->connection->aborted)
1203 written = apr_vformatter(r_flush, &vd.vbuff, fmt, va);
1204 /* tack on null terminator on remaining string */
1205 *(vd.vbuff.curpos) = '\0';
1207 if (written != -1) {
1208 int n = vd.vbuff.curpos - vrprintf_buf;
1210 /* last call to buffer_output, to finish clearing the buffer */
1211 if (buffer_output(r, vrprintf_buf,n) != APR_SUCCESS)
1220 AP_DECLARE_NONSTD(int) ap_rprintf(request_rec *r, const char *fmt, ...)
1225 if (r->connection->aborted)
1229 n = ap_vrprintf(r, fmt, va);
1235 AP_DECLARE_NONSTD(int) ap_rvputs(request_rec *r, ...)
1240 apr_size_t written = 0;
1242 if (r->connection->aborted)
1245 /* ### TODO: if the total output is large, put all the strings
1246 ### into a single brigade, rather than flushing each time we
1247 ### fill the buffer */
1250 s = va_arg(va, const char *);
1255 if (buffer_output(r, s, len) != APR_SUCCESS) {
1266 AP_DECLARE(int) ap_rflush(request_rec *r)
1268 apr_bucket_brigade *bb;
1271 bb = apr_brigade_create(r->pool);
1272 b = apr_bucket_flush_create();
1273 APR_BRIGADE_INSERT_TAIL(bb, b);
1274 if (ap_pass_brigade(r->output_filters, bb) != APR_SUCCESS)
1280 * This function sets the Last-Modified output header field to the value
1281 * of the mtime field in the request structure - rationalized to keep it from
1282 * being in the future.
1284 AP_DECLARE(void) ap_set_last_modified(request_rec *r)
1286 if (!r->assbackwards) {
1287 apr_time_t mod_time = ap_rationalize_mtime(r, r->mtime);
1288 char *datestr = apr_palloc(r->pool, APR_RFC822_DATE_LEN);
1289 apr_rfc822_date(datestr, mod_time);
1290 apr_table_setn(r->headers_out, "Last-Modified", datestr);
1294 AP_IMPLEMENT_HOOK_RUN_ALL(int,post_read_request,
1295 (request_rec *r),(r),OK,DECLINED)
1296 AP_IMPLEMENT_HOOK_RUN_ALL(int,log_transaction,
1297 (request_rec *r),(r),OK,DECLINED)
1298 AP_IMPLEMENT_HOOK_RUN_FIRST(const char *,http_method,
1299 (const request_rec *r),(r),NULL)
1300 AP_IMPLEMENT_HOOK_RUN_FIRST(unsigned short,default_port,
1301 (const request_rec *r),(r),0)