setup_traverse_info(): stop copying oid
authorJeff King <peff@peff.net>
Wed, 31 Jul 2019 04:38:11 +0000 (00:38 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 31 Jul 2019 20:30:58 +0000 (13:30 -0700)
We assume that if setup_traverse_info() is passed a non-empty "base"
string, that string is pointing into a tree object and we can read the
object oid by skipping past the trailing NUL.

As it turns out, this is not true for either of the two calls, and we
may end up reading garbage bytes:

  1. In git-merge-tree, our base string is either empty (in which case
     we'd never run this code), or it comes from our traverse_path()
     helper. The latter overallocates a buffer by the_hash_algo->rawsz
     bytes, but then fills it with only make_traverse_path(), leaving
     those extra bytes uninitialized (but part of a legitimate heap
     buffer).

  2. In unpack_trees(), we pass o->prefix, which is some arbitrary
     string from the caller. In "git read-tree --prefix=foo", for
     instance, it will point to the command-line parameter, and we'll
     read 20 bytes past the end of the string.

Interestingly, tools like ASan do not detect (2) because the process
argv is part of a big pre-allocated buffer. So we're reading trash, but
it's trash that's probably part of the next argument, or the
environment.

You can convince it to fail by putting something like this at the
beginning of common-main.c's main() function:

  {
int i;
for (i = 0; i < argc; i++)
argv[i] = xstrdup_or_null(argv[i]);
  }

That puts the arguments into their own heap buffers, so running:

  make SANITIZE=address test

will find problems when "read-tree --prefix" is used (e.g., in t3030).

Doubly interesting, even with the hackery above, this does not fail
prior to ea82b2a085 (tree-walk: store object_id in a separate member,
2019-01-15). That commit switched setup_traverse_info() to actually
copying the hash, rather than simply pointing to it. That pointer was
always pointing to garbage memory, but that commit started actually
dereferencing the bytes, which is what triggers ASan.

That also implies that nobody actually cares about reading these oid
bytes anyway (or at least no path covered by our tests). And manual
inspection of the code backs that up (I'll follow this patch with some
cleanups that show definitively this is the case, but they're quite
invasive, so it's worth doing this fix on its own).

So let's drop the bogus hashcpy(), along with the confusing oversizing
in merge-tree.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-tree-walking.txt
builtin/merge-tree.c
tree-walk.c

index bde1862..59d78e0 100644 (file)
@@ -62,9 +62,7 @@ Initializing
 `setup_traverse_info`::
 
        Initialize a `traverse_info` given the pathname of the tree to start
-       traversing from. The `base` argument is assumed to be the `path`
-       member of the `name_entry` being recursed into unless the tree is a
-       top-level tree in which case the empty string ("") is used.
+       traversing from.
 
 Walking
 -------
index 34ca025..8ac6270 100644 (file)
@@ -180,7 +180,7 @@ static struct merge_list *create_entry(unsigned stage, unsigned mode, const stru
 
 static char *traverse_path(const struct traverse_info *info, const struct name_entry *n)
 {
-       char *path = xmallocz(traverse_path_len(info, n) + the_hash_algo->rawsz);
+       char *path = xmallocz(traverse_path_len(info, n));
        return make_traverse_path(path, info, n);
 }
 
index ec32a47..ba10615 100644 (file)
@@ -177,10 +177,8 @@ void setup_traverse_info(struct traverse_info *info, const char *base)
        info->pathlen = pathlen ? pathlen + 1 : 0;
        info->name.path = base;
        info->name.pathlen = pathlen;
-       if (pathlen) {
-               hashcpy(info->name.oid.hash, (const unsigned char *)base + pathlen + 1);
+       if (pathlen)
                info->prev = &dummy;
-       }
 }
 
 char *make_traverse_path(char *path, const struct traverse_info *info, const struct name_entry *n)