chie-core 0.2.0

Core protocol logic for CHIE Protocol
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
//! Incremental content verification with streaming hash.
//!
//! This module provides streaming hash verification for large content,
//! allowing verification to proceed incrementally as chunks arrive without
//! needing to buffer the entire content in memory.
//!
//! # Features
//!
//! - Streaming hash computation (BLAKE3)
//! - Incremental verification without full buffering
//! - Merkle tree-based chunk verification
//! - Progress tracking for long-running verification
//! - Memory-efficient verification of large files
//! - Resumable verification from checkpoints
//!
//! # Example
//!
//! ```
//! use chie_core::streaming_verification::{StreamingVerifier, VerificationProgress};
//!
//! # fn example() -> Result<(), Box<dyn std::error::Error>> {
//! // Create a verifier with expected root hash
//! let expected_hash = [0u8; 32];
//! let mut verifier = StreamingVerifier::new(expected_hash);
//!
//! // Feed chunks incrementally
//! let chunk1 = b"Hello, ";
//! let chunk2 = b"World!";
//!
//! verifier.update(chunk1);
//! verifier.update(chunk2);
//!
//! // Finalize and verify
//! let result = verifier.finalize()?;
//! if result.verified {
//!     println!("Content verified successfully!");
//! }
//! # Ok(())
//! # }
//! ```

use chie_crypto::hash::{IncrementalHasher, hash};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use thiserror::Error;

/// Default chunk size for Merkle tree construction (256 KB)
const MERKLE_CHUNK_SIZE: usize = 256 * 1024;

/// Errors that can occur during streaming verification
#[derive(Debug, Error)]
pub enum VerificationError {
    #[error("Hash mismatch: expected {expected:?}, got {actual:?}")]
    HashMismatch {
        expected: [u8; 32],
        actual: [u8; 32],
    },

    #[error("Incomplete verification: {0} bytes processed, {1} bytes expected")]
    Incomplete(u64, u64),

    #[error("Chunk {0} failed verification")]
    ChunkFailed(u64),

    #[error("Merkle tree error: {0}")]
    MerkleError(String),
}

/// Result of verification
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VerificationResult {
    /// Whether the content passed verification
    pub verified: bool,
    /// Total bytes verified
    pub bytes_verified: u64,
    /// Actual hash computed
    pub actual_hash: [u8; 32],
    /// Expected hash
    pub expected_hash: [u8; 32],
    /// Number of chunks verified
    pub chunks_verified: u64,
}

impl VerificationResult {
    /// Check if verification succeeded
    #[must_use]
    #[inline]
    pub const fn is_verified(&self) -> bool {
        self.verified
    }

    /// Get the hash mismatch if verification failed
    #[must_use]
    #[inline]
    pub fn hash_mismatch(&self) -> Option<([u8; 32], [u8; 32])> {
        if !self.verified {
            Some((self.expected_hash, self.actual_hash))
        } else {
            None
        }
    }
}

/// Progress information for streaming verification
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VerificationProgress {
    /// Bytes processed so far
    pub bytes_processed: u64,
    /// Total bytes expected (None if unknown)
    pub total_bytes: Option<u64>,
    /// Number of chunks processed
    pub chunks_processed: u64,
    /// Percentage complete (0.0 to 100.0)
    pub percentage: f64,
}

impl VerificationProgress {
    /// Check if verification is complete
    #[must_use]
    #[inline]
    pub fn is_complete(&self) -> bool {
        if let Some(total) = self.total_bytes {
            self.bytes_processed >= total
        } else {
            false
        }
    }
}

/// Streaming content verifier using BLAKE3
pub struct StreamingVerifier {
    /// BLAKE3 hasher for streaming hash computation
    hasher: IncrementalHasher,
    /// Expected root hash
    expected_hash: [u8; 32],
    /// Total bytes processed
    bytes_processed: u64,
    /// Expected total bytes (None if unknown)
    total_bytes: Option<u64>,
    /// Chunks processed
    chunks_processed: u64,
}

