payload_dumper 0.8.1

A fast and efficient Android OTA payload dumper library and CLI
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

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 rhythmcache
// https://github.com/rhythmcache/payload-dumper-rust

use serde::Serialize;

#[derive(Serialize, Clone)]
pub struct ExtentInfo {
    pub start_block: u64,
    pub num_blocks: u64,
}

#[derive(Serialize)]
pub struct PartitionInfoDetails {
    pub size: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hash: Option<String>,
}

#[derive(Serialize)]
pub struct SignatureInfo {
    // #[serde(skip_serializing_if = "Option::is_none")]
    // pub version: Option<u32>, // deprecated
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<String>, // hex encoded
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unpadded_signature_size: Option<u32>,
}

#[derive(Serialize)]
pub struct InstallOperationInfo {
    pub operation_type: String,
    pub operation_index: usize,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data_offset: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data_length: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data_length_readable: Option<String>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub src_extents: Vec<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub src_length: Option<u64>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub dst_extents: Vec<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dst_length: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data_sha256_hash: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub src_sha256_hash: Option<String>,
}

#[derive(Serialize)]
pub struct OperationTypeStats {
    pub operation_type: String,
    pub count: usize,
    pub total_data_size: u64,
}

#[derive(Serialize)]
pub struct MergeOperationInfo {
    pub operation_type: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub src_extent: Option<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dst_extent: Option<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub src_offset: Option<u32>,
}

#[derive(Serialize)]
pub struct PartitionMetadata {
    pub partition_name: String,
    pub size_in_blocks: u64,
    pub size_in_bytes: u64,
    pub size_readable: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hash: Option<String>,
    pub start_offset: u64,
    pub end_offset: u64,
    pub data_offset: u64,
    pub partition_type: String,
    pub operations_count: usize,
    pub compression_type: String,
    pub encryption: String,
    pub block_size: u64,
    pub total_blocks: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub run_postinstall: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postinstall_path: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filesystem_type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postinstall_optional: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hash_tree_algorithm: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,

    // detailed partition info
    #[serde(skip_serializing_if = "Option::is_none")]
    pub old_partition_info: Option<PartitionInfoDetails>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hash_tree_salt: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hash_tree_data_extent: Option<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hash_tree_extent: Option<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fec_data_extent: Option<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fec_extent: Option<ExtentInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fec_roots: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub estimate_cow_size: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub estimate_cow_size_readable: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub estimate_op_count_max: Option<u64>,

    // complete operations list with all details
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub operations: Vec<InstallOperationInfo>,

    // merge operations
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub merge_operations: Vec<MergeOperationInfo>,
    pub merge_operations_count: usize,

    // signatures
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub new_partition_signatures: Vec<SignatureInfo>,
    pub signature_count: usize,

    // statistics
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub operation_type_stats: Vec<OperationTypeStats>,
    pub total_data_size: u64,
    pub total_data_size_readable: String,
    pub num_src_extents: usize,
    pub num_dst_extents: usize,
}

#[derive(Serialize)]
pub struct DynamicPartitionGroupInfo {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub size: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub size_readable: Option<String>,
    pub partition_names: Vec<String>,
    pub partition_count: usize,
}

#[derive(Serialize)]
pub struct VabcFeatureSetInfo {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub threaded: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub batch_writes: Option<bool>,
}

#[derive(Serialize)]
pub struct DynamicPartitionInfo {
    pub groups: Vec<DynamicPartitionGroupInfo>,
    pub groups_count: usize,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub snapshot_enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vabc_enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vabc_compression_param: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cow_version: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vabc_feature_set: Option<VabcFeatureSetInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub compression_factor: Option<u64>,
}

#[derive(Serialize)]
pub struct ApexInfoMetadata {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub package_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_compressed: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub decompressed_size: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub decompressed_size_readable: Option<String>,
}

#[derive(Serialize)]
pub struct PayloadMetadata {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub security_patch_level: Option<String>,
    pub block_size: u32,
    pub minor_version: u32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_timestamp: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dynamic_partition_metadata: Option<DynamicPartitionInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub partial_update: Option<bool>,
    pub apex_info: Vec<ApexInfoMetadata>,
    pub apex_info_count: usize,
    pub partitions: Vec<PartitionMetadata>,
    pub partitions_count: usize,

    // manifest-level fields
    #[serde(skip_serializing_if = "Option::is_none")]
    pub signatures_offset: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub signatures_size: Option<u64>,

    // computed statistics
    pub total_payload_size: u64,
    pub total_payload_size_readable: String,
    pub total_operations_count: usize,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub global_operation_stats: Vec<OperationTypeStats>,
}