Skip to content

multiboot2: Follow C behavior for string parsing #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions multiboot2/src/tag.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,24 +43,17 @@ impl Tag {
/// UTF-8 Rust string slice without a terminating null byte or an error is
/// returned.
pub fn get_dst_str_slice(bytes: &[u8]) -> Result<&str, Utf8Error> {
if bytes.is_empty() {
// Very unlikely. A sane bootloader would omit the tag in this case.
// But better be safe.
return Ok("");
}
// Determine length of string before first NUL character

let length = match bytes.iter().position(|ch| (*ch) == 0x00) {
// Unterminated string case:
None => bytes.len(),

// Return without a trailing null byte. By spec, the null byte should
// always terminate the string. However, for safety, we do make an extra
// check.
let str_slice = if bytes.ends_with(&[b'\0']) {
let str_len = bytes.len() - 1;
&bytes[0..str_len]
} else {
// Unlikely that a bootloader doesn't follow the spec and does not
// add a terminating null byte.
bytes
// Terminated case:
Some(idx) => idx,
};
core::str::from_utf8(str_slice)
// Convert to Rust string:
core::str::from_utf8(&bytes[..length])
}
}

Expand Down Expand Up @@ -141,9 +134,11 @@ mod tests {
// also unlikely case
assert_eq!(Ok(""), Tag::get_dst_str_slice(&[b'\0']));
// unlikely case: missing null byte. but the lib can cope with that
assert_eq!(Ok("foobar"), Tag::get_dst_str_slice("foobar".as_bytes()));
assert_eq!(Ok("foobar"), Tag::get_dst_str_slice(b"foobar"));
// test that the null bytes is not included in the string slice
assert_eq!(Ok("foobar"), Tag::get_dst_str_slice("foobar\0".as_bytes()));
assert_eq!(Ok("foobar"), Tag::get_dst_str_slice(b"foobar\0"));
// test that C-style null string termination works as expected
assert_eq!(Ok("foo"), Tag::get_dst_str_slice(b"foo\0bar"));
// test invalid utf8
assert!(matches!(
Tag::get_dst_str_slice(&[0xff, 0xff]),
Expand Down