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