A class that is used to encrypt a PDF file (AES-256) More...

#include <PdfEncrypt.h>

Inheritance diagram for PoDoFo::PdfEncryptAESV3:

Public Member Functions
std::unique_ptr< InputStream >	CreateEncryptionInputStream (InputStream &inputStream, size_t inputLen, PdfEncryptContext &context, const PdfReference &objref) const override
	Create an InputStream that decrypts all data read from it using the current settings of the PdfEncrypt object.

std::unique_ptr< OutputStream >	CreateEncryptionOutputStream (OutputStream &outputStream, PdfEncryptContext &context, const PdfReference &objref) const override
	Create an OutputStream that encrypts all data written to it using the current settings of the PdfEncrypt object.

size_t	CalculateStreamOffset () const override
	Calculate stream offset.

size_t	CalculateStreamLength (size_t length) const override
	Calculate stream size.

void	CreateEncryptionDictionary (PdfDictionary &dictionary) const override
	Fill all keys into a encryption dictionary.

bufferview	GetUEValue () const

bufferview	GetOEValue () const

bufferview	GetPermsValue () const

Public Member Functions inherited from PoDoFo::PdfEncrypt
void	EnsureEncryptionInitialized (const PdfString &documentId, PdfEncryptContext &context)
	Ensure encryption key and /O, /U, /OE, /UE values are initialized.

void	Authenticate (const std::string_view &password, const PdfString &documentId, PdfEncryptContext &context) const
	Tries to authenticate a user using either the user or owner password.

PdfEncryptionAlgorithm	GetEncryptAlgorithm () const
	Get the encryption algorithm of this object.

bool	IsOwnerPasswordSet () const
	Checks if an owner password is set.

bool	IsPrintAllowed () const
	Checks if printing this document is allowed.

bool	IsEditAllowed () const
	Checks if modifying this document (besides annotations, form fields or changing pages) is allowed.

bool	IsCopyAllowed () const
	Checks if text and graphics extraction is allowed.

bool	IsEditNotesAllowed () const
	Checks if it is allowed to add or modify annotations or form fields Every PDF consuming applications has to adhere this value!

bool	IsFillAndSignAllowed () const
	Checks if it is allowed to fill in existing form or signature fields Every PDF consuming applications has to adhere this value!

bool	IsAccessibilityAllowed () const
	Checks if it is allowed to extract text and graphics to support users with disabilities Every PDF consuming applications has to adhere this value!

bool	IsDocAssemblyAllowed () const
	Checks if it is allowed to insert, create, rotate, delete pages or add bookmarks Every PDF consuming applications has to adhere this value!

bool	IsHighPrintAllowed () const
	Checks if it is allowed to print a high quality version of this document Every PDF consuming applications has to adhere this value!

void	EncryptTo (charbuff &out, const bufferview &view, PdfEncryptContext &context, const PdfReference &objref) const
	Encrypt a character span.

void	DecryptTo (charbuff &out, const bufferview &view, PdfEncryptContext &context, const PdfReference &objref) const
	Decrypt a character span.

unsigned	GetKeyLengthBytes () const
	Get the encryption key length in bytes.

bufferview	GetUValue () const
	Get the U object value (user)

bufferview	GetOValue () const
	Get the O object value (owner)

PdfKeyLength	GetKeyLength () const
	Get the length of the encryption key in bits.

PdfPermissions	GetPValue () const
	Get the P object value (protection)

unsigned	GetRevision () const
	Get the revision number of the encryption method.

bool	IsMetadataEncrypted () const

bool	IsParsed () const

Protected Member Functions
void	Encrypt (const char inStr, size_t inLen, PdfEncryptContext &context, const PdfReference &objref, char outStr, size_t outLen) const override

void	Decrypt (const char inStr, size_t inLen, PdfEncryptContext &context, const PdfReference &objref, char outStr, size_t &outLen) const override

PdfAuthResult	Authenticate (const std::string_view &password, const std::string_view &documentId, PODOFO_CRYPT_CTX *ctx, unsigned char encryptionKey[32]) const override

void	GenerateEncryptionKey (const std::string_view &documentId, PdfAuthResult authResult, PODOFO_CRYPT_CTX *ctx, unsigned char uValue[48], unsigned char oValue[48], unsigned char encryptionKey[32]) override

Protected Member Functions inherited from PoDoFo::PdfEncrypt
const unsigned char *	GetUValueRaw () const

const unsigned char *	GetOValueRaw () const

const std::string &	GetUserPassword () const

const std::string &	GetOwnerPassword () const

int64_t	GetPValueForSerialization () const

void	InitFromValues (PdfEncryptionAlgorithm algorithm, PdfKeyLength keyLength, unsigned char revision, PdfPermissions pValue, const bufferview &uValue, const bufferview &oValue, bool encryptedMetadata)
	Init from parsed values.

void	InitFromScratch (const std::string_view &userPassword, const std::string_view &ownerPassword, PdfEncryptionAlgorithm algorithm, PdfKeyLength keyLength, unsigned char revision, PdfPermissions pValue, bool encryptedMetadata)
	Init from scratch with user/owner password.

bool	CheckKey (const unsigned char key1[32], const unsigned char key2[32]) const

Friends
class	PdfEncrypt

