Skip to contentSkip to conversation

rev-parse: Check argc before using argv[i+1]

PATCH Superseded David Sharp 3 participants 8 messages Jun 15, 2016

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rev-parse: Check argc before using argv[i+1]

Without this patch, git-rev-parse --prefix, --default, or --resolve-git-dir, without a value argument, would result in a segfault. Instead, die() with a message.

---
 builtin/rev-parse.c | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)
builtin/rev-parse.c +10 -6
index aaeb611..3bf65c5 100644
@@ -547,15 +547,17 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--default")) {
-				def = argv[i+1];
-				i++;
+				if (++i >= argc)
+					die("--default requires an argument");
+				def = argv[i];
 				continue;
 			}
 			if (!strcmp(arg, "--prefix")) {
-				prefix = argv[i+1];
+				if (++i >= argc)
+					die("--prefix requires an argument");
+				prefix = argv[i];
 				startup_info->prefix = prefix;
 				output_prefix = 1;
-				i++;
 				continue;
 			}
 			if (!strcmp(arg, "--revs-only")) {
@@ -738,9 +740,11 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--resolve-git-dir")) {
-				const char *gitdir = resolve_gitdir(argv[i+1]);
+				if (++i >= argc)
+					die("--resolve-git-dir requires an argument");
+				const char *gitdir = resolve_gitdir(argv[i]);
 				if (!gitdir)
-					die("not a gitdir '%s'", argv[i+1]);
+					die("not a gitdir '%s'", argv[i]);
 				puts(gitdir);
 				continue;
 			}
Signature · 1 line
1.8.5.3
#1 lore raw

builtin/rev-parse.c int cmd_rev_parse(int argc, const char **argv, const char *prefix) · line 747

Quoted 11 lines · David Sharp
builtin/rev-parse.c +4 -2
@@ -738,9 +740,11 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--resolve-git-dir")) {
-				const char *gitdir = resolve_gitdir(argv[i+1]);
+				if (++i >= argc)
+					die("--resolve-git-dir requires an argument");
+				const char *gitdir = resolve_gitdir(argv[i]);
 				if (!gitdir)
-					die("not a gitdir '%s'", argv[i+1]);
+					die("not a gitdir '%s'", argv[i]);

This adds decl-after-statement. As referencing argv[argc] is not a crime (you will grab a NULL), how about doing it this way to see if the value is a NULL, instead of comparing the index and argc?

	const char *gitdir;
        if (!argv[++i])
        	die("--resolve-git-dir requires an argument");
	gitdir = resolve_gitdir(argv[i]);
        if (!gitdir)
        	die("not a gitdir '%s'", argv[i]);

Same comment may apply to other hunks.

Thanks.

#2 lore raw
Quoted 15 lines · Junio C Hamano

builtin/rev-parse.c int cmd_rev_parse(int argc, const char **argv, const char *prefix) · line 747

Quoted 11 lines · David Sharp
builtin/rev-parse.c +4 -2
@@ -738,9 +740,11 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
                              continue;
                      }
                      if (!strcmp(arg, "--resolve-git-dir")) {
-                             const char *gitdir = resolve_gitdir(argv[i+1]);
+                             if (++i >= argc)
+                                     die("--resolve-git-dir requires an argument");
+                             const char *gitdir = resolve_gitdir(argv[i]);
                              if (!gitdir)
-                                     die("not a gitdir '%s'", argv[i+1]);
+                                     die("not a gitdir '%s'", argv[i]);

This adds decl-after-statement.

Sorry, I wasn't aware that git is trying to conform to C90. (It's not compiled with -std=c90, -ansi or -Wdeclaration-after-statement.)

Quoted 3 lines

As referencing argv[argc] is not a
crime (you will grab a NULL), how about doing it this way to see if the value is a NULL, instead of comparing the index and argc?

I'm not convinced this is any better, but alright. I did something slightly different based on that, though.

v2 patch incoming...

