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_CACHESIZE 1024
43 #define GOTWEBD_MAXCLIENTS 1024
44 #define GOTWEBD_MAXTEXT 511
45 #define GOTWEBD_MAXNAME 64
46 #define GOTWEBD_MAXPORT 6
47 #define GOTWEBD_NUMPROC 3
48 #define GOTWEBD_MAXIFACE 16
49 #define GOTWEBD_REPO_CACHESIZE 4
52 #define MAX_QUERYSTRING 2048
53 #define MAX_SCRIPT_NAME 255
54 #define MAX_SERVER_NAME 255
56 #define GOTWEB_GIT_DIR ".git"
58 #define D_HTTPD_CHROOT "/var/www"
59 #define D_UNIX_SOCKET "/run/gotweb.sock"
60 #define D_FCGI_PORT "9000"
61 #define D_GOTPATH "/got/public"
62 #define D_SITENAME "Gotweb"
63 #define D_SITEOWNER "Got Owner"
64 #define D_SITELINK "Repos"
65 #define D_GOTLOGO "got.png"
66 #define D_GOTURL "https://gameoftrees.org"
67 #define D_GOTWEBCSS "gotweb.css"
69 #define D_SHOWROWNER 1
70 #define D_SHOWSOWNER 1
75 #define D_MAXREPODISP 25
76 #define D_MAXSLCOMMDISP 10
77 #define D_MAXCOMMITDISP 25
81 #define TIMEOUT_DEFAULT 120
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)
88 #define FCGI_ALIGNMENT 8
89 #define FCGI_ALIGN(n) \
90 (((n) + (FCGI_ALIGNMENT - 1)) & ~(FCGI_ALIGNMENT - 1))
95 #define FCGI_BEGIN_REQUEST 1
96 #define FCGI_ABORT_REQUEST 2
97 #define FCGI_END_REQUEST 3
100 #define FCGI_STDOUT 6
101 #define FCGI_STDERR 7
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)
108 #define FCGI_REQUEST_COMPLETE 0
109 #define FCGI_CANT_MPX_CONN 1
110 #define FCGI_OVERLOADED 2
111 #define FCGI_UNKNOWN_ROLE 3
113 #define GOTWEB_PACK_NUM_TEMPFILES 32
116 IMSG_CFG_SRV = IMSG_PROC_MAX,
124 SLIST_ENTRY(env_val) entry;
127 SLIST_HEAD(env_head, env_val);
129 struct fcgi_record_header {
133 uint16_t content_len;
136 }__attribute__((__packed__));
148 TAILQ_ENTRY(repo_tag) entry;
158 TAILQ_ENTRY(repo_commit) entry;
161 char *commit_id; /* id_str1 */
162 char *parent_id; /* id_str2 */
167 time_t committer_time;
170 struct got_repository;
172 TAILQ_HEAD(repo_commits_head, repo_commit) repo_commits;
173 TAILQ_HEAD(repo_tags_head, repo_tag) repo_tags;
174 struct got_repository *repo;
175 struct repo_dir *repo_dir;
176 struct querystring *qs;
179 unsigned int repos_total;
180 unsigned int next_disp;
181 unsigned int prev_disp;
182 unsigned int tag_count;
185 enum socket_priv_fds {
211 int priv_fd[PRIV_FDS__MAX];
213 uint8_t buf[FCGI_RECORD_SIZE];
217 uint8_t outbuf[GOTWEBD_CACHESIZE];
220 char querystring[MAX_QUERYSTRING];
221 char http_host[GOTWEBD_MAXTEXT];
222 char script_name[MAX_SCRIPT_NAME];
223 char server_name[MAX_SERVER_NAME];
225 uint8_t request_started;
228 struct fcgi_begin_request_body {
232 }__attribute__((__packed__));
234 struct fcgi_end_request_body {
236 uint8_t protocol_status;
238 }__attribute__((__packed__));
241 TAILQ_ENTRY(address) entry;
242 struct sockaddr_storage ss;
246 char ifname[IFNAMSIZ];
248 TAILQ_HEAD(addresslist, address);
252 struct got_repository *repo;
256 TAILQ_ENTRY(server) entry;
257 struct addresslist al;
259 struct cached_repo *cached_repos;
262 char name[GOTWEBD_MAXTEXT];
264 char repos_path[PATH_MAX];
265 char site_name[GOTWEBD_MAXNAME];
266 char site_owner[GOTWEBD_MAXNAME];
267 char site_link[GOTWEBD_MAXTEXT];
268 char logo[GOTWEBD_MAXTEXT];
269 char logo_url[GOTWEBD_MAXTEXT];
270 char custom_css[PATH_MAX];
273 size_t max_repos_display;
274 size_t max_commits_display;
279 int show_repo_description;
280 int show_repo_cloneurl;
283 char unix_socket_name[PATH_MAX];
287 TAILQ_HEAD(serverlist, server);
297 char name[GOTWEBD_MAXTEXT];
298 char srv_name[GOTWEBD_MAXTEXT];
302 char unix_socket_name[PATH_MAX];
303 in_port_t fcgi_socket_port;
307 TAILQ_ENTRY(socket) entry;
308 struct socket_conf conf;
311 int pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
312 int priv_fd[PRIV_FDS__MAX];
320 TAILQ_HEAD(socketlist, socket);
323 struct serverlist servers;
324 struct socketlist sockets;
326 struct privsep *gotwebd_ps;
327 const char *gotwebd_conffile;
331 int gotwebd_noaction;
333 uint16_t prefork_gotwebd;
338 char httpd_chroot[PATH_MAX];
341 char unix_socket_name[PATH_MAX];
345 * URL parameter for gotweb_link. NULL values and int set to -1 are
346 * implicitly ignored, and string are properly escaped.
370 char *index_page_str;
376 struct querystring_keys {
386 enum querystring_elements {
414 extern struct gotwebd *gotwebd_env;
417 void sockets(struct privsep *, struct privsep_proc *);
418 void sockets_shutdown(void);
419 void sockets_parse_sockets(struct gotwebd *);
420 void sockets_socket_accept(int, short, void *);
421 int sockets_privinit(struct gotwebd *, struct socket *);
424 const struct got_error *gotweb_render_content_type(struct request *,
426 const struct got_error
427 *gotweb_render_content_type_file(struct request *, const uint8_t *, char *);
428 const struct got_error *gotweb_get_time_str(char **, time_t, int);
429 const struct got_error *gotweb_init_transport(struct transport **);
430 const struct got_error *gotweb_escape_html(char **, const char *);
431 int gotweb_link(struct request *, struct gotweb_url *, const char *, ...)
432 __attribute__((__format__(printf, 3, 4)))
433 __attribute__((__nonnull__(3)));
434 void gotweb_free_repo_commit(struct repo_commit *);
435 void gotweb_free_repo_tag(struct repo_tag *);
436 void gotweb_process_request(struct request *);
437 void gotweb_free_transport(struct transport *);
440 int parse_config(const char *, struct gotwebd *);
441 int cmdline_symset(char *);
444 void fcgi_request(int, short, void *);
445 void fcgi_timeout(int, short, void *);
446 void fcgi_cleanup_request(struct request *);
447 void fcgi_create_end_record(struct request *);
448 void dump_fcgi_record(const char *, struct fcgi_record_header *);
449 int fcgi_vprintf(struct request *, const char *, va_list);
450 int fcgi_printf(struct request *, const char *, ...)
451 __attribute__((__format__(printf, 2, 3)))
452 __attribute__((__nonnull__(2)));
453 int fcgi_gen_binary_response(struct request *, const uint8_t *, int);
455 /* got_operations.c */
456 const struct got_error *got_get_repo_owner(char **, struct request *, char *);
457 const struct got_error *got_get_repo_age(char **, struct request *, char *,
459 const struct got_error *got_get_repo_commits(struct request *, int);
460 const struct got_error *got_get_repo_tags(struct request *, int);
461 const struct got_error *got_get_repo_heads(struct request *);
462 const struct got_error *got_output_repo_diff(struct request *);
463 const struct got_error *got_output_repo_tree(struct request *);
464 const struct got_error *got_output_file_blob(struct request *);
465 const struct got_error *got_output_file_blame(struct request *);
468 int config_setserver(struct gotwebd *, struct server *);
469 int config_getserver(struct gotwebd *, struct imsg *);
470 int config_setsock(struct gotwebd *, struct socket *);
471 int config_getsock(struct gotwebd *, struct imsg *);
472 int config_setfd(struct gotwebd *, struct socket *);
473 int config_getfd(struct gotwebd *, struct imsg *);
474 int config_getcfg(struct gotwebd *, struct imsg *);
475 int config_init(struct gotwebd *);