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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
use crate::err::{self, Result};

use crate::attr_x10::StandardInfoAttr;
use crate::attr_x30::FileNameAttr;
use crate::enumerator::PathMapping;
use crate::mft::MftHandler;
use crate::{attribute, ReadSeek};
use log::debug;
use snafu::ensure;

use std::collections::BTreeMap;

use winstructs::reference::MftReference;

use byteorder::{LittleEndian, ReadBytesExt};

use bitflags::bitflags;
use serde::{ser, Serialize};

use crate::attribute::MftAttribute;
use std::io::Cursor;
use std::io::Read;
use std::io::Seek;
use std::io::SeekFrom;

//https://github.com/libyal/libfsntfs/blob/master/documentation/New%20Technologies%20File%20System%20(NTFS).asciidoc#5-the-master-file-table-mft

bitflags! {
    pub struct EntryFlags: u16 {
        const ALLOCATED     = 0x01;
        const INDEX_PRESENT = 0x02;
        const UNKNOWN_1     = 0x04;
        const UNKNOWN_2     = 0x08;
    }
}
pub fn serialize_entry_flags<S>(
    item: &EntryFlags,
    serializer: S,
) -> ::std::result::Result<S::Ok, S::Error>
where
    S: ser::Serializer,
{
    serializer.serialize_str(&format!("{:?}", item))
}

#[derive(Serialize, Debug)]
pub struct EntryHeader {
    pub signature: u32,
    #[serde(skip_serializing)]
    pub usa_offset: u16,
    #[serde(skip_serializing)]
    pub usa_size: u16,
    pub logfile_sequence_number: u64,
    #[serde(skip_serializing)]
    pub sequence: u16,
    pub hard_link_count: u16,
    #[serde(skip_serializing)]
    pub fst_attr_offset: u16,
    #[serde(serialize_with = "serialize_entry_flags")]
    pub flags: EntryFlags,
    #[serde(skip_serializing)]
    pub entry_size_real: u32,
    #[serde(skip_serializing)]
    pub entry_size_allocated: u32,
    pub base_reference: MftReference,
    #[serde(skip_serializing)]
    pub next_attribute_id: u16,
    #[serde(skip_serializing)]
    pub record_number: u64,
    pub update_sequence_value: u32,
    pub entry_reference: MftReference,
}

impl EntryHeader {
    pub fn from_reader<R: Read>(reader: &mut R, _entry: u64) -> Result<EntryHeader> {
        let signature = reader.read_u32::<LittleEndian>()?;

        ensure!(
            signature == 1_162_627_398,
            err::InvalidEntrySignature { bad_sig: signature }
        );

        let usa_offset = reader.read_u16::<LittleEndian>()?;
        let usa_size = reader.read_u16::<LittleEndian>()?;
        let logfile_sequence_number = reader.read_u64::<LittleEndian>()?;
        let sequence = reader.read_u16::<LittleEndian>()?;
        let hard_link_count = reader.read_u16::<LittleEndian>()?;
        let fst_attr_offset = reader.read_u16::<LittleEndian>()?;
        let flags = EntryFlags::from_bits_truncate(reader.read_u16::<LittleEndian>()?);
        let entry_size_real = reader.read_u32::<LittleEndian>()?;
        let entry_size_allocated = reader.read_u32::<LittleEndian>()?;
        let base_reference = MftReference(reader.read_u64::<LittleEndian>()?);
        let next_attribute_id = reader.read_u16::<LittleEndian>()?;

        ensure!(
            usa_offset == 48,
            err::InvalidUsaOffset { offset: usa_offset }
        );

        let _padding = reader.read_u16::<LittleEndian>()?;
        let record_number = u64::from(reader.read_u32::<LittleEndian>()?);

        let entry_reference = MftReference::get_from_entry_and_seq(record_number as u64, sequence);

        Ok(EntryHeader {
            signature,
            usa_offset,
            usa_size,
            logfile_sequence_number,
            sequence,
            hard_link_count,
            fst_attr_offset,
            flags,
            entry_size_real,
            entry_size_allocated,
            base_reference,
            next_attribute_id,
            record_number,
            update_sequence_value: 0,
            entry_reference,
        })
    }
}

#[derive(Serialize, Debug)]
pub struct MftEntry {
    pub header: EntryHeader,
    pub attributes: Vec<MftAttribute>,
}

impl MftEntry {
    pub fn new(buffer: Vec<u8>, entry: u64) -> Result<MftEntry> {
        debug!("MftEntry `{}` from buffer", entry);
        let mut cursor = Cursor::new(&buffer);
        // Get Header
        let entry_header = EntryHeader::from_reader(&mut cursor, entry)?;

        let attributes = Self::read_attributes(&entry_header, &mut cursor)?;

        Ok(MftEntry {
            header: entry_header,
            attributes,
        })
    }

    pub fn is_allocated(&self) -> bool {
        self.header.flags.bits() & 0x01 != 0
    }

    pub fn is_dir(&self) -> bool {
        self.header.flags.bits() & 0x02 != 0
    }

