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 ca21e100 2021-02-04 op #include <signal.h>
30 488f059a 2020-12-24 op #include <stdio.h>
31 488f059a 2020-12-24 op #include <stdlib.h>
32 b63e30ff 2021-02-07 op #include <time.h>
33 488f059a 2020-12-24 op #include <tls.h>
34 488f059a 2020-12-24 op #include <unistd.h>
36 02be96c6 2021-02-09 op #include <openssl/x509.h>
38 488f059a 2020-12-24 op #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
40 488f059a 2020-12-24 op #define SUCCESS 20
41 0be51733 2021-01-20 op #define TEMP_REDIRECT 30
42 488f059a 2020-12-24 op #define TEMP_FAILURE 40
43 35744950 2021-02-01 op #define CGI_ERROR 42
44 488f059a 2020-12-24 op #define NOT_FOUND 51
45 7b1d9790 2021-01-11 op #define PROXY_REFUSED 53
46 488f059a 2020-12-24 op #define BAD_REQUEST 59
47 02be96c6 2021-02-09 op #define CLIENT_CERT_REQ 60
48 02be96c6 2021-02-09 op #define CERT_NOT_AUTH 61
50 488f059a 2020-12-24 op #define MAX_USERS 64
52 15902770 2021-01-15 op #define HOSTSLEN 64
53 c8b74339 2021-01-24 op #define LOCLEN 32
55 35cf19e3 2021-01-28 op /* maximum hostname and label length, +1 for the NUL-terminator */
56 35cf19e3 2021-01-28 op #define DOMAIN_NAME_LEN (253+1)
57 35cf19e3 2021-01-28 op #define LABEL_LEN (63+1)
59 c8b74339 2021-01-24 op struct location {
60 fe5967cd 2021-01-27 op const char *match;
61 fe5967cd 2021-01-27 op const char *lang;
62 fe5967cd 2021-01-27 op const char *default_mime;
63 fe5967cd 2021-01-27 op const char *index;
64 252908e6 2021-01-24 op int auto_index; /* 0 auto, -1 off, 1 on */
65 6abda252 2021-02-06 op int block_code;
66 6abda252 2021-02-06 op const char *block_fmt;
68 02be96c6 2021-02-09 op X509_STORE *reqca;
69 793835cb 2021-02-23 op int disable_log;
72 15902770 2021-01-15 op struct vhost {
73 15902770 2021-01-15 op const char *domain;
74 15902770 2021-01-15 op const char *cert;
75 15902770 2021-01-15 op const char *key;
76 15902770 2021-01-15 op const char *dir;
77 15902770 2021-01-15 op const char *cgi;
78 e3ddf390 2021-02-06 op const char *entrypoint;
81 6016a593 2021-01-30 op /* the first location rule is always '*' and holds the default
82 6016a593 2021-01-30 op * settings for the vhost, from locations[1] onwards there are
83 6016a593 2021-01-30 op * the "real" location rules specified in the configuration. */
84 c8b74339 2021-01-24 op struct location locations[LOCLEN];
87 15902770 2021-01-15 op extern struct vhost hosts[HOSTSLEN];
89 a010b0dd 2021-01-18 op struct etm { /* extension to mime */
90 a010b0dd 2021-01-18 op const char *mime;
91 a010b0dd 2021-01-18 op const char *ext;
95 a010b0dd 2021-01-18 op struct etm *t;
100 15902770 2021-01-15 op struct conf {
101 3abf91b0 2021-02-07 op /* from command line */
102 3abf91b0 2021-02-07 op int foreground;
105 3abf91b0 2021-02-07 op /* in the config */
108 ae08ec7d 2021-01-25 op uint32_t protos;
109 ae08ec7d 2021-01-25 op struct mime mime;
110 ae08ec7d 2021-01-25 op char *chroot;
115 d090dc84 2021-02-08 op extern const char *config_path;
116 15902770 2021-01-15 op extern struct conf conf;
117 881a9dd9 2021-01-16 op extern int exfd;
119 ca21e100 2021-02-04 op extern volatile sig_atomic_t hupped;
122 0be51733 2021-01-20 op char *schema;
125 0be51733 2021-01-20 op uint16_t port_no;
128 0be51733 2021-01-20 op char *fragment;
131 0be51733 2021-01-20 op struct parser {
133 0be51733 2021-01-20 op struct iri *parsed;
134 0be51733 2021-01-20 op const char *err;
137 112802ea 2021-02-01 op struct client;
139 abc007d2 2021-02-08 op typedef void (*statefn)(int, short, void*);
142 92da8285 2021-02-01 op * DFA: handle_handshake is the initial state, close_conn the final.
143 5f715ce4 2021-02-02 op * Sometimes we have an enter_* function to handle the state switch.
145 92da8285 2021-02-01 op * handle_handshake -> handle_open_conn
146 92da8285 2021-02-01 op * handle_handshake -> close_conn // on err
148 35744950 2021-02-01 op * handle_open_conn -> handle_cgi_reply // via open_file/dir/...
149 5f715ce4 2021-02-02 op * handle_open_conn -> handle_dirlist // ...same
150 92da8285 2021-02-01 op * handle_open_conn -> send_file // ...same
151 35744950 2021-02-01 op * handle_open_conn -> start_reply // on error
153 35744950 2021-02-01 op * handle_cgi_reply -> handle_cgi // after logging the CGI reply
154 35744950 2021-02-01 op * handle_cgi_reply -> start_reply // on error
156 92da8285 2021-02-01 op * handle_cgi -> close_conn
158 5f715ce4 2021-02-02 op * handle_dirlist -> send_directory_listing
159 5f715ce4 2021-02-02 op * handle_dirlist -> close_conn // on error
161 92da8285 2021-02-01 op * send_directory_listing -> close_conn
163 92da8285 2021-02-01 op * send_file -> close_conn
165 488f059a 2020-12-24 op struct client {
166 488f059a 2020-12-24 op struct tls *ctx;
167 0be51733 2021-01-20 op char req[GEMINI_URL_LEN];
168 0be51733 2021-01-20 op struct iri iri;
169 3300cbe0 2021-01-27 op char domain[DOMAIN_NAME_LEN];
170 abc007d2 2021-02-08 op statefn next;
172 488f059a 2020-12-24 op const char *meta;
175 9356f61a 2021-02-12 op char sbuf[1024];
176 27b2fa9a 2021-02-12 op ssize_t len, off;
177 709d6e5e 2021-01-10 op struct sockaddr_storage addr;
178 f7b816dc 2021-01-15 op struct vhost *host; /* host she's talking to */
183 488f059a 2020-12-24 op FILE_EXECUTABLE,
184 488f059a 2020-12-24 op FILE_DIRECTORY,
185 488f059a 2020-12-24 op FILE_MISSING,
189 4a28dd01 2020-12-28 op void sig_handler(int);
190 8443bff7 2021-01-25 op void mkdirs(const char*);
191 8443bff7 2021-01-25 op char *data_dir(void);
192 8443bff7 2021-01-25 op void load_local_cert(const char*, const char*);
193 ae08ec7d 2021-01-25 op void load_vhosts(void);
194 33ac26a0 2021-01-21 op int make_socket(int, int);
195 ae08ec7d 2021-01-25 op void setup_tls(void);
196 c8b74339 2021-01-24 op void init_config(void);
197 ca21e100 2021-02-04 op void free_config(void);
198 ae08ec7d 2021-01-25 op void drop_priv(void);
200 f7b816dc 2021-01-15 op /* provided by lex/yacc */
201 15902770 2021-01-15 op extern FILE *yyin;
202 15902770 2021-01-15 op extern int yylineno;
203 15902770 2021-01-15 op extern int yyparse(void);
204 15902770 2021-01-15 op extern int yylex(void);
206 6abda252 2021-02-06 op void yyerror(const char*, ...);
207 13ed2fb6 2021-01-27 op int parse_portno(const char*);
208 13ed2fb6 2021-01-27 op void parse_conf(const char*);
211 3abf91b0 2021-02-07 op void fatal(const char*, ...)
212 3abf91b0 2021-02-07 op __attribute__((format (printf, 1, 2)))
213 3abf91b0 2021-02-07 op __attribute__((__noreturn__));
215 3abf91b0 2021-02-07 op #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
216 3abf91b0 2021-02-07 op void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
217 3abf91b0 2021-02-07 op void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
218 3abf91b0 2021-02-07 op void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
219 3abf91b0 2021-02-07 op void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
220 3abf91b0 2021-02-07 op void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
221 3abf91b0 2021-02-07 op void log_request(struct client*, char*, size_t);
222 d278a0c3 2021-02-23 op void logger_init(void);
225 b2a6b613 2021-01-21 op void init_mime(struct mime*);
226 b2a6b613 2021-01-21 op void add_mime(struct mime*, const char*, const char*);
227 b2a6b613 2021-01-21 op void load_default_mime(struct mime*);
228 6119e13e 2021-01-19 op const char *mime(struct vhost*, const char*);
230 d3a08f4d 2021-01-17 op /* server.c */
231 c8b74339 2021-01-24 op const char *vhost_lang(struct vhost*, const char*);
232 c8b74339 2021-01-24 op const char *vhost_default_mime(struct vhost*, const char*);
233 c8b74339 2021-01-24 op const char *vhost_index(struct vhost*, const char*);
234 252908e6 2021-01-24 op int vhost_auto_index(struct vhost*, const char*);
235 6abda252 2021-02-06 op int vhost_block_return(struct vhost*, const char*, int*, const char**);
236 6abda252 2021-02-06 op int vhost_strip(struct vhost*, const char*);
237 02be96c6 2021-02-09 op X509_STORE *vhost_require_ca(struct vhost*, const char*);
238 793835cb 2021-02-23 op int vhost_disable_log(struct vhost*, const char*);
239 9b8f5ed2 2021-02-03 op void mark_nonblock(int);
240 d3a08f4d 2021-01-17 op void loop(struct tls*, int, int);
243 881a9dd9 2021-01-16 op int send_string(int, const char*);
244 881a9dd9 2021-01-16 op int recv_string(int, char**);
245 2fafa2d2 2021-02-01 op int send_iri(int, struct iri*);
246 2fafa2d2 2021-02-01 op int recv_iri(int, struct iri*);
247 2fafa2d2 2021-02-01 op void free_recvd_iri(struct iri*);
248 881a9dd9 2021-01-16 op int send_vhost(int, struct vhost*);
249 881a9dd9 2021-01-16 op int recv_vhost(int, struct vhost**);
250 b63e30ff 2021-02-07 op int send_time(int, time_t);
251 b63e30ff 2021-02-07 op int recv_time(int, time_t*);
252 881a9dd9 2021-01-16 op int send_fd(int, int);
253 881a9dd9 2021-01-16 op int recv_fd(int);
254 4e2e2ab1 2021-02-03 op int executor_main(void);
256 dafb57b8 2021-01-15 op /* sandbox.c */
257 33ac26a0 2021-01-21 op void sandbox(void);
260 ef04b551 2021-01-09 op int valid_multibyte_utf8(struct parser*);
261 3300cbe0 2021-01-27 op char *utf8_nth(char*, size_t);
264 3c1cf9d0 2021-01-11 op int parse_iri(char*, struct iri*, const char**);
265 c4f682f8 2021-01-27 op int trim_req_iri(char*, const char **);
266 2fafa2d2 2021-02-01 op int serialize_iri(struct iri*, char*, size_t);
267 9f006a21 2021-02-07 op char *pct_decode_str(char *);
270 a2fd8013 2021-01-29 op int puny_decode(const char*, char*, size_t, const char**);
272 44ee1bac 2021-01-27 op /* utils.c */
273 ca21e100 2021-02-04 op void block_signals(void);
274 ca21e100 2021-02-04 op void unblock_signals(void);
275 44ee1bac 2021-01-27 op int starts_with(const char*, const char*);
276 44ee1bac 2021-01-27 op int ends_with(const char*, const char*);
277 44ee1bac 2021-01-27 op ssize_t filesize(int);
278 2fafa2d2 2021-02-01 op char *absolutify_path(const char*);
279 ca21e100 2021-02-04 op char *xstrdup(const char*);
280 3abf91b0 2021-02-07 op void gen_certificate(const char*, const char*, const char*);
281 02be96c6 2021-02-09 op X509_STORE *load_ca(const char*);
282 02be96c6 2021-02-09 op int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
