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