gotwebd/gotwebd.h

   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  */
  19
  20 #include <netinet/in.h>
  21 #include <net/if.h>
  22 #include <sys/queue.h>
  23
  24 #include <limits.h>
  25 #include <stdio.h>
  26
  27 #include "tmpl.h"
  28
  29 #ifdef DEBUG
  30 #define dprintf(x...)   do { log_debug(x); } while(0)
  31 #else
  32 #define dprintf(x...)
  33 #endif /* DEBUG */
  34
  35 #ifndef nitems
  36 #define nitems(_a)      (sizeof((_a)) / sizeof((_a)[0]))
  37 #endif
  38
  39 /* GOTWEBD DEFAULTS */
  40 #define GOTWEBD_CONF             "/etc/gotwebd.conf"
  41
  42 #define GOTWEBD_USER             "www"
  43
  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
  54
  55 /* GOTWEB DEFAULTS */
  56 #define MAX_QUERYSTRING          2048
  57 #define MAX_DOCUMENT_URI         255
  58 #define MAX_SERVER_NAME          255
  59
  60 #define GOTWEB_GIT_DIR           ".git"
  61
  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"
  72
  73 #define D_SHOWROWNER             1
  74 #define D_SHOWSOWNER             1
  75 #define D_SHOWAGE                1
  76 #define D_SHOWDESC               1
  77 #define D_SHOWURL                1
  78 #define D_RESPECTEXPORTOK        0
  79 #define D_MAXREPO                0
  80 #define D_MAXREPODISP            25
  81 #define D_MAXSLCOMMDISP          10
  82 #define D_MAXCOMMITDISP          25
  83
  84 #define BUF                      8192
  85
  86 #define TIMEOUT_DEFAULT          120
  87
  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)
  92
  93 #define FCGI_ALIGNMENT           8
  94 #define FCGI_ALIGN(n)            \
  95     (((n) + (FCGI_ALIGNMENT - 1)) & ~(FCGI_ALIGNMENT - 1))
  96
  97 #define FD_RESERVE               5
  98 #define FD_NEEDED                6
  99
 100 #define FCGI_BEGIN_REQUEST       1
 101 #define FCGI_ABORT_REQUEST       2
 102 #define FCGI_END_REQUEST         3
 103 #define FCGI_PARAMS              4
 104 #define FCGI_STDIN               5
 105 #define FCGI_STDOUT              6
 106 #define FCGI_STDERR              7
 107 #define FCGI_DATA                8
 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)
 112
 113 #define FCGI_REQUEST_COMPLETE   0
 114 #define FCGI_CANT_MPX_CONN      1
 115 #define FCGI_OVERLOADED         2
 116 #define FCGI_UNKNOWN_ROLE       3
 117
 118 #define GOTWEB_PACK_NUM_TEMPFILES     (32 * 2)
 119
 120 /* Forward declaration */
 121 struct got_blob_object;
 122 struct got_tree_entry;
 123 struct got_reflist_head;
 124
 125 enum imsg_type {
 126         IMSG_CFG_SRV = IMSG_PROC_MAX,
 127         IMSG_CFG_SOCK,
 128         IMSG_CFG_FD,
 129         IMSG_CFG_DONE,
 130         IMSG_CTL_START,
 131 };
 132
 133 struct env_val {
 134         SLIST_ENTRY(env_val)     entry;
 135         char                    *val;
 136 };
 137 SLIST_HEAD(env_head, env_val);
 138
 139 struct fcgi_record_header {
 140         uint8_t         version;
 141         uint8_t         type;
 142         uint16_t        id;
 143         uint16_t        content_len;
 144         uint8_t         padding_len;
 145         uint8_t         reserved;
 146 }__attribute__((__packed__));
 147
 148 struct blame_line {
 149         int              annotated;
 150         char            *id_str;
 151         char            *committer;
 152         char             datebuf[11]; /* YYYY-MM-DD + NUL */
 153 };
 154
 155 struct repo_dir {
 156         char                    *name;
 157         char                    *owner;
 158         char                    *description;
 159         char                    *url;
 160         time_t                   age;
 161         char                    *path;
 162 };
 163
 164 struct repo_tag {
 165         TAILQ_ENTRY(repo_tag)    entry;
 166         char                    *commit_id;
 167         char                    *tag_name;
 168         char                    *tag_commit;
 169         char                    *commit_msg;
 170         char                    *tagger;
 171         time_t                   tagger_time;
 172 };
 173
 174 struct repo_commit {
 175         TAILQ_ENTRY(repo_commit)         entry;
 176         char                    *path;
 177         char                    *refs_str;
 178         char                    *commit_id; /* id_str1 */
 179         char                    *parent_id; /* id_str2 */
 180         char                    *tree_id;
 181         char                    *author;
 182         char                    *committer;
 183         char                    *commit_msg;
 184         time_t                   committer_time;
 185 };
 186
 187 struct got_repository;
 188 struct transport {
 189         TAILQ_HEAD(repo_commits_head, repo_commit)       repo_commits;
 190         TAILQ_HEAD(repo_tags_head, repo_tag)             repo_tags;
 191         struct got_reflist_head  refs;
 192         struct got_repository   *repo;
 193         struct repo_dir         *repo_dir;
 194         struct querystring      *qs;
 195         char                    *more_id;
 196         char                    *next_id;
 197         char                    *prev_id;
 198         unsigned int             repos_total;
 199         unsigned int             next_disp;
 200         unsigned int             prev_disp;
 201         unsigned int             tag_count;
 202         const struct got_error  *error;
 203         struct got_blob_object  *blob;
 204         int                      fd;
 205         FILE                    *fp;
 206         struct dirent           **repos;
 207         int                      nrepos;
 208 };
 209
 210 enum socket_priv_fds {
 211         DIFF_FD_1,
 212         DIFF_FD_2,
 213         DIFF_FD_3,
 214         DIFF_FD_4,
 215         DIFF_FD_5,
 216         BLAME_FD_1,
 217         BLAME_FD_2,
 218         BLAME_FD_3,
 219         BLAME_FD_4,
 220         BLAME_FD_5,
 221         BLAME_FD_6,
 222         BLOB_FD_1,
 223         BLOB_FD_2,
 224         PRIV_FDS__MAX,
 225 };
 226
 227 struct template;
 228 struct request {
 229         struct socket                   *sock;
 230         struct server                   *srv;
 231         struct transport                *t;
 232         struct template                 *tp;
 233         struct event                     ev;
 234         struct event                     tmo;
 235
 236         uint16_t                         id;
 237         int                              fd;
 238         int                              priv_fd[PRIV_FDS__MAX];
 239
 240         uint8_t                          buf[FCGI_RECORD_SIZE];
 241         size_t                           buf_pos;
 242         size_t                           buf_len;
 243
 244         uint8_t                          outbuf[GOTWEBD_CACHESIZE];
 245
 246         char                             querystring[MAX_QUERYSTRING];
 247         char                             document_uri[MAX_DOCUMENT_URI];
 248         char                             server_name[MAX_SERVER_NAME];
 249         int                              https;
 250
 251         uint8_t                          request_started;
 252 };
 253
 254 struct fcgi_begin_request_body {
 255         uint16_t        role;
 256         uint8_t         flags;
 257         uint8_t         reserved[5];
 258 }__attribute__((__packed__));
 259
 260 struct fcgi_end_request_body {
 261         uint32_t        app_status;
 262         uint8_t         protocol_status;
 263         uint8_t         reserved[3];
 264 }__attribute__((__packed__));
 265
 266 struct address {
 267         TAILQ_ENTRY(address)     entry;
 268         struct sockaddr_storage  ss;
 269         int                      ipproto;
 270         in_port_t                port;
 271         char                     ifname[IFNAMSIZ];
 272 };
 273 TAILQ_HEAD(addresslist, address);
 274
 275 struct cached_repo {
 276         char path[PATH_MAX];
 277         struct got_repository *repo;
 278 };
 279
 280 struct server {
 281         TAILQ_ENTRY(server)      entry;
 282         struct addresslist      al;
 283
 284         struct cached_repo      *cached_repos;
 285         int              ncached_repos;
 286
 287         char             name[GOTWEBD_MAXTEXT];
 288
 289         char             repos_path[PATH_MAX];
 290         char             site_name[GOTWEBD_MAXNAME];
 291         char             site_owner[GOTWEBD_MAXNAME];
 292         char             site_link[GOTWEBD_MAXTEXT];
 293         char             logo[GOTWEBD_MAXTEXT];
 294         char             logo_url[GOTWEBD_MAXTEXT];
 295         char             custom_css[PATH_MAX];
 296
 297         size_t           max_repos;
 298         size_t           max_repos_display;
 299         size_t           max_commits_display;
 300
 301         int              show_site_owner;
 302         int              show_repo_owner;
 303         int              show_repo_age;
 304         int              show_repo_description;
 305         int              show_repo_cloneurl;
 306         int              respect_exportok;
 307
 308         int              unix_socket;
 309         char             unix_socket_name[PATH_MAX];
 310
 311         int              fcgi_socket;
 312 };
 313 TAILQ_HEAD(serverlist, server);
 314
 315 enum client_action {
 316         CLIENT_CONNECT,
 317         CLIENT_DISCONNECT,
 318 };
 319
 320 struct socket_conf {
 321         struct address   addr;
 322
 323         char             name[GOTWEBD_MAXTEXT];
 324         char             srv_name[GOTWEBD_MAXTEXT];
 325
 326         int              id;
 327         int              af_type;
 328         char             unix_socket_name[PATH_MAX];
 329         in_port_t        fcgi_socket_port;
 330 };
 331
 332 struct socket {
 333         TAILQ_ENTRY(socket)      entry;
 334         struct socket_conf       conf;
 335
 336         int              fd;
 337         int              pack_fds[GOTWEB_PACK_NUM_TEMPFILES];
 338         int              priv_fd[PRIV_FDS__MAX];
 339
 340         struct event     evt;
 341         struct event     ev;
 342         struct event     pause;
 343
 344         int              client_status;
 345 };
 346 TAILQ_HEAD(socketlist, socket);
 347
 348 struct gotwebd {
 349         struct serverlist       servers;
 350         struct socketlist       sockets;
 351
 352         struct privsep  *gotwebd_ps;
 353         const char      *gotwebd_conffile;
 354
 355         int              gotwebd_debug;
 356         int              gotwebd_verbose;
 357         int              gotwebd_noaction;
 358
 359         uint16_t         prefork_gotwebd;
 360         int              gotwebd_reload;
 361
 362         int              server_cnt;
 363
 364         char             httpd_chroot[PATH_MAX];
 365
 366         int              unix_socket;
 367         char             unix_socket_name[PATH_MAX];
 368 };
 369
 370 /*
 371  * URL parameter for gotweb_render_url.  NULL values and int set to -1
 372  * are implicitly ignored, and string are properly escaped.
 373  */
 374 struct gotweb_url {
 375         int              action;
 376         int              index_page;
 377         int              page;
 378         const char      *commit;
 379         const char      *previd;
 380         const char      *prevset;
 381         const char      *file;
 382         const char      *folder;
 383         const char      *headref;
 384         const char      *path;
 385 };
 386
 387 struct querystring {
 388         uint8_t          action;
 389         char            *commit;
 390         char            *previd;
 391         char            *prevset;
 392         char            *file;
 393         char            *folder;
 394         char            *headref;
 395         int              index_page;
 396         char            *path;
 397         int              page;
 398 };
 399
 400 struct querystring_keys {
 401         const char      *name;
 402         int              element;
 403 };
 404
 405 struct action_keys {
 406         const char      *name;
 407         int              action;
 408 };
 409
 410 enum querystring_elements {
 411         ACTION,
 412         COMMIT,
 413         RFILE,
 414         FOLDER,
 415         HEADREF,
 416         INDEX_PAGE,
 417         PATH,
 418         PAGE,
 419         PREVID,
 420         QSELEM__MAX,
 421 };
 422
 423 enum query_actions {
 424         BLAME,
 425         BLOB,
 426         BLOBRAW,
 427         BRIEFS,
 428         COMMITS,
 429         DIFF,
 430         ERR,
 431         INDEX,
 432         SUMMARY,
 433         TAG,
 434         TAGS,
 435         TREE,
 436         RSS,
 437         ACTIONS__MAX,
 438 };
 439
 440 extern struct gotwebd   *gotwebd_env;
 441
 442 typedef int (*got_render_blame_line_cb)(struct template *, const char *,
 443     struct blame_line *, int, int);
 444
 445 /* sockets.c */
 446 void sockets(struct privsep *, struct privsep_proc *);
 447 void sockets_shutdown(void);
 448 void sockets_parse_sockets(struct gotwebd *);
 449 void sockets_socket_accept(int, short, void *);
 450 int sockets_privinit(struct gotwebd *, struct socket *);
 451
 452 /* gotweb.c */
 453 void gotweb_get_navs(struct request *, struct gotweb_url *, int *,
 454     struct gotweb_url *, int *);
 455 int gotweb_render_age(struct template *, time_t);
 456 const struct got_error *gotweb_init_transport(struct transport **);
 457 const char *gotweb_action_name(int);
 458 int gotweb_render_url(struct request *, struct gotweb_url *);
 459 int gotweb_render_absolute_url(struct request *, struct gotweb_url *);
 460 void gotweb_free_repo_commit(struct repo_commit *);
 461 void gotweb_free_repo_tag(struct repo_tag *);
 462 void gotweb_process_request(struct request *);
 463 void gotweb_free_transport(struct transport *);
 464
 465 /* pages.tmpl */
 466 int     gotweb_render_page(struct template *, int (*)(struct template *));
 467 int     gotweb_render_error(struct template *);
 468 int     gotweb_render_repo_table_hdr(struct template *);
 469 int     gotweb_render_repo_fragment(struct template *, struct repo_dir *);
 470 int     gotweb_render_briefs(struct template *);
 471 int     gotweb_render_navs(struct template *);
 472 int     gotweb_render_commits(struct template *);
 473 int     gotweb_render_blob(struct template *);
 474 int     gotweb_render_tree(struct template *);
 475 int     gotweb_render_tags(struct template *);
 476 int     gotweb_render_tag(struct template *);
 477 int     gotweb_render_diff(struct template *);
 478 int     gotweb_render_branches(struct template *, struct got_reflist_head *);
 479 int     gotweb_render_summary(struct template *);
 480 int     gotweb_render_blame(struct template *);
 481 int     gotweb_render_rss(struct template *);
 482
 483 /* parse.y */
 484 int parse_config(const char *, struct gotwebd *);
 485 int cmdline_symset(char *);
 486
 487 /* fcgi.c */
 488 void fcgi_request(int, short, void *);
 489 void fcgi_timeout(int, short, void *);
 490 void fcgi_cleanup_request(struct request *);
 491 void fcgi_create_end_record(struct request *);
 492 void dump_fcgi_record(const char *, struct fcgi_record_header *);
 493 int fcgi_write(void *, const void *, size_t);
 494
 495 /* got_operations.c */
 496 const struct got_error *got_gotweb_closefile(FILE *);
 497 const struct got_error *got_get_repo_owner(char **, struct request *);
 498 const struct got_error *got_get_repo_age(time_t *, struct request *,
 499     const char *);
 500 const struct got_error *got_get_repo_commits(struct request *, size_t);
 501 const struct got_error *got_get_repo_tags(struct request *, size_t);
 502 const struct got_error *got_get_repo_heads(struct request *);
 503 const struct got_error *got_open_diff_for_output(FILE **, struct request *);
 504 int got_output_repo_tree(struct request *,
 505     int (*)(struct template *, struct got_tree_entry *));
 506 const struct got_error *got_open_blob_for_output(struct got_blob_object **,
 507     int *, int *, struct request *);
 508 int got_output_blob_by_lines(struct template *, struct got_blob_object *,
 509     int (*)(struct template *, const char *, size_t));
 510 const struct got_error *got_output_file_blame(struct request *,
 511     got_render_blame_line_cb);
 512
 513 /* config.c */
 514 int config_setserver(struct gotwebd *, struct server *);
 515 int config_getserver(struct gotwebd *, struct imsg *);
 516 int config_setsock(struct gotwebd *, struct socket *);
 517 int config_getsock(struct gotwebd *, struct imsg *);
 518 int config_setfd(struct gotwebd *, struct socket *);
 519 int config_getfd(struct gotwebd *, struct imsg *);
 520 int config_getcfg(struct gotwebd *, struct imsg *);
 521 int config_init(struct gotwebd *);