2 * uhttpd - Tiny single-threaded httpd
4 * Copyright (C) 2010-2013 Jo-Philipp Wich <xm@subsignal.org>
5 * Copyright (C) 2013 Felix Fietkau <nbd@openwrt.org>
7 * Permission to use, copy, modify, and/or distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #define _DARWIN_C_SOURCE
22 #define _XOPEN_SOURCE 700
24 #include <sys/types.h>
31 #include <libubox/blobmsg.h>
34 #include "mimetypes.h"
36 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
38 static LIST_HEAD(index_files);
39 static LIST_HEAD(dispatch_handlers);
40 static LIST_HEAD(pending_requests);
41 static int n_requests;
43 struct deferred_request {
44 struct list_head list;
45 struct dispatch_handler *d;
52 struct list_head list;
58 HDR_IF_MODIFIED_SINCE,
59 HDR_IF_UNMODIFIED_SINCE,
66 void uh_index_add(const char *filename)
68 struct index_file *idx;
70 idx = calloc(1, sizeof(*idx));
72 list_add_tail(&idx->list, &index_files);
75 static char * canonpath(const char *path, char *path_resolved)
77 const char *path_cpy = path;
78 char *path_res = path_resolved;
81 return realpath(path, path_resolved);
84 while ((*path_cpy != '\0') && (path_cpy < (path + PATH_MAX - 2))) {
88 /* skip repeating / */
89 if (path_cpy[1] == '/') {
95 if (path_cpy[1] == '.') {
97 if ((path_cpy[2] == '/') || (path_cpy[2] == '\0')) {
102 /* collapse /x/../ */
103 if ((path_cpy[2] == '.') &&
104 ((path_cpy[3] == '/') || (path_cpy[3] == '\0'))) {
105 while ((path_res > path_resolved) && (*--path_res != '/'));
113 *path_res++ = *path_cpy++;
116 /* remove trailing slash if not root / */
117 if ((path_res > (path_resolved+1)) && (path_res[-1] == '/'))
119 else if (path_res == path_resolved)
124 return path_resolved;
127 /* Returns NULL on error.
128 ** NB: improperly encoded URL should give client 400 [Bad Syntax]; returning
129 ** NULL here causes 404 [Not Found], but that's not too unreasonable. */
130 static struct path_info *
131 uh_path_lookup(struct client *cl, const char *url)
133 static char path_phys[PATH_MAX];
134 static char path_info[PATH_MAX];
135 static struct path_info p;
137 const char *docroot = conf.docroot;
138 int docroot_len = strlen(docroot);
139 char *pathptr = NULL;
145 struct index_file *idx;
147 /* back out early if url is undefined */
151 memset(&p, 0, sizeof(p));
155 strcpy(uh_buf, docroot);
157 /* separate query string from url */
158 if ((pathptr = strchr(url, '?')) != NULL) {
159 p.query = pathptr[1] ? pathptr + 1 : NULL;
161 /* urldecode component w/o query */
163 if (uh_urldecode(&uh_buf[docroot_len],
164 sizeof(uh_buf) - docroot_len - 1,
165 url, pathptr - url ) < 0)
170 /* no query string, decode all of url */
171 else if (uh_urldecode(&uh_buf[docroot_len],
172 sizeof(uh_buf) - docroot_len - 1,
173 url, strlen(url) ) < 0)
176 /* create canon path */
177 len = strlen(uh_buf);
178 slash = len && uh_buf[len - 1] == '/';
179 len = min(len, sizeof(path_phys) - 1);
181 for (i = len; i >= 0; i--) {
185 if (ch != 0 && ch != '/')
189 exists = !!canonpath(uh_buf, path_phys);
195 /* test current path */
196 if (stat(path_phys, &p.stat))
199 snprintf(path_info, sizeof(path_info), "%s", uh_buf + i);
203 /* check whether found path is within docroot */
204 if (strncmp(path_phys, docroot, docroot_len) != 0 ||
205 (path_phys[docroot_len] != 0 &&
206 path_phys[docroot_len] != '/'))
209 /* is a regular file */
210 if (p.stat.st_mode & S_IFREG) {
213 p.name = &path_phys[docroot_len];
214 p.info = path_info[0] ? path_info : NULL;
218 if (!(p.stat.st_mode & S_IFDIR))
224 pathptr = path_phys + strlen(path_phys);
226 /* ensure trailing slash */
227 if (pathptr[-1] != '/') {
233 /* if requested url resolves to a directory and a trailing slash
234 is missing in the request url, redirect the client to the same
235 url with trailing slash appended */
237 uh_http_header(cl, 302, "Found");
238 ustream_printf(cl->us, "Content-Length: 0\r\n");
239 ustream_printf(cl->us, "Location: %s%s%s\r\n\r\n",
240 &path_phys[docroot_len],
242 p.query ? p.query : "");
248 /* try to locate index file */
249 len = path_phys + sizeof(path_phys) - pathptr - 1;
250 list_for_each_entry(idx, &index_files, list) {
251 if (strlen(idx->name) > len)
254 strcpy(pathptr, idx->name);
255 if (!stat(path_phys, &s) && (s.st_mode & S_IFREG)) {
256 memcpy(&p.stat, &s, sizeof(p.stat));
265 p.name = &path_phys[docroot_len];
267 return p.phys ? &p : NULL;
270 static const char * uh_file_mime_lookup(const char *path)
272 const struct mimetype *m = &uh_mime_types[0];
276 e = &path[strlen(path)-1];
279 if ((*e == '.' || *e == '/') && !strcasecmp(&e[1], m->extn))
288 return "application/octet-stream";
291 static const char * uh_file_mktag(struct stat *s, char *buf, int len)
293 snprintf(buf, len, "\"%" PRIx64 "-%" PRIx64 "-%" PRIx64 "\"",
294 s->st_ino, s->st_size, (uint64_t)s->st_mtime);
299 static time_t uh_file_date2unix(const char *date)
303 memset(&t, 0, sizeof(t));
305 if (strptime(date, "%a, %d %b %Y %H:%M:%S %Z", &t) != NULL)
311 static char * uh_file_unix2date(time_t ts, char *buf, int len)
313 struct tm *t = gmtime(&ts);
315 strftime(buf, len, "%a, %d %b %Y %H:%M:%S GMT", t);
320 static char *uh_file_header(struct client *cl, int idx)
322 if (!cl->dispatch.file.hdr[idx])
325 return (char *) blobmsg_data(cl->dispatch.file.hdr[idx]);
328 static void uh_file_response_ok_hdrs(struct client *cl, struct stat *s)
333 ustream_printf(cl->us, "ETag: %s\r\n", uh_file_mktag(s, buf, sizeof(buf)));
334 ustream_printf(cl->us, "Last-Modified: %s\r\n",
335 uh_file_unix2date(s->st_mtime, buf, sizeof(buf)));
337 ustream_printf(cl->us, "Date: %s\r\n",
338 uh_file_unix2date(time(NULL), buf, sizeof(buf)));
341 static void uh_file_response_200(struct client *cl, struct stat *s)
343 uh_http_header(cl, 200, "OK");
344 return uh_file_response_ok_hdrs(cl, s);
347 static void uh_file_response_304(struct client *cl, struct stat *s)
349 uh_http_header(cl, 304, "Not Modified");
351 return uh_file_response_ok_hdrs(cl, s);
354 static void uh_file_response_412(struct client *cl)
356 uh_http_header(cl, 412, "Precondition Failed");
359 static bool uh_file_if_match(struct client *cl, struct stat *s)
362 const char *tag = uh_file_mktag(s, buf, sizeof(buf));
363 char *hdr = uh_file_header(cl, HDR_IF_MATCH);
371 for (i = 0; i < strlen(hdr); i++)
373 if ((hdr[i] == ' ') || (hdr[i] == ',')) {
376 } else if (!strcmp(p, "*") || !strcmp(p, tag)) {
381 uh_file_response_412(cl);
385 static int uh_file_if_modified_since(struct client *cl, struct stat *s)
387 char *hdr = uh_file_header(cl, HDR_IF_MODIFIED_SINCE);
392 if (uh_file_date2unix(hdr) >= s->st_mtime) {
393 uh_file_response_304(cl, s);
400 static int uh_file_if_none_match(struct client *cl, struct stat *s)
403 const char *tag = uh_file_mktag(s, buf, sizeof(buf));
404 char *hdr = uh_file_header(cl, HDR_IF_NONE_MATCH);
412 for (i = 0; i < strlen(hdr); i++) {
413 if ((hdr[i] == ' ') || (hdr[i] == ',')) {
416 } else if (!strcmp(p, "*") || !strcmp(p, tag)) {
417 if ((cl->request.method == UH_HTTP_MSG_GET) ||
418 (cl->request.method == UH_HTTP_MSG_HEAD))
419 uh_file_response_304(cl, s);
421 uh_file_response_412(cl);
430 static int uh_file_if_range(struct client *cl, struct stat *s)
432 char *hdr = uh_file_header(cl, HDR_IF_RANGE);
435 uh_file_response_412(cl);
442 static int uh_file_if_unmodified_since(struct client *cl, struct stat *s)
444 char *hdr = uh_file_header(cl, HDR_IF_UNMODIFIED_SINCE);
446 if (hdr && uh_file_date2unix(hdr) <= s->st_mtime) {
447 uh_file_response_412(cl);
454 static int dirent_cmp(const struct dirent **a, const struct dirent **b)
456 bool dir_a = !!((*a)->d_type & DT_DIR);
457 bool dir_b = !!((*b)->d_type & DT_DIR);
459 /* directories first */
461 return dir_b - dir_a;
463 return alphasort(a, b);
466 static void list_entries(struct client *cl, struct dirent **files, int count,
467 const char *path, char *local_path)
469 const char *suffix = "/";
470 const char *type = "directory";
471 unsigned int mode = S_IXOTH;
477 file = local_path + strlen(local_path);
478 for (i = 0; i < count; i++) {
479 const char *name = files[i]->d_name;
480 bool dir = !!(files[i]->d_type & DT_DIR);
482 if (name[0] == '.' && name[1] == 0)
485 sprintf(file, "%s", name);
486 if (stat(local_path, &s))
492 type = uh_file_mime_lookup(local_path);
495 if (!(s.st_mode & mode))
499 "<li><strong><a href='%s%s%s'>%s</a>%s"
500 "</strong><br /><small>modified: %s"
501 "<br />%s - %.02f kbyte<br />"
502 "<br /></small></li>",
505 uh_file_unix2date(s.st_mtime, buf, sizeof(buf)),
506 type, s.st_size / 1024.0);
514 static void uh_file_dirlist(struct client *cl, struct path_info *pi)
516 struct dirent **files = NULL;
519 uh_file_response_200(cl, NULL);
520 ustream_printf(cl->us, "Content-Type: text/html\r\n\r\n");
523 "<html><head><title>Index of %s</title></head>"
524 "<body><h1>Index of %s</h1><hr /><ol>",
527 count = scandir(pi->phys, &files, NULL, dirent_cmp);
529 strcpy(uh_buf, pi->phys);
530 list_entries(cl, files, count, pi->name, uh_buf);
534 uh_chunk_printf(cl, "</ol><hr /></body></html>");
538 static void file_write_cb(struct client *cl)
540 int fd = cl->dispatch.file.fd;
543 while (cl->us->w.data_bytes < 256) {
544 r = read(fd, uh_buf, sizeof(uh_buf));
555 uh_chunk_write(cl, uh_buf, r);
559 static void uh_file_free(struct client *cl)
561 close(cl->dispatch.file.fd);
564 static void uh_file_data(struct client *cl, struct path_info *pi, int fd)
566 /* test preconditions */
567 if (!uh_file_if_modified_since(cl, &pi->stat) ||
568 !uh_file_if_match(cl, &pi->stat) ||
569 !uh_file_if_range(cl, &pi->stat) ||
570 !uh_file_if_unmodified_since(cl, &pi->stat) ||
571 !uh_file_if_none_match(cl, &pi->stat)) {
572 ustream_printf(cl->us, "\r\n");
579 uh_file_response_200(cl, &pi->stat);
581 ustream_printf(cl->us, "Content-Type: %s\r\n",
582 uh_file_mime_lookup(pi->name));
584 ustream_printf(cl->us, "Content-Length: %" PRIu64 "\r\n\r\n",
589 if (cl->request.method == UH_HTTP_MSG_HEAD) {
595 cl->dispatch.file.fd = fd;
596 cl->dispatch.write_cb = file_write_cb;
597 cl->dispatch.free = uh_file_free;
598 cl->dispatch.close_fds = uh_file_free;
602 static bool __handle_file_request(struct client *cl, char *url);
604 static void uh_file_request(struct client *cl, const char *url,
605 struct path_info *pi, struct blob_attr **tb)
608 struct http_request *req = &cl->request;
611 if (!(pi->stat.st_mode & S_IROTH))
614 if (pi->stat.st_mode & S_IFREG) {
615 fd = open(pi->phys, O_RDONLY);
619 req->disable_chunked = true;
620 cl->dispatch.file.hdr = tb;
621 uh_file_data(cl, pi, fd);
622 cl->dispatch.file.hdr = NULL;
626 if ((pi->stat.st_mode & S_IFDIR)) {
627 if (conf.no_dirlists)
630 uh_file_dirlist(cl, pi);
635 /* check for a previously set 403 redirect status to prevent infinite
636 recursion when the error page itself lacks sufficient permissions */
637 if (conf.error_handler && req->redirect_status != 403) {
638 req->redirect_status = 403;
639 error_handler = alloca(strlen(conf.error_handler) + 1);
640 strcpy(error_handler, conf.error_handler);
641 if (__handle_file_request(cl, error_handler))
645 uh_client_error(cl, 403, "Forbidden",
646 "You don't have permission to access %s on this server.",
650 void uh_dispatch_add(struct dispatch_handler *d)
652 list_add_tail(&d->list, &dispatch_handlers);
655 static struct dispatch_handler *
656 dispatch_find(const char *url, struct path_info *pi)
658 struct dispatch_handler *d;
660 list_for_each_entry(d, &dispatch_handlers, list) {
665 if (d->check_path(pi, url))
671 if (d->check_url(url))
680 uh_invoke_script(struct client *cl, struct dispatch_handler *d, struct path_info *pi)
682 char *url = blobmsg_data(blob_data(cl->hdr.head));
685 d->handle_request(cl, url, pi);
688 static void uh_complete_request(struct client *cl)
690 struct deferred_request *dr;
694 while (!list_empty(&pending_requests)) {
695 if (n_requests >= conf.max_script_requests)
698 dr = list_first_entry(&pending_requests, struct deferred_request, list);
703 cl->dispatch.data_blocked = false;
704 uh_invoke_script(cl, dr->d, dr->path ? &dr->pi : NULL);
705 client_poll_post_data(cl);
711 uh_free_pending_request(struct client *cl)
713 struct deferred_request *dr = cl->dispatch.req_data;
716 uh_complete_request(cl);
722 static int field_len(const char *ptr)
727 return strlen(ptr) + 1;
730 #define path_info_fields \
739 uh_defer_script(struct client *cl, struct dispatch_handler *d, struct path_info *pi)
741 struct deferred_request *dr;
742 char *_root, *_phys, *_name, *_info, *_query, *_auth;
744 cl->dispatch.req_free = uh_free_pending_request;
747 /* allocate enough memory to duplicate all path_info strings in one block */
749 #define _field(_name) &_##_name, field_len(pi->_name),
750 dr = calloc_a(sizeof(*dr), path_info_fields NULL);
752 memcpy(&dr->pi, pi, sizeof(*pi));
755 /* copy all path_info strings */
757 #define _field(_name) if (pi->_name) dr->pi._name = strcpy(_##_name, pi->_name);
760 dr = calloc(1, sizeof(*dr));
763 cl->dispatch.req_data = dr;
764 cl->dispatch.data_blocked = true;
767 list_add(&dr->list, &pending_requests);
771 uh_invoke_handler(struct client *cl, struct dispatch_handler *d, char *url, struct path_info *pi)
774 return d->handle_request(cl, url, pi);
776 if (n_requests >= conf.max_script_requests)
777 return uh_defer_script(cl, d, pi);
779 cl->dispatch.req_free = uh_complete_request;
780 uh_invoke_script(cl, d, pi);
783 static bool __handle_file_request(struct client *cl, char *url)
785 static const struct blobmsg_policy hdr_policy[__HDR_MAX] = {
786 [HDR_AUTHORIZATION] = { "authorization", BLOBMSG_TYPE_STRING },
787 [HDR_IF_MODIFIED_SINCE] = { "if-modified-since", BLOBMSG_TYPE_STRING },
788 [HDR_IF_UNMODIFIED_SINCE] = { "if-unmodified-since", BLOBMSG_TYPE_STRING },
789 [HDR_IF_MATCH] = { "if-match", BLOBMSG_TYPE_STRING },
790 [HDR_IF_NONE_MATCH] = { "if-none-match", BLOBMSG_TYPE_STRING },
791 [HDR_IF_RANGE] = { "if-range", BLOBMSG_TYPE_STRING },
793 struct dispatch_handler *d;
794 struct blob_attr *tb[__HDR_MAX];
795 struct path_info *pi;
797 pi = uh_path_lookup(cl, url);
804 blobmsg_parse(hdr_policy, __HDR_MAX, tb, blob_data(cl->hdr.head), blob_len(cl->hdr.head));
805 if (tb[HDR_AUTHORIZATION])
806 pi->auth = blobmsg_data(tb[HDR_AUTHORIZATION]);
808 if (!uh_auth_check(cl, pi))
811 d = dispatch_find(url, pi);
813 uh_invoke_handler(cl, d, url, pi);
815 uh_file_request(cl, url, pi, tb);
820 static char *uh_handle_alias(char *old_url)
823 static char *new_url;
826 if (!list_empty(&conf.cgi_alias)) list_for_each_entry(alias, &conf.cgi_alias, list) {
831 if (uh_path_match(alias->alias, old_url))
835 path_len = strlen(alias->path);
837 old_len = strlen(old_url) + 1;
838 new_len = old_len + MAX(conf.cgi_prefix_len, path_len);
840 if (new_len > url_len) {
841 new_url = realloc(new_url, new_len);
848 strcpy(new_url, alias->path);
849 else if (conf.cgi_prefix)
850 strcpy(new_url, conf.cgi_prefix);
851 strcat(new_url, old_url);
858 void uh_handle_request(struct client *cl)
860 struct http_request *req = &cl->request;
861 struct dispatch_handler *d;
862 char *url = blobmsg_data(blob_data(cl->hdr.head));
865 url = uh_handle_alias(url);
867 req->redirect_status = 200;
868 d = dispatch_find(url, NULL);
870 return uh_invoke_handler(cl, d, url, NULL);
872 if (__handle_file_request(cl, url))
875 req->redirect_status = 404;
876 if (conf.error_handler) {
877 error_handler = alloca(strlen(conf.error_handler) + 1);
878 strcpy(error_handler, conf.error_handler);
879 if (__handle_file_request(cl, error_handler))
883 uh_client_error(cl, 404, "Not Found", "The requested URL %s was not found on this server.", url);