2 d5aba4c7 2020-12-24 op * Copyright (c) 2020 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 8ad1c570 2021-05-09 op #include <event.h>
30 bc99d868 2021-03-19 op #include <limits.h>
31 bc99d868 2021-03-19 op #include <netdb.h>
32 ca21e100 2021-02-04 op #include <signal.h>
33 488f059a 2020-12-24 op #include <stdio.h>
34 488f059a 2020-12-24 op #include <stdlib.h>
35 b63e30ff 2021-02-07 op #include <time.h>
36 488f059a 2020-12-24 op #include <tls.h>
37 488f059a 2020-12-24 op #include <unistd.h>
39 02be96c6 2021-02-09 op #include <openssl/x509.h>
41 f361f799 2021-07-10 op #define GMID_STRING "gmid " VERSION
42 f361f799 2021-07-10 op #define GMID_VERSION "gmid/" VERSION
44 488f059a 2020-12-24 op #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
46 488f059a 2020-12-24 op #define SUCCESS 20
47 0be51733 2021-01-20 op #define TEMP_REDIRECT 30
48 488f059a 2020-12-24 op #define TEMP_FAILURE 40
49 35744950 2021-02-01 op #define CGI_ERROR 42
50 488f059a 2020-12-24 op #define NOT_FOUND 51
51 7b1d9790 2021-01-11 op #define PROXY_REFUSED 53
52 488f059a 2020-12-24 op #define BAD_REQUEST 59
53 02be96c6 2021-02-09 op #define CLIENT_CERT_REQ 60
54 02be96c6 2021-02-09 op #define CERT_NOT_AUTH 61
56 488f059a 2020-12-24 op #define MAX_USERS 64
58 35cf19e3 2021-01-28 op /* maximum hostname and label length, +1 for the NUL-terminator */
59 35cf19e3 2021-01-28 op #define DOMAIN_NAME_LEN (253+1)
60 35cf19e3 2021-01-28 op #define LABEL_LEN (63+1)
62 8ad1c570 2021-05-09 op #define FCGI_MAX 32
63 2c3e53da 2021-03-03 op #define PROC_MAX 16
72 741b69be 2021-09-26 op struct bufferevent *bev;
74 090b8a89 2021-07-06 op /* number of pending clients */
77 8ad1c570 2021-05-09 op #define FCGI_OFF 0
78 8ad1c570 2021-05-09 op #define FCGI_INFLIGHT 1
79 8ad1c570 2021-05-09 op #define FCGI_READY 2
82 8ad1c570 2021-05-09 op extern struct fcgi fcgi[FCGI_MAX];
84 b8e64ccd 2021-03-31 op TAILQ_HEAD(lochead, location);
85 c8b74339 2021-01-24 op struct location {
86 fe5967cd 2021-01-27 op const char *match;
87 fe5967cd 2021-01-27 op const char *lang;
88 fe5967cd 2021-01-27 op const char *default_mime;
89 fe5967cd 2021-01-27 op const char *index;
90 252908e6 2021-01-24 op int auto_index; /* 0 auto, -1 off, 1 on */
91 6abda252 2021-02-06 op int block_code;
92 6abda252 2021-02-06 op const char *block_fmt;
94 02be96c6 2021-02-09 op X509_STORE *reqca;
95 793835cb 2021-02-23 op int disable_log;
98 fdea6aa0 2021-04-30 op const char *dir;
101 b8e64ccd 2021-03-31 op TAILQ_ENTRY(location) locations;
104 9cc630aa 2021-04-28 op TAILQ_HEAD(envhead, envlist);
105 9cc630aa 2021-04-28 op struct envlist {
108 9cc630aa 2021-04-28 op TAILQ_ENTRY(envlist) envs;
111 cc8c2901 2021-04-29 op TAILQ_HEAD(aliashead, alist);
112 cc8c2901 2021-04-29 op struct alist {
114 cc8c2901 2021-04-29 op TAILQ_ENTRY(alist) aliases;
117 b8e64ccd 2021-03-31 op extern TAILQ_HEAD(vhosthead, vhost) hosts;
118 15902770 2021-01-15 op struct vhost {
119 15902770 2021-01-15 op const char *domain;
120 15902770 2021-01-15 op const char *cert;
121 15902770 2021-01-15 op const char *key;
122 15902770 2021-01-15 op const char *cgi;
123 e3ddf390 2021-02-06 op const char *entrypoint;
125 b8e64ccd 2021-03-31 op TAILQ_ENTRY(vhost) vhosts;
128 a8a1f439 2021-07-07 op * the first location rule is always '*' and holds the default
129 b8e64ccd 2021-03-31 op * settings for the vhost, then follows the "real" location
130 a8a1f439 2021-07-07 op * rules as specified in the configuration.
132 b8e64ccd 2021-03-31 op struct lochead locations;
134 9cc630aa 2021-04-28 op struct envhead env;
135 f740b61b 2021-06-11 op struct envhead params;
136 cc8c2901 2021-04-29 op struct aliashead aliases;
139 a010b0dd 2021-01-18 op struct etm { /* extension to mime */
140 a010b0dd 2021-01-18 op const char *mime;
141 a010b0dd 2021-01-18 op const char *ext;
144 b2a6b613 2021-01-21 op struct mime {
145 a010b0dd 2021-01-18 op struct etm *t;
150 15902770 2021-01-15 op struct conf {
151 3abf91b0 2021-02-07 op /* from command line */
152 3abf91b0 2021-02-07 op int foreground;
155 3abf91b0 2021-02-07 op /* in the config */
158 ae08ec7d 2021-01-25 op uint32_t protos;
159 ae08ec7d 2021-01-25 op struct mime mime;
160 ae08ec7d 2021-01-25 op char *chroot;
165 d090dc84 2021-02-08 op extern const char *config_path;
166 15902770 2021-01-15 op extern struct conf conf;
168 bc99d868 2021-03-19 op extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
170 2c3e53da 2021-03-03 op extern int servpipes[PROC_MAX];
173 0be51733 2021-01-20 op char *schema;
176 0be51733 2021-01-20 op uint16_t port_no;
179 0be51733 2021-01-20 op char *fragment;
182 0be51733 2021-01-20 op struct parser {
184 0be51733 2021-01-20 op struct iri *parsed;
185 0be51733 2021-01-20 op const char *err;
188 8ad1c570 2021-05-09 op struct mbuf {
191 8ad1c570 2021-05-09 op TAILQ_ENTRY(mbuf) mbufs;
194 8ad1c570 2021-05-09 op TAILQ_HEAD(mbufhead, mbuf);
196 bc99d868 2021-03-19 op typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
198 abc007d2 2021-02-08 op typedef void (*statefn)(int, short, void*);
201 92da8285 2021-02-01 op * DFA: handle_handshake is the initial state, close_conn the final.
202 5f715ce4 2021-02-02 op * Sometimes we have an enter_* function to handle the state switch.
204 92da8285 2021-02-01 op * handle_handshake -> handle_open_conn
205 92da8285 2021-02-01 op * handle_handshake -> close_conn // on err
207 35744950 2021-02-01 op * handle_open_conn -> handle_cgi_reply // via open_file/dir/...
208 8ad1c570 2021-05-09 op * handle_open_conn -> send_fcgi_req // via apply_fastcgi, IMSG_FCGI_FD
209 5f715ce4 2021-02-02 op * handle_open_conn -> handle_dirlist // ...same
210 92da8285 2021-02-01 op * handle_open_conn -> send_file // ...same
211 35744950 2021-02-01 op * handle_open_conn -> start_reply // on error
213 35744950 2021-02-01 op * handle_cgi_reply -> handle_cgi // after logging the CGI reply
214 35744950 2021-02-01 op * handle_cgi_reply -> start_reply // on error
216 92da8285 2021-02-01 op * handle_cgi -> close_conn
218 8ad1c570 2021-05-09 op * send_fcgi_req -> copy_mbuf // via handle_fcgi
219 8ad1c570 2021-05-09 op * handle_fcgi -> close_all // on error
220 8ad1c570 2021-05-09 op * copy_mbuf -> close_conn // on success/error
222 5f715ce4 2021-02-02 op * handle_dirlist -> send_directory_listing
223 5f715ce4 2021-02-02 op * handle_dirlist -> close_conn // on error
225 92da8285 2021-02-01 op * send_directory_listing -> close_conn
227 92da8285 2021-02-01 op * send_file -> close_conn
229 488f059a 2020-12-24 op struct client {
231 488f059a 2020-12-24 op struct tls *ctx;
232 0be51733 2021-01-20 op char req[GEMINI_URL_LEN];
233 0be51733 2021-01-20 op struct iri iri;
234 3300cbe0 2021-01-27 op char domain[DOMAIN_NAME_LEN];
237 8ad1c570 2021-05-09 op * start_reply uses this to know what function call after the
238 8ad1c570 2021-05-09 op * reply. It's also used as sentinel value in fastcgi to know
239 8ad1c570 2021-05-09 op * if the server has closed the request.
241 abc007d2 2021-02-08 op statefn next;
244 488f059a 2020-12-24 op const char *meta;
246 11c98667 2021-04-25 op struct dirent **dir;
247 11c98667 2021-04-25 op int dirlen, diroff;
250 c836cdfa 2021-03-29 op /* big enough to store STATUS + SPACE + META + CRLF */
251 c836cdfa 2021-03-29 op char sbuf[1029];
252 27b2fa9a 2021-02-12 op ssize_t len, off;
254 8ad1c570 2021-05-09 op struct mbufhead mbufhead;
256 709d6e5e 2021-01-10 op struct sockaddr_storage addr;
257 bc99d868 2021-03-19 op struct vhost *host; /* host they're talking to */
258 1feaf2a6 2021-05-15 op size_t loc; /* location matched */
261 8ad1c570 2021-05-09 op extern struct client clients[MAX_USERS];
263 bc99d868 2021-03-19 op struct cgireq {
264 bc99d868 2021-03-19 op char buf[GEMINI_URL_LEN];
266 bc99d868 2021-03-19 op size_t iri_schema_off;
267 bc99d868 2021-03-19 op size_t iri_host_off;
268 bc99d868 2021-03-19 op size_t iri_port_off;
269 bc99d868 2021-03-19 op size_t iri_path_off;
270 bc99d868 2021-03-19 op size_t iri_query_off;
271 bc99d868 2021-03-19 op size_t iri_fragment_off;
272 bc99d868 2021-03-19 op int iri_portno;
274 bc99d868 2021-03-19 op char spath[PATH_MAX+1];
275 bc99d868 2021-03-19 op char relpath[PATH_MAX+1];
276 bc99d868 2021-03-19 op char addr[NI_MAXHOST+1];
278 bc99d868 2021-03-19 op /* AFAIK there isn't an upper limit for these two fields. */
279 bc99d868 2021-03-19 op char subject[64+1];
280 bc99d868 2021-03-19 op char issuer[64+1];
282 bc99d868 2021-03-19 op char hash[128+1];
283 89541eee 2021-04-13 op char version[8];
284 89541eee 2021-04-13 op char cipher[32];
285 89541eee 2021-04-13 op int cipher_strength;
286 bc99d868 2021-03-19 op time_t notbefore;
287 bc99d868 2021-03-19 op time_t notafter;
289 bc99d868 2021-03-19 op size_t host_off;
290 fdea6aa0 2021-04-30 op size_t loc_off;
295 488f059a 2020-12-24 op FILE_EXECUTABLE,
296 488f059a 2020-12-24 op FILE_DIRECTORY,
297 488f059a 2020-12-24 op FILE_MISSING,
300 bc99d868 2021-03-19 op enum imsg_type {
301 bc99d868 2021-03-19 op IMSG_CGI_REQ,
302 bc99d868 2021-03-19 op IMSG_CGI_RES,
303 8ad1c570 2021-05-09 op IMSG_FCGI_REQ,
304 8ad1c570 2021-05-09 op IMSG_FCGI_FD,
306 41395640 2021-07-19 op IMSG_LOG_REQUEST,
307 e952c505 2021-06-15 op IMSG_LOG_TYPE,
312 8443bff7 2021-01-25 op char *data_dir(void);
313 8443bff7 2021-01-25 op void load_local_cert(const char*, const char*);
314 ae08ec7d 2021-01-25 op void load_vhosts(void);
315 33ac26a0 2021-01-21 op int make_socket(int, int);
316 ae08ec7d 2021-01-25 op void setup_tls(void);
317 c8b74339 2021-01-24 op void init_config(void);
318 ca21e100 2021-02-04 op void free_config(void);
319 ae08ec7d 2021-01-25 op void drop_priv(void);
321 6abda252 2021-02-06 op void yyerror(const char*, ...);
322 13ed2fb6 2021-01-27 op void parse_conf(const char*);
323 3b21cca3 2021-06-29 op int cmdline_symset(char *);
326 3abf91b0 2021-02-07 op void fatal(const char*, ...)
327 3abf91b0 2021-02-07 op __attribute__((format (printf, 1, 2)))
328 3abf91b0 2021-02-07 op __attribute__((__noreturn__));
330 3abf91b0 2021-02-07 op #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
331 3abf91b0 2021-02-07 op void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
332 3abf91b0 2021-02-07 op void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
333 3abf91b0 2021-02-07 op void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
334 3abf91b0 2021-02-07 op void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
335 3abf91b0 2021-02-07 op void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
336 3abf91b0 2021-02-07 op void log_request(struct client*, char*, size_t);
337 376a5407 2021-02-23 op int logger_main(int, struct imsgbuf*);
340 b2a6b613 2021-01-21 op void init_mime(struct mime*);
341 b2a6b613 2021-01-21 op void add_mime(struct mime*, const char*, const char*);
342 b2a6b613 2021-01-21 op void load_default_mime(struct mime*);
343 6119e13e 2021-01-19 op const char *mime(struct vhost*, const char*);
345 d3a08f4d 2021-01-17 op /* server.c */
346 090b8a89 2021-07-06 op extern int shutting_down;
347 c8b74339 2021-01-24 op const char *vhost_lang(struct vhost*, const char*);
348 c8b74339 2021-01-24 op const char *vhost_default_mime(struct vhost*, const char*);
349 c8b74339 2021-01-24 op const char *vhost_index(struct vhost*, const char*);
350 252908e6 2021-01-24 op int vhost_auto_index(struct vhost*, const char*);
351 6abda252 2021-02-06 op int vhost_block_return(struct vhost*, const char*, int*, const char**);
352 8ad1c570 2021-05-09 op int vhost_fastcgi(struct vhost*, const char*);
353 1feaf2a6 2021-05-15 op int vhost_dirfd(struct vhost*, const char*, size_t*);
354 6abda252 2021-02-06 op int vhost_strip(struct vhost*, const char*);
355 02be96c6 2021-02-09 op X509_STORE *vhost_require_ca(struct vhost*, const char*);
356 793835cb 2021-02-23 op int vhost_disable_log(struct vhost*, const char*);
358 9b8f5ed2 2021-02-03 op void mark_nonblock(int);
359 8ad1c570 2021-05-09 op void start_reply(struct client*, int, const char*);
360 8ad1c570 2021-05-09 op void close_conn(int, short, void*);
361 8ad1c570 2021-05-09 op struct client *try_client_by_id(int);
362 bc99d868 2021-03-19 op void loop(struct tls*, int, int, struct imsgbuf*);
365 11c98667 2021-04-25 op int scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
366 11c98667 2021-04-25 op int(*)(const struct dirent**, const struct dirent**));
367 11c98667 2021-04-25 op int select_non_dot(const struct dirent*);
368 11c98667 2021-04-25 op int select_non_dotdot(const struct dirent*);
371 881a9dd9 2021-01-16 op int send_string(int, const char*);
372 881a9dd9 2021-01-16 op int recv_string(int, char**);
373 2fafa2d2 2021-02-01 op int send_iri(int, struct iri*);
374 2fafa2d2 2021-02-01 op int recv_iri(int, struct iri*);
375 2fafa2d2 2021-02-01 op void free_recvd_iri(struct iri*);
376 881a9dd9 2021-01-16 op int send_vhost(int, struct vhost*);
377 881a9dd9 2021-01-16 op int recv_vhost(int, struct vhost**);
378 b63e30ff 2021-02-07 op int send_time(int, time_t);
379 b63e30ff 2021-02-07 op int recv_time(int, time_t*);
380 881a9dd9 2021-01-16 op int send_fd(int, int);
381 881a9dd9 2021-01-16 op int recv_fd(int);
382 bc99d868 2021-03-19 op int executor_main(struct imsgbuf*);
385 090b8a89 2021-07-06 op void fcgi_close_backend(struct fcgi *);
386 741b69be 2021-09-26 op void fcgi_read(struct bufferevent *, void *);
387 741b69be 2021-09-26 op void fcgi_write(struct bufferevent *, void *);
388 741b69be 2021-09-26 op void fcgi_error(struct bufferevent *, short, void *);
389 741b69be 2021-09-26 op void fcgi_req(struct fcgi *, struct client *);
391 dafb57b8 2021-01-15 op /* sandbox.c */
392 62e001b0 2021-03-20 op void sandbox_server_process(void);
393 62e001b0 2021-03-20 op void sandbox_executor_process(void);
394 62e001b0 2021-03-20 op void sandbox_logger_process(void);
397 ef04b551 2021-01-09 op int valid_multibyte_utf8(struct parser*);
398 3300cbe0 2021-01-27 op char *utf8_nth(char*, size_t);
401 3c1cf9d0 2021-01-11 op int parse_iri(char*, struct iri*, const char**);
402 c4f682f8 2021-01-27 op int trim_req_iri(char*, const char **);
403 2fafa2d2 2021-02-01 op int serialize_iri(struct iri*, char*, size_t);
404 9f006a21 2021-02-07 op char *pct_decode_str(char *);
407 a2fd8013 2021-01-29 op int puny_decode(const char*, char*, size_t, const char**);
409 44ee1bac 2021-01-27 op /* utils.c */
410 ca21e100 2021-02-04 op void block_signals(void);
411 ca21e100 2021-02-04 op void unblock_signals(void);
412 44ee1bac 2021-01-27 op int starts_with(const char*, const char*);
413 44ee1bac 2021-01-27 op int ends_with(const char*, const char*);
414 44ee1bac 2021-01-27 op ssize_t filesize(int);
415 2fafa2d2 2021-02-01 op char *absolutify_path(const char*);
416 ca21e100 2021-02-04 op char *xstrdup(const char*);
417 b8e64ccd 2021-03-31 op void *xcalloc(size_t, size_t);
418 3abf91b0 2021-02-07 op void gen_certificate(const char*, const char*, const char*);
419 02be96c6 2021-02-09 op X509_STORE *load_ca(const char*);
420 02be96c6 2021-02-09 op int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
421 bc99d868 2021-03-19 op void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);