ArchiveReader Component

Properties   Methods   Events   Config Settings   Errors  

The ArchiveReader component supports inspection and extraction of files from zip, tar, gzip and bzip2 archives.

Syntax

nsoftware.SecureBlackbox.Archivereader

Remarks

ArchiveReader shows and extracts archived files.

Property List

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

Method List

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

Event List

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

Config Settings

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

ArchiveType Property (ArchiveReader Component)

The type of the archive file.

Syntax

• C#
• VB.NET

public ArchivereaderArchiveTypes ArchiveType { get; }

enum ArchivereaderArchiveTypes {
  aftUnknown,
  aftZip,
  aftGzip,
  aftBzip2,
  aftTar,
  aftTarGzip,
  aftTarBzip2,
  aftSFX
}

Public ReadOnly Property ArchiveType As ArchivereaderArchiveTypes

Enum ArchivereaderArchiveTypes
  aftUnknown
  aftZip
  aftGzip
  aftBzip2
  aftTar
  aftTarGzip
  aftTarBzip2
  aftSFX
End Enum

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

A collection of decryption certificates.

Syntax

• C#
• VB.NET

public CertificateList DecryptionCertificates { get; }

Public Property DecryptionCertificates As CertificateList

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 component will walk through the certificate list to locate the matching decryption certificate.

This property is not available at design time.

DecryptionPassword Property (ArchiveReader Component)

The decryption password.

Syntax

• C#
• VB.NET

public string DecryptionPassword { get; set; }

Public Property DecryptionPassword As String

Default Value

""

Remarks

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

FileData Property (ArchiveReader Component)

The contents of the last extracted file.

Syntax

• C#
• VB.NET

public byte[] FileData { get; set; }

Public Property FileData As Byte()

Remarks

Use this property to get the contents of the last extracted file with DataSource set to stBuffer (2).

This property is not available at design time.

Files Property (ArchiveReader Component)

Lists all files contained in the archive.

Syntax

• C#
• VB.NET

public ArchivedFileList Files { get; }

Public ReadOnly Property Files As ArchivedFileList

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.

FileStream Property (ArchiveReader Component)

The stream to extract the compressed file contents to.

Syntax

• C#
• VB.NET

public System.IO.Stream FileStream { get; set; }

Public Property FileStream As System.IO.Stream

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

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (ArchiveReader Component)

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

Syntax

• C#
• VB.NET

public string HashAlgorithm { get; }

Public ReadOnly Property HashAlgorithm As String

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

A collection of certificates to be used for signature validation.

Syntax

• C#
• VB.NET

public CertificateList KnownCertificates { get; }

Public Property KnownCertificates As CertificateList

Remarks

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

This property is not available at design time.

Opened Property (ArchiveReader Component)

Indicates if the component is in the open state.

Syntax

• C#
• VB.NET

public bool Opened { get; }

Public ReadOnly Property Opened As Boolean

Default Value

False

Remarks

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

This property is read-only.

SignatureValidationResult Property (ArchiveReader Component)

The signature validation result.

Syntax

• C#
• VB.NET

public ArchivereaderSignatureValidationResults SignatureValidationResult { get; }

enum ArchivereaderSignatureValidationResults {
  svtValid,
  svtUnknown,
  svtCorrupted,
  svtSignerNotFound,
  svtFailure
}

Public ReadOnly Property SignatureValidationResult As ArchivereaderSignatureValidationResults

Enum ArchivereaderSignatureValidationResults
  svtValid
  svtUnknown
  svtCorrupted
  svtSignerNotFound
  svtFailure
End Enum

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

The certificate of the signature creator.

Syntax

• C#
• VB.NET

public Certificate SigningCertificate { get; }

Public ReadOnly Property SigningCertificate As Certificate

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.

Close Method (ArchiveReader Component)

Closes the current archive.

Syntax

• C#
• VB.NET

public void Close();

Public Sub 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 Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. 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 Component)