impl StreamingVerifier {
    /// Create a new streaming verifier with expected hash
    #[must_use]
    pub fn new(expected_hash: [u8; 32]) -> Self {
        Self {
            hasher: IncrementalHasher::new(),
            expected_hash,
            bytes_processed: 0,
            total_bytes: None,
            chunks_processed: 0,
        }
    }

    /// Create a verifier with known total size
    #[must_use]
    pub fn with_size(expected_hash: [u8; 32], total_bytes: u64) -> Self {
        Self {
            hasher: IncrementalHasher::new(),
            expected_hash,
            bytes_processed: 0,
            total_bytes: Some(total_bytes),
            chunks_processed: 0,
        }
    }

    /// Update the hash with new data
    pub fn update(&mut self, data: &[u8]) {
        self.hasher.update(data);
        self.bytes_processed += data.len() as u64;
        self.chunks_processed += 1;
    }

    /// Get current verification progress
    #[must_use]
    #[inline]
    pub fn progress(&self) -> VerificationProgress {
        let percentage = if let Some(total) = self.total_bytes {
            if total > 0 {
                (self.bytes_processed as f64 / total as f64) * 100.0
            } else {
                100.0
            }
        } else {
            0.0
        };

        VerificationProgress {
            bytes_processed: self.bytes_processed,
            total_bytes: self.total_bytes,
            chunks_processed: self.chunks_processed,
            percentage,
        }
    }

    /// Finalize the hash and verify
    pub fn finalize(self) -> Result<VerificationResult, VerificationError> {
        let actual_hash: [u8; 32] = self.hasher.finalize();
        let verified = actual_hash == self.expected_hash;

        if !verified {
            return Err(VerificationError::HashMismatch {
                expected: self.expected_hash,
                actual: actual_hash,
            });
        }

        Ok(VerificationResult {
            verified,
            bytes_verified: self.bytes_processed,
            actual_hash,
            expected_hash: self.expected_hash,
            chunks_verified: self.chunks_processed,
        })
    }

    /// Reset the verifier to initial state
    pub fn reset(&mut self) {
        self.hasher = IncrementalHasher::new();
        self.bytes_processed = 0;
        self.chunks_processed = 0;
    }
}

/// Merkle tree-based chunk verifier for parallel verification
pub struct MerkleVerifier {
    /// Expected root hash
    expected_root: [u8; 32],
    /// Chunk hashes (index -> hash)
    chunk_hashes: HashMap<u64, [u8; 32]>,
    /// Chunk size
    chunk_size: usize,
    /// Total chunks expected
    total_chunks: u64,
}

impl MerkleVerifier {
    /// Create a new Merkle verifier
    #[must_use]
    pub fn new(expected_root: [u8; 32], chunk_size: usize, total_chunks: u64) -> Self {
        Self {
            expected_root,
            chunk_hashes: HashMap::new(),
            chunk_size,
            total_chunks,
        }
    }

    /// Create a Merkle verifier with default chunk size (256 KB)
    #[must_use]
    pub fn with_default_chunk_size(expected_root: [u8; 32], total_chunks: u64) -> Self {
        Self::new(expected_root, MERKLE_CHUNK_SIZE, total_chunks)
    }

    /// Verify a single chunk and record its hash
    pub fn verify_chunk(&mut self, chunk_index: u64, data: &[u8]) -> Result<(), VerificationError> {
        // Compute chunk hash
        let chunk_hash: [u8; 32] = hash(data);

        // Store the hash for later Merkle tree verification
        self.chunk_hashes.insert(chunk_index, chunk_hash);

        Ok(())
    }

