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 offers capabilities of inspecting, editing, and unpacking archived files from a variety of archive formats. 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

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), as a stream (OpenStream), or load it from a disk file (Open).

Inspecting the archive contents

Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' ACTION> and DATASOURCE> properties to configure bespoke processing for specific files.

Extracting the files

Call ExtractAll to initiate extraction of all the files contained in the archive and selected using the ACTION> property, or Extract to extract a single file. The component notifies your code about each individual extraction using its BeforeExtractFile and AfterExtractFile events. You can use BeforeExtractFile to provide your final decision about the extraction of a particular file.

Use DecryptionPassword 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 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 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.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ArchiveType Property (ArchiveReader Class)

The type of the archive file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArchiveType();

Unicode (Windows)
INT GetArchiveType();

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.

This property is read-only.

Data Type

Integer

DecryptionCertificates Property (ArchiveReader Class)

A collection of decryption certificates.

Syntax

• C++
• C
• Qt

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. You can add certificates to this collection before opening the archive, or on-the-fly, in your RecipientFound event handler.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

DecryptionPassword Property (ArchiveReader Class)

The decryption password.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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 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 Class)

Lists all files contained in the archive.

Syntax

• C++
• C
• Qt

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);

char* secureblackbox_archivereader_getfileattributes(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfileattributes(void* lpObj, int fileindex, const char* lpszFileAttributes);

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);

QString GetFileAttributes(int iFileIndex);
int SetFileAttributes(int iFileIndex, QString qsFileAttributes);

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

SecureBlackboxArchivedFile

FIPSMode Property (ArchiveReader Class)

Reserved.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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

SecureBlackboxCertificate

Opened Property (ArchiveReader Class)

Indicates if the class is in the open state.

Syntax

• C++
• C
• Qt

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

Overwrite Property (ArchiveReader Class)

Whether the class should overwrite existing files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int secureblackbox_archivereader_getoverwrite(void* lpObj);
int secureblackbox_archivereader_setoverwrite(void* lpObj, int bOverwrite);

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 Class)

The signature validation result.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureValidationResult();

Unicode (Windows)
INT GetSignatureValidationResult();

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.

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

• C++
• C
• Qt

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);

char* secureblackbox_archivereader_getsigningcertfingerprint(void* lpObj);

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);

char* secureblackbox_archivereader_getsigningcertkeyfingerprint(void* lpObj);

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();

QString GetSigningCertFingerprint();

QString GetSigningCertFriendlyName();

qint64 GetSigningCertHandle();

QString GetSigningCertHashAlgorithm();

QString GetSigningCertIssuer();

QString GetSigningCertIssuerRDN();

QString GetSigningCertKeyAlgorithm();

int GetSigningCertKeyBits();

QString 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

SecureBlackboxCertificate

Close Method (ArchiveReader Class)

Closes the current archive.

Syntax

• C++
• C
• Qt

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)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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 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;....

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

• C++
• C
• Qt

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

• C++
• C
• Qt

ANSI (Cross Platform)
int ExtractAll(const char* lpszOutputPath);

Unicode (Windows)
INT ExtractAll(LPCWSTR lpszOutputPath);

int secureblackbox_archivereader_extractall(void* lpObj, const char* lpszOutputPath);

int ExtractAll(const QString& qsOutputPath);

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 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

• C++
• C
• Qt

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:

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

• C++
• C
• Qt

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:

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

• C++
• C
• Qt

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:

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

• C++
• C
• Qt

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.)

ActionNeeded Event (ArchiveReader Class)

Requests a decision from the application in case of a conflict.

Syntax

• C++
• C
• Qt

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;

#define EID_ARCHIVEREADER_ACTIONNEEDED 1

virtual INT SECUREBLACKBOX_CALL FireActionNeeded(INT &iWhatFor, LPSTR &lpszEntryPath, LPSTR &lpszDestPath, LPSTR &lpszDescription, INT &iAction);

class ArchiveReaderActionNeededEventParams {
public:
  int WhatFor();

  const QString &EntryPath();

  const QString &DestPath();

  const QString &Description();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ActionNeeded(ArchiveReaderActionNeededEventParams *e);

// Or, subclass ArchiveReader and override this emitter function.
virtual int FireActionNeeded(ArchiveReaderActionNeededEventParams *e) {...}

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:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

AfterExtractFile Event (ArchiveReader Class)

Marks the completion of extraction of an archived file.

Syntax

• C++
• C
• Qt

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 2

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.

BeforeExtractFile Event (ArchiveReader Class)

Marks the start of extraction of an archived file.

Syntax

• C++
• C
• Qt

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 3

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:

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

• C++
• C
• Qt

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 4

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.

The PasswordTarget parameter references the object that is protected with the requested password.

Error Event (ArchiveReader Class)

Reports information about errors during archive processing.

Syntax

• C++
• C
• Qt

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 5

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

• C++
• C
• Qt

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 6

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 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 Class)

Reports the progress of data extraction.

Syntax

• C++
• C
• Qt

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 7

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

• C++
• C
• Qt

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;

#define EID_ARCHIVEREADER_RECIPIENTFOUND 8

virtual INT SECUREBLACKBOX_CALL FireRecipientFound(LPSTR &lpszPublicKeyHash, BOOL &bCertFound);

class ArchiveReaderRecipientFoundEventParams {
public:
  const QString &PublicKeyHash();

  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. 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 Class)

Signifies the start of signature validation.

Syntax

• C++
• C
• Qt

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 9

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 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 property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the 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

Constructors

ArchivedFile()

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.

Fields

Constructors

Certificate()

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.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (ArchiveReader Class)

ArchiveReader Config Settings

Base Config Settings

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.