Skip to contentSkip to conversation

dell-smbios: fix string overflow

PATCH Applied Arnd Bergmann 6 participants 8 messages Nov 8, 2017 – Nov 9, 2017 x86 platform drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dell-smbios: fix string overflow

The new sysfs code overwrites two fixed-length character arrays that are each one byte shorter than they need to be, to hold the trailing \0:

drivers/platform/x86/dell-smbios.c: In function 'build_tokens_sysfs':
drivers/platform/x86/dell-smbios.c:494:42: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_location, "%04x_location",
drivers/platform/x86/dell-smbios.c:494:3: note: 'sprintf' output 14 bytes into a destination of size 13 drivers/platform/x86/dell-smbios.c:506:36: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_value, "%04x_value",
drivers/platform/x86/dell-smbios.c:506:3: note: 'sprintf' output 11 bytes into a destination of size 10

This changes it to just use kasprintf(), which always gets it right.

Fixes 33b9ca1e53b4 ("platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens")
---
 drivers/platform/x86/dell-smbios.c | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)
drivers/platform/x86/dell-smbios.c +4 -8
index d99edd803c19..6a60db515bda 100644
@@ -463,8 +463,6 @@ static struct platform_driver platform_driver = {
 
 static int build_tokens_sysfs(struct platform_device *dev)
 {
-	char buffer_location[13];
-	char buffer_value[10];
 	char *location_name;
 	char *value_name;
 	size_t size;
@@ -491,9 +489,8 @@ static int build_tokens_sysfs(struct platform_device *dev)
 		if (da_tokens[i].tokenID == 0)
 			continue;
 		/* add location */
-		sprintf(buffer_location, "%04x_location",
-			da_tokens[i].tokenID);
-		location_name = kstrdup(buffer_location, GFP_KERNEL);
+		location_name = kasprintf(GFP_KERNEL, "%04x_location",
+					  da_tokens[i].tokenID);
 		if (location_name == NULL)
 			goto out_unwind_strings;
 		sysfs_attr_init(&token_location_attrs[i].attr);
@@ -503,9 +500,8 @@ static int build_tokens_sysfs(struct platform_device *dev)
 		token_attrs[j++] = &token_location_attrs[i].attr;
 
 		/* add value */
-		sprintf(buffer_value, "%04x_value",
-			da_tokens[i].tokenID);
-		value_name = kstrdup(buffer_value, GFP_KERNEL);
+		value_name = kasprintf(GFP_KERNEL, "%04x_value",
+				       da_tokens[i].tokenID);
 		if (value_name == NULL)
 			goto loop_fail_create_value;
 		sysfs_attr_init(&token_value_attrs[i].attr);
Signature · 1 line
2.9.0
#1 lore raw

Hi,

I recommend using "platform/x86: dell-smbios:" in commit header.

Quoted 11 lines · Arnd Bergmann

The new sysfs code overwrites two fixed-length character arrays that are each one byte shorter than they need to be, to hold the trailing \0:

drivers/platform/x86/dell-smbios.c: In function 'build_tokens_sysfs':
drivers/platform/x86/dell-smbios.c:494:42: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_location, "%04x_location",
drivers/platform/x86/dell-smbios.c:494:3: note: 'sprintf' output 14 bytes into a destination of size 13 drivers/platform/x86/dell-smbios.c:506:36: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]

    sprintf(buffer_value, "%04x_value",

drivers/platform/x86/dell-smbios.c:506:3: note: 'sprintf' output 11 bytes into a destination of size 10

Don't need to include the error log in commit message. Just explaining the issue is good enough.

Quoted 46 lines

This changes it to just use kasprintf(), which always gets it right.

Fixes 33b9ca1e53b4 ("platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens")
---
  drivers/platform/x86/dell-smbios.c | 12 ++++--------
  1 file changed, 4 insertions(+), 8 deletions(-)
drivers/platform/x86/dell-smbios.c +4 -8
index d99edd803c19..6a60db515bda 100644
@@ -463,8 +463,6 @@ static struct platform_driver platform_driver = {
 
  static int build_tokens_sysfs(struct platform_device *dev)
  {
-	char buffer_location[13];
-	char buffer_value[10];
  	char *location_name;
  	char *value_name;
  	size_t size;
@@ -491,9 +489,8 @@ static int build_tokens_sysfs(struct platform_device *dev)
  		if (da_tokens[i].tokenID == 0)
  			continue;
  		/* add location */
-		sprintf(buffer_location, "%04x_location",
-			da_tokens[i].tokenID);
-		location_name = kstrdup(buffer_location, GFP_KERNEL);
+		location_name = kasprintf(GFP_KERNEL, "%04x_location",
+					  da_tokens[i].tokenID);
  		if (location_name == NULL)
  			goto out_unwind_strings;
  		sysfs_attr_init(&token_location_attrs[i].attr);
@@ -503,9 +500,8 @@ static int build_tokens_sysfs(struct platform_device *dev)
  		token_attrs[j++] = &token_location_attrs[i].attr;
 
  		/* add value */
-		sprintf(buffer_value, "%04x_value",
-			da_tokens[i].tokenID);
-		value_name = kstrdup(buffer_value, GFP_KERNEL);
+		value_name = kasprintf(GFP_KERNEL, "%04x_value",
+				       da_tokens[i].tokenID);
  		if (value_name == NULL)
  			goto loop_fail_create_value;
  		sysfs_attr_init(&token_value_attrs[i].attr);
Signature · 2 lines
Sathyanarayanan Kuppuswamy
Linux kernel developer
#2 lore raw
Quoted 77 lines

-----Original Message-----
From: sathyanarayanan kuppuswamy [mailto:[email protected]]
Sent: Wednesday, November 8, 2017 12:23 PM
To: Arnd Bergmann <[email protected]>; Pali Rohár <[email protected]>; Limonciello, Mario <[email protected]>; Darren Hart <[email protected]>; Andy Shevchenko <[email protected]>
Cc: Edward O'Callaghan <[email protected]>; Hans de Goede <[email protected]>; [email protected]; linux- [email protected]
Subject: Re: [PATCH] dell-smbios: fix string overflow

Hi,

I recommend using "platform/x86: dell-smbios:" in commit header.

Quoted 6 lines · Arnd Bergmann

The new sysfs code overwrites two fixed-length character arrays that are each one byte shorter than they need to be, to hold the trailing \0:

drivers/platform/x86/dell-smbios.c: In function 'build_tokens_sysfs':
drivers/platform/x86/dell-smbios.c:494:42: error: 'sprintf' writing a terminating

nul past the end of the destination [-Werror=format-overflow=]

Quoted 2 lines

sprintf(buffer_location, "%04x_location",
drivers/platform/x86/dell-smbios.c:494:3: note: 'sprintf' output 14 bytes into a

destination of size 13

Quoted 1 line

drivers/platform/x86/dell-smbios.c:506:36: error: 'sprintf' writing a terminating

nul past the end of the destination [-Werror=format-overflow=]

Quoted 2 lines
    sprintf(buffer_value, "%04x_value",

drivers/platform/x86/dell-smbios.c:506:3: note: 'sprintf' output 11 bytes into a

destination of size 10
Don't need to include the error log in commit message. Just explaining the issue is good enough.

Quoted 4 lines

This changes it to just use kasprintf(), which always gets it right.

Fixes 33b9ca1e53b4 ("platform/x86: dell-smbios: Add a sysfs interface for

SMBIOS tokens")

drivers/platform/x86/dell-

Quoted 6 lines
---
  drivers/platform/x86/dell-smbios.c | 12 ++++--------
  1 file changed, 4 insertions(+), 8 deletions(-)
drivers/platform/x86/dell- renamed from drivers/platform/x86/dell-smbios.c +0 -0

smbios.c

drivers/platform/x86/dell-smbios.c static int build_tokens_sysfs(struct platform_device

Quoted 13 lines

index d99edd803c19..6a60db515bda 100644

drivers/platform/x86/dell-smbios.c +0 -2
@@ -463,8 +463,6 @@ static struct platform_driver platform_driver = {
 
  static int build_tokens_sysfs(struct platform_device *dev)
  {
-	char buffer_location[13];
-	char buffer_value[10];
  	char *location_name;
  	char *value_name;
  	size_t size;
@@ -491,9 +489,8 @@ static int build_tokens_sysfs(struct platform_device

*dev)

drivers/platform/x86/dell-smbios.c static int build_tokens_sysfs(struct platform_device

Quoted 12 lines
drivers/platform/x86/dell-smbios.c +2 -3
  		if (da_tokens[i].tokenID == 0)
  			continue;
  		/* add location */
-		sprintf(buffer_location, "%04x_location",
-			da_tokens[i].tokenID);
-		location_name = kstrdup(buffer_location, GFP_KERNEL);
+		location_name = kasprintf(GFP_KERNEL, "%04x_location",
+					  da_tokens[i].tokenID);
  		if (location_name == NULL)
  			goto out_unwind_strings;
  		sysfs_attr_init(&token_location_attrs[i].attr);
@@ -503,9 +500,8 @@ static int build_tokens_sysfs(struct platform_device

*dev)

Quoted 2 lines
drivers/platform/x86/dell-smbios.c +0 -0
  		token_attrs[j++] = &token_location_attrs[i].attr;
 
Quoted 11 lines

drivers/platform/x86/dell-smbios.c static int build_tokens_sysfs(struct platform_device *dev) · line 507

Quoted 9 lines
drivers/platform/x86/dell-smbios.c +2 -3
  		/* add value */
-		sprintf(buffer_value, "%04x_value",
-			da_tokens[i].tokenID);
-		value_name = kstrdup(buffer_value, GFP_KERNEL);
+		value_name = kasprintf(GFP_KERNEL, "%04x_value",
+				       da_tokens[i].tokenID);
  		if (value_name == NULL)
  			goto loop_fail_create_value;
  		sysfs_attr_init(&token_value_attrs[i].attr);

--

Arnd,

Assuming Darren will do the fixup for title and message as recommended by Sathyanarayanan before committing:

Thanks, for the fix. For my own information and improvement, would you share how you caught that? Just added "-Werror=format-overflow=" to CFLAGS? I wasn't seeing the compile errors with default flags in my own testing, so I'd like to make sure I'm doing better testing in the future.

#3 lore raw
Quoted 1 line · On Wed, Nov 8, 2017 at 8:30 PM, <[email protected]> wrote:
Quoted 1 line

I recommend using "platform/x86: dell-smbios:" in commit header.

While we (maintainers) are fixing this manually, it would be better if contributors will do this themselves :-)

Quoted 12 lines
Quoted 12 lines · Arnd Bergmann
Quoted 6 lines

The new sysfs code overwrites two fixed-length character arrays that are each one byte shorter than they need to be, to hold the trailing \0:

drivers/platform/x86/dell-smbios.c: In function 'build_tokens_sysfs':
drivers/platform/x86/dell-smbios.c:494:42: error: 'sprintf' writing a terminating

nul past the end of the destination [-Werror=format-overflow=]

Quoted 2 lines

sprintf(buffer_location, "%04x_location",
drivers/platform/x86/dell-smbios.c:494:3: note: 'sprintf' output 14 bytes into a

destination of size 13

Quoted 1 line

drivers/platform/x86/dell-smbios.c:506:36: error: 'sprintf' writing a terminating

Quoted 8 lines
Quoted 8 lines

nul past the end of the destination [-Werror=format-overflow=]

Quoted 2 lines
    sprintf(buffer_value, "%04x_value",

drivers/platform/x86/dell-smbios.c:506:3: note: 'sprintf' output 11 bytes into a

destination of size 10
Don't need to include the error log in commit message. Just explaining the issue is good enough.

Quoted 2 lines

This changes it to just use kasprintf(), which always gets it right.

Good catch followed by a fix!

Quoted 9 lines

Assuming Darren will do the fixup for title and message as recommended by Sathyanarayanan before committing:

Thanks, for the fix. For my own information and improvement, would you share how you caught that? Just added "-Werror=format-overflow=" to CFLAGS?

I wasn't seeing the compile errors with default flags in my own testing, so I'd like to make sure I'm doing better testing in the future.

gcc7 by its default [1], though you need to revert [2].

And always good to remember

% make W=1

which implies some warning, W=2 a lot more.

[1]: http://patches.linaro.org/cover/107779/

[2]: commit bd664f6b3e376a8ef4990f87d08271cc2d01ba9a

Author: Linus Torvalds <[email protected]>
Date:   Wed Jul 12 19:25:47 2017 -0700

disable new gcc-7.1.1 warnings for now

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#4 lore raw
Quoted 6 lines · Andy Shevchenko

On Wed, Nov 8, 2017 at 8:30 PM, <[email protected]> wrote:

% make W=1

which implies some warning, W=2 a lot more.

Quoted 7 lines

[1]: http://patches.linaro.org/cover/107779/

[2]: commit bd664f6b3e376a8ef4990f87d08271cc2d01ba9a

Author: Linus Torvalds <[email protected]>
Date:   Wed Jul 12 19:25:47 2017 -0700

disable new gcc-7.1.1 warnings for now

I have reverted that patch locally and this is the first time I actually hit a warning
since it landed, but that reminds me that I should check whether all my workarounds have landed in mainline and we are ready to turn it on globally again.

Arnd

#5 lore raw
In reply to sathyanarayanan kuppuswamy
Quoted 3 lines · sathyanarayanan kuppuswamy

Hi,

I recommend using "platform/x86: dell-smbios:" in commit header.

Ok, noted. I usually try to follow the lines for each maintainer, but I'm not always
keeping track of each one, sorry.

Quoted 18 lines · Arnd Bergmann
Quoted 13 lines

The new sysfs code overwrites two fixed-length character arrays that are each one byte shorter than they need to be, to hold the trailing \0:

drivers/platform/x86/dell-smbios.c: In function 'build_tokens_sysfs':
drivers/platform/x86/dell-smbios.c:494:42: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_location, "%04x_location",
drivers/platform/x86/dell-smbios.c:494:3: note: 'sprintf' output 14 bytes into a destination of size 13 drivers/platform/x86/dell-smbios.c:506:36: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]

Quoted 3 lines
    sprintf(buffer_value, "%04x_value",

drivers/platform/x86/dell-smbios.c:506:3: note: 'sprintf' output 11 bytes into a destination of size 10

Quoted 2 lines

Don't need to include the error log in commit message. Just explaining the issue is good enough.

I always include the messages I get, it helps a lot when you run into a related problem and find it in either the git log or using google search.

It's particularly useful when patches that introduce warnings get backported to stable kernels.

Arnd

Applied
#6 lore raw
In reply to Arnd Bergmann
Quoted 12 lines · Arnd Bergmann

The new sysfs code overwrites two fixed-length character arrays that are each one byte shorter than they need to be, to hold the trailing \0:

drivers/platform/x86/dell-smbios.c: In function 'build_tokens_sysfs':
drivers/platform/x86/dell-smbios.c:494:42: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_location, "%04x_location",
drivers/platform/x86/dell-smbios.c:494:3: note: 'sprintf' output 14 bytes into a destination of size 13 drivers/platform/x86/dell-smbios.c:506:36: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_value, "%04x_value",
drivers/platform/x86/dell-smbios.c:506:3: note: 'sprintf' output 11 bytes into a destination of size 10

Quoted 4 lines

This changes it to just use kasprintf(), which always gets it right.

Fixes 33b9ca1e53b4 ("platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens")

Queued, thanks Arnd.

Yes, please keep the error messages. Costs us nothing and can be useful to have.

I corrected the prefix as noted, and added the details of the gcc and reverted patch for reproducer context.

Signature · 2 lines
Darren Hart
VMware Open Source Technology Center
Reviewed-by on v1 1/1
#7 lore raw
In reply to Arnd Bergmann
Quoted 12 lines · On Wednesday 08 November 2017 13:08:39 Arnd Bergmann wrote:

The new sysfs code overwrites two fixed-length character arrays that are each one byte shorter than they need to be, to hold the trailing \0:

drivers/platform/x86/dell-smbios.c: In function 'build_tokens_sysfs':
drivers/platform/x86/dell-smbios.c:494:42: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_location, "%04x_location",
drivers/platform/x86/dell-smbios.c:494:3: note: 'sprintf' output 14 bytes into a destination of size 13 drivers/platform/x86/dell-smbios.c:506:36: error: 'sprintf' writing a terminating nul past the end of the destination [-Werror=format-overflow=]
sprintf(buffer_value, "%04x_value",
drivers/platform/x86/dell-smbios.c:506:3: note: 'sprintf' output 11 bytes into a destination of size 10

Quoted 4 lines

This changes it to just use kasprintf(), which always gets it right.

Fixes 33b9ca1e53b4 ("platform/x86: dell-smbios: Add a sysfs interface for SMBIOS tokens")
Quoted 41 lines
---
 drivers/platform/x86/dell-smbios.c | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)
drivers/platform/x86/dell-smbios.c +4 -8
index d99edd803c19..6a60db515bda 100644
@@ -463,8 +463,6 @@ static struct platform_driver platform_driver = {
 
 static int build_tokens_sysfs(struct platform_device *dev)
 {
-	char buffer_location[13];
-	char buffer_value[10];
 	char *location_name;
 	char *value_name;
 	size_t size;
@@ -491,9 +489,8 @@ static int build_tokens_sysfs(struct platform_device *dev)
 		if (da_tokens[i].tokenID == 0)
 			continue;
 		/* add location */
-		sprintf(buffer_location, "%04x_location",
-			da_tokens[i].tokenID);
-		location_name = kstrdup(buffer_location, GFP_KERNEL);
+		location_name = kasprintf(GFP_KERNEL, "%04x_location",
+					  da_tokens[i].tokenID);
 		if (location_name == NULL)
 			goto out_unwind_strings;
 		sysfs_attr_init(&token_location_attrs[i].attr);
@@ -503,9 +500,8 @@ static int build_tokens_sysfs(struct platform_device *dev)
 		token_attrs[j++] = &token_location_attrs[i].attr;
 
 		/* add value */
-		sprintf(buffer_value, "%04x_value",
-			da_tokens[i].tokenID);
-		value_name = kstrdup(buffer_value, GFP_KERNEL);
+		value_name = kasprintf(GFP_KERNEL, "%04x_value",
+				       da_tokens[i].tokenID);
 		if (value_name == NULL)
 			goto loop_fail_create_value;
 		sysfs_attr_init(&token_value_attrs[i].attr);
Signature · 2 lines
Pali Rohár
[email protected]