1 /*
2  * Copyright (c) 2020 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 #define GEMINI_URL_LEN (1024+3)	/* URL max len + \r\n + \0 */
41 
42 #define SUCCESS		20
43 #define TEMP_REDIRECT	30
44 #define TEMP_FAILURE	40
45 #define CGI_ERROR	42
46 #define NOT_FOUND	51
47 #define PROXY_REFUSED	53
48 #define BAD_REQUEST	59
49 #define CLIENT_CERT_REQ	60
50 #define CERT_NOT_AUTH	61
51 
52 #define MAX_USERS	64
53 
54 /* maximum hostname and label length, +1 for the NUL-terminator */
55 #define DOMAIN_NAME_LEN	(253+1)
56 #define LABEL_LEN	(63+1)
57 
58 #define PROC_MAX	16
59 
60 TAILQ_HEAD(lochead, location);
61 struct location {
62 	const char	*match;
63 	const char	*lang;
64 	const char	*default_mime;
65 	const char	*index;
66 	int		 auto_index; /* 0 auto, -1 off, 1 on */
67 	int		 block_code;
68 	const char	*block_fmt;
69 	int		 strip;
70 	X509_STORE	*reqca;
71 	int		 disable_log;
72 
73 	TAILQ_ENTRY(location) locations;
74 };
75 
76 TAILQ_HEAD(envhead, envlist);
77 struct envlist {
78 	char		*name;
79 	char		*value;
80 	TAILQ_ENTRY(envlist) envs;
81 };
82 
83 TAILQ_HEAD(aliashead, alist);
84 struct alist {
85 	char		*alias;
86 	TAILQ_ENTRY(alist) aliases;
87 };
88 
89 extern TAILQ_HEAD(vhosthead, vhost) hosts;
90 struct vhost {
91 	const char	*domain;
92 	const char	*cert;
93 	const char	*key;
94 	const char	*dir;
95 	const char	*cgi;
96 	const char	*entrypoint;
97 	int		 dirfd;
98 
99 	TAILQ_ENTRY(vhost) vhosts;
100 
101 	/* the first location rule is always '*' and holds the default
102 	 * settings for the vhost, then follows the "real" location
103 	 * rules as specified in the configuration. */
104 	struct lochead	 locations;
105 
106 	struct envhead	 env;
107 	struct aliashead aliases;
108 };
109 
110 struct etm {			/* extension to mime */
111 	const char	*mime;
112 	const char	*ext;
113 };
114 
115 struct mime {
116 	struct etm	*t;
117 	size_t		len;
118 	size_t		cap;
119 };
120 
121 struct conf {
122 	/* from command line */
123 	int		 foreground;
124 	int		 verbose;
125 
126 	/* in the config */
127 	int		 port;
128 	int		 ipv6;
129 	uint32_t	 protos;
130 	struct mime	 mime;
131 	char		*chroot;
132 	char		*user;
133 	int		 prefork;
134 };
135 
136 extern const char *config_path;
137 extern struct conf conf;
138 
139 extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
140 
141 extern int servpipes[PROC_MAX];
142 
143 struct iri {
144 	char		*schema;
145 	char		*host;
146 	char		*port;
147 	uint16_t	 port_no;
148 	char		*path;
149 	char		*query;
150 	char		*fragment;
151 };
152 
153 struct parser {
154 	char		*iri;
155 	struct iri	*parsed;
156 	const char	*err;
157 };
158 
159 struct client;
160 
161 typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
162 
163 typedef void (*statefn)(int, short, void*);
164 
165 /*
166  * DFA: handle_handshake is the initial state, close_conn the final.
167  * Sometimes we have an enter_* function to handle the state switch.
168  *
169  * handle_handshake -> handle_open_conn
170  * handle_handshake -> close_conn		// on err
171  *
172  * handle_open_conn -> handle_cgi_reply		// via open_file/dir/...
173  * handle_open_conn -> handle_dirlist		// ...same
174  * handle_open_conn -> send_file		// ...same
175  * handle_open_conn -> start_reply		// on error
176  *
177  * handle_cgi_reply -> handle_cgi	// after logging the CGI reply
178  * handle_cgi_reply -> start_reply	// on error
179  *
180  * handle_cgi -> close_conn
181  *
182  * handle_dirlist -> send_directory_listing
183  * handle_dirlist -> close_conn			// on error
184  *
185  * send_directory_listing -> close_conn
186  *
187  * send_file -> close_conn
188  */
189 struct client {
190 	int		 id;
191 	struct tls	*ctx;
192 	char		 req[GEMINI_URL_LEN];
193 	struct iri	 iri;
194 	char		 domain[DOMAIN_NAME_LEN];
195 	statefn		 next;
196 	int		 code;
197 	const char	*meta;
198 	int		 fd, pfd;
199 	struct dirent	**dir;
200 	int		 dirlen, diroff;
201 
202 	/* big enough to store STATUS + SPACE + META + CRLF */
203 	char		 sbuf[1029];
204 	ssize_t		 len, off;
205 
206 	struct sockaddr_storage	 addr;
207 	struct vhost	*host;	/* host they're talking to */
208 };
209 
210 struct cgireq {
211 	char		buf[GEMINI_URL_LEN];
212 
213 	size_t		iri_schema_off;
214 	size_t		iri_host_off;
215 	size_t		iri_port_off;
216 	size_t		iri_path_off;
217 	size_t		iri_query_off;
218 	size_t		iri_fragment_off;
219 	int		iri_portno;
220 
221 	char		spath[PATH_MAX+1];
222 	char		relpath[PATH_MAX+1];
223 	char		addr[NI_MAXHOST+1];
224 
225 	/* AFAIK there isn't an upper limit for these two fields. */
226 	char		subject[64+1];
227 	char		issuer[64+1];
228 
229 	char		hash[128+1];
230 	char		version[8];
231 	char		cipher[32];
232 	int		cipher_strength;
233 	time_t		notbefore;
234 	time_t		notafter;
235 
236 	size_t		host_off;
237 };
238 
239 enum {
240 	FILE_EXISTS,
241 	FILE_EXECUTABLE,
242 	FILE_DIRECTORY,
243 	FILE_MISSING,
244 };
245 
246 enum imsg_type {
247 	IMSG_CGI_REQ,
248 	IMSG_CGI_RES,
249 	IMSG_LOG,
250 	IMSG_QUIT,
251 };
252 
253 /* gmid.c */
254 char		*data_dir(void);
255 void		 load_local_cert(const char*, const char*);
256 void		 load_vhosts(void);
257 int		 make_socket(int, int);
258 void		 setup_tls(void);
259 void		 init_config(void);
260 void		 free_config(void);
261 void		 drop_priv(void);
262 
263 /* provided by lex/yacc */
264 extern FILE *yyin;
265 extern int yylineno;
266 extern int yyparse(void);
267 extern int yylex(void);
268 
269 void		 yyerror(const char*, ...);
270 int		 parse_portno(const char*);
271 void		 parse_conf(const char*);
272 
273 /* log.c */
274 void		 fatal(const char*, ...)
275 	__attribute__((format (printf, 1, 2)))
276 	__attribute__((__noreturn__));
277 
278 #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
279 void		 log_err(struct client*, const char*, ...)	LOG_ATTR_FMT;
280 void		 log_warn(struct client*, const char*, ...)	LOG_ATTR_FMT;
281 void		 log_notice(struct client*, const char*, ...)	LOG_ATTR_FMT;
282 void		 log_info(struct client*, const char*, ...)	LOG_ATTR_FMT;
283 void		 log_debug(struct client*, const char*, ...)	LOG_ATTR_FMT;
284 void		 log_request(struct client*, char*, size_t);
285 int		 logger_main(int, struct imsgbuf*);
286 
287 /* mime.c */
288 void		 init_mime(struct mime*);
289 void		 add_mime(struct mime*, const char*, const char*);
290 void		 load_default_mime(struct mime*);
291 const char	*mime(struct vhost*, const char*);
292 
293 /* server.c */
294 const char	*vhost_lang(struct vhost*, const char*);
295 const char	*vhost_default_mime(struct vhost*, const char*);
296 const char	*vhost_index(struct vhost*, const char*);
297 int		 vhost_auto_index(struct vhost*, const char*);
298 int		 vhost_block_return(struct vhost*, const char*, int*, const char**);
299 int		 vhost_strip(struct vhost*, const char*);
300 X509_STORE	*vhost_require_ca(struct vhost*, const char*);
301 int		 vhost_disable_log(struct vhost*, const char*);
302 void		 mark_nonblock(int);
303 void		 loop(struct tls*, int, int, struct imsgbuf*);
304 
305 /* dirs.c */
306 int		 scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
307 		    int(*)(const struct dirent**, const struct dirent**));
308 int		 select_non_dot(const struct dirent*);
309 int		 select_non_dotdot(const struct dirent*);
310 
311 /* ex.c */
312 int		 send_string(int, const char*);
313 int		 recv_string(int, char**);
314 int		 send_iri(int, struct iri*);
315 int		 recv_iri(int, struct iri*);
316 void		 free_recvd_iri(struct iri*);
317 int		 send_vhost(int, struct vhost*);
318 int		 recv_vhost(int, struct vhost**);
319 int		 send_time(int, time_t);
320 int		 recv_time(int, time_t*);
321 int		 send_fd(int, int);
322 int		 recv_fd(int);
323 int		 executor_main(struct imsgbuf*);
324 
325 /* sandbox.c */
326 void		 sandbox_server_process(void);
327 void		 sandbox_executor_process(void);
328 void		 sandbox_logger_process(void);
329 
330 /* utf8.c */
331 int		 valid_multibyte_utf8(struct parser*);
332 char		*utf8_nth(char*, size_t);
333 
334 /* iri.c */
335 int		 parse_iri(char*, struct iri*, const char**);
336 int		 trim_req_iri(char*, const char **);
337 int		 serialize_iri(struct iri*, char*, size_t);
338 char		*pct_decode_str(char *);
339 
340 /* puny.c */
341 int		 puny_decode(const char*, char*, size_t, const char**);
342 
343 /* utils.c */
344 void		 block_signals(void);
345 void		 unblock_signals(void);
346 int		 starts_with(const char*, const char*);
347 int		 ends_with(const char*, const char*);
348 ssize_t		 filesize(int);
349 char		*absolutify_path(const char*);
350 char		*xstrdup(const char*);
351 void		*xcalloc(size_t, size_t);
352 void		 gen_certificate(const char*, const char*, const char*);
353 X509_STORE	*load_ca(const char*);
354 int		 validate_against_ca(X509_STORE*, const uint8_t*, size_t);
355 void		 dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
356 
357 #endif