ArchiveWriter Class
Properties Methods Events Configuration Settings Errors
The ArchiveWriter class allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.
Syntax
class secureblackbox.ArchiveWriter
Remarks
Use ArchiveWriter to compress, update, and modify files in archives.
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_type | The type of the archive. |
| compression_level | The compression level to apply to the archived data. |
| decryption_cert_count | The number of records in the DecryptionCert arrays. |
| decryption_cert_bytes | Returns raw certificate data in DER format. |
| decryption_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| decryption_password | The decryption password. |
| encryption_algorithm | Specifies the encryption algorithm to apply to the archive. |
| encryption_cert_bytes | Returns raw certificate data in DER format. |
| encryption_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encryption_password | Specifies the archive encryption password. |
| encryption_type | The type of encryption to apply to the archive. |
| file_data | The contents of the file being added to the archive. |
| file_count | The number of records in the File arrays. |
| file_action | The action to apply to the file. |
| file_compressed_size | The size of the file after compression. |
| file_data_source | The type of the data source for this entry. |
| file_directory | Tells if the entry is a directory or a regular file. |
| file_encryption_algorithm | Returns the symmetric algorithm that was used to encrypt the file. |
| file_encryption_key_length | Returns the length, in bits, of the encryption key. |
| file_encryption_type | The type of encryption applied to the file. |
| file_file_name | The original name of the compressed file or folder. |
| file_folder | The containing folder of the entry. |
| file_local_path | The local path associated with this entry. |
| file_m_time | The entry's last modification time. |
| file_new_file | Indicates whether the entry corresponds to a file to be added to the archive. |
| file_path | The full internal path of the archived entry. |
| file_signature_count | The number of signatures covering the entry. |
| file_signed | Indicates whether the entry is signed. |
| file_size | The size of the file before compression. |
| new_archive | Indicates whether the archive object represents a new (rather than opened) archive. |
| opened | Indicates whether class is currently in edit mode. |
| signing_cert_bytes | Returns raw certificate data in DER format. |
| signing_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signing_chain_count | The number of records in the SigningChain arrays. |
| signing_chain_bytes | Returns raw certificate data in DER format. |
| signing_chain_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| add_empty_dir | Adds an empty folder to the archive. |
| add_file | Adds a file to the archive. |
| add_files | Adds a group of files to the archive. |
| add_virtual | Adds a file placeholder to the archive. |
| close | Closes the archive. |
| config | Sets or retrieves a configuration setting. |
| create_new | Creates a new archive. |
| open | Opens an archive file. |
| open_bytes | Loads an archive file from a byte array. |
| remove | Removes file(s) and/or folder(s) from the archive. |
| save | Compresses the archive and saves it to a file. |
| save_bytes | Compresses the archive and saves it to a byte array. |
| update_file | Updates an existing compressed entry with a fresher local version. |
| update_files | Updates a selection of files in the archive. |
| update_virtual | Updates an entry in the archive with on-the-fly content. |
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_compress_file | Marks the completion of compression of a file. |
| on_before_compress_file | Marks the start of compression of a file. |
| on_decryption_password_needed | Fires when the class needs a password to decrypt the archive. |
| on_error | Reports information about errors during archive assembling. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_prepare_file | Fires for every file to be compressed before the compression starts. |
| on_progress | Reports the progress of data compression. |
| on_recipient_found | Signifies that the archive was found to be encrypted with a digital certificate. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| EncryptionKeyLength | The length of the encryption key. |
| TempPath | Path for storing temporary files. |
| UsePax | Enables use of PAX algorithm when creating TAR directories. |
| UseUStar | Enables use of UStar variant of file name packaging when creating TAR directories. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |