ArchiveReader Module

Properties   Methods   Events   Config Settings   Errors  

The ArchiveReader module 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

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' > and > 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 > 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

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

ArchiveType Property (ArchiveReader Module)

The type of the archive file.

Syntax

• Swift
• Objective-C

public var archiveType: ArchiveReaderArchiveTypes {
  get {...}
}

public enum ArchiveReaderArchiveTypes: Int32 {
  case aftUnknown = 0
  case aftZip = 1
  case aftGzip = 2
  case aftBzip2 = 3
  case aftTar = 4
  case aftTarGzip = 5
  case aftTarBzip2 = 6
  case aftSFX = 7
}

@property (nonatomic,readonly,assign,getter=archiveType) int archiveType;

- (int)archiveType;

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

A collection of decryption certificates.

Syntax

• Swift
• Objective-C

public var decryptionCertificates: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=decryptionCertCount,setter=setDecryptionCertCount:) int decryptionCertCount;

- (int)decryptionCertCount;
- (void)setDecryptionCertCount :(int)newDecryptionCertCount;

- (NSData*)decryptionCertBytes:(int)decryptionCertIndex;

- (long long)decryptionCertHandle:(int)decryptionCertIndex;
- (void)setDecryptionCertHandle:(int)decryptionCertIndex :(long long)newDecryptionCertHandle;

Default Value

""

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 read-only.

DecryptionPassword Property (ArchiveReader Module)

The decryption password.

Syntax

• Swift
• Objective-C

public var decryptionPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=decryptionPassword,setter=setDecryptionPassword:) NSString* decryptionPassword;

- (NSString*)decryptionPassword;
- (void)setDecryptionPassword :(NSString*)newDecryptionPassword;

Default Value

""

Remarks

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

FileData Property (ArchiveReader Module)

The contents of the last extracted file.

Syntax

• Swift
• Objective-C

public var fileData: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=fileData,setter=setFileData:) NSData* fileData;

- (NSData*)fileData;
- (void)setFileData :(NSData*)newFileData;

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.

Files Property (ArchiveReader Module)

Lists all files contained in the archive.

Syntax

• Swift
• Objective-C

public var files: Array<ArchivedFile> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=fileCount,setter=setFileCount:) int fileCount;

- (int)fileCount;
- (void)setFileCount :(int)newFileCount;

- (int)fileAction:(int)fileIndex;
- (void)setFileAction:(int)fileIndex :(int)newFileAction;

- (NSString*)fileAttributes:(int)fileIndex;
- (void)setFileAttributes:(int)fileIndex :(NSString*)newFileAttributes;

- (long long)fileCompressedSize:(int)fileIndex;

- (int)fileDataSource:(int)fileIndex;
- (void)setFileDataSource:(int)fileIndex :(int)newFileDataSource;

- (BOOL)fileDirectory:(int)fileIndex;

- (NSString*)fileEncryptionAlgorithm:(int)fileIndex;

- (int)fileEncryptionKeyLength:(int)fileIndex;

- (int)fileEncryptionType:(int)fileIndex;

- (NSString*)fileFileName:(int)fileIndex;
- (void)setFileFileName:(int)fileIndex :(NSString*)newFileFileName;

- (NSString*)fileFolder:(int)fileIndex;

- (NSString*)fileLocalPath:(int)fileIndex;
- (void)setFileLocalPath:(int)fileIndex :(NSString*)newFileLocalPath;

- (NSString*)fileMTime:(int)fileIndex;
- (void)setFileMTime:(int)fileIndex :(NSString*)newFileMTime;

- (BOOL)fileNewFile:(int)fileIndex;

- (NSString*)filePath:(int)fileIndex;

- (int)fileSignatureCount:(int)fileIndex;

- (BOOL)fileSigned:(int)fileIndex;

- (long long)fileSize:(int)fileIndex;

Default Value

""

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.

FIPSMode Property (ArchiveReader Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (ArchiveReader Module)

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

Syntax

• Swift
• Objective-C

public var hashAlgorithm: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=hashAlgorithm) NSString* hashAlgorithm;

- (NSString*)hashAlgorithm;

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.

KnownCertificates Property (ArchiveReader Module)

A collection of certificates to be used for signature validation.

Syntax

• Swift
• Objective-C

public var knownCertificates: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount;

- (int)knownCertCount;
- (void)setKnownCertCount :(int)newKnownCertCount;

- (NSData*)knownCertBytes:(int)knownCertIndex;

