blob: 60b5b802699f53f59559085ed3a0ad9492cbadb0 [file] [log] [blame]
Victor Hsiehac4f3f42021-02-26 12:35:58 -08001/*
2 * Copyright (C) 2021 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//! A module for writing to a file from a trusted world to an untrusted storage.
18//!
19//! Architectural Model:
20//! * Trusted world: the writer, a signing secret, has some memory, but NO persistent storage.
21//! * Untrusted world: persistent storage, assuming untrusted.
22//! * IPC mechanism between trusted and untrusted world
23//!
24//! Use cases:
25//! * In the trusted world, we want to generate a large file, sign it, and share the signature for
26//! a third party to verify the file.
27//! * In the trusted world, we want to read a previously signed file back with signature check
28//! without having to touch the whole file.
29//!
30//! Requirements:
31//! * Communication between trusted and untrusted world is not cheap, and files can be large.
32//! * A file write pattern may not be sequential, neither does read.
33//!
34//! Considering the above, a technique similar to fs-verity is used. fs-verity uses an alternative
35//! hash function, a Merkle tree, to calculate the hash of file content. A file update at any
36//! location will propagate the hash update from the leaf to the root node. Unlike fs-verity, which
37//! assumes static files, to support write operation, we need to allow the file (thus tree) to
38//! update.
39//!
40//! For the trusted world to generate a large file with random write and hash it, the writer needs
41//! to hold some private information and update the Merkle tree during a file write (or even when
42//! the Merkle tree needs to be stashed to the untrusted storage).
43//!
44//! A write to a file must update the root hash. In order for the root hash to update, a tree
45//! walk to update from the write location to the root node is necessary. Importantly, in case when
46//! (part of) the Merkle tree needs to be read from the untrusted storage (e.g. not yet verified in
47//! cache), the original path must be verified by the trusted signature before the update to happen.
48//!
49//! Denial-of-service is a known weakness if the untrusted storage decides to simply remove the
50//! file. But there is nothing we can do in this architecture.
51//!
52//! Rollback attack is another possible attack, but can be addressed with a rollback counter when
53//! possible.
54
Victor Hsieh3e35f9a2022-03-03 22:17:23 +000055use log::warn;
Victor Hsiehac4f3f42021-02-26 12:35:58 -080056use std::io;
57use std::sync::{Arc, RwLock};
58
Victor Hsieh09e26262021-03-03 16:00:55 -080059use super::builder::MerkleLeaves;
Victor Hsiehac4f3f42021-02-26 12:35:58 -080060use crate::common::{ChunkedSizeIter, CHUNK_SIZE};
61use crate::crypto::{CryptoError, Sha256Hash, Sha256Hasher};
Victor Hsiehd0bb5d32021-03-19 12:48:03 -070062use crate::file::{ChunkBuffer, RandomWrite, ReadByChunk};
Victor Hsiehac4f3f42021-02-26 12:35:58 -080063
64// Implement the conversion from `CryptoError` to `io::Error` just to avoid manual error type
65// mapping below.
66impl From<CryptoError> for io::Error {
67 fn from(error: CryptoError) -> Self {
68 io::Error::new(io::ErrorKind::Other, error)
69 }
70}
71
Victor Hsieh9d0ab622021-04-26 17:07:02 -070072fn debug_assert_usize_is_u64() {
73 // Since we don't need to support 32-bit CPU, make an assert to make conversion between
74 // u64 and usize easy below. Otherwise, we need to check `divide_roundup(offset + buf.len()
75 // <= usize::MAX` or handle `TryInto` errors.
76 debug_assert!(usize::MAX as u64 == u64::MAX, "Only 64-bit arch is supported");
77}
78
Victor Hsiehac4f3f42021-02-26 12:35:58 -080079/// VerifiedFileEditor provides an integrity layer to an underlying read-writable file, which may
80/// not be stored in a trusted environment. Only new, empty files are currently supported.
Victor Hsiehd0bb5d32021-03-19 12:48:03 -070081pub struct VerifiedFileEditor<F: ReadByChunk + RandomWrite> {
Victor Hsiehac4f3f42021-02-26 12:35:58 -080082 file: F,
83 merkle_tree: Arc<RwLock<MerkleLeaves>>,
84}
85
Victor Hsiehd0bb5d32021-03-19 12:48:03 -070086impl<F: ReadByChunk + RandomWrite> VerifiedFileEditor<F> {
Victor Hsiehac4f3f42021-02-26 12:35:58 -080087 /// Wraps a supposedly new file for integrity protection.
88 pub fn new(file: F) -> Self {
89 Self { file, merkle_tree: Arc::new(RwLock::new(MerkleLeaves::new())) }
90 }
91
Victor Hsieh71f10032021-08-13 11:24:02 -070092 /// Returns the fs-verity digest size in bytes.
93 pub fn get_fsverity_digest_size(&self) -> usize {
94 Sha256Hasher::HASH_SIZE
95 }
96
Victor Hsiehac4f3f42021-02-26 12:35:58 -080097 /// Calculates the fs-verity digest of the current file.
98 pub fn calculate_fsverity_digest(&self) -> io::Result<Sha256Hash> {
99 let merkle_tree = self.merkle_tree.read().unwrap();
100 merkle_tree.calculate_fsverity_digest().map_err(|e| io::Error::new(io::ErrorKind::Other, e))
101 }
102
Victor Hsieh3e35f9a2022-03-03 22:17:23 +0000103 fn read_backing_chunk_unverified(
104 &self,
105 chunk_index: u64,
106 buf: &mut ChunkBuffer,
107 ) -> io::Result<usize> {
108 self.file.read_chunk(chunk_index, buf)
109 }
110
111 fn read_backing_chunk_verified(
112 &self,
113 chunk_index: u64,
114 buf: &mut ChunkBuffer,
Victor Hsiehafdfd0e2022-03-05 00:35:23 +0000115 merkle_tree_locked: &MerkleLeaves,
Victor Hsieh3e35f9a2022-03-03 22:17:23 +0000116 ) -> io::Result<usize> {
117 let size = self.read_backing_chunk_unverified(chunk_index, buf)?;
118
119 // Ensure the returned buffer matches the known hash.
Victor Hsieh3e35f9a2022-03-03 22:17:23 +0000120 debug_assert_usize_is_u64();
Victor Hsiehafdfd0e2022-03-05 00:35:23 +0000121 if merkle_tree_locked.is_index_valid(chunk_index as usize) {
Victor Hsieh3e35f9a2022-03-03 22:17:23 +0000122 let hash = Sha256Hasher::new()?.update(buf)?.finalize()?;
Victor Hsiehafdfd0e2022-03-05 00:35:23 +0000123 if !merkle_tree_locked.is_consistent(chunk_index as usize, &hash) {
Victor Hsieh3e35f9a2022-03-03 22:17:23 +0000124 return Err(io::Error::new(io::ErrorKind::InvalidData, "Inconsistent hash"));
125 }
126 Ok(size)
127 } else {
128 if size != 0 {
129 // This is unexpected. For any reason that the file is changed and doesn't match
130 // the known state, ignore it at the moment. We can still generate correct
131 // fs-verity digest for an output file.
132 warn!(
133 "Ignoring the received {} bytes for index {} beyond the known file size",
134 size, chunk_index,
135 );
136 }
137 Ok(0)
138 }
139 }
140
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800141 fn new_hash_for_incomplete_write(
142 &self,
143 source: &[u8],
144 offset_from_alignment: usize,
145 output_chunk_index: usize,
146 merkle_tree: &mut MerkleLeaves,
147 ) -> io::Result<Sha256Hash> {
148 // The buffer is initialized to 0 purposely. To calculate the block hash, the data is
149 // 0-padded to the block size. When a chunk read is less than a chunk, the initial value
150 // conveniently serves the padding purpose.
151 let mut orig_data = [0u8; CHUNK_SIZE as usize];
152
153 // If previous data exists, read back and verify against the known hash (since the
154 // storage / remote server is not trusted).
155 if merkle_tree.is_index_valid(output_chunk_index) {
Victor Hsieh3e35f9a2022-03-03 22:17:23 +0000156 self.read_backing_chunk_unverified(output_chunk_index as u64, &mut orig_data)?;
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800157
158 // Verify original content
159 let hash = Sha256Hasher::new()?.update(&orig_data)?.finalize()?;
160 if !merkle_tree.is_consistent(output_chunk_index, &hash) {
161 return Err(io::Error::new(io::ErrorKind::InvalidData, "Inconsistent hash"));
162 }
163 }
164
165 Ok(Sha256Hasher::new()?
166 .update(&orig_data[..offset_from_alignment])?
167 .update(source)?
168 .update(&orig_data[offset_from_alignment + source.len()..])?
169 .finalize()?)
170 }
171
172 fn new_chunk_hash(
173 &self,
174 source: &[u8],
175 offset_from_alignment: usize,
176 current_size: usize,
177 output_chunk_index: usize,
178 merkle_tree: &mut MerkleLeaves,
179 ) -> io::Result<Sha256Hash> {
180 if current_size as u64 == CHUNK_SIZE {
181 // Case 1: If the chunk is a complete one, just calculate the hash, regardless of
182 // write location.
183 Ok(Sha256Hasher::new()?.update(source)?.finalize()?)
184 } else {
185 // Case 2: For an incomplete write, calculate the hash based on previous data (if
186 // any).
187 self.new_hash_for_incomplete_write(
188 source,
189 offset_from_alignment,
190 output_chunk_index,
191 merkle_tree,
192 )
193 }
194 }
Victor Hsieh6a47e7f2021-03-03 15:53:49 -0800195
196 pub fn size(&self) -> u64 {
197 self.merkle_tree.read().unwrap().file_size()
198 }
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800199}
200
Victor Hsiehd0bb5d32021-03-19 12:48:03 -0700201impl<F: ReadByChunk + RandomWrite> RandomWrite for VerifiedFileEditor<F> {
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800202 fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
Victor Hsieh9d0ab622021-04-26 17:07:02 -0700203 debug_assert_usize_is_u64();
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800204
205 // The write range may not be well-aligned with the chunk boundary. There are various cases
206 // to deal with:
207 // 1. A write of a full 4K chunk.
208 // 2. A write of an incomplete chunk, possibly beyond the original EOF.
209 //
210 // Note that a write beyond EOF can create a hole. But we don't need to handle it here
211 // because holes are zeros, and leaves in MerkleLeaves are hashes of 4096-zeros by
212 // default.
213
214 // Now iterate on the input data, considering the alignment at the destination.
215 for (output_offset, current_size) in
216 ChunkedSizeIter::new(buf.len(), offset, CHUNK_SIZE as usize)
217 {
218 // Lock the tree for the whole write for now. There may be room to improve to increase
219 // throughput.
220 let mut merkle_tree = self.merkle_tree.write().unwrap();
221
222 let offset_in_buf = (output_offset - offset) as usize;
223 let source = &buf[offset_in_buf as usize..offset_in_buf as usize + current_size];
224 let output_chunk_index = (output_offset / CHUNK_SIZE) as usize;
225 let offset_from_alignment = (output_offset % CHUNK_SIZE) as usize;
226
227 let new_hash = match self.new_chunk_hash(
228 source,
229 offset_from_alignment,
230 current_size,
231 output_chunk_index,
232 &mut merkle_tree,
233 ) {
234 Ok(hash) => hash,
235 Err(e) => {
236 // Return early when any error happens before the right. Even if the hash is not
237 // consistent for the current chunk, we can still consider the earlier writes
238 // successful. Note that nothing persistent has been done in this iteration.
239 let written = output_offset - offset;
240 if written > 0 {
241 return Ok(written as usize);
242 }
243 return Err(e);
244 }
245 };
246
247 // A failed, partial write here will make the backing file inconsistent to the (old)
248 // hash. Nothing can be done within this writer, but at least it still maintains the
249 // (original) integrity for the file. To matches what write(2) describes for an error
250 // case (though it's about direct I/O), "Partial data may be written ... should be
251 // considered inconsistent", an error below is propagated.
Chris Wailes68c39f82021-07-27 16:03:44 -0700252 self.file.write_all_at(source, output_offset)?;
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800253
254 // Update the hash only after the write succeeds. Note that this only attempts to keep
255 // the tree consistent to what has been written regardless the actual state beyond the
256 // writer.
257 let size_at_least = offset.saturating_add(buf.len() as u64);
258 merkle_tree.update_hash(output_chunk_index, &new_hash, size_at_least);
259 }
260 Ok(buf.len())
261 }
Victor Hsieh9d0ab622021-04-26 17:07:02 -0700262
263 fn resize(&self, size: u64) -> io::Result<()> {
264 debug_assert_usize_is_u64();
265
266 let mut merkle_tree = self.merkle_tree.write().unwrap();
267 // In case when we are truncating the file, we may need to recalculate the hash of the (new)
268 // last chunk. Since the content is provided by the untrusted backend, we need to read the
269 // data back first, verify it, then override the truncated portion with 0-padding for
270 // hashing. As an optimization, we only need to read the data back if the new size isn't a
271 // multiple of CHUNK_SIZE (since the hash is already correct).
272 //
273 // The same thing does not need to happen when the size is growing. Since the new extended
274 // data is always 0, we can just resize the `MerkleLeaves`, where a new hash is always
275 // calculated from 4096 zeros.
276 if size < merkle_tree.file_size() && size % CHUNK_SIZE > 0 {
277 let new_tail_size = (size % CHUNK_SIZE) as usize;
278 let chunk_index = size / CHUNK_SIZE;
279 if new_tail_size > 0 {
280 let mut buf: ChunkBuffer = [0; CHUNK_SIZE as usize];
Victor Hsiehafdfd0e2022-03-05 00:35:23 +0000281 let s = self.read_backing_chunk_verified(chunk_index, &mut buf, &merkle_tree)?;
Victor Hsieh9d0ab622021-04-26 17:07:02 -0700282 debug_assert!(new_tail_size <= s);
283
284 let zeros = vec![0; CHUNK_SIZE as usize - new_tail_size];
285 let new_hash = Sha256Hasher::new()?
286 .update(&buf[..new_tail_size])?
287 .update(&zeros)?
288 .finalize()?;
289 merkle_tree.update_hash(chunk_index as usize, &new_hash, size);
290 }
291 }
292
293 self.file.resize(size)?;
294 merkle_tree.resize(size as usize);
295
296 Ok(())
297 }
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800298}
299
Victor Hsiehd0bb5d32021-03-19 12:48:03 -0700300impl<F: ReadByChunk + RandomWrite> ReadByChunk for VerifiedFileEditor<F> {
301 fn read_chunk(&self, chunk_index: u64, buf: &mut ChunkBuffer) -> io::Result<usize> {
Victor Hsiehafdfd0e2022-03-05 00:35:23 +0000302 let merkle_tree = self.merkle_tree.read().unwrap();
303 self.read_backing_chunk_verified(chunk_index, buf, &merkle_tree)
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800304 }
305}
306
307#[cfg(test)]
308mod tests {
309 // Test data below can be generated by:
310 // $ perl -e 'print "\x{00}" x 6000' > foo
311 // $ perl -e 'print "\x{01}" x 5000' >> foo
312 // $ fsverity digest foo
313 use super::*;
314 use anyhow::Result;
315 use std::cell::RefCell;
316 use std::convert::TryInto;
317
Victor Hsieh09e26262021-03-03 16:00:55 -0800318 struct InMemoryEditor {
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800319 data: RefCell<Vec<u8>>,
320 fail_read: bool,
321 }
322
Victor Hsieh09e26262021-03-03 16:00:55 -0800323 impl InMemoryEditor {
324 pub fn new() -> InMemoryEditor {
325 InMemoryEditor { data: RefCell::new(Vec::new()), fail_read: false }
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800326 }
327 }
328
Victor Hsieh09e26262021-03-03 16:00:55 -0800329 impl RandomWrite for InMemoryEditor {
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800330 fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
331 let begin: usize =
332 offset.try_into().map_err(|e| io::Error::new(io::ErrorKind::Other, e))?;
333 let end = begin + buf.len();
334 if end > self.data.borrow().len() {
335 self.data.borrow_mut().resize(end, 0);
336 }
Chris Wailes68c39f82021-07-27 16:03:44 -0700337 self.data.borrow_mut().as_mut_slice()[begin..end].copy_from_slice(buf);
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800338 Ok(buf.len())
339 }
Victor Hsieh9d0ab622021-04-26 17:07:02 -0700340
341 fn resize(&self, size: u64) -> io::Result<()> {
342 let size: usize =
343 size.try_into().map_err(|e| io::Error::new(io::ErrorKind::Other, e))?;
344 self.data.borrow_mut().resize(size, 0);
345 Ok(())
346 }
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800347 }
348
Victor Hsiehd0bb5d32021-03-19 12:48:03 -0700349 impl ReadByChunk for InMemoryEditor {
350 fn read_chunk(&self, chunk_index: u64, buf: &mut ChunkBuffer) -> io::Result<usize> {
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800351 if self.fail_read {
352 return Err(io::Error::new(io::ErrorKind::Other, "test!"));
353 }
354
355 let borrowed = self.data.borrow();
356 let chunk = &borrowed
357 .chunks(CHUNK_SIZE as usize)
358 .nth(chunk_index as usize)
359 .ok_or_else(|| {
360 io::Error::new(
361 io::ErrorKind::InvalidInput,
362 format!("read_chunk out of bound: index {}", chunk_index),
363 )
364 })?;
Chris Wailes68c39f82021-07-27 16:03:44 -0700365 buf[..chunk.len()].copy_from_slice(chunk);
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800366 Ok(chunk.len())
367 }
368 }
369
370 #[test]
371 fn test_writer() -> Result<()> {
Victor Hsieh09e26262021-03-03 16:00:55 -0800372 let writer = InMemoryEditor::new();
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800373 let buf = [1; 4096];
374 assert_eq!(writer.data.borrow().len(), 0);
375
376 assert_eq!(writer.write_at(&buf, 16384)?, 4096);
377 assert_eq!(writer.data.borrow()[16384..16384 + 4096], buf);
378
379 assert_eq!(writer.write_at(&buf, 2048)?, 4096);
380 assert_eq!(writer.data.borrow()[2048..2048 + 4096], buf);
381
382 assert_eq!(writer.data.borrow().len(), 16384 + 4096);
383 Ok(())
384 }
385
386 #[test]
387 fn test_verified_writer_no_write() -> Result<()> {
388 // Verify fs-verity hash without any write.
Victor Hsieh09e26262021-03-03 16:00:55 -0800389 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800390 assert_eq!(
391 file.calculate_fsverity_digest()?,
392 to_u8_vec("3d248ca542a24fc62d1c43b916eae5016878e2533c88238480b26128a1f1af95")
393 .as_slice()
394 );
395 Ok(())
396 }
397
398 #[test]
399 fn test_verified_writer_from_zero() -> Result<()> {
400 // Verify a write of a full chunk.
Victor Hsieh09e26262021-03-03 16:00:55 -0800401 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800402 assert_eq!(file.write_at(&[1; 4096], 0)?, 4096);
403 assert_eq!(
404 file.calculate_fsverity_digest()?,
405 to_u8_vec("cd0875ca59c7d37e962c5e8f5acd3770750ac80225e2df652ce5672fd34500af")
406 .as_slice()
407 );
408
409 // Verify a write of across multiple chunks.
Victor Hsieh09e26262021-03-03 16:00:55 -0800410 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800411 assert_eq!(file.write_at(&[1; 4097], 0)?, 4097);
412 assert_eq!(
413 file.calculate_fsverity_digest()?,
414 to_u8_vec("2901b849fda2d91e3929524561c4a47e77bb64734319759507b2029f18b9cc52")
415 .as_slice()
416 );
417
418 // Verify another write of across multiple chunks.
Victor Hsieh09e26262021-03-03 16:00:55 -0800419 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800420 assert_eq!(file.write_at(&[1; 10000], 0)?, 10000);
421 assert_eq!(
422 file.calculate_fsverity_digest()?,
423 to_u8_vec("7545409b556071554d18973a29b96409588c7cda4edd00d5586b27a11e1a523b")
424 .as_slice()
425 );
426 Ok(())
427 }
428
429 #[test]
430 fn test_verified_writer_unaligned() -> Result<()> {
431 // Verify small, unaligned write beyond EOF.
Victor Hsieh09e26262021-03-03 16:00:55 -0800432 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800433 assert_eq!(file.write_at(&[1; 5], 3)?, 5);
434 assert_eq!(
435 file.calculate_fsverity_digest()?,
436 to_u8_vec("a23fc5130d3d7b3323fc4b4a5e79d5d3e9ddf3a3f5872639e867713512c6702f")
437 .as_slice()
438 );
439
440 // Verify bigger, unaligned write beyond EOF.
Victor Hsieh09e26262021-03-03 16:00:55 -0800441 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800442 assert_eq!(file.write_at(&[1; 6000], 4000)?, 6000);
443 assert_eq!(
444 file.calculate_fsverity_digest()?,
445 to_u8_vec("d16d4c1c186d757e646f76208b21254f50d7f07ea07b1505ff48b2a6f603f989")
446 .as_slice()
447 );
448 Ok(())
449 }
450
451 #[test]
452 fn test_verified_writer_with_hole() -> Result<()> {
453 // Verify an aligned write beyond EOF with holes.
Victor Hsieh09e26262021-03-03 16:00:55 -0800454 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800455 assert_eq!(file.write_at(&[1; 4096], 4096)?, 4096);
456 assert_eq!(
457 file.calculate_fsverity_digest()?,
458 to_u8_vec("4df2aefd8c2a9101d1d8770dca3ede418232eabce766bb8e020395eae2e97103")
459 .as_slice()
460 );
461
462 // Verify an unaligned write beyond EOF with holes.
Victor Hsieh09e26262021-03-03 16:00:55 -0800463 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800464 assert_eq!(file.write_at(&[1; 5000], 6000)?, 5000);
465 assert_eq!(
466 file.calculate_fsverity_digest()?,
467 to_u8_vec("47d5da26f6934484e260630a69eb2eebb21b48f69bc8fbf8486d1694b7dba94f")
468 .as_slice()
469 );
470
471 // Just another example with a small write.
Victor Hsieh09e26262021-03-03 16:00:55 -0800472 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800473 assert_eq!(file.write_at(&[1; 5], 16381)?, 5);
474 assert_eq!(
475 file.calculate_fsverity_digest()?,
476 to_u8_vec("8bd118821fb4aff26bb4b51d485cc481a093c68131b7f4f112e9546198449752")
477 .as_slice()
478 );
479 Ok(())
480 }
481
482 #[test]
483 fn test_verified_writer_various_writes() -> Result<()> {
Victor Hsieh09e26262021-03-03 16:00:55 -0800484 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800485 assert_eq!(file.write_at(&[1; 2048], 0)?, 2048);
486 assert_eq!(file.write_at(&[1; 2048], 4096 + 2048)?, 2048);
487 assert_eq!(
488 file.calculate_fsverity_digest()?,
489 to_u8_vec("4c433d8640c888b629dc673d318cbb8d93b1eebcc784d9353e07f09f0dcfe707")
490 .as_slice()
491 );
492 assert_eq!(file.write_at(&[1; 2048], 2048)?, 2048);
493 assert_eq!(file.write_at(&[1; 2048], 4096)?, 2048);
494 assert_eq!(
495 file.calculate_fsverity_digest()?,
496 to_u8_vec("2a476d58eb80394052a3a783111e1458ac3ecf68a7878183fed86ca0ff47ec0d")
497 .as_slice()
498 );
499 assert_eq!(file.write_at(&[0; 2048], 2048)?, 2048);
500 assert_eq!(file.write_at(&[0; 2048], 4096)?, 2048);
501 assert_eq!(
502 file.calculate_fsverity_digest()?,
503 to_u8_vec("4c433d8640c888b629dc673d318cbb8d93b1eebcc784d9353e07f09f0dcfe707")
504 .as_slice()
505 );
506 assert_eq!(file.write_at(&[1; 4096], 2048)?, 4096);
507 assert_eq!(
508 file.calculate_fsverity_digest()?,
509 to_u8_vec("2a476d58eb80394052a3a783111e1458ac3ecf68a7878183fed86ca0ff47ec0d")
510 .as_slice()
511 );
512 assert_eq!(file.write_at(&[1; 2048], 8192)?, 2048);
513 assert_eq!(file.write_at(&[1; 2048], 8192 + 2048)?, 2048);
514 assert_eq!(
515 file.calculate_fsverity_digest()?,
516 to_u8_vec("23cbac08371e6ee838ebcc7ae6512b939d2226e802337be7b383c3e046047d24")
517 .as_slice()
518 );
519 Ok(())
520 }
521
522 #[test]
523 fn test_verified_writer_inconsistent_read() -> Result<()> {
Victor Hsieh09e26262021-03-03 16:00:55 -0800524 let file = VerifiedFileEditor::new(InMemoryEditor::new());
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800525 assert_eq!(file.write_at(&[1; 8192], 0)?, 8192);
526
527 // Replace the expected hash of the first/0-th chunk. An incomplete write will fail when it
528 // detects the inconsistent read.
529 {
530 let mut merkle_tree = file.merkle_tree.write().unwrap();
531 let overriding_hash = [42; Sha256Hasher::HASH_SIZE];
532 merkle_tree.update_hash(0, &overriding_hash, 8192);
533 }
534 assert!(file.write_at(&[1; 1], 2048).is_err());
535
536 // A write of full chunk can still succeed. Also fixed the inconsistency.
537 assert_eq!(file.write_at(&[1; 4096], 4096)?, 4096);
538
539 // Replace the expected hash of the second/1-th chunk. A write range from previous chunk can
540 // still succeed, but returns early due to an inconsistent read but still successfully. A
541 // resumed write will fail since no bytes can be written due to the same inconsistency.
542 {
543 let mut merkle_tree = file.merkle_tree.write().unwrap();
544 let overriding_hash = [42; Sha256Hasher::HASH_SIZE];
545 merkle_tree.update_hash(1, &overriding_hash, 8192);
546 }
547 assert_eq!(file.write_at(&[10; 8000], 0)?, 4096);
548 assert!(file.write_at(&[10; 8000 - 4096], 4096).is_err());
549 Ok(())
550 }
551
552 #[test]
553 fn test_verified_writer_failed_read_back() -> Result<()> {
Victor Hsieh09e26262021-03-03 16:00:55 -0800554 let mut writer = InMemoryEditor::new();
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800555 writer.fail_read = true;
556 let file = VerifiedFileEditor::new(writer);
557 assert_eq!(file.write_at(&[1; 8192], 0)?, 8192);
558
559 // When a read back is needed, a read failure will fail to write.
560 assert!(file.write_at(&[1; 1], 2048).is_err());
561 Ok(())
562 }
563
Victor Hsieh9d0ab622021-04-26 17:07:02 -0700564 #[test]
565 fn test_resize_to_same_size() -> Result<()> {
566 let file = VerifiedFileEditor::new(InMemoryEditor::new());
567 assert_eq!(file.write_at(&[1; 2048], 0)?, 2048);
568
569 assert!(file.resize(2048).is_ok());
570 assert_eq!(file.size(), 2048);
571
572 assert_eq!(
573 file.calculate_fsverity_digest()?,
574 to_u8_vec("fef1b4f19bb7a2cd944d7cdee44d1accb12726389ca5b0f61ac0f548ae40876f")
575 .as_slice()
576 );
577 Ok(())
578 }
579
580 #[test]
581 fn test_resize_to_grow() -> Result<()> {
582 let file = VerifiedFileEditor::new(InMemoryEditor::new());
583 assert_eq!(file.write_at(&[1; 2048], 0)?, 2048);
584
585 // Resize should grow with 0s.
586 assert!(file.resize(4096).is_ok());
587 assert_eq!(file.size(), 4096);
588
589 assert_eq!(
590 file.calculate_fsverity_digest()?,
591 to_u8_vec("9e0e2745c21e4e74065240936d2047340d96a466680c3c9d177b82433e7a0bb1")
592 .as_slice()
593 );
594 Ok(())
595 }
596
597 #[test]
598 fn test_resize_to_shrink() -> Result<()> {
599 let file = VerifiedFileEditor::new(InMemoryEditor::new());
600 assert_eq!(file.write_at(&[1; 4096], 0)?, 4096);
601
602 // Truncate.
603 file.resize(2048)?;
604 assert_eq!(file.size(), 2048);
605
606 assert_eq!(
607 file.calculate_fsverity_digest()?,
608 to_u8_vec("fef1b4f19bb7a2cd944d7cdee44d1accb12726389ca5b0f61ac0f548ae40876f")
609 .as_slice()
610 );
611 Ok(())
612 }
613
614 #[test]
615 fn test_resize_to_shrink_with_read_failure() -> Result<()> {
616 let mut writer = InMemoryEditor::new();
617 writer.fail_read = true;
618 let file = VerifiedFileEditor::new(writer);
619 assert_eq!(file.write_at(&[1; 4096], 0)?, 4096);
620
621 // A truncate needs a read back. If the read fail, the resize should fail.
622 assert!(file.resize(2048).is_err());
623 Ok(())
624 }
625
626 #[test]
627 fn test_resize_to_shirink_to_chunk_boundary() -> Result<()> {
628 let mut writer = InMemoryEditor::new();
629 writer.fail_read = true;
630 let file = VerifiedFileEditor::new(writer);
631 assert_eq!(file.write_at(&[1; 8192], 0)?, 8192);
632
633 // Truncate to a chunk boundary. A read error doesn't matter since we won't need to
634 // recalcuate the leaf hash.
635 file.resize(4096)?;
636 assert_eq!(file.size(), 4096);
637
638 assert_eq!(
639 file.calculate_fsverity_digest()?,
640 to_u8_vec("cd0875ca59c7d37e962c5e8f5acd3770750ac80225e2df652ce5672fd34500af")
641 .as_slice()
642 );
643 Ok(())
644 }
645
Victor Hsiehac4f3f42021-02-26 12:35:58 -0800646 fn to_u8_vec(hex_str: &str) -> Vec<u8> {
647 assert!(hex_str.len() % 2 == 0);
648 (0..hex_str.len())
649 .step_by(2)
650 .map(|i| u8::from_str_radix(&hex_str[i..i + 2], 16).unwrap())
651 .collect()
652 }
653}