Skip to contentSkip to conversation

char: tpm: tpm-buf: Fix uninitialized return values in read helpers

PATCH In review Purva Yeshi 3 participants 9 messages Apr 9, 2025 – Apr 10, 2025

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

PATCH 1/1 char: tpm: tpm-buf: Fix uninitialized return values in read helpers

Fix Smatch-detected error:
drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

---
 drivers/char/tpm/tpm-buf.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/char/tpm/tpm-buf.c +3 -3
index e49a19fea3bd..dc882fc9fa9e 100644
@@ -201,7 +201,7 @@ static void tpm_buf_read(struct tpm_buf *buf, off_t *offset, size_t count, void
  */
 u8 tpm_buf_read_u8(struct tpm_buf *buf, off_t *offset)
 {
-	u8 value;
+	u8 value = 0;
 
 	tpm_buf_read(buf, offset, sizeof(value), &value);
 
@@ -218,7 +218,7 @@ EXPORT_SYMBOL_GPL(tpm_buf_read_u8);
  */
 u16 tpm_buf_read_u16(struct tpm_buf *buf, off_t *offset)
 {
-	u16 value;
+	u16 value = 0;
 
 	tpm_buf_read(buf, offset, sizeof(value), &value);
 
@@ -235,7 +235,7 @@ EXPORT_SYMBOL_GPL(tpm_buf_read_u16);
  */
 u32 tpm_buf_read_u32(struct tpm_buf *buf, off_t *offset)
 {
-	u32 value;
+	u32 value = 0;
 
 	tpm_buf_read(buf, offset, sizeof(value), &value);
 
Signature · 1 line
2.34.1
maintainer
#1 lore raw
Quoted 8 lines · Purva Yeshi

Fix Smatch-detected error:
drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Quoted 7 lines

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

How does tpm_buf_read() fail?

Quoted 40 lines
---
 drivers/char/tpm/tpm-buf.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/char/tpm/tpm-buf.c +3 -3
index e49a19fea3bd..dc882fc9fa9e 100644
@@ -201,7 +201,7 @@ static void tpm_buf_read(struct tpm_buf *buf, off_t *offset, size_t count, void
  */
 u8 tpm_buf_read_u8(struct tpm_buf *buf, off_t *offset)
 {
-	u8 value;
+	u8 value = 0;
 
 	tpm_buf_read(buf, offset, sizeof(value), &value);
 
@@ -218,7 +218,7 @@ EXPORT_SYMBOL_GPL(tpm_buf_read_u8);
  */
 u16 tpm_buf_read_u16(struct tpm_buf *buf, off_t *offset)
 {
-	u16 value;
+	u16 value = 0;
 
 	tpm_buf_read(buf, offset, sizeof(value), &value);
 
@@ -235,7 +235,7 @@ EXPORT_SYMBOL_GPL(tpm_buf_read_u16);
  */
 u32 tpm_buf_read_u32(struct tpm_buf *buf, off_t *offset)
 {
-	u32 value;
+	u32 value = 0;
 
 	tpm_buf_read(buf, offset, sizeof(value), &value);
 
Signature · 1 line
2.34.1

BR, Jarkko

#2 lore raw
Quoted 13 lines · Jarkko Sakkinen
Quoted 12 lines · Purva Yeshi

Fix Smatch-detected error:
drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Quoted 5 lines
Quoted 3 lines

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

How does tpm_buf_read() fail?

If TPM_BUF_BOUNDARY_ERROR is set (or we are setting it), we are effectively returning random stack bytes to the caller. Could this be a problem?

If it is, maybe instead of this patch, we could set *output to zero in the error path of tpm_buf_read(). Or return an error from tpm_buf_read() so callers can return 0 or whatever they want.

Thanks,
Stefano

#3 lore raw
Quoted 20 lines · Stefano Garzarella
Quoted 13 lines · Jarkko Sakkinen
Quoted 12 lines · Purva Yeshi

Fix Smatch-detected error:
drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Quoted 5 lines
Quoted 3 lines

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

How does tpm_buf_read() fail?

Quoted 8 lines

If TPM_BUF_BOUNDARY_ERROR is set (or we are setting it), we are effectively returning random stack bytes to the caller. Could this be a problem?

If it is, maybe instead of this patch, we could set *output to zero in the error path of tpm_buf_read(). Or return an error from tpm_buf_read() so callers can return 0 or whatever they want.

Thanks,
Stefano

Hi Jarkko, Stefano,
Thank you for the review.

I've revisited the issue and updated the implementation of tpm_buf_read() to zero out the *output buffer in the error paths, instead of initializing the return value in each caller.

static void tpm_buf_read(struct tpm_buf *buf, off_t *offset, size_t count, void *output)

{
	off_t next_offset;

	/* Return silently if overflow has already happened. */
	if (buf->flags & TPM_BUF_BOUNDARY_ERROR) {
		memset(output, 0, count);
		return;
	}

	next_offset = *offset + count;
	if (next_offset > buf->length) {
		WARN(1, "tpm_buf: read out of boundary\n");
		buf->flags |= TPM_BUF_BOUNDARY_ERROR;
		memset(output, 0, count);
		return;
	}

	memcpy(output, &buf->data[*offset], count);
	*offset = next_offset;
}

This approach ensures that output is always zeroed when the read fails, which avoids returning uninitialized stack values from the helper functions like tpm_buf_read_u8(), tpm_buf_read_u16(), and tpm_buf_read_u32().

Does this solution look acceptable for the next version of the patch?

Best regards,
Purva Yeshi

maintainer
#4 lore raw
Quoted 54 lines · Purva Yeshi
Quoted 24 lines · Stefano Garzarella
Quoted 13 lines · Jarkko Sakkinen
Quoted 12 lines · Purva Yeshi

Fix Smatch-detected error:
drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Quoted 5 lines
Quoted 3 lines

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

How does tpm_buf_read() fail?

If TPM_BUF_BOUNDARY_ERROR is set (or we are setting it), we are effectively returning random stack bytes to the caller. Could this be a problem?

Quoted 7 lines

If it is, maybe instead of this patch, we could set *output to zero in the error path of tpm_buf_read(). Or return an error from tpm_buf_read() so callers can return 0 or whatever they want.

Thanks,
Stefano

Hi Jarkko, Stefano,
Thank you for the review.

I've revisited the issue and updated the implementation of tpm_buf_read() to zero out the *output buffer in the error paths, instead of initializing the return value in each caller.

static void tpm_buf_read(struct tpm_buf *buf, off_t *offset, size_t count, void *output)

{
	off_t next_offset;

	/* Return silently if overflow has already happened. */
	if (buf->flags & TPM_BUF_BOUNDARY_ERROR) {
		memset(output, 0, count);
		return;
	}

	next_offset = *offset + count;
	if (next_offset > buf->length) {
		WARN(1, "tpm_buf: read out of boundary\n");
Quoted 8 lines
		buf->flags |= TPM_BUF_BOUNDARY_ERROR;
		memset(output, 0, count);
		return;
	}

	memcpy(output, &buf->data[*offset], count);
	*offset = next_offset;
}

Please don't touch this.

Quoted 9 lines

This approach ensures that output is always zeroed when the read fails, which avoids returning uninitialized stack values from the helper functions like tpm_buf_read_u8(), tpm_buf_read_u16(), and tpm_buf_read_u32().

Does this solution look acceptable for the next version of the patch?

Best regards,
Purva Yeshi

BR, Jarkko

maintainer
#5 lore raw
Quoted 60 lines · Jarkko Sakkinen
Quoted 59 lines · Purva Yeshi
Quoted 24 lines · Stefano Garzarella
Quoted 13 lines · Jarkko Sakkinen
Quoted 12 lines · Purva Yeshi

Fix Smatch-detected error:
drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Quoted 5 lines
Quoted 3 lines

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

How does tpm_buf_read() fail?

If TPM_BUF_BOUNDARY_ERROR is set (or we are setting it), we are effectively returning random stack bytes to the caller. Could this be a problem?

Quoted 7 lines

If it is, maybe instead of this patch, we could set *output to zero in the error path of tpm_buf_read(). Or return an error from tpm_buf_read() so callers can return 0 or whatever they want.

Thanks,
Stefano

Hi Jarkko, Stefano,
Thank you for the review.

I've revisited the issue and updated the implementation of tpm_buf_read() to zero out the *output buffer in the error paths, instead of initializing the return value in each caller.

static void tpm_buf_read(struct tpm_buf *buf, off_t *offset, size_t count, void *output)

{
	off_t next_offset;

	/* Return silently if overflow has already happened. */
	if (buf->flags & TPM_BUF_BOUNDARY_ERROR) {
		memset(output, 0, count);
		return;
	}

	next_offset = *offset + count;
	if (next_offset > buf->length) {
		WARN(1, "tpm_buf: read out of boundary\n");
		buf->flags |= TPM_BUF_BOUNDARY_ERROR;
		memset(output, 0, count);
		return;
	}
Quoted 5 lines
Quoted 3 lines
	memcpy(output, &buf->data[*offset], count);
	*offset = next_offset;
}

Please don't touch this.

If you want to do anything, check the call sites for raw tpm_buf_read() instead, which is not very common.

BR, Jarkko

#6 lore raw
In reply to Jarkko Sakkinen
Quoted 60 lines · Jarkko Sakkinen
Quoted 59 lines · Purva Yeshi
Quoted 24 lines · Stefano Garzarella
Quoted 13 lines · Jarkko Sakkinen
Quoted 12 lines · Purva Yeshi

Fix Smatch-detected error:
drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Quoted 5 lines
Quoted 3 lines

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

How does tpm_buf_read() fail?

If TPM_BUF_BOUNDARY_ERROR is set (or we are setting it), we are effectively returning random stack bytes to the caller. Could this be a problem?

Quoted 7 lines

If it is, maybe instead of this patch, we could set *output to zero in the error path of tpm_buf_read(). Or return an error from tpm_buf_read() so callers can return 0 or whatever they want.

Thanks,
Stefano

Hi Jarkko, Stefano,
Thank you for the review.

I've revisited the issue and updated the implementation of tpm_buf_read() to zero out the *output buffer in the error paths, instead of initializing the return value in each caller.

static void tpm_buf_read(struct tpm_buf *buf, off_t *offset, size_t count, void *output)

{
	off_t next_offset;

	/* Return silently if overflow has already happened. */
	if (buf->flags & TPM_BUF_BOUNDARY_ERROR) {
		memset(output, 0, count);
		return;
	}

	next_offset = *offset + count;
	if (next_offset > buf->length) {
		WARN(1, "tpm_buf: read out of boundary\n");
		buf->flags |= TPM_BUF_BOUNDARY_ERROR;
		memset(output, 0, count);
		return;
	}
Quoted 5 lines
Quoted 3 lines
	memcpy(output, &buf->data[*offset], count);
	*offset = next_offset;
}

Please don't touch this.

Got it, thanks!

Quoted 12 lines
Quoted 10 lines

This approach ensures that output is always zeroed when the read fails, which avoids returning uninitialized stack values from the helper functions like tpm_buf_read_u8(), tpm_buf_read_u16(), and tpm_buf_read_u32().

Does this solution look acceptable for the next version of the patch?

Best regards,
Purva Yeshi

BR, Jarkko

maintainer
#7 lore raw
In reply to Stefano Garzarella
Quoted 3 lines · Stefano Garzarella
Quoted 2 lines · Jarkko Sakkinen
Quoted 1 line · Purva Yeshi

Fix Smatch-detected error:

Empty line and s/error/issue/.

Quoted 15 lines
Quoted 15 lines
Quoted 14 lines

drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

Quoted 5 lines
Quoted 1 line

How does tpm_buf_read() fail?

If TPM_BUF_BOUNDARY_ERROR is set (or we are setting it), we are effectively returning random stack bytes to the caller.
Could this be a problem?

It should never happen, if the kernel is working correctly. The commit message implies a legit failure scenario, which would imply that the patch is a bug fix, which it actually is not.

"Add a sanity check for boundary overflow, and zero out the value, if the unexpected happens" is what this patch actually does. I.e., code change acceptable, commit message is all wrong.

Quoted 9 lines

If it is, maybe instead of this patch, we could set *output to zero in the error path of tpm_buf_read(). Or return an error from tpm_buf_read() so callers can return 0 or whatever they want.

Thanks,
Stefano

BR, Jarkko

#8 lore raw
Quoted 28 lines · Jarkko Sakkinen
Quoted 3 lines · Stefano Garzarella
Quoted 2 lines · Jarkko Sakkinen
Quoted 1 line · Purva Yeshi

Fix Smatch-detected error:

Empty line and s/error/issue/.

Quoted 15 lines
Quoted 15 lines
Quoted 14 lines

drivers/char/tpm/tpm-buf.c:208 tpm_buf_read_u8() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:225 tpm_buf_read_u16() error:
uninitialized symbol 'value'. drivers/char/tpm/tpm-buf.c:242 tpm_buf_read_u32() error:
uninitialized symbol 'value'.

Call tpm_buf_read() to populate value but do not check its return status. If the read fails, value remains uninitialized, causing undefined behavior when returned or processed.

Initialize value to zero to ensure a defined return even if tpm_buf_read() fails, avoiding undefined behavior from using an uninitialized variable.

Quoted 5 lines
Quoted 1 line

How does tpm_buf_read() fail?

If TPM_BUF_BOUNDARY_ERROR is set (or we are setting it), we are effectively returning random stack bytes to the caller.
Could this be a problem?

Quoted 7 lines

It should never happen, if the kernel is working correctly. The commit message implies a legit failure scenario, which would imply that the patch is a bug fix, which it actually is not.

"Add a sanity check for boundary overflow, and zero out the value, if the unexpected happens" is what this patch actually does. I.e., code change acceptable, commit message is all wrong.

Understood now. I’ll update the commit message to clearly state this is a sanity check for unexpected boundary overflows. Thanks for the clarification!

Quoted 12 lines
Quoted 10 lines

If it is, maybe instead of this patch, we could set *output to zero in the error path of tpm_buf_read(). Or return an error from tpm_buf_read() so callers can return 0 or whatever they want.

Thanks,
Stefano

BR, Jarkko