http: document index.cgi usage. no code changes
[oweals/busybox.git] / networking / httpd.c
index 956eecaf20cd95f9495bc181f717d59f8c41fde8..eded7b63f05dc882b741055fbdb06499f864b322 100644 (file)
@@ -5,32 +5,33 @@
  * Copyright (C) 2002,2003 Glenn Engel <glenne@engel.org>
  * Copyright (C) 2003-2006 Vladimir Oleynik <dzo@simtreas.ru>
  *
- * simplify patch stolen from libbb without using strdup
- *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  *
  *****************************************************************************
  *
  * Typical usage:
- *   for non root user
- * httpd -p 8080 -h $HOME/public_html
- *   or for daemon start from rc script with uid=0:
- * httpd -u www
- * This is equivalent if www user have uid=80 to
- * httpd -p 80 -u 80 -h /www -c /etc/httpd.conf -r "Web Server Authentication"
- *
+ * For non root user:
+ *      httpd -p 8080 -h $HOME/public_html
+ * For daemon start from rc script with uid=0:
+ *      httpd -u www
+ * which is equivalent to (assuming user www has uid 80):
+ *      httpd -p 80 -u 80 -h $PWD -c /etc/httpd.conf -r "Web Server Authentication"
  *
- * When a url starts by "/cgi-bin/" it is assumed to be a cgi script.  The
- * server changes directory to the location of the script and executes it
+ * When an url starts with "/cgi-bin/" it is assumed to be a cgi script.
+ * The server changes directory to the location of the script and executes it
  * after setting QUERY_STRING and other environment variables.
  *
+ * If directory URL is given, no index.html is found and CGI support is enabled,
+ * cgi-bin/index.cgi will be run. Directory to list is ../$QUERY_STRING.
+ * See httpd_indexcgi.c for an example GCI code.
+ *
  * Doc:
  * "CGI Environment Variables": http://hoohoo.ncsa.uiuc.edu/cgi/env.html
  *
- * The applet can also be invoked as a url arg decoder and html text encoder
+ * The applet can also be invoked as an url arg decoder and html text encoder
  * as follows:
- *  foo=`httpd -d $foo`           # decode "Hello%20World" as "Hello World"
- *  bar=`httpd -e "<Hello World>"`  # encode as "&#60Hello&#32World&#62"
+ *      foo=`httpd -d $foo`             # decode "Hello%20World" as "Hello World"
+ *      bar=`httpd -e "<Hello World>"`  # encode as "&#60Hello&#32World&#62"
  * Note that url encoding for arguments is not the same as html encoding for
  * presentation.  -d decodes an url-encoded argument while -e encodes in html
  * for page display.
@@ -74,7 +75,7 @@
  *     D:2.3.4.        # deny from 2.3.4.0 - 2.3.4.255
  *     A:*             # (optional line added for clarity)
  *
- * If a sub directory contains a config file it is parsed and merged with
+ * If a sub directory contains config file, it is parsed and merged with
  * any existing settings as if it was appended to the original configuration.
  *
  * subdir paths are relative to the containing subdir and thus cannot
 #if ENABLE_FEATURE_HTTPD_USE_SENDFILE
 # include <sys/sendfile.h>
 #endif
-
-#define DEBUG 0
-
-#define IOBUF_SIZE 8192    /* IO buffer */
-
 /* amount of buffering in a pipe */
 #ifndef PIPE_BUF
 # define PIPE_BUF 4096
 #endif
+
+#define DEBUG 0
+
+#define IOBUF_SIZE 8192
 #if PIPE_BUF >= IOBUF_SIZE
 # error "PIPE_BUF >= IOBUF_SIZE"
 #endif
 static const char DEFAULT_PATH_HTTPD_CONF[] ALIGN1 = "/etc";
 static const char HTTPD_CONF[] ALIGN1 = "httpd.conf";
 static const char HTTP_200[] ALIGN1 = "HTTP/1.0 200 OK\r\n";
