# Struct secureblackbox::ArchiveReader The ArchiveReader struct supports inspection and extraction of files from zip, tar, gzip and bzip2 archives. ## Syntax ```text secureblackbox::ArchiveReader ``` ## 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 ([open_bytes](#open_bytes-method-archivereader-struct)), as a stream (open_stream), or load it from a disk file ([open](#open-method-archivereader-struct)). **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 [extract_all](#extract_all-method-archivereader-struct) to initiate extraction of all the files contained in the archive and selected using the > property, or [extract](#extract-method-archivereader-struct) to extract a single file. The component notifies your code about each individual extraction using its [on_before_extract_file](#on_before_extract_file-event-archivereader-struct) and [on_after_extract_file](#on_after_extract_file-event-archivereader-struct) events. You can use [on_before_extract_file](#on_before_extract_file-event-archivereader-struct) to provide your final decision about the extraction of a particular file. Use [decryption_password](#decryption_password-property-archivereader-struct) 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 [on_decryption_password_needed](#on_decryption_password_needed-event-archivereader-struct) 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-archivereader-struct) method to close the archive file and release the associated memory. ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the ArchiveReader struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of ArchiveReader when you have finished using the instance. ## Property List *The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [archive_type](#archive_type-property-archivereader-struct) | The type of the archive file. | | [decryption_cert_count](#decryption_cert_count-property-archivereader-struct) | The number of records in the DecryptionCert arrays. | | [decryption_cert_bytes](#decryption_cert_bytes-property-archivereader-struct) | Returns the raw certificate data in DER format. | | [decryption_cert_handle](#decryption_cert_handle-property-archivereader-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [decryption_password](#decryption_password-property-archivereader-struct) | The decryption password. | | [file_data](#file_data-property-archivereader-struct) | The contents of the last extracted file. | | [file_count](#file_count-property-archivereader-struct) | The number of records in the File arrays. | | [file_action](#file_action-property-archivereader-struct) | This property contains the action to apply to the file. | | [file_attributes](#file_attributes-property-archivereader-struct) | This property provides access to file attributes. | | [file_compressed_size](#file_compressed_size-property-archivereader-struct) | This property contains the size of the file after compression. | | [file_data_source](#file_data_source-property-archivereader-struct) | This property contains the type of data source for this entry. | | [file_directory](#file_directory-property-archivereader-struct) | This property tells if the entry is a directory or a regular file. | | [file_encryption_algorithm](#file_encryption_algorithm-property-archivereader-struct) | This property returns the symmetric algorithm that was used to encrypt the file. | | [file_encryption_key_length](#file_encryption_key_length-property-archivereader-struct) | This property returns the length, in bits, of the encryption key. | | [file_encryption_type](#file_encryption_type-property-archivereader-struct) | This property contains the type of encryption applied to the file. | | [file_name](#file_name-property-archivereader-struct) | This property specifies the original name of the compressed file or folder. | | [file_folder](#file_folder-property-archivereader-struct) | This property includes the containing folder of the entry. | | [file_local_path](#file_local_path-property-archivereader-struct) | This property contains the local path associated with this entry. | | [file_m_time](#file_m_time-property-archivereader-struct) | This property contains the entry's last modification time. | | [file_new_file](#file_new_file-property-archivereader-struct) | This property indicates whether the entry corresponds to a file to be added to the archive. | | [file_path](#file_path-property-archivereader-struct) | This property contains the full internal path of the archived entry. | | [file_signature_count](#file_signature_count-property-archivereader-struct) | This property includes the number of signatures covering the entry. | | [file_signed](#file_signed-property-archivereader-struct) | This property indicates whether the entry is signed. | | [file_size](#file_size-property-archivereader-struct) | This property specifies the size of the file before compression. | | [fips_mode](#fips_mode-property-archivereader-struct) | Reserved. | | [hash_algorithm](#hash_algorithm-property-archivereader-struct) | Returns the hash algorithm that was used to generate the signature. | | [known_cert_count](#known_cert_count-property-archivereader-struct) | The number of records in the KnownCert arrays. | | [known_cert_bytes](#known_cert_bytes-property-archivereader-struct) | Returns the raw certificate data in DER format. | | [known_cert_handle](#known_cert_handle-property-archivereader-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [opened](#opened-property-archivereader-struct) | Indicates if the struct is in the open state. | | [overwrite](#overwrite-property-archivereader-struct) | Whether the struct should overwrite existing files. | | [signature_validation_result](#signature_validation_result-property-archivereader-struct) | The signature validation result. | | [signing_cert_bytes](#signing_cert_bytes-property-archivereader-struct) | Returns the raw certificate data in DER format. | | [signing_cert_ca](#signing_cert_ca-property-archivereader-struct) | Indicates whether the certificate has a CA capability. | | [signing_cert_ca_key_id](#signing_cert_ca_key_id-property-archivereader-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [signing_cert_crl_distribution_points](#signing_cert_crl_distribution_points-property-archivereader-struct) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [signing_cert_curve](#signing_cert_curve-property-archivereader-struct) | Specifies the elliptic curve associated with the certificate's public key. | | [signing_cert_fingerprint](#signing_cert_fingerprint-property-archivereader-struct) | Contains the fingerprint (a hash imprint) of this certificate. | | [signing_cert_friendly_name](#signing_cert_friendly_name-property-archivereader-struct) | Contains an associated alias (friendly name) of the certificate. | | [signing_cert_handle](#signing_cert_handle-property-archivereader-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signing_cert_hash_algorithm](#signing_cert_hash_algorithm-property-archivereader-struct) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [signing_cert_issuer](#signing_cert_issuer-property-archivereader-struct) | The common name of the certificate issuer (CA), typically a company name. | | [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property-archivereader-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [signing_cert_key_algorithm](#signing_cert_key_algorithm-property-archivereader-struct) | Specifies the public key algorithm of this certificate. | | [signing_cert_key_bits](#signing_cert_key_bits-property-archivereader-struct) | Returns the length of the public key in bits. | | [signing_cert_key_fingerprint](#signing_cert_key_fingerprint-property-archivereader-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [signing_cert_key_usage](#signing_cert_key_usage-property-archivereader-struct) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [signing_cert_key_valid](#signing_cert_key_valid-property-archivereader-struct) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [signing_cert_ocsp_locations](#signing_cert_ocsp_locations-property-archivereader-struct) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [signing_cert_policy_i_ds](#signing_cert_policy_i_ds-property-archivereader-struct) | Contains identifiers (OIDs) of the applicable certificate policies. | | [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property-archivereader-struct) | Contains the certificate's public key in DER format. | | [signing_cert_self_signed](#signing_cert_self_signed-property-archivereader-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [signing_cert_serial_number](#signing_cert_serial_number-property-archivereader-struct) | Returns the certificate's serial number. | | [signing_cert_sig_algorithm](#signing_cert_sig_algorithm-property-archivereader-struct) | Indicates the algorithm that was used by the CA to sign this certificate. | | [signing_cert_subject](#signing_cert_subject-property-archivereader-struct) | The 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_id](#signing_cert_subject_key_id-property-archivereader-struct) | Contains a unique identifier of the certificate's cryptographic key. | | [signing_cert_subject_rdn](#signing_cert_subject_rdn-property-archivereader-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [signing_cert_valid_from](#signing_cert_valid_from-property-archivereader-struct) | The time point at which the certificate becomes valid, in UTC. | | [signing_cert_valid_to](#signing_cert_valid_to-property-archivereader-struct) | The time point at which the certificate expires, in UTC. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [close](#close-method-archivereader-struct) | Closes the current archive. | | [config](#config-method-archivereader-struct) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method-archivereader-struct) | Performs an additional action. | | [extract](#extract-method-archivereader-struct) | Extracts a single file from the archive. | | [extract_all](#extract_all-method-archivereader-struct) | Extract all the files contained in the archive. | | [open](#open-method-archivereader-struct) | Opens an archive file. | | [open_bytes](#open_bytes-method-archivereader-struct) | Loads an archive file from a byte array. | | [reset](#reset-method-archivereader-struct) | Resets the struct settings. | ## Event List *The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_action_needed](#on_action_needed-event-archivereader-struct) | Requests a decision from the application in case of a conflict. | | [on_after_extract_file](#on_after_extract_file-event-archivereader-struct) | Marks the completion of extraction of an archived file. | | [on_before_extract_file](#on_before_extract_file-event-archivereader-struct) | Marks the start of extraction of an archived file. | | [on_decryption_password_needed](#on_decryption_password_needed-event-archivereader-struct) | Requests a decryption password, when needed. | | [on_error](#on_error-event-archivereader-struct) | Reports information about errors during archive processing. | | [on_notification](#on_notification-event-archivereader-struct) | This event notifies the application about an underlying control flow event. | | [on_progress](#on_progress-event-archivereader-struct) | Reports the progress of data extraction. | | [on_recipient_found](#on_recipient_found-event-archivereader-struct) | Informs the application that an archive is encrypted with a digital certificate. | | [on_signature_found](#on_signature_found-event-archivereader-struct) | Signifies the start of signature validation. | ## Config Settings *The following is a list of config settings for the struct 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 struct. | | [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 structs. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server structs. | | [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 structs 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 structs 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. | # archive_type property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The type of the archive file. ## Syntax *Rust Syntax* ```text fn archive_type(&self ) -> Result ``` ## Possible Values ```text 0 // Unknown1 // Zip2 // Gzip3 // Bzip24 // Tar5 // TarGzip6 // TarBzip27 // SFX ``` ## 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 i32 # decryption_cert_count property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The number of records in the DecryptionCert arrays. ## Syntax *Rust Syntax* ```text fn decryption_cert_count(&self ) -> Result fn set_decryption_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [decryption_cert_bytes](#decryption_cert_bytes-property-archivereader-struct) - [decryption_cert_handle](#decryption_cert_handle-property-archivereader-struct) The array indices start at *0* and end at *decryption_cert_count - 1*. ## Data Type i32 # decryption_cert_bytes property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn decryption_cert_bytes(&self , DecryptionCertIndex : i32) -> Result, SecureBlackboxError> ``` ## 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](#decryption_cert_count-property-archivereader-struct) property. This property is read-only. ## Data Type Vec # decryption_cert_handle property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn decryption_cert_handle(&self , DecryptionCertIndex : i32) -> Result fn set_decryption_cert_handle(&self, DecryptionCertIndex : i32, value : i64) -> Option ``` ## 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](#decryption_cert_count-property-archivereader-struct) property. ## Data Type i64 # decryption_password property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The decryption password. ## Syntax *Rust Syntax* ```text fn decryption_password(&self ) -> Result fn set_decryption_password(&self, value : &str) -> Option fn set_decryption_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to provide the decryption password for the archive. ## Data Type String # file_data property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The contents of the last extracted file. ## Syntax *Rust Syntax* ```text fn file_data(&self ) -> Result, SecureBlackboxError> fn set_file_data(&self, value : Vec) -> Option fn set_file_data_ref(&self, value : &[u8]) -> Option ``` ## 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. ## Data Type Vec # file_count property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The number of records in the File arrays. ## Syntax *Rust Syntax* ```text fn file_count(&self ) -> Result fn set_file_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [file_action](#file_action-property-archivereader-struct) - [file_attributes](#file_attributes-property-archivereader-struct) - [file_compressed_size](#file_compressed_size-property-archivereader-struct) - [file_data_source](#file_data_source-property-archivereader-struct) - [file_directory](#file_directory-property-archivereader-struct) - [file_encryption_algorithm](#file_encryption_algorithm-property-archivereader-struct) - [file_encryption_key_length](#file_encryption_key_length-property-archivereader-struct) - [file_encryption_type](#file_encryption_type-property-archivereader-struct) - [file_folder](#file_folder-property-archivereader-struct) - [file_local_path](#file_local_path-property-archivereader-struct) - [file_m_time](#file_m_time-property-archivereader-struct) - [file_name](#file_name-property-archivereader-struct) - [file_new_file](#file_new_file-property-archivereader-struct) - [file_path](#file_path-property-archivereader-struct) - [file_signature_count](#file_signature_count-property-archivereader-struct) - [file_signed](#file_signed-property-archivereader-struct) - [file_size](#file_size-property-archivereader-struct) The array indices start at *0* and end at *file_count - 1*. ## Data Type i32 # file_action property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property contains the action to apply to the file. ## Syntax *Rust Syntax* ```text fn file_action(&self , FileIndex : i32) -> Result fn set_file_action(&self, FileIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // Add1 // Keep2 // Update3 // Delete4 // Extract5 // Skip ``` ## 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](#file_count-property-archivereader-struct) property. ## Data Type i32 # file_attributes property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property provides access to file attributes. ## Syntax *Rust Syntax* ```text fn file_attributes(&self , FileIndex : i32) -> Result fn set_file_attributes(&self, FileIndex : i32, value : &str) -> Option fn set_file_attributes_ref(&self, FileIndex : i32, value : &String) -> Option ``` ## 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](#file_count-property-archivereader-struct) property. ## Data Type String # file_compressed_size property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property contains the size of the file after compression. ## Syntax *Rust Syntax* ```text fn file_compressed_size(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type i64 # file_data_source property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property contains the type of data source for this entry. ## Syntax *Rust Syntax* ```text fn file_data_source(&self , FileIndex : i32) -> Result fn set_file_data_source(&self, FileIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // File1 // Stream2 // Buffer ``` ## 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 [file_local_path](#file_local_path-property-archivereader-struct). | | 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](#file_count-property-archivereader-struct) property. ## Data Type i32 # file_directory property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property tells if the entry is a directory or a regular file. ## Syntax *Rust Syntax* ```text fn file_directory(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type bool # file_encryption_algorithm property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property returns the symmetric algorithm that was used to encrypt the file. ## Syntax *Rust Syntax* ```text fn file_encryption_algorithm(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type String # file_encryption_key_length property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property returns the length, in bits, of the encryption key. ## Syntax *Rust Syntax* ```text fn file_encryption_key_length(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type i32 # file_encryption_type property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property contains the type of encryption applied to the file. ## Syntax *Rust Syntax* ```text fn file_encryption_type(&self , FileIndex : i32) -> Result ``` ## Possible Values ```text 0 // Default1 // NoEncryption2 // Generic3 // WinZip4 // Strong ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type i32 # file_name property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property specifies the original name of the compressed file or folder. ## Syntax *Rust Syntax* ```text fn file_name(&self , FileIndex : i32) -> Result fn set_file_name(&self, FileIndex : i32, value : &str) -> Option fn set_file_name_ref(&self, FileIndex : i32, value : &String) -> Option ``` ## 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](#file_count-property-archivereader-struct) property. ## Data Type String # file_folder property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property includes the containing folder of the entry. ## Syntax *Rust Syntax* ```text fn file_folder(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type String # file_local_path property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property contains the local path associated with this entry. ## Syntax *Rust Syntax* ```text fn file_local_path(&self , FileIndex : i32) -> Result fn set_file_local_path(&self, FileIndex : i32, value : &str) -> Option fn set_file_local_path_ref(&self, FileIndex : i32, value : &String) -> Option ``` ## 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](#file_count-property-archivereader-struct) property. ## Data Type String # file_m_time property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property contains the entry's last modification time. ## Syntax *Rust Syntax* ```text fn file_m_time(&self , FileIndex : i32) -> Result fn set_file_m_time(&self, FileIndex : i32, value : &str) -> Option fn set_file_m_time_ref(&self, FileIndex : i32, value : &String) -> Option ``` ## 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](#file_count-property-archivereader-struct) property. ## Data Type String # file_new_file property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property indicates whether the entry corresponds to a file to be added to the archive. ## Syntax *Rust Syntax* ```text fn file_new_file(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type bool # file_path property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property contains the full internal path of the archived entry. ## Syntax *Rust Syntax* ```text fn file_path(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type String # file_signature_count property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property includes the number of signatures covering the entry. ## Syntax *Rust Syntax* ```text fn file_signature_count(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type i32 # file_signed property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property indicates whether the entry is signed. ## Syntax *Rust Syntax* ```text fn file_signed(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type bool # file_size property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This property specifies the size of the file before compression. ## Syntax *Rust Syntax* ```text fn file_size(&self , FileIndex : i32) -> Result ``` ## 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](#file_count-property-archivereader-struct) property. This property is read-only. ## Data Type i64 # fips_mode property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Reserved. ## Syntax *Rust Syntax* ```text fn fips_mode(&self ) -> Result fn set_fips_mode(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type bool # hash_algorithm property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns the hash algorithm that was used to generate the signature. ## Syntax *Rust Syntax* ```text fn hash_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks Check this property after calling [extract](#extract-method-archivereader-struct) 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. ## Data Type String # known_cert_count property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The number of records in the KnownCert arrays. ## Syntax *Rust Syntax* ```text fn known_cert_count(&self ) -> Result fn set_known_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_cert_bytes](#known_cert_bytes-property-archivereader-struct) - [known_cert_handle](#known_cert_handle-property-archivereader-struct) The array indices start at *0* and end at *known_cert_count - 1*. ## Data Type i32 # known_cert_bytes property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result, SecureBlackboxError> ``` ## 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](#known_cert_count-property-archivereader-struct) property. This property is read-only. ## Data Type Vec # known_cert_handle property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn known_cert_handle(&self , KnownCertIndex : i32) -> Result fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) -> Option ``` ## 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](#known_cert_count-property-archivereader-struct) property. ## Data Type i64 # opened property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Indicates if the struct is in the open state. ## Syntax *Rust Syntax* ```text fn opened(&self ) -> Result ``` ## 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 bool # overwrite property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Whether the struct should overwrite existing files. ## Syntax *Rust Syntax* ```text fn overwrite(&self ) -> Result fn set_overwrite(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Enable this property to force overwriting of existing files. ## Data Type bool # signature_validation_result property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The signature validation result. ## Syntax *Rust Syntax* ```text fn signature_validation_result(&self ) -> Result ``` ## Possible Values ```text 0 // Valid1 // Unknown2 // Corrupted3 // SignerNotFound4 // Failure5 // ReferenceCorrupted ``` ## 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. ## Data Type i32 # signing_cert_bytes property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn signing_cert_bytes(&self ) -> Result, SecureBlackboxError> ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. ## Data Type Vec # signing_cert_ca property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Indicates whether the certificate has a CA capability. ## Syntax *Rust Syntax* ```text fn signing_cert_ca(&self ) -> Result ``` ## 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. ## Data Type bool # signing_cert_ca_key_id property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax *Rust Syntax* ```text fn signing_cert_ca_key_id(&self ) -> Result, SecureBlackboxError> ``` ## 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 [signing_cert_subject_key_id](#signing_cert_subject_key_id-property-archivereader-struct) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. This property is read-only. ## Data Type Vec # signing_cert_crl_distribution_points property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax *Rust Syntax* ```text fn signing_cert_crl_distribution_points(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_curve property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Specifies the elliptic curve associated with the certificate's public key. ## Syntax *Rust Syntax* ```text fn signing_cert_curve(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_fingerprint property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_fingerprint(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_friendly_name property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Contains an associated alias (friendly name) of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_friendly_name(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_handle property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn signing_cert_handle(&self ) -> Result ``` ## 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. ## Data Type i64 # signing_cert_hash_algorithm property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax *Rust Syntax* ```text fn signing_cert_hash_algorithm(&self ) -> Result ``` ## 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 [signing_cert_sig_algorithm](#signing_cert_sig_algorithm-property-archivereader-struct) 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. ## Data Type String # signing_cert_issuer property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The common name of the certificate issuer (CA), typically a company name. ## Syntax *Rust Syntax* ```text fn signing_cert_issuer(&self ) -> Result ``` ## 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 [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property-archivereader-struct). This property is read-only. ## Data Type String # signing_cert_issuer_rdn property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *Rust Syntax* ```text fn signing_cert_issuer_rdn(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_key_algorithm property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Specifies the public key algorithm of this certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_key_algorithm(&self ) -> Result ``` ## 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 [signing_cert_key_bits](#signing_cert_key_bits-property-archivereader-struct), [signing_cert_curve](#signing_cert_curve-property-archivereader-struct), and [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property-archivereader-struct) properties to get more details about the key the certificate contains. This property is read-only. ## Data Type String # signing_cert_key_bits property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns the length of the public key in bits. ## Syntax *Rust Syntax* ```text fn signing_cert_key_bits(&self ) -> Result ``` ## 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 [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property-archivereader-struct) or [signing_cert_private_key_bytes](#ArchiveReader_p_SigningCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. This property is read-only. ## Data Type i32 # signing_cert_key_fingerprint property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_key_fingerprint(&self ) -> Result ``` ## 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 [signing_cert_fingerprint](#signing_cert_fingerprint-property-archivereader-struct) 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. ## Data Type String # signing_cert_key_usage property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *Rust Syntax* ```text fn signing_cert_key_usage(&self ) -> Result ``` ## 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. ## Data Type i32 # signing_cert_key_valid property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax *Rust Syntax* ```text fn signing_cert_key_valid(&self ) -> Result ``` ## Default Value false ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. This property is read-only. ## Data Type bool # signing_cert_ocsp_locations property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax *Rust Syntax* ```text fn signing_cert_ocsp_locations(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_policy_i_ds property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax *Rust Syntax* ```text fn signing_cert_policy_i_ds(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_public_key_bytes property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Contains the certificate's public key in DER format. ## Syntax *Rust Syntax* ```text fn signing_cert_public_key_bytes(&self ) -> Result, SecureBlackboxError> ``` ## 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. ## Data Type Vec # signing_cert_self_signed property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *Rust Syntax* ```text fn signing_cert_self_signed(&self ) -> Result ``` ## Default Value false ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. This property is read-only. ## Data Type bool # signing_cert_serial_number property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Returns the certificate's serial number. ## Syntax *Rust Syntax* ```text fn signing_cert_serial_number(&self ) -> Result, SecureBlackboxError> ``` ## 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. ## Data Type Vec # signing_cert_sig_algorithm property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_sig_algorithm(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_subject property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *Rust Syntax* ```text fn signing_cert_subject(&self ) -> Result ``` ## 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 [signing_cert_subject_rdn](#signing_cert_subject_rdn-property-archivereader-struct). This property is read-only. ## Data Type String # signing_cert_subject_key_id property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Contains a unique identifier of the certificate's cryptographic key. ## Syntax *Rust Syntax* ```text fn signing_cert_subject_key_id(&self ) -> Result, SecureBlackboxError> ``` ## 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 [signing_cert_subject_key_id](#signing_cert_subject_key_id-property-archivereader-struct) and [signing_cert_ca_key_id](#signing_cert_ca_key_id-property-archivereader-struct) 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. ## Data Type Vec # signing_cert_subject_rdn property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *Rust Syntax* ```text fn signing_cert_subject_rdn(&self ) -> Result ``` ## 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. ## Data Type String # signing_cert_valid_from property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The time point at which the certificate becomes valid, in UTC. ## Syntax *Rust Syntax* ```text fn signing_cert_valid_from(&self ) -> Result ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. This property is read-only. ## Data Type String # signing_cert_valid_to property ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) The time point at which the certificate expires, in UTC. ## Syntax *Rust Syntax* ```text fn signing_cert_valid_to(&self ) -> Result ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. This property is read-only. ## Data Type String # close method ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Closes the current archive. ## Syntax *Rust Syntax* ```text fn close(&self) -> Result<(), SecureBlackboxError> ``` ## 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 ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-archivereader-struct) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Performs an additional action. ## Syntax *Rust Syntax* ```text fn do_action(&self, action_id : &str, action_params : &str) -> Result ``` ## Remarks do_action is a generic method available in every struct. 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 ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Extracts a single file from the archive. ## Syntax *Rust Syntax* ```text fn extract(&self, path : &str, local_path : &str, preserve_full_path : bool) -> Result<(), SecureBlackboxError> ``` ## 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 [extract_all](#extract_all-method-archivereader-struct) to extract all files at once. # extract_all method ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Extract all the files contained in the archive. ## Syntax *Rust Syntax* ```text fn extract_all(&self, output_path : &str) -> Result<(), SecureBlackboxError> ``` ## 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 [on_before_extract_file](#on_before_extract_file-event-archivereader-struct) and [on_after_extract_file](#on_after_extract_file-event-archivereader-struct) events. Use [extract](#extract-method-archivereader-struct) to extract a single file. # open method ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Opens an archive file. ## Syntax *Rust Syntax* ```text fn open(&self, archive_type : i32, archive_path : &str) -> Result<(), SecureBlackboxError> ``` ## 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. | # open_bytes method ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Loads an archive file from a byte array. ## Syntax *Rust Syntax* ```text fn open_bytes(&self, archive_type : i32, archive_bytes : &[u8]) -> Result<(), SecureBlackboxError> ``` ## 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 ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Resets the struct settings. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks reset is a generic method available in every struct. # on_action_needed event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Requests a decision from the application in case of a conflict. ## Syntax *Rust Syntax* ```text // ArchiveReaderActionNeededEventArgs carries the ArchiveReader ActionNeeded event's parameters. pub struct ArchiveReaderActionNeededEventArgs { fn what_for(&self) -> i32 fn entry_path(&self) -> &String fn dest_path(&self) -> &String fn description(&self) -> &String fn action(&self) -> i32 fn set_action(&self, value : i32) } // ArchiveReaderActionNeededEvent defines the signature of the ArchiveReader ActionNeeded event's handler function. pub trait ArchiveReaderActionNeededEvent { fn on_action_needed(&self, sender : ArchiveReader, e : &mut ArchiveReaderActionNeededEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_action_needed(&self) -> &'a dyn ArchiveReaderActionNeededEvent; pub fn set_on_action_needed(&mut self, value : &'a dyn ArchiveReaderActionNeededEvent); ... } ``` ## 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 | # on_after_extract_file event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Marks the completion of extraction of an archived file. ## Syntax *Rust Syntax* ```text // ArchiveReaderAfterExtractFileEventArgs carries the ArchiveReader AfterExtractFile event's parameters. pub struct ArchiveReaderAfterExtractFileEventArgs { fn path(&self) -> &String fn file_size(&self) -> i64 fn data_source(&self) -> i32 } // ArchiveReaderAfterExtractFileEvent defines the signature of the ArchiveReader AfterExtractFile event's handler function. pub trait ArchiveReaderAfterExtractFileEvent { fn on_after_extract_file(&self, sender : ArchiveReader, e : &mut ArchiveReaderAfterExtractFileEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_after_extract_file(&self) -> &'a dyn ArchiveReaderAfterExtractFileEvent; pub fn set_on_after_extract_file(&mut self, value : &'a dyn ArchiveReaderAfterExtractFileEvent); ... } ``` ## 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 file_stream property. | | fdsBuffer (2) | The file data is available in [file_data](#file_data-property-archivereader-struct) buffer. | # on_before_extract_file event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Marks the start of extraction of an archived file. ## Syntax *Rust Syntax* ```text // ArchiveReaderBeforeExtractFileEventArgs carries the ArchiveReader BeforeExtractFile event's parameters. pub struct ArchiveReaderBeforeExtractFileEventArgs { fn path(&self) -> &String fn file_size(&self) -> i64 fn data_source(&self) -> i32 fn set_data_source(&self, value : i32) fn extraction_path(&self) -> &String fn set_extraction_path(&self, value : &str) fn set_extraction_path_ref(&self, value : &String) fn skip(&self) -> bool fn set_skip(&self, value : bool) } // ArchiveReaderBeforeExtractFileEvent defines the signature of the ArchiveReader BeforeExtractFile event's handler function. pub trait ArchiveReaderBeforeExtractFileEvent { fn on_before_extract_file(&self, sender : ArchiveReader, e : &mut ArchiveReaderBeforeExtractFileEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_before_extract_file(&self) -> &'a dyn ArchiveReaderBeforeExtractFileEvent; pub fn set_on_before_extract_file(&mut self, value : &'a dyn ArchiveReaderBeforeExtractFileEvent); ... } ``` ## 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 file_stream property. | | fdsBuffer (2) | The file data will be saved to a buffer and returned via the [file_data](#file_data-property-archivereader-struct) property. | If saving to a stream or buffer, use [on_after_extract_file](#on_after_extract_file-event-archivereader-struct) to collect the extracted data from file_stream or [file_data](#file_data-property-archivereader-struct), 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. # on_decryption_password_needed event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Requests a decryption password, when needed. ## Syntax *Rust Syntax* ```text // ArchiveReaderDecryptionPasswordNeededEventArgs carries the ArchiveReader DecryptionPasswordNeeded event's parameters. pub struct ArchiveReaderDecryptionPasswordNeededEventArgs { fn password_target(&self) -> &String fn cancel(&self) -> bool fn set_cancel(&self, value : bool) } // ArchiveReaderDecryptionPasswordNeededEvent defines the signature of the ArchiveReader DecryptionPasswordNeeded event's handler function. pub trait ArchiveReaderDecryptionPasswordNeededEvent { fn on_decryption_password_needed(&self, sender : ArchiveReader, e : &mut ArchiveReaderDecryptionPasswordNeededEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_decryption_password_needed(&self) -> &'a dyn ArchiveReaderDecryptionPasswordNeededEvent; pub fn set_on_decryption_password_needed(&mut self, value : &'a dyn ArchiveReaderDecryptionPasswordNeededEvent); ... } ``` ## Remarks Struct 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 [decryption_password](#decryption_password-property-archivereader-struct) property, or set *Cancel* parameter to true to terminate the processing. The *PasswordTarget* parameter references the object that is protected with the requested password. # on_error event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Reports information about errors during archive processing. ## Syntax *Rust Syntax* ```text // ArchiveReaderErrorEventArgs carries the ArchiveReader Error event's parameters. pub struct ArchiveReaderErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // ArchiveReaderErrorEvent defines the signature of the ArchiveReader Error event's handler function. pub trait ArchiveReaderErrorEvent { fn on_error(&self, sender : ArchiveReader, e : &mut ArchiveReaderErrorEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_error(&self) -> &'a dyn ArchiveReaderErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn ArchiveReaderErrorEvent); ... } ``` ## 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. # on_notification event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) This event notifies the application about an underlying control flow event. ## Syntax *Rust Syntax* ```text // ArchiveReaderNotificationEventArgs carries the ArchiveReader Notification event's parameters. pub struct ArchiveReaderNotificationEventArgs { fn event_id(&self) -> &String fn event_param(&self) -> &String } // ArchiveReaderNotificationEvent defines the signature of the ArchiveReader Notification event's handler function. pub trait ArchiveReaderNotificationEvent { fn on_notification(&self, sender : ArchiveReader, e : &mut ArchiveReaderNotificationEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_notification(&self) -> &'a dyn ArchiveReaderNotificationEvent; pub fn set_on_notification(&mut self, value : &'a dyn ArchiveReaderNotificationEvent); ... } ``` ## Remarks The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted. # on_progress event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Reports the progress of data extraction. ## Syntax *Rust Syntax* ```text // ArchiveReaderProgressEventArgs carries the ArchiveReader Progress event's parameters. pub struct ArchiveReaderProgressEventArgs { fn processed(&self) -> i64 fn total(&self) -> i64 fn overall_processed(&self) -> i64 fn overall_total(&self) -> i64 fn cancel(&self) -> bool fn set_cancel(&self, value : bool) } // ArchiveReaderProgressEvent defines the signature of the ArchiveReader Progress event's handler function. pub trait ArchiveReaderProgressEvent { fn on_progress(&self, sender : ArchiveReader, e : &mut ArchiveReaderProgressEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_progress(&self) -> &'a dyn ArchiveReaderProgressEvent; pub fn set_on_progress(&mut self, value : &'a dyn ArchiveReaderProgressEvent); ... } ``` ## 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. # on_recipient_found event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Informs the application that an archive is encrypted with a digital certificate. ## Syntax *Rust Syntax* ```text // ArchiveReaderRecipientFoundEventArgs carries the ArchiveReader RecipientFound event's parameters. pub struct ArchiveReaderRecipientFoundEventArgs { fn public_key_hash(&self) -> &String fn cert_found(&self) -> bool } // ArchiveReaderRecipientFoundEvent defines the signature of the ArchiveReader RecipientFound event's handler function. pub trait ArchiveReaderRecipientFoundEvent { fn on_recipient_found(&self, sender : ArchiveReader, e : &mut ArchiveReaderRecipientFoundEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_recipient_found(&self) -> &'a dyn ArchiveReaderRecipientFoundEvent; pub fn set_on_recipient_found(&mut self, value : &'a dyn ArchiveReaderRecipientFoundEvent); ... } ``` ## Remarks The struct fires this event when processing archives encrypted with an X.509 certificate. *CertFound* indicates whether the matching certificate has been found in decryption_certificates 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. # on_signature_found event ([ArchiveReader](#struct-secureblackboxarchivereader) Struct) Signifies the start of signature validation. ## Syntax *Rust Syntax* ```text // ArchiveReaderSignatureFoundEventArgs carries the ArchiveReader SignatureFound event's parameters. pub struct ArchiveReaderSignatureFoundEventArgs { fn issuer_rdn(&self) -> &String fn serial_number(&self) -> &[u8] fn subject_key_id(&self) -> &[u8] fn cert_found(&self) -> bool fn validate_signature(&self) -> bool fn set_validate_signature(&self, value : bool) fn validate_chain(&self) -> bool fn set_validate_chain(&self, value : bool) } // ArchiveReaderSignatureFoundEvent defines the signature of the ArchiveReader SignatureFound event's handler function. pub trait ArchiveReaderSignatureFoundEvent { fn on_signature_found(&self, sender : ArchiveReader, e : &mut ArchiveReaderSignatureFoundEventArgs); } impl <'a> ArchiveReader<'a> { pub fn on_signature_found(&self) -> &'a dyn ArchiveReaderSignatureFoundEvent; pub fn set_on_signature_found(&mut self, value : &'a dyn ArchiveReaderSignatureFoundEvent); ... } ``` ## 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 struct 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 known_certificates 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](#struct-secureblackboxarchivereader) Struct) The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-archivereader-struct) 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 struct. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the struct.Use this property to get cookies from the internal cookie storage of the struct 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 structs 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 structs. **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 struct. 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 struct) 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 struct is set to "*local*", the property returns/restores the rules from/to the internal storage of the struct. If *StaticDNS* of the struct 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 structs. **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](#struct-secureblackboxarchivereader) Struct)