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

8
#include "smart.h"
9 10

#include "git2.h"
11
#include "refs.h"
12
#include "refspec.h"
13
#include "proxy.h"
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

static int git_smart__recv_cb(gitno_buffer *buf)
{
	transport_smart *t = (transport_smart *) buf->cb_data;
	size_t old_len, bytes_read;
	int error;

	assert(t->current_stream);

	old_len = buf->offset;

	if ((error = t->current_stream->read(t->current_stream, buf->data + buf->offset, buf->len - buf->offset, &bytes_read)) < 0)
		return error;

	buf->offset += bytes_read;

30 31 32
	if (t->packetsize_cb && !t->cancelled.val) {
		error = t->packetsize_cb(bytes_read, t->packetsize_payload);
		if (error) {
33
			git_atomic_set(&t->cancelled, 1);
34
			return GIT_EUSER;
35
		}
36
	}
37 38 39 40

	return (int)(buf->offset - old_len);
}

41
GIT_INLINE(int) git_smart__reset_stream(transport_smart *t, bool close_subtransport)
42 43 44 45 46
{
	if (t->current_stream) {
		t->current_stream->free(t->current_stream);
		t->current_stream = NULL;
	}
47

48 49 50 51 52
	if (t->url) {
		git__free(t->url);
		t->url = NULL;
	}

53 54 55 56 57
	if (close_subtransport &&
		t->wrapped->close(t->wrapped) < 0)
		return -1;

	return 0;
58 59 60 61 62 63
}

static int git_smart__set_callbacks(
	git_transport *transport,
	git_transport_message_cb progress_cb,
	git_transport_message_cb error_cb,
64
	git_transport_certificate_check_cb certificate_check_cb,
65 66 67 68 69 70
	void *message_cb_payload)
{
	transport_smart *t = (transport_smart *)transport;

	t->progress_cb = progress_cb;
	t->error_cb = error_cb;
71
	t->certificate_check_cb = certificate_check_cb;
72 73 74 75 76
	t->message_cb_payload = message_cb_payload;

	return 0;
}

Matt Burke committed
77
static int http_header_name_length(const char *http_header)
78 79 80 81 82 83
{
	const char *colon = strchr(http_header, ':');
	if (!colon)
		return 0;
	return colon - http_header;
}
84

Matt Burke committed
85
static bool is_malformed_http_header(const char *http_header)
86 87 88 89
{
	const char *c;
	int name_len;

90
	/* Disallow \r and \n */
91 92 93 94 95 96
	c = strchr(http_header, '\r');
	if (c)
		return true;
	c = strchr(http_header, '\n');
	if (c)
		return true;
97

98
	/* Require a header name followed by : */
99
	name_len = http_header_name_length(http_header);
100
	if (name_len < 1)
101
		return true;
102

103
	return false;
104 105
}

106 107 108 109 110 111 112 113
static char *forbidden_custom_headers[] = {
	"User-Agent",
	"Host",
	"Accept",
	"Content-Type",
	"Transfer-Encoding",
	"Content-Length",
};
114

Matt Burke committed
115
static bool is_forbidden_custom_header(const char *custom_header)
116 117 118
{
	unsigned long i;
	int name_len = http_header_name_length(custom_header);
119

120
	/* Disallow headers that we set */
121 122 123
	for (i = 0; i < ARRAY_SIZE(forbidden_custom_headers); i++)
		if (strncmp(forbidden_custom_headers[i], custom_header, name_len) == 0)
			return true;
124

125
	return false;
126 127
}

128 129 130 131 132
static int git_smart__set_custom_headers(
	git_transport *transport,
	const git_strarray *custom_headers)
{
	transport_smart *t = (transport_smart *)transport;
133
	size_t i;
134

135 136 137 138 139 140
	if (t->custom_headers.count)
		git_strarray_free(&t->custom_headers);

	if (!custom_headers)
		return 0;

141 142 143 144 145 146 147 148 149
	for (i = 0; i < custom_headers->count; i++) {
		if (is_malformed_http_header(custom_headers->strings[i])) {
			giterr_set(GITERR_INVALID, "custom HTTP header '%s' is malformed", custom_headers->strings[i]);
			return -1;
		}
		if (is_forbidden_custom_header(custom_headers->strings[i])) {
			giterr_set(GITERR_INVALID, "custom HTTP header '%s' is already set by libgit2", custom_headers->strings[i]);
			return -1;
		}
150
	}
151

152
	return git_strarray_copy(&t->custom_headers, custom_headers);
153 154
}

