[bpf-next] bpftool: Fix readlink usage in get_fd_type

Commit Message

Viktor Malik Jan. 29, 2025, 7:18 a.m. UTC

The `readlink(path, buf, sizeof(buf))` call reads at most sizeof(buf)
bytes and *does not* append null-terminator to buf. With respect to
that, fix two pieces in get_fd_type:

1. Change the truncation check to contain sizeof(buf) rather than
   sizeof(path).
2. Append null-terminator to buf.

Reported by Coverity.

Signed-off-by: Viktor Malik <[e-mail]>
---
 tools/bpf/bpftool/common.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Quentin Monnet Jan. 29, 2025, 11:15 p.m. UTC | #1

2025-01-29 08:18 UTC+0100 ~ Viktor Malik <[e-mail]>
> The `readlink(path, buf, sizeof(buf))` call reads at most sizeof(buf)
> bytes and *does not* append null-terminator to buf. With respect to
> that, fix two pieces in get_fd_type:
> 
> 1. Change the truncation check to contain sizeof(buf) rather than
>    sizeof(path).
> 2. Append null-terminator to buf.
> 
> Reported by Coverity.
> 
> Signed-off-by: Viktor Malik <[e-mail]>

Nice, thank you!

Fixes: 71bb428fe2c1 ("tools: bpf: add bpftool")
Reviewed-by: Quentin Monnet <[e-mail]>

[e-mail] Jan. 30, 2025, 1 a.m. UTC | #2

Hello:

This patch was applied to bpf/bpf-next.git (master)
by Andrii Nakryiko <[e-mail]>:

On Wed, 29 Jan 2025 08:18:57 +0100 you wrote:
> The `readlink(path, buf, sizeof(buf))` call reads at most sizeof(buf)
> bytes and *does not* append null-terminator to buf. With respect to
> that, fix two pieces in get_fd_type:
> 
> 1. Change the truncation check to contain sizeof(buf) rather than
>    sizeof(path).
> 2. Append null-terminator to buf.
> 
> [...]

Here is the summary with links:
  - [bpf-next] bpftool: Fix readlink usage in get_fd_type
    https://git.kernel.org/bpf/bpf-next/c/57e71f8c8923

You are awesome, thank you!

Patch

diff --git a/tools/bpf/bpftool/common.c b/tools/bpf/bpftool/common.c
index 9b75639434b8..0a764426d935 100644
--- a/tools/bpf/bpftool/common.c
+++ b/tools/bpf/bpftool/common.c
@@ -461,10 +461,11 @@  int get_fd_type(int fd)
 		p_err("can't read link type: %s", strerror(errno));
 		return -1;
 	}
-	if (n == sizeof(path)) {
+	if (n == sizeof(buf)) {
 		p_err("can't read link type: path too long!");
 		return -1;
 	}
+	buf[n] = '\0';
 
 	if (strstr(buf, "bpf-map"))
 		return BPF_OBJ_MAP;