2 * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 * All code runs under the same UID but sensitive code paths are
19 * run in a separate process with tighter pledge(2) promises.
20 * Data is communicated between processes via imsg_flush(3) and imsg_read(3).
21 * This behaviour is transparent to users of the library.
23 * We generally transmit data in imsg buffers, split across several messages
24 * if necessary. File descriptors are used in cases where this is impractical,
25 * such as when accessing pack files or when transferring large blobs.
27 * We exec(2) after a fork(2). Parts of our library functionality are
28 * accessible via separate executables in a libexec directory.
31 #define GOT_IMSG_FD_CHILD (STDERR_FILENO + 1)
33 #ifndef GOT_LIBEXECDIR
34 #define GOT_LIBEXECDIR /usr/libexec
37 /* Names of helper programs in libexec directory */
38 #define GOT_PROG_READ_OBJECT got-read-object
39 #define GOT_PROG_READ_TREE got-read-tree
40 #define GOT_PROG_READ_COMMIT got-read-commit
41 #define GOT_PROG_READ_BLOB got-read-blob
42 #define GOT_PROG_READ_TAG got-read-tag
43 #define GOT_PROG_READ_PACK got-read-pack
45 #define GOT_STRINGIFY(x) #x
46 #define GOT_STRINGVAL(x) GOT_STRINGIFY(x)
48 /* Paths to helper programs in libexec directory */
49 #define GOT_PATH_PROG_READ_OBJECT \
50 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_OBJECT)
51 #define GOT_PATH_PROG_READ_TREE \
52 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TREE)
53 #define GOT_PATH_PROG_READ_COMMIT \
54 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_COMMIT)
55 #define GOT_PATH_PROG_READ_BLOB \
56 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_BLOB)
57 #define GOT_PATH_PROG_READ_TAG \
58 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TAG)
59 #define GOT_PATH_PROG_READ_PACK \
60 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PACK)
62 struct got_privsep_child {
69 /* An error occured while processing a request. */
72 /* Stop the child process. */
76 * Messages concerned with read access to objects in a repository.
77 * Object and pack files are opened by the main process, where
78 * data may be read as a byte string but without any interpretation.
79 * Decompression and parsing of object and pack files occurs in a
80 * separate process which runs under pledge("stdio recvfd").
81 * This sandboxes our own repository parsing code, as well as zlib.
83 GOT_IMSG_OBJECT_REQUEST,
85 GOT_IMSG_COMMIT_REQUEST,
87 GOT_IMSG_COMMIT_LOGMSG,
88 GOT_IMSG_TREE_REQUEST,
91 GOT_IMSG_BLOB_REQUEST,
98 /* Messages related to pack files. */
101 GOT_IMSG_PACKED_OBJECT_REQUEST,
103 /* Message sending file descriptor to a temporary file. */
107 /* Structure for GOT_IMSG_ERROR. */
108 struct got_imsg_error {
109 int code; /* an error code from got_error.h */
110 int errno_code; /* in case code equals GOT_ERR_ERRNO */
111 } __attribute__((__packed__));
114 * Structure for GOT_IMSG_TREE_REQUEST and GOT_IMSG_OBJECT data.
116 struct got_imsg_object {
117 uint8_t id[SHA1_DIGEST_LENGTH];
119 /* These fields are the same as in struct got_object. */
126 } __attribute__((__packed__));
128 /* Structure for GOT_IMSG_COMMIT data. */
129 struct got_imsg_commit_object {
130 uint8_t tree_id[SHA1_DIGEST_LENGTH];
133 time_t author_gmtoff;
134 size_t committer_len;
135 time_t committer_time;
136 time_t committer_gmtoff;
141 * Followed by author_len + committer_len data bytes
144 /* Followed by 'nparents' SHA1_DIGEST_LENGTH length strings */
147 * Followed by 'logmsg_len' bytes of commit log message data in
148 * one or more GOT_IMSG_COMMIT_LOGMSG messages.
150 } __attribute__((__packed__));
153 /* Structure for GOT_IMSG_TREE_ENTRY. */
154 struct got_imsg_tree_entry {
155 char id[SHA1_DIGEST_LENGTH];
157 /* Followed by entry's name in remaining data of imsg buffer. */
158 } __attribute__((__packed__));
160 /* Structure for GOT_IMSG_TREE_OBJECT_REPLY data. */
161 struct got_imsg_tree_object {
162 int nentries; /* This many TREE_ENTRY messages follow. */
165 /* Structure for GOT_IMSG_BLOB. */
166 struct got_imsg_blob {
171 * If size <= GOT_PRIVSEP_INLINE_BLOB_DATA_MAX, blob data follows
172 * in the imsg buffer. Otherwise, blob data has been written to a
173 * file descriptor passed via the GOT_IMSG_BLOB_OUTFD imsg.
175 #define GOT_PRIVSEP_INLINE_BLOB_DATA_MAX \
176 (MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_blob))
180 /* Structure for GOT_IMSG_TAG data. */
181 struct got_imsg_tag_object {
182 uint8_t id[SHA1_DIGEST_LENGTH];
187 time_t tagger_gmtoff;
191 * Followed by tag_len + tagger_len data bytes
195 * Followed by 'tagmsg_len' bytes of tag message data in
196 * one or more GOT_IMSG_TAG_TAGMSG messages.
198 } __attribute__((__packed__));
200 /* Structure for GOT_IMSG_PACKIDX. */
201 struct got_imsg_packidx {
203 /* Additionally, a file desciptor is passed via imsg. */
206 /* Structure for GOT_IMSG_PACK. */
207 struct got_imsg_pack {
208 char path_packfile[PATH_MAX];
210 /* Additionally, a file desciptor is passed via imsg. */
211 } __attribute__((__packed__));
214 * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST data.
216 struct got_imsg_packed_object {
217 uint8_t id[SHA1_DIGEST_LENGTH];
219 } __attribute__((__packed__));
224 const struct got_error *got_privsep_wait_for_child(pid_t);
225 const struct got_error *got_privsep_send_stop(int);
226 const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,
228 void got_privsep_send_error(struct imsgbuf *, const struct got_error *);
229 const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int);
230 const struct got_error *got_privsep_send_commit_req(struct imsgbuf *, int,
231 struct got_object_id *, int);
232 const struct got_error *got_privsep_send_tree_req(struct imsgbuf *, int,
233 struct got_object_id *, int);
234 const struct got_error *got_privsep_send_tag_req(struct imsgbuf *, int,
235 struct got_object_id *, int);
236 const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int,
237 struct got_object_id *, int);
238 const struct got_error *got_privsep_send_blob_outfd(struct imsgbuf *, int);
239 const struct got_error *got_privsep_send_tmpfd(struct imsgbuf *, int);
240 const struct got_error *got_privsep_send_obj(struct imsgbuf *,
241 struct got_object *);
242 const struct got_error *got_privsep_get_imsg_obj(struct got_object **,
243 struct imsg *, struct imsgbuf *);
244 const struct got_error *got_privsep_recv_obj(struct got_object **,
246 const struct got_error *got_privsep_send_commit(struct imsgbuf *,
247 struct got_commit_object *);
248 const struct got_error *got_privsep_recv_commit(struct got_commit_object **,
250 const struct got_error *got_privsep_recv_tree(struct got_tree_object **,
252 const struct got_error *got_privsep_send_tree(struct imsgbuf *,
253 struct got_tree_object *);
254 const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t, size_t,
256 const struct got_error *got_privsep_recv_blob(uint8_t **, size_t *, size_t *,
258 const struct got_error *got_privsep_send_tag(struct imsgbuf *,
259 struct got_tag_object *);
260 const struct got_error *got_privsep_recv_tag(struct got_tag_object **,
262 const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,
263 struct got_pack *, struct got_packidx *);
264 const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int,
265 struct got_object_id *);
266 const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);