ArchiveReader Class
Properties Methods Events Config Settings Errors
The ArchiveReader class supports inspection and extraction of files from zip, tar, gzip and bzip2 archives.
Syntax
ArchiveReader
Remarks
ArchiveReader shows and extracts archived files.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
ArchiveType | The type of the archive file. |
DecryptionCertificates | A collection of decryption certificates. |
DecryptionPassword | The decryption password. |
FileData | The contents of the last extracted file. |
Files | Lists all files contained in the archive. |
FIPSMode | Reserved. |
HashAlgorithm | Returns the hash algorithm that was used to generate the signature. |
KnownCertificates | A collection of certificates to be used for signature validation. |
Opened | Indicates if the class is in the open state. |
SignatureValidationResult | The signature validation result. |
SigningCertificate | 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 | Closes the current archive. |
Config | This method sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
Extract | Extracts a single file from the archive. |
ExtractAll | Extract all the files contained in the archive. |
Open | Opens an archive file. |
OpenBytes | Loads an archive file from a byte array. |
OpenStream | Loads an archive file from a stream. |
Reset | 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.
AfterExtractFile | Marks the completion of extraction of an archived file. |
BeforeExtractFile | Marks the start of extraction of an archived file. |
DecryptionPasswordNeeded | Requests a decryption password, when needed. |
Error | Reports information about errors during archive processing. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Reports the progress of data extraction. |
RecipientFound | Informs the application that an archive is encrypted with a digital certificate. |
SignatureFound | 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.
OverwriteExisting | Whether the class should overwrite existing files. |
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
ArchiveType Property (ArchiveReader Class)
The type of the archive file.
Syntax
ANSI (Cross Platform) int GetArchiveType(); Unicode (Windows) INT GetArchiveType();
Possible Values
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)
int secureblackbox_archivereader_getarchivetype(void* lpObj);
int GetArchiveType();
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 Class)
A collection of decryption certificates.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetDecryptionCertificates(); int SetDecryptionCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_archivereader_getdecryptioncertcount(void* lpObj);
int secureblackbox_archivereader_setdecryptioncertcount(void* lpObj, int iDecryptionCertCount);
int secureblackbox_archivereader_getdecryptioncertbytes(void* lpObj, int decryptioncertindex, char** lpDecryptionCertBytes, int* lenDecryptionCertBytes);
int64 secureblackbox_archivereader_getdecryptioncerthandle(void* lpObj, int decryptioncertindex);
int secureblackbox_archivereader_setdecryptioncerthandle(void* lpObj, int decryptioncertindex, int64 lDecryptionCertHandle);
int GetDecryptionCertCount();
int SetDecryptionCertCount(int iDecryptionCertCount); QByteArray GetDecryptionCertBytes(int iDecryptionCertIndex); qint64 GetDecryptionCertHandle(int iDecryptionCertIndex);
int SetDecryptionCertHandle(int iDecryptionCertIndex, qint64 lDecryptionCertHandle);
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.
This property is not available at design time.
Data Type
DecryptionPassword Property (ArchiveReader Class)
The decryption password.
Syntax
ANSI (Cross Platform) char* GetDecryptionPassword();
int SetDecryptionPassword(const char* lpszDecryptionPassword); Unicode (Windows) LPWSTR GetDecryptionPassword();
INT SetDecryptionPassword(LPCWSTR lpszDecryptionPassword);
char* secureblackbox_archivereader_getdecryptionpassword(void* lpObj);
int secureblackbox_archivereader_setdecryptionpassword(void* lpObj, const char* lpszDecryptionPassword);
QString GetDecryptionPassword();
int SetDecryptionPassword(QString qsDecryptionPassword);
Default Value
""
Remarks
Use this property to provide the decryption password for the archive.
Data Type
String
FileData Property (ArchiveReader Class)
The contents of the last extracted file.
Syntax
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);
int secureblackbox_archivereader_getfiledata(void* lpObj, char** lpFileData, int* lenFileData);
int secureblackbox_archivereader_setfiledata(void* lpObj, const char* lpFileData, int lenFileData);
QByteArray GetFileData();
int SetFileData(QByteArray qbaFileData);
Remarks
Use this property to get the contents of the last extracted file with DataSource set to stBuffer (2).
This property is not available at design time.
Data Type
Byte Array
Files Property (ArchiveReader Class)
Lists all files contained in the archive.
Syntax
SecureBlackboxList<SecureBlackboxArchivedFile>* GetFiles();
int secureblackbox_archivereader_getfilecount(void* lpObj);
int secureblackbox_archivereader_setfilecount(void* lpObj, int iFileCount);
int secureblackbox_archivereader_getfileaction(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfileaction(void* lpObj, int fileindex, int iFileAction);
int64 secureblackbox_archivereader_getfilecompressedsize(void* lpObj, int fileindex);
int secureblackbox_archivereader_getfiledatasource(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfiledatasource(void* lpObj, int fileindex, int iFileDataSource);
int secureblackbox_archivereader_getfiledirectory(void* lpObj, int fileindex);
char* secureblackbox_archivereader_getfileencryptionalgorithm(void* lpObj, int fileindex);
int secureblackbox_archivereader_getfileencryptionkeylength(void* lpObj, int fileindex);
int secureblackbox_archivereader_getfileencryptiontype(void* lpObj, int fileindex);
char* secureblackbox_archivereader_getfilefilename(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfilefilename(void* lpObj, int fileindex, const char* lpszFileFileName);
char* secureblackbox_archivereader_getfilefolder(void* lpObj, int fileindex);
char* secureblackbox_archivereader_getfilelocalpath(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfilelocalpath(void* lpObj, int fileindex, const char* lpszFileLocalPath);
char* secureblackbox_archivereader_getfilemtime(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfilemtime(void* lpObj, int fileindex, const char* lpszFileMTime);
int secureblackbox_archivereader_getfilenewfile(void* lpObj, int fileindex);
char* secureblackbox_archivereader_getfilepath(void* lpObj, int fileindex);
int secureblackbox_archivereader_getfilesignaturecount(void* lpObj, int fileindex);
int secureblackbox_archivereader_getfilesigned(void* lpObj, int fileindex);
int64 secureblackbox_archivereader_getfilesize(void* lpObj, int fileindex);
int GetFileCount();
int SetFileCount(int iFileCount); int GetFileAction(int iFileIndex);
int SetFileAction(int iFileIndex, int iFileAction); qint64 GetFileCompressedSize(int iFileIndex); int GetFileDataSource(int iFileIndex);
int SetFileDataSource(int iFileIndex, int iFileDataSource); bool GetFileDirectory(int iFileIndex); QString GetFileEncryptionAlgorithm(int iFileIndex); int GetFileEncryptionKeyLength(int iFileIndex); int GetFileEncryptionType(int iFileIndex); QString GetFileFileName(int iFileIndex);
int SetFileFileName(int iFileIndex, QString qsFileFileName); QString GetFileFolder(int iFileIndex); QString GetFileLocalPath(int iFileIndex);
int SetFileLocalPath(int iFileIndex, QString qsFileLocalPath); QString GetFileMTime(int iFileIndex);
int SetFileMTime(int iFileIndex, QString qsFileMTime); bool GetFileNewFile(int iFileIndex); QString GetFilePath(int iFileIndex); int GetFileSignatureCount(int iFileIndex); bool GetFileSigned(int iFileIndex); qint64 GetFileSize(int iFileIndex);
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
FIPSMode Property (ArchiveReader Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_archivereader_getfipsmode(void* lpObj);
int secureblackbox_archivereader_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
HashAlgorithm Property (ArchiveReader Class)
Returns the hash algorithm that was used to generate the signature.
Syntax
ANSI (Cross Platform) char* GetHashAlgorithm(); Unicode (Windows) LPWSTR GetHashAlgorithm();
char* secureblackbox_archivereader_gethashalgorithm(void* lpObj);
QString GetHashAlgorithm();
Default Value
""
Remarks
Check this property after calling Extract 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 Class)
A collection of certificates to be used for signature validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_archivereader_getknowncertcount(void* lpObj);
int secureblackbox_archivereader_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_archivereader_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_archivereader_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_archivereader_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
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
Opened Property (ArchiveReader Class)
Indicates if the class is in the open state.
Syntax
ANSI (Cross Platform) int GetOpened(); Unicode (Windows) BOOL GetOpened();
int secureblackbox_archivereader_getopened(void* lpObj);
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
SignatureValidationResult Property (ArchiveReader Class)
The signature validation result.
Syntax
ANSI (Cross Platform) int GetSignatureValidationResult(); Unicode (Windows) INT GetSignatureValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4),
SVT_REFERENCE_CORRUPTED(5)
int secureblackbox_archivereader_getsignaturevalidationresult(void* lpObj);
int GetSignatureValidationResult();
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 Class)
The certificate of the signature creator.
Syntax
SecureBlackboxCertificate* GetSigningCertificate();
int secureblackbox_archivereader_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
int secureblackbox_archivereader_getsigningcertca(void* lpObj);
int secureblackbox_archivereader_getsigningcertcakeyid(void* lpObj, char** lpSigningCertCAKeyID, int* lenSigningCertCAKeyID);
char* secureblackbox_archivereader_getsigningcertcrldistributionpoints(void* lpObj);
char* secureblackbox_archivereader_getsigningcertcurve(void* lpObj);
int secureblackbox_archivereader_getsigningcertfingerprint(void* lpObj, char** lpSigningCertFingerprint, int* lenSigningCertFingerprint);
char* secureblackbox_archivereader_getsigningcertfriendlyname(void* lpObj);
int64 secureblackbox_archivereader_getsigningcerthandle(void* lpObj);
char* secureblackbox_archivereader_getsigningcerthashalgorithm(void* lpObj);
char* secureblackbox_archivereader_getsigningcertissuer(void* lpObj);
char* secureblackbox_archivereader_getsigningcertissuerrdn(void* lpObj);
char* secureblackbox_archivereader_getsigningcertkeyalgorithm(void* lpObj);
int secureblackbox_archivereader_getsigningcertkeybits(void* lpObj);
int secureblackbox_archivereader_getsigningcertkeyfingerprint(void* lpObj, char** lpSigningCertKeyFingerprint, int* lenSigningCertKeyFingerprint);
int secureblackbox_archivereader_getsigningcertkeyusage(void* lpObj);
int secureblackbox_archivereader_getsigningcertkeyvalid(void* lpObj);
char* secureblackbox_archivereader_getsigningcertocsplocations(void* lpObj);
char* secureblackbox_archivereader_getsigningcertpolicyids(void* lpObj);
int secureblackbox_archivereader_getsigningcertpublickeybytes(void* lpObj, char** lpSigningCertPublicKeyBytes, int* lenSigningCertPublicKeyBytes);
int secureblackbox_archivereader_getsigningcertselfsigned(void* lpObj);
int secureblackbox_archivereader_getsigningcertserialnumber(void* lpObj, char** lpSigningCertSerialNumber, int* lenSigningCertSerialNumber);
char* secureblackbox_archivereader_getsigningcertsigalgorithm(void* lpObj);
char* secureblackbox_archivereader_getsigningcertsubject(void* lpObj);
int secureblackbox_archivereader_getsigningcertsubjectkeyid(void* lpObj, char** lpSigningCertSubjectKeyID, int* lenSigningCertSubjectKeyID);
char* secureblackbox_archivereader_getsigningcertsubjectrdn(void* lpObj);
char* secureblackbox_archivereader_getsigningcertvalidfrom(void* lpObj);
char* secureblackbox_archivereader_getsigningcertvalidto(void* lpObj);
QByteArray GetSigningCertBytes(); bool GetSigningCertCA(); QByteArray GetSigningCertCAKeyID(); QString GetSigningCertCRLDistributionPoints(); QString GetSigningCertCurve(); QByteArray GetSigningCertFingerprint(); QString GetSigningCertFriendlyName(); qint64 GetSigningCertHandle(); QString GetSigningCertHashAlgorithm(); QString GetSigningCertIssuer(); QString GetSigningCertIssuerRDN(); QString GetSigningCertKeyAlgorithm(); int GetSigningCertKeyBits(); QByteArray GetSigningCertKeyFingerprint(); int GetSigningCertKeyUsage(); bool GetSigningCertKeyValid(); QString GetSigningCertOCSPLocations(); QString GetSigningCertPolicyIDs(); QByteArray GetSigningCertPublicKeyBytes(); bool GetSigningCertSelfSigned(); QByteArray GetSigningCertSerialNumber(); QString GetSigningCertSigAlgorithm(); QString GetSigningCertSubject(); QByteArray GetSigningCertSubjectKeyID(); QString GetSigningCertSubjectRDN(); QString GetSigningCertValidFrom(); QString GetSigningCertValidTo();
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
Close Method (ArchiveReader Class)
Closes the current archive.
Syntax
ANSI (Cross Platform) int Close(); Unicode (Windows) INT Close();
int secureblackbox_archivereader_close(void* lpObj);
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 Class)
This method sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_archivereader_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, 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 Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_archivereader_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
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 insencitive) 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;....
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 Class)
Extracts a single file from the archive.
Syntax
ANSI (Cross Platform) int Extract(const char* lpszPath, const char* lpszLocalPath, int bPreserveFullPath); Unicode (Windows) INT Extract(LPCWSTR lpszPath, LPCWSTR lpszLocalPath, BOOL bPreserveFullPath);
int secureblackbox_archivereader_extract(void* lpObj, const char* lpszPath, const char* lpszLocalPath, int bPreserveFullPath);
int Extract(const QString& qsPath, const QString& qsLocalPath, 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 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 Class)
Extract all the files contained in the archive.
Syntax
ANSI (Cross Platform) int ExtractAll(const char* lpszOutputPath, int bOverwriteExisting); Unicode (Windows) INT ExtractAll(LPCWSTR lpszOutputPath, BOOL bOverwriteExisting);
int secureblackbox_archivereader_extractall(void* lpObj, const char* lpszOutputPath, int bOverwriteExisting);
int ExtractAll(const QString& qsOutputPath, bool bOverwriteExisting);
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. Existing files will be overwritten if the OverwriteExisting parameter is set to true.
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 and AfterExtractFile events.
Use Extract 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 Class)
Opens an archive file.
Syntax
ANSI (Cross Platform) int Open(int iArchiveType, const char* lpszArchivePath); Unicode (Windows) INT Open(INT iArchiveType, LPCWSTR lpszArchivePath);
int secureblackbox_archivereader_open(void* lpObj, int iArchiveType, const char* lpszArchivePath);
int Open(int iArchiveType, const QString& qsArchivePath);
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 Class)
Loads an archive file from a byte array.
Syntax
ANSI (Cross Platform) int OpenBytes(int iArchiveType, const char* lpArchiveBytes, int lenArchiveBytes); Unicode (Windows) INT OpenBytes(INT iArchiveType, LPCSTR lpArchiveBytes, INT lenArchiveBytes);
int secureblackbox_archivereader_openbytes(void* lpObj, int iArchiveType, const char* lpArchiveBytes, int lenArchiveBytes);
int OpenBytes(int iArchiveType, QByteArray qbaArchiveBytes);
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 Class)
Loads an archive file from a stream.
Syntax
ANSI (Cross Platform) int OpenStream(int iArchiveType, SecureBlackboxStream* sArchiveStream); Unicode (Windows) INT OpenStream(INT iArchiveType, SecureBlackboxStream* sArchiveStream);
int secureblackbox_archivereader_openstream(void* lpObj, int iArchiveType, SecureBlackboxStream* sArchiveStream);
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 Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_archivereader_reset(void* lpObj);
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.)
AfterExtractFile Event (ArchiveReader Class)
Marks the completion of extraction of an archived file.
Syntax
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;
#define EID_ARCHIVEREADER_AFTEREXTRACTFILE 1 virtual INT SECUREBLACKBOX_CALL FireAfterExtractFile(LPSTR &lpszPath, LONG64 &lFileSize, INT &iDataSource);
class ArchiveReaderAfterExtractFileEventParams { public: const QString &Path(); qint64 FileSize(); int DataSource(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireAfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e) {...}
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 buffer. |
BeforeExtractFile Event (ArchiveReader Class)
Marks the start of extraction of an archived file.
Syntax
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;
#define EID_ARCHIVEREADER_BEFOREEXTRACTFILE 2 virtual INT SECUREBLACKBOX_CALL FireBeforeExtractFile(LPSTR &lpszPath, LONG64 &lFileSize, INT &iDataSource, LPSTR &lpszExtractionPath, BOOL &bSkip);
class ArchiveReaderBeforeExtractFileEventParams { public: const QString &Path(); qint64 FileSize(); int DataSource(); void SetDataSource(int iDataSource); const QString &ExtractionPath(); void SetExtractionPath(const QString &qsExtractionPath); bool Skip(); void SetSkip(bool bSkip); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeExtractFile(ArchiveReaderBeforeExtractFileEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireBeforeExtractFile(ArchiveReaderBeforeExtractFileEventParams *e) {...}
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 property. |
Use the Skip parameter to cancel extraction of this file and proceed to the next one.
DecryptionPasswordNeeded Event (ArchiveReader Class)
Requests a decryption password, when needed.
Syntax
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;
#define EID_ARCHIVEREADER_DECRYPTIONPASSWORDNEEDED 3 virtual INT SECUREBLACKBOX_CALL FireDecryptionPasswordNeeded(LPSTR &lpszPasswordTarget, BOOL &bCancel);
class ArchiveReaderDecryptionPasswordNeededEventParams { public: const QString &PasswordTarget(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DecryptionPasswordNeeded(ArchiveReaderDecryptionPasswordNeededEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireDecryptionPasswordNeeded(ArchiveReaderDecryptionPasswordNeededEventParams *e) {...}
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 property, or set Cancel parameter to true to terminate the processing.
Error Event (ArchiveReader Class)
Reports information about errors during archive processing.
Syntax
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;
#define EID_ARCHIVEREADER_ERROR 4 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class ArchiveReaderErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(ArchiveReaderErrorEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireError(ArchiveReaderErrorEventParams *e) {...}
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 Class)
This event notifies the application about an underlying control flow event.
Syntax
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;
#define EID_ARCHIVEREADER_NOTIFICATION 5 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class ArchiveReaderNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(ArchiveReaderNotificationEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireNotification(ArchiveReaderNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
Progress Event (ArchiveReader Class)
Reports the progress of data extraction.
Syntax
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;
#define EID_ARCHIVEREADER_PROGRESS 6 virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lProcessed, LONG64 &lTotal, LONG64 &lOverallProcessed, LONG64 &lOverallTotal, BOOL &bCancel);
class ArchiveReaderProgressEventParams { public: qint64 Processed(); qint64 Total(); qint64 OverallProcessed(); qint64 OverallTotal(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Progress(ArchiveReaderProgressEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireProgress(ArchiveReaderProgressEventParams *e) {...}
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 Class)
Informs the application that an archive is encrypted with a digital certificate.
Syntax
ANSI (Cross Platform) virtual int FireRecipientFound(ArchiveReaderRecipientFoundEventParams *e);
typedef struct {
const char *RecipientHash; int lenRecipientHash;
int CertFound; int reserved; } ArchiveReaderRecipientFoundEventParams;
Unicode (Windows) virtual INT FireRecipientFound(ArchiveReaderRecipientFoundEventParams *e);
typedef struct {
LPCSTR RecipientHash; INT lenRecipientHash;
BOOL CertFound; INT reserved; } ArchiveReaderRecipientFoundEventParams;
#define EID_ARCHIVEREADER_RECIPIENTFOUND 7 virtual INT SECUREBLACKBOX_CALL FireRecipientFound(LPSTR &lpRecipientHash, INT &lenRecipientHash, BOOL &bCertFound);
class ArchiveReaderRecipientFoundEventParams { public: const QByteArray &RecipientHash(); bool CertFound(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void RecipientFound(ArchiveReaderRecipientFoundEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireRecipientFound(ArchiveReaderRecipientFoundEventParams *e) {...}
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 collection.
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 Class)
Signifies the start of signature validation.
Syntax
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;
#define EID_ARCHIVEREADER_SIGNATUREFOUND 8 virtual INT SECUREBLACKBOX_CALL FireSignatureFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class ArchiveReaderSignatureFoundEventParams { public: const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); bool CertFound(); bool ValidateSignature(); void SetValidateSignature(bool bValidateSignature); bool ValidateChain(); void SetValidateChain(bool bValidateChain); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureFound(ArchiveReaderSignatureFoundEventParams *e);
// Or, subclass ArchiveReader and override this emitter function. virtual int FireSignatureFound(ArchiveReaderSignatureFoundEventParams *e) {...}
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 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 KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and 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.
Fields
Action
int
Default Value: 0
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) |
CompressedSize
int64 (read-only)
Default Value: 0
The size of the file after compression.
DataSource
int
Default Value: 0
The type of the data source for this entry.
Use this property to control the data source for this entry.
Directory
int (read-only)
Default Value: FALSE
Tells if the entry is a directory or a regular file.
EncryptionAlgorithm
char* (read-only)
Default Value: ""
Returns the symmetric algorithm that was used to encrypt the file.
EncryptionKeyLength
int (read-only)
Default Value: 0
Returns the length, in bits, of the encryption key.
EncryptionType
int (read-only)
Default Value: 0
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: ""
The original name of the compressed file or folder.
Folder
char* (read-only)
Default Value: ""
The containing folder of the entry.
LocalPath
char*
Default Value: ""
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: ""
The entry's last modification time.
NewFile
int (read-only)
Default Value: FALSE
Indicates whether the entry corresponds to a file to be added to the archive.
Path
char* (read-only)
Default Value: ""
The full internal path of the archived entry.
SignatureCount
int (read-only)
Default Value: 0
The number of signatures covering the entry.
Signed
int (read-only)
Default Value: FALSE
Indicates whether the entry is signed.
Size
int64 (read-only)
Default Value: 0
The size of the file before compression.
Constructors
>
ArchivedFile()
Creates a new ArchivedFile object.
Certificate Type
Provides details of an individual X.509 certificate.
Syntax
SecureBlackboxCertificate (declared in secureblackbox.h)
Remarks
This type provides access to X.509 certificate details.
Fields
Bytes
char* (read-only)
Default Value:
Returns raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the object.
CRLDistributionPoints
char*
Default Value: ""
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Curve
char*
Default Value: ""
Specifies the elliptic curve of the EC public key.
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.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate.
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name.
IssuerRDN
char*
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
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 |
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key.
KeyFingerprint
char* (read-only)
Default Value:
Returns a fingerprint of the public key contained in the certificate.
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 |
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 (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificates ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the origin of this certificate.
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.
PrivateKeyBytes
char* (read-only)
Default Value:
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has an associated private key.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
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 TSL to be qualified.
QualifiedStatements
int
Default Value: 0
Returns the qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifiers 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.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
Source
int (read-only)
Default Value: 0
Returns the source of the entity contained in the object.
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.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
SubjectKeyID
char*
Default Value:
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
SubjectRDN
char*
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature on the request is valid and matches the public key contained in the 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
>
Certificate(const char* lpBytes, int lenBytes, int iStartIndex, int iCount, const char* lpszPassword)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
>Certificate(const char* lpCertBytes, int lenCertBytes, int iCertStartIndex, int iCertCount, const char* lpKeyBytes, int lenKeyBytes, int iKeyStartIndex, int iKeyCount, const char* lpszPassword)
Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
>Certificate(const char* lpBytes, int lenBytes, int iStartIndex, int iCount)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.
>Certificate(const char* lpszPath, const char* lpszPassword)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.
>Certificate(const char* lpszCertPath, const char* lpszKeyPath, const char* lpszPassword)
Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.
>Certificate(const char* lpszPath)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
>Certificate()
Creates a new object with default field values.
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (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.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
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.
int SetCount() {}
|
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.
T* Get(int index) {}
|
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.
T* Set(int index, T* value) {}
|
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.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} 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.
int Flush() { return 0; } 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.
int Read(void* buffer, int count) = 0; 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.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
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.
int Write(const void* buffer, int count) = 0; 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 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 method.ArchiveReader Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
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) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (ArchiveReader 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.