wt_blk 0.2.0

Parser and unpacker for the BLK file format
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

use std::fmt::{Display, Formatter};

use color_eyre::{eyre::bail, Report};

#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
#[allow(non_camel_case_types)]
pub enum HeaderType {
	// Simple header format
	VRFS = 0x73465256, // bitrepr as b"VRFs"

	// Extended header format
	VRFX = 0x78465256, // bitrepr as b"VRFx"
}

impl HeaderType {
	pub fn is_extended(self) -> bool {
		self == HeaderType::VRFX
	}
}

impl Display for HeaderType {
	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
		write!(
			f,
			"{}",
			match self {
				HeaderType::VRFS => {
					"Base header"
				},
				HeaderType::VRFX => {
					"Extended header"
				},
			}
		)
	}
}

impl TryFrom<u32> for HeaderType {
	type Error = Report;

	fn try_from(value: u32) -> Result<Self, Self::Error> {
		return match value {
			0x73465256 => Ok(Self::VRFS),
			0x78465256 => Ok(Self::VRFX),
			_ => bail!("Unknown header type: {value:X}"),
		};
	}
}

#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub enum PlatformType {
	// b'\x00\x00PC'
	Pc      = 0x43500000,

	// b'\x00iOS'
	Ios     = 0x534F6900,

	// b'\x00and'
	Android = 0x646E6100,
}

impl Display for PlatformType {
	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
		write!(
			f,
			"{}",
			match self {
				PlatformType::Pc => {
					"Pc"
				},
				PlatformType::Ios => {
					"Ios"
				},
				PlatformType::Android => {
					"Android"
				},
			}
		)
	}
}

impl TryFrom<u32> for PlatformType {
	type Error = Report;

	fn try_from(value: u32) -> Result<Self, Self::Error> {
		return match value {
			0x43500000 => Ok(Self::Pc),
			0x534F6900 => Ok(Self::Ios),
			0x646E6100 => Ok(Self::Android),
			_ => bail!("Unknown platform {value:X}"),
		};
	}
}

#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
#[allow(non_camel_case_types)]
pub enum Packing {
	// ZSTD compressed and obfuscated. No digest
	ZSTD_OBFS_NOCHECK = 0x10,

	// Image in plain form. With digest
	PLAIN             = 0x20,

	// Same as ZSTD_OBFS_NOCHECK except with digest
	ZSTD_OBFS         = 0x30,
}

impl Packing {
	pub fn is_obfuscated(&self) -> bool {
		match self {
			Packing::ZSTD_OBFS_NOCHECK => true,
			Packing::PLAIN => false,
			Packing::ZSTD_OBFS => true,
		}
	}

	pub fn is_compressed(&self) -> bool {
		match self {
			Packing::ZSTD_OBFS_NOCHECK => true,
			Packing::PLAIN => false,
			Packing::ZSTD_OBFS => true,
		}
	}
}

impl TryFrom<u8> for Packing {
	type Error = Report;

	fn try_from(value: u8) -> Result<Self, Self::Error> {
		return match value {
			0x10 => Ok(Self::ZSTD_OBFS_NOCHECK),
			0x20 => Ok(Self::PLAIN),
			0x30 => Ok(Self::ZSTD_OBFS),
			_ => bail!("Unknown packing type: {value:X}"),
		};
	}
}