Skip to content

Test: Verify overlapping buffers check for compress_into and decompress_into #374

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.

Sign up for GitHub

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
404Setup merged 1 commit into from
Feb 24, 2026
Merged

Test: Verify overlapping buffers check for compress_into and decompress_into #374

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
143 changes: 118 additions & 25 deletions tests/security_overlap_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,135 @@ mod tests {
fn test_compress_overlap() {
let mut compressor = Compressor::new(1).unwrap();
let mut buffer = vec![0u8; 1024];
// Fill buffer with some data to compress
for i in 0..512 {
buffer[i] = (i % 256) as u8;
}

// Create overlapping slices using unsafe
let ptr = buffer.as_mut_ptr();
let input_slice = unsafe { std::slice::from_raw_parts(ptr, 512) };
let output_slice = unsafe { std::slice::from_raw_parts_mut(ptr.add(10), 512) };
// Helper to test overlap for a specific format
let mut check_overlap = |input_range: std::ops::Range<usize>, output_range: std::ops::Range<usize>, method: &str| {
let ptr = buffer.as_mut_ptr();
let input_slice = unsafe { std::slice::from_raw_parts(ptr.add(input_range.start), input_range.len()) };
let output_slice = unsafe { std::slice::from_raw_parts_mut(ptr.add(output_range.start), output_range.len()) };

let res = compressor.compress_deflate_into(input_slice, output_slice);
assert!(res.is_err());
let err = res.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
assert_eq!(err.to_string(), "Input and output buffers overlap");
let res = match method {
"deflate" => compressor.compress_deflate_into(input_slice, output_slice),
"zlib" => compressor.compress_zlib_into(input_slice, output_slice),
"gzip" => compressor.compress_gzip_into(input_slice, output_slice),
_ => panic!("Unknown method"),
};

assert!(res.is_err(), "Expected error for overlap with method {}", method);
let err = res.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
assert_eq!(err.to_string(), "Input and output buffers overlap");
};

// Scenarios:
// 1. Partial overlap (start)
// Input: [0, 100), Output: [50, 150) -> Overlap [50, 100)
check_overlap(0..100, 50..150, "deflate");
check_overlap(0..100, 50..150, "zlib");
check_overlap(0..100, 50..150, "gzip");

// 2. Partial overlap (end)
// Input: [50, 150), Output: [0, 100) -> Overlap [50, 100)
check_overlap(50..150, 0..100, "deflate");
check_overlap(50..150, 0..100, "zlib");
check_overlap(50..150, 0..100, "gzip");

// 3. Inclusion (input inside output)
// Input: [50, 100), Output: [0, 150) -> Overlap [50, 100)
check_overlap(50..100, 0..150, "deflate");
check_overlap(50..100, 0..150, "zlib");
check_overlap(50..100, 0..150, "gzip");

// 4. Inclusion (output inside input)
// Input: [0, 150), Output: [50, 100) -> Overlap [50, 100)
check_overlap(0..150, 50..100, "deflate");
check_overlap(0..150, 50..100, "zlib");
check_overlap(0..150, 50..100, "gzip");

// 5. Exact match
// Input: [0, 100), Output: [0, 100) -> Overlap [0, 100)
check_overlap(0..100, 0..100, "deflate");
check_overlap(0..100, 0..100, "zlib");
check_overlap(0..100, 0..100, "gzip");
}

#[test]
fn test_decompress_overlap() {
let mut decompressor = Decompressor::new();
let mut buffer = vec![0u8; 1024];

// We don't strictly need valid compressed data to test the overlap check,
// because the check happens before decompression logic.
// But to be safe against future reordering, we can put some dummy data.
// Helper to test overlap for a specific format
let mut check_overlap = |input_range: std::ops::Range<usize>, output_range: std::ops::Range<usize>, method: &str| {
let ptr = buffer.as_mut_ptr();
let input_slice = unsafe { std::slice::from_raw_parts(ptr.add(input_range.start), input_range.len()) };
let output_slice = unsafe { std::slice::from_raw_parts_mut(ptr.add(output_range.start), output_range.len()) };

let res = match method {
"deflate" => decompressor.decompress_deflate_into(input_slice, output_slice),
"zlib" => decompressor.decompress_zlib_into(input_slice, output_slice),
"gzip" => decompressor.decompress_gzip_into(input_slice, output_slice),
_ => panic!("Unknown method"),
};

assert!(res.is_err(), "Expected error for overlap with method {}", method);
let err = res.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
assert_eq!(err.to_string(), "Input and output buffers overlap");
};

// Scenarios:
// 1. Partial overlap (start)
check_overlap(0..100, 50..150, "deflate");
check_overlap(0..100, 50..150, "zlib");
check_overlap(0..100, 50..150, "gzip");

// 2. Partial overlap (end)
check_overlap(50..150, 0..100, "deflate");
check_overlap(50..150, 0..100, "zlib");
check_overlap(50..150, 0..100, "gzip");

// 3. Inclusion (input inside output)
check_overlap(50..100, 0..150, "deflate");
check_overlap(50..100, 0..150, "zlib");
check_overlap(50..100, 0..150, "gzip");

// 4. Inclusion (output inside input)
check_overlap(0..150, 50..100, "deflate");
check_overlap(0..150, 50..100, "zlib");
check_overlap(0..150, 50..100, "gzip");

// 5. Exact match
check_overlap(0..100, 0..100, "deflate");
check_overlap(0..100, 0..100, "zlib");
check_overlap(0..100, 0..100, "gzip");
}

#[test]
fn test_no_overlap() {
let mut compressor = Compressor::new(1).unwrap();
let mut buffer = vec![0u8; 1024];

let ptr = buffer.as_mut_ptr();
// Input: 0..100

// Input: [0, 100)
// Output: [100, 200) -> No overlap (Touching at 100)
let input_slice = unsafe { std::slice::from_raw_parts(ptr, 100) };
// Output: 50..150 (Overlap 50..100)
let output_slice = unsafe { std::slice::from_raw_parts_mut(ptr.add(50), 100) };

let res = decompressor.decompress_deflate_into(input_slice, output_slice);
assert!(res.is_err(), "Result should be Err, got {:?}", res);
let err = res.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
assert_eq!(err.to_string(), "Input and output buffers overlap");
let output_slice = unsafe { std::slice::from_raw_parts_mut(ptr.add(100), 100) };

let res = compressor.compress_deflate_into(input_slice, output_slice);
if let Err(e) = res {
assert_ne!(e.to_string(), "Input and output buffers overlap");
}

// Touching on the other side
// Input: [100, 200)
// Output: [0, 100) -> No overlap (Touching at 100)
let input_slice = unsafe { std::slice::from_raw_parts(ptr.add(100), 100) };
let output_slice = unsafe { std::slice::from_raw_parts_mut(ptr, 100) };

let res = compressor.compress_deflate_into(input_slice, output_slice);
if let Err(e) = res {
assert_ne!(e.to_string(), "Input and output buffers overlap");
}
}
}