Skip to contentSkip to conversation

lib/vsnprintf: Limit the returning size to INT_MAX

RFC PATCH In review Masami Hiramatsu (Google) 3 participants 6 messages Mar 18 – Mar 19

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover lib/vsnprintf: Limit the returning size to INT_MAX

Hi,

Recently we discussed snprintf() usage in bootconfig and found snprintf() design has a problem[1]. It returns the required or printed size in 'int' but the maxlen is passed by 'size_t'. If the maxlen is bigger than INT_MAX (this should never happen), it can not return the size correctly, that becomes negative value or very shorter than it has actually done.

I think it should not be handled by caller side, instead, vsnprintf() should handle it. This is an extremely unlikely input, and if we need to address it, I think we should keep the fix to a minimum (in performance point of view).

Thus I just limited the returning size to INT_MAX. If caller sees the *printf() returns INT_MAX, it can handle it as an error or use strlen() to get real printed size (but I don't recommend it.)

IMHO, this input is basically impossible unless done intentionally, so I think it's a form of over-engineering. Therefore, this is an RFC patch.

A question is that we should use WARN_ON() when the return size is over INT_MAX. Currently this just returns INT_MAX (no warning) because this is a library function, which can be called from anywhere.

[1] https://lore.kernel.org/all/[email protected]/

Thank you,

---

Masami Hiramatsu (Google) (1):
lib/vsprintf: Limit the returning size to INT_MAX

 drivers/firmware/efi/libstub/vsprintf.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
Masami Hiramatsu (Google) <[email protected]>

#1 lore raw

RFC PATCH 1/1 lib/vsprintf: Limit the returning size to INT_MAX

From: Masami Hiramatsu (Google) <[email protected]>

There seems a design flaw of vsnprintf() whose return value can overflow the INT_MAX even on 32bit arch, because the buffer size is passed by 'size_t' but it returns the printed or required size in 'int'.

The size_t is unsigned long, thus the caller can pass bigger than INT_MAX as the size of buffer (that is OK). But even the vsnprintf calculates the required/printed length correctly, if it overflows the INT_MAX, it can not return the size correctly by int.

This should never happen but it should be checked and limited.

---
 drivers/firmware/efi/libstub/vsprintf.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/firmware/efi/libstub/vsprintf.c +1 -1
index 71c71c222346..1713cacecc25 100644
@@ -549,7 +549,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap)
 	if (size)
 		buf[min(pos, size-1)] = '\0';
 
-	return pos;
+	return (pos > INT_MAX) ? INT_MAX : pos;
 }
 
 int snprintf(char *buf, size_t size, const char *fmt, ...)
maintainer
#2 lore raw

Re: [RFC PATCH 1/1] lib/vsprintf: Limit the returning size to INT_MAX

Quoted 23 lines · On Wed, 18 Mar 2026 10:19:56 +0900 "Masami Hiramatsu (Google)"…

From: Masami Hiramatsu (Google) <[email protected]>

There seems a design flaw of vsnprintf() whose return value can overflow the INT_MAX even on 32bit arch, because the buffer size is passed by 'size_t' but it returns the printed or required size in 'int'.

The size_t is unsigned long, thus the caller can pass bigger than INT_MAX as the size of buffer (that is OK). But even the vsnprintf calculates the required/printed length correctly, if it overflows the INT_MAX, it can not return the size correctly by int.

This should never happen but it should be checked and limited.

---
 drivers/firmware/efi/libstub/vsprintf.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/firmware/efi/libstub/vsprintf.c +0 -0
index 71c71c222346..1713cacecc25 100644

drivers/firmware/efi/libstub/vsprintf.c int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap) · line 555

Quoted 8 lines
drivers/firmware/efi/libstub/vsprintf.c +1 -1
@@ -549,7 +549,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap)
 	if (size)
 		buf[min(pos, size-1)] = '\0';
 
-	return pos;
+	return (pos > INT_MAX) ? INT_MAX : pos;
 }
 
 int snprintf(char *buf, size_t size, const char *fmt, ...)

Since this would require a buffer of size greater than 2G to be passed in, I highly doubt this would happen anywhere in the kernel.

If anything, it would be for "correctness" only, but I don't see this ever being an issue within this century.

-- Steve

#3 lore raw

Re: [RFC PATCH 1/1] lib/vsprintf: Limit the returning size to INT_MAX

Quoted 33 lines · On Wed, 18 Mar 2026 09:47:33 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 30 lines · On Wed, 18 Mar 2026 10:19:56 +0900 "Masami Hiramatsu (Google)"…

From: Masami Hiramatsu (Google) <[email protected]>

There seems a design flaw of vsnprintf() whose return value can overflow the INT_MAX even on 32bit arch, because the buffer size is passed by 'size_t' but it returns the printed or required size in 'int'.

The size_t is unsigned long, thus the caller can pass bigger than INT_MAX as the size of buffer (that is OK). But even the vsnprintf calculates the required/printed length correctly, if it overflows the INT_MAX, it can not return the size correctly by int.

This should never happen but it should be checked and limited.

---
 drivers/firmware/efi/libstub/vsprintf.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/firmware/efi/libstub/vsprintf.c +1 -1
index 71c71c222346..1713cacecc25 100644
@@ -549,7 +549,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap)
 	if (size)
 		buf[min(pos, size-1)] = '\0';
 
-	return pos;
+	return (pos > INT_MAX) ? INT_MAX : pos;
 }
 
