2 7be7cc45 2018-04-02 stsp * Copyright (c) 2018 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 876c234b 2018-09-10 stsp #define GOT_PROG_READ_PACK got-read-pack
44 ad242220 2018-09-08 stsp #define GOT_STRINGIFY(x) #x
45 ad242220 2018-09-08 stsp #define GOT_STRINGVAL(x) GOT_STRINGIFY(x)
47 ad242220 2018-09-08 stsp /* Paths to helper programs in libexec directory */
48 ad242220 2018-09-08 stsp #define GOT_PATH_PROG_READ_OBJECT \
49 ad242220 2018-09-08 stsp GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_OBJECT)
50 ad242220 2018-09-08 stsp #define GOT_PATH_PROG_READ_TREE \
51 ad242220 2018-09-08 stsp GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TREE)
52 ad242220 2018-09-08 stsp #define GOT_PATH_PROG_READ_COMMIT \
53 ad242220 2018-09-08 stsp GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_COMMIT)
54 ad242220 2018-09-08 stsp #define GOT_PATH_PROG_READ_BLOB \
55 ad242220 2018-09-08 stsp GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_BLOB)
56 876c234b 2018-09-10 stsp #define GOT_PATH_PROG_READ_PACK \
57 876c234b 2018-09-10 stsp GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PACK)
59 876c234b 2018-09-10 stsp struct got_privsep_child {
60 876c234b 2018-09-10 stsp int imsg_fd;
62 876c234b 2018-09-10 stsp struct imsgbuf *ibuf;
65 7be7cc45 2018-04-02 stsp enum got_imsg_type {
66 c025a41e 2018-04-02 stsp /* An error occured while processing a request. */
67 c025a41e 2018-04-02 stsp GOT_IMSG_ERROR,
69 ad242220 2018-09-08 stsp /* Stop the child process. */
70 ad242220 2018-09-08 stsp GOT_IMSG_STOP,
73 7be7cc45 2018-04-02 stsp * Messages concerned with read access to objects in a repository.
74 7be7cc45 2018-04-02 stsp * Object and pack files are opened by the main process, where
75 7be7cc45 2018-04-02 stsp * data may be read as a byte string but without any interpretation.
76 7be7cc45 2018-04-02 stsp * Decompression and parsing of object and pack files occurs in a
77 f0b0c746 2018-09-09 stsp * separate process which runs under pledge("stdio recvfd").
78 7be7cc45 2018-04-02 stsp * This sandboxes our own repository parsing code, as well as zlib.
80 ad242220 2018-09-08 stsp GOT_IMSG_OBJECT_REQUEST,
81 2178c42e 2018-04-22 stsp GOT_IMSG_OBJECT,
82 ad242220 2018-09-08 stsp GOT_IMSG_COMMIT_REQUEST,
83 bff6ca00 2018-04-23 stsp GOT_IMSG_COMMIT,
84 ad242220 2018-09-08 stsp GOT_IMSG_TREE_REQUEST,
85 366d86ca 2018-04-23 stsp GOT_IMSG_TREE,
86 d80ab12b 2018-04-02 stsp GOT_IMSG_TREE_ENTRY,
87 ad242220 2018-09-08 stsp GOT_IMSG_BLOB_REQUEST,
88 ad242220 2018-09-08 stsp GOT_IMSG_BLOB_OUTFD,
89 366d86ca 2018-04-23 stsp GOT_IMSG_BLOB,
91 876c234b 2018-09-10 stsp /* Messages related to pack files. */
92 876c234b 2018-09-10 stsp GOT_IMSG_PACKIDX,
93 876c234b 2018-09-10 stsp GOT_IMSG_PACK,
94 876c234b 2018-09-10 stsp GOT_IMSG_PACKED_OBJECT_REQUEST,
96 ad242220 2018-09-08 stsp /* Messages for transmitting deltas and associated delta streams: */
97 ad242220 2018-09-08 stsp GOT_IMSG_DELTA,
98 ad242220 2018-09-08 stsp GOT_IMSG_DELTA_STREAM,
101 c025a41e 2018-04-02 stsp /* Structure for GOT_IMSG_ERROR. */
102 c025a41e 2018-04-02 stsp struct got_imsg_error {
103 c025a41e 2018-04-02 stsp int code; /* an error code from got_error.h */
104 2178c42e 2018-04-22 stsp int errno_code; /* in case code equals GOT_ERR_ERRNO */
107 1e4880cb 2018-04-02 stsp /* Structure for GOT_IMSG_DELTA data. */
108 1e4880cb 2018-04-02 stsp struct got_imsg_delta {
109 1e4880cb 2018-04-02 stsp /* These fields are the same as in struct got_delta. */
110 1e4880cb 2018-04-02 stsp off_t offset;
111 1e4880cb 2018-04-02 stsp size_t tslen;
113 1e4880cb 2018-04-02 stsp size_t size;
114 1e4880cb 2018-04-02 stsp off_t data_offset;
115 1e4880cb 2018-04-02 stsp size_t delta_len;
118 876c234b 2018-09-10 stsp * Followed by one or more DELTA_STREAM messages until delta_len
119 876c234b 2018-09-10 stsp * bytes of delta stream have been transmitted.
123 1e4880cb 2018-04-02 stsp /* Structure for GOT_IMSG_DELTA_STREAM data. */
124 1e4880cb 2018-04-02 stsp struct got_imsg_delta_stream {
126 1e4880cb 2018-04-02 stsp * Empty since the following is implied:
127 48f392b2 2018-04-02 stsp * Read additional delta stream data from imsg buffer.
132 ad242220 2018-09-08 stsp * Structure for GOT_IMSG_TREE_REQUEST, GOT_IMSG_COMMIT_REQUEST,
133 ad242220 2018-09-08 stsp * and GOT_IMSG_OBJECT data.
135 f7171542 2018-04-02 stsp struct got_imsg_object {
136 7be7cc45 2018-04-02 stsp /* These fields are the same as in struct got_object. */
139 7be7cc45 2018-04-02 stsp size_t hdrlen;
140 7be7cc45 2018-04-02 stsp size_t size;
142 876c234b 2018-09-10 stsp off_t pack_offset;
143 7be7cc45 2018-04-02 stsp int ndeltas; /* this many GOT_IMSG_DELTA messages follow */
146 366d86ca 2018-04-23 stsp /* Structure for GOT_IMSG_COMMIT data. */
147 bff6ca00 2018-04-23 stsp struct got_imsg_commit_object {
148 86acc566 2018-04-23 stsp uint8_t tree_id[SHA1_DIGEST_LENGTH];
149 bff6ca00 2018-04-23 stsp size_t author_len;
150 788c352e 2018-06-16 stsp struct tm tm_author;
151 bff6ca00 2018-04-23 stsp size_t committer_len;
152 788c352e 2018-06-16 stsp struct tm tm_committer;
153 bff6ca00 2018-04-23 stsp size_t logmsg_len;
154 bff6ca00 2018-04-23 stsp int nparents;
157 788c352e 2018-06-16 stsp * Followed by author_len + committer_len + logmsg_len data bytes
160 86acc566 2018-04-23 stsp /* Followed by 'nparents' SHA1_DIGEST_LENGTH length strings */
162 bff6ca00 2018-04-23 stsp /* XXX should use more messages to support very large log messages */
163 bff6ca00 2018-04-23 stsp } __attribute__((__packed__));
166 48f392b2 2018-04-02 stsp /* Structure for GOT_IMSG_TREE_ENTRY. */
167 48f392b2 2018-04-02 stsp struct got_imsg_tree_entry {
168 e033d803 2018-04-23 stsp char id[SHA1_DIGEST_LENGTH];
169 48f392b2 2018-04-02 stsp mode_t mode;
170 48f392b2 2018-04-02 stsp /* Followed by entry's name in remaining data of imsg buffer. */
171 8d98bcfb 2018-04-02 stsp } __attribute__((__packed__));
173 d80ab12b 2018-04-02 stsp /* Structure for GOT_IMSG_TREE_OBJECT_REPLY data. */
174 48f392b2 2018-04-02 stsp struct got_imsg_tree_object {
175 48f392b2 2018-04-02 stsp int nentries; /* This many TREE_ENTRY messages follow. */
178 2967a784 2018-04-24 stsp /* Structure for GOT_IMSG_BLOB. */
179 2967a784 2018-04-24 stsp struct got_imsg_blob {
180 2967a784 2018-04-24 stsp size_t size;
183 876c234b 2018-09-10 stsp /* Structure for GOT_IMSG_PACKIDX. */
184 876c234b 2018-09-10 stsp struct got_imsg_packidx {
185 876c234b 2018-09-10 stsp size_t len;
186 876c234b 2018-09-10 stsp /* Additionally, a file desciptor is passed via imsg. */
189 876c234b 2018-09-10 stsp /* Structure for GOT_IMSG_PACK. */
190 876c234b 2018-09-10 stsp struct got_imsg_pack {
191 876c234b 2018-09-10 stsp char path_packfile[PATH_MAX];
192 876c234b 2018-09-10 stsp size_t filesize;
193 876c234b 2018-09-10 stsp /* Additionally, a file desciptor is passed via imsg. */
197 876c234b 2018-09-10 stsp * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST data.
199 876c234b 2018-09-10 stsp struct got_imsg_packed_object {
203 876c234b 2018-09-10 stsp struct got_pack;
204 876c234b 2018-09-10 stsp struct got_packidx;
206 876c234b 2018-09-10 stsp const struct got_error *got_privsep_wait_for_child(pid_t);
207 ad242220 2018-09-08 stsp const struct got_error *got_privsep_send_stop(int);
208 ad242220 2018-09-08 stsp const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,
210 2178c42e 2018-04-22 stsp void got_privsep_send_error(struct imsgbuf *, const struct got_error *);
211 ad242220 2018-09-08 stsp const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int,
212 ad242220 2018-09-08 stsp struct got_object *);
213 ad242220 2018-09-08 stsp const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int, int);
214 2178c42e 2018-04-22 stsp const struct got_error *got_privsep_send_obj(struct imsgbuf *,
215 876c234b 2018-09-10 stsp struct got_object *);
216 2178c42e 2018-04-22 stsp const struct got_error *got_privsep_recv_obj(struct got_object **,
217 2178c42e 2018-04-22 stsp struct imsgbuf *);
218 068fd2bf 2018-04-24 stsp const struct got_error *got_privsep_send_commit(struct imsgbuf *,
219 bff6ca00 2018-04-23 stsp struct got_commit_object *);
220 068fd2bf 2018-04-24 stsp const struct got_error *got_privsep_recv_commit(struct got_commit_object **,
221 bff6ca00 2018-04-23 stsp struct imsgbuf *);
222 068fd2bf 2018-04-24 stsp const struct got_error *got_privsep_recv_tree(struct got_tree_object **,
223 e033d803 2018-04-23 stsp struct imsgbuf *);
224 068fd2bf 2018-04-24 stsp const struct got_error *got_privsep_send_tree(struct imsgbuf *,
225 e033d803 2018-04-23 stsp struct got_tree_object *);
226 2967a784 2018-04-24 stsp const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t);
227 2967a784 2018-04-24 stsp const struct got_error *got_privsep_recv_blob(size_t *, struct imsgbuf *);
228 876c234b 2018-09-10 stsp const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,
229 876c234b 2018-09-10 stsp struct got_pack *, struct got_packidx *);
230 876c234b 2018-09-10 stsp const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int);
231 876c234b 2018-09-10 stsp const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);
