2 * Copyright (c) 2020 Omar Polo <op@omarpolo.com>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 #include <sys/socket.h>
21 #include <arpa/inet.h>
22 #include <netinet/in.h>
37 # define pledge(a, b) 0
38 # define unveil(a, b) 0
39 #endif /* __OpenBSD__ */
45 #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
47 /* large enough to hold a copy of a gemini URL and still have extra room */
51 #define TEMP_FAILURE 40
53 #define BAD_REQUEST 59
71 int fd, waiting_on_child;
73 char sbuf[1024]; /* static buffer */
74 void *buf, *i; /* mmap buffer */
75 ssize_t len, off; /* mmap/static buffer */
87 struct etm { /* file extension to mime */
91 {"application/pdf", "pdf"},
94 {"image/jpeg", "jpg"},
95 {"image/jpeg", "jpeg"},
97 {"image/svg+xml", "svg"},
99 {"text/gemini", "gemini"},
100 {"text/gemini", "gmi"},
101 {"text/markdown", "markdown"},
102 {"text/markdown", "md"},
103 {"text/plain", "txt"},
109 #define LOG(c, fmt, ...) \
111 char buf[INET_ADDRSTRLEN]; \
112 if (inet_ntop((c)->af, &(c)->addr, buf, sizeof(buf)) == NULL) \
113 err(1, "inet_ntop"); \
114 dprintf(logfd, "[%s] " fmt "\n", buf, __VA_ARGS__); \
117 const char *dir, *cgi;
119 int connected_clients;
121 void siginfo_handler(int);
122 int starts_with(const char*, const char*);
124 char *url_after_proto(char*);
125 char *url_start_of_request(char*);
126 int url_trim(struct client*, char*);
127 char *adjust_path(char*);
128 ssize_t filesize(int);
130 int start_reply(struct pollfd*, struct client*, int, const char*);
131 const char *path_ext(const char*);
132 const char *mime(const char*);
133 int check_path(const char*, int*);
134 int check_for_cgi(char *, char*, struct pollfd*, struct client*);
135 int open_file(char*, char*, struct pollfd*, struct client*);
136 int start_cgi(const char*, const char*, const char*, struct pollfd*, struct client*);
137 void cgi_setpoll_on_child(struct pollfd*, struct client*);
138 void cgi_setpoll_on_client(struct pollfd*, struct client*);
139 void handle_cgi(struct pollfd*, struct client*);
140 void send_file(char*, char*, struct pollfd*, struct client*);
141 void send_dir(char*, struct pollfd*, struct client*);
142 void handle(struct pollfd*, struct client*);
144 void mark_nonblock(int);
146 void do_accept(int, struct tls*, struct pollfd*, struct client*);
147 void goodbye(struct pollfd*, struct client*);
148 void loop(struct tls*, int);
150 void usage(const char*);
153 siginfo_handler(int sig)
159 starts_with(const char *str, const char *prefix)
163 for (i = 0; prefix[i] != '\0'; ++i)
164 if (str[i] != prefix[i])
170 url_after_proto(char *url)
173 const char *proto = "gemini";
174 const char *marker = "://";
177 if ((s = strstr(url, marker)) == NULL)
180 if (s - strlen(proto) != url)
183 if (!starts_with(url, proto))
186 /* a valid gemini:// URL */
187 return s + strlen(marker);
191 url_start_of_request(char *url)
195 if ((s = url_after_proto(url)) == NULL)
198 if ((t = strstr(s, "/")) == NULL)
199 return s + strlen(s);
204 url_trim(struct client *c, char *url)
206 const char *e = "\r\n";
209 if ((s = strstr(url, e)) == NULL)
215 LOG(c, "%s", "request longer than 1024 bytes\n");
223 adjust_path(char *path)
228 if ((query = strchr(path, '?')) != NULL) {
236 if (!strcmp(&path[len-3], "/..")) {
241 /* if the path is only `..` trim out and exit */
242 if (!strcmp(path, "..")) {
247 /* remove every ../ in the path */
249 if ((s = strstr(path, "../")) == NULL)
251 memmove(s, s+3, strlen(s)+1); /* copy also the \0 */
256 start_reply(struct pollfd *pfd, struct client *client, int code, const char *reason)
258 char buf[1030] = {0}; /* status + ' ' + max reply len + \r\n\0 */
263 client->meta = reason;
264 client->state = S_INITIALIZING;
266 len = snprintf(buf, sizeof(buf), "%d %s\r\n", code, reason);
267 assert(len < (int)sizeof(buf));
268 ret = tls_write(client->ctx, buf, len);
269 if (ret == TLS_WANT_POLLIN) {
270 pfd->events = POLLIN;
274 if (ret == TLS_WANT_POLLOUT) {
275 pfd->events = POLLOUT;
287 if ((len = lseek(fd, 0, SEEK_END)) == -1)
289 if (lseek(fd, 0, SEEK_SET) == -1)
295 path_ext(const char *path)
299 end = path + strlen(path)-1; /* the last byte before the NUL */
300 for (; end != path; --end) {
311 mime(const char *path)
313 const char *ext, *def = "application/octet-stream";
316 if ((ext = path_ext(path)) == NULL)
319 for (t = filetypes; t->mime != NULL; ++t)
320 if (!strcmp(ext, t->ext))
327 check_path(const char *path, int *fd)
331 assert(path != NULL);
332 if ((*fd = openat(dirfd, path,
333 O_RDONLY | O_NOFOLLOW | O_CLOEXEC)) == -1) {
337 if (fstat(*fd, &sb) == -1) {
338 dprintf(logfd, "failed stat for %s\n", path);
342 if (S_ISDIR(sb.st_mode))
343 return FILE_DIRECTORY;
345 if (sb.st_mode & S_IXUSR)
346 return FILE_EXECUTABLE;
352 * the inverse of this algorithm, i.e. starting from the start of the
353 * path + strlen(cgi), and checking if each component, should be
354 * faster. But it's tedious to write. This does the opposite: starts
355 * from the end and strip one component at a time, until either an
356 * executable is found or we emptied the path.
359 check_for_cgi(char *path, char *query, struct pollfd *fds, struct client *c)
362 end = strchr(path, '\0');
364 /* NB: assume CGI is enabled and path matches cgi */
367 /* go up one level. UNIX paths are simple and POSIX
368 * dirname, with its ambiguities on if the given path
369 * is changed or not, gives me headaches. */
374 switch (check_path(path, &c->fd)) {
375 case FILE_EXECUTABLE:
376 return start_cgi(path, end+1, query, fds,c);
388 if (!start_reply(fds, c, NOT_FOUND, "not found"))
396 open_file(char *path, char *query, struct pollfd *fds, struct client *c)
400 bzero(fpath, sizeof(fpath));
404 strlcat(fpath, path, PATHBUF);
406 switch (check_path(fpath, &c->fd)) {
407 case FILE_EXECUTABLE:
408 /* +2 to skip the ./ */
409 if (cgi != NULL && starts_with(fpath+2, cgi))
410 return start_cgi(fpath, "", query, fds, c);
415 if ((c->len = filesize(c->fd)) == -1) {
416 LOG(c, "failed to get file size for %s", fpath);
421 if ((c->buf = mmap(NULL, c->len, PROT_READ, MAP_PRIVATE,
422 c->fd, 0)) == MAP_FAILED) {
423 warn("mmap: %s", fpath);
428 return start_reply(fds, c, SUCCESS, mime(fpath));
431 LOG(c, "%s is a directory, trying %s/index.gmi", fpath, fpath);
434 send_dir(fpath, fds, c);
438 if (cgi != NULL && starts_with(fpath+2, cgi))
439 return check_for_cgi(fpath, query, fds, c);
441 if (!start_reply(fds, c, NOT_FOUND, "not found"))
453 start_cgi(const char *spath, const char *relpath, const char *query,
454 struct pollfd *fds, struct client *c)
457 int p[2]; /* read end, write end */
462 switch (pid = fork()) {
466 case 0: { /* child */
468 char addr[INET_ADDRSTRLEN];
469 char *argv[] = { NULL, NULL, NULL };
474 if (dup2(p[1], 1) == -1)
477 if (inet_ntop(c->af, &c->addr, addr, sizeof(addr)) == NULL)
480 if (asprintf(&ex, "%s%s", dir, spath+1) == -1)
483 if (asprintf(&requri, "%s%s%s", spath,
484 *relpath == '\0' ? "" : "/",
488 argv[0] = argv[1] = ex;
491 setenv("SERVER_SOFTWARE", "gmid", 1);
492 setenv("SERVER_PORT", "1965", 1);
493 /* setenv("SERVER_NAME", "", 1); */
494 setenv("SCRIPT_NAME", spath, 1);
495 setenv("SCRIPT_EXECUTABLE", ex, 1);
496 setenv("REQUEST_URI", requri, 1);
497 setenv("REQUEST_RELATIVE", relpath, 1);
499 setenv("QUERY_STRING", query, 1);
500 setenv("REMOTE_HOST", addr, 1);
501 setenv("DOCUMENT_ROOT", dir, 1);
507 default: /* parent */
512 mark_nonblock(c->fd);
513 c->state = S_SENDING;
519 if (!start_reply(fds, c, TEMP_FAILURE, "internal server error"))
525 dprintf(p[1], "%d internal server error\r\n", TEMP_FAILURE);
531 cgi_setpoll_on_child(struct pollfd *fds, struct client *c)
535 if (c->waiting_on_child)
537 c->waiting_on_child = 1;
539 fds->events = POLLIN;
547 cgi_setpoll_on_client(struct pollfd *fds, struct client *c)
551 if (!c->waiting_on_child)
553 c->waiting_on_child = 0;
561 handle_cgi(struct pollfd *fds, struct client *c)
565 /* ensure c->fd is the child and fds->fd the client */
566 cgi_setpoll_on_client(fds, c);
570 if ((r = read(c->fd, c->sbuf, sizeof(c->sbuf))) == 0)
573 if (errno == EAGAIN || errno == EWOULDBLOCK) {
574 cgi_setpoll_on_child(fds, c);
584 switch (r = tls_write(c->ctx, c->sbuf + c->off, c->len)) {
588 case TLS_WANT_POLLOUT:
589 fds->events = POLLOUT;
592 case TLS_WANT_POLLIN:
593 fds->events = POLLIN;
609 send_file(char *path, char *query, struct pollfd *fds, struct client *c)
614 if (!open_file(path, query, fds, c))
616 c->state = S_SENDING;
619 len = (c->buf + c->len) - c->i;
622 switch (ret = tls_write(c->ctx, c->i, len)) {
624 LOG(c, "tls_write: %s", tls_error(c->ctx));
628 case TLS_WANT_POLLIN:
629 fds->events = POLLIN;
632 case TLS_WANT_POLLOUT:
633 fds->events = POLLOUT;
647 send_dir(char *path, struct pollfd *fds, struct client *client)
652 bzero(fpath, PATHBUF);
657 /* this cannot fail since sizeof(fpath) > maxlen of path */
658 strlcat(fpath, path, PATHBUF);
661 /* add a trailing / in case. */
662 if (fpath[len-1] != '/') {
666 strlcat(fpath, "index.gmi", sizeof(fpath));
668 send_file(fpath, NULL, fds, client);
672 handle(struct pollfd *fds, struct client *client)
674 char buf[GEMINI_URL_LEN];
678 switch (client->state) {
680 bzero(buf, GEMINI_URL_LEN);
681 switch (tls_read(client->ctx, buf, sizeof(buf)-1)) {
683 LOG(client, "tls_read: %s", tls_error(client->ctx));
684 goodbye(fds, client);
687 case TLS_WANT_POLLIN:
688 fds->events = POLLIN;
691 case TLS_WANT_POLLOUT:
692 fds->events = POLLOUT;
696 if (!url_trim(client, buf)) {
697 if (!start_reply(fds, client, BAD_REQUEST, "bad request"))
699 goodbye(fds, client);
703 if ((path = url_start_of_request(buf)) == NULL) {
704 if (!start_reply(fds, client, BAD_REQUEST, "bad request"))
706 goodbye(fds, client);
710 query = adjust_path(path);
711 LOG(client, "get %s%s%s", path,
715 send_file(path, query, fds, client);
719 if (!start_reply(fds, client, client->code, client->meta))
722 if (client->code != SUCCESS) {
723 /* we don't need a body */
724 goodbye(fds, client);
728 client->state = S_SENDING;
733 if (client->child != -1)
734 handle_cgi(fds, client);
736 send_file(NULL, NULL, fds, client);
740 goodbye(fds, client);
750 mark_nonblock(int fd)
754 if ((flags = fcntl(fd, F_GETFL)) == -1)
755 err(1, "fcntl(F_GETFL)");
756 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1)
757 err(1, "fcntl(F_SETFL)");
761 make_socket(int port, int family)
764 struct sockaddr_in addr4;
765 struct sockaddr_in6 addr6;
766 struct sockaddr *addr;
771 bzero(&addr4, sizeof(addr4));
772 addr4.sin_family = family;
773 addr4.sin_port = htons(port);
774 addr4.sin_addr.s_addr = INADDR_ANY;
775 addr = (struct sockaddr*)&addr4;
780 bzero(&addr6, sizeof(addr6));
781 addr6.sin6_family = AF_INET6;
782 addr6.sin6_port = htons(port);
783 addr6.sin6_addr = in6addr_any;
784 addr = (struct sockaddr*)&addr6;
793 if ((sock = socket(family, SOCK_STREAM, 0)) == -1)
797 if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &v, sizeof(v)) == -1)
798 err(1, "setsockopt(SO_REUSEADDR)");
801 if (setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, &v, sizeof(v)) == -1)
802 err(1, "setsockopt(SO_REUSEPORT)");
806 if (bind(sock, addr, len) == -1)
809 if (listen(sock, 16) == -1)
816 do_accept(int sock, struct tls *ctx, struct pollfd *fds, struct client *clients)
819 struct sockaddr_in addr;
823 if ((fd = accept(sock, (struct sockaddr*)&addr, &len)) == -1) {
824 if (errno == EWOULDBLOCK)
831 for (i = 0; i < MAX_USERS; ++i) {
832 if (fds[i].fd == -1) {
833 bzero(&clients[i], sizeof(struct client));
834 if (tls_accept_socket(ctx, &clients[i].ctx, fd) == -1)
835 break; /* goodbye fd! */
838 fds[i].events = POLLIN;
840 clients[i].state = S_OPEN;
842 clients[i].child = -1;
843 clients[i].buf = MAP_FAILED;
844 clients[i].af = AF_INET;
845 clients[i].addr = addr.sin_addr;
856 goodbye(struct pollfd *pfd, struct client *c)
860 c->state = S_CLOSING;
862 ret = tls_close(c->ctx);
863 if (ret == TLS_WANT_POLLIN) {
864 pfd->events = POLLIN;
867 if (ret == TLS_WANT_POLLOUT) {
868 pfd->events = POLLOUT;
877 if (c->buf != MAP_FAILED)
878 munmap(c->buf, c->len);
888 loop(struct tls *ctx, int sock)
891 struct client clients[MAX_USERS];
892 struct pollfd fds[MAX_USERS];
894 for (i = 0; i < MAX_USERS; ++i) {
896 fds[i].events = POLLIN;
897 bzero(&clients[i], sizeof(struct client));
903 if ((todo = poll(fds, MAX_USERS, INFTIM)) == -1) {
904 if (errno == EINTR) {
905 warnx("connected clients: %d", connected_clients);
911 for (i = 0; i < MAX_USERS; i++) {
912 assert(i < MAX_USERS);
914 if (fds[i].revents == 0)
917 if (fds[i].revents & (POLLERR|POLLNVAL))
918 err(1, "bad fd %d", fds[i].fd);
920 if (fds[i].revents & POLLHUP) {
921 /* fds[i] may be the fd of the stdin
922 * of a cgi script that has exited. */
923 if (!clients[i].waiting_on_child) {
924 goodbye(&fds[i], &clients[i]);
931 if (i == 0) { /* new client */
932 do_accept(sock, ctx, fds, clients);
936 handle(&fds[i], &clients[i]);
942 usage(const char *me)
945 "USAGE: %s [-h] [-c cert.pem] [-d docs] [-k key.pem] "
946 "[-l logfile] [-x cgi-bin]\n",
951 main(int argc, char **argv)
953 const char *cert = "cert.pem", *key = "key.pem";
954 struct tls *ctx = NULL;
955 struct tls_config *conf;
958 signal(SIGPIPE, SIG_IGN);
959 signal(SIGCHLD, SIG_IGN);
962 signal(SIGINFO, siginfo_handler);
964 signal(SIGUSR2, siginfo_handler);
966 connected_clients = 0;
969 logfd = 2; /* stderr */
972 while ((ch = getopt(argc, argv, "c:d:hk:l:x:")) != -1) {
991 /* open log file or create it with 644 */
992 if ((logfd = open(optarg, O_WRONLY | O_CREAT | O_CLOEXEC,
993 S_IRUSR | S_IWUSR | S_IRGRP | S_IWOTH)) == -1)
994 err(1, "%s", optarg);
1007 if ((conf = tls_config_new()) == NULL)
1008 err(1, "tls_config_new");
1010 if (tls_config_set_protocols(conf,
1011 TLS_PROTOCOL_TLSv1_2 | TLS_PROTOCOL_TLSv1_3) == -1)
1012 err(1, "tls_config_set_protocols");
1014 if (tls_config_set_cert_file(conf, cert) == -1)
1015 err(1, "tls_config_set_cert_file: %s", cert);
1017 if (tls_config_set_key_file(conf, key) == -1)
1018 err(1, "tls_config_set_key_file: %s", key);
1020 if ((ctx = tls_server()) == NULL)
1021 err(1, "tls_server");
1023 if (tls_configure(ctx, conf) == -1)
1024 errx(1, "tls_configure: %s", tls_error(ctx));
1026 sock = make_socket(1965, AF_INET);
1028 if ((dirfd = open(dir, O_RDONLY | O_DIRECTORY)) == -1)
1029 err(1, "open: %s", dir);
1032 if (unveil(dir, "rx") == -1)
1034 if (pledge("stdio rpath inet proc exec", NULL) == -1)
1037 if (unveil(dir, "r") == -1)
1039 if (pledge("stdio rpath inet", NULL) == -1)
1047 tls_config_free(conf);