SecureBlackbox 2020 macOS Edition

Questions / Feedback?

PDFEncryptor Module

Properties   Methods   Events   Configuration Settings   Errors  

The PDFEncryptor component encrypts PDF documents.

Syntax

nsoftware.SecureBlackbox.Pdfencryptor

Remarks

PDFEncryptor encrypts PDF documents with passwords or certificates.

Property List


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

EncryptionAlgorithmThe encryption algorithm to encrypt the document with.
EncryptionCertificateThe encryption certificate.
EncryptionCertificatesThe encryption certificates.
EncryptionTypeThe encryption type.
EncryptMetadataSpecifies whether to encrypt the document metadata.
InputBytesUse this property to pass the input to component in the byte array form.
InputFileThe PDF file to be encrypted.
OutputBytesUse this property to read the output the component object has produced.
OutputFileThe file to save the encrypted document to.
OwnerPasswordThe owner password.
PermissionsSpecifies the document permissions associated with the encryption.
UserPasswordThe user password.

Method List


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

ConfigSets or retrieves a configuration setting.
EncryptEncrypts the PDF document.

Event List


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

ErrorInformation about errors during encryption.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


The following is a list of configuration settings for the module 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 component (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 components 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 macOS Edition - Version 20.0 [Build 8165]