2 * Copyright (c) 2022 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 #define GOTD_UNIX_SOCKET "/var/run/gotd.sock"
19 #define GOTD_UNIX_SOCKET_BACKLOG 10
20 #define GOTD_UNIX_GROUP "_gotsh"
21 #define GOTD_USER "_gotd"
22 #define GOTD_CONF_PATH "/etc/gotd.conf"
23 #define GOTD_EMPTY_PATH "/var/empty"
25 #define GOTD_MAXCLIENTS 1024
26 #define GOTD_FD_RESERVE 5
27 #define GOTD_FD_NEEDED 6
28 #define GOTD_FILENO_MSG_PIPE 3
30 /* Client hash tables need some extra room. */
31 #define GOTD_CLIENT_TABLE_SIZE (GOTD_MAXCLIENTS * 4)
44 void (*handler)(int, short, void *);
50 struct gotd_child_proc {
52 enum gotd_procid type;
53 char repo_name[NAME_MAX];
54 char repo_path[PATH_MAX];
56 struct gotd_imsgev iev;
61 GOTD_ACCESS_PERMITTED = 1,
65 struct gotd_access_rule {
66 STAILQ_ENTRY(gotd_access_rule) entry;
68 enum gotd_access access;
71 #define GOTD_AUTH_READ 0x1
72 #define GOTD_AUTH_WRITE 0x2
76 STAILQ_HEAD(gotd_access_rule_list, gotd_access_rule);
79 TAILQ_ENTRY(gotd_repo) entry;
84 struct gotd_access_rule_list rules;
86 TAILQ_HEAD(gotd_repolist, gotd_repo);
88 enum gotd_client_state {
89 GOTD_STATE_EXPECT_LIST_REFS,
90 GOTD_STATE_EXPECT_CAPABILITIES,
91 GOTD_STATE_EXPECT_WANT,
92 GOTD_STATE_EXPECT_REF_UPDATE,
93 GOTD_STATE_EXPECT_MORE_REF_UPDATES,
94 GOTD_STATE_EXPECT_HAVE,
95 GOTD_STATE_EXPECT_PACKFILE,
96 GOTD_STATE_EXPECT_DONE,
100 struct gotd_client_capability {
105 struct gotd_object_id_array {
106 struct got_object_id **ids;
113 char unix_socket_path[PATH_MAX];
114 char unix_group_name[32];
116 struct gotd_repolist repos;
118 struct gotd_child_proc listen_proc;
121 const char *confpath;
126 enum gotd_imsg_type {
127 /* An error occured while processing a request. */
130 /* Commands used by gotctl(8). */
133 GOTD_IMSG_INFO_CLIENT,
136 /* Request a list of references. */
138 GOTD_IMSG_LIST_REFS_INTERNAL,
145 /* Git protocol capabilities. */
146 GOTD_IMSG_CAPABILITIES,
147 GOTD_IMSG_CAPABILITY,
149 /* Git protocol chatter. */
150 GOTD_IMSG_WANT, /* The client wants an object. */
151 GOTD_IMSG_HAVE, /* The client has an object. */
152 GOTD_IMSG_ACK, /* The server has an object or a reference. */
153 GOTD_IMSG_NAK, /* The server does not have an object/ref. */
154 GOTD_IMSG_REF_UPDATE, /* The client wants to update a reference. */
155 GOTD_IMSG_REF_DELETE, /* The client wants to delete a reference. */
156 GOTD_IMSG_FLUSH, /* The client sent a flush packet. */
157 GOTD_IMSG_DONE, /* The client is done chatting. */
159 /* Sending or receiving a pack file. */
160 GOTD_IMSG_SEND_PACKFILE, /* The server is sending a pack file. */
161 GOTD_IMSG_RECV_PACKFILE, /* The server is receiving a pack file. */
162 GOTD_IMSG_PACKIDX_FILE, /* Temporary file handle for new pack index. */
163 GOTD_IMSG_PACKFILE_PIPE, /* Pipe to send/receive a pack file stream. */
164 GOTD_IMSG_PACKFILE_PROGRESS, /* Progress reporting. */
165 GOTD_IMSG_PACKFILE_READY, /* Pack file is ready to be sent. */
166 GOTD_IMSG_PACKFILE_STATUS, /* Received pack success/failure status. */
167 GOTD_IMSG_PACKFILE_INSTALL, /* Received pack file can be installed. */
168 GOTD_IMSG_PACKFILE_DONE, /* Pack file has been sent/received. */
170 /* Reference updates. */
171 GOTD_IMSG_REF_UPDATES_START, /* Ref updates starting. */
172 GOTD_IMSG_REF_UPDATE_OK, /* Update went OK. */
173 GOTD_IMSG_REF_UPDATE_NG, /* Update was not good. */
174 GOTD_IMSG_REFS_UPDATED, /* The server proccessed all ref updates. */
176 /* Client connections. */
177 GOTD_IMSG_DISCONNECT,
180 /* Child process management. */
181 GOTD_IMSG_REPO_CHILD_READY,
183 /* Auth child process. */
184 GOTD_IMSG_AUTHENTICATE,
185 GOTD_IMSG_ACCESS_GRANTED,
188 /* Structure for GOTD_IMSG_ERROR. */
189 struct gotd_imsg_error {
190 int code; /* an error code from got_error.h */
191 int errno_code; /* in case code equals GOT_ERR_ERRNO */
193 char msg[GOT_ERR_MAX_MSG_SIZE];
194 } __attribute__((__packed__));
196 /* Structure for GOTD_IMSG_INFO. */
197 struct gotd_imsg_info {
203 /* Followed by nrepos GOTD_IMSG_INFO_REPO messages. */
204 /* Followed by nclients GOTD_IMSG_INFO_CLIENT messages. */
207 /* Structure for GOTD_IMSG_INFO_REPO. */
208 struct gotd_imsg_info_repo {
209 char repo_name[NAME_MAX];
210 char repo_path[PATH_MAX];
213 /* Structure for GOTD_IMSG_INFO_CLIENT */
214 struct gotd_imsg_info_client {
217 char repo_name[NAME_MAX];
219 enum gotd_client_state state;
220 size_t ncapabilities;
222 /* Followed by ncapabilities GOTD_IMSG_CAPABILITY. */
225 /* Structure for GOTD_IMSG_LIST_REFS. */
226 struct gotd_imsg_list_refs {
227 char repo_name[NAME_MAX];
228 int client_is_reading; /* 1 if reading, 0 if writing */
231 /* Structure for GOTD_IMSG_LIST_REFS_INTERNAL. */
232 struct gotd_imsg_list_refs_internal {
236 /* Structure for GOTD_IMSG_REFLIST. */
237 struct gotd_imsg_reflist {
240 /* Followed by nrefs times of gotd_imsg_ref/gotd_imsg_symref data. */
241 } __attribute__((__packed__));
243 /* Structure for GOTD_IMSG_REF data. */
244 struct gotd_imsg_ref {
245 uint8_t id[SHA1_DIGEST_LENGTH];
247 /* Followed by name_len data bytes. */
248 } __attribute__((__packed__));
250 /* Structure for GOTD_IMSG_SYMREF data. */
251 struct gotd_imsg_symref {
254 uint8_t target_id[SHA1_DIGEST_LENGTH];
257 * Followed by name_len + target_len data bytes.
259 } __attribute__((__packed__));
261 /* Structure for GOTD_IMSG_CAPABILITIES data. */
262 struct gotd_imsg_capabilities {
263 size_t ncapabilities;
266 * Followed by ncapabilities * GOTD_IMSG_CAPABILITY.
268 } __attribute__((__packed__));
270 /* Structure for GOTD_IMSG_CAPABILITY data. */
271 struct gotd_imsg_capability {
276 * Followed by key_len + value_len data bytes.
278 } __attribute__((__packed__));
280 /* Structure for GOTD_IMSG_WANT data. */
281 struct gotd_imsg_want {
282 uint8_t object_id[SHA1_DIGEST_LENGTH];
284 } __attribute__((__packed__));
286 /* Structure for GOTD_IMSG_HAVE data. */
287 struct gotd_imsg_have {
288 uint8_t object_id[SHA1_DIGEST_LENGTH];
290 } __attribute__((__packed__));
292 /* Structure for GOTD_IMSG_ACK data. */
293 struct gotd_imsg_ack {
294 uint8_t object_id[SHA1_DIGEST_LENGTH];
296 } __attribute__((__packed__));
298 /* Structure for GOTD_IMSG_NAK data. */
299 struct gotd_imsg_nak {
300 uint8_t object_id[SHA1_DIGEST_LENGTH];
302 } __attribute__((__packed__));
304 /* Structure for GOTD_IMSG_PACKFILE_STATUS data. */
305 struct gotd_imsg_packfile_status {
308 /* Followed by reason_len data bytes. */
309 } __attribute__((__packed__));
312 /* Structure for GOTD_IMSG_REF_UPDATE data. */
313 struct gotd_imsg_ref_update {
314 uint8_t old_id[SHA1_DIGEST_LENGTH];
315 uint8_t new_id[SHA1_DIGEST_LENGTH];
320 /* Followed by name_len data bytes. */
321 } __attribute__((__packed__));
323 /* Structure for GOTD_IMSG_REF_UPDATES_START data. */
324 struct gotd_imsg_ref_updates_start {
328 /* Followed by nref_updates GOT_IMSG_REF_UPDATE_OK/NG messages. */
331 /* Structure for GOTD_IMSG_REF_UPDATE_OK data. */
332 struct gotd_imsg_ref_update_ok {
333 uint8_t old_id[SHA1_DIGEST_LENGTH];
334 uint8_t new_id[SHA1_DIGEST_LENGTH];
339 /* Followed by name_len data bytes. */
340 } __attribute__((__packed__));
342 /* Structure for GOTD_IMSG_REF_UPDATE_NG data. */
343 struct gotd_imsg_ref_update_ng {
344 uint8_t old_id[SHA1_DIGEST_LENGTH];
345 uint8_t new_id[SHA1_DIGEST_LENGTH];
350 /* Followed by name_len + reason_len data bytes. */
351 } __attribute__((__packed__));
353 /* Structure for GOTD_IMSG_SEND_PACKFILE data. */
354 struct gotd_imsg_send_packfile {
358 /* delta cache file is sent as a file descriptor */
360 /* followed by two GOTD_IMSG_PACKFILE_PIPE messages */
363 /* Structure for GOTD_IMSG_RECV_PACKFILE data. */
364 struct gotd_imsg_recv_packfile {
368 /* pack destination temp file is sent as a file descriptor */
371 /* Structure for GOTD_IMSG_PACKFILE_PIPE data. */
372 struct gotd_imsg_packfile_pipe {
376 /* Structure for GOTD_IMSG_PACKIDX_FILE data. */
377 struct gotd_imsg_packidx_file {
383 * Structure for GOTD_IMSG_PACKFILE_PROGRESS and
384 * GOTD_IMSG_PACKFILE_READY data.
386 struct gotd_imsg_packfile_progress {
398 /* Structure for GOTD_IMSG_PACKFILE_INSTALL. */
399 struct gotd_imsg_packfile_install {
401 uint8_t pack_sha1[SHA1_DIGEST_LENGTH];
404 /* Structure for GOTD_IMSG_PACKFILE_DONE data. */
405 struct gotd_imsg_packfile_done {
409 /* Structure for GOTD_IMSG_DISCONNECT data. */
410 struct gotd_imsg_disconnect {
414 /* Structure for GOTD_IMSG_CONNECT. */
415 struct gotd_imsg_connect {
421 /* Structure for GOTD_IMSG_AUTHENTICATE. */
422 struct gotd_imsg_auth {
429 int parse_config(const char *, enum gotd_procid, struct gotd *);
432 const struct got_error *gotd_imsg_flush(struct imsgbuf *);
433 const struct got_error *gotd_imsg_recv(struct imsg *, struct imsgbuf *, size_t);
434 const struct got_error *gotd_imsg_poll_recv(struct imsg *, struct imsgbuf *,
436 const struct got_error *gotd_imsg_recv_error(uint32_t *client_id,
438 int gotd_imsg_send_error(struct imsgbuf *ibuf, uint32_t, uint32_t,
439 const struct got_error *);
440 int gotd_imsg_send_error_event(struct gotd_imsgev *, uint32_t, uint32_t,
441 const struct got_error *);
442 void gotd_imsg_event_add(struct gotd_imsgev *);
443 int gotd_imsg_compose_event(struct gotd_imsgev *, uint16_t, uint32_t, int,
445 int gotd_imsg_forward(struct gotd_imsgev *, struct imsg *, int);
447 void gotd_imsg_send_ack(struct got_object_id *, struct imsgbuf *,
449 void gotd_imsg_send_nak(struct got_object_id *, struct imsgbuf *,