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 VERSION_STR(n) n " " VERSION
54 #define GE_STRING VERSION_STR("ge")
55 #define GG_STRING VERSION_STR("gg")
56 #define GMID_STRING VERSION_STR("gmid")
58 #define GMID_VERSION "gmid/" VERSION
60 #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
62 #define SUCCESS 20
63 #define TEMP_REDIRECT 30
64 #define TEMP_FAILURE 40
65 #define CGI_ERROR 42
66 #define PROXY_ERROR 43
67 #define NOT_FOUND 51
68 #define PROXY_REFUSED 53
69 #define BAD_REQUEST 59
70 #define CLIENT_CERT_REQ 60
71 #define CERT_NOT_AUTH 61
73 /* maximum hostname and label length, +1 for the NUL-terminator */
74 #define DOMAIN_NAME_LEN (253+1)
75 #define LABEL_LEN (63+1)
77 #define MEDIATYPE_NAMEMAX 128 /* file name extension */
78 #define MEDIATYPE_TYPEMAX 128 /* length of type/subtype */
80 #define FCGI_NAME_MAX 511
81 #define FCGI_VAL_MAX 511
83 #define FCGI_MAX 32
84 #define PROC_MAX 16
86 struct iri {
87 char *schema;
88 char *host;
89 char *port;
90 uint16_t port_no;
91 char *path;
92 char *query;
93 char *fragment;
94 };
96 struct parser {
97 char *iri;
98 struct iri *parsed;
99 const char *err;
100 };
102 struct fcgi {
103 int id;
104 char path[PATH_MAX];
105 char port[32];
106 };
107 extern struct fcgi fcgi[FCGI_MAX];
109 TAILQ_HEAD(proxyhead, proxy);
110 struct proxy {
111 char match_proto[32];
112 char match_host[HOST_NAME_MAX + 1];
113 char match_port[32];
115 char host[HOST_NAME_MAX + 1];
116 char port[32];
117 char sni[HOST_NAME_MAX];
118 int notls;
119 uint32_t protocols;
120 int noverifyname;
121 uint8_t *cert;
122 size_t certlen;
123 uint8_t *key;
124 size_t keylen;
125 X509_STORE *reqca;
127 TAILQ_ENTRY(proxy) proxies;
128 };
130 TAILQ_HEAD(lochead, location);
131 struct location {
132 char match[128];
133 char lang[32];
134 char default_mime[MEDIATYPE_TYPEMAX];
135 char index[PATH_MAX];
136 int auto_index; /* 0 auto, -1 off, 1 on */
137 int block_code;
138 char block_fmt[GEMINI_URL_LEN];
139 int strip;
140 X509_STORE *reqca;
141 int disable_log;
142 int fcgi;
144 char dir[PATH_MAX];
145 int dirfd;
147 TAILQ_ENTRY(location) locations;
148 };
150 TAILQ_HEAD(envhead, envlist);
151 struct envlist {
152 char name[FCGI_NAME_MAX];
153 char value[FCGI_VAL_MAX];
154 TAILQ_ENTRY(envlist) envs;
155 };
157 TAILQ_HEAD(aliashead, alist);
158 struct alist {
159 char alias[HOST_NAME_MAX + 1];
160 TAILQ_ENTRY(alist) aliases;
161 };
163 extern TAILQ_HEAD(vhosthead, vhost) hosts;
164 struct vhost {
165 char domain[HOST_NAME_MAX + 1];
166 char cert[PATH_MAX];
167 char key[PATH_MAX];
168 char ocsp[PATH_MAX];
170 TAILQ_ENTRY(vhost) vhosts;
172 /*
173 * the first location rule is always '*' and holds the default
174 * settings for the vhost, then follows the "real" location
175 * rules as specified in the configuration.
176 */
177 struct lochead locations;
179 struct envhead params;
180 struct aliashead aliases;
181 struct proxyhead proxies;
182 };
184 struct etm { /* extension to mime */
185 char mime[MEDIATYPE_TYPEMAX];
186 char ext[MEDIATYPE_NAMEMAX];
187 };
189 struct mime {
190 struct etm *t;
191 size_t len;
192 size_t cap;
193 };
195 struct conf {
196 /* from command line */
197 int foreground;
198 int verbose;
199 int can_open_sockets;
201 /* in the config */
202 int port;
203 int ipv6;
204 uint32_t protos;
205 struct mime mime;
206 char chroot[PATH_MAX];
207 char user[LOGIN_NAME_MAX];
208 int prefork;
209 };
211 extern const char *config_path;
212 extern struct conf conf;
214 extern struct imsgbuf logibuf, servibuf[PROC_MAX];
216 extern int servpipes[PROC_MAX];
218 typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
220 enum {
221 REQUEST_UNDECIDED,
222 REQUEST_FILE,
223 REQUEST_DIR,
224 REQUEST_FCGI,
225 REQUEST_PROXY,
226 REQUEST_DONE,
227 };
229 #define IS_INTERNAL_REQUEST(x) \
230 (x) != REQUEST_FCGI && \
231 (x) != REQUEST_PROXY)
233 struct client {
234 uint32_t id;
235 struct tls *ctx;
236 char *req;
237 size_t reqlen;
238 struct iri iri;
239 char domain[DOMAIN_NAME_LEN];
241 struct bufferevent *bev;
243 int type;
245 struct bufferevent *cgibev;
247 struct proxy *proxy;
248 struct bufferevent *proxybev;
249 struct tls *proxyctx;
250 int proxyevset;
251 struct event proxyev;
253 char *header;
255 int code;
256 const char *meta;
257 int fd, pfd;
258 struct dirent **dir;
259 int dirlen, diroff;
261 /* big enough to store STATUS + SPACE + META + CRLF */
262 char sbuf[1029];
263 ssize_t len, off;
265 struct sockaddr_storage addr;
266 struct vhost *host; /* host they're talking to */
267 size_t loc; /* location matched */
269 SPLAY_ENTRY(client) entry;
270 };
271 SPLAY_HEAD(client_tree_id, client);
272 extern struct client_tree_id clients;
274 struct connreq {
275 char host[NI_MAXHOST];
276 char port[NI_MAXSERV];
277 int flag;
278 };
280 enum {
281 FILE_EXISTS,
282 FILE_DIRECTORY,
283 FILE_MISSING,
284 };
286 enum imsg_type {
287 IMSG_FCGI_REQ,
288 IMSG_FCGI_FD,
289 IMSG_CONN_REQ,
290 IMSG_CONN_FD,
291 IMSG_LOG,
292 IMSG_LOG_REQUEST,
293 IMSG_LOG_TYPE,
294 IMSG_QUIT,
295 };
297 /* gmid.c */
298 char *data_dir(void);
299 void load_local_cert(struct vhost*, const char*, const char*);
300 void load_vhosts(void);
301 int make_socket(int, int);
302 void setup_tls(void);
303 void init_config(void);
304 void free_config(void);
305 void drop_priv(void);
307 void yyerror(const char*, ...);
308 void parse_conf(const char*);
309 void print_conf(void);
310 int cmdline_symset(char *);
312 /* log.c */
313 void fatal(const char*, ...)
314 __attribute__((format (printf, 1, 2)))
315 __attribute__((__noreturn__));
317 #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
318 void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
319 void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
320 void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
321 void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
322 void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
323 void log_request(struct client*, char*, size_t);
324 int logger_main(int, struct imsgbuf*);
326 /* mime.c */
327 void init_mime(struct mime*);
328 int add_mime(struct mime*, const char*, const char*);
329 int load_default_mime(struct mime*);
330 void sort_mime(struct mime *);
331 const char *mime(struct vhost*, const char*);
332 void free_mime(struct mime *);
334 /* server.c */
335 extern int shutting_down;
336 const char *vhost_lang(struct vhost*, const char*);
337 const char *vhost_default_mime(struct vhost*, const char*);
338 const char *vhost_index(struct vhost*, const char*);
339 int vhost_auto_index(struct vhost*, const char*);
340 int vhost_block_return(struct vhost*, const char*, int*, const char**);
341 int vhost_fastcgi(struct vhost*, const char*);
342 int vhost_dirfd(struct vhost*, const char*, size_t*);
343 int vhost_strip(struct vhost*, const char*);
344 X509_STORE *vhost_require_ca(struct vhost*, const char*);
345 int vhost_disable_log(struct vhost*, const char*);
347 void mark_nonblock(int);
348 void client_write(struct bufferevent *, void *);
349 void start_reply(struct client*, int, const char*);
350 void client_close(struct client *);
351 struct client *client_by_id(int);
352 void loop(struct tls*, int, int, struct imsgbuf*);
354 int client_tree_cmp(struct client *, struct client *);
355 SPLAY_PROTOTYPE(client_tree_id, client, entry, client_tree_cmp);
357 /* dirs.c */
358 int scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
359 int(*)(const struct dirent**, const struct dirent**));
360 int select_non_dot(const struct dirent*);
361 int select_non_dotdot(const struct dirent*);
363 /* fcgi.c */
364 void fcgi_read(struct bufferevent *, void *);
365 void fcgi_write(struct bufferevent *, void *);
366 void fcgi_error(struct bufferevent *, short, void *);
367 void fcgi_req(struct client *);
369 /* sandbox.c */
370 void sandbox_server_process(int);
371 void sandbox_logger_process(void);
373 /* utf8.c */
374 int valid_multibyte_utf8(struct parser*);
375 char *utf8_nth(char*, size_t);
377 /* iri.c */
378 int parse_iri(char*, struct iri*, const char**);
379 int serialize_iri(struct iri*, char*, size_t);
380 int encode_path(char *, size_t, const char *);
381 char *pct_decode_str(char *);
383 /* proxy.c */
384 int proxy_init(struct client *);
386 /* puny.c */
387 int puny_decode(const char*, char*, size_t, const char**);
389 /* utils.c */
390 void block_signals(void);
391 void unblock_signals(void);
392 int starts_with(const char*, const char*);
393 int ends_with(const char*, const char*);
394 ssize_t filesize(int);
395 char *absolutify_path(const char*);
396 char *xstrdup(const char*);
397 void *xcalloc(size_t, size_t);
398 void gen_certificate(const char*, const char*, const char*);
399 X509_STORE *load_ca(const char*);
400 int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
401 void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
403 #endif