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

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

Work with ArchiveReader builds on the following steps:

Opening the archive.

On this step the component loads the provided compressed data into its memory. You can pass the compressed data as a byte array (OpenBytes), 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

public int getArchiveType();



Enumerated values:
  public final static int aftUnknown = 0;
  public final static int aftZip = 1;
  public final static int aftGzip = 2;
  public final static int aftBzip2 = 3;
  public final static int aftTar = 4;
  public final static int aftTarGzip = 5;
  public final static int aftTarBzip2 = 6;
  public final static int aftSFX = 7;

Default Value

0

Remarks

Use this property to learn about the type (format) of the opened archive.

This property is read-only.

DecryptionCertificates Property (ArchiveReader Class)

A collection of decryption certificates.

Syntax

public CertificateList getDecryptionCertificates();


public void setDecryptionCertificates(CertificateList decryptionCertificates);

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.

Please refer to the Certificate type for a complete list of fields.

DecryptionPassword Property (ArchiveReader Class)

The decryption password.

Syntax

public String getDecryptionPassword();


public void setDecryptionPassword(String decryptionPassword);

Default Value

""

Remarks

Use this property to provide the decryption password for the archive.

FileData Property (ArchiveReader Class)

The contents of the last extracted file.

Syntax

public byte[] getFileData();


public void setFileData(byte[] fileData);

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.

Files Property (ArchiveReader Class)

Lists all files contained in the archive.

Syntax

public ArchivedFileList getFiles();

Remarks

Use this collection property to walk through the list of files contained in the archive. Use individual file entries to cherry-pick the files that should be extracted by adjusting their Action property, or fine-tune extraction paths using LocalPath property.

This property is read-only and not available at design time.

Please refer to the ArchivedFile type for a complete list of fields.

FileStream Property (ArchiveReader Class)

The stream to extract the compressed file contents to.

Syntax

public java.io.OutputStream getFileStream();


public void setFileStream(java.io.OutputStream fileStream);

Default Value

null

Remarks

Use this property to provide the stream to save the contents of the decompressed file to.

You would typically provide the output stream from your BeforeExtractFile event handler, and process/release it in your AfterExtractFile event handler.

This property is not available at design time.

FIPSMode Property (ArchiveReader Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (ArchiveReader Class)

Returns the hash algorithm that was used to generate the signature.

Syntax

public String 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.

KnownCertificates Property (ArchiveReader Class)

A collection of certificates to be used for signature validation.

Syntax

public CertificateList getKnownCertificates();


public void setKnownCertificates(CertificateList knownCertificates);

Remarks

Use this property to provide a list of certificates to be used for signature validation.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

Opened Property (ArchiveReader Class)

Indicates if the class is in the open state.

Syntax

public boolean isOpened();

Default Value

False

Remarks

Use this property to check if the component provides access to an open archive file.

This property is read-only.

Overwrite Property (ArchiveReader Class)

Whether the class should overwrite existing files.

Syntax

public boolean isOverwrite();


public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

Enable this property to force overwriting of existing files.

SignatureValidationResult Property (ArchiveReader Class)

The signature validation result.

Syntax

public int getSignatureValidationResult();



Enumerated values:
  public final static int svtValid = 0;
  public final static int svtUnknown = 1;
  public final static int svtCorrupted = 2;
  public final static int svtSignerNotFound = 3;
  public final static int svtFailure = 4;
  public final static int svtReferenceCorrupted = 5;

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.

SigningCertificate Property (ArchiveReader Class)

The certificate of the signature creator.

Syntax

public Certificate getSigningCertificate();

Remarks

Use this property to access the certificate that was used to create the signature.

This property is read-only and not available at design time.

Please refer to the Certificate type for a complete list of fields.

Close Method (ArchiveReader Class)

Closes the current archive.

Syntax

public void 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.

Config Method (ArchiveReader Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

DoAction Method (ArchiveReader Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

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

Extract Method (ArchiveReader Class)

Extracts a single file from the archive.

Syntax

public void extract(String path, String localPath, boolean preserveFullPath);

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.

ExtractAll Method (ArchiveReader Class)

Extract all the files contained in the archive.

Syntax

public void extractAll(String outputPath);

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.

Open Method (ArchiveReader Class)

Opens an archive file.

Syntax

public void open(int archiveType, String archivePath);

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:

OpenBytes Method (ArchiveReader Class)

Loads an archive file from a byte array.

Syntax

public void openBytes(int archiveType, byte[] archiveBytes);

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:

OpenStream Method (ArchiveReader Class)

Loads an archive file from a stream.

Syntax

public void openStream(int archiveType, java.io.InputStream archiveStream);

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:

Reset Method (ArchiveReader Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

ActionNeeded Event (ArchiveReader Class)

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

Syntax

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void actionNeeded(ArchiveReaderActionNeededEvent e) {}
  ...
}

public class ArchiveReaderActionNeededEvent {
  public int whatFor;
  public String entryPath;
  public String destPath;
  public String description;
  public int action; //read-write
}

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

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void afterExtractFile(ArchiveReaderAfterExtractFileEvent e) {}
  ...
}

public class ArchiveReaderAfterExtractFileEvent {
  public String path;
  public long fileSize;
  public int dataSource;
}

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

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void beforeExtractFile(ArchiveReaderBeforeExtractFileEvent e) {}
  ...
}

public class ArchiveReaderBeforeExtractFileEvent {
  public String path;
  public long fileSize;
  public int dataSource; //read-write
  public String extractionPath; //read-write
  public boolean skip; //read-write
}

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:

If saving to a stream or buffer, use AfterExtractFile to collect the extracted data from FileStream or FileData, and dispose of any objects allocated in this event handler (such as the output stream).

Use the Skip parameter to cancel extraction of this file and proceed to the next one.

DecryptionPasswordNeeded Event (ArchiveReader Class)

Requests a decryption password, when needed.

Syntax

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void decryptionPasswordNeeded(ArchiveReaderDecryptionPasswordNeededEvent e) {}
  ...
}

public class ArchiveReaderDecryptionPasswordNeededEvent {
  public String passwordTarget;
  public boolean cancel; //read-write
}

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

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void error(ArchiveReaderErrorEvent e) {}
  ...
}

public class ArchiveReaderErrorEvent {
  public int errorCode;
  public String description;
}

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

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void notification(ArchiveReaderNotificationEvent e) {}
  ...
}

public class ArchiveReaderNotificationEvent {
  public String eventID;
  public String eventParam;
}

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

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void progress(ArchiveReaderProgressEvent e) {}
  ...
}

public class ArchiveReaderProgressEvent {
  public long processed;
  public long total;
  public long overallProcessed;
  public long overallTotal;
  public boolean cancel; //read-write
}

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

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void recipientFound(ArchiveReaderRecipientFoundEvent e) {}
  ...
}

public class ArchiveReaderRecipientFoundEvent {
  public String publicKeyHash;
  public boolean certFound;
}

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

public class DefaultArchiveReaderEventListener implements ArchiveReaderEventListener {
  ...
  public void signatureFound(ArchiveReaderSignatureFoundEvent e) {}
  ...
}

public class ArchiveReaderSignatureFoundEvent {
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public boolean certFound;
  public boolean validateSignature; //read-write
  public boolean validateChain; //read-write
}

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.

Remarks

Use this type to access compressed file details.

Fields

Constructors

public ArchivedFile();

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

public Certificate( certPath,  keyPath,  password);

public Certificate( path);

public Certificate( stream);

public Certificate( stream,  password);

public Certificate( certStream,  keyStream,  password);

public Certificate();

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

Trappable Errors (ArchiveReader Class)