2 * Copyright (c) 2022 Omar Polo <op@omarpolo.com>
3 * Copyright (c) 2006 - 2015 Reyk Floeter <reyk@openbsd.org>
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.
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.
18 #include <sys/types.h>
19 #include <sys/queue.h>
21 #include <sys/socket.h>
24 #include <netinet/in.h>
25 #include <arpa/inet.h>
48 #define MINIMUM(a, b) ((a) < (b) ? (a) : (b))
50 /* provided by OpenBSD' base libevent but not in any header? */
51 extern void bufferevent_read_pressure_cb(struct evbuffer *, size_t,
54 void proxy_init(struct privsep *, struct privsep_proc *, void *);
55 int proxy_launch(struct galileo *);
56 void proxy_inflight_dec(const char *);
57 int proxy_dispatch_parent(int, struct privsep_proc *, struct imsg *);
58 void proxy_translate_gemtext(struct client *);
59 void proxy_resolved(struct asr_result *, void *);
60 void proxy_connect(int, short, void *);
61 void proxy_read(struct bufferevent *, void *);
62 void proxy_write(struct bufferevent *, void *);
63 void proxy_error(struct bufferevent *, short, void *);
64 int proxy_bufferevent_add(struct event *, int);
65 void proxy_tls_writecb(int, short, void *);
66 void proxy_tls_readcb(int, short, void *);
68 static struct privsep_proc procs[] = {
69 { "parent", PROC_PARENT, proxy_dispatch_parent },
72 volatile int proxy_clients;
73 volatile int proxy_inflight;
74 uint32_t proxy_fcg_id;
77 proxy(struct privsep *ps, struct privsep_proc *p)
79 proc_run(ps, p, procs, nitems(procs), proxy_init, NULL);
83 proxy_init(struct privsep *ps, struct privsep_proc *p, void *arg)
85 if (config_init(ps->ps_env) == -1)
86 fatal("failed to initialize configuration");
88 /* We use a custom shutdown callback */
89 /* p->p_shutdown = proxy_shutdown */
91 if (pledge("stdio recvfd unix inet dns", NULL) == -1)
96 proxy_launch(struct galileo *env)
98 event_add(&env->sc_evsock, NULL);
103 proxy_purge(struct server *srv)
108 proxy_inflight_dec(const char *why)
111 log_debug("%s: inflight decremented, now %d, %s",
112 __func__, proxy_inflight, why);
116 proxy_dispatch_parent(int fd, struct privsep_proc *p, struct imsg *imsg)
118 struct privsep *ps = p->p_ps;
119 struct galileo *env = ps->ps_env;
121 switch (imsg->hdr.type) {
123 if (config_getserver(env, imsg) == -1)
124 fatal("config_getproxy");
129 if (env->sc_sock_fd != -1) {
130 event_del(&env->sc_evsock);
131 close(env->sc_sock_fd);
134 env->sc_sock_fd = config_getsock(env, imsg);
135 if (env->sc_sock_fd == -1)
136 fatal("config_getsock");
138 event_set(&env->sc_evsock, env->sc_sock_fd,
139 EV_READ | EV_PERSIST, fcgi_accept, env);
140 event_add(&env->sc_evsock, NULL);
141 evtimer_set(&env->sc_evpause, fcgi_accept, env);
144 log_debug("config done!");
150 log_warnx("unknown message %d", imsg->hdr.type);
158 gemtext_translate_line(struct client *clt, char *line)
160 /* preformatted line / closing */
161 if (clt->clt_translate & TR_PRE) {
162 if (!strncmp(line, "```", 3)) {
163 clt->clt_translate &= ~TR_PRE;
164 return (clt_puts(clt, "</pre>"));
167 if (tp_htmlescape(clt->clt_tp, line) == -1)
169 return (clt_putc(clt, '\n'));
173 if (!strncmp(line, "* ", 2)) {
174 if (clt->clt_translate & TR_NAV) {
175 if (clt_puts(clt, "</ul></nav>") == -1)
177 clt->clt_translate &= ~TR_NAV;
180 if (!(clt->clt_translate & TR_LIST)) {
181 if (clt_puts(clt, "<ul>") == -1)
183 clt->clt_translate |= TR_LIST;
186 if (clt_puts(clt, "<li>") == -1 ||
187 tp_htmlescape(clt->clt_tp, line + 2) == -1 ||
188 clt_puts(clt, "</li>") == -1)
193 if (clt->clt_translate & TR_LIST) {
194 if (clt_puts(clt, "</ul>") == -1)
196 clt->clt_translate &= ~TR_LIST;
199 /* link -- TODO: relativify from SCRIPT_NAME */
200 if (!strncmp(line, "=>", 2)) {
204 line += strspn(line, " \t");
206 label = line + strcspn(line, " \t");
212 if (fnmatch("*.jpg", line, 0) == 0 ||
213 fnmatch("*.jpeg", line, 0) == 0 ||
214 fnmatch("*.gif", line, 0) == 0 ||
215 fnmatch("*.png", line, 0) == 0 ||
216 fnmatch("*.svg", line, 0) == 0 ||
217 fnmatch("*.webp", line, 0) == 0) {
218 if (clt->clt_translate & TR_NAV) {
219 if (clt_puts(clt, "</ul></nav>") == -1)
221 clt->clt_translate &= ~TR_NAV;
224 if (tp_figure(clt->clt_tp, line, label) == -1)
230 if (!(clt->clt_translate & TR_NAV)) {
231 if (clt_puts(clt, "<nav><ul>") == -1)
233 clt->clt_translate |= TR_NAV;
236 if (clt_puts(clt, "<li><a href='") == -1)
239 /* XXX: do proper parsing */
240 if (*line == '/' || strstr(line, "//") == NULL) {
241 if (tp_urlescape(clt->clt_tp,
242 clt->clt_script_name) == -1)
245 /* skip the first / */
249 if (tp_urlescape(clt->clt_tp, line) == -1 ||
250 clt_puts(clt, "'>") == -1 ||
251 tp_htmlescape(clt->clt_tp, label) == -1 ||
252 clt_puts(clt, "</a></li>") == -1)
258 if (clt->clt_translate & TR_NAV) {
259 if (clt_puts(clt, "</ul></nav>") == -1)
261 clt->clt_translate &= ~TR_NAV;
265 if (!strncmp(line, "```", 3)) {
266 clt->clt_translate |= TR_PRE;
267 return (clt_puts(clt, "<pre>"));
272 if (clt_puts(clt, "<blockquote>") == -1 ||
273 tp_htmlescape(clt->clt_tp, line + 1) == -1 ||
274 clt_puts(clt, "</blockquote>") == -1)
280 if (!strncmp(line, "###", 3)) {
281 if (clt_puts(clt, "<h3>") == -1 ||
282 tp_htmlescape(clt->clt_tp, line + 3) == -1 ||
283 clt_puts(clt, "</h3>") == -1)
287 if (!strncmp(line, "##", 2)) {
288 if (clt_puts(clt, "<h2>") == -1 ||
289 tp_htmlescape(clt->clt_tp, line + 2) == -1 ||
290 clt_puts(clt, "</h2>") == -1)
294 if (!strncmp(line, "#", 1)) {
295 if (clt_puts(clt, "<h1>") == -1 ||
296 tp_htmlescape(clt->clt_tp, line + 1) == -1 ||
297 clt_puts(clt, "</h1>") == -1)
302 /* Not following strictly the gemini specification... */
307 if (clt_puts(clt, "<p>") == -1 ||
308 tp_htmlescape(clt->clt_tp, line) == -1 ||
309 clt_puts(clt, "</p>") == -1)
316 proxy_translate_gemtext(struct client *clt)
318 struct bufferevent *bev = clt->clt_bev;
319 struct evbuffer *src = EVBUFFER_INPUT(bev);
325 line = evbuffer_readln(src, &len, EVBUFFER_EOL_CRLF);
329 r = gemtext_translate_line(clt, line);
336 static struct proxy_config *
337 proxy_server_match(struct galileo *env, struct client *clt)
341 if (clt->clt_server_name == NULL)
344 TAILQ_FOREACH(srv, &env->sc_servers, srv_entry) {
345 if (!strcmp(clt->clt_server_name, srv->srv_conf.host))
346 return &srv->srv_conf;
353 proxy_start_request(struct galileo *env, struct client *clt)
355 struct addrinfo hints;
356 struct asr_query *query;
359 if ((clt->clt_pc = proxy_server_match(env, clt)) == NULL) {
360 if (clt_printf(clt, "Status: 501\r\n\r\n") == -1)
362 fcgi_end_request(clt, 1);
366 (void)snprintf(port, sizeof(port), "%d", clt->clt_pc->proxy_port);
368 memset(&hints, 0, sizeof(hints));
369 hints.ai_family = AF_UNSPEC;
370 hints.ai_socktype = SOCK_STREAM;
372 query = getaddrinfo_async(clt->clt_pc->proxy_addr, port, &hints, NULL);
374 log_warn("getaddrinfo_async");
375 fcgi_abort_request(clt);
379 clt->clt_evasr = event_asr_run(query, proxy_resolved, clt);
380 if (clt->clt_evasr == NULL) {
381 log_warn("event_asr_run");
383 fcgi_abort_request(clt);
389 proxy_resolved(struct asr_result *res, void *d)
391 struct client *clt = d;
392 struct proxy_config *pc = clt->clt_pc;
394 clt->clt_evasr = NULL;
396 if (res->ar_gai_errno != 0) {
397 log_warnx("failed to resolve %s:%d: %s",
398 pc->proxy_addr, pc->proxy_port,
399 gai_strerror(res->ar_gai_errno));
400 if (clt_printf(clt, "Status: 501\r\n") == -1)
402 if (clt_printf(clt, "Content-Type: text/plain\r\n") == -1)
404 if (clt_printf(clt, "Proxy error; connection failed") == -1)
406 fcgi_end_request(clt, 1);
410 clt->clt_addrinfo = res->ar_addrinfo;
411 clt->clt_p = clt->clt_addrinfo;
412 proxy_connect(-1, 0, clt);
416 proxy_connect(int fd, short ev, void *d)
418 struct client *clt = d;
419 struct evbuffer *out;
421 struct tls_config *conf;
422 struct timeval conntv = {5, 0};
424 socklen_t len = sizeof(err);
427 if (clt->clt_p == NULL)
430 if (clt->clt_fd != -1) {
431 if (getsockopt(clt->clt_fd, SOL_SOCKET, SO_ERROR, &err, &len)
442 clt->clt_fd = socket(p->ai_family, p->ai_socktype | SOCK_NONBLOCK,
444 if (clt->clt_fd == -1) {
445 clt->clt_p = clt->clt_p->ai_next;
449 if (connect(clt->clt_fd, p->ai_addr, p->ai_addrlen) == 0)
452 clt->clt_evconn_live = 1;
453 event_set(&clt->clt_evconn, clt->clt_fd, EV_WRITE, proxy_connect, clt);
454 event_add(&clt->clt_evconn, &conntv);
458 clt->clt_evconn_live = 0;
459 freeaddrinfo(clt->clt_addrinfo);
460 clt->clt_addrinfo = clt->clt_p = NULL;
462 /* initialize TLS for Gemini */
463 if ((conf = tls_config_new()) == NULL) {
464 log_warn("tls_config_new failed");
468 tls_config_insecure_noverifycert(conf);
470 if ((clt->clt_ctx = tls_client()) == NULL) {
471 log_warnx("tls_client failed");
472 tls_config_free(conf);
476 if (tls_configure(clt->clt_ctx, conf) == -1) {
477 log_warnx("tls_configure failed");
478 tls_config_free(conf);
482 tls_config_free(conf);
484 if (tls_connect_socket(clt->clt_ctx, clt->clt_fd,
485 clt->clt_pc->proxy_name) == -1) {
486 log_warnx("tls_connect_socket failed");
490 clt->clt_bev = bufferevent_new(clt->clt_fd, proxy_read, proxy_write,
492 if (clt->clt_bev == NULL) {
493 log_warn("bufferevent_new");
496 out = EVBUFFER_OUTPUT(clt->clt_bev);
498 event_set(&clt->clt_bev->ev_read, clt->clt_fd, EV_READ,
499 proxy_tls_readcb, clt->clt_bev);
500 event_set(&clt->clt_bev->ev_write, clt->clt_fd, EV_WRITE,
501 proxy_tls_writecb, clt->clt_bev);
503 /* bufferevent_settimeout(); */
504 bufferevent_enable(clt->clt_bev, EV_READ|EV_WRITE);
506 /* TODO: compute the URL */
507 if (evbuffer_add_printf(out, "gemini://%s/%s\r\n",
508 clt->clt_pc->proxy_name, clt->clt_path_info) == -1) {
509 log_warn("bufferevent_printf failed");
516 log_warn("failed to connect to %s:%d",
517 clt->clt_pc->proxy_addr, clt->clt_pc->proxy_port);
518 if (clt_printf(clt, "Status: 501\r\n") == -1)
520 if (clt_printf(clt, "Content-Type: text/plain\r\n") == -1)
522 if (clt_printf(clt, "Proxy error; connection failed") == -1)
524 fcgi_end_request(clt, 1);
528 parse_mime(struct client *clt, char *mime, char *lang, size_t len)
532 if (strncmp(mime, "text/gemini", 11) != 0)
535 clt->clt_translate = TR_ENABLED;
537 if ((mime = strchr(mime, ';')) == NULL)
541 while ((t = strsep(&mime, ";")) != NULL) {
542 if (!strncmp(t, "charset=", 8)) {
544 if (!strncasecmp(t, "utf8", 4) ||
545 !strncasecmp(t, "utf-8", 5) ||
546 !strncasecmp(t, "ascii", 5)) {
547 log_debug("unknown charset %s", t);
553 if (!strncmp(t, "lang=", 5)) {
555 if ((semi = strchr(t, ';')) != NULL)
558 if (strlcpy(lang, t, len) >= len) {
559 log_debug("lang too long: %s", t);
573 proxy_tp_puts(struct template *tp, const char *c)
575 struct client *clt = tp->tp_arg;
577 if (clt_puts(clt, c) == -1) {
585 proxy_tp_putc(struct template *tp, int c)
587 struct client *clt = tp->tp_arg;
589 if (clt_putc(clt, c) == -1) {
597 proxy_read(struct bufferevent *bev, void *d)
599 struct client *clt = d;
600 struct proxy_config *pc = clt->clt_pc;
601 struct evbuffer *src = EVBUFFER_INPUT(bev);
607 if (clt->clt_headersdone) {
608 if (clt->clt_translate)
609 proxy_translate_gemtext(clt);
611 clt_write_bufferevent(clt, bev);
615 hdr = evbuffer_readln(src, &len, EVBUFFER_EOL_CRLF_STRICT);
617 if (EVBUFFER_LENGTH(src) >= 1026)
618 proxy_error(bev, EV_READ, clt);
623 !isdigit((unsigned char)hdr[0]) ||
624 !isdigit((unsigned char)hdr[1]) ||
626 log_warnx("invalid ");
627 proxy_error(bev, EV_READ, clt);
636 if (clt_puts(clt, "Status: 501\r\n") == -1)
639 "Content-Type: text/plain;charset=utf-8\r\n") == -1)
641 if (clt_puts(clt, "\r\n") == -1)
643 if (clt_printf(clt, "Request failed with code %c%c\n\n",
644 hdr[0], hdr[1]) == -1)
646 if (clt_printf(clt, "The server says: %s\n", &hdr[3]) == -1)
648 fcgi_end_request(clt, 1);
652 mime = hdr + 2 + strspn(hdr + 2, " \t");
653 if (parse_mime(clt, mime, lang, sizeof(lang)) == -1) {
654 if (clt_puts(clt, "Status: 501\r\n") == -1)
657 "Content-Type: text/plain;charset=utf-8\r\n") == -1)
659 if (clt_puts(clt, "\r\n") == -1)
661 if (clt_printf(clt, "Failed to parse the Gemini response\n")
663 fcgi_end_request(clt, 1);
667 if (clt->clt_translate) {
668 clt->clt_tp = template(clt, proxy_tp_puts, proxy_tp_putc);
670 ctype = "text/html;charset=utf-8";
674 if (clt_printf(clt, "Content-Type: %s\r\n\r\n", ctype) == -1)
677 clt->clt_headersdone = 1;
679 if (clt->clt_translate &&
680 tp_head(clt->clt_tp, lang, pc->stylesheet) == -1)
684 * Trigger the read again so we proceed with the response
696 proxy_write(struct bufferevent *bev, void *d)
702 proxy_error(struct bufferevent *bev, short err, void *d)
704 struct client *clt = d;
705 int status = !(err & EVBUFFER_EOF);
707 log_debug("proxy error, shutting down the connection (err: %x)",
710 if (!clt->clt_headersdone) {
711 if (clt_printf(clt, "Status: 501\r\n") == -1)
713 if (clt_printf(clt, "Content-Type: text/plain\r\n") == -1)
715 if (clt_printf(clt, "Proxy error\n") == -1)
717 } else if (status == 0) {
718 if (clt->clt_translate & TR_PRE) {
719 if (clt_puts(clt, "</pre>"))
721 clt->clt_translate &= ~TR_PRE;
724 if (clt->clt_translate & TR_LIST) {
725 if (clt_puts(clt, "</ul>") == -1)
727 clt->clt_translate &= ~TR_LIST;
730 if (clt->clt_translate & TR_NAV) {
731 if (clt_puts(clt, "</ul></nav>") == -1)
733 clt->clt_translate &= ~TR_NAV;
736 if (tp_foot(clt->clt_tp) == -1)
740 fcgi_end_request(clt, status);
744 proxy_tls_readcb(int fd, short event, void *arg)
746 struct bufferevent *bufev = arg;
747 struct client *clt = bufev->cbarg;
748 char rbuf[IBUF_READ_SIZE];
749 int what = EVBUFFER_READ;
750 int howmuch = IBUF_READ_SIZE;
754 if (event == EV_TIMEOUT) {
755 what |= EVBUFFER_TIMEOUT;
759 if (bufev->wm_read.high != 0)
760 howmuch = MINIMUM(sizeof(rbuf), bufev->wm_read.high);
762 ret = tls_read(clt->clt_ctx, rbuf, howmuch);
763 if (ret == TLS_WANT_POLLIN || ret == TLS_WANT_POLLOUT) {
765 } else if (ret == -1) {
766 what |= EVBUFFER_ERROR;
772 what |= EVBUFFER_EOF;
776 if (evbuffer_add(bufev->input, rbuf, len) == -1) {
777 what |= EVBUFFER_ERROR;
781 proxy_bufferevent_add(&bufev->ev_read, bufev->timeout_read);
783 len = EVBUFFER_LENGTH(bufev->input);
784 if (bufev->wm_read.low != 0 && len < bufev->wm_read.low)
786 if (bufev->wm_read.high != 0 && len > bufev->wm_read.high) {
787 struct evbuffer *buf = bufev->input;
788 event_del(&bufev->ev_read);
789 evbuffer_setcb(buf, bufferevent_read_pressure_cb, bufev);
793 if (bufev->readcb != NULL)
794 (*bufev->readcb)(bufev, bufev->cbarg);
798 proxy_bufferevent_add(&bufev->ev_read, bufev->timeout_read);
802 (*bufev->errorcb)(bufev, what, bufev->cbarg);
806 proxy_bufferevent_add(struct event *ev, int timeout)
808 struct timeval tv, *ptv = NULL;
816 return (event_add(ev, ptv));
820 proxy_tls_writecb(int fd, short event, void *arg)
822 struct bufferevent *bufev = arg;
823 struct client *clt = bufev->cbarg;
825 short what = EVBUFFER_WRITE;
828 if (event == EV_TIMEOUT) {
829 what |= EVBUFFER_TIMEOUT;
833 if (EVBUFFER_LENGTH(bufev->output)) {
834 ret = tls_write(clt->clt_ctx,
835 EVBUFFER_DATA(bufev->output),
836 EVBUFFER_LENGTH(bufev->output));
837 if (ret == TLS_WANT_POLLIN || ret == TLS_WANT_POLLOUT) {
839 } else if (ret == -1) {
840 what |= EVBUFFER_ERROR;
844 evbuffer_drain(bufev->output, len);
847 if (EVBUFFER_LENGTH(bufev->output) != 0)
848 proxy_bufferevent_add(&bufev->ev_write, bufev->timeout_write);
850 if (bufev->writecb != NULL &&
851 EVBUFFER_LENGTH(bufev->output) <= bufev->wm_write.low)
852 (*bufev->writecb)(bufev, bufev->cbarg);
856 proxy_bufferevent_add(&bufev->ev_write, bufev->timeout_write);
860 (*bufev->errorcb)(bufev, what, bufev->cbarg);
864 proxy_client_free(struct client *clt)
867 event_asr_abort(clt->clt_evasr);
869 if (clt->clt_addrinfo)
870 freeaddrinfo(clt->clt_addrinfo);
872 if (clt->clt_evconn_live)
873 event_del(&clt->clt_evconn);
875 if (clt->clt_fd != -1)
879 tls_free(clt->clt_ctx);
882 bufferevent_free(clt->clt_bev);
885 free(clt->clt_server_name);
886 free(clt->clt_script_name);
887 free(clt->clt_path_info);