Skip to content

Commit 00cb75d

Browse files
authored
Validate PostscriptFragment offsets when parsing the footer (#8818)
Parser shouldn't crash, but error in these cases
1 parent b7b01d3 commit 00cb75d

2 files changed

Lines changed: 117 additions & 18 deletions

File tree

‎vortex-file/src/footer/deserializer.rs‎

Lines changed: 115 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,11 @@ impl FooterDeserializer {
229229
initial_read: &[u8],
230230
segment: &PostscriptSegment,
231231
) -> VortexResult<DType> {
232-
let offset = usize::try_from(segment.offset - initial_offset)?;
233-
let sliced_buffer =
234-
FlatBuffer::copy_from(&initial_read[offset..offset + (segment.length as usize)]);
232+
let sliced_buffer = FlatBuffer::copy_from(checked_segment_slice(
233+
initial_read,
234+
initial_offset,
235+
segment,
236+
)?);
235237
DType::from_flatbuffer(sliced_buffer, &self.session)
236238
}
237239

@@ -244,11 +246,9 @@ impl FooterDeserializer {
244246
dtype: &DType,
245247
session: &VortexSession,
246248
) -> VortexResult<FileStatistics> {
247-
let offset = usize::try_from(segment.offset - initial_offset)?;
248-
let sliced_buffer =
249-
FlatBuffer::copy_from(&initial_read[offset..offset + (segment.length as usize)]);
249+
let sliced_buffer = checked_segment_slice(initial_read, initial_offset, segment)?;
250250

251-
let fb = root::<vortex_flatbuffers::footer::FileStatistics>(&sliced_buffer)?;
251+
let fb = root::<vortex_flatbuffers::footer::FileStatistics>(sliced_buffer)?;
252252
FileStatistics::from_flatbuffer(&fb, dtype, session)
253253
}
254254

@@ -262,20 +262,119 @@ impl FooterDeserializer {
262262
dtype: DType,
263263
file_stats: Option<FileStatistics>,
264264
) -> VortexResult<Footer> {
265-
let footer_offset = usize::try_from(footer_segment.offset - initial_offset)?;
266-
let footer_bytes = FlatBuffer::copy_from(
267-
&initial_read[footer_offset..footer_offset + (footer_segment.length as usize)],
268-
);
269-
270-
let layout_offset = usize::try_from(layout_segment.offset - initial_offset)?;
271-
let layout_bytes = FlatBuffer::copy_from(
272-
&initial_read[layout_offset..layout_offset + (layout_segment.length as usize)],
273-
);
265+
let footer_bytes = checked_segment_slice(initial_read, initial_offset, footer_segment)?;
266+
let layout_bytes = FlatBuffer::copy_from(checked_segment_slice(
267+
initial_read,
268+
initial_offset,
269+
layout_segment,
270+
)?);
274271

275272
Footer::from_flatbuffer(footer_bytes, layout_bytes, dtype, file_stats, &self.session)
276273
}
277274
}
278275

