]> git.cameronkatri.com Git - mandoc.git/blobdiff - cgi.c
Decide whether to use_pager as early as possible,
[mandoc.git] / cgi.c
diff --git a/cgi.c b/cgi.c
index 0ea3179def2bea64ec3321e49728a8413cd507d4..e47cd0014c4830673cbf8ce235fdb9bd9e6ee8f3 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,15 +1,15 @@
-/*     $Id: cgi.c,v 1.94 2014/08/17 03:24:47 schwarze Exp $ */
+/*     $Id: cgi.c,v 1.109 2015/10/06 18:32:19 schwarze Exp $ */
 /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
+ * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@usta.de>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
@@ -18,6 +18,7 @@
 #include "config.h"
 
 #include <sys/types.h>
+#include <sys/time.h>
 
 #include <ctype.h>
 #include <errno.h>
 #include <string.h>
 #include <unistd.h>
 
-#include "mandoc.h"
 #include "mandoc_aux.h"
+#include "mandoc.h"
+#include "roff.h"
 #include "main.h"
-#include "manpath.h"
+#include "manconf.h"
 #include "mansearch.h"
 #include "cgi.h"
 
@@ -57,10 +59,10 @@ static      void             catman(const struct req *, const char *);
 static void             format(const struct req *, const char *);
 static void             html_print(const char *);
 static void             html_putchar(char);
-static int              http_decode(char *);
+static int              http_decode(char *);
 static void             http_parse(struct req *, const char *);
 static void             http_print(const char *);
-static void             http_putchar(char);
+static void             http_putchar(char);
 static void             http_printquery(const struct req *, const char *);
 static void             pathgen(struct req *);
 static void             pg_error_badrequest(const char *);
@@ -91,14 +93,14 @@ static      const char *const sec_names[] = {
     "All Sections",
     "1 - General Commands",
     "2 - System Calls",
-    "3 - Subroutines",
-    "3p - Perl Subroutines",
-    "4 - Special Files",
+    "3 - Library Functions",
+    "3p - Perl Library",
+    "4 - Device Drivers",
     "5 - File Formats",
     "6 - Games",
-    "7 - Macros and Conventions",
-    "8 - Maintenance Commands",
-    "9 - Kernel Interface"
+    "7 - Miscellaneous Information",
+    "8 - System Manager\'s Manual",
+    "9 - Kernel Developer\'s Manual"
 };
 static const int sec_MAX = sizeof(sec_names) / sizeof(char *);
 
@@ -162,8 +164,7 @@ http_printquery(const struct req *req, const char *sep)
                printf("%sarch=", sep);
                http_print(req->q.arch);
        }
-       if (NULL != req->q.manpath &&
-           strcmp(req->q.manpath, req->p[0])) {
+       if (strcmp(req->q.manpath, req->p[0])) {
                printf("%smanpath=", sep);
                http_print(req->q.manpath);
        }
@@ -186,7 +187,7 @@ http_print(const char *p)
 static void
 html_print(const char *p)
 {
-       
+
        if (NULL == p)
                return;
        while ('\0' != *p)
@@ -297,11 +298,6 @@ next:
                if (*qs != '\0')
                        qs++;
        }
-
-       /* Fall back to the default manpath. */
-
-       if (req->q.manpath == NULL)
-               req->q.manpath = mandoc_strdup(req->p[0]);
 }
 
 static void
@@ -336,13 +332,13 @@ http_decode(char *p)
        for ( ; '\0' != *p; p++, q++) {
                if ('%' == *p) {
                        if ('\0' == (hex[0] = *(p + 1)))
-                               return(0);
+                               return 0;
                        if ('\0' == (hex[1] = *(p + 2)))
-                               return(0);
+                               return 0;
                        if (1 != sscanf(hex, "%x", &c))
-                               return(0);
+                               return 0;
                        if ('\0' == c)
-                               return(0);
+                               return 0;
 
                        *q = (char)c;
                        p += 2;
@@ -351,7 +347,7 @@ http_decode(char *p)
        }
 
        *q = '\0';
-       return(1);
+       return 1;
 }
 
 static void
@@ -375,13 +371,10 @@ resp_begin_html(int code, const char *msg)
 
        resp_begin_http(code, msg);
 
