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