/* ==================================================================== * Copyright (c) 1995 The Apache Group. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. All advertising materials mentioning features or use of this * software must display the following acknowledgment: * "This product includes software developed by the Apache Group * for use in the Apache HTTP server project (http://www.apache.org/)." * * 4. The names "Apache Server" and "Apache Group" must not be used to * endorse or promote products derived from this software without * prior written permission. * * 5. Redistributions of any form whatsoever must retain the following * acknowledgment: * "This product includes software developed by the Apache Group * for use in the Apache HTTP server project (http://www.apache.org/)." * * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Group and was originally based * on public domain software written at the National Center for * Supercomputing Applications, University of Illinois, Urbana-Champaign. * For more information on the Apache Group and the Apache HTTP server * project, please see . * */ /* * httpd.h: header for simple (ha! not anymore) http daemon */ /* Headers in which EVERYONE has an interest... */ #include "conf.h" #include "alloc.h" /* ----------------------------- config dir ------------------------------ */ /* Define this to be the default server home dir. Anything later in this * file with a relative pathname will have this added. */ #ifdef __EMX__ /* Set default for OS/2 file system */ #define HTTPD_ROOT "/os2httpd" #else #define HTTPD_ROOT "/usr/local/etc/httpd" #endif /* Root of server */ #ifdef __EMX__ /* Set default for OS/2 file system */ #define DOCUMENT_LOCATION "/os2httpd/docs" #else #define DOCUMENT_LOCATION "/usr/local/etc/httpd/htdocs" #endif /* Max. number of dynamically loaded modules */ #define DYNAMIC_MODULE_LIMIT 64 /* Default administrator's address */ #define DEFAULT_ADMIN "[no address given]" /* * --------- You shouldn't have to edit anything below this line ---------- * * Any modifications to any defaults not defined above should be done in the * respective config. file. * */ /* -------------- Port number for server running standalone --------------- */ #define DEFAULT_PORT 80 /* --------- Default user name and group name running standalone ---------- */ /* --- These may be specified as numbers by placing a # before a number --- */ #define DEFAULT_USER "#-1" #define DEFAULT_GROUP "#-1" /* The name of the log files */ #ifdef __EMX__ /* Set default for OS/2 file system */ #define DEFAULT_XFERLOG "logs/access.log" #else #define DEFAULT_XFERLOG "logs/access_log" #endif #ifdef __EMX__ /* Set default for OS/2 file system */ #define DEFAULT_ERRORLOG "logs/error.log" #else #define DEFAULT_ERRORLOG "logs/error_log" #endif #define DEFAULT_PIDLOG "logs/httpd.pid" #define DEFAULT_SCOREBOARD "logs/apache_runtime_status" /* Define this to be what your HTML directory content files are called */ #define DEFAULT_INDEX "index.html" /* Define this to 1 if you want fancy indexing, 0 otherwise */ #define DEFAULT_INDEXING 0 /* Define this to be what type you'd like returned for files with unknown */ /* suffixes */ #define DEFAULT_TYPE "text/html" /* Define this to be what your per-directory security files are called */ #ifdef __EMX__ /* Set default for OS/2 file system */ #define DEFAULT_ACCESS_FNAME "htaccess" #else #define DEFAULT_ACCESS_FNAME ".htaccess" #endif /* The name of the server config file */ #define SERVER_CONFIG_FILE "conf/httpd.conf" /* The name of the document config file */ #define RESOURCE_CONFIG_FILE "conf/srm.conf" /* The name of the MIME types file */ #define TYPES_CONFIG_FILE "conf/mime.types" /* The name of the access file */ #define ACCESS_CONFIG_FILE "conf/access.conf" /* Whether we should enable rfc931 identity checking */ #define DEFAULT_RFC931 0 /* The default directory in user's home dir */ #define DEFAULT_USER_DIR "public_html" /* The default path for CGI scripts if none is currently set */ #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin" /* The path to the Bourne shell, for parsed docs */ #ifdef __EMX__ /* Set default for OS/2 file system */ #define SHELL_PATH "CMD.EXE" #else #define SHELL_PATH "/bin/sh" #endif /* The default string lengths */ #define MAX_STRING_LEN HUGE_STRING_LEN #define HUGE_STRING_LEN 8192 /* The timeout for waiting for messages */ #define DEFAULT_TIMEOUT 1200 /* The timeout for waiting for keepalive timeout until next request */ #define DEFAULT_KEEPALIVE_TIMEOUT 15 /* The number of requests to entertain per connection */ #define DEFAULT_KEEPALIVE 5 /* The size of the server's internal read-write buffers */ #define IOBUFSIZE 8192 /* The number of header lines we will accept from a client */ #define MAX_HEADERS 200 /* Number of servers to spawn off by default --- also, if fewer than * this free when the caretaker checks, it will spawn more. */ #define DEFAULT_START_DAEMON 5 /* Maximum number of *free* server processes --- more than this, and * they will die off. */ #define DEFAULT_MAX_FREE_DAEMON 10 /* Minimum --- fewer than this, and more will be created */ #define DEFAULT_MIN_FREE_DAEMON 5 /* Limit on the total --- clients will be locked out if more servers than * this are needed. It is intended solely to keep the server from crashing * when things get out of hand. */ #define DEFAULT_SERVER_LIMIT 150 /* Number of requests to try to handle in a single process. If <= 0, * the children don't die off. That's the default here, since I'm still * interested in finding and stanching leaks. */ #define DEFAULT_MAX_REQUESTS_PER_CHILD 0 /* ------------------------------ error types ------------------------------ */ #define SERVER_VERSION "Apache/1.1b0" #define SERVER_PROTOCOL "HTTP/1.0" #define SERVER_SUPPORT "http://www.apache.org/" #define DECLINED -1 /* Module declines to handle */ #define OK 0 /* Module has handled this stage. */ #define DOCUMENT_FOLLOWS 200 #define REDIRECT 302 #define USE_LOCAL_COPY 304 #define BAD_REQUEST 400 #define AUTH_REQUIRED 401 #define FORBIDDEN 403 #define NOT_FOUND 404 #define SERVER_ERROR 500 #define NOT_IMPLEMENTED 501 #define BAD_GATEWAY 502 #define SERVICE_UNAVAILABLE 503 #define RESPONSE_CODES 10 #define METHODS 5 #define M_GET 0 #define M_PUT 1 #define M_POST 2 #define M_DELETE 3 #define M_INVALID 4 #define CGI_MAGIC_TYPE "application/x-httpd-cgi" #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html" #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3" #define MAP_FILE_MAGIC_TYPE "application/x-type-map" #define ASIS_MAGIC_TYPE "httpd/send-as-is" #define DIR_MAGIC_TYPE "httpd/unix-directory" #define PROXY_MAGIC_TYPE "httpd/proxy" /* Just in case your linefeed isn't the one the other end is expecting. */ #define LF 10 #define CR 13 /* Things which may vary per file-lookup WITHIN a request --- * e.g., state of MIME config. Basically, the name of an object, info * about the object, and any other info we may ahve which may need to * change as we go poking around looking for it (e.g., overridden by * .htaccess files). * * Note how the default state of almost all these things is properly * zero, so that allocating it with pcalloc does the right thing without * a whole lot of hairy initialization... so long as we are willing to * make the (fairly) portable assumption that the bit pattern of a NULL * pointer is, in fact, zero. */ /* This represents the result of calling htaccess; these are cached for * each request. */ struct htaccess_result { char *dir; /* the directory to which this applies */ int override; /* the overrides allowed for the .htaccess file */ void *htaccess; /* the configuration directives */ /* the next one, or NULL if no more; N.B. never change this */ const struct htaccess_result *next; }; typedef struct conn_rec conn_rec; typedef struct server_rec server_rec; typedef struct request_rec request_rec; typedef struct listen_rec listen_rec; struct request_rec { pool *pool; conn_rec *connection; server_rec *server; request_rec *next; /* If we wind up getting redirected, * pointer to the request we redirected to. */ request_rec *prev; /* If this is an internal redirect, * pointer to where we redirected *from*. */ request_rec *main; /* If this is a sub_request (see request.h) * pointer back to the main request. */ request_rec *back; /* If this is part of a persistent con- * nection (Keep-Alive), pointer to the * previous one. */ /* Info about the request itself... we begin with stuff that only * protocol.c should ever touch... */ char *the_request; /* First line of request, so we can log it */ int assbackwards; /* HTTP/0.9, "simple" request */ int proxyreq; /* A proxy request */ int header_only; /* HEAD request, as opposed to GET */ char *protocol; /* Protocol, as given to us, or HTTP/0.9 */ char *status_line; /* Status line, if set by script */ int status; /* In any case */ /* Request method, two ways; also, protocol, etc.. Outside of protocol.c, * look, but don't touch. */ char *method; /* GET, HEAD, POST, etc. */ int method_number; /* M_GET, M_POST, etc. */ /* int header_bytes_sent; */ int bytes_sent; /* body --- not headers */ /* MIME header environments, in and out. Also, an array containing * environment variables to be passed to subprocesses, so people can * write modules to add to that environment. * * The difference between headers_out and err_headers_out is that the * latter are printed even on error, and persist across internal redirects * (so the headers printed for ErrorDocument handlers will have them). * * The 'notes' table is for notes from one module to another, with no * other set purpose in mind... */ table *headers_in; table *headers_out; table *err_headers_out; table *subprocess_env; table *notes; char *content_type; /* Break these out --- we dispatch on 'em */ char *content_encoding; char *content_language; int no_cache; /* What object is being requested (either directly, or via include * or content-negotiation mapping). */ char *uri; /* complete URI for a proxy req, or URL path for a non-proxy req */ char *filename; char *path_info; char *args; /* QUERY_ARGS, if any */ struct stat finfo; /* ST_MODE set to zero if no such file */ /* Various other config info which may change with .htaccess files * These are config vectors, with one void* pointer for each module * (the thing pointed to being the module's business). */ void *per_dir_config; /* Options set in config files, etc. */ void *request_config; /* Notes on *this* request */ /* * a linked list of the configuration directives in the .htaccess files * accessed by this request. * N.B. always add to the head of the list, _never_ to the end. * that way, a sub request's list can (temporarily) point to a parent's list */ const struct htaccess_result *htaccess; }; /* Things which are per connection */ struct conn_rec { pool *pool; server_rec *server; /* Information about the connection itself */ FILE *client; /* Connetion to the guy */ FILE *request_in; /* Connection from the guy */ int aborted; /* Are we still talking? */ /* Who is the client? */ char *remote_ip; /* Client's IP address */ char *remote_host; /* Client's DNS name, if known */ char *remote_name; /* Host ID --- same as remote_host, if known; * otherwise same as remote_ip. */ char *remote_logname; /* Only ever set if doing_rfc931 */ char *user; /* If an authentication check was made, * this gets set to the user name. We assume * that there's only one user per connection(!) */ char *auth_type; /* Ditto. */ int keepalive; /* Are we using HTTP Keep-Alive? */ int keptalive; /* Did we use HTTP Keep-Alive? */ int keepalives; /* How many times have we used it? */ }; /* Per-vhost config... */ struct server_rec { server_rec *next; /* Full locations of server config info */ char *srm_confname; char *access_confname; /* Contact information */ char *server_admin; char *server_hostname; short port; /* for redirects, etc. */ /* Log files --- note that transfer log is now in the modules... */ char *error_fname; FILE *error_log; /* Module-specific configuration for server, and defaults... */ int is_virtual; /* true if this is the virtual server */ void *module_config; /* Config vector containing pointers to * modules' per-server config structures. */ void *lookup_defaults; /* MIME type info, etc., before we start * checking per-directory info. */ /* Transaction handling */ short hostname_lookups; struct in_addr host_addr; /* The bound address, for this server */ short host_port; /* The bound port, for this server */ int timeout; /* Timeout, in seconds, before we give up */ int keep_alive_timeout; /* Seconds we'll wait for another request */ int keep_alive; /* Maximum requests per connection */ int do_rfc931; /* See if client is advertising a username? */ }; /* These are more like real hosts than virtual hosts */ struct listen_rec { listen_rec *next; struct sockaddr_in local_addr; /* local IP address and port */ /* more stuff here, like which protocol is bound to the port */ }; /* Prototypes for utilities... util.c. */ /* Time */ extern const char month_snames[12][4]; struct tm *get_gmtoff(long *tz); char *get_time(); char *ht_time (pool *p, time_t t, char *fmt, int gmt); char *gm_timestr_822(pool *p, time_t t); /* String handling */ char *getword(pool *p, char **line, char stop); char *getword_conf (pool *p, char **line); int is_url(char *u); extern int unescape_url(char *url); void no2slash(char *name); void getparents(char *name); char *escape_path_segment(pool *p, const char *s); char *os_escape_path(pool *p,const char *path); char *escape_uri (pool *p, char *s); extern char *escape_html(pool *p, const char *s); char *construct_url (pool *p, char *path, server_rec *s); char *escape_shell_cmd (pool *p, char *s); int count_dirs(char *path); char *make_dirstr(pool *a, char *s, int n); char *make_full_path(pool *a, char *dir, char *f); int is_matchexp(char *str); int strcmp_match(char *str, char *exp); char *uudecode (pool *, char *); void str_tolower (char *); int ind (const char *, char); /* Sigh... */ int rind (const char *, char); int cfg_getline(char *s, int n, FILE *f); /* Misc system hackery */ uid_t uname2id(char *name); gid_t gname2id(char *name); int is_directory(char *name); int can_exec(struct stat *); void chdir_file(char *file); char *get_local_host(pool *); struct in_addr get_local_addr (int sd); unsigned long get_virthost_addr (char *hostname, short int *port); void get_remote_host(conn_rec *conn); int get_portnum(int sd);