+static const char index_html[] ALIGN1 = "index.html";
 
 typedef struct has_next_ptr {
        struct has_next_ptr *next;
@@ -170,7 +171,6 @@ enum {
        HTTP_PAYMENT_REQUIRED = 402,
        HTTP_BAD_GATEWAY = 502,
        HTTP_SERVICE_UNAVAILABLE = 503, /* overload, maintenance */
-       HTTP_RESPONSE_SETSIZE = 0xffffffff
 #endif
 };
 
@@ -231,12 +231,11 @@ static const struct {
 #endif
 };
 
-
 struct globals {
        int verbose;            /* must be int (used by getopt32) */
        smallint flg_deny_all;
 
-       unsigned rmt_ip;        /* used for IP-based allow/deny rules */
+       unsigned rmt_ip;        /* used for IP-based allow/deny rules */
        time_t last_mod;
        char *rmt_ip_str;       /* for $REMOTE_ADDR and $REMOTE_PORT */
        const char *bind_addr_or_port;
@@ -272,7 +271,7 @@ struct globals {
 #if ENABLE_FEATURE_HTTPD_CONFIG_WITH_SCRIPT_INTERPR
        Htaccess *script_i;     /* config script interpreters */
 #endif
-       char *iobuf;            /* [IOBUF_SIZE] */
+       char *iobuf;            /* [IOBUF_SIZE] */
 #define hdr_buf bb_common_bufsiz1
        char *hdr_ptr;
        int hdr_cnt;
@@ -282,6 +281,10 @@ struct globals {
 #if ENABLE_FEATURE_HTTPD_PROXY
        Htaccess_Proxy *proxy;
 #endif
+#if ENABLE_FEATURE_HTTPD_GZIP
+       /* client can handle gzip / we are going to send gzip */
+       smallint content_gzip;
+#endif
 };
 #define G (*ptr_to_globals)
 #define verbose           (G.verbose          )
@@ -324,11 +327,16 @@ enum {
 #define hdr_cnt           (G.hdr_cnt          )
 #define http_error_page   (G.http_error_page  )
 #define proxy             (G.proxy            )
+#if ENABLE_FEATURE_HTTPD_GZIP
+# define content_gzip     (G.content_gzip     )
+#else
+# define content_gzip     0
+#endif
 #define INIT_G() do { \
        SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
        IF_FEATURE_HTTPD_BASIC_AUTH(g_realm = "Web Server Authentication";) \
        bind_addr_or_port = "80"; \
-       index_page = "index.html"; \
+       index_page = index_html; \
        file_size = -1; \
 } while (0)
 
@@ -569,6 +577,8 @@ static void parse_conf(const char *path, int flag)
                ch = (buf[0] & ~0x20); /* toupper if it's a letter */
 
                if (ch == 'I') {
+                       if (index_page != index_html)
+                               free((char*)index_page);
                        index_page = xstrdup(after_colon);
                        continue;
                }
@@ -773,7 +783,7 @@ static char *encodeString(const char *string)
        char *p = out;
        char ch;
 
-       while ((ch = *string++)) {
+       while ((ch = *string++) != '\0') {
                /* very simple check for what to encode */
                if (isalnum(ch))
                        *p++ = ch;
@@ -783,7 +793,7 @@ static char *encodeString(const char *string)
        *p = '\0';
        return out;
 }
-#endif          /* FEATURE_HTTPD_ENCODE_URL_STR */
+#endif
 
 /*
  * Given a URL encoded string, convert it to plain ascii.
@@ -810,12 +820,12 @@ static unsigned hex_to_bin(unsigned char c)
        if (v <= 5)
                return v + 10;
        return ~0;
-}
 /* For testing:
 void t(char c) { printf("'%c'(%u) %u\n", c, c, hex_to_bin(c)); }
 int main() { t(0x10); t(0x20); t('0'); t('9'); t('A'); t('F'); t('a'); t('f');
 t('0'-1); t('9'+1); t('A'-1); t('F'+1); t('a'-1); t('f'+1); return 0; }
 */
+}
 static char *decodeString(char *orig, int option_d)
 {
        /* note that decoded string is always shorter than original */
@@ -1017,7 +1027,7 @@ static void send_headers(int responseNum)
                strftime(tmp_str, sizeof(tmp_str), RFC1123FMT, gmtime(&last_mod));
 #if ENABLE_FEATURE_HTTPD_RANGES
                if (responseNum == HTTP_PARTIAL_CONTENT) {
-                       len += sprintf(iobuf + len, "Content-Range: bytes %"OFF_FMT"d-%"OFF_FMT"d/%"OFF_FMT"d\r\n",
+                       len += sprintf(iobuf + len, "Content-Range: bytes %"OFF_FMT"u-%"OFF_FMT"u/%"OFF_FMT"u\r\n",
                                        range_start,
                                        range_end,
                                        file_size);
@@ -1028,12 +1038,16 @@ static void send_headers(int responseNum)
 #if ENABLE_FEATURE_HTTPD_RANGES
                        "Accept-Ranges: bytes\r\n"
 #endif
-                       "Last-Modified: %s\r\n%s %"OFF_FMT"d\r\n",
+                       "Last-Modified: %s\r\n%s %"OFF_FMT"u\r\n",
                                tmp_str,
-                               "Content-length:",
+                               content_gzip ? "Transfer-length:" : "Content-length:",
                                file_size
                );
        }
+
+       if (content_gzip)
+               len += sprintf(iobuf + len, "Content-Encoding: gzip\r\n");
+
        iobuf[len++] = '\r';
        iobuf[len++] = '\n';
        if (infoString) {
@@ -1055,6 +1069,7 @@ static void send_headers(int responseNum)
 static void send_headers_and_exit(int responseNum) NORETURN;
 static void send_headers_and_exit(int responseNum)
 {
+       IF_FEATURE_HTTPD_GZIP(content_gzip = 0;)
        send_headers(responseNum);
        log_and_exit();
 }
@@ -1141,13 +1156,14 @@ static NOINLINE void cgi_io_loop_and_exit(int fromCgi_rd, int toCgi_wr, int post
                                /* post_len <= 0 && hdr_cnt <= 0:
                                 * no more POST data to CGI,
                                 * let CGI see EOF on CGI's stdin */
-                               close(toCgi_wr);
+                               if (toCgi_wr != fromCgi_rd)
+                                       close(toCgi_wr);
                                toCgi_wr = 0;
                        }
                }
 
                /* Now wait on the set of sockets */
-               count = safe_poll(pfd, 3, -1);
+               count = safe_poll(pfd, toCgi_wr ? TO_CGI+1 : FROM_CGI+1, -1);
                if (count <= 0) {
 #if 0
                        if (safe_waitpid(pid, &status, WNOHANG) <= 0) {
@@ -1321,10 +1337,8 @@ static void send_cgi_and_exit(
        /* Check for [dirs/]script.cgi/PATH_INFO */
        script = (char*)url;
        while ((script = strchr(script + 1, '/')) != NULL) {
-               struct stat sb;
-
                *script = '\0';
-               if (!is_directory(url + 1, 1, &sb)) {
+               if (!is_directory(url + 1, 1, NULL)) {
                        /* not directory, found script.cgi/PATH_INFO */
                        *script = '/';
                        break;
@@ -1430,7 +1444,7 @@ static void send_cgi_and_exit(
                if (script != url) { /* paranoia */
                        *script = '\0';
                        if (chdir(url + 1) != 0) {
-                               bb_perror_msg("chdir %s", url + 1);
+                               bb_perror_msg("chdir(%s)", url + 1);
                                goto error_execing_cgi;
                        }
                        // not needed: *script = '/';
@@ -1471,7 +1485,7 @@ static void send_cgi_and_exit(
                 * in the current directory */
                execv(argv[0], argv);
                if (verbose)
-                       bb_perror_msg("exec %s", argv[0]);
+                       bb_perror_msg("can't execute '%s'", argv[0]);
  error_execing_cgi:
                /* send to stdout
                 * (we are CGI here, our stdout is pumped to the net) */
@@ -1500,35 +1514,27 @@ static void send_cgi_and_exit(
  */
 static NOINLINE void send_file_and_exit(const char *url, int what)
 {
-       static const char *const suffixTable[] = {
-       /* Warning: shorter equivalent suffix in one line must be first */
-               ".htm.html", "text/html",
-               ".jpg.jpeg", "image/jpeg",
-               ".gif",      "image/gif",
-               ".png",      "image/png",
-               ".txt.h.c.cc.cpp", "text/plain",
-               ".css",      "text/css",
-               ".wav",      "audio/wav",
-               ".avi",      "video/x-msvideo",
-               ".qt.mov",   "video/quicktime",
-               ".mpe.mpeg", "video/mpeg",
-               ".mid.midi", "audio/midi",
-               ".mp3",      "audio/mpeg",
-#if 0                        /* unpopular */
-               ".au",       "audio/basic",
-               ".pac",      "application/x-ns-proxy-autoconfig",
-               ".vrml.wrl", "model/vrml",
-#endif
-               NULL
-       };
-
        char *suffix;
        int fd;
-       const char *const *table;
-       const char *try_suffix;
        ssize_t count;
 
-       fd = open(url, O_RDONLY);
+       if (content_gzip) {
+               /* does <url>.gz exist? Then use it instead */
+               char *gzurl = xasprintf("%s.gz", url);
+               fd = open(gzurl, O_RDONLY);
+               free(gzurl);
+               if (fd != -1) {
+                       struct stat sb;
+                       fstat(fd, &sb);
+                       file_size = sb.st_size;
+                       last_mod = sb.st_mtime;
+               } else {
+                       IF_FEATURE_HTTPD_GZIP(content_gzip = 0;)
+                       fd = open(url, O_RDONLY);
+               }
+       } else {
+               fd = open(url, O_RDONLY);
+       }
        if (fd < 0) {
                if (DEBUG)
                        bb_perror_msg("can't open '%s'", url);
@@ -1543,22 +1549,61 @@ static NOINLINE void send_file_and_exit(const char *url, int what)
         * (happens if you abort downloads from local httpd): */
        signal(SIGPIPE, SIG_IGN);
 
-       suffix = strrchr(url, '.');
-
-       /* If not found, set default as "application/octet-stream";  */
+       /* If not found, default is "application/octet-stream" */
        found_mime_type = "application/octet-stream";
+       suffix = strrchr(url, '.');
        if (suffix) {
+               static const char suffixTable[] ALIGN1 =
+                       /* Shorter suffix must be first:
+                        * ".html.htm" will fail for ".htm"
+                        */
+                       ".txt.h.c.cc.cpp\0" "text/plain\0"
+                       /* .htm line must be after .h line */
+                       ".htm.html\0" "text/html\0"
+                       ".jpg.jpeg\0" "image/jpeg\0"
+                       ".gif\0"      "image/gif\0"
+                       ".png\0"      "image/png\0"
+                       /* .css line must be after .c line */
+                       ".css\0"      "text/css\0"
+                       ".wav\0"      "audio/wav\0"
+                       ".avi\0"      "video/x-msvideo\0"
+                       ".qt.mov\0"   "video/quicktime\0"
+                       ".mpe.mpeg\0" "video/mpeg\0"
+                       ".mid.midi\0" "audio/midi\0"
+                       ".mp3\0"      "audio/mpeg\0"
+#if 0  /* unpopular */
+                       ".au\0"       "audio/basic\0"
+                       ".pac\0"      "application/x-ns-proxy-autoconfig\0"
+                       ".vrml.wrl\0" "model/vrml\0"
+#endif
+                       /* compiler adds another "\0" here */
+               ;
                Htaccess *cur;
-               for (table = suffixTable; *table; table += 2) {
-                       try_suffix = strstr(table[0], suffix);
-                       if (try_suffix) {
-                               try_suffix += strlen(suffix);
-                               if (*try_suffix == '\0' || *try_suffix == '.') {
-                                       found_mime_type = table[1];
-                                       break;
-                               }
+
+               /* Examine built-in table */
+               const char *table = suffixTable;
+               const char *table_next;
+               for (; *table; table = table_next) {
+                       const char *try_suffix;
+                       const char *mime_type;
+                       mime_type  = table + strlen(table) + 1;
+                       table_next = mime_type + strlen(mime_type) + 1;
+                       try_suffix = strstr(table, suffix);
+                       if (!try_suffix)
+                               continue;
+                       try_suffix += strlen(suffix);
+                       if (*try_suffix == '\0' || *try_suffix == '.') {
+                               found_mime_type = mime_type;
+                               break;
                        }
+                       /* Example: strstr(table, ".av") != NULL, but it
+                        * does not match ".avi" after all and we end up here.
+                        * The table is arranged so that in this case we know
+                        * that it can't match anything in the following lines,
+                        * and we stop the search: */
+                       break;
                }
+               /* ...then user's table */
                for (cur = mime_a; cur; cur = cur->next) {
                        if (strcmp(cur->before_colon, suffix) == 0) {
                                found_mime_type = cur->after_colon;
@@ -1572,8 +1617,11 @@ static NOINLINE void send_file_and_exit(const char *url, int what)
                        url, found_mime_type);
 
 #if ENABLE_FEATURE_HTTPD_RANGES
-       if (what == SEND_BODY)
-               range_start = 0; /* err pages and ranges don't mix */
+       if (what == SEND_BODY /* err pages and ranges don't mix */
+        || content_gzip /* we are sending compressed page: can't do ranges */  ///why?
+       ) {
+               range_start = 0;
+       }
        range_len = MAXINT(off_t);
        if (range_start) {
                if (!range_end) {
@@ -1915,7 +1963,7 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
 
        /* If URL is a directory, add '/' */
        if (urlp[-1] != '/') {
-               if (is_directory(urlcopy + 1, 1, &sb)) {
+               if (is_directory(urlcopy + 1, 1, NULL)) {
                        found_moved_temporarily = urlcopy;
                }
        }
@@ -1929,7 +1977,7 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
        while (ip_allowed && (tptr = strchr(tptr + 1, '/')) != NULL) {
                /* have path1/path2 */
                *tptr = '\0';
-               if (is_directory(urlcopy + 1, 1, &sb)) {
+               if (is_directory(urlcopy + 1, 1, NULL)) {
                        /* may have subdir config */
                        parse_conf(urlcopy + 1, SUBDIR_PARSE);
                        ip_allowed = checkPermIP();
@@ -1946,7 +1994,7 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
        if (http_major_version >= '0') {
                /* Request was with "... HTTP/nXXX", and n >= 0 */
 
-               /* Read until blank line for HTTP version specified, else parse immediate */
+               /* Read until blank line */
                while (1) {
                        if (!get_line())
                                break; /* EOF or error or empty line */
@@ -1973,9 +2021,9 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
                        if ((STRNCASECMP(iobuf, "Content-length:") == 0)) {
                                /* extra read only for POST */
                                if (prequest != request_GET
-#if ENABLE_FEATURE_HTTPD_CGI
+# if ENABLE_FEATURE_HTTPD_CGI
                                 && prequest != request_HEAD
-#endif
+# endif
                                ) {
                                        tptr = skip_whitespace(iobuf + sizeof("Content-length:") - 1);
                                        if (!tptr[0])
@@ -2036,6 +2084,23 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
                                        }
                                }
                        }
+#endif
+#if ENABLE_FEATURE_HTTPD_GZIP
+                       if (STRNCASECMP(iobuf, "Accept-Encoding:") == 0) {
+                               /* Note: we do not support "gzip;q=0"
+                                * method of _disabling_ gzip
+                                * delivery. No one uses that, though */
+                               const char *s = strstr(iobuf, "gzip");
+                               if (s) {
+                                       // want more thorough checks?
+                                       //if (s[-1] == ' '
+                                       // || s[-1] == ','
+                                       // || s[-1] == ':'
+                                       //) {
+                                               content_gzip = 1;
+                                       //}
+                               }
+                       }
 #endif
                } /* while extra header reading */
        }
@@ -2086,8 +2151,7 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
                header_ptr += 2;
                write(proxy_fd, header_buf, header_ptr - header_buf);
                free(header_buf); /* on the order of 8k, free it */
-               /* cgi_io_loop_and_exit needs to have two distinct fds */
-               cgi_io_loop_and_exit(proxy_fd, dup(proxy_fd), length);
+               cgi_io_loop_and_exit(proxy_fd, proxy_fd, length);
        }
 #endif
 
@@ -2101,8 +2165,12 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
                }
                send_cgi_and_exit(urlcopy, prequest, length, cookie, content_type);
        }
+#endif
+
+       if (urlp[-1] == '/')
+               strcpy(urlp, index_page);
+       if (stat(tptr, &sb) == 0) {
 #if ENABLE_FEATURE_HTTPD_CONFIG_WITH_SCRIPT_INTERPR
-       {
                char *suffix = strrchr(tptr, '.');
                if (suffix) {
                        Htaccess *cur;
@@ -2112,16 +2180,7 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
                                }
                        }
                }
-       }
 #endif
-       if (prequest != request_GET && prequest != request_HEAD) {
-               send_headers_and_exit(HTTP_NOT_IMPLEMENTED);
-       }
-#endif  /* FEATURE_HTTPD_CGI */
-
-       if (urlp[-1] == '/')
-               strcpy(urlp, index_page);
-       if (stat(tptr, &sb) == 0) {
                file_size = sb.st_size;
                last_mod = sb.st_mtime;
        }
@@ -2135,19 +2194,18 @@ static void handle_incoming_and_exit(const len_and_sockaddr *fromAddr)
                        send_cgi_and_exit("/cgi-bin/index.cgi", prequest, length, cookie, content_type);
                }
        }
-#endif
-       /* else {
-        *      fall through to send_file, it errors out if open fails
-        * }
-        */
+       /* else fall through to send_file, it errors out if open fails: */
 
+       if (prequest != request_GET && prequest != request_HEAD) {
+               /* POST for files does not make sense */
+               send_headers_and_exit(HTTP_NOT_IMPLEMENTED);
+       }
        send_file_and_exit(tptr,
-#if ENABLE_FEATURE_HTTPD_CGI
                (prequest != request_HEAD ? SEND_HEADERS_AND_BODY : SEND_HEADERS)
+       );
 #else
-               SEND_HEADERS_AND_BODY
+       send_file_and_exit(tptr, SEND_HEADERS_AND_BODY);
 #endif
-       );
 }
 
 /*
@@ -2172,9 +2230,9 @@ static void mini_httpd(int server_socket)
                /* Wait for connections... */
                fromAddr.len = LSA_SIZEOF_SA;
                n = accept(server_socket, &fromAddr.u.sa, &fromAddr.len);
-
                if (n < 0)
                        continue;
+
                /* set the KEEPALIVE option to cull dead connections */
                setsockopt(n, SOL_SOCKET, SO_KEEPALIVE, &const_int_1, sizeof(const_int_1));
 
@@ -2215,9 +2273,9 @@ static void mini_httpd_nommu(int server_socket, int argc, char **argv)
                /* Wait for connections... */
                fromAddr.len = LSA_SIZEOF_SA;
                n = accept(server_socket, &fromAddr.u.sa, &fromAddr.len);
-
                if (n < 0)
                        continue;
+
                /* set the KEEPALIVE option to cull dead connections */
                setsockopt(n, SOL_SOCKET, SO_KEEPALIVE, &const_int_1, sizeof(const_int_1));
 
@@ -2336,7 +2394,12 @@ int httpd_main(int argc UNUSED_PARAM, char **argv)
 #endif
 #if ENABLE_FEATURE_HTTPD_AUTH_MD5
        if (opt & OPT_MD5) {
-               puts(pw_encrypt(pass, "$1$", 1));
+               char salt[sizeof("$1$XXXXXXXX")];
+               salt[0] = '$';
+               salt[1] = '1';
+               salt[2] = '$';
+               crypt_make_salt(salt + 3, 4, 0);
+               puts(pw_encrypt(pass, salt, 1));
                return 0;
        }
 #endif