155
int git_smart__update_heads(transport_smart *t, git_vector *symrefs)
156 157 158 159 160 161 162 163 164 165
{
	size_t i;
	git_pkt *pkt;

	git_vector_clear(&t->heads);
	git_vector_foreach(&t->refs, i, pkt) {
		git_pkt_ref *ref = (git_pkt_ref *) pkt;
		if (pkt->type != GIT_PKT_REF)
			continue;

166 167 168 169
		if (symrefs) {
			git_refspec *spec;
			git_buf buf = GIT_BUF_INIT;
			size_t j;
170
			int error = 0;
171 172 173 174

			git_vector_foreach(symrefs, j, spec) {
				git_buf_clear(&buf);
				if (git_refspec_src_matches(spec, ref->head.name) &&
175 176
				    !(error = git_refspec_transform(&buf, spec, ref->head.name))) {
					git__free(ref->head.symref_target);
177
					ref->head.symref_target = git_buf_detach(&buf);
178
				}
179 180
			}

181
			git_buf_dispose(&buf);
182 183 184 185 186

			if (error < 0)
				return error;
		}

187 188 189 190 191 192 193
		if (git_vector_insert(&t->heads, &ref->head) < 0)
			return -1;
	}

	return 0;
}

194 195 196 197 198 199
static void free_symrefs(git_vector *symrefs)
{
	git_refspec *spec;
	size_t i;

	git_vector_foreach(symrefs, i, spec) {
200
		git_refspec__dispose(spec);
201 202 203 204 205 206
		git__free(spec);
	}

	git_vector_free(symrefs);
}

207 208 209 210
static int git_smart__connect(
	git_transport *transport,
	const char *url,
	git_cred_acquire_cb cred_acquire_cb,
211
	void *cred_acquire_payload,
212
	const git_proxy_options *proxy,
213 214
	int direction,
	int flags)
215 216 217 218 219
{
	transport_smart *t = (transport_smart *)transport;
	git_smart_subtransport_stream *stream;
	int error;
	git_pkt *pkt;
220
	git_pkt_ref *first;
221
	git_vector symrefs;
222
	git_smart_service_t service;
223

224 225
	if (git_smart__reset_stream(t, true) < 0)
		return -1;
226 227 228 229

	t->url = git__strdup(url);
	GITERR_CHECK_ALLOC(t->url);

230 231 232
	if (git_proxy_options_dup(&t->proxy, proxy) < 0)
		return -1;

233 234
	t->direction = direction;
	t->flags = flags;
235
	t->cred_acquire_cb = cred_acquire_cb;
236
	t->cred_acquire_payload = cred_acquire_payload;
237

238 239 240 241 242
	if (GIT_DIRECTION_FETCH == t->direction)
		service = GIT_SERVICE_UPLOADPACK_LS;
	else if (GIT_DIRECTION_PUSH == t->direction)
		service = GIT_SERVICE_RECEIVEPACK_LS;
	else {
243
		giterr_set(GITERR_NET, "invalid direction");
244 245
		return -1;
	}
246

247 248
	if ((error = t->wrapped->action(&stream, t->wrapped, t->url, service)) < 0)
		return error;
249

250 251
	/* Save off the current stream (i.e. socket) that we are working with */
	t->current_stream = stream;
252

253
	gitno_buffer_setup_callback(&t->buffer, t->buffer_data, sizeof(t->buffer_data), git_smart__recv_cb, t);
254

255 256 257 258 259 260 261
	/* 2 flushes for RPC; 1 for stateful */
	if ((error = git_smart__store_refs(t, t->rpc ? 2 : 1)) < 0)
		return error;

	/* Strip the comment packet for RPC */
	if (t->rpc) {
		pkt = (git_pkt *)git_vector_get(&t->refs, 0);
262

263
		if (!pkt || GIT_PKT_COMMENT != pkt->type) {
264
			giterr_set(GITERR_NET, "invalid response");
265 266 267 268 269 270
			return -1;
		} else {
			/* Remove the comment pkt from the list */
			git_vector_remove(&t->refs, 0);
			git__free(pkt);
		}
271
	}
272 273 274 275

	/* We now have loaded the refs. */
	t->have_refs = 1;

276 277 278 279 280 281
	pkt = (git_pkt *)git_vector_get(&t->refs, 0);
	if (pkt && GIT_PKT_REF != pkt->type) {
		giterr_set(GITERR_NET, "invalid response");
		return -1;
	}
	first = (git_pkt_ref *)pkt;
282

283 284 285
	if ((error = git_vector_init(&symrefs, 1, NULL)) < 0)
		return error;

286
	/* Detect capabilities */
287
	if ((error = git_smart__detect_caps(first, &t->caps, &symrefs)) == 0) {
288 289 290 291 292 293
		/* If the only ref in the list is capabilities^{} with OID_ZERO, remove it */
		if (1 == t->refs.length && !strcmp(first->head.name, "capabilities^{}") &&
			git_oid_iszero(&first->head.oid)) {
			git_vector_clear(&t->refs);
			git_pkt_free((git_pkt *)first);
		}
294

295 296 297 298 299 300 301 302
		/* Keep a list of heads for _ls */
		git_smart__update_heads(t, &symrefs);
	} else if (error == GIT_ENOTFOUND) {
		/* There was no ref packet received, or the cap list was empty */
		error = 0;
	} else {
		giterr_set(GITERR_NET, "invalid response");
		goto cleanup;
303 304
	}

305 306
	if (t->rpc && (error = git_smart__reset_stream(t, false)) < 0)
		goto cleanup;
307 308 309 310

	/* We're now logically connected. */
	t->connected = 1;

311 312 313 314
cleanup:
	free_symrefs(&symrefs);

	return error;
315 316
}

