SecureBlackbox 2020 Qt Edition

Questions / Feedback?

PDFDecryptor Class

Properties   Methods   Events   Configuration Settings   Errors  

The PDFDecryptor class decrypts PDF documents.

Syntax

PDFDecryptor

Remarks

PDFDecryptor decrypts PDF documents encrypted with passwords or certificates.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

DecryptionCertificateBytesReturns raw certificate data in DER format.
DecryptionCertificateHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
DecryptionCertCountThe number of records in the DecryptionCert arrays.
DecryptionCertBytesReturns raw certificate data in DER format.
DecryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
EncryptedIndicates if the PDF document is encrypted.
EncryptionAlgorithmThe symmetric algorithm used to encrypt the document.
EncryptionTypeThe document encryption type.
ExternalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
ExternalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecretThe pre-shared key used for DC request authentication.
ExternalCryptoMethodSpecifies the asynchronous signing method.
ExternalCryptoModeSpecifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
InputBytesUse this property to pass the input to class in the byte array form.
InputFileThe PDF file to be decrypted.
MetadataEncryptedIndicates if the document metadata is encrypted.
OutputBytesUse this property to read the output the class object has produced.
OutputFileThe file to save the decrypted document to.
PasswordThe decryption password.
PermsAnnotationsIndicates whether the viewer may add annotations to the document.
PermsAssembleIndicates if the viewer may assemble a new document on the basis of the encrypted one.
PermsExtractIndicates if the user may extract (copy) pictures and text from the encrypted document.
PermsExtractAccIndicates if the user may extract pictures/text from the document for accessibility purposes.
PermsFillInFormsIndicates if the user may fill in forms in the document.
PermsHighQualityPrintIndicates if the document may be printed in high quality.
PermsLowQualityPrintIndicates if the document may be printed in low quality.
PermsModifyIndicates if the document may be modified.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DecryptDecrypts a PDF document.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

DecryptionInfoNeededRequests decryption information during decryption, signing, or validation.
ErrorInformation about errors during signing/validation.
ExternalDecryptHandles remote or external decryption.
NotificationThis event notifies the application about an underlying control flow event.
RecipientFoundProvides recipient certificate details to the application.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

EncryptionHandlerNameSpecifies the custom security handler PDF-name.
HardenedKeyGenerationSpecifies if hardened Key generation should be used.
RC4KeyBitsSpecifies the number of key bits used for RC4 algorithm.
TempPathLocation where the temporary files are stored.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Qt Edition - Version 20.0 [Build 8154]