Skip to contentSkip to conversation

bpf: bpf_probe_read_user_str() returns 0 for empty strings

DISCUSSION Bagas Sanjaya 3 participants 4 messages Jul 23, 2023 – Aug 28, 2023

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

Hi,

I notice a bug report on Bugzilla [1]. Quoting from it:

Quoted 32 lines

Overview:

From within eBPF, calling the helper function bpf_probe_read_user_str(void *dst, __u32 size, const void *unsafe_ptr returns 0 when the source string (void *unsafe_ptr) consists of a string containing only a single null-byte.

This violates various functions documentations (the helper and various internal kernel functions), which all state:

Quoted 2 lines

On success, the strictly positive length of the output string, including the trailing NUL character. On error, a negative value.

To me, this states that the function should return 1 for char myString[] = ""; However, this is not the case. The function returns 0 instead.

For non-empty strings, it works as expected. For example, char myString[] = "abc"; returns 4.

Steps to Reproduce:
* Write an eBPF program that calls bpf_probe_read_user_str(), using a userspace pointer pointing to an empty string.
* Store the result value of that function
* Do the same thing, but try out bpf_probe_read_kernel_str(), like this:
char empty[] = "";
char copy[5];
long ret = bpf_probe_read_kernel_str(copy, 5, empty);
* Compare the return value of bpf_probe_read_user_str() and bpf_probe_read_kernel_str()

Expected Result:

Both functions return 1 (because of the single NULL byte).

Actual Result:

bpf_probe_read_user_str() returns 0, while bpf_probe_read_kernel_str() returns 1.

Additional Information:

Quoted 7 lines

I believe I can see the bug on the current Linux kernel master branch.

In the file/function mm/maccess.c::strncpy_from_user_nofault() the helper implementation calls strncpy_from_user(), which returns the length without trailing 0. Hence this function returns 0 for an empty string.

However, in line 192 (as of commit fdf0eaf11452d72945af31804e2a1048ee1b574c) there is a check that only increments ret, if it is > 0. This appears to be the logic that adds the trailing null byte. Since the check only does this for a ret > 0, a ret of 0 remains at 0.

This is a possible off-by-one error that might cause the behavior.

See Bugzilla for the full thread.

FYI, the culprit line is introduced by commit 3d7081822f7f9e ("uaccess: Add non-pagefault user-space read functions"). I Cc: culprit SoB so that they can look into this bug.

Thanks.

[1]: https://bugzilla.kernel.org/show_bug.cgi?id=217679

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw
Quoted 10 lines · Bagas Sanjaya

Hi,

I notice a bug report on Bugzilla [1]. Quoting from it:

Quoted 5 lines

Overview:

From within eBPF, calling the helper function bpf_probe_read_user_str(void *dst, __u32 size, const void *unsafe_ptr returns 0 when the source string (void *unsafe_ptr) consists of a string containing only a single null-byte.

This violates various functions documentations (the helper and various internal kernel functions), which all state:

Sounds like the bugzilla author believes it's a documentation issue. If so, please encourage the author to send the patch to fix the doc.

Quoted 48 lines
Quoted 27 lines
Quoted 3 lines

On success, the strictly positive length of the output string, including the trailing NUL character. On error, a negative value.

To me, this states that the function should return 1 for char myString[] = ""; However, this is not the case. The function returns 0 instead.

For non-empty strings, it works as expected. For example, char myString[] = "abc"; returns 4.

Steps to Reproduce:
* Write an eBPF program that calls bpf_probe_read_user_str(), using a userspace pointer pointing to an empty string.
* Store the result value of that function
* Do the same thing, but try out bpf_probe_read_kernel_str(), like this:
char empty[] = "";
char copy[5];
long ret = bpf_probe_read_kernel_str(copy, 5, empty);
* Compare the return value of bpf_probe_read_user_str() and bpf_probe_read_kernel_str()

Expected Result:

Both functions return 1 (because of the single NULL byte).

Actual Result:

bpf_probe_read_user_str() returns 0, while bpf_probe_read_kernel_str() returns 1.

Additional Information:

Quoted 7 lines

I believe I can see the bug on the current Linux kernel master branch.

In the file/function mm/maccess.c::strncpy_from_user_nofault() the helper implementation calls strncpy_from_user(), which returns the length without trailing 0. Hence this function returns 0 for an empty string.

However, in line 192 (as of commit fdf0eaf11452d72945af31804e2a1048ee1b574c) there is a check that only increments ret, if it is > 0. This appears to be the logic that adds the trailing null byte. Since the check only does this for a ret > 0, a ret of 0 remains at 0.

This is a possible off-by-one error that might cause the behavior.

See Bugzilla for the full thread.

FYI, the culprit line is introduced by commit 3d7081822f7f9e ("uaccess: Add non-pagefault user-space read functions"). I Cc: culprit SoB so that they can look into this bug.

Thanks.

[1]: https://bugzilla.kernel.org/show_bug.cgi?id=217679

--
An old man doll... just what I always wanted! - Clara

#2 lore raw

Hi,

I'm the author of that bug report. I believe you are mistaken: I do not think that this is a documentation issue. I strongly believe that the documentation is correct and the function behavior itself is wrong.

bpf_probe_read_kernel_str() behaves like it should (as documented).
bpf_probe_read_user_str() has the same documentation as the above (so should have the same behavior), yet it behaves differently. I see no reason why these two functions should return different (non-error) values for the same string.

I can try to prepare a code patch for this issue, but I haven't done this previously so this is all a bit new to me.

Kind regards,
Max

-----Original Message-----
From: Alexei Starovoitov <[email protected]>
Sent: Sunday, July 23, 2023 4:02 AM
To: Bagas Sanjaya <[email protected]>
Cc: Ingo Molnar <[email protected]>; Masami Hiramatsu <[email protected]>; Steven Rostedt (Google) <[email protected]>; Fröhling, Maximilian <[email protected]>; Linux Kernel Mailing List <[email protected]>; Linux BPF <[email protected]>; Linux Memory Management List <[email protected]>
Subject: Re: bpf: bpf_probe_read_user_str() returns 0 for empty strings

Quoted 10 lines · Bagas Sanjaya

Hi,

I notice a bug report on Bugzilla [1]. Quoting from it:

Quoted 5 lines

Overview:

From within eBPF, calling the helper function bpf_probe_read_user_str(void *dst, __u32 size, const void *unsafe_ptr returns 0 when the source string (void *unsafe_ptr) consists of a string containing only a single null-byte.

This violates various functions documentations (the helper and various internal kernel functions), which all state:

Sounds like the bugzilla author believes it's a documentation issue. If so, please encourage the author to send the patch to fix the doc.

Quoted 49 lines
Quoted 28 lines
Quoted 3 lines

On success, the strictly positive length of the output string, including the trailing NUL character. On error, a negative value.

To me, this states that the function should return 1 for char myString[] = ""; However, this is not the case. The function returns 0 instead.

For non-empty strings, it works as expected. For example, char myString[] = "abc"; returns 4.

Steps to Reproduce:
* Write an eBPF program that calls bpf_probe_read_user_str(), using a userspace pointer pointing to an empty string.
* Store the result value of that function
* Do the same thing, but try out bpf_probe_read_kernel_str(), like this:
char empty[] = "";
char copy[5];
long ret = bpf_probe_read_kernel_str(copy, 5, empty);
* Compare the return value of bpf_probe_read_user_str() and
bpf_probe_read_kernel_str()

Expected Result:

Both functions return 1 (because of the single NULL byte).

Actual Result:

bpf_probe_read_user_str() returns 0, while bpf_probe_read_kernel_str() returns 1.

Additional Information:

Quoted 7 lines

I believe I can see the bug on the current Linux kernel master branch.

In the file/function mm/maccess.c::strncpy_from_user_nofault() the helper implementation calls strncpy_from_user(), which returns the length without trailing 0. Hence this function returns 0 for an empty string.

However, in line 192 (as of commit fdf0eaf11452d72945af31804e2a1048ee1b574c) there is a check that only increments ret, if it is > 0. This appears to be the logic that adds the trailing null byte. Since the check only does this for a ret > 0, a ret of 0 remains at 0.

This is a possible off-by-one error that might cause the behavior.

See Bugzilla for the full thread.

FYI, the culprit line is introduced by commit 3d7081822f7f9e ("uaccess: Add non-pagefault user-space read functions"). I Cc:
culprit SoB so that they can look into this bug.

Thanks.

[1]: https://bugzilla.kernel.org/show_bug.cgi?id=217679

--
An old man doll... just what I always wanted! - Clara

#3 lore raw
In reply to Bagas Sanjaya

As a quick summary, just in case the original issue got misunderstood:

The root cause appears to be in mm/maccess.c::strncpy_from_user_nofault()

The function says it returns the length of the string "including the trailing NUL". It doesn't do that for empty strings: It returns 0 instead. This is causing issues for the upstream BPF function that calls it. There's a potential off-by-one error visible in the code.

strncpy_from_kernel_nofault() on the other hand works correctly: It returns 1 for an empty string.

Thanks,
Max

-----Original Message-----
From: Bagas Sanjaya <[email protected]>
Sent: Sunday, July 23, 2023 3:53 AM
To: Ingo Molnar <[email protected]>; Masami Hiramatsu <[email protected]>; Steven Rostedt (Google) <[email protected]>; Fröhling, Maximilian <[email protected]>
Cc: Linux Kernel Mailing List <[email protected]>; Linux BPF <[email protected]>; Linux Memory Management List <[email protected]>
Subject: Fwd: bpf: bpf_probe_read_user_str() returns 0 for empty strings

Hi,

I notice a bug report on Bugzilla [1]. Quoting from it:

Quoted 33 lines

Overview:

From within eBPF, calling the helper function bpf_probe_read_user_str(void *dst, __u32 size, const void *unsafe_ptr returns 0 when the source string (void *unsafe_ptr) consists of a string containing only a single null-byte.

This violates various functions documentations (the helper and various internal kernel functions), which all state:

Quoted 2 lines

On success, the strictly positive length of the output string, including the trailing NUL character. On error, a negative value.

To me, this states that the function should return 1 for char myString[] = ""; However, this is not the case. The function returns 0 instead.

For non-empty strings, it works as expected. For example, char myString[] = "abc"; returns 4.

Steps to Reproduce:
* Write an eBPF program that calls bpf_probe_read_user_str(), using a userspace pointer pointing to an empty string.
* Store the result value of that function
* Do the same thing, but try out bpf_probe_read_kernel_str(), like this:
char empty[] = "";
char copy[5];
long ret = bpf_probe_read_kernel_str(copy, 5, empty);
* Compare the return value of bpf_probe_read_user_str() and
bpf_probe_read_kernel_str()

Expected Result:

Both functions return 1 (because of the single NULL byte).

Actual Result:

bpf_probe_read_user_str() returns 0, while bpf_probe_read_kernel_str() returns 1.

Additional Information:

Quoted 7 lines

I believe I can see the bug on the current Linux kernel master branch.

In the file/function mm/maccess.c::strncpy_from_user_nofault() the helper implementation calls strncpy_from_user(), which returns the length without trailing 0. Hence this function returns 0 for an empty string.

However, in line 192 (as of commit fdf0eaf11452d72945af31804e2a1048ee1b574c) there is a check that only increments ret, if it is > 0. This appears to be the logic that adds the trailing null byte. Since the check only does this for a ret > 0, a ret of 0 remains at 0.

This is a possible off-by-one error that might cause the behavior.

See Bugzilla for the full thread.

FYI, the culprit line is introduced by commit 3d7081822f7f9e ("uaccess: Add non-pagefault user-space read functions"). I Cc: culprit SoB so that they can look into this bug.

Thanks.

[1]: https://bugzilla.kernel.org/show_bug.cgi?id=217679

--
An old man doll... just what I always wanted! - Clara