lib/got_lib_privsep.h

   1 /*
   2  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
   3  * Copyright (c) 2019, Ori Bernstein <ori@openbsd.org>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /*
  19  * All code runs under the same UID but sensitive code paths are
  20  * run in a separate process with tighter pledge(2) promises.
  21  * Data is communicated between processes via imsg_flush(3) and imsg_read(3).
  22  * This behaviour is transparent to users of the library.
  23  *
  24  * We generally transmit data in imsg buffers, split across several messages
  25  * if necessary. File descriptors are used in cases where this is impractical,
  26  * such as when accessing pack files or when transferring large blobs.
  27  *
  28  * We exec(2) after a fork(2). Parts of our library functionality are
  29  * accessible via separate executables in a libexec directory.
  30  */
  31
  32 #define GOT_IMSG_FD_CHILD (STDERR_FILENO + 1)
  33
  34 #ifndef GOT_LIBEXECDIR
  35 #define GOT_LIBEXECDIR /usr/local/bin
  36 #endif
  37
  38 /* Names of helper programs in libexec directory */
  39 #define GOT_PROG_READ_OBJECT    got-read-object
  40 #define GOT_PROG_READ_TREE      got-read-tree
  41 #define GOT_PROG_READ_COMMIT    got-read-commit
  42 #define GOT_PROG_READ_BLOB      got-read-blob
  43 #define GOT_PROG_READ_TAG       got-read-tag
  44 #define GOT_PROG_READ_PACK      got-read-pack
  45 #define GOT_PROG_READ_GITCONFIG got-read-gitconfig
  46 #define GOT_PROG_READ_GOTCONFIG got-read-gotconfig
  47 #define GOT_PROG_READ_PATCH     got-read-patch
  48 #define GOT_PROG_FETCH_PACK     got-fetch-pack
  49 #define GOT_PROG_INDEX_PACK     got-index-pack
  50 #define GOT_PROG_SEND_PACK      got-send-pack
  51
  52 #define GOT_STRINGIFY(x) #x
  53 #define GOT_STRINGVAL(x) GOT_STRINGIFY(x)
  54
  55 /* Paths to helper programs in libexec directory */
  56 #define GOT_PATH_PROG_READ_OBJECT \
  57         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_OBJECT)
  58 #define GOT_PATH_PROG_READ_TREE \
  59         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TREE)
  60 #define GOT_PATH_PROG_READ_COMMIT \
  61         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_COMMIT)
  62 #define GOT_PATH_PROG_READ_BLOB \
  63         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_BLOB)
  64 #define GOT_PATH_PROG_READ_TAG \
  65         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TAG)
  66 #define GOT_PATH_PROG_READ_PACK \
  67         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PACK)
  68 #define GOT_PATH_PROG_READ_GITCONFIG \
  69         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_GITCONFIG)
  70 #define GOT_PATH_PROG_READ_GOTCONFIG \
  71         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_GOTCONFIG)
  72 #define GOT_PATH_PROG_READ_PATCH \
  73         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PATCH)
  74 #define GOT_PATH_PROG_FETCH_PACK \
  75         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_FETCH_PACK)
  76 #define GOT_PATH_PROG_SEND_PACK \
  77         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_SEND_PACK)
  78 #define GOT_PATH_PROG_INDEX_PACK \
  79         GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_INDEX_PACK)
  80
  81 enum got_imsg_type {
  82         /* An error occured while processing a request. */
  83         GOT_IMSG_ERROR,
  84
  85         /* Stop the child process. */
  86         GOT_IMSG_STOP,
  87
  88         /*
  89          * Messages concerned with read access to objects in a repository.
  90          * Object and pack files are opened by the main process, where
  91          * data may be read as a byte string but without any interpretation.
  92          * Decompression and parsing of object and pack files occurs in a
  93          * separate process which runs under pledge("stdio recvfd").
  94          * This sandboxes our own repository parsing code, as well as zlib.
  95          */
  96         GOT_IMSG_OBJECT_REQUEST,
  97         GOT_IMSG_OBJECT,
  98         GOT_IMSG_COMMIT_REQUEST,
  99         GOT_IMSG_COMMIT,
 100         GOT_IMSG_COMMIT_LOGMSG,
 101         GOT_IMSG_TREE_REQUEST,
 102         GOT_IMSG_TREE,
 103         GOT_IMSG_TREE_ENTRIES,
 104         GOT_IMSG_BLOB_REQUEST,
 105         GOT_IMSG_BLOB_OUTFD,
 106         GOT_IMSG_BLOB,
 107         GOT_IMSG_TAG_REQUEST,
 108         GOT_IMSG_TAG,
 109         GOT_IMSG_TAG_TAGMSG,
 110
 111         /* Messages related to networking. */
 112         GOT_IMSG_FETCH_REQUEST,
 113         GOT_IMSG_FETCH_HAVE_REF,
 114         GOT_IMSG_FETCH_WANTED_BRANCH,
 115         GOT_IMSG_FETCH_WANTED_REF,
 116         GOT_IMSG_FETCH_OUTFD,
 117         GOT_IMSG_FETCH_SYMREFS,
 118         GOT_IMSG_FETCH_REF,
 119         GOT_IMSG_FETCH_SERVER_PROGRESS,
 120         GOT_IMSG_FETCH_DOWNLOAD_PROGRESS,
 121         GOT_IMSG_FETCH_DONE,
 122         GOT_IMSG_IDXPACK_REQUEST,
 123         GOT_IMSG_IDXPACK_OUTFD,
 124         GOT_IMSG_IDXPACK_PROGRESS,
 125         GOT_IMSG_IDXPACK_DONE,
 126         GOT_IMSG_SEND_REQUEST,
 127         GOT_IMSG_SEND_REF,
 128         GOT_IMSG_SEND_REMOTE_REF,
 129         GOT_IMSG_SEND_REF_STATUS,
 130         GOT_IMSG_SEND_PACK_REQUEST,
 131         GOT_IMSG_SEND_PACKFD,
 132         GOT_IMSG_SEND_UPLOAD_PROGRESS,
 133         GOT_IMSG_SEND_DONE,
 134
 135         /* Messages related to pack files. */
 136         GOT_IMSG_PACKIDX,
 137         GOT_IMSG_PACK,
 138         GOT_IMSG_PACKED_OBJECT_REQUEST,
 139         GOT_IMSG_COMMIT_TRAVERSAL_REQUEST,
 140         GOT_IMSG_TRAVERSED_COMMITS,
 141         GOT_IMSG_COMMIT_TRAVERSAL_DONE,
 142         GOT_IMSG_OBJECT_ENUMERATION_REQUEST,
 143         GOT_IMSG_ENUMERATED_COMMIT,
 144         GOT_IMSG_ENUMERATED_TREE,
 145         GOT_IMSG_TREE_ENUMERATION_DONE,
 146         GOT_IMSG_OBJECT_ENUMERATION_DONE,
 147         GOT_IMSG_OBJECT_ENUMERATION_INCOMPLETE,
 148
 149         /* Message sending file descriptor to a temporary file. */
 150         GOT_IMSG_TMPFD,
 151
 152         /* Messages related to gitconfig files. */
 153         GOT_IMSG_GITCONFIG_PARSE_REQUEST,
 154         GOT_IMSG_GITCONFIG_REPOSITORY_FORMAT_VERSION_REQUEST,
 155         GOT_IMSG_GITCONFIG_REPOSITORY_EXTENSIONS_REQUEST,
 156         GOT_IMSG_GITCONFIG_AUTHOR_NAME_REQUEST,
 157         GOT_IMSG_GITCONFIG_AUTHOR_EMAIL_REQUEST,
 158         GOT_IMSG_GITCONFIG_REMOTES_REQUEST,
 159         GOT_IMSG_GITCONFIG_INT_VAL,
 160         GOT_IMSG_GITCONFIG_STR_VAL,
 161         GOT_IMSG_GITCONFIG_PAIR,
 162         GOT_IMSG_GITCONFIG_REMOTES,
 163         GOT_IMSG_GITCONFIG_REMOTE,
 164         GOT_IMSG_GITCONFIG_OWNER_REQUEST,
 165         GOT_IMSG_GITCONFIG_OWNER,
 166
 167         /* Messages related to gotconfig files. */
 168         GOT_IMSG_GOTCONFIG_PARSE_REQUEST,
 169         GOT_IMSG_GOTCONFIG_AUTHOR_REQUEST,
 170         GOT_IMSG_GOTCONFIG_ALLOWEDSIGNERS_REQUEST,
 171         GOT_IMSG_GOTCONFIG_REVOKEDSIGNERS_REQUEST,
 172         GOT_IMSG_GOTCONFIG_SIGNERID_REQUEST,
 173         GOT_IMSG_GOTCONFIG_REMOTES_REQUEST,
 174         GOT_IMSG_GOTCONFIG_INT_VAL,
 175         GOT_IMSG_GOTCONFIG_STR_VAL,
 176         GOT_IMSG_GOTCONFIG_REMOTES,
 177         GOT_IMSG_GOTCONFIG_REMOTE,
 178
 179         /* Raw object access. Uncompress object data but do not parse it. */
 180         GOT_IMSG_RAW_OBJECT_REQUEST,
 181         GOT_IMSG_RAW_OBJECT_OUTFD,
 182         GOT_IMSG_PACKED_RAW_OBJECT_REQUEST,
 183         GOT_IMSG_RAW_OBJECT,
 184
 185         /* Read raw delta data from pack files. */
 186         GOT_IMSG_RAW_DELTA_OUTFD,
 187         GOT_IMSG_RAW_DELTA_REQUEST,
 188         GOT_IMSG_RAW_DELTA,
 189
 190         /* Re-use deltas found in a pack file. */
 191         GOT_IMSG_DELTA_REUSE_REQUEST,
 192         GOT_IMSG_REUSED_DELTAS,
 193         GOT_IMSG_DELTA_REUSE_DONE,
 194
 195         /* Commit coloring in got-read-pack. */
 196         GOT_IMSG_COMMIT_PAINTING_INIT,
 197         GOT_IMSG_COMMIT_PAINTING_REQUEST,
 198         GOT_IMSG_PAINTED_COMMITS,
 199         GOT_IMSG_COMMIT_PAINTING_DONE,
 200
 201         /* Transfer a list of object IDs. */
 202         GOT_IMSG_OBJ_ID_LIST,
 203         GOT_IMSG_OBJ_ID_LIST_DONE,
 204
 205         /* Messages related to patch files. */
 206         GOT_IMSG_PATCH_FILE,
 207         GOT_IMSG_PATCH_HUNK,
 208         GOT_IMSG_PATCH_DONE,
 209         GOT_IMSG_PATCH_LINE,
 210         GOT_IMSG_PATCH,
 211         GOT_IMSG_PATCH_EOF,
 212 };
 213
 214 /* Structure for GOT_IMSG_ERROR. */
 215 struct got_imsg_error {
 216         int code; /* an error code from got_error.h */
 217         int errno_code; /* in case code equals GOT_ERR_ERRNO */
 218 } __attribute__((__packed__));
 219
 220 /*
 221  * Structure for GOT_IMSG_TREE_REQUEST and GOT_IMSG_OBJECT data.
 222  */
 223 struct got_imsg_object {
 224         struct got_object_id id;
 225
 226         /* These fields are the same as in struct got_object. */
 227         int type;
 228         int flags;
 229         size_t hdrlen;
 230         size_t size;
 231         off_t pack_offset;
 232         int pack_idx;
 233 }  __attribute__((__packed__));
 234
 235 /* Structure for GOT_IMSG_COMMIT data. */
 236 struct got_imsg_commit_object {
 237         struct got_object_id tree_id;
 238         size_t author_len;
 239         time_t author_time;
 240         time_t author_gmtoff;
 241         size_t committer_len;
 242         time_t committer_time;
 243         time_t committer_gmtoff;
 244         size_t logmsg_len;
 245         int nparents;
 246
 247         /*
 248          * Followed by author_len + committer_len data bytes
 249          */
 250
 251         /* Followed by 'nparents' struct got_object_id */
 252
 253         /*
 254          * Followed by 'logmsg_len' bytes of commit log message data in
 255          * one or more GOT_IMSG_COMMIT_LOGMSG messages.
 256          */
 257 } __attribute__((__packed__));
 258
 259 struct got_imsg_tree_entry {
 260         char id[SHA1_DIGEST_LENGTH];
 261         mode_t mode;
 262         size_t namelen;
 263         /* Followed by namelen bytes of entry's name, not NUL-terminated. */
 264 } __attribute__((__packed__));
 265
 266 /* Structure for GOT_IMSG_TREE_ENTRIES. */
 267 struct got_imsg_tree_entries {
 268         size_t nentries; /* Number of tree entries contained in this message. */
 269
 270         /* Followed by nentries * struct got_imsg_tree_entry */
 271 };
 272
 273 /* Structure for GOT_IMSG_TREE_OBJECT_REPLY data. */
 274 struct got_imsg_tree_object {
 275         int nentries; /* This many tree entries follow. */
 276 };
 277
 278 /* Structure for GOT_IMSG_BLOB. */
 279 struct got_imsg_blob {
 280         size_t size;
 281         size_t hdrlen;
 282
 283         /*
 284          * If size <= GOT_PRIVSEP_INLINE_BLOB_DATA_MAX, blob data follows
 285          * in the imsg buffer. Otherwise, blob data has been written to a
 286          * file descriptor passed via the GOT_IMSG_BLOB_OUTFD imsg.
 287          */
 288 #define GOT_PRIVSEP_INLINE_BLOB_DATA_MAX \
 289         (MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_blob))
 290 };
 291
 292 /* Structure for GOT_IMSG_RAW_OBJECT. */
 293 struct got_imsg_raw_obj {
 294         off_t size;
 295         size_t hdrlen;
 296
 297         /*
 298          * If size <= GOT_PRIVSEP_INLINE_OBJECT_DATA_MAX, object data follows
 299          * in the imsg buffer. Otherwise, object data has been written to a
 300          * file descriptor passed via the GOT_IMSG_RAW_OBJECT_OUTFD imsg.
 301          */
 302 #define GOT_PRIVSEP_INLINE_OBJECT_DATA_MAX \
 303         (MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_raw_obj))
 304 };
 305
 306 /* Structure for GOT_IMSG_RAW_DELTA. */
 307 struct got_imsg_raw_delta {
 308         struct got_object_id base_id;
 309         uint64_t base_size;
 310         uint64_t result_size;
 311         off_t delta_size;
 312         off_t delta_compressed_size;
 313         off_t delta_offset;
 314         off_t delta_out_offset;
 315
 316         /*
 317          * Delta data has been written at delta_out_offset to the file
 318          * descriptor passed via the GOT_IMSG_RAW_DELTA_OUTFD imsg.
 319          */
 320 };
 321
 322 /* Structures for GOT_IMSG_REUSED_DELTAS. */
 323 struct got_imsg_reused_delta {
 324         struct got_object_id id;
 325         struct got_object_id base_id;
 326         uint64_t base_size;
 327         uint64_t result_size;
 328         off_t delta_size;
 329         off_t delta_compressed_size;
 330         off_t delta_offset;
 331 };
 332 struct got_imsg_reused_deltas {
 333         size_t ndeltas;
 334
 335         /*
 336          * Followed by ndeltas * struct got_imsg_reused_delta.
 337          */
 338
 339 #define GOT_IMSG_REUSED_DELTAS_MAX_NDELTAS \
 340         ((MAX_IMSGSIZE - IMSG_HEADER_SIZE - \
 341         sizeof(struct got_imsg_reused_deltas)) \
 342         / sizeof(struct got_imsg_reused_delta))
 343 };
 344
 345 /* Structure for GOT_IMSG_COMMIT_PAINTING_REQUEST. */
 346 struct got_imsg_commit_painting_request {
 347         struct got_object_id id;
 348         int idx;
 349         int color;
 350 } __attribute__((__packed__));
 351
 352 /* Structure for GOT_IMSG_PAINTED_COMMITS. */
 353 struct got_imsg_painted_commit {
 354         uint8_t id[SHA1_DIGEST_LENGTH];
 355         intptr_t color;
 356 } __attribute__((__packed__));
 357
 358 struct got_imsg_painted_commits {
 359         int ncommits;
 360         int present_in_pack;
 361         /*
 362          * Followed by ncommits * struct got_imsg_painted_commit.
 363          */
 364 } __attribute__((__packed__));
 365
 366 /* Structure for GOT_IMSG_TAG data. */
 367 struct got_imsg_tag_object {
 368         struct got_object_id id;
 369         int obj_type;
 370         size_t tag_len;
 371         size_t tagger_len;
 372         time_t tagger_time;
 373         time_t tagger_gmtoff;
 374         size_t tagmsg_len;
 375
 376         /*
 377          * Followed by tag_len + tagger_len data bytes
 378          */
 379
 380         /*
 381          * Followed by 'tagmsg_len' bytes of tag message data in
 382          * one or more GOT_IMSG_TAG_TAGMSG messages.
 383          */
 384 } __attribute__((__packed__));
 385
 386 /* Structure for GOT_IMSG_FETCH_HAVE_REF data. */
 387 struct got_imsg_fetch_have_ref {
 388         struct got_object_id id;
 389         size_t name_len;
 390         /* Followed by name_len data bytes. */
 391 } __attribute__((__packed__));
 392
 393 /* Structure for GOT_IMSG_FETCH_WANTED_BRANCH data. */
 394 struct got_imsg_fetch_wanted_branch {
 395         size_t name_len;
 396         /* Followed by name_len data bytes. */
 397 } __attribute__((__packed__));
 398
 399 /* Structure for GOT_IMSG_FETCH_WANTED_REF data. */
 400 struct got_imsg_fetch_wanted_ref {
 401         size_t name_len;
 402         /* Followed by name_len data bytes. */
 403 } __attribute__((__packed__));
 404
 405 /* Structure for GOT_IMSG_FETCH_REQUEST data. */
 406 struct got_imsg_fetch_request {
 407         int no_head;
 408         int fetch_all_branches;
 409         int list_refs_only;
 410         int verbosity;
 411         size_t worktree_branch_len;
 412         size_t remote_head_len;
 413         size_t n_have_refs;
 414         size_t n_wanted_branches;
 415         size_t n_wanted_refs;
 416         /* Followed by worktree_branch_len bytes of reference name. */
 417         /* Followed by remote_head_len bytes of reference name. */
 418         /* Followed by n_have_refs GOT_IMSG_FETCH_HAVE_REF messages. */
 419         /* Followed by n_wanted_branches times GOT_IMSG_FETCH_WANTED_BRANCH. */
 420         /* Followed by n_wanted_refs times GOT_IMSG_FETCH_WANTED_REF. */
 421 } __attribute__((__packed__));
 422
 423 /* Structures for GOT_IMSG_FETCH_SYMREFS data. */
 424 struct got_imsg_fetch_symref {
 425         size_t name_len;
 426         size_t target_len;
 427
 428         /*
 429          * Followed by name_len + target_len data bytes.
 430          */
 431 } __attribute__((__packed__));
 432
 433 struct got_imsg_fetch_symrefs {
 434         size_t nsymrefs;
 435
 436         /* Followed by nsymrefs times of got_imsg_fetch_symref data. */
 437 } __attribute__((__packed__));
 438
 439 /* Structure for GOT_IMSG_FETCH_REF data. */
 440 struct got_imsg_fetch_ref {
 441         /* Describes a reference which will be fetched. */
 442         struct got_object_id refid;
 443         /* Followed by reference name in remaining data of imsg buffer. */
 444 };
 445
 446 /* Structure for GOT_IMSG_FETCH_DOWNLOAD_PROGRESS data. */
 447 struct got_imsg_fetch_download_progress {
 448         /* Number of packfile data bytes downloaded so far. */
 449         off_t packfile_bytes;
 450 };
 451
 452 /* Structure for GOT_IMSG_SEND_REQUEST data. */
 453 struct got_imsg_send_request {
 454         int verbosity;
 455         size_t nrefs;
 456         /* Followed by nrefs GOT_IMSG_SEND_REF messages. */
 457 } __attribute__((__packed__));
 458
 459 /* Structure for GOT_IMSG_SEND_UPLOAD_PROGRESS data. */
 460 struct got_imsg_send_upload_progress {
 461         /* Number of packfile data bytes uploaded so far. */
 462         off_t packfile_bytes;
 463 };
 464
 465 /* Structure for GOT_IMSG_SEND_REF data. */
 466 struct got_imsg_send_ref {
 467         struct got_object_id id;
 468         int delete;
 469         size_t name_len;
 470         /* Followed by name_len data bytes. */
 471 } __attribute__((__packed__));
 472
 473 /* Structure for GOT_IMSG_SEND_REMOTE_REF data. */
 474 struct got_imsg_send_remote_ref {
 475         struct got_object_id id;
 476         size_t name_len;
 477         /* Followed by name_len data bytes. */
 478 } __attribute__((__packed__));
 479
 480 /* Structure for GOT_IMSG_SEND_REF_STATUS data. */
 481 struct got_imsg_send_ref_status {
 482         int success;
 483         size_t name_len;
 484         size_t errmsg_len;
 485         /* Followed by name_len data bytes. */
 486         /* Followed by errmsg_len data bytes. */
 487 } __attribute__((__packed__));
 488
 489 /* Structure for GOT_IMSG_IDXPACK_REQUEST data. */
 490 struct got_imsg_index_pack_request {
 491         uint8_t pack_hash[SHA1_DIGEST_LENGTH];
 492 } __attribute__((__packed__));
 493
 494 /* Structure for GOT_IMSG_IDXPACK_PROGRESS data. */
 495 struct got_imsg_index_pack_progress {
 496         /* Total number of objects in pack file. */
 497         int nobj_total;
 498
 499         /* Number of objects indexed so far. */
 500         int nobj_indexed;
 501
 502         /* Number of non-deltified objects in pack file. */
 503         int nobj_loose;
 504
 505         /* Number of deltified objects resolved so far. */
 506         int nobj_resolved;
 507 };
 508
 509 /* Structure for GOT_IMSG_PACKIDX. */
 510 struct got_imsg_packidx {
 511         size_t len;
 512         off_t packfile_size;
 513         /* Additionally, a file desciptor is passed via imsg. */
 514 };
 515
 516 /* Structure for GOT_IMSG_PACK. */
 517 struct got_imsg_pack {
 518         char path_packfile[PATH_MAX];
 519         off_t filesize;
 520         /* Additionally, a file desciptor is passed via imsg. */
 521 } __attribute__((__packed__));
 522
 523 /*
 524  * Structure for GOT_IMSG_OBJECT_REQUEST, GOT_IMSG_BLOB_REQUEST,
 525  * GOT_IMSG_TREE_REQUEST, GOT_IMSG_COMMIT_REQUEST, and
 526  * GOT_IMSG_TAG_REQUEST data.
 527  */
 528 struct got_object_id;
 529
 530 /*
 531  * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST and
 532  * GOT_IMSG_PACKED_RAW_OBJECT_REQUEST data.
 533  */
 534 struct got_imsg_packed_object {
 535         struct got_object_id id;
 536         int idx;
 537 } __attribute__((__packed__));
 538
 539 /*
 540  * Structure for GOT_IMSG_DELTA data.
 541  */
 542 struct got_imsg_delta {
 543         /* These fields are the same as in struct got_delta. */
 544         off_t offset;
 545         size_t tslen;
 546         int type;
 547         size_t size;
 548         off_t data_offset;
 549 };
 550
 551 /*
 552  * Structure for GOT_IMSG_RAW_DELTA_REQUEST data.
 553  */
 554 struct got_imsg_raw_delta_request {
 555         struct got_object_id id;
 556         int idx;
 557 };
 558
 559 /*
 560  * Structure for GOT_IMSG_OBJ_ID_LIST data.
 561  * Multiple such messages may be sent back-to-back, where each message
 562  * contains a chunk of IDs. The entire list must be terminated with a
 563  * GOT_IMSG_OBJ_ID_LIST_DONE message.
 564  */
 565 struct got_imsg_object_idlist {
 566         size_t nids;
 567
 568         /*
 569          * Followed by nids * struct got_object_id.
 570          */
 571
 572 #define GOT_IMSG_OBJ_ID_LIST_MAX_NIDS \
 573         ((MAX_IMSGSIZE - IMSG_HEADER_SIZE - \
 574         sizeof(struct got_imsg_object_idlist)) / sizeof(struct got_object_id))
 575 };
 576
 577 /* Structure for GOT_IMSG_COMMIT_TRAVERSAL_REQUEST  */
 578 struct got_imsg_commit_traversal_request {
 579         struct got_imsg_packed_object iobj;
 580         size_t path_len;
 581         /* Followed by path_len bytes of path data */
 582 } __attribute__((__packed__));
 583
 584 /* Structure for GOT_IMSG_TRAVERSED_COMMITS  */
 585 struct got_imsg_traversed_commits {
 586         size_t ncommits;
 587         /* Followed by ncommit struct got_object_id */
 588 } __attribute__((__packed__));
 589
 590 /* Structure for GOT_IMSG_ENUMERATED_COMMIT  */
 591 struct got_imsg_enumerated_commit {
 592         uint8_t id[SHA1_DIGEST_LENGTH];
 593         time_t mtime;
 594 } __attribute__((__packed__));
 595
 596 /* Structure for GOT_IMSG_ENUMERATED_TREE */
 597 struct got_imsg_enumerated_tree {
 598         uint8_t id[SHA1_DIGEST_LENGTH]; /* tree ID */
 599         int nentries;                   /* number of tree entries */
 600
 601         /* Followed by tree's path in remaining data of imsg buffer. */
 602
 603         /* Followed by nentries * GOT_IMSG_TREE_ENTRY messages. */
 604 } __attribute__((__packed__));
 605
 606 /*
 607  * Structure for GOT_IMSG_GOTCONFIG_REMOTE and
 608  * GOT_IMSG_GOTCONFIG_REMOTE data.
 609  */
 610 struct got_imsg_remote {
 611         size_t name_len;
 612         size_t fetch_url_len;
 613         size_t send_url_len;
 614         int mirror_references;
 615         int fetch_all_branches;
 616         int nfetch_branches;
 617         int nsend_branches;
 618         int nfetch_refs;
 619
 620         /* Followed by name_len data bytes. */
 621         /* Followed by fetch_url_len + send_url_len data bytes. */
 622         /* Followed by nfetch_branches GOT_IMSG_GITCONFIG_STR_VAL messages. */
 623         /* Followed by nsend_branches GOT_IMSG_GITCONFIG_STR_VAL messages. */
 624         /* Followed by nfetch_refs GOT_IMSG_GITCONFIG_STR_VAL messages. */
 625 } __attribute__((__packed__));
 626
 627 /*
 628  * Structure for GOT_IMSG_GITCONFIG_REMOTES data.
 629  */
 630 struct got_imsg_remotes {
 631         int nremotes; /* This many GOT_IMSG_GITCONFIG_REMOTE messages follow. */
 632 };
 633
 634 /*
 635  * Structure for GOT_IMSG_GITCONFIG_PAIR.
 636  */
 637 struct got_imsg_gitconfig_pair {
 638         size_t  klen;
 639         size_t  vlen;
 640         /* Followed by klen data bytes of key string. */
 641         /* Followed by vlen data bytes of value string. */
 642 };
 643
 644 /*
 645  * Structure for GOT_IMSG_PATCH data.
 646  */
 647 struct got_imsg_patch {
 648         int     git;
 649         int     xbit;
 650         char    old[PATH_MAX];
 651         char    new[PATH_MAX];
 652         char    cid[41];
 653         char    blob[41];
 654 };
 655
 656 /*
 657  * Structure for GOT_IMSG_PATCH_HUNK data.
 658  */
 659 struct got_imsg_patch_hunk {
 660         int     oldfrom;
 661         int     oldlines;
 662         int     newfrom;
 663         int     newlines;
 664 };
 665
 666 struct got_remote_repo;
 667 struct got_pack;
 668 struct got_packidx;
 669 struct got_pathlist_head;
 670
 671 const struct got_error *got_send_ack(pid_t);
 672 const struct got_error *got_privsep_wait_for_child(pid_t);
 673 const struct got_error *got_privsep_flush_imsg(struct imsgbuf *);
 674 const struct got_error *got_privsep_send_stop(int);
 675 const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,
 676     size_t);
 677 void got_privsep_send_error(struct imsgbuf *, const struct got_error *);
 678 const struct got_error *got_privsep_send_ack(struct imsgbuf *);
 679 const struct got_error *got_privsep_wait_ack(struct imsgbuf *);
 680 const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int,
 681     struct got_object_id *);
 682 const struct got_error *got_privsep_send_raw_obj_req(struct imsgbuf *, int,
 683     struct got_object_id *);
 684 const struct got_error *got_privsep_send_raw_obj_outfd(struct imsgbuf *, int);
 685 const struct got_error *got_privsep_send_commit_req(struct imsgbuf *, int,
 686     struct got_object_id *, int);
 687 const struct got_error *got_privsep_send_tree_req(struct imsgbuf *, int,
 688     struct got_object_id *, int);
 689 const struct got_error *got_privsep_send_tag_req(struct imsgbuf *, int,
 690     struct got_object_id *, int);
 691 const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int,
 692     struct got_object_id *, int);
 693 const struct got_error *got_privsep_send_blob_outfd(struct imsgbuf *, int);
 694 const struct got_error *got_privsep_send_tmpfd(struct imsgbuf *, int);
 695 const struct got_error *got_privsep_send_obj(struct imsgbuf *,
 696     struct got_object *);
 697 const struct got_error *got_privsep_send_index_pack_req(struct imsgbuf *,
 698     uint8_t *, int);
 699 const struct got_error *got_privsep_send_index_pack_outfd(struct imsgbuf *,
 700     int);
 701 const struct got_error *got_privsep_recv_index_progress(int *, int *, int *,
 702     int *, int *, struct imsgbuf *ibuf);
 703 const struct got_error *got_privsep_send_fetch_req(struct imsgbuf *, int,
 704     struct got_pathlist_head *, int, struct got_pathlist_head *,
 705     struct got_pathlist_head *, int, const char *, const char *, int, int);
 706 const struct got_error *got_privsep_send_fetch_outfd(struct imsgbuf *, int);
 707 const struct got_error *got_privsep_recv_fetch_progress(int *,
 708     struct got_object_id **, char **, struct got_pathlist_head *, char **,
 709     off_t *, uint8_t *, struct imsgbuf *);
 710 const struct got_error *got_privsep_send_send_req(struct imsgbuf *, int,
 711     struct got_pathlist_head *, struct got_pathlist_head *, int);
 712 const struct got_error *got_privsep_recv_send_remote_refs(
 713     struct got_pathlist_head *, struct imsgbuf *);
 714 const struct got_error *got_privsep_send_packfd(struct imsgbuf *, int);
 715 const struct got_error *got_privsep_recv_send_progress(int *, off_t *,
 716     int *, char **, char **, struct imsgbuf *);
 717 const struct got_error *got_privsep_get_imsg_obj(struct got_object **,
 718     struct imsg *, struct imsgbuf *);
 719 const struct got_error *got_privsep_recv_obj(struct got_object **,
 720     struct imsgbuf *);
 721 const struct got_error *got_privsep_send_raw_obj(struct imsgbuf *, off_t,
 722     size_t, uint8_t *);
 723 const struct got_error *got_privsep_recv_raw_obj(uint8_t **, off_t *, size_t *,
 724     struct imsgbuf *);
 725 const struct got_error *got_privsep_send_commit(struct imsgbuf *,
 726     struct got_commit_object *);
 727 const struct got_error *got_privsep_recv_commit(struct got_commit_object **,
 728     struct imsgbuf *);
 729 const struct got_error *got_privsep_recv_tree(struct got_tree_object **,
 730     struct imsgbuf *);
 731 struct got_parsed_tree_entry;
 732 const struct got_error *got_privsep_send_tree(struct imsgbuf *,
 733     struct got_parsed_tree_entry *, int);
 734 const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t, size_t,
 735     const uint8_t *);
 736 const struct got_error *got_privsep_recv_blob(uint8_t **, size_t *, size_t *,
 737     struct imsgbuf *);
 738 const struct got_error *got_privsep_send_tag(struct imsgbuf *,
 739     struct got_tag_object *);
 740 const struct got_error *got_privsep_recv_tag(struct got_tag_object **,
 741     struct imsgbuf *);
 742 const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,
 743     struct got_pack *, struct got_packidx *);
 744 const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int,
 745     struct got_object_id *);
 746 const struct got_error *got_privsep_send_packed_raw_obj_req(struct imsgbuf *,
 747     int, struct got_object_id *);
 748 const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);
 749
 750 const struct got_error *got_privsep_send_gitconfig_parse_req(struct imsgbuf *,
 751     int);
 752 const struct got_error *
 753     got_privsep_send_gitconfig_repository_format_version_req(struct imsgbuf *);
 754 const struct got_error *got_privsep_send_gitconfig_repository_extensions_req(
 755     struct imsgbuf *);
 756 const struct got_error *got_privsep_send_gitconfig_author_name_req(
 757     struct imsgbuf *);
 758 const struct got_error *got_privsep_send_gitconfig_author_email_req(
 759     struct imsgbuf *);
 760 const struct got_error *got_privsep_send_gitconfig_remotes_req(
 761     struct imsgbuf *);
 762 const struct got_error *got_privsep_send_gitconfig_owner_req(struct imsgbuf *);
 763 const struct got_error *got_privsep_recv_gitconfig_str(char **,
 764     struct imsgbuf *);
 765 const struct got_error *got_privsep_recv_gitconfig_pair(char **, char **,
 766     struct imsgbuf *);
 767 const struct got_error *got_privsep_recv_gitconfig_int(int *, struct imsgbuf *);
 768 const struct got_error *got_privsep_recv_gitconfig_remotes(
 769     struct got_remote_repo **, int *, struct imsgbuf *);
 770
 771 const struct got_error *got_privsep_send_gotconfig_parse_req(struct imsgbuf *,
 772     int);
 773 const struct got_error *got_privsep_send_gotconfig_author_req(struct imsgbuf *);
 774 const struct got_error *got_privsep_send_gotconfig_allowed_signers_req(
 775     struct imsgbuf *);
 776 const struct got_error *got_privsep_send_gotconfig_revoked_signers_req(
 777     struct imsgbuf *);
 778 const struct got_error *got_privsep_send_gotconfig_signer_id_req(
 779     struct imsgbuf *);
 780 const struct got_error *got_privsep_send_gotconfig_remotes_req(
 781     struct imsgbuf *);
 782 const struct got_error *got_privsep_recv_gotconfig_str(char **,
 783     struct imsgbuf *);
 784 const struct got_error *got_privsep_recv_gotconfig_remotes(
 785     struct got_remote_repo **, int *, struct imsgbuf *);
 786
 787 const struct got_error *got_privsep_send_commit_traversal_request(
 788     struct imsgbuf *, struct got_object_id *, int, const char *);
 789 const struct got_error *got_privsep_recv_traversed_commits(
 790     struct got_commit_object **, struct got_object_id **,
 791     struct got_object_id_queue *, struct imsgbuf *);
 792 const struct got_error *got_privsep_send_enumerated_tree(size_t *,
 793     struct imsgbuf *, struct got_object_id *, const char *,
 794     struct got_parsed_tree_entry *, int);
 795 const struct got_error *got_privsep_send_object_enumeration_request(
 796     struct imsgbuf *);
 797 const struct got_error *got_privsep_send_object_enumeration_done(
 798     struct imsgbuf *);
 799 const struct got_error *got_privsep_send_object_enumeration_incomplete(
 800     struct imsgbuf *);
 801 const struct got_error *got_privsep_send_enumerated_commit(struct imsgbuf *,
 802     struct got_object_id *, time_t);
 803 const struct got_error *got_privsep_recv_enumerated_objects(int *,
 804     struct imsgbuf *, got_object_enumerate_commit_cb,
 805     got_object_enumerate_tree_cb, void *, struct got_repository *);
 806
 807 const struct got_error *got_privsep_send_raw_delta_req(struct imsgbuf *, int,
 808     struct got_object_id *);
 809 const struct got_error *got_privsep_send_raw_delta_outfd(struct imsgbuf *, int);
 810 const struct got_error *got_privsep_send_raw_delta(struct imsgbuf *, uint64_t,
 811     uint64_t,  off_t, off_t, off_t, off_t, struct got_object_id *);
 812 const struct got_error *got_privsep_recv_raw_delta(uint64_t *, uint64_t *,
 813     off_t *, off_t *, off_t *, off_t *, struct got_object_id **,
 814     struct imsgbuf *);
 815
 816 const struct got_error *got_privsep_send_object_idlist(struct imsgbuf *,
 817     struct got_object_id **, size_t);
 818 const struct got_error *got_privsep_send_object_idlist_done(struct imsgbuf *);
 819 const struct got_error *got_privsep_recv_object_idlist(int *,
 820     struct got_object_id **, size_t *, struct imsgbuf *);
 821
 822 const struct got_error *got_privsep_send_delta_reuse_req(struct imsgbuf *);
 823 const struct got_error *got_privsep_send_reused_deltas(struct imsgbuf *,
 824     struct got_imsg_reused_delta *, size_t);
 825 const struct got_error *got_privsep_send_reused_deltas_done(struct imsgbuf *);
 826 const struct got_error *got_privsep_recv_reused_deltas(int *,
 827     struct got_imsg_reused_delta *, size_t *, struct imsgbuf *);
 828
 829 const struct got_error *got_privsep_init_commit_painting(struct imsgbuf *);
 830 const struct got_error *got_privsep_send_painting_request(struct imsgbuf *,
 831     int, struct got_object_id *, intptr_t);
 832 typedef const struct got_error *(*got_privsep_recv_painted_commit_cb)(void *,
 833     struct got_object_id *, intptr_t);
 834 const struct got_error *got_privsep_send_painted_commits(struct imsgbuf *,
 835     struct got_object_id_queue *, int *, int, int);
 836 const struct got_error *got_privsep_send_painting_commits_done(struct imsgbuf *);
 837 const struct got_error *got_privsep_recv_painted_commits(
 838     struct got_object_id_queue *, got_privsep_recv_painted_commit_cb, void *,
 839     struct imsgbuf *);
 840
 841 void got_privsep_exec_child(int[2], const char *, const char *);