- (long long)knownCertHandle:(int)knownCertIndex;
- (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;

Default Value

""

Remarks

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

This property is read-only.

Opened Property (ArchiveReader Module)

Indicates if the module is in the open state.

Syntax

• Swift
• Objective-C

public var opened: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=opened) BOOL opened;

- (BOOL)opened;

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

Whether the module should overwrite existing files.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

Enable this property to force overwriting of existing files.

SignatureValidationResult Property (ArchiveReader Module)

The signature validation result.

Syntax

• Swift
• Objective-C

public var signatureValidationResult: ArchiveReaderSignatureValidationResults {
  get {...}
}

public enum ArchiveReaderSignatureValidationResults: Int32 {
  case svtValid = 0
  case svtUnknown = 1
  case svtCorrupted = 2
  case svtSignerNotFound = 3
  case svtFailure = 4
  case svtReferenceCorrupted = 5
}

@property (nonatomic,readonly,assign,getter=signatureValidationResult) int signatureValidationResult;

- (int)signatureValidationResult;

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

This property is read-only.

SigningCertificate Property (ArchiveReader Module)

The certificate of the signature creator.

Syntax

• Swift
• Objective-C

public var signingCertificate: Certificate {
  get {...}
}

@property (nonatomic,readonly,assign,getter=signingCertBytes) NSData* signingCertBytes;

- (NSData*)signingCertBytes;

@property (nonatomic,readonly,assign,getter=signingCertCA) BOOL signingCertCA;

- (BOOL)signingCertCA;

@property (nonatomic,readonly,assign,getter=signingCertCAKeyID) NSData* signingCertCAKeyID;

- (NSData*)signingCertCAKeyID;

@property (nonatomic,readonly,assign,getter=signingCertCRLDistributionPoints) NSString* signingCertCRLDistributionPoints;

- (NSString*)signingCertCRLDistributionPoints;

@property (nonatomic,readonly,assign,getter=signingCertCurve) NSString* signingCertCurve;

- (NSString*)signingCertCurve;

@property (nonatomic,readonly,assign,getter=signingCertFingerprint) NSString* signingCertFingerprint;

- (NSString*)signingCertFingerprint;

@property (nonatomic,readonly,assign,getter=signingCertFriendlyName) NSString* signingCertFriendlyName;

- (NSString*)signingCertFriendlyName;

@property (nonatomic,readonly,assign,getter=signingCertHandle) long long signingCertHandle;

- (long long)signingCertHandle;

@property (nonatomic,readonly,assign,getter=signingCertHashAlgorithm) NSString* signingCertHashAlgorithm;

- (NSString*)signingCertHashAlgorithm;

@property (nonatomic,readonly,assign,getter=signingCertIssuer) NSString* signingCertIssuer;

- (NSString*)signingCertIssuer;

@property (nonatomic,readonly,assign,getter=signingCertIssuerRDN) NSString* signingCertIssuerRDN;

- (NSString*)signingCertIssuerRDN;

@property (nonatomic,readonly,assign,getter=signingCertKeyAlgorithm) NSString* signingCertKeyAlgorithm;

- (NSString*)signingCertKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=signingCertKeyBits) int signingCertKeyBits;

- (int)signingCertKeyBits;

@property (nonatomic,readonly,assign,getter=signingCertKeyFingerprint) NSString* signingCertKeyFingerprint;

- (NSString*)signingCertKeyFingerprint;

@property (nonatomic,readonly,assign,getter=signingCertKeyUsage) int signingCertKeyUsage;

- (int)signingCertKeyUsage;

@property (nonatomic,readonly,assign,getter=signingCertKeyValid) BOOL signingCertKeyValid;

- (BOOL)signingCertKeyValid;

@property (nonatomic,readonly,assign,getter=signingCertOCSPLocations) NSString* signingCertOCSPLocations;

- (NSString*)signingCertOCSPLocations;

@property (nonatomic,readonly,assign,getter=signingCertPolicyIDs) NSString* signingCertPolicyIDs;

- (NSString*)signingCertPolicyIDs;

@property (nonatomic,readonly,assign,getter=signingCertPublicKeyBytes) NSData* signingCertPublicKeyBytes;

- (NSData*)signingCertPublicKeyBytes;

@property (nonatomic,readonly,assign,getter=signingCertSelfSigned) BOOL signingCertSelfSigned;

- (BOOL)signingCertSelfSigned;

@property (nonatomic,readonly,assign,getter=signingCertSerialNumber) NSData* signingCertSerialNumber;

- (NSData*)signingCertSerialNumber;

@property (nonatomic,readonly,assign,getter=signingCertSigAlgorithm) NSString* signingCertSigAlgorithm;