317
static int git_smart__ls(const git_remote_head ***out, size_t *size, git_transport *transport)
318 319 320 321
{
	transport_smart *t = (transport_smart *)transport;

	if (!t->have_refs) {
322
		giterr_set(GITERR_NET, "the transport has not yet loaded the refs");
323 324 325
		return -1;
	}

326 327
	*out = (const git_remote_head **) t->heads.contents;
	*size = t->heads.length;
328 329 330 331 332 333 334 335 336 337

	return 0;
}

int git_smart__negotiation_step(git_transport *transport, void *data, size_t len)
{
	transport_smart *t = (transport_smart *)transport;
	git_smart_subtransport_stream *stream;
	int error;

338 339 340 341
	if (t->rpc && git_smart__reset_stream(t, false) < 0)
		return -1;

	if (GIT_DIRECTION_FETCH != t->direction) {
342
		giterr_set(GITERR_NET, "this operation is only valid for fetch");
343 344 345 346 347 348 349 350
		return -1;
	}

	if ((error = t->wrapped->action(&stream, t->wrapped, t->url, GIT_SERVICE_UPLOADPACK)) < 0)
		return error;

	/* If this is a stateful implementation, the stream we get back should be the same */
	assert(t->rpc || t->current_stream == stream);
351

352 353
	/* Save off the current stream (i.e. socket) that we are working with */
	t->current_stream = stream;
354

355 356
	if ((error = stream->write(stream, (const char *)data, len)) < 0)
		return error;
357

358
	gitno_buffer_setup_callback(&t->buffer, t->buffer_data, sizeof(t->buffer_data), git_smart__recv_cb, t);
359

360 361
	return 0;
}
362

363 364 365 366 367 368
int git_smart__get_push_stream(transport_smart *t, git_smart_subtransport_stream **stream)
{
	int error;

	if (t->rpc && git_smart__reset_stream(t, false) < 0)
		return -1;
369

370
	if (GIT_DIRECTION_PUSH != t->direction) {
371
		giterr_set(GITERR_NET, "this operation is only valid for push");
372
		return -1;
373 374
	}

375 376 377 378 379 380 381 382 383
	if ((error = t->wrapped->action(stream, t->wrapped, t->url, GIT_SERVICE_RECEIVEPACK)) < 0)
		return error;

	/* If this is a stateful implementation, the stream we get back should be the same */
	assert(t->rpc || t->current_stream == *stream);

	/* Save off the current stream (i.e. socket) that we are working with */
	t->current_stream = *stream;

384
	gitno_buffer_setup_callback(&t->buffer, t->buffer_data, sizeof(t->buffer_data), git_smart__recv_cb, t);
385 386

	return 0;
387 388 389 390 391 392 393 394 395
}

static void git_smart__cancel(git_transport *transport)
{
	transport_smart *t = (transport_smart *)transport;

	git_atomic_set(&t->cancelled, 1);
}

396
static int git_smart__is_connected(git_transport *transport)
397 398 399
{
	transport_smart *t = (transport_smart *)transport;

400
	return t->connected;
401 402 403 404 405 406 407 408 409 410 411 412 413 414
}

static int git_smart__read_flags(git_transport *transport, int *flags)
{
	transport_smart *t = (transport_smart *)transport;

	*flags = t->flags;

	return 0;
}

