1 /*
2  * Copyright (c) 2016, 2019, 2020-2022 Tracey Emery <tracey@traceyemery.net>
3  * Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org>
4  * Copyright (c) 2013 David Gwynne <dlg@openbsd.org>
5  * Copyright (c) 2013 Florian Obser <florian@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #include <netinet/in.h>
21 #include <net/if.h>
22 #include <sys/queue.h>
23 
24 #include <limits.h>
25 #include <stdio.h>
26 
27 #ifdef DEBUG
28 #define dprintf(x...)   do { log_debug(x); } while(0)
29 #else
30 #define dprintf(x...)
31 #endif /* DEBUG */
32 
33 #ifndef nitems
34 #define nitems(_a)	(sizeof((_a)) / sizeof((_a)[0]))
35 #endif
36 
37 /* GOTWEBD DEFAULTS */
38 #define GOTWEBD_CONF		 "/etc/gotwebd.conf"
39 
40 #define GOTWEBD_USER		 "www"
41 
42 #define GOTWEBD_MAXDESCRSZ	 1024
43 #define GOTWEBD_MAXCLONEURLSZ	 1024
44 #define GOTWEBD_CACHESIZE	 1024
45 #define GOTWEBD_MAXCLIENTS	 1024
46 #define GOTWEBD_MAXTEXT		 511
47 #define GOTWEBD_MAXNAME		 64
48 #define GOTWEBD_MAXPORT		 6
49 #define GOTWEBD_NUMPROC		 3
50 #define GOTWEBD_MAXIFACE	 16
51 #define GOTWEBD_REPO_CACHESIZE	 4
52 
53 /* GOTWEB DEFAULTS */
54 #define MAX_QUERYSTRING		 2048
55 #define MAX_DOCUMENT_URI	 255
56 #define MAX_SERVER_NAME		 255
57 
58 #define GOTWEB_GIT_DIR		 ".git"
59 
60 #define D_HTTPD_CHROOT		 "/var/www"
61 #define D_UNIX_SOCKET		 "/run/gotweb.sock"
62 #define D_FCGI_PORT		 "9000"
63 #define D_GOTPATH		 "/got/public"
64 #define D_SITENAME		 "Gotweb"
65 #define D_SITEOWNER		 "Got Owner"
66 #define D_SITELINK		 "Repos"
67 #define D_GOTLOGO		 "got.png"
68 #define D_GOTURL		 "https://gameoftrees.org"
69 #define D_GOTWEBCSS		 "gotweb.css"
70 
71 #define D_SHOWROWNER		 1
72 #define D_SHOWSOWNER		 1
73 #define D_SHOWAGE		 1
74 #define D_SHOWDESC		 1
75 #define D_SHOWURL		 1
76 #define D_RESPECTEXPORTOK	 0
77 #define D_MAXREPO		 0
78 #define D_MAXREPODISP		 25
79 #define D_MAXSLCOMMDISP		 10
80 #define D_MAXCOMMITDISP		 25
81 
82 #define BUF			 8192
83 
84 #define TIMEOUT_DEFAULT		 120
85 
86 #define FCGI_CONTENT_SIZE	 65535
87 #define FCGI_PADDING_SIZE	 255
88 #define FCGI_RECORD_SIZE	 \
89     (sizeof(struct fcgi_record_header) + FCGI_CONTENT_SIZE + FCGI_PADDING_SIZE)
90 
91 #define FCGI_ALIGNMENT		 8
92 #define FCGI_ALIGN(n)		 \
93     (((n) + (FCGI_ALIGNMENT - 1)) & ~(FCGI_ALIGNMENT - 1))
94 
95 #define FD_RESERVE		 5
96 #define FD_NEEDED		 6
97 
98 #define FCGI_BEGIN_REQUEST	 1
99 #define FCGI_ABORT_REQUEST	 2
100 #define FCGI_END_REQUEST	 3
101 #define FCGI_PARAMS		 4
102 #define FCGI_STDIN		 5
103 #define FCGI_STDOUT		 6
104 #define FCGI_STDERR		 7
105 #define FCGI_DATA		 8
106 #define FCGI_GET_VALUES		 9
107 #define FCGI_GET_VALUES_RESULT	10
108 #define FCGI_UNKNOWN_TYPE	11
109 #define FCGI_MAXTYPE		(FCGI_UNKNOWN_TYPE)
110 
111 #define FCGI_REQUEST_COMPLETE	0
112 #define FCGI_CANT_MPX_CONN	1
113 #define FCGI_OVERLOADED		2
114 #define FCGI_UNKNOWN_ROLE	3
115 
116 #define GOTWEB_PACK_NUM_TEMPFILES     32
117 
118 enum imsg_type {
119 	IMSG_CFG_SRV = IMSG_PROC_MAX,
120 	IMSG_CFG_SOCK,
121 	IMSG_CFG_FD,
122 	IMSG_CFG_DONE,
123 	IMSG_CTL_START,
124 };
125 
126 struct env_val {
127 	SLIST_ENTRY(env_val)	 entry;
128 	char			*val;
129 };
130 SLIST_HEAD(env_head, env_val);
131 
132 struct fcgi_record_header {
133 	uint8_t		version;
134 	uint8_t		type;
135 	uint16_t	id;
136 	uint16_t	content_len;
137 	uint8_t		padding_len;
138 	uint8_t		reserved;
139 }__attribute__((__packed__));
140 
141 struct repo_dir {
142 	char			*name;
143 	char			*owner;
144 	char			*description;
145 	char			*url;
146 	char			*age;
147 	char			*path;
148 };
149 
150 struct repo_tag {
151 	TAILQ_ENTRY(repo_tag)	 entry;
152 	char			*commit_id;
153 	char			*tag_name;
154 	char			*tag_commit;
155 	char			*commit_msg;
156 	char			*tagger;
157 	time_t			 tagger_time;
158 };
159 
160 struct repo_commit {
161 	TAILQ_ENTRY(repo_commit)	 entry;
162 	char			*path;
163 	char			*refs_str;
164 	char			*commit_id; /* id_str1 */
165 	char			*parent_id; /* id_str2 */
166 	char			*tree_id;
167 	char			*author;
168 	char			*committer;
169 	char			*commit_msg;
170 	time_t			 committer_time;
171 };
172 
173 struct got_repository;
174 struct transport {
175 	TAILQ_HEAD(repo_commits_head, repo_commit)	 repo_commits;
176 	TAILQ_HEAD(repo_tags_head, repo_tag)		 repo_tags;
177 	struct got_repository	*repo;
178 	struct repo_dir		*repo_dir;
179 	struct querystring	*qs;
180 	char			*next_id;
181 	char			*prev_id;
182 	unsigned int		 repos_total;
183 	unsigned int		 next_disp;
184 	unsigned int		 prev_disp;
185 	unsigned int		 tag_count;
186 };
187 
188 enum socket_priv_fds {
189 	DIFF_FD_1,
190 	DIFF_FD_2,
191 	DIFF_FD_3,
192 	DIFF_FD_4,
193 	DIFF_FD_5,
194 	BLAME_FD_1,
195 	BLAME_FD_2,
196 	BLAME_FD_3,
197 	BLAME_FD_4,
198 	BLAME_FD_5,
199 	BLAME_FD_6,
200 	BLOB_FD_1,
201 	BLOB_FD_2,
202 	PRIV_FDS__MAX,
203 };
204 
205 struct template;
206 struct request {
207 	struct socket			*sock;
208 	struct server			*srv;
209 	struct transport		*t;
210 	struct template			*tp;
211 	struct event			 ev;
212 	struct event			 tmo;
213 
214 	uint16_t			 id;
215 	int				 fd;
216 	int				 priv_fd[PRIV_FDS__MAX];
217 
218 	uint8_t				 buf[FCGI_RECORD_SIZE];
219 	size_t				 buf_pos;
220 	size_t				 buf_len;
221 
222 	uint8_t				 outbuf[GOTWEBD_CACHESIZE];
223 	size_t				 outbuf_len;
224 
225 	char				 querystring[MAX_QUERYSTRING];
226 	char				 http_host[GOTWEBD_MAXTEXT];
227 	char				 document_uri[MAX_DOCUMENT_URI];
228 	char				 server_name[MAX_SERVER_NAME];
229 	int				 https;
230 
231 	uint8_t				 request_started;
232 };
233 
234 struct fcgi_begin_request_body {
235 	uint16_t	role;
236 	uint8_t		flags;
237 	uint8_t		reserved[5];
238 }__attribute__((__packed__));
239 
240 struct fcgi_end_request_body {
241 	uint32_t	app_status;
242 	uint8_t		protocol_status;
243 	uint8_t		reserved[3];
244 }__attribute__((__packed__));
245 
246 struct address {
247 	TAILQ_ENTRY(address)	 entry;
248 	struct sockaddr_storage	 ss;
249 	int			 ipproto;
250 	int			 prefixlen;
251 	in_port_t		 port;
252 	char			 ifname[IFNAMSIZ];
253 };
254 TAILQ_HEAD(addresslist, address);
255 
256 struct cached_repo {
257 	char path[PATH_MAX];
258 	struct got_repository *repo;
259 };
260 
261 struct server {
262 	TAILQ_ENTRY(server)	 entry;
263 	struct addresslist	al;
264 
265 	struct cached_repo	*cached_repos;
266 	int		 ncached_repos;
267 
268 	char		 name[GOTWEBD_MAXTEXT];
269 
270 	char		 repos_path[PATH_MAX];
271 	char		 site_name[GOTWEBD_MAXNAME];
272 	char		 site_owner[GOTWEBD_MAXNAME];
273 	char		 site_link[GOTWEBD_MAXTEXT];
274 	char		 logo[GOTWEBD_MAXTEXT];
275 	char		 logo_url[GOTWEBD_MAXTEXT];
276 	char		 custom_css[PATH_MAX];
277 
278 	size_t		 max_repos;
279 	size_t		 max_repos_display;
280 	size_t		 max_commits_display;
281 
282 	int		 show_site_owner;
283 	int		 show_repo_owner;
284 	int		 show_repo_age;
285 	int		 show_repo_description;
286 	int		 show_repo_cloneurl;
287 	int		 respect_exportok;
288 
289 	int		 unix_socket;
290 	char		 unix_socket_name[PATH_MAX];
291 
292 	int		 fcgi_socket;
293 };
294 TAILQ_HEAD(serverlist, server);
295 
296 enum client_action {
297 	CLIENT_CONNECT,
298 	CLIENT_DISCONNECT,
299 };
300 
301 struct socket_conf {
302 	struct address	 addr;
303 
304 	char		 name[GOTWEBD_MAXTEXT];
305 	char		 srv_name[GOTWEBD_MAXTEXT];
306 
307 	int		 id;
308 	int		 af_type;
309 	char		 unix_socket_name[PATH_MAX];
310 	in_port_t	 fcgi_socket_port;
311 };
312 
313 struct socket {
314 	TAILQ_ENTRY(socket)	 entry;
315 	struct socket_conf	 conf;
316 
317 	int		 fd;
318 	int		 pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
319 	int		 priv_fd[PRIV_FDS__MAX];
320 
321 	struct event	 evt;
322 	struct event	 ev;
323 	struct event	 pause;
324 
325 	int		 client_status;
326 };
327 TAILQ_HEAD(socketlist, socket);
328 
329 struct gotwebd {
330 	struct serverlist	servers;
331 	struct socketlist	sockets;
332 
333 	struct privsep	*gotwebd_ps;
334 	const char	*gotwebd_conffile;
335 
336 	int		 gotwebd_debug;
337 	int		 gotwebd_verbose;
338 	int		 gotwebd_noaction;
339 
340 	uint16_t	 prefork_gotwebd;
341 	int		 gotwebd_reload;
342 
343 	int		 server_cnt;
344 
345 	char		 httpd_chroot[PATH_MAX];
346 
347 	int		 unix_socket;
348 	char		 unix_socket_name[PATH_MAX];
349 };
350 
351 /*
352  * URL parameter for gotweb_link.  NULL values and int set to -1 are
353  * implicitly ignored, and string are properly escaped.
354  */
355 struct gotweb_url {
356 	int		 action;
357 	int		 index_page;
358 	int		 page;
359 	const char	*commit;
360 	const char	*previd;
361 	const char	*prevset;
362 	const char	*file;
363 	const char	*folder;
364 	const char	*headref;
365 	const char	*path;
366 };
367 
368 struct querystring {
369 	uint8_t		 action;
370 	char		*commit;
371 	char		*previd;
372 	char		*prevset;
373 	char		*file;
374 	char		*folder;
375 	char		*headref;
376 	int		 index_page;
377 	char		*path;
378 	int		 page;
379 };
380 
381 struct querystring_keys {
382 	const char	*name;
383 	int		 element;
384 };
385 
386 struct action_keys {
387 	const char	*name;
388 	int		 action;
389 };
390 
391 enum querystring_elements {
392 	ACTION,
393 	COMMIT,
394 	RFILE,
395 	FOLDER,
396 	HEADREF,
397 	INDEX_PAGE,
398 	PATH,
399 	PAGE,
400 	PREVID,
401 	QSELEM__MAX,
402 };
403 
404 enum query_actions {
405 	BLAME,
406 	BLOB,
407 	BRIEFS,
408 	COMMITS,
409 	DIFF,
410 	ERR,
411 	INDEX,
412 	SUMMARY,
413 	TAG,
414 	TAGS,
415 	TREE,
416 	RSS,
417 	ACTIONS__MAX,
418 };
419 
420 enum gotweb_ref_tm {
421 	TM_DIFF,
422 	TM_LONG,
423 	TM_RFC822,
424 };
425 
426 extern struct gotwebd	*gotwebd_env;
427 
428 /* sockets.c */
429 void sockets(struct privsep *, struct privsep_proc *);
430 void sockets_shutdown(void);
431 void sockets_parse_sockets(struct gotwebd *);
432 void sockets_socket_accept(int, short, void *);
433 int sockets_privinit(struct gotwebd *, struct socket *);
434 
435 /* gotweb.c */
436 const struct got_error *gotweb_render_content_type(struct request *,
437     const uint8_t *);
438 const struct got_error
439     *gotweb_render_content_type_file(struct request *, const uint8_t *, char *);
440 void gotweb_get_navs(struct request *, struct gotweb_url *, int *,
441     struct gotweb_url *, int *);
442 const struct got_error *gotweb_get_time_str(char **, time_t, int);
443 const struct got_error *gotweb_init_transport(struct transport **);
444 const struct got_error *gotweb_escape_html(char **, const char *);
445 const char *gotweb_action_name(int);
446 int gotweb_render_url(struct request *, struct gotweb_url *);
447 int gotweb_render_absolute_url(struct request *, struct gotweb_url *);
448 int gotweb_link(struct request *, struct gotweb_url *, const char *, ...)
449 	__attribute__((__format__(printf, 3, 4)))
450 	__attribute__((__nonnull__(3)));
451 void gotweb_free_repo_commit(struct repo_commit *);
452 void gotweb_free_repo_tag(struct repo_tag *);
453 void gotweb_process_request(struct request *);
454 void gotweb_free_transport(struct transport *);
455 
456 /* pages.tmpl */
457 int	gotweb_render_header(struct template *);
458 int	gotweb_render_footer(struct template *);
459 int	gotweb_render_repo_table_hdr(struct template *);
460 int	gotweb_render_repo_fragment(struct template *, struct repo_dir *);
461 int	gotweb_render_briefs(struct template *);
462 int	gotweb_render_navs(struct template *);
463 int	gotweb_render_commits(struct template *);
464 int	gotweb_render_rss(struct template *);
465 
466 /* parse.y */
467 int parse_config(const char *, struct gotwebd *);
468 int cmdline_symset(char *);
469 
470 /* fcgi.c */
471 void fcgi_request(int, short, void *);
472 void fcgi_timeout(int, short, void *);
473 void fcgi_cleanup_request(struct request *);
474 void fcgi_create_end_record(struct request *);
475 void dump_fcgi_record(const char *, struct fcgi_record_header *);
476 int fcgi_puts(struct template *, const char *);
477 int fcgi_putc(struct template *, int);
478 int fcgi_vprintf(struct request *, const char *, va_list);
479 int fcgi_printf(struct request *, const char *, ...)
480 	__attribute__((__format__(printf, 2, 3)))
481 	__attribute__((__nonnull__(2)));
482 int fcgi_gen_binary_response(struct request *, const uint8_t *, int);
483 
484 /* got_operations.c */
485 const struct got_error *got_get_repo_owner(char **, struct request *);
486 const struct got_error *got_get_repo_age(char **, struct request *,
487     const char *, int);
488 const struct got_error *got_get_repo_commits(struct request *, int);
489 const struct got_error *got_get_repo_tags(struct request *, int);
490 const struct got_error *got_get_repo_heads(struct request *);
491 const struct got_error *got_output_repo_diff(struct request *);
492 const struct got_error *got_output_repo_tree(struct request *);
493 const struct got_error *got_output_file_blob(struct request *);
494 const struct got_error *got_output_file_blame(struct request *);
495 
496 /* config.c */
497 int config_setserver(struct gotwebd *, struct server *);
498 int config_getserver(struct gotwebd *, struct imsg *);
499 int config_setsock(struct gotwebd *, struct socket *);
500 int config_getsock(struct gotwebd *, struct imsg *);
501 int config_setfd(struct gotwebd *, struct socket *);
502 int config_getfd(struct gotwebd *, struct imsg *);
503 int config_getcfg(struct gotwebd *, struct imsg *);
504 int config_init(struct gotwebd *);