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
49 #define GOTWEBD_REPO_CACHESIZE 4
51 /* GOTWEB DEFAULTS */
52 #define MAX_QUERYSTRING 2048
53 #define MAX_SCRIPT_NAME 255
54 #define MAX_SERVER_NAME 255
56 #define GOTWEB_GOT_DIR ".got"
57 #define GOTWEB_GIT_DIR ".git"
59 #define D_HTTPD_CHROOT "/var/www"
60 #define D_UNIX_SOCKET "/run/gotweb.sock"
61 #define D_FCGI_PORT "9000"
62 #define D_GOTPATH "/got/public"
63 #define D_SITENAME "Gotweb"
64 #define D_SITEOWNER "Got Owner"
65 #define D_SITELINK "Repos"
66 #define D_GOTLOGO "got.png"
67 #define D_GOTURL "https://gameoftrees.org"
68 #define D_GOTWEBCSS "gotweb.css"
70 #define D_SHOWROWNER 1
71 #define D_SHOWSOWNER 1
72 #define D_SHOWAGE 1
73 #define D_SHOWDESC 1
74 #define D_SHOWURL 1
75 #define D_MAXREPO 0
76 #define D_MAXREPODISP 25
77 #define D_MAXSLCOMMDISP 10
78 #define D_MAXCOMMITDISP 25
80 #define BUF 8192
82 #define TIMEOUT_DEFAULT 120
84 #define FCGI_CONTENT_SIZE 65535
85 #define FCGI_PADDING_SIZE 255
86 #define FCGI_RECORD_SIZE \
87 (sizeof(struct fcgi_record_header) + FCGI_CONTENT_SIZE + FCGI_PADDING_SIZE)
89 #define FCGI_ALIGNMENT 8
90 #define FCGI_ALIGN(n) \
91 (((n) + (FCGI_ALIGNMENT - 1)) & ~(FCGI_ALIGNMENT - 1))
93 #define FD_RESERVE 5
94 #define FD_NEEDED 6
96 #define FCGI_BEGIN_REQUEST 1
97 #define FCGI_ABORT_REQUEST 2
98 #define FCGI_END_REQUEST 3
99 #define FCGI_PARAMS 4
100 #define FCGI_STDIN 5
101 #define FCGI_STDOUT 6
102 #define FCGI_STDERR 7
103 #define FCGI_DATA 8
104 #define FCGI_GET_VALUES 9
105 #define FCGI_GET_VALUES_RESULT 10
106 #define FCGI_UNKNOWN_TYPE 11
107 #define FCGI_MAXTYPE (FCGI_UNKNOWN_TYPE)
109 #define FCGI_REQUEST_COMPLETE 0
110 #define FCGI_CANT_MPX_CONN 1
111 #define FCGI_OVERLOADED 2
112 #define FCGI_UNKNOWN_ROLE 3
114 #define GOTWEB_PACK_NUM_TEMPFILES 32
116 enum imsg_type {
117 IMSG_CFG_SRV = IMSG_PROC_MAX,
118 IMSG_CFG_SOCK,
119 IMSG_CFG_FD,
120 IMSG_CFG_DONE,
121 IMSG_CTL_START,
122 };
124 struct env_val {
125 SLIST_ENTRY(env_val) entry;
126 char *val;
127 };
128 SLIST_HEAD(env_head, env_val);
130 struct fcgi_record_header {
131 uint8_t version;
132 uint8_t type;
133 uint16_t id;
134 uint16_t content_len;
135 uint8_t padding_len;
136 uint8_t reserved;
137 }__attribute__((__packed__));
139 struct repo_dir {
140 char *name;
141 char *owner;
142 char *description;
143 char *url;
144 char *age;
145 char *path;
146 };
148 struct repo_tag {
149 TAILQ_ENTRY(repo_tag) entry;
150 char *commit_id;
151 char *tag_name;
152 char *tag_commit;
153 char *commit_msg;
154 char *tagger;
155 time_t tagger_time;
156 };
158 struct repo_commit {
159 TAILQ_ENTRY(repo_commit) entry;
160 char *path;
161 char *refs_str;
162 char *commit_id; /* id_str1 */
163 char *parent_id; /* id_str2 */
164 char *tree_id;
165 char *author;
166 char *committer;
167 char *commit_msg;
168 time_t committer_time;
169 };
171 struct got_repository;
172 struct transport {
173 TAILQ_HEAD(repo_commits_head, repo_commit) repo_commits;
174 TAILQ_HEAD(repo_tags_head, repo_tag) repo_tags;
175 struct got_repository *repo;
176 struct repo_dir *repo_dir;
177 struct querystring *qs;
178 char *next_id;
179 char *prev_id;
180 unsigned int repos_total;
181 unsigned int next_disp;
182 unsigned int prev_disp;
183 unsigned int tag_count;
184 };
186 enum socket_priv_fds {
187 DIFF_FD_1,
188 DIFF_FD_2,
189 DIFF_FD_3,
190 DIFF_FD_4,
191 DIFF_FD_5,
192 BLAME_FD_1,
193 BLAME_FD_2,
194 BLAME_FD_3,
195 BLAME_FD_4,
196 BLAME_FD_5,
197 BLAME_FD_6,
198 BLOB_FD_1,
199 BLOB_FD_2,
200 PRIV_FDS__MAX,
201 };
203 struct request {
204 struct socket *sock;
205 struct server *srv;
206 struct transport *t;
207 struct event ev;
208 struct event tmo;
210 uint16_t id;
211 int fd;
212 int priv_fd[PRIV_FDS__MAX];
214 uint8_t buf[FCGI_RECORD_SIZE];
215 size_t buf_pos;
216 size_t buf_len;
218 uint8_t outbuf[GOTWEBD_CACHESIZE];
219 size_t outbuf_len;
221 char querystring[MAX_QUERYSTRING];
222 char http_host[GOTWEBD_MAXTEXT];
223 char script_name[MAX_SCRIPT_NAME];
224 char server_name[MAX_SERVER_NAME];
226 struct env_head env;
227 int env_count;
229 uint8_t request_started;
230 };
232 struct fcgi_begin_request_body {
233 uint16_t role;
234 uint8_t flags;
235 uint8_t reserved[5];
236 }__attribute__((__packed__));
238 struct fcgi_end_request_body {
239 uint32_t app_status;
240 uint8_t protocol_status;
241 uint8_t reserved[3];
242 }__attribute__((__packed__));
244 struct address {
245 TAILQ_ENTRY(address) entry;
246 struct sockaddr_storage ss;
247 int ipproto;
248 int prefixlen;
249 in_port_t port;
250 char ifname[IFNAMSIZ];
251 };
252 TAILQ_HEAD(addresslist, address);
254 struct cached_repo {
255 char path[PATH_MAX];
256 struct got_repository *repo;
257 };
259 struct server {
260 TAILQ_ENTRY(server) entry;
261 struct addresslist al;
263 struct cached_repo cached_repos[GOTWEBD_REPO_CACHESIZE];
264 int ncached_repos;
266 char name[GOTWEBD_MAXTEXT];
268 char repos_path[PATH_MAX];
269 char site_name[GOTWEBD_MAXNAME];
270 char site_owner[GOTWEBD_MAXNAME];
271 char site_link[GOTWEBD_MAXTEXT];
272 char logo[GOTWEBD_MAXTEXT];
273 char logo_url[GOTWEBD_MAXTEXT];
274 char custom_css[PATH_MAX];
276 size_t max_repos;
277 size_t max_repos_display;
278 size_t max_commits_display;
280 int show_site_owner;
281 int show_repo_owner;
282 int show_repo_age;
283 int show_repo_description;
284 int show_repo_cloneurl;
286 int unix_socket;
287 char unix_socket_name[PATH_MAX];
289 int fcgi_socket;
290 };
291 TAILQ_HEAD(serverlist, server);
293 enum client_action {
294 CLIENT_CONNECT,
295 CLIENT_DISCONNECT,
296 };
298 struct socket_conf {
299 struct address addr;
301 char name[GOTWEBD_MAXTEXT];
302 char srv_name[GOTWEBD_MAXTEXT];
304 int id;
305 int af_type;
306 char unix_socket_name[PATH_MAX];
307 in_port_t fcgi_socket_port;
308 };
310 struct socket {
311 TAILQ_ENTRY(socket) entry;
312 struct socket_conf conf;
314 int fd;
315 int pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
316 int priv_fd[PRIV_FDS__MAX];
318 struct event evt;
319 struct event ev;
320 struct event pause;
322 int client_status;
323 };
324 TAILQ_HEAD(socketlist, socket);
326 struct gotwebd {
327 struct serverlist servers;
328 struct socketlist sockets;
330 struct privsep *gotwebd_ps;
331 const char *gotwebd_conffile;
333 int gotwebd_debug;
334 int gotwebd_verbose;
335 int gotwebd_noaction;
337 uint16_t prefork_gotwebd;
338 int gotwebd_reload;
340 int server_cnt;
342 char httpd_chroot[PATH_MAX];
344 int unix_socket;
345 char unix_socket_name[PATH_MAX];
346 };
348 struct querystring {
349 uint8_t action;
350 char *commit;
351 char *previd;
352 char *prevset;
353 char *file;
354 char *folder;
355 char *headref;
356 int index_page;
357 char *index_page_str;
358 char *path;
359 int page;
360 char *page_str;
361 };
363 struct querystring_keys {
364 const char *name;
365 int element;
366 };
368 struct action_keys {
369 const char *name;
370 int action;
371 };
373 enum querystring_elements {
374 ACTION,
375 COMMIT,
376 RFILE,
377 FOLDER,
378 HEADREF,
379 INDEX_PAGE,
380 PATH,
381 PAGE,
382 PREVID,
383 QSELEM__MAX,
384 };
386 enum query_actions {
387 BLAME,
388 BLOB,
389 BRIEFS,
390 COMMITS,
391 DIFF,
392 ERR,
393 INDEX,
394 SUMMARY,
395 TAG,
396 TAGS,
397 TREE,
398 ACTIONS__MAX,
399 };
401 extern struct gotwebd *gotwebd_env;
403 /* sockets.c */
404 void sockets(struct privsep *, struct privsep_proc *);
405 void sockets_shutdown(void);
406 void sockets_parse_sockets(struct gotwebd *);
407 void sockets_socket_accept(int, short, void *);
408 int sockets_privinit(struct gotwebd *, struct socket *);
410 /* gotweb.c */
411 const struct got_error *gotweb_render_content_type(struct request *,
412 const uint8_t *);
413 const struct got_error
414 *gotweb_render_content_type_file(struct request *, const uint8_t *, char *);
415 const struct got_error *gotweb_get_time_str(char **, time_t, int);
416 const struct got_error *gotweb_init_transport(struct transport **);
417 const struct got_error *gotweb_escape_html(char **, const char *);
418 void gotweb_free_repo_commit(struct repo_commit *);
419 void gotweb_free_repo_tag(struct repo_tag *);
420 void gotweb_process_request(struct request *);
421 void gotweb_free_transport(struct transport *);
423 /* parse.y */
424 int parse_config(const char *, struct gotwebd *);
425 int cmdline_symset(char *);
427 /* fcgi.c */
428 void fcgi_request(int, short, void *);
429 void fcgi_timeout(int, short, void *);
430 void fcgi_cleanup_request(struct request *);
431 void fcgi_create_end_record(struct request *);
432 void dump_fcgi_record(const char *, struct fcgi_record_header *);
433 int fcgi_printf(struct request *, const char *, ...)
434 __attribute__((__format__(printf, 2, 3)))
435 __attribute__((__nonnull__(2)));
436 int fcgi_gen_binary_response(struct request *, const uint8_t *, int);
438 /* got_operations.c */
439 const struct got_error *got_get_repo_owner(char **, struct request *, char *);
440 const struct got_error *got_get_repo_age(char **, struct request *, char *,
441 const char *, int);
442 const struct got_error *got_get_repo_commits(struct request *, int);
443 const struct got_error *got_get_repo_tags(struct request *, int);
444 const struct got_error *got_get_repo_heads(struct request *);
445 const struct got_error *got_output_repo_diff(struct request *);
446 const struct got_error *got_output_repo_tree(struct request *);
447 const struct got_error *got_output_file_blob(struct request *);
448 const struct got_error *got_output_file_blame(struct request *);
450 /* config.c */
451 int config_setserver(struct gotwebd *, struct server *);
452 int config_getserver(struct gotwebd *, struct imsg *);
453 int config_setsock(struct gotwebd *, struct socket *);
454 int config_getsock(struct gotwebd *, struct imsg *);
455 int config_setfd(struct gotwebd *, struct socket *);
456 int config_getfd(struct gotwebd *, struct imsg *);
457 int config_getcfg(struct gotwebd *, struct imsg *);
458 int config_init(struct gotwebd *);