Blob

Date:
Message:
fix typo in comment
Actions:
History | Blame | Raw File
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_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 {

76 	int imsg_fd;

77 	pid_t pid;

78 	struct imsgbuf *ibuf;

79 };

81 enum got_imsg_type {

82 	/* An error occured while processing a request. */

83 	GOT_IMSG_ERROR,

85 	/* Stop the child process. */

86 	GOT_IMSG_STOP,

88 	/*

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.

95 	 */

96 	GOT_IMSG_OBJECT_REQUEST,

97 	GOT_IMSG_OBJECT,

98 	GOT_IMSG_COMMIT_REQUEST,

99 	GOT_IMSG_COMMIT,

100 	GOT_IMSG_COMMIT_LOGMSG,

101 	GOT_IMSG_TREE_REQUEST,

102 	GOT_IMSG_TREE,

103 	GOT_IMSG_TREE_ENTRY,

104 	GOT_IMSG_BLOB_REQUEST,

105 	GOT_IMSG_BLOB_OUTFD,

106 	GOT_IMSG_BLOB,

107 	GOT_IMSG_TAG_REQUEST,

108 	GOT_IMSG_TAG,

109 	GOT_IMSG_TAG_TAGMSG,

111 	/* Messages related to networking. */

112 	GOT_IMSG_FETCH_REQUEST,

113 	GOT_IMSG_FETCH_SYMREFS,

114 	GOT_IMSG_FETCH_PROGRESS,

115 	GOT_IMSG_FETCH_DONE,

116 	GOT_IMSG_IDXPACK_REQUEST,

117 	GOT_IMSG_IDXPACK_DONE,

119 	/* Messages related to pack files. */

120 	GOT_IMSG_PACKIDX,

121 	GOT_IMSG_PACK,

122 	GOT_IMSG_PACKED_OBJECT_REQUEST,

123 	GOT_IMSG_COMMIT_TRAVERSAL_REQUEST,

124 	GOT_IMSG_TRAVERSED_COMMITS,

125 	GOT_IMSG_COMMIT_TRAVERSAL_DONE,

127 	/* Message sending file descriptor to a temporary file. */

128 	GOT_IMSG_TMPFD,

130 	/* Messages related to gitconfig files. */

131 	GOT_IMSG_GITCONFIG_PARSE_REQUEST,

132 	GOT_IMSG_GITCONFIG_REPOSITORY_FORMAT_VERSION_REQUEST,

133 	GOT_IMSG_GITCONFIG_AUTHOR_NAME_REQUEST,

134 	GOT_IMSG_GITCONFIG_AUTHOR_EMAIL_REQUEST,

135 	GOT_IMSG_GITCONFIG_REMOTES_REQUEST,

136 	GOT_IMSG_GITCONFIG_INT_VAL,

137 	GOT_IMSG_GITCONFIG_STR_VAL,

138 	GOT_IMSG_GITCONFIG_REMOTES,

139 	GOT_IMSG_GITCONFIG_REMOTE,

140 	GOT_IMSG_GITCONFIG_OWNER_REQUEST,

141 	GOT_IMSG_GITCONFIG_OWNER,

142 };

144 /* Structure for GOT_IMSG_ERROR. */

145 struct got_imsg_error {

146 	int code; /* an error code from got_error.h */

147 	int errno_code; /* in case code equals GOT_ERR_ERRNO */

148 } __attribute__((__packed__));

150 /*

151  * Structure for GOT_IMSG_TREE_REQUEST and GOT_IMSG_OBJECT data.

152  */

153 struct got_imsg_object {

154 	uint8_t id[SHA1_DIGEST_LENGTH];

156 	/* These fields are the same as in struct got_object. */

157 	int type;

158 	int flags;

159 	size_t hdrlen;

160 	size_t size;

161 	off_t pack_offset;

162 	int pack_idx;

163 }  __attribute__((__packed__));

165 /* Structure for GOT_IMSG_COMMIT data. */

166 struct got_imsg_commit_object {

167 	uint8_t tree_id[SHA1_DIGEST_LENGTH];

168 	size_t author_len;

169 	time_t author_time;

170 	time_t author_gmtoff;

171 	size_t committer_len;

172 	time_t committer_time;

173 	time_t committer_gmtoff;

174 	size_t logmsg_len;

175 	int nparents;

177 	/*

178 	 * Followed by author_len + committer_len data bytes

179 	 */

181 	/* Followed by 'nparents' SHA1_DIGEST_LENGTH length strings */

183 	/*

184 	 * Followed by 'logmsg_len' bytes of commit log message data in

185 	 * one or more GOT_IMSG_COMMIT_LOGMSG messages.

186 	 */

187 } __attribute__((__packed__));

190 /* Structure for GOT_IMSG_TREE_ENTRY. */

