2 bd5f7954 2021-01-01 op * Copyright (c) 2020, 2021, 2022 Omar Polo <op@omarpolo.com>
4 d5aba4c7 2020-12-24 op * Permission to use, copy, modify, and distribute this software for any
5 d5aba4c7 2020-12-24 op * purpose with or without fee is hereby granted, provided that the above
6 d5aba4c7 2020-12-24 op * copyright notice and this permission notice appear in all copies.
8 d5aba4c7 2020-12-24 op * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 d5aba4c7 2020-12-24 op * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 d5aba4c7 2020-12-24 op * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 d5aba4c7 2020-12-24 op * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 d5aba4c7 2020-12-24 op * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 d5aba4c7 2020-12-24 op * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 d5aba4c7 2020-12-24 op * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 488f059a 2020-12-24 op #ifndef GMID_H
18 488f059a 2020-12-24 op #define GMID_H
20 52418c8d 2021-02-12 op #include "config.h"
22 252908e6 2021-01-24 op #include <sys/socket.h>
23 252908e6 2021-01-24 op #include <sys/types.h>
25 488f059a 2020-12-24 op #include <arpa/inet.h>
26 488f059a 2020-12-24 op #include <netinet/in.h>
28 252908e6 2021-01-24 op #include <dirent.h>
29 bc99d868 2021-03-19 op #include <limits.h>
30 bc99d868 2021-03-19 op #include <netdb.h>
31 ca21e100 2021-02-04 op #include <signal.h>
32 488f059a 2020-12-24 op #include <stdio.h>
33 488f059a 2020-12-24 op #include <stdlib.h>
34 b63e30ff 2021-02-07 op #include <time.h>
35 488f059a 2020-12-24 op #include <tls.h>
36 488f059a 2020-12-24 op #include <unistd.h>
38 02be96c6 2021-02-09 op #include <openssl/x509.h>
40 efb6210d 2021-10-02 op #if HAVE_EVENT2
41 efb6210d 2021-10-02 op # include <event2/event.h>
42 efb6210d 2021-10-02 op # include <event2/event_compat.h>
43 efb6210d 2021-10-02 op # include <event2/event_struct.h>
44 efb6210d 2021-10-02 op # include <event2/buffer.h>
45 efb6210d 2021-10-02 op # include <event2/buffer_compat.h>
46 efb6210d 2021-10-02 op # include <event2/bufferevent.h>
47 efb6210d 2021-10-02 op # include <event2/bufferevent_struct.h>
48 efb6210d 2021-10-02 op # include <event2/bufferevent_compat.h>
50 efb6210d 2021-10-02 op # include <event.h>
53 f361f799 2021-07-10 op #define GMID_STRING "gmid " VERSION
54 f361f799 2021-07-10 op #define GMID_VERSION "gmid/" VERSION
56 488f059a 2020-12-24 op #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
58 488f059a 2020-12-24 op #define SUCCESS 20
59 0be51733 2021-01-20 op #define TEMP_REDIRECT 30
60 488f059a 2020-12-24 op #define TEMP_FAILURE 40
61 35744950 2021-02-01 op #define CGI_ERROR 42
62 72b033ef 2021-12-29 op #define PROXY_ERROR 43
63 488f059a 2020-12-24 op #define NOT_FOUND 51
64 7b1d9790 2021-01-11 op #define PROXY_REFUSED 53
65 488f059a 2020-12-24 op #define BAD_REQUEST 59
66 02be96c6 2021-02-09 op #define CLIENT_CERT_REQ 60
67 02be96c6 2021-02-09 op #define CERT_NOT_AUTH 61
69 35cf19e3 2021-01-28 op /* maximum hostname and label length, +1 for the NUL-terminator */
70 35cf19e3 2021-01-28 op #define DOMAIN_NAME_LEN (253+1)
71 35cf19e3 2021-01-28 op #define LABEL_LEN (63+1)
73 8ad1c570 2021-05-09 op #define FCGI_MAX 32
74 2c3e53da 2021-03-03 op #define PROC_MAX 16
80 054387bb 2021-12-29 op uint16_t port_no;
83 054387bb 2021-12-29 op char *fragment;
86 054387bb 2021-12-29 op struct parser {
88 054387bb 2021-12-29 op struct iri *parsed;
89 054387bb 2021-12-29 op const char *err;
98 8ad1c570 2021-05-09 op extern struct fcgi fcgi[FCGI_MAX];
100 b7967bc1 2021-01-02 op TAILQ_HEAD(proxyhead, proxy);
101 7bdcc91e 2021-01-01 op struct proxy {
102 b7967bc1 2021-01-02 op char *match_proto;
103 b7967bc1 2021-01-02 op char *match_host;
104 b7967bc1 2021-01-02 op const char *match_port;
107 7bdcc91e 2021-01-01 op const char *port;
109 c7c8ef44 2021-01-01 op uint32_t protocols;
110 5128c0b0 2021-01-01 op int noverifyname;
111 7bdcc91e 2021-01-01 op uint8_t *cert;
112 7bdcc91e 2021-01-01 op size_t certlen;
113 7bdcc91e 2021-01-01 op uint8_t *key;
114 7bdcc91e 2021-01-01 op size_t keylen;
115 ba94a608 2022-01-04 op X509_STORE *reqca;
117 b7967bc1 2021-01-02 op TAILQ_ENTRY(proxy) proxies;
120 b8e64ccd 2021-03-31 op TAILQ_HEAD(lochead, location);
121 c8b74339 2021-01-24 op struct location {
122 fe5967cd 2021-01-27 op const char *match;
123 fe5967cd 2021-01-27 op const char *lang;
124 fe5967cd 2021-01-27 op const char *default_mime;
125 fe5967cd 2021-01-27 op const char *index;
126 252908e6 2021-01-24 op int auto_index; /* 0 auto, -1 off, 1 on */
127 6abda252 2021-02-06 op int block_code;
128 6abda252 2021-02-06 op const char *block_fmt;
130 02be96c6 2021-02-09 op X509_STORE *reqca;
131 793835cb 2021-02-23 op int disable_log;
134 fdea6aa0 2021-04-30 op const char *dir;
137 b8e64ccd 2021-03-31 op TAILQ_ENTRY(location) locations;
140 9cc630aa 2021-04-28 op TAILQ_HEAD(envhead, envlist);
141 9cc630aa 2021-04-28 op struct envlist {
144 9cc630aa 2021-04-28 op TAILQ_ENTRY(envlist) envs;
147 cc8c2901 2021-04-29 op TAILQ_HEAD(aliashead, alist);
148 cc8c2901 2021-04-29 op struct alist {
150 cc8c2901 2021-04-29 op TAILQ_ENTRY(alist) aliases;
153 b8e64ccd 2021-03-31 op extern TAILQ_HEAD(vhosthead, vhost) hosts;
154 15902770 2021-01-15 op struct vhost {
155 15902770 2021-01-15 op const char *domain;
156 15902770 2021-01-15 op const char *cert;
157 15902770 2021-01-15 op const char *key;
158 ff05125e 2021-10-15 op const char *ocsp;
159 15902770 2021-01-15 op const char *cgi;
160 e3ddf390 2021-02-06 op const char *entrypoint;
162 b8e64ccd 2021-03-31 op TAILQ_ENTRY(vhost) vhosts;
165 a8a1f439 2021-07-07 op * the first location rule is always '*' and holds the default
166 b8e64ccd 2021-03-31 op * settings for the vhost, then follows the "real" location
167 a8a1f439 2021-07-07 op * rules as specified in the configuration.
169 b8e64ccd 2021-03-31 op struct lochead locations;
171 9cc630aa 2021-04-28 op struct envhead env;
172 f740b61b 2021-06-11 op struct envhead params;
173 cc8c2901 2021-04-29 op struct aliashead aliases;
174 b7967bc1 2021-01-02 op struct proxyhead proxies;
177 a010b0dd 2021-01-18 op struct etm { /* extension to mime */
178 a010b0dd 2021-01-18 op const char *mime;
179 a010b0dd 2021-01-18 op const char *ext;
182 b2a6b613 2021-01-21 op struct mime {
183 a010b0dd 2021-01-18 op struct etm *t;
188 15902770 2021-01-15 op struct conf {
189 3abf91b0 2021-02-07 op /* from command line */
190 3abf91b0 2021-02-07 op int foreground;
193 3abf91b0 2021-02-07 op /* in the config */
196 ae08ec7d 2021-01-25 op uint32_t protos;
197 ae08ec7d 2021-01-25 op struct mime mime;
198 ae08ec7d 2021-01-25 op char *chroot;
203 d090dc84 2021-02-08 op extern const char *config_path;
204 15902770 2021-01-15 op extern struct conf conf;
206 bc99d868 2021-03-19 op extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
208 2c3e53da 2021-03-03 op extern int servpipes[PROC_MAX];
210 bc99d868 2021-03-19 op typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
213 efe7d180 2021-10-02 op REQUEST_UNDECIDED,
214 efe7d180 2021-10-02 op REQUEST_FILE,
217 efe7d180 2021-10-02 op REQUEST_FCGI,
218 72b033ef 2021-12-29 op REQUEST_PROXY,
219 efe7d180 2021-10-02 op REQUEST_DONE,
222 72b033ef 2021-12-29 op #define IS_INTERNAL_REQUEST(x) \
223 72b033ef 2021-12-29 op ((x) != REQUEST_CGI && \
224 72b033ef 2021-12-29 op (x) != REQUEST_FCGI && \
225 72b033ef 2021-12-29 op (x) != REQUEST_PROXY)
227 488f059a 2020-12-24 op struct client {
229 488f059a 2020-12-24 op struct tls *ctx;
231 0be51733 2021-01-20 op struct iri iri;
232 3300cbe0 2021-01-27 op char domain[DOMAIN_NAME_LEN];
234 efe7d180 2021-10-02 op struct bufferevent *bev;
238 efe7d180 2021-10-02 op struct bufferevent *cgibev;
240 b7967bc1 2021-01-02 op struct proxy *proxy;
241 72b033ef 2021-12-29 op struct bufferevent *proxybev;
242 72b033ef 2021-12-29 op struct tls *proxyctx;
243 72b033ef 2021-12-29 op struct event proxyev;
245 efe7d180 2021-10-02 op char *header;
248 488f059a 2020-12-24 op const char *meta;
250 11c98667 2021-04-25 op struct dirent **dir;
251 11c98667 2021-04-25 op int dirlen, diroff;
253 c836cdfa 2021-03-29 op /* big enough to store STATUS + SPACE + META + CRLF */
254 c836cdfa 2021-03-29 op char sbuf[1029];
255 27b2fa9a 2021-02-12 op ssize_t len, off;
257 709d6e5e 2021-01-10 op struct sockaddr_storage addr;
258 bc99d868 2021-03-19 op struct vhost *host; /* host they're talking to */
259 1feaf2a6 2021-05-15 op size_t loc; /* location matched */
261 207b3e80 2021-10-07 op SPLAY_ENTRY(client) entry;
263 207b3e80 2021-10-07 op SPLAY_HEAD(client_tree_id, client);
264 207b3e80 2021-10-07 op extern struct client_tree_id clients;
266 bc99d868 2021-03-19 op struct cgireq {
267 bc99d868 2021-03-19 op char buf[GEMINI_URL_LEN];
269 bc99d868 2021-03-19 op size_t iri_schema_off;
270 bc99d868 2021-03-19 op size_t iri_host_off;
271 bc99d868 2021-03-19 op size_t iri_port_off;
272 bc99d868 2021-03-19 op size_t iri_path_off;
273 bc99d868 2021-03-19 op size_t iri_query_off;
274 bc99d868 2021-03-19 op size_t iri_fragment_off;
275 bc99d868 2021-03-19 op int iri_portno;
277 bc99d868 2021-03-19 op char spath[PATH_MAX+1];
278 bc99d868 2021-03-19 op char relpath[PATH_MAX+1];
279 bc99d868 2021-03-19 op char addr[NI_MAXHOST+1];
281 bc99d868 2021-03-19 op /* AFAIK there isn't an upper limit for these two fields. */
282 bc99d868 2021-03-19 op char subject[64+1];
283 bc99d868 2021-03-19 op char issuer[64+1];
285 bc99d868 2021-03-19 op char hash[128+1];
286 89541eee 2021-04-13 op char version[8];
287 89541eee 2021-04-13 op char cipher[32];
288 89541eee 2021-04-13 op int cipher_strength;
289 bc99d868 2021-03-19 op time_t notbefore;
290 bc99d868 2021-03-19 op time_t notafter;
292 bc99d868 2021-03-19 op size_t host_off;
293 fdea6aa0 2021-04-30 op size_t loc_off;
296 72b033ef 2021-12-29 op struct connreq {
297 72b033ef 2021-12-29 op char host[NI_MAXHOST];
298 72b033ef 2021-12-29 op char port[NI_MAXSERV];
304 488f059a 2020-12-24 op FILE_EXECUTABLE,
305 488f059a 2020-12-24 op FILE_DIRECTORY,
306 488f059a 2020-12-24 op FILE_MISSING,
309 bc99d868 2021-03-19 op enum imsg_type {
310 bc99d868 2021-03-19 op IMSG_CGI_REQ,
311 bc99d868 2021-03-19 op IMSG_CGI_RES,
312 8ad1c570 2021-05-09 op IMSG_FCGI_REQ,
313 8ad1c570 2021-05-09 op IMSG_FCGI_FD,
314 72b033ef 2021-12-29 op IMSG_CONN_REQ,
315 72b033ef 2021-12-29 op IMSG_CONN_FD,
317 41395640 2021-07-19 op IMSG_LOG_REQUEST,
318 e952c505 2021-06-15 op IMSG_LOG_TYPE,
323 8443bff7 2021-01-25 op char *data_dir(void);
324 8443bff7 2021-01-25 op void load_local_cert(const char*, const char*);
325 ae08ec7d 2021-01-25 op void load_vhosts(void);
326 33ac26a0 2021-01-21 op int make_socket(int, int);
327 ae08ec7d 2021-01-25 op void setup_tls(void);
328 c8b74339 2021-01-24 op void init_config(void);
329 ca21e100 2021-02-04 op void free_config(void);
330 ae08ec7d 2021-01-25 op void drop_priv(void);
332 6abda252 2021-02-06 op void yyerror(const char*, ...);
333 13ed2fb6 2021-01-27 op void parse_conf(const char*);
334 f0a01fc7 2021-10-09 op void print_conf(void);
335 3b21cca3 2021-06-29 op int cmdline_symset(char *);
338 3abf91b0 2021-02-07 op void fatal(const char*, ...)
339 3abf91b0 2021-02-07 op __attribute__((format (printf, 1, 2)))
340 3abf91b0 2021-02-07 op __attribute__((__noreturn__));
342 3abf91b0 2021-02-07 op #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
343 3abf91b0 2021-02-07 op void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
344 3abf91b0 2021-02-07 op void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
345 3abf91b0 2021-02-07 op void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
346 3abf91b0 2021-02-07 op void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
347 3abf91b0 2021-02-07 op void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
348 3abf91b0 2021-02-07 op void log_request(struct client*, char*, size_t);
349 376a5407 2021-02-23 op int logger_main(int, struct imsgbuf*);
352 b2a6b613 2021-01-21 op void init_mime(struct mime*);
353 b2a6b613 2021-01-21 op void add_mime(struct mime*, const char*, const char*);
354 b2a6b613 2021-01-21 op void load_default_mime(struct mime*);
355 6119e13e 2021-01-19 op const char *mime(struct vhost*, const char*);
357 d3a08f4d 2021-01-17 op /* server.c */
358 090b8a89 2021-07-06 op extern int shutting_down;
359 c8b74339 2021-01-24 op const char *vhost_lang(struct vhost*, const char*);
360 c8b74339 2021-01-24 op const char *vhost_default_mime(struct vhost*, const char*);
361 c8b74339 2021-01-24 op const char *vhost_index(struct vhost*, const char*);
362 252908e6 2021-01-24 op int vhost_auto_index(struct vhost*, const char*);
363 6abda252 2021-02-06 op int vhost_block_return(struct vhost*, const char*, int*, const char**);
364 8ad1c570 2021-05-09 op int vhost_fastcgi(struct vhost*, const char*);
365 1feaf2a6 2021-05-15 op int vhost_dirfd(struct vhost*, const char*, size_t*);
366 6abda252 2021-02-06 op int vhost_strip(struct vhost*, const char*);
367 02be96c6 2021-02-09 op X509_STORE *vhost_require_ca(struct vhost*, const char*);
368 793835cb 2021-02-23 op int vhost_disable_log(struct vhost*, const char*);
370 9b8f5ed2 2021-02-03 op void mark_nonblock(int);
371 efe7d180 2021-10-02 op void client_write(struct bufferevent *, void *);
372 8ad1c570 2021-05-09 op void start_reply(struct client*, int, const char*);
373 efe7d180 2021-10-02 op void client_close(struct client *);
374 8ad1c570 2021-05-09 op struct client *try_client_by_id(int);
375 bc99d868 2021-03-19 op void loop(struct tls*, int, int, struct imsgbuf*);
377 207b3e80 2021-10-07 op int client_tree_cmp(struct client *, struct client *);
378 207b3e80 2021-10-07 op SPLAY_PROTOTYPE(client_tree_id, client, entry, client_tree_cmp);
381 11c98667 2021-04-25 op int scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
382 11c98667 2021-04-25 op int(*)(const struct dirent**, const struct dirent**));
383 11c98667 2021-04-25 op int select_non_dot(const struct dirent*);
384 11c98667 2021-04-25 op int select_non_dotdot(const struct dirent*);
387 881a9dd9 2021-01-16 op int send_string(int, const char*);
388 881a9dd9 2021-01-16 op int recv_string(int, char**);
389 2fafa2d2 2021-02-01 op int send_iri(int, struct iri*);
390 2fafa2d2 2021-02-01 op int recv_iri(int, struct iri*);
391 2fafa2d2 2021-02-01 op void free_recvd_iri(struct iri*);
392 881a9dd9 2021-01-16 op int send_vhost(int, struct vhost*);
393 881a9dd9 2021-01-16 op int recv_vhost(int, struct vhost**);
394 b63e30ff 2021-02-07 op int send_time(int, time_t);
395 b63e30ff 2021-02-07 op int recv_time(int, time_t*);
396 881a9dd9 2021-01-16 op int send_fd(int, int);
397 881a9dd9 2021-01-16 op int recv_fd(int);
398 bc99d868 2021-03-19 op int executor_main(struct imsgbuf*);
401 741b69be 2021-09-26 op void fcgi_read(struct bufferevent *, void *);
402 741b69be 2021-09-26 op void fcgi_write(struct bufferevent *, void *);
403 741b69be 2021-09-26 op void fcgi_error(struct bufferevent *, short, void *);
404 4cd25209 2021-10-07 op void fcgi_req(struct client *);
406 dafb57b8 2021-01-15 op /* sandbox.c */
407 62e001b0 2021-03-20 op void sandbox_server_process(void);
408 62e001b0 2021-03-20 op void sandbox_executor_process(void);
409 62e001b0 2021-03-20 op void sandbox_logger_process(void);
412 ef04b551 2021-01-09 op int valid_multibyte_utf8(struct parser*);
413 3300cbe0 2021-01-27 op char *utf8_nth(char*, size_t);
416 3c1cf9d0 2021-01-11 op int parse_iri(char*, struct iri*, const char**);
417 2fafa2d2 2021-02-01 op int serialize_iri(struct iri*, char*, size_t);
418 9f006a21 2021-02-07 op char *pct_decode_str(char *);
420 72b033ef 2021-12-29 op /* proxy.c */
421 72b033ef 2021-12-29 op int proxy_init(struct client *);
424 a2fd8013 2021-01-29 op int puny_decode(const char*, char*, size_t, const char**);
426 44ee1bac 2021-01-27 op /* utils.c */
427 ca21e100 2021-02-04 op void block_signals(void);
428 ca21e100 2021-02-04 op void unblock_signals(void);
429 44ee1bac 2021-01-27 op int starts_with(const char*, const char*);
430 44ee1bac 2021-01-27 op int ends_with(const char*, const char*);
431 44ee1bac 2021-01-27 op ssize_t filesize(int);
432 2fafa2d2 2021-02-01 op char *absolutify_path(const char*);
433 ca21e100 2021-02-04 op char *xstrdup(const char*);
434 b8e64ccd 2021-03-31 op void *xcalloc(size_t, size_t);
435 3abf91b0 2021-02-07 op void gen_certificate(const char*, const char*, const char*);
436 02be96c6 2021-02-09 op X509_STORE *load_ca(const char*);
437 02be96c6 2021-02-09 op int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
438 bc99d868 2021-03-19 op void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
