Skip to contentSkip to conversation

kvargs: fix a heap-buffer-overflow when detect list

PATCH In review wangyunjian 3 participants 9 messages Mar 19, 2020 – Mar 27, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kvargs: fix a heap-buffer-overflow when detect list

From: Yunjian Wang <[email protected]>

When an input params'value is '[', leading to the 'str' over read or heap-buffer-overflow. So we can check the 'ctx1' length to avoid this problem.

Fixes cc0579f2339a ("kvargs: support list value")
---
 lib/librte_kvargs/rte_kvargs.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
lib/librte_kvargs/rte_kvargs.c +2 -1
index d39332999..a1144b90b 100644
@@ -48,7 +48,8 @@ rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params)
 		str = kvlist->pairs[i].value;
 		if (str[0] == '[') {
 			/* Find the end of the list. */
-			while (str[strlen(str) - 1] != ']') {
+			while ((str[strlen(str) - 1] != ']') &&
+			       (strlen(ctx1) > 0)) {
 				/* Restore the comma erased by strtok_r(). */
 				str[strlen(str)] = ',';
 				/* Parse until next comma. */
Signature · 1 line
2.19.1
#1 lore raw

Hi,

Quoted 19 lines · wangyunjian

From: Yunjian Wang <[email protected]>

When an input params'value is '[', leading to the 'str' over read or heap-buffer-overflow. So we can check the 'ctx1' length to avoid this problem.

Fixes cc0579f2339a ("kvargs: support list value")
---
 lib/librte_kvargs/rte_kvargs.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
lib/librte_kvargs/rte_kvargs.c +0 -0
index d39332999..a1144b90b 100644

lib/librte_kvargs/rte_kvargs.c rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params) · line 55

Quoted 9 lines
lib/librte_kvargs/rte_kvargs.c +2 -1
@@ -48,7 +48,8 @@ rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params)
 		str = kvlist->pairs[i].value;
 		if (str[0] == '[') {
 			/* Find the end of the list. */
-			while (str[strlen(str) - 1] != ']') {
+			while ((str[strlen(str) - 1] != ']') &&
+			       (strlen(ctx1) > 0)) {
 				/* Restore the comma erased by strtok_r(). */
 				str[strlen(str)] = ',';
 				/* Parse until next comma. */

I would prefer to keep the while condition as is, like this:

                                /* Restore the comma erased by strtok_r(). */
+                               if (ctx1[0] == '\0')
+                                       return -1; /* no closing bracket */
                                str[strlen(str)] = ',';

It avoids an uneeded call to strlen(), and ensure we are returning an error in that case.

I also wanted to add a test case, but I realized that kvargs unit tests are broken now. I have done 2 patches to fix them.

Do you mind if I send a patchset with these 2 patches + your patch (keeping your signed-off and doing the modification described above), to ensure there is no implicit dependency?

Thanks,
Olivier

#2 lore raw
Quoted 57 lines

-----邮件原件-----
发件人: Olivier Matz [mailto:[email protected]]
发送时间: 2020年3月26日 0:32
收件人: wangyunjian <[email protected]>
抄送: [email protected]; Lilijun (Jerry) <[email protected]>; xudingke <[email protected]>; [email protected]
主题: Re: [dpdk-dev] [PATCH] kvargs: fix a heap-buffer-overflow when detect list

Hi,

lib/librte_kvargs/rte_kvargs.c rte_kvargs_tokenize(struct rte_kvargs *kvlist, const

Quoted 19 lines · wangyunjian

From: Yunjian Wang <[email protected]>

When an input params'value is '[', leading to the 'str' over read or heap-buffer-overflow. So we can check the 'ctx1' length to avoid this problem.

Fixes cc0579f2339a ("kvargs: support list value")
---
 lib/librte_kvargs/rte_kvargs.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
(quoted diff) +0 -0

b/lib/librte_kvargs/rte_kvargs.c index d39332999..a1144b90b 100644

lib/librte_kvargs/rte_kvargs.c +0 -0
@@ -48,7 +48,8 @@ rte_kvargs_tokenize(struct rte_kvargs *kvlist, const

char *params)

lib/librte_kvargs/rte_kvargs.c rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params) · line 55

Quoted 9 lines
lib/librte_kvargs/rte_kvargs.c +2 -1
 		str = kvlist->pairs[i].value;
 		if (str[0] == '[') {
 			/* Find the end of the list. */
-			while (str[strlen(str) - 1] != ']') {
+			while ((str[strlen(str) - 1] != ']') &&
+			       (strlen(ctx1) > 0)) {
 				/* Restore the comma erased by strtok_r(). */
 				str[strlen(str)] = ',';
 				/* Parse until next comma. */

I would prefer to keep the while condition as is, like this:

                                /* Restore the comma erased by

strtok_r(). */

(quoted diff) +2 -0
+                               if (ctx1[0] == '\0')
+                                       return -1; /* no closing

bracket
+ */

                                str[strlen(str)] = ',';

It avoids an uneeded call to strlen(), and ensure we are returning an error in that case.

Quoted 6 lines

I also wanted to add a test case, but I realized that kvargs unit tests are broken now. I have done 2 patches to fix them.

Do you mind if I send a patchset with these 2 patches + your patch (keeping your signed-off and doing the modification described above), to ensure there is no implicit dependency?

No, I don’t mind. I agree with your view.

Thanks
Yunjian

Quoted 3 lines

Thanks,
Olivier

#3 lore raw

v2 cover kvargs fixes

In reply to wangyunjian

This patchset fixes a buffer overflow in kvargs when parsing an invalid string, and fixes the kvargs unit tests.

Olivier Matz (2):
tests/kvargs: fix to consider empty elements as valid tests/kvargs: fix check of invalid cases

Yunjian Wang (1):
kvargs: fix a heap buffer overflow when parsing list

 app/test/test_kvargs.c         | 40 +++++++++++++++++++++++++++++++---
 lib/librte_kvargs/rte_kvargs.c |  2 ++
 2 files changed, 39 insertions(+), 3 deletions(-)
Signature · 1 line
2.25.1
#4 lore raw

PATCH v2 1/3 tests/kvargs: fix to consider empty elements as valid

Empty elements passed to the kvargs parser are silently ignored. Examples of valid strings:
""
","
",,,,,,key=val,,,,"

Fix the unit tests to conform to this behavior.

Note: the test_invalid_kvargs() function is currently broken, which explain why the tests were not failing. It is fixed in the next commit.

Fixes e495f5435524 ("kvargs: add test case in app/test")
---
 app/test/test_kvargs.c | 37 +++++++++++++++++++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)
app/test/test_kvargs.c +35 -2
index a42056f36..d3db88a57 100644
@@ -142,7 +142,7 @@ static int test_valid_kvargs(void)
 	valid_keys = valid_keys_list;
 	kvlist = rte_kvargs_parse(args, valid_keys);
 	if (kvlist == NULL) {
-		printf("rte_kvargs_parse() error");
+		printf("rte_kvargs_parse() error\n");
 		goto fail;
 	}
 	if (strcmp(kvlist->pairs[0].value, "[0,1]") != 0) {
@@ -157,6 +157,40 @@ static int test_valid_kvargs(void)
 	}
 	rte_kvargs_free(kvlist);
 
+	/* test using empty string (it is valid) */
+	args = "";
+	kvlist = rte_kvargs_parse(args, NULL);
+	if (kvlist == NULL) {
+		printf("rte_kvargs_parse() error\n");
+		goto fail;
+	}
+	if (rte_kvargs_count(kvlist, NULL) != 0) {
+		printf("invalid count value\n");
+		goto fail;
+	}
+	rte_kvargs_free(kvlist);
+
+	/* test using empty elements (it is valid) */
+	args = "foo=1,,check=value2,,";
+	kvlist = rte_kvargs_parse(args, NULL);
+	if (kvlist == NULL) {
+		printf("rte_kvargs_parse() error\n");
+		goto fail;
+	}
+	if (rte_kvargs_count(kvlist, NULL) != 2) {
+		printf("invalid count value\n");
+		goto fail;
+	}
+	if (rte_kvargs_count(kvlist, "foo") != 1) {
+		printf("invalid count value for 'foo'\n");
+		goto fail;
+	}
+	if (rte_kvargs_count(kvlist, "check") != 1) {
+		printf("invalid count value for 'check'\n");
+		goto fail;
+	}
+	rte_kvargs_free(kvlist);
+
 	return 0;
 
  fail:
@@ -179,7 +213,6 @@ static int test_invalid_kvargs(void)
 	const char *args_list[] = {
 		"wrong-key=x",     /* key not in valid_keys_list */
 		"foo=1,foo=",      /* empty value */
-		"foo=1,,foo=2",    /* empty key/value */
 		"foo=1,foo",       /* no value */
 		"foo=1,=2",        /* no key */
 		"foo=[1,2",        /* no closing bracket in value */
Signature · 1 line
2.25.1
#5 lore raw

PATCH v2 2/3 tests/kvargs: fix check of invalid cases

In reply to Olivier Matz

The return was not properly placed, and only the first test case was validated.

Fixes e495f5435524 ("kvargs: add test case in app/test")
---
 app/test/test_kvargs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
app/test/test_kvargs.c +1 -1
index d3db88a57..f823b771f 100644
@@ -230,8 +230,8 @@ static int test_invalid_kvargs(void)
 			rte_kvargs_free(kvlist);
 			goto fail;
 		}
-		return 0;
 	}
+	return 0;
 
  fail:
 	printf("while processing <%s>", *args);
Signature · 1 line
2.25.1
#6 lore raw

PATCH v2 3/3 kvargs: fix a heap buffer overflow when parsing list

In reply to Olivier Matz

From: Yunjian Wang <[email protected]>

When the input string is "key=[", the ending '\0' is replaced by a ',', leading to a heap buffer overflow.

Check the content of ctx1 to avoid this problem.

Fixes cc0579f2339a ("kvargs: support list value")
---
 app/test/test_kvargs.c         | 1 +
 lib/librte_kvargs/rte_kvargs.c | 2 ++
 2 files changed, 3 insertions(+)
app/test/test_kvargs.c +1 -0
index f823b771f..2a2dae43a 100644
@@ -217,6 +217,7 @@ static int test_invalid_kvargs(void)
 		"foo=1,=2",        /* no key */
 		"foo=[1,2",        /* no closing bracket in value */
 		",=",              /* also test with a smiley */
+		"foo=[",           /* no value in list and no closing bracket */
 		NULL };
 	const char **args;
 	const char *valid_keys_list[] = { "foo", "check", NULL };
lib/librte_kvargs/rte_kvargs.c +2 -0
index d39332999..1d815dcd9 100644
@@ -50,6 +50,8 @@ rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params)
 			/* Find the end of the list. */
 			while (str[strlen(str) - 1] != ']') {
 				/* Restore the comma erased by strtok_r(). */
+				if (ctx1[0] == '\0')
+					return -1; /* no closing bracket */
 				str[strlen(str)] = ',';
 				/* Parse until next comma. */
 				str = strtok_r(NULL, RTE_KVARGS_PAIRS_DELIM, &ctx1);
Signature · 1 line
2.25.1
Reviewed-by on the v2 series
#7 lore raw

Re: [dpdk-dev] [dpdk-stable] [PATCH v2 0/3] kvargs fixes

In reply to Olivier Matz
Quoted 10 lines · Olivier Matz

This patchset fixes a buffer overflow in kvargs when parsing an invalid string, and fixes the kvargs unit tests.

Olivier Matz (2):
tests/kvargs: fix to consider empty elements as valid tests/kvargs: fix check of invalid cases

Yunjian Wang (1):
kvargs: fix a heap buffer overflow when parsing list

For the series,

Signature · 1 line
David Marchand
#8 lore raw

Re: [dpdk-dev] [dpdk-stable] [PATCH v2 0/3] kvargs fixes

Quoted 10 lines · David Marchand
Quoted 8 lines · Olivier Matz

This patchset fixes a buffer overflow in kvargs when parsing an invalid string, and fixes the kvargs unit tests.

Olivier Matz (2):
tests/kvargs: fix to consider empty elements as valid tests/kvargs: fix check of invalid cases

Quoted 5 lines
Quoted 2 lines

Yunjian Wang (1):
kvargs: fix a heap buffer overflow when parsing list

For the series,

Applied, thanks.

Signature · 1 line
David Marchand