Skip to main content

AlgorithmParams

Struct AlgorithmParams 

Source
#[non_exhaustive]
pub struct AlgorithmParams { pub cipher: Option<CipherAlgorithm>, pub hash: Option<HashAlgorithm>, pub key_bits: Option<u32>, pub block_size: Option<u32>, pub salt_size: Option<u32>, pub spin_count: Option<u32>, }
Expand description

One parameter set, as the file declares it.

Every field is Option because every one of them is optional in at least one of the two formats: agile writes all six on <p:encryptedKey> and five on <keyData> (no spinCount), while standard encryption declares a cipher, a hash, a key length and a salt size, and fixes the remaining two by spec — AES-ECB has no blockSize, and [MS-OFFCRYPTO] §2.3.4.7 fixes the spin count at 50 000 rather than carrying it in the file.

The numbers are reported unbounded and unvalidated — spin_count may be u32::MAX, key_bits may be 7. Bounding them is decrypt’s job (crate::limits); a classifier that refused to report a hostile value would leave its caller unable to see what it was refusing.

§Examples

use msoffice_crypto::classify;

let class = classify(include_bytes!("../tests/fixtures/agile_encrypted.docx"));
let password = class.password_key.expect("agile files declare a password encryptor");
assert_eq!(password.spin_count, Some(100_000));
assert_eq!(password.key_bits, Some(256));

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§cipher: Option<CipherAlgorithm>

cipherAlgorithm, or standard encryption’s AlgID + fAES.

§hash: Option<HashAlgorithm>

hashAlgorithm, or standard encryption’s AlgIDHash.

§key_bits: Option<u32>

keyBits, or standard encryption’s EncryptionHeader.KeySize.

§block_size: Option<u32>

blockSize — the cipher block / IV truncation length. Agile only: standard encryption is AES-ECB and declares no block size field.

§salt_size: Option<u32>

saltSize, or standard encryption’s EncryptionVerifier.SaltSize.

§spin_count: Option<u32>

spinCount — the password KDF iteration count. Agile <p:encryptedKey> only: <keyData> has no such attribute, and standard encryption fixes it at 50 000 by spec rather than declaring it.

Trait Implementations§

Source§

impl Clone for AlgorithmParams

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for AlgorithmParams

Source§

impl Debug for AlgorithmParams

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for AlgorithmParams

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for AlgorithmParams

Source§

impl PartialEq for AlgorithmParams

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AlgorithmParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.