SecureBlackbox 2020 PHP Edition

Questions / Feedback?

MessageCompressor Class

Properties   Methods   Events   Configuration Settings   Errors  

The MessageCompressor class compresses data and stores it in the PKCS#7 format.

Class Name

SecureBlackbox_MessageCompressor

Procedural Interface

 secureblackbox_messagecompressor_open();
 secureblackbox_messagecompressor_close($res);
 secureblackbox_messagecompressor_register_callback($res, $id, $function);
 secureblackbox_messagecompressor_get_last_error($res);
 secureblackbox_messagecompressor_get_last_error_code($res);
 secureblackbox_messagecompressor_set($res, $id, $index, $value);
 secureblackbox_messagecompressor_get($res, $id, $index);
 secureblackbox_messagecompressor_do_compress($res);
 secureblackbox_messagecompressor_do_config($res, $configurationstring);

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

Property List


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

CompressionLevelCompression level to apply (1-9).
InputBytesUse this property to pass the input to class in the byte array form.
InputFilePath to the source (uncompressed) file.
OutputBytesUse this property to read the output the class object has produced.
OutputFilePath to the destination (compressed) file.

Method List


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

CompressCompresses input data into a PKCS7 message.
ConfigSets or retrieves a configuration setting.

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 PKCS#7 message encryption.
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.

ContentTypeContent type.
FragmentSizeFragment size.
TempPathPath for storing temporary files.
UseUndefSizeAllows or forbids the use of ASN.1 tags of undefined size.
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]