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
|
// Copyright 2021 Colin Finck <colin@reactos.org>
// SPDX-License-Identifier: GPL-2.0-or-later
use crate::attribute_value::NtfsNonResidentAttributeValue;
use crate::error::{NtfsError, Result};
use crate::index_entry::{IndexNodeEntryRanges, NtfsIndexNodeEntries};
use crate::record::Record;
use crate::record::RecordHeader;
use crate::traits::NtfsReadSeek;
use crate::types::Vcn;
use binread::io::{Read, Seek};
use byteorder::{ByteOrder, LittleEndian};
use core::ops::Range;
use memoffset::offset_of;
/// Size of all [`IndexRecordHeader`] fields.
const INDEX_RECORD_HEADER_SIZE: u32 = 24;
#[repr(C, packed)]
struct IndexRecordHeader {
record_header: RecordHeader,
vcn: i64,
}
/// Size of all [`IndexNodeHeader`] fields plus some reserved bytes.
pub(crate) const INDEX_NODE_HEADER_SIZE: usize = 16;
#[repr(C, packed)]
pub(crate) struct IndexNodeHeader {
pub(crate) entries_offset: u32,
pub(crate) index_size: u32,
pub(crate) allocated_size: u32,
pub(crate) flags: u8,
}
#[derive(Debug)]
pub struct NtfsIndexRecord<'n> {
record: Record<'n>,
}
const HAS_SUBNODES_FLAG: u8 = 0x01;
impl<'n> NtfsIndexRecord<'n> {
pub(crate) fn new<T>(
fs: &mut T,
mut value: NtfsNonResidentAttributeValue<'n, '_>,
index_record_size: u32,
) -> Result<Self>
where
T: Read + Seek,
{
// The caller must have checked that value.stream_position() < value.len(),
// so that value.data_position() returns a value.
let data_position = value.data_position().unwrap();
let mut data = vec![0; index_record_size as usize];
value.read_exact(fs, &mut data)?;
let mut record = Record::new(value.ntfs(), data, data_position);
record.fixup()?;
let index_record = Self { record };
index_record.validate_signature()?;
index_record.validate_sizes()?;
Ok(index_record)
}
pub fn entries<'r>(&'r self) -> Result<NtfsIndexNodeEntries<'r>> {
let (entries_range, position) = self.entries_range_and_position();
let data = &self.record.data()[entries_range];
Ok(NtfsIndexNodeEntries::new(data, position))
}
fn entries_range_and_position(&self) -> (Range<usize>, u64) {
let start = INDEX_RECORD_HEADER_SIZE as usize + self.index_entries_offset() as usize;
let end = INDEX_RECORD_HEADER_SIZE as usize + self.index_used_size() as usize;
let position = self.record.position() + start as u64;
(start..end, position)
}
/// Returns whether this index node has sub-nodes.
/// Otherwise, this index node is a leaf node.
pub fn has_subnodes(&self) -> bool {
let start = INDEX_RECORD_HEADER_SIZE as usize + offset_of!(IndexNodeHeader, flags);
let flags = self.record.data()[start];
(flags & HAS_SUBNODES_FLAG) != 0
}
pub fn index_allocated_size(&self) -> u32 {
let start = INDEX_RECORD_HEADER_SIZE as usize + offset_of!(IndexNodeHeader, allocated_size);
LittleEndian::read_u32(&self.record.data()[start..])
}
pub(crate) fn index_entries_offset(&self) -> u32 {
let start = INDEX_RECORD_HEADER_SIZE as usize + offset_of!(IndexNodeHeader, entries_offset);
LittleEndian::read_u32(&self.record.data()[start..])
}
pub fn index_used_size(&self) -> u32 {
let start = INDEX_RECORD_HEADER_SIZE as usize + offset_of!(IndexNodeHeader, index_size);
LittleEndian::read_u32(&self.record.data()[start..])
}
pub(crate) fn into_entry_ranges(self) -> IndexNodeEntryRanges {
let (entries_range, position) = self.entries_range_and_position();
IndexNodeEntryRanges::new(self.record.into_data(), entries_range, position)
}
fn validate_signature(&self) -> Result<()> {
let signature = &self.record.signature();
let expected = b"INDX";
if signature == expected {
Ok(())
} else {
Err(NtfsError::InvalidIndexSignature {
position: self.record.position(),
expected,
actual: *signature,
})
}
}
fn validate_sizes(&self) -> Result<()> {
let index_record_size = self.record.len() as u32;
// The total size allocated for this index record must not be larger than
// the size defined for all index records of this index.
let total_allocated_size = INDEX_RECORD_HEADER_SIZE + self.index_allocated_size();
if total_allocated_size > index_record_size {
return Err(NtfsError::InvalidIndexAllocatedSize {
position: self.record.position(),
expected: index_record_size,
actual: total_allocated_size,
});
}
// Furthermore, the total used size for this index record must not be
// larger than the total allocated size.
let total_used_size = INDEX_RECORD_HEADER_SIZE + self.index_used_size();
if total_used_size > total_allocated_size {
return Err(NtfsError::InvalidIndexUsedSize {
position: self.record.position(),
expected: total_allocated_size,
actual: total_used_size,
});
}
Ok(())
}
pub fn vcn(&self) -> Vcn {
let start = offset_of!(IndexRecordHeader, vcn);
Vcn::from(LittleEndian::read_i64(&self.record.data()[start..]))
}
}
|
