2 * uhttpd - Tiny single-threaded httpd - Main component
4 * Copyright (C) 2010 Jo-Philipp Wich <xm@subsignal.org>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
19 #define _XOPEN_SOURCE 500 /* crypt() */
22 #include "uhttpd-utils.h"
23 #include "uhttpd-file.h"
26 #include "uhttpd-cgi.h"
30 #include "uhttpd-lua.h"
34 #include "uhttpd-tls.h"
40 static void uh_sigterm(int sig)
45 static void uh_sigchld(int sig)
47 while( waitpid(-1, NULL, WNOHANG) > 0 ) { }
50 static void uh_config_parse(struct config *conf)
58 const char *path = conf->file ? conf->file : "/etc/httpd.conf";
61 if( (c = fopen(path, "r")) != NULL )
63 memset(line, 0, sizeof(line));
65 while( fgets(line, sizeof(line) - 1, c) )
67 if( (line[0] == '/') && (strchr(line, ':') != NULL) )
69 if( !(col1 = strchr(line, ':')) || (*col1++ = 0) ||
70 !(col2 = strchr(col1, ':')) || (*col2++ = 0) ||
71 !(eol = strchr(col2, '\n')) || (*eol++ = 0) )
74 if( !uh_auth_add(line, col1, col2) )
77 "Notice: No password set for user %s, ignoring "
78 "authentication on %s\n", col1, line
82 else if( !strncmp(line, "I:", 2) )
84 if( !(col1 = strchr(line, ':')) || (*col1++ = 0) ||
85 !(eol = strchr(col1, '\n')) || (*eol++ = 0) )
88 conf->index_file = strdup(col1);
90 else if( !strncmp(line, "E404:", 5) )
92 if( !(col1 = strchr(line, ':')) || (*col1++ = 0) ||
93 !(eol = strchr(col1, '\n')) || (*eol++ = 0) )
96 conf->error_handler = strdup(col1);
99 else if( (line[0] == '*') && (strchr(line, ':') != NULL) )
101 if( !(col1 = strchr(line, '*')) || (*col1++ = 0) ||
102 !(col2 = strchr(col1, ':')) || (*col2++ = 0) ||
103 !(eol = strchr(col2, '\n')) || (*eol++ = 0) )
106 if( !uh_interpreter_add(col1, col2) )
109 "Unable to add interpreter %s for extension %s: "
110 "Out of memory\n", col2, col1
121 static int uh_socket_bind(
122 fd_set *serv_fds, int *max_fd, const char *host, const char *port,
123 struct addrinfo *hints, int do_tls, struct config *conf
130 int tcp_ka_idl, tcp_ka_int, tcp_ka_cnt;
132 struct listener *l = NULL;
133 struct addrinfo *addrs = NULL, *p = NULL;
135 if( (status = getaddrinfo(host, port, hints, &addrs)) != 0 )
137 fprintf(stderr, "getaddrinfo(): %s\n", gai_strerror(status));
140 /* try to bind a new socket to each found address */
141 for( p = addrs; p; p = p->ai_next )
144 if( (sock = socket(p->ai_family, p->ai_socktype, p->ai_protocol)) == -1 )
150 /* "address already in use" */
151 if( setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes)) )
153 perror("setsockopt()");
158 if( conf->tcp_keepalive > 0 )
162 tcp_ka_int = conf->tcp_keepalive;
164 if( setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &yes, sizeof(yes)) ||
165 setsockopt(sock, SOL_TCP, TCP_KEEPIDLE, &tcp_ka_idl, sizeof(tcp_ka_idl)) ||
166 setsockopt(sock, SOL_TCP, TCP_KEEPINTVL, &tcp_ka_int, sizeof(tcp_ka_int)) ||
167 setsockopt(sock, SOL_TCP, TCP_KEEPCNT, &tcp_ka_cnt, sizeof(tcp_ka_cnt)) )
169 fprintf(stderr, "Notice: Unable to enable TCP keep-alive: %s\n",
174 /* required to get parallel v4 + v6 working */
175 if( p->ai_family == AF_INET6 )
177 if( setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, &yes, sizeof(yes)) == -1 )
179 perror("setsockopt()");
185 if( bind(sock, p->ai_addr, p->ai_addrlen) == -1 )
192 if( listen(sock, UH_LIMIT_CLIENTS) == -1 )
198 /* add listener to global list */
199 if( ! (l = uh_listener_add(sock, conf)) )
201 fprintf(stderr, "uh_listener_add(): Failed to allocate memory\n");
207 l->tls = do_tls ? conf->tls : NULL;
210 /* add socket to server fd set */
211 FD_SET(sock, serv_fds);
213 *max_fd = max(*max_fd, sock);
228 static struct http_request * uh_http_header_parse(struct client *cl, char *buffer, int buflen)
230 char *method = &buffer[0];
232 char *version = NULL;
234 char *headers = NULL;
235 char *hdrname = NULL;
236 char *hdrdata = NULL;
241 static struct http_request req;
243 memset(&req, 0, sizeof(req));
246 /* terminate initial header line */
247 if( (headers = strfind(buffer, buflen, "\r\n", 2)) != NULL )
249 buffer[buflen-1] = 0;
254 /* find request path */
255 if( (path = strchr(buffer, ' ')) != NULL )
258 /* find http version */
259 if( (path != NULL) && ((version = strchr(path, ' ')) != NULL) )
264 if( strcmp(method, "GET") && strcmp(method, "HEAD") && strcmp(method, "POST") )
267 uh_http_response(cl, 405, "Method Not Allowed");
275 req.method = UH_HTTP_MSG_GET;
279 req.method = UH_HTTP_MSG_HEAD;
283 req.method = UH_HTTP_MSG_POST;
289 if( !path || !strlen(path) )
291 /* malformed request */
292 uh_http_response(cl, 400, "Bad Request");
301 if( (version == NULL) || (strcmp(version, "HTTP/0.9") &&
302 strcmp(version, "HTTP/1.0") && strcmp(version, "HTTP/1.1")) )
304 /* unsupported version */
305 uh_http_response(cl, 400, "Bad Request");
310 req.version = strtof(&version[5], NULL);
314 /* process header fields */
315 for( i = (int)(headers - buffer); i < buflen; i++ )
317 /* found eol and have name + value, push out header tuple */
318 if( hdrname && hdrdata && (buffer[i] == '\r' || buffer[i] == '\n') )
323 if( (hdrcount + 1) < array_size(req.headers) )
325 req.headers[hdrcount++] = hdrname;
326 req.headers[hdrcount++] = hdrdata;
328 hdrname = hdrdata = NULL;
334 uh_http_response(cl, 413, "Request Entity Too Large");
339 /* have name but no value and found a colon, start of value */
340 else if( hdrname && !hdrdata &&
341 ((i+1) < buflen) && (buffer[i] == ':')
344 hdrdata = &buffer[i+1];
346 while ((hdrdata + 1) < (buffer + buflen) && *hdrdata == ' ')
350 /* have no name and found [A-Za-z], start of name */
351 else if( !hdrname && isalpha(buffer[i]) )
353 hdrname = &buffer[i];
358 req.redirect_status = 200;
362 /* Malformed request */
363 uh_http_response(cl, 400, "Bad Request");
368 static struct http_request * uh_http_header_recv(struct client *cl)
370 static char buffer[UH_LIMIT_MSGHEAD];
371 char *bufptr = &buffer[0];
374 struct timeval timeout;
378 ssize_t blen = sizeof(buffer)-1;
381 memset(buffer, 0, sizeof(buffer));
386 FD_SET(cl->socket, &reader);
388 /* fail after 0.1s */
390 timeout.tv_usec = 100000;
392 /* check whether fd is readable */
393 if( select(cl->socket + 1, &reader, NULL, NULL, &timeout) > 0 )
396 ensure_out(rlen = uh_tcp_peek(cl, bufptr, blen));
398 if( (idxptr = strfind(buffer, sizeof(buffer), "\r\n\r\n", 4)) )
400 ensure_out(rlen = uh_tcp_recv(cl, bufptr,
401 (int)(idxptr - bufptr) + 4));
403 /* header read complete ... */
405 return uh_http_header_parse(cl, buffer,
406 sizeof(buffer) - blen - 1);
410 ensure_out(rlen = uh_tcp_recv(cl, bufptr, rlen));
412 /* unexpected eof - #7904 */
422 /* invalid request (unexpected eof/timeout) */
427 /* request entity too large */
428 uh_http_response(cl, 413, "Request Entity Too Large");
434 #if defined(HAVE_LUA) || defined(HAVE_CGI)
435 static int uh_path_match(const char *prefix, const char *url)
437 if( (strstr(url, prefix) == url) &&
438 ((prefix[strlen(prefix)-1] == '/') ||
439 (strlen(url) == strlen(prefix)) ||
440 (url[strlen(prefix)] == '/'))
449 static void uh_dispatch_request(
450 struct client *cl, struct http_request *req, struct path_info *pin
453 struct interpreter *ipr = NULL;
455 if( uh_path_match(cl->server->conf->cgi_prefix, pin->name) ||
456 (ipr = uh_interpreter_lookup(pin->phys)) )
458 uh_cgi_request(cl, req, pin, ipr);
463 uh_file_request(cl, req, pin);
467 static void uh_mainloop(struct config *conf, fd_set serv_fds, int max_fd)
469 /* master file descriptor list */
470 fd_set used_fds, read_fds;
472 /* working structs */
473 struct http_request *req;
474 struct path_info *pin;
477 /* maximum file descriptor number */
478 int new_fd, cur_fd = 0;
480 /* clear the master and temp sets */
484 /* backup server descriptor set */
490 /* create a working copy of the used fd set */
493 /* sleep until socket activity */
494 if( select(max_fd + 1, &read_fds, NULL, NULL, NULL) == -1 )
500 /* run through the existing connections looking for data to be read */
501 for( cur_fd = 0; cur_fd <= max_fd; cur_fd++ )
503 /* is a socket managed by us */
504 if( FD_ISSET(cur_fd, &read_fds) )
506 /* is one of our listen sockets */
507 if( FD_ISSET(cur_fd, &serv_fds) )
509 /* handle new connections */
510 if( (new_fd = accept(cur_fd, NULL, 0)) != -1 )
512 /* add to global client list */
513 if( (cl = uh_client_add(new_fd, uh_listener_lookup(cur_fd))) != NULL )
516 /* setup client tls context */
519 if( conf->tls_accept(cl) < 1 )
522 "tls_accept failed, "
523 "connection dropped\n");
525 /* close client socket */
528 /* remove from global client list */
529 uh_client_remove(new_fd);
536 /* add client socket to global fdset */
537 FD_SET(new_fd, &used_fds);
539 max_fd = max(max_fd, new_fd);
542 /* insufficient resources */
546 "uh_client_add(): Cannot allocate memory\n");
553 /* is a client socket */
556 if( ! (cl = uh_client_lookup(cur_fd)) )
558 /* this should not happen! */
560 "uh_client_lookup(): No entry for fd %i!\n",
566 /* parse message header */
567 if( (req = uh_http_header_recv(cl)) != NULL )
569 /* RFC1918 filtering required? */
570 if( conf->rfc1918_filter &&
571 sa_rfc1918(&cl->peeraddr) &&
572 !sa_rfc1918(&cl->servaddr) )
574 uh_http_sendhf(cl, 403, "Forbidden",
575 "Rejected request from RFC1918 IP "
576 "to public server address");
581 if( conf->lua_state &&
582 uh_path_match(conf->lua_prefix, req->url) )
584 conf->lua_request(cl, req, conf->lua_state);
588 /* dispatch request */
589 if( (pin = uh_path_lookup(cl, req->url)) != NULL )
592 if( !pin->redirected && uh_auth_check(cl, req, pin) )
593 uh_dispatch_request(cl, req, pin);
599 /* Try to invoke an error handler */
600 pin = uh_path_lookup(cl, conf->error_handler);
602 if( pin && uh_auth_check(cl, req, pin) )
604 req->redirect_status = 404;
605 uh_dispatch_request(cl, req, pin);
609 uh_http_sendhf(cl, 404, "Not Found",
610 "No such file or directory");
616 /* free client tls context */
623 /* close client socket */
625 FD_CLR(cur_fd, &used_fds);
627 /* remove from global client list */
628 uh_client_remove(cur_fd);
635 /* destroy the Lua state */
636 if( conf->lua_state != NULL )
637 conf->lua_close(conf->lua_state);
642 static inline int uh_inittls(struct config *conf)
648 if( conf->tls != NULL )
651 /* load TLS plugin */
652 if( ! (lib = dlopen("uhttpd_tls.so", RTLD_LAZY | RTLD_GLOBAL)) )
655 "Notice: Unable to load TLS plugin - disabling SSL support! "
656 "(Reason: %s)\n", dlerror()
663 /* resolve functions */
664 if( !(conf->tls_init = dlsym(lib, "uh_tls_ctx_init")) ||
665 !(conf->tls_cert = dlsym(lib, "uh_tls_ctx_cert")) ||
666 !(conf->tls_key = dlsym(lib, "uh_tls_ctx_key")) ||
667 !(conf->tls_free = dlsym(lib, "uh_tls_ctx_free")) ||
668 !(conf->tls_accept = dlsym(lib, "uh_tls_client_accept")) ||
669 !(conf->tls_close = dlsym(lib, "uh_tls_client_close")) ||
670 !(conf->tls_recv = dlsym(lib, "uh_tls_client_recv")) ||
671 !(conf->tls_send = dlsym(lib, "uh_tls_client_send"))
674 "Error: Failed to lookup required symbols "
675 "in TLS plugin: %s\n", dlerror()
680 /* init SSL context */
681 if( ! (conf->tls = conf->tls_init()) )
683 fprintf(stderr, "Error: Failed to initalize SSL context\n");
692 int main (int argc, char **argv)
694 /* master file descriptor list */
697 /* working structs */
698 struct addrinfo hints;
705 /* maximum file descriptor number */
706 int cur_fd, max_fd = 0;
728 /* handle SIGPIPE, SIGINT, SIGTERM, SIGCHLD */
730 sigemptyset(&sa.sa_mask);
732 sa.sa_handler = SIG_IGN;
733 sigaction(SIGPIPE, &sa, NULL);
735 sa.sa_handler = uh_sigchld;
736 sigaction(SIGCHLD, &sa, NULL);
738 sa.sa_handler = uh_sigterm;
739 sigaction(SIGINT, &sa, NULL);
740 sigaction(SIGTERM, &sa, NULL);
744 sigaddset(&ss, SIGCHLD);
745 sigprocmask(SIG_BLOCK, &ss, NULL);
747 /* prepare addrinfo hints */
748 memset(&hints, 0, sizeof(hints));
749 hints.ai_family = AF_UNSPEC;
750 hints.ai_socktype = SOCK_STREAM;
751 hints.ai_flags = AI_PASSIVE;
754 memset(&conf, 0, sizeof(conf));
755 memset(bind, 0, sizeof(bind));
758 while( (opt = getopt(argc, argv,
759 "fSDRC:K:E:I:p:s:h:c:l:L:d:r:m:x:i:t:T:A:")) > 0
766 if( (port = strrchr(optarg, ':')) != NULL )
768 if( (optarg[0] == '[') && (port > optarg) && (port[-1] == ']') )
769 memcpy(bind, optarg + 1,
770 min(sizeof(bind), (int)(port - optarg) - 2));
773 min(sizeof(bind), (int)(port - optarg)));
785 if( uh_inittls(&conf) )
788 "Notice: TLS support is disabled, "
789 "ignoring '-s %s'\n", optarg
799 bound += uh_socket_bind(
800 &serv_fds, &max_fd, bind[0] ? bind : NULL, port,
801 &hints, (opt == 's'), &conf
804 memset(bind, 0, sizeof(bind));
810 if( !uh_inittls(&conf) )
812 if( conf.tls_cert(conf.tls, optarg) < 1 )
815 "Error: Invalid certificate file given\n");
826 if( !uh_inittls(&conf) )
828 if( conf.tls_key(conf.tls, optarg) < 1 )
831 "Error: Invalid private key file given\n");
843 if( ! realpath(optarg, conf.docroot) )
845 fprintf(stderr, "Error: Invalid directory %s: %s\n",
846 optarg, strerror(errno));
853 if( (strlen(optarg) == 0) || (optarg[0] != '/') )
855 fprintf(stderr, "Error: Invalid error handler: %s\n",
859 conf.error_handler = optarg;
864 if( (strlen(optarg) == 0) || (optarg[0] == '/') )
866 fprintf(stderr, "Error: Invalid index page: %s\n",
870 conf.index_file = optarg;
873 /* don't follow symlinks */
875 conf.no_symlinks = 1;
878 /* don't list directories */
880 conf.no_dirlists = 1;
884 conf.rfc1918_filter = 1;
890 conf.cgi_prefix = optarg;
895 if( (optarg[0] == '.') && (port = strchr(optarg, '=')) )
898 uh_interpreter_add(optarg, port);
902 fprintf(stderr, "Error: Invalid interpreter: %s\n",
912 conf.lua_prefix = optarg;
917 conf.lua_handler = optarg;
921 #if defined(HAVE_CGI) || defined(HAVE_LUA)
924 conf.script_timeout = atoi(optarg);
928 /* network timeout */
930 conf.network_timeout = atoi(optarg);
935 conf.tcp_keepalive = atoi(optarg);
945 if( (port = malloc(strlen(optarg)+1)) != NULL )
947 /* "decode" plus to space to retain compat */
948 for (opt = 0; optarg[opt]; opt++)
949 if (optarg[opt] == '+')
951 /* opt now contains strlen(optarg) -- no need to re-scan */
952 memset(port, 0, opt+1);
953 if (uh_urldecode(port, opt, optarg, opt) < 0)
954 fprintf( stderr, "uhttpd: invalid encoding\n" );
962 /* basic auth realm */
969 printf("%s\n", crypt(optarg, "$1$"));
980 "Usage: %s -p [addr:]port [-h docroot]\n"
981 " -f Do not fork to background\n"
982 " -c file Configuration file, default is '/etc/httpd.conf'\n"
983 " -p [addr:]port Bind to specified address and port, multiple allowed\n"
985 " -s [addr:]port Like -p but provide HTTPS on this port\n"
986 " -C file ASN.1 server certificate file\n"
987 " -K file ASN.1 server private key file\n"
989 " -h directory Specify the document root, default is '.'\n"
990 " -E string Use given virtual URL as 404 error handler\n"
991 " -I string Use given filename as index page for directories\n"
992 " -S Do not follow symbolic links outside of the docroot\n"
993 " -D Do not allow directory listings, send 403 instead\n"
994 " -R Enable RFC1918 filter\n"
996 " -l string URL prefix for Lua handler, default is '/lua'\n"
997 " -L file Lua handler script, omit to disable Lua\n"
1000 " -x string URL prefix for CGI handler, default is '/cgi-bin'\n"
1001 " -i .ext=path Use interpreter at path for files with the given extension\n"
1003 #if defined(HAVE_CGI) || defined(HAVE_LUA)
1004 " -t seconds CGI and Lua script timeout in seconds, default is 60\n"
1006 " -T seconds Network timeout in seconds, default is 30\n"
1007 " -d string URL decode given string\n"
1008 " -r string Specify basic auth realm\n"
1009 " -m string MD5 crypt given string\n"
1018 if( (tls == 1) && (keys < 2) )
1020 fprintf(stderr, "Error: Missing private key or certificate file\n");
1027 fprintf(stderr, "Error: No sockets bound, unable to continue\n");
1031 /* default docroot */
1032 if( !conf.docroot[0] && !realpath(".", conf.docroot) )
1034 fprintf(stderr, "Error: Can not determine default document root: %s\n",
1041 conf.realm = "Protected Area";
1044 uh_config_parse(&conf);
1046 /* default network timeout */
1047 if( conf.network_timeout <= 0 )
1048 conf.network_timeout = 30;
1050 #if defined(HAVE_CGI) || defined(HAVE_LUA)
1051 /* default script timeout */
1052 if( conf.script_timeout <= 0 )
1053 conf.script_timeout = 60;
1057 /* default cgi prefix */
1058 if( ! conf.cgi_prefix )
1059 conf.cgi_prefix = "/cgi-bin";
1063 /* load Lua plugin */
1064 if( ! (lib = dlopen("uhttpd_lua.so", RTLD_LAZY | RTLD_GLOBAL)) )
1067 "Notice: Unable to load Lua plugin - disabling Lua support! "
1068 "(Reason: %s)\n", dlerror()
1073 /* resolve functions */
1074 if( !(conf.lua_init = dlsym(lib, "uh_lua_init")) ||
1075 !(conf.lua_close = dlsym(lib, "uh_lua_close")) ||
1076 !(conf.lua_request = dlsym(lib, "uh_lua_request"))
1079 "Error: Failed to lookup required symbols "
1080 "in Lua plugin: %s\n", dlerror()
1085 /* init Lua runtime if handler is specified */
1086 if( conf.lua_handler )
1088 /* default lua prefix */
1089 if( ! conf.lua_prefix )
1090 conf.lua_prefix = "/lua";
1092 conf.lua_state = conf.lua_init(&conf);
1097 /* fork (if not disabled) */
1111 if( (cur_fd = open("/dev/null", O_WRONLY)) > -1 )
1114 if( (cur_fd = open("/dev/null", O_RDONLY)) > -1 )
1117 if( (cur_fd = open("/dev/null", O_RDONLY)) > -1 )
1127 /* server main loop */
1128 uh_mainloop(&conf, serv_fds, max_fd);
1131 /* destroy the Lua state */
1132 if( conf.lua_state != NULL )
1133 conf.lua_close(conf.lua_state);