Skip to contentSkip to conversation

seq_buf: Make seq_buf_puts() null-terminate the buffer

PATCH In review Michael Ellerman 2 participants 6 messages Oct 19, 2018 – Dec 18, 2018 Library code

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 seq_buf: Make seq_buf_puts() null-terminate the buffer

Currently seq_buf_puts() will happily create a non null-terminated string for you in the buffer. This is particularly dangerous if the buffer is on the stack.

For example:

  char buf[8];
  char secret = "secret";
  struct seq_buf s;

  seq_buf_init(&s, buf, sizeof(buf));
  seq_buf_puts(&s, "foo");
  printk("Message is %s\n", buf);

Can result in:

Message is fooªªªªªsecret

We could require all users to memset() their buffer to zero before use. But that seems likely to be forgotten and lead to bugs.

Instead we can change seq_buf_puts() to always leave the buffer in a null-terminated state.

The only downside is that this makes the buffer 1 character smaller for seq_buf_puts(), but that seems like a good trade off.

---
 lib/seq_buf.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

v2: Fix NULL/null terminology.

lib/seq_buf.c +5 -1
index 11f2ae0f9099..6aabb609dd87 100644
@@ -144,9 +144,13 @@ int seq_buf_puts(struct seq_buf *s, const char *str)
 
 	WARN_ON(s->size == 0);
 
+	/* Add 1 to len for the trailing null byte which must be there */
+	len += 1;
+
 	if (seq_buf_can_fit(s, len)) {
 		memcpy(s->buffer + s->len, str, len);
-		s->len += len;
+		/* Don't count the trailing null byte against the capacity */
+		s->len += len - 1;
 		return 0;
 	}
 	seq_buf_set_overflow(s);
Signature · 1 line
2.17.2
#1 lore raw

PATCH v2 2/2 seq_buf: Use size_t for len in seq_buf_puts()

Jann Horn points out that we're using unsigned int for len in seq_buf_puts(), which could potentially overflow if we're passed a UINT_MAX sized string.

The rest of the code already uses size_t, so we should also use that in seq_buf_puts() to avoid any issues.

---
 lib/seq_buf.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

v2: New in v2.

lib/seq_buf.c +1 -1
index 6aabb609dd87..bd807f545a9d 100644
@@ -140,7 +140,7 @@ int seq_buf_bprintf(struct seq_buf *s, const char *fmt, const u32 *binary)
  */
 int seq_buf_puts(struct seq_buf *s, const char *str)
 {
-	unsigned int len = strlen(str);
+	size_t len = strlen(str);
 
 	WARN_ON(s->size == 0);
 
Signature · 1 line
2.17.2
#2 lore raw
In reply to Michael Ellerman

Hi Steve,

Friendly ping :)

Do you mind picking this one up for 4.21 ?

cheers

Quoted 56 lines · Michael Ellerman

Currently seq_buf_puts() will happily create a non null-terminated string for you in the buffer. This is particularly dangerous if the buffer is on the stack.

For example:

  char buf[8];
  char secret = "secret";
  struct seq_buf s;

  seq_buf_init(&s, buf, sizeof(buf));
  seq_buf_puts(&s, "foo");
  printk("Message is %s\n", buf);

Can result in:

Message is fooªªªªªsecret

We could require all users to memset() their buffer to zero before use. But that seems likely to be forgotten and lead to bugs.

Instead we can change seq_buf_puts() to always leave the buffer in a null-terminated state.

The only downside is that this makes the buffer 1 character smaller for seq_buf_puts(), but that seems like a good trade off.

---
 lib/seq_buf.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

v2: Fix NULL/null terminology.

lib/seq_buf.c +5 -1
index 11f2ae0f9099..6aabb609dd87 100644
@@ -144,9 +144,13 @@ int seq_buf_puts(struct seq_buf *s, const char *str)
 
 	WARN_ON(s->size == 0);
 
+	/* Add 1 to len for the trailing null byte which must be there */
+	len += 1;
+
 	if (seq_buf_can_fit(s, len)) {
 		memcpy(s->buffer + s->len, str, len);
-		s->len += len;
+		/* Don't count the trailing null byte against the capacity */
+		s->len += len - 1;
 		return 0;
 	}
 	seq_buf_set_overflow(s);
Signature · 1 line
2.17.2
#3 lore raw
Quoted 7 lines · On Wed, 12 Dec 2018 22:21:46 +1100 Michael Ellerman <[email protected]> wrote:

Hi Steve,

Friendly ping :)

Do you mind picking this one up for 4.21 ?

Thanks for the reminder, I've been swamped lately. I'll take a look now.

-- Steve

#4 lore raw
Quoted 5 lines · On Wed, 12 Dec 2018 08:45:32 -0500 Steven Rostedt <[email protected]> wrote:
Quoted 2 lines · On Wed, 12 Dec 2018 22:21:46 +1100 Michael Ellerman <[email protected]> wrote:

Hi Steve,

Quoted 9 lines
Quoted 5 lines

Friendly ping :)

Do you mind picking this one up for 4.21 ?

Thanks for the reminder, I've been swamped lately. I'll take a look now.

OK, I applied both to my local queue, and it will reach linux-next probably some time at the end of this week or early next week. It needs to wait till I'm ready to run my local changes through my test suite.

Thanks!

-- Steve

#5 lore raw
Quoted 14 lines · Steven Rostedt
Quoted 11 lines · On Wed, 12 Dec 2018 08:45:32 -0500 Steven Rostedt <[email protected]> wrote:
Quoted 7 lines · On Wed, 12 Dec 2018 22:21:46 +1100 Michael Ellerman <[email protected]> wrote:

Hi Steve,

Friendly ping :)

Do you mind picking this one up for 4.21 ?

Quoted 6 lines
Quoted 2 lines

Thanks for the reminder, I've been swamped lately. I'll take a look now.

OK, I applied both to my local queue, and it will reach linux-next probably some time at the end of this week or early next week. It needs to wait till I'm ready to run my local changes through my test suite.

Sure, no rush. Thanks.

cheers