Blame src/signature.c

Packit ae9e2a
/*
Packit ae9e2a
 * Copyright (C) the libgit2 contributors. All rights reserved.
Packit ae9e2a
 *
Packit ae9e2a
 * This file is part of libgit2, distributed under the GNU GPL v2 with
Packit ae9e2a
 * a Linking Exception. For full terms see the included COPYING file.
Packit ae9e2a
 */
Packit ae9e2a
Packit ae9e2a
#include "common.h"
Packit ae9e2a
#include "signature.h"
Packit ae9e2a
#include "repository.h"
Packit ae9e2a
#include "git2/common.h"
Packit ae9e2a
#include "posix.h"
Packit ae9e2a
Packit ae9e2a
void git_signature_free(git_signature *sig)
Packit ae9e2a
{
Packit ae9e2a
	if (sig == NULL)
Packit ae9e2a
		return;
Packit ae9e2a
Packit ae9e2a
	git__free(sig->name);
Packit ae9e2a
	sig->name = NULL;
Packit ae9e2a
	git__free(sig->email);
Packit ae9e2a
	sig->email = NULL;
Packit ae9e2a
	git__free(sig);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static int signature_error(const char *msg)
Packit ae9e2a
{
Packit ae9e2a
	giterr_set(GITERR_INVALID, "failed to parse signature - %s", msg);
Packit ae9e2a
	return -1;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static bool contains_angle_brackets(const char *input)
Packit ae9e2a
{
Packit ae9e2a
	return strchr(input, '<') != NULL || strchr(input, '>') != NULL;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static bool is_crud(unsigned char c)
Packit ae9e2a
{
Packit ae9e2a
	return  c <= 32  ||
Packit ae9e2a
		c == '.' ||
Packit ae9e2a
		c == ',' ||
Packit ae9e2a
		c == ':' ||
Packit ae9e2a
		c == ';' ||
Packit ae9e2a
		c == '<' ||
Packit ae9e2a
		c == '>' ||
Packit ae9e2a
		c == '"' ||
Packit ae9e2a
		c == '\\' ||
Packit ae9e2a
		c == '\'';
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static char *extract_trimmed(const char *ptr, size_t len)
Packit ae9e2a
{
Packit ae9e2a
	while (len && is_crud((unsigned char)ptr[0])) {
Packit ae9e2a
		ptr++; len--;
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	while (len && is_crud((unsigned char)ptr[len - 1])) {
Packit ae9e2a
		len--;
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	return git__substrdup(ptr, len);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_signature_new(git_signature **sig_out, const char *name, const char *email, git_time_t time, int offset)
Packit ae9e2a
{
Packit ae9e2a
	git_signature *p = NULL;
Packit ae9e2a
Packit ae9e2a
	assert(name && email);
Packit ae9e2a
Packit ae9e2a
	*sig_out = NULL;
Packit ae9e2a
Packit ae9e2a
	if (contains_angle_brackets(name) ||
Packit ae9e2a
		contains_angle_brackets(email)) {
Packit ae9e2a
		return signature_error(
Packit ae9e2a
			"Neither `name` nor `email` should contain angle brackets chars.");
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	p = git__calloc(1, sizeof(git_signature));
Packit ae9e2a
	GITERR_CHECK_ALLOC(p);
Packit ae9e2a
Packit ae9e2a
	p->name = extract_trimmed(name, strlen(name));
Packit ae9e2a
	GITERR_CHECK_ALLOC(p->name);
Packit ae9e2a
	p->email = extract_trimmed(email, strlen(email));
Packit ae9e2a
	GITERR_CHECK_ALLOC(p->email);
Packit ae9e2a
Packit ae9e2a
	if (p->name[0] == '\0' || p->email[0] == '\0') {
Packit ae9e2a
		git_signature_free(p);
Packit ae9e2a
		return signature_error("Signature cannot have an empty name or email");
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	p->when.time = time;
Packit ae9e2a
	p->when.offset = offset;
Packit ae9e2a
Packit ae9e2a
	*sig_out = p;
Packit ae9e2a
	return 0;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_signature_dup(git_signature **dest, const git_signature *source)
Packit ae9e2a
{
Packit ae9e2a
	git_signature *signature;
Packit ae9e2a
Packit ae9e2a
	if (source == NULL)
Packit ae9e2a
		return 0;
Packit ae9e2a
Packit ae9e2a
	signature = git__calloc(1, sizeof(git_signature));
Packit ae9e2a
	GITERR_CHECK_ALLOC(signature);
Packit ae9e2a
Packit ae9e2a
	signature->name = git__strdup(source->name);
Packit ae9e2a
	GITERR_CHECK_ALLOC(signature->name);
Packit ae9e2a
Packit ae9e2a
	signature->email = git__strdup(source->email);
Packit ae9e2a
	GITERR_CHECK_ALLOC(signature->email);
Packit ae9e2a
Packit ae9e2a
	signature->when.time = source->when.time;
Packit ae9e2a
	signature->when.offset = source->when.offset;
Packit ae9e2a
Packit ae9e2a
	*dest = signature;
Packit ae9e2a
Packit ae9e2a
	return 0;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_signature__pdup(git_signature **dest, const git_signature *source, git_pool *pool)
Packit ae9e2a
{
Packit ae9e2a
	git_signature *signature;
Packit ae9e2a
Packit ae9e2a
	if (source == NULL)
Packit ae9e2a
		return 0;
Packit ae9e2a
Packit ae9e2a
	signature = git_pool_mallocz(pool, sizeof(git_signature));
Packit ae9e2a
	GITERR_CHECK_ALLOC(signature);
Packit ae9e2a
Packit ae9e2a
	signature->name = git_pool_strdup(pool, source->name);
Packit ae9e2a
	GITERR_CHECK_ALLOC(signature->name);
Packit ae9e2a
Packit ae9e2a
	signature->email = git_pool_strdup(pool, source->email);
Packit ae9e2a
	GITERR_CHECK_ALLOC(signature->email);
Packit ae9e2a
Packit ae9e2a
	signature->when.time = source->when.time;
Packit ae9e2a
	signature->when.offset = source->when.offset;
Packit ae9e2a
Packit ae9e2a
	*dest = signature;
Packit ae9e2a
Packit ae9e2a
	return 0;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_signature_now(git_signature **sig_out, const char *name, const char *email)
Packit ae9e2a
{
Packit ae9e2a
	time_t now;
Packit ae9e2a
	time_t offset;
Packit ae9e2a
	struct tm *utc_tm;
Packit ae9e2a
	git_signature *sig;
Packit ae9e2a
	struct tm _utc;
Packit ae9e2a
Packit ae9e2a
	*sig_out = NULL;
Packit ae9e2a
Packit ae9e2a
	/*
Packit ae9e2a
	 * Get the current time as seconds since the epoch and
Packit ae9e2a
	 * transform that into a tm struct containing the time at
Packit ae9e2a
	 * UTC. Give that to mktime which considers it a local time
Packit ae9e2a
	 * (tm_isdst = -1 asks it to take DST into account) and gives
Packit ae9e2a
	 * us that time as seconds since the epoch. The difference
Packit ae9e2a
	 * between its return value and 'now' is our offset to UTC.
Packit ae9e2a
	 */
Packit ae9e2a
	time(&now;;
Packit ae9e2a
	utc_tm = p_gmtime_r(&now, &_utc);
Packit ae9e2a
	utc_tm->tm_isdst = -1;
Packit ae9e2a
	offset = (time_t)difftime(now, mktime(utc_tm));
Packit ae9e2a
	offset /= 60;
Packit ae9e2a
Packit ae9e2a
	if (git_signature_new(&sig, name, email, now, (int)offset) < 0)
Packit ae9e2a
		return -1;
Packit ae9e2a
Packit ae9e2a
	*sig_out = sig;
Packit ae9e2a
Packit ae9e2a
	return 0;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_signature_default(git_signature **out, git_repository *repo)
Packit ae9e2a
{
Packit ae9e2a
	int error;
Packit ae9e2a
	git_config *cfg;
Packit ae9e2a
	const char *user_name, *user_email;
Packit ae9e2a
Packit ae9e2a
	if ((error = git_repository_config_snapshot(&cfg, repo)) < 0)
Packit ae9e2a
		return error;
Packit ae9e2a
Packit ae9e2a
	if (!(error = git_config_get_string(&user_name, cfg, "user.name")) &&
Packit ae9e2a
		!(error = git_config_get_string(&user_email, cfg, "user.email")))
Packit ae9e2a
		error = git_signature_now(out, user_name, user_email);
Packit ae9e2a
Packit ae9e2a
	git_config_free(cfg);
Packit ae9e2a
	return error;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_signature__parse(git_signature *sig, const char **buffer_out,
Packit ae9e2a
		const char *buffer_end, const char *header, char ender)
Packit ae9e2a
{
Packit ae9e2a
	const char *buffer = *buffer_out;
Packit ae9e2a
	const char *email_start, *email_end;
Packit ae9e2a
Packit ae9e2a
	memset(sig, 0, sizeof(git_signature));
Packit ae9e2a
Packit ae9e2a
	if (ender &&
Packit ae9e2a
		(buffer_end = memchr(buffer, ender, buffer_end - buffer)) == NULL)
Packit ae9e2a
		return signature_error("no newline given");
Packit ae9e2a
Packit ae9e2a
	if (header) {
Packit ae9e2a
		const size_t header_len = strlen(header);
Packit ae9e2a
Packit ae9e2a
		if (buffer + header_len >= buffer_end || memcmp(buffer, header, header_len) != 0)
Packit ae9e2a
			return signature_error("expected prefix doesn't match actual");
Packit ae9e2a
Packit ae9e2a
		buffer += header_len;
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	email_start = git__memrchr(buffer, '<', buffer_end - buffer);
Packit ae9e2a
	email_end = git__memrchr(buffer, '>', buffer_end - buffer);
Packit ae9e2a
Packit ae9e2a
	if (!email_start || !email_end || email_end <= email_start)
Packit ae9e2a
		return signature_error("malformed e-mail");
Packit ae9e2a
Packit ae9e2a
	email_start += 1;
Packit ae9e2a
	sig->name = extract_trimmed(buffer, email_start - buffer - 1);
Packit ae9e2a
	sig->email = extract_trimmed(email_start, email_end - email_start);
Packit ae9e2a
Packit ae9e2a
	/* Do we even have a time at the end of the signature? */
Packit ae9e2a
	if (email_end + 2 < buffer_end) {
Packit ae9e2a
		const char *time_start = email_end + 2;
Packit ae9e2a
		const char *time_end;
Packit ae9e2a
Packit ae9e2a
		if (git__strntol64(&sig->when.time, time_start,
Packit ae9e2a
				   buffer_end - time_start, &time_end, 10) < 0) {
Packit ae9e2a
			git__free(sig->name);
Packit ae9e2a
			git__free(sig->email);
Packit ae9e2a
			sig->name = sig->email = NULL;
Packit ae9e2a
			return signature_error("invalid Unix timestamp");
Packit ae9e2a
		}
Packit ae9e2a
Packit ae9e2a
		/* do we have a timezone? */
Packit ae9e2a
		if (time_end + 1 < buffer_end) {
Packit ae9e2a
			int offset, hours, mins;
Packit ae9e2a
			const char *tz_start, *tz_end;
Packit ae9e2a
Packit ae9e2a
			tz_start = time_end + 1;
Packit ae9e2a
Packit ae9e2a
			if ((tz_start[0] != '-' && tz_start[0] != '+') ||
Packit ae9e2a
			    git__strntol32(&offset, tz_start + 1,
Packit ae9e2a
					   buffer_end - tz_start + 1, &tz_end, 10) < 0) {
Packit ae9e2a
				/* malformed timezone, just assume it's zero */
Packit ae9e2a
				offset = 0;
Packit ae9e2a
			}
Packit ae9e2a
Packit ae9e2a
			hours = offset / 100;
Packit ae9e2a
			mins = offset % 100;
Packit ae9e2a
Packit ae9e2a
			/*
Packit ae9e2a
			 * only store timezone if it's not overflowing;
Packit ae9e2a
			 * see http://www.worldtimezone.com/faq.html
Packit ae9e2a
			 */
Packit ae9e2a
			if (hours <= 14 && mins <= 59) {
Packit ae9e2a
				sig->when.offset = (hours * 60) + mins;
Packit ae9e2a
				if (tz_start[0] == '-')
Packit ae9e2a
					sig->when.offset = -sig->when.offset;
Packit ae9e2a
			}
Packit ae9e2a
		}
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	*buffer_out = buffer_end + 1;
Packit ae9e2a
	return 0;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_signature_from_buffer(git_signature **out, const char *buf)
Packit ae9e2a
{
Packit ae9e2a
	git_signature *sig;
Packit ae9e2a
	const char *buf_end;
Packit ae9e2a
	int error;
Packit ae9e2a
Packit ae9e2a
	assert(out && buf);
Packit ae9e2a
Packit ae9e2a
	*out = NULL;
Packit ae9e2a
Packit ae9e2a
	sig = git__calloc(1, sizeof(git_signature));
Packit ae9e2a
	GITERR_CHECK_ALLOC(sig);
Packit ae9e2a
Packit ae9e2a
	buf_end = buf + strlen(buf);
Packit ae9e2a
	error = git_signature__parse(sig, &buf, buf_end, NULL, '\0');
Packit ae9e2a
Packit ae9e2a
	if (error)
Packit ae9e2a
		git__free(sig);
Packit ae9e2a
	else
Packit ae9e2a
		*out = sig;
Packit ae9e2a
Packit ae9e2a
	return error;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
void git_signature__writebuf(git_buf *buf, const char *header, const git_signature *sig)
Packit ae9e2a
{
Packit ae9e2a
	int offset, hours, mins;
Packit ae9e2a
	char sign;
Packit ae9e2a
Packit ae9e2a
	assert(buf && sig);
Packit ae9e2a
Packit ae9e2a
	offset = sig->when.offset;
Packit ae9e2a
	sign = (sig->when.offset < 0) ? '-' : '+';
Packit ae9e2a
Packit ae9e2a
	if (offset < 0)
Packit ae9e2a
		offset = -offset;
Packit ae9e2a
Packit ae9e2a
	hours = offset / 60;
Packit ae9e2a
	mins = offset % 60;
Packit ae9e2a
Packit ae9e2a
	git_buf_printf(buf, "%s%s <%s> %u %c%02d%02d\n",
Packit ae9e2a
			header ? header : "", sig->name, sig->email,
Packit ae9e2a
			(unsigned)sig->when.time, sign, hours, mins);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
bool git_signature__equal(const git_signature *one, const git_signature *two)
Packit ae9e2a
{
Packit ae9e2a
	assert(one && two);
Packit ae9e2a
Packit ae9e2a
	return
Packit ae9e2a
		git__strcmp(one->name, two->name) == 0 &&
Packit ae9e2a
		git__strcmp(one->email, two->email) == 0 &&
Packit ae9e2a
		one->when.time == two->when.time &&
Packit ae9e2a
		one->when.offset == two->when.offset;
Packit ae9e2a
}
Packit ae9e2a