1 /*
2  * Copyright (c) 2020, 2021, 2022 Omar Polo <op@omarpolo.com>
3  *
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.
7  *
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.
15  */
16 
17 #ifndef GMID_H
18 #define GMID_H
19 
20 #include "config.h"
21 
22 #include <sys/socket.h>
23 #include <sys/types.h>
24 
25 #include <arpa/inet.h>
26 #include <netinet/in.h>
27 
28 #include <dirent.h>
29 #include <limits.h>
30 #include <netdb.h>
31 #include <signal.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <time.h>
35 #include <tls.h>
36 #include <unistd.h>
37 
38 #include <openssl/x509.h>
39 
40 #if HAVE_EVENT2
41 # include <event2/event.h>
42 # include <event2/event_compat.h>
43 # include <event2/event_struct.h>
44 # include <event2/buffer.h>
45 # include <event2/buffer_compat.h>
46 # include <event2/bufferevent.h>
47 # include <event2/bufferevent_struct.h>
48 # include <event2/bufferevent_compat.h>
49 #else
50 # include <event.h>
51 #endif
52 
53 #define GMID_STRING	"gmid " VERSION
54 #define GMID_VERSION	"gmid/" VERSION
55 
56 #define GEMINI_URL_LEN (1024+3)	/* URL max len + \r\n + \0 */
57 
58 #define SUCCESS		20
59 #define TEMP_REDIRECT	30
60 #define TEMP_FAILURE	40
61 #define CGI_ERROR	42
62 #define PROXY_ERROR	43
63 #define NOT_FOUND	51
64 #define PROXY_REFUSED	53
65 #define BAD_REQUEST	59
66 #define CLIENT_CERT_REQ	60
67 #define CERT_NOT_AUTH	61
68 
69 /* maximum hostname and label length, +1 for the NUL-terminator */
70 #define DOMAIN_NAME_LEN	(253+1)
71 #define LABEL_LEN	(63+1)
72 
73 #define FCGI_MAX	32
74 #define PROC_MAX	16
75 
76 struct iri {
77 	char		*schema;
78 	char		*host;
79 	char		*port;
80 	uint16_t	 port_no;
81 	char		*path;
82 	char		*query;
83 	char		*fragment;
84 };
85 
86 struct parser {
87 	char		*iri;
88 	struct iri	*parsed;
89 	const char	*err;
90 };
91 
92 struct fcgi {
93 	int		 id;
94 	char		*path;
95 	char		*port;
96 	char		*prog;
97 };
98 extern struct fcgi fcgi[FCGI_MAX];
99 
100 struct proxy {
101 	char		*host;
102 	const char	*port;
103 	uint8_t		*cert;
104 	size_t		 certlen;
105 	uint8_t		*key;
106 	size_t		 keylen;
107 };
108 
109 TAILQ_HEAD(lochead, location);
110 struct location {
111 	const char	*match;
112 	const char	*lang;
113 	const char	*default_mime;
114 	const char	*index;
115 	int		 auto_index; /* 0 auto, -1 off, 1 on */
116 	int		 block_code;
117 	const char	*block_fmt;
118 	int		 strip;
119 	X509_STORE	*reqca;
120 	int		 disable_log;
121 	int		 fcgi;
122 
123 	const char	*dir;
124 	int		 dirfd;
125 
126 	TAILQ_ENTRY(location) locations;
127 };
128 
129 TAILQ_HEAD(envhead, envlist);
130 struct envlist {
131 	char		*name;
132 	char		*value;
133 	TAILQ_ENTRY(envlist) envs;
134 };
135 
136 TAILQ_HEAD(aliashead, alist);
137 struct alist {
138 	char		*alias;
139 	TAILQ_ENTRY(alist) aliases;
140 };
141 
142 extern TAILQ_HEAD(vhosthead, vhost) hosts;
143 struct vhost {
144 	const char	*domain;
145 	const char	*cert;
146 	const char	*key;
147 	const char	*ocsp;
148 	const char	*cgi;
149 	const char	*entrypoint;
150 
151 	TAILQ_ENTRY(vhost) vhosts;
152 
153 	/*
154 	 * the first location rule is always '*' and holds the default
155 	 * settings for the vhost, then follows the "real" location
156 	 * rules as specified in the configuration.
157 	 */
158 	struct lochead	 locations;
159 
160 	struct envhead	 env;
161 	struct envhead	 params;
162 	struct aliashead aliases;
163 	struct proxy	 proxy;
164 };
165 
166 struct etm {			/* extension to mime */
167 	const char	*mime;
168 	const char	*ext;
169 };
170 
171 struct mime {
172 	struct etm	*t;
173 	size_t		len;
174 	size_t		cap;
175 };
176 
177 struct conf {
178 	/* from command line */
179 	int		 foreground;
180 	int		 verbose;
181 
182 	/* in the config */
183 	int		 port;
184 	int		 ipv6;
185 	uint32_t	 protos;
186 	struct mime	 mime;
187 	char		*chroot;
188 	char		*user;
189 	int		 prefork;
190 };
191 
192 extern const char *config_path;
193 extern struct conf conf;
194 
195 extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
196 
197 extern int servpipes[PROC_MAX];
198 
199 typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
200 
201 enum {
202 	REQUEST_UNDECIDED,
203 	REQUEST_FILE,
204 	REQUEST_DIR,
205 	REQUEST_CGI,
206 	REQUEST_FCGI,
207 	REQUEST_PROXY,
208 	REQUEST_DONE,
209 };
210 
211 #define IS_INTERNAL_REQUEST(x) \
212 	((x) != REQUEST_CGI && \
213 	 (x) != REQUEST_FCGI && \
214 	 (x) != REQUEST_PROXY)
215 
216 struct client {
217 	uint32_t	 id;
218 	struct tls	*ctx;
219 	char		*req;
220 	struct iri	 iri;
221 	char		 domain[DOMAIN_NAME_LEN];
222 
223 	struct bufferevent *bev;
224 
225 	int		 type;
226 
227 	struct bufferevent *cgibev;
228 
229 	struct bufferevent *proxybev;
230 	struct tls	*proxyctx;
231 	struct event	 proxyev;
232 
233 	char		*header;
234 
235 	int		 code;
236 	const char	*meta;
237 	int		 fd, pfd;
238 	struct dirent	**dir;
239 	int		 dirlen, diroff;
240 
241 	/* big enough to store STATUS + SPACE + META + CRLF */
242 	char		 sbuf[1029];
243 	ssize_t		 len, off;
244 
245 	struct sockaddr_storage	 addr;
246 	struct vhost	*host;	/* host they're talking to */
247 	size_t		 loc;	/* location matched */
248 
249 	SPLAY_ENTRY(client) entry;
250 };
251 SPLAY_HEAD(client_tree_id, client);
252 extern struct client_tree_id clients;
253 
254 struct cgireq {
255 	char		buf[GEMINI_URL_LEN];
256 
257 	size_t		iri_schema_off;
258 	size_t		iri_host_off;
259 	size_t		iri_port_off;
260 	size_t		iri_path_off;
261 	size_t		iri_query_off;
262 	size_t		iri_fragment_off;
263 	int		iri_portno;
264 
265 	char		spath[PATH_MAX+1];
266 	char		relpath[PATH_MAX+1];
267 	char		addr[NI_MAXHOST+1];
268 
269 	/* AFAIK there isn't an upper limit for these two fields. */
270 	char		subject[64+1];
271 	char		issuer[64+1];
272 
273 	char		hash[128+1];
274 	char		version[8];
275 	char		cipher[32];
276 	int		cipher_strength;
277 	time_t		notbefore;
278 	time_t		notafter;
279 
280 	size_t		host_off;
281 	size_t		loc_off;
282 };
283 
284 struct connreq {
285 	char	host[NI_MAXHOST];
286 	char	port[NI_MAXSERV];
287 	int	flag;
288 };
289 
290 enum {
291 	FILE_EXISTS,
292 	FILE_EXECUTABLE,
293 	FILE_DIRECTORY,
294 	FILE_MISSING,
295 };
296 
297 enum imsg_type {
298 	IMSG_CGI_REQ,
299 	IMSG_CGI_RES,
300 	IMSG_FCGI_REQ,
301 	IMSG_FCGI_FD,
302 	IMSG_CONN_REQ,
303 	IMSG_CONN_FD,
304 	IMSG_LOG,
305 	IMSG_LOG_REQUEST,
306 	IMSG_LOG_TYPE,
307 	IMSG_QUIT,
308 };
309 
310 /* gmid.c */
311 char		*data_dir(void);
312 void		 load_local_cert(const char*, const char*);
313 void		 load_vhosts(void);
314 int		 make_socket(int, int);
315 void		 setup_tls(void);
316 void		 init_config(void);
317 void		 free_config(void);
318 void		 drop_priv(void);
319 
320 void		 yyerror(const char*, ...);
321 void		 parse_conf(const char*);
322 void		 print_conf(void);
323 int		 cmdline_symset(char *);
324 
325 /* log.c */
326 void		 fatal(const char*, ...)
327 	__attribute__((format (printf, 1, 2)))
328 	__attribute__((__noreturn__));
329 
330 #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
331 void		 log_err(struct client*, const char*, ...)	LOG_ATTR_FMT;
332 void		 log_warn(struct client*, const char*, ...)	LOG_ATTR_FMT;
333 void		 log_notice(struct client*, const char*, ...)	LOG_ATTR_FMT;
334 void		 log_info(struct client*, const char*, ...)	LOG_ATTR_FMT;
335 void		 log_debug(struct client*, const char*, ...)	LOG_ATTR_FMT;
336 void		 log_request(struct client*, char*, size_t);
337 int		 logger_main(int, struct imsgbuf*);
338 
339 /* mime.c */
340 void		 init_mime(struct mime*);
341 void		 add_mime(struct mime*, const char*, const char*);
342 void		 load_default_mime(struct mime*);
343 const char	*mime(struct vhost*, const char*);
344 
345 /* server.c */
346 extern int	shutting_down;
347 const char	*vhost_lang(struct vhost*, const char*);
348 const char	*vhost_default_mime(struct vhost*, const char*);
349 const char	*vhost_index(struct vhost*, const char*);
350 int		 vhost_auto_index(struct vhost*, const char*);
351 int		 vhost_block_return(struct vhost*, const char*, int*, const char**);
352 int		 vhost_fastcgi(struct vhost*, const char*);
353 int		 vhost_dirfd(struct vhost*, const char*, size_t*);
354 int		 vhost_strip(struct vhost*, const char*);
355 X509_STORE	*vhost_require_ca(struct vhost*, const char*);
356 int		 vhost_disable_log(struct vhost*, const char*);
357 
358 void		 mark_nonblock(int);
359 void		 client_write(struct bufferevent *, void *);
360 void		 start_reply(struct client*, int, const char*);
361 void		 client_close(struct client *);
362 struct client	*try_client_by_id(int);
363 void		 loop(struct tls*, int, int, struct imsgbuf*);
364 
365 int		 client_tree_cmp(struct client *, struct client *);
366 SPLAY_PROTOTYPE(client_tree_id, client, entry, client_tree_cmp);
367 
368 /* dirs.c */
369 int		 scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
370 		    int(*)(const struct dirent**, const struct dirent**));
371 int		 select_non_dot(const struct dirent*);
372 int		 select_non_dotdot(const struct dirent*);
373 
374 /* ex.c */
375 int		 send_string(int, const char*);
376 int		 recv_string(int, char**);
377 int		 send_iri(int, struct iri*);
378 int		 recv_iri(int, struct iri*);
379 void		 free_recvd_iri(struct iri*);
380 int		 send_vhost(int, struct vhost*);
381 int		 recv_vhost(int, struct vhost**);
382 int		 send_time(int, time_t);
383 int		 recv_time(int, time_t*);
384 int		 send_fd(int, int);
385 int		 recv_fd(int);
386 int		 executor_main(struct imsgbuf*);
387 
388 /* fcgi.c */
389 void		 fcgi_read(struct bufferevent *, void *);
390 void		 fcgi_write(struct bufferevent *, void *);
391 void		 fcgi_error(struct bufferevent *, short, void *);
392 void		 fcgi_req(struct client *);
393 
394 /* sandbox.c */
395 void		 sandbox_server_process(void);
396 void		 sandbox_executor_process(void);
397 void		 sandbox_logger_process(void);
398 
399 /* utf8.c */
400 int		 valid_multibyte_utf8(struct parser*);
401 char		*utf8_nth(char*, size_t);
402 
403 /* iri.c */
404 int		 parse_iri(char*, struct iri*, const char**);
405 int		 serialize_iri(struct iri*, char*, size_t);
406 char		*pct_decode_str(char *);
407 
408 /* proxy.c */
409 int		 proxy_init(struct client *);
410 
411 /* puny.c */
412 int		 puny_decode(const char*, char*, size_t, const char**);
413 
414 /* utils.c */
415 void		 block_signals(void);
416 void		 unblock_signals(void);
417 int		 starts_with(const char*, const char*);
418 int		 ends_with(const char*, const char*);
419 ssize_t		 filesize(int);
420 char		*absolutify_path(const char*);
421 char		*xstrdup(const char*);
422 void		*xcalloc(size_t, size_t);
423 void		 gen_certificate(const char*, const char*, const char*);
424 X509_STORE	*load_ca(const char*);
425 int		 validate_against_ca(X509_STORE*, const uint8_t*, size_t);
426 void		 dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
427 
428 #endif