191 struct got_imsg_tree_entry {

192 	char id[SHA1_DIGEST_LENGTH];

193 	mode_t mode;

194 	/* Followed by entry's name in remaining data of imsg buffer. */

195 } __attribute__((__packed__));

197 /* Structure for GOT_IMSG_TREE_OBJECT_REPLY data. */

198 struct got_imsg_tree_object {

199 	int nentries; /* This many TREE_ENTRY messages follow. */

200 };

202 /* Structure for GOT_IMSG_BLOB. */

203 struct got_imsg_blob {

204 	size_t size;

205 	size_t hdrlen;

207 	/*

208 	 * If size <= GOT_PRIVSEP_INLINE_BLOB_DATA_MAX, blob data follows

209 	 * in the imsg buffer. Otherwise, blob data has been written to a

210 	 * file descriptor passed via the GOT_IMSG_BLOB_OUTFD imsg.

211 	 */

212 #define GOT_PRIVSEP_INLINE_BLOB_DATA_MAX \

213 	(MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_blob))

214 };

217 /* Structure for GOT_IMSG_TAG data. */

218 struct got_imsg_tag_object {

219 	uint8_t id[SHA1_DIGEST_LENGTH];

220 	int obj_type;

221 	size_t tag_len;

222 	size_t tagger_len;

223 	time_t tagger_time;

224 	time_t tagger_gmtoff;

225 	size_t tagmsg_len;

227 	/*

228 	 * Followed by tag_len + tagger_len data bytes

229 	 */

231 	/*

232 	 * Followed by 'tagmsg_len' bytes of tag message data in

233 	 * one or more GOT_IMSG_TAG_TAGMSG messages.

234 	 */

235 } __attribute__((__packed__));

237 /* Structures for GOT_IMSG_FETCH_SYMREFS data. */

238 struct got_imsg_fetch_symref {

239 	size_t name_len;

240 	size_t target_len;

242 	/*

243 	 * Followed by name_len + target_len data bytes.

244 	 */

245 } __attribute__((__packed__));

247 struct got_imsg_fetch_symrefs {

248 	size_t nsymrefs;

250 	/* Followed by nsymrefs times of got_imsg_fetch_symref data. */

251 } __attribute__((__packed__));

253 /* Structure for GOT_IMSG_FETCH_PROGRESS data. */

254 struct got_imsg_fetch_progress {

255 	/* Describes a reference which will be fetched. */

256 	uint8_t refid[SHA1_DIGEST_LENGTH];

257 	/* Followed by reference name in remaining data of imsg buffer. */

258 };

260 /* Structure for GOT_IMSG_PACKIDX. */

261 struct got_imsg_packidx {

262 	size_t len;

263 	/* Additionally, a file desciptor is passed via imsg. */

264 };

266 /* Structure for GOT_IMSG_PACK. */

267 struct got_imsg_pack {

268 	char path_packfile[PATH_MAX];

269 	size_t filesize;

270 	/* Additionally, a file desciptor is passed via imsg. */

271 } __attribute__((__packed__));

273 /*

274  * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST data.

275  */

276 struct got_imsg_packed_object {

277 	uint8_t id[SHA1_DIGEST_LENGTH];

278 	int idx;

279 } __attribute__((__packed__));

281 /* Structure for GOT_IMSG_COMMIT_TRAVERSAL_REQUEST  */

282 struct got_imsg_commit_traversal_request {

283 	uint8_t id[SHA1_DIGEST_LENGTH];

284 	int idx;

285 	size_t path_len;

286 	/* Followed by path_len bytes of path data */

287 } __attribute__((__packed__));

289 /* Structure for GOT_IMSG_TRAVERSED_COMMITS  */

290 struct got_imsg_traversed_commits {

291 	size_t ncommits;

292 	/* Followed by ncommit IDs of SHA1_DIGEST_LENGTH each */

293 } __attribute__((__packed__));

295 /*

296  * Structure for GOT_IMSG_GITCONFIG_REMOTE data.

297  */

298 struct got_imsg_remote {

299 	size_t name_len;

300 	size_t url_len;

302 	/* Followed by name_len + url_len data bytes. */

303 };

305 /*

306  * Structure for GOT_IMSG_GITCONFIG_REMOTES data.

307  */

308 struct got_imsg_remotes {

309 	int nremotes; /* This many GOT_IMSG_GITCONFIG_REMOTE messages follow. */

310 };

312 struct got_remote_repo;

313 struct got_pack;

314 struct got_packidx;

315 struct got_pathlist_head;

317 const struct got_error *got_send_ack(pid_t);

318 const struct got_error *got_privsep_wait_for_child(pid_t);

319 const struct got_error *got_privsep_send_stop(int);

320 const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,

321     size_t);

322 void got_privsep_send_error(struct imsgbuf *, const struct got_error *);

323 const struct got_error *got_privsep_send_ack(struct imsgbuf *);

324 const struct got_error *got_privsep_wait_ack(struct imsgbuf *);

