office-crypto 0.2.0

Pure Rust library to decrypt password-protected MS Office files
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
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
use crate::validate;
use crate::DecryptError::{self, InvalidHeader, InvalidStructure, IoError, Unknown};

use bytemuck::cast_slice;
use derivative::Derivative;
use packed_struct::prelude::*;
use std::collections::HashMap;
use std::fmt;
use std::fs::File;
use std::io::prelude::*;
use std::path::Path;

// https://github.com/decalage2/olefile/blob/master/olefile/olefile.py#L207
const MAGIC: [u8; 8] = [208, 207, 17, 224, 161, 177, 26, 225];
const ZERO_CLSID: [u8; 16] = [0; 16];
const BYTE_ORDER: u16 = 65534;

const DIFSECT: u32 = 0xFFFF_FFFC;
const FATSECT: u32 = 0xFFFF_FFFD;
const ENDOFCHAIN: u32 = 0xFFFF_FFFE;
const FREESECT: u32 = 0xFFFF_FFFF;

const _MAXREGSID: u32 = 0xFFFF_FFFA;
const NOSTREAM: u32 = 0xFFFF_FFFF;

const STGTY_EMPTY: u8 = 0;
const STGTY_STORAGE: u8 = 1;
const STGTY_STREAM: u8 = 2;
const _STGTY_LOCKBYTES: u8 = 3;
const _STGTY_PROPERTY: u8 = 4;
const STGTY_ROOT: u8 = 5;

const UNKNOWN_SIZE: u32 = 0x7FFF_FFFF;

// little-endian
#[derive(PackedStruct, Debug)]
#[packed_struct(endian = "lsb", bit_numbering = "msb0")]
pub struct OleHeader {
    #[packed_field(bytes = "0..=7")]
    magic: [u8; 8],
    #[packed_field(bytes = "8..=23")]
    clsid: [u8; 16],
    #[packed_field(bytes = "24..=25")]
    minor_version: u16,
    #[packed_field(bytes = "26..=27")]
    dll_version: u16,
    #[packed_field(bytes = "28..=29")]
    byte_order: u16,
    #[packed_field(bytes = "30..=31")]
    sector_shift: u16,
    #[packed_field(bytes = "32..=33")]
    mini_sector_shift: u16,
    #[packed_field(bytes = "34..=35")]
    reserved1: u16,
    #[packed_field(bytes = "36..=39")]
    reserved2: u32,
    #[packed_field(bytes = "40..=43")]
    num_dir_sectors: u32,
    #[packed_field(bytes = "44..=47")]
    num_fat_sectors: u32,
    #[packed_field(bytes = "48..=51")]
    first_dir_sector: u32,
    #[packed_field(bytes = "52..=55")]
    transaction_signature_number: u32,
    #[packed_field(bytes = "56..=59")]
    mini_stream_cutoff_size: u32,
    #[packed_field(bytes = "60..=63")]
    first_mini_fat_sector: u32,
    #[packed_field(bytes = "64..=67")]
    num_mini_fat_sectors: u32,
    #[packed_field(bytes = "68..=71")]
    first_difat_sector: u32,
    #[packed_field(bytes = "72..=75")]
    num_difat_sectors: u32,
}

impl OleHeader {
    fn validate_header(&mut self) -> Result<(), DecryptError> {
        validate!(self.magic == MAGIC, InvalidHeader)?;
        validate!(
            self.dll_version == 3 || self.dll_version == 4,
            InvalidHeader
        )?;
        validate!(self.byte_order == BYTE_ORDER, InvalidHeader)?;
        validate!(
            self.sector_shift == 9 || self.sector_shift == 12,
            InvalidHeader
        )?;
        validate!(
            (self.dll_version == 3 && self.sector_shift == 9)
                || (self.dll_version == 4 && self.sector_shift == 12),
            InvalidHeader
        )?;
        validate!(self.mini_sector_shift == 6, InvalidHeader)?;
        validate!(self.reserved1 == 0, InvalidHeader)?;
        validate!(self.reserved2 == 0, InvalidHeader)?;
        validate!(
            self.dll_version == 4 || self.num_dir_sectors == 0,
            InvalidHeader
        )?;
        validate!(self.transaction_signature_number == 0, InvalidHeader)?;
        // TODO set to 4096 if not already
        validate!(self.mini_stream_cutoff_size == 4096, InvalidHeader)?;

        Ok(())
    }
}