static int git_smart__close(git_transport *transport)
{
	transport_smart *t = (transport_smart *)transport;
415 416 417 418
	git_vector *common = &t->common;
	unsigned int i;
	git_pkt *p;
	int ret;
419 420 421 422 423 424 425 426 427 428 429 430
	git_smart_subtransport_stream *stream;
	const char flush[] = "0000";

	/*
	 * If we're still connected at this point and not using RPC,
	 * we should say goodbye by sending a flush, or git-daemon
	 * will complain that we disconnected unexpectedly.
	 */
	if (t->connected && !t->rpc &&
	    !t->wrapped->action(&stream, t->wrapped, t->url, GIT_SERVICE_UPLOADPACK)) {
		t->current_stream->write(t->current_stream, flush, 4);
	}
431 432 433 434 435 436 437 438 439 440 441 442

	ret = git_smart__reset_stream(t, true);

	git_vector_foreach(common, i, p)
		git_pkt_free(p);

	git_vector_free(common);

	if (t->url) {
		git__free(t->url);
		t->url = NULL;
	}
443 444 445

	t->connected = 0;

446
	return ret;
447 448 449 450 451
}

static void git_smart__free(git_transport *transport)
{
	transport_smart *t = (transport_smart *)transport;
452 453 454
	git_vector *refs = &t->refs;
	unsigned int i;
	git_pkt *p;
455 456 457 458 459 460 461

	/* Make sure that the current stream is closed, if we have one. */
	git_smart__close(transport);

	/* Free the subtransport */
	t->wrapped->free(t->wrapped);

462
	git_vector_free(&t->heads);
463 464 465 466
	git_vector_foreach(refs, i, p)
		git_pkt_free(p);

	git_vector_free(refs);
467
	git__free((char *)t->proxy.url);
468

469 470
	git_strarray_free(&t->custom_headers);

471 472 473
	git__free(t);
}

474 475 476 477 478 479 480
static int ref_name_cmp(const void *a, const void *b)
{
	const git_pkt_ref *ref_a = a, *ref_b = b;

	return strcmp(ref_a->head.name, ref_b->head.name);
}

481 482 483 484 485 486 487 488 489 490 491 492 493 494
int git_transport_smart_certificate_check(git_transport *transport, git_cert *cert, int valid, const char *hostname)
{
	transport_smart *t = (transport_smart *)transport;

	return t->certificate_check_cb(cert, valid, hostname, t->message_cb_payload);
}

int git_transport_smart_credentials(git_cred **out, git_transport *transport, const char *user, int methods)
{
	transport_smart *t = (transport_smart *)transport;

	return t->cred_acquire_cb(out, t->url, user, methods, t->cred_acquire_payload);
}

495 496 497 498 499 500
int git_transport_smart_proxy_options(git_proxy_options *out, git_transport *transport)
{
	transport_smart *t = (transport_smart *) transport;
	return git_proxy_options_dup(out, &t->proxy);
}

501
int git_transport_smart(git_transport **out, git_remote *owner, void *param)
502 503 504 505 506 507 508
{
	transport_smart *t;
	git_smart_subtransport_definition *definition = (git_smart_subtransport_definition *)param;

	if (!param)
		return -1;

509
	t = git__calloc(1, sizeof(transport_smart));
510 511
	GITERR_CHECK_ALLOC(t);

512
	t->parent.version = GIT_TRANSPORT_VERSION;
513
	t->parent.set_callbacks = git_smart__set_callbacks;
514
	t->parent.set_custom_headers = git_smart__set_custom_headers;
515 516 517 518 519
	t->parent.connect = git_smart__connect;
	t->parent.close = git_smart__close;
	t->parent.free = git_smart__free;
	t->parent.negotiate_fetch = git_smart__negotiate_fetch;
	t->parent.download_pack = git_smart__download_pack;
520
	t->parent.push = git_smart__push;
521 522 523 524
	t->parent.ls = git_smart__ls;
	t->parent.is_connected = git_smart__is_connected;
	t->parent.read_flags = git_smart__read_flags;
	t->parent.cancel = git_smart__cancel;
525

526
	t->owner = owner;
527 528
	t->rpc = definition->rpc;

529
	if (git_vector_init(&t->refs, 16, ref_name_cmp) < 0) {
530 531 532 533
		git__free(t);
		return -1;
	}

534 535 536 537 538
	if (git_vector_init(&t->heads, 16, ref_name_cmp) < 0) {
		git__free(t);
		return -1;
	}

539
	if (definition->callback(&t->wrapped, &t->parent, definition->param) < 0) {
540 541
		git__free(t);
		return -1;
542
	}
543 544 545 546

	*out = (git_transport *) t;
	return 0;
}