    pub fn get_pathmap(&self) -> Option<PathMapping> {
        for attribute in self.attributes.iter() {
            if let attribute::AttributeContent::AttrX30(ref attrib) = attribute.content {
                if attrib.namespace != 2 {
                    return Some(PathMapping {
                        name: attrib.name.clone(),
                        parent: MftReference(attrib.parent.0),
                    });
                }
            }
        }

        None
    }

    //    pub fn set_full_names(&mut self, mft_handler: &mut MftHandler) {
    //        if self.attributes.contains_key("0x0030") {
    //            if let Some(attr_list) = self.attributes.get_mut("0x0030") {
    //                for attribute in attr_list.iter_mut() {
    //                    // Check if resident content
    //                    if let attribute::AttributeContent::AttrX30(ref mut attrib) = attribute.content
    //                    {
    //                        // Get fullpath
    //                        let fullpath = mft_handler.get_fullpath(attrib.parent);
    //                        // Set fullname
    //                        let fullname = fullpath + "/" + attrib.name.as_str();
    //                        // Set attribute to fullname
    //                        attrib.fullname = Some(fullname);
    //                    }
    //                }
    //            }
    //        }
    //    }

    //    // TODO: what is this function?
    //    pub fn buffer_fixup(&self, buffer: &mut [u8]) {
    //        let fixup_values = &buffer[(self.header.usa_offset + 2) as usize
    //            ..((self.header.usa_offset + 2) + ((self.header.usa_size - 1) * 2)) as usize]
    //            .to_vec();
    //
    //        for i in 0..(self.header.usa_size - 1) {
    //            let ofs = (i * 512) as usize;
    //            *buffer.get_mut(ofs + 510).unwrap() = fixup_values[i as usize];
    //            *buffer.get_mut(ofs + 511).unwrap() = fixup_values[(i + 1) as usize];
    //        }
    //    }

    fn read_attributes<S: ReadSeek>(
        header: &EntryHeader,
        buffer: &mut S,
    ) -> Result<Vec<MftAttribute>> {
        let mut current_offset = buffer.seek(SeekFrom::Start(u64::from(header.fst_attr_offset)))?;

        let mut attributes = vec![];

        loop {
            let attribute_header = attribute::AttributeHeader::from_stream(buffer)?;

            if attribute_header.attribute_type == 0x00 {
                break;
            }

            match attribute_header.residential_header {
                attribute::ResidentialHeader::Resident(ref header) => {
                    // Create attribute content to parse buffer into
                    // Get attribute contents
                    let attr_content = match attribute_header.attribute_type {
                        0x10 => attribute::AttributeContent::AttrX10(
                            StandardInfoAttr::from_reader(buffer)?,
                        ),
                        0x30 => {
                            attribute::AttributeContent::AttrX30(FileNameAttr::from_reader(buffer)?)
                        }
                        _ => {
                            let mut content_buffer = vec![0; header.data_size as usize];
                            buffer.read_exact(&mut content_buffer)?;

                            attribute::AttributeContent::Raw(attribute::RawAttribute(
                                content_buffer,
                            ))
                        }
                    };

                    attributes.push(attribute::MftAttribute {
                        header: attribute_header.clone(),
                        content: attr_content,
                    });
                }
                attribute::ResidentialHeader::NonResident(_) => {
                    // No content, so push header into attributes
                    attributes.push(attribute::MftAttribute {
                        header: attribute_header.clone(),
                        content: attribute::AttributeContent::None,
                    });
                }
                attribute::ResidentialHeader::None => {
                    // Not sure about this...
                }
            }

            current_offset = buffer.seek(SeekFrom::Start(
                current_offset + u64::from(attribute_header.attribute_size),
            ))?;
        }

        Ok(attributes)
    }
}

#[cfg(test)]
mod tests {
    use super::EntryHeader;
    use std::io::Cursor;

    #[test]
    fn mft_header_test_01() {
        let header_buffer: &[u8] = &[
            0x46, 0x49, 0x4C, 0x45, 0x30, 0x00, 0x03, 0x00, 0xCC, 0xB3, 0x7D, 0x84, 0x0C, 0x00,
            0x00, 0x00, 0x05, 0x00, 0x01, 0x00, 0x38, 0x00, 0x05, 0x00, 0x48, 0x03, 0x00, 0x00,
            0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
            0x00, 0x00, 0xD5, 0x95, 0x00, 0x00, 0x53, 0x57, 0x81, 0x37, 0x00, 0x00, 0x00, 0x00,
        ];

        let entry_header = EntryHeader::from_reader(&mut Cursor::new(header_buffer), 0).unwrap();

        assert_eq!(entry_header.signature, 1_162_627_398);
        assert_eq!(entry_header.usa_offset, 48);
        assert_eq!(entry_header.usa_size, 3);
        assert_eq!(entry_header.logfile_sequence_number, 53_762_438_092);
        assert_eq!(entry_header.sequence, 5);
        assert_eq!(entry_header.hard_link_count, 1);
        assert_eq!(entry_header.fst_attr_offset, 56);
        assert_eq!(entry_header.flags.bits(), 5);
        assert_eq!(entry_header.entry_size_real, 840);
        assert_eq!(entry_header.entry_size_allocated, 1024);
        assert_eq!(entry_header.base_reference.0, 0);
        assert_eq!(entry_header.next_attribute_id, 6);
        assert_eq!(entry_header.record_number, 38357);
    }
}