SecureBlackbox 2020 PHP Edition

Questions / Feedback?

OfficeEncryptor Class

Properties   Methods   Events   Configuration Settings   Errors  

The OfficeEncryptor class encrypts Office documents.

Class Name


Procedural Interface

 secureblackbox_officeencryptor_register_callback($res, $id, $function);
 secureblackbox_officeencryptor_set($res, $id, $index, $value);
 secureblackbox_officeencryptor_get($res, $id, $index);
 secureblackbox_officeencryptor_do_config($res, $configurationstring);


OfficeEncryptor encrypts Office documents.

Property List

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

DocumentFormatDefines the format of the Office document.
EncryptionAlgorithmThe encryption algorithm used to encrypt the document.
EncryptionTypeThe encryption type used to encrypt the document.
InputBytesUse this property to pass the input to class in the byte array form.
InputFileThe Office file to be encrypted.
OutputBytesUse this property to read the output the class object has produced.
OutputFileDefines where to save the encrypted document.
PasswordThe password used for decryption.

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.
EncryptEncrypts the whole 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.

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

Configuration Settings

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

ChecksumAlgorithmSpecifies checksum algorithm that should be used.
EncryptDocumentPropertiesSpecifies if document properties should be encrypted.
HardenedKeyGenerationSpecifies if hardened Key generation should be used.
HashAlgorithmSpecifies hash algorithm that should be used.
RC4KeyBitsSpecifies the number of key bits used for RC4 algorithm.
SaltSizeSpecifies salt size that should be used.
SpinCountSpecifies spin count that should be used.
StartKeyGenerationAlgorithmSpecifies start key generation algorithm that should be used.
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 PHP Edition - Version 20.0 [Build 8165]