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.
18 * http_script: keeps all script-related ramblings together.
20 * Compliant to CGI/1.1 spec
22 * Adapted by rst from original NCSA code by Rob McCool
24 * Apache adds some new env vars; REDIRECT_URL and REDIRECT_QUERY_STRING for
25 * custom error responses, and DOCUMENT_ROOT because we found it useful.
26 * It also adds SERVER_ADMIN - useful for scripts to know who to mail when
31 #include "apr_strings.h"
32 #include "apr_thread_proc.h" /* for RLIMIT stuff */
33 #include "apr_optional.h"
34 #include "apr_buckets.h"
38 #define APR_WANT_STRFUNC
39 #define APR_WANT_MEMFUNC
42 #include "util_filter.h"
43 #include "ap_config.h"
45 #include "http_config.h"
46 #include "http_request.h"
47 #include "http_core.h"
48 #include "http_protocol.h"
49 #include "http_main.h"
51 #include "util_script.h"
56 #if APR_HAVE_STRUCT_RLIMIT
57 #if defined (RLIMIT_CPU) || defined (RLIMIT_NPROC) || defined (RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
58 #define AP_CGI_USE_RLIMIT
62 module AP_MODULE_DECLARE_DATA cgi_module;
64 static APR_OPTIONAL_FN_TYPE(ap_register_include_handler) *cgi_pfn_reg_with_ssi;
65 static APR_OPTIONAL_FN_TYPE(ap_ssi_get_tag_and_value) *cgi_pfn_gtv;
66 static APR_OPTIONAL_FN_TYPE(ap_ssi_parse_string) *cgi_pfn_ps;
67 static APR_OPTIONAL_FN_TYPE(ap_cgi_build_command) *cgi_build_command;
69 /* Read and discard the data in the brigade produced by a CGI script */
70 static void discard_script_output(apr_bucket_brigade *bb);
72 /* KLUDGE --- for back-combatibility, we don't have to check ExecCGI
73 * in ScriptAliased directories, which means we need to know if this
74 * request came through ScriptAlias or not... so the Alias module
75 * leaves a note for us.
78 static int is_scriptaliased(request_rec *r)
80 const char *t = apr_table_get(r->notes, "alias-forced-type");
81 return t && (!strcasecmp(t, "cgi-script"));
84 /* Configuration stuff */
86 #define DEFAULT_LOGBYTES 10385760
87 #define DEFAULT_BUFBYTES 1024
95 static void *create_cgi_config(apr_pool_t *p, server_rec *s)
98 (cgi_server_conf *) apr_pcalloc(p, sizeof(cgi_server_conf));
101 c->logbytes = DEFAULT_LOGBYTES;
102 c->bufbytes = DEFAULT_BUFBYTES;
107 static void *merge_cgi_config(apr_pool_t *p, void *basev, void *overridesv)
109 cgi_server_conf *base = (cgi_server_conf *) basev,
110 *overrides = (cgi_server_conf *) overridesv;
112 return overrides->logname ? overrides : base;
115 static const char *set_scriptlog(cmd_parms *cmd, void *dummy, const char *arg)
117 server_rec *s = cmd->server;
118 cgi_server_conf *conf = ap_get_module_config(s->module_config,
121 conf->logname = ap_server_root_relative(cmd->pool, arg);
123 if (!conf->logname) {
124 return apr_pstrcat(cmd->pool, "Invalid ScriptLog path ",
131 static const char *set_scriptlog_length(cmd_parms *cmd, void *dummy,
134 server_rec *s = cmd->server;
135 cgi_server_conf *conf = ap_get_module_config(s->module_config,
138 conf->logbytes = atol(arg);
142 static const char *set_scriptlog_buffer(cmd_parms *cmd, void *dummy,
145 server_rec *s = cmd->server;
146 cgi_server_conf *conf = ap_get_module_config(s->module_config,
149 conf->bufbytes = atoi(arg);
153 static const command_rec cgi_cmds[] =
155 AP_INIT_TAKE1("ScriptLog", set_scriptlog, NULL, RSRC_CONF,
156 "the name of a log for script debugging info"),
157 AP_INIT_TAKE1("ScriptLogLength", set_scriptlog_length, NULL, RSRC_CONF,
158 "the maximum length (in bytes) of the script debug log"),
159 AP_INIT_TAKE1("ScriptLogBuffer", set_scriptlog_buffer, NULL, RSRC_CONF,
160 "the maximum size (in bytes) to record of a POST request"),
164 static int log_scripterror(request_rec *r, cgi_server_conf * conf, int ret,
165 apr_status_t rv, char *logno, char *error)
167 apr_file_t *f = NULL;
169 char time_str[APR_CTIME_LEN];
170 int log_flags = rv ? APLOG_ERR : APLOG_ERR;
172 ap_log_rerror(APLOG_MARK, log_flags, rv, r,
173 "%s%s: %s", logno ? logno : "", error, r->filename);
175 /* XXX Very expensive mainline case! Open, then getfileinfo! */
176 if (!conf->logname ||
177 ((apr_stat(&finfo, conf->logname,
178 APR_FINFO_SIZE, r->pool) == APR_SUCCESS) &&
179 (finfo.size > conf->logbytes)) ||
180 (apr_file_open(&f, conf->logname,
181 APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT,
182 r->pool) != APR_SUCCESS)) {
186 /* "%% [Wed Jun 19 10:53:21 1996] GET /cgi-bin/printenv HTTP/1.0" */
187 apr_ctime(time_str, apr_time_now());
188 apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
189 r->args ? "?" : "", r->args ? r->args : "", r->protocol);
190 /* "%% 500 /usr/local/apache/cgi-bin */
191 apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
193 apr_file_printf(f, "%%error\n%s\n", error);
199 /* Soak up stderr from a script and redirect it to the error log.
201 static apr_status_t log_script_err(request_rec *r, apr_file_t *script_err)
203 char argsbuffer[HUGE_STRING_LEN];
206 cgi_server_conf *conf = ap_get_module_config(r->server->module_config, &cgi_module);
208 while ((rv = apr_file_gets(argsbuffer, HUGE_STRING_LEN,
209 script_err)) == APR_SUCCESS) {
210 newline = strchr(argsbuffer, '\n');
214 log_scripterror(r, conf, r->status, 0, APLOGNO(01215), argsbuffer);
220 static int log_script(request_rec *r, cgi_server_conf * conf, int ret,
221 char *dbuf, const char *sbuf, apr_bucket_brigade *bb,
222 apr_file_t *script_err)
224 const apr_array_header_t *hdrs_arr = apr_table_elts(r->headers_in);
225 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
226 char argsbuffer[HUGE_STRING_LEN];
227 apr_file_t *f = NULL;
235 char time_str[APR_CTIME_LEN];
237 /* XXX Very expensive mainline case! Open, then getfileinfo! */
238 if (!conf->logname ||
239 ((apr_stat(&finfo, conf->logname,
240 APR_FINFO_SIZE, r->pool) == APR_SUCCESS) &&
241 (finfo.size > conf->logbytes)) ||
242 (apr_file_open(&f, conf->logname,
243 APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT,
244 r->pool) != APR_SUCCESS)) {
245 /* Soak up script output */
246 discard_script_output(bb);
247 log_script_err(r, script_err);
251 /* "%% [Wed Jun 19 10:53:21 1996] GET /cgi-bin/printenv HTTP/1.0" */
252 apr_ctime(time_str, apr_time_now());
253 apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
254 r->args ? "?" : "", r->args ? r->args : "", r->protocol);
255 /* "%% 500 /usr/local/apache/cgi-bin" */
256 apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
258 apr_file_puts("%request\n", f);
259 for (i = 0; i < hdrs_arr->nelts; ++i) {
262 apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
264 if ((r->method_number == M_POST || r->method_number == M_PUT) &&
266 apr_file_printf(f, "\n%s\n", dbuf);
269 apr_file_puts("%response\n", f);
270 hdrs_arr = apr_table_elts(r->err_headers_out);
271 hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
273 for (i = 0; i < hdrs_arr->nelts; ++i) {
276 apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
280 apr_file_printf(f, "%s\n", sbuf);
283 for (e = APR_BRIGADE_FIRST(bb);
284 e != APR_BRIGADE_SENTINEL(bb);
285 e = APR_BUCKET_NEXT(e))
287 if (APR_BUCKET_IS_EOS(e)) {
290 rv = apr_bucket_read(e, &buf, &len, APR_BLOCK_READ);
291 if (rv != APR_SUCCESS || (len == 0)) {
295 apr_file_puts("%stdout\n", f);
298 apr_file_write(f, buf, &len);
299 apr_file_puts("\n", f);
302 if (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_err) == APR_SUCCESS) {
303 apr_file_puts("%stderr\n", f);
304 apr_file_puts(argsbuffer, f);
305 while (apr_file_gets(argsbuffer, HUGE_STRING_LEN,
306 script_err) == APR_SUCCESS) {
307 apr_file_puts(argsbuffer, f);
309 apr_file_puts("\n", f);
312 apr_brigade_destroy(bb);
313 apr_file_close(script_err);
320 /* This is the special environment used for running the "exec cmd="
321 * variety of SSI directives.
323 static void add_ssi_vars(request_rec *r)
325 apr_table_t *e = r->subprocess_env;
327 if (r->path_info && r->path_info[0] != '\0') {
330 apr_table_setn(e, "PATH_INFO", ap_escape_shell_cmd(r->pool,
333 pa_req = ap_sub_req_lookup_uri(ap_escape_uri(r->pool, r->path_info),
335 if (pa_req->filename) {
336 apr_table_setn(e, "PATH_TRANSLATED",
337 apr_pstrcat(r->pool, pa_req->filename,
338 pa_req->path_info, NULL));
340 ap_destroy_sub_req(pa_req);
344 char *arg_copy = apr_pstrdup(r->pool, r->args);
346 apr_table_setn(e, "QUERY_STRING", r->args);
347 ap_unescape_url(arg_copy);
348 apr_table_setn(e, "QUERY_STRING_UNESCAPED",
349 ap_escape_shell_cmd(r->pool, arg_copy));
353 static void cgi_child_errfn(apr_pool_t *pool, apr_status_t err,
354 const char *description)
356 apr_file_t *stderr_log;
358 apr_file_open_stderr(&stderr_log, pool);
359 /* Escape the logged string because it may be something that
360 * came in over the network.
362 apr_file_printf(stderr_log,
366 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
367 ap_escape_logitem(pool,
370 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
376 static apr_status_t run_cgi_child(apr_file_t **script_out,
377 apr_file_t **script_in,
378 apr_file_t **script_err,
380 const char * const argv[],
383 cgi_exec_info_t *e_info)
385 const char * const *env;
386 apr_procattr_t *procattr;
388 apr_status_t rc = APR_SUCCESS;
390 #ifdef AP_CGI_USE_RLIMIT
391 core_dir_config *conf = ap_get_core_module_config(r->per_dir_config);
396 /* Under OS/2 need to use device con. */
397 FILE *dbg = fopen("con", "w");
399 FILE *dbg = fopen("/dev/tty", "w");
404 RAISE_SIGSTOP(CGI_CHILD);
406 fprintf(dbg, "Attempting to exec %s as CGI child (argv0 = %s)\n",
407 r->filename, argv[0]);
410 env = (const char * const *)ap_create_environment(p, r->subprocess_env);
413 fprintf(dbg, "Environment: \n");
414 for (i = 0; env[i]; ++i)
415 fprintf(dbg, "'%s'\n", env[i]);
419 /* Transmute ourselves into the script.
420 * NB only ISINDEX scripts get decoded arguments.
422 if (((rc = apr_procattr_create(&procattr, p)) != APR_SUCCESS) ||
423 ((rc = apr_procattr_io_set(procattr,
426 e_info->err_pipe)) != APR_SUCCESS) ||
427 ((rc = apr_procattr_dir_set(procattr,
428 ap_make_dirstr_parent(r->pool,
429 r->filename))) != APR_SUCCESS) ||
430 #if defined(RLIMIT_CPU) && defined(AP_CGI_USE_RLIMIT)
431 ((rc = apr_procattr_limit_set(procattr, APR_LIMIT_CPU,
432 conf->limit_cpu)) != APR_SUCCESS) ||
434 #if defined(AP_CGI_USE_RLIMIT) && (defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS))
435 ((rc = apr_procattr_limit_set(procattr, APR_LIMIT_MEM,
436 conf->limit_mem)) != APR_SUCCESS) ||
438 #if defined(RLIMIT_NPROC) && defined(AP_CGI_USE_RLIMIT)
439 ((rc = apr_procattr_limit_set(procattr, APR_LIMIT_NPROC,
440 conf->limit_nproc)) != APR_SUCCESS) ||
442 ((rc = apr_procattr_cmdtype_set(procattr,
443 e_info->cmd_type)) != APR_SUCCESS) ||
445 ((rc = apr_procattr_detach_set(procattr,
446 e_info->detached)) != APR_SUCCESS) ||
447 ((rc = apr_procattr_addrspace_set(procattr,
448 e_info->addrspace)) != APR_SUCCESS) ||
449 ((rc = apr_procattr_child_errfn_set(procattr, cgi_child_errfn)) != APR_SUCCESS)) {
450 /* Something bad happened, tell the world. */
451 ap_log_rerror(APLOG_MARK, APLOG_ERR, rc, r, APLOGNO(01216)
452 "couldn't set child process attributes: %s", r->filename);
455 procnew = apr_pcalloc(p, sizeof(*procnew));
456 rc = ap_os_create_privileged_process(r, procnew, command, argv, env,
459 if (rc != APR_SUCCESS) {
460 /* Bad things happened. Everyone should have cleaned up. */
461 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_TOCLIENT, rc, r,
462 "couldn't create child process: %d: %s", rc,
463 apr_filepath_name_get(r->filename));
466 apr_pool_note_subprocess(p, procnew, APR_KILL_AFTER_TIMEOUT);
468 *script_in = procnew->out;
471 apr_file_pipe_timeout_set(*script_in, r->server->timeout);
473 if (e_info->prog_type == RUN_AS_CGI) {
474 *script_out = procnew->in;
477 apr_file_pipe_timeout_set(*script_out, r->server->timeout);
479 *script_err = procnew->err;
482 apr_file_pipe_timeout_set(*script_err, r->server->timeout);
490 static apr_status_t default_build_command(const char **cmd, const char ***argv,
491 request_rec *r, apr_pool_t *p,
492 cgi_exec_info_t *e_info)
494 int numwords, x, idx;
496 const char *args = NULL;
498 if (e_info->process_cgi) {
500 /* Do not process r->args if they contain an '=' assignment
502 if (r->args && r->args[0] && !ap_strchr_c(r->args, '=')) {
511 /* count the number of keywords */
512 for (x = 0, numwords = 2; args[x]; x++) {
513 if (args[x] == '+') {
518 /* Everything is - 1 to account for the first parameter
519 * which is the program name.
521 if (numwords > APACHE_ARG_MAX - 1) {
522 numwords = APACHE_ARG_MAX - 1; /* Truncate args to prevent overrun */
524 *argv = apr_palloc(p, (numwords + 2) * sizeof(char *));
526 for (x = 1, idx = 1; x < numwords; x++) {
527 w = ap_getword_nulls(p, &args, '+');
529 (*argv)[idx++] = ap_escape_shell_cmd(p, w);
536 static void discard_script_output(apr_bucket_brigade *bb)
543 for (e = APR_BRIGADE_FIRST(bb);
544 e != APR_BRIGADE_SENTINEL(bb);
545 e = APR_BUCKET_NEXT(e))
547 if (APR_BUCKET_IS_EOS(e)) {
550 rv = apr_bucket_read(e, &buf, &len, APR_BLOCK_READ);
551 if (rv != APR_SUCCESS) {
557 #if APR_FILES_AS_SOCKETS
559 /* A CGI bucket type is needed to catch any output to stderr from the
560 * script; see PR 22030. */
561 static const apr_bucket_type_t bucket_type_cgi;
563 struct cgi_bucket_data {
564 apr_pollset_t *pollset;
568 /* Create a CGI bucket using pipes from script stdout 'out'
569 * and stderr 'err', for request 'r'. */
570 static apr_bucket *cgi_bucket_create(request_rec *r,
571 apr_file_t *out, apr_file_t *err,
572 apr_bucket_alloc_t *list)
574 apr_bucket *b = apr_bucket_alloc(sizeof(*b), list);
577 struct cgi_bucket_data *data = apr_palloc(r->pool, sizeof *data);
580 b->free = apr_bucket_free;
582 b->type = &bucket_type_cgi;
583 b->length = (apr_size_t)(-1);
586 /* Create the pollset */
587 rv = apr_pollset_create(&data->pollset, 2, r->pool, 0);
588 if (rv != APR_SUCCESS) {
589 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01217)
590 "apr_pollset_create(); check system or user limits");
594 fd.desc_type = APR_POLL_FILE;
595 fd.reqevents = APR_POLLIN;
597 fd.desc.f = out; /* script's stdout */
598 fd.client_data = (void *)1;
599 rv = apr_pollset_add(data->pollset, &fd);
600 if (rv != APR_SUCCESS) {
601 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01218)
602 "apr_pollset_add(); check system or user limits");
606 fd.desc.f = err; /* script's stderr */
607 fd.client_data = (void *)2;
608 rv = apr_pollset_add(data->pollset, &fd);
609 if (rv != APR_SUCCESS) {
610 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01219)
611 "apr_pollset_add(); check system or user limits");
620 /* Create a duplicate CGI bucket using given bucket data */
621 static apr_bucket *cgi_bucket_dup(struct cgi_bucket_data *data,
622 apr_bucket_alloc_t *list)
624 apr_bucket *b = apr_bucket_alloc(sizeof(*b), list);
626 b->free = apr_bucket_free;
628 b->type = &bucket_type_cgi;
629 b->length = (apr_size_t)(-1);
635 /* Handle stdout from CGI child. Duplicate of logic from the _read
636 * method of the real APR pipe bucket implementation. */
637 static apr_status_t cgi_read_stdout(apr_bucket *a, apr_file_t *out,
638 const char **str, apr_size_t *len)
644 *len = APR_BUCKET_BUFF_SIZE;
645 buf = apr_bucket_alloc(*len, a->list); /* XXX: check for failure? */
647 rv = apr_file_read(out, buf, len);
649 if (rv != APR_SUCCESS && rv != APR_EOF) {
650 apr_bucket_free(buf);
655 struct cgi_bucket_data *data = a->data;
658 /* Change the current bucket to refer to what we read */
659 a = apr_bucket_heap_make(a, buf, *len, apr_bucket_free);
661 h->alloc_len = APR_BUCKET_BUFF_SIZE; /* note the real buffer size */
663 APR_BUCKET_INSERT_AFTER(a, cgi_bucket_dup(data, a->list));
666 apr_bucket_free(buf);
667 a = apr_bucket_immortal_make(a, "", 0);
673 /* Read method of CGI bucket: polls on stderr and stdout of the child,
674 * sending any stderr output immediately away to the error log. */
675 static apr_status_t cgi_bucket_read(apr_bucket *b, const char **str,
676 apr_size_t *len, apr_read_type_e block)
678 struct cgi_bucket_data *data = b->data;
679 apr_interval_time_t timeout;
683 timeout = block == APR_NONBLOCK_READ ? 0 : data->r->server->timeout;
686 const apr_pollfd_t *results;
689 rv = apr_pollset_poll(data->pollset, timeout, &num, &results);
690 if (APR_STATUS_IS_TIMEUP(rv)) {
692 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, data->r, APLOGNO(01220)
693 "Timeout waiting for output from CGI script %s",
701 else if (APR_STATUS_IS_EINTR(rv)) {
704 else if (rv != APR_SUCCESS) {
705 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, data->r, APLOGNO(01221)
706 "poll failed waiting for CGI child");
710 for (; num; num--, results++) {
711 if (results[0].client_data == (void *)1) {
713 rv = cgi_read_stdout(b, results[0].desc.f, str, len);
714 if (APR_STATUS_IS_EOF(rv)) {
720 apr_status_t rv2 = log_script_err(data->r, results[0].desc.f);
721 if (APR_STATUS_IS_EOF(rv2)) {
722 apr_pollset_remove(data->pollset, &results[0]);
732 static const apr_bucket_type_t bucket_type_cgi = {
733 "CGI", 5, APR_BUCKET_DATA,
734 apr_bucket_destroy_noop,
736 apr_bucket_setaside_notimpl,
737 apr_bucket_split_notimpl,
738 apr_bucket_copy_notimpl
743 static int cgi_handler(request_rec *r)
746 apr_size_t dbpos = 0;
751 apr_file_t *script_out = NULL, *script_in = NULL, *script_err = NULL;
752 apr_bucket_brigade *bb;
755 int seen_eos, child_stopped_reading;
757 cgi_server_conf *conf;
759 cgi_exec_info_t e_info;
762 if (strcmp(r->handler, CGI_MAGIC_TYPE) && strcmp(r->handler, "cgi-script")) {
768 is_included = !strcmp(r->protocol, "INCLUDED");
770 p = r->main ? r->main->pool : r->pool;
772 argv0 = apr_filepath_name_get(r->filename);
773 nph = !(strncmp(argv0, "nph-", 4));
774 conf = ap_get_module_config(r->server->module_config, &cgi_module);
776 if (!(ap_allow_options(r) & OPT_EXECCGI) && !is_scriptaliased(r))
777 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0, APLOGNO(02809),
778 "Options ExecCGI is off in this directory");
779 if (nph && is_included)
780 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0, APLOGNO(02810),
781 "attempt to include NPH CGI script");
783 if (r->finfo.filetype == APR_NOFILE)
784 return log_scripterror(r, conf, HTTP_NOT_FOUND, 0, APLOGNO(02811),
785 "script not found or unable to stat");
786 if (r->finfo.filetype == APR_DIR)
787 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0, APLOGNO(02812),
788 "attempt to invoke directory as script");
790 if ((r->used_path_info == AP_REQ_REJECT_PATH_INFO) &&
791 r->path_info && *r->path_info)
793 /* default to accept */
794 return log_scripterror(r, conf, HTTP_NOT_FOUND, 0, APLOGNO(02813),
795 "AcceptPathInfo off disallows user's path");
798 if (!ap_suexec_enabled) {
799 if (!ap_can_exec(&r->finfo))
800 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
801 "file permissions deny server execution");
805 ap_add_common_vars(r);
808 e_info.process_cgi = 1;
809 e_info.cmd_type = APR_PROGRAM;
811 e_info.in_pipe = APR_CHILD_BLOCK;
812 e_info.out_pipe = APR_CHILD_BLOCK;
813 e_info.err_pipe = APR_CHILD_BLOCK;
814 e_info.prog_type = RUN_AS_CGI;
818 e_info.addrspace = 0;
820 /* build the command line */
821 if ((rv = cgi_build_command(&command, &argv, r, p, &e_info)) != APR_SUCCESS) {
822 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01222)
823 "don't know how to spawn child process: %s",
825 return HTTP_INTERNAL_SERVER_ERROR;
828 /* run the script in its own process */
829 if ((rv = run_cgi_child(&script_out, &script_in, &script_err,
830 command, argv, r, p, &e_info)) != APR_SUCCESS) {
831 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01223)
832 "couldn't spawn child process: %s", r->filename);
833 return HTTP_INTERNAL_SERVER_ERROR;
836 /* Transfer any put/post args, CERN style...
837 * Note that we already ignore SIGPIPE in the core server.
839 bb = apr_brigade_create(r->pool, c->bucket_alloc);
841 child_stopped_reading = 0;
843 dbuf = apr_palloc(r->pool, conf->bufbytes + 1);
849 rv = ap_get_brigade(r->input_filters, bb, AP_MODE_READBYTES,
850 APR_BLOCK_READ, HUGE_STRING_LEN);
852 if (rv != APR_SUCCESS) {
853 if (APR_STATUS_IS_TIMEUP(rv)) {
854 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01224)
855 "Timeout during reading request entity data");
856 return HTTP_REQUEST_TIME_OUT;
858 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01225)
859 "Error reading request entity data");
860 return ap_map_http_request_error(rv, HTTP_INTERNAL_SERVER_ERROR);
863 for (bucket = APR_BRIGADE_FIRST(bb);
864 bucket != APR_BRIGADE_SENTINEL(bb);
865 bucket = APR_BUCKET_NEXT(bucket))
870 if (APR_BUCKET_IS_EOS(bucket)) {
875 /* We can't do much with this. */
876 if (APR_BUCKET_IS_FLUSH(bucket)) {
880 /* If the child stopped, we still must read to EOS. */
881 if (child_stopped_reading) {
886 apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
888 if (conf->logname && dbpos < conf->bufbytes) {
891 if ((dbpos + len) > conf->bufbytes) {
892 cursize = conf->bufbytes - dbpos;
897 memcpy(dbuf + dbpos, data, cursize);
901 /* Keep writing data to the child until done or too much time
902 * elapses with no progress or an error occurs.
904 rv = apr_file_write_full(script_out, data, len, NULL);
906 if (rv != APR_SUCCESS) {
907 /* silly script stopped reading, soak up remaining message */
908 child_stopped_reading = 1;
911 apr_brigade_cleanup(bb);
918 /* Is this flush really needed? */
919 apr_file_flush(script_out);
920 apr_file_close(script_out);
922 AP_DEBUG_ASSERT(script_in != NULL);
924 #if APR_FILES_AS_SOCKETS
925 apr_file_pipe_timeout_set(script_in, 0);
926 apr_file_pipe_timeout_set(script_err, 0);
928 b = cgi_bucket_create(r, script_in, script_err, c->bucket_alloc);
930 return HTTP_INTERNAL_SERVER_ERROR;
932 b = apr_bucket_pipe_create(script_in, c->bucket_alloc);
934 APR_BRIGADE_INSERT_TAIL(bb, b);
935 b = apr_bucket_eos_create(c->bucket_alloc);
936 APR_BRIGADE_INSERT_TAIL(bb, b);
938 /* Handle script return... */
940 const char *location;
941 char sbuf[MAX_STRING_LEN];
944 if ((ret = ap_scan_script_header_err_brigade_ex(r, bb, sbuf,
945 APLOG_MODULE_INDEX)))
947 ret = log_script(r, conf, ret, dbuf, sbuf, bb, script_err);
950 * ret could be HTTP_NOT_MODIFIED in the case that the CGI script
951 * does not set an explicit status and ap_meets_conditions, which
952 * is called by ap_scan_script_header_err_brigade, detects that
953 * the conditions of the requests are met and the response is
955 * In this case set r->status and return OK in order to prevent
956 * running through the error processing stack as this would
957 * break with mod_cache, if the conditions had been set by
958 * mod_cache itself to validate a stale entity.
959 * BTW: We circumvent the error processing stack anyway if the
960 * CGI script set an explicit status code (whatever it is) and
961 * the only possible values for ret here are:
963 * HTTP_NOT_MODIFIED (set by ap_meets_conditions)
964 * HTTP_PRECONDITION_FAILED (set by ap_meets_conditions)
965 * HTTP_INTERNAL_SERVER_ERROR (if something went wrong during the
966 * processing of the response of the CGI script, e.g broken headers
967 * or a crashed CGI process).
969 if (ret == HTTP_NOT_MODIFIED) {
977 location = apr_table_get(r->headers_out, "Location");
979 if (location && r->status == 200) {
980 /* For a redirect whether internal or not, discard any
981 * remaining stdout from the script, and log any remaining
982 * stderr output, as normal. */
983 discard_script_output(bb);
984 apr_brigade_destroy(bb);
985 apr_file_pipe_timeout_set(script_err, r->server->timeout);
986 log_script_err(r, script_err);
989 if (location && location[0] == '/' && r->status == 200) {
990 /* This redirect needs to be a GET no matter what the original
994 r->method_number = M_GET;
996 /* We already read the message body (if any), so don't allow
997 * the redirected request to think it has one. We can ignore
998 * Transfer-Encoding, since we used REQUEST_CHUNKED_ERROR.
1000 apr_table_unset(r->headers_in, "Content-Length");
1002 ap_internal_redirect_handler(location, r);
1005 else if (location && r->status == 200) {
1006 /* XXX: Note that if a script wants to produce its own Redirect
1007 * body, it now has to explicitly *say* "Status: 302"
1009 return HTTP_MOVED_TEMPORARILY;
1012 rv = ap_pass_brigade(r->output_filters, bb);
1015 struct ap_filter_t *cur;
1017 /* get rid of all filters up through protocol... since we
1018 * haven't parsed off the headers, there is no way they can
1022 cur = r->proto_output_filters;
1023 while (cur && cur->frec->ftype < AP_FTYPE_CONNECTION) {
1026 r->output_filters = r->proto_output_filters = cur;
1028 rv = ap_pass_brigade(r->output_filters, bb);
1031 /* don't soak up script output if errors occurred writing it
1032 * out... otherwise, we prolong the life of the script when the
1033 * connection drops or we stopped sending output for some other
1035 if (rv == APR_SUCCESS && !r->connection->aborted) {
1036 apr_file_pipe_timeout_set(script_err, r->server->timeout);
1037 log_script_err(r, script_err);
1040 apr_file_close(script_err);
1042 return OK; /* NOT r->status, even if it has changed. */
1045 /*============================================================================
1046 *============================================================================
1047 * This is the beginning of the cgi filter code moved from mod_include. This
1048 * is the code required to handle the "exec" SSI directive.
1049 *============================================================================
1050 *============================================================================*/
1051 static apr_status_t include_cgi(include_ctx_t *ctx, ap_filter_t *f,
1052 apr_bucket_brigade *bb, char *s)
1054 request_rec *r = f->r;
1055 request_rec *rr = ap_sub_req_lookup_uri(s, r, f->next);
1058 if (rr->status != HTTP_OK) {
1059 ap_destroy_sub_req(rr);
1060 return APR_EGENERAL;
1063 /* No hardwired path info or query allowed */
1064 if ((rr->path_info && rr->path_info[0]) || rr->args) {
1065 ap_destroy_sub_req(rr);
1066 return APR_EGENERAL;
1068 if (rr->finfo.filetype != APR_REG) {
1069 ap_destroy_sub_req(rr);
1070 return APR_EGENERAL;
1073 /* Script gets parameters of the *document*, for back compatibility */
1074 rr->path_info = r->path_info; /* hard to get right; see mod_cgi.c */
1077 /* Force sub_req to be treated as a CGI request, even if ordinary
1078 * typing rules would have called it something else.
1080 ap_set_content_type(rr, CGI_MAGIC_TYPE);
1083 rr_status = ap_run_sub_req(rr);
1084 if (ap_is_HTTP_REDIRECT(rr_status)) {
1085 const char *location = apr_table_get(rr->headers_out, "Location");
1090 location = ap_escape_html(rr->pool, location);
1091 buffer = apr_pstrcat(ctx->pool, "<a href=\"", location, "\">",
1092 location, "</a>", NULL);
1094 APR_BRIGADE_INSERT_TAIL(bb, apr_bucket_pool_create(buffer,
1095 strlen(buffer), ctx->pool,
1096 f->c->bucket_alloc));
1100 ap_destroy_sub_req(rr);
1105 static apr_status_t include_cmd(include_ctx_t *ctx, ap_filter_t *f,
1106 apr_bucket_brigade *bb, const char *command)
1108 cgi_exec_info_t e_info;
1110 apr_file_t *script_out = NULL, *script_in = NULL, *script_err = NULL;
1112 request_rec *r = f->r;
1116 e_info.process_cgi = 0;
1117 e_info.cmd_type = APR_SHELLCMD;
1118 e_info.detached = 0;
1119 e_info.in_pipe = APR_NO_PIPE;
1120 e_info.out_pipe = APR_FULL_BLOCK;
1121 e_info.err_pipe = APR_NO_PIPE;
1122 e_info.prog_type = RUN_AS_SSI;
1125 e_info.next = f->next;
1126 e_info.addrspace = 0;
1128 if ((rv = cgi_build_command(&command, &argv, r, r->pool,
1129 &e_info)) != APR_SUCCESS) {
1130 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01226)
1131 "don't know how to spawn cmd child process: %s",
1136 /* run the script in its own process */
1137 if ((rv = run_cgi_child(&script_out, &script_in, &script_err,
1138 command, argv, r, r->pool,
1139 &e_info)) != APR_SUCCESS) {
1140 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01227)
1141 "couldn't spawn child process: %s", r->filename);
1145 APR_BRIGADE_INSERT_TAIL(bb, apr_bucket_pipe_create(script_in,
1146 f->c->bucket_alloc));
1149 /* We can't close the pipe here, because we may return before the
1150 * full CGI has been sent to the network. That's okay though,
1151 * because we can rely on the pool to close the pipe for us.
1156 static apr_status_t handle_exec(include_ctx_t *ctx, ap_filter_t *f,
1157 apr_bucket_brigade *bb)
1160 char *tag_val = NULL;
1161 request_rec *r = f->r;
1162 char *file = r->filename;
1163 char parsed_string[MAX_STRING_LEN];
1166 ap_log_rerror(APLOG_MARK,
1167 (ctx->flags & SSI_FLAG_PRINTING)
1168 ? APLOG_ERR : APLOG_WARNING,
1169 0, r, "missing argument for exec element in %s",
1173 if (!(ctx->flags & SSI_FLAG_PRINTING)) {
1178 SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1182 if (ctx->flags & SSI_FLAG_NO_EXEC) {
1183 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01228) "exec used but not allowed "
1184 "in %s", r->filename);
1185 SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1190 cgi_pfn_gtv(ctx, &tag, &tag_val, SSI_VALUE_DECODED);
1191 if (!tag || !tag_val) {
1195 if (!strcmp(tag, "cmd")) {
1198 cgi_pfn_ps(ctx, tag_val, parsed_string, sizeof(parsed_string),
1199 SSI_EXPAND_LEAVE_NAME);
1201 rv = include_cmd(ctx, f, bb, parsed_string);
1202 if (rv != APR_SUCCESS) {
1203 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01229) "execution failure "
1204 "for parameter \"%s\" to tag exec in file %s",
1206 SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1210 else if (!strcmp(tag, "cgi")) {
1213 cgi_pfn_ps(ctx, tag_val, parsed_string, sizeof(parsed_string),
1214 SSI_EXPAND_DROP_NAME);
1216 rv = include_cgi(ctx, f, bb, parsed_string);
1217 if (rv != APR_SUCCESS) {
1218 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01230) "invalid CGI ref "
1219 "\"%s\" in %s", tag_val, file);
1220 SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1225 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01231) "unknown parameter "
1226 "\"%s\" to tag exec in %s", tag, file);
1227 SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1236 /*============================================================================
1237 *============================================================================
1238 * This is the end of the cgi filter code moved from mod_include.
1239 *============================================================================
1240 *============================================================================*/
1243 static int cgi_post_config(apr_pool_t *p, apr_pool_t *plog,
1244 apr_pool_t *ptemp, server_rec *s)
1246 cgi_pfn_reg_with_ssi = APR_RETRIEVE_OPTIONAL_FN(ap_register_include_handler);
1247 cgi_pfn_gtv = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_get_tag_and_value);
1248 cgi_pfn_ps = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_parse_string);
1250 if ((cgi_pfn_reg_with_ssi) && (cgi_pfn_gtv) && (cgi_pfn_ps)) {
1251 /* Required by mod_include filter. This is how mod_cgi registers
1252 * with mod_include to provide processing of the exec directive.
1254 cgi_pfn_reg_with_ssi("exec", handle_exec);
1257 /* This is the means by which unusual (non-unix) os's may find alternate
1258 * means to run a given command (e.g. shebang/registry parsing on Win32)
1260 cgi_build_command = APR_RETRIEVE_OPTIONAL_FN(ap_cgi_build_command);
1261 if (!cgi_build_command) {
1262 cgi_build_command = default_build_command;
1267 static void register_hooks(apr_pool_t *p)
1269 static const char * const aszPre[] = { "mod_include.c", NULL };
1270 ap_hook_handler(cgi_handler, NULL, NULL, APR_HOOK_MIDDLE);
1271 ap_hook_post_config(cgi_post_config, aszPre, NULL, APR_HOOK_REALLY_FIRST);
1274 AP_DECLARE_MODULE(cgi) =
1276 STANDARD20_MODULE_STUFF,
1277 NULL, /* dir config creater */
1278 NULL, /* dir merger --- default is to override */
1279 create_cgi_config, /* server config */
1280 merge_cgi_config, /* merge server config */
1281 cgi_cmds, /* command apr_table_t */
1282 register_hooks /* register hooks */