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/libexec
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 	uint8_t id[SHA1_DIGEST_LENGTH];
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 	uint8_t id[SHA1_DIGEST_LENGTH];
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 n_have_refs;
413 	size_t n_wanted_branches;
414 	size_t n_wanted_refs;
415 	/* Followed by worktree_branch_len bytes of reference name. */
416 	/* Followed by n_have_refs GOT_IMSG_FETCH_HAVE_REF messages. */
417 	/* Followed by n_wanted_branches times GOT_IMSG_FETCH_WANTED_BRANCH. */
418 	/* Followed by n_wanted_refs times GOT_IMSG_FETCH_WANTED_REF. */
419 } __attribute__((__packed__));
420 
421 /* Structures for GOT_IMSG_FETCH_SYMREFS data. */
422 struct got_imsg_fetch_symref {
423 	size_t name_len;
424 	size_t target_len;
425 
426 	/*
427 	 * Followed by name_len + target_len data bytes.
428 	 */
429 } __attribute__((__packed__));
430 
431 struct got_imsg_fetch_symrefs {
432 	size_t nsymrefs;
433 
434 	/* Followed by nsymrefs times of got_imsg_fetch_symref data. */
435 } __attribute__((__packed__));
436 
437 /* Structure for GOT_IMSG_FETCH_REF data. */
438 struct got_imsg_fetch_ref {
439 	/* Describes a reference which will be fetched. */
440 	struct got_object_id refid;
441 	/* Followed by reference name in remaining data of imsg buffer. */
442 };
443 
444 /* Structure for GOT_IMSG_FETCH_DOWNLOAD_PROGRESS data. */
445 struct got_imsg_fetch_download_progress {
446 	/* Number of packfile data bytes downloaded so far. */
447 	off_t packfile_bytes;
448 };
449 
450 /* Structure for GOT_IMSG_SEND_REQUEST data. */
451 struct got_imsg_send_request {
452 	int verbosity;
453 	size_t nrefs;
454 	/* Followed by nrefs GOT_IMSG_SEND_REF messages. */
455 } __attribute__((__packed__));
456 
457 /* Structure for GOT_IMSG_SEND_UPLOAD_PROGRESS data. */
458 struct got_imsg_send_upload_progress {
459 	/* Number of packfile data bytes uploaded so far. */
460 	off_t packfile_bytes;
461 };
462 
463 /* Structure for GOT_IMSG_SEND_REF data. */
464 struct got_imsg_send_ref {
465 	struct got_object_id id;
466 	int delete;
467 	size_t name_len;
468 	/* Followed by name_len data bytes. */
469 } __attribute__((__packed__));
470 
471 /* Structure for GOT_IMSG_SEND_REMOTE_REF data. */
472 struct got_imsg_send_remote_ref {
473 	struct got_object_id id;
474 	size_t name_len;
475 	/* Followed by name_len data bytes. */
476 } __attribute__((__packed__));
477 
478 /* Structure for GOT_IMSG_SEND_REF_STATUS data. */
479 struct got_imsg_send_ref_status {
480 	int success;
481 	size_t name_len;
482 	size_t errmsg_len;
483 	/* Followed by name_len data bytes. */
484 	/* Followed by errmsg_len data bytes. */
485 } __attribute__((__packed__));
486 
487 /* Structure for GOT_IMSG_IDXPACK_REQUEST data. */
488 struct got_imsg_index_pack_request {
489 	uint8_t pack_hash[SHA1_DIGEST_LENGTH];
490 } __attribute__((__packed__));
491 
492 /* Structure for GOT_IMSG_IDXPACK_PROGRESS data. */
493 struct got_imsg_index_pack_progress {
494 	/* Total number of objects in pack file. */
495 	int nobj_total;
496 
497 	/* Number of objects indexed so far. */
498 	int nobj_indexed;
499 
500 	/* Number of non-deltified objects in pack file. */
501 	int nobj_loose;
502 
503 	/* Number of deltified objects resolved so far. */
504 	int nobj_resolved;
505 };
506 
507 /* Structure for GOT_IMSG_PACKIDX. */
508 struct got_imsg_packidx {
509 	size_t len;
510 	off_t packfile_size;
511 	/* Additionally, a file desciptor is passed via imsg. */
512 };
513 
514 /* Structure for GOT_IMSG_PACK. */
515 struct got_imsg_pack {
516 	char path_packfile[PATH_MAX];
517 	off_t filesize;
518 	/* Additionally, a file desciptor is passed via imsg. */
519 } __attribute__((__packed__));
520 
521 /*
522  * Structure for GOT_IMSG_OBJECT_REQUEST, GOT_IMSG_BLOB_REQUEST,
523  * GOT_IMSG_TREE_REQUEST, GOT_IMSG_COMMIT_REQUEST, and
524  * GOT_IMSG_TAG_REQUEST data.
525  */
526 struct got_object_id;
527 
528 /*
529  * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST and
530  * GOT_IMSG_PACKED_RAW_OBJECT_REQUEST data.
531  */
532 struct got_imsg_packed_object {
533 	struct got_object_id id;
534 	int idx;
535 } __attribute__((__packed__));
536 
537 /*
538  * Structure for GOT_IMSG_DELTA data.
539  */
540 struct got_imsg_delta {
541 	/* These fields are the same as in struct got_delta. */
542 	off_t offset;
543 	size_t tslen;
544 	int type;
545 	size_t size;
546 	off_t data_offset;
547 };
548 
549 /*
550  * Structure for GOT_IMSG_RAW_DELTA_REQUEST data.
551  */
552 struct got_imsg_raw_delta_request {
553 	struct got_object_id id;
554 	int idx;
555 };
556 
557 /*
558  * Structure for GOT_IMSG_OBJ_ID_LIST data.
559  * Multiple such messages may be sent back-to-back, where each message
560  * contains a chunk of IDs. The entire list must be terminated with a
561  * GOT_IMSG_OBJ_ID_LIST_DONE message.
562  */
563 struct got_imsg_object_idlist {
564 	size_t nids;
565 
566 	/*
567 	 * Followed by nids * struct got_object_id.
568 	 */
569 
570 #define GOT_IMSG_OBJ_ID_LIST_MAX_NIDS \
571 	((MAX_IMSGSIZE - IMSG_HEADER_SIZE - \
572 	sizeof(struct got_imsg_object_idlist)) / sizeof(struct got_object_id))
573 };
574 
575 /* Structure for GOT_IMSG_COMMIT_TRAVERSAL_REQUEST  */
576 struct got_imsg_commit_traversal_request {
577 	uint8_t id[SHA1_DIGEST_LENGTH];
578 	int idx;
579 	size_t path_len;
580 	/* Followed by path_len bytes of path data */
581 } __attribute__((__packed__));
582 
583 /* Structure for GOT_IMSG_TRAVERSED_COMMITS  */
584 struct got_imsg_traversed_commits {
585 	size_t ncommits;
586 	/* Followed by ncommit IDs of SHA1_DIGEST_LENGTH each */
587 } __attribute__((__packed__));
588 
589 /* Structure for GOT_IMSG_ENUMERATED_COMMIT  */
590 struct got_imsg_enumerated_commit {
591 	uint8_t id[SHA1_DIGEST_LENGTH];
592 	time_t mtime;
593 } __attribute__((__packed__));
594 
595 /* Structure for GOT_IMSG_ENUMERATED_TREE */
596 struct got_imsg_enumerated_tree {
597 	uint8_t id[SHA1_DIGEST_LENGTH]; /* tree ID */
598 	int nentries;			/* number of tree entries */
599 
600 	/* Followed by tree's path in remaining data of imsg buffer. */
601 
602 	/* Followed by nentries * GOT_IMSG_TREE_ENTRY messages. */
603 } __attribute__((__packed__));
604 
605 /*
606  * Structure for GOT_IMSG_GOTCONFIG_REMOTE and
607  * GOT_IMSG_GOTCONFIG_REMOTE data.
608  */
609 struct got_imsg_remote {
610 	size_t name_len;
611 	size_t fetch_url_len;
612 	size_t send_url_len;
613 	int mirror_references;
614 	int fetch_all_branches;
615 	int nfetch_branches;
616 	int nsend_branches;
617 	int nfetch_refs;
618 
619 	/* Followed by name_len data bytes. */
620 	/* Followed by fetch_url_len + send_url_len data bytes. */
621 	/* Followed by nfetch_branches GOT_IMSG_GITCONFIG_STR_VAL messages. */
622 	/* Followed by nsend_branches GOT_IMSG_GITCONFIG_STR_VAL messages. */
623 	/* Followed by nfetch_refs GOT_IMSG_GITCONFIG_STR_VAL messages. */
624 } __attribute__((__packed__));
625 
626 /*
627  * Structure for GOT_IMSG_GITCONFIG_REMOTES data.
628  */
629 struct got_imsg_remotes {
630 	int nremotes; /* This many GOT_IMSG_GITCONFIG_REMOTE messages follow. */
631 };
632 
633 /*
634  * Structure for GOT_IMSG_GITCONFIG_PAIR.
635  */
636 struct got_imsg_gitconfig_pair {
637 	size_t	klen;
638 	size_t	vlen;
639 	/* Followed by klen data bytes of key string. */
640 	/* Followed by vlen data bytes of value string. */
641 };
642 
643 /*
644  * Structure for GOT_IMSG_PATCH data.
645  */
646 struct got_imsg_patch {
647 	int	git;
648 	int	xbit;
649 	char	old[PATH_MAX];
650 	char	new[PATH_MAX];
651 	char	cid[41];
652 	char	blob[41];
653 };
654 
655 /*
656  * Structure for GOT_IMSG_PATCH_HUNK data.
657  */
658 struct got_imsg_patch_hunk {
659 	int	oldfrom;
660 	int	oldlines;
661 	int	newfrom;
662 	int	newlines;
663 };
664 
665 struct got_remote_repo;
666 struct got_pack;
667 struct got_packidx;
668 struct got_pathlist_head;
669 
670 const struct got_error *got_send_ack(pid_t);
671 const struct got_error *got_privsep_wait_for_child(pid_t);
672 const struct got_error *got_privsep_flush_imsg(struct imsgbuf *);
673 const struct got_error *got_privsep_send_stop(int);
674 const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,
675     size_t);
676 void got_privsep_send_error(struct imsgbuf *, const struct got_error *);
677 const struct got_error *got_privsep_send_ack(struct imsgbuf *);
678 const struct got_error *got_privsep_wait_ack(struct imsgbuf *);
679 const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int,
680     struct got_object_id *);
681 const struct got_error *got_privsep_send_raw_obj_req(struct imsgbuf *, int,
682     struct got_object_id *);
683 const struct got_error *got_privsep_send_raw_obj_outfd(struct imsgbuf *, int);
684 const struct got_error *got_privsep_send_commit_req(struct imsgbuf *, int,
685     struct got_object_id *, int);
686 const struct got_error *got_privsep_send_tree_req(struct imsgbuf *, int,
687     struct got_object_id *, int);
688 const struct got_error *got_privsep_send_tag_req(struct imsgbuf *, int,
689     struct got_object_id *, int);
690 const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int,
691     struct got_object_id *, int);
692 const struct got_error *got_privsep_send_blob_outfd(struct imsgbuf *, int);
693 const struct got_error *got_privsep_send_tmpfd(struct imsgbuf *, int);
694 const struct got_error *got_privsep_send_obj(struct imsgbuf *,
695     struct got_object *);
696 const struct got_error *got_privsep_send_index_pack_req(struct imsgbuf *,
697     uint8_t *, int);
698 const struct got_error *got_privsep_send_index_pack_outfd(struct imsgbuf *,
699     int);
700 const struct got_error *got_privsep_recv_index_progress(int *, int *, int *,
701     int *, int *, struct imsgbuf *ibuf);
702 const struct got_error *got_privsep_send_fetch_req(struct imsgbuf *, int,
703     struct got_pathlist_head *, int, struct got_pathlist_head *,
704     struct got_pathlist_head *, int, const char *, int, int);
705 const struct got_error *got_privsep_send_fetch_outfd(struct imsgbuf *, int);
706 const struct got_error *got_privsep_recv_fetch_progress(int *,
707     struct got_object_id **, char **, struct got_pathlist_head *, char **,
708     off_t *, uint8_t *, struct imsgbuf *);
709 const struct got_error *got_privsep_send_send_req(struct imsgbuf *, int,
710     struct got_pathlist_head *, struct got_pathlist_head *, int);
711 const struct got_error *got_privsep_recv_send_remote_refs(
712     struct got_pathlist_head *, struct imsgbuf *);
713 const struct got_error *got_privsep_send_packfd(struct imsgbuf *, int);
714 const struct got_error *got_privsep_recv_send_progress(int *, off_t *,
715     int *, char **, char **, struct imsgbuf *);
716 const struct got_error *got_privsep_get_imsg_obj(struct got_object **,
717     struct imsg *, struct imsgbuf *);
718 const struct got_error *got_privsep_recv_obj(struct got_object **,
719     struct imsgbuf *);
720 const struct got_error *got_privsep_send_raw_obj(struct imsgbuf *, off_t,
721     size_t, uint8_t *);
722 const struct got_error *got_privsep_recv_raw_obj(uint8_t **, off_t *, size_t *,
723     struct imsgbuf *);
724 const struct got_error *got_privsep_send_commit(struct imsgbuf *,
725     struct got_commit_object *);
726 const struct got_error *got_privsep_recv_commit(struct got_commit_object **,
727     struct imsgbuf *);
728 const struct got_error *got_privsep_recv_tree(struct got_tree_object **,
729     struct imsgbuf *);
730 struct got_parsed_tree_entry;
731 const struct got_error *got_privsep_send_tree(struct imsgbuf *,
732     struct got_parsed_tree_entry *, int);
733 const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t, size_t,
734     const uint8_t *);
735 const struct got_error *got_privsep_recv_blob(uint8_t **, size_t *, size_t *,
736     struct imsgbuf *);
737 const struct got_error *got_privsep_send_tag(struct imsgbuf *,
738     struct got_tag_object *);
739 const struct got_error *got_privsep_recv_tag(struct got_tag_object **,
740     struct imsgbuf *);
741 const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,
742     struct got_pack *, struct got_packidx *);
743 const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int,
744     struct got_object_id *);
745 const struct got_error *got_privsep_send_packed_raw_obj_req(struct imsgbuf *,
746     int, struct got_object_id *);
747 const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);
748 
749 const struct got_error *got_privsep_send_gitconfig_parse_req(struct imsgbuf *,
750     int);
751 const struct got_error *
752     got_privsep_send_gitconfig_repository_format_version_req(struct imsgbuf *);
753 const struct got_error *got_privsep_send_gitconfig_repository_extensions_req(
754     struct imsgbuf *);
755 const struct got_error *got_privsep_send_gitconfig_author_name_req(
756     struct imsgbuf *);
757 const struct got_error *got_privsep_send_gitconfig_author_email_req(
758     struct imsgbuf *);
759 const struct got_error *got_privsep_send_gitconfig_remotes_req(
760     struct imsgbuf *);
761 const struct got_error *got_privsep_send_gitconfig_owner_req(struct imsgbuf *);
762 const struct got_error *got_privsep_recv_gitconfig_str(char **,
763     struct imsgbuf *);
764 const struct got_error *got_privsep_recv_gitconfig_pair(char **, char **,
765     struct imsgbuf *);
766 const struct got_error *got_privsep_recv_gitconfig_int(int *, struct imsgbuf *);
767 const struct got_error *got_privsep_recv_gitconfig_remotes(
768     struct got_remote_repo **, int *, struct imsgbuf *);
769 
770 const struct got_error *got_privsep_send_gotconfig_parse_req(struct imsgbuf *,
771     int);
772 const struct got_error *got_privsep_send_gotconfig_author_req(struct imsgbuf *);
773 const struct got_error *got_privsep_send_gotconfig_allowed_signers_req(
774     struct imsgbuf *);
775 const struct got_error *got_privsep_send_gotconfig_revoked_signers_req(
776     struct imsgbuf *);
777 const struct got_error *got_privsep_send_gotconfig_signer_id_req(
778     struct imsgbuf *);
779 const struct got_error *got_privsep_send_gotconfig_remotes_req(
780     struct imsgbuf *);
781 const struct got_error *got_privsep_recv_gotconfig_str(char **,
782     struct imsgbuf *);
783 const struct got_error *got_privsep_recv_gotconfig_remotes(
784     struct got_remote_repo **, int *, struct imsgbuf *);
785 
786 const struct got_error *got_privsep_send_commit_traversal_request(
787     struct imsgbuf *, struct got_object_id *, int, const char *);
788 const struct got_error *got_privsep_recv_traversed_commits(
789     struct got_commit_object **, struct got_object_id **,
790     struct got_object_id_queue *, struct imsgbuf *);
791 const struct got_error *got_privsep_send_enumerated_tree(size_t *,
792     struct imsgbuf *, struct got_object_id *, const char *,
793     struct got_parsed_tree_entry *, int);
794 const struct got_error *got_privsep_send_object_enumeration_request(
795     struct imsgbuf *);
796 const struct got_error *got_privsep_send_object_enumeration_done(
797     struct imsgbuf *);
798 const struct got_error *got_privsep_send_object_enumeration_incomplete(
799     struct imsgbuf *);
800 const struct got_error *got_privsep_send_enumerated_commit(struct imsgbuf *,
801     struct got_object_id *, time_t);
802 const struct got_error *got_privsep_recv_enumerated_objects(int *,
803     struct imsgbuf *, got_object_enumerate_commit_cb,
804     got_object_enumerate_tree_cb, void *, struct got_repository *);
805 
806 const struct got_error *got_privsep_send_raw_delta_req(struct imsgbuf *, int,
807     struct got_object_id *);
808 const struct got_error *got_privsep_send_raw_delta_outfd(struct imsgbuf *, int);
809 const struct got_error *got_privsep_send_raw_delta(struct imsgbuf *, uint64_t,
810     uint64_t,  off_t, off_t, off_t, off_t, struct got_object_id *);
811 const struct got_error *got_privsep_recv_raw_delta(uint64_t *, uint64_t *,
812     off_t *, off_t *, off_t *, off_t *, struct got_object_id **,
813     struct imsgbuf *);
814 
815 const struct got_error *got_privsep_send_object_idlist(struct imsgbuf *,
816     struct got_object_id **, size_t);
817 const struct got_error *got_privsep_send_object_idlist_done(struct imsgbuf *);
818 const struct got_error *got_privsep_recv_object_idlist(int *,
819     struct got_object_id **, size_t *, struct imsgbuf *);
820 
821 const struct got_error *got_privsep_send_delta_reuse_req(struct imsgbuf *);
822 const struct got_error *got_privsep_send_reused_deltas(struct imsgbuf *,
823     struct got_imsg_reused_delta *, size_t);
824 const struct got_error *got_privsep_send_reused_deltas_done(struct imsgbuf *);
825 const struct got_error *got_privsep_recv_reused_deltas(int *,
826     struct got_imsg_reused_delta *, size_t *, struct imsgbuf *);
827 
828 const struct got_error *got_privsep_init_commit_painting(struct imsgbuf *);
829 const struct got_error *got_privsep_send_painting_request(struct imsgbuf *,
830     int, struct got_object_id *, intptr_t);
831 typedef const struct got_error *(*got_privsep_recv_painted_commit_cb)(void *,
832     struct got_object_id *, intptr_t);
833 const struct got_error *got_privsep_send_painted_commits(struct imsgbuf *,
834     struct got_object_id_queue *, int *, int, int);
835 const struct got_error *got_privsep_send_painting_commits_done(struct imsgbuf *);
836 const struct got_error *got_privsep_recv_painted_commits(
837     struct got_object_id_queue *, got_privsep_recv_painted_commit_cb, void *,
838     struct imsgbuf *);
839 
840 void got_privsep_exec_child(int[2], const char *, const char *);