-       printf("<!DOCTYPE HTML PUBLIC "
-              " \"-//W3C//DTD HTML 4.01//EN\""
-              " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
+       printf("<!DOCTYPE html>\n"
               "<HTML>\n"
               "<HEAD>\n"
-              "<META HTTP-EQUIV=\"Content-Type\""
-              " CONTENT=\"text/html; charset=utf-8\">\n"
+              "<META CHARSET=\"UTF-8\" />\n"
               "<LINK REL=\"stylesheet\" HREF=\"%s/man-cgi.css\""
               " TYPE=\"text/css\" media=\"all\">\n"
               "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""
@@ -471,8 +464,7 @@ resp_searchform(const struct req *req)
                puts("<SELECT NAME=\"manpath\">");
                for (i = 0; i < (int)req->psz; i++) {
                        printf("<OPTION ");
-                       if (NULL == req->q.manpath ? 0 == i :
-                           0 == strcmp(req->q.manpath, req->p[i]))
+                       if (strcmp(req->q.manpath, req->p[i]) == 0)
                                printf("SELECTED=\"selected\" ");
                        printf("VALUE=\"");
                        html_print(req->p[i]);
@@ -507,10 +499,10 @@ validate_urifrag(const char *frag)
                if ( ! (isalnum((unsigned char)*frag) ||
                    '-' == *frag || '.' == *frag ||
                    '/' == *frag || '_' == *frag))
-                       return(0);
+                       return 0;
                frag++;
        }
-       return(1);
+       return 1;
 }
 
 static int
@@ -519,13 +511,13 @@ validate_manpath(const struct req *req, const char* manpath)
        size_t   i;
 
        if ( ! strcmp(manpath, "mandoc"))
-               return(1);
+               return 1;
 
        for (i = 0; i < req->psz; i++)
                if ( ! strcmp(manpath, req->p[i]))
-                       return(1);
+                       return 1;
 
-       return(0);
+       return 0;
 }
 
 static int
@@ -535,8 +527,8 @@ validate_filename(const char *file)
        if ('.' == file[0] && '/' == file[1])
                file += 2;
 
-       return ! (strstr(file, "../") || strstr(file, "/..") ||
-           (strncmp(file, "man", 3) && strncmp(file, "cat", 3))));
+       return ! (strstr(file, "../") || strstr(file, "/..") ||
+           (strncmp(file, "man", 3) && strncmp(file, "cat", 3)));
 }
 
 static void
@@ -630,7 +622,7 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz)
        for (i = 0; i < sz; i++) {
                printf("<TR>\n"
                       "<TD CLASS=\"title\">\n"
-                      "<A HREF=\"%s/%s/%s?", 
+                      "<A HREF=\"%s/%s/%s?",
                    scriptname, req->q.manpath, r[i].file);
                http_printquery(req, "&amp;");
                printf("\">");
@@ -710,7 +702,7 @@ catman(const struct req *req, const char *file)
        while (NULL != (p = fgetln(f, &len))) {
                bold = italic = 0;
                for (i = 0; i < (int)len - 1; i++) {
-                       /* 
+                       /*
                         * This means that the catpage is out of state.
                         * Ignore it and keep going (although the
                         * catpage is bogus).
@@ -751,7 +743,7 @@ catman(const struct req *req, const char *file)
                                continue;
                        }
 
-                       /* 
+                       /*
                         * Handle funny behaviour troff-isms.
                         * These grok'd from the original man2html.c.
                         */
@@ -789,7 +781,7 @@ catman(const struct req *req, const char *file)
                        }
 
                        /* Bold mode. */
-                       
+
                        if (italic)
                                printf("</I>");
                        if ( ! bold)
@@ -800,9 +792,9 @@ catman(const struct req *req, const char *file)
                        html_putchar(p[i]);
                }
 
-               /* 
+               /*
                 * Clean up the last character.
-                * We can get to a newline; don't print that. 
+                * We can get to a newline; don't print that.
                 */
 
                if (italic)
@@ -825,12 +817,11 @@ catman(const struct req *req, const char *file)
 static void
 format(const struct req *req, const char *file)
 {
+       struct manoutput conf;
        struct mparse   *mp;
-       struct mdoc     *mdoc;
-       struct man      *man;
+       struct mchars   *mchars;
+       struct roff_man *man;
        void            *vp;
-       char            *opts;
-       enum mandoclevel rc;
        int              fd;
        int              usepath;
 
@@ -839,46 +830,43 @@ format(const struct req *req, const char *file)
                return;
        }
 
-       mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL,
-           req->q.manpath);
-       rc = mparse_readfd(mp, fd, file);
+       mchars = mchars_alloc();
+       mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_BADARG, NULL,
+           mchars, req->q.manpath);
+       mparse_readfd(mp, fd, file);
        close(fd);
 
