SecureBlackbox 2020 iOS Edition

Questions / Feedback?

ArchiveReader Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

SecureBlackboxArchiveReader
SecureBlackboxArchiveReaderSwift

Remarks

ArchiveReader shows and extracts archived files.

Property List


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

- archiveTypeThe type of the archive file.
- decryptionCertCountThe number of records in the DecryptionCert arrays.
- decryptionCertBytes:(int)decryptionCertIndexReturns raw certificate data in DER format.
- decryptionCertHandle:(int)decryptionCertIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- decryptionPasswordThe decryption password.
- fileDataThe contents of the last extracted file.
- fileCountThe number of records in the File arrays.
- fileAction:(int)fileIndexThe action to apply to the file.
- fileCompressedSize:(int)fileIndexThe size of the file after compression.
- fileDataSource:(int)fileIndexThe type of the data source for this entry.
- fileDirectory:(int)fileIndexTells if the entry is a directory or a regular file.
- fileEncryptionAlgorithm:(int)fileIndexReturns the symmetric algorithm that was used to encrypt the file.
- fileEncryptionKeyLength:(int)fileIndexReturns the length, in bits, of the encryption key.
- fileEncryptionType:(int)fileIndexThe type of encryption applied to the file.
- fileFileName:(int)fileIndexThe original name of the compressed file or folder.
- fileFolder:(int)fileIndexThe containing folder of the entry.
- fileLocalPath:(int)fileIndexThe local path associated with this entry.
- fileMTime:(int)fileIndexThe entry's last modification time.
- fileNewFile:(int)fileIndexIndicates whether the entry corresponds to a file to be added to the archive.
- filePath:(int)fileIndexThe full internal path of the archived entry.
- fileSignatureCount:(int)fileIndexThe number of signatures covering the entry.
- fileSigned:(int)fileIndexIndicates whether the entry is signed.
- fileSize:(int)fileIndexThe size of the file before compression.
- hashAlgorithmReturns the hash algorithm that was used to generate the signature.
- knownCertCountThe number of records in the KnownCert arrays.
- knownCertBytes:(int)knownCertIndexReturns raw certificate data in DER format.
- knownCertHandle:(int)knownCertIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- openedIndicates if the class is in the open state.
- signatureValidationResultThe signature validation result.
- signingCertBytesReturns raw certificate data in DER format.
- signingCertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
- signingCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
- signingCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
- signingCertCurveSpecifies the elliptic curve of the EC public key.
- signingCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
- signingCertFriendlyNameContains an associated alias (friendly name) of the certificate.
- signingCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
- signingCertHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
- signingCertIssuerThe common name of the certificate issuer (CA), typically a company name.
- signingCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
- signingCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
- signingCertKeyBitsReturns the length of the public key.
- signingCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
- signingCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
- signingCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
- signingCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
- signingCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
- signingCertPublicKeyBytesContains the certificate's public key in DER format.
- signingCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
- signingCertSerialNumberReturns the certificate's serial number.
- signingCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
- signingCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
- signingCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
- signingCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
- signingCertValidFromThe time point at which the certificate becomes valid, in UTC.
- signingCertValidToThe time point at which the certificate expires, in UTC.

Method List


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

- closeCloses the current archive.
- configSets or retrieves a configuration setting.
- extractExtracts a single file from the archive.
- extractAllExtract all the files contained in the archive.
- openOpens an archive file.
- openBytesLoads an archive file from a byte array.

Event List


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

- onAfterExtractFileMarks the completion of extraction of an archived file.
- onBeforeExtractFileMarks the start of extraction of an archived file.
- onDecryptionPasswordNeededRequests a decryption password, when needed.
- onErrorReports information about errors during archive processing.
- onNotificationThis event notifies the application about an underlying control flow event.
- onProgressReports the progress of data extraction.
- onRecipientFoundInforms the application that an archive is encrypted with a digital certificate.
- onSignatureFoundSignifies the start of signature validation.

Configuration Settings


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

OverwriteExistingWhether the class should overwrite existing files.
TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 iOS Edition - Version 20.0 [Build 8166]