ls-refs: ignore very long ref-prefix counts

Because each "ref-prefix" capability from the client comes in its own
pkt-line, there's no limit to the number of them that a misbehaving
client may send. We read them all into a strvec, which means the client
can waste arbitrary amounts of our memory by just sending us "ref-prefix
foo" over and over.

One possible solution is to just drop the connection when the limit is
reached. If we set it high enough, then only misbehaving or malicious
clients would hit it. But "high enough" is vague, and it's unfriendly if
we guess wrong and a legitimate client hits this.

But we can do better. Since supporting the ref-prefix capability is
optional anyway, the client has to further cull the response based on
their own patterns. So we can simply ignore the patterns once we cross a
certain threshold. Note that we have to ignore _all_ patterns, not just
the ones past our limit (since otherwise we'd send too little data).

The limit here is fairly arbitrary, and probably much higher than anyone
would need in practice. It might be worth limiting it further, if only
because we check it linearly (so with "m" local refs and "n" patterns,
we do "m * n" string comparisons). But if we care about optimizing this,
an even better solution may be a more advanced data structure anyway.

I didn't bother making the limit configurable, since it's so high and
since Git should behave correctly in either case. It wouldn't be too
hard to do, but it makes both the code and documentation more complex.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/ls-refs.c b/ls-refs.c
index df7f1674334a7e8fd9eb52d97f9e84df464794c2..07429f3a1c4ac2dc0254479a612ee415fc9414d1 100644 (file)
--- a/ls-refs.c
+++ b/ls-refs.c
@@ -40,6 +40,12 @@ static void ensure_config_read(void)
        config_read = 1;
 }
 
+/*
+ * If we see this many or more "ref-prefix" lines from the client, we consider
+ * it "too many" and will avoid using the prefix feature entirely.
+ */
+#define TOO_MANY_PREFIXES 65536
+
 /*
  * Check if one of the prefixes is a prefix of the ref.
  * If no prefixes were provided, all refs match.
@@ -158,8 +164,10 @@ int ls_refs(struct repository *r, struct packet_reader *request)
                        data.peel = 1;
                else if (!strcmp("symrefs", arg))
                        data.symrefs = 1;
-               else if (skip_prefix(arg, "ref-prefix ", &out))
-                       strvec_push(&data.prefixes, out);
+               else if (skip_prefix(arg, "ref-prefix ", &out)) {
+                       if (data.prefixes.nr < TOO_MANY_PREFIXES)
+                               strvec_push(&data.prefixes, out);
+               }
                else if (!strcmp("unborn", arg))
                        data.unborn = allow_unborn;
        }
@@ -167,6 +175,14 @@ int ls_refs(struct repository *r, struct packet_reader *request)
        if (request->status != PACKET_READ_FLUSH)
                die(_("expected flush after ls-refs arguments"));
 
+       /*
+        * If we saw too many prefixes, we must avoid using them at all; as
+        * soon as we have any prefix, they are meant to form a comprehensive
+        * list.
+        */
+       if (data.prefixes.nr >= TOO_MANY_PREFIXES)
+               strvec_clear(&data.prefixes);
+
        send_possibly_unborn_head(&data);
        if (!data.prefixes.nr)
                strvec_push(&data.prefixes, "");

diff --git a/t/t5701-git-serve.sh b/t/t5701-git-serve.sh
index 930721f053f1d1bb418fec18e547e51d3ae64719..520672f842873646d6de46500f413c2927c69995 100755 (executable)
--- a/t/t5701-git-serve.sh
+++ b/t/t5701-git-serve.sh
@@ -158,6 +158,37 @@ test_expect_success 'refs/heads prefix' '
        test_cmp expect actual
 '
 
+test_expect_success 'ignore very large set of prefixes' '
+       # generate a large number of ref-prefixes that we expect
+       # to match nothing; the value here exceeds TOO_MANY_PREFIXES
+       # from ls-refs.c.
+       {
+               echo command=ls-refs &&
+               echo object-format=$(test_oid algo) &&
+               echo 0001 &&
+               perl -le "print \"ref-prefix refs/heads/\$_\" for (1..65536)" &&
+               echo 0000
+       } |
+       test-tool pkt-line pack >in &&
+
+       # and then confirm that we see unmatched prefixes anyway (i.e.,
+       # that the prefix was not applied).
+       cat >expect <<-EOF &&
+       $(git rev-parse HEAD) HEAD
+       $(git rev-parse refs/heads/dev) refs/heads/dev
+       $(git rev-parse refs/heads/main) refs/heads/main
+       $(git rev-parse refs/heads/release) refs/heads/release
+       $(git rev-parse refs/tags/annotated-tag) refs/tags/annotated-tag
+       $(git rev-parse refs/tags/one) refs/tags/one
+       $(git rev-parse refs/tags/two) refs/tags/two
+       0000
+       EOF
+
+       test-tool serve-v2 --stateless-rpc <in >out &&
+       test-tool pkt-line unpack <out >actual &&
+       test_cmp expect actual
+'
+
 test_expect_success 'peel parameter' '
        test-tool pkt-line pack >in <<-EOF &&
        command=ls-refs