Struct EncryptionConfig 

pub struct EncryptionConfig {

    pub revision: u8,
    pub length_bits: usize,
    pub user_password: Vec<u8>,
    pub owner_password: Vec<u8>,
    pub p: i32,
    pub encrypt_metadata: bool,
    pub method: CryptMethod,
    pub file_id: Vec<u8>,
    pub u_salt_validate: [u8; 8],
    pub u_salt_key: [u8; 8],
    pub o_salt_validate: [u8; 8],
    pub o_salt_key: [u8; 8],
    pub file_key_v5: Option<[u8; 32]>,
    pub perms_padding: [u8; 4],
    pub aes_iv: [u8; 16],
}

Writer-side configuration: what kind of encryption to apply, what the user / owner passwords are, the permissions, and the (optional) IVs / salts to feed into the AES paths so output stays deterministic for tests.

Fields

revision: u8

Revision — 2..=6. Implies length_bits, cfm, and which algorithm family (V≤4 vs V=5) to use.

length_bits: usize

File-key length in bits. R=2: 40. R=3 / R=4: typically 128. R=5 / R=6: always 256.

user_password: Vec<u8>

User password (raw bytes — V=5 truncates to 127, V≤4 pads to 32).

owner_password: Vec<u8>

Owner password — Algorithm 3 falls back to user password when empty.

p: i32

32-bit signed permissions value (§7.6.3.2 Table 22).

encrypt_metadata: bool

Whether the document metadata stream is encrypted (R≥4).

method: CryptMethod

Per-stream / per-string crypt method. RC4 / AES-128 / AES-256.

file_id: Vec<u8>

Permanent file identifier — placed in /ID[0] and fed into the V≤4 file-key derivation. Use ≥16 bytes of random data per the spec; tests pin it for determinism.

u_salt_validate: [u8; 8]

V=5 user-validation salt (8 bytes).

u_salt_key: [u8; 8]

V=5 user-key salt (8 bytes).

o_salt_validate: [u8; 8]

V=5 owner-validation salt (8 bytes).

o_salt_key: [u8; 8]

V=5 owner-key salt (8 bytes).

file_key_v5: Option<[u8; 32]>

V=5 file encryption key (32 bytes) — random for production, caller-pinned for tests. None defaults to a deterministic-but- non-reused-across-callers value.

perms_padding: [u8; 4]

V=5 Algorithm 10 padding bytes (12..16).

aes_iv: [u8; 16]

IV for AES per-object encryption (16 bytes). Tests pin; production callers should override per-object.

Implementations

impl EncryptionConfig

pub fn aes_128(user_password: &[u8], file_id: &[u8]) -> Self

Sensible R=4 (AES-128) default — empty owner password, no metadata encryption opt-out, full permissions.

pub fn rc4_128(user_password: &[u8], file_id: &[u8]) -> Self

R=3 RC4-128 default.

pub fn rc4_40(user_password: &[u8], file_id: &[u8]) -> Self

R=2 RC4-40 default.

pub fn aes_256_r5(user_password: &[u8], file_id: &[u8]) -> Self

R=5 AES-256 default (Adobe extension level 3).

pub fn aes_256_r6(user_password: &[u8], file_id: &[u8]) -> Self

R=6 AES-256 default (ISO 32000-2 PDF 2.0).

pub fn with_owner_password(self, owner: &[u8]) -> Self

Apply an owner password.

pub fn with_permissions(self, p: i32) -> Self

Override permissions.

Trait Implementations

impl Clone for EncryptionConfig

fn clone(&self) -> EncryptionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptionConfig

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

Formats the value using the given formatter.