276+
fn checked_segment_slice<'a>(
277+
read: &'a [u8],
278+
read_offset: u64,
279+
segment: &PostscriptSegment,
280+
) -> VortexResult<&'a [u8]> {
281+
let offset = usize::try_from(segment.offset.checked_sub(read_offset).ok_or_else(|| {
282+
vortex_err!(
283+
"Segment offset {} is smaller than file read offset {read_offset}",
284+
segment.offset
285+
)
286+
})?)?;
287+
offset
288+
.checked_add(segment.length as usize)
289+
.and_then(|end| read.get(offset..end))
290+
.ok_or_else(|| {
291+
vortex_err!(
292+
"Segment length {} (at offset {}) out of bounds of slice of length {}",
293+
segment.length,
294+
offset,
295+
read.len()
296+
)
297+
})
298+
}
299+
300+
#[cfg(test)]
301+
mod tests {
302+
use rstest::rstest;
303+
use vortex_array::array_session;
304+
use vortex_array::dtype::Nullability;
305+
use vortex_array::dtype::PType;
306+
use vortex_flatbuffers::WriteFlatBufferExt;
307+
308+
use super::*;
309+
310+
fn segment(offset: u64, length: u32) -> PostscriptSegment {
311+
PostscriptSegment {
312+
offset,
313+
length,
314+
alignment: FlatBuffer::alignment(),
315+
}
316+
}
317+
318+
#[test]
319+
fn in_bounds_segment_slice() -> VortexResult<()> {
320+
let read: Vec<u8> = (0u8..10).collect();
321+
let sliced = checked_segment_slice(&read, 100, &segment(104, 4))?;
322+
assert_eq!(sliced, &read[4..8]);
323+
Ok(())
324+
}
325+
326+
#[rstest]
327+
#[case::offset_before_read_start(100, 99, 4, "smaller than file read offset")]
328+
#[case::end_past_buffer(100, 105, 6, "out of bounds")]
329+
#[case::offset_past_buffer(100, 120, 1, "out of bounds")]
330+
#[case::end_overflows_usize(0, u64::MAX, u32::MAX, "out of bounds")]
331+
fn out_of_bounds_segment_slice(
332+
#[case] read_offset: u64,
333+
#[case] segment_offset: u64,
334+
#[case] segment_length: u32,
335+
#[case] expected: &str,
336+
) {
337+
let read = [0u8; 10];
338+
let err =
339+
checked_segment_slice(&read, read_offset, &segment(segment_offset, segment_length))
340+
.unwrap_err();
341+
assert!(err.to_string().contains(expected), "{err}");
342+
}
343+
344+
fn eof_buffer(postscript: &Postscript) -> VortexResult<ByteBuffer> {
345+
let postscript_bytes = postscript.write_flatbuffer_bytes()?;
346+
let mut buffer = ByteBufferMut::with_capacity(postscript_bytes.len() + EOF_SIZE);
347+
buffer.extend_from_slice(&postscript_bytes);
348+
buffer.extend_from_slice(&VERSION.to_le_bytes());
349+
buffer.extend_from_slice(&u16::try_from(postscript_bytes.len())?.to_le_bytes());
350+
buffer.extend_from_slice(&MAGIC_BYTES);
351+
Ok(buffer.freeze())
352+
}
353+
354+
#[rstest]
355+
#[case::length_past_eof(segment(0, u32::MAX))]
356+
#[case::offset_overflow(segment(u64::MAX, u32::MAX))]
357+
fn deserialize_rejects_out_of_bounds_footer_segment(
358+
#[case] footer_segment: PostscriptSegment,
359+
) -> VortexResult<()> {
360+
let postscript = Postscript {
361+
dtype: None,
362+
layout: segment(0, 1),
363+
statistics: None,
364+
footer: footer_segment,
365+
};
366+
let buffer = eof_buffer(&postscript)?;
367+
let file_size = buffer.len() as u64;
368+
369+
let mut deserializer = FooterDeserializer::new(buffer, array_session())
370+
.with_dtype(DType::Primitive(PType::I32, Nullability::NonNullable))
371+
.with_size(file_size);
372+
let err = deserializer.deserialize().unwrap_err();
373+
assert!(err.to_string().contains("out of bounds"), "{err}");
374+
Ok(())
375+
}
376+
}
377+
279378
#[derive(Debug)]
280379
/// Result of one [`FooterDeserializer::deserialize`] step.
281380
pub enum DeserializeStep {

‎vortex-file/src/footer/mod.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,14 @@ impl Footer {
7474

7575
/// Read the [`Footer`] from a flatbuffer.
7676
pub(crate) fn from_flatbuffer(
77-
footer_bytes: FlatBuffer,
77+
footer_bytes: &[u8],
7878
layout_bytes: FlatBuffer,
7979
dtype: DType,
8080
statistics: Option<FileStatistics>,
8181
session: &VortexSession,
8282
) -> VortexResult<Self> {
8383
let approx_byte_size = footer_bytes.len() + layout_bytes.len();
84-
let fb_footer = root::<fb::Footer>(&footer_bytes)?;
84+
let fb_footer = root::<fb::Footer>(footer_bytes)?;
8585

8686
// Create a LayoutContext from the registry.
8787
let layout_specs = fb_footer.layout_specs();

0 commit comments

Comments
 (0)