Skip to contentSkip to conversation

dma-buf: Replace strlcpy() with strscpy()

PATCH In review Kees Cook 3 participants 3 messages Nov 16, 2023 – Nov 20, 2023

Subsystems (2)
lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 dma-buf: Replace strlcpy() with strscpy()

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated[1]. Additionally, it returns the size of the source string, not the resulting size of the destination string. In an effort to remove strlcpy() completely[2], replace strlcpy() here with strscpy().

---
 drivers/dma-buf/dma-buf.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/dma-buf/dma-buf.c +2 -2
index 21916bba77d5..8fe5aa67b167 100644
@@ -46,12 +46,12 @@ static char *dmabuffs_dname(struct dentry *dentry, char *buffer, int buflen)
 {
 	struct dma_buf *dmabuf;
 	char name[DMA_BUF_NAME_LEN];
-	size_t ret = 0;
+	ssize_t ret = 0;
 
 	dmabuf = dentry->d_fsdata;
 	spin_lock(&dmabuf->name_lock);
 	if (dmabuf->name)
-		ret = strlcpy(name, dmabuf->name, DMA_BUF_NAME_LEN);
+		ret = strscpy(name, dmabuf->name, sizeof(name));
 	spin_unlock(&dmabuf->name_lock);
 
 	return dynamic_dname(buffer, buflen, "/%s:%s",
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · Kees Cook

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated[1]. Additionally, it returns the size of the source string, not the resulting size of the destination string. In an effort to remove strlcpy() completely[2], replace strlcpy() here with strscpy().

Quoted 9 lines

strscpy returns -E2BIG when it truncates / force null-terminates which would provide the wrong argument for dynamic_dname, but dma_buf_set_name{_user} makes sure we have a null-terminated string of the appropriate maximum size in dmabuf->name.

maintainer
#2 lore raw

Am 17.11.23 um 19:50 schrieb T.J. Mercier:

Quoted 17 lines · Kees Cook
Quoted 7 lines

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated[1]. Additionally, it returns the size of the source string, not the resulting size of the destination string. In an effort to remove strlcpy() completely[2], replace strlcpy() here with strscpy().

Quoted 9 lines
Quoted 6 lines

strscpy returns -E2BIG when it truncates / force null-terminates which would provide the wrong argument for dynamic_dname, but dma_buf_set_name{_user} makes sure we have a null-terminated string of the appropriate maximum size in dmabuf->name.

Thanks for that background check, I was about to note that this might not be a good idea.

Linus pretty clearly stated that he doesn't want to see patches like that one here, see this article as well. https://lwn.net/Articles/659214/

I think the commit message gives enough reason to merge the patch, so I'm going to push it to drm-misc-next. But please make sure to triple check stuff like this before sending.

Thanks,
Christian.