Additional Inherited Members
Static Public Member Functions inherited from PoDoFo::PdfEncrypt
static std::unique_ptr< PdfEncrypt >	Create (const std::string_view &userPassword, const std::string_view &ownerPassword, PdfPermissions protection=PdfPermissions::Default, PdfEncryptionAlgorithm algorithm=PdfEncryptionAlgorithm::AESV3R6, PdfKeyLength keyLength=PdfKeyLength::Unknown)
	Create a PdfEncrypt object which can be used to encrypt a PDF file.

static std::unique_ptr< PdfEncrypt >	CreateFromObject (const PdfObject &obj)
	Initialize a PdfEncrypt object from an encryption dictionary in a PDF file.

static PdfEncryptionAlgorithm	GetEnabledEncryptionAlgorithms ()
	Retrieve the list of encryption algorithms that are used when loading a PDF document.

static bool	IsEncryptionEnabled (PdfEncryptionAlgorithm algorithm)
	Test if a certain encryption algorithm is enabled for loading PDF documents.

Protected Types inherited from PoDoFo::PdfEncrypt
enum class	PdfRC4Revision : uint8_t { R2 = 2 , R3 = 3 }

enum class	PdfAESV3Revision : uint8_t { R5 = 5 , R6 = 6 }

Detailed Description

A class that is used to encrypt a PDF file (AES-256)

Client code is working only with PdfEncrypt class and knows nothing about PdfEncryptAES*, it is created through CreatePdfEncrypt factory method

Member Function Documentation

◆ Authenticate()

PdfAuthResult PdfEncryptAESV3::Authenticate	(	const std::string_view &	password,
		const std::string_view &	documentId,
		PODOFO_CRYPT_CTX *	ctx,
		unsigned char	encryptionKey[32]
	)		const

overrideprotectedvirtual

Implements PoDoFo::PdfEncrypt.

◆ CalculateStreamLength()

size_t PdfEncryptAESV3::CalculateStreamLength ( size_t length ) const

overridevirtual

Calculate stream size.

Implements PoDoFo::PdfEncrypt.

◆ CalculateStreamOffset()

size_t PdfEncryptAESV3::CalculateStreamOffset ( ) const

overridevirtual

Calculate stream offset.

Implements PoDoFo::PdfEncrypt.

◆ CreateEncryptionDictionary()

void PdfEncryptAESV3::CreateEncryptionDictionary ( PdfDictionary & dictionary ) const

overridevirtual

Fill all keys into a encryption dictionary.

This dictionary is usually added to the PDF files trailer under the /Encryption key.

Parameters

dictionary an empty dictionary which is filled with information about the used encryption algorithm

Implements PoDoFo::PdfEncrypt.

◆ CreateEncryptionInputStream()

unique_ptr< InputStream > PdfEncryptAESV3::CreateEncryptionInputStream	(	InputStream &	inputStream,
		size_t	inputLen,
		PdfEncryptContext &	context,
		const PdfReference &	objref
	)		const

overridevirtual

Create an InputStream that decrypts all data read from it using the current settings of the PdfEncrypt object.

Warning: Currently only RC4 based encryption is supported using output streams!

Parameters

inputStream the created InputStream reads all decrypted data to this input stream.

Returns: an InputStream that decrypts all data.

Implements PoDoFo::PdfEncrypt.

◆ CreateEncryptionOutputStream()

unique_ptr< OutputStream > PdfEncryptAESV3::CreateEncryptionOutputStream	(	OutputStream &	outputStream,
		PdfEncryptContext &	context,
		const PdfReference &	objref
	)		const

overridevirtual

Create an OutputStream that encrypts all data written to it using the current settings of the PdfEncrypt object.

Warning: Currently only RC4 based encryption is supported using output streams!

Parameters

outputStream the created OutputStream writes all encrypted data to this output stream.

Returns: a OutputStream that encrypts all data.

Implements PoDoFo::PdfEncrypt.

◆ Decrypt()

void PdfEncryptAESV3::Decrypt	(	const char *	inStr,
		size_t	inLen,
		PdfEncryptContext &	context,
		const PdfReference &	objref,
		char *	outStr,
		size_t &	outLen
	)		const

overrideprotectedvirtual

Implements PoDoFo::PdfEncrypt.

◆ Encrypt()

void PdfEncryptAESV3::Encrypt	(	const char *	inStr,
		size_t	inLen,
		PdfEncryptContext &	context,
		const PdfReference &	objref,
		char *	outStr,
		size_t	outLen
	)		const

overrideprotectedvirtual

Implements PoDoFo::PdfEncrypt.

◆ GenerateEncryptionKey()

void PdfEncryptAESV3::GenerateEncryptionKey	(	const std::string_view &	documentId,
		PdfAuthResult	authResult,
		PODOFO_CRYPT_CTX *	ctx,
		unsigned char	uValue[48],
		unsigned char	oValue[48],
		unsigned char	encryptionKey[32]
	)

overrideprotectedvirtual

Implements PoDoFo::PdfEncrypt.

The documentation for this class was generated from the following files:

src/podofo/main/PdfEncrypt.h
src/podofo/main/PdfEncrypt.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Authenticate()

◆ CalculateStreamLength()

◆ CalculateStreamOffset()

◆ CreateEncryptionDictionary()

◆ CreateEncryptionInputStream()

◆ CreateEncryptionOutputStream()

◆ Decrypt()

◆ Encrypt()

◆ GenerateEncryptionKey()