#[derive(Debug)]
pub(crate) struct OleFile {
    raw: Vec<u8>,
    header: OleHeader,
    sector_size: u32,
    mini_sector_size: u32,
    nb_sect: u32,
    used_streams_fat: Vec<u32>,
    used_streams_minifat: Vec<u32>,
    // TODO should these be i32 not u32??
    fat: Vec<u32>,
    minifat: Vec<u32>,
    directory_fp: OleStream,
    direntries: Vec<OleDirentry>,
    ministream: Option<OleStream>,
    root_sid: usize,
}

impl OleFile {
    pub fn new(raw: Vec<u8>) -> Result<Self, DecryptError> {
        // u32::MAX bytes = ~4.2GB which i can live with
        let filesize = raw.len() as u32;
        validate!(filesize > 76, InvalidHeader)?;

        let header: [u8; 76] = raw[..76].try_into().unwrap();
        let mut header = OleHeader::unpack(&header).map_err(|_| InvalidHeader)?;
        header.validate_header()?;

        let sector_size = u32::pow(2, header.sector_shift as u32);
        let mini_sector_size = u32::pow(2, header.mini_sector_shift as u32);
        let nb_sect = ((filesize + sector_size - 1) / sector_size) - 1;

        Ok(Self {
            raw,
            header,
            sector_size,
            mini_sector_size,
            nb_sect,
            used_streams_fat: Vec::new(),
            used_streams_minifat: Vec::new(),
            fat: Vec::new(),
            minifat: Vec::new(),
            directory_fp: OleStream::default(),
            direntries: Vec::new(),
            ministream: None,
            root_sid: 0,
        })
    }

    pub fn from_file<P: AsRef<Path>>(filename: P) -> Result<Self, DecryptError> {
        let mut file = File::open(filename).map_err(IoError)?;
        let mut raw: Vec<u8> = Vec::new();
        file.read_to_end(&mut raw).map_err(IoError)?;

        OleFile::new(raw)
    }

    pub fn init(&mut self) -> Result<(), DecryptError> {
        self.check_duplicate_stream(self.header.first_dir_sector, false)?;
        if self.header.num_mini_fat_sectors > 0 {
            // [minifat: false] is not a mistake here
            self.check_duplicate_stream(self.header.first_mini_fat_sector, false)?;
        }
        if self.header.num_difat_sectors > 0 {
            self.check_duplicate_stream(self.header.first_difat_sector, false)?;
        }

        self.load_fat()?;
        self.load_directory(self.header.first_dir_sector)
    }

    // takes a path (e.g. [storage_1, storage_1.2, stream])
    pub fn open_stream(&mut self, path: &[String]) -> Result<OleStream, DecryptError> {
        let node_sid = self.find_stream_sid(path)?;

        self.open_helper(
            self.direntries[node_sid].packed.isect_start,
            self.direntries[node_sid].size,
            false,
        )
    }

    pub fn exists(&self, path: &[String]) -> Result<bool, DecryptError> {
        Ok(path.iter().all(|name|
            self.direntries.iter().any(|item| item.name.to_lowercase() == name.to_lowercase())
        ))
    }

    fn find_stream_sid(&self, path: &[String]) -> Result<usize, DecryptError> {
        // walk direntries red/black tree to find the right stream
        let mut node_sid = self.root_sid;
        for name in path {
            let name_lower = name.to_lowercase();
            node_sid = *self.direntries[node_sid]
                .children_map
                .get(&name_lower)
                .ok_or(InvalidStructure)?;
        }

        validate!(
            self.direntries[node_sid].packed.entry_type == STGTY_STREAM,
            InvalidStructure
        )?;

        Ok(node_sid)
    }

    pub fn write_stream(&mut self, path: &[String], data: &[u8]) -> Result<(), DecryptError> {
        let node_sid = self.find_stream_sid(path)?;

        let start_sector = self.direntries[node_sid].packed.isect_start;
        let stream_size = self.direntries[node_sid].size;

        validate!(data.len() == stream_size as usize, InvalidStructure)?;

        // Write data sector by sector, following the FAT
        let nb_sectors = ((stream_size + self.sector_size as u64 - 1) / self.sector_size as u64) as usize;
        let mut sect = start_sector;
        let mut data_offset = 0usize;

        for _i in 0..nb_sectors {
            if sect == ENDOFCHAIN {
                break;
            }

            let file_offset = ((sect + 1) * self.sector_size) as usize;
            let bytes_to_write = std::cmp::min(
                self.sector_size as usize,
                data.len() - data_offset
            );

            self.raw[file_offset..(file_offset + bytes_to_write)]
                .copy_from_slice(&data[data_offset..(data_offset + bytes_to_write)]);

            data_offset += bytes_to_write;
            sect = self.fat[sect as usize];
        }

        Ok(())
    }

