Skip to main content

EncryptionHandler

Struct EncryptionHandler 

Source
pub struct EncryptionHandler { /* private fields */ }
Expand description

Main encryption handler for PDF documents.

This struct manages the encryption state and provides methods for authenticating passwords and decrypting content.

Implementations§

Source§

impl EncryptionHandler

Source

pub fn new(encrypt_obj: &Object, file_id: Vec<u8>) -> Result<Self>

Create a new encryption handler from an encryption dictionary.

§Arguments
  • encrypt_obj - The /Encrypt dictionary object from the PDF trailer
  • file_id - The first element of the /ID array from the PDF trailer
§Returns

An encryption handler ready for password authentication

Source

pub fn authenticate(&mut self, password: &[u8]) -> Result<bool>

Authenticate with a password.

This attempts to authenticate with the given password as either a user password or owner password. If successful, the encryption key is derived and stored for future decryption operations.

§Arguments
  • password - The password to authenticate (empty string for no password)
§Returns

Ok(true) if authentication succeeded, Ok(false) if it failed, or an error if the encryption is unsupported.

Source

pub fn is_authenticated(&self) -> bool

Check if the handler has been authenticated.

Source

pub fn encryption_key(&self) -> Option<&[u8]>

Get the encryption key (if authenticated).

Source

pub fn permissions(&self) -> Permissions

Get the permissions.

Source

pub fn algorithm(&self) -> Algorithm

Get the encryption algorithm.

Source

pub fn decrypt_stream( &self, data: &[u8], obj_num: u32, gen_num: u32, ) -> Result<Vec<u8>>

Decrypt a stream using the encryption key.

PDF Spec: Section 7.6.2 - General Encryption Algorithm

§Arguments
  • data - The encrypted stream data
  • obj_num - Object number
  • gen_num - Generation number
§Returns

The decrypted stream data, or an error if decryption fails

Source

pub fn decrypt_string( &self, data: &[u8], obj_num: u32, gen_num: u32, ) -> Result<Vec<u8>>

Decrypt a string using the encryption key.

§Arguments
  • data - The encrypted string data
  • obj_num - Object number
  • gen_num - Generation number
§Returns

The decrypted string data

Trait Implementations§

Source§

impl Clone for EncryptionHandler

Source§

fn clone(&self) -> EncryptionHandler

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EncryptionHandler

Source§

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

Formats the value using the given formatter. Read more

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> Ungil for T
where T: Send,