Blob


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 */
17 #ifndef GMID_H
18 #define GMID_H
20 #include "config.h"
22 #include <sys/socket.h>
23 #include <sys/types.h>
25 #include <arpa/inet.h>
26 #include <netinet/in.h>
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>
38 #include <openssl/x509.h>
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
53 #define GMID_STRING "gmid " VERSION
54 #define GMID_VERSION "gmid/" VERSION
56 #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
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
69 /* maximum hostname and label length, +1 for the NUL-terminator */
70 #define DOMAIN_NAME_LEN (253+1)
71 #define LABEL_LEN (63+1)
73 #define FCGI_MAX 32
74 #define PROC_MAX 16
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 };
86 struct parser {
87 char *iri;
88 struct iri *parsed;
89 const char *err;
90 };
92 struct fcgi {
93 int id;
94 char *path;
95 char *port;
96 char *prog;
97 };
98 extern struct fcgi fcgi[FCGI_MAX];
100 TAILQ_HEAD(proxyhead, proxy);
101 struct proxy {
102 char *match_proto;
103 char *match_host;
104 const char *match_port;
106 char *host;
107 const char *port;
108 char *sni;
109 int notls;
110 uint32_t protocols;
111 int noverifyname;
112 uint8_t *cert;
113 size_t certlen;
114 uint8_t *key;
115 size_t keylen;
116 X509_STORE *reqca;
118 TAILQ_ENTRY(proxy) proxies;
119 };
121 TAILQ_HEAD(lochead, location);
122 struct location {
123 const char *match;
124 const char *lang;
125 const char *default_mime;
126 const char *index;
127 int auto_index; /* 0 auto, -1 off, 1 on */
128 int block_code;
129 const char *block_fmt;
130 int strip;
131 X509_STORE *reqca;
132 int disable_log;
133 int fcgi;
135 const char *dir;
136 int dirfd;
138 TAILQ_ENTRY(location) locations;
139 };
141 TAILQ_HEAD(envhead, envlist);
142 struct envlist {
143 char *name;
144 char *value;
145 TAILQ_ENTRY(envlist) envs;
146 };
148 TAILQ_HEAD(aliashead, alist);
149 struct alist {
150 char *alias;
151 TAILQ_ENTRY(alist) aliases;
152 };
154 extern TAILQ_HEAD(vhosthead, vhost) hosts;
155 struct vhost {
156 const char *domain;
157 const char *cert;
158 const char *key;
159 const char *ocsp;
160 const char *cgi;
161 const char *entrypoint;
163 TAILQ_ENTRY(vhost) vhosts;
165 /*
166 * the first location rule is always '*' and holds the default
167 * settings for the vhost, then follows the "real" location
168 * rules as specified in the configuration.
169 */
170 struct lochead locations;
172 struct envhead env;
173 struct envhead params;
174 struct aliashead aliases;
175 struct proxyhead proxies;
176 };
178 struct etm { /* extension to mime */
179 const char *mime;
180 const char *ext;
181 };
183 struct mime {
184 struct etm *t;
185 size_t len;
186 size_t cap;
187 };
189 struct conf {
190 /* from command line */
191 int foreground;
192 int verbose;
194 /* in the config */
195 int port;
196 int ipv6;
197 uint32_t protos;
198 struct mime mime;
199 char *chroot;
200 char *user;
201 int prefork;
202 };
204 extern const char *config_path;
205 extern struct conf conf;
207 extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
209 extern int servpipes[PROC_MAX];
211 typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
213 enum {
214 REQUEST_UNDECIDED,
215 REQUEST_FILE,
216 REQUEST_DIR,
217 REQUEST_CGI,
218 REQUEST_FCGI,
219 REQUEST_PROXY,
220 REQUEST_DONE,
221 };
223 #define IS_INTERNAL_REQUEST(x) \
224 ((x) != REQUEST_CGI && \
225 (x) != REQUEST_FCGI && \
226 (x) != REQUEST_PROXY)
228 struct client {
229 uint32_t id;
230 struct tls *ctx;
231 char *req;
232 struct iri iri;
233 char domain[DOMAIN_NAME_LEN];
235 struct bufferevent *bev;
237 int type;
239 struct bufferevent *cgibev;
241 struct proxy *proxy;
242 struct bufferevent *proxybev;
243 struct tls *proxyctx;
244 int proxyevset;
245 struct event proxyev;
247 char *header;
249 int code;
250 const char *meta;
251 int fd, pfd;
252 struct dirent **dir;
253 int dirlen, diroff;
255 /* big enough to store STATUS + SPACE + META + CRLF */
256 char sbuf[1029];
257 ssize_t len, off;
259 struct sockaddr_storage addr;
260 struct vhost *host; /* host they're talking to */
261 size_t loc; /* location matched */
263 SPLAY_ENTRY(client) entry;
264 };
265 SPLAY_HEAD(client_tree_id, client);
266 extern struct client_tree_id clients;
268 struct cgireq {
269 char buf[GEMINI_URL_LEN];
271 size_t iri_schema_off;
272 size_t iri_host_off;
273 size_t iri_port_off;
274 size_t iri_path_off;
275 size_t iri_query_off;
276 size_t iri_fragment_off;
277 int iri_portno;
279 char spath[PATH_MAX+1];
280 char relpath[PATH_MAX+1];
281 char addr[NI_MAXHOST+1];
283 /* AFAIK there isn't an upper limit for these two fields. */
284 char subject[64+1];
285 char issuer[64+1];
287 char hash[128+1];
288 char version[8];
289 char cipher[32];
290 int cipher_strength;
291 time_t notbefore;
292 time_t notafter;
294 size_t host_off;
295 size_t loc_off;
296 };
298 struct connreq {
299 char host[NI_MAXHOST];
300 char port[NI_MAXSERV];
301 int flag;
302 };
304 enum {
305 FILE_EXISTS,
306 FILE_EXECUTABLE,
307 FILE_DIRECTORY,
308 FILE_MISSING,
309 };
311 enum imsg_type {
312 IMSG_CGI_REQ,
313 IMSG_CGI_RES,
314 IMSG_FCGI_REQ,
315 IMSG_FCGI_FD,
316 IMSG_CONN_REQ,
317 IMSG_CONN_FD,
318 IMSG_LOG,
319 IMSG_LOG_REQUEST,
320 IMSG_LOG_TYPE,
321 IMSG_QUIT,
322 };
324 /* gmid.c */
325 char *data_dir(void);
326 void load_local_cert(const char*, const char*);
327 void load_vhosts(void);
328 int make_socket(int, int);
329 void setup_tls(void);
330 void init_config(void);
331 void free_config(void);
332 void drop_priv(void);
334 void yyerror(const char*, ...);
335 void parse_conf(const char*);
336 void print_conf(void);
337 int cmdline_symset(char *);
339 /* log.c */
340 void fatal(const char*, ...)
341 __attribute__((format (printf, 1, 2)))
342 __attribute__((__noreturn__));
344 #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
345 void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
346 void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
347 void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
348 void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
349 void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
350 void log_request(struct client*, char*, size_t);
351 int logger_main(int, struct imsgbuf*);
353 /* mime.c */
354 void init_mime(struct mime*);
355 void add_mime(struct mime*, const char*, const char*);
356 void load_default_mime(struct mime*);
357 const char *mime(struct vhost*, const char*);
359 /* server.c */
360 extern int shutting_down;
361 const char *vhost_lang(struct vhost*, const char*);
362 const char *vhost_default_mime(struct vhost*, const char*);
363 const char *vhost_index(struct vhost*, const char*);
364 int vhost_auto_index(struct vhost*, const char*);
365 int vhost_block_return(struct vhost*, const char*, int*, const char**);
366 int vhost_fastcgi(struct vhost*, const char*);
367 int vhost_dirfd(struct vhost*, const char*, size_t*);
368 int vhost_strip(struct vhost*, const char*);
369 X509_STORE *vhost_require_ca(struct vhost*, const char*);
370 int vhost_disable_log(struct vhost*, const char*);
372 void mark_nonblock(int);
373 void client_write(struct bufferevent *, void *);
374 void start_reply(struct client*, int, const char*);
375 void client_close(struct client *);
376 struct client *try_client_by_id(int);
377 void loop(struct tls*, int, int, struct imsgbuf*);
379 int client_tree_cmp(struct client *, struct client *);
380 SPLAY_PROTOTYPE(client_tree_id, client, entry, client_tree_cmp);
382 /* dirs.c */
383 int scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
384 int(*)(const struct dirent**, const struct dirent**));
385 int select_non_dot(const struct dirent*);
386 int select_non_dotdot(const struct dirent*);
388 /* ex.c */
389 int send_string(int, const char*);
390 int recv_string(int, char**);
391 int send_iri(int, struct iri*);
392 int recv_iri(int, struct iri*);
393 void free_recvd_iri(struct iri*);
394 int send_vhost(int, struct vhost*);
395 int recv_vhost(int, struct vhost**);
396 int send_time(int, time_t);
397 int recv_time(int, time_t*);
398 int send_fd(int, int);
399 int recv_fd(int);
400 int executor_main(struct imsgbuf*);
402 /* fcgi.c */
403 void fcgi_read(struct bufferevent *, void *);
404 void fcgi_write(struct bufferevent *, void *);
405 void fcgi_error(struct bufferevent *, short, void *);
406 void fcgi_req(struct client *);
408 /* sandbox.c */
409 void sandbox_server_process(void);
410 void sandbox_executor_process(void);
411 void sandbox_logger_process(void);
413 /* utf8.c */
414 int valid_multibyte_utf8(struct parser*);
415 char *utf8_nth(char*, size_t);
417 /* iri.c */
418 int parse_iri(char*, struct iri*, const char**);
419 int serialize_iri(struct iri*, char*, size_t);
420 char *pct_decode_str(char *);
422 /* proxy.c */
423 int proxy_init(struct client *);
425 /* puny.c */
426 int puny_decode(const char*, char*, size_t, const char**);
428 /* utils.c */
429 void block_signals(void);
430 void unblock_signals(void);
431 int starts_with(const char*, const char*);
432 int ends_with(const char*, const char*);
433 ssize_t filesize(int);
434 char *absolutify_path(const char*);
435 char *xstrdup(const char*);
436 void *xcalloc(size_t, size_t);
437 void gen_certificate(const char*, const char*, const char*);
438 X509_STORE *load_ca(const char*);
439 int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
440 void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
442 #endif