Blob


1 /*
2 * Copyright (c) 2022 Omar Polo <op@omarpolo.com>
3 * Copyright (c) 2006 - 2015 Reyk Floeter <reyk@openbsd.org>
4 *
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
18 #include <sys/types.h>
19 #include <sys/queue.h>
20 #include <sys/tree.h>
21 #include <sys/socket.h>
22 #include <sys/uio.h>
24 #include <netinet/in.h>
25 #include <arpa/inet.h>
26 #include <netdb.h>
28 #include <asr.h>
29 #include <ctype.h>
30 #include <errno.h>
31 #include <event.h>
32 #include <limits.h>
33 #include <stdlib.h>
34 #include <stdint.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <imsg.h>
38 #include <tls.h>
39 #include <unistd.h>
41 #include "log.h"
42 #include "proc.h"
44 #include "galileo.h"
46 #define MINIMUM(a, b) ((a) < (b) ? (a) : (b))
48 /* provided by OpenBSD' base libevent but not in any header? */
49 extern void bufferevent_read_pressure_cb(struct evbuffer *, size_t,
50 size_t, void *);
52 void proxy_init(struct privsep *, struct privsep_proc *, void *);
53 int proxy_launch(struct galileo *);
54 void proxy_inflight_dec(const char *);
55 int proxy_dispatch_parent(int, struct privsep_proc *, struct imsg *);
56 void proxy_translate_gemtext(struct client *);
57 void proxy_resolved(struct asr_result *, void *);
58 void proxy_connect(int, short, void *);
59 void proxy_read(struct bufferevent *, void *);
60 void proxy_write(struct bufferevent *, void *);
61 void proxy_error(struct bufferevent *, short, void *);
62 int proxy_bufferevent_add(struct event *, int);
63 void proxy_tls_writecb(int, short, void *);
64 void proxy_tls_readcb(int, short, void *);
66 static struct privsep_proc procs[] = {
67 { "parent", PROC_PARENT, proxy_dispatch_parent },
68 };
70 volatile int proxy_clients;
71 volatile int proxy_inflight;
72 uint32_t proxy_fcg_id;
74 void
75 proxy(struct privsep *ps, struct privsep_proc *p)
76 {
77 proc_run(ps, p, procs, nitems(procs), proxy_init, NULL);
78 }
80 void
81 proxy_init(struct privsep *ps, struct privsep_proc *p, void *arg)
82 {
83 if (config_init(ps->ps_env) == -1)
84 fatal("failed to initialize configuration");
86 /* We use a custom shutdown callback */
87 /* p->p_shutdown = proxy_shutdown */
89 if (pledge("stdio recvfd unix inet dns", NULL) == -1)
90 fatal("pledge");
91 }
93 int
94 proxy_launch(struct galileo *env)
95 {
96 event_add(&env->sc_evsock, NULL);
97 return (0);
98 }
100 void
101 proxy_purge(struct server *srv)
105 void
106 proxy_inflight_dec(const char *why)
108 proxy_inflight--;
109 log_debug("%s: inflight decremented, now %d, %s",
110 __func__, proxy_inflight, why);
113 int
114 proxy_dispatch_parent(int fd, struct privsep_proc *p, struct imsg *imsg)
116 struct privsep *ps = p->p_ps;
117 struct galileo *env = ps->ps_env;
119 switch (imsg->hdr.type) {
120 case IMSG_CFG_SRV:
121 if (config_getserver(env, imsg) == -1)
122 fatal("config_getproxy");
123 break;
124 case IMSG_CFG_SOCK:
125 /* XXX: improve */
127 if (env->sc_sock_fd != -1) {
128 event_del(&env->sc_evsock);
129 close(env->sc_sock_fd);
132 env->sc_sock_fd = config_getsock(env, imsg);
133 if (env->sc_sock_fd == -1)
134 fatal("config_getsock");
136 event_set(&env->sc_evsock, env->sc_sock_fd,
137 EV_READ | EV_PERSIST, fcgi_accept, env);
138 event_add(&env->sc_evsock, NULL);
139 evtimer_set(&env->sc_evpause, fcgi_accept, env);
140 break;
141 case IMSG_CFG_DONE:
142 log_debug("config done!");
143 break;
144 case IMSG_CTL_START:
145 proxy_launch(env);
146 break;
147 default:
148 log_warnx("unknown message %d", imsg->hdr.type);
149 return (-1);
152 return (0);
155 static inline int
156 printurl(struct client *clt, const char *str)
158 for (; *str; ++str) {
159 switch (*str) {
160 case ' ':
161 case '\t':
162 case '\'':
163 case '\\':
164 if (clt_printf(clt, "%2X", (unsigned char)*str) == -1)
165 return (-1);
166 break;
167 default:
168 if (clt_putc(clt, *str) == -1)
169 return (-1);
170 break;
174 return (0);
177 static inline int
178 htmlescape(struct client *clt, const char *str)
180 int r;
182 for (; *str; ++str) {
183 switch (*str) {
184 case '<':
185 r = clt_puts(clt, "&lt;");
186 break;
187 case '>':
188 r = clt_puts(clt, "&gt;");
189 break;
190 case '&':
191 r = clt_puts(clt, "&amp;");
192 break;
193 default:
194 r = clt_putc(clt, *str);
195 break;
198 if (r == -1)
199 return (-1);
202 return (0);
205 static int
206 gemtext_translate_line(struct client *clt, char *line)
208 /* preformatted line / closing */
209 if (clt->clt_translate & TR_PRE) {
210 if (!strncmp(line, "```", 3)) {
211 clt->clt_translate &= ~TR_PRE;
212 return (clt_puts(clt, "</pre>"));
215 if (htmlescape(clt, line) == -1)
216 return (-1);
217 return (clt_putc(clt, '\n'));
220 /* bullet */
221 if (!strncmp(line, "* ", 2)) {
222 if (clt->clt_translate & TR_NAV) {
223 if (clt_puts(clt, "</ul></nav>") == -1)
224 return (-1);
225 clt->clt_translate &= ~TR_NAV;
228 if (!(clt->clt_translate & TR_LIST)) {
229 if (clt_puts(clt, "<ul>") == -1)
230 return (-1);
231 clt->clt_translate |= TR_LIST;
234 if (clt_puts(clt, "<li>") == -1 ||
235 htmlescape(clt, line + 2) == -1 ||
236 clt_puts(clt, "</li>") == -1)
237 return (-1);
238 return (0);
241 if (clt->clt_translate & TR_LIST) {
242 if (clt_puts(clt, "</ul>") == -1)
243 return (-1);
244 clt->clt_translate &= ~TR_LIST;
247 /* link -- TODO: relativify from SCRIPT_NAME */
248 if (!strncmp(line, "=>", 2)) {
249 char *label;
251 if (!(clt->clt_translate & TR_NAV)) {
252 if (clt_puts(clt, "<nav><ul>") == -1)
253 return (-1);
254 clt->clt_translate |= TR_NAV;
257 line += 2;
258 line += strspn(line, " \t");
260 label = line + strcspn(line, " \t");
261 if (*label == '\0')
262 label = line;
263 else
264 *label++ = '\0';
266 if (clt_puts(clt, "<li><a href='") == -1 ||
267 printurl(clt, line) == -1 ||
268 clt_puts(clt, "'>") == -1 ||
269 htmlescape(clt, label) == -1 ||
270 clt_puts(clt, "</a></li>") == -1)
271 return (-1);
273 return (0);
276 if (clt->clt_translate & TR_NAV) {
277 if (clt_puts(clt, "</ul></nav>") == -1)
278 return (-1);
279 clt->clt_translate &= ~TR_NAV;
282 /* pre opening */
283 if (!strncmp(line, "```", 3)) {
284 clt->clt_translate |= TR_PRE;
285 return (clt_puts(clt, "<pre>"));
288 /* citation block */
289 if (*line == '>') {
290 if (clt_puts(clt, "<blockquote>") == -1 ||
291 htmlescape(clt, line + 1) == -1 ||
292 clt_puts(clt, "</blockquote>") == -1)
293 return (-1);
294 return (0);
297 /* headings */
298 if (!strncmp(line, "###", 3)) {
299 if (clt_puts(clt, "<h3>") == -1 ||
300 htmlescape(clt, line + 3) == -1 ||
301 clt_puts(clt, "</h3>") == -1)
302 return (-1);
303 return (0);
305 if (!strncmp(line, "##", 2)) {
306 if (clt_puts(clt, "<h2>") == -1 ||
307 htmlescape(clt, line + 2) == -1 ||
308 clt_puts(clt, "</h2>") == -1)
309 return (-1);
310 return (0);
312 if (!strncmp(line, "#", 1)) {
313 if (clt_puts(clt, "<h1>") == -1 ||
314 htmlescape(clt, line + 1) == -1 ||
315 clt_puts(clt, "</h1>") == -1)
316 return (-1);
317 return (0);
320 /* Not following strictly the gemini specification... */
321 if (*line == '\0')
322 return (0);
324 /* paragraph */
325 if (clt_puts(clt, "<p>") == -1 ||
326 htmlescape(clt, line) == -1 ||
327 clt_puts(clt, "</p>") == -1)
328 return (-1);
330 return (0);
333 void
334 proxy_translate_gemtext(struct client *clt)
336 struct bufferevent *bev = clt->clt_bev;
337 struct evbuffer *src = EVBUFFER_INPUT(bev);
338 char *line;
339 size_t len;
340 int r;
342 for (;;) {
343 line = evbuffer_readln(src, &len, EVBUFFER_EOL_CRLF);
344 if (line == NULL)
345 return;
347 r = gemtext_translate_line(clt, line);
348 free(line);
349 if (r == -1)
350 return;
354 static struct proxy_config *
355 proxy_server_match(struct galileo *env, struct client *clt)
357 struct server *srv;
359 if (clt->clt_server_name == NULL)
360 return NULL;
362 TAILQ_FOREACH(srv, &env->sc_servers, srv_entry) {
363 if (!strcmp(clt->clt_server_name, srv->srv_conf.host))
364 return &srv->srv_conf;
367 return NULL;
370 void
371 proxy_start_request(struct galileo *env, struct client *clt)
373 struct addrinfo hints;
374 struct asr_query *query;
375 char port[32];
377 if ((clt->clt_pc = proxy_server_match(env, clt)) == NULL) {
378 if (clt_printf(clt, "Status: 501\r\n\r\n") == -1)
379 return;
380 fcgi_end_request(clt, 1);
381 return;
384 (void)snprintf(port, sizeof(port), "%d", clt->clt_pc->proxy_port);
386 memset(&hints, 0, sizeof(hints));
387 hints.ai_family = AF_UNSPEC;
388 hints.ai_socktype = SOCK_STREAM;
390 query = getaddrinfo_async(clt->clt_pc->proxy_addr, port, &hints, NULL);
391 if (query == NULL) {
392 log_warn("getaddrinfo_async");
393 fcgi_abort_request(clt);
394 return;
397 clt->clt_evasr = event_asr_run(query, proxy_resolved, clt);
398 if (clt->clt_evasr == NULL) {
399 log_warn("event_asr_run");
400 asr_abort(query);
401 fcgi_abort_request(clt);
402 return;
406 void
407 proxy_resolved(struct asr_result *res, void *d)
409 struct client *clt = d;
410 struct proxy_config *pc = clt->clt_pc;
412 clt->clt_evasr = NULL;
414 if (res->ar_gai_errno != 0) {
415 log_warnx("failed to resolve %s:%d: %s",
416 pc->proxy_addr, pc->proxy_port,
417 gai_strerror(res->ar_gai_errno));
418 if (clt_printf(clt, "Status: 501\r\n") == -1)
419 return;
420 if (clt_printf(clt, "Content-Type: text/plain\r\n") == -1)
421 return;
422 if (clt_printf(clt, "Proxy error; connection failed") == -1)
423 return;
424 fcgi_end_request(clt, 1);
425 return;
428 clt->clt_addrinfo = res->ar_addrinfo;
429 clt->clt_p = clt->clt_addrinfo;
430 proxy_connect(-1, 0, clt);
433 void
434 proxy_connect(int fd, short ev, void *d)
436 struct client *clt = d;
437 struct evbuffer *out;
438 struct addrinfo *p;
439 struct tls_config *conf;
440 struct timeval conntv = {5, 0};
441 int err = 0;
442 socklen_t len = sizeof(err);
444 again:
445 if (clt->clt_p == NULL)
446 goto err;
448 if (clt->clt_fd != -1) {
449 if (getsockopt(clt->clt_fd, SOL_SOCKET, SO_ERROR, &err, &len)
450 == -1)
451 goto err;
452 if (err != 0) {
453 errno = err;
454 goto err;
456 goto done;
459 p = clt->clt_p;
460 clt->clt_fd = socket(p->ai_family, p->ai_socktype | SOCK_NONBLOCK,
461 p->ai_protocol);
462 if (clt->clt_fd == -1) {
463 clt->clt_p = clt->clt_p->ai_next;
464 goto again;
467 if (connect(clt->clt_fd, p->ai_addr, p->ai_addrlen) == 0)
468 goto done;
470 clt->clt_evconn_live = 1;
471 event_set(&clt->clt_evconn, clt->clt_fd, EV_WRITE, proxy_connect, clt);
472 event_add(&clt->clt_evconn, &conntv);
473 return;
475 done:
476 clt->clt_evconn_live = 0;
477 freeaddrinfo(clt->clt_addrinfo);
478 clt->clt_addrinfo = clt->clt_p = NULL;
480 /* initialize TLS for Gemini */
481 if ((conf = tls_config_new()) == NULL) {
482 log_warn("tls_config_new failed");
483 goto err;
486 tls_config_insecure_noverifycert(conf);
488 if ((clt->clt_ctx = tls_client()) == NULL) {
489 log_warnx("tls_client failed");
490 tls_config_free(conf);
491 goto err;
494 if (tls_configure(clt->clt_ctx, conf) == -1) {
495 log_warnx("tls_configure failed");
496 tls_config_free(conf);
497 goto err;
500 tls_config_free(conf);
502 if (tls_connect_socket(clt->clt_ctx, clt->clt_fd,
503 clt->clt_pc->proxy_name) == -1) {
504 log_warnx("tls_connect_socket failed");
505 goto err;
508 clt->clt_bev = bufferevent_new(clt->clt_fd, proxy_read, proxy_write,
509 proxy_error, clt);
510 if (clt->clt_bev == NULL) {
511 log_warn("bufferevent_new");
512 goto err;
514 out = EVBUFFER_OUTPUT(clt->clt_bev);
516 event_set(&clt->clt_bev->ev_read, clt->clt_fd, EV_READ,
517 proxy_tls_readcb, clt->clt_bev);
518 event_set(&clt->clt_bev->ev_write, clt->clt_fd, EV_WRITE,
519 proxy_tls_writecb, clt->clt_bev);
521 /* bufferevent_settimeout(); */
522 bufferevent_enable(clt->clt_bev, EV_READ|EV_WRITE);
524 /* TODO: compute the URL */
525 if (evbuffer_add_printf(out, "gemini://%s/%s\r\n",
526 clt->clt_pc->proxy_name, clt->clt_path_info) == -1) {
527 log_warn("bufferevent_printf failed");
528 goto err;
531 return;
533 err:
534 log_warn("failed to connect to %s:%d",
535 clt->clt_pc->proxy_addr, clt->clt_pc->proxy_port);
536 if (clt_printf(clt, "Status: 501\r\n") == -1)
537 return;
538 if (clt_printf(clt, "Content-Type: text/plain\r\n") == -1)
539 return;
540 if (clt_printf(clt, "Proxy error; connection failed") == -1)
541 return;
542 fcgi_end_request(clt, 1);
545 void
546 proxy_read(struct bufferevent *bev, void *d)
548 struct client *clt = d;
549 struct proxy_config *pc = clt->clt_pc;
550 struct evbuffer *src = EVBUFFER_INPUT(bev);
551 const char *ctype;
552 char *hdr;
553 size_t len;
554 int code;
556 if (clt->clt_headersdone) {
557 copy:
558 if (clt->clt_translate)
559 proxy_translate_gemtext(clt);
560 else
561 clt_write_bufferevent(clt, bev);
562 return;
565 hdr = evbuffer_readln(src, &len, EVBUFFER_EOL_CRLF_STRICT);
566 if (hdr == NULL) {
567 if (EVBUFFER_LENGTH(src) >= 1026)
568 proxy_error(bev, EV_READ, clt);
569 return;
572 if (len < 4 ||
573 !isdigit((unsigned char)hdr[0]) ||
574 !isdigit((unsigned char)hdr[1]) ||
575 hdr[2] != ' ') {
576 log_warnx("invalid ");
577 free(hdr);
578 proxy_error(bev, EV_READ, clt);
579 return;
582 code = (hdr[0] - '0') * 10 + (hdr[1] - '0');
583 if (code != 20) {
584 log_warnx("un-handled gemini reply status %d", code);
585 free(hdr);
586 proxy_error(bev, EV_READ, clt);
587 return;
590 if (!strncmp(&hdr[3], "text/gemini", 11)) {
591 ctype = "text/html; charset=utf8";
592 clt->clt_translate = TR_ENABLED;
593 } else
594 ctype = &hdr[3];
596 if (clt_printf(clt, "Content-Type: %s\r\n", ctype) == -1)
597 return;
598 if (clt_printf(clt, "\r\n") == -1)
599 return;
601 clt->clt_headersdone = 1;
603 if (clt->clt_translate) {
604 if (clt_puts(clt, "<!doctype html><html><head>") == -1)
605 return;
606 if (*pc->stylesheet != '\0' &&
607 clt_printf(clt, "<link rel='stylesheet' href='%s' />",
608 pc->stylesheet) == -1)
609 return;
610 if (clt_puts(clt, "</head><body>") == -1)
611 return;
614 goto copy;
617 void
618 proxy_write(struct bufferevent *bev, void *d)
620 return;
623 void
624 proxy_error(struct bufferevent *bev, short err, void *d)
626 struct client *clt = d;
627 int status = !(err & EVBUFFER_EOF);
629 log_debug("proxy error, shutting down the connection (err: %x)",
630 err);
632 if (!clt->clt_headersdone) {
633 if (clt_printf(clt, "Status: 501\r\n") == -1)
634 return;
635 if (clt_printf(clt, "Content-Type: text/plain\r\n") == -1)
636 return;
637 if (clt_printf(clt, "Proxy error\n") == -1)
638 return;
639 } else if (status == 0) {
640 if (clt_puts(clt, "</body></html>") == -1)
641 return;
644 fcgi_end_request(clt, status);
647 void
648 proxy_tls_readcb(int fd, short event, void *arg)
650 struct bufferevent *bufev = arg;
651 struct client *clt = bufev->cbarg;
652 char rbuf[IBUF_READ_SIZE];
653 int what = EVBUFFER_READ;
654 int howmuch = IBUF_READ_SIZE;
655 ssize_t ret;
656 size_t len;
658 if (event == EV_TIMEOUT) {
659 what |= EVBUFFER_TIMEOUT;
660 goto err;
663 if (bufev->wm_read.high != 0)
664 howmuch = MINIMUM(sizeof(rbuf), bufev->wm_read.high);
666 ret = tls_read(clt->clt_ctx, rbuf, howmuch);
667 if (ret == TLS_WANT_POLLIN || ret == TLS_WANT_POLLOUT) {
668 goto retry;
669 } else if (ret == -1) {
670 what |= EVBUFFER_ERROR;
671 goto err;
673 len = ret;
675 if (len == 0) {
676 what |= EVBUFFER_EOF;
677 goto err;
680 if (evbuffer_add(bufev->input, rbuf, len) == -1) {
681 what |= EVBUFFER_ERROR;
682 goto err;
685 proxy_bufferevent_add(&bufev->ev_read, bufev->timeout_read);
687 len = EVBUFFER_LENGTH(bufev->input);
688 if (bufev->wm_read.low != 0 && len < bufev->wm_read.low)
689 return;
690 if (bufev->wm_read.high != 0 && len > bufev->wm_read.high) {
691 struct evbuffer *buf = bufev->input;
692 event_del(&bufev->ev_read);
693 evbuffer_setcb(buf, bufferevent_read_pressure_cb, bufev);
694 return;
697 if (bufev->readcb != NULL)
698 (*bufev->readcb)(bufev, bufev->cbarg);
699 return;
701 retry:
702 proxy_bufferevent_add(&bufev->ev_read, bufev->timeout_read);
703 return;
705 err:
706 (*bufev->errorcb)(bufev, what, bufev->cbarg);
709 int
710 proxy_bufferevent_add(struct event *ev, int timeout)
712 struct timeval tv, *ptv = NULL;
714 if (timeout) {
715 timerclear(&tv);
716 tv.tv_sec = timeout;
717 ptv = &tv;
720 return (event_add(ev, ptv));
723 void
724 proxy_tls_writecb(int fd, short event, void *arg)
726 struct bufferevent *bufev = arg;
727 struct client *clt = bufev->cbarg;
728 ssize_t ret;
729 short what = EVBUFFER_WRITE;
730 size_t len;
732 if (event == EV_TIMEOUT) {
733 what |= EVBUFFER_TIMEOUT;
734 goto err;
737 if (EVBUFFER_LENGTH(bufev->output)) {
738 ret = tls_write(clt->clt_ctx,
739 EVBUFFER_DATA(bufev->output),
740 EVBUFFER_LENGTH(bufev->output));
741 if (ret == TLS_WANT_POLLIN || ret == TLS_WANT_POLLOUT) {
742 goto retry;
743 } else if (ret == -1) {
744 what |= EVBUFFER_ERROR;
745 goto err;
747 len = ret;
748 evbuffer_drain(bufev->output, len);
751 if (EVBUFFER_LENGTH(bufev->output) != 0)
752 proxy_bufferevent_add(&bufev->ev_write, bufev->timeout_write);
754 if (bufev->writecb != NULL &&
755 EVBUFFER_LENGTH(bufev->output) <= bufev->wm_write.low)
756 (*bufev->writecb)(bufev, bufev->cbarg);
757 return;
759 retry:
760 proxy_bufferevent_add(&bufev->ev_write, bufev->timeout_write);
761 return;
763 err:
764 (*bufev->errorcb)(bufev, what, bufev->cbarg);
767 void
768 proxy_client_free(struct client *clt)
770 if (clt->clt_evasr)
771 event_asr_abort(clt->clt_evasr);
773 if (clt->clt_addrinfo)
774 freeaddrinfo(clt->clt_addrinfo);
776 if (clt->clt_evconn_live)
777 event_del(&clt->clt_evconn);
779 if (clt->clt_fd != -1)
780 close(clt->clt_fd);
782 if (clt->clt_ctx)
783 tls_free(clt->clt_ctx);
785 if (clt->clt_bev)
786 bufferevent_free(clt->clt_bev);
788 free(clt->clt_server_name);
789 free(clt->clt_script_name);
790 free(clt->clt_path_info);
791 free(clt);