ArchiveWriter Component
Properties Methods Events Config Settings Errors
The ArchiveWriter component allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.
Syntax
nsoftware.SecureBlackbox.Archivewriter
Remarks
Use ArchiveWriter to compress, update, and modify files in archives.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| ArchiveType | The type of the archive. |
| CompressionAlgorithm | Specifies the compression algorithm to use when forming the ZIP archive. |
| CompressionLevel | The compression level to apply to the archived data. |
| DecryptionCertificates | A collection of decryption certificates. |
| DecryptionPassword | The decryption password. |
| EncryptionAlgorithm | Specifies the encryption algorithm to apply to the archive. |
| EncryptionCertificate | The encryption certificate. |
| EncryptionKeyLength | The length of the encryption key. |
| EncryptionPassword | Specifies the archive encryption password. |
| EncryptionType | The type of encryption to apply to the archive. |
| FileData | The contents of the file being added to the archive. |
| Files | Lists the contents of the archive. |
| FileStream | The contents of the file being added to the archive, in a stream. |
| FIPSMode | Reserved. |
| NewArchive | Indicates whether the archive object represents a new (rather than opened) archive. |
| Opened | Indicates whether component is currently in edit mode. |
| SigningCertificate | The certificate to be used for signing. |
| SigningChain | The signing certificate chain. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddEmptyDir | Adds an empty folder to the archive. |
| AddFile | Adds a file to the archive. |
| AddFiles | Adds a group of files to the archive. |
| AddVirtual | Adds a file placeholder to the archive. |
| Close | Closes the archive. |
| Config | Sets or retrieves a configuration setting. |
| CreateNew | Creates a new archive. |
| DoAction | Performs an additional action. |
| Open | Opens an archive file. |
| OpenBytes | Loads an archive file from a byte array. |
| OpenStream | Loads an archive file from a stream. |
| Remove | Removes file(s) and/or folder(s) from the archive. |
| Save | Compresses the archive and saves it to a file. |
| SaveBytes | Compresses the archive and saves it to a byte array. |
| SaveStream | Compresses the archive and saves it to a stream. |
| UpdateFile | Updates an existing compressed entry with a fresher local version. |
| UpdateFiles | Updates a selection of files in the archive. |
| UpdateVirtual | Updates an entry in the archive with on-the-fly content. |
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.
| AfterCompressFile | Marks the completion of compression of a file. |
| BeforeCompressFile | Marks the start of compression of a file. |
| DecryptionPasswordNeeded | Fires when the component needs a password to decrypt the archive. |
| Error | Reports information about errors during archive assembling. |
| Notification | This event notifies the application about an underlying control flow event. |
| PrepareFile | Fires for every file to be compressed before the compression starts. |
| Progress | Reports the progress of data compression. |
| RecipientFound | Signifies that the archive was found to be encrypted with a digital certificate. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| TempPath | Path for storing temporary files. |
| UsePax | Enables use of PAX algorithm when creating TAR directories. |
| UseUStar | Enables use of UStar variant of file name packaging when creating TAR directories. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
ArchiveType Property (ArchiveWriter Component)
The type of the archive.
Syntax
public ArchivewriterArchiveTypes ArchiveType { get; }
enum ArchivewriterArchiveTypes { aftUnknown, aftZip, aftGzip, aftBzip2, aftTar, aftTarGzip, aftTarBzip2, aftSFX }
Public ReadOnly Property ArchiveType As ArchivewriterArchiveTypes
Enum ArchivewriterArchiveTypes aftUnknown aftZip aftGzip aftBzip2 aftTar aftTarGzip aftTarBzip2 aftSFX End Enum
Default Value
0
Remarks
This property indicates the type of the opened archive.
This property is read-only.
CompressionAlgorithm Property (ArchiveWriter Component)
Specifies the compression algorithm to use when forming the ZIP archive.
Syntax
Default Value
8
Remarks
Use this property to select the compression algorithm to be used when creating a ZIP archive.
A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).
| acaStored | 0 | STORED |
| acaShrunk | 1 | SHRUNK |
| acaReduce1 | 2 | REDUCE_1 |
| acaReduce2 | 3 | REDUCE_2 |
| acaReduce3 | 4 | REDUCE_3 |
| acaReduce4 | 5 | REDUCE_4 |
| acaImplode | 6 | IMPLODE |
| acaTokenizing | 7 | Tokenizing |
| acaDeflate | 8 | Deflate |
| acaDeflate64 | 9 | Deflate64 |
| acaTerseOld | 10 | TERSE (old) |
| acaBzip2 | 12 | Bzip2 |
| acaLzma | 14 | LZMA |
| acaTerseNew | 18 | TERSE (new) |
| acaLz77 | 19 | LZ77 |
| acaWavPack | 97 | WAVPACK |
| acaPPMDv1 | 98 | PPMD v1 |
| acaWinzipAES | 99 | WinZIP AES |
| acaUnknown | 65535 | Unknown or unsupported algorithm |
CompressionLevel Property (ArchiveWriter Component)
The compression level to apply to the archived data.
Syntax
Default Value
6
Remarks
Use this property to specify the compression level to apply to the archived data.
DecryptionCertificates Property (ArchiveWriter Component)
A collection of decryption certificates.
Syntax
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 document, the component will walk through the certificate list to locate the matching decryption certificate. If no such certificate is found, it will fire DecryptionInfoNeeded event to request it.
This property is not available at design time.
DecryptionPassword Property (ArchiveWriter Component)
The decryption password.
Syntax
Default Value
""
Remarks
Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.
EncryptionAlgorithm Property (ArchiveWriter Component)
Specifies the encryption algorithm to apply to the archive.
Syntax
Default Value
""
Remarks
Use this property to specify the encryption algorithm to apply to the archive.
Component supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.
EncryptionCertificate Property (ArchiveWriter Component)
The encryption certificate.
Syntax
public Certificate EncryptionCertificate { get; set; }
Public Property EncryptionCertificate As Certificate
Remarks
Use this property to provide the encryption certificate.
This property is not available at design time.
EncryptionKeyLength Property (ArchiveWriter Component)
The length of the encryption key.
Syntax
Default Value
0
Remarks
Use this setting to specify the length of the encryption key in bits.
EncryptionPassword Property (ArchiveWriter Component)
Specifies the archive encryption password.
Syntax
Default Value
""
Remarks
Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.
EncryptionType Property (ArchiveWriter Component)
The type of encryption to apply to the archive.
Syntax
public ArchivewriterEncryptionTypes EncryptionType { get; set; }
enum ArchivewriterEncryptionTypes { aetDefault, aetNoEncryption, aetGeneric, aetWinZip, aetStrong }
Public Property EncryptionType As ArchivewriterEncryptionTypes
Enum ArchivewriterEncryptionTypes aetDefault aetNoEncryption aetGeneric aetWinZip aetStrong End Enum
Default Value
0
Remarks
Specifies the encryption type for the archive.
FileData Property (ArchiveWriter Component)
The contents of the file being added to the archive.
Syntax
Remarks
Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.
Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.
This property is not available at design time.
Files Property (ArchiveWriter Component)
Lists the contents of the archive.
Syntax
public ArchivedFileList Files { get; }
Public ReadOnly Property Files As ArchivedFileList
Remarks
This colletction property provides access to all files contained in the archive, both existing and newly added.
Use it to view or adjust properties of specific files, alter their data sources, and tune up actions to be performed on them.
This property is read-only and not available at design time.
FileStream Property (ArchiveWriter Component)
The contents of the file being added to the archive, in a stream.
Syntax
public System.IO.Stream FileStream { get; set; }
Public Property FileStream As System.IO.Stream
Default Value
null
Remarks
Assign a stream containing the contents of the file being added to the archive to this property. Remember to assign the entry's DataSource field to fdsStream.
This property is not available at design time.
FIPSMode Property (ArchiveWriter Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
NewArchive Property (ArchiveWriter Component)
Indicates whether the archive object represents a new (rather than opened) archive.
Syntax
Default Value
False
Remarks
This property is set to true if the archive is new, or to false if the component control is editing an existing archive.
NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.
This property is read-only.
Opened Property (ArchiveWriter Component)
Indicates whether component is currently in edit mode.
Syntax
Default Value
False
Remarks
This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.
When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.
This property is read-only.
SigningCertificate Property (ArchiveWriter Component)
The certificate to be used for signing.
Syntax
public Certificate SigningCertificate { get; set; }
Public Property SigningCertificate As Certificate
Remarks
Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
SigningChain Property (ArchiveWriter Component)
The signing certificate chain.
Syntax
public CertificateList SigningChain { get; }
Public Property SigningChain As CertificateList
Remarks
Use this property to provide the chain for the signing certificate. Use SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
AddEmptyDir Method (ArchiveWriter Component)
Adds an empty folder to the archive.
Syntax
Remarks
Use this method to added an empty folder to the archive with an internal path of Path.
The method returns the index of the new folder entry in the Files collection.
AddFile Method (ArchiveWriter Component)
Adds a file to the archive.
Syntax
Remarks
Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.
AddFiles Method (ArchiveWriter Component)
Adds a group of files to the archive.
Syntax
Remarks
Use this method to add a collection of files to the archive.
Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.
You can use file mask wildcards in LocalPath to only select the files that match the mask.
AddVirtual Method (ArchiveWriter Component)
Adds a file placeholder to the archive.
Syntax
Remarks
Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.
Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.
This method returns the index of the new entry in the Files collection.
Close Method (ArchiveWriter Component)
Closes the archive.
Syntax
public void Close();
Public Sub Close()
Remarks
Use this method to close the current archive and dispose of all the allocated resources.
Call this method when you are done with the archive.
Config Method (ArchiveWriter Component)
Sets or retrieves a configuration setting.
Syntax
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.
CreateNew Method (ArchiveWriter Component)
Creates a new archive.
Syntax
Remarks
Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.
The following archive types are currently supported:
| aftZip (1) | The archive contains data in ZIP format. |
| aftGzip (2) | The archive file contains data in GZIP format. |
| aftBzip2 (3) | The archive contains BZIP2 data. |
| aftTar (4) | The archive contains a .tar file. |
| aftTarGzip (5) | The archive contains a .tar.gz file. |
| aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save or SaveStream method.
DoAction Method (ArchiveWriter Component)
Performs an additional action.
Syntax
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Open Method (ArchiveWriter Component)
Opens an archive file.
Syntax
Remarks
Use this method to open an existing archive file for modification.
Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.
The following archive types are currently supported:
| aftUnknown (0) | It was not possible to establish the type of the archive file. |
| aftZip (1) | The archive contains data in ZIP format. |
| aftGzip (2) | The archive file contains data in GZIP format. |
| aftBzip2 (3) | The archive contains BZIP2 data. |
| aftTar (4) | The archive contains a .tar file. |
| aftTarGzip (5) | The archive contains a .tar.gz file. |
| aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save or SaveStream method.
OpenBytes Method (ArchiveWriter Component)
Loads an archive file from a byte array.
Syntax
Remarks
Use this method to load an existing archive file from a byte array.
Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.
The following archive types are currently supported:
| aftUnknown (0) | It was not possible to establish the type of the archive. |
| aftZip (1) | The archive contains data in ZIP format. |
| aftGzip (2) | The archive file contains data in GZIP format. |
| aftBzip2 (3) | The archive contains BZIP2 data. |
| aftTar (4) | The archive contains a .tar file. |
| aftTarGzip (5) | The archive contains a .tar.gz file. |
| aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.
OpenStream Method (ArchiveWriter Component)
Loads an archive file from a stream.
Syntax
public void OpenStream(int archiveType, System.IO.Stream archiveStream);
Public Sub OpenStream(ByVal ArchiveType As Integer, ByVal ArchiveStream As System.IO.Stream)
Remarks
Use this method to load an existing archive file from a stream.
Provide the archive stream via the ArchiveStream parameter, and pass the archive type in the ArchiveType parameter.
The following archive types are currently supported:
| aftUnknown (0) | It was not possible to establish the type of the archive. |
| aftZip (1) | The archive contains data in ZIP format. |
| aftGzip (2) | The archive file contains data in GZIP format. |
| aftBzip2 (3) | The archive contains BZIP2 data. |
| aftTar (4) | The archive contains a .tar file. |
| aftTarGzip (5) | The archive contains a .tar.gz file. |
| aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save or SaveStream method.
Remove Method (ArchiveWriter Component)
Removes file(s) and/or folder(s) from the archive.
Syntax
Remarks
Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.
Path supports file masks, which makes this method quite powerful (and potentially dangerous).
Save Method (ArchiveWriter Component)
Compresses the archive and saves it to a file.
Syntax
Remarks
Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.
This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.
Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.
Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.
SaveBytes Method (ArchiveWriter Component)
Compresses the archive and saves it to a byte array.
Syntax
Remarks
Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.
You can fine-tune the compression process by providing compression details on the fly via the events component fires. See the description of the Save method for the details.
SaveStream Method (ArchiveWriter Component)
Compresses the archive and saves it to a stream.
Syntax
public void SaveStream(System.IO.Stream archiveStream);
Public Sub SaveStream(ByVal ArchiveStream As System.IO.Stream)
Remarks
Use this method to finalize all preparations and compress all entries contained in the Files collection to ArchiveStream.
You can fine-tune the compression process by providing compression details on the fly via the events component fires. See the description of the Save method for the details.
UpdateFile Method (ArchiveWriter Component)
Updates an existing compressed entry with a fresher local version.
Syntax
Remarks
Call this method to update the Path entry in the archive with a fresher entry at LocalPath.
UpdateFiles Method (ArchiveWriter Component)
Updates a selection of files in the archive.
Syntax
Remarks
This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.
Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.
The Recursive parameter specifies whether the directory should be browsed recursively.
UpdateVirtual Method (ArchiveWriter Component)
Updates an entry in the archive with on-the-fly content.
Syntax
Remarks
Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.
AfterCompressFile Event (ArchiveWriter Component)
Marks the completion of compression of a file.
Syntax
public event OnAfterCompressFileHandler OnAfterCompressFile; public delegate void OnAfterCompressFileHandler(object sender, ArchivewriterAfterCompressFileEventArgs e); public class ArchivewriterAfterCompressFileEventArgs : EventArgs { public string Path { get; } public long FileSize { get; } public int DataSource { get; } }
Public Event OnAfterCompressFile As OnAfterCompressFileHandler Public Delegate Sub OnAfterCompressFileHandler(sender As Object, e As ArchivewriterAfterCompressFileEventArgs) Public Class ArchivewriterAfterCompressFileEventArgs 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 compression of a file.
The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.
| fdsFile (0) | The data was taken from a file. |
| fdsStream (1) | The data was taken from a stream assigned to FileStream property. |
| fdsBuffer (2) | The file data taken from the FileData buffer. |
BeforeCompressFile Event (ArchiveWriter Component)
Marks the start of compression of a file.
Syntax
public event OnBeforeCompressFileHandler OnBeforeCompressFile; public delegate void OnBeforeCompressFileHandler(object sender, ArchivewriterBeforeCompressFileEventArgs e); public class ArchivewriterBeforeCompressFileEventArgs : EventArgs { public string Path { get; } public long FileSize { get; } public int DataSource { get; } }
Public Event OnBeforeCompressFile As OnBeforeCompressFileHandler Public Delegate Sub OnBeforeCompressFileHandler(sender As Object, e As ArchivewriterBeforeCompressFileEventArgs) Public Class ArchivewriterBeforeCompressFileEventArgs 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 be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.
The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:
| fdsFile (0) | The data will be taken from a file indicated by the entry's LocalPath setting. You can change this path in the handler of this event. |
| fdsStream (1) | The file data will be taken from a stream assigned to FileStream property. |
| fdsBuffer (2) | The data will be taken from a buffer attached to the FileData property. |
Use PrepareFile event to adjust the file data source on the fly.
DecryptionPasswordNeeded Event (ArchiveWriter Component)
Fires when the component needs a password to decrypt the archive.
Syntax
public event OnDecryptionPasswordNeededHandler OnDecryptionPasswordNeeded; public delegate void OnDecryptionPasswordNeededHandler(object sender, ArchivewriterDecryptionPasswordNeededEventArgs e); public class ArchivewriterDecryptionPasswordNeededEventArgs : EventArgs { public string PasswordTarget { get; } public bool Cancel { get; set; } }
Public Event OnDecryptionPasswordNeeded As OnDecryptionPasswordNeededHandler Public Delegate Sub OnDecryptionPasswordNeededHandler(sender As Object, e As ArchivewriterDecryptionPasswordNeededEventArgs) Public Class ArchivewriterDecryptionPasswordNeededEventArgs Inherits EventArgs Public ReadOnly Property PasswordTarget As String Public Property Cancel As Boolean End Class
Remarks
Component fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.
Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation.
Error Event (ArchiveWriter Component)
Reports information about errors during archive assembling.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, ArchivewriterErrorEventArgs e); public class ArchivewriterErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As ArchivewriterErrorEventArgs) Public Class ArchivewriterErrorEventArgs 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 formation.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (ArchiveWriter Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, ArchivewriterNotificationEventArgs e); public class ArchivewriterNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As ArchivewriterNotificationEventArgs) Public Class ArchivewriterNotificationEventArgs 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 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.
PrepareFile Event (ArchiveWriter Component)
Fires for every file to be compressed before the compression starts.
Syntax
public event OnPrepareFileHandler OnPrepareFile; public delegate void OnPrepareFileHandler(object sender, ArchivewriterPrepareFileEventArgs e); public class ArchivewriterPrepareFileEventArgs : EventArgs { public string Path { get; } public long FileSize { get; } public int DataSource { get; set; } public string LocalPath { get; set; } public int Action { get; set; } }
Public Event OnPrepareFile As OnPrepareFileHandler Public Delegate Sub OnPrepareFileHandler(sender As Object, e As ArchivewriterPrepareFileEventArgs) Public Class ArchivewriterPrepareFileEventArgs Inherits EventArgs Public ReadOnly Property Path As String Public ReadOnly Property FileSize As Long Public Property DataSource As Integer Public Property LocalPath As String Public Property Action As Integer End Class
Remarks
Component fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.
The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.
The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:
| fdsFile (0) | The data will be taken from a file indicated by the LocalPath parameter. You can change this path in this event handler. |
| fdsStream (1) | The file data will be taken from a stream assigned to FileStream property. |
| fdsBuffer (2) | The data will be taken from a buffer attached to the FileData property. |
The Action parameter, which is also tuneable, indicates the action for component to take on the file:
| atAdd (0) | Add the file to the archive |
| atKeep (1) | Keep the existing file in the archive |
| atUpdate (2) | Update the archived file with a fresher copy |
| atDelete (3) | Delete the file from the archive |
| atExtract (4) | Extract the file (extraction only) |
| atSkip (5) | Skip file extraction (extraction only) |
Progress Event (ArchiveWriter Component)
Reports the progress of data compression.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, ArchivewriterProgressEventArgs e); public class ArchivewriterProgressEventArgs : 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 ArchivewriterProgressEventArgs) Public Class ArchivewriterProgressEventArgs 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 compression progress.
Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.
RecipientFound Event (ArchiveWriter Component)
Signifies that the archive was found to be encrypted with a digital certificate.
Syntax
public event OnRecipientFoundHandler OnRecipientFound; public delegate void OnRecipientFoundHandler(object sender, ArchivewriterRecipientFoundEventArgs e); public class ArchivewriterRecipientFoundEventArgs : EventArgs { public byte[] PublicKeyHash { get; } public bool CertFound { get; } }
Public Event OnRecipientFound As OnRecipientFoundHandler Public Delegate Sub OnRecipientFoundHandler(sender As Object, e As ArchivewriterRecipientFoundEventArgs) Public Class ArchivewriterRecipientFoundEventArgs Inherits EventArgs Public ReadOnly Property PublicKeyHash As Byte() Public ReadOnly Property CertFound As Boolean End Class
Remarks
The component fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.
CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: component won't be able to decrypt the archive otherwise.
Please note that the certificate must have an associated private key to be capable of decryption.
ArchivedFile Type
Provides information about the compressed file.
Remarks
Use this type to access compressed file details.
Fields
|
Action Actions |
The action to apply to the file. Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:
|
||||||||||||
|
CompressedSize Long |
The size of the file after compression. |
||||||||||||
|
DataSource FileDataSources |
The type of the data source for this entry. Use this property to control the data source for this entry.
|
||||||||||||
|
Directory Boolean |
Tells if the entry is a directory or a regular file. |
||||||||||||
|
EncryptionAlgorithm String |
Returns the symmetric algorithm that was used to encrypt the file. |
||||||||||||
|
EncryptionKeyLength Integer |
Returns the length, in bits, of the encryption key. |
||||||||||||
|
EncryptionType EncryptionTypes |
The type of encryption applied to the file. Use this property to find out what kind of encryption was applied to the file.
|
||||||||||||
|
FileName String |
The original name of the compressed file or folder. |
||||||||||||
|
Folder String |
The containing folder of the entry. |
||||||||||||
|
LocalPath String |
The local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to. |
||||||||||||
|
MTime String |
The entry's last modification time. |
||||||||||||
|
NewFile Boolean |
Indicates whether the entry corresponds to a file to be added to the archive. |
||||||||||||
|
Path String |
The full internal path of the archived entry. |
||||||||||||
|
SignatureCount Integer |
The number of signatures covering the entry. |
||||||||||||
|
Signed Boolean |
Indicates whether the entry is signed. |
||||||||||||
|
Size Long |
The size of the file before compression. |
Constructors
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
|
Bytes Byte() |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CA Boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CAKeyID Byte() |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fingerprint Byte() |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits Integer |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyFingerprint Byte() |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage Integer |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid Boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPNoCheck Boolean |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Origin Integer |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PolicyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes Byte() |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExists Boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExtractable Boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes Byte() |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
QualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SelfSigned Boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SerialNumber Byte() |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectKeyID Byte() |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidTo String |
The time point at which the certificate expires, in UTC. |
Constructors
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.
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.
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.
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.
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.
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.
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.
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.
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.
public Certificate();
Public Certificate()
Creates a new object with default field values.
Config Settings (ArchiveWriter Component)
The component 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 component, access to these internal properties is provided through the Config method.ArchiveWriter Config Settings
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | |
| UsePax: Enables use of PAX algorithm when creating TAR directories.Use this setting to enable or disable the use of PAX algorithm when TARring directories. | |
| UseUStar: Enables use of UStar variant of file name packaging when creating TAR directories.Use this setting to enable or disable the use of UStar file name encoding format. This format allows for correct saving of path names longer than 99 characters in TAR archives. |
Base Config Settings
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
|||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component.
Supported values are:
|
|||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. | |||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | |||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
|||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global". | |||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components. | |||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | |||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
|||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
|||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | |||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | |||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | |||||||||||||||||||||||||||||||
| StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
|||||||||||||||||||||||||||||||
| StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | |||||||||||||||||||||||||||||||
| StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | |||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | |||||||||||||||||||||||||||||||
| UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | |||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | |||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
|||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |