smart_pkt.c 12.6 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3
 *
Vicent Marti committed
4 5
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
6 7
 */

Vicent Marti committed
8 9
#include "common.h"

10 11
#include "git2/types.h"
#include "git2/errors.h"
12 13
#include "git2/refs.h"
#include "git2/revwalk.h"
14

15
#include "smart.h"
16
#include "util.h"
17
#include "netops.h"
18
#include "posix.h"
19
#include "buffer.h"
20

21 22 23
#include <ctype.h>

#define PKT_LEN_SIZE 4
24 25 26 27
static const char pkt_done_str[] = "0009done\n";
static const char pkt_flush_str[] = "0000";
static const char pkt_have_prefix[] = "0032have ";
static const char pkt_want_prefix[] = "0032want ";
28

29 30 31 32
static int flush_pkt(git_pkt **out)
{
	git_pkt *pkt;

33
	pkt = git__malloc(sizeof(git_pkt));
34
	GITERR_CHECK_ALLOC(pkt);
35 36 37 38

	pkt->type = GIT_PKT_FLUSH;
	*out = pkt;

39
	return 0;
40 41
}

42
/* the rest of the line will be useful for multi_ack and multi_ack_detailed */
43
static int ack_pkt(git_pkt **out, const char *line, size_t len)
Carlos Martín Nieto committed
44
{
45
	git_pkt_ack *pkt;
46 47
	GIT_UNUSED(line);
	GIT_UNUSED(len);
Carlos Martín Nieto committed
48

49
	pkt = git__calloc(1, sizeof(git_pkt_ack));
50
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
51 52

	pkt->type = GIT_PKT_ACK;
53 54 55 56 57 58 59 60 61 62 63 64
	line += 3;
	len -= 3;

	if (len >= GIT_OID_HEXSZ) {
		git_oid_fromstr(&pkt->oid, line + 1);
		line += GIT_OID_HEXSZ + 1;
		len -= GIT_OID_HEXSZ + 1;
	}

	if (len >= 7) {
		if (!git__prefixcmp(line + 1, "continue"))
			pkt->status = GIT_ACK_CONTINUE;
65 66 67 68
		if (!git__prefixcmp(line + 1, "common"))
			pkt->status = GIT_ACK_COMMON;
		if (!git__prefixcmp(line + 1, "ready"))
			pkt->status = GIT_ACK_READY;
69 70 71
	}

	*out = (git_pkt *) pkt;
Carlos Martín Nieto committed
72

73
	return 0;
Carlos Martín Nieto committed
74 75
}

Carlos Martín Nieto committed
76
static int nak_pkt(git_pkt **out)
Carlos Martín Nieto committed
77 78 79
{
	git_pkt *pkt;

80
	pkt = git__malloc(sizeof(git_pkt));
81
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
82

Carlos Martín Nieto committed
83 84 85
	pkt->type = GIT_PKT_NAK;
	*out = pkt;

86
	return 0;
Carlos Martín Nieto committed
87 88 89 90 91 92
}

static int pack_pkt(git_pkt **out)
{
	git_pkt *pkt;

93
	pkt = git__malloc(sizeof(git_pkt));
94
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
95 96

	pkt->type = GIT_PKT_PACK;
Carlos Martín Nieto committed
97 98
	*out = pkt;

99
	return 0;
Carlos Martín Nieto committed
100 101
}

102 103 104
static int comment_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_comment *pkt;
105
	size_t alloclen;
106

107 108 109
	GITERR_CHECK_ALLOC_ADD(&alloclen, sizeof(git_pkt_comment), len);
	GITERR_CHECK_ALLOC_ADD(&alloclen, alloclen, 1);
	pkt = git__malloc(alloclen);
110
	GITERR_CHECK_ALLOC(pkt);
111 112 113 114 115 116 117

	pkt->type = GIT_PKT_COMMENT;
	memcpy(pkt->comment, line, len);
	pkt->comment[len] = '\0';

	*out = (git_pkt *) pkt;

118
	return 0;
119 120
}

121 122 123
static int err_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_err *pkt;
124
	size_t alloclen;
125 126 127 128

	/* Remove "ERR " from the line */
	line += 4;
	len -= 4;
129