Quoted 11 lines
        const char *gitdir;
        if (!argv[++i])
                die("--resolve-git-dir requires an argument");
        gitdir = resolve_gitdir(argv[i]);
        if (!gitdir)
                die("not a gitdir '%s'", argv[i]);

Same comment may apply to other hunks.

Thanks.

#3 lore raw

PATCH v2 1/1 rev-parse: Check argc before using argv[i+1]

Without this patch, git-rev-parse --prefix, --default, or --resolve-git-dir, without a value argument, would result in a segfault. Instead, die() with a message.

---
 builtin/rev-parse.c | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)
builtin/rev-parse.c +11 -6
index aaeb611..45901df 100644
@@ -547,15 +547,17 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--default")) {
-				def = argv[i+1];
-				i++;
+				def = argv[++i];
+				if (!def)
+					die("--default requires an argument");
 				continue;
 			}
 			if (!strcmp(arg, "--prefix")) {
-				prefix = argv[i+1];
+				prefix = argv[++i];
+				if (!prefix)
+					die("--prefix requires an argument");
 				startup_info->prefix = prefix;
 				output_prefix = 1;
-				i++;
 				continue;
 			}
 			if (!strcmp(arg, "--revs-only")) {
@@ -738,9 +740,12 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--resolve-git-dir")) {
-				const char *gitdir = resolve_gitdir(argv[i+1]);
+				const char *gitdir = argv[++i];
 				if (!gitdir)
-					die("not a gitdir '%s'", argv[i+1]);
+					die("--resolve-git-dir requires an argument");
+				gitdir = resolve_gitdir(gitdir);
+				if (!gitdir)
+					die("not a gitdir '%s'", argv[i]);
 				puts(gitdir);
 				continue;
 			}
Signature · 1 line
1.8.5.3
#4 lore raw

Am 28.01.2014 22:21, schrieb David Sharp:

Quoted 5 lines
builtin/rev-parse.c +0 -1
@@ -738,9 +740,12 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--resolve-git-dir")) {
-				const char *gitdir = resolve_gitdir(argv[i+1]);

builtin/rev-parse.c int cmd_rev_parse(int argc, const char **argv, const char *prefix) · line 751

Quoted 10 lines
builtin/rev-parse.c +5 -1
+				const char *gitdir = argv[++i];
 				if (!gitdir)
-					die("not a gitdir '%s'", argv[i+1]);
+					die("--resolve-git-dir requires an argument");
+				gitdir = resolve_gitdir(gitdir);
+				if (!gitdir)
+					die("not a gitdir '%s'", argv[i]);
 				puts(gitdir);
 				continue;
 			}

In this hunk, I don't see where the old code incremented i for the argument. Was this another bug lurking that is fixed now?

-- Hannes

#5 lore raw
Quoted 11 lines · Johannes Sixt

Am 28.01.2014 22:21, schrieb David Sharp:

Quoted 10 lines
builtin/rev-parse.c +3 -2
@@ -738,9 +740,12 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
                              continue;
                      }
                      if (!strcmp(arg, "--resolve-git-dir")) {
-                             const char *gitdir = resolve_gitdir(argv[i+1]);
+                             const char *gitdir = argv[++i];
                              if (!gitdir)
-                                     die("not a gitdir '%s'", argv[i+1]);
+                                     die("--resolve-git-dir requires an argument");
+                             gitdir = resolve_gitdir(gitdir);
Quoted 8 lines

builtin/rev-parse.c int cmd_rev_parse(int argc, const char **argv, const char *prefix) · line 751

Quoted 5 lines
builtin/rev-parse.c +2 -0
+                             if (!gitdir)
+                                     die("not a gitdir '%s'", argv[i]);
                              puts(gitdir);
                              continue;
                      }

In this hunk, I don't see where the old code incremented i for the argument. Was this another bug lurking that is fixed now?

Yup. I did notice that too. Should have mentioned it in the description.

Quoted 3 lines

-- Hannes

#6 lore raw
In reply to David Sharp
Quoted 3 lines · David Sharp

