2 * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3 * Copyright (c) 2019, Ori Bernstein <ori@openbsd.org>
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.
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.
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.
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.
28 * We exec(2) after a fork(2). Parts of our library functionality are
29 * accessible via separate executables in a libexec directory.
32 #define GOT_IMSG_FD_CHILD (STDERR_FILENO + 1)
34 #ifndef GOT_LIBEXECDIR
35 #define GOT_LIBEXECDIR /usr/libexec
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_FETCH_PACK got-fetch-pack
47 #define GOT_PROG_INDEX_PACK got-index-pack
48 #define GOT_PROG_SEND_PACK got-send-pack
50 #define GOT_STRINGIFY(x) #x
51 #define GOT_STRINGVAL(x) GOT_STRINGIFY(x)
53 /* Paths to helper programs in libexec directory */
54 #define GOT_PATH_PROG_READ_OBJECT \
55 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_OBJECT)
56 #define GOT_PATH_PROG_READ_TREE \
57 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TREE)
58 #define GOT_PATH_PROG_READ_COMMIT \
59 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_COMMIT)
60 #define GOT_PATH_PROG_READ_BLOB \
61 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_BLOB)
62 #define GOT_PATH_PROG_READ_TAG \
63 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TAG)
64 #define GOT_PATH_PROG_READ_PACK \
65 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PACK)
66 #define GOT_PATH_PROG_READ_GITCONFIG \
67 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_GITCONFIG)
68 #define GOT_PATH_PROG_FETCH_PACK \
69 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_FETCH_PACK)
70 #define GOT_PATH_PROG_SEND_PACK \
71 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_SEND_PACK)
72 #define GOT_PATH_PROG_INDEX_PACK \
73 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_INDEX_PACK)
75 struct got_privsep_child {
82 /* An error occured while processing a request. */
85 /* Stop the child process. */
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.
96 GOT_IMSG_OBJECT_REQUEST,
98 GOT_IMSG_COMMIT_REQUEST,
100 GOT_IMSG_COMMIT_LOGMSG,
101 GOT_IMSG_TREE_REQUEST,
104 GOT_IMSG_BLOB_REQUEST,
107 GOT_IMSG_TAG_REQUEST,
111 /* Messages related to networking. */
112 GOT_IMSG_FETCH_REQUEST,
113 GOT_IMSG_FETCH_SYMREFS,
115 GOT_IMSG_FETCH_SERVER_PROGRESS,
116 GOT_IMSG_FETCH_DOWNLOAD_PROGRESS,
118 GOT_IMSG_IDXPACK_REQUEST,
119 GOT_IMSG_IDXPACK_PROGRESS,
120 GOT_IMSG_IDXPACK_DONE,
122 /* Messages related to pack files. */
125 GOT_IMSG_PACKED_OBJECT_REQUEST,
126 GOT_IMSG_COMMIT_TRAVERSAL_REQUEST,
127 GOT_IMSG_TRAVERSED_COMMITS,
128 GOT_IMSG_COMMIT_TRAVERSAL_DONE,
130 /* Message sending file descriptor to a temporary file. */
133 /* Messages related to gitconfig files. */
134 GOT_IMSG_GITCONFIG_PARSE_REQUEST,
135 GOT_IMSG_GITCONFIG_REPOSITORY_FORMAT_VERSION_REQUEST,
136 GOT_IMSG_GITCONFIG_AUTHOR_NAME_REQUEST,
137 GOT_IMSG_GITCONFIG_AUTHOR_EMAIL_REQUEST,
138 GOT_IMSG_GITCONFIG_REMOTES_REQUEST,
139 GOT_IMSG_GITCONFIG_INT_VAL,
140 GOT_IMSG_GITCONFIG_STR_VAL,
141 GOT_IMSG_GITCONFIG_REMOTES,
142 GOT_IMSG_GITCONFIG_REMOTE,
143 GOT_IMSG_GITCONFIG_OWNER_REQUEST,
144 GOT_IMSG_GITCONFIG_OWNER,
147 /* Structure for GOT_IMSG_ERROR. */
148 struct got_imsg_error {
149 int code; /* an error code from got_error.h */
150 int errno_code; /* in case code equals GOT_ERR_ERRNO */
151 } __attribute__((__packed__));
154 * Structure for GOT_IMSG_TREE_REQUEST and GOT_IMSG_OBJECT data.
156 struct got_imsg_object {
157 uint8_t id[SHA1_DIGEST_LENGTH];
159 /* These fields are the same as in struct got_object. */
166 } __attribute__((__packed__));
168 /* Structure for GOT_IMSG_COMMIT data. */
169 struct got_imsg_commit_object {
170 uint8_t tree_id[SHA1_DIGEST_LENGTH];
173 time_t author_gmtoff;
174 size_t committer_len;
175 time_t committer_time;
176 time_t committer_gmtoff;
181 * Followed by author_len + committer_len data bytes
184 /* Followed by 'nparents' SHA1_DIGEST_LENGTH length strings */
187 * Followed by 'logmsg_len' bytes of commit log message data in
188 * one or more GOT_IMSG_COMMIT_LOGMSG messages.
190 } __attribute__((__packed__));
193 /* Structure for GOT_IMSG_TREE_ENTRY. */
194 struct got_imsg_tree_entry {
195 char id[SHA1_DIGEST_LENGTH];
197 /* Followed by entry's name in remaining data of imsg buffer. */
198 } __attribute__((__packed__));
200 /* Structure for GOT_IMSG_TREE_OBJECT_REPLY data. */
201 struct got_imsg_tree_object {
202 int nentries; /* This many TREE_ENTRY messages follow. */
205 /* Structure for GOT_IMSG_BLOB. */
206 struct got_imsg_blob {
211 * If size <= GOT_PRIVSEP_INLINE_BLOB_DATA_MAX, blob data follows
212 * in the imsg buffer. Otherwise, blob data has been written to a
213 * file descriptor passed via the GOT_IMSG_BLOB_OUTFD imsg.
215 #define GOT_PRIVSEP_INLINE_BLOB_DATA_MAX \
216 (MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_blob))
220 /* Structure for GOT_IMSG_TAG data. */
221 struct got_imsg_tag_object {
222 uint8_t id[SHA1_DIGEST_LENGTH];
227 time_t tagger_gmtoff;
231 * Followed by tag_len + tagger_len data bytes
235 * Followed by 'tagmsg_len' bytes of tag message data in
236 * one or more GOT_IMSG_TAG_TAGMSG messages.
238 } __attribute__((__packed__));
240 /* Structures for GOT_IMSG_FETCH_REQUEST data. */
241 struct got_imsg_fetch_have_ref {
242 uint8_t id[SHA1_DIGEST_LENGTH];
244 /* Followed by name_len data bytes. */
246 struct got_imsg_fetch_have_refs {
248 /* Followed by n_have_refs times of got_imsg_fetch_have_ref data. */
251 /* Structures for GOT_IMSG_FETCH_SYMREFS data. */
252 struct got_imsg_fetch_symref {
257 * Followed by name_len + target_len data bytes.
259 } __attribute__((__packed__));
261 struct got_imsg_fetch_symrefs {
264 /* Followed by nsymrefs times of got_imsg_fetch_symref data. */
265 } __attribute__((__packed__));
267 /* Structure for GOT_IMSG_FETCH_REF data. */
268 struct got_imsg_fetch_ref {
269 /* Describes a reference which will be fetched. */
270 uint8_t refid[SHA1_DIGEST_LENGTH];
271 /* Followed by reference name in remaining data of imsg buffer. */
274 /* Structure for GOT_IMSG_FETCH_DOWNLOAD_PROGRESS data. */
275 struct got_imsg_fetch_download_progress {
276 /* Number of packfile data bytes downloaded so far. */
277 off_t packfile_bytes;
280 /* Structure for GOT_IMSG_IDXPACK_REQUEST data. */
281 struct got_imsg_index_pack_request {
282 uint8_t pack_hash[SHA1_DIGEST_LENGTH];
283 } __attribute__((__packed__));
285 /* Structure for GOT_IMSG_IDXPACK_PROGRESS data. */
286 struct got_imsg_index_pack_progress {
287 /* Total number of objects in pack file. */
290 /* Number of objects indexed so far. */
293 /* Number of non-deltified objects in pack file. */
296 /* Number of deltified objects resolved so far. */
300 /* Structure for GOT_IMSG_PACKIDX. */
301 struct got_imsg_packidx {
303 /* Additionally, a file desciptor is passed via imsg. */
306 /* Structure for GOT_IMSG_PACK. */
307 struct got_imsg_pack {
308 char path_packfile[PATH_MAX];
310 /* Additionally, a file desciptor is passed via imsg. */
311 } __attribute__((__packed__));
314 * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST data.
316 struct got_imsg_packed_object {
317 uint8_t id[SHA1_DIGEST_LENGTH];
319 } __attribute__((__packed__));
321 /* Structure for GOT_IMSG_COMMIT_TRAVERSAL_REQUEST */
322 struct got_imsg_commit_traversal_request {
323 uint8_t id[SHA1_DIGEST_LENGTH];
326 /* Followed by path_len bytes of path data */
327 } __attribute__((__packed__));
329 /* Structure for GOT_IMSG_TRAVERSED_COMMITS */
330 struct got_imsg_traversed_commits {
332 /* Followed by ncommit IDs of SHA1_DIGEST_LENGTH each */
333 } __attribute__((__packed__));
336 * Structure for GOT_IMSG_GITCONFIG_REMOTE data.
338 struct got_imsg_remote {
342 /* Followed by name_len + url_len data bytes. */
346 * Structure for GOT_IMSG_GITCONFIG_REMOTES data.
348 struct got_imsg_remotes {
349 int nremotes; /* This many GOT_IMSG_GITCONFIG_REMOTE messages follow. */
352 struct got_remote_repo;
355 struct got_pathlist_head;
357 const struct got_error *got_send_ack(pid_t);
358 const struct got_error *got_privsep_wait_for_child(pid_t);
359 const struct got_error *got_privsep_send_stop(int);
360 const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,
362 void got_privsep_send_error(struct imsgbuf *, const struct got_error *);
363 const struct got_error *got_privsep_send_ack(struct imsgbuf *);
364 const struct got_error *got_privsep_wait_ack(struct imsgbuf *);
365 const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int);
366 const struct got_error *got_privsep_send_commit_req(struct imsgbuf *, int,
367 struct got_object_id *, int);
368 const struct got_error *got_privsep_send_tree_req(struct imsgbuf *, int,
369 struct got_object_id *, int);
370 const struct got_error *got_privsep_send_tag_req(struct imsgbuf *, int,
371 struct got_object_id *, int);
372 const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int,
373 struct got_object_id *, int);
374 const struct got_error *got_privsep_send_blob_outfd(struct imsgbuf *, int);
375 const struct got_error *got_privsep_send_tmpfd(struct imsgbuf *, int);
376 const struct got_error *got_privsep_send_obj(struct imsgbuf *,
377 struct got_object *);
378 const struct got_error *got_privsep_send_index_pack_req(struct imsgbuf *,
380 const struct got_error *got_privsep_send_index_pack_progress(struct imsgbuf *,
382 const struct got_error *got_privsep_send_index_pack_done(struct imsgbuf *);
383 const struct got_error *got_privsep_recv_index_progress(int *, int *, int *,
384 int *, int *, struct imsgbuf *ibuf);
385 const struct got_error *got_privsep_send_fetch_req(struct imsgbuf *, int,
386 struct got_pathlist_head *);
387 const struct got_error *got_privsep_send_fetch_symrefs(struct imsgbuf *,
388 struct got_pathlist_head *);
389 const struct got_error *got_privsep_send_fetch_ref(struct imsgbuf *,
390 struct got_object_id *, const char *);
391 const struct got_error *got_privsep_send_fetch_server_progress(struct imsgbuf *,
392 const char *, size_t);
393 const struct got_error *got_privsep_send_fetch_download_progress(struct imsgbuf *,
395 const struct got_error *got_privsep_recv_fetch_progress(int *,
396 struct got_object_id **, char **, struct got_pathlist_head *,
397 char **, off_t *, struct imsgbuf *);
398 const struct got_error *got_privsep_send_fetch_done(struct imsgbuf *,
399 struct got_object_id);
400 const struct got_error *got_privsep_get_imsg_obj(struct got_object **,
401 struct imsg *, struct imsgbuf *);
402 const struct got_error *got_privsep_recv_obj(struct got_object **,
404 const struct got_error *got_privsep_send_commit(struct imsgbuf *,
405 struct got_commit_object *);
406 const struct got_error *got_privsep_recv_commit(struct got_commit_object **,
408 const struct got_error *got_privsep_recv_tree(struct got_tree_object **,
410 const struct got_error *got_privsep_send_tree(struct imsgbuf *,
411 struct got_pathlist_head *, int);
412 const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t, size_t,
414 const struct got_error *got_privsep_recv_blob(uint8_t **, size_t *, size_t *,
416 const struct got_error *got_privsep_send_tag(struct imsgbuf *,
417 struct got_tag_object *);
418 const struct got_error *got_privsep_recv_tag(struct got_tag_object **,
420 const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,
421 struct got_pack *, struct got_packidx *);
422 const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int,
423 struct got_object_id *);
424 const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);
426 const struct got_error *got_privsep_send_gitconfig_parse_req(struct imsgbuf *,
428 const struct got_error *
429 got_privsep_send_gitconfig_repository_format_version_req(struct imsgbuf *);
430 const struct got_error *got_privsep_send_gitconfig_author_name_req(
432 const struct got_error *got_privsep_send_gitconfig_author_email_req(
434 const struct got_error *got_privsep_send_gitconfig_remotes_req(
436 const struct got_error *got_privsep_send_gitconfig_owner_req(struct imsgbuf *);
437 const struct got_error *got_privsep_send_gitconfig_str(struct imsgbuf *,
439 const struct got_error *got_privsep_recv_gitconfig_str(char **,
441 const struct got_error *got_privsep_send_gitconfig_int(struct imsgbuf *, int);
442 const struct got_error *got_privsep_recv_gitconfig_int(int *, struct imsgbuf *);
443 const struct got_error *got_privsep_send_gitconfig_remotes(struct imsgbuf *,
444 struct got_remote_repo *, int);
445 const struct got_error *got_privsep_recv_gitconfig_remotes(
446 struct got_remote_repo **, int *, struct imsgbuf *);
448 const struct got_error *got_privsep_send_commit_traversal_request(
449 struct imsgbuf *, struct got_object_id *, int, const char *);
450 const struct got_error *got_privsep_recv_traversed_commits(
451 struct got_commit_object **, struct got_object_id **,
452 struct got_object_id_queue *, struct imsgbuf *);
453 const struct got_error *got_privsep_send_traversed_commits(
454 struct got_object_id *, size_t, struct imsgbuf *);
455 const struct got_error *got_privsep_send_commit_traversal_done(
458 void got_privsep_exec_child(int[2], const char *, const char *);