smart.c 12.4 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3 4 5 6 7 8 9
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
#include "git2.h"
#include "smart.h"
#include "refs.h"
10
#include "refspec.h"
11
#include "proxy.h"
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

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;

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

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

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

	if (close_subtransport &&
		t->wrapped->close(t->wrapped) < 0)
		return -1;

	return 0;
51 52 53 54 55 56
}

static int git_smart__set_callbacks(
	git_transport *transport,
	git_transport_message_cb progress_cb,
	git_transport_message_cb error_cb,
57
	git_transport_certificate_check_cb certificate_check_cb,
58 59 60 61 62 63
	void *message_cb_payload)
{
	transport_smart *t = (transport_smart *)transport;

	t->progress_cb = progress_cb;
	t->error_cb = error_cb;
64
	t->certificate_check_cb = certificate_check_cb;
65 66 67 68 69
	t->message_cb_payload = message_cb_payload;

	return 0;
}

Matt Burke committed
70
static int http_header_name_length(const char *http_header)
71 72 73 74 75 76
{
	const char *colon = strchr(http_header, ':');
	if (!colon)
		return 0;
	return colon - http_header;
}
77

Matt Burke committed
78
static bool is_malformed_http_header(const char *http_header)
79 80 81 82 83
{
	const char *c;
	int name_len;

	// Disallow \r and \n
84 85 86 87 88 89
	c = strchr(http_header, '\r');
	if (c)
		return true;
	c = strchr(http_header, '\n');
	if (c)
		return true;
90 91

	// Require a header name followed by :
92
	name_len = http_header_name_length(http_header);
93
	if (name_len < 1)
94
		return true;
95

96
	return false;
97 98
}

99 100 101 102 103 104 105 106
static char *forbidden_custom_headers[] = {
	"User-Agent",
	"Host",
	"Accept",
	"Content-Type",
	"Transfer-Encoding",
	"Content-Length",
};
107

Matt Burke committed
108
static bool is_forbidden_custom_header(const char *custom_header)
109 110 111
{
	unsigned long i;
	int name_len = http_header_name_length(custom_header);
112

113 114 115 116
	// Disallow headers that we set
	for (i = 0; i < ARRAY_SIZE(forbidden_custom_headers); i++)
		if (strncmp(forbidden_custom_headers[i], custom_header, name_len) == 0)
			return true;
117

118
	return false;
119 120
}

121 122 123 124 125
static int git_smart__set_custom_headers(
	git_transport *transport,
	const git_strarray *custom_headers)
{
	transport_smart *t = (transport_smart *)transport;
126
	size_t i;
127

128 129 130 131 132 133
	if (t->custom_headers.count)
		git_strarray_free(&t->custom_headers);

	if (!custom_headers)
		return 0;

134 135 136 137 138 139 140 141 142
	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;
		}
143
	}
144

145
	return git_strarray_copy(&t->custom_headers, custom_headers);
146 147
}

148
int git_smart__update_heads(transport_smart *t, git_vector *symrefs)
149 150 151 152 153 154 155 156 157 158
{
	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;

159 160 161 162
		if (symrefs) {
			git_refspec *spec;
			git_buf buf = GIT_BUF_INIT;
			size_t j;
163
			int error = 0;
164 165 166 167 168 169 170 171 172 173 174 175 176 177

			git_vector_foreach(symrefs, j, spec) {
				git_buf_clear(&buf);
				if (git_refspec_src_matches(spec, ref->head.name) &&
				    !(error = git_refspec_transform(&buf, spec, ref->head.name)))
					ref->head.symref_target = git_buf_detach(&buf);
			}

			git_buf_free(&buf);

			if (error < 0)
				return error;
		}

178 179 180 181 182 183 184
		if (git_vector_insert(&t->heads, &ref->head) < 0)
			return -1;
	}

	return 0;
}

185 186 187 188 189 190 191 192 193 194 195 196 197
static void free_symrefs(git_vector *symrefs)
{
	git_refspec *spec;
	size_t i;

	git_vector_foreach(symrefs, i, spec) {
		git_refspec__free(spec);
		git__free(spec);
	}

	git_vector_free(symrefs);
}

198 199 200 201
static int git_smart__connect(
	git_transport *transport,
	const char *url,
	git_cred_acquire_cb cred_acquire_cb,
202
	void *cred_acquire_payload,
203
	const git_proxy_options *proxy,
204 205
	int direction,
	int flags)
206 207 208 209 210
{
	transport_smart *t = (transport_smart *)transport;
	git_smart_subtransport_stream *stream;
	int error;
	git_pkt *pkt;
211
	git_pkt_ref *first;
212
	git_vector symrefs;
213
	git_smart_service_t service;
214

215 216
	if (git_smart__reset_stream(t, true) < 0)
		return -1;
217 218 219 220

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

221 222 223
	if (git_proxy_options_dup(&t->proxy, proxy) < 0)
		return -1;

224 225
	t->direction = direction;
	t->flags = flags;
226
	t->cred_acquire_cb = cred_acquire_cb;
227
	t->cred_acquire_payload = cred_acquire_payload;
228

229 230 231 232 233
	if (GIT_DIRECTION_FETCH == t->direction)
		service = GIT_SERVICE_UPLOADPACK_LS;
	else if (GIT_DIRECTION_PUSH == t->direction)
		service = GIT_SERVICE_RECEIVEPACK_LS;
	else {
234
		giterr_set(GITERR_NET, "invalid direction");
235 236
		return -1;
	}
237

238 239
	if ((error = t->wrapped->action(&stream, t->wrapped, t->url, service)) < 0)
		return error;
240

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

244
	gitno_buffer_setup_callback(&t->buffer, t->buffer_data, sizeof(t->buffer_data), git_smart__recv_cb, t);
245

246 247 248 249 250 251 252
	/* 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);
253

254
		if (!pkt || GIT_PKT_COMMENT != pkt->type) {
255
			giterr_set(GITERR_NET, "invalid response");
256 257 258 259 260 261
			return -1;
		} else {
			/* Remove the comment pkt from the list */
			git_vector_remove(&t->refs, 0);
			git__free(pkt);
		}