Without this patch, git-rev-parse --prefix, --default, or --resolve-git-dir, without a value argument, would result in a segfault. Instead, die() with a message.

When I sent the review message, I actually was on the fence between checking i vs argc and checking the nullness myself. I realize, after seeing the actual patch below, that we are protecting against picking up a NULL and blindly passing it on in the codepaths that follow, so the updated code does look a lot better, at least to me.

Thanks.

Quoted 47 lines
---
 builtin/rev-parse.c | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)
builtin/rev-parse.c +11 -6
index aaeb611..45901df 100644
@@ -547,15 +547,17 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--default")) {
-				def = argv[i+1];
-				i++;
+				def = argv[++i];
+				if (!def)
+					die("--default requires an argument");
 				continue;
 			}
 			if (!strcmp(arg, "--prefix")) {
-				prefix = argv[i+1];
+				prefix = argv[++i];
+				if (!prefix)
+					die("--prefix requires an argument");
 				startup_info->prefix = prefix;
 				output_prefix = 1;
-				i++;
 				continue;
 			}
 			if (!strcmp(arg, "--revs-only")) {
@@ -738,9 +740,12 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
 				continue;
 			}
 			if (!strcmp(arg, "--resolve-git-dir")) {
-				const char *gitdir = resolve_gitdir(argv[i+1]);
+				const char *gitdir = argv[++i];
 				if (!gitdir)
-					die("not a gitdir '%s'", argv[i+1]);
+					die("--resolve-git-dir requires an argument");
+				gitdir = resolve_gitdir(gitdir);
+				if (!gitdir)
+					die("not a gitdir '%s'", argv[i]);
 				puts(gitdir);
 				continue;
 			}
#7 lore raw
Quoted 11 lines · Junio C Hamano
Quoted 3 lines · David Sharp

Without this patch, git-rev-parse --prefix, --default, or --resolve-git-dir, without a value argument, would result in a segfault. Instead, die() with a message.

When I sent the review message, I actually was on the fence between checking i vs argc and checking the nullness myself. I realize, after seeing the actual patch below, that we are protecting against picking up a NULL and blindly passing it on in the codepaths that follow, so the updated code does look a lot better, at least to me.

It's a matter of perspective, I guess. When checking the index, to me, I saw that it is protecting against reading past the end of an array, which is at least as bad as sending NULL to codepaths that don't accept NULL. I do think that everybody knows that reading past the end of an array is bad, while not necessarily everybody knows that the argv array is null-terminated.

Quoted 50 lines

Thanks.

Quoted 47 lines
---
 builtin/rev-parse.c | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)
builtin/rev-parse.c +11 -6
index aaeb611..45901df 100644
@@ -547,15 +547,17 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
                              continue;
                      }
                      if (!strcmp(arg, "--default")) {
-                             def = argv[i+1];
-                             i++;
+                             def = argv[++i];
+                             if (!def)
+                                     die("--default requires an argument");
                              continue;
                      }
                      if (!strcmp(arg, "--prefix")) {
-                             prefix = argv[i+1];
+                             prefix = argv[++i];
+                             if (!prefix)
+                                     die("--prefix requires an argument");
                              startup_info->prefix = prefix;
                              output_prefix = 1;
-                             i++;
                              continue;
                      }
                      if (!strcmp(arg, "--revs-only")) {
@@ -738,9 +740,12 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix)
                              continue;
                      }
                      if (!strcmp(arg, "--resolve-git-dir")) {
-                             const char *gitdir = resolve_gitdir(argv[i+1]);
+                             const char *gitdir = argv[++i];
                              if (!gitdir)
-                                     die("not a gitdir '%s'", argv[i+1]);
+                                     die("--resolve-git-dir requires an argument");
+                             gitdir = resolve_gitdir(gitdir);
+                             if (!gitdir)
+                                     die("not a gitdir '%s'", argv[i]);
                              puts(gitdir);
                              continue;
                      }