Quoted 7 lines

drivers/firmware/efi/libstub/vsprintf.c int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap) · line 555

Quoted 1 line
drivers/firmware/efi/libstub/vsprintf.c +0 -0
 int snprintf(char *buf, size_t size, const char *fmt, ...)  

Since this would require a buffer of size greater than 2G to be passed in, I highly doubt this would happen anywhere in the kernel.

If anything, it would be for "correctness" only, but I don't see this ever being an issue within this century.

What about the return value (on 32bit) from:

	snprintf(NULL, 0, " %*s %*s ", INT_MAX, "", INT_MAX, "");

This is more of a problem for libc.

In reality there are easier ways to crash the kernel....

David

Quoted 3 lines

-- Steve

#4 lore raw

Re: [RFC PATCH 1/1] lib/vsprintf: Limit the returning size to INT_MAX

Quoted 44 lines · On Wed, 18 Mar 2026 15:12:50 +0000 David Laight <[email protected]>…
Quoted 33 lines · On Wed, 18 Mar 2026 09:47:33 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 30 lines · On Wed, 18 Mar 2026 10:19:56 +0900 "Masami Hiramatsu (Google)"…

From: Masami Hiramatsu (Google) <[email protected]>

There seems a design flaw of vsnprintf() whose return value can overflow the INT_MAX even on 32bit arch, because the buffer size is passed by 'size_t' but it returns the printed or required size in 'int'.

The size_t is unsigned long, thus the caller can pass bigger than INT_MAX as the size of buffer (that is OK). But even the vsnprintf calculates the required/printed length correctly, if it overflows the INT_MAX, it can not return the size correctly by int.

This should never happen but it should be checked and limited.

---
 drivers/firmware/efi/libstub/vsprintf.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/firmware/efi/libstub/vsprintf.c +1 -1
index 71c71c222346..1713cacecc25 100644
@@ -549,7 +549,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap)
 	if (size)
 		buf[min(pos, size-1)] = '\0';
 
-	return pos;
+	return (pos > INT_MAX) ? INT_MAX : pos;
 }
 
Quoted 7 lines

drivers/firmware/efi/libstub/vsprintf.c int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap) · line 555

Quoted 1 line
drivers/firmware/efi/libstub/vsprintf.c +0 -0
 int snprintf(char *buf, size_t size, const char *fmt, ...)  

Since this would require a buffer of size greater than 2G to be passed in, I highly doubt this would happen anywhere in the kernel.

If anything, it would be for "correctness" only, but I don't see this ever being an issue within this century.

Quoted 6 lines

What about the return value (on 32bit) from:

	snprintf(NULL, 0, " %*s %*s ", INT_MAX, "", INT_MAX, "");

This is more of a problem for libc.

In reality there are easier ways to crash the kernel....

Good catch! I found that size >= INT_MAX has been handled correctly, (see lib/vsprintf.c:2875) but width check has been removed by commit 938df695e98d ("vsprintf: associate the format state with the
format pointer") accidentally.

lib/vsprintf.c +4 -2
index 800b8ac49f53..054c9758118e 100644
@@ -2803,7 +2803,8 @@ static void
 set_field_width(struct printf_spec *spec, int width)
 {
 	spec->field_width = width;
-	if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
+	if (WARN_ONCE(spec->field_width > FIELD_WIDTH_MAX ||
+		      spec->field_width < -FIELD_WIDTH_MAX, "field width %d too large", width)) {
 		spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
 	}
 }
@@ -2812,7 +2813,8 @@ static void
 set_precision(struct printf_spec *spec, int prec)
 {
 	spec->precision = prec;
-	if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
+	if (WARN_ONCE(spec->precision > PRECISION_MAX || spec->precision < 0,
+		      "precision %d too large", prec)) {
 		spec->precision = clamp(prec, 0, PRECISION_MAX);
 	}
 }
Quoted 8 lines

David

Quoted 3 lines

-- Steve

Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>
#5 lore raw

Re: [RFC PATCH 1/1] lib/vsprintf: Limit the returning size to INT_MAX

In reply to Masami Hiramatsu (Google)

drivers/firmware/efi/libstub/vsprintf.c

Quoted 22 lines · On Wed, 18 Mar 2026 10:19:56 +0900 "Masami Hiramatsu (Google)"…

From: Masami Hiramatsu (Google) <[email protected]>

There seems a design flaw of vsnprintf() whose return value can overflow the INT_MAX even on 32bit arch, because the buffer size is passed by 'size_t' but it returns the printed or required size in 'int'.

The size_t is unsigned long, thus the caller can pass bigger than INT_MAX as the size of buffer (that is OK). But even the vsnprintf calculates the required/printed length correctly, if it overflows the INT_MAX, it can not return the size correctly by int.

This should never happen but it should be checked and limited.

---
 drivers/firmware/efi/libstub/vsprintf.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/firmware/efi/libstub/vsprintf.c +0 -0
index 71c71c222346..1713cacecc25 100644

Ooops, I saw a wrong code. Nevermind.

Quoted 10 lines
drivers/firmware/efi/libstub/vsprintf.c +1 -1
@@ -549,7 +549,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap)
 	if (size)
 		buf[min(pos, size-1)] = '\0';
 
-	return pos;
+	return (pos > INT_MAX) ? INT_MAX : pos;
 }
 
 int snprintf(char *buf, size_t size, const char *fmt, ...)
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>