130 131 132
	GITERR_CHECK_ALLOC_ADD(&alloclen, sizeof(git_pkt_progress), len);
	GITERR_CHECK_ALLOC_ADD(&alloclen, alloclen, 1);
	pkt = git__malloc(alloclen);
133 134 135
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_ERR;
136
	pkt->len = (int)len;
137 138 139 140 141 142 143 144
	memcpy(pkt->error, line, len);
	pkt->error[len] = '\0';

	*out = (git_pkt *) pkt;

	return 0;
}

145 146 147
static int data_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_data *pkt;
148
	size_t alloclen;
149 150 151

	line++;
	len--;
152

153 154
	GITERR_CHECK_ALLOC_ADD(&alloclen, sizeof(git_pkt_progress), len);
	pkt = git__malloc(alloclen);
155 156 157 158 159 160 161 162 163 164 165
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_DATA;
	pkt->len = (int) len;
	memcpy(pkt->data, line, len);

	*out = (git_pkt *) pkt;

	return 0;
}

166
static int sideband_progress_pkt(git_pkt **out, const char *line, size_t len)
167 168
{
	git_pkt_progress *pkt;
169
	size_t alloclen;
170 171 172

	line++;
	len--;
173

174 175
	GITERR_CHECK_ALLOC_ADD(&alloclen, sizeof(git_pkt_progress), len);
	pkt = git__malloc(alloclen);
176 177 178 179 180 181 182 183 184 185 186
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_PROGRESS;
	pkt->len = (int) len;
	memcpy(pkt->data, line, len);

	*out = (git_pkt *) pkt;

	return 0;
}

187 188 189
static int sideband_error_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_err *pkt;
190
	size_t alloc_len;
191 192 193

	line++;
	len--;
194

195 196 197
	GITERR_CHECK_ALLOC_ADD(&alloc_len, sizeof(git_pkt_err), len);
	GITERR_CHECK_ALLOC_ADD(&alloc_len, alloc_len, 1);
	pkt = git__malloc(alloc_len);
198 199 200 201 202 203 204 205 206 207 208 209
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_ERR;
	pkt->len = (int)len;
	memcpy(pkt->error, line, len);
	pkt->error[len] = '\0';

	*out = (git_pkt *)pkt;

	return 0;
}

210
/*
211 212
 * Parse an other-ref line.
 */
Carlos Martín Nieto committed
213
static int ref_pkt(git_pkt **out, const char *line, size_t len)
214
{
215
	int error;
216
	git_pkt_ref *pkt;
217
	size_t alloclen;
218

219
	pkt = git__malloc(sizeof(git_pkt_ref));
220
	GITERR_CHECK_ALLOC(pkt);
221

222
	memset(pkt, 0x0, sizeof(git_pkt_ref));
223
	pkt->type = GIT_PKT_REF;
224
	if ((error = git_oid_fromstr(&pkt->head.oid, line)) < 0)
225
		goto error_out;
226 227 228

	/* Check for a bit of consistency */
	if (line[GIT_OID_HEXSZ] != ' ') {
229
		giterr_set(GITERR_NET, "error parsing pkt-line");
230
		error = -1;
231
		goto error_out;
232 233
	}

234
	/* Jump from the name */
235
	line += GIT_OID_HEXSZ + 1;
236
	len -= (GIT_OID_HEXSZ + 1);
237

238 239
	if (line[len - 1] == '\n')
		--len;
240

241 242
	GITERR_CHECK_ALLOC_ADD(&alloclen, len, 1);
	pkt->head.name = git__malloc(alloclen);
243 244
	GITERR_CHECK_ALLOC(pkt->head.name);

245 246
	memcpy(pkt->head.name, line, len);
	pkt->head.name[len] = '\0';
247

248
	if (strlen(pkt->head.name) < len) {
249
		pkt->capabilities = strchr(pkt->head.name, '\0') + 1;
250 251
	}

252 253 254 255 256
	*out = (git_pkt *)pkt;
	return 0;

error_out:
	git__free(pkt);
257
	return error;
258 259
}

260 261 262 263
static int ok_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_ok *pkt;
	const char *ptr;
264
	size_t alloc_len;
265

266
	pkt = git__malloc(sizeof(*pkt));
