Blob


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 */
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 */
32 #define GOT_IMSG_FD_CHILD (STDERR_FILENO + 1)
34 #ifndef GOT_LIBEXECDIR
35 #define GOT_LIBEXECDIR /usr/libexec
36 #endif
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_FETCH_PACK got-fetch-pack
48 #define GOT_PROG_INDEX_PACK got-index-pack
49 #define GOT_PROG_SEND_PACK got-send-pack
51 #define GOT_STRINGIFY(x) #x
52 #define GOT_STRINGVAL(x) GOT_STRINGIFY(x)
54 /* Paths to helper programs in libexec directory */
55 #define GOT_PATH_PROG_READ_OBJECT \
56 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_OBJECT)
57 #define GOT_PATH_PROG_READ_TREE \
58 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TREE)
59 #define GOT_PATH_PROG_READ_COMMIT \
60 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_COMMIT)
61 #define GOT_PATH_PROG_READ_BLOB \
62 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_BLOB)
63 #define GOT_PATH_PROG_READ_TAG \
64 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TAG)
65 #define GOT_PATH_PROG_READ_PACK \
66 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PACK)
67 #define GOT_PATH_PROG_READ_GITCONFIG \
68 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_GITCONFIG)
69 #define GOT_PATH_PROG_READ_GOTCONFIG \
70 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_GOTCONFIG)
71 #define GOT_PATH_PROG_FETCH_PACK \
72 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_FETCH_PACK)
73 #define GOT_PATH_PROG_SEND_PACK \
74 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_SEND_PACK)
75 #define GOT_PATH_PROG_INDEX_PACK \
76 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_INDEX_PACK)
78 struct got_privsep_child {
79 int imsg_fd;
80 pid_t pid;
81 struct imsgbuf *ibuf;
82 };
84 enum got_imsg_type {
85 /* An error occured while processing a request. */
86 GOT_IMSG_ERROR,
88 /* Stop the child process. */
89 GOT_IMSG_STOP,
91 /*
92 * Messages concerned with read access to objects in a repository.
93 * Object and pack files are opened by the main process, where
94 * data may be read as a byte string but without any interpretation.
95 * Decompression and parsing of object and pack files occurs in a
96 * separate process which runs under pledge("stdio recvfd").
97 * This sandboxes our own repository parsing code, as well as zlib.
98 */
99 GOT_IMSG_OBJECT_REQUEST,
100 GOT_IMSG_OBJECT,
101 GOT_IMSG_COMMIT_REQUEST,
102 GOT_IMSG_COMMIT,
103 GOT_IMSG_COMMIT_LOGMSG,
104 GOT_IMSG_TREE_REQUEST,
105 GOT_IMSG_TREE,
106 GOT_IMSG_TREE_ENTRY,
107 GOT_IMSG_BLOB_REQUEST,
108 GOT_IMSG_BLOB_OUTFD,
109 GOT_IMSG_BLOB,
110 GOT_IMSG_TAG_REQUEST,
111 GOT_IMSG_TAG,
112 GOT_IMSG_TAG_TAGMSG,
114 /* Messages related to networking. */
115 GOT_IMSG_FETCH_REQUEST,
116 GOT_IMSG_FETCH_HAVE_REF,
117 GOT_IMSG_FETCH_WANTED_BRANCH,
118 GOT_IMSG_FETCH_WANTED_REF,
119 GOT_IMSG_FETCH_OUTFD,
120 GOT_IMSG_FETCH_SYMREFS,
121 GOT_IMSG_FETCH_REF,
122 GOT_IMSG_FETCH_SERVER_PROGRESS,
123 GOT_IMSG_FETCH_DOWNLOAD_PROGRESS,
124 GOT_IMSG_FETCH_DONE,
125 GOT_IMSG_IDXPACK_REQUEST,
126 GOT_IMSG_IDXPACK_OUTFD,
127 GOT_IMSG_IDXPACK_PROGRESS,
128 GOT_IMSG_IDXPACK_DONE,
130 /* Messages related to pack files. */
131 GOT_IMSG_PACKIDX,
132 GOT_IMSG_PACK,
133 GOT_IMSG_PACKED_OBJECT_REQUEST,
134 GOT_IMSG_COMMIT_TRAVERSAL_REQUEST,
135 GOT_IMSG_TRAVERSED_COMMITS,
136 GOT_IMSG_COMMIT_TRAVERSAL_DONE,
138 /* Message sending file descriptor to a temporary file. */
139 GOT_IMSG_TMPFD,
141 /* Messages related to gitconfig files. */
142 GOT_IMSG_GITCONFIG_PARSE_REQUEST,
143 GOT_IMSG_GITCONFIG_REPOSITORY_FORMAT_VERSION_REQUEST,
144 GOT_IMSG_GITCONFIG_REPOSITORY_EXTENSIONS_REQUEST,
145 GOT_IMSG_GITCONFIG_AUTHOR_NAME_REQUEST,
146 GOT_IMSG_GITCONFIG_AUTHOR_EMAIL_REQUEST,
147 GOT_IMSG_GITCONFIG_REMOTES_REQUEST,
148 GOT_IMSG_GITCONFIG_INT_VAL,
149 GOT_IMSG_GITCONFIG_STR_VAL,
150 GOT_IMSG_GITCONFIG_REMOTES,
151 GOT_IMSG_GITCONFIG_REMOTE,
152 GOT_IMSG_GITCONFIG_OWNER_REQUEST,
153 GOT_IMSG_GITCONFIG_OWNER,
155 /* Messages related to gotconfig files. */
156 GOT_IMSG_GOTCONFIG_PARSE_REQUEST,
157 GOT_IMSG_GOTCONFIG_AUTHOR_REQUEST,
158 GOT_IMSG_GOTCONFIG_REMOTES_REQUEST,
159 GOT_IMSG_GOTCONFIG_INT_VAL,
160 GOT_IMSG_GOTCONFIG_STR_VAL,
161 GOT_IMSG_GOTCONFIG_REMOTES,
162 GOT_IMSG_GOTCONFIG_REMOTE,
163 };
165 /* Structure for GOT_IMSG_ERROR. */
166 struct got_imsg_error {
167 int code; /* an error code from got_error.h */
168 int errno_code; /* in case code equals GOT_ERR_ERRNO */
169 } __attribute__((__packed__));
171 /*
172 * Structure for GOT_IMSG_TREE_REQUEST and GOT_IMSG_OBJECT data.
173 */
174 struct got_imsg_object {
175 uint8_t id[SHA1_DIGEST_LENGTH];
177 /* These fields are the same as in struct got_object. */
178 int type;
179 int flags;
180 size_t hdrlen;
181 size_t size;
182 off_t pack_offset;
183 int pack_idx;
184 } __attribute__((__packed__));
186 /* Structure for GOT_IMSG_COMMIT data. */
187 struct got_imsg_commit_object {
188 uint8_t tree_id[SHA1_DIGEST_LENGTH];
189 size_t author_len;
190 time_t author_time;
191 time_t author_gmtoff;
192 size_t committer_len;
193 time_t committer_time;
194 time_t committer_gmtoff;
195 size_t logmsg_len;
196 int nparents;
198 /*
199 * Followed by author_len + committer_len data bytes
200 */
202 /* Followed by 'nparents' SHA1_DIGEST_LENGTH length strings */
204 /*
205 * Followed by 'logmsg_len' bytes of commit log message data in
206 * one or more GOT_IMSG_COMMIT_LOGMSG messages.
207 */
208 } __attribute__((__packed__));
211 /* Structure for GOT_IMSG_TREE_ENTRY. */
212 struct got_imsg_tree_entry {
213 char id[SHA1_DIGEST_LENGTH];
214 mode_t mode;
215 /* Followed by entry's name in remaining data of imsg buffer. */
216 } __attribute__((__packed__));
218 /* Structure for GOT_IMSG_TREE_OBJECT_REPLY data. */
219 struct got_imsg_tree_object {
220 int nentries; /* This many TREE_ENTRY messages follow. */
221 };
223 /* Structure for GOT_IMSG_BLOB. */
224 struct got_imsg_blob {
225 size_t size;
226 size_t hdrlen;
228 /*
229 * If size <= GOT_PRIVSEP_INLINE_BLOB_DATA_MAX, blob data follows
230 * in the imsg buffer. Otherwise, blob data has been written to a
231 * file descriptor passed via the GOT_IMSG_BLOB_OUTFD imsg.
232 */
233 #define GOT_PRIVSEP_INLINE_BLOB_DATA_MAX \
234 (MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_blob))
235 };
238 /* Structure for GOT_IMSG_TAG data. */
239 struct got_imsg_tag_object {
240 uint8_t id[SHA1_DIGEST_LENGTH];
241 int obj_type;
242 size_t tag_len;
243 size_t tagger_len;
244 time_t tagger_time;
245 time_t tagger_gmtoff;
246 size_t tagmsg_len;
248 /*
249 * Followed by tag_len + tagger_len data bytes
250 */
252 /*
253 * Followed by 'tagmsg_len' bytes of tag message data in
254 * one or more GOT_IMSG_TAG_TAGMSG messages.
255 */
256 } __attribute__((__packed__));
258 /* Structure for GOT_IMSG_FETCH_HAVE_REF data. */
259 struct got_imsg_fetch_have_ref {
260 uint8_t id[SHA1_DIGEST_LENGTH];
261 size_t name_len;
262 /* Followed by name_len data bytes. */
263 } __attribute__((__packed__));
265 /* Structure for GOT_IMSG_FETCH_WANTED_BRANCH data. */
266 struct got_imsg_fetch_wanted_branch {
267 size_t name_len;
268 /* Followed by name_len data bytes. */
269 } __attribute__((__packed__));
271 /* Structure for GOT_IMSG_FETCH_WANTED_REF data. */
272 struct got_imsg_fetch_wanted_ref {
273 size_t name_len;
274 /* Followed by name_len data bytes. */
275 } __attribute__((__packed__));
277 /* Structure for GOT_IMSG_FETCH_REQUEST data. */
278 struct got_imsg_fetch_request {
279 int fetch_all_branches;
280 int list_refs_only;
281 int verbosity;
282 size_t n_have_refs;
283 size_t n_wanted_branches;
284 size_t n_wanted_refs;
285 /* Followed by n_have_refs GOT_IMSG_FETCH_HAVE_REF messages. */
286 /* Followed by n_wanted_branches times GOT_IMSG_FETCH_WANTED_BRANCH. */
287 /* Followed by n_wanted_refs times GOT_IMSG_FETCH_WANTED_REF. */
288 } __attribute__((__packed__));
290 /* Structures for GOT_IMSG_FETCH_SYMREFS data. */
291 struct got_imsg_fetch_symref {
292 size_t name_len;
293 size_t target_len;
295 /*
296 * Followed by name_len + target_len data bytes.
297 */
298 } __attribute__((__packed__));
300 struct got_imsg_fetch_symrefs {
301 size_t nsymrefs;
303 /* Followed by nsymrefs times of got_imsg_fetch_symref data. */
304 } __attribute__((__packed__));
306 /* Structure for GOT_IMSG_FETCH_REF data. */
307 struct got_imsg_fetch_ref {
308 /* Describes a reference which will be fetched. */
309 uint8_t refid[SHA1_DIGEST_LENGTH];
310 /* Followed by reference name in remaining data of imsg buffer. */
311 };
313 /* Structure for GOT_IMSG_FETCH_DOWNLOAD_PROGRESS data. */
314 struct got_imsg_fetch_download_progress {
315 /* Number of packfile data bytes downloaded so far. */
316 off_t packfile_bytes;
317 };
319 /* Structure for GOT_IMSG_IDXPACK_REQUEST data. */
320 struct got_imsg_index_pack_request {
321 uint8_t pack_hash[SHA1_DIGEST_LENGTH];
322 } __attribute__((__packed__));
324 /* Structure for GOT_IMSG_IDXPACK_PROGRESS data. */
325 struct got_imsg_index_pack_progress {
326 /* Total number of objects in pack file. */
327 int nobj_total;
329 /* Number of objects indexed so far. */
330 int nobj_indexed;
332 /* Number of non-deltified objects in pack file. */
333 int nobj_loose;
335 /* Number of deltified objects resolved so far. */
336 int nobj_resolved;
337 };
339 /* Structure for GOT_IMSG_PACKIDX. */
340 struct got_imsg_packidx {
341 size_t len;
342 /* Additionally, a file desciptor is passed via imsg. */
343 };
345 /* Structure for GOT_IMSG_PACK. */
346 struct got_imsg_pack {
347 char path_packfile[PATH_MAX];
348 size_t filesize;
349 /* Additionally, a file desciptor is passed via imsg. */
350 } __attribute__((__packed__));
352 /*
353 * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST data.
354 */
355 struct got_imsg_packed_object {
356 uint8_t id[SHA1_DIGEST_LENGTH];
357 int idx;
358 } __attribute__((__packed__));
360 /* Structure for GOT_IMSG_COMMIT_TRAVERSAL_REQUEST */
361 struct got_imsg_commit_traversal_request {
362 uint8_t id[SHA1_DIGEST_LENGTH];
363 int idx;
364 size_t path_len;
365 /* Followed by path_len bytes of path data */
366 } __attribute__((__packed__));
368 /* Structure for GOT_IMSG_TRAVERSED_COMMITS */
369 struct got_imsg_traversed_commits {
370 size_t ncommits;
371 /* Followed by ncommit IDs of SHA1_DIGEST_LENGTH each */
372 } __attribute__((__packed__));
374 /*
375 * Structure for GOT_IMSG_GITCONFIG_REMOTE data.
376 */
377 struct got_imsg_remote {
378 size_t name_len;
379 size_t url_len;
380 int mirror_references;
381 int fetch_all_branches;
382 int nbranches;
383 int nrefs;
385 /* Followed by name_len + url_len data bytes. */
386 /* Followed by nbranches GOT_IMSG_GITCONFIG_STR_VAL messages. */
387 /* Followed by nrefs GOT_IMSG_GITCONFIG_STR_VAL messages. */
388 } __attribute__((__packed__));
390 /*
391 * Structure for GOT_IMSG_GITCONFIG_REMOTES data.
392 */
393 struct got_imsg_remotes {
394 int nremotes; /* This many GOT_IMSG_GITCONFIG_REMOTE messages follow. */
395 };
397 struct got_remote_repo;
398 struct got_pack;
399 struct got_packidx;
400 struct got_pathlist_head;
402 const struct got_error *got_send_ack(pid_t);
403 const struct got_error *got_privsep_wait_for_child(pid_t);
404 const struct got_error *got_privsep_flush_imsg(struct imsgbuf *);
405 const struct got_error *got_privsep_send_stop(int);
406 const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,
407 size_t);
408 void got_privsep_send_error(struct imsgbuf *, const struct got_error *);
409 const struct got_error *got_privsep_send_ack(struct imsgbuf *);
410 const struct got_error *got_privsep_wait_ack(struct imsgbuf *);
411 const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int);
412 const struct got_error *got_privsep_send_commit_req(struct imsgbuf *, int,
413 struct got_object_id *, int);
414 const struct got_error *got_privsep_send_tree_req(struct imsgbuf *, int,
415 struct got_object_id *, int);
416 const struct got_error *got_privsep_send_tag_req(struct imsgbuf *, int,
417 struct got_object_id *, int);
418 const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int,
419 struct got_object_id *, int);
420 const struct got_error *got_privsep_send_blob_outfd(struct imsgbuf *, int);
421 const struct got_error *got_privsep_send_tmpfd(struct imsgbuf *, int);
422 const struct got_error *got_privsep_send_obj(struct imsgbuf *,
423 struct got_object *);
424 const struct got_error *got_privsep_send_index_pack_req(struct imsgbuf *,
425 uint8_t *, int);
426 const struct got_error *got_privsep_send_index_pack_outfd(struct imsgbuf *,
427 int);
428 const struct got_error *got_privsep_recv_index_progress(int *, int *, int *,
429 int *, int *, struct imsgbuf *ibuf);
430 const struct got_error *got_privsep_send_fetch_req(struct imsgbuf *, int,
431 struct got_pathlist_head *, int, struct got_pathlist_head *,
432 struct got_pathlist_head *, int, int);
433 const struct got_error *got_privsep_send_fetch_outfd(struct imsgbuf *, int);
434 const struct got_error *got_privsep_recv_fetch_progress(int *,
435 struct got_object_id **, char **, struct got_pathlist_head *, char **,
436 off_t *, uint8_t *, struct imsgbuf *);
437 const struct got_error *got_privsep_get_imsg_obj(struct got_object **,
438 struct imsg *, struct imsgbuf *);
439 const struct got_error *got_privsep_recv_obj(struct got_object **,
440 struct imsgbuf *);
441 const struct got_error *got_privsep_send_commit(struct imsgbuf *,
442 struct got_commit_object *);
443 const struct got_error *got_privsep_recv_commit(struct got_commit_object **,
444 struct imsgbuf *);
445 const struct got_error *got_privsep_recv_tree(struct got_tree_object **,
446 struct imsgbuf *);
447 const struct got_error *got_privsep_send_tree(struct imsgbuf *,
448 struct got_pathlist_head *, int);
449 const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t, size_t,
450 const uint8_t *);
451 const struct got_error *got_privsep_recv_blob(uint8_t **, size_t *, size_t *,
452 struct imsgbuf *);
453 const struct got_error *got_privsep_send_tag(struct imsgbuf *,
454 struct got_tag_object *);
455 const struct got_error *got_privsep_recv_tag(struct got_tag_object **,
456 struct imsgbuf *);
457 const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,
458 struct got_pack *, struct got_packidx *);
459 const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int,
460 struct got_object_id *);
461 const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);
463 const struct got_error *got_privsep_send_gitconfig_parse_req(struct imsgbuf *,
464 int);
465 const struct got_error *
466 got_privsep_send_gitconfig_repository_format_version_req(struct imsgbuf *);
467 const struct got_error *got_privsep_send_gitconfig_repository_extensions_req(
468 struct imsgbuf *);
469 const struct got_error *got_privsep_send_gitconfig_author_name_req(
470 struct imsgbuf *);
471 const struct got_error *got_privsep_send_gitconfig_author_email_req(
472 struct imsgbuf *);
473 const struct got_error *got_privsep_send_gitconfig_remotes_req(
474 struct imsgbuf *);
475 const struct got_error *got_privsep_send_gitconfig_owner_req(struct imsgbuf *);
476 const struct got_error *got_privsep_recv_gitconfig_str(char **,
477 struct imsgbuf *);
478 const struct got_error *got_privsep_recv_gitconfig_int(int *, struct imsgbuf *);
479 const struct got_error *got_privsep_recv_gitconfig_remotes(
480 struct got_remote_repo **, int *, struct imsgbuf *);
482 const struct got_error *got_privsep_send_gotconfig_parse_req(struct imsgbuf *,
483 int);
484 const struct got_error *got_privsep_send_gotconfig_author_req(struct imsgbuf *);
485 const struct got_error *got_privsep_send_gotconfig_remotes_req(
486 struct imsgbuf *);
487 const struct got_error *got_privsep_recv_gotconfig_str(char **,
488 struct imsgbuf *);
489 const struct got_error *got_privsep_recv_gotconfig_remotes(
490 struct got_remote_repo **, int *, struct imsgbuf *);
492 const struct got_error *got_privsep_send_commit_traversal_request(
493 struct imsgbuf *, struct got_object_id *, int, const char *);
494 const struct got_error *got_privsep_recv_traversed_commits(
495 struct got_commit_object **, struct got_object_id **,
496 struct got_object_id_queue *, struct imsgbuf *);
498 void got_privsep_exec_child(int[2], const char *, const char *);