    /// Build Merkle tree from chunk hashes and verify root
    pub fn verify_merkle_root(&self) -> Result<VerificationResult, VerificationError> {
        if self.chunk_hashes.len() as u64 != self.total_chunks {
            return Err(VerificationError::Incomplete(
                self.chunk_hashes.len() as u64,
                self.total_chunks,
            ));
        }

        // Build Merkle tree bottom-up
        let mut current_level: Vec<[u8; 32]> = (0..self.total_chunks)
            .map(|i| self.chunk_hashes.get(&i).copied().unwrap_or([0u8; 32]))
            .collect();

        // Build tree upward
        while current_level.len() > 1 {
            let mut next_level = Vec::new();

            for chunk in current_level.chunks(2) {
                let combined_hash = if chunk.len() == 2 {
                    // Combine two hashes
                    let mut combined = [0u8; 64];
                    combined[..32].copy_from_slice(&chunk[0]);
                    combined[32..].copy_from_slice(&chunk[1]);
                    hash(&combined)
                } else {
                    // Odd number of nodes, promote the last one
                    chunk[0]
                };
                next_level.push(combined_hash);
            }

            current_level = next_level;
        }

        let actual_root = current_level[0];
        let verified = actual_root == self.expected_root;

        if !verified {
            return Err(VerificationError::HashMismatch {
                expected: self.expected_root,
                actual: actual_root,
            });
        }

        Ok(VerificationResult {
            verified,
            bytes_verified: (self.total_chunks * self.chunk_size as u64),
            actual_hash: actual_root,
            expected_hash: self.expected_root,
            chunks_verified: self.total_chunks,
        })
    }

    /// Get the number of chunks verified so far
    #[must_use]
    #[inline]
    pub fn chunks_verified(&self) -> u64 {
        self.chunk_hashes.len() as u64
    }

    /// Check if all chunks have been verified
    #[must_use]
    #[inline]
    pub fn is_complete(&self) -> bool {
        self.chunk_hashes.len() as u64 == self.total_chunks
    }

    /// Get verification progress
    #[must_use]
    pub fn progress(&self) -> VerificationProgress {
        let chunks_verified = self.chunk_hashes.len() as u64;
        let percentage = if self.total_chunks > 0 {
            (chunks_verified as f64 / self.total_chunks as f64) * 100.0
        } else {
            0.0
        };

        VerificationProgress {
            bytes_processed: chunks_verified * self.chunk_size as u64,
            total_bytes: Some(self.total_chunks * self.chunk_size as u64),
            chunks_processed: chunks_verified,
            percentage,
        }
    }
}

/// Checkpoint for resumable verification
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VerificationCheckpoint {
    /// Bytes processed so far
    pub bytes_processed: u64,
    /// Chunks processed
    pub chunks_processed: u64,
    /// Partial hash state (serialized)
    pub hash_state: Vec<u8>,
}

