Blob


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 */
20 #include <netinet/in.h>
21 #include <net/if.h>
22 #include <sys/queue.h>
24 #include <limits.h>
25 #include <stdio.h>
27 #ifdef DEBUG
28 #define dprintf(x...) do { log_debug(x); } while(0)
29 #else
30 #define dprintf(x...)
31 #endif /* DEBUG */
33 #ifndef nitems
34 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
35 #endif
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
50 /* GOTWEB DEFAULTS */
51 #define MAX_QUERYSTRING 2048
52 #define MAX_DOCUMENT_ROOT 255
53 #define MAX_SERVER_NAME 255
55 #define GOTWEB_GOT_DIR ".got"
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
71 #define D_SHOWAGE 1
72 #define D_SHOWDESC 1
73 #define D_SHOWURL 1
74 #define D_MAXREPO 0
75 #define D_MAXREPODISP 25
76 #define D_MAXSLCOMMDISP 10
77 #define D_MAXCOMMITDISP 25
79 #define BUF 8192
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))
92 #define FD_RESERVE 5
93 #define FD_NEEDED 6
95 #define FCGI_BEGIN_REQUEST 1
96 #define FCGI_ABORT_REQUEST 2
97 #define FCGI_END_REQUEST 3
98 #define FCGI_PARAMS 4
99 #define FCGI_STDIN 5
100 #define FCGI_STDOUT 6
101 #define FCGI_STDERR 7
102 #define FCGI_DATA 8
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
115 enum imsg_type {
116 IMSG_CFG_SRV = IMSG_PROC_MAX,
117 IMSG_CFG_SOCK,
118 IMSG_CFG_FD,
119 IMSG_CFG_DONE,
120 IMSG_CTL_START,
121 };
123 struct env_val {
124 SLIST_ENTRY(env_val) entry;
125 char *val;
126 };
127 SLIST_HEAD(env_head, env_val);
129 struct fcgi_record_header {
130 uint8_t version;
131 uint8_t type;
132 uint16_t id;
133 uint16_t content_len;
134 uint8_t padding_len;
135 uint8_t reserved;
136 }__attribute__((__packed__));
138 struct repo_dir {
139 char *name;
140 char *owner;
141 char *description;
142 char *url;
143 char *age;
144 char *path;
145 };
147 struct repo_tag {
148 TAILQ_ENTRY(repo_tag) entry;
149 char *commit_id;
150 char *tag_name;
151 char *tag_commit;
152 char *commit_msg;
153 char *tagger;
154 time_t tagger_time;
155 };
157 struct repo_commit {
158 TAILQ_ENTRY(repo_commit) entry;
159 char *path;
160 char *refs_str;
161 char *commit_id; /* id_str1 */
162 char *parent_id; /* id_str2 */
163 char *tree_id;
164 char *author;
165 char *committer;
166 char *commit_msg;
167 time_t committer_time;
168 };
170 struct got_repository;
171 struct transport {
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;
177 char *next_id;
178 char *prev_id;
179 unsigned int repos_total;
180 unsigned int next_disp;
181 unsigned int prev_disp;
182 unsigned int tag_count;
183 };
185 enum socket_priv_fds {
186 DIFF_FD_1,
187 DIFF_FD_2,
188 DIFF_FD_3,
189 DIFF_FD_4,
190 DIFF_FD_5,
191 BLAME_FD_1,
192 BLAME_FD_2,
193 BLAME_FD_3,
194 BLAME_FD_4,
195 BLAME_FD_5,
196 BLAME_FD_6,
197 BLOB_FD_1,
198 BLOB_FD_2,
199 PRIV_FDS__MAX,
200 };
202 struct request {
203 struct socket *sock;
204 struct server *srv;
205 struct transport *t;
206 struct event ev;
207 struct event tmo;
209 uint16_t id;
210 int fd;
211 int priv_fd[PRIV_FDS__MAX];
213 uint8_t buf[FCGI_RECORD_SIZE];
214 size_t buf_pos;
215 size_t buf_len;
217 uint8_t outbuf[GOTWEBD_CACHESIZE];
218 size_t outbuf_len;
220 char querystring[MAX_QUERYSTRING];
221 char http_host[GOTWEBD_MAXTEXT];
222 char document_root[MAX_DOCUMENT_ROOT];
223 char server_name[MAX_SERVER_NAME];
225 struct env_head env;
226 int env_count;
228 uint8_t request_started;
229 };
231 struct fcgi_begin_request_body {
232 uint16_t role;
233 uint8_t flags;
234 uint8_t reserved[5];
235 }__attribute__((__packed__));
237 struct fcgi_end_request_body {
238 uint32_t app_status;
239 uint8_t protocol_status;
240 uint8_t reserved[3];
241 }__attribute__((__packed__));
243 struct address {
244 TAILQ_ENTRY(address) entry;
245 struct sockaddr_storage ss;
246 int ipproto;
247 int prefixlen;
248 in_port_t port;
249 char ifname[IFNAMSIZ];
250 };
251 TAILQ_HEAD(addresslist, address);
253 struct server {
254 TAILQ_ENTRY(server) entry;
255 struct addresslist al;
257 char name[GOTWEBD_MAXTEXT];
259 char repos_path[PATH_MAX];
260 char site_name[GOTWEBD_MAXNAME];
261 char site_owner[GOTWEBD_MAXNAME];
262 char site_link[GOTWEBD_MAXTEXT];
263 char logo[GOTWEBD_MAXTEXT];
264 char logo_url[GOTWEBD_MAXTEXT];
265 char custom_css[PATH_MAX];
267 size_t max_repos;
268 size_t max_repos_display;
269 size_t max_commits_display;
271 int show_site_owner;
272 int show_repo_owner;
273 int show_repo_age;
274 int show_repo_description;
275 int show_repo_cloneurl;
277 int unix_socket;
278 char unix_socket_name[PATH_MAX];
280 int fcgi_socket;
281 char fcgi_socket_bind[GOTWEBD_MAXTEXT];
282 in_port_t fcgi_socket_port;
283 };
284 TAILQ_HEAD(serverlist, server);
286 enum client_action {
287 CLIENT_CONNECT,
288 CLIENT_DISCONNECT,
289 };
291 enum sock_type {
292 UNIX,
293 FCGI,
294 };
296 struct socket_conf {
297 struct addresslist al;
299 char name[GOTWEBD_MAXTEXT];
300 char srv_name[GOTWEBD_MAXTEXT];
302 int id;
303 int child_id;
304 int parent_id;
306 int ipv4;
307 int ipv6;
309 int type;
310 char unix_socket_name[PATH_MAX];
311 in_port_t fcgi_socket_port;
312 };
314 struct socket {
315 TAILQ_ENTRY(socket) entry;
316 struct socket_conf conf;
318 int fd;
319 int pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
320 int priv_fd[PRIV_FDS__MAX];
322 struct event evt;
323 struct event ev;
324 struct event pause;
326 int client_status;
327 };
328 TAILQ_HEAD(socketlist, socket);
330 struct gotwebd {
331 struct serverlist servers;
332 struct socketlist sockets;
334 struct privsep *gotwebd_ps;
335 const char *gotwebd_conffile;
337 int gotwebd_debug;
338 int gotwebd_verbose;
339 int gotwebd_noaction;
341 uint16_t prefork_gotwebd;
342 int gotwebd_reload;
344 int server_cnt;
346 char httpd_chroot[PATH_MAX];
348 int unix_socket;
349 char unix_socket_name[PATH_MAX];
351 int fcgi_socket;
352 char fcgi_socket_bind[GOTWEBD_MAXTEXT];
353 in_port_t fcgi_socket_port;
354 };
356 struct querystring {
357 uint8_t action;
358 char *commit;
359 char *previd;
360 char *prevset;
361 char *file;
362 char *folder;
363 char *headref;
364 int index_page;
365 char *index_page_str;
366 char *path;
367 int page;
368 char *page_str;
369 };
371 struct querystring_keys {
372 const char *name;
373 int element;
374 };
376 struct action_keys {
377 const char *name;
378 int action;
379 };
381 enum querystring_elements {
382 ACTION,
383 COMMIT,
384 RFILE,
385 FOLDER,
386 HEADREF,
387 INDEX_PAGE,
388 PATH,
389 PAGE,
390 PREVID,
391 QSELEM__MAX,
392 };
394 enum query_actions {
395 BLAME,
396 BLOB,
397 BRIEFS,
398 COMMITS,
399 DIFF,
400 ERR,
401 INDEX,
402 SUMMARY,
403 TAG,
404 TAGS,
405 TREE,
406 ACTIONS__MAX,
407 };
409 extern struct gotwebd *gotwebd_env;
411 /* sockets.c */
412 void sockets(struct privsep *, struct privsep_proc *);
413 void sockets_shutdown(void);
414 void sockets_parse_sockets(struct gotwebd *);
415 void sockets_socket_accept(int, short, void *);
416 int sockets_privinit(struct gotwebd *, struct socket *);
418 /* gotweb.c */
419 const struct got_error *gotweb_render_content_type(struct request *,
420 const uint8_t *);
421 const struct got_error
422 *gotweb_render_content_type_file(struct request *, const uint8_t *, char *);
423 const struct got_error *gotweb_get_time_str(char **, time_t, int);
424 const struct got_error *gotweb_init_transport(struct transport **);
425 const struct got_error *gotweb_escape_html(char **, const char *);
426 void gotweb_free_repo_commit(struct repo_commit *);
427 void gotweb_free_repo_tag(struct repo_tag *);
428 void gotweb_process_request(struct request *);
429 void gotweb_free_transport(struct transport *);
431 /* parse.y */
432 int parse_config(const char *, struct gotwebd *);
433 int cmdline_symset(char *);
435 /* fcgi.c */
436 void fcgi_request(int, short, void *);
437 void fcgi_timeout(int, short, void *);
438 void fcgi_cleanup_request(struct request *);
439 void fcgi_create_end_record(struct request *);
440 void dump_fcgi_record(const char *, struct fcgi_record_header *);
441 int fcgi_gen_response(struct request *, const char *);
442 int fcgi_gen_binary_response(struct request *, const uint8_t *, int);
444 /* got_operations.c */
445 const struct got_error *got_get_repo_owner(char **, struct request *, char *);
446 const struct got_error *got_get_repo_age(char **, struct request *, char *,
447 const char *, int);
448 const struct got_error *got_get_repo_commits(struct request *, int);
449 const struct got_error *got_get_repo_tags(struct request *, int);
450 const struct got_error *got_get_repo_heads(struct request *);
451 const struct got_error *got_output_repo_diff(struct request *);
452 const struct got_error *got_output_repo_tree(struct request *);
453 const struct got_error *got_output_file_blob(struct request *);
454 const struct got_error *got_output_file_blame(struct request *);
456 /* config.c */
457 int config_setserver(struct gotwebd *, struct server *);
458 int config_getserver(struct gotwebd *, struct imsg *);
459 int config_setsock(struct gotwebd *, struct socket *);
460 int config_getsock(struct gotwebd *, struct imsg *);
461 int config_setfd(struct gotwebd *, struct socket *);
462 int config_getfd(struct gotwebd *, struct imsg *);
463 int config_getcfg(struct gotwebd *, struct imsg *);
464 int config_init(struct gotwebd *);