SecureBlackbox Lite 2020 Python 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

class secureblackboxlite.ArchiveReader

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.

archive_typeThe type of the archive file.
decryption_cert_countThe number of records in the DecryptionCert arrays.
decryption_cert_bytesReturns raw certificate data in DER format.
decryption_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
decryption_passwordThe decryption password.
file_dataThe contents of the last extracted file.
file_countThe number of records in the File arrays.
file_actionThe action to apply to the file.
file_compressed_sizeThe size of the file after compression.
file_data_sourceThe type of the data source for this entry.
file_directoryTells if the entry is a directory or a regular file.
file_encryption_algorithmReturns the symmetric algorithm that was used to encrypt the file.
file_encryption_key_lengthReturns the length, in bits, of the encryption key.
file_encryption_typeThe type of encryption applied to the file.
file_file_nameThe original name of the compressed file or folder.
file_folderThe containing folder of the entry.
file_local_pathThe local path associated with this entry.
file_m_timeThe entry's last modification time.
file_new_fileIndicates whether the entry corresponds to a file to be added to the archive.
file_pathThe full internal path of the archived entry.
file_signature_countThe number of signatures covering the entry.
file_signedIndicates whether the entry is signed.
file_sizeThe size of the file before compression.
hash_algorithmReturns the hash algorithm that was used to generate the signature.
known_cert_countThe number of records in the KnownCert arrays.
known_cert_bytesReturns raw certificate data in DER format.
known_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
openedIndicates if the class is in the open state.
signature_validation_resultThe signature validation result.
signing_cert_bytesReturns raw certificate data in DER format.
signing_cert_caIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
signing_cert_ca_key_idA unique identifier (fingerprint) of the CA certificate's private key.
signing_cert_crl_distribution_pointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
signing_cert_curveSpecifies the elliptic curve of the EC public key.
signing_cert_fingerprintContains the fingerprint (a hash imprint) of this certificate.
signing_cert_friendly_nameContains an associated alias (friendly name) of the certificate.
signing_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
signing_cert_hash_algorithmSpecifies 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 .
signing_cert_issuerThe common name of the certificate issuer (CA), typically a company name.
signing_cert_issuer_rdnA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
signing_cert_key_algorithmSpecifies the public key algorithm of this certificate.
signing_cert_key_bitsReturns the length of the public key.
signing_cert_key_fingerprintReturns a fingerprint of the public key contained in the certificate.
signing_cert_key_usageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
signing_cert_key_validReturns True if the certificate's key is cryptographically valid, and False otherwise.
signing_cert_ocsp_locationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
signing_cert_policy_i_dsContains identifiers (OIDs) of the applicable certificate policies.
signing_cert_public_key_bytesContains the certificate's public key in DER format.
signing_cert_self_signedIndicates whether the certificate is self-signed (root) or signed by an external CA.
signing_cert_serial_numberReturns the certificate's serial number.
signing_cert_sig_algorithmIndicates the algorithm that was used by the CA to sign this certificate.
signing_cert_subjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
signing_cert_subject_key_idContains a unique identifier (fingerprint) of the certificate's private key.
signing_cert_subject_rdnA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
signing_cert_valid_fromThe time point at which the certificate becomes valid, in UTC.
signing_cert_valid_toThe 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.
extract_allExtract all the files contained in the archive.
openOpens an archive file.
open_bytesLoads 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.

on_after_extract_fileMarks the completion of extraction of an archived file.
on_before_extract_fileMarks the start of extraction of an archived file.
on_decryption_password_neededRequests a decryption password, when needed.
on_errorReports information about errors during archive processing.
on_notificationThis event notifies the application about an underlying control flow event.
on_progressReports the progress of data extraction.
on_recipient_foundInforms the application that an archive is encrypted with a digital certificate.
on_signature_foundSignifies 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.

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