Blob


1 /*
2 * Copyright (c) 2022 Stefan Sperling <stsp@openbsd.org>
3 *
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.
7 *
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.
15 */
17 #include <sys/types.h>
18 #include <sys/queue.h>
19 #include <sys/uio.h>
21 #include <errno.h>
22 #include <event.h>
23 #include <poll.h>
24 #include <limits.h>
25 #include <sha1.h>
26 #include <sha2.h>
27 #include <stdio.h>
28 #include <stdint.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <imsg.h>
32 #include <unistd.h>
34 #include "got_error.h"
35 #include "got_serve.h"
36 #include "got_path.h"
37 #include "got_version.h"
38 #include "got_reference.h"
39 #include "got_object.h"
41 #include "got_lib_pkt.h"
42 #include "got_lib_dial.h"
43 #include "got_lib_gitproto.h"
44 #include "got_lib_hash.h"
45 #include "got_lib_poll.h"
47 #include "gotd.h"
49 #ifndef nitems
50 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
51 #endif
53 static const struct got_capability read_capabilities[] = {
54 { GOT_CAPA_AGENT, "got/" GOT_VERSION_STR },
55 { GOT_CAPA_OFS_DELTA, NULL },
56 { GOT_CAPA_SIDE_BAND_64K, NULL },
57 };
59 static const struct got_capability write_capabilities[] = {
60 { GOT_CAPA_AGENT, "got/" GOT_VERSION_STR },
61 { GOT_CAPA_OFS_DELTA, NULL },
62 { GOT_CAPA_REPORT_STATUS, NULL },
63 { GOT_CAPA_NO_THIN, NULL },
64 { GOT_CAPA_DELETE_REFS, NULL },
65 };
67 static const struct got_error *
68 append_read_capabilities(size_t *capalen, size_t len, const char *symrefstr,
69 uint8_t *buf, size_t bufsize)
70 {
71 struct got_capability capa[nitems(read_capabilities) + 1];
72 size_t ncapa;
74 memcpy(&capa, read_capabilities, sizeof(read_capabilities));
75 if (symrefstr) {
76 capa[nitems(read_capabilities)].key = "symref";
77 capa[nitems(read_capabilities)].value = symrefstr;
78 ncapa = nitems(capa);
79 } else
80 ncapa = nitems(read_capabilities);
82 return got_gitproto_append_capabilities(capalen, buf, len,
83 bufsize, capa, ncapa);
84 }
86 static const struct got_error *
87 send_ref(int outfd, uint8_t *id, const char *refname, int send_capabilities,
88 int client_is_reading, const char *symrefstr, int chattygot)
89 {
90 const struct got_error *err = NULL;
91 char hex[SHA1_DIGEST_STRING_LENGTH];
92 char buf[GOT_PKT_MAX];
93 size_t len, capalen = 0;
95 if (got_sha1_digest_to_str(id, hex, sizeof(hex)) == NULL)
96 return got_error(GOT_ERR_BAD_OBJ_ID);
98 len = snprintf(buf, sizeof(buf), "%s %s", hex, refname);
99 if (len >= sizeof(buf))
100 return got_error(GOT_ERR_NO_SPACE);
102 if (send_capabilities) {
103 if (client_is_reading) {
104 err = append_read_capabilities(&capalen, len,
105 symrefstr, buf, sizeof(buf));
106 } else {
107 err = got_gitproto_append_capabilities(&capalen,
108 buf, len, sizeof(buf), write_capabilities,
109 nitems(write_capabilities));
111 if (err)
112 return err;
113 len += capalen;
116 if (len + 1 >= sizeof(buf))
117 return got_error(GOT_ERR_NO_SPACE);
118 buf[len] = '\n';
119 len++;
120 buf[len] = '\0';
122 return got_pkt_writepkt(outfd, buf, len, chattygot);
125 static const struct got_error *
126 send_zero_refs(int outfd, int client_is_reading, int chattygot)
128 const struct got_error *err = NULL;
129 const char *line = GOT_SHA1_STRING_ZERO " capabilities^{}";
130 char buf[GOT_PKT_MAX];
131 size_t len, capalen = 0;
133 len = strlcpy(buf, line, sizeof(buf));
134 if (len >= sizeof(buf))
135 return got_error(GOT_ERR_NO_SPACE);
137 if (client_is_reading) {
138 err = got_gitproto_append_capabilities(&capalen, buf, len,
139 sizeof(buf), read_capabilities, nitems(read_capabilities));
140 if (err)
141 return err;
142 } else {
143 err = got_gitproto_append_capabilities(&capalen, buf, len,
144 sizeof(buf), write_capabilities,
145 nitems(write_capabilities));
146 if (err)
147 return err;
150 return got_pkt_writepkt(outfd, buf, len + capalen, chattygot);
153 static void
154 echo_error(const struct got_error *err, int outfd, int chattygot)
156 char buf[4 + GOT_ERR_MAX_MSG_SIZE];
157 size_t len;
159 /*
160 * Echo the error to the client on a pkt-line.
161 * The client should then terminate its session.
162 */
163 buf[0] = 'E'; buf[1] = 'R'; buf[2] = 'R'; buf[3] = ' '; buf[4] = '\0';
164 len = strlcat(buf, err->msg, sizeof(buf));
165 got_pkt_writepkt(outfd, buf, len, chattygot);
168 static const struct got_error *
169 announce_refs(int outfd, struct imsgbuf *ibuf, int client_is_reading,
170 const char *repo_path, int chattygot)
172 const struct got_error *err = NULL;
173 struct imsg imsg;
174 size_t datalen;
175 struct gotd_imsg_list_refs lsref;
176 struct gotd_imsg_reflist ireflist;
177 struct gotd_imsg_ref iref;
178 struct gotd_imsg_symref isymref;
179 size_t nrefs = 0;
180 int have_nrefs = 0, sent_capabilities = 0;
181 char *symrefname = NULL, *symreftarget = NULL, *symrefstr = NULL;
182 char *refname = NULL;
184 memset(&imsg, 0, sizeof(imsg));
185 memset(&lsref, 0, sizeof(lsref));
187 if (strlcpy(lsref.repo_name, repo_path, sizeof(lsref.repo_name)) >=
188 sizeof(lsref.repo_name))
189 return got_error(GOT_ERR_NO_SPACE);
190 lsref.client_is_reading = client_is_reading;
192 if (imsg_compose(ibuf, GOTD_IMSG_LIST_REFS, 0, 0, -1,
193 &lsref, sizeof(lsref)) == -1)
194 return got_error_from_errno("imsg_compose LIST_REFS");
196 err = gotd_imsg_flush(ibuf);
197 if (err)
198 return err;
200 while (!have_nrefs || nrefs > 0) {
201 err = gotd_imsg_poll_recv(&imsg, ibuf, 0);
202 if (err)
203 goto done;
204 datalen = imsg.hdr.len - IMSG_HEADER_SIZE;
205 switch (imsg.hdr.type) {
206 case GOTD_IMSG_ERROR:
207 err = gotd_imsg_recv_error(NULL, &imsg);
208 goto done;
209 case GOTD_IMSG_REFLIST:
210 if (have_nrefs || nrefs > 0) {
211 err = got_error(GOT_ERR_PRIVSEP_MSG);
212 goto done;
214 if (datalen != sizeof(ireflist)) {
215 err = got_error(GOT_ERR_PRIVSEP_MSG);
216 goto done;
218 memcpy(&ireflist, imsg.data, sizeof(ireflist));
219 nrefs = ireflist.nrefs;
220 have_nrefs = 1;
221 if (nrefs == 0)
222 err = send_zero_refs(outfd, client_is_reading,
223 chattygot);
224 break;
225 case GOTD_IMSG_REF:
226 if (!have_nrefs || nrefs == 0) {
227 err = got_error(GOT_ERR_PRIVSEP_MSG);
228 goto done;
230 if (datalen < sizeof(iref)) {
231 err = got_error(GOT_ERR_PRIVSEP_MSG);
232 goto done;
234 memcpy(&iref, imsg.data, sizeof(iref));
235 if (datalen != sizeof(iref) + iref.name_len) {
236 err = got_error(GOT_ERR_PRIVSEP_LEN);
237 goto done;
239 refname = strndup(imsg.data + sizeof(iref),
240 iref.name_len);
241 if (refname == NULL) {
242 err = got_error_from_errno("strndup");
243 goto done;
245 err = send_ref(outfd, iref.id, refname,
246 !sent_capabilities, client_is_reading,
247 NULL, chattygot);
248 free(refname);
249 refname = NULL;
250 if (err)
251 goto done;
252 sent_capabilities = 1;
253 if (nrefs > 0)
254 nrefs--;
255 break;
256 case GOTD_IMSG_SYMREF:
257 if (!have_nrefs || nrefs == 0) {
258 err = got_error(GOT_ERR_PRIVSEP_MSG);
259 goto done;
261 if (datalen < sizeof(isymref)) {
262 err = got_error(GOT_ERR_PRIVSEP_LEN);
263 goto done;
265 memcpy(&isymref, imsg.data, sizeof(isymref));
266 if (datalen != sizeof(isymref) + isymref.name_len +
267 isymref.target_len) {
268 err = got_error(GOT_ERR_PRIVSEP_LEN);
269 goto done;
272 /*
273 * For now, we only announce one symbolic ref,
274 * as part of our capability advertisement.
275 */
276 if (sent_capabilities || symrefstr != NULL ||
277 symrefname != NULL || symreftarget != NULL)
278 break;
280 symrefname = strndup(imsg.data + sizeof(isymref),
281 isymref.name_len);
282 if (symrefname == NULL) {
283 err = got_error_from_errno("malloc");
284 goto done;
287 symreftarget = strndup(
288 imsg.data + sizeof(isymref) + isymref.name_len,
289 isymref.target_len);
290 if (symreftarget == NULL) {
291 err = got_error_from_errno("strndup");
292 goto done;
295 if (asprintf(&symrefstr, "%s:%s", symrefname,
296 symreftarget) == -1) {
297 err = got_error_from_errno("asprintf");
298 goto done;
300 err = send_ref(outfd, isymref.target_id, symrefname,
301 !sent_capabilities, client_is_reading, symrefstr,
302 chattygot);
303 free(refname);
304 refname = NULL;
305 if (err)
306 goto done;
307 sent_capabilities = 1;
308 if (nrefs > 0)
309 nrefs--;
310 break;
311 default:
312 err = got_error(GOT_ERR_PRIVSEP_MSG);
313 break;
316 imsg_free(&imsg);
319 err = got_pkt_flushpkt(outfd, chattygot);
320 if (err)
321 goto done;
322 done:
323 free(symrefstr);
324 free(symrefname);
325 free(symreftarget);
326 return err;
329 static const struct got_error *
330 parse_want_line(char **common_capabilities, uint8_t *id, char *buf, size_t len)
332 const struct got_error *err;
333 char *id_str = NULL, *client_capabilities = NULL;
335 err = got_gitproto_parse_want_line(&id_str,
336 &client_capabilities, buf, len);
337 if (err)
338 return err;
340 if (!got_parse_hash_digest(id, id_str, GOT_HASH_SHA1)) {
341 err = got_error_msg(GOT_ERR_BAD_PACKET,
342 "want-line with bad object ID");
343 goto done;
346 if (client_capabilities) {
347 err = got_gitproto_match_capabilities(common_capabilities,
348 NULL, client_capabilities, read_capabilities,
349 nitems(read_capabilities));
350 if (err)
351 goto done;
353 done:
354 free(id_str);
355 free(client_capabilities);
356 return err;
359 static const struct got_error *
360 parse_have_line(uint8_t *id, char *buf, size_t len)
362 const struct got_error *err;
363 char *id_str = NULL;
365 err = got_gitproto_parse_have_line(&id_str, buf, len);
366 if (err)
367 return err;
369 if (!got_parse_hash_digest(id, id_str, GOT_HASH_SHA1)) {
370 err = got_error_msg(GOT_ERR_BAD_PACKET,
371 "have-line with bad object ID");
372 goto done;
374 done:
375 free(id_str);
376 return err;
379 static const struct got_error *
380 send_capability(struct got_capability *capa, struct imsgbuf *ibuf)
382 const struct got_error *err = NULL;
383 struct gotd_imsg_capability icapa;
384 size_t len;
385 struct ibuf *wbuf;
387 memset(&icapa, 0, sizeof(icapa));
389 icapa.key_len = strlen(capa->key);
390 len = sizeof(icapa) + icapa.key_len;
391 if (capa->value) {
392 icapa.value_len = strlen(capa->value);
393 len += icapa.value_len;
396 wbuf = imsg_create(ibuf, GOTD_IMSG_CAPABILITY, 0, 0, len);
397 if (wbuf == NULL) {
398 err = got_error_from_errno("imsg_create CAPABILITY");
399 return err;
402 if (imsg_add(wbuf, &icapa, sizeof(icapa)) == -1)
403 return got_error_from_errno("imsg_add CAPABILITY");
404 if (imsg_add(wbuf, capa->key, icapa.key_len) == -1)
405 return got_error_from_errno("imsg_add CAPABILITY");
406 if (capa->value) {
407 if (imsg_add(wbuf, capa->value, icapa.value_len) == -1)
408 return got_error_from_errno("imsg_add CAPABILITY");
411 imsg_close(ibuf, wbuf);
413 return NULL;
416 static const struct got_error *
417 send_capabilities(int *use_sidebands, int *report_status,
418 char *capabilities_str, struct imsgbuf *ibuf)
420 const struct got_error *err = NULL;
421 struct gotd_imsg_capabilities icapas;
422 struct got_capability *capa = NULL;
423 size_t ncapa, i;
425 err = got_gitproto_split_capabilities_str(&capa, &ncapa,
426 capabilities_str);
427 if (err)
428 return err;
430 icapas.ncapabilities = ncapa;
431 if (imsg_compose(ibuf, GOTD_IMSG_CAPABILITIES, 0, 0, -1,
432 &icapas, sizeof(icapas)) == -1) {
433 err = got_error_from_errno("imsg_compose IMSG_CAPABILITIES");
434 goto done;
437 for (i = 0; i < ncapa; i++) {
438 err = send_capability(&capa[i], ibuf);
439 if (err)
440 goto done;
441 if (use_sidebands &&
442 strcmp(capa[i].key, GOT_CAPA_SIDE_BAND_64K) == 0)
443 *use_sidebands = 1;
444 if (report_status &&
445 strcmp(capa[i].key, GOT_CAPA_REPORT_STATUS) == 0)
446 *report_status = 1;
448 done:
449 free(capa);
450 return err;
453 static const struct got_error *
454 forward_flushpkt(struct imsgbuf *ibuf)
456 if (imsg_compose(ibuf, GOTD_IMSG_FLUSH, 0, 0, -1, NULL, 0) == -1)
457 return got_error_from_errno("imsg_compose FLUSH");
459 return gotd_imsg_flush(ibuf);
462 static const struct got_error *
463 recv_ack(struct imsg *imsg, uint8_t *expected_id)
465 struct gotd_imsg_ack iack;
466 size_t datalen;
468 datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
469 if (datalen != sizeof(iack))
470 return got_error(GOT_ERR_PRIVSEP_LEN);
472 memcpy(&iack, imsg->data, sizeof(iack));
473 if (memcmp(iack.object_id, expected_id, SHA1_DIGEST_LENGTH) != 0)
474 return got_error(GOT_ERR_BAD_OBJ_ID);
476 return NULL;
479 static const struct got_error *
480 recv_nak(struct imsg *imsg, uint8_t *expected_id)
482 struct gotd_imsg_ack inak;
483 size_t datalen;
485 datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
486 if (datalen != sizeof(inak))
487 return got_error(GOT_ERR_PRIVSEP_LEN);
489 memcpy(&inak, imsg->data, sizeof(inak));
490 if (memcmp(inak.object_id, expected_id, SHA1_DIGEST_LENGTH) != 0)
491 return got_error(GOT_ERR_BAD_OBJ_ID);
493 return NULL;
497 static const struct got_error *
498 recv_want(int *use_sidebands, int outfd, struct imsgbuf *ibuf,
499 char *buf, size_t len, int expect_capabilities, int chattygot)
501 const struct got_error *err;
502 struct gotd_imsg_want iwant;
503 char *capabilities_str;
504 int done = 0;
505 struct imsg imsg;
507 memset(&iwant, 0, sizeof(iwant));
508 memset(&imsg, 0, sizeof(imsg));
510 err = parse_want_line(&capabilities_str, iwant.object_id, buf, len);
511 if (err)
512 return err;
514 if (capabilities_str) {
515 if (!expect_capabilities) {
516 err = got_error_msg(GOT_ERR_BAD_PACKET,
517 "unexpected capability announcement received");
518 goto done;
520 err = send_capabilities(use_sidebands, NULL, capabilities_str,
521 ibuf);
522 if (err)
523 goto done;
527 if (imsg_compose(ibuf, GOTD_IMSG_WANT, 0, 0, -1,
528 &iwant, sizeof(iwant)) == -1) {
529 err = got_error_from_errno("imsg_compose WANT");
530 goto done;
533 err = gotd_imsg_flush(ibuf);
534 if (err)
535 goto done;
537 /*
538 * Wait for an ACK, or an error in case the desired object
539 * does not exist.
540 */
541 while (!done && err == NULL) {
542 err = gotd_imsg_poll_recv(&imsg, ibuf, 0);
543 if (err)
544 break;
545 switch (imsg.hdr.type) {
546 case GOTD_IMSG_ERROR:
547 err = gotd_imsg_recv_error(NULL, &imsg);
548 break;
549 case GOTD_IMSG_ACK:
550 err = recv_ack(&imsg, iwant.object_id);
551 if (err)
552 break;
553 done = 1;
554 break;
555 default:
556 err = got_error(GOT_ERR_PRIVSEP_MSG);
557 break;
560 imsg_free(&imsg);
562 done:
563 free(capabilities_str);
564 return err;
567 static const struct got_error *
568 send_ack(int outfd, uint8_t *id, int chattygot)
570 char hex[SHA1_DIGEST_STRING_LENGTH];
571 char buf[GOT_PKT_MAX];
572 int len;
574 if (got_sha1_digest_to_str(id, hex, sizeof(hex)) == NULL)
575 return got_error(GOT_ERR_BAD_OBJ_ID);
577 len = snprintf(buf, sizeof(buf), "ACK %s\n", hex);
578 if (len >= sizeof(buf))
579 return got_error(GOT_ERR_NO_SPACE);
581 return got_pkt_writepkt(outfd, buf, len, chattygot);
584 static const struct got_error *
585 send_nak(int outfd, int chattygot)
587 char buf[5];
588 int len;
590 len = snprintf(buf, sizeof(buf), "NAK\n");
591 if (len >= sizeof(buf))
592 return got_error(GOT_ERR_NO_SPACE);
594 return got_pkt_writepkt(outfd, buf, len, chattygot);
597 static const struct got_error *
598 recv_have(int *have_ack, int outfd, struct imsgbuf *ibuf, char *buf,
599 size_t len, int chattygot)
601 const struct got_error *err;
602 struct gotd_imsg_have ihave;
603 int done = 0;
604 struct imsg imsg;
606 memset(&ihave, 0, sizeof(ihave));
607 memset(&imsg, 0, sizeof(imsg));
609 err = parse_have_line(ihave.object_id, buf, len);
610 if (err)
611 return err;
613 if (imsg_compose(ibuf, GOTD_IMSG_HAVE, 0, 0, -1,
614 &ihave, sizeof(ihave)) == -1)
615 return got_error_from_errno("imsg_compose HAVE");
617 err = gotd_imsg_flush(ibuf);
618 if (err)
619 return err;
621 /*
622 * Wait for an ACK or a NAK, indicating whether a common
623 * commit object has been found.
624 */
625 while (!done && err == NULL) {
626 err = gotd_imsg_poll_recv(&imsg, ibuf, 0);
627 if (err)
628 return err;
629 switch (imsg.hdr.type) {
630 case GOTD_IMSG_ERROR:
631 err = gotd_imsg_recv_error(NULL, &imsg);
632 break;
633 case GOTD_IMSG_ACK:
634 err = recv_ack(&imsg, ihave.object_id);
635 if (err)
636 break;
637 if (!*have_ack) {
638 err = send_ack(outfd, ihave.object_id,
639 chattygot);
640 if (err)
641 return err;
642 *have_ack = 1;
644 done = 1;
645 break;
646 case GOTD_IMSG_NAK:
647 err = recv_nak(&imsg, ihave.object_id);
648 if (err)
649 break;
650 done = 1;
651 break;
652 default:
653 err = got_error(GOT_ERR_PRIVSEP_MSG);
654 break;
657 imsg_free(&imsg);
660 return err;
663 static const struct got_error *
664 recv_done(int *packfd, int outfd, struct imsgbuf *ibuf, int chattygot)
666 const struct got_error *err;
667 struct imsg imsg;
668 int fd;
670 *packfd = -1;
672 if (imsg_compose(ibuf, GOTD_IMSG_DONE, 0, 0, -1, NULL, 0) == -1)
673 return got_error_from_errno("imsg_compose DONE");
675 err = gotd_imsg_flush(ibuf);
676 if (err)
677 return err;
679 while (*packfd == -1 && err == NULL) {
680 err = gotd_imsg_poll_recv(&imsg, ibuf, 0);
681 if (err)
682 break;
684 switch (imsg.hdr.type) {
685 case GOTD_IMSG_ERROR:
686 err = gotd_imsg_recv_error(NULL, &imsg);
687 break;
688 case GOTD_IMSG_PACKFILE_PIPE:
689 fd = imsg_get_fd(&imsg);
690 if (fd != -1)
691 *packfd = fd;
692 else
693 err = got_error(GOT_ERR_PRIVSEP_NO_FD);
694 break;
695 default:
696 err = got_error(GOT_ERR_PRIVSEP_MSG);
697 break;
700 imsg_free(&imsg);
703 return err;
706 static const struct got_error *
707 relay_progress_reports(struct imsgbuf *ibuf, int outfd, int chattygot)
709 const struct got_error *err = NULL;
710 int pack_starting = 0;
711 struct gotd_imsg_packfile_progress iprog;
712 char buf[GOT_PKT_MAX];
713 struct imsg imsg;
714 size_t datalen;
715 int p_deltify = 0, n;
716 const char *eol = "\r";
718 memset(&imsg, 0, sizeof(imsg));
720 while (!pack_starting && err == NULL) {
721 err = gotd_imsg_poll_recv(&imsg, ibuf, 0);
722 if (err)
723 break;
725 datalen = imsg.hdr.len - IMSG_HEADER_SIZE;
726 switch (imsg.hdr.type) {
727 case GOTD_IMSG_ERROR:
728 err = gotd_imsg_recv_error(NULL, &imsg);
729 break;
730 case GOTD_IMSG_PACKFILE_READY:
731 eol = "\n";
732 pack_starting = 1;
733 /* fallthrough */
734 case GOTD_IMSG_PACKFILE_PROGRESS:
735 if (datalen != sizeof(iprog)) {
736 err = got_error(GOT_ERR_PRIVSEP_LEN);
737 break;
739 memcpy(&iprog, imsg.data, sizeof(iprog));
740 if (iprog.nobj_total > 0) {
741 p_deltify = (iprog.nobj_deltify * 100) /
742 iprog.nobj_total;
744 buf[0] = GOT_SIDEBAND_PROGRESS_INFO;
745 n = snprintf(&buf[1], sizeof(buf) - 1,
746 "%d commits colored, "
747 "%d objects found, "
748 "deltify %d%%%s",
749 iprog.ncolored,
750 iprog.nfound,
751 p_deltify, eol);
752 if (n >= sizeof(buf) - 1)
753 break;
754 err = got_pkt_writepkt(outfd, buf, 1 + n, chattygot);
755 break;
756 default:
757 err = got_error(GOT_ERR_PRIVSEP_MSG);
758 break;
761 imsg_free(&imsg);
764 return err;
767 static const struct got_error *
768 serve_read(int infd, int outfd, int gotd_sock, const char *repo_path,
769 int chattygot)
771 const struct got_error *err = NULL;
772 char buf[GOT_PKT_MAX];
773 struct imsgbuf ibuf;
774 enum protostate {
775 STATE_EXPECT_WANT,
776 STATE_EXPECT_MORE_WANT,
777 STATE_EXPECT_HAVE,
778 STATE_EXPECT_DONE,
779 STATE_DONE,
780 };
781 enum protostate curstate = STATE_EXPECT_WANT;
782 int have_ack = 0, use_sidebands = 0, seen_have = 0;
783 int packfd = -1;
784 size_t pack_chunksize;
786 imsg_init(&ibuf, gotd_sock);
788 err = announce_refs(outfd, &ibuf, 1, repo_path, chattygot);
789 if (err)
790 goto done;
792 while (curstate != STATE_DONE) {
793 int n;
794 buf[0] = '\0';
795 err = got_pkt_readpkt(&n, infd, buf, sizeof(buf), chattygot);
796 if (err)
797 goto done;
798 if (n == 0) {
799 if (curstate != STATE_EXPECT_WANT &&
800 curstate != STATE_EXPECT_MORE_WANT &&
801 curstate != STATE_EXPECT_HAVE &&
802 curstate != STATE_EXPECT_DONE) {
803 err = got_error_msg(GOT_ERR_BAD_PACKET,
804 "unexpected flush packet received");
805 goto done;
808 if (curstate == STATE_EXPECT_WANT) {
809 ssize_t r;
810 /*
811 * If the client does not want to fetch
812 * anything we should receive a flush
813 * packet followed by EOF.
814 */
815 r = read(infd, buf, sizeof(buf));
816 if (r == -1) {
817 err = got_error_from_errno("read");
818 goto done;
820 if (r == 0) /* EOF */
821 goto done;
823 /* Zero-length field followed by payload. */
824 err = got_error_msg(GOT_ERR_BAD_PACKET,
825 "unexpected flush packet received");
826 goto done;
829 if (curstate == STATE_EXPECT_WANT ||
830 curstate == STATE_EXPECT_MORE_WANT ||
831 curstate == STATE_EXPECT_HAVE) {
832 err = forward_flushpkt(&ibuf);
833 if (err)
834 goto done;
836 if (curstate == STATE_EXPECT_HAVE && !have_ack) {
837 err = send_nak(outfd, chattygot);
838 if (err)
839 goto done;
841 if (curstate == STATE_EXPECT_MORE_WANT)
842 curstate = STATE_EXPECT_HAVE;
843 else
844 curstate = STATE_EXPECT_DONE;
845 } else if (n >= 5 && strncmp(buf, "want ", 5) == 0) {
846 if (curstate != STATE_EXPECT_WANT &&
847 curstate != STATE_EXPECT_MORE_WANT) {
848 err = got_error_msg(GOT_ERR_BAD_PACKET,
849 "unexpected 'want' packet");
850 goto done;
852 err = recv_want(&use_sidebands, outfd, &ibuf, buf, n,
853 curstate == STATE_EXPECT_WANT ? 1 : 0, chattygot);
854 if (err)
855 goto done;
856 if (curstate == STATE_EXPECT_WANT)
857 curstate = STATE_EXPECT_MORE_WANT;
858 } else if (n >= 5 && strncmp(buf, "have ", 5) == 0) {
859 if (curstate != STATE_EXPECT_HAVE &&
860 curstate != STATE_EXPECT_DONE) {
861 err = got_error_msg(GOT_ERR_BAD_PACKET,
862 "unexpected 'have' packet");
863 goto done;
865 if (curstate == STATE_EXPECT_HAVE) {
866 err = recv_have(&have_ack, outfd, &ibuf,
867 buf, n, chattygot);
868 if (err)
869 goto done;
870 seen_have = 1;
872 } else if (n == 5 && strncmp(buf, "done\n", 5) == 0) {
873 if (curstate != STATE_EXPECT_HAVE &&
874 curstate != STATE_EXPECT_DONE) {
875 err = got_error_msg(GOT_ERR_BAD_PACKET,
876 "unexpected 'done' packet");
877 goto done;
879 err = recv_done(&packfd, outfd, &ibuf, chattygot);
880 if (err)
881 goto done;
882 curstate = STATE_DONE;
883 break;
884 } else {
885 err = got_error(GOT_ERR_BAD_PACKET);
886 goto done;
890 if (!seen_have) {
891 err = send_nak(outfd, chattygot);
892 if (err)
893 goto done;
896 if (use_sidebands) {
897 err = relay_progress_reports(&ibuf, outfd, chattygot);
898 if (err)
899 goto done;
900 pack_chunksize = GOT_SIDEBAND_64K_PACKFILE_DATA_MAX;
901 } else
902 pack_chunksize = sizeof(buf);
904 for (;;) {
905 ssize_t r;
907 r = read(packfd, use_sidebands ? &buf[1] : buf,
908 pack_chunksize);
909 if (r == -1) {
910 err = got_error_from_errno("read");
911 break;
912 } else if (r == 0) {
913 err = got_pkt_flushpkt(outfd, chattygot);
914 break;
917 if (use_sidebands) {
918 buf[0] = GOT_SIDEBAND_PACKFILE_DATA;
919 err = got_pkt_writepkt(outfd, buf, 1 + r, chattygot);
920 if (err)
921 break;
922 } else {
923 err = got_poll_write_full(outfd, buf, r);
924 if (err) {
925 if (err->code == GOT_ERR_EOF)
926 err = NULL;
927 break;
931 done:
932 imsg_clear(&ibuf);
933 if (packfd != -1 && close(packfd) == -1 && err == NULL)
934 err = got_error_from_errno("close");
935 if (err)
936 echo_error(err, outfd, chattygot);
937 return err;
940 static const struct got_error *
941 parse_ref_update_line(char **common_capabilities, char **refname,
942 uint8_t *old_id, uint8_t *new_id, char *buf, size_t len)
944 const struct got_error *err;
945 char *old_id_str = NULL, *new_id_str = NULL;
946 char *client_capabilities = NULL;
948 *refname = NULL;
950 err = got_gitproto_parse_ref_update_line(&old_id_str, &new_id_str,
951 refname, &client_capabilities, buf, len);
952 if (err)
953 return err;
955 if (!got_parse_hash_digest(old_id, old_id_str, GOT_HASH_SHA1) ||
956 !got_parse_hash_digest(new_id, new_id_str, GOT_HASH_SHA1)) {
957 err = got_error_msg(GOT_ERR_BAD_PACKET,
958 "ref-update with bad object ID");
959 goto done;
961 if (!got_ref_name_is_valid(*refname)) {
962 err = got_error_msg(GOT_ERR_BAD_PACKET,
963 "ref-update with bad reference name");
964 goto done;
967 if (client_capabilities) {
968 err = got_gitproto_match_capabilities(common_capabilities,
969 NULL, client_capabilities, write_capabilities,
970 nitems(write_capabilities));
971 if (err)
972 goto done;
974 done:
975 free(old_id_str);
976 free(new_id_str);
977 free(client_capabilities);
978 if (err) {
979 free(*refname);
980 *refname = NULL;
982 return err;
985 static const struct got_error *
986 recv_ref_update(int *report_status, int outfd, struct imsgbuf *ibuf,
987 char *buf, size_t len, int expect_capabilities, int chattygot)
989 const struct got_error *err;
990 struct gotd_imsg_ref_update iref;
991 struct ibuf *wbuf;
992 char *capabilities_str = NULL, *refname = NULL;
993 int done = 0;
994 struct imsg imsg;
996 memset(&iref, 0, sizeof(iref));
997 memset(&imsg, 0, sizeof(imsg));
999 err = parse_ref_update_line(&capabilities_str, &refname,
1000 iref.old_id, iref.new_id, buf, len);
1001 if (err)
1002 return err;
1004 if (capabilities_str) {
1005 if (!expect_capabilities) {
1006 err = got_error_msg(GOT_ERR_BAD_PACKET,
1007 "unexpected capability announcement received");
1008 goto done;
1010 err = send_capabilities(NULL, report_status, capabilities_str,
1011 ibuf);
1012 if (err)
1013 goto done;
1016 iref.name_len = strlen(refname);
1017 len = sizeof(iref) + iref.name_len;
1018 wbuf = imsg_create(ibuf, GOTD_IMSG_REF_UPDATE, 0, 0, len);
1019 if (wbuf == NULL) {
1020 err = got_error_from_errno("imsg_create REF_UPDATE");
1021 goto done;
1024 if (imsg_add(wbuf, &iref, sizeof(iref)) == -1)
1025 return got_error_from_errno("imsg_add REF_UPDATE");
1026 if (imsg_add(wbuf, refname, iref.name_len) == -1)
1027 return got_error_from_errno("imsg_add REF_UPDATE");
1028 imsg_close(ibuf, wbuf);
1030 err = gotd_imsg_flush(ibuf);
1031 if (err)
1032 goto done;
1034 /* Wait for ACK or an error. */
1035 while (!done && err == NULL) {
1036 err = gotd_imsg_poll_recv(&imsg, ibuf, 0);
1037 if (err)
1038 break;
1039 switch (imsg.hdr.type) {
1040 case GOTD_IMSG_ERROR:
1041 err = gotd_imsg_recv_error(NULL, &imsg);
1042 break;
1043 case GOTD_IMSG_ACK:
1044 err = recv_ack(&imsg, iref.new_id);
1045 if (err)
1046 break;
1047 done = 1;
1048 break;
1049 default:
1050 err = got_error(GOT_ERR_PRIVSEP_MSG);
1051 break;
1054 imsg_free(&imsg);
1056 done:
1057 free(capabilities_str);
1058 free(refname);
1059 return err;
1062 static const struct got_error *
1063 recv_packfile(struct imsg *imsg, int infd)
1065 const struct got_error *err = NULL;
1066 size_t datalen;
1067 int packfd;
1068 char buf[GOT_PKT_MAX];
1069 int pack_done = 0;
1071 datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
1072 if (datalen != 0)
1073 return got_error(GOT_ERR_PRIVSEP_MSG);
1075 packfd = imsg_get_fd(imsg);
1076 if (packfd == -1)
1077 return got_error(GOT_ERR_PRIVSEP_NO_FD);
1079 while (!pack_done) {
1080 ssize_t r = 0;
1082 err = got_poll_fd(infd, POLLIN, 1);
1083 if (err) {
1084 if (err->code != GOT_ERR_TIMEOUT)
1085 break;
1086 err = NULL;
1087 } else {
1088 r = read(infd, buf, sizeof(buf));
1089 if (r == -1) {
1090 err = got_error_from_errno("read");
1091 break;
1093 if (r == 0) {
1095 * Git clients hang up their side of the
1096 * connection after sending the pack file.
1098 err = NULL;
1099 pack_done = 1;
1100 break;
1104 if (r == 0) {
1105 /* Detect gotd(8) closing the pack pipe when done. */
1106 err = got_poll_fd(packfd, 0, 1);
1107 if (err) {
1108 if (err->code != GOT_ERR_TIMEOUT &&
1109 err->code != GOT_ERR_EOF)
1110 break;
1111 if (err->code == GOT_ERR_EOF)
1112 pack_done = 1;
1113 err = NULL;
1115 } else {
1116 /* Write pack data and/or detect pipe being closed. */
1117 err = got_poll_write_full(packfd, buf, r);
1118 if (err) {
1119 if (err->code == GOT_ERR_EOF)
1120 err = NULL;
1121 break;
1126 close(packfd);
1127 return err;
1130 static const struct got_error *
1131 report_unpack_status(struct imsg *imsg, int outfd, int chattygot)
1133 const struct got_error *err = NULL;
1134 struct gotd_imsg_packfile_status istatus;
1135 char buf[GOT_PKT_MAX];
1136 size_t datalen, len;
1137 char *reason = NULL;
1139 datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
1140 if (datalen < sizeof(istatus))
1141 return got_error(GOT_ERR_PRIVSEP_LEN);
1142 memcpy(&istatus, imsg->data, sizeof(istatus));
1143 if (datalen != sizeof(istatus) + istatus.reason_len)
1144 return got_error(GOT_ERR_PRIVSEP_LEN);
1146 reason = strndup(imsg->data + sizeof(istatus), istatus.reason_len);
1147 if (reason == NULL) {
1148 err = got_error_from_errno("strndup");
1149 goto done;
1152 if (err == NULL)
1153 len = snprintf(buf, sizeof(buf), "unpack ok\n");
1154 else
1155 len = snprintf(buf, sizeof(buf), "unpack %s\n", reason);
1156 if (len >= sizeof(buf)) {
1157 err = got_error(GOT_ERR_NO_SPACE);
1158 goto done;
1161 err = got_pkt_writepkt(outfd, buf, len, chattygot);
1162 done:
1163 free(reason);
1164 return err;
1167 static const struct got_error *
1168 recv_ref_update_ok(struct imsg *imsg, int outfd, int chattygot)
1170 const struct got_error *err = NULL;
1171 struct gotd_imsg_ref_update_ok iok;
1172 size_t datalen, len;
1173 char buf[GOT_PKT_MAX];
1174 char *refname = NULL;
1176 datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
1177 if (datalen < sizeof(iok))
1178 return got_error(GOT_ERR_PRIVSEP_LEN);
1179 memcpy(&iok, imsg->data, sizeof(iok));
1180 if (datalen != sizeof(iok) + iok.name_len)
1181 return got_error(GOT_ERR_PRIVSEP_LEN);
1183 memcpy(&iok, imsg->data, sizeof(iok));
1185 refname = strndup(imsg->data + sizeof(iok), iok.name_len);
1186 if (refname == NULL)
1187 return got_error_from_errno("strndup");
1189 len = snprintf(buf, sizeof(buf), "ok %s\n", refname);
1190 if (len >= sizeof(buf)) {
1191 err = got_error(GOT_ERR_NO_SPACE);
1192 goto done;
1195 err = got_pkt_writepkt(outfd, buf, len, chattygot);
1196 done:
1197 free(refname);
1198 return err;
1201 static const struct got_error *
1202 recv_ref_update_ng(struct imsg *imsg, int outfd, int chattygot)
1204 const struct got_error *err = NULL;
1205 struct gotd_imsg_ref_update_ng ing;
1206 size_t datalen, len;
1207 char buf[GOT_PKT_MAX];
1208 char *refname = NULL, *reason = NULL;
1210 datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
1211 if (datalen < sizeof(ing))
1212 return got_error(GOT_ERR_PRIVSEP_LEN);
1213 memcpy(&ing, imsg->data, sizeof(ing));
1214 if (datalen != sizeof(ing) + ing.name_len + ing.reason_len)
1215 return got_error(GOT_ERR_PRIVSEP_LEN);
1217 memcpy(&ing, imsg->data, sizeof(ing));
1219 refname = strndup(imsg->data + sizeof(ing), ing.name_len);
1220 if (refname == NULL)
1221 return got_error_from_errno("strndup");
1223 reason = strndup(imsg->data + sizeof(ing) + ing.name_len,
1224 ing.reason_len);
1225 if (reason == NULL) {
1226 err = got_error_from_errno("strndup");
1227 goto done;
1230 len = snprintf(buf, sizeof(buf), "ng %s %s\n", refname, reason);
1231 if (len >= sizeof(buf)) {
1232 err = got_error(GOT_ERR_NO_SPACE);
1233 goto done;
1236 err = got_pkt_writepkt(outfd, buf, len, chattygot);
1237 done:
1238 free(refname);
1239 free(reason);
1240 return err;
1243 static const struct got_error *
1244 serve_write(int infd, int outfd, int gotd_sock, const char *repo_path,
1245 int chattygot)
1247 const struct got_error *err = NULL;
1248 char buf[GOT_PKT_MAX];
1249 struct imsgbuf ibuf;
1250 enum protostate {
1251 STATE_EXPECT_REF_UPDATE,
1252 STATE_EXPECT_MORE_REF_UPDATES,
1253 STATE_EXPECT_PACKFILE,
1254 STATE_PACKFILE_RECEIVED,
1255 STATE_REFS_UPDATED,
1257 enum protostate curstate = STATE_EXPECT_REF_UPDATE;
1258 struct imsg imsg;
1259 int report_status = 0;
1261 imsg_init(&ibuf, gotd_sock);
1262 memset(&imsg, 0, sizeof(imsg));
1264 err = announce_refs(outfd, &ibuf, 0, repo_path, chattygot);
1265 if (err)
1266 goto done;
1268 while (curstate != STATE_EXPECT_PACKFILE) {
1269 int n;
1270 buf[0] = '\0';
1271 err = got_pkt_readpkt(&n, infd, buf, sizeof(buf), chattygot);
1272 if (err)
1273 goto done;
1274 if (n == 0) {
1275 if (curstate == STATE_EXPECT_REF_UPDATE) {
1276 /* The client will not send us anything. */
1277 goto done;
1278 } else if (curstate != STATE_EXPECT_MORE_REF_UPDATES) {
1279 err = got_error_msg(GOT_ERR_BAD_PACKET,
1280 "unexpected flush packet received");
1281 goto done;
1283 err = forward_flushpkt(&ibuf);
1284 if (err)
1285 goto done;
1286 curstate = STATE_EXPECT_PACKFILE;
1287 } else if (n >= (SHA1_DIGEST_STRING_LENGTH * 2) + 2) {
1288 if (curstate != STATE_EXPECT_REF_UPDATE &&
1289 curstate != STATE_EXPECT_MORE_REF_UPDATES) {
1290 err = got_error_msg(GOT_ERR_BAD_PACKET,
1291 "unexpected ref-update packet");
1292 goto done;
1294 if (curstate == STATE_EXPECT_REF_UPDATE) {
1295 err = recv_ref_update(&report_status,
1296 outfd, &ibuf, buf, n, 1, chattygot);
1297 } else {
1298 err = recv_ref_update(NULL, outfd, &ibuf,
1299 buf, n, 0, chattygot);
1301 if (err)
1302 goto done;
1303 curstate = STATE_EXPECT_MORE_REF_UPDATES;
1304 } else {
1305 err = got_error(GOT_ERR_BAD_PACKET);
1306 goto done;
1310 while (curstate != STATE_PACKFILE_RECEIVED) {
1311 err = gotd_imsg_poll_recv(&imsg, &ibuf, 0);
1312 if (err)
1313 goto done;
1314 switch (imsg.hdr.type) {
1315 case GOTD_IMSG_ERROR:
1316 err = gotd_imsg_recv_error(NULL, &imsg);
1317 goto done;
1318 case GOTD_IMSG_PACKFILE_PIPE:
1319 err = recv_packfile(&imsg, infd);
1320 if (err) {
1321 if (err->code != GOT_ERR_EOF)
1322 goto done;
1324 * EOF is reported when the client hangs up,
1325 * which can happen with Git clients.
1326 * The socket should stay half-open so we
1327 * can still send our reports if requested.
1329 err = NULL;
1331 curstate = STATE_PACKFILE_RECEIVED;
1332 break;
1333 default:
1334 err = got_error(GOT_ERR_PRIVSEP_MSG);
1335 break;
1338 imsg_free(&imsg);
1339 if (err)
1340 goto done;
1343 while (curstate != STATE_REFS_UPDATED && err == NULL) {
1344 err = gotd_imsg_poll_recv(&imsg, &ibuf, 0);
1345 if (err)
1346 break;
1347 switch (imsg.hdr.type) {
1348 case GOTD_IMSG_ERROR:
1349 err = gotd_imsg_recv_error(NULL, &imsg);
1350 break;
1351 case GOTD_IMSG_PACKFILE_STATUS:
1352 if (!report_status)
1353 break;
1354 err = report_unpack_status(&imsg, outfd, chattygot);
1355 break;
1356 case GOTD_IMSG_REF_UPDATE_OK:
1357 if (!report_status)
1358 break;
1359 err = recv_ref_update_ok(&imsg, outfd, chattygot);
1360 break;
1361 case GOTD_IMSG_REF_UPDATE_NG:
1362 if (!report_status)
1363 break;
1364 err = recv_ref_update_ng(&imsg, outfd, chattygot);
1365 break;
1366 case GOTD_IMSG_REFS_UPDATED:
1367 curstate = STATE_REFS_UPDATED;
1368 err = got_pkt_flushpkt(outfd, chattygot);
1369 break;
1370 default:
1371 err = got_error(GOT_ERR_PRIVSEP_MSG);
1372 break;
1375 imsg_free(&imsg);
1377 done:
1378 imsg_clear(&ibuf);
1379 if (err)
1380 echo_error(err, outfd, chattygot);
1381 return err;
1384 const struct got_error *
1385 got_serve(int infd, int outfd, const char *command, const char *repo_path,
1386 int gotd_sock, int chattygot)
1388 const struct got_error *err = NULL;
1390 if (strcmp(command, GOT_DIAL_CMD_FETCH) == 0)
1391 err = serve_read(infd, outfd, gotd_sock, repo_path, chattygot);
1392 else if (strcmp(command, GOT_DIAL_CMD_SEND) == 0)
1393 err = serve_write(infd, outfd, gotd_sock, repo_path,
1394 chattygot);
1395 else
1396 err = got_error(GOT_ERR_BAD_PACKET);
1398 return err;