    pub fn to_bytes(&self) -> Result<Vec<u8>, DecryptError> {
        Ok(self.raw.clone())
    }

    fn check_duplicate_stream(
        &mut self,
        first_sect: u32,
        minifat: bool,
    ) -> Result<(), DecryptError> {
        if minifat {
            validate!(
                !self.used_streams_minifat.contains(&first_sect),
                InvalidStructure
            )?;
            self.used_streams_minifat.push(first_sect);
        } else {
            if [DIFSECT, FATSECT, ENDOFCHAIN, FREESECT].contains(&first_sect) {
                return Ok(());
            }
            validate!(
                !self.used_streams_fat.contains(&first_sect),
                InvalidStructure
            )?;
            self.used_streams_fat.push(first_sect);
        }

        Ok(())
    }

    fn load_fat_sect(&mut self, sect: &[u32]) {
        for isect in sect {
            // labeled as JYTHON-WORKAROUND in the olefile code
            // let isect = isect & 0xFFFFFFFF;
            let isect = *isect;
            if isect == ENDOFCHAIN || isect == FREESECT {
                break;
            }
            let start = (self.sector_size * (isect + 1)) as usize;
            let s = &self.raw[start..(start + self.sector_size as usize)];
            let next_fat = sect_to_array(s);
            self.fat.extend_from_slice(next_fat);
        }
    }

    fn load_fat_sect_range(&mut self, sect_start: usize, sect_end: usize) {
        let sect = &self.raw[sect_start..sect_end].to_owned();
        let fat1: &[u32] = sect_to_array(sect);
        self.load_fat_sect(fat1);
    }

    fn load_fat(&mut self) -> Result<(), DecryptError> {
        self.load_fat_sect_range(76, 512);
        // "There's a DIFAT because file is larger than 6.8MB"
        if self.header.num_difat_sectors > 0 {
            validate!(self.header.num_fat_sectors > 109, InvalidStructure)?;
            validate!(
                self.header.first_difat_sector < self.nb_sect,
                InvalidStructure
            )?;
            // "We compute the necessary number of DIFAT sectors :
            // Number of pointers per DIFAT sector = (sectorsize/4)-1
            // (-1 because the last pointer is the next DIFAT sector number)"
            let nb_difat_sectors = (self.sector_size / 4) - 1;
            // "(if 512 bytes: each DIFAT sector = 127 pointers + 1 towards next DIFAT sector)"
            let nb_difat =
                (self.header.num_fat_sectors - 109 + nb_difat_sectors - 1) / nb_difat_sectors;
            validate!(self.header.num_difat_sectors == nb_difat, InvalidStructure)?;

            let mut isect_difat = self.header.first_difat_sector;

            for _ in 0..nb_difat {
                let start = ((self.sector_size) * (isect_difat + 1)) as usize;
                let sector_difat = self.raw[start..(start + self.sector_size as usize)].to_owned();
                let difat = sect_to_array(&sector_difat);

                self.load_fat_sect(&difat[..(nb_difat_sectors as usize)]);
                isect_difat = difat[nb_difat_sectors as usize];
            }

            validate!(
                [ENDOFCHAIN, FREESECT].contains(&isect_difat),
                InvalidStructure
            )?;
        }

        if self.fat.len() as u32 > self.nb_sect {
            self.fat = self.fat[..self.nb_sect as usize].to_vec();
        }

        Ok(())
    }

    fn load_directory(&mut self, sect: u32) -> Result<(), DecryptError> {
        self.directory_fp = self.open_helper(sect, UNKNOWN_SIZE as u64, true)?;
        let max_entries = self.directory_fp.size / 128;
        // build direntries and figure out what struct type each is
        self.direntries = vec![OleDirentry::default(); max_entries as usize];
        self.load_direntry(0)?;
        self.build_storage_tree(self.root_sid)
    }

    fn load_direntry(&mut self, sid: usize) -> Result<usize, DecryptError> {
        validate!(sid < self.direntries.len(), InvalidStructure)?;
        // double reference for OLE stream/storage
        validate!(!self.direntries[sid].used, Unknown)?;

        let start = sid * 128;
        let entry = &self.directory_fp.stream[start..(start + 128)];
        let direntry = OleDirentry::new(entry.try_into().map_err(|_| Unknown)?, sid, self)?;
        self.direntries[sid] = direntry;

        Ok(sid)
    }

