2 * $Id: fcgi_config.c,v 1.46 2002/12/23 03:13:15 robs Exp $
11 #include "mpm_common.h" /* ap_uname2id, ap_gname2id */
23 /* warning C4100: unreferenced formal parameter */
24 /* warning C4706: assignment within conditional expression */
25 #pragma warning( disable : 4100 4706 )
28 /*******************************************************************************
29 * Get the next configuration directive argument, & return an in_addr and port.
30 * The arg must be in the form "host:port" where host can be an IP or hostname.
31 * The pool arg should be persistant storage.
33 static const char *get_host_n_port(pool
*p
, const char **arg
,
34 const char **host
, u_short
*port
)
36 char *cvptr
, *portStr
;
39 *host
= ap_getword_conf(p
, arg
);
43 portStr
= strchr(*host
, ':');
45 return "missing port specification";
47 /* Split the host and port portions */
50 /* Convert port number */
51 tmp
= (u_short
) strtol(portStr
, &cvptr
, 10);
52 if (*cvptr
!= '\0' || tmp
< 1 || tmp
> USHRT_MAX
)
53 return ap_pstrcat(p
, "bad port number \"", portStr
, "\"", NULL
);
55 *port
= (unsigned short) tmp
;
60 /*******************************************************************************
61 * Get the next configuration directive argument, & return an u_short.
62 * The pool arg should be temporary storage.
64 static const char *get_u_short(pool
*p
, const char **arg
,
65 u_short
*num
, u_short min
)
69 const char *txt
= ap_getword_conf(p
, arg
);
75 tmp
= strtol(txt
, &ptr
, 10);
78 return ap_pstrcat(p
, "\"", txt
, "\" must be a positive integer", NULL
);
81 if (tmp
< min
|| tmp
> USHRT_MAX
) {
82 return ap_psprintf(p
, "\"%u\" must be >= %u and < %u", *num
, min
, USHRT_MAX
);
90 static const char *get_int(pool
*p
, const char **arg
, int *num
, int min
)
93 const char *val
= ap_getword_conf(p
, arg
);
100 *num
= (int) strtol(val
, &cp
, 10);
104 return ap_pstrcat(p
, "can't parse ", "\"", val
, "\"", NULL
);
108 return ap_psprintf(p
, "\"%d\" must be >= %d", *num
, min
);
114 /*******************************************************************************
115 * Get the next configuration directive argument, & return an u_int.
116 * The pool arg should be temporary storage.
118 static const char *get_u_int(pool
*p
, const char **arg
,
119 u_int
*num
, u_int min
)
122 const char *val
= ap_getword_conf(p
, arg
);
126 *num
= (u_int
)strtol(val
, &ptr
, 10);
129 return ap_pstrcat(p
, "\"", val
, "\" must be a positive integer", NULL
);
131 return ap_psprintf(p
, "\"%u\" must be >= %u", *num
, min
);
135 /*******************************************************************************
136 * Get the next configuration directive argument, & return a float.
137 * The pool arg should be temporary storage.
139 static const char *get_float(pool
*p
, const char **arg
,
140 float *num
, float min
, float max
)
143 const char *val
= ap_getword_conf(p
, arg
);
147 *num
= (float) strtod(val
, &ptr
);
150 return ap_pstrcat(p
, "\"", val
, "\" is not a floating point number", NULL
);
151 if (*num
< min
|| *num
> max
)
152 return ap_psprintf(p
, "\"%f\" is not between %f and %f", *num
, min
, max
);
156 const char *fcgi_config_set_env_var(pool
*p
, char **envp
, unsigned int *envc
, char * var
)
158 if (*envc
>= MAX_INIT_ENV_VARS
) {
159 return "too many variables, must be <= MAX_INIT_ENV_VARS";
162 if (strchr(var
, '=') == NULL
) {
163 *(envp
+ *envc
) = ap_pstrcat(p
, var
, "=", getenv(var
), NULL
);
166 *(envp
+ *envc
) = var
;
174 /*******************************************************************************
175 * Get the next configuration directive argument, & add it to an env array.
176 * The pool arg should be permanent storage.
178 static const char *get_env_var(pool
*p
, const char **arg
, char **envp
, unsigned int *envc
)
180 char * const val
= ap_getword_conf(p
, arg
);
186 return fcgi_config_set_env_var(p
, envp
, envc
, val
);
189 static const char *get_pass_header(pool
*p
, const char **arg
, array_header
**array
)
194 *array
= ap_make_array(p
, 10, sizeof(char*));
197 header
= (const char **)ap_push_array(*array
);
198 *header
= ap_getword_conf(p
, arg
);
200 return header
? NULL
: "\"\"";
203 /*******************************************************************************
204 * Return a "standard" message for common configuration errors.
206 static const char *invalid_value(pool
*p
, const char *cmd
, const char *id
,
207 const char *opt
, const char *err
)
209 return ap_psprintf(p
, "%s%s%s: invalid value for %s: %s",
210 cmd
, id
? " " : "", id
? id
: "", opt
, err
);
213 /*******************************************************************************
214 * Set/Reset the uid/gid that Apache and the PM will run as. This is ap_user_id
215 * and ap_group_id if we're started as root, and euid/egid otherwise. Also try
216 * to check that the config files don't set the User/Group after a FastCGI
217 * directive is used that depends on it.
219 /*@@@ To be complete, we should save a handle to the server each AppClass is
220 * configured in and at init() check that the user/group is still what we
221 * thought it was. Also the other directives should only be allowed in the
222 * parent Apache server.
224 const char *fcgi_config_set_fcgi_uid_n_gid(int set
)
226 static int isSet
= 0;
230 uid_t uid
= geteuid();
231 gid_t gid
= getegid();
235 fcgi_user_id
= (uid_t
)-1;
236 fcgi_group_id
= (gid_t
)-1;
248 if (isSet
&& (uid
!= fcgi_user_id
|| gid
!= fcgi_group_id
)) {
249 return "User/Group commands must preceed FastCGI server definitions";
261 apcb_t
fcgi_config_reset_globals(void* dummy
)
263 fcgi_config_pool
= NULL
;
265 fcgi_config_set_fcgi_uid_n_gid(0);
267 fcgi_socket_dir
= NULL
;
269 fcgi_dynamic_total_proc_count
= 0;
270 fcgi_dynamic_epoch
= 0;
271 fcgi_dynamic_last_analyzed
= 0;
273 dynamicMaxProcs
= FCGI_DEFAULT_MAX_PROCS
;
274 dynamicMinProcs
= FCGI_DEFAULT_MIN_PROCS
;
275 dynamicMaxClassProcs
= FCGI_DEFAULT_MAX_CLASS_PROCS
;
276 dynamicKillInterval
= FCGI_DEFAULT_KILL_INTERVAL
;
277 dynamicUpdateInterval
= FCGI_DEFAULT_UPDATE_INTERVAL
;
278 dynamicGain
= FCGI_DEFAULT_GAIN
;
279 dynamicThreshold1
= FCGI_DEFAULT_THRESHOLD_1
;
280 dynamicThresholdN
= FCGI_DEFAULT_THRESHOLD_N
;
281 dynamicPleaseStartDelay
= FCGI_DEFAULT_START_PROCESS_DELAY
;
282 dynamicAppConnectTimeout
= FCGI_DEFAULT_APP_CONN_TIMEOUT
;
283 dynamicEnvp
= &fcgi_empty_env
;
284 dynamicProcessSlack
= FCGI_DEFAULT_PROCESS_SLACK
;
285 dynamicAutoRestart
= FCGI_DEFAULT_RESTART_DYNAMIC
;
286 dynamicAutoUpdate
= FCGI_DEFAULT_AUTOUPDATE
;
287 dynamicListenQueueDepth
= FCGI_DEFAULT_LISTEN_Q
;
288 dynamicInitStartDelay
= DEFAULT_INIT_START_DELAY
;
289 dynamicRestartDelay
= FCGI_DEFAULT_RESTART_DELAY
;
290 dynamic_pass_headers
= NULL
;
291 dynamic_idle_timeout
= FCGI_DEFAULT_IDLE_TIMEOUT
;
292 dynamicFlush
= FCGI_FLUSH
;
295 /* Close any old pipe (HUP/USR1) */
296 if (fcgi_pm_pipe
[0] != -1) {
297 close(fcgi_pm_pipe
[0]);
298 fcgi_pm_pipe
[0] = -1;
300 if (fcgi_pm_pipe
[1] != -1) {
301 close(fcgi_pm_pipe
[1]);
302 fcgi_pm_pipe
[1] = -1;
309 /*******************************************************************************
310 * Create a directory to hold Unix/Domain sockets.
312 const char *fcgi_config_make_dir(pool
*tp
, char *path
)
315 const char *err
= NULL
;
317 /* Is the directory spec'd correctly */
319 return "path is not absolute (it must start with a \"/\")";
322 int i
= strlen(path
) - 1;
324 /* Strip trailing "/"s */
325 while(i
> 0 && path
[i
] == '/') path
[i
--] = '\0';
329 if (stat(path
, &finfo
) != 0) {
330 /* No, but maybe we can create it */
332 if (mkdir(path
) != 0)
334 if (mkdir(path
, S_IRWXU
) != 0)
337 return ap_psprintf(tp
,
338 "doesn't exist and can't be created: %s",
343 /* If we're root, we're gonna setuid/setgid so we need to chown */
344 if (geteuid() == 0 && chown(path
, ap_user_id
, ap_group_id
) != 0) {
345 return ap_psprintf(tp
,
346 "can't chown() to the server (uid %ld, gid %ld): %s",
347 (long)ap_user_id
, (long)ap_group_id
, strerror(errno
));
352 /* Yes, is it a directory? */
353 if (!S_ISDIR(finfo
.st_mode
))
354 return "isn't a directory!";
356 /* Can we RWX in there? */
358 err
= fcgi_util_check_access(tp
, NULL
, &finfo
, _S_IREAD
| _S_IWRITE
| _S_IEXEC
, fcgi_user_id
, fcgi_group_id
);
360 err
= fcgi_util_check_access(tp
, NULL
, &finfo
, R_OK
| W_OK
| X_OK
,
361 fcgi_user_id
, fcgi_group_id
);
364 return ap_psprintf(tp
,
365 "access for server (uid %ld, gid %ld) failed: %s",
366 (long)fcgi_user_id
, (long)fcgi_group_id
, err
);
372 /*******************************************************************************
373 * Create a "dynamic" subdirectory. If the directory
374 * already exists we don't mess with it unless 'wax' is set.
377 const char *fcgi_config_make_dynamic_dir(pool
*p
, const int wax
)
382 fcgi_dynamic_dir
= ap_pstrcat(p
, fcgi_socket_dir
, "/dynamic", NULL
);
384 if ((err
= fcgi_config_make_dir(p
, fcgi_dynamic_dir
)))
385 return ap_psprintf(p
, "can't create dynamic directory \"%s\": %s", fcgi_dynamic_dir
, err
);
387 /* Don't step on a running server unless its OK. */
396 if (apr_pool_create(&tp
, p
))
397 return "apr_pool_create() failed";
399 if (apr_dir_open(&dir
, fcgi_dynamic_dir
, tp
))
400 return "apr_dir_open() failed";
402 /* delete the contents */
404 while (apr_dir_read(&finfo
, APR_FINFO_NAME
, dir
) == APR_SUCCESS
)
406 if (strcmp(finfo
.name
, ".") == 0 || strcmp(finfo
.name
, "..") == 0)
409 apr_file_remove(finfo
.name
, tp
);
416 struct dirent
*dirp
= NULL
;
418 tp
= ap_make_sub_pool(p
);
420 dp
= ap_popendir(tp
, fcgi_dynamic_dir
);
423 return ap_psprintf(p
, "can't open dynamic directory \"%s\": %s",
424 fcgi_dynamic_dir
, strerror(errno
));
427 /* delete the contents */
429 while ((dirp
= readdir(dp
)) != NULL
)
431 if (strcmp(dirp
->d_name
, ".") == 0 || strcmp(dirp
->d_name
, "..") == 0)
434 unlink(ap_pstrcat(tp
, fcgi_dynamic_dir
, "/", dirp
->d_name
, NULL
));
438 #endif /* !APACHE2 */
446 /*******************************************************************************
447 * Change the directory used for the Unix/Domain sockets from the default.
448 * Create the directory and the "dynamic" subdirectory.
450 const char *fcgi_config_set_socket_dir(cmd_parms
*cmd
, void *dummy
, const char *arg
)
452 pool
* const tp
= cmd
->temp_pool
;
453 const char * const name
= cmd
->cmd
->name
;
457 if (fcgi_socket_dir
) {
458 return ap_psprintf(tp
, "%s %s: already defined as \"%s\"",
459 name
, arg
, fcgi_socket_dir
);
462 err
= fcgi_config_set_fcgi_uid_n_gid(1);
464 return ap_psprintf(tp
, "%s %s: %s", name
, arg
, err
);
466 if (fcgi_servers
!= NULL
) {
467 return ap_psprintf(tp
,
468 "The %s command must preceed static FastCGI server definitions",
472 arg_nc
= ap_pstrdup(cmd
->pool
, arg
);
477 if (apr_filepath_merge(&arg_nc
, "", arg
, 0, cmd
->pool
))
478 return ap_psprintf(tp
, "%s %s: invalid filepath", name
, arg
);
480 arg_nc
= ap_os_canonical_filename(cmd
->pool
, arg_nc
);
483 arg_nc
= ap_server_root_relative(cmd
->pool
, arg_nc
);
487 if (strncmp(arg_nc
, "\\\\.\\pipe\\", 9) != 0)
488 return ap_psprintf(tp
, "%s %s is invalid format",name
, arg_nc
);
492 fcgi_socket_dir
= arg_nc
;
495 fcgi_dynamic_dir
= ap_pstrcat(cmd
->pool
, fcgi_socket_dir
, "dynamic", NULL
);
497 err
= fcgi_config_make_dir(tp
, fcgi_socket_dir
);
499 return ap_psprintf(tp
, "%s %s: %s", name
, arg_nc
, err
);
501 err
= fcgi_config_make_dynamic_dir(cmd
->pool
, 0);
503 return ap_psprintf(tp
, "%s %s: %s", name
, arg_nc
, err
);
509 /*******************************************************************************
510 * Enable, disable, or specify the path to a wrapper used to invoke all
511 * FastCGI applications.
513 const char *fcgi_config_set_wrapper(cmd_parms
*cmd
, void *dummy
, const char *arg
)
516 return ap_psprintf(cmd
->temp_pool
,
517 "the %s directive is not supported on WIN", cmd
->cmd
->name
);
520 const char *err
= NULL
;
521 const char * const name
= cmd
->cmd
->name
;
522 pool
* const tp
= cmd
->temp_pool
;
523 char * wrapper
= NULL
;
525 err
= fcgi_config_set_fcgi_uid_n_gid(1);
527 return ap_psprintf(tp
, "%s %s: %s", name
, arg
, err
);
529 if (fcgi_servers
!= NULL
) {
530 return ap_psprintf(tp
,
531 "The %s command must preceed static FastCGI server definitions", name
);
534 if (strcasecmp(arg
, "Off") == 0) {
539 if (strcasecmp(arg
, "On") == 0)
541 wrapper
= SUEXEC_BIN
;
546 if (apr_filepath_merge(&wrapper
, "", arg
, 0, cmd
->pool
))
547 return ap_psprintf(tp
, "%s %s: invalid filepath", name
, arg
);
549 wrapper
= ap_os_canonical_filename(cmd
->pool
, (char *) arg
);
552 wrapper
= ap_server_root_relative(cmd
->pool
, wrapper
);
555 err
= fcgi_util_check_access(tp
, wrapper
, NULL
, X_OK
, fcgi_user_id
, fcgi_group_id
);
558 return ap_psprintf(tp
, "%s: \"%s\" execute access for server "
559 "(uid %ld, gid %ld) failed: %s", name
, wrapper
,
560 (long) fcgi_user_id
, (long) fcgi_group_id
, err
);
563 fcgi_wrapper
= wrapper
;
569 /*******************************************************************************
570 * Configure a static FastCGI server.
572 const char *fcgi_config_new_static_server(cmd_parms
*cmd
, void *dummy
, const char *arg
)
575 pool
*p
= cmd
->pool
, *tp
= cmd
->temp_pool
;
576 const char *name
= cmd
->cmd
->name
;
577 char *fs_path
= ap_getword_conf(p
, &arg
);
578 const char *option
, *err
;
580 /* Allocate temp storage for the array of initial environment variables */
581 char **envp
= ap_pcalloc(tp
, sizeof(char *) * (MAX_INIT_ENV_VARS
+ 3));
582 unsigned int envc
= 0;
588 if (*fs_path
== '\0')
589 return "AppClass requires a pathname!?";
591 if ((err
= fcgi_config_set_fcgi_uid_n_gid(1)) != NULL
)
592 return ap_psprintf(tp
, "%s %s: %s", name
, fs_path
, err
);
595 if (apr_filepath_merge(&fs_path
, "", fs_path
, 0, p
))
596 return ap_psprintf(tp
, "%s %s: invalid filepath", name
, fs_path
);
598 fs_path
= ap_os_canonical_filename(p
, fs_path
);
600 fs_path
= ap_server_root_relative(p
, fs_path
);
602 ap_getparents(fs_path
);
603 ap_no2slash(fs_path
);
605 /* See if we've already got one of these configured */
606 s
= fcgi_util_fs_get_by_id(fs_path
, fcgi_util_get_server_uid(cmd
->server
),
607 fcgi_util_get_server_gid(cmd
->server
));
610 return ap_psprintf(tp
,
611 "%s: redefinition of a previously defined FastCGI "
612 "server \"%s\" with uid=%ld and gid=%ld",
613 name
, fs_path
, (long) fcgi_util_get_server_uid(cmd
->server
),
614 (long) fcgi_util_get_server_gid(cmd
->server
));
617 return ap_psprintf(tp
,
618 "%s: redefinition of a previously defined FastCGI server \"%s\"",
623 err
= fcgi_util_fs_is_path_ok(tp
, fs_path
, NULL
);
625 return ap_psprintf(tp
, "%s: \"%s\" %s", name
, fs_path
, err
);
628 s
= fcgi_util_fs_new(p
);
629 s
->fs_path
= fs_path
;
630 s
->directive
= APP_CLASS_STANDARD
;
631 s
->restartOnExit
= TRUE
;
636 // TCP FastCGI applications require SystemRoot be present in the environment
637 // Put it in both for consistency to the application
638 fcgi_config_set_env_var(tp
, envp
, &envc
, "SystemRoot");
640 mutex
= CreateMutex(NULL
, FALSE
, fs_path
);
644 ap_log_error(FCGI_LOG_ALERT
, fcgi_apache_main_server
,
645 "FastCGI: CreateMutex() failed");
646 return "failed to create FastCGI application accept mutex";
649 SetHandleInformation(mutex
, HANDLE_FLAG_INHERIT
, TRUE
);
651 s
->mutex_env_string
= ap_psprintf(p
, "_FCGI_MUTEX_=%ld", mutex
);
655 /* Parse directive arguments */
657 option
= ap_getword_conf(tp
, &arg
);
659 if (strcasecmp(option
, "-processes") == 0) {
660 if ((err
= get_u_int(tp
, &arg
, &s
->numProcesses
, 1)))
661 return invalid_value(tp
, name
, fs_path
, option
, err
);
663 else if (strcasecmp(option
, "-restart-delay") == 0) {
664 if ((err
= get_u_int(tp
, &arg
, &s
->restartDelay
, 0)))
665 return invalid_value(tp
, name
, fs_path
, option
, err
);
667 else if (strcasecmp(option
, "-init-start-delay") == 0) {
668 if ((err
= get_int(tp
, &arg
, &s
->initStartDelay
, 0)))
669 return invalid_value(tp
, name
, fs_path
, option
, err
);
671 else if (strcasecmp(option
, "-priority") == 0) {
672 if ((err
= get_u_int(tp
, &arg
, &s
->processPriority
, 0)))
673 return invalid_value(tp
, name
, fs_path
, option
, err
);
675 else if (strcasecmp(option
, "-listen-queue-depth") == 0) {
676 if ((err
= get_u_int(tp
, &arg
, &s
->listenQueueDepth
, 1)))
677 return invalid_value(tp
, name
, fs_path
, option
, err
);
679 else if (strcasecmp(option
, "-appConnTimeout") == 0) {
680 if ((err
= get_u_int(tp
, &arg
, &s
->appConnectTimeout
, 0)))
681 return invalid_value(tp
, name
, fs_path
, option
, err
);
683 else if (strcasecmp(option
, "-idle-timeout") == 0) {
684 if ((err
= get_u_int(tp
, &arg
, &s
->idle_timeout
, 1)))
685 return invalid_value(tp
, name
, fs_path
, option
, err
);
687 else if (strcasecmp(option
, "-port") == 0) {
688 if ((err
= get_u_short(tp
, &arg
, &s
->port
, 1)))
689 return invalid_value(tp
, name
, fs_path
, option
, err
);
691 else if (strcasecmp(option
, "-socket") == 0) {
692 s
->socket_path
= ap_getword_conf(tp
, &arg
);
693 if (*s
->socket_path
== '\0')
694 return invalid_value(tp
, name
, fs_path
, option
, "\"\"");
696 else if (strcasecmp(option
, "-initial-env") == 0) {
697 if ((err
= get_env_var(p
, &arg
, envp
, &envc
)))
698 return invalid_value(tp
, name
, fs_path
, option
, err
);
700 else if (strcasecmp(option
, "-pass-header") == 0) {
701 if ((err
= get_pass_header(p
, &arg
, &s
->pass_headers
)))
702 return invalid_value(tp
, name
, fs_path
, option
, err
);
704 else if (strcasecmp(option
, "-flush") == 0) {
707 else if (strcasecmp(option
, "-user") == 0) {
709 return ap_psprintf(tp
,
710 "%s %s: the -user option isn't supported on WIN", name
, fs_path
);
712 s
->user
= ap_getword_conf(tp
, &arg
);
713 if (*s
->user
== '\0')
714 return invalid_value(tp
, name
, fs_path
, option
, "\"\"");
717 else if (strcasecmp(option
, "-group") == 0) {
719 return ap_psprintf(tp
,
720 "%s %s: the -group option isn't supported on WIN", name
, fs_path
);
722 s
->group
= ap_getword_conf(tp
, &arg
);
723 if (*s
->group
== '\0')
724 return invalid_value(tp
, name
, fs_path
, option
, "\"\"");
728 return ap_psprintf(tp
, "%s %s: invalid option: %s", name
, fs_path
, option
);
735 if (s
->group
== NULL
)
737 s
->group
= ap_psprintf(tp
, "#%ld", fcgi_util_get_server_gid(cmd
->server
));
742 s
->user
= ap_psprintf(p
, "#%ld", fcgi_util_get_server_uid(cmd
->server
));
745 s
->uid
= ap_uname2id(s
->user
);
746 s
->gid
= ap_gname2id(s
->group
);
748 else if (s
->user
|| s
->group
)
750 ap_log_error(FCGI_LOG_WARN
, cmd
->server
, "FastCGI: there is no "
751 "fastcgi wrapper set, user/group options are ignored");
754 if ((err
= fcgi_util_fs_set_uid_n_gid(p
, s
, s
->uid
, s
->gid
)))
756 return ap_psprintf(tp
,
757 "%s %s: invalid user or group: %s", name
, fs_path
, err
);
761 if (s
->socket_path
!= NULL
&& s
->port
!= 0) {
762 return ap_psprintf(tp
,
763 "%s %s: -port and -socket are mutually exclusive options",
767 /* Move env array to a surviving pool */
768 s
->envp
= (char **)ap_pcalloc(p
, sizeof(char *) * (envc
+ 4));
769 memcpy(s
->envp
, envp
, sizeof(char *) * envc
);
771 /* Initialize process structs */
772 s
->procs
= fcgi_util_fs_create_procs(p
, s
->numProcesses
);
774 /* Build the appropriate sockaddr structure */
776 err
= fcgi_util_socket_make_inet_addr(p
, (struct sockaddr_in
**)&s
->socket_addr
,
777 &s
->socket_addr_len
, NULL
, s
->port
);
779 return ap_psprintf(tp
, "%s %s: %s", name
, fs_path
, err
);
781 err
= fcgi_util_socket_make_inet_addr(p
, (struct sockaddr_in
**)&s
->dest_addr
,
782 &s
->socket_addr_len
, "localhost", s
->port
);
784 return ap_psprintf(tp
, "%s %s: %s", name
, fs_path
, err
);
787 if (s
->socket_path
== NULL
)
788 s
->socket_path
= fcgi_util_socket_hash_filename(tp
, fs_path
, s
->user
, s
->group
);
790 if (fcgi_socket_dir
== NULL
)
793 fcgi_socket_dir
= DEFAULT_SOCK_DIR
;
795 fcgi_socket_dir
= ap_server_root_relative(p
, DEFAULT_SOCK_DIR
);
799 s
->socket_path
= fcgi_util_socket_make_path_absolute(p
, s
->socket_path
, 0);
801 err
= fcgi_util_socket_make_domain_addr(p
, (struct sockaddr_un
**)&s
->socket_addr
,
802 &s
->socket_addr_len
, s
->socket_path
);
804 return ap_psprintf(tp
, "%s %s: %s", name
, fs_path
, err
);
808 /* Add it to the list of FastCGI servers */
814 /*******************************************************************************
815 * Configure a static FastCGI server that is started/managed elsewhere.
817 const char *fcgi_config_new_external_server(cmd_parms
*cmd
, void *dummy
, const char *arg
)
820 pool
* const p
= cmd
->pool
, *tp
= cmd
->temp_pool
;
821 const char * const name
= cmd
->cmd
->name
;
822 char *fs_path
= ap_getword_conf(p
, &arg
);
823 const char *option
, *err
;
826 return ap_pstrcat(tp
, name
, " requires a path and either a -socket or -host option", NULL
);
830 if (apr_filepath_merge(&fs_path
, "", fs_path
, 0, p
))
831 return ap_psprintf(tp
, "%s %s: invalid filepath", name
, fs_path
);
833 fs_path
= ap_os_canonical_filename(p
, fs_path
);
836 fs_path
= ap_server_root_relative(p
, fs_path
);
838 ap_getparents(fs_path
);
839 ap_no2slash(fs_path
);
841 /* See if we've already got one of these bettys configured */
842 s
= fcgi_util_fs_get_by_id(fs_path
, fcgi_util_get_server_uid(cmd
->server
),
843 fcgi_util_get_server_gid(cmd
->server
));
846 return ap_psprintf(tp
,
847 "%s: redefinition of a previously defined class \"%s\" "
848 "with uid=%ld and gid=%ld",
849 name
, fs_path
, (long) fcgi_util_get_server_uid(cmd
->server
),
850 (long) fcgi_util_get_server_gid(cmd
->server
));
854 return ap_psprintf(tp
,
855 "%s: redefinition of previously defined class \"%s\"", name
, fs_path
);
859 s
= fcgi_util_fs_new(p
);
860 s
->fs_path
= fs_path
;
861 s
->directive
= APP_CLASS_EXTERNAL
;
863 /* Parse directive arguments */
864 while (*arg
!= '\0') {
865 option
= ap_getword_conf(tp
, &arg
);
867 if (strcasecmp(option
, "-host") == 0) {
868 if ((err
= get_host_n_port(p
, &arg
, &s
->host
, &s
->port
)))
869 return invalid_value(tp
, name
, fs_path
, option
, err
);
871 else if (strcasecmp(option
, "-socket") == 0) {
872 s
->socket_path
= ap_getword_conf(tp
, &arg
);
873 if (*s
->socket_path
== '\0')
874 return invalid_value(tp
, name
, fs_path
, option
, "\"\"");
876 else if (strcasecmp(option
, "-appConnTimeout") == 0) {
877 if ((err
= get_u_int(tp
, &arg
, &s
->appConnectTimeout
, 0)))
878 return invalid_value(tp
, name
, fs_path
, option
, err
);
880 else if (strcasecmp(option
, "-idle-timeout") == 0) {
881 if ((err
= get_u_int(tp
, &arg
, &s
->idle_timeout
, 1)))
882 return invalid_value(tp
, name
, fs_path
, option
, err
);
884 else if (strcasecmp(option
, "-pass-header") == 0) {
885 if ((err
= get_pass_header(p
, &arg
, &s
->pass_headers
)))
886 return invalid_value(tp
, name
, fs_path
, option
, err
);
888 else if (strcasecmp(option
, "-flush") == 0) {
891 else if (strcasecmp(option
, "-user") == 0) {
893 return ap_psprintf(tp
,
894 "%s %s: the -user option isn't supported on WIN", name
, fs_path
);
896 s
->user
= ap_getword_conf(tp
, &arg
);
897 if (*s
->user
== '\0')
898 return invalid_value(tp
, name
, fs_path
, option
, "\"\"");
901 else if (strcasecmp(option
, "-group") == 0) {
903 return ap_psprintf(tp
,
904 "%s %s: the -group option isn't supported on WIN", name
, fs_path
);
906 s
->group
= ap_getword_conf(tp
, &arg
);
907 if (*s
->group
== '\0')
908 return invalid_value(tp
, name
, fs_path
, option
, "\"\"");
912 return ap_psprintf(tp
, "%s %s: invalid option: %s", name
, fs_path
, option
);
920 if (s
->group
== NULL
)
922 s
->group
= ap_psprintf(tp
, "#%ld", fcgi_util_get_server_gid(cmd
->server
));
927 s
->user
= ap_psprintf(p
, "#%ld", fcgi_util_get_server_uid(cmd
->server
));
930 s
->uid
= ap_uname2id(s
->user
);
931 s
->gid
= ap_gname2id(s
->group
);
933 else if (s
->user
|| s
->group
)
935 ap_log_error(FCGI_LOG_WARN
, cmd
->server
, "FastCGI: there is no "
936 "fastcgi wrapper set, user/group options are ignored");
939 if ((err
= fcgi_util_fs_set_uid_n_gid(p
, s
, s
->uid
, s
->gid
)))
941 return ap_psprintf(tp
,
942 "%s %s: invalid user or group: %s", name
, fs_path
, err
);
946 /* Require one of -socket or -host, but not both */
947 if (s
->socket_path
!= NULL
&& s
->port
!= 0) {
948 return ap_psprintf(tp
,
949 "%s %s: -host and -socket are mutually exclusive options",
952 if (s
->socket_path
== NULL
&& s
->port
== 0) {
953 return ap_psprintf(tp
,
954 "%s %s: -socket or -host option missing", name
, fs_path
);
957 /* Build the appropriate sockaddr structure */
959 err
= fcgi_util_socket_make_inet_addr(p
, (struct sockaddr_in
**)&s
->socket_addr
,
960 &s
->socket_addr_len
, s
->host
, s
->port
);
962 return ap_psprintf(tp
, "%s %s: %s", name
, fs_path
, err
);
965 if (fcgi_socket_dir
== NULL
)
968 fcgi_socket_dir
= DEFAULT_SOCK_DIR
;
970 fcgi_socket_dir
= ap_server_root_relative(p
, DEFAULT_SOCK_DIR
);
974 s
->socket_path
= fcgi_util_socket_make_path_absolute(p
, s
->socket_path
, 0);
976 err
= fcgi_util_socket_make_domain_addr(p
, (struct sockaddr_un
**)&s
->socket_addr
,
977 &s
->socket_addr_len
, s
->socket_path
);
979 return ap_psprintf(tp
, "%s %s: %s", name
, fs_path
, err
);
983 /* Add it to the list of FastCGI servers */
990 *----------------------------------------------------------------------
992 * fcgi_config_set_config --
994 * Implements the FastCGI FCGIConfig configuration directive.
995 * This command adds routines to control the execution of the
996 * dynamic FastCGI processes.
999 *----------------------------------------------------------------------
1001 const char *fcgi_config_set_config(cmd_parms
*cmd
, void *dummy
, const char *arg
)
1003 pool
* const p
= cmd
->pool
;
1004 pool
* const tp
= cmd
->temp_pool
;
1005 const char *err
, *option
;
1006 const char * const name
= cmd
->cmd
->name
;
1008 /* Allocate temp storage for an initial environment */
1009 unsigned int envc
= 0;
1010 char **envp
= (char **)ap_pcalloc(tp
, sizeof(char *) * (MAX_INIT_ENV_VARS
+ 3));
1012 /* Parse the directive arguments */
1014 option
= ap_getword_conf(tp
, &arg
);
1016 if (strcasecmp(option
, "-maxProcesses") == 0) {
1017 if ((err
= get_u_int(tp
, &arg
, &dynamicMaxProcs
, 1)))
1018 return invalid_value(tp
, name
, NULL
, option
, err
);
1020 else if (strcasecmp(option
, "-minProcesses") == 0) {
1021 if ((err
= get_int(tp
, &arg
, &dynamicMinProcs
, 0)))
1022 return invalid_value(tp
, name
, NULL
, option
, err
);
1024 else if (strcasecmp(option
, "-maxClassProcesses") == 0) {
1025 if ((err
= get_int(tp
, &arg
, &dynamicMaxClassProcs
, 1)))
1026 return invalid_value(tp
, name
, NULL
, option
, err
);
1028 else if (strcasecmp(option
, "-killInterval") == 0) {
1029 if ((err
= get_u_int(tp
, &arg
, &dynamicKillInterval
, 1)))
1030 return invalid_value(tp
, name
, NULL
, option
, err
);
1032 else if (strcasecmp(option
, "-updateInterval") == 0) {
1033 if ((err
= get_u_int(tp
, &arg
, &dynamicUpdateInterval
, 1)))
1034 return invalid_value(tp
, name
, NULL
, option
, err
);
1036 else if (strcasecmp(option
, "-gainValue") == 0) {
1037 if ((err
= get_float(tp
, &arg
, &dynamicGain
, 0.0, 1.0)))
1038 return invalid_value(tp
, name
, NULL
, option
, err
);
1040 else if ((strcasecmp(option
, "-singleThreshold") == 0)
1041 || (strcasecmp(option
, "-singleThreshhold") == 0))
1043 if ((err
= get_int(tp
, &arg
, &dynamicThreshold1
, 0)))
1044 return invalid_value(tp
, name
, NULL
, option
, err
);
1046 else if ((strcasecmp(option
, "-multiThreshold") == 0)
1047 || (strcasecmp(option
, "-multiThreshhold") == 0))
1049 if ((err
= get_int(tp
, &arg
, &dynamicThresholdN
, 0)))
1050 return invalid_value(tp
, name
, NULL
, option
, err
);
1052 else if (strcasecmp(option
, "-startDelay") == 0) {
1053 if ((err
= get_u_int(tp
, &arg
, &dynamicPleaseStartDelay
, 1)))
1054 return invalid_value(tp
, name
, NULL
, option
, err
);
1056 else if (strcasecmp(option
, "-initial-env") == 0) {
1057 if ((err
= get_env_var(p
, &arg
, envp
, &envc
)))
1058 return invalid_value(tp
, name
, NULL
, option
, err
);
1060 else if (strcasecmp(option
, "-pass-header") == 0) {
1061 if ((err
= get_pass_header(p
, &arg
, &dynamic_pass_headers
)))
1062 return invalid_value(tp
, name
, NULL
, option
, err
);
1064 else if (strcasecmp(option
, "-appConnTimeout") == 0) {
1065 if ((err
= get_u_int(tp
, &arg
, &dynamicAppConnectTimeout
, 0)))
1066 return invalid_value(tp
, name
, NULL
, option
, err
);
1068 else if (strcasecmp(option
, "-idle-timeout") == 0) {
1069 if ((err
= get_u_int(tp
, &arg
, &dynamic_idle_timeout
, 1)))
1070 return invalid_value(tp
, name
, NULL
, option
, err
);
1072 else if (strcasecmp(option
, "-listen-queue-depth") == 0) {
1073 if ((err
= get_u_int(tp
, &arg
, &dynamicListenQueueDepth
, 1)))
1074 return invalid_value(tp
, name
, NULL
, option
, err
);
1076 else if (strcasecmp(option
, "-restart-delay") == 0) {
1077 if ((err
= get_u_int(tp
, &arg
, &dynamicRestartDelay
, 0)))
1078 return invalid_value(tp
, name
, NULL
, option
, err
);
1080 else if (strcasecmp(option
, "-init-start-delay") == 0) {
1081 if ((err
= get_u_int(tp
, &arg
, &dynamicInitStartDelay
, 0)))
1082 return invalid_value(tp
, name
, NULL
, option
, err
);
1084 else if (strcasecmp(option
, "-processSlack") == 0) {
1085 if ((err
= get_u_int(tp
, &arg
, &dynamicProcessSlack
, 1)))
1086 return invalid_value(tp
, name
, NULL
, option
, err
);
1088 else if (strcasecmp(option
, "-restart") == 0) {
1089 dynamicAutoRestart
= 1;
1091 else if (strcasecmp(option
, "-autoUpdate") == 0) {
1092 dynamicAutoUpdate
= 1;
1094 else if (strcasecmp(option
, "-flush") == 0) {
1095 dynamicFlush
= TRUE
;
1098 return ap_psprintf(tp
, "%s: invalid option: %s", name
, option
);
1102 if (dynamicProcessSlack
>= dynamicMaxProcs
+ 1) {
1103 /* the kill policy would work unexpectedly */
1104 return ap_psprintf(tp
,
1105 "%s: processSlack (%u) must be less than maxProcesses (%u) + 1",
1106 name
, dynamicProcessSlack
, dynamicMaxProcs
);
1109 /* Move env array to a surviving pool, leave 2 extra slots for
1110 * WIN32 _FCGI_MUTEX_ and _FCGI_SHUTDOWN_EVENT_ */
1111 dynamicEnvp
= (char **)ap_pcalloc(p
, sizeof(char *) * (envc
+ 4));
1112 memcpy(dynamicEnvp
, envp
, sizeof(char *) * envc
);
1117 void *fcgi_config_create_dir_config(pool
*p
, char *dummy
)
1119 fcgi_dir_config
*dir_config
= ap_pcalloc(p
, sizeof(fcgi_dir_config
));
1121 dir_config
->authenticator_options
= FCGI_AUTHORITATIVE
;
1122 dir_config
->authorizer_options
= FCGI_AUTHORITATIVE
;
1123 dir_config
->access_checker_options
= FCGI_AUTHORITATIVE
;
1129 const char *fcgi_config_new_auth_server(cmd_parms
* cmd
,
1130 void * dircfg
, const char *fs_path
, const char * compat
)
1132 fcgi_dir_config
* dir_config
= (fcgi_dir_config
*) dircfg
;
1133 pool
* const tp
= cmd
->temp_pool
;
1137 if (apr_filepath_merge(&auth_server
, "", fs_path
, 0, cmd
->pool
))
1138 return ap_psprintf(tp
, "%s %s: invalid filepath", cmd
->cmd
->name
, fs_path
);
1140 auth_server
= (char *) ap_os_canonical_filename(cmd
->pool
, fs_path
);
1143 auth_server
= ap_server_root_relative(cmd
->pool
, auth_server
);
1145 /* Make sure its already configured or at least a candidate for dynamic */
1146 if (fcgi_util_fs_get_by_id(auth_server
, fcgi_util_get_server_uid(cmd
->server
),
1147 fcgi_util_get_server_gid(cmd
->server
)) == NULL
)
1149 const char *err
= fcgi_util_fs_is_path_ok(tp
, auth_server
, NULL
);
1151 return ap_psprintf(tp
, "%s: \"%s\" %s", cmd
->cmd
->name
, auth_server
, err
);
1154 if (compat
&& strcasecmp(compat
, "-compat"))
1155 return ap_psprintf(cmd
->temp_pool
, "%s: unknown option: \"%s\"", cmd
->cmd
->name
, compat
);
1157 switch((int)cmd
->info
) {
1158 case FCGI_AUTH_TYPE_AUTHENTICATOR
:
1159 dir_config
->authenticator
= auth_server
;
1160 dir_config
->authenticator_options
|= (compat
) ? FCGI_COMPAT
: 0;
1162 case FCGI_AUTH_TYPE_AUTHORIZER
:
1163 dir_config
->authorizer
= auth_server
;
1164 dir_config
->authorizer_options
|= (compat
) ? FCGI_COMPAT
: 0;
1166 case FCGI_AUTH_TYPE_ACCESS_CHECKER
:
1167 dir_config
->access_checker
= auth_server
;
1168 dir_config
->access_checker_options
|= (compat
) ? FCGI_COMPAT
: 0;
1175 const char *fcgi_config_set_authoritative_slot(cmd_parms
* cmd
,
1176 void * dir_config
, int arg
)
1178 int offset
= (int)(long)cmd
->info
;
1181 *((u_char
*)dir_config
+ offset
) |= FCGI_AUTHORITATIVE
;
1183 *((u_char
*)dir_config
+ offset
) &= ~FCGI_AUTHORITATIVE
;