Skip to main content

hayro_syntax/crypto/
mod.rs

1//! Cryptographic implementations for hayro, ported from pdf.js.
2//!
3//! **Important note**: Please keep in mind that these haven't been
4//! audited and should not be used for security-critical purposes, like creating new
5//! encrypted PDFs. They solely serve the purpose of being able to decrypt and read
6//! _already_ encrypted documents, where security isn't really relevant.
7
8use crate::crypto::DecryptionError::InvalidEncryption;
9use crate::crypto::aes::{AES128Cipher, AES256Cipher};
10use crate::crypto::rc4::Rc4;
11use crate::object;
12use crate::object::dict::keys::{
13    CF, CFM, ENCRYPT_META_DATA, FILTER, LENGTH, O, OE, P, R, STM_F, STR_F, U, UE, V,
14};
15use crate::object::{Dict, Name, ObjectIdentifier};
16use crate::sync::HashMap;
17use alloc::string::ToString;
18use alloc::vec;
19use alloc::vec::Vec;
20use core::cmp;
21use core::ops::Deref;
22
23mod aes;
24mod md5;
25mod rc4;
26mod sha256;
27mod sha384;
28mod sha512;
29
30const PASSWORD_PADDING: [u8; 32] = [
31    0x28, 0xBF, 0x4E, 0x5E, 0x4E, 0x75, 0x8A, 0x41, 0x64, 0x00, 0x4E, 0x56, 0xFF, 0xFA, 0x01, 0x08,
32    0x2E, 0x2E, 0x00, 0xB6, 0xD0, 0x68, 0x3E, 0x80, 0x2F, 0x0C, 0xA9, 0xFE, 0x64, 0x53, 0x69, 0x7A,
33];
34
35/// An error that occurred during decryption.
36#[derive(Debug, Copy, Clone, PartialEq, Eq)]
37pub enum DecryptionError {
38    /// The ID entry is missing in the PDF.
39    MissingIDEntry,
40    /// The PDF is password-protected and no password (or a wrong one) was
41    /// provided.
42    PasswordProtected,
43    /// The PDF has invalid encryption.
44    InvalidEncryption,
45    /// The PDF uses an unsupported encryption algorithm.
46    UnsupportedAlgorithm,
47}
48
49#[derive(Debug, Copy, Clone, PartialEq, Eq)]
50enum DecryptorTag {
51    None,
52    Rc4,
53    Aes128,
54    Aes256,
55}
56
57impl DecryptorTag {
58    fn from_name(name: &Name<'_>) -> Option<Self> {
59        match name.as_str() {
60            "None" | "Identity" => Some(Self::None),
61            "V2" => Some(Self::Rc4),
62            "AESV2" => Some(Self::Aes128),
63            "AESV3" => Some(Self::Aes256),
64            _ => None,
65        }
66    }
67}
68#[derive(Debug, Clone)]
69pub(crate) enum Decryptor {
70    None,
71    Rc4 { key: Vec<u8> },
72    Aes128 { key: Vec<u8>, dict: DecryptorData },
73    Aes256 { key: Vec<u8>, dict: DecryptorData },
74}
75
76#[derive(Debug, Copy, Clone)]
77pub(crate) enum DecryptionTarget {
78    String,
79    Stream,
80}
81
82impl Decryptor {
83    pub(crate) fn decrypt(
84        &self,
85        id: ObjectIdentifier,
86        data: &[u8],
87        target: DecryptionTarget,
88    ) -> Option<Vec<u8>> {
89        match self {
90            Self::None => Some(data.to_vec()),
91            Self::Rc4 { key } => decrypt_rc4(key, data, id),
92            Self::Aes128 { key, dict } | Self::Aes256 { key, dict } => {
93                let crypt_dict = match target {
94                    DecryptionTarget::String => dict.string_filter,
95                    DecryptionTarget::Stream => dict.stream_filter,
96                };
97
98                match crypt_dict.cfm {
99                    DecryptorTag::None => Some(data.to_vec()),
100                    DecryptorTag::Rc4 => decrypt_rc4(key, data, id),
101                    DecryptorTag::Aes128 => decrypt_aes128(key, data, id),
102                    DecryptorTag::Aes256 => decrypt_aes256(key, data),
103                }
104            }
105        }
106    }
107}
108
109pub(crate) fn get(
110    dict: &Dict<'_>,
111    id: &[u8],
112    password: &[u8],
113) -> Result<Decryptor, DecryptionError> {
114    let filter = dict.get::<Name<'_>>(FILTER).ok_or(InvalidEncryption)?;
115
116    if filter.deref() != b"Standard" {
117        return Err(DecryptionError::UnsupportedAlgorithm);
118    }
119
120    let encryption_v = dict.get::<u8>(V).ok_or(InvalidEncryption)?;
121    let encrypt_metadata = dict.get::<bool>(ENCRYPT_META_DATA).unwrap_or(true);
122    let revision = dict.get::<u8>(R).ok_or(InvalidEncryption)?;
123    let length = match encryption_v {
124        1 => 40,
125        2 => dict.get::<u16>(LENGTH).unwrap_or(40),
126        4 => dict.get::<u16>(LENGTH).unwrap_or(128),
127        5 => 256,
128        _ => return Err(DecryptionError::UnsupportedAlgorithm),
129    };
130
131    let (algorithm, data) = match encryption_v {
132        1 => (DecryptorTag::Rc4, None),
133        2 => (DecryptorTag::Rc4, None),
134        4 => (
135            DecryptorTag::Aes128,
136            Some(DecryptorData::from_dict(dict, length).ok_or(InvalidEncryption)?),
137        ),
138        5 | 6 => (
139            DecryptorTag::Aes256,
140            Some(DecryptorData::from_dict(dict, length).ok_or(InvalidEncryption)?),
141        ),
142        _ => {
143            return Err(DecryptionError::UnsupportedAlgorithm);
144        }
145    };
146
147    let byte_length = length / 8;
148
149    let owner_string = dict.get::<object::String<'_>>(O).ok_or(InvalidEncryption)?;
150    let user_string = dict.get::<object::String<'_>>(U).ok_or(InvalidEncryption)?;
151    let permissions = {
152        let raw = dict.get::<i64>(P).ok_or(InvalidEncryption)?;
153
154        if raw < 0 {
155            u32::from_be_bytes((raw as i32).to_be_bytes())
156        } else {
157            raw as u32
158        }
159    };
160
161    let mut decryption_key = if revision <= 4 {
162        let key = decryption_key_rev1234(
163            password,
164            encrypt_metadata,
165            revision,
166            byte_length,
167            &owner_string,
168            permissions,
169            id,
170        )?;
171        authenticate_user_password_rev234(revision, &key, id, &user_string)?;
172
173        key
174    } else {
175        decryption_key_rev56(dict, revision, password, &owner_string, &user_string)?
176    };
177
178    // See pdf.js issue 19484.
179    if encryption_v == 4 && decryption_key.len() < 16 {
180        decryption_key.resize(16, 0);
181    }
182
183    match algorithm {
184        DecryptorTag::None => Ok(Decryptor::None),
185        DecryptorTag::Rc4 => Ok(Decryptor::Rc4 {
186            key: decryption_key,
187        }),
188        DecryptorTag::Aes128 => Ok(Decryptor::Aes128 {
189            key: decryption_key,
190            dict: data.unwrap(),
191        }),
192        DecryptorTag::Aes256 => Ok(Decryptor::Aes256 {
193            key: decryption_key,
194            dict: data.unwrap(),
195        }),
196    }
197}
198
199/// Algorithm 1.A: Encryption of data using the AES algorithms
200fn decrypt_aes256(key: &[u8], data: &[u8]) -> Option<Vec<u8>> {
201    // a) Use the 32-byte file encryption key for the AES-256 symmetric key algorithm,
202    // along with the string or stream data to be encrypted.
203    // Use the AES algorithm in Cipher Block Chaining (CBC) mode, which requires an initialization
204    // vector. The block size parameter is set to 16 bytes, and the initialization
205    // vector is a 16-byte random number that is stored as the first 16 bytes of the
206    // encrypted stream or string.
207    let (iv, data) = data.split_at_checked(16)?;
208    let iv: [u8; 16] = iv.try_into().ok()?;
209    let cipher = AES256Cipher::new(key)?;
210    Some(cipher.decrypt_cbc(data, &iv, true))
211}
212
213fn decrypt_aes128(key: &[u8], data: &[u8], id: ObjectIdentifier) -> Option<Vec<u8>> {
214    decrypt_rc_aes(key, id, true, |key| {
215        // If using the AES algorithm, the Cipher Block Chaining (CBC) mode, which requires an initialization
216        // vector, is used. The block size parameter is set to 16 bytes, and the initialization vector is a 16-byte
217        // random number that is stored as the first 16 bytes of the encrypted stream or string.
218        let cipher = AES128Cipher::new(key)?;
219        let (iv, data) = data.split_at_checked(16)?;
220        let iv: [u8; 16] = iv.try_into().ok()?;
221
222        Some(cipher.decrypt_cbc(data, &iv, true))
223    })
224}
225
226fn decrypt_rc4(key: &[u8], data: &[u8], id: ObjectIdentifier) -> Option<Vec<u8>> {
227    decrypt_rc_aes(key, id, false, |key| {
228        let mut rc = Rc4::new(key);
229        Some(rc.decrypt(data))
230    })
231}
232
233/// Algorithm 1: Encryption of data using the RC4 or AES algorithms
234fn decrypt_rc_aes(
235    key: &[u8],
236    id: ObjectIdentifier,
237    aes: bool,
238    with_key: impl FnOnce(&[u8]) -> Option<Vec<u8>>,
239) -> Option<Vec<u8>> {
240    let n = key.len();
241    // a) Obtain the object number and generation number from the object identifier of
242    // the string or stream to be encrypted (see 7.3.10, "Indirect objects"). If the
243    // string is a direct object, use the identifier of the indirect object containing
244    // it.
245    let mut key = key.to_vec();
246
247    // b) For all strings and streams without crypt filter specifier; treating the
248    // object number and generation number as binary integers, extend the original
249    // n-byte file encryption key to n + 5 bytes by appending the low-order 3 bytes of
250    // the object number and the low-order 2 bytes of the generation number in that
251    // order, low-order byte first.
252    key.extend(&id.obj_number.to_le_bytes()[..3]);
253    key.extend(&id.gen_number.to_le_bytes()[..2]);
254
255    // If using the AES algorithm, extend the file encryption key an additional 4 bytes by adding the value
256    // "sAlT", which corresponds to the hexadecimal values 0x73, 0x41, 0x6C, 0x54. (This addition is done
257    // for backward compatibility and is not intended to provide additional security.)
258    if aes {
259        key.extend(b"sAlT");
260    }
261
262    // c) Initialise the MD5 hash function and pass the result of step (b) as input
263    // to this function.
264    let hash = md5::calculate(&key);
265
266    // d) Use the first (n + 5) bytes, up to a maximum of 16, of the output
267    // from the MD5 hash as the key for the RC4 or AES symmetric key algorithms,
268    // along with the string or stream data to be encrypted.
269    let final_key = &hash[..cmp::min(16, n + 5)];
270
271    with_key(final_key)
272}
273
274#[derive(Debug, Copy, Clone)]
275pub(crate) struct DecryptorData {
276    stream_filter: CryptDictionary,
277    string_filter: CryptDictionary,
278}
279
280impl DecryptorData {
281    fn from_dict(dict: &Dict<'_>, default_length: u16) -> Option<Self> {
282        let mut mappings = HashMap::new();
283
284        if let Some(dict) = dict.get::<Dict<'_>>(CF) {
285            for key in dict.keys() {
286                if let Some(dict) = dict.get::<Dict<'_>>(key.as_ref())
287                    && let Some(crypt_dict) = CryptDictionary::from_dict(&dict, default_length)
288                {
289                    mappings.insert(key.as_str().to_string(), crypt_dict);
290                }
291            }
292        }
293
294        let stm_f = *mappings
295            .get(dict.get::<Name<'_>>(STM_F)?.as_str())
296            .unwrap_or(&CryptDictionary::identity(default_length));
297        let str_f = *mappings
298            .get(dict.get::<Name<'_>>(STR_F)?.as_str())
299            .unwrap_or(&CryptDictionary::identity(default_length));
300
301        Some(Self {
302            stream_filter: stm_f,
303            string_filter: str_f,
304        })
305    }
306}
307
308#[derive(Debug, Copy, Clone)]
309struct CryptDictionary {
310    cfm: DecryptorTag,
311    _length: u16,
312}
313
314impl CryptDictionary {
315    fn from_dict(dict: &Dict<'_>, default_length: u16) -> Option<Self> {
316        let cfm = DecryptorTag::from_name(&dict.get::<Name<'_>>(CFM)?)?;
317        // The standard security handler expresses the Length entry in bytes (e.g., 32 means a
318        // length of 256 bits) and public-key security handlers express it as is (e.g., 256 means a
319        // length of 256 bits).
320        // Note: We only support the standard security handler.
321        let mut length = dict.get::<u16>(LENGTH).unwrap_or(default_length / 8);
322
323        // When CFM is AESV2, the Length key shall have the value of 128. When
324        // CFM is AESV3, the Length key shall have a value of 256.
325        if cfm == DecryptorTag::Aes128 {
326            length = 16;
327        } else if cfm == DecryptorTag::Aes256 {
328            length = 32;
329        }
330
331        Some(Self {
332            cfm,
333            _length: length,
334        })
335    }
336
337    fn identity(default_length: u16) -> Self {
338        Self {
339            cfm: DecryptorTag::None,
340            _length: default_length,
341        }
342    }
343}
344
345/// Algorithm 2.B: Computing a hash (revision 6 and later)
346fn compute_hash_rev56(
347    password: &[u8],
348    validation_salt: &[u8],
349    user_string: Option<&[u8]>,
350    revision: u8,
351) -> Result<[u8; 32], DecryptionError> {
352    // Take the SHA-256 hash of the original input to the algorithm and name the resulting
353    // 32 bytes, K.
354    let mut k = {
355        let mut input = Vec::new();
356        input.extend_from_slice(password);
357        input.extend_from_slice(validation_salt);
358
359        if let Some(user_string) = user_string {
360            input.extend_from_slice(user_string);
361        }
362
363        let hash = sha256::calculate(&input);
364
365        // Apparently revision 5 only uses this hash.
366        if revision == 5 {
367            return Ok(hash);
368        }
369
370        hash.to_vec()
371    };
372
373    let mut round: u16 = 0;
374
375    // Perform the following steps (a)-(d) 64 times:
376    loop {
377        // a) Make a new string, K1, consisting of 64 repetitions of the sequence:
378        // input password, K, the 48-byte user key. The 48 byte user key is only used when
379        // checking the owner password or creating the owner key. If checking the user
380        // password or creating the user key, K1 is the concatenation of the input
381        // password and K.
382        let k1 = {
383            let mut single: Vec<u8> = vec![];
384            single.extend(password);
385            single.extend(&k);
386
387            if let Some(user_string) = user_string {
388                single.extend(user_string);
389            }
390
391            single.repeat(64)
392        };
393
394        // b) Encrypt K1 with the AES-128 (CBC, no padding) algorithm,
395        // using the first 16 bytes of K as the key and the second 16 bytes of K as the
396        // initialization vector. The result of this encryption is E.
397        let e = {
398            let aes = AES128Cipher::new(&k[..16]).ok_or(InvalidEncryption)?;
399            let mut res = aes.encrypt_cbc(&k1, &k[16..32].try_into().unwrap());
400
401            // Remove padding that was added by `encrypt_cbc`.
402            res.truncate(k1.len());
403
404            res
405        };
406
407        // c) Taking the first 16 bytes of E as an unsigned big-endian integer,
408        // compute the remainder, modulo 3. If the result is 0, the next hash used is
409        // SHA-256, if the result is 1, the next hash used is SHA-384, if the result is
410        // 2, the next hash used is SHA-512.
411        let num = u128::from_be_bytes(e[..16].try_into().unwrap()) % 3;
412
413        // d) Using the hash algorithm determined in step c, take the hash of E.
414        // The result is a new value of K, which will be 32, 48, or 64 bytes in length.
415        k = match num {
416            0 => sha256::calculate(&e).to_vec(),
417            1 => sha384::calculate(&e).to_vec(),
418            2 => sha512::calculate(&e).to_vec(),
419            _ => unreachable!(),
420        };
421
422        round += 1;
423
424        // Repeat the process (a-d) with this new value for K. Following 64 rounds
425        // (round number 0 to round number 63), do the following, starting with round
426        // number 64:
427        if round > 63 {
428            // e) Look at the very last byte of E. If the value of that byte
429            // (taken as an unsigned integer) is greater than the round number - 32,
430            // repeat steps (a-d) again.
431            let last_byte = *e.last().unwrap();
432
433            // f) Repeat from steps (a-e) until the value of the last byte
434            // is < (round number) - 32.
435            // For some reason we need to use <= here?
436            if (last_byte as u16) <= round - 32 {
437                break;
438            }
439        }
440    }
441
442    // The first 32 bytes of the final K are the output of the algorithm.
443    let mut result = [0_u8; 32];
444    result.copy_from_slice(&k[..32]);
445    Ok(result)
446}
447
448/// Algorithm 2: Computing a file encryption key in order to encrypt a document (revision 4 and earlier)
449fn decryption_key_rev1234(
450    password: &[u8],
451    encrypt_metadata: bool,
452    revision: u8,
453    byte_length: u16,
454    owner_string: &object::String<'_>,
455    permissions: u32,
456    id: &[u8],
457) -> Result<Vec<u8>, DecryptionError> {
458    let mut md5_input = vec![];
459
460    // TODO: Convert to PDFDocEncoding.
461    // a) Pad or truncate password to 32 bytes using PASSWORD_PADDING.
462    let mut padded_password = [0_u8; 32];
463    let copy_len = password.len().min(32);
464    padded_password[..copy_len].copy_from_slice(&password[..copy_len]);
465    if copy_len < 32 {
466        padded_password[copy_len..].copy_from_slice(&PASSWORD_PADDING[..(32 - copy_len)]);
467    }
468
469    // b) Initialise the MD5 hash function and pass the
470    // result of step a) as input to this function.
471    md5_input.extend(&padded_password);
472
473    // c) Pass the value of the encryption dictionary's O entry
474    // to the MD5 hash function.
475    md5_input.extend(owner_string.as_ref());
476
477    // d) Convert the integer value of the P entry to a 32-bit unsigned
478    // binary number and pass these bytes to the MD5 hash function, low-order byte first.
479    md5_input.extend(permissions.to_le_bytes());
480
481    // e) Pass the first element of the file's file identifier array to the MD5 hash function.
482    md5_input.extend(id);
483
484    // f) (Security handlers of revision 4 or greater) If document metadata
485    // is not being encrypted, pass 4 bytes with the value 0xFFFFFFFF to the MD5 hash function.
486    if !encrypt_metadata && revision >= 4 {
487        md5_input.extend(&[0xff, 0xff, 0xff, 0xff]);
488    }
489
490    // g) Finish the hash.
491    let mut hash = md5::calculate(&md5_input);
492
493    // h) For revisions >= 3, do the following 50 times: Take the output from the previous
494    // MD5 hash and pass the first n bytes of the output as input into a new MD5 hash,
495    // where n is the number of bytes of the file encryption key as defined by the value
496    // of the encryption dictionary's `Length` entry.
497    if revision >= 3 {
498        for _ in 0..50 {
499            hash = md5::calculate(&hash[..byte_length as usize]);
500        }
501    }
502
503    let decryption_key = hash[..byte_length as usize].to_vec();
504    Ok(decryption_key)
505}
506
507/// Algorithm 6: Authenticating the user password
508fn authenticate_user_password_rev234(
509    revision: u8,
510    decryption_key: &[u8],
511    id: &[u8],
512    user_string: &object::String<'_>,
513) -> Result<(), DecryptionError> {
514    // a) Perform all but the last step of Algorithm 4 (revision 2) or Algorithm 5 (revision 3 + 4).
515    let result = match revision {
516        2 => user_password_rev2(decryption_key),
517        3 | 4 => user_password_rev34(decryption_key, id),
518        _ => return Err(InvalidEncryption),
519    };
520
521    // b) If the result of step (a) is equal to the value of the encryption dictionary's
522    // U entry (comparing on the first 16 bytes in the case of security handlers of
523    // revision 3 or greater), the password supplied is the correct user password.
524    match revision {
525        2 => {
526            if result.as_slice() != user_string.as_ref() {
527                return Err(DecryptionError::PasswordProtected);
528            }
529        }
530        3 | 4 => {
531            if Some(&result[..16]) != user_string.as_ref().get(0..16) {
532                return Err(DecryptionError::PasswordProtected);
533            }
534        }
535        _ => unreachable!(),
536    }
537
538    Ok(())
539}
540
541/// Algorithm 4: Computing the encryption dictionary’s U-entry value
542/// (Security handlers of revision 2).
543fn user_password_rev2(decryption_key: &[u8]) -> Vec<u8> {
544    // a) Create a file encryption key based on the user password string.
545    // b) Encrypt the 32-byte padding string using an RC4 encryption
546    // function with the file encryption key from the preceding step.
547    let mut rc = Rc4::new(decryption_key);
548    rc.decrypt(&PASSWORD_PADDING)
549}
550
551/// Algorithm 5: Computing the encryption dictionary’s U (user password)
552/// value (Security handlers of revision 3 or 4).
553fn user_password_rev34(decryption_key: &[u8], id: &[u8]) -> Vec<u8> {
554    // a) Create a file encryption key based on the user password string.
555    let mut rc = Rc4::new(decryption_key);
556
557    let mut input = vec![];
558    // b) Initialise the MD5 hash function and pass the 32-byte padding string.
559    input.extend(PASSWORD_PADDING);
560
561    // c) Pass the first element of the file's file identifier array to the hash function
562    // and finish the hash.
563    input.extend(id);
564    let hash = md5::calculate(&input);
565
566    // d) Encrypt the 16-byte result of the hash, using an RC4 encryption function with
567    // the encryption key from step (a).
568    let mut encrypted = rc.encrypt(&hash);
569
570    // e) Do the following 19 times: Take the output from the previous invocation of the
571    // RC4 function and pass it as input to a new invocation of the function; use a file
572    // encryption key generated by taking each byte of the original file encryption key
573    // obtained in step (a) and performing an XOR (exclusive or) operation between that
574    // byte and the single-byte value of the iteration counter (from 1 to 19).
575    for i in 1..=19 {
576        let mut key = decryption_key.to_vec();
577        for byte in &mut key {
578            *byte ^= i;
579        }
580
581        let mut rc = Rc4::new(&key);
582        encrypted = rc.encrypt(&encrypted);
583    }
584
585    encrypted.resize(32, 0);
586    encrypted
587}
588
589/// Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later)
590fn decryption_key_rev56(
591    dict: &Dict<'_>,
592    revision: u8,
593    password: &[u8],
594    owner_string: &object::String<'_>,
595    user_string: &object::String<'_>,
596) -> Result<Vec<u8>, DecryptionError> {
597    // a) The UTF-8 password string shall be generated from Unicode input by processing the input string with
598    // the SASLprep (Internet RFC 4013) profile of stringprep (Internet RFC 3454) using the Normalize and BiDi
599    // options, and then converting to a UTF-8 representation.
600    // TODO: Do the above.
601    // b) Truncate the UTF-8 representation to 127 bytes if it is longer than 127 bytes.
602    let password = &password[..password.len().min(127)];
603
604    let string_len = if revision <= 4 { 32 } else { 48 };
605
606    let trimmed_os = owner_string.get(..string_len).ok_or(InvalidEncryption)?;
607
608    let (owner_hash, owner_tail) = trimmed_os.split_at_checked(32).ok_or(InvalidEncryption)?;
609    let (owner_validation_salt, owner_key_salt) =
610        owner_tail.split_at_checked(8).ok_or(InvalidEncryption)?;
611
612    let trimmed_us = user_string.get(..string_len).ok_or(InvalidEncryption)?;
613    let (user_hash, user_tail) = trimmed_us.split_at_checked(32).ok_or(InvalidEncryption)?;
614    let (user_validation_salt, user_key_salt) =
615        user_tail.split_at_checked(8).ok_or(InvalidEncryption)?;
616
617    // c) Test the password against the owner key by computing a hash using algorithm 2.B
618    // with an input string consisting of the UTF-8 password concatenated with the 8 bytes of
619    // owner Validation Salt, concatenated with the 48-byte U string. If the 32-byte result
620    // matches the first 32 bytes of the O string, this is the owner password.
621    if compute_hash_rev56(password, owner_validation_salt, Some(trimmed_us), revision)?
622        == owner_hash
623    {
624        // d) Compute an intermediate owner key by computing a hash using algorithm 2.B with an input string
625        // consisting of the UTF-8 owner password concatenated with the 8 bytes of owner Key Salt,
626        // concatenated with the 48-byte U string. The 32-byte result is the key used to decrypt the 32-byte OE string
627        // using AES-256 in CBC mode with no padding and an initialization vector of zero. The 32-byte result is the file encryption key.
628        let intermediate_owner_key =
629            compute_hash_rev56(password, owner_key_salt, Some(trimmed_us), revision)?;
630
631        let oe_string = dict
632            .get::<object::String<'_>>(OE)
633            .ok_or(InvalidEncryption)?;
634
635        if oe_string.len() != 32 {
636            return Err(InvalidEncryption);
637        }
638
639        let cipher = AES256Cipher::new(&intermediate_owner_key).ok_or(InvalidEncryption)?;
640        let zero_iv = [0_u8; 16];
641
642        Ok(cipher.decrypt_cbc(&oe_string, &zero_iv, false))
643    } else if compute_hash_rev56(password, user_validation_salt, None, revision)? == user_hash {
644        // e) Compute an intermediate user key by computing a hash using algorithm 2.B with an input string
645        // consisting of the UTF-8 user password concatenated with the 8 bytes of user Key Salt. The 32-byte result
646        // is the key used to decrypt the 32-byte UE string using AES-256 in CBC mode with no padding and an
647        // initialization vector of zero. The 32-byte result is the file encryption key.
648        let intermediate_key = compute_hash_rev56(password, user_key_salt, None, revision)?;
649
650        let ue_string = dict
651            .get::<object::String<'_>>(UE)
652            .ok_or(InvalidEncryption)?;
653
654        if ue_string.len() != 32 {
655            return Err(InvalidEncryption);
656        }
657
658        let cipher = AES256Cipher::new(&intermediate_key).ok_or(InvalidEncryption)?;
659        let zero_iv = [0_u8; 16];
660
661        Ok(cipher.decrypt_cbc(&ue_string, &zero_iv, false))
662    } else {
663        Err(DecryptionError::PasswordProtected)
664    }
665
666    // TODO:
667    // f) Decrypt the 16-byte Perms string using AES-256 in ECB mode with an initialization vector of zero and
668    // the file encryption key as the key. Verify that bytes 9-11 of the result are the characters "a", "d",
669    // "b". Bytes 0-3 of the decrypted Perms entry, treated as a little-endian integer, are the user
670    // permissions. They shall match the value in the P key.
671}