ArchiveReader Class

Properties   Methods   Events   Config Settings   Errors  

The ArchiveReader class supports inspection and extraction of files from zip, tar, gzip and bzip2 archives.

Class Name

SecureBlackbox_ArchiveReader

Procedural Interface

 secureblackbox_archivereader_open();
 secureblackbox_archivereader_close($res);
 secureblackbox_archivereader_register_callback($res, $id, $function);
 secureblackbox_archivereader_get_last_error($res);
 secureblackbox_archivereader_get_last_error_code($res);
 secureblackbox_archivereader_set($res, $id, $index, $value);
 secureblackbox_archivereader_get($res, $id, $index);
 secureblackbox_archivereader_do_close($res);
 secureblackbox_archivereader_do_config($res, $configurationstring);
 secureblackbox_archivereader_do_doaction($res, $actionid, $actionparams);
 secureblackbox_archivereader_do_extract($res, $path, $localpath, $preservefullpath);
 secureblackbox_archivereader_do_extractall($res, $outputpath, $overwriteexisting);
 secureblackbox_archivereader_do_open($res, $archivetype, $archivepath);
 secureblackbox_archivereader_do_openbytes($res, $archivetype, $archivebytes);

Remarks

ArchiveReader shows and extracts archived files.

Property List


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

ArchiveTypeThe type of the archive file.
DecryptionCertCountThe number of records in the DecryptionCert arrays.
DecryptionCertBytesReturns the raw certificate data in DER format.
DecryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
DecryptionPasswordThe decryption password.
FileDataThe contents of the last extracted file.
FileCountThe number of records in the File arrays.
FileActionThe action to apply to the file.
FileCompressedSizeThe size of the file after compression.
FileDataSourceThe type of the data source for this entry.
FileDirectoryTells if the entry is a directory or a regular file.
FileEncryptionAlgorithmReturns the symmetric algorithm that was used to encrypt the file.
FileEncryptionKeyLengthReturns the length, in bits, of the encryption key.
FileEncryptionTypeThe type of encryption applied to the file.
FileFileNameThe original name of the compressed file or folder.
FileFolderThe containing folder of the entry.
FileLocalPathThe local path associated with this entry.
FileMTimeThe entry's last modification time.
FileNewFileIndicates whether the entry corresponds to a file to be added to the archive.
FilePathThe full internal path of the archived entry.
FileSignatureCountThe number of signatures covering the entry.
FileSignedIndicates whether the entry is signed.
FileSizeThe size of the file before compression.
FIPSModeReserved.
HashAlgorithmReturns the hash algorithm that was used to generate the signature.
KnownCertCountThe number of records in the KnownCert arrays.
KnownCertBytesReturns the raw certificate data in DER format.
KnownCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
OpenedIndicates if the class is in the open state.
SignatureValidationResultThe signature validation result.
SigningCertBytesReturns the raw certificate data in DER format.
SigningCertCAIndicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
SigningCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
SigningCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
SigningCertCurveSpecifies the elliptic curve of the EC public key.
SigningCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
SigningCertFriendlyNameContains an associated alias (friendly name) of the certificate.
SigningCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SigningCertHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
SigningCertIssuerThe common name of the certificate issuer (CA), typically a company name.
SigningCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
SigningCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
SigningCertKeyBitsReturns the length of the public key.
SigningCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
SigningCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
SigningCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
SigningCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
SigningCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
SigningCertPublicKeyBytesContains the certificate's public key in DER format.
SigningCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
SigningCertSerialNumberReturns the certificate's serial number.
SigningCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
SigningCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
SigningCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
SigningCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
SigningCertValidFromThe time point at which the certificate becomes valid, in UTC.
SigningCertValidToThe time point at which the certificate expires, in UTC.

Method List


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

CloseCloses the current archive.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
ExtractExtracts a single file from the archive.
ExtractAllExtract all the files contained in the archive.
OpenOpens an archive file.
OpenBytesLoads an archive file from a byte array.

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.

AfterExtractFileMarks the completion of extraction of an archived file.
BeforeExtractFileMarks the start of extraction of an archived file.
DecryptionPasswordNeededRequests a decryption password, when needed.
ErrorReports information about errors during archive processing.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the progress of data extraction.
RecipientFoundInforms the application that an archive is encrypted with a digital certificate.
SignatureFoundSignifies the start of signature validation.

