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 488f059a 2020-12-24 op #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
42 488f059a 2020-12-24 op #define SUCCESS 20
43 0be51733 2021-01-20 op #define TEMP_REDIRECT 30
44 488f059a 2020-12-24 op #define TEMP_FAILURE 40
45 35744950 2021-02-01 op #define CGI_ERROR 42
46 488f059a 2020-12-24 op #define NOT_FOUND 51
47 7b1d9790 2021-01-11 op #define PROXY_REFUSED 53
48 488f059a 2020-12-24 op #define BAD_REQUEST 59
49 02be96c6 2021-02-09 op #define CLIENT_CERT_REQ 60
50 02be96c6 2021-02-09 op #define CERT_NOT_AUTH 61
52 488f059a 2020-12-24 op #define MAX_USERS 64
54 35cf19e3 2021-01-28 op /* maximum hostname and label length, +1 for the NUL-terminator */
55 35cf19e3 2021-01-28 op #define DOMAIN_NAME_LEN (253+1)
56 35cf19e3 2021-01-28 op #define LABEL_LEN (63+1)
58 2c3e53da 2021-03-03 op #define PROC_MAX 16
60 b8e64ccd 2021-03-31 op TAILQ_HEAD(lochead, location);
61 c8b74339 2021-01-24 op struct location {
62 fe5967cd 2021-01-27 op const char *match;
63 fe5967cd 2021-01-27 op const char *lang;
64 fe5967cd 2021-01-27 op const char *default_mime;
65 fe5967cd 2021-01-27 op const char *index;
66 252908e6 2021-01-24 op int auto_index; /* 0 auto, -1 off, 1 on */
67 6abda252 2021-02-06 op int block_code;
68 6abda252 2021-02-06 op const char *block_fmt;
70 02be96c6 2021-02-09 op X509_STORE *reqca;
71 793835cb 2021-02-23 op int disable_log;
73 fdea6aa0 2021-04-30 op const char *dir;
76 b8e64ccd 2021-03-31 op TAILQ_ENTRY(location) locations;
79 9cc630aa 2021-04-28 op TAILQ_HEAD(envhead, envlist);
80 9cc630aa 2021-04-28 op struct envlist {
83 9cc630aa 2021-04-28 op TAILQ_ENTRY(envlist) envs;
86 cc8c2901 2021-04-29 op TAILQ_HEAD(aliashead, alist);
87 cc8c2901 2021-04-29 op struct alist {
89 cc8c2901 2021-04-29 op TAILQ_ENTRY(alist) aliases;
92 b8e64ccd 2021-03-31 op extern TAILQ_HEAD(vhosthead, vhost) hosts;
93 15902770 2021-01-15 op struct vhost {
94 15902770 2021-01-15 op const char *domain;
95 15902770 2021-01-15 op const char *cert;
96 15902770 2021-01-15 op const char *key;
97 15902770 2021-01-15 op const char *cgi;
98 e3ddf390 2021-02-06 op const char *entrypoint;
100 b8e64ccd 2021-03-31 op TAILQ_ENTRY(vhost) vhosts;
102 6016a593 2021-01-30 op /* the first location rule is always '*' and holds the default
103 b8e64ccd 2021-03-31 op * settings for the vhost, then follows the "real" location
104 b8e64ccd 2021-03-31 op * rules as specified in the configuration. */
105 b8e64ccd 2021-03-31 op struct lochead locations;
107 9cc630aa 2021-04-28 op struct envhead env;
108 cc8c2901 2021-04-29 op struct aliashead aliases;
111 a010b0dd 2021-01-18 op struct etm { /* extension to mime */
112 a010b0dd 2021-01-18 op const char *mime;
113 a010b0dd 2021-01-18 op const char *ext;
116 b2a6b613 2021-01-21 op struct mime {
117 a010b0dd 2021-01-18 op struct etm *t;
122 15902770 2021-01-15 op struct conf {
123 3abf91b0 2021-02-07 op /* from command line */
124 3abf91b0 2021-02-07 op int foreground;
127 3abf91b0 2021-02-07 op /* in the config */
130 ae08ec7d 2021-01-25 op uint32_t protos;
131 ae08ec7d 2021-01-25 op struct mime mime;
132 ae08ec7d 2021-01-25 op char *chroot;
137 d090dc84 2021-02-08 op extern const char *config_path;
138 15902770 2021-01-15 op extern struct conf conf;
140 bc99d868 2021-03-19 op extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
142 2c3e53da 2021-03-03 op extern int servpipes[PROC_MAX];
145 0be51733 2021-01-20 op char *schema;
148 0be51733 2021-01-20 op uint16_t port_no;
151 0be51733 2021-01-20 op char *fragment;
154 0be51733 2021-01-20 op struct parser {
156 0be51733 2021-01-20 op struct iri *parsed;
157 0be51733 2021-01-20 op const char *err;
160 112802ea 2021-02-01 op struct client;
162 bc99d868 2021-03-19 op typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
164 abc007d2 2021-02-08 op typedef void (*statefn)(int, short, void*);
167 92da8285 2021-02-01 op * DFA: handle_handshake is the initial state, close_conn the final.
168 5f715ce4 2021-02-02 op * Sometimes we have an enter_* function to handle the state switch.
170 92da8285 2021-02-01 op * handle_handshake -> handle_open_conn
171 92da8285 2021-02-01 op * handle_handshake -> close_conn // on err
173 35744950 2021-02-01 op * handle_open_conn -> handle_cgi_reply // via open_file/dir/...
174 5f715ce4 2021-02-02 op * handle_open_conn -> handle_dirlist // ...same
175 92da8285 2021-02-01 op * handle_open_conn -> send_file // ...same
176 35744950 2021-02-01 op * handle_open_conn -> start_reply // on error
178 35744950 2021-02-01 op * handle_cgi_reply -> handle_cgi // after logging the CGI reply
179 35744950 2021-02-01 op * handle_cgi_reply -> start_reply // on error
181 92da8285 2021-02-01 op * handle_cgi -> close_conn
183 5f715ce4 2021-02-02 op * handle_dirlist -> send_directory_listing
184 5f715ce4 2021-02-02 op * handle_dirlist -> close_conn // on error
186 92da8285 2021-02-01 op * send_directory_listing -> close_conn
188 92da8285 2021-02-01 op * send_file -> close_conn
190 488f059a 2020-12-24 op struct client {
192 488f059a 2020-12-24 op struct tls *ctx;
193 0be51733 2021-01-20 op char req[GEMINI_URL_LEN];
194 0be51733 2021-01-20 op struct iri iri;
195 3300cbe0 2021-01-27 op char domain[DOMAIN_NAME_LEN];
196 abc007d2 2021-02-08 op statefn next;
198 488f059a 2020-12-24 op const char *meta;
200 11c98667 2021-04-25 op struct dirent **dir;
201 11c98667 2021-04-25 op int dirlen, diroff;
203 c836cdfa 2021-03-29 op /* big enough to store STATUS + SPACE + META + CRLF */
204 c836cdfa 2021-03-29 op char sbuf[1029];
205 27b2fa9a 2021-02-12 op ssize_t len, off;
207 709d6e5e 2021-01-10 op struct sockaddr_storage addr;
208 bc99d868 2021-03-19 op struct vhost *host; /* host they're talking to */
211 bc99d868 2021-03-19 op struct cgireq {
212 bc99d868 2021-03-19 op char buf[GEMINI_URL_LEN];
214 bc99d868 2021-03-19 op size_t iri_schema_off;
215 bc99d868 2021-03-19 op size_t iri_host_off;
216 bc99d868 2021-03-19 op size_t iri_port_off;
217 bc99d868 2021-03-19 op size_t iri_path_off;
218 bc99d868 2021-03-19 op size_t iri_query_off;
219 bc99d868 2021-03-19 op size_t iri_fragment_off;
220 bc99d868 2021-03-19 op int iri_portno;
222 bc99d868 2021-03-19 op char spath[PATH_MAX+1];
223 bc99d868 2021-03-19 op char relpath[PATH_MAX+1];
224 bc99d868 2021-03-19 op char addr[NI_MAXHOST+1];
226 bc99d868 2021-03-19 op /* AFAIK there isn't an upper limit for these two fields. */
227 bc99d868 2021-03-19 op char subject[64+1];
228 bc99d868 2021-03-19 op char issuer[64+1];
230 bc99d868 2021-03-19 op char hash[128+1];
231 89541eee 2021-04-13 op char version[8];
232 89541eee 2021-04-13 op char cipher[32];
233 89541eee 2021-04-13 op int cipher_strength;
234 bc99d868 2021-03-19 op time_t notbefore;
235 bc99d868 2021-03-19 op time_t notafter;
237 bc99d868 2021-03-19 op size_t host_off;
238 fdea6aa0 2021-04-30 op size_t loc_off;
243 488f059a 2020-12-24 op FILE_EXECUTABLE,
244 488f059a 2020-12-24 op FILE_DIRECTORY,
245 488f059a 2020-12-24 op FILE_MISSING,
248 bc99d868 2021-03-19 op enum imsg_type {
249 bc99d868 2021-03-19 op IMSG_CGI_REQ,
250 bc99d868 2021-03-19 op IMSG_CGI_RES,
256 8443bff7 2021-01-25 op char *data_dir(void);
257 8443bff7 2021-01-25 op void load_local_cert(const char*, const char*);
258 ae08ec7d 2021-01-25 op void load_vhosts(void);
259 33ac26a0 2021-01-21 op int make_socket(int, int);
260 ae08ec7d 2021-01-25 op void setup_tls(void);
261 c8b74339 2021-01-24 op void init_config(void);
262 ca21e100 2021-02-04 op void free_config(void);
263 ae08ec7d 2021-01-25 op void drop_priv(void);
265 f7b816dc 2021-01-15 op /* provided by lex/yacc */
266 15902770 2021-01-15 op extern FILE *yyin;
267 15902770 2021-01-15 op extern int yylineno;
268 15902770 2021-01-15 op extern int yyparse(void);
269 15902770 2021-01-15 op extern int yylex(void);
271 6abda252 2021-02-06 op void yyerror(const char*, ...);
272 13ed2fb6 2021-01-27 op int parse_portno(const char*);
273 13ed2fb6 2021-01-27 op void parse_conf(const char*);
276 3abf91b0 2021-02-07 op void fatal(const char*, ...)
277 3abf91b0 2021-02-07 op __attribute__((format (printf, 1, 2)))
278 3abf91b0 2021-02-07 op __attribute__((__noreturn__));
280 3abf91b0 2021-02-07 op #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
281 3abf91b0 2021-02-07 op void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
282 3abf91b0 2021-02-07 op void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
283 3abf91b0 2021-02-07 op void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
284 3abf91b0 2021-02-07 op void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
285 3abf91b0 2021-02-07 op void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
286 3abf91b0 2021-02-07 op void log_request(struct client*, char*, size_t);
287 376a5407 2021-02-23 op int logger_main(int, struct imsgbuf*);
290 b2a6b613 2021-01-21 op void init_mime(struct mime*);
291 b2a6b613 2021-01-21 op void add_mime(struct mime*, const char*, const char*);
292 b2a6b613 2021-01-21 op void load_default_mime(struct mime*);
293 6119e13e 2021-01-19 op const char *mime(struct vhost*, const char*);
295 d3a08f4d 2021-01-17 op /* server.c */
296 c8b74339 2021-01-24 op const char *vhost_lang(struct vhost*, const char*);
297 c8b74339 2021-01-24 op const char *vhost_default_mime(struct vhost*, const char*);
298 c8b74339 2021-01-24 op const char *vhost_index(struct vhost*, const char*);
299 252908e6 2021-01-24 op int vhost_auto_index(struct vhost*, const char*);
300 6abda252 2021-02-06 op int vhost_block_return(struct vhost*, const char*, int*, const char**);
301 6abda252 2021-02-06 op int vhost_strip(struct vhost*, const char*);
302 02be96c6 2021-02-09 op X509_STORE *vhost_require_ca(struct vhost*, const char*);
303 793835cb 2021-02-23 op int vhost_disable_log(struct vhost*, const char*);
304 9b8f5ed2 2021-02-03 op void mark_nonblock(int);
305 bc99d868 2021-03-19 op void loop(struct tls*, int, int, struct imsgbuf*);
308 11c98667 2021-04-25 op int scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
309 11c98667 2021-04-25 op int(*)(const struct dirent**, const struct dirent**));
310 11c98667 2021-04-25 op int select_non_dot(const struct dirent*);
311 11c98667 2021-04-25 op int select_non_dotdot(const struct dirent*);
314 881a9dd9 2021-01-16 op int send_string(int, const char*);
315 881a9dd9 2021-01-16 op int recv_string(int, char**);
316 2fafa2d2 2021-02-01 op int send_iri(int, struct iri*);
317 2fafa2d2 2021-02-01 op int recv_iri(int, struct iri*);
318 2fafa2d2 2021-02-01 op void free_recvd_iri(struct iri*);
319 881a9dd9 2021-01-16 op int send_vhost(int, struct vhost*);
320 881a9dd9 2021-01-16 op int recv_vhost(int, struct vhost**);
321 b63e30ff 2021-02-07 op int send_time(int, time_t);
322 b63e30ff 2021-02-07 op int recv_time(int, time_t*);
323 881a9dd9 2021-01-16 op int send_fd(int, int);
324 881a9dd9 2021-01-16 op int recv_fd(int);
325 bc99d868 2021-03-19 op int executor_main(struct imsgbuf*);
327 dafb57b8 2021-01-15 op /* sandbox.c */
328 62e001b0 2021-03-20 op void sandbox_server_process(void);
329 62e001b0 2021-03-20 op void sandbox_executor_process(void);
330 62e001b0 2021-03-20 op void sandbox_logger_process(void);
333 ef04b551 2021-01-09 op int valid_multibyte_utf8(struct parser*);
334 3300cbe0 2021-01-27 op char *utf8_nth(char*, size_t);
337 3c1cf9d0 2021-01-11 op int parse_iri(char*, struct iri*, const char**);
338 c4f682f8 2021-01-27 op int trim_req_iri(char*, const char **);
339 2fafa2d2 2021-02-01 op int serialize_iri(struct iri*, char*, size_t);
340 9f006a21 2021-02-07 op char *pct_decode_str(char *);
343 a2fd8013 2021-01-29 op int puny_decode(const char*, char*, size_t, const char**);
345 44ee1bac 2021-01-27 op /* utils.c */
346 ca21e100 2021-02-04 op void block_signals(void);
347 ca21e100 2021-02-04 op void unblock_signals(void);
348 44ee1bac 2021-01-27 op int starts_with(const char*, const char*);
349 44ee1bac 2021-01-27 op int ends_with(const char*, const char*);
350 44ee1bac 2021-01-27 op ssize_t filesize(int);
351 2fafa2d2 2021-02-01 op char *absolutify_path(const char*);
352 ca21e100 2021-02-04 op char *xstrdup(const char*);
353 b8e64ccd 2021-03-31 op void *xcalloc(size_t, size_t);
354 3abf91b0 2021-02-07 op void gen_certificate(const char*, const char*, const char*);
355 02be96c6 2021-02-09 op X509_STORE *load_ca(const char*);
356 02be96c6 2021-02-09 op int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
357 bc99d868 2021-03-19 op void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