impl VerificationCheckpoint {
    /// Create a checkpoint from current state
    #[must_use]
    pub fn new(bytes_processed: u64, chunks_processed: u64) -> Self {
        Self {
            bytes_processed,
            chunks_processed,
            hash_state: Vec::new(), // BLAKE3 doesn't support state serialization
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_streaming_verifier_success() {
        let data = b"Hello, World!";
        let expected_hash: [u8; 32] = hash(data);

        let mut verifier = StreamingVerifier::new(expected_hash);
        verifier.update(data);

        let result = verifier.finalize().unwrap();
        assert!(result.verified);
        assert_eq!(result.bytes_verified, data.len() as u64);
    }

    #[test]
    fn test_streaming_verifier_incremental() {
        let part1 = b"Hello, ";
        let part2 = b"World!";
        let full_data = b"Hello, World!";
        let expected_hash: [u8; 32] = hash(full_data);

        let mut verifier = StreamingVerifier::new(expected_hash);
        verifier.update(part1);
        verifier.update(part2);

        let result = verifier.finalize().unwrap();
        assert!(result.verified);
        assert_eq!(result.bytes_verified, full_data.len() as u64);
        assert_eq!(result.chunks_verified, 2);
    }

    #[test]
    fn test_streaming_verifier_mismatch() {
        let data = b"Hello, World!";
        let wrong_hash = [0u8; 32];

        let mut verifier = StreamingVerifier::new(wrong_hash);
        verifier.update(data);

        let result = verifier.finalize();
        assert!(result.is_err());
    }

    #[test]
    fn test_streaming_verifier_progress() {
        let data = b"Hello, World!";
        let expected_hash: [u8; 32] = hash(data);

        let mut verifier = StreamingVerifier::with_size(expected_hash, data.len() as u64);
        verifier.update(&data[..5]);

        let progress = verifier.progress();
        assert_eq!(progress.bytes_processed, 5);
        assert_eq!(progress.total_bytes, Some(data.len() as u64));
        assert!(!progress.is_complete());

        verifier.update(&data[5..]);

        let progress = verifier.progress();
        assert!(progress.is_complete());
        assert_eq!(progress.percentage, 100.0);
    }

    #[test]
    fn test_merkle_verifier_single_chunk() {
        let data = b"Hello, World!";
        let chunk_hash: [u8; 32] = hash(data);

        let mut verifier = MerkleVerifier::new(chunk_hash, 1024, 1);
        verifier.verify_chunk(0, data).unwrap();

        assert!(verifier.is_complete());
        let result = verifier.verify_merkle_root().unwrap();
        assert!(result.verified);
    }

    #[test]
    fn test_merkle_verifier_multiple_chunks() {
        let chunk1 = b"Hello, ";
        let chunk2 = b"World!";

        // Compute expected root
        let hash1: [u8; 32] = hash(chunk1);
        let hash2: [u8; 32] = hash(chunk2);
        let mut combined = [0u8; 64];
        combined[..32].copy_from_slice(&hash1);
        combined[32..].copy_from_slice(&hash2);
        let root: [u8; 32] = hash(&combined);

        let mut verifier = MerkleVerifier::new(root, 1024, 2);
        verifier.verify_chunk(0, chunk1).unwrap();
        verifier.verify_chunk(1, chunk2).unwrap();

        assert_eq!(verifier.chunks_verified(), 2);
        assert!(verifier.is_complete());

        let result = verifier.verify_merkle_root().unwrap();
        assert!(result.verified);
    }

    #[test]
    fn test_merkle_verifier_incomplete() {
        let data = b"Hello, World!";
        let chunk_hash: [u8; 32] = hash(data);

        let mut verifier = MerkleVerifier::new(chunk_hash, 1024, 2);
        verifier.verify_chunk(0, data).unwrap();

        assert!(!verifier.is_complete());
        assert_eq!(verifier.chunks_verified(), 1);

        let result = verifier.verify_merkle_root();
        assert!(result.is_err());
    }

    #[test]
    fn test_merkle_verifier_progress() {
        let chunk1 = b"Hello";
        let chunk_hash: [u8; 32] = hash(chunk1);

        let mut verifier = MerkleVerifier::with_default_chunk_size(chunk_hash, 4);
        verifier.verify_chunk(0, chunk1).unwrap();

        let progress = verifier.progress();
        assert_eq!(progress.chunks_processed, 1);
        assert_eq!(progress.percentage, 25.0);
    }

    #[test]
    fn test_streaming_verifier_reset() {
        let data = b"Hello, World!";
        let expected_hash: [u8; 32] = hash(data);

        let mut verifier = StreamingVerifier::new(expected_hash);
        verifier.update(data);

        verifier.reset();

        assert_eq!(verifier.bytes_processed, 0);
        assert_eq!(verifier.chunks_processed, 0);
    }

    #[test]
    fn test_verification_result_helpers() {
        let result = VerificationResult {
            verified: false,
            bytes_verified: 100,
            actual_hash: [1u8; 32],
            expected_hash: [2u8; 32],
            chunks_verified: 10,
        };

        assert!(!result.is_verified());
        assert!(result.hash_mismatch().is_some());
        let (expected, actual) = result.hash_mismatch().unwrap();
        assert_eq!(expected, [2u8; 32]);
        assert_eq!(actual, [1u8; 32]);
    }
}