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