Config Settings


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

AttributesProvides access to file attributes recorded in the archive.
OverwriteExistingWhether the class should overwrite existing files.
RestoreAttributesSpecifies whether the class should apply recorded attributes to the extracted files.
TempPathPath for storing temporary files.
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.
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.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
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.

ArchiveType Property (SecureBlackbox_ArchiveReader Class)

The type of the archive file.

Object Oriented Interface


public function getArchiveType();


Procedural Interface


secureblackbox_archivereader_get($res, 1 );


Default Value

0

Remarks

Use this property to learn about the type (format) of the opened archive.

aftUnknown (0)It was not possible to establish the type of the archive file.
aftZip (1)The archive contains data in ZIP format.
aftGzip (2)The archive file contains data in GZIP format.
aftBzip2 (3)The archive contains BZIP2 data.
aftTar (4)The archive contains a .tar file.
aftTarGzip (5)The archive contains a .tar.gz file.
aftTarBzip2 (6)The archive contains data in .tar.bz2 format.

This property is read-only.

Data Type

Integer

DecryptionCertCount Property (SecureBlackbox_ArchiveReader Class)

The number of records in the DecryptionCert arrays.

Object Oriented Interface


public function getDecryptionCertCount();


public function setDecryptionCertCount($value);

Procedural Interface


secureblackbox_archivereader_get($res, 2 );


