ArchiveWriter Module
Properties Methods Events Config Settings Errors
The ArchiveWriter module allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.
Syntax
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 module 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. |
| FIPSMode | Reserved. |
| NewArchive | Indicates whether the archive object represents a new (rather than opened) archive. |
| Opened | Indicates whether module 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 module 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. |
| 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. |
| 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 module 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 module 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 module 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 module (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. |
| Tag | Allows to store any custom data. |
| UseOwnDNSResolver | Specifies whether the client modules 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 Module)
The type of the archive.
Syntax
public var archiveType: ArchivewriterArchiveTypes { get {...} }
public enum ArchivewriterArchiveTypes: 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
This property indicates the type of the opened archive.
This property is read-only.
CompressionAlgorithm Property (ArchiveWriter Module)
Specifies the compression algorithm to use when forming the ZIP archive.
Syntax
public var compressionAlgorithm: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=compressionAlgorithm,setter=setCompressionAlgorithm:) int compressionAlgorithm; - (int)compressionAlgorithm; - (void)setCompressionAlgorithm :(int)newCompressionAlgorithm;
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 Module)
The compression level to apply to the archived data.
Syntax
public var compressionLevel: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=compressionLevel,setter=setCompressionLevel:) int compressionLevel; - (int)compressionLevel; - (void)setCompressionLevel :(int)newCompressionLevel;
Default Value
6
Remarks
Use this property to specify the compression level to apply to the archived data.
DecryptionCertificates Property (ArchiveWriter Module)
A collection of decryption certificates.
Syntax
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
DecryptionPassword Property (ArchiveWriter Module)
The decryption password.
Syntax
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. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.
EncryptionAlgorithm Property (ArchiveWriter Module)
Specifies the encryption algorithm to apply to the archive.
Syntax
public var encryptionAlgorithm: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) NSString* encryptionAlgorithm; - (NSString*)encryptionAlgorithm; - (void)setEncryptionAlgorithm :(NSString*)newEncryptionAlgorithm;
Default Value
""
Remarks
Use this property to specify the encryption algorithm to apply to the archive.
Class 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 Module)
The encryption certificate.
Syntax
public var encryptionCertificate: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=encryptionCertBytes) NSData* encryptionCertBytes; - (NSData*)encryptionCertBytes; @property (nonatomic,readwrite,assign,getter=encryptionCertHandle,setter=setEncryptionCertHandle:) long long encryptionCertHandle; - (long long)encryptionCertHandle; - (void)setEncryptionCertHandle :(long long)newEncryptionCertHandle;
Default Value
""
Remarks
EncryptionKeyLength Property (ArchiveWriter Module)
The length of the encryption key.
Syntax
public var encryptionKeyLength: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=encryptionKeyLength,setter=setEncryptionKeyLength:) int encryptionKeyLength; - (int)encryptionKeyLength; - (void)setEncryptionKeyLength :(int)newEncryptionKeyLength;
Default Value
0
Remarks
Use this setting to specify the length of the encryption key in bits.
EncryptionPassword Property (ArchiveWriter Module)
Specifies the archive encryption password.
Syntax
public var encryptionPassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=encryptionPassword,setter=setEncryptionPassword:) NSString* encryptionPassword; - (NSString*)encryptionPassword; - (void)setEncryptionPassword :(NSString*)newEncryptionPassword;
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 Module)
The type of encryption to apply to the archive.
Syntax
public var encryptionType: ArchivewriterEncryptionTypes { get {...} set {...} }
public enum ArchivewriterEncryptionTypes: Int32 { case aetDefault = 0 case aetNoEncryption = 1 case aetGeneric = 2 case aetWinZip = 3 case aetStrong = 4 }
@property (nonatomic,readwrite,assign,getter=encryptionType,setter=setEncryptionType:) int encryptionType; - (int)encryptionType; - (void)setEncryptionType :(int)newEncryptionType;
Default Value
0
Remarks
Specifies the encryption type for the archive.
FileData Property (ArchiveWriter Module)
The contents of the file being added to the archive.
Syntax
public var fileData: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=fileData,setter=setFileData:) NSData* fileData; - (NSData*)fileData; - (void)setFileData :(NSData*)newFileData;
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.
Files Property (ArchiveWriter Module)
Lists the contents of the archive.
Syntax
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; - (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
FIPSMode Property (ArchiveWriter Module)
Reserved.
Syntax
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.
NewArchive Property (ArchiveWriter Module)
Indicates whether the archive object represents a new (rather than opened) archive.
Syntax
public var newArchive: Bool { get {...} }
@property (nonatomic,readonly,assign,getter=newArchive) BOOL newArchive; - (BOOL)newArchive;
Default Value
False
Remarks
This property is set to true if the archive is new, or to false if the class 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 Module)
Indicates whether module is currently in edit mode.
Syntax
public var opened: Bool { get {...} }
@property (nonatomic,readonly,assign,getter=opened) BOOL opened; - (BOOL)opened;
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 Module)
The certificate to be used for signing.
Syntax
public var signingCertificate: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=signingCertBytes) NSData* signingCertBytes; - (NSData*)signingCertBytes; @property (nonatomic,readwrite,assign,getter=signingCertHandle,setter=setSigningCertHandle:) long long signingCertHandle; - (long long)signingCertHandle; - (void)setSigningCertHandle :(long long)newSigningCertHandle;
Default Value
""
Remarks
SigningChain Property (ArchiveWriter Module)
The signing certificate chain.
Syntax
public var signingChain: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=signingChainCount,setter=setSigningChainCount:) int signingChainCount; - (int)signingChainCount; - (void)setSigningChainCount :(int)newSigningChainCount; - (NSData*)signingChainBytes:(int)signingChainIndex; - (long long)signingChainHandle:(int)signingChainIndex; - (void)setSigningChainHandle:(int)signingChainIndex :(long long)newSigningChainHandle;
Default Value
""
Remarks
AddEmptyDir Method (ArchiveWriter Module)
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 Module)
Adds a file to the archive.
Syntax
- (int)addFile:(NSString*)path :(NSString*)localPath;
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 Module)
Adds a group of files to the archive.
Syntax
- (void)addFiles:(NSString*)folder :(NSString*)localPath :(BOOL)recursive;
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 Module)
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 Module)
Closes the archive.
Syntax
public func close() throws -> Void
- (void)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 Module)
Sets or retrieves a configuration setting.
Syntax
- (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.
CreateNew Method (ArchiveWriter Module)
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 Module)
Performs an additional action.
Syntax
- (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 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 Module)
Opens an archive file.
Syntax
- (void)open:(int)archiveType :(NSString*)archiveName;
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 Module)
Loads an archive file from a byte array.
Syntax
- (void)openBytes:(int)archiveType :(NSData*)archiveBytes;
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.
Remove Method (ArchiveWriter Module)
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 Module)
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 Module)
Compresses the archive and saves it to a byte array.
Syntax
public func saveBytes() throws -> Data
- (NSData*)saveBytes;
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 class fires. See the description of the Save method for the details.
UpdateFile Method (ArchiveWriter Module)
Updates an existing compressed entry with a fresher local version.
Syntax
- (void)updateFile:(NSString*)path :(NSString*)localPath;
Remarks
Call this method to update the Path entry in the archive with a fresher entry at LocalPath.
UpdateFiles Method (ArchiveWriter Module)
Updates a selection of files in the archive.
Syntax
public func updateFiles(folder: String, localPath: String, addMissingFiles: Bool, removeMissingFiles: Bool, recursive: Bool) throws -> Void
- (void)updateFiles:(NSString*)folder :(NSString*)localPath :(BOOL)addMissingFiles :(BOOL)removeMissingFiles :(BOOL)recursive;
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 Module)
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 Module)
Marks the completion of compression of a file.
Syntax
- (void)onAfterCompressFile:(NSString*)path :(long long)fileSize :(int)dataSource;
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 Module)
Marks the start of compression of a file.
Syntax
- (void)onBeforeCompressFile:(NSString*)path :(long long)fileSize :(int)dataSource;
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 Module)
Fires when the component needs a password to decrypt the archive.
Syntax
func onDecryptionPasswordNeeded(passwordTarget: String, cancel: inout Bool)
- (void)onDecryptionPasswordNeeded:(NSString*)passwordTarget :(int*)cancel;
Remarks
Class 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 Module)
Reports information about errors during archive assembling.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
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 Module)
This event notifies the application about an underlying control flow event.
Syntax
- (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 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 Module)
Fires for every file to be compressed before the compression starts.
Syntax
func onPrepareFile(path: String, fileSize: Int64, dataSource: inout Int32, localPath: inout String, action: inout Int32)
- (void)onPrepareFile:(NSString*)path :(long long)fileSize :(int*)dataSource :(NSString**)localPath :(int*)action;
Remarks
Class 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 class 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 Module)
Reports the progress of data compression.
Syntax
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 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 Module)
Signifies that the archive was found to be encrypted with a digital certificate.
Syntax
- (void)onRecipientFound:(NSData*)publicKeyHash :(BOOL)certFound;
Remarks
The class 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: class 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 Int64 |
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 Bool |
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 Int32 |
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 Bool |
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 Int32 |
The number of signatures covering the entry. |
||||||||||||
|
signed Bool |
Indicates whether the entry is signed. |
||||||||||||
|
size Int64 |
The size of the file before compression. |
Constructors
public init()
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 Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
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 Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
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 Bool |
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 Bool |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
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 Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
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 Data |
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 init(stream: )
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public init()
Creates a new object with default field values.
Config Settings (ArchiveWriter Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.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 class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class 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 classes 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 classes. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. |