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>
30 #define dprintf(x...) do { log_debug(x); } while(0)
36 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
39 /* GOTWEBD DEFAULTS */
40 #define GOTWEBD_CONF "/etc/gotwebd.conf"
42 #define GOTWEBD_USER "www"
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
56 #define MAX_QUERYSTRING 2048
57 #define MAX_DOCUMENT_URI 255
58 #define MAX_SERVER_NAME 255
60 #define GOTWEB_GIT_DIR ".git"
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"
73 #define D_SHOWROWNER 1
74 #define D_SHOWSOWNER 1
78 #define D_RESPECTEXPORTOK 0
80 #define D_MAXREPODISP 25
81 #define D_MAXSLCOMMDISP 10
82 #define D_MAXCOMMITDISP 25
86 #define TIMEOUT_DEFAULT 120
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)
93 #define FCGI_ALIGNMENT 8
94 #define FCGI_ALIGN(n) \
95 (((n) + (FCGI_ALIGNMENT - 1)) & ~(FCGI_ALIGNMENT - 1))
100 #define FCGI_BEGIN_REQUEST 1
101 #define FCGI_ABORT_REQUEST 2
102 #define FCGI_END_REQUEST 3
103 #define FCGI_PARAMS 4
105 #define FCGI_STDOUT 6
106 #define FCGI_STDERR 7
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)
113 #define FCGI_REQUEST_COMPLETE 0
114 #define FCGI_CANT_MPX_CONN 1
115 #define FCGI_OVERLOADED 2
116 #define FCGI_UNKNOWN_ROLE 3
118 #define GOTWEB_PACK_NUM_TEMPFILES 32
121 IMSG_CFG_SRV = IMSG_PROC_MAX,
129 SLIST_ENTRY(env_val) entry;
132 SLIST_HEAD(env_head, env_val);
134 struct fcgi_record_header {
138 uint16_t content_len;
141 }__attribute__((__packed__));
153 TAILQ_ENTRY(repo_tag) entry;
163 TAILQ_ENTRY(repo_commit) entry;
166 char *commit_id; /* id_str1 */
167 char *parent_id; /* id_str2 */
172 time_t committer_time;
175 struct got_repository;
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;
184 unsigned int repos_total;
185 unsigned int next_disp;
186 unsigned int prev_disp;
187 unsigned int tag_count;
190 enum socket_priv_fds {
218 int priv_fd[PRIV_FDS__MAX];
220 uint8_t buf[FCGI_RECORD_SIZE];
224 uint8_t outbuf[GOTWEBD_CACHESIZE];
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];
233 uint8_t request_started;
236 struct fcgi_begin_request_body {
240 }__attribute__((__packed__));
242 struct fcgi_end_request_body {
244 uint8_t protocol_status;
246 }__attribute__((__packed__));
249 TAILQ_ENTRY(address) entry;
250 struct sockaddr_storage ss;
254 char ifname[IFNAMSIZ];
256 TAILQ_HEAD(addresslist, address);
260 struct got_repository *repo;
264 TAILQ_ENTRY(server) entry;
265 struct addresslist al;
267 struct cached_repo *cached_repos;
270 char name[GOTWEBD_MAXTEXT];
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];
281 size_t max_repos_display;
282 size_t max_commits_display;
287 int show_repo_description;
288 int show_repo_cloneurl;
289 int respect_exportok;
292 char unix_socket_name[PATH_MAX];
296 TAILQ_HEAD(serverlist, server);
306 char name[GOTWEBD_MAXTEXT];
307 char srv_name[GOTWEBD_MAXTEXT];
311 char unix_socket_name[PATH_MAX];
312 in_port_t fcgi_socket_port;
316 TAILQ_ENTRY(socket) entry;
317 struct socket_conf conf;
320 int pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
321 int priv_fd[PRIV_FDS__MAX];
329 TAILQ_HEAD(socketlist, socket);
332 struct serverlist servers;
333 struct socketlist sockets;
335 struct privsep *gotwebd_ps;
336 const char *gotwebd_conffile;
340 int gotwebd_noaction;
342 uint16_t prefork_gotwebd;
347 char httpd_chroot[PATH_MAX];
350 char unix_socket_name[PATH_MAX];
354 * URL parameter for gotweb_link. NULL values and int set to -1 are
355 * implicitly ignored, and string are properly escaped.
383 struct querystring_keys {
393 enum querystring_elements {
428 extern struct gotwebd *gotwebd_env;
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 *);
438 const struct got_error *gotweb_render_content_type(struct request *,
440 const struct got_error
441 *gotweb_render_content_type_file(struct request *, const uint8_t *, char *);
442 void gotweb_get_navs(struct request *, struct gotweb_url *, int *,
443 struct gotweb_url *, int *);
444 const struct got_error *gotweb_get_time_str(char **, time_t, int);
445 const struct got_error *gotweb_init_transport(struct transport **);
446 const struct got_error *gotweb_escape_html(char **, const char *);
447 const char *gotweb_action_name(int);
448 int gotweb_render_url(struct request *, struct gotweb_url *);
449 int gotweb_render_absolute_url(struct request *, struct gotweb_url *);
450 int gotweb_link(struct request *, struct gotweb_url *, const char *, ...)
451 __attribute__((__format__(printf, 3, 4)))
452 __attribute__((__nonnull__(3)));
453 void gotweb_free_repo_commit(struct repo_commit *);
454 void gotweb_free_repo_tag(struct repo_tag *);
455 void gotweb_process_request(struct request *);
456 void gotweb_free_transport(struct transport *);
459 int gotweb_render_header(struct template *);
460 int gotweb_render_footer(struct template *);
461 int gotweb_render_repo_table_hdr(struct template *);
462 int gotweb_render_repo_fragment(struct template *, struct repo_dir *);
463 int gotweb_render_briefs(struct template *);
464 int gotweb_render_navs(struct template *);
465 int gotweb_render_commits(struct template *);
466 int gotweb_render_rss(struct template *);
469 int parse_config(const char *, struct gotwebd *);
470 int cmdline_symset(char *);
473 void fcgi_request(int, short, void *);
474 void fcgi_timeout(int, short, void *);
475 void fcgi_cleanup_request(struct request *);
476 void fcgi_create_end_record(struct request *);
477 void dump_fcgi_record(const char *, struct fcgi_record_header *);
478 int fcgi_puts(struct template *, const char *);
479 int fcgi_putc(struct template *, int);
480 int fcgi_vprintf(struct request *, const char *, va_list);
481 int fcgi_printf(struct request *, const char *, ...)
482 __attribute__((__format__(printf, 2, 3)))
483 __attribute__((__nonnull__(2)));
484 int fcgi_gen_binary_response(struct request *, const uint8_t *, int);
486 /* got_operations.c */
487 const struct got_error *got_get_repo_owner(char **, struct request *);
488 const struct got_error *got_get_repo_age(char **, struct request *,
490 const struct got_error *got_get_repo_commits(struct request *, int);
491 const struct got_error *got_get_repo_tags(struct request *, int);
492 const struct got_error *got_get_repo_heads(struct request *);
493 const struct got_error *got_output_repo_diff(struct request *);
494 const struct got_error *got_output_repo_tree(struct request *);
495 const struct got_error *got_output_file_blob(struct request *);
496 const struct got_error *got_output_file_blame(struct request *);
499 int config_setserver(struct gotwebd *, struct server *);
500 int config_getserver(struct gotwebd *, struct imsg *);
501 int config_setsock(struct gotwebd *, struct socket *);
502 int config_getsock(struct gotwebd *, struct imsg *);
503 int config_setfd(struct gotwebd *, struct socket *);
504 int config_getfd(struct gotwebd *, struct imsg *);
505 int config_getcfg(struct gotwebd *, struct imsg *);
506 int config_init(struct gotwebd *);