262
	}
263 264 265 266 267 268

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

	first = (git_pkt_ref *)git_vector_get(&t->refs, 0);

269 270 271
	if ((error = git_vector_init(&symrefs, 1, NULL)) < 0)
		return error;

272
	/* Detect capabilities */
273
	if (git_smart__detect_caps(first, &t->caps, &symrefs) < 0)
274
		return -1;
275 276 277 278 279 280

	/* 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);
281 282
	}

283
	/* Keep a list of heads for _ls */
284 285 286
	git_smart__update_heads(t, &symrefs);

	free_symrefs(&symrefs);
287

288 289 290 291 292 293 294
	if (t->rpc && git_smart__reset_stream(t, false) < 0)
		return -1;

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

	return 0;
295 296
}

297
static int git_smart__ls(const git_remote_head ***out, size_t *size, git_transport *transport)
298 299 300 301
{
	transport_smart *t = (transport_smart *)transport;

	if (!t->have_refs) {
302
		giterr_set(GITERR_NET, "the transport has not yet loaded the refs");
303 304 305
		return -1;
	}

306 307
	*out = (const git_remote_head **) t->heads.contents;
	*size = t->heads.length;
308 309 310 311 312 313 314 315 316 317

	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;

318 319 320 321
	if (t->rpc && git_smart__reset_stream(t, false) < 0)
		return -1;

	if (GIT_DIRECTION_FETCH != t->direction) {
322
		giterr_set(GITERR_NET, "this operation is only valid for fetch");
323 324 325 326 327 328 329 330
		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);
331

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

335 336
	if ((error = stream->write(stream, (const char *)data, len)) < 0)
		return error;
337

338
	gitno_buffer_setup_callback(&t->buffer, t->buffer_data, sizeof(t->buffer_data), git_smart__recv_cb, t);
339

340 341
	return 0;
}
342

343 344 345 346 347 348
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;
349

350
	if (GIT_DIRECTION_PUSH != t->direction) {
351
		giterr_set(GITERR_NET, "this operation is only valid for push");
352
		return -1;
353 354
	}

355 356 357 358 359 360 361 362 363
	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;

364
	gitno_buffer_setup_callback(&t->buffer, t->buffer_data, sizeof(t->buffer_data), git_smart__recv_cb, t);
365 366

	return 0;
367 368 369 370 371 372 373 374 375
}

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

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

376
static int git_smart__is_connected(git_transport *transport)
377 378 379
{
	transport_smart *t = (transport_smart *)transport;

380
	return t->connected;
381 382 383 384 385 386 387 388 389 390 391 392 393 394
}

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;
395 396 397 398
	git_vector *common = &t->common;
	unsigned int i;
	git_pkt *p;
	int ret;
399 400 401 402 403 404 405 406 407 408 409 410
	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);
	}
411 412 413 414 415 416 417 418 419 420 421 422

	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;
	}
423 424 425

	t->connected = 0;

426
	return ret;
427 428 429 430 431
}

static void git_smart__free(git_transport *transport)
{
	transport_smart *t = (transport_smart *)transport;
432 433 434
	git_vector *refs = &t->refs;
	unsigned int i;
	git_pkt *p;
435 436 437 438 439 440 441

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

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

442
	git_vector_free(&t->heads);
443 444 445 446
	git_vector_foreach(refs, i, p)
		git_pkt_free(p);

	git_vector_free(refs);
447
	git__free((char *)t->proxy.url);
448

449 450
	git_strarray_free(&t->custom_headers);

451 452 453
	git__free(t);
}

454 455 456 457 458 459 460
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);
}

461 462 463 464 465 466 467 468 469 470 471 472 473 474
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);
}

475
int git_transport_smart(git_transport **out, git_remote *owner, void *param)
476 477 478 479 480 481 482
{
	transport_smart *t;
	git_smart_subtransport_definition *definition = (git_smart_subtransport_definition *)param;

	if (!param)
		return -1;

483
	t = git__calloc(1, sizeof(transport_smart));
484 485
	GITERR_CHECK_ALLOC(t);

486
	t->parent.version = GIT_TRANSPORT_VERSION;
487
	t->parent.set_callbacks = git_smart__set_callbacks;
488
	t->parent.set_custom_headers = git_smart__set_custom_headers;
489 490 491 492 493
	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;
494
	t->parent.push = git_smart__push;
495 496 497 498
	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;
499

500
	t->owner = owner;
501 502
	t->rpc = definition->rpc;

503
	if (git_vector_init(&t->refs, 16, ref_name_cmp) < 0) {
504 505 506 507
		git__free(t);
		return -1;
	}

508 509 510 511 512
	if (git_vector_init(&t->heads, 16, ref_name_cmp) < 0) {
		git__free(t);
		return -1;
	}

513
	if (definition->callback(&t->wrapped, &t->parent, definition->param) < 0) {
514 515
		git__free(t);
		return -1;
516
	}
517 518 519 520

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