267 268 269 270 271
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_OK;

	line += 3; /* skip "ok " */
272
	if (!(ptr = strchr(line, '\n'))) {
273
		giterr_set(GITERR_NET, "invalid packet line");
274
		git__free(pkt);
275 276
		return -1;
	}
277 278
	len = ptr - line;

279 280
	GITERR_CHECK_ALLOC_ADD(&alloc_len, len, 1);
	pkt->ref = git__malloc(alloc_len);
281 282 283 284 285 286 287 288 289 290 291 292 293
	GITERR_CHECK_ALLOC(pkt->ref);

	memcpy(pkt->ref, line, len);
	pkt->ref[len] = '\0';

	*out = (git_pkt *)pkt;
	return 0;
}

static int ng_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_ng *pkt;
	const char *ptr;
294
	size_t alloclen;
295

296
	pkt = git__malloc(sizeof(*pkt));
297 298
	GITERR_CHECK_ALLOC(pkt);

299
	pkt->ref = NULL;
300 301 302
	pkt->type = GIT_PKT_NG;

	line += 3; /* skip "ng " */
303 304
	if (!(ptr = strchr(line, ' ')))
		goto out_err;
305 306
	len = ptr - line;

307 308
	GITERR_CHECK_ALLOC_ADD(&alloclen, len, 1);
	pkt->ref = git__malloc(alloclen);
309 310 311 312 313 314
	GITERR_CHECK_ALLOC(pkt->ref);

	memcpy(pkt->ref, line, len);
	pkt->ref[len] = '\0';

	line = ptr + 1;
315 316
	if (!(ptr = strchr(line, '\n')))
		goto out_err;
317 318
	len = ptr - line;

319 320
	GITERR_CHECK_ALLOC_ADD(&alloclen, len, 1);
	pkt->msg = git__malloc(alloclen);
321 322 323 324 325 326 327
	GITERR_CHECK_ALLOC(pkt->msg);

	memcpy(pkt->msg, line, len);
	pkt->msg[len] = '\0';

	*out = (git_pkt *)pkt;
	return 0;
328 329

out_err:
330
	giterr_set(GITERR_NET, "invalid packet line");
331 332 333
	git__free(pkt->ref);
	git__free(pkt);
	return -1;
334 335 336 337 338 339 340 341
}

static int unpack_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_unpack *pkt;

	GIT_UNUSED(len);

342
	pkt = git__malloc(sizeof(*pkt));
343 344 345 346 347 348 349 350 351 352 353 354
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_UNPACK;
	if (!git__prefixcmp(line, "unpack ok"))
		pkt->unpack_ok = 1;
	else
		pkt->unpack_ok = 0;

	*out = (git_pkt *)pkt;
	return 0;
}

355
static int32_t parse_len(const char *line)
356 357
{
	char num[PKT_LEN_SIZE + 1];
358
	int i, k, error;
359
	int32_t len;
360 361 362 363 364 365
	const char *num_end;

	memcpy(num, line, PKT_LEN_SIZE);
	num[PKT_LEN_SIZE] = '\0';

	for (i = 0; i < PKT_LEN_SIZE; ++i) {
366
		if (!isxdigit(num[i])) {
367 368 369 370 371 372 373 374
			/* Make sure there are no special characters before passing to error message */
			for (k = 0; k < PKT_LEN_SIZE; ++k) {
				if(!isprint(num[k])) {
					num[k] = '.';
				}
			}
			
			giterr_set(GITERR_NET, "invalid hex digit in length: '%s'", num);
375 376
			return -1;
		}
377 378
	}

379 380
	if ((error = git__strtol32(&len, num, &num_end, 16)) < 0)
		return error;
381

382
	return len;
383 384
}

385
/*
386 387
 * As per the documentation, the syntax is:
 *
Vicent Marti committed
388 389 390
 * pkt-line	= data-pkt / flush-pkt
 * data-pkt	= pkt-len pkt-payload
 * pkt-len		= 4*(HEXDIG)
391
 * pkt-payload = (pkt-len -4)*(OCTET)
Vicent Marti committed
392
 * flush-pkt	= "0000"
393 394 395 396 397
 *
 * Which means that the first four bytes are the length of the line,
 * in ASCII hexadecimal (including itself)
 */

