A pure virtual class that is used to encrypt a PDF file (RC4, AES-128) This class is the base for classes that implement algorithms based on MD5 hashes. More...
#include <PdfEncrypt.h>
Inheritance diagram for PoDoFo::PdfEncryptMD5Base:
Public Member Functions | |
| void | CreateEncryptionDictionary (PdfDictionary &dictionary) const override |
| Fill all keys into a encryption dictionary. | |
| PdfAuthResult | Authenticate (const std::string_view &password, const std::string_view &documentId, PODOFO_CRYPT_CTX *ctx, unsigned char encryptionKey[32]) const override=0 |
 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. | |
| virtual std::unique_ptr< InputStream > | CreateEncryptionInputStream (InputStream &inputStream, size_t inputLen, PdfEncryptContext &context, const PdfReference &objref) const =0 |
| Create an InputStream that decrypts all data read from it using the current settings of the PdfEncrypt object. | |
| virtual std::unique_ptr< OutputStream > | CreateEncryptionOutputStream (OutputStream &outputStream, PdfEncryptContext &context, const PdfReference &objref) const =0 |
| Create an OutputStream that encrypts all data written to it using the current settings of the PdfEncrypt object. | |
| 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. | |
| virtual size_t | CalculateStreamLength (size_t length) const =0 |
| Calculate stream size. | |
| virtual size_t | CalculateStreamOffset () const =0 |
| Calculate stream offset. | |
| 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 |
Static Protected Member Functions | |
| static void | ComputeOwnerKey (const unsigned char userPad[32], const unsigned char ownerPad[32], unsigned keylength, unsigned revision, bool authenticate, PODOFO_CRYPT_CTX *ctx, unsigned char ownerKey[32]) |
| static void | PadPassword (const std::string_view &password, unsigned char pswd[32]) |
| static void | ComputeEncryptionKey (const std::string_view &documentID, const unsigned char userPad[32], const unsigned char ownerKey[32], PdfPermissions pValue, unsigned keyLength, unsigned revision, bool encryptMetadata, PODOFO_CRYPT_CTX *ctx, unsigned char userKey[32], unsigned char encryptionKey[32]) |
Friends | |
| class | PdfEncryptRC4 |
| class | PdfEncryptAESV2 |
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 pure virtual class that is used to encrypt a PDF file (RC4, AES-128) This class is the base for classes that implement algorithms based on MD5 hashes.
Client code is working only with PdfEncrypt class and knows nothing about PdfEncrypt*, it is created through CreatePdfEncrypt factory method
Member Function Documentation
◆ Authenticate()
|
overridepure virtual |
Implements PoDoFo::PdfEncrypt.
◆ CreateEncryptionDictionary()
|
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.
◆ CreateObjKey()
|
protected |
Create the encryption key for the current object.
- Parameters
-
objkey pointer to an array of at least MD5_HASHBYTES (=16) bytes length pnKeyLen pointer to an integer where the actual keylength is stored.
The documentation for this class was generated from the following files:
- src/podofo/main/PdfEncrypt.h
- src/podofo/main/PdfEncrypt.cpp