-       if (rc >= MANDOCLEVEL_FATAL) {
-               fprintf(stderr, "fatal mandoc error: %s/%s\n",
-                   req->q.manpath, file);
-               pg_error_internal();
-               return;
-       }
-
+       memset(&conf, 0, sizeof(conf));
+       conf.fragment = 1;
        usepath = strcmp(req->q.manpath, req->p[0]);
-       mandoc_asprintf(&opts,
-           "fragment,man=%s?query=%%N&sec=%%S%s%s%s%s",
+       mandoc_asprintf(&conf.man, "%s?query=%%N&sec=%%S%s%s%s%s",
            scriptname,
            req->q.arch ? "&arch="       : "",
            req->q.arch ? req->q.arch    : "",
            usepath     ? "&manpath="    : "",
            usepath     ? req->q.manpath : "");
 
-       mparse_result(mp, &mdoc, &man, NULL);
-       if (NULL == man && NULL == mdoc) {
+       mparse_result(mp, &man, NULL);
+       if (man == NULL) {
                fprintf(stderr, "fatal mandoc error: %s/%s\n",
                    req->q.manpath, file);
                pg_error_internal();
                mparse_free(mp);
+               mchars_free(mchars);
                return;
        }
 
-       vp = html_alloc(opts);
+       vp = html_alloc(mchars, &conf);
 
-       if (NULL != mdoc)
-               html_mdoc(vp, mdoc);
+       if (man->macroset == MACROSET_MDOC)
+               html_mdoc(vp, man);
        else
                html_man(vp, man);
 
        html_free(vp);
        mparse_free(mp);
-       free(opts);
+       mchars_free(mchars);
+       free(conf.man);
 }
 
 static void
@@ -904,7 +892,7 @@ pg_show(struct req *req, const char *fullpath)
                pg_error_badrequest(
                    "You did not specify a page to show.");
                return;
-       } 
+       }
        manpath = mandoc_strndup(fullpath, file - fullpath);
        file++;
 
@@ -953,10 +941,10 @@ pg_search(const struct req *req)
        struct mansearch          search;
        struct manpaths           paths;
        struct manpage           *res;
-       char                    **cp;
-       const char               *ep, *start;
+       char                    **argv;
+       char                     *query, *rp, *wp;
        size_t                    ressz;
-       int                       i, sz;
+       int                       argc;
 
        /*
         * Begin by chdir()ing into the root of the manpath.
@@ -975,52 +963,52 @@ pg_search(const struct req *req)
        search.sec = req->q.sec;
        search.outkey = "Nd";
        search.argmode = req->q.equal ? ARG_NAME : ARG_EXPR;
+       search.firstmatch = 1;
 
        paths.sz = 1;
        paths.paths = mandoc_malloc(sizeof(char *));
        paths.paths[0] = mandoc_strdup(".");
 
        /*
-        * Poor man's tokenisation: just break apart by spaces.
-        * Yes, this is half-ass.  But it works for now.
+        * Break apart at spaces with backslash-escaping.
         */
 