Extracts a single file from the archive.

Syntax

• C#
• VB.NET

public void Extract(string path, string localPath, bool preserveFullPath);

Public Sub Extract(ByVal Path As String, ByVal LocalPath As String, ByVal PreserveFullPath As Boolean)

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

Extract all the files contained in the archive.

Syntax

• C#
• VB.NET

public void ExtractAll(string outputPath, bool overwriteExisting);

Public Sub ExtractAll(ByVal OutputPath As String, ByVal OverwriteExisting As Boolean)

Remarks

Use this method to extract all the files contained in the archive file. Pass the path where the extracted files should be saved via the OutputPath parameter. Existing files will be overwritten if the OverwriteExisting parameter is set to true.

You can cherry-pick the files to extract, as well as choose different extraction destinations (including files at custom locations, streams, or memory buffers) by subscribing to BeforeExtractFile and AfterExtractFile events.

Use Extract to extract a single file.

Open Method (ArchiveReader Component)

Opens an archive file.

Syntax

• C#
• VB.NET

public void Open(int archiveType, string archivePath);

Public Sub Open(ByVal ArchiveType As Integer, ByVal ArchivePath As String)

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

Loads an archive file from a byte array.

Syntax

• C#
• VB.NET

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

Public Sub OpenBytes(ByVal ArchiveType As Integer, ByVal ArchiveBytes As Byte())

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

Loads an archive file from a stream.

Syntax

• C#
• VB.NET

public void OpenStream(int archiveType, System.IO.Stream archiveStream);

Public Sub OpenStream(ByVal ArchiveType As Integer, ByVal ArchiveStream As System.IO.Stream)

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:

AfterExtractFile Event (ArchiveReader Component)

Marks the completion of extraction of an archived file.

Syntax

• C#
• VB.NET

public event OnAfterExtractFileHandler OnAfterExtractFile;

public delegate void OnAfterExtractFileHandler(object sender, ArchivereaderAfterExtractFileEventArgs e);

public class ArchivereaderAfterExtractFileEventArgs : EventArgs {
  public string Path { get; }
  public long FileSize { get; }
  public int DataSource { get; }
}

Public Event OnAfterExtractFile As OnAfterExtractFileHandler

Public Delegate Sub OnAfterExtractFileHandler(sender As Object, e As ArchivereaderAfterExtractFileEventArgs)

Public Class ArchivereaderAfterExtractFileEventArgs Inherits EventArgs
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileSize As Long
  Public ReadOnly Property DataSource As Integer
End Class

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

Marks the start of extraction of an archived file.

Syntax

• C#
• VB.NET

public event OnBeforeExtractFileHandler OnBeforeExtractFile;

public delegate void OnBeforeExtractFileHandler(object sender, ArchivereaderBeforeExtractFileEventArgs e);

public class ArchivereaderBeforeExtractFileEventArgs : EventArgs {
  public string Path { get; }
  public long FileSize { get; }
  public int DataSource { get; set; }
  public string ExtractionPath { get; set; }
  public bool Skip { get; set; }
}

Public Event OnBeforeExtractFile As OnBeforeExtractFileHandler

Public Delegate Sub OnBeforeExtractFileHandler(sender As Object, e As ArchivereaderBeforeExtractFileEventArgs)

Public Class ArchivereaderBeforeExtractFileEventArgs Inherits EventArgs
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileSize As Long
  Public Property DataSource As Integer
  Public Property ExtractionPath As String
  Public Property Skip As Boolean
End Class

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

Requests a decryption password, when needed.

Syntax

• C#
• VB.NET

public event OnDecryptionPasswordNeededHandler OnDecryptionPasswordNeeded;

public delegate void OnDecryptionPasswordNeededHandler(object sender, ArchivereaderDecryptionPasswordNeededEventArgs e);

public class ArchivereaderDecryptionPasswordNeededEventArgs : EventArgs {
  public string PasswordTarget { get; }
  public bool Cancel { get; set; }
}

