2 * Copyright (c) 2020 Omar Polo <op@omarpolo.com>
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.
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.
22 #include <sys/socket.h>
23 #include <sys/types.h>
25 #include <arpa/inet.h>
26 #include <netinet/in.h>
39 #include <openssl/x509.h>
41 #define GMID_STRING "gmid " VERSION
42 #define GMID_VERSION "gmid/" VERSION
44 #define GEMINI_URL_LEN (1024+3) /* URL max len + \r\n + \0 */
47 #define TEMP_REDIRECT 30
48 #define TEMP_FAILURE 40
51 #define PROXY_REFUSED 53
52 #define BAD_REQUEST 59
53 #define CLIENT_CERT_REQ 60
54 #define CERT_NOT_AUTH 61
58 /* maximum hostname and label length, +1 for the NUL-terminator */
59 #define DOMAIN_NAME_LEN (253+1)
60 #define LABEL_LEN (63+1)
73 /* number of pending clients */
77 #define FCGI_INFLIGHT 1
81 extern struct fcgi fcgi[FCGI_MAX];
83 TAILQ_HEAD(lochead, location);
87 const char *default_mime;
89 int auto_index; /* 0 auto, -1 off, 1 on */
91 const char *block_fmt;
100 TAILQ_ENTRY(location) locations;
103 TAILQ_HEAD(envhead, envlist);
107 TAILQ_ENTRY(envlist) envs;
110 TAILQ_HEAD(aliashead, alist);
113 TAILQ_ENTRY(alist) aliases;
116 extern TAILQ_HEAD(vhosthead, vhost) hosts;
122 const char *entrypoint;
124 TAILQ_ENTRY(vhost) vhosts;
127 * the first location rule is always '*' and holds the default
128 * settings for the vhost, then follows the "real" location
129 * rules as specified in the configuration.
131 struct lochead locations;
134 struct envhead params;
135 struct aliashead aliases;
138 struct etm { /* extension to mime */
150 /* from command line */
164 extern const char *config_path;
165 extern struct conf conf;
167 extern struct imsgbuf logibuf, exibuf, servibuf[PROC_MAX];
169 extern int servpipes[PROC_MAX];
190 TAILQ_ENTRY(mbuf) mbufs;
193 TAILQ_HEAD(mbufhead, mbuf);
195 typedef void (imsg_handlerfn)(struct imsgbuf*, struct imsg*, size_t);
197 typedef void (*statefn)(int, short, void*);
200 * DFA: handle_handshake is the initial state, close_conn the final.
201 * Sometimes we have an enter_* function to handle the state switch.
203 * handle_handshake -> handle_open_conn
204 * handle_handshake -> close_conn // on err
206 * handle_open_conn -> handle_cgi_reply // via open_file/dir/...
207 * handle_open_conn -> send_fcgi_req // via apply_fastcgi, IMSG_FCGI_FD
208 * handle_open_conn -> handle_dirlist // ...same
209 * handle_open_conn -> send_file // ...same
210 * handle_open_conn -> start_reply // on error
212 * handle_cgi_reply -> handle_cgi // after logging the CGI reply
213 * handle_cgi_reply -> start_reply // on error
215 * handle_cgi -> close_conn
217 * send_fcgi_req -> copy_mbuf // via handle_fcgi
218 * handle_fcgi -> close_all // on error
219 * copy_mbuf -> close_conn // on success/error
221 * handle_dirlist -> send_directory_listing
222 * handle_dirlist -> close_conn // on error
224 * send_directory_listing -> close_conn
226 * send_file -> close_conn
231 char req[GEMINI_URL_LEN];
233 char domain[DOMAIN_NAME_LEN];
236 * start_reply uses this to know what function call after the
237 * reply. It's also used as sentinel value in fastcgi to know
238 * if the server has closed the request.
249 /* big enough to store STATUS + SPACE + META + CRLF */
253 struct mbufhead mbufhead;
255 struct sockaddr_storage addr;
256 struct vhost *host; /* host they're talking to */
257 size_t loc; /* location matched */
260 extern struct client clients[MAX_USERS];
263 char buf[GEMINI_URL_LEN];
265 size_t iri_schema_off;
269 size_t iri_query_off;
270 size_t iri_fragment_off;
273 char spath[PATH_MAX+1];
274 char relpath[PATH_MAX+1];
275 char addr[NI_MAXHOST+1];
277 /* AFAIK there isn't an upper limit for these two fields. */
311 char *data_dir(void);
312 void load_local_cert(const char*, const char*);
313 void load_vhosts(void);
314 int make_socket(int, int);
315 void setup_tls(void);
316 void init_config(void);
317 void free_config(void);
318 void drop_priv(void);
320 void yyerror(const char*, ...);
321 void parse_conf(const char*);
322 int cmdline_symset(char *);
325 void fatal(const char*, ...)
326 __attribute__((format (printf, 1, 2)))
327 __attribute__((__noreturn__));
329 #define LOG_ATTR_FMT __attribute__((format (printf, 2, 3)))
330 void log_err(struct client*, const char*, ...) LOG_ATTR_FMT;
331 void log_warn(struct client*, const char*, ...) LOG_ATTR_FMT;
332 void log_notice(struct client*, const char*, ...) LOG_ATTR_FMT;
333 void log_info(struct client*, const char*, ...) LOG_ATTR_FMT;
334 void log_debug(struct client*, const char*, ...) LOG_ATTR_FMT;
335 void log_request(struct client*, char*, size_t);
336 int logger_main(int, struct imsgbuf*);
339 void init_mime(struct mime*);
340 void add_mime(struct mime*, const char*, const char*);
341 void load_default_mime(struct mime*);
342 const char *mime(struct vhost*, const char*);
345 extern int shutting_down;
346 const char *vhost_lang(struct vhost*, const char*);
347 const char *vhost_default_mime(struct vhost*, const char*);
348 const char *vhost_index(struct vhost*, const char*);
349 int vhost_auto_index(struct vhost*, const char*);
350 int vhost_block_return(struct vhost*, const char*, int*, const char**);
351 int vhost_fastcgi(struct vhost*, const char*);
352 int vhost_dirfd(struct vhost*, const char*, size_t*);
353 int vhost_strip(struct vhost*, const char*);
354 X509_STORE *vhost_require_ca(struct vhost*, const char*);
355 int vhost_disable_log(struct vhost*, const char*);
357 void mark_nonblock(int);
358 void start_reply(struct client*, int, const char*);
359 void close_conn(int, short, void*);
360 struct client *try_client_by_id(int);
361 void loop(struct tls*, int, int, struct imsgbuf*);
364 int scandir_fd(int, struct dirent***, int(*)(const struct dirent*),
365 int(*)(const struct dirent**, const struct dirent**));
366 int select_non_dot(const struct dirent*);
367 int select_non_dotdot(const struct dirent*);
370 int send_string(int, const char*);
371 int recv_string(int, char**);
372 int send_iri(int, struct iri*);
373 int recv_iri(int, struct iri*);
374 void free_recvd_iri(struct iri*);
375 int send_vhost(int, struct vhost*);
376 int recv_vhost(int, struct vhost**);
377 int send_time(int, time_t);
378 int recv_time(int, time_t*);
379 int send_fd(int, int);
381 int executor_main(struct imsgbuf*);
384 void fcgi_close_backend(struct fcgi *);
385 void handle_fcgi(int, short, void*);
386 void send_fcgi_req(struct fcgi*, struct client*);
389 void sandbox_server_process(void);
390 void sandbox_executor_process(void);
391 void sandbox_logger_process(void);
394 int valid_multibyte_utf8(struct parser*);
395 char *utf8_nth(char*, size_t);
398 int parse_iri(char*, struct iri*, const char**);
399 int trim_req_iri(char*, const char **);
400 int serialize_iri(struct iri*, char*, size_t);
401 char *pct_decode_str(char *);
404 int puny_decode(const char*, char*, size_t, const char**);
407 void block_signals(void);
408 void unblock_signals(void);
409 int starts_with(const char*, const char*);
410 int ends_with(const char*, const char*);
411 ssize_t filesize(int);
412 char *absolutify_path(const char*);
413 char *xstrdup(const char*);
414 void *xcalloc(size_t, size_t);
415 void gen_certificate(const char*, const char*, const char*);
416 X509_STORE *load_ca(const char*);
417 int validate_against_ca(X509_STORE*, const uint8_t*, size_t);
418 void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);