ArchiveReader Module

Properties Methods Events Config Settings Errors

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

Syntax

SecureBlackbox.Archivereader

Remarks

ArchiveReader shows and extracts archived files.

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 file.
DecryptionCertificates	A collection of decryption certificates.
DecryptionPassword	The decryption password.
FileData	The contents of the last extracted file.
Files	Lists all files contained in the archive.
FIPSMode	Reserved.
HashAlgorithm	Returns the hash algorithm that was used to generate the signature.
KnownCertificates	A collection of certificates to be used for signature validation.
Opened	Indicates if the module is in the open state.
SignatureValidationResult	The signature validation result.
SigningCertificate	The certificate of the signature creator.

Method List

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


Close	Closes the current archive.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
Extract	Extracts a single file from the archive.
ExtractAll	Extract all the files contained in the archive.
Open	Opens an archive file.
OpenBytes	Loads an archive file from a byte array.

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.


AfterExtractFile	Marks the completion of extraction of an archived file.
BeforeExtractFile	Marks the start of extraction of an archived file.
DecryptionPasswordNeeded	Requests a decryption password, when needed.
Error	Reports information about errors during archive processing.
Notification	This event notifies the application about an underlying control flow event.
Progress	Reports the progress of data extraction.
RecipientFound	Informs the application that an archive is encrypted with a digital certificate.
SignatureFound	Signifies the start of signature validation.

Config Settings

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


OverwriteExisting	Whether the module should overwrite existing files.
TempPath	Path for storing temporary files.
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.
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 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 (ArchiveReader Module)

The type of the archive file.

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

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


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

- (int)archiveType;

Default Value

Remarks

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


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.

This property is read-only.

DecryptionCertificates Property (ArchiveReader Module)

A collection of decryption certificates.

Syntax

Swift
Objective-C

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


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

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

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

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

Default Value

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only.

DecryptionPassword Property (ArchiveReader Module)

The decryption password.

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

FileData Property (ArchiveReader Module)

The contents of the last extracted file.

Syntax

Swift
Objective-C

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


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

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

Remarks

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

Files Property (ArchiveReader Module)

Lists all files contained in the archive.

Syntax

Swift
Objective-C

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


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

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

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

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

The time point at which the certificate expires, in UTC.

This property is read-only.

FIPSMode Property (ArchiveReader Module)

Reserved.

Syntax

Swift
Objective-C

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


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

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

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (ArchiveReader Module)

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

Syntax

Swift
Objective-C

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


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

- (NSString*)hashAlgorithm;

Default Value

Remarks

Check this property after calling Extract to get the hash algorithm which was used to calculate the signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

This property is read-only.

KnownCertificates Property (ArchiveReader Module)

A collection of certificates to be used for signature validation.

Syntax

Swift
Objective-C

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


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

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

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

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

Default Value

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only.

Opened Property (ArchiveReader Module)

Indicates if the module is in the open state.

Syntax

Swift
Objective-C

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


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

- (BOOL)opened;

Default Value

False

Remarks

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

This property is read-only.

SignatureValidationResult Property (ArchiveReader Module)

The signature validation result.

Syntax

Swift
Objective-C

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

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


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

- (int)signatureValidationResult;

Default Value

Remarks

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


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure

This property is read-only.

SigningCertificate Property (ArchiveReader Module)

The certificate of the signature creator.

Syntax

Swift
Objective-C

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


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

- (NSData*)signingCertBytes;

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

- (BOOL)signingCertCA;

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

- (NSData*)signingCertCAKeyID;

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

- (NSString*)signingCertCRLDistributionPoints;

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

- (NSString*)signingCertCurve;

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

- (NSData*)signingCertFingerprint;

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

- (NSString*)signingCertFriendlyName;

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

- (long long)signingCertHandle;

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

- (NSString*)signingCertHashAlgorithm;

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

- (NSString*)signingCertIssuer;

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

- (NSString*)signingCertIssuerRDN;

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

- (NSString*)signingCertKeyAlgorithm;

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

- (int)signingCertKeyBits;

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

- (NSData*)signingCertKeyFingerprint;

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

- (int)signingCertKeyUsage;

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

- (BOOL)signingCertKeyValid;

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

- (NSString*)signingCertOCSPLocations;

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

- (NSString*)signingCertPolicyIDs;

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

- (NSData*)signingCertPublicKeyBytes;

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

- (BOOL)signingCertSelfSigned;

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

- (NSData*)signingCertSerialNumber;

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

- (NSString*)signingCertSigAlgorithm;

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

- (NSString*)signingCertSubject;

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

- (NSData*)signingCertSubjectKeyID;

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

- (NSString*)signingCertSubjectRDN;

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

- (NSString*)signingCertValidFrom;

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

- (NSString*)signingCertValidTo;

Default Value

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only.

Close Method (ArchiveReader Module)

Closes the current archive.

Syntax

Swift
Objective-C

public func close() throws -> Void

- (void)close;

Remarks

Use this method to close the archive that is currently opened and release the associated memory. You won't be able to extract files or access the archive details after closing the archive.