Public Event OnDecryptionPasswordNeeded As OnDecryptionPasswordNeededHandler

Public Delegate Sub OnDecryptionPasswordNeededHandler(sender As Object, e As ArchivereaderDecryptionPasswordNeededEventArgs)

Public Class ArchivereaderDecryptionPasswordNeededEventArgs Inherits EventArgs
  Public ReadOnly Property PasswordTarget As String
  Public Property Cancel As Boolean
End Class

Remarks

Component fires this event when it needs a password to decrypt the archive. Subscribe to this event if you expect to process encrypted archives.

Inside the event handler, please assign the correct password to DecryptionPassword property, or set Cancel parameter to true to terminate the processing.

Error Event (ArchiveReader Component)

Reports information about errors during archive processing.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, ArchivereaderErrorEventArgs e);

public class ArchivereaderErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As ArchivereaderErrorEventArgs)

Public Class ArchivereaderErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, ArchivereaderNotificationEventArgs e);

public class ArchivereaderNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As ArchivereaderNotificationEventArgs)

Public Class ArchivereaderNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (ArchiveReader Component)

Reports the progress of data extraction.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, ArchivereaderProgressEventArgs e);

public class ArchivereaderProgressEventArgs : EventArgs {
  public long Processed { get; }
  public long Total { get; }
  public long OverallProcessed { get; }
  public long OverallTotal { get; }
  public bool Cancel { get; set; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As ArchivereaderProgressEventArgs)

Public Class ArchivereaderProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Processed As Long
  Public ReadOnly Property Total As Long
  Public ReadOnly Property OverallProcessed As Long
  Public ReadOnly Property OverallTotal As Long
  Public Property Cancel As Boolean
End Class

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

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

Syntax

• C#
• VB.NET

public event OnRecipientFoundHandler OnRecipientFound;

public delegate void OnRecipientFoundHandler(object sender, ArchivereaderRecipientFoundEventArgs e);

public class ArchivereaderRecipientFoundEventArgs : EventArgs {
  public byte[] RecipientHash { get; }
  public bool CertFound { get; }
}

Public Event OnRecipientFound As OnRecipientFoundHandler

Public Delegate Sub OnRecipientFoundHandler(sender As Object, e As ArchivereaderRecipientFoundEventArgs)

Public Class ArchivereaderRecipientFoundEventArgs Inherits EventArgs
  Public ReadOnly Property RecipientHash As Byte()
  Public ReadOnly Property CertFound As Boolean
End Class

Remarks

The component fires this event when processing archives encrypted with an X.509 certificate. CertFound indicates whether the matching certificate has been found in DecryptionCertificates collection.

This event is an opportunity to add the decryption certificate on a later stage if it was not known at the start of the processing.

SignatureFound Event (ArchiveReader Component)

Signifies the start of signature validation.

Syntax

• C#
• VB.NET

public event OnSignatureFoundHandler OnSignatureFound;

public delegate void OnSignatureFoundHandler(object sender, ArchivereaderSignatureFoundEventArgs e);

public class ArchivereaderSignatureFoundEventArgs : EventArgs {
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public bool CertFound { get; }
  public bool ValidateSignature { get; set; }
  public bool ValidateChain { get; set; }
}

Public Event OnSignatureFound As OnSignatureFoundHandler

Public Delegate Sub OnSignatureFoundHandler(sender As Object, e As ArchivereaderSignatureFoundEventArgs)

Public Class ArchivereaderSignatureFoundEventArgs Inherits EventArgs
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property CertFound As Boolean
  Public Property ValidateSignature As Boolean
  Public Property ValidateChain As Boolean
End Class

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

• C#
• VB.NET

public ArchivedFile();

Public ArchivedFile()

Creates a new ArchivedFile object.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a new object with default field values.

Config Settings (ArchiveReader Component)

ArchiveReader Config Settings

Base Config Settings

Trappable Errors (ArchiveReader Component)