398 399
int git_pkt_parse_line(
	git_pkt **head, const char *line, const char **out, size_t bufflen)
400
{
401 402
	int ret;
	int32_t len;
403

404
	/* Not even enough for the length */
405
	if (bufflen > 0 && bufflen < PKT_LEN_SIZE)
406
		return GIT_EBUFS;
407

408 409
	len = parse_len(line);
	if (len < 0) {
Carlos Martín Nieto committed
410 411 412 413 414
		/*
		 * If we fail to parse the length, it might be because the
		 * server is trying to send us the packfile already.
		 */
		if (bufflen >= 4 && !git__prefixcmp(line, "PACK")) {
Carlos Martín Nieto committed
415
			giterr_clear();
Carlos Martín Nieto committed
416 417 418 419
			*out = line;
			return pack_pkt(head);
		}

420
		return (int)len;
421
	}
422

423 424 425 426
	/*
	 * If we were given a buffer length, then make sure there is
	 * enough in the buffer to satisfy this line
	 */
427
	if (bufflen > 0 && bufflen < (size_t)len)
428
		return GIT_EBUFS;
429

430 431 432 433 434 435 436 437
	/*
	 * The length has to be exactly 0 in case of a flush
	 * packet or greater than PKT_LEN_SIZE, as the decoded
	 * length includes its own encoded length of four bytes.
	 */
	if (len != 0 && len < PKT_LEN_SIZE)
		return GIT_ERROR;

438
	line += PKT_LEN_SIZE;
439
	/*
440 441 442
	 * The Git protocol does not specify empty lines as part
	 * of the protocol. Not knowing what to do with an empty
	 * line, we should return an error upon hitting one.
443
	 */
444
	if (len == PKT_LEN_SIZE) {
445 446
		giterr_set_str(GITERR_NET, "Invalid empty packet");
		return GIT_ERROR;
447 448
	}

449 450 451
	if (len == 0) { /* Flush pkt */
		*out = line;
		return flush_pkt(head);
452 453
	}

454
	len -= PKT_LEN_SIZE; /* the encoded length includes its own size */
455

456 457 458
	if (*line == GIT_SIDE_BAND_DATA)
		ret = data_pkt(head, line, len);
	else if (*line == GIT_SIDE_BAND_PROGRESS)
459
		ret = sideband_progress_pkt(head, line, len);
460 461
	else if (*line == GIT_SIDE_BAND_ERROR)
		ret = sideband_error_pkt(head, line, len);
462
	else if (!git__prefixcmp(line, "ACK"))
463
		ret = ack_pkt(head, line, len);
Carlos Martín Nieto committed
464
	else if (!git__prefixcmp(line, "NAK"))
465
		ret = nak_pkt(head);
466 467
	else if (!git__prefixcmp(line, "ERR "))
		ret = err_pkt(head, line, len);
468
	else if (*line == '#')
469
		ret = comment_pkt(head, line, len);
470 471 472 473 474 475
	else if (!git__prefixcmp(line, "ok"))
		ret = ok_pkt(head, line, len);
	else if (!git__prefixcmp(line, "ng"))
		ret = ng_pkt(head, line, len);
	else if (!git__prefixcmp(line, "unpack"))
		ret = unpack_pkt(head, line, len);
Carlos Martín Nieto committed
476
	else
477
		ret = ref_pkt(head, line, len);
478 479 480

	*out = line + len;

481
	return ret;
482
}
483

484 485
void git_pkt_free(git_pkt *pkt)
{
486
	if (pkt->type == GIT_PKT_REF) {
487
		git_pkt_ref *p = (git_pkt_ref *) pkt;
488
		git__free(p->head.name);
489
		git__free(p->head.symref_target);
490 491
	}

492 493 494 495 496 497 498 499 500 501 502
	if (pkt->type == GIT_PKT_OK) {
		git_pkt_ok *p = (git_pkt_ok *) pkt;
		git__free(p->ref);
	}

	if (pkt->type == GIT_PKT_NG) {
		git_pkt_ng *p = (git_pkt_ng *) pkt;
		git__free(p->ref);
		git__free(p->msg);
	}

503
	git__free(pkt);
504 505
}