- (NSString*)signingCertSigAlgorithm;

@property (nonatomic,readonly,assign,getter=signingCertSubject) NSString* signingCertSubject;

- (NSString*)signingCertSubject;

@property (nonatomic,readonly,assign,getter=signingCertSubjectKeyID) NSData* signingCertSubjectKeyID;

- (NSData*)signingCertSubjectKeyID;

@property (nonatomic,readonly,assign,getter=signingCertSubjectRDN) NSString* signingCertSubjectRDN;

- (NSString*)signingCertSubjectRDN;

@property (nonatomic,readonly,assign,getter=signingCertValidFrom) NSString* signingCertValidFrom;

- (NSString*)signingCertValidFrom;

@property (nonatomic,readonly,assign,getter=signingCertValidTo) NSString* signingCertValidTo;

- (NSString*)signingCertValidTo;

 

Default Value

""

Remarks

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

This property is read-only.

Close Method (ArchiveReader Module)

Closes the current archive.

Syntax

• Swift
• Objective-C

public func close() throws -> Void

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

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)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 Module)

Extracts a single file from the archive.

Syntax

• Swift
• Objective-C

public func extract(path: String, localPath: String, preserveFullPath: Bool) throws -> Void

- (void)extract:(NSString*)path :(NSString*)localPath :(BOOL)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 Module)

Extract all the files contained in the archive.

Syntax

• Swift
• Objective-C

public func extractAll(outputPath: String) throws -> Void

- (void)extractAll:(NSString*)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 Module)

Opens an archive file.

Syntax

• Swift
• Objective-C

public func open(archiveType: Int32, archivePath: String) throws -> Void

- (void)open:(int)archiveType :(NSString*)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 Module)

Loads an archive file from a byte array.

Syntax

• Swift
• Objective-C

public func openBytes(archiveType: Int32, archiveBytes: Data) throws -> Void

- (void)openBytes:(int)archiveType :(NSData*)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:

Reset Method (ArchiveReader Module)

Resets the component settings.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

ActionNeeded Event (ArchiveReader Module)

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

Syntax

• Swift
• Objective-C

func onActionNeeded(whatFor: Int32, entryPath: String, destPath: String, description: String, action: inout Int32)

- (void)onActionNeeded:(int)whatFor :(NSString*)entryPath :(NSString*)destPath :(NSString*)description :(int*)action;

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

Marks the completion of extraction of an archived file.

Syntax

• Swift
• Objective-C

func onAfterExtractFile(path: String, fileSize: Int64, dataSource: Int32)

- (void)onAfterExtractFile:(NSString*)path :(long long)fileSize :(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 Module)

Marks the start of extraction of an archived file.

Syntax

• Swift
• Objective-C

func onBeforeExtractFile(path: String, fileSize: Int64, dataSource: inout Int32, extractionPath: inout String, skip: inout Bool)

- (void)onBeforeExtractFile:(NSString*)path :(long long)fileSize :(int*)dataSource :(NSString**)extractionPath :(int*)skip;

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

Requests a decryption password, when needed.

Syntax

• Swift
• Objective-C

func onDecryptionPasswordNeeded(passwordTarget: String, cancel: inout Bool)

- (void)onDecryptionPasswordNeeded:(NSString*)passwordTarget :(int*)cancel;

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

Reports information about errors during archive processing.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)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 Module)

This event notifies the application about an underlying control flow event.

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)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 Module)

Reports the progress of data extraction.

Syntax

• Swift
• Objective-C

func onProgress(processed: Int64, total: Int64, overallProcessed: Int64, overallTotal: Int64, cancel: inout Bool)

- (void)onProgress:(long long)processed :(long long)total :(long long)overallProcessed :(long long)overallTotal :(int*)cancel;

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

Informs the application that an archive is encrypted with a digital certificate.

Syntax

• Swift
• Objective-C

func onRecipientFound(publicKeyHash: String, certFound: Bool)

- (void)onRecipientFound:(NSString*)publicKeyHash :(BOOL)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 Module)

Signifies the start of signature validation.

Syntax

• Swift
• Objective-C

func onSignatureFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateSignature: inout Bool, validateChain: inout Bool)

- (void)onSignatureFound:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound :(int*)validateSignature :(int*)validateChain;

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 and 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 init()

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

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

Fields

Constructors

public init(stream: )

public init()

Config Settings (ArchiveReader Module)

ArchiveReader Config Settings

Base Config Settings

Trappable Errors (ArchiveReader Module)