# ArchiveReader Class The ArchiveReader class supports inspection and extraction of files from zip, tar, gzip and bzip2 archives. ## Syntax ```text 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 ([OpenBytes](#openbytes-method-archivereader-class)), as a stream ([OpenStream](#openstream-method-archivereader-class)), or load it from a disk file ([Open](#open-method-archivereader-class)). **Inspecting the archive contents** Use the [Files](#files-property-archivereader-class) collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' [ACTION](#ArchivedFile_f_ACTION)> and [DATASOURCE](#ArchivedFile_f_DATASOURCE)> properties to configure bespoke processing for specific files. **Extracting the files** Call [ExtractAll](#extractall-method-archivereader-class) to initiate extraction of all the files contained in the archive and selected using the [ACTION](#ArchivedFile_f_ACTION)> property, or [Extract](#extract-method-archivereader-class) to extract a single file. The component notifies your code about each individual extraction using its [BeforeExtractFile](#beforeextractfile-event-archivereader-class) and [AfterExtractFile](#afterextractfile-event-archivereader-class) events. You can use [BeforeExtractFile](#beforeextractfile-event-archivereader-class) to provide your final decision about the extraction of a particular file. Use [DecryptionPassword](#decryptionpassword-property-archivereader-class) property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the [DecryptionPasswordNeeded](#decryptionpasswordneeded-event-archivereader-class) event. This event is fired repeatedly until the correct password is provided or its *Cancel* parameter is returned as true. **Closing the archive** Once you are finished with the archive, call the component's [Close](#close-method-archivereader-class) method to close the archive file and release the associated memory. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ArchiveType](#archivetype-property-archivereader-class) | The type of the archive file. | | [DecryptionCertificates](#decryptioncertificates-property-archivereader-class) | A collection of decryption certificates. | | [DecryptionPassword](#decryptionpassword-property-archivereader-class) | The decryption password. | | [FileData](#filedata-property-archivereader-class) | The contents of the last extracted file. | | [Files](#files-property-archivereader-class) | Lists all files contained in the archive. | | [FIPSMode](#fipsmode-property-archivereader-class) | Reserved. | | [HashAlgorithm](#hashalgorithm-property-archivereader-class) | Returns the hash algorithm that was used to generate the signature. | | [KnownCertificates](#knowncertificates-property-archivereader-class) | A collection of certificates to be used for signature validation. | | [Opened](#opened-property-archivereader-class) | Indicates if the class is in the open state. | | [Overwrite](#overwrite-property-archivereader-class) | Whether the class should overwrite existing files. | | [SignatureValidationResult](#signaturevalidationresult-property-archivereader-class) | The signature validation result. | | [SigningCertificate](#signingcertificate-property-archivereader-class) | The certificate of the signature creator. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Close](#close-method-archivereader-class) | Closes the current archive. | | [Config](#config-method-archivereader-class) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-archivereader-class) | Performs an additional action. | | [Extract](#extract-method-archivereader-class) | Extracts a single file from the archive. | | [ExtractAll](#extractall-method-archivereader-class) | Extract all the files contained in the archive. | | [Open](#open-method-archivereader-class) | Opens an archive file. | | [OpenBytes](#openbytes-method-archivereader-class) | Loads an archive file from a byte array. | | [OpenStream](#openstream-method-archivereader-class) | Loads an archive file from a stream. | | [Reset](#reset-method-archivereader-class) | Resets the class settings. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ActionNeeded](#actionneeded-event-archivereader-class) | Requests a decision from the application in case of a conflict. | | [AfterExtractFile](#afterextractfile-event-archivereader-class) | Marks the completion of extraction of an archived file. | | [BeforeExtractFile](#beforeextractfile-event-archivereader-class) | Marks the start of extraction of an archived file. | | [DecryptionPasswordNeeded](#decryptionpasswordneeded-event-archivereader-class) | Requests a decryption password, when needed. | | [Error](#error-event-archivereader-class) | Reports information about errors during archive processing. | | [Notification](#notification-event-archivereader-class) | This event notifies the application about an underlying control flow event. | | [Progress](#progress-event-archivereader-class) | Reports the progress of data extraction. | | [RecipientFound](#recipientfound-event-archivereader-class) | Informs the application that an archive is encrypted with a digital certificate. | | [SignatureFound](#signaturefound-event-archivereader-class) | Signifies the start of signature validation. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [FilenamesCharset](#FilenamesCharset) | The character set to apply to archived file names. | | [RestoreAttributes](#RestoreAttributes) | Specifies whether file and directory attributes should be restored upon extraction. | | [TempPath](#TempPath) | Path for storing temporary files. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # ArchiveType Property ([ArchiveReader](#archivereader-class) Class) The type of the archive file. ## Syntax ```text ANSI (Cross Platform) int GetArchiveType(); Unicode (Windows) INT GetArchiveType(); ``` ## Possible Values ```text AFT_UNKNOWN(0), AFT_ZIP(1), AFT_GZIP(2), AFT_BZIP_2(3), AFT_TAR(4), AFT_TAR_GZIP(5), AFT_TAR_BZIP_2(6), AFT_SFX(7) ``` ## Default Value 0 ## Remarks Use this property to learn about the type (format) of the opened archive. | | | | --- | --- | | aftUnknown (0) | It was not possible to establish the type of the archive file. | | aftZip (1) | The archive contains data in ZIP format. | | aftGzip (2) | The archive file contains data in GZIP format. | | aftBzip2 (3) | The archive contains BZIP2 data. | | aftTar (4) | The archive contains a .tar file. | | aftTarGzip (5) | The archive contains a .tar.gz file. | | aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. | This property is read-only. ## Data Type Integer # DecryptionCertificates Property ([ArchiveReader](#archivereader-class) Class) A collection of decryption certificates. ## Syntax ```text SecureBlackboxList* GetDecryptionCertificates(); int SetDecryptionCertificates(SecureBlackboxList* val); ``` ## Remarks Use this property to provide a collection of decryption certificates. All certificates should contain their respective private keys. When processing an encrypted archive, the class will walk through the certificate list to locate the matching decryption certificate. You can add certificates to this collection before opening the archive, or on-the-fly, in your [RecipientFound](#recipientfound-event-archivereader-class) event handler. This property is not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # DecryptionPassword Property ([ArchiveReader](#archivereader-class) Class) The decryption password. ## Syntax ```text ANSI (Cross Platform) char* GetDecryptionPassword();int SetDecryptionPassword(const char* lpszDecryptionPassword); Unicode (Windows) LPWSTR GetDecryptionPassword();INT SetDecryptionPassword(LPCWSTR lpszDecryptionPassword); ``` ## Default Value "" ## Remarks Use this property to provide the decryption password for the archive. ## Data Type String # FileData Property ([ArchiveReader](#archivereader-class) Class) The contents of the last extracted file. ## Syntax ```text ANSI (Cross Platform) int GetFileData(char* &lpFileData, int &lenFileData);int SetFileData(const char* lpFileData, int lenFileData); Unicode (Windows) INT GetFileData(LPSTR &lpFileData, INT &lenFileData);INT SetFileData(LPCSTR lpFileData, INT lenFileData); ``` ## Remarks Use this property to get the contents of the last extracted file with DataSource set to stBuffer (2). This setting is writable to let you clear up any earlier retrieved content to reduce memory footprint. This property is not available at design time. ## Data Type Byte Array # Files Property ([ArchiveReader](#archivereader-class) Class) Lists all files contained in the archive. ## Syntax ```text SecureBlackboxList* GetFiles(); ``` ## Remarks Use this collection property to walk through the list of files contained in the archive. Use individual file entries to cherry-pick the files that should be extracted by adjusting their *Action* property, or fine-tune extraction paths using *LocalPath* property. This property is read-only and not available at design time. ## Data Type [SecureBlackboxArchivedFile](#archivedfile-type) # FIPSMode Property ([ArchiveReader](#archivereader-class) Class) Reserved. ## Syntax ```text ANSI (Cross Platform) int GetFIPSMode();int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode); ``` ## Default Value FALSE ## Remarks This property is reserved for future use. ## Data Type Boolean # HashAlgorithm Property ([ArchiveReader](#archivereader-class) Class) Returns the hash algorithm that was used to generate the signature. ## Syntax ```text ANSI (Cross Platform) char* GetHashAlgorithm(); Unicode (Windows) LPWSTR GetHashAlgorithm(); ``` ## Default Value "" ## Remarks Check this property after calling [Extract](#extract-method-archivereader-class) to get the hash algorithm which was used to calculate the signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | This property is read-only and not available at design time. ## Data Type String # KnownCertificates Property ([ArchiveReader](#archivereader-class) Class) A collection of certificates to be used for signature validation. ## Syntax ```text SecureBlackboxList* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList* val); ``` ## Remarks Use this property to provide a list of certificates to be used for signature validation. This property is not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # Opened Property ([ArchiveReader](#archivereader-class) Class) Indicates if the class is in the open state. ## Syntax ```text ANSI (Cross Platform) int GetOpened(); Unicode (Windows) BOOL GetOpened(); ``` ## Default Value FALSE ## Remarks Use this property to check if the component provides access to an open archive file. This property is read-only. ## Data Type Boolean # Overwrite Property ([ArchiveReader](#archivereader-class) Class) Whether the class should overwrite existing files. ## Syntax ```text ANSI (Cross Platform) int GetOverwrite();int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();INT SetOverwrite(BOOL bOverwrite); ``` ## Default Value FALSE ## Remarks Enable this property to force overwriting of existing files. ## Data Type Boolean # SignatureValidationResult Property ([ArchiveReader](#archivereader-class) Class) The signature validation result. ## Syntax ```text ANSI (Cross Platform) int GetSignatureValidationResult(); Unicode (Windows) INT GetSignatureValidationResult(); ``` ## Possible Values ```text SVT_VALID(0), SVT_UNKNOWN(1), SVT_CORRUPTED(2), SVT_SIGNER_NOT_FOUND(3), SVT_FAILURE(4), SVT_REFERENCE_CORRUPTED(5) ``` ## Default Value 0 ## Remarks Use this property to check the result of the most recent signature validation. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only and not available at design time. ## Data Type Integer # SigningCertificate Property ([ArchiveReader](#archivereader-class) Class) The certificate of the signature creator. ## Syntax ```text SecureBlackboxCertificate* GetSigningCertificate(); ``` ## Remarks Use this property to access the certificate that was used to create the signature. This property is read-only and not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # Close Method ([ArchiveReader](#archivereader-class) Class) Closes the current archive. ## Syntax ```text ANSI (Cross Platform) int Close(); Unicode (Windows) INT Close(); ``` ## 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. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Config Method ([ArchiveReader](#archivereader-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-archivereader-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-archivereader-class), you must call *Config("PROPERTY")*. The value will be returned as a string. ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # DoAction Method ([ArchiveReader](#archivereader-class) Class) Performs an additional action. ## Syntax ```text ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams); ``` ## Remarks DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # Extract Method ([ArchiveReader](#archivereader-class) Class) Extracts a single file from the archive. ## Syntax ```text ANSI (Cross Platform) int Extract(const char* lpszPath, const char* lpszLocalPath, int bPreserveFullPath); Unicode (Windows) INT Extract(LPCWSTR lpszPath, LPCWSTR lpszLocalPath, BOOL bPreserveFullPath); ``` ## Remarks Use this method to extract a single file from the archive. Pass the internal path to the entry in the archive via the *Path* parameter, and the path where to save the extracted entry via the *LocalPath* parameter. Set *PreserveFullPath* to true to enforce full-path extraction, in which case *LocalPath* would indicate the mount point at which the full *Path* needs to be rooted. If *PreserveFullPath* is false, the *LocalPath* provides the final location for the extracted file. Use [ExtractAll](#extractall-method-archivereader-class) to extract all files at once. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ExtractAll Method ([ArchiveReader](#archivereader-class) Class) Extract all the files contained in the archive. ## Syntax ```text ANSI (Cross Platform) int ExtractAll(const char* lpszOutputPath); Unicode (Windows) INT ExtractAll(LPCWSTR lpszOutputPath); ``` ## Remarks Use this method to extract all the files contained in the archive file. Pass the path where the extracted files should be saved via the *OutputPath* parameter. You can cherry-pick the files to extract, as well as choose different extraction destinations (including files at custom locations, streams, or memory buffers) by subscribing to [BeforeExtractFile](#beforeextractfile-event-archivereader-class) and [AfterExtractFile](#afterextractfile-event-archivereader-class) events. Use [Extract](#extract-method-archivereader-class) to extract a single file. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Open Method ([ArchiveReader](#archivereader-class) Class) Opens an archive file. ## Syntax ```text ANSI (Cross Platform) int Open(int iArchiveType, const char* lpszArchivePath); Unicode (Windows) INT Open(INT iArchiveType, LPCWSTR lpszArchivePath); ``` ## 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. | ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # OpenBytes Method ([ArchiveReader](#archivereader-class) Class) Loads an archive file from a byte array. ## Syntax ```text ANSI (Cross Platform) int OpenBytes(int iArchiveType, const char* lpArchiveBytes, int lenArchiveBytes); Unicode (Windows) INT OpenBytes(INT iArchiveType, LPCSTR lpArchiveBytes, INT lenArchiveBytes); ``` ## 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. | ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # OpenStream Method ([ArchiveReader](#archivereader-class) Class) Loads an archive file from a stream. ## Syntax ```text ANSI (Cross Platform) int OpenStream(int iArchiveType, SecureBlackboxStream* sArchiveStream); Unicode (Windows) INT OpenStream(INT iArchiveType, SecureBlackboxStream* sArchiveStream); ``` ## Remarks Call this method to load an archive file from a stream. Provide the archive type via the *ArchiveType* parameter, and the stream containing the archive data via the *ArchiveStream* 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. | ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Reset Method ([ArchiveReader](#archivereader-class) Class) Resets the class settings. ## Syntax ```text ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset(); ``` ## Remarks Reset is a generic method available in every class. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ActionNeeded Event ([ArchiveReader](#archivereader-class) Class) Requests a decision from the application in case of a conflict. ## Syntax ```text ANSI (Cross Platform) virtual int FireActionNeeded(ArchiveReaderActionNeededEventParams *e); typedef struct { int WhatFor; const char *EntryPath; const char *DestPath; const char *Description; int Action; int reserved; } ArchiveReaderActionNeededEventParams; Unicode (Windows) virtual INT FireActionNeeded(ArchiveReaderActionNeededEventParams *e); typedef struct { INT WhatFor; LPCWSTR EntryPath; LPCWSTR DestPath; LPCWSTR Description; INT Action; INT reserved; } ArchiveReaderActionNeededEventParams; ``` ## Remarks The component fires this event to request a decision from the application when it encounters a conflict. The *WhatFor* parameter can take one of the following values: | | | | | --- | --- | --- | | aceExtractionFailed | 4097 | File extraction failed | | aceFileAlreadyExists | 4098 | The file already exists | | aceCannotCreateFile | 4099 | Cannot create a file | | aceDirAlreadyExists | 4100 | The directory already exists | | aceFileAlreadyAdded | 4101 | The file has already been added to the archive | | aceCRCMismatch | 4102 | The calculated file or archive CRC does not match the stored CRC | | aceInvalidPassword | 4103 | The provided password is wrong | You can control the further flow from the event handler by setting the *Action* parameter to one of the following values: | | | | | --- | --- | --- | | auaIgnore | 0 | Ignore the conflict - go ahead (overwrite etc.) | | auaAbort | 1 | Abort the operation | | auaRetry | 2 | Make another attempt | | auaSkip | 3 | Skip this item and proceed with the operation | # AfterExtractFile Event ([ArchiveReader](#archivereader-class) Class) Marks the completion of extraction of an archived file. ## Syntax ```text ANSI (Cross Platform) virtual int FireAfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e); typedef struct { const char *Path; int64 FileSize; int DataSource; int reserved; } ArchiveReaderAfterExtractFileEventParams; Unicode (Windows) virtual INT FireAfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e); typedef struct { LPCWSTR Path; LONG64 FileSize; INT DataSource; INT reserved; } ArchiveReaderAfterExtractFileEventParams; ``` ## Remarks Subscribe to this event to get notified about the completion of extraction of an archived file. The *Path* parameter specifies the internal path to the entry inside the archive. The *FileSize* indicates the size of the decompressed file, and the *DataSource* specifies the type of the destination media. | | | | --- | --- | | fdsFile (0) | The data was saved to a file. | | fdsStream (1) | The data was saved into a stream assigned to FileStream property. | | fdsBuffer (2) | The file data is available in [FileData](#filedata-property-archivereader-class) buffer. | # BeforeExtractFile Event ([ArchiveReader](#archivereader-class) Class) Marks the start of extraction of an archived file. ## Syntax ```text ANSI (Cross Platform) virtual int FireBeforeExtractFile(ArchiveReaderBeforeExtractFileEventParams *e); typedef struct { const char *Path; int64 FileSize; int DataSource; char *ExtractionPath; int Skip; int reserved; } ArchiveReaderBeforeExtractFileEventParams; Unicode (Windows) virtual INT FireBeforeExtractFile(ArchiveReaderBeforeExtractFileEventParams *e); typedef struct { LPCWSTR Path; LONG64 FileSize; INT DataSource; LPWSTR ExtractionPath; BOOL Skip; INT reserved; } ArchiveReaderBeforeExtractFileEventParams; ``` ## Remarks Subscribe to this event to be notified about the start of extraction of an archived entry. The handler of this event is a good place to tune up the destination media. The *Path* parameter indicates the path to the extracted entry in the archive. The *FileSize* specifies the uncompressed size of the file. Set the by-reference *DataSource* parameter in accordance with the desired extraction media type: | | | | --- | --- | | fdsFile (0) | The data will be saved to a file indicated by the ExtractionPath parameter. You can change the path here. | | fdsStream (1) | The data will be saved into a stream assigned to FileStream property. | | fdsBuffer (2) | The file data will be saved to a buffer and returned via the [FileData](#filedata-property-archivereader-class) property. | If saving to a stream or buffer, use [AfterExtractFile](#afterextractfile-event-archivereader-class) to collect the extracted data from FileStream or [FileData](#filedata-property-archivereader-class), and dispose of any objects allocated in this event handler (such as the output stream). Use the *Skip* parameter to cancel extraction of this file and proceed to the next one. # DecryptionPasswordNeeded Event ([ArchiveReader](#archivereader-class) Class) Requests a decryption password, when needed. ## Syntax ```text ANSI (Cross Platform) virtual int FireDecryptionPasswordNeeded(ArchiveReaderDecryptionPasswordNeededEventParams *e); typedef struct { const char *PasswordTarget; int Cancel; int reserved; } ArchiveReaderDecryptionPasswordNeededEventParams; Unicode (Windows) virtual INT FireDecryptionPasswordNeeded(ArchiveReaderDecryptionPasswordNeededEventParams *e); typedef struct { LPCWSTR PasswordTarget; BOOL Cancel; INT reserved; } ArchiveReaderDecryptionPasswordNeededEventParams; ``` ## Remarks Class fires this event when it needs a password to decrypt the archive. Subscribe to this event if you expect to process encrypted archives. Inside the event handler, please assign the correct password to [DecryptionPassword](#decryptionpassword-property-archivereader-class) property, or set *Cancel* parameter to true to terminate the processing. The *PasswordTarget* parameter references the object that is protected with the requested password. # Error Event ([ArchiveReader](#archivereader-class) Class) Reports information about errors during archive processing. ## Syntax ```text ANSI (Cross Platform) virtual int FireError(ArchiveReaderErrorEventParams *e); typedef struct { int ErrorCode; const char *Description; int reserved; } ArchiveReaderErrorEventParams; Unicode (Windows) virtual INT FireError(ArchiveReaderErrorEventParams *e); typedef struct { INT ErrorCode; LPCWSTR Description; INT reserved; } ArchiveReaderErrorEventParams; ``` ## Remarks The event is fired in case of exceptional conditions during archive processing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # Notification Event ([ArchiveReader](#archivereader-class) Class) This event notifies the application about an underlying control flow event. ## Syntax ```text ANSI (Cross Platform) virtual int FireNotification(ArchiveReaderNotificationEventParams *e); typedef struct { const char *EventID; const char *EventParam; int reserved; } ArchiveReaderNotificationEventParams; Unicode (Windows) virtual INT FireNotification(ArchiveReaderNotificationEventParams *e); typedef struct { LPCWSTR EventID; LPCWSTR EventParam; INT reserved; } ArchiveReaderNotificationEventParams; ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. # Progress Event ([ArchiveReader](#archivereader-class) Class) Reports the progress of data extraction. ## Syntax ```text ANSI (Cross Platform) virtual int FireProgress(ArchiveReaderProgressEventParams *e); typedef struct { int64 Processed; int64 Total; int64 OverallProcessed; int64 OverallTotal; int Cancel; int reserved; } ArchiveReaderProgressEventParams; Unicode (Windows) virtual INT FireProgress(ArchiveReaderProgressEventParams *e); typedef struct { LONG64 Processed; LONG64 Total; LONG64 OverallProcessed; LONG64 OverallTotal; BOOL Cancel; INT reserved; } ArchiveReaderProgressEventParams; ``` ## Remarks Subscribe to this event to be notified about decompression progress. *Processed* and *Total* report the progress of extraction of the current entry; *OverallProcessed* and *OverallTotal* report the progress of the whole operation. Set *Cancel* to true to stop the operation. # RecipientFound Event ([ArchiveReader](#archivereader-class) Class) Informs the application that an archive is encrypted with a digital certificate. ## Syntax ```text ANSI (Cross Platform) virtual int FireRecipientFound(ArchiveReaderRecipientFoundEventParams *e); typedef struct { const char *PublicKeyHash; int CertFound; int reserved; } ArchiveReaderRecipientFoundEventParams; Unicode (Windows) virtual INT FireRecipientFound(ArchiveReaderRecipientFoundEventParams *e); typedef struct { LPCWSTR PublicKeyHash; BOOL CertFound; INT reserved; } ArchiveReaderRecipientFoundEventParams; ``` ## Remarks The class fires this event when processing archives encrypted with an X.509 certificate. *CertFound* indicates whether the matching certificate has been found in [DecryptionCertificates](#decryptioncertificates-property-archivereader-class) collection. The *PublicKeyHash* contains the hash (fingerprint) of the certificate's public key. This event is an opportunity to add the decryption certificate on a later stage if it was not known at the start of the processing. # SignatureFound Event ([ArchiveReader](#archivereader-class) Class) Signifies the start of signature validation. ## Syntax ```text ANSI (Cross Platform) virtual int FireSignatureFound(ArchiveReaderSignatureFoundEventParams *e); typedef struct { const char *IssuerRDN; const char *SerialNumber; int lenSerialNumber; const char *SubjectKeyID; int lenSubjectKeyID; int CertFound; int ValidateSignature; int ValidateChain; int reserved; } ArchiveReaderSignatureFoundEventParams; Unicode (Windows) virtual INT FireSignatureFound(ArchiveReaderSignatureFoundEventParams *e); typedef struct { LPCWSTR IssuerRDN; LPCSTR SerialNumber; INT lenSerialNumber; LPCSTR SubjectKeyID; INT lenSubjectKeyID; BOOL CertFound; BOOL ValidateSignature; BOOL ValidateChain; INT reserved; } ArchiveReaderSignatureFoundEventParams; ``` ## Remarks This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters. It fires for every signature located in the verified document or message. The *CertFound* parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the [KnownCertificates](#knowncertificates-property-archivereader-class) property. Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the [SignatureValidationResult](#PDFSignature_f_SignatureValidationResult) and [ChainValidationResult](#PDFSignature_f_ChainValidationResult) properties respectively. Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation. # ArchivedFile Type Provides information about the compressed file. ## Syntax *SecureBlackboxArchivedFile* (declared in *secureblackbox.h*) ## Remarks Use this type to access compressed file details. The following fields are available: - [Action](#ArchivedFile_f_Action) - [Attributes](#ArchivedFile_f_Attributes) - [CompressedSize](#ArchivedFile_f_CompressedSize) - [DataSource](#ArchivedFile_f_DataSource) - [Directory](#ArchivedFile_f_Directory) - [EncryptionAlgorithm](#ArchivedFile_f_EncryptionAlgorithm) - [EncryptionKeyLength](#ArchivedFile_f_EncryptionKeyLength) - [EncryptionType](#ArchivedFile_f_EncryptionType) - [FileName](#ArchivedFile_f_FileName) - [Folder](#ArchivedFile_f_Folder) - [LocalPath](#ArchivedFile_f_LocalPath) - [MTime](#ArchivedFile_f_MTime) - [NewFile](#ArchivedFile_f_NewFile) - [Path](#ArchivedFile_f_Path) - [SignatureCount](#ArchivedFile_f_SignatureCount) - [Signed](#ArchivedFile_f_Signed) - [Size](#ArchivedFile_f_Size) ## Fields **Action** *int* *Default Value: 0* This field 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). | **Attributes** *char** *Default Value: ""* This field 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 ``` **CompressedSize** *int64 (read-only)* *Default Value: 0* This field contains the size of the file after compression. **DataSource** *int* *Default Value: 0* This field 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 [LocalPath](#ArchivedFile_f_LocalPath). | | 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. | **Directory** *int (read-only)* *Default Value: FALSE* This field tells if the entry is a directory or a regular file. **EncryptionAlgorithm** *char* (read-only)* *Default Value: ""* This field returns the symmetric algorithm that was used to encrypt the file. **EncryptionKeyLength** *int (read-only)* *Default Value: 0* This field returns the length, in bits, of the encryption key. **EncryptionType** *int (read-only)* *Default Value: 0* This field 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 | **FileName** *char** *Default Value: ""* This field specifies the original name of the compressed file or folder. **Folder** *char* (read-only)* *Default Value: ""* This field includes the containing folder of the entry. **LocalPath** *char** *Default Value: ""* This field 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. **MTime** *char** *Default Value: ""* This field contains the entry's last modification time. **NewFile** *int (read-only)* *Default Value: FALSE* This field indicates whether the entry corresponds to a file to be added to the archive. **Path** *char* (read-only)* *Default Value: ""* This field contains the full internal path of the archived entry. **SignatureCount** *int (read-only)* *Default Value: 0* This field includes the number of signatures covering the entry. **Signed** *int (read-only)* *Default Value: FALSE* This field indicates whether the entry is signed. **Size** *int64 (read-only)* *Default Value: 0* This field specifies the size of the file before compression. ## Constructors ```text ArchivedFile() ``` Creates a new ArchivedFile object. # Certificate Type Encapsulates an individual X.509 certificate. ## Syntax *SecureBlackboxCertificate* (declared in *secureblackbox.h*) ## Remarks This type keeps and provides access to X.509 certificate details. The following fields are available: - [Bytes](#Certificate_f_Bytes) - [CA](#Certificate_f_CA) - [CAKeyID](#Certificate_f_CAKeyID) - [CertType](#Certificate_f_CertType) - [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints) - [Curve](#Certificate_f_Curve) - [Fingerprint](#Certificate_f_Fingerprint) - [FriendlyName](#Certificate_f_FriendlyName) - [Handle](#Certificate_f_Handle) - [HashAlgorithm](#Certificate_f_HashAlgorithm) - [Issuer](#Certificate_f_Issuer) - [IssuerRDN](#Certificate_f_IssuerRDN) - [KeyAlgorithm](#Certificate_f_KeyAlgorithm) - [KeyBits](#Certificate_f_KeyBits) - [KeyFingerprint](#Certificate_f_KeyFingerprint) - [KeyUsage](#Certificate_f_KeyUsage) - [KeyValid](#Certificate_f_KeyValid) - [OCSPLocations](#Certificate_f_OCSPLocations) - [OCSPNoCheck](#Certificate_f_OCSPNoCheck) - [Origin](#Certificate_f_Origin) - [PolicyIDs](#Certificate_f_PolicyIDs) - [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) - [PrivateKeyExists](#Certificate_f_PrivateKeyExists) - [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable) - [PublicKeyBytes](#Certificate_f_PublicKeyBytes) - [Qualified](#Certificate_f_Qualified) - [QualifiedStatements](#Certificate_f_QualifiedStatements) - [Qualifiers](#Certificate_f_Qualifiers) - [SelfSigned](#Certificate_f_SelfSigned) - [SerialNumber](#Certificate_f_SerialNumber) - [SigAlgorithm](#Certificate_f_SigAlgorithm) - [Source](#Certificate_f_Source) - [Subject](#Certificate_f_Subject) - [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName) - [SubjectKeyID](#Certificate_f_SubjectKeyID) - [SubjectRDN](#Certificate_f_SubjectRDN) - [Valid](#Certificate_f_Valid) - [ValidFrom](#Certificate_f_ValidFrom) - [ValidTo](#Certificate_f_ValidTo) ## Fields **Bytes** *char* (read-only)* *Default Value: * Returns the raw certificate data in DER format. **CA** *int* *Default Value: FALSE* 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 field when generating a new certificate to have its Basic Constraints extension generated automatically. **CAKeyID** *char* (read-only)* *Default Value: * 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.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. **CertType** *int (read-only)* *Default Value: 0* Returns the type of the entity contained in the [Certificate](#certificate-type) object. A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](CertificateManager.md#CertificateManager) class to load or create new certificate and certificate requests objects. **CRLDistributionPoints** *char** *Default Value: ""* 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 field 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. **Curve** *char** *Default Value: ""* 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 | | **Fingerprint** *char* (read-only)* *Default Value: ""* 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. **FriendlyName** *char* (read-only)* *Default Value: ""* 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. **Handle** *int64* *Default Value: 0* 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()); ``` **HashAlgorithm** *char** *Default Value: ""* 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 [SigAlgorithm](#Certificate_f_SigAlgorithm) 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 | | **Issuer** *char* (read-only)* *Default Value: ""* The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN). **IssuerRDN** *char** *Default Value: ""* A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* **KeyAlgorithm** *char** *Default Value: "0"* 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 [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains. **KeyBits** *int (read-only)* *Default Value: 0* 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 [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer. **KeyFingerprint** *char* (read-only)* *Default Value: ""* 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 [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. **KeyUsage** *int* *Default Value: 0* 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 field before generating the certificate to propagate the key usage flags to the new certificate. **KeyValid** *int (read-only)* *Default Value: FALSE* Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. **OCSPLocations** *char** *Default Value: ""* Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this field before calling the certificate manager's [Generate](CertificateManager.md#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. **OCSPNoCheck** *int* *Default Value: FALSE* Accessor to the value of the certificate's ocsp-no-check extension. **Origin** *int (read-only)* *Default Value: 0* Returns the location that the certificate was taken or loaded from. **PolicyIDs** *char** *Default Value: ""* 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 field 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. **PrivateKeyBytes** *char* (read-only)* *Default Value: * Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. **PrivateKeyExists** *int (read-only)* *Default Value: FALSE* Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. **PrivateKeyExtractable** *int (read-only)* *Default Value: FALSE* Indicates whether the private key is extractable (exportable). **PublicKeyBytes** *char* (read-only)* *Default Value: * 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. **Qualified** *int (read-only)* *Default Value: FALSE* Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. **QualifiedStatements** *int* *Default Value: 0* Returns a simplified qualified status of the certificate. **Qualifiers** *char* (read-only)* *Default Value: ""* A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. **SelfSigned** *int (read-only)* *Default Value: FALSE* Indicates whether the certificate is self-signed (root) or signed by an external CA. **SerialNumber** *char** *Default Value: * 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. **SigAlgorithm** *char* (read-only)* *Default Value: ""* 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*. **Source** *int (read-only)* *Default Value: 0* Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **Subject** *char* (read-only)* *Default Value: ""* 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 [SubjectRDN](#Certificate_f_SubjectRDN). **SubjectAlternativeName** *char** *Default Value: ""* Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [SubjectRDN](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names 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 element separator. **SubjectKeyID** *char** *Default Value: * 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 [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **SubjectRDN** *char** *Default Value: ""* 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*. **Valid** *int (read-only)* *Default Value: FALSE* Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. **ValidFrom** *char** *Default Value: ""* The time point at which the certificate becomes valid, in UTC. **ValidTo** *char** *Default Value: ""* The time point at which the certificate expires, in UTC. ## Constructors ```text Certificate() ``` Creates a new object with default field values. # SecureBlackboxList Type ## Syntax *SecureBlackboxList* (declared in *secureblackbox.h*) ## Remarks *SecureBlackboxList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the ArchiveReader class. ```text int GetCount() {} ``` ```text int SetCount(int count) {} ``` ```text T* Get(int index) {} ``` ```text T* Set(int index, T* value) {} ``` | | | | --- | --- | | Methods | | | GetCount | This method returns the current size of the collection. | | SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. | | Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. | | Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. | # SecureBlackboxStream Type ## Syntax *SecureBlackboxStream* (declared in *secureblackbox.h*) ## Remarks The ArchiveReader class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the ArchiveReader class an instance of that concrete class. When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur. ```text bool CanRead() { return true; } ``` ```text bool CanSeek() { return true; } ``` ```text bool CanWrite() { return true; } ``` ```text int64 GetLength() = 0; ``` ```text void Close() {} ``` ```text int Flush() { return 0; } ``` ```text int Read(void* buffer, int count) = 0; ``` ```text int64 Seek(int64 offset, int seekOrigin) = 0; ``` ```text int Write(const void* buffer, int count) = 0; ``` | | | | --- | --- | | Properties | | | CanRead | Whether the stream supports reading. | | CanSeek | Whether the stream supports seeking. | | CanWrite | Whether the stream supports writing. | | Length | Gets the length of the stream, in bytes. | | Methods | | | Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a SecureBlackboxStream object is deleted. | | Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. | | Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. | | Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. | | Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. | # Config Settings ([ArchiveReader](#archivereader-class) Class) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-archivereader-class) method. ### ArchiveReader Config Settings **FilenamesCharset**: The character set to apply to archived file names.Use this setting to apply a specific charset to the names of the archived files: ```text writer.Config("FilenamesCharset=cp852"); ``` **RestoreAttributes**: Specifies whether file and directory attributes should be restored upon extraction.Set this property to true to tell ArchiveReader to restore file attributes when extracting files from the archive. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([ArchiveReader](#archivereader-class) Class) ## Error Handling (C++) Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.