secureblackbox_archivereader_set($res, 2, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at DecryptionCertCount - 1.

This property is not available at design time.

Data Type

Integer

DecryptionCertBytes Property (SecureBlackbox_ArchiveReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getDecryptionCertBytes($decryptioncertindex);


Procedural Interface


secureblackbox_archivereader_get($res, 3 , $decryptioncertindex);


Remarks

Returns the raw certificate data in DER format.

The $decryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertHandle Property (SecureBlackbox_ArchiveReader Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getDecryptionCertHandle($decryptioncertindex);


public function setDecryptionCertHandle($decryptioncertindex, $value);

Procedural Interface


secureblackbox_archivereader_get($res, 10 , $decryptioncertindex);


secureblackbox_archivereader_set($res, 10, $value , $decryptioncertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $decryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is not available at design time.

Data Type

Long64

DecryptionPassword Property (SecureBlackbox_ArchiveReader Class)

The decryption password.

Object Oriented Interface


public function getDecryptionPassword();


public function setDecryptionPassword($value);

Procedural Interface


secureblackbox_archivereader_get($res, 37 );


secureblackbox_archivereader_set($res, 37, $value );

Default Value

''

Remarks

Use this property to provide the decryption password for the archive.

Data Type

String

FileData Property (SecureBlackbox_ArchiveReader Class)

The contents of the last extracted file.

Object Oriented Interface


public function getFileData();


public function setFileData($value);

Procedural Interface


secureblackbox_archivereader_get($res, 38 );


secureblackbox_archivereader_set($res, 38, $value );

Remarks

Use this property to get the contents of the last extracted file with DataSource set to stBuffer (2).

This property is not available at design time.

Data Type

Byte Array

FileCount Property (SecureBlackbox_ArchiveReader Class)

The number of records in the File arrays.

Object Oriented Interface


public function getFileCount();


public function setFileCount($value);

Procedural Interface


secureblackbox_archivereader_get($res, 39 );


secureblackbox_archivereader_set($res, 39, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at FileCount - 1.

This property is not available at design time.

Data Type

Integer

FileAction Property (SecureBlackbox_ArchiveReader Class)

The action to apply to the file.

Object Oriented Interface


public function getFileAction($fileindex);


public function setFileAction($fileindex, $value);

Procedural Interface


secureblackbox_archivereader_get($res, 40 , $fileindex);


secureblackbox_archivereader_set($res, 40, $value , $fileindex);

Default Value

0

Remarks

The action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:

atAdd (0)Add the file to the archive
atKeep (1)Keep the existing file in the archive
atUpdate (2)Update the archived file with a fresher copy
atDelete (3)Delete the file from the archive
atExtract (4)Extract the file (extraction only)
atSkip (5)Skip file extraction (extraction only)

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileCompressedSize Property (SecureBlackbox_ArchiveReader Class)

The size of the file after compression.

Object Oriented Interface


public function getFileCompressedSize($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 41 , $fileindex);


Default Value

0

Remarks

The size of the file after compression.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FileDataSource Property (SecureBlackbox_ArchiveReader Class)

The type of the data source for this entry.

Object Oriented Interface


public function getFileDataSource($fileindex);


public function setFileDataSource($fileindex, $value);

Procedural Interface


secureblackbox_archivereader_get($res, 42 , $fileindex);


secureblackbox_archivereader_set($res, 42, $value , $fileindex);

Default Value

0

Remarks

The type of the data source for this entry.

Use this property to control the data source for this entry.

fdsFile (0)The data for this entry should be taken from the file provided via FileLocalPath.
fdsStream (1)The data is going to be provided on-the-fly via the FileStream property.
fdsBuffer (2)The data is going to be provided on-the-fly via the FileData property.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileDirectory Property (SecureBlackbox_ArchiveReader Class)

Tells if the entry is a directory or a regular file.

Object Oriented Interface


public function getFileDirectory($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 43 , $fileindex);


Default Value

false

Remarks

Tells if the entry is a directory or a regular file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileEncryptionAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Returns the symmetric algorithm that was used to encrypt the file.

Object Oriented Interface


public function getFileEncryptionAlgorithm($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 44 , $fileindex);


Default Value

''

Remarks

Returns the symmetric algorithm that was used to encrypt the file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileEncryptionKeyLength Property (SecureBlackbox_ArchiveReader Class)

Returns the length, in bits, of the encryption key.

Object Oriented Interface


public function getFileEncryptionKeyLength($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 45 , $fileindex);


Default Value

0

Remarks

Returns the length, in bits, of the encryption key.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileEncryptionType Property (SecureBlackbox_ArchiveReader Class)

The type of encryption applied to the file.

Object Oriented Interface


public function getFileEncryptionType($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 46 , $fileindex);


Default Value

0

Remarks

The type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.

aetDefault (0)Default encryption (not used for already encrypted files)
aetNoEncryption (1)No encryption
aetGeneric (2)Standard ZIP encryption
aetWinZip (3)WinZIP-based encryption
aetStrong (4)Strong encryption

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileFileName Property (SecureBlackbox_ArchiveReader Class)

The original name of the compressed file or folder.

Object Oriented Interface


public function getFileFileName($fileindex);


public function setFileFileName($fileindex, $value);

Procedural Interface


secureblackbox_archivereader_get($res, 47 , $fileindex);


secureblackbox_archivereader_set($res, 47, $value , $fileindex);

Default Value

''

Remarks

The original name of the compressed file or folder.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileFolder Property (SecureBlackbox_ArchiveReader Class)

The containing folder of the entry.

Object Oriented Interface


public function getFileFolder($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 48 , $fileindex);


Default Value

''

Remarks

The containing folder of the entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileLocalPath Property (SecureBlackbox_ArchiveReader Class)

The local path associated with this entry.

Object Oriented Interface


public function getFileLocalPath($fileindex);


public function setFileLocalPath($fileindex, $value);

Procedural Interface


secureblackbox_archivereader_get($res, 49 , $fileindex);


secureblackbox_archivereader_set($res, 49, $value , $fileindex);

Default Value

''

Remarks

The local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileMTime Property (SecureBlackbox_ArchiveReader Class)

The entry's last modification time.

Object Oriented Interface


public function getFileMTime($fileindex);


public function setFileMTime($fileindex, $value);

Procedural Interface


secureblackbox_archivereader_get($res, 50 , $fileindex);


secureblackbox_archivereader_set($res, 50, $value , $fileindex);

Default Value

''

Remarks

The entry's last modification time.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileNewFile Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the entry corresponds to a file to be added to the archive.

Object Oriented Interface


public function getFileNewFile($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 51 , $fileindex);


Default Value

false

Remarks

Indicates whether the entry corresponds to a file to be added to the archive.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FilePath Property (SecureBlackbox_ArchiveReader Class)

The full internal path of the archived entry.

Object Oriented Interface


public function getFilePath($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 52 , $fileindex);


Default Value

''

Remarks

The full internal path of the archived entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileSignatureCount Property (SecureBlackbox_ArchiveReader Class)

The number of signatures covering the entry.

Object Oriented Interface


public function getFileSignatureCount($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 53 , $fileindex);


Default Value

0

Remarks

The number of signatures covering the entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileSigned Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the entry is signed.

Object Oriented Interface


public function getFileSigned($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 54 , $fileindex);


Default Value

false

Remarks

Indicates whether the entry is signed.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileSize Property (SecureBlackbox_ArchiveReader Class)

The size of the file before compression.

Object Oriented Interface


public function getFileSize($fileindex);


Procedural Interface


secureblackbox_archivereader_get($res, 55 , $fileindex);


Default Value

0

Remarks

The size of the file before compression.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FIPSMode Property (SecureBlackbox_ArchiveReader Class)

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_archivereader_get($res, 56 );


secureblackbox_archivereader_set($res, 56, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Returns the hash algorithm that was used to generate the signature.

Object Oriented Interface


public function getHashAlgorithm();


Procedural Interface


secureblackbox_archivereader_get($res, 57 );


Default Value

''

Remarks

Check this property after calling Extract to get the hash algorithm which was used to calculate the signature.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only and not available at design time.

Data Type

String

KnownCertCount Property (SecureBlackbox_ArchiveReader Class)

The number of records in the KnownCert arrays.

Object Oriented Interface


public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface


secureblackbox_archivereader_get($res, 58 );


secureblackbox_archivereader_set($res, 58, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at KnownCertCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_ArchiveReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getKnownCertBytes($knowncertindex);


Procedural Interface


secureblackbox_archivereader_get($res, 59 , $knowncertindex);


Remarks

Returns the raw certificate data in DER format.

The $knowncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_ArchiveReader Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface


secureblackbox_archivereader_get($res, 66 , $knowncertindex);


secureblackbox_archivereader_set($res, 66, $value , $knowncertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $knowncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

Opened Property (SecureBlackbox_ArchiveReader Class)

Indicates if the class is in the open state.

Object Oriented Interface


public function getOpened();


Procedural Interface


secureblackbox_archivereader_get($res, 93 );


Default Value

false

Remarks

Use this property to check if the component provides access to an open archive file.

This property is read-only.

Data Type

Boolean

SignatureValidationResult Property (SecureBlackbox_ArchiveReader Class)

The signature validation result.

Object Oriented Interface


public function getSignatureValidationResult();


Procedural Interface


secureblackbox_archivereader_get($res, 94 );


Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

This property is read-only and not available at design time.

Data Type

Integer

SigningCertBytes Property (SecureBlackbox_ArchiveReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getSigningCertBytes();


Procedural Interface


secureblackbox_archivereader_get($res, 95 );


Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCA Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Object Oriented Interface


public function getSigningCertCA();


Procedural Interface


secureblackbox_archivereader_get($res, 96 );


Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertCAKeyID Property (SecureBlackbox_ArchiveReader Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Object Oriented Interface


public function getSigningCertCAKeyID();


Procedural Interface


secureblackbox_archivereader_get($res, 97 );


Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (SecureBlackbox_ArchiveReader Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Object Oriented Interface


public function getSigningCertCRLDistributionPoints();


Procedural Interface


secureblackbox_archivereader_get($res, 98 );


Default Value

''

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is read-only and not available at design time.

Data Type

String

SigningCertCurve Property (SecureBlackbox_ArchiveReader Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface


public function getSigningCertCurve();


Procedural Interface


secureblackbox_archivereader_get($res, 99 );


Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

This property is read-only and not available at design time.

Data Type

String

SigningCertFingerprint Property (SecureBlackbox_ArchiveReader Class)

Contains the fingerprint (a hash imprint) of this certificate.

Object Oriented Interface


public function getSigningCertFingerprint();


Procedural Interface


secureblackbox_archivereader_get($res, 100 );


Remarks

Contains the fingerprint (a hash imprint) of this certificate.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertFriendlyName Property (SecureBlackbox_ArchiveReader Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface


public function getSigningCertFriendlyName();


Procedural Interface


secureblackbox_archivereader_get($res, 101 );


Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate.

This property is read-only and not available at design time.

Data Type

String

SigningCertHandle Property (SecureBlackbox_ArchiveReader Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getSigningCertHandle();


Procedural Interface


secureblackbox_archivereader_get($res, 102 );


Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is read-only and not available at design time.

Data Type

Long64

SigningCertHashAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Object Oriented Interface


public function getSigningCertHashAlgorithm();


Procedural Interface


secureblackbox_archivereader_get($res, 103 );


Default Value

''

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuer Property (SecureBlackbox_ArchiveReader Class)

The common name of the certificate issuer (CA), typically a company name.

Object Oriented Interface


public function getSigningCertIssuer();


Procedural Interface


secureblackbox_archivereader_get($res, 104 );


Default Value

''

Remarks

The common name of the certificate issuer (CA), typically a company name.

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuerRDN Property (SecureBlackbox_ArchiveReader Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface


public function getSigningCertIssuerRDN();


Procedural Interface


secureblackbox_archivereader_get($res, 105 );


Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface


public function getSigningCertKeyAlgorithm();


Procedural Interface


secureblackbox_archivereader_get($res, 106 );


Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyBits Property (SecureBlackbox_ArchiveReader Class)

Returns the length of the public key.

Object Oriented Interface


public function getSigningCertKeyBits();


Procedural Interface


secureblackbox_archivereader_get($res, 107 );


Default Value

0

Remarks

Returns the length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyFingerprint Property (SecureBlackbox_ArchiveReader Class)

Returns a fingerprint of the public key contained in the certificate.

Object Oriented Interface


public function getSigningCertKeyFingerprint();


Procedural Interface


secureblackbox_archivereader_get($res, 108 );


Remarks

Returns a fingerprint of the public key contained in the certificate.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertKeyUsage Property (SecureBlackbox_ArchiveReader Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Object Oriented Interface


public function getSigningCertKeyUsage();


Procedural Interface


secureblackbox_archivereader_get($res, 109 );


Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyValid Property (SecureBlackbox_ArchiveReader Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface


public function getSigningCertKeyValid();


Procedural Interface


secureblackbox_archivereader_get($res, 110 );


Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertOCSPLocations Property (SecureBlackbox_ArchiveReader Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Object Oriented Interface


public function getSigningCertOCSPLocations();


Procedural Interface


secureblackbox_archivereader_get($res, 111 );


Default Value

''

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is read-only and not available at design time.

Data Type

String

SigningCertPolicyIDs Property (SecureBlackbox_ArchiveReader Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface


public function getSigningCertPolicyIDs();


Procedural Interface


secureblackbox_archivereader_get($res, 114 );


Default Value

''

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

This property is read-only and not available at design time.

Data Type

String

SigningCertPublicKeyBytes Property (SecureBlackbox_ArchiveReader Class)

Contains the certificate's public key in DER format.

Object Oriented Interface


public function getSigningCertPublicKeyBytes();


Procedural Interface


secureblackbox_archivereader_get($res, 118 );


Remarks

Contains the certificate's public key in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSelfSigned Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Object Oriented Interface


public function getSigningCertSelfSigned();


Procedural Interface


secureblackbox_archivereader_get($res, 120 );


Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertSerialNumber Property (SecureBlackbox_ArchiveReader Class)

Returns the certificate's serial number.

Object Oriented Interface


public function getSigningCertSerialNumber();


Procedural Interface


secureblackbox_archivereader_get($res, 121 );


Remarks

Returns the certificate's serial number.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSigAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Object Oriented Interface


public function getSigningCertSigAlgorithm();


Procedural Interface


secureblackbox_archivereader_get($res, 122 );


Default Value

''

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

This property is read-only and not available at design time.

Data Type

String

SigningCertSubject Property (SecureBlackbox_ArchiveReader Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface


public function getSigningCertSubject();


Procedural Interface


secureblackbox_archivereader_get($res, 123 );


Default Value

''

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

This property is read-only and not available at design time.

Data Type

String

SigningCertSubjectKeyID Property (SecureBlackbox_ArchiveReader Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface


public function getSigningCertSubjectKeyID();


Procedural Interface


secureblackbox_archivereader_get($res, 125 );


Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSubjectRDN Property (SecureBlackbox_ArchiveReader Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Object Oriented Interface


public function getSigningCertSubjectRDN();


Procedural Interface


secureblackbox_archivereader_get($res, 126 );


Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is read-only and not available at design time.

Data Type

String

SigningCertValidFrom Property (SecureBlackbox_ArchiveReader Class)

The time point at which the certificate becomes valid, in UTC.

Object Oriented Interface


public function getSigningCertValidFrom();


Procedural Interface


secureblackbox_archivereader_get($res, 127 );


Default Value

''

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is read-only and not available at design time.

Data Type

String

SigningCertValidTo Property (SecureBlackbox_ArchiveReader Class)

The time point at which the certificate expires, in UTC.

Object Oriented Interface


public function getSigningCertValidTo();


Procedural Interface


secureblackbox_archivereader_get($res, 128 );


Default Value

''

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only and not available at design time.

Data Type

String

Close Method (SecureBlackbox_ArchiveReader Class)

Closes the current archive.

Object Oriented Interface

public function doClose();

Procedural Interface

secureblackbox_archivereader_do_close($res);

Remarks

Use this method to close the archive that is currently opened and release the associated memory. You won't be able to extract files or access the archive details after closing the archive.

Config Method (SecureBlackbox_ArchiveReader Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_archivereader_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (SecureBlackbox_ArchiveReader Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_archivereader_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Extract Method (SecureBlackbox_ArchiveReader Class)

Extracts a single file from the archive.

Object Oriented Interface

public function doExtract($path, $localpath, $preservefullpath);

Procedural Interface

secureblackbox_archivereader_do_extract($res, $path, $localpath, $preservefullpath);

Remarks

Use this method to extract a single file from the archive.

Pass the internal path to the entry in the archive via the Path parameter, and the path where to save the extracted entry via the LocalPath parameter. Set PreserveFullPath to true to enforce full-path extraction, in which case LocalPath would indicate the mount point at which the full Path needs to be rooted. If PreserveFullPath is false, the LocalPath provides the final location for the extracted file.

Use ExtractAll to extract all files at once.

ExtractAll Method (SecureBlackbox_ArchiveReader Class)

Extract all the files contained in the archive.

Object Oriented Interface

public function doExtractAll($outputpath, $overwriteexisting);

Procedural Interface

secureblackbox_archivereader_do_extractall($res, $outputpath, $overwriteexisting);

Remarks

Use this method to extract all the files contained in the archive file. Pass the path where the extracted files should be saved via the OutputPath parameter. Existing files will be overwritten if the OverwriteExisting parameter is set to true.

You can cherry-pick the files to extract, as well as choose different extraction destinations (including files at custom locations, streams, or memory buffers) by subscribing to BeforeExtractFile and AfterExtractFile events.

Use Extract to extract a single file.

Open Method (SecureBlackbox_ArchiveReader Class)

Opens an archive file.

Object Oriented Interface

public function doOpen($archivetype, $archivepath);

Procedural Interface

secureblackbox_archivereader_do_open($res, $archivetype, $archivepath);

Remarks

Call this method to open an archive file. Provide the archive type via the ArchiveType parameter, and the path via the ArchivePath parameter.

The following archive types (formats) are supported:

aftUnknown (0)Unknown type.
aftZip (1)The archive contains data in ZIP format.
aftGzip (2)The archive file contains data in GZIP format.
aftBzip2 (3)The archive contains BZIP2 data.
aftTarGzip (4)The archive contains a .tar.gz file.
aftTarBzip2 (5)The archive contains data in .tar.bz2 format.

OpenBytes Method (SecureBlackbox_ArchiveReader Class)

Loads an archive file from a byte array.

Object Oriented Interface

public function doOpenBytes($archivetype, $archivebytes);

Procedural Interface

secureblackbox_archivereader_do_openbytes($res, $archivetype, $archivebytes);

Remarks

Call this method to load an archive file from a byte array. Provide the archive type via the ArchiveType parameter, and the byte array containing the archive data via the ArchiveBytes parameter.

The following archive types (formats) are supported:

aftUnknown (0)Unknown type.
aftZip (1)The archive contains data in ZIP format.
aftGzip (2)The archive file contains data in GZIP format.
aftBzip2 (3)The archive contains BZIP2 data.
aftTarGzip (4)The archive contains a .tar.gz file.
aftTarBzip2 (5)The archive contains data in .tar.bz2 format.

AfterExtractFile Event (SecureBlackbox_ArchiveReader Class)

Marks the completion of extraction of an archived file.

Object Oriented Interface

public function fireAfterExtractFile($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 1, array($this, 'fireAfterExtractFile'));

Parameter List

 'path'
'filesize'
'datasource'

Remarks

Subscribe to this event to get notified about the completion of extraction of an archived file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the decompressed file, and the DataSource specifies the type of the destination media.

fdsFile (0)The data was saved to a file.
fdsStream (1)The data was saved into a stream assigned to FileStream property.
fdsBuffer (2)The file data is available in FileData buffer.

BeforeExtractFile Event (SecureBlackbox_ArchiveReader Class)

Marks the start of extraction of an archived file.

Object Oriented Interface

public function fireBeforeExtractFile($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 2, array($this, 'fireBeforeExtractFile'));

Parameter List

 'path'
'filesize'
'datasource'
'extractionpath'
'skip'

Remarks

Subscribe to this event to be notified about the start of extraction of an archived entry. The handler of this event is a good place to tune up the destination media.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the uncompressed size of the file. Set the by-reference DataSource parameter in accordance with the desired extraction media type:

fdsFile (0)The data will be saved to a file indicated by the ExtractionPath parameter. You can change the path here.
fdsStream (1)The data will be saved into a stream assigned to FileStream property.
fdsBuffer (2)The file data will be saved to a buffer and returned via the FileData property.
If saving to a stream or buffer, use AfterExtractFile to collect the extracted data from FileStream or FileData, and dispose of any objects allocated in this event handler (such as the output stream).

Use the Skip parameter to cancel extraction of this file and proceed to the next one.

DecryptionPasswordNeeded Event (SecureBlackbox_ArchiveReader Class)

Requests a decryption password, when needed.

Object Oriented Interface

public function fireDecryptionPasswordNeeded($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 3, array($this, 'fireDecryptionPasswordNeeded'));

Parameter List

 'passwordtarget'
'cancel'

Remarks

Class fires this event when it needs a password to decrypt the archive. Subscribe to this event if you expect to process encrypted archives.

Inside the event handler, please assign the correct password to DecryptionPassword property, or set Cancel parameter to true to terminate the processing.

Error Event (SecureBlackbox_ArchiveReader Class)

Reports information about errors during archive processing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 4, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

Remarks

The event is fired in case of exceptional conditions during archive processing.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SecureBlackbox_ArchiveReader Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 5, array($this, 'fireNotification'));

Parameter List

 'eventid'
'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (SecureBlackbox_ArchiveReader Class)

Reports the progress of data extraction.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 6, array($this, 'fireProgress'));

Parameter List

 'processed'
'total'
'overallprocessed'
'overalltotal'
'cancel'

Remarks

Subscribe to this event to be notified about decompression progress.

Processed and Total report the progress of extraction of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (SecureBlackbox_ArchiveReader Class)

Informs the application that an archive is encrypted with a digital certificate.

Object Oriented Interface

public function fireRecipientFound($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 7, array($this, 'fireRecipientFound'));

Parameter List

 'recipienthash'
'certfound'

Remarks

The class fires this event when processing archives encrypted with an X.509 certificate. CertFound indicates whether the matching certificate has been found in DecryptionCertificates collection.

This event is an opportunity to add the decryption certificate on a later stage if it was not known at the start of the processing.

SignatureFound Event (SecureBlackbox_ArchiveReader Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 8, array($this, 'fireSignatureFound'));

Parameter List

 'issuerrdn'
'serialnumber'
'subjectkeyid'
'certfound'
'validatesignature'
'validatechain'

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

Config Settings (ArchiveReader Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

ArchiveReader Config Settings

Attributes:   Provides access to file attributes recorded in the archive.

Use this configuration setting to retrieve attributes for the files kept in the archive. Windows- and Unix-style attributes are supported: Console.WriteLine(reader.Files[i].FileName); Console.WriteLine(reader.Config("Attributes[" + i.ToString() + "]")); // outputs: // // file1.txt // unix:-rw-r--r--

OverwriteExisting:   Whether the component should overwrite existing files.

Enable this property to force overwriting of existing files.

RestoreAttributes:   Specifies whether the component should apply recorded attributes to the extracted files.

If this config setting is enabled, the component will apply the attributes saved in the archive to the extracted files. Enabling this setting may carry compatibility risks as certain file systems may not support attribute management fully.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (ArchiveReader Class)