X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/ff8805995c4600c46115ece11c83d63b9a28c1e8..5a924a1a48fa00e58c87fec9f0e6f8257855bcc0:/cgi.c
diff --git a/cgi.c b/cgi.c
index 65ca0289..91310ce4 100644
--- a/cgi.c
+++ b/cgi.c
@@ -1,7 +1,7 @@
-/* $Id: cgi.c,v 1.123 2016/04/15 00:14:17 schwarze Exp $ */
+/* $Id: cgi.c,v 1.175 2021/08/19 15:23:36 schwarze Exp $ */
/*
+ * Copyright (c) 2014-2019, 2021 Ingo Schwarze \n"
+ resp_begin_html(200, NULL, NULL);
+ resp_searchform(req, FOCUS_QUERY);
+ printf(" \n"
"This web interface is documented in the\n"
- "man.cgi\n"
+ "man.cgi(8)\n"
"manual, and the\n"
- "apropos\n"
+ "apropos(1)\n"
"manual explains the query syntax.\n"
- "
"); - puts(msg); - puts("
"); + resp_begin_html(code, http_msg, NULL); + resp_searchform(req, FOCUS_QUERY); + puts(""); + puts(user_msg); + puts("
"); resp_end_html(); } @@ -534,24 +585,43 @@ static void pg_error_badrequest(const char *msg) { - resp_begin_html(400, "Bad Request"); - puts("\n"); + resp_begin_html(400, "Bad Request", NULL); + puts("
\n"); puts(msg); printf("Try again from the\n" - "main page.\n" - "
", scriptname); + "main page.\n" + "", scriptname); resp_end_html(); } static void pg_error_internal(void) { - resp_begin_html(500, "Internal Server Error"); - puts("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) { @@ -564,7 +634,7 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz) for (i = 0; i < sz; i++) { if (validate_filename(r[i].file)) continue; - fprintf(stderr, "invalid filename %s in %s database\n", + warnx("invalid filename %s in %s database", r[i].file, req->q.manpath); pg_error_internal(); return; @@ -575,52 +645,25 @@ pg_searchres(const struct req *req, struct manpage *r, size_t sz) * 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); - - if (sz > 1) { - puts("\n" - "q.manpath, r[i].file); - printf("\">"); - html_print(r[i].names); - printf("\n" - " | \n" - ""); - html_print(r[i].output); - puts(" | \n" - "
" + "q.manpath, req->p[0])) + printf("%s/", req->q.manpath); + printf("%s\">", r[i].file); + html_print(r[i].names); + printf(" | \n" + ""); + html_print(r[i].output); + puts(" | \n" + "
You specified an invalid manual file.
"); + puts("You specified an invalid manual file.
"); return; } - puts(""); + puts("\n" + "\n" + ""); + puts(""); p = NULL; sz = 0; @@ -701,9 +774,9 @@ catman(const struct req *req, const char *file) if ('\b' != p[i + 1]) { if (italic) - printf(""); + printf(""); if (bold) - printf(""); + printf(""); italic = bold = 0; html_putchar(p[i]); continue; @@ -714,9 +787,9 @@ catman(const struct req *req, const char *file) if ('_' == p[i]) { if (bold) - printf(""); + printf(""); if ( ! italic) - printf(""); + printf(""); bold = 0; italic = 1; i += 2; @@ -738,9 +811,9 @@ catman(const struct req *req, const char *file) ('*' == p[i] && '|' == p[i + 2]) || ('|' == p[i] && '*' == p[i + 2])) { if (italic) - printf(""); + printf(""); if (bold) - printf(""); + printf(""); italic = bold = 0; putchar('*'); i += 2; @@ -752,9 +825,9 @@ catman(const struct req *req, const char *file) ('+' == p[i] && '|' == p[i + 1]) || ('|' == p[i] && '+' == p[i + 1])) { if (italic) - printf(""); + printf(""); if (bold) - printf(""); + printf(""); italic = bold = 0; putchar('+'); i += 2; @@ -764,9 +837,9 @@ catman(const struct req *req, const char *file) /* Bold mode. */ if (italic) - printf(""); + printf(""); if ( ! bold) - printf(""); + printf(""); bold = 1; italic = 0; i += 2; @@ -779,9 +852,9 @@ catman(const struct req *req, const char *file) */ if (italic) - printf(""); + printf(""); if (bold) - printf(""); + printf(""); if (i == len - 1 && p[i] != '\n') html_putchar(p[i]); @@ -790,62 +863,53 @@ catman(const struct req *req, const char *file) } free(p); - puts("\n" - "
You specified an invalid manual file.
"); + puts("You specified an invalid manual file.
"); return; } mchars_alloc(); - mp = mparse_alloc(MPARSE_SO, 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) { - fprintf(stderr, "fatal mandoc error: %s/%s\n", - req->q.manpath, file); - pg_error_internal(); - mparse_free(mp); - mchars_free(); - return; - } - vp = html_alloc(&conf); - - if (man->macroset == MACROSET_MDOC) { - mdoc_validate(man); - html_mdoc(vp, man); - } else { - man_validate(man); - html_man(vp, man); - } + if (meta->macroset == MACROSET_MDOC) + html_mdoc(vp, meta); + else + html_man(vp, meta); html_free(vp); mparse_free(mp); mchars_free(); free(conf.man); + free(conf.style); } static void @@ -856,9 +920,9 @@ resp_show(const struct req *req, const char *file) file += 2; if ('c' == *file) - catman(req, file); + resp_catman(req, file); else - format(req, file); + resp_format(req, file); } static void @@ -889,18 +953,12 @@ pg_show(struct req *req, const char *fullpath) */ if (chdir(manpath) == -1) { - fprintf(stderr, "chdir %s: %s\n", - manpath, strerror(errno)); + warn("chdir %s", manpath); pg_error_internal(); free(manpath); return; } - - if (strcmp(manpath, "mandoc")) { - free(req->q.manpath); - req->q.manpath = manpath; - } else - free(manpath); + free(manpath); if ( ! validate_filename(file)) { pg_error_badrequest( @@ -908,8 +966,8 @@ pg_show(struct req *req, const char *fullpath) return; } - resp_begin_html(200, NULL); - resp_searchform(req); + resp_begin_html(200, NULL, file); + resp_searchform(req, FOCUS_NONE); resp_show(req, file); resp_end_html(); } @@ -931,9 +989,8 @@ pg_search(const struct req *req) * relative to the manpath root. */ - if (-1 == (chdir(req->q.manpath))) { - fprintf(stderr, "chdir %s: %s\n", - req->q.manpath, strerror(errno)); + if (chdir(req->q.manpath) == -1) { + warn("chdir %s", req->q.manpath); pg_error_internal(); return; } @@ -979,10 +1036,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); @@ -1001,6 +1063,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; @@ -1008,7 +1086,7 @@ main(void) 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)); + warn("setitimer"); pg_error_internal(); return EXIT_FAILURE; } @@ -1019,16 +1097,15 @@ main(void) * relative to the same position. */ - if (-1 == chdir(MAN_DIR)) { - fprintf(stderr, "MAN_DIR: %s: %s\n", - MAN_DIR, strerror(errno)); + if (chdir(MAN_DIR) == -1) { + warn("MAN_DIR: %s", MAN_DIR); pg_error_internal(); return EXIT_FAILURE; } memset(&req, 0, sizeof(struct req)); req.q.equal = 1; - pathgen(&req); + parse_manpath_conf(&req); /* Parse the path info and the query string. */ @@ -1037,11 +1114,13 @@ main(void) else if (*path == '/') path++; - if (*path != '\0' && access(path, F_OK) == -1) { - path_parse(&req, path); - path = ""; + if (*path != '\0') { + parse_path_info(&req, path); + 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) - http_parse(&req, querystring); + parse_query_string(&req, querystring); /* Validate parsed data and add defaults. */ @@ -1053,7 +1132,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; @@ -1079,58 +1158,73 @@ main(void) } /* - * If PATH_INFO is not a file name, translate it to a query. + * Translate PATH_INFO to a query. */ static void -path_parse(struct req *req, const char *path) +parse_path_info(struct req *req, const char *path) { - int dir_done; + 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) { - req->q.arch = NULL; + if (name == path) return; + + /* Optional manpath. */ + 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; } - req->q.query = mandoc_strdup(req->q.query); - /* Optional architecture. */ - dir_done = 0; - for (;;) { - if ((req->q.arch = strrchr(req->q.manpath, '/')) == NULL) - break; - *req->q.arch++ = '\0'; - if (dir_done || strncmp(req->q.arch, "man", 3)) { - req->q.arch = mandoc_strdup(req->q.arch); - break; - } + /* Optional section. */ + if (strncmp(path, "man", 3) == 0 || strncmp(path, "cat", 3) == 0) { + path += 3; + end = strchr(path, '/'); + free(req->q.sec); + req->q.sec = mandoc_strndup(path, end - path); + path = end + 1; + if (name == path) + return; + } - /* Optional directory name. */ - req->q.arch += 3; - if (*req->q.arch != '\0') { - free(req->q.sec); - req->q.sec = mandoc_strdup(req->q.arch); - } - dir_done = 1; + /* Optional architecture. */ + end = strchr(path, '/'); + if (end + 1 != name) { + pg_error_badrequest( + "You specified too many directory components."); + exit(EXIT_FAILURE); + } + 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); } } @@ -1138,16 +1232,15 @@ path_parse(struct req *req, const char *path) * Scan for indexable paths. */ static void -pathgen(struct req *req) +parse_manpath_conf(struct req *req) { FILE *fp; char *dp; size_t dpsz; ssize_t len; - if (NULL == (fp = fopen("manpath.conf", "r"))) { - fprintf(stderr, "%s/manpath.conf: %s\n", - MAN_DIR, strerror(errno)); + if ((fp = fopen("manpath.conf", "r")) == NULL) { + warn("%s/manpath.conf", MAN_DIR); pg_error_internal(); exit(EXIT_FAILURE); } @@ -1161,14 +1254,14 @@ pathgen(struct req *req) req->p = mandoc_realloc(req->p, (req->psz + 1) * sizeof(char *)); if ( ! validate_urifrag(dp)) { - fprintf(stderr, "%s/manpath.conf contains " - "unsafe path \"%s\"\n", MAN_DIR, dp); + warnx("%s/manpath.conf contains " + "unsafe path \"%s\"", MAN_DIR, dp); pg_error_internal(); exit(EXIT_FAILURE); } - if (NULL != strchr(dp, '/')) { - fprintf(stderr, "%s/manpath.conf contains " - "path with slash \"%s\"\n", MAN_DIR, dp); + if (strchr(dp, '/') != NULL) { + warnx("%s/manpath.conf contains " + "path with slash \"%s\"", MAN_DIR, dp); pg_error_internal(); exit(EXIT_FAILURE); } @@ -1178,8 +1271,8 @@ pathgen(struct req *req) } free(dp); - if ( req->p == NULL ) { - fprintf(stderr, "%s/manpath.conf is empty\n", MAN_DIR); + if (req->p == NULL) { + warnx("%s/manpath.conf is empty", MAN_DIR); pg_error_internal(); exit(EXIT_FAILURE); }