    fn load_minifat(&mut self) -> Result<(), DecryptError> {
        // "MiniFAT is stored in a standard  sub-stream, pointed to by a header
        // field.
        // NOTE: there are two sizes to take into account for this stream:
        // 1) Stream size is calculated according to the number of sectors
        //    declared in the OLE header. This allocated stream may be more than
        //    needed to store the actual sector indexes.
        // (self.num_mini_fat_sectors is the number of sectors of size self.sector_size)
        // 2) Actually used size is calculated by dividing the MiniStream size
        //    (given by root entry size) by the size of mini sectors, *4 for
        //    32 bits indexes:"
        let stream_size = (self.header.num_mini_fat_sectors * self.sector_size) as u64;
        let nb_minisectors = (self.direntries[self.root_sid].size + self.mini_sector_size as u64
            - 1)
            / self.mini_sector_size as u64;

        // "This is not really a problem, but may indicate a wrong implementation:"
        // let _used_size = nb_minisectors * 4;
        // assert!(used_size <= stream_size);

        let s = self.open_helper(self.header.first_mini_fat_sector, stream_size, true)?;
        self.minifat = sect_to_array(&s.stream).to_vec();
        self.minifat = self.minifat[..nb_minisectors as usize].to_vec();

        Ok(())
    }

    fn open_helper(
        &mut self,
        start: u32,
        size: u64,
        force_fat: bool,
    ) -> Result<OleStream, DecryptError> {
        if size < self.header.mini_stream_cutoff_size as u64 && !force_fat {
            if self.ministream.is_none() {
                self.load_minifat()?;
                let size_ministream = self.direntries[self.root_sid].size;

                self.ministream = Some(self.open_helper(
                    self.direntries[self.root_sid].packed.isect_start,
                    size_ministream,
                    true,
                )?);
            }

            let mut olestream = OleStream::new(start, size, 0, self.mini_sector_size);
            olestream.init(&self.ministream.as_ref().unwrap().stream, &self.minifat)?;

            Ok(olestream)
        } else {
            let mut olestream = OleStream::new(start, size, self.sector_size, self.sector_size);
            olestream.init(&self.raw, &self.fat)?;

            Ok(olestream)
        }
    }

    fn build_storage_tree(&mut self, direntry_ind: usize) -> Result<(), DecryptError> {
        let sid_child = self.direntries[direntry_ind].packed.sid_child;
        if sid_child != NOSTREAM {
            // "Note from OpenOffice documentation: the safest way is to
            // recreate the tree because some implementations may store broken
            // red-black trees..."
            self.append_children(direntry_ind, sid_child as usize)?;
        }

        Ok(())
    }

    fn append_children(&mut self, parent_sid: usize, child_sid: usize) -> Result<(), DecryptError> {
        if child_sid as u32 == NOSTREAM {
            return Ok(());
        }
        validate!(child_sid < self.direntries.len(), InvalidStructure)?;

        self.load_direntry(child_sid)?;
        // now child is an OleDirentry at self.direntries[child_sid]
        // refer by index so borrow checker stays happy
        validate!(!self.direntries[child_sid].used, InvalidStructure)?;

        self.direntries[child_sid].used = true;
        self.append_children(
            parent_sid,
            self.direntries[child_sid].packed.sid_left as usize,
        )?;
        let name_lower = self.direntries[child_sid].name.to_lowercase();

        validate!(
            !self.direntries[parent_sid]
                .children_map
                .contains_key(&name_lower),
            InvalidStructure
        )?;

        self.direntries[parent_sid].children.push(child_sid);
        self.direntries[parent_sid]
            .children_map
            .insert(name_lower, child_sid);

        self.append_children(
            parent_sid,
            self.direntries[child_sid].packed.sid_right as usize,
        )?;

        self.build_storage_tree(child_sid)
    }
}

