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_script: keeps all script-related ramblings together.
62 * Compliant to cgi/1.1 spec
64 * Adapted by rst from original NCSA code by Rob McCool
66 * Apache adds some new env vars; REDIRECT_URL and REDIRECT_QUERY_STRING for
67 * custom error responses, and DOCUMENT_ROOT because we found it useful.
68 * It also adds SERVER_ADMIN - useful for scripts to know who to mail when
73 #include "apr_strings.h"
74 #include "apr_general.h"
75 #include "apr_file_io.h"
76 #include "apr_portable.h"
77 #include "apr_buckets.h"
78 #include "apr_optional.h"
79 #include "apr_signal.h"
81 #define APR_WANT_STRFUNC
84 #if APR_HAVE_SYS_SOCKET_H
85 #include <sys/socket.h>
90 #if APR_HAVE_SYS_TYPES_H
91 #include <sys/types.h>
96 #include "util_filter.h"
98 #include "http_config.h"
99 #include "http_request.h"
100 #include "http_core.h"
101 #include "http_protocol.h"
102 #include "http_main.h"
103 #include "http_log.h"
104 #include "util_script.h"
107 #include "mod_suexec.h"
108 #include "../filters/mod_include.h"
110 #include "mod_core.h"
113 /* ### should be tossed in favor of APR */
114 #include <sys/stat.h>
115 #include <sys/un.h> /* for sockaddr_un */
118 module AP_MODULE_DECLARE_DATA cgid_module;
120 static void cgid_init(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *main_server);
121 static int handle_exec(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
122 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head);
124 static APR_OPTIONAL_FN_TYPE(ap_register_include_handler) *cgid_pfn_reg_with_ssi;
125 static APR_OPTIONAL_FN_TYPE(ap_ssi_get_tag_and_value) *cgid_pfn_gtv;
126 static APR_OPTIONAL_FN_TYPE(ap_ssi_parse_string) *cgid_pfn_ps;
128 static apr_pool_t *pcgi;
129 static int total_modules = 0;
131 /* KLUDGE --- for back-combatibility, we don't have to check Execcgid
132 * in ScriptAliased directories, which means we need to know if this
133 * request came through ScriptAlias or not... so the Alias module
134 * leaves a note for us.
137 static int is_scriptaliased(request_rec *r)
139 const char *t = apr_table_get(r->notes, "alias-forced-type");
140 return t && (!strcasecmp(t, "cgi-script"));
143 /* Configuration stuff */
145 #define DEFAULT_LOGBYTES 10385760
146 #define DEFAULT_BUFBYTES 1024
147 #define DEFAULT_SOCKET "logs/cgisock"
149 #define SHELL_PATH "/bin/sh"
154 /* DEFAULT_CGID_LISTENBACKLOG controls the max depth on the unix socket's
155 * pending connection queue. If a bunch of cgi requests arrive at about
156 * the same time, connections from httpd threads/processes will back up
157 * in the queue while the cgid process slowly forks off a child to process
158 * each connection on the unix socket. If the queue is too short, the
159 * httpd process will get ECONNREFUSED when trying to connect.
161 #ifndef DEFAULT_CGID_LISTENBACKLOG
162 #define DEFAULT_CGID_LISTENBACKLOG 100
166 const char *sockname;
172 /* If a request includes query info in the URL (stuff after "?"), and
173 * the query info does not contain "=" (indicative of a FORM submission),
174 * then this routine is called to create the argument list to be passed
175 * to the CGI script. When suexec is enabled, the suexec path, user, and
176 * group are the first three arguments to be passed; if not, all three
177 * must be NULL. The query info is split into separate arguments, where
178 * "+" is the separator between keyword arguments.
180 * XXXX: note that the WIN32 code uses one of the suexec strings
181 * to pass an interpreter name. Remember this if changing the way they
182 * are handled in create_argv.
185 static char **create_argv(apr_pool_t *p, char *path, char *user, char *group,
186 char *av0, const char *args)
193 /* count the number of keywords */
195 for (x = 0, numwords = 1; args[x]; x++) {
196 if (args[x] == '+') {
201 if (numwords > APACHE_ARG_MAX - 5) {
202 numwords = APACHE_ARG_MAX - 5; /* Truncate args to prevent overrun */
204 av = (char **) apr_pcalloc(p, (numwords + 5) * sizeof(char *));
216 av[idx++] = apr_pstrdup(p, av0);
218 for (x = 1; x <= numwords; x++) {
219 w = ap_getword_nulls(p, &args, '+');
222 av[idx++] = ap_escape_shell_cmd(p, w);
229 #if APR_HAS_OTHER_CHILD
230 static void cgid_maint(int reason, void *data, apr_wait_t status)
235 case APR_OC_REASON_DEATH:
236 /* don't do anything; server is stopping or restarting */
238 case APR_OC_REASON_LOST:
239 /* it would be better to restart just the cgid child
240 * process but for now we'll gracefully restart the entire
241 * server by sending AP_SIG_GRACEFUL to ourself, the httpd
244 kill(getpid(), AP_SIG_GRACEFUL);
246 case APR_OC_REASON_RESTART:
247 apr_proc_other_child_unregister(data);
249 case APR_OC_REASON_UNREGISTER:
250 /* we get here when pcgi is cleaned up; pcgi gets cleaned
251 * up when pconf gets cleaned up
259 static void get_req(int fd, request_rec *r, char **argv0, char ***env, int *req_type)
264 core_dir_config *temp_core;
266 module *suexec_mod = ap_find_linked_module("mod_suexec.c");
268 r->server = apr_pcalloc(r->pool, sizeof(server_rec));
270 read(fd, req_type, sizeof(int));
271 read(fd, &j, sizeof(int));
272 read(fd, &len, sizeof(int));
273 data = apr_pcalloc(r->pool, len + 1); /* get a cleared byte for final '\0' */
274 i = read(fd, data, len);
276 r->filename = ap_getword(r->pool, (const char **)&data, '\n');
277 *argv0 = ap_getword(r->pool, (const char **)&data, '\n');
279 r->uri = ap_getword(r->pool, (const char **)&data, '\n');
281 environ = apr_pcalloc(r->pool, (j + 2) *sizeof(char *));
283 for (i = 0; i < j; i++) {
284 environ[i] = ap_getword(r->pool, (const char **)&data, '\n');
287 r->args = ap_getword(r->pool, (const char **)&data, '\n');
289 read(fd, &i, sizeof(int));
291 /* add 1, so that if i == 0, we still malloc something. */
293 dconf = (void **) apr_pcalloc(r->pool, sizeof(void *) * (total_modules + DYNAMIC_MODULE_LIMIT));
295 temp_core = (core_dir_config *)apr_palloc(r->pool, sizeof(core_module));
297 dconf[i] = (void *)temp_core;
300 suexec_config_t *suexec_cfg = apr_pcalloc(r->pool, sizeof(*suexec_cfg));
302 read(fd, &i, sizeof(int));
303 read(fd, &suexec_cfg->ugid.uid, sizeof(uid_t));
304 read(fd, &suexec_cfg->ugid.gid, sizeof(gid_t));
305 read(fd, &suexec_cfg->active, sizeof(int));
306 dconf[i] = (void *)suexec_cfg;
309 r->per_dir_config = (ap_conf_vector_t *)dconf;
312 read(fd, &j, sizeof(int));
314 temp_core->limit_cpu = (struct rlimit *)apr_palloc (sizeof(struct rlimit));
315 read(fd, temp_core->limit_cpu, sizeof(struct rlimit));
318 temp_core->limit_cpu = NULL;
322 #if defined (RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
323 read(fd, &j, sizeof(int));
325 temp_core->limit_mem = (struct rlimit *)apr_palloc(r->pool, sizeof(struct rlimit));
326 read(fd, temp_core->limit_mem, sizeof(struct rlimit));
329 temp_core->limit_mem = NULL;
334 read(fd, &j, sizeof(int));
336 temp_core->limit_nproc = (struct rlimit *)apr_palloc(r->pool, sizeof(struct rlimit));
337 read(fd, temp_core->limit_nproc, sizeof(struct rlimit));
340 temp_core->limit_nproc = NULL;
344 /* For right now, just make the notes table. At some point we will need
345 * to actually fill this out, but for now we just don't want suexec to
348 r->notes = apr_table_make(r->pool, 1);
353 static void send_req(int fd, request_rec *r, char *argv0, char **env, int req_type)
355 int len, r_type = req_type;
358 module *suexec_mod = ap_find_linked_module("mod_suexec.c");
360 data = apr_pstrcat(r->pool, r->filename, "\n", argv0, "\n", r->uri, "\n",
363 for (i =0; env[i]; i++) {
367 /* Write the request type (SSI "exec cmd" or cgi). */
368 if (write(fd, &r_type, sizeof(int)) < 0) {
369 ap_log_rerror(APLOG_MARK, APLOG_ERR, errno, r,
370 "write to cgi daemon process");
373 /* Write the number of entries in the environment. */
374 if (write(fd, &i, sizeof(int)) < 0) {
375 ap_log_rerror(APLOG_MARK, APLOG_ERR, errno, r,
376 "write to cgi daemon process");
379 for (i = 0; env[i]; i++) {
380 data = apr_pstrcat(r->pool, data, env[i], "\n", NULL);
382 data = apr_pstrcat(r->pool, data, r->args, NULL);
384 /* Write the length of the concatenated env string. */
385 if (write(fd, &len, sizeof(int)) < 0) {
386 ap_log_rerror(APLOG_MARK, APLOG_ERR, errno, r,
387 "write to cgi daemon process");
389 /* Write the concatted env string. */
390 if (write(fd, data, len) < 0) {
391 ap_log_rerror(APLOG_MARK, APLOG_ERR, errno, r,
392 "write to cgi daemon process");
394 /* Write module_index id value. */
395 if (write(fd, &core_module.module_index, sizeof(int)) < 0) {
396 ap_log_rerror(APLOG_MARK, APLOG_ERR, errno, r,
397 "write to cgi daemon process");
400 suexec_config_t *suexec_cfg = ap_get_module_config(r->per_dir_config,
403 write(fd, &suexec_mod->module_index, sizeof(int));
404 write(fd, &suexec_cfg->ugid.uid, sizeof(uid_t));
405 write(fd, &suexec_cfg->ugid.gid, sizeof(gid_t));
406 write(fd, &suexec_cfg->active, sizeof(int));
411 if (conf->limit_cpu) {
413 write(fd, &len, sizeof(int));
414 write(fd, conf->limit_cpu, sizeof(struct rlimit));
418 write(fd, &len, sizeof(int));
422 #if defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
423 if (conf->limit_mem) {
425 write(fd, &len, sizeof(int));
426 write(fd, conf->limit_mem, sizeof(struct rlimit));
430 write(fd, &len, sizeof(int));
435 if (conf->limit_nproc) {
437 write(fd, &len, sizeof(int));
438 write(fd, conf->limit_nproc, sizeof(struct rlimit));
442 write(fd, &len, sizeof(int));
448 static int cgid_server(void *data)
450 struct sockaddr_un unix_addr;
451 int sd, sd2, rc, req_type;
455 server_rec *main_server = data;
456 cgid_server_conf *sconf = ap_get_module_config(main_server->module_config,
459 apr_pool_create(&ptrans, pcgi);
461 apr_signal(SIGCHLD, SIG_IGN);
462 if (unlink(sconf->sockname) < 0 && errno != ENOENT) {
463 ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server,
464 "Couldn't unlink unix domain socket %s",
466 /* just a warning; don't bail out */
469 if ((sd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
470 ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server,
471 "Couldn't create unix domain socket");
475 memset(&unix_addr, 0, sizeof(unix_addr));
476 unix_addr.sun_family = AF_UNIX;
477 strcpy(unix_addr.sun_path, sconf->sockname);
479 omask = umask(0077); /* so that only Apache can use socket */
480 rc = bind(sd, (struct sockaddr *)&unix_addr, sizeof(unix_addr));
481 umask(omask); /* can't fail, so can't clobber errno */
483 ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server,
484 "Couldn't bind unix domain socket %s",
489 if (listen(sd, DEFAULT_CGID_LISTENBACKLOG) < 0) {
490 ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server,
491 "Couldn't listen on unix domain socket");
496 if (chown(sconf->sockname, unixd_config.user_id, -1) < 0) {
497 ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server,
498 "Couldn't change owner of unix domain socket %s",
504 unixd_setup_child(); /* if running as root, switch to configured user/group */
506 int errfileno = STDERR_FILENO;
509 const char * const *argv;
510 apr_int32_t in_pipe = APR_CHILD_BLOCK;
511 apr_int32_t out_pipe = APR_CHILD_BLOCK;
512 apr_int32_t err_pipe = APR_CHILD_BLOCK;
513 apr_cmdtype_e cmd_type = APR_PROGRAM;
515 apr_procattr_t *procattr = NULL;
516 apr_proc_t *procnew = NULL;
519 apr_pool_clear(ptrans);
521 len = sizeof(unix_addr);
522 sd2 = accept(sd, (struct sockaddr *)&unix_addr, &len);
524 if (errno != EINTR) {
525 ap_log_error(APLOG_MARK, APLOG_ERR, errno,
527 "Error accepting on cgid socket.");
532 r = apr_pcalloc(ptrans, sizeof(request_rec));
533 procnew = apr_pcalloc(ptrans, sizeof(*procnew));
535 get_req(sd2, r, &argv0, &env, &req_type);
536 apr_os_file_put(&r->server->error_log, &errfileno, r->pool);
537 apr_os_file_put(&inout, &sd2, r->pool);
539 if (req_type == SSI_REQ) {
540 in_pipe = APR_NO_PIPE;
541 out_pipe = APR_FULL_BLOCK;
542 err_pipe = APR_NO_PIPE;
543 cmd_type = APR_SHELLCMD;
546 if (((rc = apr_procattr_create(&procattr, ptrans)) != APR_SUCCESS) ||
547 ((req_type == CGI_REQ) &&
548 (((rc = apr_procattr_io_set(procattr,
551 err_pipe)) != APR_SUCCESS) ||
552 /* XXX apr_procattr_child_*_set() is creating an unnecessary
553 * pipe between this process and the child being created...
554 * It is cleaned up with the temporary pool for this request.
556 ((rc = apr_procattr_child_err_set(procattr, r->server->error_log, NULL)) != APR_SUCCESS) ||
557 ((rc = apr_procattr_child_in_set(procattr, inout, NULL)) != APR_SUCCESS))) ||
558 ((rc = apr_procattr_child_out_set(procattr, inout, NULL)) != APR_SUCCESS) ||
559 ((rc = apr_procattr_dir_set(procattr,
560 ap_make_dirstr_parent(r->pool, r->filename))) != APR_SUCCESS) ||
561 ((rc = apr_procattr_cmdtype_set(procattr, cmd_type)) != APR_SUCCESS)) {
562 /* Something bad happened, tell the world. */
563 ap_log_rerror(APLOG_MARK, APLOG_ERR, rc, r,
564 "couldn't set child process attributes: %s", r->filename);
567 argv = (const char * const *)create_argv(r->pool, NULL, NULL, NULL, argv0, r->args);
569 /* We want to sd2 close for new CGI process too.
570 * If it's remained open it'll make ap_pass_brigade() block
571 * waiting for EOF if CGI forked something running long.
572 * close(sd2) here should be okay, as CGI channel
573 * is already dup()ed by apr_procattr_child_{in,out}_set()
578 rc = ap_os_create_privileged_process(r, procnew, argv0, argv,
579 (const char * const *)env,
582 if (rc != APR_SUCCESS) {
583 /* Bad things happened. Everyone should have cleaned up. */
584 ap_log_rerror(APLOG_MARK, APLOG_ERR, rc, r,
585 "couldn't create child process: %d: %s", rc, r->filename);
592 static void cgid_init(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp,
593 server_rec *main_server)
599 const char *userdata_key = "cgid_init";
602 apr_pool_userdata_get(&data, userdata_key, main_server->process->pool);
605 apr_pool_userdata_set((const void *)1, userdata_key,
606 apr_pool_cleanup_null, main_server->process->pool);
611 for (m = ap_preloaded_modules; *m != NULL; m++)
615 if ((pid = fork()) < 0) {
616 ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server,
617 "Couldn't spawn cgid daemon process");
620 apr_pool_create(&pcgi, p);
621 cgid_server(main_server);
624 procnew = apr_pcalloc(p, sizeof(*procnew));
626 procnew->err = procnew->in = procnew->out = NULL;
627 apr_pool_note_subprocess(p, procnew, kill_after_timeout);
628 #if APR_HAS_OTHER_CHILD
629 apr_proc_other_child_register(procnew, cgid_maint, &procnew->pid, NULL, p);
632 cgid_pfn_reg_with_ssi = APR_RETRIEVE_OPTIONAL_FN(ap_register_include_handler);
633 cgid_pfn_gtv = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_get_tag_and_value);
634 cgid_pfn_ps = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_parse_string);
636 if ((cgid_pfn_reg_with_ssi) && (cgid_pfn_gtv) && (cgid_pfn_ps)) {
637 /* Required by mod_include filter. This is how mod_cgid registers
638 * with mod_include to provide processing of the exec directive.
640 cgid_pfn_reg_with_ssi("exec", handle_exec);
645 static void *create_cgid_config(apr_pool_t *p, server_rec *s)
647 cgid_server_conf *c =
648 (cgid_server_conf *) apr_pcalloc(p, sizeof(cgid_server_conf));
651 c->logbytes = DEFAULT_LOGBYTES;
652 c->bufbytes = DEFAULT_BUFBYTES;
653 c->sockname = ap_server_root_relative(p, DEFAULT_SOCKET);
657 static void *merge_cgid_config(apr_pool_t *p, void *basev, void *overridesv)
659 cgid_server_conf *base = (cgid_server_conf *) basev, *overrides = (cgid_server_conf *) overridesv;
661 return overrides->logname ? overrides : base;
664 static const char *set_scriptlog(cmd_parms *cmd, void *dummy, const char *arg)
666 server_rec *s = cmd->server;
667 cgid_server_conf *conf = ap_get_module_config(s->module_config,
670 conf->logname = ap_server_root_relative(cmd->pool, arg);
674 static const char *set_scriptlog_length(cmd_parms *cmd, void *dummy, const char *arg)
676 server_rec *s = cmd->server;
677 cgid_server_conf *conf = ap_get_module_config(s->module_config,
680 conf->logbytes = atol(arg);
684 static const char *set_scriptlog_buffer(cmd_parms *cmd, void *dummy, const char *arg)
686 server_rec *s = cmd->server;
687 cgid_server_conf *conf = ap_get_module_config(s->module_config,
690 conf->bufbytes = atoi(arg);
694 static const char *set_script_socket(cmd_parms *cmd, void *dummy, const char *arg)
696 server_rec *s = cmd->server;
697 cgid_server_conf *conf = ap_get_module_config(s->module_config,
700 conf->sockname = ap_server_root_relative(cmd->pool, arg);
704 static const command_rec cgid_cmds[] =
706 AP_INIT_TAKE1("ScriptLog", set_scriptlog, NULL, RSRC_CONF,
707 "the name of a log for script debugging info"),
708 AP_INIT_TAKE1("ScriptLogLength", set_scriptlog_length, NULL, RSRC_CONF,
709 "the maximum length (in bytes) of the script debug log"),
710 AP_INIT_TAKE1("ScriptLogBuffer", set_scriptlog_buffer, NULL, RSRC_CONF,
711 "the maximum size (in bytes) to record of a POST request"),
712 AP_INIT_TAKE1("Scriptsock", set_script_socket, NULL, RSRC_CONF,
713 "the name of the socket to use for communication with "
718 static int log_scripterror(request_rec *r, cgid_server_conf * conf, int ret,
719 apr_status_t rv, char *error)
721 apr_file_t *f = NULL;
723 char time_str[APR_CTIME_LEN];
724 int log_flags = rv ? APLOG_ERR : APLOG_NOERRNO | APLOG_ERR;
726 ap_log_rerror(APLOG_MARK, log_flags, rv, r,
727 "%s: %s", error, r->filename);
729 /* XXX Very expensive mainline case! Open, then getfileinfo! */
730 if (!conf->logname ||
731 ((stat(conf->logname, &finfo) == 0)
732 && (finfo.st_size > conf->logbytes)) ||
733 (apr_file_open(&f, conf->logname,
734 APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT, r->pool) != APR_SUCCESS)) {
738 /* "%% [Wed Jun 19 10:53:21 1996] GET /cgid-bin/printenv HTTP/1.0" */
739 apr_ctime(time_str, apr_time_now());
740 apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
741 r->args ? "?" : "", r->args ? r->args : "", r->protocol);
742 /* "%% 500 /usr/local/apache/cgid-bin */
743 apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
745 apr_file_printf(f, "%%error\n%s\n", error);
751 static int log_script(request_rec *r, cgid_server_conf * conf, int ret,
752 char *dbuf, const char *sbuf, apr_file_t *script_in, apr_file_t *script_err)
754 apr_array_header_t *hdrs_arr = apr_table_elts(r->headers_in);
755 apr_table_entry_t *hdrs = (apr_table_entry_t *) hdrs_arr->elts;
756 char argsbuffer[HUGE_STRING_LEN];
757 apr_file_t *f = NULL;
760 char time_str[APR_CTIME_LEN];
762 /* XXX Very expensive mainline case! Open, then getfileinfo! */
763 if (!conf->logname ||
764 ((stat(conf->logname, &finfo) == 0)
765 && (finfo.st_size > conf->logbytes)) ||
766 (apr_file_open(&f, conf->logname,
767 APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT, r->pool) != APR_SUCCESS)) {
768 /* Soak up script output */
769 while (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_in) == 0)
772 while (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_err) == 0)
778 /* "%% [Wed Jun 19 10:53:21 1996] GET /cgid-bin/printenv HTTP/1.0" */
779 apr_ctime(time_str, apr_time_now());
780 apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
781 r->args ? "?" : "", r->args ? r->args : "", r->protocol);
782 /* "%% 500 /usr/local/apache/cgid-bin" */
783 apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
785 apr_file_puts("%request\n", f);
786 for (i = 0; i < hdrs_arr->nelts; ++i) {
789 apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
791 if ((r->method_number == M_POST || r->method_number == M_PUT)
793 apr_file_printf(f, "\n%s\n", dbuf);
796 apr_file_puts("%response\n", f);
797 hdrs_arr = apr_table_elts(r->err_headers_out);
798 hdrs = (apr_table_entry_t *) hdrs_arr->elts;
800 for (i = 0; i < hdrs_arr->nelts; ++i) {
803 apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
807 apr_file_printf(f, "%s\n", sbuf);
809 if (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_in) == 0) {
810 apr_file_puts("%stdout\n", f);
811 apr_file_puts(argsbuffer, f);
812 while (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_in) == 0)
813 apr_file_puts(argsbuffer, f);
814 apr_file_puts("\n", f);
818 if (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_err) == 0) {
819 apr_file_puts("%stderr\n", f);
820 apr_file_puts(argsbuffer, f);
821 while (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_err) == 0)
822 apr_file_puts(argsbuffer, f);
823 apr_file_puts("\n", f);
827 apr_file_close(script_in);
829 apr_file_close(script_err);
838 /****************************************************************
840 * Actual cgid handling...
842 static int cgid_handler(request_rec *r)
844 int retval, nph, dbpos = 0;
845 char *argv0, *dbuf = NULL;
846 apr_bucket_brigade *bb;
848 char argsbuffer[HUGE_STRING_LEN];
849 cgid_server_conf *conf;
853 struct sockaddr_un unix_addr;
854 apr_file_t *tempsock;
857 if(strcmp(r->handler,CGI_MAGIC_TYPE) && strcmp(r->handler,"cgi-script"))
860 if (r->method_number == M_OPTIONS) {
861 /* 99 out of 100 cgid scripts, this is all they support */
862 r->allowed |= (AP_METHOD_BIT << M_GET);
863 r->allowed |= (AP_METHOD_BIT << M_POST);
867 conf = ap_get_module_config(r->server->module_config, &cgid_module);
868 is_included = !strcmp(r->protocol, "INCLUDED");
870 if ((argv0 = strrchr(r->filename, '/')) != NULL)
875 nph = !(strncmp(argv0, "nph-", 4));
877 if ((argv0 = strrchr(r->filename, '/')) != NULL)
882 if (!(ap_allow_options(r) & OPT_EXECCGI) && !is_scriptaliased(r))
883 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
884 "Options ExecCGI is off in this directory");
885 if (nph && is_included)
886 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
887 "attempt to include NPH CGI script");
889 #if defined(OS2) || defined(WIN32)
890 #error mod_cgid does not work on this platform. If you teach it to, look
891 #error at mod_cgi.c for required code in this path.
893 if (r->finfo.filetype == 0)
894 return log_scripterror(r, conf, HTTP_NOT_FOUND, 0,
895 "script not found or unable to stat");
897 if (r->finfo.filetype == APR_DIR)
898 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
899 "attempt to invoke directory as script");
901 if (!ap_suexec_enabled) {
902 if (!ap_can_exec(&r->finfo))
903 return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
904 "file permissions deny server execution");
907 ap_add_common_vars(r);
909 env = ap_create_environment(r->pool, r->subprocess_env);
911 if ((sd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
912 return log_scripterror(r, conf, HTTP_INTERNAL_SERVER_ERROR, errno,
913 "unable to create socket to cgi daemon");
915 memset(&unix_addr, 0, sizeof(unix_addr));
916 unix_addr.sun_family = AF_UNIX;
917 strcpy(unix_addr.sun_path, conf->sockname);
919 if (connect(sd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) < 0) {
920 return log_scripterror(r, conf, HTTP_INTERNAL_SERVER_ERROR, errno,
921 "unable to connect to cgi daemon");
924 send_req(sd, r, argv0, env, CGI_REQ);
926 /* We are putting the tempsock variable into a file so that we can use
927 * a pipe bucket to send the data to the client.
929 apr_os_file_put(&tempsock, &sd, r->pool);
931 if ((retval = ap_setup_client_block(r, REQUEST_CHUNKED_ERROR)))
934 if ((argv0 = strrchr(r->filename, '/')) != NULL)
939 /* Transfer any put/post args, CERN style...
940 * Note that we already ignore SIGPIPE in the core server.
943 if (ap_should_client_block(r)) {
944 int dbsize, len_read;
947 dbuf = apr_pcalloc(r->pool, conf->bufbytes + 1);
952 ap_get_client_block(r, argsbuffer, HUGE_STRING_LEN)) > 0) {
954 if ((dbpos + len_read) > conf->bufbytes) {
955 dbsize = conf->bufbytes - dbpos;
960 memcpy(dbuf + dbpos, argsbuffer, dbsize);
964 apr_file_write(tempsock, argsbuffer, &nbytes);
965 if (nbytes < len_read) {
966 /* silly script stopped reading, soak up remaining message */
967 while (ap_get_client_block(r, argsbuffer, HUGE_STRING_LEN) > 0) {
974 /* we're done writing, or maybe we didn't write at all;
975 * force EOF on child's stdin so that the cgi detects end (or
980 /* Handle script return... */
982 const char *location;
983 char sbuf[MAX_STRING_LEN];
986 if ((ret = ap_scan_script_header_err(r, tempsock, sbuf))) {
987 return log_script(r, conf, ret, dbuf, sbuf, tempsock, NULL);
990 location = apr_table_get(r->headers_out, "Location");
992 if (location && location[0] == '/' && r->status == 200) {
994 /* Soak up all the script output */
995 while (apr_file_gets(argsbuffer, HUGE_STRING_LEN, tempsock) > 0) {
998 /* This redirect needs to be a GET no matter what the original
1001 r->method = apr_pstrdup(r->pool, "GET");
1002 r->method_number = M_GET;
1004 /* We already read the message body (if any), so don't allow
1005 * the redirected request to think it has one. We can ignore
1006 * Transfer-Encoding, since we used REQUEST_CHUNKED_ERROR.
1008 apr_table_unset(r->headers_in, "Content-Length");
1010 ap_internal_redirect_handler(location, r);
1013 else if (location && r->status == 200) {
1014 /* XX Note that if a script wants to produce its own Redirect
1015 * body, it now has to explicitly *say* "Status: 302"
1017 return HTTP_MOVED_TEMPORARILY;
1020 if (!r->header_only) {
1021 bb = apr_brigade_create(r->pool);
1022 b = apr_bucket_pipe_create(tempsock);
1023 APR_BRIGADE_INSERT_TAIL(bb, b);
1024 b = apr_bucket_eos_create();
1025 APR_BRIGADE_INSERT_TAIL(bb, b);
1026 ap_pass_brigade(r->output_filters, bb);
1031 bb = apr_brigade_create(r->pool);
1032 b = apr_bucket_pipe_create(tempsock);
1033 APR_BRIGADE_INSERT_TAIL(bb, b);
1034 b = apr_bucket_eos_create();
1035 APR_BRIGADE_INSERT_TAIL(bb, b);
1036 ap_pass_brigade(r->output_filters, bb);
1039 apr_file_close(tempsock);
1041 return OK; /* NOT r->status, even if it has changed. */
1047 /*============================================================================
1048 *============================================================================
1049 * This is the beginning of the cgi filter code moved from mod_include. This
1050 * is the code required to handle the "exec" SSI directive.
1051 *============================================================================
1052 *============================================================================*/
1053 static int include_cgi(char *s, request_rec *r, ap_filter_t *next,
1054 apr_bucket *head_ptr, apr_bucket **inserted_head)
1056 request_rec *rr = ap_sub_req_lookup_uri(s, r, next);
1058 apr_bucket *tmp_buck, *tmp2_buck;
1060 if (rr->status != HTTP_OK) {
1061 ap_destroy_sub_req(rr);
1065 /* No hardwired path info or query allowed */
1067 if ((rr->path_info && rr->path_info[0]) || rr->args) {
1068 ap_destroy_sub_req(rr);
1071 if (rr->finfo.filetype != APR_REG) {
1072 ap_destroy_sub_req(rr);
1076 /* Script gets parameters of the *document*, for back compatibility */
1078 rr->path_info = r->path_info; /* hard to get right; see mod_cgi.c */
1081 /* Force sub_req to be treated as a CGI request, even if ordinary
1082 * typing rules would have called it something else.
1085 rr->content_type = CGI_MAGIC_TYPE;
1089 rr_status = ap_run_sub_req(rr);
1090 if (ap_is_HTTP_REDIRECT(rr_status)) {
1091 apr_size_t len_loc, h_wrt;
1092 const char *location = apr_table_get(rr->headers_out, "Location");
1094 location = ap_escape_html(rr->pool, location);
1095 len_loc = strlen(location);
1097 tmp_buck = apr_bucket_immortal_create("<A HREF=\"", sizeof("<A HREF=\""));
1098 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp_buck);
1099 tmp2_buck = apr_bucket_heap_create(location, len_loc, 1, &h_wrt);
1100 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp2_buck);
1101 tmp2_buck = apr_bucket_immortal_create("\">", sizeof("\">"));
1102 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp2_buck);
1103 tmp2_buck = apr_bucket_heap_create(location, len_loc, 1, &h_wrt);
1104 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp2_buck);
1105 tmp2_buck = apr_bucket_immortal_create("</A>", sizeof("</A>"));
1106 APR_BUCKET_INSERT_BEFORE(head_ptr, tmp2_buck);
1108 if (*inserted_head == NULL) {
1109 *inserted_head = tmp_buck;
1113 ap_destroy_sub_req(rr);
1119 /* This is the special environment used for running the "exec cmd="
1120 * variety of SSI directives.
1122 static void add_ssi_vars(request_rec *r, ap_filter_t *next)
1124 apr_table_t *e = r->subprocess_env;
1126 if (r->path_info && r->path_info[0] != '\0') {
1127 request_rec *pa_req;
1129 apr_table_setn(e, "PATH_INFO", ap_escape_shell_cmd(r->pool, r->path_info));
1131 pa_req = ap_sub_req_lookup_uri(ap_escape_uri(r->pool, r->path_info), r, next);
1132 if (pa_req->filename) {
1133 apr_table_setn(e, "PATH_TRANSLATED",
1134 apr_pstrcat(r->pool, pa_req->filename, pa_req->path_info, NULL));
1136 ap_destroy_sub_req(pa_req);
1140 char *arg_copy = apr_pstrdup(r->pool, r->args);
1142 apr_table_setn(e, "QUERY_STRING", r->args);
1143 ap_unescape_url(arg_copy);
1144 apr_table_setn(e, "QUERY_STRING_UNESCAPED", ap_escape_shell_cmd(r->pool, arg_copy));
1148 static int include_cmd(include_ctx_t *ctx, apr_bucket_brigade **bb, char *command,
1149 request_rec *r, ap_filter_t *f)
1152 const char *location;
1154 apr_status_t rc = APR_SUCCESS;
1156 apr_bucket_brigade *bcgi;
1158 struct sockaddr_un unix_addr;
1159 apr_file_t *tempsock = NULL;
1160 cgid_server_conf *conf = ap_get_module_config(r->server->module_config,
1163 add_ssi_vars(r, f->next);
1164 env = ap_create_environment(r->pool, r->subprocess_env);
1166 if ((sd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
1167 return log_scripterror(r, conf, HTTP_INTERNAL_SERVER_ERROR, 0,
1168 "unable to create socket to cgi daemon");
1171 memset(&unix_addr, 0, sizeof(unix_addr));
1172 unix_addr.sun_family = AF_UNIX;
1173 strcpy(unix_addr.sun_path, conf->sockname);
1175 if (connect(sd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) < 0) {
1176 return log_scripterror(r, conf, HTTP_INTERNAL_SERVER_ERROR, 0,
1177 "unable to connect to cgi daemon");
1180 SPLIT_AND_PASS_PRETAG_BUCKETS(*bb, ctx, f->next, rc);
1181 if (rc != APR_SUCCESS) {
1185 send_req(sd, r, command, env, SSI_REQ);
1187 /* We are putting the tempsock variable into a file so that we can use
1188 * a pipe bucket to send the data to the client.
1190 apr_os_file_put(&tempsock, &sd, r->pool);
1192 if ((retval = ap_setup_client_block(r, REQUEST_CHUNKED_ERROR)))
1195 location = apr_table_get(r->headers_out, "Location");
1197 if (location && location[0] == '/' && r->status == 200) {
1198 char argsbuffer[HUGE_STRING_LEN];
1200 /* Soak up all the script output */
1201 while (apr_file_gets(argsbuffer, HUGE_STRING_LEN, tempsock) > 0) {
1204 /* This redirect needs to be a GET no matter what the original
1207 r->method = apr_pstrdup(r->pool, "GET");
1208 r->method_number = M_GET;
1210 /* We already read the message body (if any), so don't allow
1211 * the redirected request to think it has one. We can ignore
1212 * Transfer-Encoding, since we used REQUEST_CHUNKED_ERROR.
1214 apr_table_unset(r->headers_in, "Content-Length");
1216 ap_internal_redirect_handler(location, r);
1219 else if (location && r->status == 200) {
1220 /* XX Note that if a script wants to produce its own Redirect
1221 * body, it now has to explicitly *say* "Status: 302"
1223 return HTTP_MOVED_TEMPORARILY;
1226 if (!r->header_only) {
1227 bcgi = apr_brigade_create(r->pool);
1228 b = apr_bucket_pipe_create(tempsock);
1229 APR_BRIGADE_INSERT_TAIL(bcgi, b);
1230 ap_pass_brigade(f->next, bcgi);
1236 static int handle_exec(include_ctx_t *ctx, apr_bucket_brigade **bb, request_rec *r,
1237 ap_filter_t *f, apr_bucket *head_ptr, apr_bucket **inserted_head)
1240 char *tag_val = NULL;
1241 char *file = r->filename;
1242 apr_bucket *tmp_buck;
1243 char parsed_string[MAX_STRING_LEN];
1245 *inserted_head = NULL;
1246 if (ctx->flags & FLAG_PRINTING) {
1247 if (ctx->flags & FLAG_NO_EXEC) {
1248 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1249 "exec used but not allowed in %s", r->filename);
1250 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
1254 cgid_pfn_gtv(ctx, &tag, &tag_val, 1);
1255 if (tag_val == NULL) {
1263 if (!strcmp(tag, "cmd")) {
1264 cgid_pfn_ps(r, tag_val, parsed_string, sizeof(parsed_string), 1);
1265 if (include_cmd(ctx, bb, parsed_string, r, f) == -1) {
1266 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1267 "execution failure for parameter \"%s\" "
1268 "to tag exec in file %s", tag, r->filename);
1269 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
1271 /* just in case some stooge changed directories */
1273 else if (!strcmp(tag, "cgi")) {
1274 apr_status_t retval = APR_SUCCESS;
1276 cgid_pfn_ps(r, tag_val, parsed_string, sizeof(parsed_string), 0);
1277 SPLIT_AND_PASS_PRETAG_BUCKETS(*bb, ctx, f->next, retval);
1278 if (retval != APR_SUCCESS) {
1282 if (include_cgi(parsed_string, r, f->next, head_ptr, inserted_head) == -1) {
1283 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1284 "invalid CGI ref \"%s\" in %s", tag_val, file);
1285 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
1289 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
1290 "unknown parameter \"%s\" to tag exec in %s", tag, file);
1291 CREATE_ERROR_BUCKET(ctx, tmp_buck, head_ptr, *inserted_head);
1298 /*============================================================================
1299 *============================================================================
1300 * This is the end of the cgi filter code moved from mod_include.
1301 *============================================================================
1302 *============================================================================*/
1305 static void register_hook(apr_pool_t *p)
1307 static const char * const aszPre[] = { "mod_include.c", NULL };
1309 ap_hook_post_config(cgid_init, aszPre, NULL, APR_HOOK_MIDDLE);
1310 ap_hook_handler(cgid_handler, NULL, NULL, APR_HOOK_MIDDLE);
1313 module AP_MODULE_DECLARE_DATA cgid_module = {
1314 STANDARD20_MODULE_STUFF,
1315 NULL, /* dir config creater */
1316 NULL, /* dir merger --- default is to override */
1317 create_cgid_config, /* server config */
1318 merge_cgid_config, /* merge server config */
1319 cgid_cmds, /* command table */
1320 register_hook /* register_handlers */