506 507
int git_pkt_buffer_flush(git_buf *buf)
{
508
	return git_buf_put(buf, pkt_flush_str, strlen(pkt_flush_str));
509 510
}

511
static int buffer_want_with_caps(const git_remote_head *head, transport_smart_caps *caps, git_buf *buf)
512
{
513
	git_buf str = GIT_BUF_INIT;
514
	char oid[GIT_OID_HEXSZ +1] = {0};
515
	size_t len;
516

517 518 519 520
	/* Prefer multi_ack_detailed */
	if (caps->multi_ack_detailed)
		git_buf_puts(&str, GIT_CAP_MULTI_ACK_DETAILED " ");
	else if (caps->multi_ack)
521 522
		git_buf_puts(&str, GIT_CAP_MULTI_ACK " ");

523 524 525 526 527 528
	/* Prefer side-band-64k if the server supports both */
	if (caps->side_band_64k)
		git_buf_printf(&str, "%s ", GIT_CAP_SIDE_BAND_64K);
	else if (caps->side_band)
		git_buf_printf(&str, "%s ", GIT_CAP_SIDE_BAND);

529 530 531
	if (caps->include_tag)
		git_buf_puts(&str, GIT_CAP_INCLUDE_TAG " ");

532 533 534
	if (caps->thin_pack)
		git_buf_puts(&str, GIT_CAP_THIN_PACK " ");

535 536 537
	if (caps->ofs_delta)
		git_buf_puts(&str, GIT_CAP_OFS_DELTA " ");

538 539
	if (git_buf_oom(&str))
		return -1;
540

541 542 543 544 545
	len = strlen("XXXXwant ") + GIT_OID_HEXSZ + 1 /* NUL */ +
		 git_buf_len(&str) + 1 /* LF */;

	if (len > 0xffff) {
		giterr_set(GITERR_NET,
546
			"tried to produce packet with invalid length %" PRIuZ, len);
547 548 549
		return -1;
	}

550
	git_buf_grow_by(buf, len);
551
	git_oid_fmt(oid, &head->oid);
552 553
	git_buf_printf(buf,
		"%04xwant %s %s\n", (unsigned int)len, oid, git_buf_cstr(&str));
554 555
	git_buf_free(&str);

556 557 558
	GITERR_CHECK_ALLOC_BUF(buf);

	return 0;
559 560
}

561 562 563 564 565
/*
 * All "want" packets have the same length and format, so what we do
 * is overwrite the OID each time.
 */

566 567 568 569 570
int git_pkt_buffer_wants(
	const git_remote_head * const *refs,
	size_t count,
	transport_smart_caps *caps,
	git_buf *buf)
571
{
572 573
	size_t i = 0;
	const git_remote_head *head;
574 575

	if (caps->common) {
576 577
		for (; i < count; ++i) {
			head = refs[i];
578 579 580 581
			if (!head->local)
				break;
		}

582
		if (buffer_want_with_caps(refs[i], caps, buf) < 0)
583
			return -1;
584 585 586 587

		i++;
	}

588
	for (; i < count; ++i) {
589 590
		char oid[GIT_OID_HEXSZ];

591
		head = refs[i];
592 593 594 595
		if (head->local)
			continue;

		git_oid_fmt(oid, &head->oid);
596
		git_buf_put(buf, pkt_want_prefix, strlen(pkt_want_prefix));
597
		git_buf_put(buf, oid, GIT_OID_HEXSZ);
598
		git_buf_putc(buf, '\n');
599 600
		if (git_buf_oom(buf))
			return -1;
601 602 603 604 605 606 607 608 609 610 611
	}

	return git_pkt_buffer_flush(buf);
}

int git_pkt_buffer_have(git_oid *oid, git_buf *buf)
{
	char oidhex[GIT_OID_HEXSZ + 1];

	memset(oidhex, 0x0, sizeof(oidhex));
	git_oid_fmt(oidhex, oid);
612
	return git_buf_printf(buf, "%s%s\n", pkt_have_prefix, oidhex);
613 614 615 616
}

int git_pkt_buffer_done(git_buf *buf)
{
617
	return git_buf_puts(buf, pkt_done_str);
618
}