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