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
134 struct listener *l = NULL;
135 struct addrinfo *addrs = NULL, *p = NULL;
137 if( (status = getaddrinfo(host, port, hints, &addrs)) != 0 )
139 fprintf(stderr, "getaddrinfo(): %s\n", gai_strerror(status));
142 /* try to bind a new socket to each found address */
143 for( p = addrs; p; p = p->ai_next )
146 if( (sock = socket(p->ai_family, p->ai_socktype, p->ai_protocol)) == -1 )
152 /* "address already in use" */
153 if( setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes)) )
155 perror("setsockopt()");
160 if( setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &yes, sizeof(yes)) ||
161 setsockopt(sock, SOL_TCP, TCP_KEEPIDLE, &tcp_ka_idl, sizeof(tcp_ka_idl)) ||
162 setsockopt(sock, SOL_TCP, TCP_KEEPINTVL, &tcp_ka_int, sizeof(tcp_ka_int)) ||
163 setsockopt(sock, SOL_TCP, TCP_KEEPCNT, &tcp_ka_cnt, sizeof(tcp_ka_cnt)) )
165 fprintf(stderr, "Notice: Unable to enable TCP keep-alive: %s\n",
169 /* required to get parallel v4 + v6 working */
170 if( p->ai_family == AF_INET6 )
172 if( setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, &yes, sizeof(yes)) == -1 )
174 perror("setsockopt()");
180 if( bind(sock, p->ai_addr, p->ai_addrlen) == -1 )
187 if( listen(sock, UH_LIMIT_CLIENTS) == -1 )
193 /* add listener to global list */
194 if( ! (l = uh_listener_add(sock, conf)) )
196 fprintf(stderr, "uh_listener_add(): Failed to allocate memory\n");
202 l->tls = do_tls ? conf->tls : NULL;
205 /* add socket to server fd set */
206 FD_SET(sock, serv_fds);
208 *max_fd = max(*max_fd, sock);
223 static struct http_request * uh_http_header_parse(struct client *cl, char *buffer, int buflen)
225 char *method = &buffer[0];
227 char *version = NULL;
229 char *headers = NULL;
230 char *hdrname = NULL;
231 char *hdrdata = NULL;
236 static struct http_request req;
238 memset(&req, 0, sizeof(req));
241 /* terminate initial header line */
242 if( (headers = strfind(buffer, buflen, "\r\n", 2)) != NULL )
244 buffer[buflen-1] = 0;
249 /* find request path */
250 if( (path = strchr(buffer, ' ')) != NULL )
253 /* find http version */
254 if( (path != NULL) && ((version = strchr(path, ' ')) != NULL) )
259 if( strcmp(method, "GET") && strcmp(method, "HEAD") && strcmp(method, "POST") )
262 uh_http_response(cl, 405, "Method Not Allowed");
270 req.method = UH_HTTP_MSG_GET;
274 req.method = UH_HTTP_MSG_HEAD;
278 req.method = UH_HTTP_MSG_POST;
284 if( !path || !strlen(path) )
286 /* malformed request */
287 uh_http_response(cl, 400, "Bad Request");
296 if( (version == NULL) || (strcmp(version, "HTTP/0.9") &&
297 strcmp(version, "HTTP/1.0") && strcmp(version, "HTTP/1.1")) )
299 /* unsupported version */
300 uh_http_response(cl, 400, "Bad Request");
305 req.version = strtof(&version[5], NULL);
309 /* process header fields */
310 for( i = (int)(headers - buffer); i < buflen; i++ )
312 /* found eol and have name + value, push out header tuple */
313 if( hdrname && hdrdata && (buffer[i] == '\r' || buffer[i] == '\n') )
318 if( (hdrcount + 1) < array_size(req.headers) )
320 req.headers[hdrcount++] = hdrname;
321 req.headers[hdrcount++] = hdrdata;
323 hdrname = hdrdata = NULL;
329 uh_http_response(cl, 413, "Request Entity Too Large");
334 /* have name but no value and found a colon, start of value */
335 else if( hdrname && !hdrdata && ((i+2) < buflen) &&
336 (buffer[i] == ':') && (buffer[i+1] == ' ')
339 hdrdata = &buffer[i+2];
342 /* have no name and found [A-Z], start of name */
343 else if( !hdrname && isalpha(buffer[i]) && isupper(buffer[i]) )
345 hdrname = &buffer[i];
350 req.redirect_status = 200;
354 /* Malformed request */
355 uh_http_response(cl, 400, "Bad Request");
360 static struct http_request * uh_http_header_recv(struct client *cl)
362 static char buffer[UH_LIMIT_MSGHEAD];
363 char *bufptr = &buffer[0];
366 struct timeval timeout;
370 ssize_t blen = sizeof(buffer)-1;
373 memset(buffer, 0, sizeof(buffer));
378 FD_SET(cl->socket, &reader);
380 /* fail after 0.1s */
382 timeout.tv_usec = 100000;
384 /* check whether fd is readable */
385 if( select(cl->socket + 1, &reader, NULL, NULL, &timeout) > 0 )
388 ensure_out(rlen = uh_tcp_peek(cl, bufptr, blen));
390 if( (idxptr = strfind(buffer, sizeof(buffer), "\r\n\r\n", 4)) )
392 ensure_out(rlen = uh_tcp_recv(cl, bufptr,
393 (int)(idxptr - bufptr) + 4));
395 /* header read complete ... */
397 return uh_http_header_parse(cl, buffer,
398 sizeof(buffer) - blen - 1);
402 ensure_out(rlen = uh_tcp_recv(cl, bufptr, rlen));
410 /* invalid request (unexpected eof/timeout) */
415 /* request entity too large */
416 uh_http_response(cl, 413, "Request Entity Too Large");
422 #if defined(HAVE_LUA) || defined(HAVE_CGI)
423 static int uh_path_match(const char *prefix, const char *url)
425 if( (strstr(url, prefix) == url) &&
426 ((prefix[strlen(prefix)-1] == '/') ||
427 (strlen(url) == strlen(prefix)) ||
428 (url[strlen(prefix)] == '/'))
437 static void uh_dispatch_request(
438 struct client *cl, struct http_request *req, struct path_info *pin
441 struct interpreter *ipr = NULL;
443 if( uh_path_match(cl->server->conf->cgi_prefix, pin->name) ||
444 (ipr = uh_interpreter_lookup(pin->phys)) )
446 uh_cgi_request(cl, req, pin, ipr);
451 uh_file_request(cl, req, pin);
455 static void uh_mainloop(struct config *conf, fd_set serv_fds, int max_fd)
457 /* master file descriptor list */
458 fd_set used_fds, read_fds;
460 /* working structs */
461 struct http_request *req;
462 struct path_info *pin;
465 /* maximum file descriptor number */
466 int new_fd, cur_fd = 0;
468 /* clear the master and temp sets */
472 /* backup server descriptor set */
478 /* create a working copy of the used fd set */
481 /* sleep until socket activity */
482 if( select(max_fd + 1, &read_fds, NULL, NULL, NULL) == -1 )
488 /* run through the existing connections looking for data to be read */
489 for( cur_fd = 0; cur_fd <= max_fd; cur_fd++ )
491 /* is a socket managed by us */
492 if( FD_ISSET(cur_fd, &read_fds) )
494 /* is one of our listen sockets */
495 if( FD_ISSET(cur_fd, &serv_fds) )
497 /* handle new connections */
498 if( (new_fd = accept(cur_fd, NULL, 0)) != -1 )
500 /* add to global client list */
501 if( (cl = uh_client_add(new_fd, uh_listener_lookup(cur_fd))) != NULL )
504 /* setup client tls context */
506 conf->tls_accept(cl);
509 /* add client socket to global fdset */
510 FD_SET(new_fd, &used_fds);
512 max_fd = max(max_fd, new_fd);
515 /* insufficient resources */
519 "uh_client_add(): Cannot allocate memory\n");
526 /* is a client socket */
529 if( ! (cl = uh_client_lookup(cur_fd)) )
531 /* this should not happen! */
533 "uh_client_lookup(): No entry for fd %i!\n",
539 /* parse message header */
540 if( (req = uh_http_header_recv(cl)) != NULL )
542 /* RFC1918 filtering required? */
543 if( conf->rfc1918_filter &&
544 sa_rfc1918(&cl->peeraddr) &&
545 !sa_rfc1918(&cl->servaddr) )
547 uh_http_sendhf(cl, 403, "Forbidden",
548 "Rejected request from RFC1918 IP "
549 "to public server address");
554 if( conf->lua_state &&
555 uh_path_match(conf->lua_prefix, req->url) )
557 conf->lua_request(cl, req, conf->lua_state);
561 /* dispatch request */
562 if( (pin = uh_path_lookup(cl, req->url)) != NULL )
565 if( uh_auth_check(cl, req, pin) )
566 uh_dispatch_request(cl, req, pin);
572 /* Try to invoke an error handler */
573 pin = uh_path_lookup(cl, conf->error_handler);
575 if( pin && uh_auth_check(cl, req, pin) )
577 req->redirect_status = 404;
578 uh_dispatch_request(cl, req, pin);
582 uh_http_sendhf(cl, 404, "Not Found",
583 "No such file or directory");
589 /* free client tls context */
596 /* close client socket */
598 FD_CLR(cur_fd, &used_fds);
600 /* remove from global client list */
601 uh_client_remove(cur_fd);
608 /* destroy the Lua state */
609 if( conf->lua_state != NULL )
610 conf->lua_close(conf->lua_state);
615 int main (int argc, char **argv)
617 /* master file descriptor list */
618 fd_set used_fds, serv_fds, read_fds;
620 /* working structs */
621 struct addrinfo hints;
628 /* maximum file descriptor number */
629 int cur_fd, max_fd = 0;
644 #if defined(HAVE_TLS) || defined(HAVE_LUA)
649 /* clear the master and temp sets */
654 /* handle SIGPIPE, SIGINT, SIGTERM, SIGCHLD */
656 sigemptyset(&sa.sa_mask);
658 sa.sa_handler = SIG_IGN;
659 sigaction(SIGPIPE, &sa, NULL);
661 sa.sa_handler = uh_sigchld;
662 sigaction(SIGCHLD, &sa, NULL);
664 sa.sa_handler = uh_sigterm;
665 sigaction(SIGINT, &sa, NULL);
666 sigaction(SIGTERM, &sa, NULL);
670 sigaddset(&ss, SIGCHLD);
671 sigprocmask(SIG_BLOCK, &ss, NULL);
673 /* prepare addrinfo hints */
674 memset(&hints, 0, sizeof(hints));
675 hints.ai_family = AF_UNSPEC;
676 hints.ai_socktype = SOCK_STREAM;
677 hints.ai_flags = AI_PASSIVE;
680 memset(&conf, 0, sizeof(conf));
681 memset(bind, 0, sizeof(bind));
684 /* load TLS plugin */
685 if( ! (lib = dlopen("uhttpd_tls.so", RTLD_LAZY | RTLD_GLOBAL)) )
688 "Notice: Unable to load TLS plugin - disabling SSL support! "
689 "(Reason: %s)\n", dlerror()
694 /* resolve functions */
695 if( !(conf.tls_init = dlsym(lib, "uh_tls_ctx_init")) ||
696 !(conf.tls_cert = dlsym(lib, "uh_tls_ctx_cert")) ||
697 !(conf.tls_key = dlsym(lib, "uh_tls_ctx_key")) ||
698 !(conf.tls_free = dlsym(lib, "uh_tls_ctx_free")) ||
699 !(conf.tls_accept = dlsym(lib, "uh_tls_client_accept")) ||
700 !(conf.tls_close = dlsym(lib, "uh_tls_client_close")) ||
701 !(conf.tls_recv = dlsym(lib, "uh_tls_client_recv")) ||
702 !(conf.tls_send = dlsym(lib, "uh_tls_client_send"))
705 "Error: Failed to lookup required symbols "
706 "in TLS plugin: %s\n", dlerror()
711 /* init SSL context */
712 if( ! (conf.tls = conf.tls_init()) )
714 fprintf(stderr, "Error: Failed to initalize SSL context\n");
720 while( (opt = getopt(argc, argv,
721 "fSDRC:K:E:I:p:s:h:c:l:L:d:r:m:x:i:t:T:")) > 0
728 if( (port = strrchr(optarg, ':')) != NULL )
730 if( (optarg[0] == '[') && (port > optarg) && (port[-1] == ']') )
731 memcpy(bind, optarg + 1,
732 min(sizeof(bind), (int)(port - optarg) - 2));
735 min(sizeof(bind), (int)(port - optarg)));
750 "Notice: TLS support is disabled, "
751 "ignoring '-s %s'\n", optarg
761 bound += uh_socket_bind(
762 &serv_fds, &max_fd, bind[0] ? bind : NULL, port,
763 &hints, (opt == 's'), &conf
766 memset(bind, 0, sizeof(bind));
774 if( conf.tls_cert(conf.tls, optarg) < 1 )
777 "Error: Invalid certificate file given\n");
790 if( conf.tls_key(conf.tls, optarg) < 1 )
793 "Error: Invalid private key file given\n");
805 if( ! realpath(optarg, conf.docroot) )
807 fprintf(stderr, "Error: Invalid directory %s: %s\n",
808 optarg, strerror(errno));
815 if( (strlen(optarg) == 0) || (optarg[0] != '/') )
817 fprintf(stderr, "Error: Invalid error handler: %s\n",
821 conf.error_handler = optarg;
826 if( (strlen(optarg) == 0) || (optarg[0] == '/') )
828 fprintf(stderr, "Error: Invalid index page: %s\n",
832 conf.index_file = optarg;
835 /* don't follow symlinks */
837 conf.no_symlinks = 1;
840 /* don't list directories */
842 conf.no_dirlists = 1;
846 conf.rfc1918_filter = 1;
852 conf.cgi_prefix = optarg;
857 if( (optarg[0] == '.') && (port = strchr(optarg, '=')) )
860 uh_interpreter_add(optarg, port);
864 fprintf(stderr, "Error: Invalid interpreter: %s\n",
874 conf.lua_prefix = optarg;
879 conf.lua_handler = optarg;
883 #if defined(HAVE_CGI) || defined(HAVE_LUA)
886 conf.script_timeout = atoi(optarg);
890 /* network timeout */
892 conf.network_timeout = atoi(optarg);
902 if( (port = malloc(strlen(optarg)+1)) != NULL )
904 memset(port, 0, strlen(optarg)+1);
905 uh_urldecode(port, strlen(optarg), optarg, strlen(optarg));
912 /* basic auth realm */
919 printf("%s\n", crypt(optarg, "$1$"));
930 "Usage: %s -p [addr:]port [-h docroot]\n"
931 " -f Do not fork to background\n"
932 " -c file Configuration file, default is '/etc/httpd.conf'\n"
933 " -p [addr:]port Bind to specified address and port, multiple allowed\n"
935 " -s [addr:]port Like -p but provide HTTPS on this port\n"
936 " -C file ASN.1 server certificate file\n"
937 " -K file ASN.1 server private key file\n"
939 " -h directory Specify the document root, default is '.'\n"
940 " -E string Use given virtual URL as 404 error handler\n"
941 " -I string Use given filename as index page for directories\n"
942 " -S Do not follow symbolic links outside of the docroot\n"
943 " -D Do not allow directory listings, send 403 instead\n"
944 " -R Enable RFC1918 filter\n"
946 " -l string URL prefix for Lua handler, default is '/lua'\n"
947 " -L file Lua handler script, omit to disable Lua\n"
950 " -x string URL prefix for CGI handler, default is '/cgi-bin'\n"
951 " -i .ext=path Use interpreter at path for files with the given extension\n"
953 #if defined(HAVE_CGI) || defined(HAVE_LUA)
954 " -t seconds CGI and Lua script timeout in seconds, default is 60\n"
956 " -T seconds Network timeout in seconds, default is 30\n"
957 " -d string URL decode given string\n"
958 " -r string Specify basic auth realm\n"
959 " -m string MD5 crypt given string\n"
968 if( (tls == 1) && (keys < 2) )
970 fprintf(stderr, "Error: Missing private key or certificate file\n");
977 fprintf(stderr, "Error: No sockets bound, unable to continue\n");
981 /* default docroot */
982 if( !conf.docroot[0] && !realpath(".", conf.docroot) )
984 fprintf(stderr, "Error: Can not determine default document root: %s\n",
991 conf.realm = "Protected Area";
994 uh_config_parse(&conf);
996 /* default network timeout */
997 if( conf.network_timeout <= 0 )
998 conf.network_timeout = 30;
1000 #if defined(HAVE_CGI) || defined(HAVE_LUA)
1001 /* default script timeout */
1002 if( conf.script_timeout <= 0 )
1003 conf.script_timeout = 60;
1007 /* default cgi prefix */
1008 if( ! conf.cgi_prefix )
1009 conf.cgi_prefix = "/cgi-bin";
1013 /* load Lua plugin */
1014 if( ! (lib = dlopen("uhttpd_lua.so", RTLD_LAZY | RTLD_GLOBAL)) )
1017 "Notice: Unable to load Lua plugin - disabling Lua support! "
1018 "(Reason: %s)\n", dlerror()
1023 /* resolve functions */
1024 if( !(conf.lua_init = dlsym(lib, "uh_lua_init")) ||
1025 !(conf.lua_close = dlsym(lib, "uh_lua_close")) ||
1026 !(conf.lua_request = dlsym(lib, "uh_lua_request"))
1029 "Error: Failed to lookup required symbols "
1030 "in Lua plugin: %s\n", dlerror()
1035 /* init Lua runtime if handler is specified */
1036 if( conf.lua_handler )
1038 /* default lua prefix */
1039 if( ! conf.lua_prefix )
1040 conf.lua_prefix = "/lua";
1042 conf.lua_state = conf.lua_init(conf.lua_handler);
1047 /* fork (if not disabled) */
1061 if( (cur_fd = open("/dev/null", O_WRONLY)) > -1 )
1064 if( (cur_fd = open("/dev/null", O_RDONLY)) > -1 )
1067 if( (cur_fd = open("/dev/null", O_RDONLY)) > -1 )
1077 /* server main loop */
1078 uh_mainloop(&conf, serv_fds, max_fd);
1081 /* destroy the Lua state */
1082 if( conf.lua_state != NULL )
1083 conf.lua_close(conf.lua_state);