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 15902770 2021-01-15 op #define HOSTSLEN 64
55 c8b74339 2021-01-24 op #define LOCLEN 32
57 35cf19e3 2021-01-28 op /* maximum hostname and label length, +1 for the NUL-terminator */
58 35cf19e3 2021-01-28 op #define DOMAIN_NAME_LEN (253+1)
59 35cf19e3 2021-01-28 op #define LABEL_LEN (63+1)
61 2c3e53da 2021-03-03 op #define PROC_MAX 16
63 c8b74339 2021-01-24 op struct location {
64 fe5967cd 2021-01-27 op const char *match;
65 fe5967cd 2021-01-27 op const char *lang;
66 fe5967cd 2021-01-27 op const char *default_mime;
67 fe5967cd 2021-01-27 op const char *index;
68 252908e6 2021-01-24 op int auto_index; /* 0 auto, -1 off, 1 on */
69 6abda252 2021-02-06 op int block_code;
70 6abda252 2021-02-06 op const char *block_fmt;
72 02be96c6 2021-02-09 op X509_STORE *reqca;
73 793835cb 2021-02-23 op int disable_log;
76 15902770 2021-01-15 op struct vhost {
77 15902770 2021-01-15 op const char *domain;
78 15902770 2021-01-15 op const char *cert;
79 15902770 2021-01-15 op const char *key;
80 15902770 2021-01-15 op const char *dir;
81 15902770 2021-01-15 op const char *cgi;
82 e3ddf390 2021-02-06 op const char *entrypoint;
85 6016a593 2021-01-30 op /* the first location rule is always '*' and holds the default
86 6016a593 2021-01-30 op * settings for the vhost, from locations[1] onwards there are
87 6016a593 2021-01-30 op * the "real" location rules specified in the configuration. */
88 c8b74339 2021-01-24 op struct location locations[LOCLEN];
91 15902770 2021-01-15 op extern struct vhost hosts[HOSTSLEN];
93 a010b0dd 2021-01-18 op struct etm { /* extension to mime */
94 a010b0dd 2021-01-18 op const char *mime;
95 a010b0dd 2021-01-18 op const char *ext;
99 a010b0dd 2021-01-18 op struct etm *t;
104 15902770 2021-01-15 op struct conf {
105 3abf91b0 2021-02-07 op /* from command line */
106 3abf91b0 2021-02-07 op int foreground;
109 3abf91b0 2021-02-07 op /* in the config */
112 ae08ec7d 2021-01-25 op uint32_t protos;
113 ae08ec7d 2021-01-25 op struct mime mime;
114 ae08ec7d 2021-01-25 op char *chroot;
119 d090dc84 2021-02-08 op extern const char *config_path;
120 15902770 2021-01-15 op extern struct conf conf;
122 bc99d868 2021-03-19 op extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
124 2c3e53da 2021-03-03 op extern int servpipes[PROC_MAX];
127 0be51733 2021-01-20 op char *schema;
130 0be51733 2021-01-20 op uint16_t port_no;
133 0be51733 2021-01-20 op char *fragment;
136 0be51733 2021-01-20 op struct parser {
138 0be51733 2021-01-20 op struct iri *parsed;
139 0be51733 2021-01-20 op const char *err;
142 112802ea 2021-02-01 op struct client;
144 bc99d868 2021-03-19 op typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
146 abc007d2 2021-02-08 op typedef void (*statefn)(int, short, void*);
149 92da8285 2021-02-01 op * DFA: handle_handshake is the initial state, close_conn the final.
150 5f715ce4 2021-02-02 op * Sometimes we have an enter_* function to handle the state switch.
152 92da8285 2021-02-01 op * handle_handshake -> handle_open_conn
153 92da8285 2021-02-01 op * handle_handshake -> close_conn // on err
155 35744950 2021-02-01 op * handle_open_conn -> handle_cgi_reply // via open_file/dir/...
156 5f715ce4 2021-02-02 op * handle_open_conn -> handle_dirlist // ...same
157 92da8285 2021-02-01 op * handle_open_conn -> send_file // ...same
158 35744950 2021-02-01 op * handle_open_conn -> start_reply // on error
160 35744950 2021-02-01 op * handle_cgi_reply -> handle_cgi // after logging the CGI reply
161 35744950 2021-02-01 op * handle_cgi_reply -> start_reply // on error
163 92da8285 2021-02-01 op * handle_cgi -> close_conn
165 5f715ce4 2021-02-02 op * handle_dirlist -> send_directory_listing
166 5f715ce4 2021-02-02 op * handle_dirlist -> close_conn // on error
168 92da8285 2021-02-01 op * send_directory_listing -> close_conn
170 92da8285 2021-02-01 op * send_file -> close_conn
172 488f059a 2020-12-24 op struct client {
174 488f059a 2020-12-24 op struct tls *ctx;
175 0be51733 2021-01-20 op char req[GEMINI_URL_LEN];
176 0be51733 2021-01-20 op struct iri iri;
177 3300cbe0 2021-01-27 op char domain[DOMAIN_NAME_LEN];
178 abc007d2 2021-02-08 op statefn next;
180 488f059a 2020-12-24 op const char *meta;
183 9356f61a 2021-02-12 op char sbuf[1024];
184 27b2fa9a 2021-02-12 op ssize_t len, off;
185 709d6e5e 2021-01-10 op struct sockaddr_storage addr;
186 bc99d868 2021-03-19 op struct vhost *host; /* host they're talking to */
189 bc99d868 2021-03-19 op struct cgireq {
190 bc99d868 2021-03-19 op char buf[GEMINI_URL_LEN];
192 bc99d868 2021-03-19 op size_t iri_schema_off;
193 bc99d868 2021-03-19 op size_t iri_host_off;
194 bc99d868 2021-03-19 op size_t iri_port_off;
195 bc99d868 2021-03-19 op size_t iri_path_off;
196 bc99d868 2021-03-19 op size_t iri_query_off;
197 bc99d868 2021-03-19 op size_t iri_fragment_off;
198 bc99d868 2021-03-19 op int iri_portno;
200 bc99d868 2021-03-19 op char spath[PATH_MAX+1];
201 bc99d868 2021-03-19 op char relpath[PATH_MAX+1];
202 bc99d868 2021-03-19 op char addr[NI_MAXHOST+1];
204 bc99d868 2021-03-19 op /* AFAIK there isn't an upper limit for these two fields. */
205 bc99d868 2021-03-19 op char subject[64+1];
206 bc99d868 2021-03-19 op char issuer[64+1];
208 bc99d868 2021-03-19 op char hash[128+1];
209 bc99d868 2021-03-19 op time_t notbefore;
210 bc99d868 2021-03-19 op time_t notafter;
212 bc99d868 2021-03-19 op size_t host_off;
217 488f059a 2020-12-24 op FILE_EXECUTABLE,
218 488f059a 2020-12-24 op FILE_DIRECTORY,
219 488f059a 2020-12-24 op FILE_MISSING,
222 bc99d868 2021-03-19 op enum imsg_type {
223 bc99d868 2021-03-19 op IMSG_CGI_REQ,
224 bc99d868 2021-03-19 op IMSG_CGI_RES,
230 8443bff7 2021-01-25 op void mkdirs(const char*);
231 8443bff7 2021-01-25 op char *data_dir(void);
232 8443bff7 2021-01-25 op void load_local_cert(const char*, const char*);
233 ae08ec7d 2021-01-25 op void load_vhosts(void);
234 33ac26a0 2021-01-21 op int make_socket(int, int);
235 ae08ec7d 2021-01-25 op void setup_tls(void);
236 c8b74339 2021-01-24 op void init_config(void);
237 ca21e100 2021-02-04 op void free_config(void);
238 ae08ec7d 2021-01-25 op void drop_priv(void);
240 f7b816dc 2021-01-15 op /* provided by lex/yacc */
241 15902770 2021-01-15 op extern FILE *yyin;
242 15902770 2021-01-15 op extern int yylineno;
243 15902770 2021-01-15 op extern int yyparse(void);
244 15902770 2021-01-15 op extern int yylex(void);
246 6abda252 2021-02-06 op void yyerror(const char*, ...);
247 13ed2fb6 2021-01-27 op int parse_portno(const char*);
248 13ed2fb6 2021-01-27 op void parse_conf(const char*);
251 3abf91b0 2021-02-07 op void fatal(const char*, ...)
252 3abf91b0 2021-02-07 op __attribute__((format (printf, 1, 2)))
253 3abf91b0 2021-02-07 op __attribute__((__noreturn__));
255 3abf91b0 2021-02-07 op #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
256 3abf91b0 2021-02-07 op void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
257 3abf91b0 2021-02-07 op void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
258 3abf91b0 2021-02-07 op void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
259 3abf91b0 2021-02-07 op void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
260 3abf91b0 2021-02-07 op void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
261 3abf91b0 2021-02-07 op void log_request(struct client*, char*, size_t);
262 376a5407 2021-02-23 op int logger_main(int, struct imsgbuf*);
265 b2a6b613 2021-01-21 op void init_mime(struct mime*);
266 b2a6b613 2021-01-21 op void add_mime(struct mime*, const char*, const char*);
267 b2a6b613 2021-01-21 op void load_default_mime(struct mime*);
268 6119e13e 2021-01-19 op const char *mime(struct vhost*, const char*);
270 d3a08f4d 2021-01-17 op /* server.c */
271 c8b74339 2021-01-24 op const char *vhost_lang(struct vhost*, const char*);
272 c8b74339 2021-01-24 op const char *vhost_default_mime(struct vhost*, const char*);
273 c8b74339 2021-01-24 op const char *vhost_index(struct vhost*, const char*);
274 252908e6 2021-01-24 op int vhost_auto_index(struct vhost*, const char*);
275 6abda252 2021-02-06 op int vhost_block_return(struct vhost*, const char*, int*, const char**);
276 6abda252 2021-02-06 op int vhost_strip(struct vhost*, const char*);
277 02be96c6 2021-02-09 op X509_STORE *vhost_require_ca(struct vhost*, const char*);
278 793835cb 2021-02-23 op int vhost_disable_log(struct vhost*, const char*);
279 9b8f5ed2 2021-02-03 op void mark_nonblock(int);
280 bc99d868 2021-03-19 op void loop(struct tls*, int, int, struct imsgbuf*);
283 881a9dd9 2021-01-16 op int send_string(int, const char*);
284 881a9dd9 2021-01-16 op int recv_string(int, char**);
285 2fafa2d2 2021-02-01 op int send_iri(int, struct iri*);
286 2fafa2d2 2021-02-01 op int recv_iri(int, struct iri*);
287 2fafa2d2 2021-02-01 op void free_recvd_iri(struct iri*);
288 881a9dd9 2021-01-16 op int send_vhost(int, struct vhost*);
289 881a9dd9 2021-01-16 op int recv_vhost(int, struct vhost**);
290 b63e30ff 2021-02-07 op int send_time(int, time_t);
291 b63e30ff 2021-02-07 op int recv_time(int, time_t*);
292 881a9dd9 2021-01-16 op int send_fd(int, int);
293 881a9dd9 2021-01-16 op int recv_fd(int);
294 bc99d868 2021-03-19 op int executor_main(struct imsgbuf*);
296 dafb57b8 2021-01-15 op /* sandbox.c */
297 33ac26a0 2021-01-21 op void sandbox(void);
300 ef04b551 2021-01-09 op int valid_multibyte_utf8(struct parser*);
301 3300cbe0 2021-01-27 op char *utf8_nth(char*, size_t);
304 3c1cf9d0 2021-01-11 op int parse_iri(char*, struct iri*, const char**);
305 c4f682f8 2021-01-27 op int trim_req_iri(char*, const char **);
306 2fafa2d2 2021-02-01 op int serialize_iri(struct iri*, char*, size_t);
307 9f006a21 2021-02-07 op char *pct_decode_str(char *);
310 a2fd8013 2021-01-29 op int puny_decode(const char*, char*, size_t, const char**);
312 44ee1bac 2021-01-27 op /* utils.c */
313 ca21e100 2021-02-04 op void block_signals(void);
314 ca21e100 2021-02-04 op void unblock_signals(void);
315 44ee1bac 2021-01-27 op int starts_with(const char*, const char*);
316 44ee1bac 2021-01-27 op int ends_with(const char*, const char*);
317 44ee1bac 2021-01-27 op ssize_t filesize(int);
318 2fafa2d2 2021-02-01 op char *absolutify_path(const char*);
319 ca21e100 2021-02-04 op char *xstrdup(const char*);
320 3abf91b0 2021-02-07 op void gen_certificate(const char*, const char*, const char*);
321 02be96c6 2021-02-09 op X509_STORE *load_ca(const char*);
322 02be96c6 2021-02-09 op int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
323 bc99d868 2021-03-19 op void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
