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 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 488f059a 2020-12-24 op #define NOT_FOUND 51
63 7b1d9790 2021-01-11 op #define PROXY_REFUSED 53
64 488f059a 2020-12-24 op #define BAD_REQUEST 59
65 02be96c6 2021-02-09 op #define CLIENT_CERT_REQ 60
66 02be96c6 2021-02-09 op #define CERT_NOT_AUTH 61
68 488f059a 2020-12-24 op #define MAX_USERS 64
70 35cf19e3 2021-01-28 op /* maximum hostname and label length, +1 for the NUL-terminator */
71 35cf19e3 2021-01-28 op #define DOMAIN_NAME_LEN (253+1)
72 35cf19e3 2021-01-28 op #define LABEL_LEN (63+1)
74 8ad1c570 2021-05-09 op #define FCGI_MAX 32
75 2c3e53da 2021-03-03 op #define PROC_MAX 16
84 741b69be 2021-09-26 op struct bufferevent *bev;
86 090b8a89 2021-07-06 op /* number of pending clients */
89 8ad1c570 2021-05-09 op #define FCGI_OFF 0
90 8ad1c570 2021-05-09 op #define FCGI_INFLIGHT 1
91 8ad1c570 2021-05-09 op #define FCGI_READY 2
94 8ad1c570 2021-05-09 op extern struct fcgi fcgi[FCGI_MAX];
96 b8e64ccd 2021-03-31 op TAILQ_HEAD(lochead, location);
97 c8b74339 2021-01-24 op struct location {
98 fe5967cd 2021-01-27 op const char *match;
99 fe5967cd 2021-01-27 op const char *lang;
100 fe5967cd 2021-01-27 op const char *default_mime;
101 fe5967cd 2021-01-27 op const char *index;
102 252908e6 2021-01-24 op int auto_index; /* 0 auto, -1 off, 1 on */
103 6abda252 2021-02-06 op int block_code;
104 6abda252 2021-02-06 op const char *block_fmt;
106 02be96c6 2021-02-09 op X509_STORE *reqca;
107 793835cb 2021-02-23 op int disable_log;
110 fdea6aa0 2021-04-30 op const char *dir;
113 b8e64ccd 2021-03-31 op TAILQ_ENTRY(location) locations;
116 9cc630aa 2021-04-28 op TAILQ_HEAD(envhead, envlist);
117 9cc630aa 2021-04-28 op struct envlist {
120 9cc630aa 2021-04-28 op TAILQ_ENTRY(envlist) envs;
123 cc8c2901 2021-04-29 op TAILQ_HEAD(aliashead, alist);
124 cc8c2901 2021-04-29 op struct alist {
126 cc8c2901 2021-04-29 op TAILQ_ENTRY(alist) aliases;
129 b8e64ccd 2021-03-31 op extern TAILQ_HEAD(vhosthead, vhost) hosts;
130 15902770 2021-01-15 op struct vhost {
131 15902770 2021-01-15 op const char *domain;
132 15902770 2021-01-15 op const char *cert;
133 15902770 2021-01-15 op const char *key;
134 15902770 2021-01-15 op const char *cgi;
135 e3ddf390 2021-02-06 op const char *entrypoint;
137 b8e64ccd 2021-03-31 op TAILQ_ENTRY(vhost) vhosts;
140 a8a1f439 2021-07-07 op * the first location rule is always '*' and holds the default
141 b8e64ccd 2021-03-31 op * settings for the vhost, then follows the "real" location
142 a8a1f439 2021-07-07 op * rules as specified in the configuration.
144 b8e64ccd 2021-03-31 op struct lochead locations;
146 9cc630aa 2021-04-28 op struct envhead env;
147 f740b61b 2021-06-11 op struct envhead params;
148 cc8c2901 2021-04-29 op struct aliashead aliases;
151 a010b0dd 2021-01-18 op struct etm { /* extension to mime */
152 a010b0dd 2021-01-18 op const char *mime;
153 a010b0dd 2021-01-18 op const char *ext;
156 b2a6b613 2021-01-21 op struct mime {
157 a010b0dd 2021-01-18 op struct etm *t;
162 15902770 2021-01-15 op struct conf {
163 3abf91b0 2021-02-07 op /* from command line */
164 3abf91b0 2021-02-07 op int foreground;
167 3abf91b0 2021-02-07 op /* in the config */
170 ae08ec7d 2021-01-25 op uint32_t protos;
171 ae08ec7d 2021-01-25 op struct mime mime;
172 ae08ec7d 2021-01-25 op char *chroot;
177 d090dc84 2021-02-08 op extern const char *config_path;
178 15902770 2021-01-15 op extern struct conf conf;
180 bc99d868 2021-03-19 op extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
182 2c3e53da 2021-03-03 op extern int servpipes[PROC_MAX];
185 0be51733 2021-01-20 op char *schema;
188 0be51733 2021-01-20 op uint16_t port_no;
191 0be51733 2021-01-20 op char *fragment;
194 0be51733 2021-01-20 op struct parser {
196 0be51733 2021-01-20 op struct iri *parsed;
197 0be51733 2021-01-20 op const char *err;
200 bc99d868 2021-03-19 op typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
203 efe7d180 2021-10-02 op REQUEST_UNDECIDED,
204 efe7d180 2021-10-02 op REQUEST_FILE,
207 efe7d180 2021-10-02 op REQUEST_FCGI,
208 efe7d180 2021-10-02 op REQUEST_DONE,
211 efe7d180 2021-10-02 op #define IS_INTERNAL_REQUEST(x) ((x) != REQUEST_CGI && (x) != REQUEST_FCGI)
213 488f059a 2020-12-24 op struct client {
215 488f059a 2020-12-24 op struct tls *ctx;
217 0be51733 2021-01-20 op struct iri iri;
218 3300cbe0 2021-01-27 op char domain[DOMAIN_NAME_LEN];
220 efe7d180 2021-10-02 op struct bufferevent *bev;
224 efe7d180 2021-10-02 op struct bufferevent *cgibev;
226 efe7d180 2021-10-02 op char *header;
229 488f059a 2020-12-24 op const char *meta;
231 11c98667 2021-04-25 op struct dirent **dir;
232 11c98667 2021-04-25 op int dirlen, diroff;
235 c836cdfa 2021-03-29 op /* big enough to store STATUS + SPACE + META + CRLF */
236 c836cdfa 2021-03-29 op char sbuf[1029];
237 27b2fa9a 2021-02-12 op ssize_t len, off;
239 709d6e5e 2021-01-10 op struct sockaddr_storage addr;
240 bc99d868 2021-03-19 op struct vhost *host; /* host they're talking to */
241 1feaf2a6 2021-05-15 op size_t loc; /* location matched */
244 8ad1c570 2021-05-09 op extern struct client clients[MAX_USERS];
246 bc99d868 2021-03-19 op struct cgireq {
247 bc99d868 2021-03-19 op char buf[GEMINI_URL_LEN];
249 bc99d868 2021-03-19 op size_t iri_schema_off;
250 bc99d868 2021-03-19 op size_t iri_host_off;
251 bc99d868 2021-03-19 op size_t iri_port_off;
252 bc99d868 2021-03-19 op size_t iri_path_off;
253 bc99d868 2021-03-19 op size_t iri_query_off;
254 bc99d868 2021-03-19 op size_t iri_fragment_off;
255 bc99d868 2021-03-19 op int iri_portno;
257 bc99d868 2021-03-19 op char spath[PATH_MAX+1];
258 bc99d868 2021-03-19 op char relpath[PATH_MAX+1];
259 bc99d868 2021-03-19 op char addr[NI_MAXHOST+1];
261 bc99d868 2021-03-19 op /* AFAIK there isn't an upper limit for these two fields. */
262 bc99d868 2021-03-19 op char subject[64+1];
263 bc99d868 2021-03-19 op char issuer[64+1];
265 bc99d868 2021-03-19 op char hash[128+1];
266 89541eee 2021-04-13 op char version[8];
267 89541eee 2021-04-13 op char cipher[32];
268 89541eee 2021-04-13 op int cipher_strength;
269 bc99d868 2021-03-19 op time_t notbefore;
270 bc99d868 2021-03-19 op time_t notafter;
272 bc99d868 2021-03-19 op size_t host_off;
273 fdea6aa0 2021-04-30 op size_t loc_off;
278 488f059a 2020-12-24 op FILE_EXECUTABLE,
279 488f059a 2020-12-24 op FILE_DIRECTORY,
280 488f059a 2020-12-24 op FILE_MISSING,
283 bc99d868 2021-03-19 op enum imsg_type {
284 bc99d868 2021-03-19 op IMSG_CGI_REQ,
285 bc99d868 2021-03-19 op IMSG_CGI_RES,
286 8ad1c570 2021-05-09 op IMSG_FCGI_REQ,
287 8ad1c570 2021-05-09 op IMSG_FCGI_FD,
289 41395640 2021-07-19 op IMSG_LOG_REQUEST,
290 e952c505 2021-06-15 op IMSG_LOG_TYPE,
295 8443bff7 2021-01-25 op char *data_dir(void);
296 8443bff7 2021-01-25 op void load_local_cert(const char*, const char*);
297 ae08ec7d 2021-01-25 op void load_vhosts(void);
298 33ac26a0 2021-01-21 op int make_socket(int, int);
299 ae08ec7d 2021-01-25 op void setup_tls(void);
300 c8b74339 2021-01-24 op void init_config(void);
301 ca21e100 2021-02-04 op void free_config(void);
302 ae08ec7d 2021-01-25 op void drop_priv(void);
304 6abda252 2021-02-06 op void yyerror(const char*, ...);
305 13ed2fb6 2021-01-27 op void parse_conf(const char*);
306 3b21cca3 2021-06-29 op int cmdline_symset(char *);
309 3abf91b0 2021-02-07 op void fatal(const char*, ...)
310 3abf91b0 2021-02-07 op __attribute__((format (printf, 1, 2)))
311 3abf91b0 2021-02-07 op __attribute__((__noreturn__));
313 3abf91b0 2021-02-07 op #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
314 3abf91b0 2021-02-07 op void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
315 3abf91b0 2021-02-07 op void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
316 3abf91b0 2021-02-07 op void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
317 3abf91b0 2021-02-07 op void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
318 3abf91b0 2021-02-07 op void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
319 3abf91b0 2021-02-07 op void log_request(struct client*, char*, size_t);
320 376a5407 2021-02-23 op int logger_main(int, struct imsgbuf*);
323 b2a6b613 2021-01-21 op void init_mime(struct mime*);
324 b2a6b613 2021-01-21 op void add_mime(struct mime*, const char*, const char*);
325 b2a6b613 2021-01-21 op void load_default_mime(struct mime*);
326 6119e13e 2021-01-19 op const char *mime(struct vhost*, const char*);
328 d3a08f4d 2021-01-17 op /* server.c */
329 090b8a89 2021-07-06 op extern int shutting_down;
330 c8b74339 2021-01-24 op const char *vhost_lang(struct vhost*, const char*);
331 c8b74339 2021-01-24 op const char *vhost_default_mime(struct vhost*, const char*);
332 c8b74339 2021-01-24 op const char *vhost_index(struct vhost*, const char*);
333 252908e6 2021-01-24 op int vhost_auto_index(struct vhost*, const char*);
334 6abda252 2021-02-06 op int vhost_block_return(struct vhost*, const char*, int*, const char**);
335 8ad1c570 2021-05-09 op int vhost_fastcgi(struct vhost*, const char*);
336 1feaf2a6 2021-05-15 op int vhost_dirfd(struct vhost*, const char*, size_t*);
337 6abda252 2021-02-06 op int vhost_strip(struct vhost*, const char*);
338 02be96c6 2021-02-09 op X509_STORE *vhost_require_ca(struct vhost*, const char*);
339 793835cb 2021-02-23 op int vhost_disable_log(struct vhost*, const char*);
341 9b8f5ed2 2021-02-03 op void mark_nonblock(int);
342 efe7d180 2021-10-02 op void client_write(struct bufferevent *, void *);
343 8ad1c570 2021-05-09 op void start_reply(struct client*, int, const char*);
344 efe7d180 2021-10-02 op void client_close(struct client *);
345 8ad1c570 2021-05-09 op struct client *try_client_by_id(int);
346 bc99d868 2021-03-19 op void loop(struct tls*, int, int, struct imsgbuf*);
349 11c98667 2021-04-25 op int scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
350 11c98667 2021-04-25 op int(*)(const struct dirent**, const struct dirent**));
351 11c98667 2021-04-25 op int select_non_dot(const struct dirent*);
352 11c98667 2021-04-25 op int select_non_dotdot(const struct dirent*);
355 881a9dd9 2021-01-16 op int send_string(int, const char*);
356 881a9dd9 2021-01-16 op int recv_string(int, char**);
357 2fafa2d2 2021-02-01 op int send_iri(int, struct iri*);
358 2fafa2d2 2021-02-01 op int recv_iri(int, struct iri*);
359 2fafa2d2 2021-02-01 op void free_recvd_iri(struct iri*);
360 881a9dd9 2021-01-16 op int send_vhost(int, struct vhost*);
361 881a9dd9 2021-01-16 op int recv_vhost(int, struct vhost**);
362 b63e30ff 2021-02-07 op int send_time(int, time_t);
363 b63e30ff 2021-02-07 op int recv_time(int, time_t*);
364 881a9dd9 2021-01-16 op int send_fd(int, int);
365 881a9dd9 2021-01-16 op int recv_fd(int);
366 bc99d868 2021-03-19 op int executor_main(struct imsgbuf*);
369 efe7d180 2021-10-02 op void fcgi_abort_request(struct client *);
370 090b8a89 2021-07-06 op void fcgi_close_backend(struct fcgi *);
371 741b69be 2021-09-26 op void fcgi_read(struct bufferevent *, void *);
372 741b69be 2021-09-26 op void fcgi_write(struct bufferevent *, void *);
373 741b69be 2021-09-26 op void fcgi_error(struct bufferevent *, short, void *);
374 741b69be 2021-09-26 op void fcgi_req(struct fcgi *, struct client *);
376 dafb57b8 2021-01-15 op /* sandbox.c */
377 62e001b0 2021-03-20 op void sandbox_server_process(void);
378 62e001b0 2021-03-20 op void sandbox_executor_process(void);
379 62e001b0 2021-03-20 op void sandbox_logger_process(void);
382 ef04b551 2021-01-09 op int valid_multibyte_utf8(struct parser*);
383 3300cbe0 2021-01-27 op char *utf8_nth(char*, size_t);
386 3c1cf9d0 2021-01-11 op int parse_iri(char*, struct iri*, const char**);
387 2fafa2d2 2021-02-01 op int serialize_iri(struct iri*, char*, size_t);
388 9f006a21 2021-02-07 op char *pct_decode_str(char *);
391 a2fd8013 2021-01-29 op int puny_decode(const char*, char*, size_t, const char**);
393 44ee1bac 2021-01-27 op /* utils.c */
394 ca21e100 2021-02-04 op void block_signals(void);
395 ca21e100 2021-02-04 op void unblock_signals(void);
396 44ee1bac 2021-01-27 op int starts_with(const char*, const char*);
397 44ee1bac 2021-01-27 op int ends_with(const char*, const char*);
398 44ee1bac 2021-01-27 op ssize_t filesize(int);
399 2fafa2d2 2021-02-01 op char *absolutify_path(const char*);
400 ca21e100 2021-02-04 op char *xstrdup(const char*);
401 b8e64ccd 2021-03-31 op void *xcalloc(size_t, size_t);
402 3abf91b0 2021-02-07 op void gen_certificate(const char*, const char*, const char*);
403 02be96c6 2021-02-09 op X509_STORE *load_ca(const char*);
404 02be96c6 2021-02-09 op int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
405 bc99d868 2021-03-19 op void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);