xref: /openbsd-src/usr.sbin/httpd/httpd.h (revision f1dd7b858388b4a23f4f67a4957ec5ff656ebbe8)
1 /*	$OpenBSD: httpd.h,v 1.157 2021/05/17 09:26:52 florian Exp $	*/
2 
3 /*
4  * Copyright (c) 2006 - 2015 Reyk Floeter <reyk@openbsd.org>
5  * Copyright (c) 2006, 2007 Pierre-Yves Ritschard <pyr@openbsd.org>
6  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
7  *
8  * Permission to use, copy, modify, and distribute this software for any
9  * purpose with or without fee is hereby granted, provided that the above
10  * copyright notice and this permission notice appear in all copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19  */
20 
21 #ifndef _HTTPD_H
22 #define _HTTPD_H
23 
24 #include <sys/types.h>
25 #include <sys/socket.h>
26 #include <sys/queue.h>
27 #include <sys/tree.h>
28 #include <sys/time.h>
29 
30 #include <net/if.h>
31 #include <netinet/in.h>
32 
33 #include <stdarg.h>
34 #include <limits.h>
35 #include <event.h>
36 #include <imsg.h>
37 #include <tls.h>
38 #include <vis.h>
39 
40 #include "patterns.h"
41 
42 #ifndef nitems
43 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
44 #endif
45 
46 #define CONF_FILE		"/etc/httpd.conf"
47 #define HTTPD_SOCKET		"/var/run/httpd.sock"
48 #define HTTPD_USER		"www"
49 #define HTTPD_SERVERNAME	"OpenBSD httpd"
50 #define HTTPD_DOCROOT		"/htdocs"
51 #define HTTPD_INDEX		"index.html"
52 #define HTTPD_FCGI_SOCKET	"/run/slowcgi.sock"
53 #define HTTPD_LOGROOT		"/logs"
54 #define HTTPD_ACCESS_LOG	"access.log"
55 #define HTTPD_ERROR_LOG		"error.log"
56 #define HTTPD_MAX_ALIAS_IP	16
57 #define HTTPD_REALM_MAX		255
58 #define HTTPD_LOCATION_MAX	255
59 #define HTTPD_DEFAULT_TYPE	{ "bin", "application", "octet-stream", NULL }
60 #define HTTPD_LOGVIS		VIS_NL|VIS_TAB|VIS_CSTYLE
61 #define HTTPD_TLS_CERT		"/etc/ssl/server.crt"
62 #define HTTPD_TLS_KEY		"/etc/ssl/private/server.key"
63 #define HTTPD_TLS_CONFIG_MAX	511
64 #define HTTPD_TLS_CIPHERS	"compat"
65 #define HTTPD_TLS_DHE_PARAMS	"none"
66 #define HTTPD_TLS_ECDHE_CURVES	"default"
67 #define HTTPD_FCGI_NAME_MAX	511
68 #define HTTPD_FCGI_VAL_MAX	511
69 #define FD_RESERVE		5
70 
71 #define SERVER_MAX_CLIENTS	1024
72 #define SERVER_TIMEOUT		600
73 #define SERVER_REQUESTTIMEOUT	60
74 #define SERVER_CACHESIZE	-1	/* use default size */
75 #define SERVER_NUMPROC		3
76 #define SERVER_MAXHEADERLENGTH	8192
77 #define SERVER_MAXREQUESTS	100	/* max requests per connection */
78 #define SERVER_MAXREQUESTBODY	1048576	/* 1M */
79 #define SERVER_BACKLOG		10
80 #define SERVER_OUTOF_FD_RETRIES	5
81 #define SERVER_MAX_PREFETCH	256
82 #define SERVER_MIN_PREFETCHED	32
83 #define SERVER_HSTS_DEFAULT_AGE	31536000
84 #define SERVER_MAX_RANGES	4
85 #define SERVER_DEF_TLS_LIFETIME	(2 * 3600)
86 #define SERVER_MIN_TLS_LIFETIME	(60)
87 #define SERVER_MAX_TLS_LIFETIME	(24 * 3600)
88 
89 #define MEDIATYPE_NAMEMAX	128	/* file name extension */
90 #define MEDIATYPE_TYPEMAX	64	/* length of type/subtype */
91 
92 #define CONFIG_RELOAD		0x00
93 #define CONFIG_MEDIA		0x01
94 #define CONFIG_SERVERS		0x02
95 #define CONFIG_AUTH		0x04
96 #define CONFIG_ALL		0xff
97 
98 #define FCGI_CONTENT_SIZE	65535
99 #define FCGI_DEFAULT_PORT	"9000"
100 
101 #define PROC_PARENT_SOCK_FILENO	3
102 #define PROC_MAX_INSTANCES	32
103 
104 enum httpchunk {
105 	TOREAD_UNLIMITED		= -1,
106 	TOREAD_HTTP_HEADER		= -2,
107 	TOREAD_HTTP_CHUNK_LENGTH	= -3,
108 	TOREAD_HTTP_CHUNK_TRAILER	= -4,
109 	TOREAD_HTTP_NONE		= -5,
110 	TOREAD_HTTP_RANGE		= TOREAD_HTTP_CHUNK_LENGTH
111 };
112 
113 #if DEBUG
114 #define DPRINTF		log_debug
115 #else
116 #define DPRINTF(x...)	do {} while(0)
117 #endif
118 
119 struct ctl_flags {
120 	uint8_t		 cf_opts;
121 	uint32_t	 cf_flags;
122 	uint8_t		 cf_tls_sid[TLS_MAX_SESSION_ID_LENGTH];
123 };
124 
125 TAILQ_HEAD(kvlist, kv);
126 RB_HEAD(kvtree, kv);
127 
128 struct kv {
129 	char			*kv_key;
130 	char			*kv_value;
131 
132 #define KV_FLAG_INVALID		 0x01
133 #define KV_FLAG_GLOBBING	 0x02
134 	uint8_t			 kv_flags;
135 
136 	struct kvlist		 kv_children;
137 	struct kv		*kv_parent;
138 	TAILQ_ENTRY(kv)		 kv_entry;
139 
140 	RB_ENTRY(kv)		 kv_node;
141 };
142 
143 struct portrange {
144 	in_port_t		 val[2];
145 	uint8_t			 op;
146 };
147 
148 struct address {
149 	struct sockaddr_storage	 ss;
150 	int			 ipproto;
151 	int			 prefixlen;
152 	struct portrange	 port;
153 	char			 ifname[IFNAMSIZ];
154 	TAILQ_ENTRY(address)	 entry;
155 };
156 TAILQ_HEAD(addresslist, address);
157 
158 /* initially control.h */
159 struct control_sock {
160 	const char	*cs_name;
161 	struct event	 cs_ev;
162 	struct event	 cs_evt;
163 	int		 cs_fd;
164 	int		 cs_restricted;
165 	void		*cs_env;
166 
167 	TAILQ_ENTRY(control_sock) cs_entry;
168 };
169 TAILQ_HEAD(control_socks, control_sock);
170 
171 extern struct {
172 	struct event	 ev;
173 	int		 fd;
174 } control_state;
175 
176 struct imsgev {
177 	struct imsgbuf		 ibuf;
178 	void			(*handler)(int, short, void *);
179 	struct event		 ev;
180 	struct privsep_proc	*proc;
181 	void			*data;
182 	short			 events;
183 };
184 
185 #define IMSG_SIZE_CHECK(imsg, p) do {				\
186 	if (IMSG_DATA_SIZE(imsg) < sizeof(*p))			\
187 		fatalx("bad length imsg received");		\
188 } while (0)
189 #define IMSG_DATA_SIZE(imsg)	((imsg)->hdr.len - IMSG_HEADER_SIZE)
190 #define MAX_IMSG_DATA_SIZE	(MAX_IMSGSIZE - IMSG_HEADER_SIZE)
191 
192 struct ctl_conn {
193 	TAILQ_ENTRY(ctl_conn)	 entry;
194 	uint8_t			 flags;
195 	unsigned int		 waiting;
196 #define CTL_CONN_NOTIFY		 0x01
197 	struct imsgev		 iev;
198 
199 };
200 TAILQ_HEAD(ctl_connlist, ctl_conn);
201 
202 enum imsg_type {
203 	IMSG_NONE,
204 	IMSG_CTL_OK,
205 	IMSG_CTL_FAIL,
206 	IMSG_CTL_VERBOSE,
207 	IMSG_CTL_PROCFD,
208 	IMSG_CTL_RESET,
209 	IMSG_CTL_SHUTDOWN,
210 	IMSG_CTL_RELOAD,
211 	IMSG_CTL_NOTIFY,
212 	IMSG_CTL_END,
213 	IMSG_CTL_START,
214 	IMSG_CTL_REOPEN,
215 	IMSG_CFG_SERVER,
216 	IMSG_CFG_TLS,
217 	IMSG_CFG_MEDIA,
218 	IMSG_CFG_AUTH,
219 	IMSG_CFG_FCGI,
220 	IMSG_CFG_DONE,
221 	IMSG_LOG_ACCESS,
222 	IMSG_LOG_ERROR,
223 	IMSG_LOG_OPEN,
224 	IMSG_TLSTICKET_REKEY
225 };
226 
227 enum privsep_procid {
228 	PROC_ALL	= -1,
229 	PROC_PARENT	= 0,
230 	PROC_SERVER,
231 	PROC_LOGGER,
232 	PROC_MAX
233 };
234 extern enum privsep_procid privsep_process;
235 
236 /* Attach the control socket to the following process */
237 #define PROC_CONTROL	PROC_LOGGER
238 
239 struct privsep_pipes {
240 	int				*pp_pipes[PROC_MAX];
241 };
242 
243 struct privsep {
244 	struct privsep_pipes		*ps_pipes[PROC_MAX];
245 	struct privsep_pipes		*ps_pp;
246 
247 	struct imsgev			*ps_ievs[PROC_MAX];
248 	const char			*ps_title[PROC_MAX];
249 	uint8_t				 ps_what[PROC_MAX];
250 
251 	unsigned int			 ps_instances[PROC_MAX];
252 	unsigned int			 ps_instance;
253 
254 	struct control_sock		 ps_csock;
255 	struct control_socks		 ps_rcsocks;
256 
257 	/* Event and signal handlers */
258 	struct event			 ps_evsigint;
259 	struct event			 ps_evsigterm;
260 	struct event			 ps_evsigchld;
261 	struct event			 ps_evsighup;
262 	struct event			 ps_evsigpipe;
263 	struct event			 ps_evsigusr1;
264 
265 	int				 ps_noaction;
266 	struct passwd			*ps_pw;
267 	struct httpd			*ps_env;
268 };
269 
270 struct privsep_proc {
271 	const char		*p_title;
272 	enum privsep_procid	 p_id;
273 	int			(*p_cb)(int, struct privsep_proc *,
274 				    struct imsg *);
275 	void			(*p_init)(struct privsep *,
276 				    struct privsep_proc *);
277 	const char		*p_chroot;
278 	struct privsep		*p_ps;
279 	void			(*p_shutdown)(void);
280 	struct passwd		*p_pw;
281 };
282 
283 struct privsep_fd {
284 	enum privsep_procid		 pf_procid;
285 	unsigned int			 pf_instance;
286 };
287 
288 enum fcgistate {
289 	FCGI_READ_HEADER,
290 	FCGI_READ_CONTENT,
291 	FCGI_READ_PADDING
292 };
293 
294 struct fcgi_data {
295 	enum fcgistate		 state;
296 	int			 toread;
297 	int			 padding_len;
298 	int			 type;
299 	int			 chunked;
300 	int			 end;
301 	int			 status;
302 	int			 headersdone;
303 	int			 headerssent;
304 };
305 
306 struct range {
307 	off_t	start;
308 	off_t	end;
309 };
310 
311 struct range_data {
312 	struct range		 range[SERVER_MAX_RANGES];
313 	int			 range_count;
314 	int			 range_index;
315 	off_t			 range_toread;
316 
317 	/* For the Content headers in each part */
318 	struct media_type	*range_media;
319 	size_t			 range_total;
320 };
321 
322 struct client {
323 	uint32_t		 clt_id;
324 	pid_t			 clt_pid;
325 	void			*clt_srv;
326 	void			*clt_srv_conf;
327 	uint32_t		 clt_srv_id;
328 	struct sockaddr_storage	 clt_srv_ss;
329 	struct str_match	 clt_srv_match;
330 
331 	int			 clt_s;
332 	in_port_t		 clt_port;
333 	struct sockaddr_storage	 clt_ss;
334 	struct bufferevent	*clt_bev;
335 	struct evbuffer		*clt_output;
336 	struct event		 clt_ev;
337 	void			*clt_descreq;
338 	void			*clt_descresp;
339 	int			 clt_sndbufsiz;
340 	uint64_t		 clt_boundary;
341 
342 	int			 clt_fd;
343 	struct tls		*clt_tls_ctx;
344 	struct bufferevent	*clt_srvbev;
345 	int			 clt_srvbev_throttled;
346 
347 	off_t			 clt_toread;
348 	size_t			 clt_headerlen;
349 	int			 clt_headersdone;
350 	unsigned int		 clt_persist;
351 	unsigned int		 clt_pipelining;
352 	int			 clt_line;
353 	int			 clt_done;
354 	int			 clt_chunk;
355 	int			 clt_inflight;
356 	struct range_data	 clt_ranges;
357 	struct fcgi_data	 clt_fcgi;
358 	char			*clt_remote_user;
359 	struct evbuffer		*clt_srvevb;
360 
361 	struct evbuffer		*clt_log;
362 	struct timeval		 clt_timeout;
363 	struct timeval		 clt_tv_start;
364 	struct timeval		 clt_tv_last;
365 	struct event		 clt_inflightevt;
366 
367 	SPLAY_ENTRY(client)	 clt_nodes;
368 };
369 SPLAY_HEAD(client_tree, client);
370 
371 #define SRVFLAG_INDEX		0x00000001
372 #define SRVFLAG_NO_INDEX	0x00000002
373 #define SRVFLAG_AUTO_INDEX	0x00000004
374 #define SRVFLAG_NO_AUTO_INDEX	0x00000008
375 #define SRVFLAG_ROOT		0x00000010
376 #define SRVFLAG_LOCATION	0x00000020
377 #define SRVFLAG_FCGI		0x00000040
378 #define SRVFLAG_NO_FCGI		0x00000080
379 #define SRVFLAG_LOG		0x00000100
380 #define SRVFLAG_NO_LOG		0x00000200
381 #define SRVFLAG_SYSLOG		0x00000800
382 #define SRVFLAG_NO_SYSLOG	0x00001000
383 #define SRVFLAG_TLS		0x00002000
384 #define SRVFLAG_ACCESS_LOG	0x00004000
385 #define SRVFLAG_ERROR_LOG	0x00008000
386 #define SRVFLAG_AUTH		0x00010000
387 #define SRVFLAG_NO_AUTH		0x00020000
388 #define SRVFLAG_BLOCK		0x00040000
389 #define SRVFLAG_NO_BLOCK	0x00080000
390 #define SRVFLAG_LOCATION_MATCH	0x00100000
391 #define SRVFLAG_SERVER_MATCH	0x00200000
392 #define SRVFLAG_SERVER_HSTS	0x00400000
393 #define SRVFLAG_DEFAULT_TYPE	0x00800000
394 #define SRVFLAG_PATH_REWRITE	0x01000000
395 #define SRVFLAG_NO_PATH_REWRITE	0x02000000
396 #define SRVFLAG_LOCATION_FOUND	0x40000000
397 #define SRVFLAG_LOCATION_NOT_FOUND 0x80000000
398 
399 #define SRVFLAG_BITS							\
400 	"\10\01INDEX\02NO_INDEX\03AUTO_INDEX\04NO_AUTO_INDEX"		\
401 	"\05ROOT\06LOCATION\07FCGI\10NO_FCGI\11LOG\12NO_LOG"		\
402 	"\14SYSLOG\15NO_SYSLOG\16TLS\17ACCESS_LOG\20ERROR_LOG"		\
403 	"\21AUTH\22NO_AUTH\23BLOCK\24NO_BLOCK\25LOCATION_MATCH"		\
404 	"\26SERVER_MATCH\27SERVER_HSTS\30DEFAULT_TYPE\31PATH\32NO_PATH" \
405 	"\37LOCATION_FOUND\40LOCATION_NOT_FOUND"
406 
407 #define TCPFLAG_NODELAY		0x01
408 #define TCPFLAG_NNODELAY	0x02
409 #define TCPFLAG_SACK		0x04
410 #define TCPFLAG_NSACK		0x08
411 #define TCPFLAG_BUFSIZ		0x10
412 #define TCPFLAG_IPTTL		0x20
413 #define TCPFLAG_IPMINTTL	0x40
414 #define TCPFLAG_NSPLICE		0x80
415 #define TCPFLAG_DEFAULT		0x00
416 
417 #define TCPFLAG_BITS						\
418 	"\10\01NODELAY\02NO_NODELAY\03SACK\04NO_SACK"		\
419 	"\05SOCKET_BUFFER_SIZE\06IP_TTL\07IP_MINTTL\10NO_SPLICE"
420 
421 #define HSTSFLAG_SUBDOMAINS	0x01
422 #define HSTSFLAG_PRELOAD	0x02
423 #define HSTSFLAG_BITS		"\10\01SUBDOMAINS\02PRELOAD"
424 
425 #define TLSFLAG_CA		0x01
426 #define TLSFLAG_CRL		0x02
427 #define TLSFLAG_OPTIONAL	0x04
428 #define TLSFLAG_BITS		"\10\01CA\02CRL\03OPTIONAL"
429 
430 enum log_format {
431 	LOG_FORMAT_COMMON,
432 	LOG_FORMAT_COMBINED,
433 	LOG_FORMAT_CONNECTION,
434 	LOG_FORMAT_FORWARDED
435 };
436 
437 struct log_file {
438 	char			log_name[PATH_MAX];
439 	int			log_fd;
440 	uint32_t		log_id;
441 	TAILQ_ENTRY(log_file)	log_entry;
442 };
443 extern TAILQ_HEAD(log_files, log_file) log_files;
444 
445 struct media_type {
446 	char			 media_name[MEDIATYPE_NAMEMAX];
447 	char			 media_type[MEDIATYPE_TYPEMAX];
448 	char			 media_subtype[MEDIATYPE_TYPEMAX];
449 	char			*media_encoding;
450 	RB_ENTRY(media_type)	 media_entry;
451 };
452 RB_HEAD(mediatypes, media_type);
453 
454 struct auth {
455 	char			 auth_htpasswd[PATH_MAX];
456 	uint32_t		 auth_id;
457 	TAILQ_ENTRY(auth)	 auth_entry;
458 };
459 TAILQ_HEAD(serverauth, auth);
460 
461 struct server_tls_ticket {
462 	uint32_t	tt_id;
463 	uint32_t	tt_keyrev;
464 	unsigned char	tt_key[TLS_TICKET_KEY_SIZE];
465 };
466 
467 struct fastcgi_param {
468 	char			name[HTTPD_FCGI_NAME_MAX];
469 	char			value[HTTPD_FCGI_VAL_MAX];
470 
471 	TAILQ_ENTRY(fastcgi_param) entry;
472 };
473 TAILQ_HEAD(server_fcgiparams, fastcgi_param);
474 
475 struct server_config {
476 	uint32_t		 id;
477 	uint32_t		 parent_id;
478 	char			 name[HOST_NAME_MAX+1];
479 	char			 location[HTTPD_LOCATION_MAX];
480 	char			 root[PATH_MAX];
481 	char			 path[PATH_MAX];
482 	char			 index[PATH_MAX];
483 	char			 accesslog[PATH_MAX];
484 	char			 errorlog[PATH_MAX];
485 	struct media_type	 default_type;
486 
487 	struct sockaddr_storage	 fastcgi_ss;
488 
489 	in_port_t		 port;
490 	struct sockaddr_storage	 ss;
491 	int			 prefixlen;
492 	struct timeval		 timeout;
493 	struct timeval		 requesttimeout;
494 	uint32_t		 maxrequests;
495 	size_t			 maxrequestbody;
496 
497 	uint8_t			*tls_ca;
498 	char			*tls_ca_file;
499 	size_t			 tls_ca_len;
500 	uint8_t			*tls_cert;
501 	size_t			 tls_cert_len;
502 	char			*tls_cert_file;
503 	char			 tls_ciphers[HTTPD_TLS_CONFIG_MAX];
504 	uint8_t			*tls_crl;
505 	char			*tls_crl_file;
506 	size_t			 tls_crl_len;
507 	char			 tls_dhe_params[HTTPD_TLS_CONFIG_MAX];
508 	char			 tls_ecdhe_curves[HTTPD_TLS_CONFIG_MAX];
509 	uint8_t			 tls_flags;
510 	uint8_t			*tls_key;
511 	size_t			 tls_key_len;
512 	char			*tls_key_file;
513 	uint32_t		 tls_protocols;
514 	uint8_t			*tls_ocsp_staple;
515 	size_t			 tls_ocsp_staple_len;
516 	char			*tls_ocsp_staple_file;
517 	struct server_tls_ticket tls_ticket_key;
518 	int			 tls_ticket_lifetime;
519 
520 	uint32_t		 flags;
521 	int			 strip;
522 	uint8_t			 tcpflags;
523 	int			 tcpbufsiz;
524 	int			 tcpbacklog;
525 	uint8_t			 tcpipttl;
526 	uint8_t			 tcpipminttl;
527 
528 	enum log_format		 logformat;
529 	struct log_file		*logaccess;
530 	struct log_file		*logerror;
531 
532 	char			 auth_realm[HTTPD_REALM_MAX];
533 	uint32_t		 auth_id;
534 	const struct auth	*auth;
535 
536 	int			 return_code;
537 	char			*return_uri;
538 	off_t			 return_uri_len;
539 
540 	int			 hsts_max_age;
541 	uint8_t			 hsts_flags;
542 
543 	struct server_fcgiparams fcgiparams;
544 	int			 fcgistrip;
545 
546 	TAILQ_ENTRY(server_config) entry;
547 };
548 TAILQ_HEAD(serverhosts, server_config);
549 
550 enum tls_config_type {
551 	TLS_CFG_CA,
552 	TLS_CFG_CERT,
553 	TLS_CFG_CRL,
554 	TLS_CFG_KEY,
555 	TLS_CFG_OCSP_STAPLE,
556 };
557 
558 struct tls_config {
559 	uint32_t		 id;
560 
561 	enum tls_config_type	 tls_type;
562 	size_t			 tls_len;
563 	size_t			 tls_chunk_len;
564 	size_t			 tls_chunk_offset;
565 };
566 
567 struct server {
568 	TAILQ_ENTRY(server)	 srv_entry;
569 	struct server_config	 srv_conf;
570 	struct serverhosts	 srv_hosts;
571 
572 	int			 srv_s;
573 	struct event		 srv_ev;
574 	struct event		 srv_evt;
575 
576 	struct tls		 *srv_tls_ctx;
577 	struct tls_config	 *srv_tls_config;
578 
579 	struct client_tree	 srv_clients;
580 };
581 TAILQ_HEAD(serverlist, server);
582 
583 struct httpd {
584 	uint8_t			 sc_opts;
585 	uint32_t		 sc_flags;
586 	const char		*sc_conffile;
587 	struct event		 sc_ev;
588 	uint16_t		 sc_prefork_server;
589 	uint16_t		 sc_id;
590 	int			 sc_paused;
591 	char			*sc_chroot;
592 	char			*sc_logdir;
593 
594 	uint8_t			 sc_tls_sid[TLS_MAX_SESSION_ID_LENGTH];
595 
596 	struct serverlist	*sc_servers;
597 	struct mediatypes	*sc_mediatypes;
598 	struct media_type	 sc_default_type;
599 	struct serverauth	*sc_auth;
600 
601 	struct privsep		*sc_ps;
602 	int			 sc_reload;
603 };
604 
605 #define HTTPD_OPT_VERBOSE		0x01
606 #define HTTPD_OPT_NOACTION		0x04
607 
608 /* control.c */
609 int	 control_init(struct privsep *, struct control_sock *);
610 int	 control_listen(struct control_sock *);
611 void	 control_cleanup(struct control_sock *);
612 void	 control_dispatch_imsg(int, short, void *);
613 void	 control_imsg_forward(struct privsep *, struct imsg *);
614 struct ctl_conn	*
615 	 control_connbyfd(int);
616 
617 /* parse.y */
618 int	 parse_config(const char *, struct httpd *);
619 int	 load_config(const char *, struct httpd *);
620 int	 cmdline_symset(char *);
621 
622 /* server.c */
623 void	 server(struct privsep *, struct privsep_proc *);
624 int	 server_tls_cmp(struct server *, struct server *);
625 int	 server_tls_load_ca(struct server *);
626 int	 server_tls_load_crl(struct server *);
627 int	 server_tls_load_keypair(struct server *);
628 int	 server_tls_load_ocsp(struct server *);
629 void	 server_generate_ticket_key(struct server_config *);
630 int	 server_privinit(struct server *);
631 void	 server_purge(struct server *);
632 void	 serverconfig_free(struct server_config *);
633 void	 serverconfig_reset(struct server_config *);
634 int	 server_socket_af(struct sockaddr_storage *, in_port_t);
635 in_port_t
636 	 server_socket_getport(struct sockaddr_storage *);
637 int	 server_socket_connect(struct sockaddr_storage *, in_port_t,
638 	    struct server_config *);
639 void	 server_write(struct bufferevent *, void *);
640 void	 server_read(struct bufferevent *, void *);
641 void	 server_error(struct bufferevent *, short, void *);
642 void	 server_log(struct client *, const char *);
643 void	 server_sendlog(struct server_config *, int, const char *, ...)
644 	    __attribute__((__format__ (printf, 3, 4)));
645 void	 server_close(struct client *, const char *);
646 void	 server_dump(struct client *, const void *, size_t);
647 int	 server_client_cmp(struct client *, struct client *);
648 int	 server_bufferevent_printf(struct client *, const char *, ...)
649 	    __attribute__((__format__ (printf, 2, 3)));
650 int	 server_bufferevent_print(struct client *, const char *);
651 int	 server_bufferevent_write_buffer(struct client *,
652 	    struct evbuffer *);
653 int	 server_bufferevent_write_chunk(struct client *,
654 	    struct evbuffer *, size_t);
655 int	 server_bufferevent_add(struct event *, int);
656 int	 server_bufferevent_write(struct client *, void *, size_t);
657 struct server *
658 	 server_byaddr(struct sockaddr *, in_port_t);
659 struct server_config *
660 	 serverconfig_byid(uint32_t);
661 int	 server_foreach(int (*)(struct server *,
662 	    struct server_config *, void *), void *);
663 struct server *
664 	 server_match(struct server *, int);
665 
666 SPLAY_PROTOTYPE(client_tree, client, clt_nodes, server_client_cmp);
667 
668 /* server_http.c */
669 void	 server_http_init(struct server *);
670 void	 server_http(void);
671 int	 server_httpdesc_init(struct client *);
672 void	 server_read_http(struct bufferevent *, void *);
673 void	 server_abort_http(struct client *, unsigned int, const char *);
674 unsigned int
675 	 server_httpmethod_byname(const char *);
676 const char
677 	*server_httpmethod_byid(unsigned int);
678 const char
679 	*server_httperror_byid(unsigned int);
680 void	 server_read_httpcontent(struct bufferevent *, void *);
681 void	 server_read_httpchunks(struct bufferevent *, void *);
682 void	 server_read_httprange(struct bufferevent *, void *);
683 int	 server_writeheader_http(struct client *clt, struct kv *, void *);
684 int	 server_headers(struct client *, void *,
685 	    int (*)(struct client *, struct kv *, void *), void *);
686 int	 server_writeresponse_http(struct client *);
687 int	 server_response_http(struct client *, unsigned int,
688 	    struct media_type *, off_t, time_t);
689 void	 server_reset_http(struct client *);
690 void	 server_close_http(struct client *);
691 int	 server_response(struct httpd *, struct client *);
692 const char *
693 	 server_root_strip(const char *, int);
694 struct server_config *
695 	 server_getlocation(struct client *, const char *);
696 int	 server_locationaccesstest(struct server_config *, const char *);
697 const char *
698 	 server_http_host(struct sockaddr_storage *, char *, size_t);
699 char	*server_http_parsehost(char *, char *, size_t, int *);
700 ssize_t	 server_http_time(time_t, char *, size_t);
701 int	 server_log_http(struct client *, unsigned int, size_t);
702 
703 /* server_file.c */
704 int	 server_file(struct httpd *, struct client *);
705 void	 server_file_error(struct bufferevent *, short, void *);
706 
707 /* server_fcgi.c */
708 int	 server_fcgi(struct httpd *, struct client *);
709 int	 fcgi_add_stdin(struct client *, struct evbuffer *);
710 
711 /* httpd.c */
712 void		 event_again(struct event *, int, short,
713 		    void (*)(int, short, void *),
714 		    struct timeval *, struct timeval *, void *);
715 int		 expand_string(char *, size_t, const char *, const char *);
716 const char	*url_decode(char *);
717 char		*url_encode(const char *);
718 const char	*canonicalize_path(const char *, char *, size_t);
719 size_t		 path_info(char *);
720 char		*escape_html(const char *);
721 void		 socket_rlimit(int);
722 char		*evbuffer_getline(struct evbuffer *);
723 char		*get_string(uint8_t *, size_t);
724 void		*get_data(uint8_t *, size_t);
725 int		 sockaddr_cmp(struct sockaddr *, struct sockaddr *, int);
726 struct in6_addr *prefixlen2mask6(uint8_t, uint32_t *);
727 uint32_t	 prefixlen2mask(uint8_t);
728 int		 accept_reserve(int, struct sockaddr *, socklen_t *, int,
729 		    volatile int *);
730 struct kv	*kv_add(struct kvtree *, char *, char *);
731 int		 kv_set(struct kv *, char *, ...)
732 		    __attribute__((__format__ (printf, 2, 3)));
733 int		 kv_setkey(struct kv *, char *, ...)
734 		    __attribute__((__format__ (printf, 2, 3)));
735 void		 kv_delete(struct kvtree *, struct kv *);
736 struct kv	*kv_extend(struct kvtree *, struct kv *, char *);
737 void		 kv_purge(struct kvtree *);
738 void		 kv_free(struct kv *);
739 struct kv	*kv_find(struct kvtree *, struct kv *);
740 int		 kv_cmp(struct kv *, struct kv *);
741 struct media_type
742 		*media_add(struct mediatypes *, struct media_type *);
743 void		 media_delete(struct mediatypes *, struct media_type *);
744 void		 media_purge(struct mediatypes *);
745 struct media_type *
746 		 media_find(struct mediatypes *, const char *);
747 struct media_type *
748 		 media_find_config(struct httpd *, struct server_config *,
749 		    const char *);
750 int		 media_cmp(struct media_type *, struct media_type *);
751 RB_PROTOTYPE(kvtree, kv, kv_node, kv_cmp);
752 RB_PROTOTYPE(mediatypes, media_type, media_entry, media_cmp);
753 struct auth	*auth_add(struct serverauth *, struct auth *);
754 struct auth	*auth_byid(struct serverauth *, uint32_t);
755 void		 auth_free(struct serverauth *, struct auth *);
756 const char	*print_host(struct sockaddr_storage *, char *, size_t);
757 const char	*printb_flags(const uint32_t, const char *);
758 void		 getmonotime(struct timeval *);
759 
760 extern struct httpd *httpd_env;
761 
762 /* log.c */
763 void	log_init(int, int);
764 void	log_procinit(const char *);
765 void	log_setverbose(int);
766 int	log_getverbose(void);
767 void	log_warn(const char *, ...)
768 	    __attribute__((__format__ (printf, 1, 2)));
769 void	log_warnx(const char *, ...)
770 	    __attribute__((__format__ (printf, 1, 2)));
771 void	log_info(const char *, ...)
772 	    __attribute__((__format__ (printf, 1, 2)));
773 void	log_debug(const char *, ...)
774 	    __attribute__((__format__ (printf, 1, 2)));
775 void	logit(int, const char *, ...)
776 	    __attribute__((__format__ (printf, 2, 3)));
777 void	vlog(int, const char *, va_list)
778 	    __attribute__((__format__ (printf, 2, 0)));
779 __dead void fatal(const char *, ...)
780 	    __attribute__((__format__ (printf, 1, 2)));
781 __dead void fatalx(const char *, ...)
782 	    __attribute__((__format__ (printf, 1, 2)));
783 
784 /* proc.c */
785 enum privsep_procid
786 	    proc_getid(struct privsep_proc *, unsigned int, const char *);
787 void	 proc_init(struct privsep *, struct privsep_proc *, unsigned int, int,
788 	    int, char **, enum privsep_procid);
789 void	 proc_kill(struct privsep *);
790 void	 proc_connect(struct privsep *);
791 void	 proc_dispatch(int, short event, void *);
792 void	 proc_run(struct privsep *, struct privsep_proc *,
793 	    struct privsep_proc *, unsigned int,
794 	    void (*)(struct privsep *, struct privsep_proc *, void *), void *);
795 void	 proc_range(struct privsep *, enum privsep_procid, int *, int *);
796 int	 proc_compose_imsg(struct privsep *, enum privsep_procid, int,
797 	    u_int16_t, u_int32_t, int, void *, u_int16_t);
798 int	 proc_compose(struct privsep *, enum privsep_procid,
799 	    uint16_t, void *, uint16_t);
800 int	 proc_composev_imsg(struct privsep *, enum privsep_procid, int,
801 	    u_int16_t, u_int32_t, int, const struct iovec *, int);
802 int	 proc_composev(struct privsep *, enum privsep_procid,
803 	    uint16_t, const struct iovec *, int);
804 int	 proc_forward_imsg(struct privsep *, struct imsg *,
805 	    enum privsep_procid, int);
806 struct imsgbuf *
807 	 proc_ibuf(struct privsep *, enum privsep_procid, int);
808 struct imsgev *
809 	 proc_iev(struct privsep *, enum privsep_procid, int);
810 int	 proc_flush_imsg(struct privsep *, enum privsep_procid, int);
811 void	 imsg_event_add(struct imsgev *);
812 int	 imsg_compose_event(struct imsgev *, uint16_t, uint32_t,
813 	    pid_t, int, void *, uint16_t);
814 int	 imsg_composev_event(struct imsgev *, uint16_t, uint32_t,
815 	    pid_t, int, const struct iovec *, int);
816 
817 /* config.c */
818 int	 config_init(struct httpd *);
819 void	 config_purge(struct httpd *, unsigned int);
820 int	 config_setreset(struct httpd *, unsigned int);
821 int	 config_getreset(struct httpd *, struct imsg *);
822 int	 config_getcfg(struct httpd *, struct imsg *);
823 int	 config_setserver(struct httpd *, struct server *);
824 int	 config_setserver_tls(struct httpd *, struct server *);
825 int	 config_setserver_fcgiparams(struct httpd *, struct server *);
826 int	 config_getserver(struct httpd *, struct imsg *);
827 int	 config_getserver_tls(struct httpd *, struct imsg *);
828 int	 config_getserver_fcgiparams(struct httpd *, struct imsg *);
829 int	 config_setmedia(struct httpd *, struct media_type *);
830 int	 config_getmedia(struct httpd *, struct imsg *);
831 int	 config_setauth(struct httpd *, struct auth *);
832 int	 config_getauth(struct httpd *, struct imsg *);
833 
834 /* logger.c */
835 void	 logger(struct privsep *, struct privsep_proc *);
836 int	 logger_open_priv(struct imsg *);
837 
838 #endif /* _HTTPD_H */
839