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