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
use gix_error::{Result, corruption, message};
use std::sync::atomic::AtomicBool;
use gix_error::{ResultExt, bail};
use gix_object::WriteTo;
use gix_object::bstr::ByteSlice;
use gix_utils::progress::{DynNestedProgress, Progress};
use crate::index;
///
pub mod integrity {
use std::marker::PhantomData;
/// Returned by [`index::File::verify_integrity()`][crate::index::File::verify_integrity()].
pub struct Outcome {
/// The computed checksum of the index which matched the stored one.
pub actual_index_checksum: gix_hash::ObjectId,
/// The packs traversal outcome, if one was provided
pub pack_traverse_statistics: Option<crate::index::traverse::Statistics>,
}
/// Additional options to define how the integrity should be verified.
#[derive(Clone)]
pub struct Options<F> {
/// The thoroughness of the verification
pub verify_mode: crate::index::verify::Mode,
/// The way to traverse packs
pub traversal: crate::index::traverse::Algorithm,
/// The amount of threads to use of `Some(N)`, with `None|Some(0)` using all available cores are used.
pub thread_limit: Option<usize>,
/// A function to create a pack cache
pub make_pack_lookup_cache: F,
}
impl Default for Options<fn() -> crate::cache::Never> {
fn default() -> Self {
Options {
verify_mode: Default::default(),
traversal: Default::default(),
thread_limit: None,
make_pack_lookup_cache: || crate::cache::Never,
}
}
}
/// The progress ids used in [`index::File::verify_integrity()`][crate::index::File::verify_integrity()].
///
/// Use this information to selectively extract the progress of interest in case the parent application has custom visualization.
#[derive(Debug, Copy, Clone)]
pub enum ProgressId {
/// The amount of bytes read to verify the index checksum.
ChecksumBytes,
/// A root progress for traversal which isn't actually used directly, but here to link to the respective `ProgressId` types.
Traverse(PhantomData<crate::index::verify::index::traverse::ProgressId>),
}
impl From<ProgressId> for gix_utils::progress::Id {
fn from(v: ProgressId) -> Self {
match v {
ProgressId::ChecksumBytes => *b"PTHI",
ProgressId::Traverse(_) => gix_utils::progress::UNKNOWN,
}
}
}
}
/// Various ways in which a pack and index can be verified
#[derive(Default, Debug, Eq, PartialEq, Hash, Clone, Copy)]
pub enum Mode {
/// Validate the object hash and CRC32
HashCrc32,
/// Validate hash and CRC32, and decode each non-Blob object.
/// Each object should be valid, i.e. be decodable.
HashCrc32Decode,
/// Validate hash and CRC32, and decode and encode each non-Blob object.
/// Each object should yield exactly the same hash when re-encoded.
#[default]
HashCrc32DecodeEncode,
}
/// Information to allow verifying the integrity of an index with the help of its corresponding pack.
pub struct PackContext<'a, F, D = crate::MMap> {
/// The pack data file itself.
pub data: &'a crate::data::File<D>,
/// The options further configuring the pack traversal and verification
pub options: integrity::Options<F>,
}
/// Verify and validate the content of the index file
impl<T> index::File<T>
where
T: crate::FileData + Sync,
{
/// Returns the trailing hash stored at the end of this index file.
///
/// It's a hash over all bytes of the index.
pub fn index_checksum(&self) -> gix_hash::ObjectId {
gix_hash::ObjectId::from_bytes_or_panic(&self.data[self.data.len() - self.hash_len..])
}
/// Returns the hash of the pack data file that this index file corresponds to.
///
/// It should [`crate::data::File::checksum()`] of the corresponding pack data file.
pub fn pack_checksum(&self) -> gix_hash::ObjectId {
let from = self.data.len() - self.hash_len * 2;
gix_hash::ObjectId::from_bytes_or_panic(&self.data[from..][..self.hash_len])
}
/// Validate that our [`index_checksum()`][index::File::index_checksum()] matches the actual contents
/// of this index file, and return it if it does.
pub fn verify_checksum(
&self,
progress: &mut dyn Progress,
should_interrupt: &AtomicBool,
) -> Result<gix_hash::ObjectId> {
crate::verify::checksum_on_disk_or_mmap(
self.path(),
&self.data,
self.index_checksum(),
self.object_hash,
progress,
should_interrupt,
)
}
/// The most thorough validation of integrity of both index file and the corresponding pack data file, if provided.
/// Returns the checksum of the index file, the traversal outcome and the given progress if the integrity check is successful.
///
/// If `pack` is provided, it is expected (and validated to be) the pack belonging to this index.
/// It will be used to validate internal integrity of the pack before checking each objects integrity
/// is indeed as advertised via its SHA1 as stored in this index, as well as the CRC32 hash.
/// The last member of the Option is a function returning an implementation of [`crate::cache::DecodeEntry`] to be used if
/// the [`index::traverse::Algorithm`] is `Lookup`.
/// To set this to `None`, use `None::<(_, _, _, fn() -> crate::cache::Never)>`.
///
/// The `thread_limit` optionally specifies the amount of threads to be used for the [pack traversal][index::File::traverse()].
/// `make_cache` is only used in case a `pack` is specified, use existing implementations in the [`crate::cache`] module.
///
/// # Tradeoffs
///
/// The given `progress` is inevitably consumed if there is an error, which is a tradeoff chosen to easily allow using `?` in the
/// error case.
pub fn verify_integrity<C, F, D>(
&self,
pack: Option<PackContext<'_, F, D>>,
progress: &mut dyn DynNestedProgress,
should_interrupt: &AtomicBool,
) -> Result<integrity::Outcome>
where
C: crate::cache::DecodeEntry,
F: Fn() -> C + Send + Clone,
D: crate::FileData + Send + Sync,
{
if let Some(first_invalid) = crate::verify::fan(&self.fan) {
bail!(corruption(format!(
"The fan at index {first_invalid} is out of order as it's larger then the following value."
)));
}
match pack {
Some(PackContext {
data: pack,
options:
integrity::Options {
verify_mode,
traversal,
thread_limit,
make_pack_lookup_cache,
},
}) => self
.traverse(
pack,
progress,
should_interrupt,
{
let mut encode_buf = Vec::with_capacity(2048);
move |kind, data, index_entry, progress| {
Self::verify_entry(verify_mode, &mut encode_buf, kind, data, index_entry, progress)
}
},
index::traverse::Options {
traversal,
thread_limit,
check: index::traverse::SafetyCheck::All,
alloc_limit_bytes: pack.alloc_limit_bytes,
make_pack_lookup_cache,
},
)
.map(|o| integrity::Outcome {
actual_index_checksum: o.actual_index_checksum,
pack_traverse_statistics: Some(o.statistics),
}),
None => self
.verify_checksum(
&mut progress
.add_child_with_id("checksum of index".into(), integrity::ProgressId::ChecksumBytes.into()),
should_interrupt,
)
.map(|id| integrity::Outcome {
actual_index_checksum: id,
pack_traverse_statistics: None,
}),
}
}
#[allow(clippy::too_many_arguments)]
fn verify_entry(
verify_mode: Mode,
encode_buf: &mut Vec<u8>,
object_kind: gix_object::Kind,
buf: &[u8],
index_entry: &index::Entry,
_progress: &dyn gix_utils::progress::Progress,
) -> Result {
if let Mode::HashCrc32Decode | Mode::HashCrc32DecodeEncode = verify_mode {
use gix_object::Kind::*;
match object_kind {
Tree | Commit | Tag => {
let object =
gix_object::ObjectRef::from_bytes(buf, object_kind, index_entry.oid.kind()).or_raise(|| {
message!("{object_kind} object {} could not be decoded", index_entry.oid).corrupted()
})?;
if let Mode::HashCrc32DecodeEncode = verify_mode {
encode_buf.clear();
object
.write_to(&mut *encode_buf)
.or_raise(|| corruption("Reserialization of an object failed"))?;
if encode_buf.as_slice() != buf {
bail!(corruption(format!(
"{object_kind} object {} wasn't re-encoded without change, wanted\n{}\n\nGOT\n\n{}",
index_entry.oid,
buf.as_bstr(),
encode_buf.as_bstr()
)));
}
}
}
Blob => {}
}
}
Ok(())
}
}