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 * 2)
117 
118 /* Forward declaration */
119 struct got_blob_object;
120 struct got_tree_entry;
121 struct got_reflist_head;
122 
123 enum imsg_type {
124 	IMSG_CFG_SRV = IMSG_PROC_MAX,
125 	IMSG_CFG_SOCK,
126 	IMSG_CFG_FD,
127 	IMSG_CFG_DONE,
128 	IMSG_CTL_START,
129 };
130 
131 struct env_val {
132 	SLIST_ENTRY(env_val)	 entry;
133 	char			*val;
134 };
135 SLIST_HEAD(env_head, env_val);
136 
137 struct fcgi_record_header {
138 	uint8_t		version;
139 	uint8_t		type;
140 	uint16_t	id;
141 	uint16_t	content_len;
142 	uint8_t		padding_len;
143 	uint8_t		reserved;
144 }__attribute__((__packed__));
145 
146 struct blame_line {
147 	int		 annotated;
148 	char		*id_str;
149 	char		*committer;
150 	char		 datebuf[11]; /* YYYY-MM-DD + NUL */
151 };
152 
153 struct repo_dir {
154 	char			*name;
155 	char			*owner;
156 	char			*description;
157 	char			*url;
158 	time_t			 age;
159 	char			*path;
160 };
161 
162 struct repo_tag {
163 	TAILQ_ENTRY(repo_tag)	 entry;
164 	char			*commit_id;
165 	char			*tag_name;
166 	char			*tag_commit;
167 	char			*commit_msg;
168 	char			*tagger;
169 	time_t			 tagger_time;
170 };
171 
172 struct repo_commit {
173 	TAILQ_ENTRY(repo_commit)	 entry;
174 	char			*path;
175 	char			*refs_str;
176 	char			*commit_id; /* id_str1 */
177 	char			*parent_id; /* id_str2 */
178 	char			*tree_id;
179 	char			*author;
180 	char			*committer;
181 	char			*commit_msg;
182 	time_t			 committer_time;
183 };
184 
185 struct got_repository;
186 struct transport {
187 	TAILQ_HEAD(repo_commits_head, repo_commit)	 repo_commits;
188 	TAILQ_HEAD(repo_tags_head, repo_tag)		 repo_tags;
189 	struct got_reflist_head	 refs;
190 	struct got_repository	*repo;
191 	struct repo_dir		*repo_dir;
192 	struct querystring	*qs;
193 	char			*more_id;
194 	char			*next_id;
195 	char			*prev_id;
196 	unsigned int		 repos_total;
197 	unsigned int		 next_disp;
198 	unsigned int		 prev_disp;
199 	unsigned int		 tag_count;
200 	const struct got_error	*error;
201 	struct got_blob_object	*blob;
202 	int			 fd;
203 	FILE			*fp;
204 	struct dirent		**repos;
205 	int			 nrepos;
206 };
207 
208 enum socket_priv_fds {
209 	DIFF_FD_1,
210 	DIFF_FD_2,
211 	DIFF_FD_3,
212 	DIFF_FD_4,
213 	DIFF_FD_5,
214 	BLAME_FD_1,
215 	BLAME_FD_2,
216 	BLAME_FD_3,
217 	BLAME_FD_4,
218 	BLAME_FD_5,
219 	BLAME_FD_6,
220 	BLOB_FD_1,
221 	BLOB_FD_2,
222 	PRIV_FDS__MAX,
223 };
224 
225 struct template;
226 struct request {
227 	struct socket			*sock;
228 	struct server			*srv;
229 	struct transport		*t;
230 	struct template			*tp;
231 	struct event			 ev;
232 	struct event			 tmo;
233 
234 	uint16_t			 id;
235 	int				 fd;
236 	int				 priv_fd[PRIV_FDS__MAX];
237 
238 	uint8_t				 buf[FCGI_RECORD_SIZE];
239 	size_t				 buf_pos;
240 	size_t				 buf_len;
241 
242 	uint8_t				 outbuf[GOTWEBD_CACHESIZE];
243 	size_t				 outbuf_len;
244 
245 	char				 querystring[MAX_QUERYSTRING];
246 	char				 document_uri[MAX_DOCUMENT_URI];
247 	char				 server_name[MAX_SERVER_NAME];
248 	int				 https;
249 
250 	uint8_t				 request_started;
251 };
252 
253 struct fcgi_begin_request_body {
254 	uint16_t	role;
255 	uint8_t		flags;
256 	uint8_t		reserved[5];
257 }__attribute__((__packed__));
258 
259 struct fcgi_end_request_body {
260 	uint32_t	app_status;
261 	uint8_t		protocol_status;
262 	uint8_t		reserved[3];
263 }__attribute__((__packed__));
264 
265 struct address {
266 	TAILQ_ENTRY(address)	 entry;
267 	struct sockaddr_storage	 ss;
268 	int			 ipproto;
269 	in_port_t		 port;
270 	char			 ifname[IFNAMSIZ];
271 };
272 TAILQ_HEAD(addresslist, address);
273 
274 struct cached_repo {
275 	char path[PATH_MAX];
276 	struct got_repository *repo;
277 };
278 
279 struct server {
280 	TAILQ_ENTRY(server)	 entry;
281 	struct addresslist	al;
282 
283 	struct cached_repo	*cached_repos;
284 	int		 ncached_repos;
285 
286 	char		 name[GOTWEBD_MAXTEXT];
287 
288 	char		 repos_path[PATH_MAX];
289 	char		 site_name[GOTWEBD_MAXNAME];
290 	char		 site_owner[GOTWEBD_MAXNAME];
291 	char		 site_link[GOTWEBD_MAXTEXT];
292 	char		 logo[GOTWEBD_MAXTEXT];
293 	char		 logo_url[GOTWEBD_MAXTEXT];
294 	char		 custom_css[PATH_MAX];
295 
296 	size_t		 max_repos;
297 	size_t		 max_repos_display;
298 	size_t		 max_commits_display;
299 
300 	int		 show_site_owner;
301 	int		 show_repo_owner;
302 	int		 show_repo_age;
303 	int		 show_repo_description;
304 	int		 show_repo_cloneurl;
305 	int		 respect_exportok;
306 
307 	int		 unix_socket;
308 	char		 unix_socket_name[PATH_MAX];
309 
310 	int		 fcgi_socket;
311 };
312 TAILQ_HEAD(serverlist, server);
313 
314 enum client_action {
315 	CLIENT_CONNECT,
316 	CLIENT_DISCONNECT,
317 };
318 
319 struct socket_conf {
320 	struct address	 addr;
321 
322 	char		 name[GOTWEBD_MAXTEXT];
323 	char		 srv_name[GOTWEBD_MAXTEXT];
324 
325 	int		 id;
326 	int		 af_type;
327 	char		 unix_socket_name[PATH_MAX];
328 	in_port_t	 fcgi_socket_port;
329 };
330 
331 struct socket {
332 	TAILQ_ENTRY(socket)	 entry;
333 	struct socket_conf	 conf;
334 
335 	int		 fd;
336 	int		 pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
337 	int		 priv_fd[PRIV_FDS__MAX];
338 
339 	struct event	 evt;
340 	struct event	 ev;
341 	struct event	 pause;
342 
343 	int		 client_status;
344 };
345 TAILQ_HEAD(socketlist, socket);
346 
347 struct gotwebd {
348 	struct serverlist	servers;
349 	struct socketlist	sockets;
350 
351 	struct privsep	*gotwebd_ps;
352 	const char	*gotwebd_conffile;
353 
354 	int		 gotwebd_debug;
355 	int		 gotwebd_verbose;
356 	int		 gotwebd_noaction;
357 
358 	uint16_t	 prefork_gotwebd;
359 	int		 gotwebd_reload;
360 
361 	int		 server_cnt;
362 
363 	char		 httpd_chroot[PATH_MAX];
364 
365 	int		 unix_socket;
366 	char		 unix_socket_name[PATH_MAX];
367 };
368 
369 /*
370  * URL parameter for gotweb_render_url.  NULL values and int set to -1
371  * are implicitly ignored, and string are properly escaped.
372  */
373 struct gotweb_url {
374 	int		 action;
375 	int		 index_page;
376 	int		 page;
377 	const char	*commit;
378 	const char	*previd;
379 	const char	*prevset;
380 	const char	*file;
381 	const char	*folder;
382 	const char	*headref;
383 	const char	*path;
384 };
385 
386 struct querystring {
387 	uint8_t		 action;
388 	char		*commit;
389 	char		*previd;
390 	char		*prevset;
391 	char		*file;
392 	char		*folder;
393 	char		*headref;
394 	int		 index_page;
395 	char		*path;
396 	int		 page;
397 };
398 
399 struct querystring_keys {
400 	const char	*name;
401 	int		 element;
402 };
403 
404 struct action_keys {
405 	const char	*name;
406 	int		 action;
407 };
408 
409 enum querystring_elements {
410 	ACTION,
411 	COMMIT,
412 	RFILE,
413 	FOLDER,
414 	HEADREF,
415 	INDEX_PAGE,
416 	PATH,
417 	PAGE,
418 	PREVID,
419 	QSELEM__MAX,
420 };
421 
422 enum query_actions {
423 	BLAME,
424 	BLOB,
425 	BLOBRAW,
426 	BRIEFS,
427 	COMMITS,
428 	DIFF,
429 	ERR,
430 	INDEX,
431 	SUMMARY,
432 	TAG,
433 	TAGS,
434 	TREE,
435 	RSS,
436 	ACTIONS__MAX,
437 };
438 
439 enum gotweb_ref_tm {
440 	TM_DIFF,
441 	TM_LONG,
442 	TM_RFC822,
443 };
444 
445 extern struct gotwebd	*gotwebd_env;
446 
447 typedef int (*got_render_blame_line_cb)(struct template *, const char *,
448     struct blame_line *, int, int);
449 
450 /* sockets.c */
451 void sockets(struct privsep *, struct privsep_proc *);
452 void sockets_shutdown(void);
453 void sockets_parse_sockets(struct gotwebd *);
454 void sockets_socket_accept(int, short, void *);
455 int sockets_privinit(struct gotwebd *, struct socket *);
456 
457 /* gotweb.c */
458 void gotweb_get_navs(struct request *, struct gotweb_url *, int *,
459     struct gotweb_url *, int *);
460 int gotweb_render_age(struct template *, time_t, int);
461 const struct got_error *gotweb_init_transport(struct transport **);
462 const char *gotweb_action_name(int);
463 int gotweb_render_url(struct request *, struct gotweb_url *);
464 int gotweb_render_absolute_url(struct request *, struct gotweb_url *);
465 void gotweb_free_repo_commit(struct repo_commit *);
466 void gotweb_free_repo_tag(struct repo_tag *);
467 void gotweb_process_request(struct request *);
468 void gotweb_free_transport(struct transport *);
469 
470 /* pages.tmpl */
471 int	gotweb_render_page(struct template *, int (*)(struct template *));
472 int	gotweb_render_error(struct template *);
473 int	gotweb_render_repo_table_hdr(struct template *);
474 int	gotweb_render_repo_fragment(struct template *, struct repo_dir *);
475 int	gotweb_render_briefs(struct template *);
476 int	gotweb_render_navs(struct template *);
477 int	gotweb_render_commits(struct template *);
478 int	gotweb_render_blob(struct template *);
479 int	gotweb_render_tree(struct template *);
480 int	gotweb_render_tags(struct template *);
481 int	gotweb_render_tag(struct template *);
482 int	gotweb_render_diff(struct template *);
483 int	gotweb_render_branches(struct template *, struct got_reflist_head *);
484 int	gotweb_render_summary(struct template *);
485 int	gotweb_render_blame(struct template *);
486 int	gotweb_render_rss(struct template *);
487 
488 /* parse.y */
489 int parse_config(const char *, struct gotwebd *);
490 int cmdline_symset(char *);
491 
492 /* fcgi.c */
493 void fcgi_request(int, short, void *);
494 void fcgi_timeout(int, short, void *);
495 void fcgi_cleanup_request(struct request *);
496 void fcgi_create_end_record(struct request *);
497 void dump_fcgi_record(const char *, struct fcgi_record_header *);
498 int fcgi_puts(struct template *, const char *);
499 int fcgi_putc(struct template *, int);
500 int fcgi_vprintf(struct request *, const char *, va_list);
501 int fcgi_printf(struct request *, const char *, ...)
502 	__attribute__((__format__(printf, 2, 3)))
503 	__attribute__((__nonnull__(2)));
504 int fcgi_gen_binary_response(struct request *, const uint8_t *, int);
505 
506 /* got_operations.c */
507 const struct got_error *got_gotweb_closefile(FILE *);
508 const struct got_error *got_get_repo_owner(char **, struct request *);
509 const struct got_error *got_get_repo_age(time_t *, struct request *,
510     const char *);
511 const struct got_error *got_get_repo_commits(struct request *, size_t);
512 const struct got_error *got_get_repo_tags(struct request *, size_t);
513 const struct got_error *got_get_repo_heads(struct request *);
514 const struct got_error *got_open_diff_for_output(FILE **, struct request *);
515 int got_output_repo_tree(struct request *,
516     int (*)(struct template *, struct got_tree_entry *));
517 const struct got_error *got_open_blob_for_output(struct got_blob_object **,
518     int *, int *, struct request *);
519 int got_output_blob_by_lines(struct template *, struct got_blob_object *,
520     int (*)(struct template *, const char *, size_t));
521 const struct got_error *got_output_file_blame(struct request *,
522     got_render_blame_line_cb);
523 
524 /* config.c */
525 int config_setserver(struct gotwebd *, struct server *);
526 int config_getserver(struct gotwebd *, struct imsg *);
527 int config_setsock(struct gotwebd *, struct socket *);
528 int config_getsock(struct gotwebd *, struct imsg *);
529 int config_setfd(struct gotwebd *, struct socket *);
530 int config_getfd(struct gotwebd *, struct imsg *);
531 int config_getcfg(struct gotwebd *, struct imsg *);
532 int config_init(struct gotwebd *);