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>
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.
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.
20 #include <netinet/in.h>
22 #include <sys/queue.h>
28 #define dprintf(x...) do { log_debug(x); } while(0)
34 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
37 /* GOTWEBD DEFAULTS */
38 #define GOTWEBD_CONF "/etc/gotwebd.conf"
40 #define GOTWEBD_USER "www"
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
54 #define MAX_QUERYSTRING 2048
55 #define MAX_DOCUMENT_URI 255
56 #define MAX_SERVER_NAME 255
58 #define GOTWEB_GIT_DIR ".git"
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"
71 #define D_SHOWROWNER 1
72 #define D_SHOWSOWNER 1
76 #define D_RESPECTEXPORTOK 0
78 #define D_MAXREPODISP 25
79 #define D_MAXSLCOMMDISP 10
80 #define D_MAXCOMMITDISP 25
84 #define TIMEOUT_DEFAULT 120
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)
91 #define FCGI_ALIGNMENT 8
92 #define FCGI_ALIGN(n) \
93 (((n) + (FCGI_ALIGNMENT - 1)) & ~(FCGI_ALIGNMENT - 1))
98 #define FCGI_BEGIN_REQUEST 1
99 #define FCGI_ABORT_REQUEST 2
100 #define FCGI_END_REQUEST 3
101 #define FCGI_PARAMS 4
103 #define FCGI_STDOUT 6
104 #define FCGI_STDERR 7
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)
111 #define FCGI_REQUEST_COMPLETE 0
112 #define FCGI_CANT_MPX_CONN 1
113 #define FCGI_OVERLOADED 2
114 #define FCGI_UNKNOWN_ROLE 3
116 #define GOTWEB_PACK_NUM_TEMPFILES (32 * 2)
118 /* Forward declaration */
119 struct got_blob_object;
120 struct got_tree_entry;
121 struct got_reflist_head;
124 IMSG_CFG_SRV = IMSG_PROC_MAX,
132 SLIST_ENTRY(env_val) entry;
135 SLIST_HEAD(env_head, env_val);
137 struct fcgi_record_header {
141 uint16_t content_len;
144 }__attribute__((__packed__));
150 char datebuf[11]; /* YYYY-MM-DD + NUL */
163 TAILQ_ENTRY(repo_tag) entry;
173 TAILQ_ENTRY(repo_commit) entry;
176 char *commit_id; /* id_str1 */
177 char *parent_id; /* id_str2 */
182 time_t committer_time;
185 struct got_repository;
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;
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;
204 struct dirent **repos;
208 enum socket_priv_fds {
236 int priv_fd[PRIV_FDS__MAX];
238 uint8_t buf[FCGI_RECORD_SIZE];
242 uint8_t outbuf[GOTWEBD_CACHESIZE];
245 char querystring[MAX_QUERYSTRING];
246 char document_uri[MAX_DOCUMENT_URI];
247 char server_name[MAX_SERVER_NAME];
250 uint8_t request_started;
253 struct fcgi_begin_request_body {
257 }__attribute__((__packed__));
259 struct fcgi_end_request_body {
261 uint8_t protocol_status;
263 }__attribute__((__packed__));
266 TAILQ_ENTRY(address) entry;
267 struct sockaddr_storage ss;
270 char ifname[IFNAMSIZ];
272 TAILQ_HEAD(addresslist, address);
276 struct got_repository *repo;
280 TAILQ_ENTRY(server) entry;
281 struct addresslist al;
283 struct cached_repo *cached_repos;
286 char name[GOTWEBD_MAXTEXT];
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];
297 size_t max_repos_display;
298 size_t max_commits_display;
303 int show_repo_description;
304 int show_repo_cloneurl;
305 int respect_exportok;
308 char unix_socket_name[PATH_MAX];
312 TAILQ_HEAD(serverlist, server);
322 char name[GOTWEBD_MAXTEXT];
323 char srv_name[GOTWEBD_MAXTEXT];
327 char unix_socket_name[PATH_MAX];
328 in_port_t fcgi_socket_port;
332 TAILQ_ENTRY(socket) entry;
333 struct socket_conf conf;
336 int pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
337 int priv_fd[PRIV_FDS__MAX];
345 TAILQ_HEAD(socketlist, socket);
348 struct serverlist servers;
349 struct socketlist sockets;
351 struct privsep *gotwebd_ps;
352 const char *gotwebd_conffile;
356 int gotwebd_noaction;
358 uint16_t prefork_gotwebd;
363 char httpd_chroot[PATH_MAX];
366 char unix_socket_name[PATH_MAX];
370 * URL parameter for gotweb_render_url. NULL values and int set to -1
371 * are implicitly ignored, and string are properly escaped.
399 struct querystring_keys {
409 enum querystring_elements {
445 extern struct gotwebd *gotwebd_env;
447 typedef int (*got_render_blame_line_cb)(struct template *, const char *,
448 struct blame_line *, int, int);
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 *);
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 *);
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 *);
489 int parse_config(const char *, struct gotwebd *);
490 int cmdline_symset(char *);
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);
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 *,
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);
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 *);