impl fmt::Display for OleFile {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        writeln!(f, "-----HEADER FIELDS-----")?;
        writeln!(f, "magic: {:?}", self.header.magic)?;
        writeln!(f, "clsid: {:?}", self.header.clsid)?;
        writeln!(f, "minor_version: {:?}", self.header.minor_version)?;
        writeln!(f, "dll_version: {:?}", self.header.dll_version)?;
        writeln!(f, "byte_order: {:?}", self.header.byte_order)?;
        writeln!(f, "sector_shift: {:?}", self.header.sector_shift)?;
        writeln!(f, "mini_sector_shift: {:?}", self.header.mini_sector_shift)?;
        writeln!(f, "reserved1: {:?}", self.header.reserved1)?;
        writeln!(f, "reserved2: {:?}", self.header.reserved2)?;
        writeln!(f, "num_dir_sectors: {:?}", self.header.num_dir_sectors)?;
        writeln!(f, "num_fat_sectors: {:?}", self.header.num_fat_sectors)?;
        writeln!(f, "first_dir_sector: {:?}", self.header.first_dir_sector)?;
        writeln!(
            f,
            "transaction_signature_number: {:?}",
            self.header.transaction_signature_number
        )?;
        writeln!(
            f,
            "mini_stream_cutoff_size: {:?}",
            self.header.mini_stream_cutoff_size
        )?;
        writeln!(
            f,
            "first_mini_fat_sector: {:?}",
            self.header.first_mini_fat_sector
        )?;
        writeln!(
            f,
            "num_mini_fat_sectors: {:?}",
            self.header.num_mini_fat_sectors
        )?;
        writeln!(
            f,
            "first_difat_sector: {:?}",
            self.header.first_difat_sector
        )?;
        writeln!(f, "num_difat_sectors: {:?}", self.header.num_difat_sectors)?;

        writeln!(f, "-----NON-HEADER FIELDS-----")?;
        writeln!(f, "sector_size: {:?}", self.sector_size)?;
        writeln!(f, "mini_sector_size: {:?}", self.mini_sector_size)?;
        writeln!(f, "nb_sect: {:?}", self.nb_sect)?;
        writeln!(f, "used_streams_fat: {:?}", self.used_streams_fat)?;
        writeln!(f, "used_streams_minifat: {:?}", self.used_streams_minifat)
    }
}

#[derive(Default, Debug)]
pub(crate) struct OleStream {
    pub stream: Vec<u8>,
    start: u32,
    size: u64,
    offset: u32,
    sector_size: u32,
}

impl OleStream {
    pub fn new(start: u32, size: u64, offset: u32, sector_size: u32) -> Self {
        OleStream {
            stream: Vec::new(),
            start,
            size,
            offset,
            sector_size,
        }
    }

    fn init(&mut self, raw: &[u8], fat: &Vec<u32>) -> Result<(), DecryptError> {
        let mut unknown_size = false;
        let fat_len = fat.len() as u32;

        if self.size == UNKNOWN_SIZE as u64 {
            self.size = fat_len as u64 * self.sector_size as u64;
            unknown_size = true;
        }

        let nb_sectors = (self.size + (self.sector_size as u64 - 1)) / self.sector_size as u64;
        validate!(nb_sectors <= fat_len as u64, InvalidStructure)?;
        let mut sect = self.start;
        validate!(self.size != 0 || sect == ENDOFCHAIN, InvalidStructure)?;

        let mut data: Vec<u8> = Vec::new();
        for _ in 0..nb_sectors {
            if sect == ENDOFCHAIN {
                validate!(unknown_size, InvalidStructure)?;
                break;
            }
            validate!(sect < fat_len, InvalidStructure)?;
            let start = (self.offset + self.sector_size * sect) as usize;
            let sector_data = &raw[start..(start + self.sector_size as usize)];
            // TODO last sector might have less than 512/4k, so read less on index
            validate!(
                sector_data.len() == self.sector_size as usize || sect == (fat_len - 1),
                InvalidStructure
            )?;
            data.extend_from_slice(sector_data);

            // labeled as JYTHON_WORKAROUND in the olefile code
            // sect = fat[sect as usize] & 0xFFFFFFFF;
            sect = fat[sect as usize];
        }

        if data.len() >= self.size as usize {
            data = data[..self.size as usize].to_vec();
        } else if unknown_size {
            self.size = data.len() as u64;
        } else {
            return Err(InvalidStructure);
        }

        self.stream = data;

        Ok(())
    }
}

