=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.140 retrieving revision 1.168 diff -u -p -r1.140 -r1.168 --- mandoc/cgi.c 2016/09/03 21:24:56 1.140 +++ mandoc/cgi.c 2019/10/01 17:54:14 1.168 @@ -1,7 +1,7 @@ -/* $Id: cgi.c,v 1.140 2016/09/03 21:24:56 schwarze Exp $ */ +/* $Id: cgi.c,v 1.168 2019/10/01 17:54:14 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons - * Copyright (c) 2014, 2015, 2016 Ingo Schwarze + * Copyright (c) 2014-2019 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -21,7 +21,9 @@ #include #include +#if HAVE_ERR #include +#endif #include #include #include @@ -36,6 +38,7 @@ #include "roff.h" #include "mdoc.h" #include "man.h" +#include "mandoc_parse.h" #include "main.h" #include "manconf.h" #include "mansearch.h" @@ -67,18 +70,21 @@ enum focus { static void html_print(const char *); static void html_putchar(char); static int http_decode(char *); +static void http_encode(const char *p); static void parse_manpath_conf(struct req *); static void parse_path_info(struct req *req, const char *path); static void parse_query_string(struct req *, const char *); static void pg_error_badrequest(const char *); static void pg_error_internal(void); static void pg_index(const struct req *); -static void pg_noresult(const struct req *, const char *); +static void pg_noresult(const struct req *, int, const char *, + const char *); +static void pg_redirect(const struct req *, const char *); static void pg_search(const struct req *); static void pg_searchres(const struct req *, struct manpage *, size_t); static void pg_show(struct req *, const char *); -static void resp_begin_html(int, const char *); +static void resp_begin_html(int, const char *, const char *); static void resp_begin_http(int, const char *); static void resp_catman(const struct req *, const char *); static void resp_copy(const char *); @@ -87,6 +93,7 @@ static void resp_format(const struct req *, const ch static void resp_searchform(const struct req *, enum focus); static void resp_show(const struct req *, const char *); static void set_query_attr(char **, char **); +static int validate_arch(const char *); static int validate_filename(const char *); static int validate_manpath(const struct req *, const char *); static int validate_urifrag(const char *); @@ -113,7 +120,7 @@ static const char *const sec_names[] = { static const int sec_MAX = sizeof(sec_names) / sizeof(char *); static const char *const arch_names[] = { - "amd64", "alpha", "armv7", + "amd64", "alpha", "armv7", "arm64", "hppa", "i386", "landisk", "loongson", "luna88k", "macppc", "mips64", "octeon", "sgi", "socppc", "sparc64", @@ -137,16 +144,16 @@ html_putchar(char c) { switch (c) { - case ('"'): - printf(""e;"); + case '"': + printf("""); break; - case ('&'): + case '&': printf("&"); break; - case ('>'): + case '>': printf(">"); break; - case ('<'): + case '<': printf("<"); break; default: @@ -313,6 +320,18 @@ http_decode(char *p) } static void +http_encode(const char *p) +{ + for (; *p != '\0'; p++) { + if (isalnum((unsigned char)*p) == 0 && + strchr("-._~", *p) == NULL) + printf("%%%2.2X", (unsigned char)*p); + else + putchar(*p); + } +} + +static void resp_begin_http(int code, const char *msg) { @@ -343,22 +362,34 @@ resp_copy(const char *filename) } static void -resp_begin_html(int code, const char *msg) +resp_begin_html(int code, const char *msg, const char *file) { + char *cp; resp_begin_http(code, msg); printf("\n" "\n" "\n" - "\n" - "\n" + " \n" + " \n" - "%s\n" + " ", + CSS_DIR); + if (file != NULL) { + if ((cp = strrchr(file, '/')) != NULL) + file = cp + 1; + if ((cp = strrchr(file, '.')) != NULL) { + printf("%.*s(%s) - ", (int)(cp - file), file, cp + 1); + } else + printf("%s - ", file); + } + printf("%s\n" "\n" - "\n" - "\n", - CSS_DIR, CUSTOMIZE_TITLE); + "\n", + CUSTOMIZE_TITLE); resp_copy(MAN_DIR "/header.html"); } @@ -378,16 +409,14 @@ resp_searchform(const struct req *req, enum focus focu { int i; - puts(""); - printf("

\n" - "

\n" - "Manual Page Search Parameters\n", + printf("\n" + "

\n" + " Manual Page Search Parameters\n", scriptname); /* Write query input box. */ - printf("q.query != NULL) html_print(req->q.query); printf( "\" size=\"40\""); @@ -397,60 +426,57 @@ resp_searchform(const struct req *req, enum focus focu /* Write submission buttons. */ - printf( "\n" - "\n
\n"); + " \n" + "
\n"); /* Write section selector. */ - puts(""); for (i = 0; i < sec_MAX; i++) { - printf("\n", sec_names[i]); } - puts(""); + puts(" "); /* Write architecture selector. */ - printf( ""); + puts(" "); /* Write manpath selector. */ if (req->psz > 1) { - puts(""); for (i = 0; i < (int)req->psz; i++) { - printf(""); } - puts(""); + puts(" "); } - puts("

\n" - "\n" - "

"); - puts(""); + puts(" \n" + ""); } static int @@ -480,6 +506,18 @@ validate_manpath(const struct req *req, const char* ma } static int +validate_arch(const char *arch) +{ + int i; + + for (i = 0; i < arch_MAX; i++) + if (strcmp(arch, arch_names[i]) == 0) + return 1; + + return 0; +} + +static int validate_filename(const char *file) { @@ -494,13 +532,13 @@ static void pg_index(const struct req *req) { - resp_begin_html(200, NULL); + resp_begin_html(200, NULL, NULL); resp_searchform(req, FOCUS_QUERY); printf("

\n" "This web interface is documented in the\n" - "man.cgi(8)\n" + "man.cgi(8)\n" "manual, and the\n" - "apropos(1)\n" + "apropos(1)\n" "manual explains the query syntax.\n" "

\n", scriptname, *scriptname == '\0' ? "" : "/", @@ -509,12 +547,13 @@ pg_index(const struct req *req) } static void -pg_noresult(const struct req *req, const char *msg) +pg_noresult(const struct req *req, int code, const char *http_msg, + const char *user_msg) { - resp_begin_html(200, NULL); + resp_begin_html(code, http_msg, NULL); resp_searchform(req, FOCUS_QUERY); puts("

"); - puts(msg); + puts(user_msg); puts("

"); resp_end_html(); } @@ -523,7 +562,7 @@ static void pg_error_badrequest(const char *msg) { - resp_begin_html(400, "Bad Request"); + resp_begin_html(400, "Bad Request", NULL); puts("

Bad Request

\n" "

\n"); puts(msg); @@ -536,12 +575,31 @@ pg_error_badrequest(const char *msg) static void pg_error_internal(void) { - resp_begin_html(500, "Internal Server Error"); + resp_begin_html(500, "Internal Server Error", NULL); puts("

Internal Server Error

"); resp_end_html(); } static void +pg_redirect(const struct req *req, const char *name) +{ + printf("Status: 303 See Other\r\n" + "Location: /"); + if (*scriptname != '\0') + printf("%s/", scriptname); + if (strcmp(req->q.manpath, req->p[0])) + printf("%s/", req->q.manpath); + if (req->q.arch != NULL) + printf("%s/", req->q.arch); + http_encode(name); + if (req->q.sec != NULL) { + putchar('.'); + http_encode(req->q.sec); + } + printf("\r\nContent-Type: text/html; charset=utf-8\r\n\r\n"); +} + +static void pg_searchres(const struct req *req, struct manpage *r, size_t sz) { char *arch, *archend; @@ -564,53 +622,25 @@ pg_searchres(const struct req *req, struct manpage *r, * If we have just one result, then jump there now * without any delay. */ - printf("Status: 303 See Other\r\n"); - printf("Location: http://%s/%s%s%s/%s", - HTTP_HOST, scriptname, - *scriptname == '\0' ? "" : "/", - req->q.manpath, r[0].file); - printf("\r\n" - "Content-Type: text/html; charset=utf-8\r\n" - "\r\n"); + printf("Status: 303 See Other\r\n" + "Location: /"); + if (*scriptname != '\0') + printf("%s/", scriptname); + if (strcmp(req->q.manpath, req->p[0])) + printf("%s/", req->q.manpath); + printf("%s\r\n" + "Content-Type: text/html; charset=utf-8\r\n\r\n", + r[0].file); return; } - resp_begin_html(200, NULL); - resp_searchform(req, - req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY); - - if (sz > 1) { - puts("

"); - puts(""); - - for (i = 0; i < sz; i++) { - printf("\n" - "\n" - "\n" - ""); - } - - puts("

\n" - "q.manpath, r[i].file); - printf("\">"); - html_print(r[i].names); - printf("\n" - "

"); - html_print(r[i].output); - puts("

\n" - "

"); - } - /* * In man(1) mode, show one of the pages * even if more than one is found. */ + iuse = 0; if (req->q.equal || sz == 1) { - puts("

"); - iuse = 0; priouse = 20; archpriouse = 3; for (i = 0; i < sz; i++) { @@ -643,6 +673,36 @@ pg_searchres(const struct req *req, struct manpage *r, priouse = prio; iuse = i; } + resp_begin_html(200, NULL, r[iuse].file); + } else + resp_begin_html(200, NULL, NULL); + + resp_searchform(req, + req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY); + + if (sz > 1) { + puts(""); + for (i = 0; i < sz; i++) { + printf(" \n" + " \n" + " \n" + " "); + } + puts("

" + "q.manpath, req->p[0])) + printf("%s/", req->q.manpath); + printf("%s\">", r[i].file); + html_print(r[i].names); + printf("	"); + html_print(r[i].output); + puts("

"); + } + + if (req->q.equal || sz == 1) { + puts("

"); resp_show(req, r[iuse].file); } @@ -791,7 +851,7 @@ resp_format(const struct req *req, const char *file) { struct manoutput conf; struct mparse *mp; - struct roff_man *man; + struct roff_meta *meta; void *vp; int fd; int usepath; @@ -802,40 +862,31 @@ resp_format(const struct req *req, const char *file) } mchars_alloc(); - mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1, - MANDOCLEVEL_BADARG, NULL, req->q.manpath); + mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1 | + MPARSE_VALIDATE, MANDOC_OS_OTHER, req->q.manpath); mparse_readfd(mp, fd, file); close(fd); + meta = mparse_result(mp); memset(&conf, 0, sizeof(conf)); conf.fragment = 1; + conf.style = mandoc_strdup(CSS_DIR "/mandoc.css"); usepath = strcmp(req->q.manpath, req->p[0]); - mandoc_asprintf(&conf.man, "/%s%s%%N.%%S", + mandoc_asprintf(&conf.man, "/%s%s%s%s%%N.%%S", + scriptname, *scriptname == '\0' ? "" : "/", usepath ? req->q.manpath : "", usepath ? "/" : ""); - mparse_result(mp, &man, NULL); - if (man == NULL) { - warnx("fatal mandoc error: %s/%s", req->q.manpath, file); - pg_error_internal(); - mparse_free(mp); - mchars_free(); - return; - } - vp = html_alloc(&conf); + if (meta->macroset == MACROSET_MDOC) + html_mdoc(vp, meta); + else + html_man(vp, meta); - if (man->macroset == MACROSET_MDOC) { - mdoc_validate(man); - html_mdoc(vp, man); - } else { - man_validate(man); - html_man(vp, man); - } - html_free(vp); mparse_free(mp); mchars_free(); free(conf.man); + free(conf.style); } static void @@ -892,7 +943,7 @@ pg_show(struct req *req, const char *fullpath) return; } - resp_begin_html(200, NULL); + resp_begin_html(200, NULL, file); resp_searchform(req, FOCUS_NONE); resp_show(req, file); resp_end_html(); @@ -962,10 +1013,15 @@ pg_search(const struct req *req) } } - 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."); + res = NULL; + ressz = 0; + if (req->isquery && req->q.equal && argc == 1) + pg_redirect(req, argv[0]); + else if (mansearch(&search, &paths, argc, argv, &res, &ressz) == 0) + pg_noresult(req, 400, "Bad Request", + "You entered an invalid query."); + else if (ressz == 0) + pg_noresult(req, 404, "Not Found", "No results found."); else pg_searchres(req, res, ressz); @@ -984,6 +1040,22 @@ main(void) const char *querystring; int i; +#if HAVE_PLEDGE + /* + * The "rpath" pledge could be revoked after mparse_readfd() + * if the file desciptor to "/footer.html" would be opened + * up front, but it's probably not worth the complication + * of the code it would cause: it would require scattering + * pledge() calls in multiple low-level resp_*() functions. + */ + + if (pledge("stdio rpath", NULL) == -1) { + warn("pledge"); + pg_error_internal(); + return EXIT_FAILURE; + } +#endif + /* Poor man's ReDoS mitigation. */ itimer.it_value.tv_sec = 2; @@ -1021,7 +1093,8 @@ main(void) if (*path != '\0') { parse_path_info(&req, path); - if (req.q.manpath == NULL || access(path, F_OK) == -1) + if (req.q.manpath == NULL || req.q.sec == NULL || + *req.q.query == '\0' || access(path, F_OK) == -1) path = ""; } else if ((querystring = getenv("QUERY_STRING")) != NULL) parse_query_string(&req, querystring); @@ -1036,7 +1109,7 @@ main(void) return EXIT_FAILURE; } - if ( ! (NULL == req.q.arch || validate_urifrag(req.q.arch))) { + if (req.q.arch != NULL && validate_arch(req.q.arch) == 0) { pg_error_badrequest( "You specified an invalid architecture."); return EXIT_FAILURE; @@ -1062,80 +1135,74 @@ main(void) } /* - * If PATH_INFO is not a file name, translate it to a query. + * Translate PATH_INFO to a query. */ static void parse_path_info(struct req *req, const char *path) { - char *dir[4]; - int i; + const char *name, *sec, *end; req->isquery = 0; req->q.equal = 1; - req->q.manpath = mandoc_strdup(path); + req->q.manpath = NULL; req->q.arch = NULL; /* Mandatory manual page name. */ - if ((req->q.query = strrchr(req->q.manpath, '/')) == NULL) { - req->q.query = req->q.manpath; - req->q.manpath = NULL; - } else - *req->q.query++ = '\0'; + if ((name = strrchr(path, '/')) == NULL) + name = path; + else + name++; /* Optional trailing section. */ - if ((req->q.sec = strrchr(req->q.query, '.')) != NULL) { - if(isdigit((unsigned char)req->q.sec[1])) { - *req->q.sec++ = '\0'; - req->q.sec = mandoc_strdup(req->q.sec); - } else - req->q.sec = NULL; + sec = strrchr(name, '.'); + if (sec != NULL && isdigit((unsigned char)*++sec)) { + req->q.query = mandoc_strndup(name, sec - name - 1); + req->q.sec = mandoc_strdup(sec); + } else { + req->q.query = mandoc_strdup(name); + req->q.sec = NULL; } /* Handle the case of name[.section] only. */ - if (req->q.manpath == NULL) + if (name == path) return; - req->q.query = mandoc_strdup(req->q.query); - /* Split directory components. */ - dir[i = 0] = req->q.manpath; - while ((dir[i + 1] = strchr(dir[i], '/')) != NULL) { - if (++i == 3) { - pg_error_badrequest( - "You specified too many directory components."); - exit(EXIT_FAILURE); - } - *dir[i]++ = '\0'; - } - /* Optional manpath. */ - if ((i = validate_manpath(req, req->q.manpath)) == 0) + end = strchr(path, '/'); + req->q.manpath = mandoc_strndup(path, end - path); + if (validate_manpath(req, req->q.manpath)) { + path = end + 1; + if (name == path) + return; + } else { + free(req->q.manpath); req->q.manpath = NULL; - else if (dir[1] == NULL) - return; + } /* Optional section. */ - if (strncmp(dir[i], "man", 3) == 0) { + if (strncmp(path, "man", 3) == 0 || strncmp(path, "cat", 3) == 0) { + path += 3; + end = strchr(path, '/'); free(req->q.sec); - req->q.sec = mandoc_strdup(dir[i++] + 3); + req->q.sec = mandoc_strndup(path, end - path); + path = end + 1; + if (name == path) + return; } - if (dir[i] == NULL) { - if (req->q.manpath == NULL) - free(dir[0]); - return; + + /* Optional architecture. */ + end = strchr(path, '/'); + if (end + 1 != name) { + pg_error_badrequest( + "You specified too many directory components."); + exit(EXIT_FAILURE); } - if (dir[i + 1] != NULL) { + req->q.arch = mandoc_strndup(path, end - path); + if (validate_arch(req->q.arch) == 0) { pg_error_badrequest( "You specified an invalid directory component."); exit(EXIT_FAILURE); } - - /* Optional architecture. */ - if (i) { - req->q.arch = mandoc_strdup(dir[i]); - if (req->q.manpath == NULL) - free(dir[0]); - } else - req->q.arch = dir[0]; } /*