mirror of
https://github.com/git/git.git
synced 2024-05-10 11:56:09 +02:00
076aa2cbda
The previous commit taught the tempfile code to give up
ownership over tempfiles that have been renamed or deleted.
That makes it possible to use a stack variable like this:
struct tempfile t;
create_tempfile(&t, ...);
...
if (!err)
rename_tempfile(&t, ...);
else
delete_tempfile(&t);
But doing it this way has a high potential for creating
memory errors. The tempfile we pass to create_tempfile()
ends up on a global linked list, and it's not safe for it to
go out of scope until we've called one of those two
deactivation functions.
Imagine that we add an early return from the function that
forgets to call delete_tempfile(). With a static or heap
tempfile variable, the worst case is that the tempfile hangs
around until the program exits (and some functions like
setup_shallow_temporary rely on this intentionally, creating
a tempfile and then leaving it for later cleanup).
But with a stack variable as above, this is a serious memory
error: the variable goes out of scope and may be filled with
garbage by the time the tempfile code looks at it. Let's
see if we can make it harder to get this wrong.
Since many callers need to allocate arbitrary numbers of
tempfiles, we can't rely on static storage as a general
solution. So we need to turn to the heap. We could just ask
all callers to pass us a heap variable, but that puts the
burden on them to call free() at the right time.
Instead, let's have the tempfile code handle the heap
allocation _and_ the deallocation (when the tempfile is
deactivated and removed from the list).
This changes the return value of all of the creation
functions. For the cleanup functions (delete and rename),
we'll add one extra bit of safety: instead of taking a
tempfile pointer, we'll take a pointer-to-pointer and set it
to NULL after freeing the object. This makes it safe to
double-call functions like delete_tempfile(), as the second
call treats the NULL input as a noop. Several callsites
follow this pattern.
The resulting patch does have a fair bit of noise, as each
caller needs to be converted to handle:
1. Storing a pointer instead of the struct itself.
2. Passing the pointer instead of taking the struct
address.
3. Handling a "struct tempfile *" return instead of a file
descriptor.
We could play games to make this less noisy. For example, by
defining the tempfile like this:
struct tempfile {
struct heap_allocated_part_of_tempfile {
int fd;
...etc
} *actual_data;
}
Callers would continue to have a "struct tempfile", and it
would be "active" only when the inner pointer was non-NULL.
But that just makes things more awkward in the long run.
There aren't that many callers, so we can simply bite
the bullet and adjust all of them. And the compiler makes it
easy for us to find them all.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
297 lines
6.9 KiB
C
297 lines
6.9 KiB
C
#include "cache.h"
|
|
#include "config.h"
|
|
#include "tempfile.h"
|
|
#include "credential.h"
|
|
#include "unix-socket.h"
|
|
#include "parse-options.h"
|
|
|
|
struct credential_cache_entry {
|
|
struct credential item;
|
|
timestamp_t expiration;
|
|
};
|
|
static struct credential_cache_entry *entries;
|
|
static int entries_nr;
|
|
static int entries_alloc;
|
|
|
|
static void cache_credential(struct credential *c, int timeout)
|
|
{
|
|
struct credential_cache_entry *e;
|
|
|
|
ALLOC_GROW(entries, entries_nr + 1, entries_alloc);
|
|
e = &entries[entries_nr++];
|
|
|
|
/* take ownership of pointers */
|
|
memcpy(&e->item, c, sizeof(*c));
|
|
memset(c, 0, sizeof(*c));
|
|
e->expiration = time(NULL) + timeout;
|
|
}
|
|
|
|
static struct credential_cache_entry *lookup_credential(const struct credential *c)
|
|
{
|
|
int i;
|
|
for (i = 0; i < entries_nr; i++) {
|
|
struct credential *e = &entries[i].item;
|
|
if (credential_match(c, e))
|
|
return &entries[i];
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
static void remove_credential(const struct credential *c)
|
|
{
|
|
struct credential_cache_entry *e;
|
|
|
|
e = lookup_credential(c);
|
|
if (e)
|
|
e->expiration = 0;
|
|
}
|
|
|
|
static timestamp_t check_expirations(void)
|
|
{
|
|
static timestamp_t wait_for_entry_until;
|
|
int i = 0;
|
|
timestamp_t now = time(NULL);
|
|
timestamp_t next = TIME_MAX;
|
|
|
|
/*
|
|
* Initially give the client 30 seconds to actually contact us
|
|
* and store a credential before we decide there's no point in
|
|
* keeping the daemon around.
|
|
*/
|
|
if (!wait_for_entry_until)
|
|
wait_for_entry_until = now + 30;
|
|
|
|
while (i < entries_nr) {
|
|
if (entries[i].expiration <= now) {
|
|
entries_nr--;
|
|
credential_clear(&entries[i].item);
|
|
if (i != entries_nr)
|
|
memcpy(&entries[i], &entries[entries_nr], sizeof(*entries));
|
|
/*
|
|
* Stick around 30 seconds in case a new credential
|
|
* shows up (e.g., because we just removed a failed
|
|
* one, and we will soon get the correct one).
|
|
*/
|
|
wait_for_entry_until = now + 30;
|
|
}
|
|
else {
|
|
if (entries[i].expiration < next)
|
|
next = entries[i].expiration;
|
|
i++;
|
|
}
|
|
}
|
|
|
|
if (!entries_nr) {
|
|
if (wait_for_entry_until <= now)
|
|
return 0;
|
|
next = wait_for_entry_until;
|
|
}
|
|
|
|
return next - now;
|
|
}
|
|
|
|
static int read_request(FILE *fh, struct credential *c,
|
|
struct strbuf *action, int *timeout) {
|
|
static struct strbuf item = STRBUF_INIT;
|
|
const char *p;
|
|
|
|
strbuf_getline_lf(&item, fh);
|
|
if (!skip_prefix(item.buf, "action=", &p))
|
|
return error("client sent bogus action line: %s", item.buf);
|
|
strbuf_addstr(action, p);
|
|
|
|
strbuf_getline_lf(&item, fh);
|
|
if (!skip_prefix(item.buf, "timeout=", &p))
|
|
return error("client sent bogus timeout line: %s", item.buf);
|
|
*timeout = atoi(p);
|
|
|
|
if (credential_read(c, fh) < 0)
|
|
return -1;
|
|
return 0;
|
|
}
|
|
|
|
static void serve_one_client(FILE *in, FILE *out)
|
|
{
|
|
struct credential c = CREDENTIAL_INIT;
|
|
struct strbuf action = STRBUF_INIT;
|
|
int timeout = -1;
|
|
|
|
if (read_request(in, &c, &action, &timeout) < 0)
|
|
/* ignore error */ ;
|
|
else if (!strcmp(action.buf, "get")) {
|
|
struct credential_cache_entry *e = lookup_credential(&c);
|
|
if (e) {
|
|
fprintf(out, "username=%s\n", e->item.username);
|
|
fprintf(out, "password=%s\n", e->item.password);
|
|
}
|
|
}
|
|
else if (!strcmp(action.buf, "exit")) {
|
|
/*
|
|
* It's important that we clean up our socket first, and then
|
|
* signal the client only once we have finished the cleanup.
|
|
* Calling exit() directly does this, because we clean up in
|
|
* our atexit() handler, and then signal the client when our
|
|
* process actually ends, which closes the socket and gives
|
|
* them EOF.
|
|
*/
|
|
exit(0);
|
|
}
|
|
else if (!strcmp(action.buf, "erase"))
|
|
remove_credential(&c);
|
|
else if (!strcmp(action.buf, "store")) {
|
|
if (timeout < 0)
|
|
warning("cache client didn't specify a timeout");
|
|
else if (!c.username || !c.password)
|
|
warning("cache client gave us a partial credential");
|
|
else {
|
|
remove_credential(&c);
|
|
cache_credential(&c, timeout);
|
|
}
|
|
}
|
|
else
|
|
warning("cache client sent unknown action: %s", action.buf);
|
|
|
|
credential_clear(&c);
|
|
strbuf_release(&action);
|
|
}
|
|
|
|
static int serve_cache_loop(int fd)
|
|
{
|
|
struct pollfd pfd;
|
|
timestamp_t wakeup;
|
|
|
|
wakeup = check_expirations();
|
|
if (!wakeup)
|
|
return 0;
|
|
|
|
pfd.fd = fd;
|
|
pfd.events = POLLIN;
|
|
if (poll(&pfd, 1, 1000 * wakeup) < 0) {
|
|
if (errno != EINTR)
|
|
die_errno("poll failed");
|
|
return 1;
|
|
}
|
|
|
|
if (pfd.revents & POLLIN) {
|
|
int client, client2;
|
|
FILE *in, *out;
|
|
|
|
client = accept(fd, NULL, NULL);
|
|
if (client < 0) {
|
|
warning_errno("accept failed");
|
|
return 1;
|
|
}
|
|
client2 = dup(client);
|
|
if (client2 < 0) {
|
|
warning_errno("dup failed");
|
|
close(client);
|
|
return 1;
|
|
}
|
|
|
|
in = xfdopen(client, "r");
|
|
out = xfdopen(client2, "w");
|
|
serve_one_client(in, out);
|
|
fclose(in);
|
|
fclose(out);
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
static void serve_cache(const char *socket_path, int debug)
|
|
{
|
|
int fd;
|
|
|
|
fd = unix_stream_listen(socket_path);
|
|
if (fd < 0)
|
|
die_errno("unable to bind to '%s'", socket_path);
|
|
|
|
printf("ok\n");
|
|
fclose(stdout);
|
|
if (!debug) {
|
|
if (!freopen("/dev/null", "w", stderr))
|
|
die_errno("unable to point stderr to /dev/null");
|
|
}
|
|
|
|
while (serve_cache_loop(fd))
|
|
; /* nothing */
|
|
|
|
close(fd);
|
|
}
|
|
|
|
static const char permissions_advice[] = N_(
|
|
"The permissions on your socket directory are too loose; other\n"
|
|
"users may be able to read your cached credentials. Consider running:\n"
|
|
"\n"
|
|
" chmod 0700 %s");
|
|
static void init_socket_directory(const char *path)
|
|
{
|
|
struct stat st;
|
|
char *path_copy = xstrdup(path);
|
|
char *dir = dirname(path_copy);
|
|
|
|
if (!stat(dir, &st)) {
|
|
if (st.st_mode & 077)
|
|
die(_(permissions_advice), dir);
|
|
} else {
|
|
/*
|
|
* We must be sure to create the directory with the correct mode,
|
|
* not just chmod it after the fact; otherwise, there is a race
|
|
* condition in which somebody can chdir to it, sleep, then try to open
|
|
* our protected socket.
|
|
*/
|
|
if (safe_create_leading_directories_const(dir) < 0)
|
|
die_errno("unable to create directories for '%s'", dir);
|
|
if (mkdir(dir, 0700) < 0)
|
|
die_errno("unable to mkdir '%s'", dir);
|
|
}
|
|
|
|
if (chdir(dir))
|
|
/*
|
|
* We don't actually care what our cwd is; we chdir here just to
|
|
* be a friendly daemon and avoid tying up our original cwd.
|
|
* If this fails, it's OK to just continue without that benefit.
|
|
*/
|
|
;
|
|
|
|
free(path_copy);
|
|
}
|
|
|
|
int cmd_main(int argc, const char **argv)
|
|
{
|
|
struct tempfile *socket_file;
|
|
const char *socket_path;
|
|
int ignore_sighup = 0;
|
|
static const char *usage[] = {
|
|
"git-credential-cache--daemon [opts] <socket_path>",
|
|
NULL
|
|
};
|
|
int debug = 0;
|
|
const struct option options[] = {
|
|
OPT_BOOL(0, "debug", &debug,
|
|
N_("print debugging messages to stderr")),
|
|
OPT_END()
|
|
};
|
|
|
|
git_config_get_bool("credentialcache.ignoresighup", &ignore_sighup);
|
|
|
|
argc = parse_options(argc, argv, NULL, options, usage, 0);
|
|
socket_path = argv[0];
|
|
|
|
if (!socket_path)
|
|
usage_with_options(usage, options);
|
|
|
|
if (!is_absolute_path(socket_path))
|
|
die("socket directory must be an absolute path");
|
|
|
|
init_socket_directory(socket_path);
|
|
socket_file = register_tempfile(socket_path);
|
|
|
|
if (ignore_sighup)
|
|
signal(SIGHUP, SIG_IGN);
|
|
|
|
serve_cache(socket_path, debug);
|
|
delete_tempfile(&socket_file);
|
|
|
|
return 0;
|
|
}
|