1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "apr_strings.h"
21 #define APR_WANT_STRFUNC
28 #include "ap_config.h"
30 #include "http_config.h"
31 #include "http_main.h"
33 #include "http_core.h"
34 #include "http_protocol.h"
35 #include "http_request.h" /* for sub_req_lookup_uri() */
36 #include "util_script.h"
37 #include "apr_date.h" /* For apr_date_parse_http() */
38 #include "util_ebcdic.h"
46 * Various utility functions which are common to a whole lot of
47 * script-type extensions mechanisms, and might as well be gathered
48 * in one place (if only to avoid creating inter-module dependancies
49 * where there don't have to be).
52 /* we know core's module_index is 0 */
53 #undef APLOG_MODULE_INDEX
54 #define APLOG_MODULE_INDEX AP_CORE_MODULE_INDEX
56 static char *http2env(request_rec *r, const char *w)
58 char *res = (char *)apr_palloc(r->pool, sizeof("HTTP_") + strlen(w));
68 while ((c = *w++) != 0) {
70 *cp++ = apr_toupper(c);
76 ap_log_rerror(APLOG_MARK, APLOG_TRACE1, 0, r,
77 "Not exporting header with invalid name as envvar: %s",
78 ap_escape_logitem(r->pool, w));
87 static void add_unless_null(apr_table_t *table, const char *name, const char *val)
90 apr_table_addn(table, name, val);
94 static void env2env(apr_table_t *table, const char *name)
96 add_unless_null(table, name, getenv(name));
99 AP_DECLARE(char **) ap_create_environment(apr_pool_t *p, apr_table_t *t)
101 const apr_array_header_t *env_arr = apr_table_elts(t);
102 const apr_table_entry_t *elts = (const apr_table_entry_t *) env_arr->elts;
103 char **env = (char **) apr_palloc(p, (env_arr->nelts + 2) * sizeof(char *));
109 if (!apr_table_get(t, "TZ")) {
112 env[j++] = apr_pstrcat(p, "TZ=", tz, NULL);
115 for (i = 0; i < env_arr->nelts; ++i) {
119 env[j] = apr_pstrcat(p, elts[i].key, "=", elts[i].val, NULL);
121 if (apr_isdigit(*whack)) {
124 while (*whack != '=') {
125 if (!apr_isalnum(*whack) && *whack != '_') {
137 AP_DECLARE(void) ap_add_common_vars(request_rec *r)
140 server_rec *s = r->server;
141 conn_rec *c = r->connection;
142 const char *env_temp;
143 const apr_array_header_t *hdrs_arr = apr_table_elts(r->headers_in);
144 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
148 /* use a temporary apr_table_t which we'll overlap onto
149 * r->subprocess_env later
150 * (exception: if r->subprocess_env is empty at the start,
151 * write directly into it)
153 if (apr_is_empty_table(r->subprocess_env)) {
154 e = r->subprocess_env;
157 e = apr_table_make(r->pool, 25 + hdrs_arr->nelts);
160 /* First, add environment vars from headers... this is as per
161 * CGI specs, though other sorts of scripting interfaces see
165 for (i = 0; i < hdrs_arr->nelts; ++i) {
170 /* A few headers are special cased --- Authorization to prevent
171 * rogue scripts from capturing passwords; content-type and -length
172 * for no particular reason.
175 if (!strcasecmp(hdrs[i].key, "Content-type")) {
176 apr_table_addn(e, "CONTENT_TYPE", hdrs[i].val);
178 else if (!strcasecmp(hdrs[i].key, "Content-length")) {
179 apr_table_addn(e, "CONTENT_LENGTH", hdrs[i].val);
182 * You really don't want to disable this check, since it leaves you
183 * wide open to CGIs stealing passwords and people viewing them
184 * in the environment with "ps -e". But, if you must...
186 #ifndef SECURITY_HOLE_PASS_AUTHORIZATION
187 else if (!strcasecmp(hdrs[i].key, "Authorization")
188 || !strcasecmp(hdrs[i].key, "Proxy-Authorization")) {
193 add_unless_null(e, http2env(r, hdrs[i].key), hdrs[i].val);
196 env_temp = apr_table_get(r->subprocess_env, "PATH");
197 if (env_temp == NULL) {
198 env_temp = getenv("PATH");
200 if (env_temp == NULL) {
201 env_temp = DEFAULT_PATH;
203 apr_table_addn(e, "PATH", apr_pstrdup(r->pool, env_temp));
206 env2env(e, "SystemRoot");
207 env2env(e, "COMSPEC");
208 env2env(e, "PATHEXT");
209 env2env(e, "WINDIR");
211 env2env(e, "COMSPEC");
214 env2env(e, "PERLLIB_PREFIX");
216 env2env(e, "LIBRARY_PATH");
217 #elif defined(DARWIN)
218 env2env(e, "DYLD_LIBRARY_PATH");
220 env2env(e, "LIBPATH");
221 #elif defined(__HPUX__)
222 /* HPUX PARISC 2.0W knows both, otherwise redundancy is harmless */
223 env2env(e, "SHLIB_PATH");
224 env2env(e, "LD_LIBRARY_PATH");
225 #else /* Some Unix */
226 env2env(e, "LD_LIBRARY_PATH");
229 apr_table_addn(e, "SERVER_SIGNATURE", ap_psignature("", r));
230 apr_table_addn(e, "SERVER_SOFTWARE", ap_get_server_banner());
231 apr_table_addn(e, "SERVER_NAME",
232 ap_escape_html(r->pool, ap_get_server_name_for_url(r)));
233 apr_table_addn(e, "SERVER_ADDR", r->connection->local_ip); /* Apache */
234 apr_table_addn(e, "SERVER_PORT",
235 apr_psprintf(r->pool, "%u", ap_get_server_port(r)));
236 add_unless_null(e, "REMOTE_HOST",
237 ap_get_remote_host(c, r->per_dir_config, REMOTE_HOST, NULL));
238 apr_table_addn(e, "REMOTE_ADDR", r->useragent_ip);
239 apr_table_addn(e, "DOCUMENT_ROOT", ap_document_root(r)); /* Apache */
240 apr_table_setn(e, "REQUEST_SCHEME", ap_http_scheme(r));
241 apr_table_addn(e, "CONTEXT_PREFIX", ap_context_prefix(r));
242 apr_table_addn(e, "CONTEXT_DOCUMENT_ROOT", ap_context_document_root(r));
243 apr_table_addn(e, "SERVER_ADMIN", s->server_admin); /* Apache */
244 apr_table_addn(e, "SCRIPT_FILENAME", r->filename); /* Apache */
246 rport = c->client_addr->port;
247 apr_table_addn(e, "REMOTE_PORT", apr_itoa(r->pool, rport));
250 apr_table_addn(e, "REMOTE_USER", r->user);
253 request_rec *back = r->prev;
257 apr_table_addn(e, "REDIRECT_REMOTE_USER", back->user);
263 add_unless_null(e, "AUTH_TYPE", r->ap_auth_type);
264 env_temp = ap_get_remote_logname(r);
266 apr_table_addn(e, "REMOTE_IDENT", apr_pstrdup(r->pool, env_temp));
269 /* Apache custom error responses. If we have redirected set two new vars */
272 add_unless_null(e, "REDIRECT_QUERY_STRING", r->prev->args);
273 add_unless_null(e, "REDIRECT_URL", r->prev->uri);
276 if (e != r->subprocess_env) {
277 apr_table_overlap(r->subprocess_env, e, APR_OVERLAP_TABLES_SET);
281 /* This "cute" little function comes about because the path info on
282 * filenames and URLs aren't always the same. So we take the two,
283 * and find as much of the two that match as possible.
286 AP_DECLARE(int) ap_find_path_info(const char *uri, const char *path_info)
288 int lu = strlen(uri);
289 int lp = strlen(path_info);
291 while (lu-- && lp-- && uri[lu] == path_info[lp]) {
292 if (path_info[lp] == '/') {
293 while (lu && uri[lu-1] == '/') lu--;
301 while (uri[lu] != '\0' && uri[lu] != '/') {
307 /* Obtain the Request-URI from the original request-line, returning
308 * a new string from the request pool containing the URI or "".
310 static char *original_uri(request_rec *r)
314 if (r->the_request == NULL) {
315 return (char *) apr_pcalloc(r->pool, 1);
318 first = r->the_request; /* use the request-line */
320 while (*first && !apr_isspace(*first)) {
321 ++first; /* skip over the method */
323 while (apr_isspace(*first)) {
324 ++first; /* and the space(s) */
328 while (*last && !apr_isspace(*last)) {
329 ++last; /* end at next whitespace */
332 return apr_pstrmemdup(r->pool, first, last - first);
335 AP_DECLARE(void) ap_add_cgi_vars(request_rec *r)
337 apr_table_t *e = r->subprocess_env;
339 apr_table_setn(e, "GATEWAY_INTERFACE", "CGI/1.1");
340 apr_table_setn(e, "SERVER_PROTOCOL", r->protocol);
341 apr_table_setn(e, "REQUEST_METHOD", r->method);
342 apr_table_setn(e, "QUERY_STRING", r->args ? r->args : "");
343 apr_table_setn(e, "REQUEST_URI", original_uri(r));
345 /* Note that the code below special-cases scripts run from includes,
346 * because it "knows" that the sub_request has been hacked to have the
347 * args and path_info of the original request, and not any that may have
348 * come with the script URI in the include command. Ugh.
351 if (!strcmp(r->protocol, "INCLUDED")) {
352 apr_table_setn(e, "SCRIPT_NAME", r->uri);
353 if (r->path_info && *r->path_info) {
354 apr_table_setn(e, "PATH_INFO", r->path_info);
357 else if (!r->path_info || !*r->path_info) {
358 apr_table_setn(e, "SCRIPT_NAME", r->uri);
361 int path_info_start = ap_find_path_info(r->uri, r->path_info);
363 apr_table_setn(e, "SCRIPT_NAME",
364 apr_pstrndup(r->pool, r->uri, path_info_start));
366 apr_table_setn(e, "PATH_INFO", r->path_info);
369 if (r->path_info && r->path_info[0]) {
371 * To get PATH_TRANSLATED, treat PATH_INFO as a URI path.
372 * Need to re-escape it for this, since the entire URI was
373 * un-escaped before we determined where the PATH_INFO began.
377 pa_req = ap_sub_req_lookup_uri(ap_escape_uri(r->pool, r->path_info), r,
380 if (pa_req->filename) {
381 char *pt = apr_pstrcat(r->pool, pa_req->filename, pa_req->path_info,
384 /* We need to make this a real Windows path name */
385 apr_filepath_merge(&pt, "", pt, APR_FILEPATH_NATIVE, r->pool);
387 apr_table_setn(e, "PATH_TRANSLATED", pt);
389 ap_destroy_sub_req(pa_req);
394 static int set_cookie_doo_doo(void *v, const char *key, const char *val)
396 apr_table_addn(v, key, val);
400 #define HTTP_UNSET (-HTTP_OK)
401 #define SCRIPT_LOG_MARK __FILE__,__LINE__,module_index
403 AP_DECLARE(int) ap_scan_script_header_err_core_ex(request_rec *r, char *buffer,
404 int (*getsfunc) (char *, int, void *),
408 char x[MAX_STRING_LEN];
411 int cgi_status = HTTP_UNSET;
413 apr_table_t *cookie_table;
414 int trace_log = APLOG_R_MODULE_IS_LEVEL(r, module_index, APLOG_TRACE1);
415 int first_header = 1;
420 w = buffer ? buffer : x;
422 /* temporary place to hold headers to merge in later */
423 merge = apr_table_make(r->pool, 10);
425 /* The HTTP specification says that it is legal to merge duplicate
426 * headers into one. Some browsers that support Cookies don't like
427 * merged headers and prefer that each Set-Cookie header is sent
428 * separately. Lets humour those browsers by not merging.
429 * Oh what a pain it is.
431 cookie_table = apr_table_make(r->pool, 2);
432 apr_table_do(set_cookie_doo_doo, cookie_table, r->err_headers_out, "Set-Cookie", NULL);
436 int rv = (*getsfunc) (w, MAX_STRING_LEN - 1, getsfunc_data);
438 const char *msg = "Premature end of script headers";
440 msg = "End of script output before headers";
441 ap_log_rerror(SCRIPT_LOG_MARK, APLOG_ERR|APLOG_TOCLIENT, 0, r,
443 apr_filepath_name_get(r->filename));
444 return HTTP_INTERNAL_SERVER_ERROR;
447 ap_log_rerror(SCRIPT_LOG_MARK, APLOG_ERR|APLOG_TOCLIENT, 0, r,
448 "Script timed out before returning headers: %s",
449 apr_filepath_name_get(r->filename));
450 return HTTP_GATEWAY_TIME_OUT;
453 /* Delete terminal (CR?)LF */
456 /* Indeed, the host's '\n':
457 '\012' for UNIX; '\015' for MacOS; '\025' for OS/390
458 -- whatever the script generates.
460 if (p > 0 && w[p - 1] == '\n') {
461 if (p > 1 && w[p - 2] == CR) {
470 * If we've finished reading the headers, check to make sure any
471 * HTTP/1.1 conditions are met. If so, we're done; normal processing
472 * will handle the script's output. If not, just return the error.
473 * The appropriate thing to do would be to send the script process a
474 * SIGPIPE to let it know we're ignoring it, close the channel to the
475 * script process, and *then* return the failed-to-meet-condition
476 * error. Otherwise we'd be waiting for the script to finish
477 * blithering before telling the client the output was no good.
478 * However, we don't have the information to do that, so we have to
479 * leave it to an upper layer.
482 int cond_status = OK;
484 /* PR#38070: This fails because it gets confused when a
485 * CGI Status header overrides ap_meets_conditions.
487 * We can fix that by dropping ap_meets_conditions when
488 * Status has been set. Since this is the only place
489 * cgi_status gets used, let's test it explicitly.
491 * The alternative would be to ignore CGI Status when
492 * ap_meets_conditions returns anything interesting.
493 * That would be safer wrt HTTP, but would break CGI.
495 if ((cgi_status == HTTP_UNSET) && (r->method_number == M_GET)) {
496 cond_status = ap_meets_conditions(r);
498 apr_table_overlap(r->err_headers_out, merge,
499 APR_OVERLAP_TABLES_MERGE);
500 if (!apr_is_empty_table(cookie_table)) {
501 /* the cookies have already been copied to the cookie_table */
502 apr_table_unset(r->err_headers_out, "Set-Cookie");
503 r->err_headers_out = apr_table_overlay(r->pool,
504 r->err_headers_out, cookie_table);
511 ap_log_rerror(SCRIPT_LOG_MARK, APLOG_TRACE4, 0, r,
512 "Headers from script '%s':",
513 apr_filepath_name_get(r->filename));
514 ap_log_rerror(SCRIPT_LOG_MARK, APLOG_TRACE4, 0, r, " %s", w);
517 /* if we see a bogus header don't ignore it. Shout and scream */
519 #if APR_CHARSET_EBCDIC
520 /* Chances are that we received an ASCII header text instead of
521 * the expected EBCDIC header lines. Try to auto-detect:
523 if (!(l = strchr(w, ':'))) {
524 int maybeASCII = 0, maybeEBCDIC = 0;
525 unsigned char *cp, native;
526 apr_size_t inbytes_left, outbytes_left;
528 for (cp = w; *cp != '\0'; ++cp) {
529 native = apr_xlate_conv_byte(ap_hdrs_from_ascii, *cp);
530 if (apr_isprint(*cp) && !apr_isprint(native))
532 if (!apr_isprint(*cp) && apr_isprint(native))
535 if (maybeASCII > maybeEBCDIC) {
536 ap_log_error(SCRIPT_LOG_MARK, APLOG_ERR, 0, r->server,
537 "CGI Interface Error: Script headers apparently ASCII: (CGI = %s)",
539 inbytes_left = outbytes_left = cp - w;
540 apr_xlate_conv_buffer(ap_hdrs_from_ascii,
541 w, &inbytes_left, w, &outbytes_left);
544 #endif /*APR_CHARSET_EBCDIC*/
545 if (!(l = strchr(w, ':'))) {
547 /* Soak up all the script output - may save an outright kill */
548 while ((*getsfunc) (w, MAX_STRING_LEN - 1, getsfunc_data)) {
553 ap_log_rerror(SCRIPT_LOG_MARK, APLOG_ERR|APLOG_TOCLIENT, 0, r,
554 "malformed header from script '%s': Bad header: %.30s",
555 apr_filepath_name_get(r->filename), w);
556 return HTTP_INTERNAL_SERVER_ERROR;
560 while (*l && apr_isspace(*l)) {
564 if (!strcasecmp(w, "Content-type")) {
567 /* Nuke trailing whitespace */
569 char *endp = l + strlen(l) - 1;
570 while (endp > l && apr_isspace(*endp)) {
574 tmp = apr_pstrdup(r->pool, l);
575 ap_content_type_tolower(tmp);
576 ap_set_content_type(r, tmp);
579 * If the script returned a specific status, that's what
580 * we'll use - otherwise we assume 200 OK.
582 else if (!strcasecmp(w, "Status")) {
583 r->status = cgi_status = atoi(l);
584 if (!ap_is_HTTP_VALID_RESPONSE(cgi_status))
585 ap_log_rerror(SCRIPT_LOG_MARK, APLOG_ERR|APLOG_TOCLIENT, 0, r,
586 "Invalid status line from script '%s': %s",
587 apr_filepath_name_get(r->filename), w);
589 ap_log_rerror(SCRIPT_LOG_MARK, APLOG_TRACE1, 0, r,
590 "Status line from script '%s': %s",
591 apr_filepath_name_get(r->filename), w);
592 r->status_line = apr_pstrdup(r->pool, l);
594 else if (!strcasecmp(w, "Location")) {
595 apr_table_set(r->headers_out, w, l);
597 else if (!strcasecmp(w, "Content-Length")) {
598 apr_table_set(r->headers_out, w, l);
600 else if (!strcasecmp(w, "Content-Range")) {
601 apr_table_set(r->headers_out, w, l);
603 else if (!strcasecmp(w, "Transfer-Encoding")) {
604 apr_table_set(r->headers_out, w, l);
606 else if (!strcasecmp(w, "ETag")) {
607 apr_table_set(r->headers_out, w, l);
610 * If the script gave us a Last-Modified header, we can't just
611 * pass it on blindly because of restrictions on future values.
613 else if (!strcasecmp(w, "Last-Modified")) {
614 ap_update_mtime(r, apr_date_parse_http(l));
615 ap_set_last_modified(r);
617 else if (!strcasecmp(w, "Set-Cookie")) {
618 apr_table_add(cookie_table, w, l);
621 apr_table_add(merge, w, l);
625 /* never reached - we leave this function within the while loop above */
629 AP_DECLARE(int) ap_scan_script_header_err_core(request_rec *r, char *buffer,
630 int (*getsfunc) (char *, int, void *),
633 return ap_scan_script_header_err_core_ex(r, buffer, getsfunc,
638 static int getsfunc_FILE(char *buf, int len, void *f)
640 return apr_file_gets(buf, len, (apr_file_t *) f) == APR_SUCCESS;
643 AP_DECLARE(int) ap_scan_script_header_err(request_rec *r, apr_file_t *f,
646 return ap_scan_script_header_err_core_ex(r, buffer, getsfunc_FILE, f,
650 AP_DECLARE(int) ap_scan_script_header_err_ex(request_rec *r, apr_file_t *f,
651 char *buffer, int module_index)
653 return ap_scan_script_header_err_core_ex(r, buffer, getsfunc_FILE, f,
658 static int getsfunc_BRIGADE(char *buf, int len, void *arg)
660 apr_bucket_brigade *bb = (apr_bucket_brigade *)arg;
661 const char *dst_end = buf + len - 1; /* leave room for terminating null */
663 apr_bucket *e = APR_BRIGADE_FIRST(bb);
667 while ((dst < dst_end) && !done && !APR_BUCKET_IS_EOS(e)) {
668 const char *bucket_data;
669 apr_size_t bucket_data_len;
674 rv = apr_bucket_read(e, &bucket_data, &bucket_data_len,
676 if (rv != APR_SUCCESS || (bucket_data_len == 0)) {
677 return APR_STATUS_IS_TIMEUP(rv) ? -1 : 0;
680 src_end = bucket_data + bucket_data_len;
681 while ((src < src_end) && (dst < dst_end) && !done) {
685 else if (*src != '\r') {
692 apr_bucket_split(e, src - bucket_data);
694 next = APR_BUCKET_NEXT(e);
695 APR_BUCKET_REMOVE(e);
696 apr_bucket_destroy(e);
703 AP_DECLARE(int) ap_scan_script_header_err_brigade(request_rec *r,
704 apr_bucket_brigade *bb,
707 return ap_scan_script_header_err_core_ex(r, buffer, getsfunc_BRIGADE, bb,
711 AP_DECLARE(int) ap_scan_script_header_err_brigade_ex(request_rec *r,
712 apr_bucket_brigade *bb,
716 return ap_scan_script_header_err_core_ex(r, buffer, getsfunc_BRIGADE, bb,
727 static int getsfunc_STRING(char *w, int len, void *pvastrs)
729 struct vastrs *strs = (struct vastrs*) pvastrs;
733 if (!strs->curpos || !*strs->curpos)
735 p = ap_strchr_c(strs->curpos, '\n');
739 p = ap_strchr_c(strs->curpos, '\0');
740 t = p - strs->curpos;
743 strncpy (w, strs->curpos, t);
745 if (!strs->curpos[t]) {
747 strs->curpos = va_arg(strs->args, const char *);
754 /* ap_scan_script_header_err_strs() accepts additional const char* args...
755 * each is treated as one or more header lines, and the first non-header
756 * character is returned to **arg, **data. (The first optional arg is
759 AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs_ex(request_rec *r,
768 va_start(strs.args, termarg);
770 strs.curpos = va_arg(strs.args, char*);
771 res = ap_scan_script_header_err_core_ex(r, buffer, getsfunc_STRING,
772 (void *) &strs, module_index);
774 *termch = strs.curpos;
781 AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r,
789 va_start(strs.args, termarg);
791 strs.curpos = va_arg(strs.args, char*);
792 res = ap_scan_script_header_err_core_ex(r, buffer, getsfunc_STRING,
793 (void *) &strs, APLOG_MODULE_INDEX);
795 *termch = strs.curpos;
803 argstr_to_table(char *str, apr_table_t *parms)
813 key = apr_strtok(str, "&", &strtok_state);
815 value = strchr(key, '=');
817 *value = '\0'; /* Split the string in two */
818 value++; /* Skip passed the = */
823 ap_unescape_url(key);
824 ap_unescape_url(value);
825 apr_table_set(parms, key, value);
826 key = apr_strtok(NULL, "&", &strtok_state);
830 AP_DECLARE(void) ap_args_to_table(request_rec *r, apr_table_t **table)
832 apr_table_t *t = apr_table_make(r->pool, 10);
833 argstr_to_table(apr_pstrdup(r->pool, r->args), t);