325 const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int);

326 const struct got_error *got_privsep_send_commit_req(struct imsgbuf *, int,

327     struct got_object_id *, int);

328 const struct got_error *got_privsep_send_tree_req(struct imsgbuf *, int,

329     struct got_object_id *, int);

330 const struct got_error *got_privsep_send_tag_req(struct imsgbuf *, int,

331     struct got_object_id *, int);

332 const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int,

333     struct got_object_id *, int);

334 const struct got_error *got_privsep_send_blob_outfd(struct imsgbuf *, int);

335 const struct got_error *got_privsep_send_tmpfd(struct imsgbuf *, int);

336 const struct got_error *got_privsep_send_obj(struct imsgbuf *,

337     struct got_object *);

338 const struct got_error *got_privsep_send_index_pack_req(struct imsgbuf *, int,

339     struct got_object_id *);

340 const struct got_error *got_privsep_send_index_pack_done(struct imsgbuf *);

341 const struct got_error *got_privsep_wait_index_pack_done(struct imsgbuf *);

342 const struct got_error *got_privsep_send_fetch_req(struct imsgbuf *, int);

343 const struct got_error *got_privsep_send_fetch_symrefs(struct imsgbuf *,

344     struct got_pathlist_head *);

345 const struct got_error *got_privsep_send_fetch_progress(struct imsgbuf *,

346     struct got_object_id *, const char *);

347 const struct got_error *got_privsep_recv_fetch_progress(int *,

348     struct got_object_id **, char **, struct got_pathlist_head *,

349     struct imsgbuf *);

350 const struct got_error *got_privsep_send_fetch_done(struct imsgbuf *,

351     struct got_object_id);

352 const struct got_error *got_privsep_get_imsg_obj(struct got_object **,

353     struct imsg *, struct imsgbuf *);

354 const struct got_error *got_privsep_recv_obj(struct got_object **,

355     struct imsgbuf *);

356 const struct got_error *got_privsep_send_commit(struct imsgbuf *,

357     struct got_commit_object *);

358 const struct got_error *got_privsep_recv_commit(struct got_commit_object **,

359     struct imsgbuf *);

360 const struct got_error *got_privsep_recv_tree(struct got_tree_object **,

361     struct imsgbuf *);

362 const struct got_error *got_privsep_send_tree(struct imsgbuf *,

363     struct got_pathlist_head *, int);

364 const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t, size_t,

365     const uint8_t *);

366 const struct got_error *got_privsep_recv_blob(uint8_t **, size_t *, size_t *,

367     struct imsgbuf *);

368 const struct got_error *got_privsep_send_tag(struct imsgbuf *,

369     struct got_tag_object *);

370 const struct got_error *got_privsep_recv_tag(struct got_tag_object **,

371     struct imsgbuf *);

372 const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,

373     struct got_pack *, struct got_packidx *);

374 const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int,

375     struct got_object_id *);

376 const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);

378 const struct got_error *got_privsep_send_gitconfig_parse_req(struct imsgbuf *,

379     int);

380 const struct got_error *

381     got_privsep_send_gitconfig_repository_format_version_req(struct imsgbuf *);

382 const struct got_error *got_privsep_send_gitconfig_author_name_req(

383     struct imsgbuf *);

384 const struct got_error *got_privsep_send_gitconfig_author_email_req(

385     struct imsgbuf *);

386 const struct got_error *got_privsep_send_gitconfig_remotes_req(

387     struct imsgbuf *);

388 const struct got_error *got_privsep_send_gitconfig_owner_req(struct imsgbuf *);

389 const struct got_error *got_privsep_send_gitconfig_str(struct imsgbuf *,

390     const char *);

391 const struct got_error *got_privsep_recv_gitconfig_str(char **,

392     struct imsgbuf *);

393 const struct got_error *got_privsep_send_gitconfig_int(struct imsgbuf *, int);

394 const struct got_error *got_privsep_recv_gitconfig_int(int *, struct imsgbuf *);

395 const struct got_error *got_privsep_send_gitconfig_remotes(struct imsgbuf *,

396     struct got_remote_repo *, int);

397 const struct got_error *got_privsep_recv_gitconfig_remotes(

398     struct got_remote_repo **, int *, struct imsgbuf *);

400 const struct got_error *got_privsep_send_commit_traversal_request(

401     struct imsgbuf *, struct got_object_id *, int, const char *);

402 const struct got_error *got_privsep_recv_traversed_commits(

403     struct got_commit_object **, struct got_object_id **,

404     struct got_object_id_queue *, struct imsgbuf *);

405 const struct got_error *got_privsep_send_traversed_commits(

406     struct got_object_id *, size_t, struct imsgbuf *);

407 const struct got_error *got_privsep_send_commit_traversal_done(

408     struct imsgbuf *);

410 void got_privsep_exec_child(int[2], const char *, const char *);