-       ep = req->q.query;
-       while (ep && isspace((unsigned char)*ep))
-               ep++;
-
-       sz = 0;
-       cp = NULL;
-       while (ep && '\0' != *ep) {
-               cp = mandoc_reallocarray(cp, sz + 1, sizeof(char *));
-               start = ep;
-               while ('\0' != *ep && ! isspace((unsigned char)*ep))
-                       ep++;
-               cp[sz] = mandoc_malloc((ep - start) + 1);
-               memcpy(cp[sz], start, ep - start);
-               cp[sz++][ep - start] = '\0';
-               while (isspace((unsigned char)*ep))
-                       ep++;
+       argc = 0;
+       argv = NULL;
+       rp = query = mandoc_strdup(req->q.query);
+       for (;;) {
+               while (isspace((unsigned char)*rp))
+                       rp++;
+               if (*rp == '\0')
+                       break;
+               argv = mandoc_reallocarray(argv, argc + 1, sizeof(char *));
+               argv[argc++] = wp = rp;
+               for (;;) {
+                       if (isspace((unsigned char)*rp)) {
+                               *wp = '\0';
+                               rp++;
+                               break;
+                       }
+                       if (rp[0] == '\\' && rp[1] != '\0')
+                               rp++;
+                       if (wp != rp)
+                               *wp = *rp;
+                       if (*rp == '\0')
+                               break;
+                       wp++;
+                       rp++;
+               }
        }
 
-       if (0 == mansearch(&search, &paths, sz, cp, &res, &ressz))
+       if (0 == mansearch(&search, &paths, argc, argv, &res, &ressz))
                pg_noresult(req, "You entered an invalid query.");
        else if (0 == ressz)
                pg_noresult(req, "No results found.");
        else
                pg_searchres(req, res, ressz);
 
-       for (i = 0; i < sz; i++)
-               free(cp[i]);
-       free(cp);
-
-       for (i = 0; i < (int)ressz; i++) {
-               free(res[i].file);
-               free(res[i].names);
-               free(res[i].output);
-       }
-       free(res);
-
+       free(query);
+       mansearch_free(res, ressz);
        free(paths.paths[0]);
        free(paths.paths);
 }
@@ -1029,10 +1017,23 @@ int
 main(void)
 {
        struct req       req;
+       struct itimerval itimer;
        const char      *path;
        const char      *querystring;
        int              i;
 
+       /* Poor man's ReDoS mitigation. */
+
+       itimer.it_value.tv_sec = 2;
+       itimer.it_value.tv_usec = 0;
+       itimer.it_interval.tv_sec = 2;
+       itimer.it_interval.tv_usec = 0;
+       if (setitimer(ITIMER_VIRTUAL, &itimer, NULL) == -1) {
+               fprintf(stderr, "setitimer: %s\n", strerror(errno));
+               pg_error_internal();
+               return EXIT_FAILURE;
+       }
+
        /* Scan our run-time environment. */
 
        if (NULL == (scriptname = getenv("SCRIPT_NAME")))
@@ -1042,7 +1043,7 @@ main(void)
                fprintf(stderr, "unsafe SCRIPT_NAME \"%s\"\n",
                    scriptname);
                pg_error_internal();
-               return(EXIT_FAILURE);
+               return EXIT_FAILURE;
        }
 
        /*
@@ -1055,8 +1056,8 @@ main(void)
                fprintf(stderr, "MAN_DIR: %s: %s\n",
                    MAN_DIR, strerror(errno));
                pg_error_internal();
-               return(EXIT_FAILURE);
-       } 
+               return EXIT_FAILURE;
+       }
 
        memset(&req, 0, sizeof(struct req));
        pathgen(&req);
@@ -1066,17 +1067,18 @@ main(void)
        if (NULL != (querystring = getenv("QUERY_STRING")))
                http_parse(&req, querystring);
 
-       if ( ! (NULL == req.q.manpath ||
-           validate_manpath(&req, req.q.manpath))) {
+       if (req.q.manpath == NULL)
+               req.q.manpath = mandoc_strdup(req.p[0]);
+       else if ( ! validate_manpath(&req, req.q.manpath)) {
                pg_error_badrequest(
                    "You specified an invalid manpath.");
-               return(EXIT_FAILURE);
+               return EXIT_FAILURE;
        }
 
        if ( ! (NULL == req.q.arch || validate_urifrag(req.q.arch))) {
                pg_error_badrequest(
                    "You specified an invalid architecture.");
-               return(EXIT_FAILURE);
+               return EXIT_FAILURE;
        }
 
        /* Dispatch to the three different pages. */
@@ -1101,7 +1103,7 @@ main(void)
        for (i = 0; i < (int)req.psz; i++)
                free(req.p[i]);
        free(req.p);
-       return(EXIT_SUCCESS);
+       return EXIT_SUCCESS;
 }
 
 /*