Config Method (ArchiveReader Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

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

- (NSString*)config:(NSString*)configurationString;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (ArchiveReader Module)

Performs an additional action.

Syntax

Swift
Objective-C

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

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier 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;....

Extract Method (ArchiveReader Module)

Extracts a single file from the archive.

Syntax

Swift
Objective-C

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

- (void)extract:(NSString*)path :(NSString*)localPath :(BOOL)preserveFullPath;

Remarks

Use this method to extract a single file from the archive.

Pass the internal path to the entry in the archive via the Path parameter, and the path where to save the extracted entry via the LocalPath parameter. Set PreserveFullPath to true to enforce full-path extraction, in which case LocalPath would indicate the mount point at which the full Path needs to be rooted. If PreserveFullPath is false, the LocalPath provides the final location for the extracted file.

Use ExtractAll to extract all files at once.

ExtractAll Method (ArchiveReader Module)

Extract all the files contained in the archive.

Syntax

Swift
Objective-C

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

- (void)extractAll:(NSString*)outputPath :(BOOL)overwriteExisting;

Remarks

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

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

Use Extract to extract a single file.

Open Method (ArchiveReader Module)

Opens an archive file.

Syntax

Swift
Objective-C

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

- (void)open:(int)archiveType :(NSString*)archivePath;

Remarks

Call this method to open an archive file. Provide the archive type via the ArchiveType parameter, and the path via the ArchivePath parameter.

The following archive types (formats) are supported:


aftUnknown (0)	Unknown type.
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.
aftTarGzip (4)	The archive contains a .tar.gz file.
aftTarBzip2 (5)	The archive contains data in .tar.bz2 format.

OpenBytes Method (ArchiveReader Module)

Loads an archive file from a byte array.

Syntax

Swift
Objective-C

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

- (void)openBytes:(int)archiveType :(NSData*)archiveBytes;

Remarks

Call this method to load an archive file from a byte array. Provide the archive type via the ArchiveType parameter, and the byte array containing the archive data via the ArchiveBytes parameter.

The following archive types (formats) are supported:


aftUnknown (0)	Unknown type.
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.
aftTarGzip (4)	The archive contains a .tar.gz file.
aftTarBzip2 (5)	The archive contains data in .tar.bz2 format.

AfterExtractFile Event (ArchiveReader Module)

Marks the completion of extraction of an archived file.

Syntax

Swift
Objective-C

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

- (void)onAfterExtractFile:(NSString*)path :(long long)fileSize :(int)dataSource;

Remarks

Subscribe to this event to get notified about the completion of extraction of an archived file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the decompressed file, and the DataSource specifies the type of the destination media.


fdsFile (0)	The data was saved to a file.
fdsStream (1)	The data was saved into a stream assigned to FileStream property.
fdsBuffer (2)	The file data is available in FileData buffer.

BeforeExtractFile Event (ArchiveReader Module)

Marks the start of extraction of an archived file.

Syntax

Swift
Objective-C

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

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

Remarks

Subscribe to this event to be notified about the start of extraction of an archived entry. The handler of this event is a good place to tune up the destination media.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the uncompressed size of the file. Set the by-reference DataSource parameter in accordance with the desired extraction media type:


fdsFile (0)	The data will be saved to a file indicated by the ExtractionPath parameter. You can change the path here.
fdsStream (1)	The data will be saved into a stream assigned to FileStream property.
fdsBuffer (2)	The file data will be saved to a buffer and returned via the FileData property.

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

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

DecryptionPasswordNeeded Event (ArchiveReader Module)

Requests a decryption password, when needed.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

Error Event (ArchiveReader Module)

Reports information about errors during archive processing.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The event is fired in case of exceptional conditions during archive processing.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (ArchiveReader Module)

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

Syntax

Swift
Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the 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.

Progress Event (ArchiveReader Module)

Reports the progress of data extraction.

Syntax

Swift
Objective-C

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

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

Remarks

Subscribe to this event to be notified about decompression progress.

Processed and Total report the progress of extraction of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (ArchiveReader Module)

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

Syntax

Swift
Objective-C

func onRecipientFound(recipientHash: Data, certFound: Bool)

- (void)onRecipientFound:(NSData*)recipientHash :(BOOL)certFound;

Remarks

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

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

SignatureFound Event (ArchiveReader Module)

Signifies the start of signature validation.

Syntax

Swift
Objective-C

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

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

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

ArchivedFile Type

Provides information about the compressed file.

Remarks

Use this type to access compressed file details.

Fields

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:


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)

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.


fdsFile (0)	The data for this entry should be taken from the file provided via .
fdsStream (1)	The data is going to be provided on-the-fly via the FileStream property.
fdsBuffer (2)	The data is going to be provided on-the-fly via the FileData property.

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.


aetDefault (0)	Default encryption (not used for already encrypted files)
aetNoEncryption (1)	No encryption
aetGeneric (2)	Standard ZIP encryption
aetWinZip (3)	WinZIP-based encryption
aetStrong (4)	Strong encryption

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.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

hashAlgorithm
String

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

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.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

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:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

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 (ArchiveReader 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.

ArchiveReader Config Settings

OverwriteExisting: Whether the component should overwrite existing files.

Enable this property to force overwriting of existing files.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

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:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

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:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

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:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

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:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

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:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

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 class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

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 class) 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 class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class 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.

Trappable Errors (ArchiveReader Module)