#[derive(PackedStruct, Derivative, Debug, Clone)]
#[packed_struct(endian = "lsb", bit_numbering = "msb0")]
#[derivative(Default)]
pub struct OleDirentryPacked {
    #[packed_field(bytes = "0..=63")]
    // workaround since Default isnt implemented for [T; >32]
    #[derivative(Default(value = "[0; 64]"))]
    name_raw: [u8; 64],
    #[packed_field(bytes = "64..=65")]
    name_length: u16,
    #[packed_field(bytes = "66..=66")]
    entry_type: u8,
    #[packed_field(bytes = "67..=67")]
    color: u8,
    #[packed_field(bytes = "68..=71")]
    sid_left: u32,
    #[packed_field(bytes = "72..=75")]
    sid_right: u32,
    #[packed_field(bytes = "76..=79")]
    sid_child: u32,
    #[packed_field(bytes = "80..=95")]
    clsid: [u8; 16],
    #[packed_field(bytes = "96..=99")]
    dw_user_flags: u32,
    #[packed_field(bytes = "100..=107")]
    create_time: u64,
    #[packed_field(bytes = "108..=115")]
    modify_time: u64,
    #[packed_field(bytes = "116..=119")]
    isect_start: u32,
    #[packed_field(bytes = "120..=123")]
    size_low: u32,
    #[packed_field(bytes = "124..=127")]
    size_high: u32,
}

#[allow(dead_code)]
#[derive(Default, Debug, Clone)]
pub(crate) struct OleDirentry {
    packed: OleDirentryPacked,
    name: String,
    clsid: String,
    sid: usize,
    size: u64,
    children: Vec<usize>,
    children_map: HashMap<String, usize>,
    sect_chain: Option<Vec<u32>>,
    used: bool,
    minifat: bool,
}

impl OleDirentry {
    pub fn new(
        entry: [u8; 128],
        sid: usize,
        // sector_size: u32,
        // mini_sector_cutoff: u32,
        olefile: &mut OleFile,
    ) -> Result<Self, DecryptError> {
        let packed = OleDirentryPacked::unpack(&entry).map_err(|_| InvalidStructure)?;

        validate!(
            [STGTY_ROOT, STGTY_STORAGE, STGTY_STREAM, STGTY_EMPTY].contains(&packed.entry_type),
            InvalidStructure
        )?;
        validate!(
            packed.entry_type != STGTY_ROOT || sid == 0,
            InvalidStructure
        )?;
        validate!(
            packed.entry_type == STGTY_ROOT || sid != 0,
            InvalidStructure
        )?;
        validate!(packed.name_length <= 64, InvalidStructure)?;

        let name_utf16 = &packed.name_raw[..(packed.name_length as usize - 2)];
        let name_utf16: &[u16] = cast_slice(name_utf16);
        let name = String::from_utf16(name_utf16).map_err(|_| InvalidStructure)?;

        let size = if olefile.sector_size == 512 {
            packed.size_low as u64
        } else {
            packed.size_low as u64 + ((packed.size_high as u64) << 32)
        };

        let clsid = convert_clsid(packed.clsid)?;
        validate!(
            packed.entry_type != STGTY_STORAGE || size == 0,
            InvalidStructure
        )?;

        let mut minifat = false;
        if [STGTY_ROOT, STGTY_STREAM].contains(&packed.entry_type) && size > 0 {
            if size < olefile.header.mini_stream_cutoff_size as u64
                && packed.entry_type == STGTY_STREAM
            {
                minifat = true;
            }
            olefile.check_duplicate_stream(packed.isect_start, minifat)?;
        }

        Ok(OleDirentry {
            packed,
            name,
            clsid,
            sid,
            size,
            children: Vec::new(),
            children_map: HashMap::new(),
            sect_chain: None,
            used: false,
            minifat,
        })
    }
}

fn convert_clsid(clsid: [u8; 16]) -> Result<String, DecryptError> {
    if clsid == ZERO_CLSID {
        return Ok(String::new());
    }
    // Convert CLSID to GUID string format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
    // https://devblogs.microsoft.com/oldnewthing/20220928-00/?p=107221
    let d1 = u32::from_le_bytes([clsid[0], clsid[1], clsid[2], clsid[3]]);
    let d2 = u16::from_le_bytes([clsid[4], clsid[5]]);
    let d3 = u16::from_le_bytes([clsid[6], clsid[7]]);
    Ok(format!(
        "{{{:08X}-{:04X}-{:04X}-{:02X}{:02X}-{:02X}{:02X}{:02X}{:02X}{:02X}{:02X}}}",
        d1, d2, d3, clsid[8], clsid[9], clsid[10], clsid[11], clsid[12], clsid[13], clsid[14], clsid[15]
    ))
}

fn sect_to_array(sect: &[u8]) -> &[u32] {
    cast_slice(sect)
}