# ArchiveReader Class The ArchiveReader class supports inspection and extraction of files from zip, tar, gzip and bzip2 archives. ## Class Name **SecureBlackbox_ArchiveReader** ## Procedural Interface ```text 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); secureblackbox_archivereader_do_open($res, $archivetype, $archivepath); secureblackbox_archivereader_do_openbytes($res, $archivetype, $archivebytes); secureblackbox_archivereader_do_reset($res); ``` ## Remarks ArchiveReader offers capabilities of inspecting, editing, and unpacking archived files from a variety of archive formats. ```text ArchiveReader archiveReader = new ArchiveReader(); archiveReader.setDecryptionPassword("MyPassword"); // the decryption password for the archive // Opens the archive file, first param is the archive type and the second one the path of the archive archiveReader.open(ArchiveReader.aftZip,"C:/MyArchives/folder.zip"); // extract all the files to the path provided archiveReader.extractAll("C:/Extracted/extractedFolder"); ``` The following common archive formats are supported: - ZIP (.zip) - GZip (.gz) - BZip2 (.bz2) - Tar+GZip (.tar.gz) - Tar+Bzip2 (.tar.bz2) ### Working with ArchiveReader Work with ArchiveReader builds on the following steps: **Opening the archive.** On this step the component loads the provided compressed data into its memory. You can pass the compressed data as a byte array ([OpenBytes](#openbytes-method-secureblackbox_archivereader-class)), as a stream (OpenStream), or load it from a disk file ([Open](#open-method-secureblackbox_archivereader-class)). **Inspecting the archive contents** Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' > and > properties to configure bespoke processing for specific files. **Extracting the files** Call [ExtractAll](#extractall-method-secureblackbox_archivereader-class) to initiate extraction of all the files contained in the archive and selected using the > property, or [Extract](#extract-method-secureblackbox_archivereader-class) to extract a single file. The component notifies your code about each individual extraction using its [BeforeExtractFile](#beforeextractfile-event-secureblackbox_archivereader-class) and [AfterExtractFile](#afterextractfile-event-secureblackbox_archivereader-class) events. You can use [BeforeExtractFile](#beforeextractfile-event-secureblackbox_archivereader-class) to provide your final decision about the extraction of a particular file. Use [DecryptionPassword](#decryptionpassword-property-secureblackbox_archivereader-class) property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the [DecryptionPasswordNeeded](#decryptionpasswordneeded-event-secureblackbox_archivereader-class) event. This event is fired repeatedly until the correct password is provided or its *Cancel* parameter is returned as true. **Closing the archive** Once you are finished with the archive, call the component's [Close](#close-method-secureblackbox_archivereader-class) method to close the archive file and release the associated memory. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ArchiveType](#archivetype-property-secureblackbox_archivereader-class) | The type of the archive file. | | [DecryptionCertCount](#decryptioncertcount-property-secureblackbox_archivereader-class) | The number of records in the DecryptionCert arrays. | | [DecryptionCertBytes](#decryptioncertbytes-property-secureblackbox_archivereader-class) | Returns the raw certificate data in DER format. | | [DecryptionCertHandle](#decryptioncerthandle-property-secureblackbox_archivereader-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [DecryptionPassword](#decryptionpassword-property-secureblackbox_archivereader-class) | The decryption password. | | [FileData](#filedata-property-secureblackbox_archivereader-class) | The contents of the last extracted file. | | [FileCount](#filecount-property-secureblackbox_archivereader-class) | The number of records in the File arrays. | | [FileAction](#fileaction-property-secureblackbox_archivereader-class) | This property contains the action to apply to the file. | | [FileAttributes](#fileattributes-property-secureblackbox_archivereader-class) | This property provides access to file attributes. | | [FileCompressedSize](#filecompressedsize-property-secureblackbox_archivereader-class) | This property contains the size of the file after compression. | | [FileDataSource](#filedatasource-property-secureblackbox_archivereader-class) | This property contains the type of data source for this entry. | | [FileDirectory](#filedirectory-property-secureblackbox_archivereader-class) | This property tells if the entry is a directory or a regular file. | | [FileEncryptionAlgorithm](#fileencryptionalgorithm-property-secureblackbox_archivereader-class) | This property returns the symmetric algorithm that was used to encrypt the file. | | [FileEncryptionKeyLength](#fileencryptionkeylength-property-secureblackbox_archivereader-class) | This property returns the length, in bits, of the encryption key. | | [FileEncryptionType](#fileencryptiontype-property-secureblackbox_archivereader-class) | This property contains the type of encryption applied to the file. | | [FileName](#filename-property-secureblackbox_archivereader-class) | This property specifies the original name of the compressed file or folder. | | [FileFolder](#filefolder-property-secureblackbox_archivereader-class) | This property includes the containing folder of the entry. | | [FileLocalPath](#filelocalpath-property-secureblackbox_archivereader-class) | This property contains the local path associated with this entry. | | [FileMTime](#filemtime-property-secureblackbox_archivereader-class) | This property contains the entry's last modification time. | | [FileNewFile](#filenewfile-property-secureblackbox_archivereader-class) | This property indicates whether the entry corresponds to a file to be added to the archive. | | [FilePath](#filepath-property-secureblackbox_archivereader-class) | This property contains the full internal path of the archived entry. | | [FileSignatureCount](#filesignaturecount-property-secureblackbox_archivereader-class) | This property includes the number of signatures covering the entry. | | [FileSigned](#filesigned-property-secureblackbox_archivereader-class) | This property indicates whether the entry is signed. | | [FileSize](#filesize-property-secureblackbox_archivereader-class) | This property specifies the size of the file before compression. | | [FIPSMode](#fipsmode-property-secureblackbox_archivereader-class) | Reserved. | | [HashAlgorithm](#hashalgorithm-property-secureblackbox_archivereader-class) | Returns the hash algorithm that was used to generate the signature. | | [KnownCertCount](#knowncertcount-property-secureblackbox_archivereader-class) | The number of records in the KnownCert arrays. | | [KnownCertBytes](#knowncertbytes-property-secureblackbox_archivereader-class) | Returns the raw certificate data in DER format. | | [KnownCertHandle](#knowncerthandle-property-secureblackbox_archivereader-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [Opened](#opened-property-secureblackbox_archivereader-class) | Indicates if the class is in the open state. | | [Overwrite](#overwrite-property-secureblackbox_archivereader-class) | Whether the class should overwrite existing files. | | [SignatureValidationResult](#signaturevalidationresult-property-secureblackbox_archivereader-class) | The signature validation result. | | [SigningCertBytes](#signingcertbytes-property-secureblackbox_archivereader-class) | Returns the raw certificate data in DER format. | | [SigningCertCA](#signingcertca-property-secureblackbox_archivereader-class) | Indicates whether the certificate has a CA capability. | | [SigningCertCAKeyID](#signingcertcakeyid-property-secureblackbox_archivereader-class) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [SigningCertCRLDistributionPoints](#signingcertcrldistributionpoints-property-secureblackbox_archivereader-class) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [SigningCertCurve](#signingcertcurve-property-secureblackbox_archivereader-class) | Specifies the elliptic curve associated with the certificate's public key. | | [SigningCertFingerprint](#signingcertfingerprint-property-secureblackbox_archivereader-class) | Contains the fingerprint (a hash imprint) of this certificate. | | [SigningCertFriendlyName](#signingcertfriendlyname-property-secureblackbox_archivereader-class) | Contains an associated alias (friendly name) of the certificate. | | [SigningCertHandle](#signingcerthandle-property-secureblackbox_archivereader-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningCertHashAlgorithm](#signingcerthashalgorithm-property-secureblackbox_archivereader-class) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [SigningCertIssuer](#signingcertissuer-property-secureblackbox_archivereader-class) | The common name of the certificate issuer (CA), typically a company name. | | [SigningCertIssuerRDN](#signingcertissuerrdn-property-secureblackbox_archivereader-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [SigningCertKeyAlgorithm](#signingcertkeyalgorithm-property-secureblackbox_archivereader-class) | Specifies the public key algorithm of this certificate. | | [SigningCertKeyBits](#signingcertkeybits-property-secureblackbox_archivereader-class) | Returns the length of the public key in bits. | | [SigningCertKeyFingerprint](#signingcertkeyfingerprint-property-secureblackbox_archivereader-class) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [SigningCertKeyUsage](#signingcertkeyusage-property-secureblackbox_archivereader-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [SigningCertKeyValid](#signingcertkeyvalid-property-secureblackbox_archivereader-class) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [SigningCertOCSPLocations](#signingcertocsplocations-property-secureblackbox_archivereader-class) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [SigningCertPolicyIDs](#signingcertpolicyids-property-secureblackbox_archivereader-class) | Contains identifiers (OIDs) of the applicable certificate policies. | | [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_archivereader-class) | Contains the certificate's public key in DER format. | | [SigningCertSelfSigned](#signingcertselfsigned-property-secureblackbox_archivereader-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [SigningCertSerialNumber](#signingcertserialnumber-property-secureblackbox_archivereader-class) | Returns the certificate's serial number. | | [SigningCertSigAlgorithm](#signingcertsigalgorithm-property-secureblackbox_archivereader-class) | Indicates the algorithm that was used by the CA to sign this certificate. | | [SigningCertSubject](#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. | | [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_archivereader-class) | Contains a unique identifier of the certificate's cryptographic key. | | [SigningCertSubjectRDN](#signingcertsubjectrdn-property-secureblackbox_archivereader-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [SigningCertValidFrom](#signingcertvalidfrom-property-secureblackbox_archivereader-class) | The time point at which the certificate becomes valid, in UTC. | | [SigningCertValidTo](#signingcertvalidto-property-secureblackbox_archivereader-class) | The 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.* | | | | --- | --- | | [Close](#close-method-secureblackbox_archivereader-class) | Closes the current archive. | | [Config](#config-method-secureblackbox_archivereader-class) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-secureblackbox_archivereader-class) | Performs an additional action. | | [Extract](#extract-method-secureblackbox_archivereader-class) | Extracts a single file from the archive. | | [ExtractAll](#extractall-method-secureblackbox_archivereader-class) | Extract all the files contained in the archive. | | [Open](#open-method-secureblackbox_archivereader-class) | Opens an archive file. | | [OpenBytes](#openbytes-method-secureblackbox_archivereader-class) | Loads an archive file from a byte array. | | [Reset](#reset-method-secureblackbox_archivereader-class) | Resets the class settings. | ## 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.* | | | | --- | --- | | [ActionNeeded](#actionneeded-event-secureblackbox_archivereader-class) | Requests a decision from the application in case of a conflict. | | [AfterExtractFile](#afterextractfile-event-secureblackbox_archivereader-class) | Marks the completion of extraction of an archived file. | | [BeforeExtractFile](#beforeextractfile-event-secureblackbox_archivereader-class) | Marks the start of extraction of an archived file. | | [DecryptionPasswordNeeded](#decryptionpasswordneeded-event-secureblackbox_archivereader-class) | Requests a decryption password, when needed. | | [Error](#error-event-secureblackbox_archivereader-class) | Reports information about errors during archive processing. | | [Notification](#notification-event-secureblackbox_archivereader-class) | This event notifies the application about an underlying control flow event. | | [Progress](#progress-event-secureblackbox_archivereader-class) | Reports the progress of data extraction. | | [RecipientFound](#recipientfound-event-secureblackbox_archivereader-class) | Informs the application that an archive is encrypted with a digital certificate. | | [SignatureFound](#signaturefound-event-secureblackbox_archivereader-class) | Signifies 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.* | | | | --- | --- | | [FilenamesCharset](#FilenamesCharset) | The character set to apply to archived file names. | | [RestoreAttributes](#RestoreAttributes) | Specifies whether file and directory attributes should be restored upon extraction. | | [TempPath](#TempPath) | Path for storing temporary files. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # ArchiveType Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The type of the archive file. ## Object Oriented Interface ```text public function getArchiveType(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 1 ); ``` ## Possible Values ```text ARCHIVEREADER_ARCHIVETYPE_UNKNOWN(0), ARCHIVEREADER_ARCHIVETYPE_ZIP(1), ARCHIVEREADER_ARCHIVETYPE_GZIP(2), ARCHIVEREADER_ARCHIVETYPE_BZIP_2(3), ARCHIVEREADER_ARCHIVETYPE_TAR(4), ARCHIVEREADER_ARCHIVETYPE_TAR_GZIP(5), ARCHIVEREADER_ARCHIVETYPE_TAR_BZIP_2(6), ARCHIVEREADER_ARCHIVETYPE_SFX(7) ``` ## 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](#archivereader-class) Class) The number of records in the DecryptionCert arrays. ## Object Oriented Interface ```text public function getDecryptionCertCount(); public function setDecryptionCertCount($value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 2 ); secureblackbox_archivereader_set($res, 2, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [DecryptionCertBytes](#decryptioncertbytes-property-secureblackbox_archivereader-class) - [DecryptionCertHandle](#decryptioncerthandle-property-secureblackbox_archivereader-class) 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](#archivereader-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getDecryptionCertBytes($decryptioncertindex); ``` ## Procedural Interface ```text 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](#decryptioncertcount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # DecryptionCertHandle Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getDecryptionCertHandle($decryptioncertindex); public function setDecryptionCertHandle($decryptioncertindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 11 , $decryptioncertindex); secureblackbox_archivereader_set($res, 11, $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. ```text 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](#decryptioncertcount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type Long64 # DecryptionPassword Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The decryption password. ## Object Oriented Interface ```text public function getDecryptionPassword(); public function setDecryptionPassword($value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 42 ); secureblackbox_archivereader_set($res, 42, $value ); ``` ## Default Value '' ## Remarks Use this property to provide the decryption password for the archive. ## Data Type String # FileData Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The contents of the last extracted file. ## Object Oriented Interface ```text public function getFileData(); public function setFileData($value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 43 ); secureblackbox_archivereader_set($res, 43, $value ); ``` ## Remarks Use this property to get the contents of the last extracted file with DataSource set to stBuffer (2). This setting is writable to let you clear up any earlier retrieved content to reduce memory footprint. This property is not available at design time. ## Data Type Byte Array # FileCount Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The number of records in the File arrays. ## Object Oriented Interface ```text public function getFileCount(); public function setFileCount($value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 44 ); secureblackbox_archivereader_set($res, 44, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [FileAction](#fileaction-property-secureblackbox_archivereader-class) - [FileAttributes](#fileattributes-property-secureblackbox_archivereader-class) - [FileCompressedSize](#filecompressedsize-property-secureblackbox_archivereader-class) - [FileDataSource](#filedatasource-property-secureblackbox_archivereader-class) - [FileDirectory](#filedirectory-property-secureblackbox_archivereader-class) - [FileEncryptionAlgorithm](#fileencryptionalgorithm-property-secureblackbox_archivereader-class) - [FileEncryptionKeyLength](#fileencryptionkeylength-property-secureblackbox_archivereader-class) - [FileEncryptionType](#fileencryptiontype-property-secureblackbox_archivereader-class) - [FileFolder](#filefolder-property-secureblackbox_archivereader-class) - [FileLocalPath](#filelocalpath-property-secureblackbox_archivereader-class) - [FileMTime](#filemtime-property-secureblackbox_archivereader-class) - [FileName](#filename-property-secureblackbox_archivereader-class) - [FileNewFile](#filenewfile-property-secureblackbox_archivereader-class) - [FilePath](#filepath-property-secureblackbox_archivereader-class) - [FileSignatureCount](#filesignaturecount-property-secureblackbox_archivereader-class) - [FileSigned](#filesigned-property-secureblackbox_archivereader-class) - [FileSize](#filesize-property-secureblackbox_archivereader-class) 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](#archivereader-class) Class) This property contains the action to apply to the file. ## Object Oriented Interface ```text public function getFileAction($fileindex); public function setFileAction($fileindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 45 , $fileindex); secureblackbox_archivereader_set($res, 45, $value , $fileindex); ``` ## Possible Values ```text ARCHIVEREADER_FILEACTION_ADD(0), ARCHIVEREADER_FILEACTION_KEEP(1), ARCHIVEREADER_FILEACTION_UPDATE(2), ARCHIVEREADER_FILEACTION_DELETE(3), ARCHIVEREADER_FILEACTION_EXTRACT(4), ARCHIVEREADER_FILEACTION_SKIP(5) ``` ## Default Value 0 ## Remarks This property contains 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](#filecount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type Integer # FileAttributes Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property provides access to file attributes. ## Object Oriented Interface ```text public function getFileAttributes($fileindex); public function setFileAttributes($fileindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 46 , $fileindex); secureblackbox_archivereader_set($res, 46, $value , $fileindex); ``` ## Default Value '' ## Remarks This property provides access to file attributes. ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive. Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows: ```text Writer.Files[0].Attributes = "unix:-rwxr-xr-x"; Writer.Files[1].Attributes = "unix:-r--r--r--"; Writer.Files[2].Attributes = "dos:readonly"; Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive ``` The *$fileindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#filecount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type String # FileCompressedSize Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property contains the size of the file after compression. ## Object Oriented Interface ```text public function getFileCompressedSize($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 47 , $fileindex); ``` ## Default Value 0 ## Remarks This property contains 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Long64 # FileDataSource Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property contains the type of data source for this entry. ## Object Oriented Interface ```text public function getFileDataSource($fileindex); public function setFileDataSource($fileindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 48 , $fileindex); secureblackbox_archivereader_set($res, 48, $value , $fileindex); ``` ## Possible Values ```text ARCHIVEREADER_FILEDATASOURCE_FILE(0), ARCHIVEREADER_FILEDATASOURCE_STREAM(1), ARCHIVEREADER_FILEDATASOURCE_BUFFER(2) ``` ## Default Value 0 ## Remarks This property contains the type of 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 by [FileLocalPath](#filelocalpath-property-secureblackbox_archivereader-class). | | fdsStream (1) | Data are going to be provided on-the-fly through the FileStream property. | | fdsBuffer (2) | Data are going to be provided on-the-fly through 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](#filecount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type Integer # FileDirectory Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property tells if the entry is a directory or a regular file. ## Object Oriented Interface ```text public function getFileDirectory($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 49 , $fileindex); ``` ## Default Value false ## Remarks This property 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Boolean # FileEncryptionAlgorithm Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property returns the symmetric algorithm that was used to encrypt the file. ## Object Oriented Interface ```text public function getFileEncryptionAlgorithm($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 50 , $fileindex); ``` ## Default Value '' ## Remarks This property 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type String # FileEncryptionKeyLength Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property returns the length, in bits, of the encryption key. ## Object Oriented Interface ```text public function getFileEncryptionKeyLength($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 51 , $fileindex); ``` ## Default Value 0 ## Remarks This property 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Integer # FileEncryptionType Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property contains the type of encryption applied to the file. ## Object Oriented Interface ```text public function getFileEncryptionType($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 52 , $fileindex); ``` ## Possible Values ```text ARCHIVEREADER_FILEENCRYPTIONTYPE_DEFAULT(0), ARCHIVEREADER_FILEENCRYPTIONTYPE_NO_ENCRYPTION(1), ARCHIVEREADER_FILEENCRYPTIONTYPE_GENERIC(2), ARCHIVEREADER_FILEENCRYPTIONTYPE_WIN_ZIP(3), ARCHIVEREADER_FILEENCRYPTIONTYPE_STRONG(4) ``` ## Default Value 0 ## Remarks This property contains 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Integer # FileName Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property specifies the original name of the compressed file or folder. ## Object Oriented Interface ```text public function getFileName($fileindex); public function setFileName($fileindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 53 , $fileindex); secureblackbox_archivereader_set($res, 53, $value , $fileindex); ``` ## Default Value '' ## Remarks This property specifies 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](#filecount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type String # FileFolder Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property includes the containing folder of the entry. ## Object Oriented Interface ```text public function getFileFolder($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 54 , $fileindex); ``` ## Default Value '' ## Remarks This property includes 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type String # FileLocalPath Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property contains the local path associated with this entry. ## Object Oriented Interface ```text public function getFileLocalPath($fileindex); public function setFileLocalPath($fileindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 55 , $fileindex); secureblackbox_archivereader_set($res, 55, $value , $fileindex); ``` ## Default Value '' ## Remarks This property contains 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](#filecount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type String # FileMTime Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property contains the entry's last modification time. ## Object Oriented Interface ```text public function getFileMTime($fileindex); public function setFileMTime($fileindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 56 , $fileindex); secureblackbox_archivereader_set($res, 56, $value , $fileindex); ``` ## Default Value '' ## Remarks This property contains 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](#filecount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type String # FileNewFile Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property indicates whether the entry corresponds to a file to be added to the archive. ## Object Oriented Interface ```text public function getFileNewFile($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 57 , $fileindex); ``` ## Default Value false ## Remarks This property 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Boolean # FilePath Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property contains the full internal path of the archived entry. ## Object Oriented Interface ```text public function getFilePath($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 58 , $fileindex); ``` ## Default Value '' ## Remarks This property contains 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type String # FileSignatureCount Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property includes the number of signatures covering the entry. ## Object Oriented Interface ```text public function getFileSignatureCount($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 59 , $fileindex); ``` ## Default Value 0 ## Remarks This property includes 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Integer # FileSigned Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property indicates whether the entry is signed. ## Object Oriented Interface ```text public function getFileSigned($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 60 , $fileindex); ``` ## Default Value false ## Remarks This property 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Boolean # FileSize Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) This property specifies the size of the file before compression. ## Object Oriented Interface ```text public function getFileSize($fileindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 61 , $fileindex); ``` ## Default Value 0 ## Remarks This property specifies 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](#filecount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Long64 # FIPSMode Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Reserved. ## Object Oriented Interface ```text public function getFIPSMode(); public function setFIPSMode($value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 62 ); secureblackbox_archivereader_set($res, 62, $value ); ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # HashAlgorithm Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Returns the hash algorithm that was used to generate the signature. ## Object Oriented Interface ```text public function getHashAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 63 ); ``` ## Default Value '' ## Remarks Check this property after calling [Extract](#extract-method-secureblackbox_archivereader-class) to get the hash algorithm which was used to calculate the signature. | | | | | --- | --- | --- | | 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 | | This property is read-only and not available at design time. ## Data Type String # KnownCertCount Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The number of records in the KnownCert arrays. ## Object Oriented Interface ```text public function getKnownCertCount(); public function setKnownCertCount($value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 64 ); secureblackbox_archivereader_set($res, 64, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCertBytes](#knowncertbytes-property-secureblackbox_archivereader-class) - [KnownCertHandle](#knowncerthandle-property-secureblackbox_archivereader-class) 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](#archivereader-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getKnownCertBytes($knowncertindex); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 65 , $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](#knowncertcount-property-secureblackbox_archivereader-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # KnownCertHandle Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getKnownCertHandle($knowncertindex); public function setKnownCertHandle($knowncertindex, $value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 73 , $knowncertindex); secureblackbox_archivereader_set($res, 73, $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. ```text 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](#knowncertcount-property-secureblackbox_archivereader-class) property. This property is not available at design time. ## Data Type Long64 # Opened Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Indicates if the class is in the open state. ## Object Oriented Interface ```text public function getOpened(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 104 ); ``` ## 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 # Overwrite Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Whether the class should overwrite existing files. ## Object Oriented Interface ```text public function getOverwrite(); public function setOverwrite($value); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 105 ); secureblackbox_archivereader_set($res, 105, $value ); ``` ## Default Value false ## Remarks Enable this property to force overwriting of existing files. ## Data Type Boolean # SignatureValidationResult Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The signature validation result. ## Object Oriented Interface ```text public function getSignatureValidationResult(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 106 ); ``` ## Possible Values ```text ARCHIVEREADER_SIGNATUREVALIDATIONRESULT_VALID(0), ARCHIVEREADER_SIGNATUREVALIDATIONRESULT_UNKNOWN(1), ARCHIVEREADER_SIGNATUREVALIDATIONRESULT_CORRUPTED(2), ARCHIVEREADER_SIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), ARCHIVEREADER_SIGNATUREVALIDATIONRESULT_FAILURE(4), ARCHIVEREADER_SIGNATUREVALIDATIONRESULT_REFERENCE_CORRUPTED(5) ``` ## Default Value 0 ## Remarks Use this property to check the result of the most recent signature validation. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only and not available at design time. ## Data Type Integer # SigningCertBytes Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getSigningCertBytes(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 107 ); ``` ## 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](#archivereader-class) Class) Indicates whether the certificate has a CA capability. ## Object Oriented Interface ```text public function getSigningCertCA(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 108 ); ``` ## Default Value false ## Remarks Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this property when generating a new certificate to have its Basic Constraints extension generated automatically. This property is read-only and not available at design time. ## Data Type Boolean # SigningCertCAKeyID Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Object Oriented Interface ```text public function getSigningCertCAKeyID(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 109 ); ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_archivereader-class) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertCRLDistributionPoints Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Object Oriented Interface ```text public function getSigningCertCRLDistributionPoints(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 111 ); ``` ## Default Value '' ## Remarks Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. This property is read-only and not available at design time. ## Data Type String # SigningCertCurve Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Specifies the elliptic curve associated with the certificate's public key. ## Object Oriented Interface ```text public function getSigningCertCurve(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 112 ); ``` ## Default Value '' ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | This property is read-only and not available at design time. ## Data Type String # SigningCertFingerprint Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Contains the fingerprint (a hash imprint) of this certificate. ## Object Oriented Interface ```text public function getSigningCertFingerprint(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 113 ); ``` ## Default Value '' ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. This property is read-only and not available at design time. ## Data Type String # SigningCertFriendlyName Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Contains an associated alias (friendly name) of the certificate. ## Object Oriented Interface ```text public function getSigningCertFriendlyName(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 114 ); ``` ## Default Value '' ## Remarks Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. This property is read-only and not available at design time. ## Data Type String # SigningCertHandle Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getSigningCertHandle(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 115 ); ``` ## 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only and not available at design time. ## Data Type Long64 # SigningCertHashAlgorithm Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Object Oriented Interface ```text public function getSigningCertHashAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 116 ); ``` ## Default Value '' ## Remarks Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [SigningCertSigAlgorithm](#signingcertsigalgorithm-property-secureblackbox_archivereader-class) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | 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 | | This property is read-only and not available at design time. ## Data Type String # SigningCertIssuer Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The common name of the certificate issuer (CA), typically a company name. ## Object Oriented Interface ```text public function getSigningCertIssuer(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 117 ); ``` ## Default Value '' ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [SigningCertIssuerRDN](#signingcertissuerrdn-property-secureblackbox_archivereader-class). This property is read-only and not available at design time. ## Data Type String # SigningCertIssuerRDN Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Object Oriented Interface ```text public function getSigningCertIssuerRDN(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 118 ); ``` ## Default Value '' ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* This property is read-only and not available at design time. ## Data Type String # SigningCertKeyAlgorithm Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Specifies the public key algorithm of this certificate. ## Object Oriented Interface ```text public function getSigningCertKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 119 ); ``` ## Default Value '0' ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [SigningCertKeyBits](#signingcertkeybits-property-secureblackbox_archivereader-class), [SigningCertCurve](#signingcertcurve-property-secureblackbox_archivereader-class), and [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_archivereader-class) properties to get more details about the key the certificate contains. This property is read-only and not available at design time. ## Data Type String # SigningCertKeyBits Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Returns the length of the public key in bits. ## Object Oriented Interface ```text public function getSigningCertKeyBits(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 120 ); ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_archivereader-class) or [SigningCertPrivateKeyBytes](#ArchiveReader_p_SigningCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. This property is read-only and not available at design time. ## Data Type Integer # SigningCertKeyFingerprint Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Object Oriented Interface ```text public function getSigningCertKeyFingerprint(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 121 ); ``` ## Default Value '' ## Remarks Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [SigningCertFingerprint](#signingcertfingerprint-property-secureblackbox_archivereader-class) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. This property is read-only and not available at design time. ## Data Type String # SigningCertKeyUsage Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Object Oriented Interface ```text public function getSigningCertKeyUsage(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 122 ); ``` ## 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: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. This property is read-only and not available at design time. ## Data Type Integer # SigningCertKeyValid Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Object Oriented Interface ```text public function getSigningCertKeyValid(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 123 ); ``` ## 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](#archivereader-class) Class) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Object Oriented Interface ```text public function getSigningCertOCSPLocations(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 124 ); ``` ## Default Value '' ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [Generate](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. This property is read-only and not available at design time. ## Data Type String # SigningCertPolicyIDs Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Contains identifiers (OIDs) of the applicable certificate policies. ## Object Oriented Interface ```text public function getSigningCertPolicyIDs(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 127 ); ``` ## 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. Set this property when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. This property is read-only and not available at design time. ## Data Type String # SigningCertPublicKeyBytes Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Contains the certificate's public key in DER format. ## Object Oriented Interface ```text public function getSigningCertPublicKeyBytes(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 131 ); ``` ## Remarks Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertSelfSigned Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Object Oriented Interface ```text public function getSigningCertSelfSigned(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 135 ); ``` ## 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](#archivereader-class) Class) Returns the certificate's serial number. ## Object Oriented Interface ```text public function getSigningCertSerialNumber(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 136 ); ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertSigAlgorithm Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Indicates the algorithm that was used by the CA to sign this certificate. ## Object Oriented Interface ```text public function getSigningCertSigAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 137 ); ``` ## Default Value '' ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. This property is read-only and not available at design time. ## Data Type String # SigningCertSubject Property ([SecureBlackbox_ArchiveReader](#archivereader-class) 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 ```text public function getSigningCertSubject(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 139 ); ``` ## 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 is part of a larger set of credentials available via [SigningCertSubjectRDN](#signingcertsubjectrdn-property-secureblackbox_archivereader-class). This property is read-only and not available at design time. ## Data Type String # SigningCertSubjectKeyID Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Contains a unique identifier of the certificate's cryptographic key. ## Object Oriented Interface ```text public function getSigningCertSubjectKeyID(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 141 ); ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_archivereader-class) and [SigningCertCAKeyID](#signingcertcakeyid-property-secureblackbox_archivereader-class) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertSubjectRDN Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Object Oriented Interface ```text public function getSigningCertSubjectRDN(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 142 ); ``` ## Default Value '' ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. This property is read-only and not available at design time. ## Data Type String # SigningCertValidFrom Property ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) The time point at which the certificate becomes valid, in UTC. ## Object Oriented Interface ```text public function getSigningCertValidFrom(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 144 ); ``` ## 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](#archivereader-class) Class) The time point at which the certificate expires, in UTC. ## Object Oriented Interface ```text public function getSigningCertValidTo(); ``` ## Procedural Interface ```text secureblackbox_archivereader_get($res, 145 ); ``` ## 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](#archivereader-class) Class) Closes the current archive. ## Object Oriented Interface ```text public function doClose(); ``` ## Procedural Interface ```text 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](#archivereader-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text 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](#config-settings-archivereader-class) 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](#config-settings-archivereader-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Performs an additional action. ## Object Oriented Interface ```text public function doDoAction($actionid, $actionparams); ``` ## Procedural Interface ```text 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;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # Extract Method ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Extracts a single file from the archive. ## Object Oriented Interface ```text public function doExtract($path, $localpath, $preservefullpath); ``` ## Procedural Interface ```text 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](#extractall-method-secureblackbox_archivereader-class) to extract all files at once. # ExtractAll Method ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Extract all the files contained in the archive. ## Object Oriented Interface ```text public function doExtractAll($outputpath); ``` ## Procedural Interface ```text secureblackbox_archivereader_do_extractall($res, $outputpath); ``` ## 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. 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](#beforeextractfile-event-secureblackbox_archivereader-class) and [AfterExtractFile](#afterextractfile-event-secureblackbox_archivereader-class) events. Use [Extract](#extract-method-secureblackbox_archivereader-class) to extract a single file. # Open Method ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Opens an archive file. ## Object Oriented Interface ```text public function doOpen($archivetype, $archivepath); ``` ## Procedural Interface ```text 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](#archivereader-class) Class) Loads an archive file from a byte array. ## Object Oriented Interface ```text public function doOpenBytes($archivetype, $archivebytes); ``` ## Procedural Interface ```text 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. | # Reset Method ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Resets the class settings. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text secureblackbox_archivereader_do_reset($res); ``` ## Remarks Reset is a generic method available in every class. # ActionNeeded Event ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Requests a decision from the application in case of a conflict. ## Object Oriented Interface ```text public function fireActionNeeded($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 1, array($this, 'fireActionNeeded')); ``` ## Parameter List ```text 'whatfor' 'entrypath' 'destpath' 'description' 'action' ``` ## Remarks The component fires this event to request a decision from the application when it encounters a conflict. The *WhatFor* parameter can take one of the following values: | | | | | --- | --- | --- | | aceExtractionFailed | 4097 | File extraction failed | | aceFileAlreadyExists | 4098 | The file already exists | | aceCannotCreateFile | 4099 | Cannot create a file | | aceDirAlreadyExists | 4100 | The directory already exists | | aceFileAlreadyAdded | 4101 | The file has already been added to the archive | | aceCRCMismatch | 4102 | The calculated file or archive CRC does not match the stored CRC | | aceInvalidPassword | 4103 | The provided password is wrong | You can control the further flow from the event handler by setting the *Action* parameter to one of the following values: | | | | | --- | --- | --- | | auaIgnore | 0 | Ignore the conflict - go ahead (overwrite etc.) | | auaAbort | 1 | Abort the operation | | auaRetry | 2 | Make another attempt | | auaSkip | 3 | Skip this item and proceed with the operation | # AfterExtractFile Event ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Marks the completion of extraction of an archived file. ## Object Oriented Interface ```text public function fireAfterExtractFile($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 2, array($this, 'fireAfterExtractFile')); ``` ## Parameter List ```text '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](#filedata-property-secureblackbox_archivereader-class) buffer. | # BeforeExtractFile Event ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Marks the start of extraction of an archived file. ## Object Oriented Interface ```text public function fireBeforeExtractFile($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 3, array($this, 'fireBeforeExtractFile')); ``` ## Parameter List ```text '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](#filedata-property-secureblackbox_archivereader-class) property. | If saving to a stream or buffer, use [AfterExtractFile](#afterextractfile-event-secureblackbox_archivereader-class) to collect the extracted data from FileStream or [FileData](#filedata-property-secureblackbox_archivereader-class), 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](#archivereader-class) Class) Requests a decryption password, when needed. ## Object Oriented Interface ```text public function fireDecryptionPasswordNeeded($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 4, array($this, 'fireDecryptionPasswordNeeded')); ``` ## Parameter List ```text '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](#decryptionpassword-property-secureblackbox_archivereader-class) property, or set *Cancel* parameter to true to terminate the processing. The *PasswordTarget* parameter references the object that is protected with the requested password. # Error Event ([SecureBlackbox_ArchiveReader](#archivereader-class) Class) Reports information about errors during archive processing. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 5, array($this, 'fireError')); ``` ## Parameter List ```text '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](#archivereader-class) Class) This event notifies the application about an underlying control flow event. ## Object Oriented Interface ```text public function fireNotification($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 6, array($this, 'fireNotification')); ``` ## Parameter List ```text '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](#archivereader-class) Class) Reports the progress of data extraction. ## Object Oriented Interface ```text public function fireProgress($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 7, array($this, 'fireProgress')); ``` ## Parameter List ```text '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](#archivereader-class) Class) Informs the application that an archive is encrypted with a digital certificate. ## Object Oriented Interface ```text public function fireRecipientFound($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 8, array($this, 'fireRecipientFound')); ``` ## Parameter List ```text 'publickeyhash' '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. The *PublicKeyHash* contains the hash (fingerprint) of the certificate's public key. 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](#archivereader-class) Class) Signifies the start of signature validation. ## Object Oriented Interface ```text public function fireSignatureFound($param); ``` ## Procedural Interface ```text secureblackbox_archivereader_register_callback($res, 9, array($this, 'fireSignatureFound')); ``` ## Parameter List ```text '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](#archivereader-class) 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](#config-method-secureblackbox_archivereader-class) method. ### ArchiveReader Config Settings **FilenamesCharset**: The character set to apply to archived file names.Use this setting to apply a specific charset to the names of the archived files: ```text writer.Config("FilenamesCharset=cp852"); ``` **RestoreAttributes**: Specifies whether file and directory attributes should be restored upon extraction.Set this property to true to tell ArchiveReader to restore file attributes when extracting files from the archive. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **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: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global 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. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **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. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **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". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **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. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (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: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All 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-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include 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: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush 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: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More 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: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep 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. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **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: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global 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 divided 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 cached 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). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **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. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **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. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([ArchiveReader](#archivereader-class) Class)