tibet-zip-core 0.2.1

Core tibet-zip block format, TIBET envelope, and zstd frame handling
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

//! TBZ Manifest: Block 0 of every archive
//!
//! The manifest is the cryptographically signed index of the archive.
//! It declares all blocks, their types, sizes, and JIS authorization levels.
//! Always JIS level 0 (publicly readable).

use crate::JisLevel;
use serde::{Deserialize, Serialize};

/// The manifest — always Block 0, always JIS level 0
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Manifest {
    /// TBZ format version
    pub tbz_version: u8,
    /// Total number of blocks (including manifest)
    pub block_count: u32,
    /// Ed25519 verifying (public) key in hex — used to verify all block signatures
    #[serde(skip_serializing_if = "Option::is_none")]
    pub signing_key: Option<String>,
    /// Per-block metadata
    pub blocks: Vec<BlockEntry>,
    /// Archive structure: flat or deep (nested)
    pub structure: ArchiveStructure,
    /// Total uncompressed size of all data blocks (bomb protection)
    pub total_uncompressed_size: u64,
    /// Maximum nesting depth (only relevant for TBZ-deep)
    pub max_nesting_depth: u8,
    /// Capabilities required to process this archive
    pub capabilities: Vec<String>,
}

/// Metadata for a single block in the manifest
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BlockEntry {
    /// Block index
    pub index: u32,
    /// Block type name
    pub block_type: String,
    /// Compressed size in bytes
    pub compressed_size: u64,
    /// Uncompressed size in bytes
    pub uncompressed_size: u64,
    /// JIS authorization level required
    pub jis_level: JisLevel,
    /// Human-readable description
    pub description: String,
    /// Original file path (for file-based archives)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub path: Option<String>,
}

/// Archive structure type
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ArchiveStructure {
    /// Flat: no nested TBZ blocks
    Flat,
    /// Deep: contains nested TBZ archives (matroesjka)
    Deep { max_depth: u8 },
}

impl Manifest {
    /// Create a new empty manifest
    pub fn new() -> Self {
        Self {
            tbz_version: crate::VERSION,
            block_count: 1, // manifest itself
            signing_key: None,
            blocks: Vec::new(),
            structure: ArchiveStructure::Flat,
            total_uncompressed_size: 0,
            max_nesting_depth: 0,
            capabilities: Vec::new(),
        }
    }

    /// Set the Ed25519 verifying key for this manifest
    pub fn set_signing_key(&mut self, verifying_key: &ed25519_dalek::VerifyingKey) {
        let hex: String = verifying_key.to_bytes().iter().map(|b| format!("{:02x}", b)).collect();
        self.signing_key = Some(hex);
    }

    /// Parse the verifying key from the manifest
    pub fn get_verifying_key(&self) -> Option<ed25519_dalek::VerifyingKey> {
        let hex = self.signing_key.as_ref()?;
        let bytes: Vec<u8> = (0..hex.len())
            .step_by(2)
            .filter_map(|i| u8::from_str_radix(&hex[i..i + 2], 16).ok())
            .collect();
        if bytes.len() != 32 {
            return None;
        }
        let mut key_bytes = [0u8; 32];
        key_bytes.copy_from_slice(&bytes);
        ed25519_dalek::VerifyingKey::from_bytes(&key_bytes).ok()
    }

    /// Add a block entry to the manifest
    pub fn add_block(&mut self, entry: BlockEntry) {
        self.total_uncompressed_size += entry.uncompressed_size;
        self.blocks.push(entry);
        self.block_count = self.blocks.len() as u32 + 1; // +1 for manifest
    }

    /// Get the highest JIS level required by any block
    pub fn max_jis_level(&self) -> JisLevel {
        self.blocks.iter().map(|b| b.jis_level).max().unwrap_or(0)
    }
}

impl Default for Manifest {
    fn default() -> Self {
        Self::new()
    }
}